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