xref: /freebsd/sys/compat/linux/linux_util.h (revision e32fecd0c2c3ee37c47ee100f169e7eb0282a873)
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/uio.h>
40 
41 MALLOC_DECLARE(M_LINUX);
42 MALLOC_DECLARE(M_EPOLL);
43 
44 extern char linux_emul_path[];
45 extern int linux_use_emul_path;
46 
47 int linux_emul_convpath(const char *, enum uio_seg, char **, int, int);
48 
49 #define LUSECONVPATH(td) atomic_load_int(&linux_use_emul_path)
50 
51 #define LCONVPATH_AT(upath, pathp, i, dfd)				\
52 	do {								\
53 		int _error;						\
54 									\
55 		_error = linux_emul_convpath(upath, UIO_USERSPACE,	\
56 		    pathp, i, dfd);					\
57 		if (*(pathp) == NULL)					\
58 			return (_error);				\
59 	} while (0)
60 
61 #define LCONVPATH(upath, pathp, i)	\
62    LCONVPATH_AT(upath, pathp, i, AT_FDCWD)
63 
64 #define LCONVPATHEXIST(upath, pathp) LCONVPATH(upath, pathp, 0)
65 #define LCONVPATHEXIST_AT(upath, pathp, dfd) LCONVPATH_AT(upath, pathp, 0, dfd)
66 #define LCONVPATHCREAT(upath, pathp) LCONVPATH(upath, pathp, 1)
67 #define LCONVPATHCREAT_AT(upath, pathp, dfd) LCONVPATH_AT(upath, pathp, 1, dfd)
68 #define LFREEPATH(path)	free(path, M_TEMP)
69 
70 #define DUMMY(s)							\
71 LIN_SDT_PROBE_DEFINE0(dummy, s, not_implemented);			\
72 int									\
73 linux_ ## s(struct thread *td, struct linux_ ## s ## _args *args)	\
74 {									\
75 	static pid_t pid;						\
76 									\
77 	if (pid != td->td_proc->p_pid) {				\
78 		linux_msg(td, "syscall %s not implemented", #s);	\
79 		LIN_SDT_PROBE0(dummy, s, not_implemented);		\
80 		pid = td->td_proc->p_pid;				\
81 	};								\
82 									\
83 	return (ENOSYS);						\
84 }									\
85 struct __hack
86 
87 /*
88  * This is for the syscalls that are not even yet implemented in Linux.
89  *
90  * They're marked as UNIMPL in syscall.master so it will
91  * have nosys record in linux_sysent[].
92  */
93 #define UNIMPLEMENTED(s)
94 
95 void linux_msg(const struct thread *td, const char *fmt, ...)
96 	__printflike(2, 3);
97 
98 struct linux_device_handler {
99 	char	*bsd_driver_name;
100 	char	*linux_driver_name;
101 	char	*bsd_device_name;
102 	char	*linux_device_name;
103 	int	linux_major;
104 	int	linux_minor;
105 	int	linux_char_device;
106 };
107 
108 struct stat;
109 
110 int	linux_device_register_handler(struct linux_device_handler *h);
111 int	linux_device_unregister_handler(struct linux_device_handler *h);
112 char	*linux_driver_get_name_dev(device_t dev);
113 int	linux_driver_get_major_minor(const char *node, int *major, int *minor);
114 int	linux_vn_get_major_minor(const struct vnode *vn, int *major, int *minor);
115 char	*linux_get_char_devices(void);
116 void	linux_free_get_char_devices(char *string);
117 void	translate_vnhook_major_minor(struct vnode *vp, struct stat *sb);
118 
119 #if defined(KTR)
120 
121 #define	KTR_LINUX				KTR_SUBSYS
122 #define	LINUX_CTRFMT(nm, fmt)	#nm"("fmt")"
123 
124 #define	LINUX_CTR6(f, m, p1, p2, p3, p4, p5, p6) do {			\
125 		CTR6(KTR_LINUX, LINUX_CTRFMT(f, m),			\
126 		    p1, p2, p3, p4, p5, p6);				\
127 } while (0)
128 
129 #define	LINUX_CTR(f)			LINUX_CTR6(f, "", 0, 0, 0, 0, 0, 0)
130 #define	LINUX_CTR0(f, m)		LINUX_CTR6(f, m, 0, 0, 0, 0, 0, 0)
131 #define	LINUX_CTR1(f, m, p1)		LINUX_CTR6(f, m, p1, 0, 0, 0, 0, 0)
132 #define	LINUX_CTR2(f, m, p1, p2)	LINUX_CTR6(f, m, p1, p2, 0, 0, 0, 0)
133 #define	LINUX_CTR3(f, m, p1, p2, p3)	LINUX_CTR6(f, m, p1, p2, p3, 0, 0, 0)
134 #define	LINUX_CTR4(f, m, p1, p2, p3, p4)	LINUX_CTR6(f, m, p1, p2, p3, p4, 0, 0)
135 #define	LINUX_CTR5(f, m, p1, p2, p3, p4, p5)	LINUX_CTR6(f, m, p1, p2, p3, p4, p5, 0)
136 #else
137 #define	LINUX_CTR(f)
138 #define	LINUX_CTR0(f, m)
139 #define	LINUX_CTR1(f, m, p1)
140 #define	LINUX_CTR2(f, m, p1, p2)
141 #define	LINUX_CTR3(f, m, p1, p2, p3)
142 #define	LINUX_CTR4(f, m, p1, p2, p3, p4)
143 #define	LINUX_CTR5(f, m, p1, p2, p3, p4, p5)
144 #define	LINUX_CTR6(f, m, p1, p2, p3, p4, p5, p6)
145 #endif
146 
147 /*
148  * Some macros for rate limiting messages:
149  *  - noisy if compat.linux.debug = 1
150  *  - print only once if compat.linux.debug > 1
151  */
152 #define LINUX_RATELIMIT_MSG_NOTTESTED(_what)			\
153 	do {						\
154 		static int seen = 0;			\
155 							\
156 		if (seen == 0 && linux_debug >= 2) {			\
157 			linux_msg(curthread, "%s is not tested, please report on emulation@FreeBSD.org how it works", _what);	\
158 							\
159 			if (linux_debug < 3)		\
160 				seen = 1;		\
161 		}					\
162 	} while (0)
163 
164 #define LINUX_RATELIMIT_MSG(_message)				\
165 	do {							\
166 		static int seen = 0;				\
167 								\
168 		if (seen == 0) {				\
169 			linux_msg(curthread, _message);		\
170 								\
171 			if (linux_debug < 3)			\
172 				seen = 1;			\
173 		}						\
174 	} while (0)
175 
176 #define LINUX_RATELIMIT_MSG_OPT1(_message, _opt1)	 	\
177 	do {							\
178 		static int seen = 0;				\
179 								\
180 		if (seen == 0) {				\
181 			linux_msg(curthread, _message, _opt1);	\
182 								\
183 			if (linux_debug < 3)			\
184 				seen = 1;			\
185 		}						\
186 	} while (0)
187 
188 #define LINUX_RATELIMIT_MSG_OPT2(_message, _opt1, _opt2)	\
189 	do {							\
190 		static int seen = 0;				\
191 								\
192 		if (seen == 0) {				\
193 			linux_msg(curthread, _message, _opt1, _opt2); \
194 								\
195 			if (linux_debug < 3)			\
196 				seen = 1;			\
197 		}						\
198 	} while (0)
199 
200 #endif /* ! _LINUX_UTIL_H_ */
201