xref: /freebsd/sys/compat/linux/linux_util.h (revision 31e938c5)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1994 Christos Zoulas
5  * Copyright (c) 1995 Frank van der Linden
6  * Copyright (c) 1995 Scott Bartram
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. The name of the author may not be used to endorse or promote products
18  *    derived from this software without specific prior written permission
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  *
31  * from: svr4_util.h,v 1.5 1994/11/18 02:54:31 christos Exp
32  * from: linux_util.h,v 1.2 1995/03/05 23:23:50 fvdl Exp
33  * $FreeBSD$
34  */
35 
36 #ifndef	_LINUX_UTIL_H_
37 #define	_LINUX_UTIL_H_
38 
39 #include <sys/sysent.h>
40 #include <sys/uio.h>
41 
42 MALLOC_DECLARE(M_LINUX);
43 MALLOC_DECLARE(M_EPOLL);
44 
45 extern char linux_emul_path[];
46 extern int linux_use_emul_path;
47 
48 int linux_emul_convpath(const char *, enum uio_seg, char **, int, int);
49 
50 #define LUSECONVPATH(td) atomic_load_int(&linux_use_emul_path)
51 
52 #define LCONVPATH_AT(upath, pathp, i, dfd)				\
53 	do {								\
54 		int _error;						\
55 									\
56 		_error = linux_emul_convpath(upath, UIO_USERSPACE,	\
57 		    pathp, i, dfd);					\
58 		if (*(pathp) == NULL)					\
59 			return (_error);				\
60 	} while (0)
61 
62 #define LCONVPATH(upath, pathp, i)	\
63    LCONVPATH_AT(upath, pathp, i, AT_FDCWD)
64 
65 #define LCONVPATHEXIST(upath, pathp) LCONVPATH(upath, pathp, 0)
66 #define LCONVPATHEXIST_AT(upath, pathp, dfd) LCONVPATH_AT(upath, pathp, 0, dfd)
67 #define LCONVPATHCREAT(upath, pathp) LCONVPATH(upath, pathp, 1)
68 #define LCONVPATHCREAT_AT(upath, pathp, dfd) LCONVPATH_AT(upath, pathp, 1, dfd)
69 #define LFREEPATH(path)	free(path, M_TEMP)
70 
71 #define DUMMY(s)							\
72 LIN_SDT_PROBE_DEFINE0(dummy, s, not_implemented);			\
73 int									\
74 linux_ ## s(struct thread *td, struct linux_ ## s ## _args *args)	\
75 {									\
76 	static pid_t pid;						\
77 									\
78 	if (pid != td->td_proc->p_pid) {				\
79 		linux_msg(td, "syscall %s not implemented", #s);	\
80 		LIN_SDT_PROBE0(dummy, s, not_implemented);		\
81 		pid = td->td_proc->p_pid;				\
82 	};								\
83 									\
84 	return (ENOSYS);						\
85 }									\
86 struct __hack
87 
88 /*
89  * This is for the syscalls that are not even yet implemented in Linux.
90  *
91  * They're marked as UNIMPL in syscall.master so it will
92  * have nosys record in linux_sysent[].
93  */
94 #define UNIMPLEMENTED(s)
95 
96 void linux_msg(const struct thread *td, const char *fmt, ...)
97 	__printflike(2, 3);
98 
99 struct linux_device_handler {
100 	char	*bsd_driver_name;
101 	char	*linux_driver_name;
102 	char	*bsd_device_name;
103 	char	*linux_device_name;
104 	int	linux_major;
105 	int	linux_minor;
106 	int	linux_char_device;
107 };
108 
109 int	linux_device_register_handler(struct linux_device_handler *h);
110 int	linux_device_unregister_handler(struct linux_device_handler *h);
111 char	*linux_driver_get_name_dev(device_t dev);
112 int	linux_driver_get_major_minor(const char *node, int *major, int *minor);
113 int	linux_vn_get_major_minor(const struct vnode *vn, int *major, int *minor);
114 char	*linux_get_char_devices(void);
115 void	linux_free_get_char_devices(char *string);
116 
117 /*
118  * Criteria for interface name translation
119  */
120 #define	IFP_IS_ETH(ifp)		((ifp)->if_type == IFT_ETHER)
121 #define	IFP_IS_LOOP(ifp)	((ifp)->if_type == IFT_LOOP)
122 
123 struct ifnet;
124 bool	linux_use_real_ifname(const struct ifnet *ifp);
125 
126 #if defined(KTR)
127 
128 #define	KTR_LINUX				KTR_SUBSYS
129 #define	LINUX_CTRFMT(nm, fmt)	#nm"("fmt")"
130 
131 #define	LINUX_CTR6(f, m, p1, p2, p3, p4, p5, p6) do {			\
132 		CTR6(KTR_LINUX, LINUX_CTRFMT(f, m),			\
133 		    p1, p2, p3, p4, p5, p6);				\
134 } while (0)
135 
136 #define	LINUX_CTR(f)			LINUX_CTR6(f, "", 0, 0, 0, 0, 0, 0)
137 #define	LINUX_CTR0(f, m)		LINUX_CTR6(f, m, 0, 0, 0, 0, 0, 0)
138 #define	LINUX_CTR1(f, m, p1)		LINUX_CTR6(f, m, p1, 0, 0, 0, 0, 0)
139 #define	LINUX_CTR2(f, m, p1, p2)	LINUX_CTR6(f, m, p1, p2, 0, 0, 0, 0)
140 #define	LINUX_CTR3(f, m, p1, p2, p3)	LINUX_CTR6(f, m, p1, p2, p3, 0, 0, 0)
141 #define	LINUX_CTR4(f, m, p1, p2, p3, p4)	LINUX_CTR6(f, m, p1, p2, p3, p4, 0, 0)
142 #define	LINUX_CTR5(f, m, p1, p2, p3, p4, p5)	LINUX_CTR6(f, m, p1, p2, p3, p4, p5, 0)
143 #else
144 #define	LINUX_CTR(f)
145 #define	LINUX_CTR0(f, m)
146 #define	LINUX_CTR1(f, m, p1)
147 #define	LINUX_CTR2(f, m, p1, p2)
148 #define	LINUX_CTR3(f, m, p1, p2, p3)
149 #define	LINUX_CTR4(f, m, p1, p2, p3, p4)
150 #define	LINUX_CTR5(f, m, p1, p2, p3, p4, p5)
151 #define	LINUX_CTR6(f, m, p1, p2, p3, p4, p5, p6)
152 #endif
153 
154 /*
155  * Some macros for rate limiting messages:
156  *  - noisy if compat.linux.debug = 1
157  *  - print only once if compat.linux.debug > 1
158  */
159 #define LINUX_RATELIMIT_MSG_NOTTESTED(_what)			\
160 	do {						\
161 		static int seen = 0;			\
162 							\
163 		if (seen == 0 && linux_debug >= 2) {			\
164 			linux_msg(curthread, "%s is not tested, please report on emulation@FreeBSD.org how it works", _what);	\
165 							\
166 			if (linux_debug < 3)		\
167 				seen = 1;		\
168 		}					\
169 	} while (0)
170 
171 #define LINUX_RATELIMIT_MSG(_message)				\
172 	do {							\
173 		static int seen = 0;				\
174 								\
175 		if (seen == 0) {				\
176 			linux_msg(curthread, _message);		\
177 								\
178 			if (linux_debug < 3)			\
179 				seen = 1;			\
180 		}						\
181 	} while (0)
182 
183 #define LINUX_RATELIMIT_MSG_OPT1(_message, _opt1)	 	\
184 	do {							\
185 		static int seen = 0;				\
186 								\
187 		if (seen == 0) {				\
188 			linux_msg(curthread, _message, _opt1);	\
189 								\
190 			if (linux_debug < 3)			\
191 				seen = 1;			\
192 		}						\
193 	} while (0)
194 
195 #define LINUX_RATELIMIT_MSG_OPT2(_message, _opt1, _opt2)	\
196 	do {							\
197 		static int seen = 0;				\
198 								\
199 		if (seen == 0) {				\
200 			linux_msg(curthread, _message, _opt1, _opt2); \
201 								\
202 			if (linux_debug < 3)			\
203 				seen = 1;			\
204 		}						\
205 	} while (0)
206 
207 #endif /* ! _LINUX_UTIL_H_ */
208