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