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 /* set when using pipes rather than tcp */
49 int server_use_pipes
= 0;
51 static int add_connection(struct service
*service
, struct command_context
*cmd_ctx
)
53 socklen_t address_size
;
54 struct connection
*c
, **p
;
58 c
= malloc(sizeof(struct connection
));
60 memset(&c
->sin
, 0, sizeof(c
->sin
));
61 c
->cmd_ctx
= copy_command_context(cmd_ctx
);
67 if (service
->type
== CONNECTION_TCP
)
69 address_size
= sizeof(c
->sin
);
71 c
->fd
= accept(service
->fd
, (struct sockaddr
*)&service
->sin
, &address_size
);
73 /* This increases performance dramatically for e.g. GDB load which
74 * does not have a sliding window protocol. */
75 retval
= setsockopt(c
->fd
, /* socket affected */
76 IPPROTO_TCP
, /* set option at TCP level */
77 TCP_NODELAY
, /* name of option */
78 (char *)&flag
, /* the cast is historical cruft */
79 sizeof(int)); /* length of option value */
81 LOG_INFO("accepting '%s' connection from %i", service
->name
, service
->port
);
82 if ((retval
= service
->new_connection(c
)) != ERROR_OK
)
85 LOG_ERROR("attempted '%s' connection rejected", service
->name
);
90 else if (service
->type
== CONNECTION_PIPE
)
94 /* do not check for new connections again on stdin */
97 LOG_INFO("accepting '%s' connection from pipe", service
->name
);
98 if ((retval
= service
->new_connection(c
)) != ERROR_OK
)
100 LOG_ERROR("attempted '%s' connection rejected", service
->name
);
106 /* add to the end of linked list */
107 for (p
= &service
->connections
; *p
; p
= &(*p
)->next
);
110 service
->max_connections
--;
115 static int remove_connection(struct service
*service
, struct connection
*connection
)
117 struct connection
**p
= &service
->connections
;
118 struct connection
*c
;
120 /* find connection */
123 if (c
->fd
== connection
->fd
)
125 service
->connection_closed(c
);
126 if (service
->type
== CONNECTION_TCP
)
128 command_done(c
->cmd_ctx
);
130 /* delete connection */
134 service
->max_connections
++;
138 /* redirect p to next list pointer */
145 int add_service(char *name
, enum connection_type type
, unsigned short 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
)
147 struct service
*c
, **p
;
148 int so_reuseaddr_option
= 1;
150 c
= malloc(sizeof(struct service
));
152 c
->name
= strdup(name
);
155 c
->max_connections
= max_connections
;
157 c
->connections
= NULL
;
158 c
->new_connection
= new_connection_handler
;
159 c
->input
= input_handler
;
160 c
->connection_closed
= connection_closed_handler
;
164 if (type
== CONNECTION_TCP
)
166 if ((c
->fd
= socket(AF_INET
, SOCK_STREAM
, 0)) == -1)
168 LOG_ERROR("error creating socket: %s", strerror(errno
));
172 setsockopt(c
->fd
, SOL_SOCKET
, SO_REUSEADDR
, (void*)&so_reuseaddr_option
, sizeof(int));
174 socket_nonblock(c
->fd
);
176 memset(&c
->sin
, 0, sizeof(c
->sin
));
177 c
->sin
.sin_family
= AF_INET
;
178 c
->sin
.sin_addr
.s_addr
= INADDR_ANY
;
179 c
->sin
.sin_port
= htons(port
);
181 if (bind(c
->fd
, (struct sockaddr
*)&c
->sin
, sizeof(c
->sin
)) == -1)
183 LOG_ERROR("couldn't bind to socket: %s", strerror(errno
));
189 setsockopt(c
->fd
, IPPROTO_TCP
, TCP_MAXSEG
, &segsize
, sizeof(int));
191 int window_size
= 128 * 1024;
193 /* These setsockopt()s must happen before the listen() */
195 setsockopt(c
->fd
, SOL_SOCKET
, SO_SNDBUF
,
196 (char *)&window_size
, sizeof(window_size
));
197 setsockopt(c
->fd
, SOL_SOCKET
, SO_RCVBUF
,
198 (char *)&window_size
, sizeof(window_size
));
200 if (listen(c
->fd
, 1) == -1)
202 LOG_ERROR("couldn't listen on socket: %s", strerror(errno
));
206 else if (type
== CONNECTION_PIPE
)
209 c
->fd
= STDIN_FILENO
;
212 /* for win32 set stdin/stdout to binary mode */
213 if (_setmode(_fileno(stdout
), _O_BINARY
) < 0)
214 LOG_WARNING("cannot change stdout mode to binary");
215 if (_setmode(_fileno(stdin
), _O_BINARY
) < 0)
216 LOG_WARNING("cannot change stdin mode to binary");
217 if (_setmode(_fileno(stderr
), _O_BINARY
) < 0)
218 LOG_WARNING("cannot change stderr mode to binary");
220 socket_nonblock(c
->fd
);
225 LOG_ERROR("unknown connection type: %d", type
);
229 /* add to the end of linked list */
230 for (p
= &services
; *p
; p
= &(*p
)->next
);
236 static int remove_services(void)
238 struct service
*c
= services
;
243 struct service
*next
= c
->next
;
254 /* remember the last service for unlinking */
263 int server_loop(struct command_context
*command_context
)
265 struct service
*service
;
269 /* used in select() */
273 /* used in accept() */
277 if (signal(SIGPIPE
, SIG_IGN
) == SIG_ERR
)
278 LOG_ERROR("couldn't set SIGPIPE to SIG_IGN");
281 while (!shutdown_openocd
)
283 /* monitor sockets for activity */
287 /* add service and connection fds to read_fds */
288 for (service
= services
; service
; service
= service
->next
)
290 if (service
->fd
!= -1)
292 /* listen for new connections */
293 FD_SET(service
->fd
, &read_fds
);
295 if (service
->fd
> fd_max
)
296 fd_max
= service
->fd
;
299 if (service
->connections
)
301 struct connection
*c
;
303 for (c
= service
->connections
; c
; c
= c
->next
)
305 /* check for activity on the connection */
306 FD_SET(c
->fd
, &read_fds
);
317 /* we're just polling this iteration, this is faster on embedded
320 retval
= socket_select(fd_max
+ 1, &read_fds
, NULL
, NULL
, &tv
);
325 /* Only while we're sleeping we'll let others run */
326 openocd_sleep_prelude();
328 retval
= socket_select(fd_max
+ 1, &read_fds
, NULL
, NULL
, &tv
);
329 openocd_sleep_postlude();
336 errno
= WSAGetLastError();
338 if (errno
== WSAEINTR
)
342 LOG_ERROR("error during select: %s", strerror(errno
));
353 LOG_ERROR("error during select: %s", strerror(errno
));
361 /* We only execute these callbacks when there was nothing to do or we timed out */
362 target_call_timer_callbacks();
363 process_jim_events(command_context
);
365 FD_ZERO(&read_fds
); /* eCos leaves read_fds unchanged in this case! */
367 /* We timed out/there was nothing to do, timeout rather than poll next time */
371 /* There was something to do, next time we'll just poll */
375 for (service
= services
; service
; service
= service
->next
)
377 /* handle new connections on listeners */
378 if ((service
->fd
!= -1)
379 && (FD_ISSET(service
->fd
, &read_fds
)))
381 if (service
->max_connections
> 0)
383 add_connection(service
, command_context
);
387 if (service
->type
!= CONNECTION_PIPE
)
389 struct sockaddr_in sin
;
390 socklen_t address_size
= sizeof(sin
);
392 tmp_fd
= accept(service
->fd
, (struct sockaddr
*)&service
->sin
, &address_size
);
393 close_socket(tmp_fd
);
395 LOG_INFO("rejected '%s' connection, no more connections allowed", service
->name
);
399 /* handle activity on connections */
400 if (service
->connections
)
402 struct connection
*c
;
404 for (c
= service
->connections
; c
;)
406 if ((FD_ISSET(c
->fd
, &read_fds
)) || c
->input_pending
)
408 if ((retval
= service
->input(c
)) != ERROR_OK
)
410 struct connection
*next
= c
->next
;
411 if (service
->type
== CONNECTION_PIPE
)
413 /* if connection uses a pipe then shutdown openocd on error */
414 shutdown_openocd
= 1;
416 remove_connection(service
, c
);
417 LOG_INFO("dropped '%s' connection - error %d", service
->name
, retval
);
429 while (PeekMessage(&msg
,NULL
,0,0,PM_REMOVE
))
431 if (msg
.message
== WM_QUIT
)
432 shutdown_openocd
= 1;
441 BOOL WINAPI
ControlHandler(DWORD dwCtrlType
)
443 shutdown_openocd
= 1;
447 void sig_handler(int sig
) {
448 shutdown_openocd
= 1;
452 int server_preinit(void)
454 /* this currently only calls WSAStartup on native win32 systems
455 * before any socket operations are performed.
456 * This is an issue if you call init in your config script */
459 WORD wVersionRequested
;
462 wVersionRequested
= MAKEWORD(2, 2);
464 if (WSAStartup(wVersionRequested
, &wsaData
) != 0)
466 LOG_ERROR("Failed to Open Winsock");
470 if (server_use_pipes
== 0)
472 /* register ctrl-c handler */
473 SetConsoleCtrlHandler(ControlHandler
, TRUE
);
477 /* we are using pipes so ignore ctrl-c */
478 SetConsoleCtrlHandler(NULL
, TRUE
);
481 signal(SIGINT
, sig_handler
);
482 signal(SIGTERM
, sig_handler
);
483 signal(SIGBREAK
, sig_handler
);
484 signal(SIGABRT
, sig_handler
);
490 int server_init(struct command_context
*cmd_ctx
)
492 int ret
= tcl_init();
496 return telnet_init("Open On-Chip Debugger");
499 int server_quit(void)
505 SetConsoleCtrlHandler(ControlHandler
, FALSE
);
511 /* tell the server we want to shut down */
512 COMMAND_HANDLER(handle_shutdown_command
)
514 LOG_USER("shutdown command invoked");
516 shutdown_openocd
= 1;
521 static const struct command_registration server_command_handlers
[] = {
524 .handler
= &handle_shutdown_command
,
526 .help
= "shut the server down",
528 COMMAND_REGISTRATION_DONE
531 int server_register_commands(struct command_context
*cmd_ctx
)
533 int retval
= telnet_register_commands(cmd_ctx
);
534 if (ERROR_OK
!= retval
)
537 retval
= tcl_register_commands(cmd_ctx
);
538 if (ERROR_OK
!= retval
)
541 return register_commands(cmd_ctx
, NULL
, server_command_handlers
);
544 SERVER_PORT_COMMAND()
548 command_print(CMD_CTX
, "%d", *out
);
553 COMMAND_PARSE_NUMBER(u16
, CMD_ARGV
[0], port
);
558 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)