Commit | Line | Data |
---|---|---|
f9f87d2c MK |
1 | /* Serial interface for raw TCP connections on Un*x like systems. |
2 | ||
61baf725 | 3 | Copyright (C) 1992-2017 Free Software Foundation, Inc. |
c906108c | 4 | |
c5aa993b | 5 | This file is part of GDB. |
c906108c | 6 | |
c5aa993b JM |
7 | This program is free software; you can redistribute it and/or modify |
8 | it under the terms of the GNU General Public License as published by | |
a9762ec7 | 9 | the Free Software Foundation; either version 3 of the License, or |
c5aa993b | 10 | (at your option) any later version. |
c906108c | 11 | |
c5aa993b JM |
12 | This program is distributed in the hope that it will be useful, |
13 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | GNU General Public License for more details. | |
c906108c | 16 | |
c5aa993b | 17 | You should have received a copy of the GNU General Public License |
a9762ec7 | 18 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
c906108c SS |
19 | |
20 | #include "defs.h" | |
21 | #include "serial.h" | |
3eb25fda | 22 | #include "ser-base.h" |
0ea3f30e | 23 | #include "ser-tcp.h" |
84603566 SL |
24 | #include "gdbcmd.h" |
25 | #include "cli/cli-decode.h" | |
26 | #include "cli/cli-setshow.h" | |
614c279d | 27 | #include "filestuff.h" |
c2c6d25f | 28 | |
c906108c | 29 | #include <sys/types.h> |
0cf3e697 MH |
30 | |
31 | #ifdef HAVE_SYS_FILIO_H | |
c378eb4e | 32 | #include <sys/filio.h> /* For FIONBIO. */ |
0cf3e697 MH |
33 | #endif |
34 | #ifdef HAVE_SYS_IOCTL_H | |
c378eb4e | 35 | #include <sys/ioctl.h> /* For FIONBIO. */ |
0cf3e697 MH |
36 | #endif |
37 | ||
438e1e42 | 38 | #include "gdb_sys_time.h" |
b4505029 MM |
39 | |
40 | #ifdef USE_WIN32API | |
41 | #include <winsock2.h> | |
8e7ebaf5 | 42 | #ifndef ETIMEDOUT |
b4505029 | 43 | #define ETIMEDOUT WSAETIMEDOUT |
8e7ebaf5 | 44 | #endif |
6ec2e0f5 SDJ |
45 | /* Gnulib defines close too, but gnulib's replacement |
46 | doesn't call closesocket unless we import the | |
47 | socketlib module. */ | |
48 | #undef close | |
056d7646 | 49 | #define close(fd) closesocket (fd) |
b4505029 MM |
50 | #define ioctl ioctlsocket |
51 | #else | |
9eb1356e | 52 | #include <netinet/in.h> |
c906108c SS |
53 | #include <arpa/inet.h> |
54 | #include <netdb.h> | |
9eb1356e | 55 | #include <sys/socket.h> |
c906108c | 56 | #include <netinet/tcp.h> |
b4505029 | 57 | #endif |
c906108c | 58 | |
042be3a9 | 59 | #include <signal.h> |
84603566 | 60 | #include "gdb_select.h" |
325fac50 | 61 | #include <algorithm> |
c906108c | 62 | |
f9f87d2c MK |
63 | #ifndef HAVE_SOCKLEN_T |
64 | typedef int socklen_t; | |
65 | #endif | |
66 | ||
84603566 SL |
67 | /* For "set tcp" and "show tcp". */ |
68 | ||
69 | static struct cmd_list_element *tcp_set_cmdlist; | |
70 | static struct cmd_list_element *tcp_show_cmdlist; | |
71 | ||
72 | /* Whether to auto-retry refused connections. */ | |
73 | ||
74 | static int tcp_auto_retry = 1; | |
75 | ||
76 | /* Timeout period for connections, in seconds. */ | |
77 | ||
964b8317 | 78 | static unsigned int tcp_retry_limit = 15; |
84603566 | 79 | |
c378eb4e | 80 | /* How many times per second to poll deprecated_ui_loop_hook. */ |
84603566 SL |
81 | |
82 | #define POLL_INTERVAL 5 | |
83 | ||
84 | /* Helper function to wait a while. If SCB is non-null, wait on its | |
85 | file descriptor. Otherwise just wait on a timeout, updating *POLLS. | |
86 | Returns -1 on timeout or interrupt, otherwise the value of select. */ | |
87 | ||
88 | static int | |
2c619be2 | 89 | wait_for_connect (struct serial *scb, unsigned int *polls) |
84603566 SL |
90 | { |
91 | struct timeval t; | |
92 | int n; | |
93 | ||
94 | /* While we wait for the connect to complete, | |
95 | poll the UI so it can update or the user can | |
96 | interrupt. */ | |
97 | if (deprecated_ui_loop_hook && deprecated_ui_loop_hook (0)) | |
98 | { | |
99 | errno = EINTR; | |
100 | return -1; | |
101 | } | |
102 | ||
103 | /* Check for timeout. */ | |
104 | if (*polls > tcp_retry_limit * POLL_INTERVAL) | |
105 | { | |
106 | errno = ETIMEDOUT; | |
107 | return -1; | |
108 | } | |
109 | ||
110 | /* Back off to polling once per second after the first POLL_INTERVAL | |
111 | polls. */ | |
112 | if (*polls < POLL_INTERVAL) | |
113 | { | |
114 | t.tv_sec = 0; | |
115 | t.tv_usec = 1000000 / POLL_INTERVAL; | |
116 | } | |
117 | else | |
118 | { | |
119 | t.tv_sec = 1; | |
120 | t.tv_usec = 0; | |
121 | } | |
122 | ||
123 | if (scb) | |
124 | { | |
125 | fd_set rset, wset, eset; | |
433759f7 | 126 | |
84603566 SL |
127 | FD_ZERO (&rset); |
128 | FD_SET (scb->fd, &rset); | |
129 | wset = rset; | |
130 | eset = rset; | |
131 | ||
132 | /* POSIX systems return connection success or failure by signalling | |
133 | wset. Windows systems return success in wset and failure in | |
134 | eset. | |
135 | ||
136 | We must call select here, rather than gdb_select, because | |
137 | the serial structure has not yet been initialized - the | |
138 | MinGW select wrapper will not know that this FD refers | |
139 | to a socket. */ | |
140 | n = select (scb->fd + 1, &rset, &wset, &eset, &t); | |
141 | } | |
142 | else | |
143 | /* Use gdb_select here, since we have no file descriptors, and on | |
144 | Windows, plain select doesn't work in that case. */ | |
145 | n = gdb_select (0, NULL, NULL, NULL, &t); | |
146 | ||
147 | /* If we didn't time out, only count it as one poll. */ | |
148 | if (n > 0 || *polls < POLL_INTERVAL) | |
149 | (*polls)++; | |
150 | else | |
151 | (*polls) += POLL_INTERVAL; | |
152 | ||
153 | return n; | |
154 | } | |
7c7a201a | 155 | |
c378eb4e | 156 | /* Open a tcp socket. */ |
c906108c | 157 | |
0ea3f30e | 158 | int |
9db8d71f | 159 | net_open (struct serial *scb, const char *name) |
c906108c | 160 | { |
e6a959d6 PA |
161 | char hostname[100]; |
162 | const char *port_str; | |
7c7a201a | 163 | int n, port, tmp; |
9db8d71f | 164 | int use_udp; |
c906108c | 165 | struct hostent *hostent; |
9eb1356e | 166 | struct sockaddr_in sockaddr; |
b4505029 MM |
167 | #ifdef USE_WIN32API |
168 | u_long ioarg; | |
169 | #else | |
170 | int ioarg; | |
171 | #endif | |
2c619be2 | 172 | unsigned int polls = 0; |
c906108c | 173 | |
9db8d71f | 174 | use_udp = 0; |
61012eef | 175 | if (startswith (name, "udp:")) |
9db8d71f DJ |
176 | { |
177 | use_udp = 1; | |
178 | name = name + 4; | |
179 | } | |
61012eef | 180 | else if (startswith (name, "tcp:")) |
9db8d71f DJ |
181 | name = name + 4; |
182 | ||
c906108c SS |
183 | port_str = strchr (name, ':'); |
184 | ||
185 | if (!port_str) | |
c378eb4e MS |
186 | error (_("net_open: No colon in host name!")); /* Shouldn't ever |
187 | happen. */ | |
c906108c | 188 | |
325fac50 | 189 | tmp = std::min (port_str - name, (ptrdiff_t) sizeof hostname - 1); |
c378eb4e MS |
190 | strncpy (hostname, name, tmp); /* Don't want colon. */ |
191 | hostname[tmp] = '\000'; /* Tie off host name. */ | |
c906108c SS |
192 | port = atoi (port_str + 1); |
193 | ||
c378eb4e | 194 | /* Default hostname is localhost. */ |
ad4571f3 CV |
195 | if (!hostname[0]) |
196 | strcpy (hostname, "localhost"); | |
197 | ||
c906108c | 198 | hostent = gethostbyname (hostname); |
c906108c SS |
199 | if (!hostent) |
200 | { | |
201 | fprintf_unfiltered (gdb_stderr, "%s: unknown host\n", hostname); | |
202 | errno = ENOENT; | |
203 | return -1; | |
204 | } | |
205 | ||
9eb1356e PA |
206 | sockaddr.sin_family = PF_INET; |
207 | sockaddr.sin_port = htons (port); | |
208 | memcpy (&sockaddr.sin_addr.s_addr, hostent->h_addr, | |
84603566 SL |
209 | sizeof (struct in_addr)); |
210 | ||
211 | retry: | |
212 | ||
9db8d71f | 213 | if (use_udp) |
614c279d | 214 | scb->fd = gdb_socket_cloexec (PF_INET, SOCK_DGRAM, 0); |
9db8d71f | 215 | else |
614c279d | 216 | scb->fd = gdb_socket_cloexec (PF_INET, SOCK_STREAM, 0); |
9db8d71f | 217 | |
363a6e9f | 218 | if (scb->fd == -1) |
7c7a201a MH |
219 | return -1; |
220 | ||
c378eb4e | 221 | /* Set socket nonblocking. */ |
b4505029 MM |
222 | ioarg = 1; |
223 | ioctl (scb->fd, FIONBIO, &ioarg); | |
c906108c | 224 | |
3e43a32a | 225 | /* Use Non-blocking connect. connect() will return 0 if connected |
c378eb4e | 226 | already. */ |
9eb1356e | 227 | n = connect (scb->fd, (struct sockaddr *) &sockaddr, sizeof (sockaddr)); |
c906108c | 228 | |
84603566 SL |
229 | if (n < 0) |
230 | { | |
b4505029 | 231 | #ifdef USE_WIN32API |
84603566 | 232 | int err = WSAGetLastError(); |
b4505029 | 233 | #else |
84603566 | 234 | int err = errno; |
b4505029 | 235 | #endif |
84603566 SL |
236 | |
237 | /* Maybe we're waiting for the remote target to become ready to | |
238 | accept connections. */ | |
239 | if (tcp_auto_retry | |
b4505029 | 240 | #ifdef USE_WIN32API |
84603566 SL |
241 | && err == WSAECONNREFUSED |
242 | #else | |
243 | && err == ECONNREFUSED | |
b4505029 | 244 | #endif |
84603566 SL |
245 | && wait_for_connect (NULL, &polls) >= 0) |
246 | { | |
247 | close (scb->fd); | |
248 | goto retry; | |
249 | } | |
c906108c | 250 | |
84603566 SL |
251 | if ( |
252 | #ifdef USE_WIN32API | |
253 | /* Under Windows, calling "connect" with a non-blocking socket | |
254 | results in WSAEWOULDBLOCK, not WSAEINPROGRESS. */ | |
255 | err != WSAEWOULDBLOCK | |
256 | #else | |
257 | err != EINPROGRESS | |
258 | #endif | |
259 | ) | |
260 | { | |
261 | errno = err; | |
262 | net_close (scb); | |
263 | return -1; | |
264 | } | |
7c7a201a | 265 | |
c378eb4e | 266 | /* Looks like we need to wait for the connect. */ |
7c7a201a MH |
267 | do |
268 | { | |
84603566 | 269 | n = wait_for_connect (scb, &polls); |
7c7a201a | 270 | } |
84603566 SL |
271 | while (n == 0); |
272 | if (n < 0) | |
7c7a201a | 273 | { |
9db8d71f | 274 | net_close (scb); |
7c7a201a MH |
275 | return -1; |
276 | } | |
277 | } | |
c906108c | 278 | |
c378eb4e | 279 | /* Got something. Is it an error? */ |
7c7a201a | 280 | { |
47b667de AC |
281 | int res, err; |
282 | socklen_t len; | |
433759f7 | 283 | |
0ea3f30e | 284 | len = sizeof (err); |
b4505029 | 285 | /* On Windows, the fourth parameter to getsockopt is a "char *"; |
69e976f8 PA |
286 | on UNIX systems it is generally "void *". The cast to "char *" |
287 | is OK everywhere, since in C++ any data pointer type can be | |
288 | implicitly converted to "void *". */ | |
289 | res = getsockopt (scb->fd, SOL_SOCKET, SO_ERROR, (char *) &err, &len); | |
7c7a201a MH |
290 | if (res < 0 || err) |
291 | { | |
84603566 SL |
292 | /* Maybe the target still isn't ready to accept the connection. */ |
293 | if (tcp_auto_retry | |
294 | #ifdef USE_WIN32API | |
295 | && err == WSAECONNREFUSED | |
296 | #else | |
297 | && err == ECONNREFUSED | |
298 | #endif | |
299 | && wait_for_connect (NULL, &polls) >= 0) | |
300 | { | |
301 | close (scb->fd); | |
302 | goto retry; | |
303 | } | |
7c7a201a MH |
304 | if (err) |
305 | errno = err; | |
9db8d71f | 306 | net_close (scb); |
7c7a201a MH |
307 | return -1; |
308 | } | |
309 | } | |
9db8d71f | 310 | |
c378eb4e | 311 | /* Turn off nonblocking. */ |
b4505029 MM |
312 | ioarg = 0; |
313 | ioctl (scb->fd, FIONBIO, &ioarg); | |
7c7a201a | 314 | |
9db8d71f DJ |
315 | if (use_udp == 0) |
316 | { | |
c378eb4e | 317 | /* Disable Nagle algorithm. Needed in some cases. */ |
9db8d71f DJ |
318 | tmp = 1; |
319 | setsockopt (scb->fd, IPPROTO_TCP, TCP_NODELAY, | |
320 | (char *)&tmp, sizeof (tmp)); | |
321 | } | |
322 | ||
6d318c73 | 323 | #ifdef SIGPIPE |
7c7a201a MH |
324 | /* If we don't do this, then GDB simply exits |
325 | when the remote side dies. */ | |
326 | signal (SIGPIPE, SIG_IGN); | |
6d318c73 | 327 | #endif |
c906108c SS |
328 | |
329 | return 0; | |
330 | } | |
331 | ||
0ea3f30e | 332 | void |
9db8d71f | 333 | net_close (struct serial *scb) |
c906108c | 334 | { |
363a6e9f | 335 | if (scb->fd == -1) |
c906108c SS |
336 | return; |
337 | ||
c5aa993b | 338 | close (scb->fd); |
c906108c SS |
339 | scb->fd = -1; |
340 | } | |
341 | ||
0ea3f30e | 342 | int |
b4505029 MM |
343 | net_read_prim (struct serial *scb, size_t count) |
344 | { | |
c49e7f76 PA |
345 | /* Need to cast to silence -Wpointer-sign on MinGW, as Winsock's |
346 | 'recv' takes 'char *' as second argument, while 'scb->buf' is | |
347 | 'unsigned char *'. */ | |
69e976f8 | 348 | return recv (scb->fd, (char *) scb->buf, count, 0); |
b4505029 MM |
349 | } |
350 | ||
0ea3f30e | 351 | int |
b4505029 MM |
352 | net_write_prim (struct serial *scb, const void *buf, size_t count) |
353 | { | |
69e976f8 PA |
354 | /* On Windows, the second parameter to send is a "const char *"; on |
355 | UNIX systems it is generally "const void *". The cast to "const | |
356 | char *" is OK everywhere, since in C++ any data pointer type can | |
357 | be implicitly converted to "const void *". */ | |
358 | return send (scb->fd, (const char *) buf, count, 0); | |
b4505029 MM |
359 | } |
360 | ||
8775bb90 MS |
361 | int |
362 | ser_tcp_send_break (struct serial *scb) | |
363 | { | |
c378eb4e | 364 | /* Send telnet IAC and BREAK characters. */ |
8775bb90 MS |
365 | return (serial_write (scb, "\377\363", 2)); |
366 | } | |
367 | ||
84603566 SL |
368 | /* Support for "set tcp" and "show tcp" commands. */ |
369 | ||
370 | static void | |
981a3fb3 | 371 | set_tcp_cmd (const char *args, int from_tty) |
84603566 | 372 | { |
635c7e8a | 373 | help_list (tcp_set_cmdlist, "set tcp ", all_commands, gdb_stdout); |
84603566 SL |
374 | } |
375 | ||
376 | static void | |
981a3fb3 | 377 | show_tcp_cmd (const char *args, int from_tty) |
84603566 | 378 | { |
635c7e8a | 379 | help_list (tcp_show_cmdlist, "show tcp ", all_commands, gdb_stdout); |
84603566 SL |
380 | } |
381 | ||
12e8c7d7 TT |
382 | #ifndef USE_WIN32API |
383 | ||
384 | /* The TCP ops. */ | |
385 | ||
386 | static const struct serial_ops tcp_ops = | |
387 | { | |
388 | "tcp", | |
389 | net_open, | |
390 | net_close, | |
391 | NULL, | |
392 | ser_base_readchar, | |
393 | ser_base_write, | |
394 | ser_base_flush_output, | |
395 | ser_base_flush_input, | |
396 | ser_tcp_send_break, | |
397 | ser_base_raw, | |
398 | ser_base_get_tty_state, | |
399 | ser_base_copy_tty_state, | |
400 | ser_base_set_tty_state, | |
401 | ser_base_print_tty_state, | |
402 | ser_base_noflush_set_tty_state, | |
403 | ser_base_setbaudrate, | |
404 | ser_base_setstopbits, | |
236af5e3 | 405 | ser_base_setparity, |
12e8c7d7 TT |
406 | ser_base_drain_output, |
407 | ser_base_async, | |
408 | net_read_prim, | |
409 | net_write_prim | |
410 | }; | |
411 | ||
412 | #endif /* USE_WIN32API */ | |
84603566 | 413 | |
c906108c | 414 | void |
c2c6d25f | 415 | _initialize_ser_tcp (void) |
c906108c | 416 | { |
b4505029 | 417 | #ifdef USE_WIN32API |
0ea3f30e DJ |
418 | /* Do nothing; the TCP serial operations will be initialized in |
419 | ser-mingw.c. */ | |
0ea3f30e | 420 | #else |
12e8c7d7 | 421 | serial_add_interface (&tcp_ops); |
0ea3f30e | 422 | #endif /* USE_WIN32API */ |
84603566 SL |
423 | |
424 | add_prefix_cmd ("tcp", class_maintenance, set_tcp_cmd, _("\ | |
425 | TCP protocol specific variables\n\ | |
426 | Configure variables specific to remote TCP connections"), | |
427 | &tcp_set_cmdlist, "set tcp ", | |
428 | 0 /* allow-unknown */, &setlist); | |
429 | add_prefix_cmd ("tcp", class_maintenance, show_tcp_cmd, _("\ | |
430 | TCP protocol specific variables\n\ | |
431 | Configure variables specific to remote TCP connections"), | |
432 | &tcp_show_cmdlist, "show tcp ", | |
433 | 0 /* allow-unknown */, &showlist); | |
434 | ||
435 | add_setshow_boolean_cmd ("auto-retry", class_obscure, | |
436 | &tcp_auto_retry, _("\ | |
437 | Set auto-retry on socket connect"), _("\ | |
438 | Show auto-retry on socket connect"), | |
439 | NULL, NULL, NULL, | |
440 | &tcp_set_cmdlist, &tcp_show_cmdlist); | |
441 | ||
442 | add_setshow_uinteger_cmd ("connect-timeout", class_obscure, | |
443 | &tcp_retry_limit, _("\ | |
f81d1120 PA |
444 | Set timeout limit in seconds for socket connection"), _("\ |
445 | Show timeout limit in seconds for socket connection"), _("\ | |
446 | If set to \"unlimited\", GDB will keep attempting to establish a\n\ | |
447 | connection forever, unless interrupted with Ctrl-c.\n\ | |
448 | The default is 15 seconds."), | |
449 | NULL, NULL, | |
450 | &tcp_set_cmdlist, &tcp_show_cmdlist); | |
c906108c | 451 | } |