xref: /freebsd/sys/compat/linux/linux_util.h (revision b1f9167f94059fd55c630891d359bcff987bd7eb)
1 /*-
2  * Copyright (c) 1994 Christos Zoulas
3  * Copyright (c) 1995 Frank van der Linden
4  * Copyright (c) 1995 Scott Bartram
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. The name of the author may not be used to endorse or promote products
16  *    derived from this software without specific prior written permission
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  *
29  * from: svr4_util.h,v 1.5 1994/11/18 02:54:31 christos Exp
30  * from: linux_util.h,v 1.2 1995/03/05 23:23:50 fvdl Exp
31  * $FreeBSD$
32  */
33 
34 #ifndef	_LINUX_UTIL_H_
35 #define	_LINUX_UTIL_H_
36 
37 #include <vm/vm.h>
38 #include <vm/vm_param.h>
39 #include <vm/pmap.h>
40 #include <machine/vmparam.h>
41 #include <sys/exec.h>
42 #include <sys/sysent.h>
43 #include <sys/syslog.h>
44 #include <sys/cdefs.h>
45 #include <sys/uio.h>
46 
47 extern const char linux_emul_path[];
48 
49 int linux_emul_convpath(struct thread *, const char *, enum uio_seg, char **, int, int);
50 
51 #define LCONVPATH_AT(td, upath, pathp, i, dfd)				\
52 	do {								\
53 		int _error;						\
54 									\
55 		_error = linux_emul_convpath(td, upath, UIO_USERSPACE,	\
56 		    pathp, i, dfd);					\
57 		if (*(pathp) == NULL)					\
58 			return (_error);				\
59 	} while (0)
60 
61 #define LCONVPATH(td, upath, pathp, i) 	\
62    LCONVPATH_AT(td, upath, pathp, i, AT_FDCWD)
63 
64 #define LCONVPATHEXIST(td, upath, pathp) LCONVPATH(td, upath, pathp, 0)
65 #define LCONVPATHEXIST_AT(td, upath, pathp, dfd) LCONVPATH_AT(td, upath, pathp, 0, dfd)
66 #define LCONVPATHCREAT(td, upath, pathp) LCONVPATH(td, upath, pathp, 1)
67 #define LCONVPATHCREAT_AT(td, upath, pathp, dfd) LCONVPATH_AT(td, upath, pathp, 1, dfd)
68 #define LFREEPATH(path)	free(path, M_TEMP)
69 
70 #define DUMMY(s)							\
71 LIN_SDT_PROBE_DEFINE0(dummy, s, entry);					\
72 LIN_SDT_PROBE_DEFINE0(dummy, s, not_implemented);			\
73 LIN_SDT_PROBE_DEFINE1(dummy, s, return, "int");				\
74 int									\
75 linux_ ## s(struct thread *td, struct linux_ ## s ## _args *args)	\
76 {									\
77 	static pid_t pid;						\
78 									\
79 	LIN_SDT_PROBE0(dummy, s, entry);				\
80 									\
81 	if (pid != td->td_proc->p_pid) {				\
82 		linux_msg(td, "syscall %s not implemented", #s);	\
83 		LIN_SDT_PROBE0(dummy, s, not_implemented);		\
84 		pid = td->td_proc->p_pid;				\
85 	};								\
86 									\
87 	LIN_SDT_PROBE1(dummy, s, return, ENOSYS);			\
88 	return (ENOSYS);						\
89 }									\
90 struct __hack
91 
92 void linux_msg(const struct thread *td, const char *fmt, ...)
93 	__printflike(2, 3);
94 
95 struct linux_device_handler {
96 	char	*bsd_driver_name;
97 	char	*linux_driver_name;
98 	char	*bsd_device_name;
99 	char	*linux_device_name;
100 	int	linux_major;
101 	int	linux_minor;
102 	int	linux_char_device;
103 };
104 
105 int	linux_device_register_handler(struct linux_device_handler *h);
106 int	linux_device_unregister_handler(struct linux_device_handler *h);
107 char	*linux_driver_get_name_dev(device_t dev);
108 int	linux_driver_get_major_minor(const char *node, int *major, int *minor);
109 char	*linux_get_char_devices(void);
110 void	linux_free_get_char_devices(char *string);
111 
112 #if defined(KTR)
113 
114 #define	KTR_LINUX				KTR_SUBSYS
115 #define	LINUX_CTRFMT(nm, fmt)	#nm"("fmt")"
116 
117 #define	LINUX_CTR6(f, m, p1, p2, p3, p4, p5, p6) do {			\
118 	if (ldebug(f))							\
119 		CTR6(KTR_LINUX, LINUX_CTRFMT(f, m),			\
120 		    p1, p2, p3, p4, p5, p6);				\
121 } while (0)
122 
123 #define	LINUX_CTR(f)			LINUX_CTR6(f, "", 0, 0, 0, 0, 0, 0)
124 #define	LINUX_CTR0(f, m)		LINUX_CTR6(f, m, 0, 0, 0, 0, 0, 0)
125 #define	LINUX_CTR1(f, m, p1)		LINUX_CTR6(f, m, p1, 0, 0, 0, 0, 0)
126 #define	LINUX_CTR2(f, m, p1, p2)	LINUX_CTR6(f, m, p1, p2, 0, 0, 0, 0)
127 #define	LINUX_CTR3(f, m, p1, p2, p3)	LINUX_CTR6(f, m, p1, p2, p3, 0, 0, 0)
128 #define	LINUX_CTR4(f, m, p1, p2, p3, p4)	LINUX_CTR6(f, m, p1, p2, p3, p4, 0, 0)
129 #define	LINUX_CTR5(f, m, p1, p2, p3, p4, p5)	LINUX_CTR6(f, m, p1, p2, p3, p4, p5, 0)
130 #else
131 #define	LINUX_CTR(f)
132 #define	LINUX_CTR0(f, m)
133 #define	LINUX_CTR1(f, m, p1)
134 #define	LINUX_CTR2(f, m, p1, p2)
135 #define	LINUX_CTR3(f, m, p1, p2, p3)
136 #define	LINUX_CTR4(f, m, p1, p2, p3, p4)
137 #define	LINUX_CTR5(f, m, p1, p2, p3, p4, p5)
138 #define	LINUX_CTR6(f, m, p1, p2, p3, p4, p5, p6)
139 #endif
140 
141 #endif /* !_LINUX_UTIL_H_ */
142