xref: /freebsd/sys/compat/linux/linux_util.h (revision 0629b152762b06325dd75a41bcb0a2789514141b)
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 <vm/vm.h>
40 #include <vm/vm_param.h>
41 #include <vm/pmap.h>
42 #include <sys/exec.h>
43 #include <sys/sysent.h>
44 #include <sys/syslog.h>
45 #include <sys/cdefs.h>
46 #include <sys/uio.h>
47 
48 MALLOC_DECLARE(M_LINUX);
49 MALLOC_DECLARE(M_EPOLL);
50 MALLOC_DECLARE(M_FUTEX);
51 MALLOC_DECLARE(M_FUTEX_WP);
52 
53 extern const char linux_emul_path[];
54 
55 int linux_emul_convpath(struct thread *, const char *, enum uio_seg, char **, int, int);
56 
57 #define LCONVPATH_AT(td, upath, pathp, i, dfd)				\
58 	do {								\
59 		int _error;						\
60 									\
61 		_error = linux_emul_convpath(td, upath, UIO_USERSPACE,	\
62 		    pathp, i, dfd);					\
63 		if (*(pathp) == NULL)					\
64 			return (_error);				\
65 	} while (0)
66 
67 #define LCONVPATH(td, upath, pathp, i)	\
68    LCONVPATH_AT(td, upath, pathp, i, AT_FDCWD)
69 
70 #define LCONVPATHEXIST(td, upath, pathp) LCONVPATH(td, upath, pathp, 0)
71 #define LCONVPATHEXIST_AT(td, upath, pathp, dfd) LCONVPATH_AT(td, upath, pathp, 0, dfd)
72 #define LCONVPATHCREAT(td, upath, pathp) LCONVPATH(td, upath, pathp, 1)
73 #define LCONVPATHCREAT_AT(td, upath, pathp, dfd) LCONVPATH_AT(td, upath, pathp, 1, dfd)
74 #define LFREEPATH(path)	free(path, M_TEMP)
75 
76 #define DUMMY(s)							\
77 LIN_SDT_PROBE_DEFINE0(dummy, s, entry);					\
78 LIN_SDT_PROBE_DEFINE0(dummy, s, not_implemented);			\
79 LIN_SDT_PROBE_DEFINE1(dummy, s, return, "int");				\
80 int									\
81 linux_ ## s(struct thread *td, struct linux_ ## s ## _args *args)	\
82 {									\
83 	static pid_t pid;						\
84 									\
85 	LIN_SDT_PROBE0(dummy, s, entry);				\
86 									\
87 	if (pid != td->td_proc->p_pid) {				\
88 		linux_msg(td, "syscall %s not implemented", #s);	\
89 		LIN_SDT_PROBE0(dummy, s, not_implemented);		\
90 		pid = td->td_proc->p_pid;				\
91 	};								\
92 									\
93 	LIN_SDT_PROBE1(dummy, s, return, ENOSYS);			\
94 	return (ENOSYS);						\
95 }									\
96 struct __hack
97 
98 /*
99  * This is for the syscalls that are not even yet implemented in Linux.
100  *
101  * They're marked as UNIMPL in syscall.master so it will
102  * have nosys record in linux_sysent[].
103  */
104 #define UNIMPLEMENTED(s)
105 
106 void linux_msg(const struct thread *td, const char *fmt, ...)
107 	__printflike(2, 3);
108 
109 struct linux_device_handler {
110 	char	*bsd_driver_name;
111 	char	*linux_driver_name;
112 	char	*bsd_device_name;
113 	char	*linux_device_name;
114 	int	linux_major;
115 	int	linux_minor;
116 	int	linux_char_device;
117 };
118 
119 int	linux_device_register_handler(struct linux_device_handler *h);
120 int	linux_device_unregister_handler(struct linux_device_handler *h);
121 char	*linux_driver_get_name_dev(device_t dev);
122 int	linux_driver_get_major_minor(const char *node, int *major, int *minor);
123 char	*linux_get_char_devices(void);
124 void	linux_free_get_char_devices(char *string);
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 #endif /* !_LINUX_UTIL_H_ */
155