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