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