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>
33 #include "tcl_server.h"
34 #include "telnet_server.h"
39 #include <netinet/tcp.h>
43 static struct service
*services
= NULL
;
45 /* shutdown_openocd == 1: exit the main event loop, and quit the debugger */
46 static int shutdown_openocd
= 0;
48 static int add_connection(struct service
*service
, struct command_context
*cmd_ctx
)
50 socklen_t address_size
;
51 struct connection
*c
, **p
;
55 c
= malloc(sizeof(struct connection
));
58 memset(&c
->sin
, 0, sizeof(c
->sin
));
59 c
->cmd_ctx
= copy_command_context(cmd_ctx
);
65 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. */
74 retval
= setsockopt(c
->fd
, /* socket affected */
75 IPPROTO_TCP
, /* set option at TCP level */
76 TCP_NODELAY
, /* name of option */
77 (char *)&flag
, /* the cast is historical cruft */
78 sizeof(int)); /* length of option value */
80 LOG_INFO("accepting '%s' connection from %s", service
->name
, service
->port
);
81 if ((retval
= service
->new_connection(c
)) != ERROR_OK
)
84 LOG_ERROR("attempted '%s' connection rejected", service
->name
);
88 } else if (service
->type
== CONNECTION_STDINOUT
)
91 c
->fd_out
= fileno(stdout
);
94 /* we are using stdin/out so ignore ctrl-c under windoze */
95 SetConsoleCtrlHandler(NULL
, TRUE
);
98 /* do not check for new connections again on stdin */
101 LOG_INFO("accepting '%s' connection from pipe", service
->name
);
102 if ((retval
= service
->new_connection(c
)) != ERROR_OK
)
104 LOG_ERROR("attempted '%s' connection rejected", service
->name
);
108 } else if (service
->type
== CONNECTION_PIPE
)
111 /* do not check for new connections again on stdin */
114 char * out_file
= alloc_printf("%so", service
->port
);
115 c
->fd_out
= open(out_file
, O_WRONLY
);
119 LOG_ERROR("could not open %s", service
->port
);
123 LOG_INFO("accepting '%s' connection from pipe %s", service
->name
, service
->port
);
124 if ((retval
= service
->new_connection(c
)) != ERROR_OK
)
126 LOG_ERROR("attempted '%s' connection rejected", service
->name
);
132 /* add to the end of linked list */
133 for (p
= &service
->connections
; *p
; p
= &(*p
)->next
);
136 service
->max_connections
--;
141 static int remove_connection(struct service
*service
, struct connection
*connection
)
143 struct connection
**p
= &service
->connections
;
144 struct connection
*c
;
146 /* find connection */
149 if (c
->fd
== connection
->fd
)
151 service
->connection_closed(c
);
152 if (service
->type
== CONNECTION_TCP
)
155 } 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
, 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
)
181 struct service
*c
, **p
;
182 int so_reuseaddr_option
= 1;
184 c
= malloc(sizeof(struct service
));
186 c
->name
= strdup(name
);
187 c
->port
= strdup(port
);
188 c
->max_connections
= 1; /* Only TCP/IP ports can support more than one connection */
190 c
->connections
= NULL
;
191 c
->new_connection
= new_connection_handler
;
192 c
->input
= input_handler
;
193 c
->connection_closed
= connection_closed_handler
;
197 if (strcmp(c
->port
, "pipe") == 0)
199 c
->type
= CONNECTION_STDINOUT
;
203 portnumber
= strtol(c
->port
, &end
, 0);
204 if (!*end
&& (parse_long(c
->port
, &portnumber
) == ERROR_OK
))
206 c
->portnumber
= portnumber
;
207 c
->type
= CONNECTION_TCP
;
210 c
->type
= CONNECTION_PIPE
;
214 if (c
->type
== CONNECTION_TCP
)
216 c
->max_connections
= max_connections
;
218 if ((c
->fd
= socket(AF_INET
, SOCK_STREAM
, 0)) == -1)
220 LOG_ERROR("error creating socket: %s", strerror(errno
));
224 setsockopt(c
->fd
, SOL_SOCKET
, SO_REUSEADDR
, (void*)&so_reuseaddr_option
, sizeof(int));
226 socket_nonblock(c
->fd
);
228 memset(&c
->sin
, 0, sizeof(c
->sin
));
229 c
->sin
.sin_family
= AF_INET
;
230 c
->sin
.sin_addr
.s_addr
= INADDR_ANY
;
231 c
->sin
.sin_port
= htons(c
->portnumber
);
233 if (bind(c
->fd
, (struct sockaddr
*)&c
->sin
, sizeof(c
->sin
)) == -1)
235 LOG_ERROR("couldn't bind to socket: %s", strerror(errno
));
241 setsockopt(c
->fd
, IPPROTO_TCP
, TCP_MAXSEG
, &segsize
, sizeof(int));
243 int window_size
= 128 * 1024;
245 /* These setsockopt()s must happen before the listen() */
247 setsockopt(c
->fd
, SOL_SOCKET
, SO_SNDBUF
,
248 (char *)&window_size
, sizeof(window_size
));
249 setsockopt(c
->fd
, SOL_SOCKET
, SO_RCVBUF
,
250 (char *)&window_size
, sizeof(window_size
));
252 if (listen(c
->fd
, 1) == -1)
254 LOG_ERROR("couldn't listen on socket: %s", strerror(errno
));
258 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
);
274 else if (c
->type
== CONNECTION_PIPE
)
277 /* we currenty do not support named pipes under win32
278 * so exit openocd for now */
279 LOG_ERROR("Named pipes currently not supported under this os");
282 /* Pipe we're reading from */
283 c
->fd
= open(c
->port
, O_RDONLY
| O_NONBLOCK
);
286 LOG_ERROR("could not open %s", c
->port
);
292 /* add to the end of linked list */
293 for (p
= &services
; *p
; p
= &(*p
)->next
);
299 static int remove_services(void)
301 struct service
*c
= services
;
306 struct service
*next
= c
->next
;
311 if (c
->type
== CONNECTION_PIPE
)
317 free((void *)c
->port
);
325 /* remember the last service for unlinking */
334 int server_loop(struct command_context
*command_context
)
336 struct service
*service
;
340 /* used in select() */
344 /* used in accept() */
348 if (signal(SIGPIPE
, SIG_IGN
) == SIG_ERR
)
349 LOG_ERROR("couldn't set SIGPIPE to SIG_IGN");
352 while (!shutdown_openocd
)
354 /* monitor sockets for activity */
358 /* add service and connection fds to read_fds */
359 for (service
= services
; service
; service
= service
->next
)
361 if (service
->fd
!= -1)
363 /* listen for new connections */
364 FD_SET(service
->fd
, &read_fds
);
366 if (service
->fd
> fd_max
)
367 fd_max
= service
->fd
;
370 if (service
->connections
)
372 struct connection
*c
;
374 for (c
= service
->connections
; c
; c
= c
->next
)
376 /* check for activity on the connection */
377 FD_SET(c
->fd
, &read_fds
);
388 /* we're just polling this iteration, this is faster on embedded
391 retval
= socket_select(fd_max
+ 1, &read_fds
, NULL
, NULL
, &tv
);
396 /* Only while we're sleeping we'll let others run */
397 openocd_sleep_prelude();
399 retval
= socket_select(fd_max
+ 1, &read_fds
, NULL
, NULL
, &tv
);
400 openocd_sleep_postlude();
407 errno
= WSAGetLastError();
409 if (errno
== WSAEINTR
)
413 LOG_ERROR("error during select: %s", strerror(errno
));
424 LOG_ERROR("error during select: %s", strerror(errno
));
432 /* We only execute these callbacks when there was nothing to do or we timed out */
433 target_call_timer_callbacks();
434 process_jim_events(command_context
);
436 FD_ZERO(&read_fds
); /* eCos leaves read_fds unchanged in this case! */
438 /* We timed out/there was nothing to do, timeout rather than poll next time */
442 /* There was something to do, next time we'll just poll */
446 for (service
= services
; service
; service
= service
->next
)
448 /* handle new connections on listeners */
449 if ((service
->fd
!= -1)
450 && (FD_ISSET(service
->fd
, &read_fds
)))
452 if (service
->max_connections
> 0)
454 add_connection(service
, command_context
);
458 if (service
->type
== CONNECTION_TCP
)
460 struct sockaddr_in sin
;
461 socklen_t address_size
= sizeof(sin
);
463 tmp_fd
= accept(service
->fd
, (struct sockaddr
*)&service
->sin
, &address_size
);
464 close_socket(tmp_fd
);
466 LOG_INFO("rejected '%s' connection, no more connections allowed", service
->name
);
470 /* handle activity on connections */
471 if (service
->connections
)
473 struct connection
*c
;
475 for (c
= service
->connections
; c
;)
477 if ((FD_ISSET(c
->fd
, &read_fds
)) || c
->input_pending
)
479 if ((retval
= service
->input(c
)) != ERROR_OK
)
481 struct connection
*next
= c
->next
;
482 if (service
->type
== CONNECTION_PIPE
)
484 /* if connection uses a pipe then shutdown openocd on error */
485 shutdown_openocd
= 1;
487 remove_connection(service
, c
);
488 LOG_INFO("dropped '%s' connection - error %d", service
->name
, retval
);
500 while (PeekMessage(&msg
,NULL
,0,0,PM_REMOVE
))
502 if (msg
.message
== WM_QUIT
)
503 shutdown_openocd
= 1;
512 BOOL WINAPI
ControlHandler(DWORD dwCtrlType
)
514 shutdown_openocd
= 1;
518 void sig_handler(int sig
) {
519 shutdown_openocd
= 1;
523 int server_preinit(void)
525 /* this currently only calls WSAStartup on native win32 systems
526 * before any socket operations are performed.
527 * This is an issue if you call init in your config script */
530 WORD wVersionRequested
;
533 wVersionRequested
= MAKEWORD(2, 2);
535 if (WSAStartup(wVersionRequested
, &wsaData
) != 0)
537 LOG_ERROR("Failed to Open Winsock");
541 /* register ctrl-c handler */
542 SetConsoleCtrlHandler(ControlHandler
, TRUE
);
544 signal(SIGINT
, sig_handler
);
545 signal(SIGTERM
, sig_handler
);
546 signal(SIGBREAK
, sig_handler
);
547 signal(SIGABRT
, sig_handler
);
553 int server_init(struct command_context
*cmd_ctx
)
555 int ret
= tcl_init();
559 return telnet_init("Open On-Chip Debugger");
562 int server_quit(void)
568 SetConsoleCtrlHandler(ControlHandler
, FALSE
);
574 int connection_write(struct connection
*connection
, const void *data
, int len
)
578 /* successful no-op. Sockets and pipes behave differently here... */
581 if (connection
->service
->type
== CONNECTION_TCP
)
583 return write_socket(connection
->fd_out
, data
, len
);
586 return write(connection
->fd_out
, data
, len
);
590 int connection_read(struct connection
*connection
, void *data
, int len
)
592 if (connection
->service
->type
== CONNECTION_TCP
)
594 return read_socket(connection
->fd
, data
, len
);
597 return read(connection
->fd
, data
, len
);
601 /* tell the server we want to shut down */
602 COMMAND_HANDLER(handle_shutdown_command
)
604 LOG_USER("shutdown command invoked");
606 shutdown_openocd
= 1;
611 static const struct command_registration server_command_handlers
[] = {
614 .handler
= &handle_shutdown_command
,
616 .help
= "shut the server down",
618 COMMAND_REGISTRATION_DONE
621 int server_register_commands(struct command_context
*cmd_ctx
)
623 int retval
= telnet_register_commands(cmd_ctx
);
624 if (ERROR_OK
!= retval
)
627 retval
= tcl_register_commands(cmd_ctx
);
628 if (ERROR_OK
!= retval
)
631 return register_commands(cmd_ctx
, NULL
, server_command_handlers
);
634 SERVER_PORT_COMMAND()
638 command_print(CMD_CTX
, "%d", *out
);
643 COMMAND_PARSE_NUMBER(u16
, CMD_ARGV
[0], port
);
648 return ERROR_INVALID_ARGUMENTS
;
653 SERVER_PIPE_COMMAND()
657 command_print(CMD_CTX
, "%s", *out
);
661 const char * t
= strdup(CMD_ARGV
[0]);
667 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)