1 /* SPDX-License-Identifier: BSD-3-Clause */
2 /*
3 * Copyright (c) 1995 Danny Gasparovski.
4 */
5
6 #ifndef SLIRP_SOCKET_H
7 #define SLIRP_SOCKET_H
8
9 #include "misc.h"
10 #include "sbuf.h"
11
12 #define SO_EXPIRE 240000
13 #define SO_EXPIREFAST 10000
14
15 /* Helps unify some in/in6 routines. */
16 union in4or6_addr {
17 struct in_addr addr4;
18 struct in6_addr addr6;
19 };
20 typedef union in4or6_addr in4or6_addr;
21
22 /*
23 * Our socket structure
24 */
25
26 union slirp_sockaddr {
27 struct sockaddr sa;
28 struct sockaddr_storage ss;
29 struct sockaddr_in sin;
30 struct sockaddr_in6 sin6;
31 };
32
33 struct socket {
34 struct socket *so_next, *so_prev; /* For a linked list of sockets */
35
36 int s; /* The actual socket */
37 struct gfwd_list *guestfwd;
38
39 int pollfds_idx; /* GPollFD GArray index */
40
41 Slirp *slirp; /* managing slirp instance */
42
43 /* XXX union these with not-yet-used sbuf params */
44 struct mbuf *so_m; /* Pointer to the original SYN packet,
45 * for non-blocking connect()'s, and
46 * PING reply's */
47 struct tcpiphdr *so_ti; /* Pointer to the original ti within
48 * so_mconn, for non-blocking connections */
49 uint32_t so_urgc;
50 union slirp_sockaddr fhost; /* Foreign host */
51 #define so_faddr fhost.sin.sin_addr
52 #define so_fport fhost.sin.sin_port
53 #define so_faddr6 fhost.sin6.sin6_addr
54 #define so_fport6 fhost.sin6.sin6_port
55 #define so_ffamily fhost.ss.ss_family
56
57 union slirp_sockaddr lhost; /* Local host */
58 #define so_laddr lhost.sin.sin_addr
59 #define so_lport lhost.sin.sin_port
60 #define so_laddr6 lhost.sin6.sin6_addr
61 #define so_lport6 lhost.sin6.sin6_port
62 #define so_lfamily lhost.ss.ss_family
63
64 uint8_t so_iptos; /* Type of service */
65 uint8_t so_emu; /* Is the socket emulated? */
66
67 uint8_t so_type; /* Type of socket, UDP or TCP */
68 int32_t so_state; /* internal state flags SS_*, below */
69
70 struct tcpcb *so_tcpcb; /* pointer to TCP protocol control block */
71 unsigned so_expire; /* When the socket will expire */
72
73 int so_queued; /* Number of packets queued from this socket */
74 int so_nqueued; /* Number of packets queued in a row
75 * Used to determine when to "downgrade" a session
76 * from fastq to batchq */
77
78 struct sbuf so_rcv; /* Receive buffer */
79 struct sbuf so_snd; /* Send buffer */
80 };
81
82
83 /*
84 * Socket state bits. (peer means the host on the Internet,
85 * local host means the host on the other end of the modem)
86 */
87 #define SS_NOFDREF 0x001 /* No fd reference */
88
89 #define SS_ISFCONNECTING \
90 0x002 /* Socket is connecting to peer (non-blocking connect()'s) */
91 #define SS_ISFCONNECTED 0x004 /* Socket is connected to peer */
92 #define SS_FCANTRCVMORE \
93 0x008 /* Socket can't receive more from peer (for half-closes) */
94 #define SS_FCANTSENDMORE \
95 0x010 /* Socket can't send more to peer (for half-closes) */
96 #define SS_FWDRAIN \
97 0x040 /* We received a FIN, drain data and set SS_FCANTSENDMORE */
98
99 #define SS_CTL 0x080
100 #define SS_FACCEPTCONN \
101 0x100 /* Socket is accepting connections from a host on the internet */
102 #define SS_FACCEPTONCE \
103 0x200 /* If set, the SS_FACCEPTCONN socket will die after one accept */
104
105 #define SS_PERSISTENT_MASK 0xf000 /* Unremovable state bits */
106 #define SS_HOSTFWD 0x1000 /* Socket describes host->guest forwarding */
107 #define SS_INCOMING \
108 0x2000 /* Connection was initiated by a host on the internet */
109 #define SS_HOSTFWD_V6ONLY 0x4000 /* Only bind on v6 addresses */
110
sockaddr_equal(const struct sockaddr_storage * a,const struct sockaddr_storage * b)111 static inline int sockaddr_equal(const struct sockaddr_storage *a,
112 const struct sockaddr_storage *b)
113 {
114 if (a->ss_family != b->ss_family) {
115 return 0;
116 }
117
118 switch (a->ss_family) {
119 case AF_INET: {
120 const struct sockaddr_in *a4 = (const struct sockaddr_in *)a;
121 const struct sockaddr_in *b4 = (const struct sockaddr_in *)b;
122 return a4->sin_addr.s_addr == b4->sin_addr.s_addr &&
123 a4->sin_port == b4->sin_port;
124 }
125 case AF_INET6: {
126 const struct sockaddr_in6 *a6 = (const struct sockaddr_in6 *)a;
127 const struct sockaddr_in6 *b6 = (const struct sockaddr_in6 *)b;
128 return (in6_equal(&a6->sin6_addr, &b6->sin6_addr) &&
129 a6->sin6_port == b6->sin6_port);
130 }
131 default:
132 g_assert_not_reached();
133 }
134
135 return 0;
136 }
137
sockaddr_size(const struct sockaddr_storage * a)138 static inline socklen_t sockaddr_size(const struct sockaddr_storage *a)
139 {
140 switch (a->ss_family) {
141 case AF_INET:
142 return sizeof(struct sockaddr_in);
143 case AF_INET6:
144 return sizeof(struct sockaddr_in6);
145 default:
146 g_assert_not_reached();
147 }
148 }
149
sockaddr_copy(struct sockaddr * dst,socklen_t dstlen,const struct sockaddr * src,socklen_t srclen)150 static inline void sockaddr_copy(struct sockaddr *dst, socklen_t dstlen, const struct sockaddr *src, socklen_t srclen)
151 {
152 socklen_t len = sockaddr_size((const struct sockaddr_storage *) src);
153 g_assert(len <= srclen);
154 g_assert(len <= dstlen);
155 memcpy(dst, src, len);
156 }
157
158 struct socket *solookup(struct socket **, struct socket *,
159 struct sockaddr_storage *, struct sockaddr_storage *);
160 struct socket *socreate(Slirp *);
161 void sofree(struct socket *);
162 int soread(struct socket *);
163 int sorecvoob(struct socket *);
164 int sosendoob(struct socket *);
165 int sowrite(struct socket *);
166 void sorecvfrom(struct socket *);
167 int sosendto(struct socket *, struct mbuf *);
168 struct socket *tcp_listen(Slirp *, uint32_t, unsigned, uint32_t, unsigned, int);
169 struct socket *tcpx_listen(Slirp *slirp,
170 const struct sockaddr *haddr, socklen_t haddrlen,
171 const struct sockaddr *laddr, socklen_t laddrlen,
172 int flags);
173 void soisfconnecting(register struct socket *);
174 void soisfconnected(register struct socket *);
175 void sofwdrain(struct socket *);
176 struct iovec; /* For win32 */
177 size_t sopreprbuf(struct socket *so, struct iovec *iov, int *np);
178 int soreadbuf(struct socket *so, const char *buf, int size);
179
180 int sotranslate_out(struct socket *, struct sockaddr_storage *);
181 void sotranslate_in(struct socket *, struct sockaddr_storage *);
182 void sotranslate_accept(struct socket *);
183 void sodrop(struct socket *, int num);
184 int soassign_guest_addr_if_needed(struct socket *so);
185
186 #endif /* SLIRP_SOCKET_H */
187