xref: /freebsd/sys/compat/linux/linux_socket.h (revision c57dfd92c876fabc04e94945dd9534468520bbbf)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 2000 Assar Westerlund
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer
12  *    in this position and unchanged.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. The name of the author may not be used to endorse or promote products
17  *    derived from this software without specific prior written permission
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  *
30  * $FreeBSD$
31  */
32 
33 #ifndef _LINUX_SOCKET_H_
34 #define _LINUX_SOCKET_H_
35 
36 /* msg flags in recvfrom/recvmsg */
37 
38 #define LINUX_MSG_OOB		0x01
39 #define LINUX_MSG_PEEK		0x02
40 #define LINUX_MSG_DONTROUTE	0x04
41 #define LINUX_MSG_CTRUNC	0x08
42 #define LINUX_MSG_PROXY		0x10
43 #define LINUX_MSG_TRUNC		0x20
44 #define LINUX_MSG_DONTWAIT	0x40
45 #define LINUX_MSG_EOR		0x80
46 #define LINUX_MSG_WAITALL	0x100
47 #define LINUX_MSG_FIN		0x200
48 #define LINUX_MSG_SYN		0x400
49 #define LINUX_MSG_CONFIRM	0x800
50 #define LINUX_MSG_RST		0x1000
51 #define LINUX_MSG_ERRQUEUE	0x2000
52 #define LINUX_MSG_NOSIGNAL	0x4000
53 #define LINUX_MSG_WAITFORONE	0x10000
54 #define LINUX_MSG_CMSG_CLOEXEC	0x40000000
55 
56 struct l_msghdr {
57 	l_uintptr_t	msg_name;
58 	l_int		msg_namelen;
59 	l_uintptr_t	msg_iov;
60 	l_size_t	msg_iovlen;
61 	l_uintptr_t	msg_control;
62 	l_size_t	msg_controllen;
63 	l_uint		msg_flags;
64 };
65 
66 struct l_mmsghdr {
67 	struct l_msghdr	msg_hdr;
68 	l_uint		msg_len;
69 
70 };
71 
72 struct l_cmsghdr {
73 	l_size_t	cmsg_len;
74 	l_int		cmsg_level;
75 	l_int		cmsg_type;
76 };
77 
78 /* Ancillary data object information macros */
79 
80 #define LINUX_CMSG_ALIGN(len)	roundup2(len, sizeof(l_ulong))
81 #define LINUX_CMSG_DATA(cmsg)	((void *)((char *)(cmsg) + \
82 				    LINUX_CMSG_ALIGN(sizeof(struct l_cmsghdr))))
83 #define LINUX_CMSG_SPACE(len)	(LINUX_CMSG_ALIGN(sizeof(struct l_cmsghdr)) + \
84 				    LINUX_CMSG_ALIGN(len))
85 #define LINUX_CMSG_LEN(len)	(LINUX_CMSG_ALIGN(sizeof(struct l_cmsghdr)) + \
86 				    (len))
87 #define LINUX_CMSG_FIRSTHDR(msg) \
88 				((msg)->msg_controllen >= \
89 				    sizeof(struct l_cmsghdr) ? \
90 				    (struct l_cmsghdr *) \
91 				        PTRIN((msg)->msg_control) : \
92 				    (struct l_cmsghdr *)(NULL))
93 #define LINUX_CMSG_NXTHDR(msg, cmsg) \
94 				((((char *)(cmsg) + \
95 				    LINUX_CMSG_ALIGN((cmsg)->cmsg_len) + \
96 				    sizeof(*(cmsg))) > \
97 				    (((char *)PTRIN((msg)->msg_control)) + \
98 				    (msg)->msg_controllen)) ? \
99 				    (struct l_cmsghdr *) NULL : \
100 				    (struct l_cmsghdr *)((char *)(cmsg) + \
101 				    LINUX_CMSG_ALIGN((cmsg)->cmsg_len)))
102 
103 #define CMSG_HDRSZ		CMSG_LEN(0)
104 #define L_CMSG_HDRSZ		LINUX_CMSG_LEN(0)
105 
106 /* Supported socket types */
107 
108 #define	LINUX_SOCK_STREAM	1
109 #define	LINUX_SOCK_DGRAM	2
110 #define	LINUX_SOCK_RAW		3
111 #define	LINUX_SOCK_RDM		4
112 #define	LINUX_SOCK_SEQPACKET	5
113 
114 #define	LINUX_SOCK_MAX		LINUX_SOCK_SEQPACKET
115 
116 #define	LINUX_SOCK_TYPE_MASK	0xf
117 
118 /* Flags for socket, socketpair, accept4 */
119 
120 #define	LINUX_SOCK_CLOEXEC	LINUX_O_CLOEXEC
121 #define	LINUX_SOCK_NONBLOCK	LINUX_O_NONBLOCK
122 
123 struct l_ucred {
124 	uint32_t	pid;
125 	uint32_t	uid;
126 	uint32_t	gid;
127 };
128 
129 #if defined(__i386__) || defined(__arm__) || \
130     (defined(__amd64__) && defined(COMPAT_LINUX32))
131 
132 struct linux_accept_args {
133 	register_t s;
134 	register_t addr;
135 	register_t namelen;
136 };
137 
138 int linux_accept(struct thread *td, struct linux_accept_args *args);
139 
140 /* Operations for socketcall */
141 #define	LINUX_SOCKET		1
142 #define	LINUX_BIND		2
143 #define	LINUX_CONNECT		3
144 #define	LINUX_LISTEN		4
145 #define	LINUX_ACCEPT		5
146 #define	LINUX_GETSOCKNAME	6
147 #define	LINUX_GETPEERNAME	7
148 #define	LINUX_SOCKETPAIR	8
149 #define	LINUX_SEND		9
150 #define	LINUX_RECV		10
151 #define	LINUX_SENDTO		11
152 #define	LINUX_RECVFROM		12
153 #define	LINUX_SHUTDOWN		13
154 #define	LINUX_SETSOCKOPT	14
155 #define	LINUX_GETSOCKOPT	15
156 #define	LINUX_SENDMSG		16
157 #define	LINUX_RECVMSG		17
158 #define	LINUX_ACCEPT4		18
159 #define	LINUX_RECVMMSG		19
160 #define	LINUX_SENDMMSG		20
161 #define	LINUX_SENDFILE		21
162 
163 #endif /* __i386__ || __arm__ || (__amd64__ && COMPAT_LINUX32) */
164 
165 /* Socket defines */
166 #define	LINUX_SOL_SOCKET	1
167 
168 #define	LINUX_SO_DEBUG		1
169 #define	LINUX_SO_REUSEADDR	2
170 #define	LINUX_SO_TYPE		3
171 #define	LINUX_SO_ERROR		4
172 #define	LINUX_SO_DONTROUTE	5
173 #define	LINUX_SO_BROADCAST	6
174 #define	LINUX_SO_SNDBUF		7
175 #define	LINUX_SO_RCVBUF		8
176 #define	LINUX_SO_KEEPALIVE	9
177 #define	LINUX_SO_OOBINLINE	10
178 #define	LINUX_SO_NO_CHECK	11
179 #define	LINUX_SO_PRIORITY	12
180 #define	LINUX_SO_LINGER		13
181 #define	LINUX_SO_REUSEPORT	15
182 #ifndef LINUX_SO_PASSCRED	/* powerpc differs */
183 #define	LINUX_SO_PASSCRED	16
184 #define	LINUX_SO_PEERCRED	17
185 #define	LINUX_SO_RCVLOWAT	18
186 #define	LINUX_SO_SNDLOWAT	19
187 #define	LINUX_SO_RCVTIMEO	20
188 #define	LINUX_SO_SNDTIMEO	21
189 #endif
190 #define	LINUX_SO_TIMESTAMPO	29
191 #define	LINUX_SO_TIMESTAMPN	63
192 #define	LINUX_SO_TIMESTAMPNSO	35
193 #define	LINUX_SO_TIMESTAMPNSN	64
194 #define	LINUX_SO_ACCEPTCONN	30
195 #define	LINUX_SO_PEERSEC	31
196 #define	LINUX_SO_SNDBUFFORCE	32
197 #define	LINUX_SO_RCVBUFFORCE	33
198 #define	LINUX_SO_PROTOCOL	38
199 #define	LINUX_SO_DOMAIN		39
200 #define	LINUX_SO_PEERGROUPS	59
201 
202 /* Socket-level control message types */
203 
204 #define LINUX_SCM_RIGHTS	0x01
205 #define LINUX_SCM_CREDENTIALS	0x02
206 #define LINUX_SCM_TIMESTAMPO	LINUX_SO_TIMESTAMPO
207 #define LINUX_SCM_TIMESTAMPN	LINUX_SO_TIMESTAMPN
208 #define LINUX_SCM_TIMESTAMPNSO	LINUX_SO_TIMESTAMPNSO
209 #define LINUX_SCM_TIMESTAMPNSN	LINUX_SO_TIMESTAMPNSN
210 
211 /* Socket options */
212 #define	LINUX_IP_TOS		1
213 #define	LINUX_IP_TTL		2
214 #define	LINUX_IP_HDRINCL	3
215 #define	LINUX_IP_OPTIONS	4
216 #define	LINUX_IP_ROUTER_ALERT	5
217 #define	LINUX_IP_RECVOPTS	6
218 #define	LINUX_IP_RETOPTS	7
219 #define	LINUX_IP_PKTINFO	8
220 #define	LINUX_IP_PKTOPTIONS	9
221 #define	LINUX_IP_MTU_DISCOVER	10
222 #define	LINUX_IP_RECVERR	11
223 #define	LINUX_IP_RECVTTL	12
224 #define	LINUX_IP_RECVTOS	13
225 #define	LINUX_IP_MTU		14
226 #define	LINUX_IP_FREEBIND	15
227 #define	LINUX_IP_IPSEC_POLICY	16
228 #define	LINUX_IP_XFRM_POLICY	17
229 #define	LINUX_IP_PASSSEC	18
230 #define	LINUX_IP_TRANSPARENT	19
231 
232 #define	LINUX_IP_ORIGDSTADDR		20
233 #define	LINUX_IP_RECVORIGDSTADDR	LINUX_IP_ORIGDSTADDR
234 #define	LINUX_IP_MINTTL		21
235 #define	LINUX_IP_NODEFRAG	22
236 #define	LINUX_IP_CHECKSUM	23
237 #define	LINUX_IP_BIND_ADDRESS_NO_PORT	24
238 #define	LINUX_IP_RECVFRAGSIZE	25
239 
240 #define	LINUX_IP_MULTICAST_IF		32
241 #define	LINUX_IP_MULTICAST_TTL		33
242 #define	LINUX_IP_MULTICAST_LOOP		34
243 #define	LINUX_IP_ADD_MEMBERSHIP		35
244 #define	LINUX_IP_DROP_MEMBERSHIP	36
245 #define	LINUX_IP_UNBLOCK_SOURCE		37
246 #define	LINUX_IP_BLOCK_SOURCE		38
247 #define	LINUX_IP_ADD_SOURCE_MEMBERSHIP	39
248 #define	LINUX_IP_DROP_SOURCE_MEMBERSHIP	40
249 #define	LINUX_IP_MSFILTER		41
250 
251 #define	LINUX_MCAST_JOIN_GROUP		42
252 #define	LINUX_MCAST_BLOCK_SOURCE	43
253 #define	LINUX_MCAST_UNBLOCK_SOURCE	44
254 #define	LINUX_MCAST_LEAVE_GROUP		45
255 #define	LINUX_MCAST_JOIN_SOURCE_GROUP	46
256 #define	LINUX_MCAST_LEAVE_SOURCE_GROUP	47
257 #define	LINUX_MCAST_MSFILTER		48
258 #define	LINUX_IP_MULTICAST_ALL		49
259 #define	LINUX_IP_UNICAST_IF		50
260 
261 #define	LINUX_IPV6_ADDRFORM		1
262 #define	LINUX_IPV6_2292PKTINFO		2
263 #define	LINUX_IPV6_2292HOPOPTS		3
264 #define	LINUX_IPV6_2292DSTOPTS		4
265 #define	LINUX_IPV6_2292RTHDR		5
266 #define	LINUX_IPV6_2292PKTOPTIONS	6
267 #define	LINUX_IPV6_CHECKSUM		7
268 #define	LINUX_IPV6_2292HOPLIMIT		8
269 #define	LINUX_IPV6_NEXTHOP		9
270 #define	LINUX_IPV6_AUTHHDR		10
271 #define	LINUX_IPV6_FLOWINFO		11
272 
273 #define	LINUX_IPV6_UNICAST_HOPS		16
274 #define	LINUX_IPV6_MULTICAST_IF		17
275 #define	LINUX_IPV6_MULTICAST_HOPS	18
276 #define	LINUX_IPV6_MULTICAST_LOOP	19
277 #define	LINUX_IPV6_ADD_MEMBERSHIP	20
278 #define	LINUX_IPV6_DROP_MEMBERSHIP	21
279 #define	LINUX_IPV6_ROUTER_ALERT		22
280 #define	LINUX_IPV6_MTU_DISCOVER		23
281 #define	LINUX_IPV6_MTU			24
282 #define	LINUX_IPV6_RECVERR		25
283 #define	LINUX_IPV6_V6ONLY		26
284 #define	LINUX_IPV6_JOIN_ANYCAST		27
285 #define	LINUX_IPV6_LEAVE_ANYCAST	28
286 #define	LINUX_IPV6_MULTICAST_ALL	29
287 #define	LINUX_IPV6_ROUTER_ALERT_ISOLATE	30
288 
289 #define	LINUX_IPV6_FLOWLABEL_MGR	32
290 #define	LINUX_IPV6_FLOWINFO_SEND	33
291 
292 #define	LINUX_IPV6_IPSEC_POLICY		34
293 #define	LINUX_IPV6_XFRM_POLICY		35
294 #define	LINUX_IPV6_HDRINCL		36
295 
296 #define	LINUX_IPV6_RECVPKTINFO		49
297 #define	LINUX_IPV6_PKTINFO		50
298 #define	LINUX_IPV6_RECVHOPLIMIT		51
299 #define	LINUX_IPV6_HOPLIMIT		52
300 #define	LINUX_IPV6_RECVHOPOPTS		53
301 #define	LINUX_IPV6_HOPOPTS		54
302 #define	LINUX_IPV6_RTHDRDSTOPTS		55
303 #define	LINUX_IPV6_RECVRTHDR		56
304 #define	LINUX_IPV6_RTHDR		57
305 #define	LINUX_IPV6_RECVDSTOPTS		58
306 #define	LINUX_IPV6_DSTOPTS		59
307 #define	LINUX_IPV6_RECVPATHMTU		60
308 #define	LINUX_IPV6_PATHMTU		61
309 #define	LINUX_IPV6_DONTFRAG		62
310 
311 #define	LINUX_IPV6_AUTOFLOWLABEL	70
312 #define	LINUX_IPV6_ADDR_PREFERENCES	72
313 #define	LINUX_IPV6_MINHOPCOUNT		73
314 #define	LINUX_IPV6_ORIGDSTADDR		74
315 #define	LINUX_IPV6_TRANSPARENT		75
316 #define	LINUX_IPV6_UNICAST_IF		76
317 #define	LINUX_IPV6_RECVFRAGSIZE		77
318 #define	LINUX_IPV6_FREEBIND		78
319 
320 #define	LINUX_TCP_NODELAY	1
321 #define	LINUX_TCP_MAXSEG	2
322 #define	LINUX_TCP_CORK		3
323 #define	LINUX_TCP_KEEPIDLE	4
324 #define	LINUX_TCP_KEEPINTVL	5
325 #define	LINUX_TCP_KEEPCNT	6
326 #define	LINUX_TCP_INFO		11
327 #define	LINUX_TCP_MD5SIG	14
328 
329 struct l_ifmap {
330 	l_ulong		mem_start;
331 	l_ulong		mem_end;
332 	l_ushort	base_addr;
333 	u_char		irq;
334 	u_char		dma;
335 	u_char		port;
336 	/* 3 bytes spare */
337 };
338 
339 /*
340  * Careful changing the declaration of this structure.
341  * To use FreeBSD names to access the struct l_ifreq members the
342  * member names of struct l_ifreq should be equal to the FreeBSD.
343  */
344 struct l_ifreq {
345 	char	ifr_name[LINUX_IFNAMSIZ];
346 	union {
347 		struct l_sockaddr	ifru_addr;
348 		struct l_sockaddr	ifru_dstaddr;
349 		struct l_sockaddr	ifru_broadaddr;
350 		struct l_sockaddr	ifru_netmask;
351 		struct l_sockaddr	ifru_hwaddr;
352 		l_short		ifru_flags[1];
353 		l_int		ifru_index;
354 		l_int		ifru_mtu;
355 		struct l_ifmap	ifru_map;
356 		char		ifru_slave[LINUX_IFNAMSIZ];
357 		char		ifru_newname[LINUX_IFNAMSIZ];
358 		l_uintptr_t	ifru_data;
359 	} ifr_ifru;
360 };
361 
362 /*
363  * Define here members which are not exists in the FreeBSD struct ifreq.
364  */
365 #define	ifr_hwaddr	ifr_ifru.ifru_hwaddr	/* MAC address */
366 
367 #endif /* _LINUX_SOCKET_H_ */
368