xref: /freebsd-13-stable/sys/compat/linux/linux_util.h (revision 4b40a16f0d188422227478889b38cc341d50f88f)
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  */
34 
35 #ifndef	_LINUX_UTIL_H_
36 #define	_LINUX_UTIL_H_
37 
38 #include <sys/uio.h>
39 
40 extern int linux_debug;
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 struct stat;
110 
111 int	linux_device_register_handler(struct linux_device_handler *h);
112 int	linux_device_unregister_handler(struct linux_device_handler *h);
113 char	*linux_driver_get_name_dev(device_t dev);
114 int	linux_driver_get_major_minor(const char *node, int *major, int *minor);
115 int	linux_vn_get_major_minor(const struct vnode *vn, int *major, int *minor);
116 char	*linux_get_char_devices(void);
117 void	linux_free_get_char_devices(char *string);
118 void	translate_vnhook_major_minor(struct vnode *vp, struct stat *sb);
119 
120 #if defined(KTR)
121 
122 #define	KTR_LINUX				KTR_SUBSYS
123 #define	LINUX_CTRFMT(nm, fmt)	#nm"("fmt")"
124 
125 #define	LINUX_CTR6(f, m, p1, p2, p3, p4, p5, p6) do {			\
126 		CTR6(KTR_LINUX, LINUX_CTRFMT(f, m),			\
127 		    p1, p2, p3, p4, p5, p6);				\
128 } while (0)
129 
130 #define	LINUX_CTR(f)			LINUX_CTR6(f, "", 0, 0, 0, 0, 0, 0)
131 #define	LINUX_CTR0(f, m)		LINUX_CTR6(f, m, 0, 0, 0, 0, 0, 0)
132 #define	LINUX_CTR1(f, m, p1)		LINUX_CTR6(f, m, p1, 0, 0, 0, 0, 0)
133 #define	LINUX_CTR2(f, m, p1, p2)	LINUX_CTR6(f, m, p1, p2, 0, 0, 0, 0)
134 #define	LINUX_CTR3(f, m, p1, p2, p3)	LINUX_CTR6(f, m, p1, p2, p3, 0, 0, 0)
135 #define	LINUX_CTR4(f, m, p1, p2, p3, p4)	LINUX_CTR6(f, m, p1, p2, p3, p4, 0, 0)
136 #define	LINUX_CTR5(f, m, p1, p2, p3, p4, p5)	LINUX_CTR6(f, m, p1, p2, p3, p4, p5, 0)
137 #else
138 #define	LINUX_CTR(f)
139 #define	LINUX_CTR0(f, m)
140 #define	LINUX_CTR1(f, m, p1)
141 #define	LINUX_CTR2(f, m, p1, p2)
142 #define	LINUX_CTR3(f, m, p1, p2, p3)
143 #define	LINUX_CTR4(f, m, p1, p2, p3, p4)
144 #define	LINUX_CTR5(f, m, p1, p2, p3, p4, p5)
145 #define	LINUX_CTR6(f, m, p1, p2, p3, p4, p5, p6)
146 #endif
147 
148 /*
149  * Some macros for rate limiting messages:
150  *  - noisy if compat.linux.debug = 1
151  *  - print only once if compat.linux.debug > 1
152  */
153 #define LINUX_RATELIMIT_MSG_NOTTESTED(_what)			\
154 	do {						\
155 		static int seen = 0;			\
156 							\
157 		if (seen == 0 && linux_debug >= 2) {			\
158 			linux_msg(curthread, "%s is not tested, please report on emulation@FreeBSD.org how it works", _what);	\
159 							\
160 			if (linux_debug < 3)		\
161 				seen = 1;		\
162 		}					\
163 	} while (0)
164 
165 #define LINUX_RATELIMIT_MSG(_message)				\
166 	do {							\
167 		static int seen = 0;				\
168 								\
169 		if (seen == 0) {				\
170 			linux_msg(curthread, _message);		\
171 								\
172 			if (linux_debug < 3)			\
173 				seen = 1;			\
174 		}						\
175 	} while (0)
176 
177 #define LINUX_RATELIMIT_MSG_OPT1(_message, _opt1)	 	\
178 	do {							\
179 		static int seen = 0;				\
180 								\
181 		if (seen == 0) {				\
182 			linux_msg(curthread, _message, _opt1);	\
183 								\
184 			if (linux_debug < 3)			\
185 				seen = 1;			\
186 		}						\
187 	} while (0)
188 
189 #define LINUX_RATELIMIT_MSG_OPT2(_message, _opt1, _opt2)	\
190 	do {							\
191 		static int seen = 0;				\
192 								\
193 		if (seen == 0) {				\
194 			linux_msg(curthread, _message, _opt1, _opt2); \
195 								\
196 			if (linux_debug < 3)			\
197 				seen = 1;			\
198 		}						\
199 	} while (0)
200 
201 #endif /* ! _LINUX_UTIL_H_ */
202