sys/compat/linux/linux_util.h

   1 /*-
   2  * Copyright (c) 1994 Christos Zoulas
   3  * Copyright (c) 1995 Frank van der Linden
   4  * Copyright (c) 1995 Scott Bartram
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. The name of the author may not be used to endorse or promote products
  16  *    derived from this software without specific prior written permission
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  *
  29  * from: svr4_util.h,v 1.5 1994/11/18 02:54:31 christos Exp
  30  * from: linux_util.h,v 1.2 1995/03/05 23:23:50 fvdl Exp
  31  * $FreeBSD$
  32  */
  33
  34 #ifndef _LINUX_UTIL_H_
  35 #define _LINUX_UTIL_H_
  36
  37 #include <vm/vm.h>
  38 #include <vm/vm_param.h>
  39 #include <vm/pmap.h>
  40 #include <sys/exec.h>
  41 #include <sys/sysent.h>
  42 #include <sys/syslog.h>
  43 #include <sys/cdefs.h>
  44 #include <sys/uio.h>
  45
  46 MALLOC_DECLARE(M_LINUX);
  47 MALLOC_DECLARE(M_EPOLL);
  48 MALLOC_DECLARE(M_FUTEX);
  49 MALLOC_DECLARE(M_FUTEX_WP);
  50
  51 extern const char linux_emul_path[];
  52
  53 int linux_emul_convpath(struct thread *, const char *, enum uio_seg, char **, int, int);
  54
  55 #define LCONVPATH_AT(td, upath, pathp, i, dfd)                          \
  56         do {                                                            \
  57                 int _error;                                             \
  58                                                                         \
  59                 _error = linux_emul_convpath(td, upath, UIO_USERSPACE,  \
  60                     pathp, i, dfd);                                     \
  61                 if (*(pathp) == NULL)                                   \
  62                         return (_error);                                \
  63         } while (0)
  64
  65 #define LCONVPATH(td, upath, pathp, i)  \
  66    LCONVPATH_AT(td, upath, pathp, i, AT_FDCWD)
  67
  68 #define LCONVPATHEXIST(td, upath, pathp) LCONVPATH(td, upath, pathp, 0)
  69 #define LCONVPATHEXIST_AT(td, upath, pathp, dfd) LCONVPATH_AT(td, upath, pathp, 0, dfd)
  70 #define LCONVPATHCREAT(td, upath, pathp) LCONVPATH(td, upath, pathp, 1)
  71 #define LCONVPATHCREAT_AT(td, upath, pathp, dfd) LCONVPATH_AT(td, upath, pathp, 1, dfd)
  72 #define LFREEPATH(path) free(path, M_TEMP)
  73
  74 #define DUMMY(s)                                                        \
  75 LIN_SDT_PROBE_DEFINE0(dummy, s, entry);                                 \
  76 LIN_SDT_PROBE_DEFINE0(dummy, s, not_implemented);                       \
  77 LIN_SDT_PROBE_DEFINE1(dummy, s, return, "int");                         \
  78 int                                                                     \
  79 linux_ ## s(struct thread *td, struct linux_ ## s ## _args *args)       \
  80 {                                                                       \
  81         static pid_t pid;                                               \
  82                                                                         \
  83         LIN_SDT_PROBE0(dummy, s, entry);                                \
  84                                                                         \
  85         if (pid != td->td_proc->p_pid) {                                \
  86                 linux_msg(td, "syscall %s not implemented", #s);        \
  87                 LIN_SDT_PROBE0(dummy, s, not_implemented);              \
  88                 pid = td->td_proc->p_pid;                               \
  89         };                                                              \
  90                                                                         \
  91         LIN_SDT_PROBE1(dummy, s, return, ENOSYS);                       \
  92         return (ENOSYS);                                                \
  93 }                                                                       \
  94 struct __hack
  95
  96 /*
  97  * This is for the syscalls that are not even yet implemented in Linux.
  98  *
  99  * They're marked as UNIMPL in syscall.master so it will
 100  * have nosys record in linux_sysent[].
 101  */
 102 #define UNIMPLEMENTED(s)
 103
 104 void linux_msg(const struct thread *td, const char *fmt, ...)
 105         __printflike(2, 3);
 106
 107 struct linux_device_handler {
 108         char    *bsd_driver_name;
 109         char    *linux_driver_name;
 110         char    *bsd_device_name;
 111         char    *linux_device_name;
 112         int     linux_major;
 113         int     linux_minor;
 114         int     linux_char_device;
 115 };
 116
 117 int     linux_device_register_handler(struct linux_device_handler *h);
 118 int     linux_device_unregister_handler(struct linux_device_handler *h);
 119 char    *linux_driver_get_name_dev(device_t dev);
 120 int     linux_driver_get_major_minor(const char *node, int *major, int *minor);
 121 char    *linux_get_char_devices(void);
 122 void    linux_free_get_char_devices(char *string);
 123
 124 #if defined(KTR)
 125
 126 #define KTR_LINUX                               KTR_SUBSYS
 127 #define LINUX_CTRFMT(nm, fmt)   #nm"("fmt")"
 128
 129 #define LINUX_CTR6(f, m, p1, p2, p3, p4, p5, p6) do {                   \
 130                 CTR6(KTR_LINUX, LINUX_CTRFMT(f, m),                     \
 131                     p1, p2, p3, p4, p5, p6);                            \
 132 } while (0)
 133
 134 #define LINUX_CTR(f)                    LINUX_CTR6(f, "", 0, 0, 0, 0, 0, 0)
 135 #define LINUX_CTR0(f, m)                LINUX_CTR6(f, m, 0, 0, 0, 0, 0, 0)
 136 #define LINUX_CTR1(f, m, p1)            LINUX_CTR6(f, m, p1, 0, 0, 0, 0, 0)
 137 #define LINUX_CTR2(f, m, p1, p2)        LINUX_CTR6(f, m, p1, p2, 0, 0, 0, 0)
 138 #define LINUX_CTR3(f, m, p1, p2, p3)    LINUX_CTR6(f, m, p1, p2, p3, 0, 0, 0)
 139 #define LINUX_CTR4(f, m, p1, p2, p3, p4)        LINUX_CTR6(f, m, p1, p2, p3, p4, 0, 0)
 140 #define LINUX_CTR5(f, m, p1, p2, p3, p4, p5)    LINUX_CTR6(f, m, p1, p2, p3, p4, p5, 0)
 141 #else
 142 #define LINUX_CTR(f)
 143 #define LINUX_CTR0(f, m)
 144 #define LINUX_CTR1(f, m, p1)
 145 #define LINUX_CTR2(f, m, p1, p2)
 146 #define LINUX_CTR3(f, m, p1, p2, p3)
 147 #define LINUX_CTR4(f, m, p1, p2, p3, p4)
 148 #define LINUX_CTR5(f, m, p1, p2, p3, p4, p5)
 149 #define LINUX_CTR6(f, m, p1, p2, p3, p4, p5, p6)
 150 #endif
 151
 152 #endif /* !_LINUX_UTIL_H_ */