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