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>
35 #include "tcl_server.h"
36 #include "telnet_server.h"
41 #include <netinet/tcp.h>
44 static struct service
*services
;
46 /* shutdown_openocd == 1: exit the main event loop, and quit the debugger */
47 static int shutdown_openocd
;
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
) {
67 address_size
= sizeof(c
->sin
);
69 c
->fd
= accept(service
->fd
, (struct sockaddr
*)&service
->sin
, &address_size
);
72 /* This increases performance dramatically for e.g. GDB load which
73 * does not have a sliding window protocol.
75 * Ignore errors from this fn as it probably just means less performance
77 setsockopt(c
->fd
, /* socket affected */
78 IPPROTO_TCP
, /* set option at TCP level */
79 TCP_NODELAY
, /* name of option */
80 (char *)&flag
, /* the cast is historical cruft */
81 sizeof(int)); /* length of option value */
83 LOG_INFO("accepting '%s' connection from %s", service
->name
, service
->port
);
84 retval
= service
->new_connection(c
);
85 if (retval
!= ERROR_OK
) {
87 LOG_ERROR("attempted '%s' connection rejected", service
->name
);
88 command_done(c
->cmd_ctx
);
92 } else if (service
->type
== CONNECTION_STDINOUT
) {
94 c
->fd_out
= fileno(stdout
);
97 /* we are using stdin/out so ignore ctrl-c under windoze */
98 SetConsoleCtrlHandler(NULL
, TRUE
);
101 /* do not check for new connections again on stdin */
104 LOG_INFO("accepting '%s' connection from pipe", service
->name
);
105 retval
= service
->new_connection(c
);
106 if (retval
!= ERROR_OK
) {
107 LOG_ERROR("attempted '%s' connection rejected", service
->name
);
108 command_done(c
->cmd_ctx
);
112 } else if (service
->type
== CONNECTION_PIPE
) {
114 /* do not check for new connections again on stdin */
117 char *out_file
= alloc_printf("%so", service
->port
);
118 c
->fd_out
= open(out_file
, O_WRONLY
);
120 if (c
->fd_out
== -1) {
121 LOG_ERROR("could not open %s", service
->port
);
125 LOG_INFO("accepting '%s' connection from pipe %s", service
->name
, service
->port
);
126 retval
= service
->new_connection(c
);
127 if (retval
!= ERROR_OK
) {
128 LOG_ERROR("attempted '%s' connection rejected", service
->name
);
129 command_done(c
->cmd_ctx
);
135 /* add to the end of linked list */
136 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 */
152 if (c
->fd
== connection
->fd
) {
153 service
->connection_closed(c
);
154 if (service
->type
== CONNECTION_TCP
)
156 else if (service
->type
== CONNECTION_PIPE
) {
157 /* The service will listen to the pipe again */
158 c
->service
->fd
= c
->fd
;
161 command_done(c
->cmd_ctx
);
163 /* delete connection */
167 service
->max_connections
++;
171 /* redirect p to next list pointer */
178 /* FIX! make service return error instead of invoking exit() */
179 int add_service(char *name
,
182 new_connection_handler_t new_connection_handler
,
183 input_handler_t input_handler
,
184 connection_closed_handler_t connection_closed_handler
,
187 struct service
*c
, **p
;
188 int so_reuseaddr_option
= 1;
190 c
= malloc(sizeof(struct service
));
192 c
->name
= strdup(name
);
193 c
->port
= strdup(port
);
194 c
->max_connections
= 1; /* Only TCP/IP ports can support more than one connection */
196 c
->connections
= NULL
;
197 c
->new_connection
= new_connection_handler
;
198 c
->input
= input_handler
;
199 c
->connection_closed
= connection_closed_handler
;
203 if (strcmp(c
->port
, "pipe") == 0)
204 c
->type
= CONNECTION_STDINOUT
;
207 portnumber
= strtol(c
->port
, &end
, 0);
208 if (!*end
&& (parse_long(c
->port
, &portnumber
) == ERROR_OK
)) {
209 c
->portnumber
= portnumber
;
210 c
->type
= CONNECTION_TCP
;
212 c
->type
= CONNECTION_PIPE
;
215 if (c
->type
== CONNECTION_TCP
) {
216 c
->max_connections
= max_connections
;
218 c
->fd
= socket(AF_INET
, SOCK_STREAM
, 0);
220 LOG_ERROR("error creating socket: %s", strerror(errno
));
227 (void *)&so_reuseaddr_option
,
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) {
238 LOG_ERROR("couldn't bind to socket: %s", strerror(errno
));
244 setsockopt(c
->fd
, IPPROTO_TCP
, TCP_MAXSEG
, &segsize
, sizeof(int));
246 int window_size
= 128 * 1024;
248 /* These setsockopt()s must happen before the listen() */
250 setsockopt(c
->fd
, SOL_SOCKET
, SO_SNDBUF
,
251 (char *)&window_size
, sizeof(window_size
));
252 setsockopt(c
->fd
, SOL_SOCKET
, SO_RCVBUF
,
253 (char *)&window_size
, sizeof(window_size
));
255 if (listen(c
->fd
, 1) == -1) {
256 LOG_ERROR("couldn't listen on socket: %s", strerror(errno
));
259 } else if (c
->type
== CONNECTION_STDINOUT
) {
260 c
->fd
= fileno(stdin
);
263 /* for win32 set stdin/stdout to binary mode */
264 if (_setmode(_fileno(stdout
), _O_BINARY
) < 0)
265 LOG_WARNING("cannot change stdout mode to binary");
266 if (_setmode(_fileno(stdin
), _O_BINARY
) < 0)
267 LOG_WARNING("cannot change stdin mode to binary");
268 if (_setmode(_fileno(stderr
), _O_BINARY
) < 0)
269 LOG_WARNING("cannot change stderr mode to binary");
271 socket_nonblock(c
->fd
);
273 } else if (c
->type
== CONNECTION_PIPE
) {
275 /* we currenty do not support named pipes under win32
276 * so exit openocd for now */
277 LOG_ERROR("Named pipes currently not supported under this os");
280 /* Pipe we're reading from */
281 c
->fd
= open(c
->port
, O_RDONLY
| O_NONBLOCK
);
283 LOG_ERROR("could not open %s", c
->port
);
289 /* add to the end of linked list */
290 for (p
= &services
; *p
; p
= &(*p
)->next
)
297 static int remove_services(void)
299 struct service
*c
= services
;
303 struct service
*next
= c
->next
;
308 if (c
->type
== CONNECTION_PIPE
) {
321 /* remember the last service for unlinking */
330 int server_loop(struct command_context
*command_context
)
332 struct service
*service
;
336 /* used in select() */
340 /* used in accept() */
344 if (signal(SIGPIPE
, SIG_IGN
) == SIG_ERR
)
345 LOG_ERROR("couldn't set SIGPIPE to SIG_IGN");
348 while (!shutdown_openocd
) {
349 /* monitor sockets for activity */
353 /* add service and connection fds to read_fds */
354 for (service
= services
; service
; service
= service
->next
) {
355 if (service
->fd
!= -1) {
356 /* listen for new connections */
357 FD_SET(service
->fd
, &read_fds
);
359 if (service
->fd
> fd_max
)
360 fd_max
= service
->fd
;
363 if (service
->connections
) {
364 struct connection
*c
;
366 for (c
= service
->connections
; c
; c
= c
->next
) {
367 /* check for activity on the connection */
368 FD_SET(c
->fd
, &read_fds
);
378 /* we're just polling this iteration, this is faster on embedded
381 retval
= socket_select(fd_max
+ 1, &read_fds
, NULL
, NULL
, &tv
);
385 /* Only while we're sleeping we'll let others run */
386 openocd_sleep_prelude();
388 retval
= socket_select(fd_max
+ 1, &read_fds
, NULL
, NULL
, &tv
);
389 openocd_sleep_postlude();
395 errno
= WSAGetLastError();
397 if (errno
== WSAEINTR
)
400 LOG_ERROR("error during select: %s", strerror(errno
));
408 LOG_ERROR("error during select: %s", strerror(errno
));
415 /* We only execute these callbacks when there was nothing to do or we timed
417 target_call_timer_callbacks();
418 process_jim_events(command_context
);
420 FD_ZERO(&read_fds
); /* eCos leaves read_fds unchanged in this case! */
422 /* We timed out/there was nothing to do, timeout rather than poll next time
426 /* There was something to do, next time we'll just poll */
430 /* This is a simple back-off algorithm where we immediately
431 * re-poll if we did something this time around.
433 * This greatly improves performance of DCC.
435 poll_ok
= poll_ok
|| target_got_message();
437 for (service
= services
; service
; service
= service
->next
) {
438 /* handle new connections on listeners */
439 if ((service
->fd
!= -1)
440 && (FD_ISSET(service
->fd
, &read_fds
))) {
441 if (service
->max_connections
> 0)
442 add_connection(service
, command_context
);
444 if (service
->type
== CONNECTION_TCP
) {
445 struct sockaddr_in sin
;
446 socklen_t address_size
= sizeof(sin
);
448 tmp_fd
= accept(service
->fd
,
449 (struct sockaddr
*)&service
->sin
,
451 close_socket(tmp_fd
);
454 "rejected '%s' connection, no more connections allowed",
459 /* handle activity on connections */
460 if (service
->connections
) {
461 struct connection
*c
;
463 for (c
= service
->connections
; c
; ) {
464 if ((FD_ISSET(c
->fd
, &read_fds
)) || c
->input_pending
) {
465 retval
= service
->input(c
);
466 if (retval
!= ERROR_OK
) {
467 struct connection
*next
= c
->next
;
468 if (service
->type
== CONNECTION_PIPE
||
469 service
->type
== CONNECTION_STDINOUT
) {
470 /* if connection uses a pipe then
471 * shutdown openocd on error */
472 shutdown_openocd
= 1;
474 remove_connection(service
, c
);
475 LOG_INFO("dropped '%s' connection",
488 while (PeekMessage(&msg
, NULL
, 0, 0, PM_REMOVE
)) {
489 if (msg
.message
== WM_QUIT
)
490 shutdown_openocd
= 1;
499 BOOL WINAPI
ControlHandler(DWORD dwCtrlType
)
501 shutdown_openocd
= 1;
505 void sig_handler(int sig
)
507 shutdown_openocd
= 1;
511 int server_preinit(void)
513 /* this currently only calls WSAStartup on native win32 systems
514 * before any socket operations are performed.
515 * This is an issue if you call init in your config script */
518 WORD wVersionRequested
;
521 wVersionRequested
= MAKEWORD(2, 2);
523 if (WSAStartup(wVersionRequested
, &wsaData
) != 0) {
524 LOG_ERROR("Failed to Open Winsock");
528 /* register ctrl-c handler */
529 SetConsoleCtrlHandler(ControlHandler
, TRUE
);
531 signal(SIGINT
, sig_handler
);
532 signal(SIGTERM
, sig_handler
);
533 signal(SIGBREAK
, sig_handler
);
534 signal(SIGABRT
, sig_handler
);
540 int server_init(struct command_context
*cmd_ctx
)
542 int ret
= tcl_init();
546 return telnet_init("Open On-Chip Debugger");
549 int server_quit(void)
555 SetConsoleCtrlHandler(ControlHandler
, FALSE
);
561 int connection_write(struct connection
*connection
, const void *data
, int len
)
564 /* successful no-op. Sockets and pipes behave differently here... */
567 if (connection
->service
->type
== CONNECTION_TCP
)
568 return write_socket(connection
->fd_out
, data
, len
);
570 return write(connection
->fd_out
, data
, len
);
573 int connection_read(struct connection
*connection
, void *data
, int len
)
575 if (connection
->service
->type
== CONNECTION_TCP
)
576 return read_socket(connection
->fd
, data
, len
);
578 return read(connection
->fd
, data
, len
);
581 /* tell the server we want to shut down */
582 COMMAND_HANDLER(handle_shutdown_command
)
584 LOG_USER("shutdown command invoked");
586 shutdown_openocd
= 1;
591 static const struct command_registration server_command_handlers
[] = {
594 .handler
= &handle_shutdown_command
,
597 .help
= "shut the server down",
599 COMMAND_REGISTRATION_DONE
602 int server_register_commands(struct command_context
*cmd_ctx
)
604 int retval
= telnet_register_commands(cmd_ctx
);
605 if (ERROR_OK
!= retval
)
608 retval
= tcl_register_commands(cmd_ctx
);
609 if (ERROR_OK
!= retval
)
612 return register_commands(cmd_ctx
, NULL
, server_command_handlers
);
615 COMMAND_HELPER(server_port_command
, unsigned short *out
)
619 command_print(CMD_CTX
, "%d", *out
);
624 COMMAND_PARSE_NUMBER(u16
, CMD_ARGV
[0], port
);
629 return ERROR_COMMAND_SYNTAX_ERROR
;
634 COMMAND_HELPER(server_pipe_command
, char **out
)
638 command_print(CMD_CTX
, "%s", *out
);
642 if (CMD_CTX
->mode
== COMMAND_EXEC
) {
643 LOG_WARNING("unable to change server port after init");
644 return ERROR_COMMAND_ARGUMENT_INVALID
;
647 *out
= strdup(CMD_ARGV
[0]);
651 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)