sys/compat/linux/linux_util.h

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