1 /* Serial port emulation using sockets.
2 Copyright (C) 1998-2021 Free Software Foundation, Inc.
3 Contributed by Cygnus Solutions.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
18 /* FIXME: will obviously need to evolve.
19 - connectionless sockets might be more appropriate. */
21 /* This must come before any other includes. */
37 #include <sys/types.h>
39 #include <netinet/in.h>
40 #include <arpa/inet.h>
42 #include <sys/select.h>
43 #include <sys/socket.h>
46 #include <netinet/tcp.h>
49 #include "sim-assert.h"
50 #include "sim-options.h"
52 #include "dv-sockser.h"
54 #ifndef HAVE_SOCKLEN_T
55 typedef int socklen_t
;
58 /* Get definitions for both O_NONBLOCK and O_NDELAY. */
62 #define O_NDELAY FNDELAY
63 #else /* ! defined (FNDELAY) */
65 #endif /* ! defined (FNDELAY) */
66 #endif /* ! defined (O_NDELAY) */
70 #define O_NONBLOCK FNBLOCK
71 #else /* ! defined (FNBLOCK) */
73 #endif /* ! defined (FNBLOCK) */
74 #endif /* ! defined (O_NONBLOCK) */
77 /* Compromise between eating cpu and properly busy-waiting.
78 One could have an option to set this but for now that seems
80 #define DEFAULT_TIMEOUT 1000 /* microseconds */
82 /* FIXME: These should allocated at run time and kept with other simulator
83 state (duh...). Later. */
84 const char * sockser_addr
= NULL
;
85 /* Timeout in microseconds during status flag computation.
86 Setting this to zero achieves proper busy wait semantics but eats cpu. */
87 static unsigned int sockser_timeout
= DEFAULT_TIMEOUT
;
88 static int sockser_listen_fd
= -1;
89 static int sockser_fd
= -1;
91 /* FIXME: use tree properties when they're ready. */
94 OPTION_ADDR
= OPTION_START
97 static DECLARE_OPTION_HANDLER (sockser_option_handler
);
99 static const OPTION sockser_options
[] =
101 { { "sockser-addr", required_argument
, NULL
, OPTION_ADDR
},
102 '\0', "SOCKET ADDRESS", "Set serial emulation socket address",
103 sockser_option_handler
, NULL
},
104 { { NULL
, no_argument
, NULL
, 0 }, '\0', NULL
, NULL
, NULL
, NULL
}
108 sockser_option_handler (SIM_DESC sd
, sim_cpu
*cpu
, int opt
,
109 char *arg
, int is_command
)
122 dv_sockser_init (SIM_DESC sd
)
124 struct hostent
*hostent
;
125 struct sockaddr_in sockaddr
;
127 const char *port_str
;
130 if (STATE_ENVIRONMENT (sd
) != OPERATING_ENVIRONMENT
131 || sockser_addr
== NULL
)
134 if (*sockser_addr
== '/')
136 /* support for these can come later */
137 sim_io_eprintf (sd
, "sockser init: unix domain sockets not supported: `%s'\n",
142 port_str
= strchr (sockser_addr
, ':');
145 sim_io_eprintf (sd
, "sockser init: missing port number: `%s'\n",
149 tmp
= port_str
- sockser_addr
;
150 if (tmp
>= sizeof hostname
)
151 tmp
= sizeof (hostname
) - 1;
152 strncpy (hostname
, sockser_addr
, tmp
);
153 hostname
[tmp
] = '\000';
154 port
= atoi (port_str
+ 1);
156 hostent
= gethostbyname (hostname
);
159 sim_io_eprintf (sd
, "sockser init: unknown host: %s\n",
164 sockser_listen_fd
= socket (PF_INET
, SOCK_STREAM
, 0);
165 if (sockser_listen_fd
== -1)
167 sim_io_eprintf (sd
, "sockser init: unable to get socket: %s\n",
172 sockaddr
.sin_family
= PF_INET
;
173 sockaddr
.sin_port
= htons (port
);
174 memcpy (&sockaddr
.sin_addr
.s_addr
, hostent
->h_addr
,
175 sizeof (struct in_addr
));
178 if (setsockopt (sockser_listen_fd
, SOL_SOCKET
, SO_REUSEADDR
, (void*)& tmp
, sizeof (tmp
)) < 0)
180 sim_io_eprintf (sd
, "sockser init: unable to set SO_REUSEADDR: %s\n",
183 if (bind (sockser_listen_fd
, (struct sockaddr
*) &sockaddr
, sizeof (sockaddr
)) < 0)
185 sim_io_eprintf (sd
, "sockser init: unable to bind socket address: %s\n",
187 close (sockser_listen_fd
);
188 sockser_listen_fd
= -1;
191 if (listen (sockser_listen_fd
, 1) < 0)
193 sim_io_eprintf (sd
, "sockser init: unable to set up listener: %s\n",
195 close (sockser_listen_fd
);
196 sockser_listen_fd
= -1;
200 /* Handle writes to missing client -> SIGPIPE.
201 ??? Need a central signal management module. */
203 RETSIGTYPE (*orig
) ();
204 orig
= signal (SIGPIPE
, SIG_IGN
);
205 /* If a handler is already set up, don't mess with it. */
206 if (orig
!= SIG_DFL
&& orig
!= SIG_IGN
)
207 signal (SIGPIPE
, orig
);
214 dv_sockser_uninstall (SIM_DESC sd
)
216 if (sockser_listen_fd
!= -1)
218 close (sockser_listen_fd
);
219 sockser_listen_fd
= -1;
221 if (sockser_fd
!= -1)
228 /* Provide a prototype to silence -Wmissing-prototypes. */
229 extern MODULE_INIT_FN sim_install_dv_sockser
;
232 sim_install_dv_sockser (SIM_DESC sd
)
234 SIM_ASSERT (STATE_MAGIC (sd
) == SIM_MAGIC_NUMBER
);
235 if (sim_add_option_table (sd
, NULL
, sockser_options
) != SIM_RC_OK
)
237 sim_module_add_init_fn (sd
, dv_sockser_init
);
238 sim_module_add_uninstall_fn (sd
, dv_sockser_uninstall
);
243 connected_p (SIM_DESC sd
)
248 struct sockaddr sockaddr
;
251 if (sockser_listen_fd
== -1)
256 /* FIXME: has client gone away? */
260 /* Not connected. Connect with a client if there is one. */
263 FD_SET (sockser_listen_fd
, &readfds
);
265 /* ??? One can certainly argue this should be done differently,
266 but for now this is sufficient. */
268 tv
.tv_usec
= sockser_timeout
;
270 numfds
= select (sockser_listen_fd
+ 1, &readfds
, 0, 0, &tv
);
274 addrlen
= sizeof (sockaddr
);
275 sockser_fd
= accept (sockser_listen_fd
, &sockaddr
, &addrlen
);
276 if (sockser_fd
== -1)
279 /* Set non-blocking i/o. */
280 flags
= fcntl (sockser_fd
, F_GETFL
);
281 flags
|= O_NONBLOCK
| O_NDELAY
;
282 if (fcntl (sockser_fd
, F_SETFL
, flags
) == -1)
284 sim_io_eprintf (sd
, "unable to set nonblocking i/o");
293 dv_sockser_status (SIM_DESC sd
)
295 int numrfds
,numwfds
,status
;
297 fd_set readfds
,writefds
;
299 /* status to return if the socket isn't set up, or select fails */
300 status
= DV_SOCKSER_INPUT_EMPTY
| DV_SOCKSER_OUTPUT_EMPTY
|
301 DV_SOCKSER_DISCONNECTED
;
303 if (! connected_p (sd
))
308 FD_SET (sockser_fd
, &readfds
);
309 FD_SET (sockser_fd
, &writefds
);
311 /* ??? One can certainly argue this should be done differently,
312 but for now this is sufficient. The read is done separately
313 from the write to enforce the delay which we heuristically set to
314 once every SOCKSER_TIMEOUT_FREQ tries.
315 No, this isn't great for SMP situations, blah blah blah. */
319 #define SOCKSER_TIMEOUT_FREQ 42
320 if (++n
== SOCKSER_TIMEOUT_FREQ
)
325 tv
.tv_usec
= sockser_timeout
;
326 numrfds
= select (sockser_fd
+ 1, &readfds
, 0, 0, &tv
);
329 numwfds
= select (sockser_fd
+ 1, 0, &writefds
, 0, &tv
);
331 else /* do both selects at once */
335 numrfds
= numwfds
= select (sockser_fd
+ 1, &readfds
, &writefds
, 0, &tv
);
340 if (numrfds
<= 0 || ! FD_ISSET (sockser_fd
, &readfds
))
341 status
|= DV_SOCKSER_INPUT_EMPTY
;
342 if (numwfds
<= 0 || FD_ISSET (sockser_fd
, &writefds
))
343 status
|= DV_SOCKSER_OUTPUT_EMPTY
;
348 dv_sockser_write_buffer (SIM_DESC sd
, const unsigned char *buffer
,
353 if (! connected_p (sd
))
355 n
= write (sockser_fd
, buffer
, nr_bytes
);
371 dv_sockser_write (SIM_DESC sd
, unsigned char c
)
373 return dv_sockser_write_buffer (sd
, &c
, 1);
377 dv_sockser_read (SIM_DESC sd
)
382 if (! connected_p (sd
))
384 n
= read (sockser_fd
, &c
, 1);
385 /* ??? We're assuming semantics that may not be correct for all hosts.
386 In particular (from cvssrc/src/server.c), this assumes that we are using
387 BSD or POSIX nonblocking I/O. System V nonblocking I/O returns zero if
388 there is nothing to read. */