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