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