xref: /freebsd/sys/compat/linux/linux.h (revision 3a1bf59d195ced99c0f69774969d7090d21f6097)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2015 Dmitry Chagin <dchagin@FreeBSD.org>
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #ifndef _LINUX_MI_H_
29 #define _LINUX_MI_H_
30 
31 typedef uint32_t	l_dev_t;
32 
33 static __inline int
34 linux_decode_major(l_dev_t _dev)
35 {
36 
37 	return ((_dev & 0xfff00) >> 8);
38 }
39 
40 static __inline int
41 linux_decode_minor(l_dev_t _dev)
42 {
43 
44 	return ((_dev & 0xff) | ((_dev & 0xfff00000) >> 12));
45 }
46 
47 static __inline dev_t
48 linux_decode_dev(l_dev_t _dev)
49 {
50 
51 	return (makedev(linux_decode_major(_dev), linux_decode_minor(_dev)));
52 }
53 
54 /*
55  * Private Brandinfo flags
56  */
57 #define	LINUX_BI_FUTEX_REQUEUE	0x01000000
58 
59 /*
60  * poll()
61  */
62 #define	LINUX_POLLIN		0x0001
63 #define	LINUX_POLLPRI		0x0002
64 #define	LINUX_POLLOUT		0x0004
65 #define	LINUX_POLLERR		0x0008
66 #define	LINUX_POLLHUP		0x0010
67 #define	LINUX_POLLNVAL		0x0020
68 #define	LINUX_POLLRDNORM	0x0040
69 #define	LINUX_POLLRDBAND	0x0080
70 #define	LINUX_POLLWRNORM	0x0100
71 #define	LINUX_POLLWRBAND	0x0200
72 #define	LINUX_POLLMSG		0x0400
73 #define	LINUX_POLLREMOVE	0x1000
74 #define	LINUX_POLLRDHUP		0x2000
75 
76 #define	LINUX_IFHWADDRLEN	6
77 #define	LINUX_IFNAMSIZ		16
78 
79 struct l_sockaddr {
80 	unsigned short	sa_family;
81 	char		sa_data[14];
82 };
83 
84 #define	LINUX_ARPHRD_ETHER	1
85 #define	LINUX_ARPHRD_LOOPBACK	772
86 
87 /*
88  * Supported address families
89  */
90 #define	LINUX_AF_UNSPEC		0
91 #define	LINUX_AF_UNIX		1
92 #define	LINUX_AF_INET		2
93 #define	LINUX_AF_AX25		3
94 #define	LINUX_AF_IPX		4
95 #define	LINUX_AF_APPLETALK	5
96 #define	LINUX_AF_INET6		10
97 #define	LINUX_AF_NETLINK	16
98 
99 #define	LINUX_NETLINK_ROUTE		0
100 #define	LINUX_NETLINK_SOCK_DIAG		4
101 #define	LINUX_NETLINK_NFLOG		5
102 #define	LINUX_NETLINK_SELINUX		7
103 #define	LINUX_NETLINK_AUDIT		9
104 #define	LINUX_NETLINK_FIB_LOOKUP	10
105 #define	LINUX_NETLINK_NETFILTER		12
106 #define	LINUX_NETLINK_KOBJECT_UEVENT	15
107 
108 /*
109  * net device flags
110  */
111 #define	LINUX_IFF_UP		0x0001
112 #define	LINUX_IFF_BROADCAST	0x0002
113 #define	LINUX_IFF_DEBUG		0x0004
114 #define	LINUX_IFF_LOOPBACK	0x0008
115 #define	LINUX_IFF_POINTOPOINT	0x0010
116 #define	LINUX_IFF_NOTRAILERS	0x0020
117 #define	LINUX_IFF_RUNNING	0x0040
118 #define	LINUX_IFF_NOARP		0x0080
119 #define	LINUX_IFF_PROMISC	0x0100
120 #define	LINUX_IFF_ALLMULTI	0x0200
121 #define	LINUX_IFF_MASTER	0x0400
122 #define	LINUX_IFF_SLAVE		0x0800
123 #define	LINUX_IFF_MULTICAST	0x1000
124 #define	LINUX_IFF_PORTSEL	0x2000
125 #define	LINUX_IFF_AUTOMEDIA	0x4000
126 #define	LINUX_IFF_DYNAMIC	0x8000
127 /* Volatile (netlink / ifinfomsg); not representable in ifr_flags short */
128 #define	LINUX_IFF_LOWER_UP	0x10000
129 #define	LINUX_IFF_DORMANT	0x20000
130 
131 /* sigaltstack */
132 #define	LINUX_SS_ONSTACK	1
133 #define	LINUX_SS_DISABLE	2
134 
135 int linux_to_bsd_sigaltstack(int lsa);
136 int bsd_to_linux_sigaltstack(int bsa);
137 
138 /* sigset */
139 typedef struct {
140 	uint64_t	__mask;
141 } l_sigset_t;
142 
143 /* primitives to manipulate sigset_t */
144 #define	LINUX_SIGEMPTYSET(set)		(set).__mask = 0
145 #define	LINUX_SIGISMEMBER(set, sig)	(1ULL & ((set).__mask >> _SIG_IDX(sig)))
146 #define	LINUX_SIGADDSET(set, sig)	(set).__mask |= 1ULL << _SIG_IDX(sig)
147 
148 void linux_to_bsd_sigset(l_sigset_t *, sigset_t *);
149 void bsd_to_linux_sigset(sigset_t *, l_sigset_t *);
150 
151 /* signaling */
152 #define	LINUX_SIGHUP		1
153 #define	LINUX_SIGINT		2
154 #define	LINUX_SIGQUIT		3
155 #define	LINUX_SIGILL		4
156 #define	LINUX_SIGTRAP		5
157 #define	LINUX_SIGABRT		6
158 #define	LINUX_SIGIOT		LINUX_SIGABRT
159 #define	LINUX_SIGBUS		7
160 #define	LINUX_SIGFPE		8
161 #define	LINUX_SIGKILL		9
162 #define	LINUX_SIGUSR1		10
163 #define	LINUX_SIGSEGV		11
164 #define	LINUX_SIGUSR2		12
165 #define	LINUX_SIGPIPE		13
166 #define	LINUX_SIGALRM		14
167 #define	LINUX_SIGTERM		15
168 #define	LINUX_SIGSTKFLT		16
169 #define	LINUX_SIGCHLD		17
170 #define	LINUX_SIGCONT		18
171 #define	LINUX_SIGSTOP		19
172 #define	LINUX_SIGTSTP		20
173 #define	LINUX_SIGTTIN		21
174 #define	LINUX_SIGTTOU		22
175 #define	LINUX_SIGURG		23
176 #define	LINUX_SIGXCPU		24
177 #define	LINUX_SIGXFSZ		25
178 #define	LINUX_SIGVTALRM		26
179 #define	LINUX_SIGPROF		27
180 #define	LINUX_SIGWINCH		28
181 #define	LINUX_SIGIO		29
182 #define	LINUX_SIGPOLL		LINUX_SIGIO
183 #define	LINUX_SIGPWR		30
184 #define	LINUX_SIGSYS		31
185 #define	LINUX_SIGTBLSZ		31
186 #define	LINUX_SIGRTMIN		32
187 #define	LINUX_SIGRTMAX		64
188 
189 #define LINUX_SIG_VALID(sig)	((sig) <= LINUX_SIGRTMAX && (sig) > 0)
190 
191 int linux_to_bsd_signal(int sig);
192 int bsd_to_linux_signal(int sig);
193 
194 /* sigprocmask actions */
195 #define	LINUX_SIG_BLOCK		0
196 #define	LINUX_SIG_UNBLOCK	1
197 #define	LINUX_SIG_SETMASK	2
198 
199 void linux_dev_shm_create(void);
200 void linux_dev_shm_destroy(void);
201 
202 /*
203  * mask=0 is not sensible for this application, so it will be taken to mean
204  * a mask equivalent to the value.  Otherwise, (word & mask) == value maps to
205  * (word & ~mask) | value in a bitfield for the platform we're converting to.
206  */
207 struct bsd_to_linux_bitmap {
208 	int	bsd_mask;
209 	int	bsd_value;
210 	int	linux_mask;
211 	int	linux_value;
212 };
213 
214 int bsd_to_linux_bits_(int value, struct bsd_to_linux_bitmap *bitmap,
215     size_t mapcnt, int no_value);
216 int linux_to_bsd_bits_(int value, struct bsd_to_linux_bitmap *bitmap,
217     size_t mapcnt, int no_value);
218 
219 /*
220  * These functions are used for simplification of BSD <-> Linux bit conversions.
221  * Given `value`, a bit field, these functions will walk the given bitmap table
222  * and set the appropriate bits for the target platform.  If any bits were
223  * successfully converted, then the return value is the equivalent of value
224  * represented with the bit values appropriate for the target platform.
225  * Otherwise, the value supplied as `no_value` is returned.
226  */
227 #define	bsd_to_linux_bits(_val, _bmap, _noval) \
228     bsd_to_linux_bits_((_val), (_bmap), nitems((_bmap)), (_noval))
229 #define	linux_to_bsd_bits(_val, _bmap, _noval) \
230     linux_to_bsd_bits_((_val), (_bmap), nitems((_bmap)), (_noval))
231 
232 /*
233  * Easy mapping helpers.  BITMAP_EASY_LINUX represents a single bit to be
234  * translated, and the FreeBSD and Linux values are supplied.  BITMAP_1t1_LINUX
235  * is the extreme version of this, where not only is it a single bit, but the
236  * name of the macro used to represent the Linux version of a bit literally has
237  * LINUX_ prepended to the normal name.
238  */
239 #define	BITMAP_EASY_LINUX(_name, _linux_name)	\
240 	{					\
241 		.bsd_value = (_name),		\
242 		.linux_value = (_linux_name),	\
243 	}
244 #define	BITMAP_1t1_LINUX(_name)	BITMAP_EASY_LINUX(_name, LINUX_##_name)
245 
246 int bsd_to_linux_errno(int error);
247 void linux_check_errtbl(void);
248 
249 #define STATX_BASIC_STATS		0x07ff
250 #define STATX_BTIME			0x0800
251 #define STATX_ALL			0x0fff
252 
253 #define STATX_ATTR_COMPRESSED		0x0004
254 #define STATX_ATTR_IMMUTABLE		0x0010
255 #define STATX_ATTR_APPEND		0x0020
256 #define STATX_ATTR_NODUMP		0x0040
257 #define STATX_ATTR_ENCRYPTED		0x0800
258 #define STATX_ATTR_AUTOMOUNT		0x1000
259 
260 struct l_statx_timestamp {
261 	int64_t tv_sec;
262 	int32_t tv_nsec;
263 	int32_t __spare0;
264 };
265 
266 struct l_statx {
267 	uint32_t stx_mask;
268 	uint32_t stx_blksize;
269 	uint64_t stx_attributes;
270 	uint32_t stx_nlink;
271 	uint32_t stx_uid;
272 	uint32_t stx_gid;
273 	uint16_t stx_mode;
274 	uint16_t __spare0[1];
275 	uint64_t stx_ino;
276 	uint64_t stx_size;
277 	uint64_t stx_blocks;
278 	uint64_t stx_attributes_mask;
279 	struct l_statx_timestamp stx_atime;
280 	struct l_statx_timestamp stx_btime;
281 	struct l_statx_timestamp stx_ctime;
282 	struct l_statx_timestamp stx_mtime;
283 	uint32_t stx_rdev_major;
284 	uint32_t stx_rdev_minor;
285 	uint32_t stx_dev_major;
286 	uint32_t stx_dev_minor;
287 	uint64_t stx_mnt_id;
288 	uint64_t __spare2[13];
289 };
290 
291 /*
292  * statfs f_flags
293  */
294 #define	LINUX_ST_RDONLY			0x0001
295 #define	LINUX_ST_NOSUID			0x0002
296 #define	LINUX_ST_NODEV			0x0004	/* No native analogue */
297 #define	LINUX_ST_NOEXEC			0x0008
298 #define	LINUX_ST_SYNCHRONOUS		0x0010
299 #define	LINUX_ST_VALID			0x0020
300 #define	LINUX_ST_MANDLOCK		0x0040	/* No native analogue */
301 #define	LINUX_ST_NOATIME		0x0400
302 #define	LINUX_ST_NODIRATIME		0x0800	/* No native analogue */
303 #define	LINUX_ST_RELATIME		0x1000	/* No native analogue */
304 #define	LINUX_ST_NOSYMFOLLOW		0x2000
305 
306 #ifndef lower_32_bits
307 #define	lower_32_bits(n)	((uint32_t)((n) & 0xffffffff))
308 #endif
309 
310 #ifdef KTRACE
311 #define	linux_ktrsigset(s, l)	\
312 	ktrstruct("l_sigset_t", (s), l)
313 #endif
314 
315 void linux_ifnet_init(void);
316 void linux_ifnet_uninit(void);
317 void linux_netlink_register(void);
318 void linux_netlink_deregister(void);
319 
320 #endif /* _LINUX_MI_H_ */
321