The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/sysent.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    1 /*-
    2  * SPDX-License-Identifier: BSD-3-Clause
    3  *
    4  * Copyright (c) 1982, 1988, 1991 The Regents of the University of California.
    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. Neither the name of the University nor the names of its contributors
   16  *    may be used to endorse or promote products derived from this software
   17  *    without specific prior written permission.
   18  *
   19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
   20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   29  * SUCH DAMAGE.
   30  *
   31  * $FreeBSD$
   32  */
   33 
   34 #ifndef _SYS_SYSENT_H_
   35 #define _SYS_SYSENT_H_
   36 
   37 #include <bsm/audit.h>
   38 
   39 struct rlimit;
   40 struct sysent;
   41 struct thread;
   42 struct ksiginfo;
   43 struct syscall_args;
   44 
   45 enum systrace_probe_t {
   46         SYSTRACE_ENTRY,
   47         SYSTRACE_RETURN,
   48 };
   49 
   50 typedef int     sy_call_t(struct thread *, void *);
   51 
   52 typedef void    (*systrace_probe_func_t)(struct syscall_args *,
   53                     enum systrace_probe_t, int);
   54 typedef void    (*systrace_args_func_t)(int, void *, uint64_t *, int *);
   55 
   56 #ifdef _KERNEL
   57 extern systrace_probe_func_t    systrace_probe_func;
   58 extern bool                     systrace_enabled;
   59 
   60 #ifdef KDTRACE_HOOKS
   61 #define SYSTRACE_ENABLED()      (systrace_enabled)
   62 #else
   63 #define SYSTRACE_ENABLED()      (0)
   64 #endif
   65 #endif /* _KERNEL */
   66 
   67 struct sysent {                 /* system call table */
   68         sy_call_t *sy_call;     /* implementing function */
   69         systrace_args_func_t sy_systrace_args_func;
   70                                 /* optional argument conversion function. */
   71         u_int8_t sy_narg;       /* number of arguments */
   72         u_int8_t sy_flags;      /* General flags for system calls. */
   73         au_event_t sy_auevent;  /* audit event associated with syscall */
   74         u_int32_t sy_entry;     /* DTrace entry ID for systrace. */
   75         u_int32_t sy_return;    /* DTrace return ID for systrace. */
   76         u_int32_t sy_thrcnt;
   77 };
   78 
   79 /*
   80  * A system call is permitted in capability mode.
   81  */
   82 #define SYF_CAPENABLED  0x00000001
   83 
   84 #define SY_THR_FLAGMASK 0x7
   85 #define SY_THR_STATIC   0x1
   86 #define SY_THR_DRAINING 0x2
   87 #define SY_THR_ABSENT   0x4
   88 #define SY_THR_INCR     0x8
   89 
   90 #ifdef KLD_MODULE
   91 #define SY_THR_STATIC_KLD       0
   92 #else
   93 #define SY_THR_STATIC_KLD       SY_THR_STATIC
   94 #endif
   95 
   96 struct image_params;
   97 struct proc;
   98 struct __sigset;
   99 struct trapframe;
  100 struct vnode;
  101 struct note_info_list;
  102 
  103 struct sysentvec {
  104         int             sv_size;        /* number of entries */
  105         struct sysent   *sv_table;      /* pointer to sysent */
  106         int             (*sv_fixup)(uintptr_t *, struct image_params *);
  107                                         /* stack fixup function */
  108         void            (*sv_sendsig)(void (*)(int), struct ksiginfo *, struct __sigset *);
  109                                         /* send signal */
  110         const char      *sv_sigcode;    /* start of sigtramp code */
  111         int             *sv_szsigcode;  /* size of sigtramp code */
  112         int             sv_sigcodeoff;
  113         char            *sv_name;       /* name of binary type */
  114         int             (*sv_coredump)(struct thread *, struct vnode *, off_t, int);
  115                                         /* function to dump core, or NULL */
  116         int             sv_elf_core_osabi;
  117         const char      *sv_elf_core_abi_vendor;
  118         void            (*sv_elf_core_prepare_notes)(struct thread *,
  119                             struct note_info_list *, size_t *);
  120         int             (*sv_imgact_try)(struct image_params *);
  121         int             (*sv_copyout_auxargs)(struct image_params *,
  122                             uintptr_t);
  123         int             sv_minsigstksz; /* minimum signal stack size */
  124         vm_offset_t     sv_minuser;     /* VM_MIN_ADDRESS */
  125         vm_offset_t     sv_maxuser;     /* VM_MAXUSER_ADDRESS */
  126         vm_offset_t     sv_usrstack;    /* USRSTACK */
  127         vm_offset_t     sv_psstrings;   /* PS_STRINGS */
  128         size_t          sv_psstringssz; /* PS_STRINGS size */
  129         int             sv_stackprot;   /* vm protection for stack */
  130         int             (*sv_copyout_strings)(struct image_params *,
  131                             uintptr_t *);
  132         void            (*sv_setregs)(struct thread *, struct image_params *,
  133                             uintptr_t);
  134         void            (*sv_fixlimit)(struct rlimit *, int);
  135         u_long          *sv_maxssiz;
  136         u_int           sv_flags;
  137         void            (*sv_set_syscall_retval)(struct thread *, int);
  138         int             (*sv_fetch_syscall_args)(struct thread *);
  139         const char      **sv_syscallnames;
  140         vm_offset_t     sv_timekeep_offset;
  141         vm_offset_t     sv_shared_page_base;
  142         vm_offset_t     sv_shared_page_len;
  143         vm_offset_t     sv_sigcode_offset;
  144         void            *sv_shared_page_obj;
  145         vm_offset_t     sv_vdso_offset;
  146         void            (*sv_schedtail)(struct thread *);
  147         void            (*sv_thread_detach)(struct thread *);
  148         int             (*sv_trap)(struct thread *);
  149         u_long          *sv_hwcap;      /* Value passed in AT_HWCAP. */
  150         u_long          *sv_hwcap2;     /* Value passed in AT_HWCAP2. */
  151         const char      *(*sv_machine_arch)(struct proc *);
  152         vm_offset_t     sv_fxrng_gen_offset;
  153         void            (*sv_onexec_old)(struct thread *td);
  154         int             (*sv_onexec)(struct proc *, struct image_params *);
  155         void            (*sv_onexit)(struct proc *);
  156         void            (*sv_ontdexit)(struct thread *td);
  157         int             (*sv_setid_allowed)(struct thread *td,
  158                             struct image_params *imgp);
  159         void            (*sv_set_fork_retval)(struct thread *);
  160                                         /* Only used on x86 */
  161         struct regset   **sv_regset_begin;
  162         struct regset   **sv_regset_end;
  163 };
  164 
  165 #define SV_ILP32        0x000100        /* 32-bit executable. */
  166 #define SV_LP64         0x000200        /* 64-bit executable. */
  167 #define SV_IA32         0x004000        /* Intel 32-bit executable. */
  168 #define SV_AOUT         0x008000        /* a.out executable. */
  169 #define SV_SHP          0x010000        /* Shared page. */
  170 #define SV_AVAIL1       0x020000        /* Unused */
  171 #define SV_TIMEKEEP     0x040000        /* Shared page timehands. */
  172 #define SV_ASLR         0x080000        /* ASLR allowed. */
  173 #define SV_RNG_SEED_VER 0x100000        /* random(4) reseed generation. */
  174 #define SV_SIG_DISCIGN  0x200000        /* Do not discard ignored signals */
  175 #define SV_SIG_WAITNDQ  0x400000        /* Wait does not dequeue SIGCHLD */
  176 #define SV_DSO_SIG      0x800000        /* Signal trampoline packed in dso */
  177 
  178 #define SV_ABI_MASK     0xff
  179 #define SV_PROC_FLAG(p, x)      ((p)->p_sysent->sv_flags & (x))
  180 #define SV_PROC_ABI(p)          ((p)->p_sysent->sv_flags & SV_ABI_MASK)
  181 #define SV_CURPROC_FLAG(x)      SV_PROC_FLAG(curproc, x)
  182 #define SV_CURPROC_ABI()        SV_PROC_ABI(curproc)
  183 /* same as ELFOSABI_XXX, to prevent header pollution */
  184 #define SV_ABI_LINUX    3
  185 #define SV_ABI_FREEBSD  9
  186 #define SV_ABI_UNDEF    255
  187 
  188 /* sv_coredump flags */
  189 #define SVC_PT_COREDUMP 0x00000001      /* dump requested by ptrace(2) */
  190 #define SVC_NOCOMPRESS  0x00000002      /* disable compression. */
  191 #define SVC_ALL         0x00000004      /* dump everything */
  192 
  193 #ifdef _KERNEL
  194 extern struct sysentvec aout_sysvec;
  195 extern struct sysent sysent[];
  196 extern const char *syscallnames[];
  197 
  198 struct nosys_args {
  199         register_t dummy;
  200 };
  201 
  202 int     nosys(struct thread *, struct nosys_args *);
  203 
  204 #define NO_SYSCALL (-1)
  205 
  206 struct module;
  207 
  208 struct syscall_module_data {
  209         int     (*chainevh)(struct module *, int, void *); /* next handler */
  210         void    *chainarg;              /* arg for next event handler */
  211         int     *offset;                /* offset into sysent */
  212         struct sysent *new_sysent;      /* new sysent */
  213         struct sysent old_sysent;       /* old sysent */
  214         int     flags;                  /* flags for syscall_register */
  215 };
  216 
  217 /* separate initialization vector so it can be used in a substructure */
  218 #define SYSENT_INIT_VALS(_syscallname) {                        \
  219         .sy_narg = (sizeof(struct _syscallname ## _args )       \
  220             / sizeof(register_t)),                              \
  221         .sy_call = (sy_call_t *)&sys_##_syscallname,            \
  222         .sy_auevent = SYS_AUE_##_syscallname,                   \
  223         .sy_systrace_args_func = NULL,                          \
  224         .sy_entry = 0,                                          \
  225         .sy_return = 0,                                         \
  226         .sy_flags = 0,                                          \
  227         .sy_thrcnt = 0                                          \
  228 }                                                       
  229 
  230 #define MAKE_SYSENT(syscallname)                                \
  231 static struct sysent syscallname##_sysent = SYSENT_INIT_VALS(syscallname);
  232 
  233 #define MAKE_SYSENT_COMPAT(syscallname)                         \
  234 static struct sysent syscallname##_sysent = {                   \
  235         (sizeof(struct syscallname ## _args )                   \
  236             / sizeof(register_t)),                              \
  237         (sy_call_t *)& syscallname,                             \
  238         SYS_AUE_##syscallname                                   \
  239 }
  240 
  241 #define SYSCALL_MODULE(name, offset, new_sysent, evh, arg)      \
  242 static struct syscall_module_data name##_syscall_mod = {        \
  243         evh, arg, offset, new_sysent, { 0, NULL, AUE_NULL }     \
  244 };                                                              \
  245                                                                 \
  246 static moduledata_t name##_mod = {                              \
  247         "sys/" #name,                                           \
  248         syscall_module_handler,                                 \
  249         &name##_syscall_mod                                     \
  250 };                                                              \
  251 DECLARE_MODULE(name, name##_mod, SI_SUB_SYSCALLS, SI_ORDER_MIDDLE)
  252 
  253 #define SYSCALL_MODULE_HELPER(syscallname)                      \
  254 static int syscallname##_syscall = SYS_##syscallname;           \
  255 MAKE_SYSENT(syscallname);                                       \
  256 SYSCALL_MODULE(syscallname,                                     \
  257     & syscallname##_syscall, & syscallname##_sysent,            \
  258     NULL, NULL)
  259 
  260 #define SYSCALL_MODULE_PRESENT(syscallname)                             \
  261         (sysent[SYS_##syscallname].sy_call != (sy_call_t *)lkmnosys &&  \
  262         sysent[SYS_##syscallname].sy_call != (sy_call_t *)lkmressys)
  263 
  264 /*
  265  * Syscall registration helpers with resource allocation handling.
  266  */
  267 struct syscall_helper_data {
  268         struct sysent new_sysent;
  269         struct sysent old_sysent;
  270         int syscall_no;
  271         int registered;
  272 };
  273 #define SYSCALL_INIT_HELPER_F(syscallname, flags) {             \
  274     .new_sysent = {                                             \
  275         .sy_narg = (sizeof(struct syscallname ## _args )        \
  276             / sizeof(register_t)),                              \
  277         .sy_call = (sy_call_t *)& sys_ ## syscallname,          \
  278         .sy_auevent = SYS_AUE_##syscallname,                    \
  279         .sy_flags = (flags)                                     \
  280     },                                                          \
  281     .syscall_no = SYS_##syscallname                             \
  282 }
  283 #define SYSCALL_INIT_HELPER_COMPAT_F(syscallname, flags) {      \
  284     .new_sysent = {                                             \
  285         .sy_narg = (sizeof(struct syscallname ## _args )        \
  286             / sizeof(register_t)),                              \
  287         .sy_call = (sy_call_t *)& syscallname,                  \
  288         .sy_auevent = SYS_AUE_##syscallname,                    \
  289         .sy_flags = (flags)                                     \
  290     },                                                          \
  291     .syscall_no = SYS_##syscallname                             \
  292 }
  293 #define SYSCALL_INIT_HELPER(syscallname)                        \
  294     SYSCALL_INIT_HELPER_F(syscallname, 0)
  295 #define SYSCALL_INIT_HELPER_COMPAT(syscallname)                 \
  296     SYSCALL_INIT_HELPER_COMPAT_F(syscallname, 0)
  297 #define SYSCALL_INIT_LAST {                                     \
  298     .syscall_no = NO_SYSCALL                                    \
  299 }
  300 
  301 int     syscall_module_handler(struct module *mod, int what, void *arg);
  302 int     syscall_helper_register(struct syscall_helper_data *sd, int flags);
  303 int     syscall_helper_unregister(struct syscall_helper_data *sd);
  304 /* Implementation, exposed for COMPAT code */
  305 int     kern_syscall_register(struct sysent *sysents, int *offset,
  306             struct sysent *new_sysent, struct sysent *old_sysent, int flags);
  307 int     kern_syscall_deregister(struct sysent *sysents, int offset,
  308             const struct sysent *old_sysent);
  309 int     kern_syscall_module_handler(struct sysent *sysents,
  310             struct module *mod, int what, void *arg);
  311 int     kern_syscall_helper_register(struct sysent *sysents,
  312             struct syscall_helper_data *sd, int flags);
  313 int     kern_syscall_helper_unregister(struct sysent *sysents,
  314             struct syscall_helper_data *sd);
  315 
  316 struct proc;
  317 const char *syscallname(struct proc *p, u_int code);
  318 
  319 /* Special purpose system call functions. */
  320 struct nosys_args;
  321 
  322 int     lkmnosys(struct thread *, struct nosys_args *);
  323 int     lkmressys(struct thread *, struct nosys_args *);
  324 
  325 int     syscall_thread_enter(struct thread *td, struct sysent *se);
  326 void    syscall_thread_exit(struct thread *td, struct sysent *se);
  327 
  328 int shared_page_alloc(int size, int align);
  329 int shared_page_fill(int size, int align, const void *data);
  330 void shared_page_write(int base, int size, const void *data);
  331 void exec_sysvec_init(void *param);
  332 void exec_sysvec_init_secondary(struct sysentvec *sv, struct sysentvec *sv2);
  333 void exec_inittk(void);
  334 
  335 void exit_onexit(struct proc *p);
  336 void exec_free_abi_mappings(struct proc *p);
  337 void exec_onexec_old(struct thread *td);
  338 
  339 #define INIT_SYSENTVEC(name, sv)                                        \
  340     SYSINIT(name, SI_SUB_EXEC, SI_ORDER_ANY,                            \
  341         (sysinit_cfunc_t)exec_sysvec_init, sv);
  342 
  343 #endif /* _KERNEL */
  344 
  345 #endif /* !_SYS_SYSENT_H_ */

Cache object: 892ee0db9699bd45356520a3e9864c44


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.