xref: /freebsd/sys/compat/linux/linux_util.h (revision 6072eea0c375fc3ab0cf5bb494c75d1beac7b8ba)
1898b0535SWarner Losh /*-
27f2d13d6SPedro F. Giffuni  * SPDX-License-Identifier: BSD-3-Clause
37f2d13d6SPedro F. Giffuni  *
4d66a5066SPeter Wemm  * Copyright (c) 1994 Christos Zoulas
5d66a5066SPeter Wemm  * Copyright (c) 1995 Frank van der Linden
6d66a5066SPeter Wemm  * Copyright (c) 1995 Scott Bartram
7d66a5066SPeter Wemm  * All rights reserved.
8d66a5066SPeter Wemm  *
9d66a5066SPeter Wemm  * Redistribution and use in source and binary forms, with or without
10d66a5066SPeter Wemm  * modification, are permitted provided that the following conditions
11d66a5066SPeter Wemm  * are met:
12d66a5066SPeter Wemm  * 1. Redistributions of source code must retain the above copyright
13d66a5066SPeter Wemm  *    notice, this list of conditions and the following disclaimer.
14d66a5066SPeter Wemm  * 2. Redistributions in binary form must reproduce the above copyright
15d66a5066SPeter Wemm  *    notice, this list of conditions and the following disclaimer in the
16d66a5066SPeter Wemm  *    documentation and/or other materials provided with the distribution.
17d66a5066SPeter Wemm  * 3. The name of the author may not be used to endorse or promote products
18d66a5066SPeter Wemm  *    derived from this software without specific prior written permission
19d66a5066SPeter Wemm  *
20d66a5066SPeter Wemm  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21d66a5066SPeter Wemm  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22d66a5066SPeter Wemm  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23d66a5066SPeter Wemm  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24d66a5066SPeter Wemm  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25d66a5066SPeter Wemm  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26d66a5066SPeter Wemm  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27d66a5066SPeter Wemm  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28d66a5066SPeter Wemm  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29d66a5066SPeter Wemm  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30d66a5066SPeter Wemm  *
31d66a5066SPeter Wemm  * from: svr4_util.h,v 1.5 1994/11/18 02:54:31 christos Exp
32d66a5066SPeter Wemm  * from: linux_util.h,v 1.2 1995/03/05 23:23:50 fvdl Exp
33c3aac50fSPeter Wemm  * $FreeBSD$
34d66a5066SPeter Wemm  */
35d66a5066SPeter Wemm 
36d66a5066SPeter Wemm #ifndef	_LINUX_UTIL_H_
37d66a5066SPeter Wemm #define	_LINUX_UTIL_H_
38d66a5066SPeter Wemm 
39ff766321SIan Dowse #include <sys/uio.h>
40d66a5066SPeter Wemm 
4167d39748SDmitry Chagin MALLOC_DECLARE(M_LINUX);
42e16fe1c7SDmitry Chagin MALLOC_DECLARE(M_EPOLL);
4367d39748SDmitry Chagin 
44b5f20658SEdward Tomasz Napierala extern char linux_emul_path[];
45a125ed50SMateusz Guzik extern int linux_use_emul_path;
4643bef515SMarcel Moolenaar 
47af4051d2SMateusz Guzik int linux_emul_convpath(const char *, enum uio_seg, char **, int, int);
48d66a5066SPeter Wemm 
49a125ed50SMateusz Guzik #define LUSECONVPATH(td) atomic_load_int(&linux_use_emul_path)
50a125ed50SMateusz Guzik 
51af4051d2SMateusz Guzik #define LCONVPATH_AT(upath, pathp, i, dfd)				\
52ff766321SIan Dowse 	do {								\
53ff766321SIan Dowse 		int _error;						\
54ff766321SIan Dowse 									\
55af4051d2SMateusz Guzik 		_error = linux_emul_convpath(upath, UIO_USERSPACE,	\
5648b05c3fSKonstantin Belousov 		    pathp, i, dfd);					\
57ff766321SIan Dowse 		if (*(pathp) == NULL)					\
58ff766321SIan Dowse 			return (_error);				\
59ff766321SIan Dowse 	} while (0)
60ff766321SIan Dowse 
61af4051d2SMateusz Guzik #define LCONVPATH(upath, pathp, i)	\
62af4051d2SMateusz Guzik    LCONVPATH_AT(upath, pathp, i, AT_FDCWD)
636734f35eSJulian Elischer 
64af4051d2SMateusz Guzik #define LCONVPATHEXIST(upath, pathp) LCONVPATH(upath, pathp, 0)
65af4051d2SMateusz Guzik #define LCONVPATHEXIST_AT(upath, pathp, dfd) LCONVPATH_AT(upath, pathp, 0, dfd)
66af4051d2SMateusz Guzik #define LCONVPATHCREAT(upath, pathp) LCONVPATH(upath, pathp, 1)
67af4051d2SMateusz Guzik #define LCONVPATHCREAT_AT(upath, pathp, dfd) LCONVPATH_AT(upath, pathp, 1, dfd)
68ff766321SIan Dowse #define LFREEPATH(path)	free(path, M_TEMP)
69ff766321SIan Dowse 
705231fb20SDavid E. O'Brien #define DUMMY(s)							\
7119e252baSAlexander Leidinger LIN_SDT_PROBE_DEFINE0(dummy, s, not_implemented);			\
725231fb20SDavid E. O'Brien int									\
7308de85f5SDavid Malone linux_ ## s(struct thread *td, struct linux_ ## s ## _args *args)	\
745231fb20SDavid E. O'Brien {									\
757a143545SGleb Smirnoff 	static pid_t pid;						\
767a143545SGleb Smirnoff 									\
777a143545SGleb Smirnoff 	if (pid != td->td_proc->p_pid) {				\
787a143545SGleb Smirnoff 		linux_msg(td, "syscall %s not implemented", #s);	\
7919e252baSAlexander Leidinger 		LIN_SDT_PROBE0(dummy, s, not_implemented);		\
807a143545SGleb Smirnoff 		pid = td->td_proc->p_pid;				\
817a143545SGleb Smirnoff 	};								\
8219e252baSAlexander Leidinger 									\
837a143545SGleb Smirnoff 	return (ENOSYS);						\
845231fb20SDavid E. O'Brien }									\
855231fb20SDavid E. O'Brien struct __hack
865231fb20SDavid E. O'Brien 
878049c6bfSMahdi Mokhtari /*
888049c6bfSMahdi Mokhtari  * This is for the syscalls that are not even yet implemented in Linux.
898049c6bfSMahdi Mokhtari  *
908049c6bfSMahdi Mokhtari  * They're marked as UNIMPL in syscall.master so it will
918049c6bfSMahdi Mokhtari  * have nosys record in linux_sysent[].
928049c6bfSMahdi Mokhtari  */
938049c6bfSMahdi Mokhtari #define UNIMPLEMENTED(s)
948049c6bfSMahdi Mokhtari 
95e15583ceSAlfred Perlstein void linux_msg(const struct thread *td, const char *fmt, ...)
96e15583ceSAlfred Perlstein 	__printflike(2, 3);
97e15583ceSAlfred Perlstein 
98060e4882SDoug Ambrisko struct linux_device_handler {
99060e4882SDoug Ambrisko 	char	*bsd_driver_name;
100060e4882SDoug Ambrisko 	char	*linux_driver_name;
101060e4882SDoug Ambrisko 	char	*bsd_device_name;
102060e4882SDoug Ambrisko 	char	*linux_device_name;
103060e4882SDoug Ambrisko 	int	linux_major;
104060e4882SDoug Ambrisko 	int	linux_minor;
105060e4882SDoug Ambrisko 	int	linux_char_device;
106060e4882SDoug Ambrisko };
107060e4882SDoug Ambrisko 
108*6072eea0SDmitry Chagin struct stat;
109*6072eea0SDmitry Chagin 
110060e4882SDoug Ambrisko int	linux_device_register_handler(struct linux_device_handler *h);
111060e4882SDoug Ambrisko int	linux_device_unregister_handler(struct linux_device_handler *h);
112060e4882SDoug Ambrisko char	*linux_driver_get_name_dev(device_t dev);
1137870adb6SEd Schouten int	linux_driver_get_major_minor(const char *node, int *major, int *minor);
1141a34e9faSEdward Tomasz Napierala int	linux_vn_get_major_minor(const struct vnode *vn, int *major, int *minor);
115060e4882SDoug Ambrisko char	*linux_get_char_devices(void);
116060e4882SDoug Ambrisko void	linux_free_get_char_devices(char *string);
117*6072eea0SDmitry Chagin void	translate_vnhook_major_minor(struct vnode *vp, struct stat *sb);
118060e4882SDoug Ambrisko 
1194ec3ea90SDmitry Chagin #if defined(KTR)
1204ec3ea90SDmitry Chagin 
1214ec3ea90SDmitry Chagin #define	KTR_LINUX				KTR_SUBSYS
1224ec3ea90SDmitry Chagin #define	LINUX_CTRFMT(nm, fmt)	#nm"("fmt")"
1234ec3ea90SDmitry Chagin 
1244ec3ea90SDmitry Chagin #define	LINUX_CTR6(f, m, p1, p2, p3, p4, p5, p6) do {			\
1254ec3ea90SDmitry Chagin 		CTR6(KTR_LINUX, LINUX_CTRFMT(f, m),			\
1264ec3ea90SDmitry Chagin 		    p1, p2, p3, p4, p5, p6);				\
1274ec3ea90SDmitry Chagin } while (0)
1284ec3ea90SDmitry Chagin 
1294ec3ea90SDmitry Chagin #define	LINUX_CTR(f)			LINUX_CTR6(f, "", 0, 0, 0, 0, 0, 0)
1304ec3ea90SDmitry Chagin #define	LINUX_CTR0(f, m)		LINUX_CTR6(f, m, 0, 0, 0, 0, 0, 0)
1314ec3ea90SDmitry Chagin #define	LINUX_CTR1(f, m, p1)		LINUX_CTR6(f, m, p1, 0, 0, 0, 0, 0)
1324ec3ea90SDmitry Chagin #define	LINUX_CTR2(f, m, p1, p2)	LINUX_CTR6(f, m, p1, p2, 0, 0, 0, 0)
1334ec3ea90SDmitry Chagin #define	LINUX_CTR3(f, m, p1, p2, p3)	LINUX_CTR6(f, m, p1, p2, p3, 0, 0, 0)
1344ec3ea90SDmitry Chagin #define	LINUX_CTR4(f, m, p1, p2, p3, p4)	LINUX_CTR6(f, m, p1, p2, p3, p4, 0, 0)
1354ec3ea90SDmitry Chagin #define	LINUX_CTR5(f, m, p1, p2, p3, p4, p5)	LINUX_CTR6(f, m, p1, p2, p3, p4, p5, 0)
1364ec3ea90SDmitry Chagin #else
1374ec3ea90SDmitry Chagin #define	LINUX_CTR(f)
1384ec3ea90SDmitry Chagin #define	LINUX_CTR0(f, m)
1394ec3ea90SDmitry Chagin #define	LINUX_CTR1(f, m, p1)
1404ec3ea90SDmitry Chagin #define	LINUX_CTR2(f, m, p1, p2)
1414ec3ea90SDmitry Chagin #define	LINUX_CTR3(f, m, p1, p2, p3)
1424ec3ea90SDmitry Chagin #define	LINUX_CTR4(f, m, p1, p2, p3, p4)
1434ec3ea90SDmitry Chagin #define	LINUX_CTR5(f, m, p1, p2, p3, p4, p5)
1444ec3ea90SDmitry Chagin #define	LINUX_CTR6(f, m, p1, p2, p3, p4, p5, p6)
1454ec3ea90SDmitry Chagin #endif
1464ec3ea90SDmitry Chagin 
1478ec6c4a3SAlexander Leidinger /*
1488ec6c4a3SAlexander Leidinger  * Some macros for rate limiting messages:
1498ec6c4a3SAlexander Leidinger  *  - noisy if compat.linux.debug = 1
1508ec6c4a3SAlexander Leidinger  *  - print only once if compat.linux.debug > 1
1518ec6c4a3SAlexander Leidinger  */
1528ec6c4a3SAlexander Leidinger #define LINUX_RATELIMIT_MSG_NOTTESTED(_what)			\
1538ec6c4a3SAlexander Leidinger 	do {						\
1548ec6c4a3SAlexander Leidinger 		static int seen = 0;			\
1558ec6c4a3SAlexander Leidinger 							\
1568ec6c4a3SAlexander Leidinger 		if (seen == 0 && linux_debug >= 2) {			\
1578ec6c4a3SAlexander Leidinger 			linux_msg(curthread, "%s is not tested, please report on emulation@FreeBSD.org how it works", _what);	\
1588ec6c4a3SAlexander Leidinger 							\
1598ec6c4a3SAlexander Leidinger 			if (linux_debug < 3)		\
1608ec6c4a3SAlexander Leidinger 				seen = 1;		\
1618ec6c4a3SAlexander Leidinger 		}					\
1628ec6c4a3SAlexander Leidinger 	} while (0)
1638ec6c4a3SAlexander Leidinger 
1640d77f6c0SDmitry Chagin #define LINUX_RATELIMIT_MSG(_message)				\
1650d77f6c0SDmitry Chagin 	do {							\
1660d77f6c0SDmitry Chagin 		static int seen = 0;				\
1670d77f6c0SDmitry Chagin 								\
1680d77f6c0SDmitry Chagin 		if (seen == 0) {				\
1690d77f6c0SDmitry Chagin 			linux_msg(curthread, _message);		\
1700d77f6c0SDmitry Chagin 								\
1710d77f6c0SDmitry Chagin 			if (linux_debug < 3)			\
1720d77f6c0SDmitry Chagin 				seen = 1;			\
1730d77f6c0SDmitry Chagin 		}						\
1740d77f6c0SDmitry Chagin 	} while (0)
1750d77f6c0SDmitry Chagin 
1768ec6c4a3SAlexander Leidinger #define LINUX_RATELIMIT_MSG_OPT1(_message, _opt1)	 	\
1778ec6c4a3SAlexander Leidinger 	do {							\
1788ec6c4a3SAlexander Leidinger 		static int seen = 0;				\
1798ec6c4a3SAlexander Leidinger 								\
1808ec6c4a3SAlexander Leidinger 		if (seen == 0) {				\
1818ec6c4a3SAlexander Leidinger 			linux_msg(curthread, _message, _opt1);	\
1828ec6c4a3SAlexander Leidinger 								\
1838ec6c4a3SAlexander Leidinger 			if (linux_debug < 3)			\
1848ec6c4a3SAlexander Leidinger 				seen = 1;			\
1858ec6c4a3SAlexander Leidinger 		}						\
1868ec6c4a3SAlexander Leidinger 	} while (0)
1878ec6c4a3SAlexander Leidinger 
1884f02a4f4SDmitry Chagin #define LINUX_RATELIMIT_MSG_OPT2(_message, _opt1, _opt2)	\
1894f02a4f4SDmitry Chagin 	do {							\
1904f02a4f4SDmitry Chagin 		static int seen = 0;				\
1914f02a4f4SDmitry Chagin 								\
1924f02a4f4SDmitry Chagin 		if (seen == 0) {				\
1934f02a4f4SDmitry Chagin 			linux_msg(curthread, _message, _opt1, _opt2); \
1944f02a4f4SDmitry Chagin 								\
1954f02a4f4SDmitry Chagin 			if (linux_debug < 3)			\
1964f02a4f4SDmitry Chagin 				seen = 1;			\
1974f02a4f4SDmitry Chagin 		}						\
1984f02a4f4SDmitry Chagin 	} while (0)
1994f02a4f4SDmitry Chagin 
200d66a5066SPeter Wemm #endif /* ! _LINUX_UTIL_H_ */
201