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