xref: /freebsd/sys/compat/linux/linux.h (revision 97ce5033a8607d79a77fbcba6aafee790dc7bf26)
1 /*-
2  * Copyright (c) 2015 Dmitry Chagin
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #ifndef _LINUX_MI_H_
30 #define _LINUX_MI_H_
31 
32 #include <sys/queue.h>
33 
34 #define	LINUX_IFHWADDRLEN	6
35 #define	LINUX_IFNAMSIZ		16
36 
37 /*
38  * Criteria for interface name translation
39  */
40 #define	IFP_IS_ETH(ifp)		(ifp->if_type == IFT_ETHER)
41 #define	IFP_IS_LOOP(ifp)	(ifp->if_type == IFT_LOOP)
42 
43 struct l_sockaddr {
44 	unsigned short	sa_family;
45 	char		sa_data[14];
46 };
47 
48 #define	LINUX_ARPHRD_ETHER	1
49 #define	LINUX_ARPHRD_LOOPBACK	772
50 
51 /*
52  * Supported address families
53  */
54 #define	LINUX_AF_UNSPEC		0
55 #define	LINUX_AF_UNIX		1
56 #define	LINUX_AF_INET		2
57 #define	LINUX_AF_AX25		3
58 #define	LINUX_AF_IPX		4
59 #define	LINUX_AF_APPLETALK	5
60 #define	LINUX_AF_INET6		10
61 
62 /*
63  * net device flags
64  */
65 #define	LINUX_IFF_UP		0x0001
66 #define	LINUX_IFF_BROADCAST	0x0002
67 #define	LINUX_IFF_DEBUG		0x0004
68 #define	LINUX_IFF_LOOPBACK	0x0008
69 #define	LINUX_IFF_POINTOPOINT	0x0010
70 #define	LINUX_IFF_NOTRAILERS	0x0020
71 #define	LINUX_IFF_RUNNING	0x0040
72 #define	LINUX_IFF_NOARP		0x0080
73 #define	LINUX_IFF_PROMISC	0x0100
74 #define	LINUX_IFF_ALLMULTI	0x0200
75 #define	LINUX_IFF_MASTER	0x0400
76 #define	LINUX_IFF_SLAVE		0x0800
77 #define	LINUX_IFF_MULTICAST	0x1000
78 #define	LINUX_IFF_PORTSEL	0x2000
79 #define	LINUX_IFF_AUTOMEDIA	0x4000
80 #define	LINUX_IFF_DYNAMIC	0x8000
81 
82 /* sigaltstack */
83 #define	LINUX_SS_ONSTACK	1
84 #define	LINUX_SS_DISABLE	2
85 
86 int linux_to_bsd_sigaltstack(int lsa);
87 int bsd_to_linux_sigaltstack(int bsa);
88 
89 /* sigset */
90 typedef struct {
91 	uint64_t	__mask;
92 } l_sigset_t;
93 
94 /* primitives to manipulate sigset_t */
95 #define	LINUX_SIGEMPTYSET(set)		(set).__mask = 0
96 #define	LINUX_SIGISMEMBER(set, sig)	(1UL & ((set).__mask >> _SIG_IDX(sig)))
97 #define	LINUX_SIGADDSET(set, sig)	(set).__mask |= 1UL << _SIG_IDX(sig)
98 
99 void linux_to_bsd_sigset(l_sigset_t *, sigset_t *);
100 void bsd_to_linux_sigset(sigset_t *, l_sigset_t *);
101 
102 /* signaling */
103 #define	LINUX_SIGHUP		1
104 #define	LINUX_SIGINT		2
105 #define	LINUX_SIGQUIT		3
106 #define	LINUX_SIGILL		4
107 #define	LINUX_SIGTRAP		5
108 #define	LINUX_SIGABRT		6
109 #define	LINUX_SIGIOT		LINUX_SIGABRT
110 #define	LINUX_SIGBUS		7
111 #define	LINUX_SIGFPE		8
112 #define	LINUX_SIGKILL		9
113 #define	LINUX_SIGUSR1		10
114 #define	LINUX_SIGSEGV		11
115 #define	LINUX_SIGUSR2		12
116 #define	LINUX_SIGPIPE		13
117 #define	LINUX_SIGALRM		14
118 #define	LINUX_SIGTERM		15
119 #define	LINUX_SIGSTKFLT		16
120 #define	LINUX_SIGCHLD		17
121 #define	LINUX_SIGCONT		18
122 #define	LINUX_SIGSTOP		19
123 #define	LINUX_SIGTSTP		20
124 #define	LINUX_SIGTTIN		21
125 #define	LINUX_SIGTTOU		22
126 #define	LINUX_SIGURG		23
127 #define	LINUX_SIGXCPU		24
128 #define	LINUX_SIGXFSZ		25
129 #define	LINUX_SIGVTALRM		26
130 #define	LINUX_SIGPROF		27
131 #define	LINUX_SIGWINCH		28
132 #define	LINUX_SIGIO		29
133 #define	LINUX_SIGPOLL		LINUX_SIGIO
134 #define	LINUX_SIGPWR		30
135 #define	LINUX_SIGSYS		31
136 #define	LINUX_SIGTBLSZ		31
137 #define	LINUX_SIGRTMIN		32
138 #define	LINUX_SIGRTMAX		64
139 
140 #define LINUX_SIG_VALID(sig)	((sig) <= LINUX_SIGRTMAX && (sig) > 0)
141 
142 int linux_to_bsd_signal(int sig);
143 int bsd_to_linux_signal(int sig);
144 
145 extern LIST_HEAD(futex_list, futex) futex_list;
146 extern struct mtx futex_mtx;
147 
148 void linux_dev_shm_create(void);
149 void linux_dev_shm_destroy(void);
150 
151 /*
152  * mask=0 is not sensible for this application, so it will be taken to mean
153  * a mask equivalent to the value.  Otherwise, (word & mask) == value maps to
154  * (word & ~mask) | value in a bitfield for the platform we're converting to.
155  */
156 struct bsd_to_linux_bitmap {
157 	int	bsd_mask;
158 	int	bsd_value;
159 	int	linux_mask;
160 	int	linux_value;
161 };
162 
163 int bsd_to_linux_bits_(int value, struct bsd_to_linux_bitmap *bitmap,
164     size_t mapcnt, int no_value);
165 int linux_to_bsd_bits_(int value, struct bsd_to_linux_bitmap *bitmap,
166     size_t mapcnt, int no_value);
167 
168 /*
169  * These functions are used for simplification of BSD <-> Linux bit conversions.
170  * Given `value`, a bit field, these functions will walk the given bitmap table
171  * and set the appropriate bits for the target platform.  If any bits were
172  * successfully converted, then the return value is the equivalent of value
173  * represented with the bit values appropriate for the target platform.
174  * Otherwise, the value supplied as `no_value` is returned.
175  */
176 #define	bsd_to_linux_bits(_val, _bmap, _noval) \
177     bsd_to_linux_bits_((_val), (_bmap), nitems((_bmap)), (_noval))
178 #define	linux_to_bsd_bits(_val, _bmap, _noval) \
179     linux_to_bsd_bits_((_val), (_bmap), nitems((_bmap)), (_noval))
180 
181 /*
182  * Easy mapping helpers.  BITMAP_EASY_LINUX represents a single bit to be
183  * translated, and the FreeBSD and Linux values are supplied.  BITMAP_1t1_LINUX
184  * is the extreme version of this, where not only is it a single bit, but the
185  * name of the macro used to represent the Linux version of a bit literally has
186  * LINUX_ prepended to the normal name.
187  */
188 #define	BITMAP_EASY_LINUX(_name, _linux_name)	\
189 	{					\
190 		.bsd_value = (_name),		\
191 		.linux_value = (_linux_name),	\
192 	}
193 #define	BITMAP_1t1_LINUX(_name)	BITMAP_EASY_LINUX(_name, LINUX_##_name)
194 
195 #endif /* _LINUX_MI_H_ */
196