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 32 #ifndef _SYS_SYSENT_H_ 33 #define _SYS_SYSENT_H_ 34 35 #include <bsm/audit.h> 36 37 struct rlimit; 38 struct sysent; 39 struct thread; 40 struct ksiginfo; 41 struct syscall_args; 42 43 enum systrace_probe_t { 44 SYSTRACE_ENTRY, 45 SYSTRACE_RETURN, 46 }; 47 48 typedef int sy_call_t(struct thread *, void *); 49 50 typedef void (*systrace_probe_func_t)(struct syscall_args *, 51 enum systrace_probe_t, int); 52 typedef void (*systrace_args_func_t)(int, void *, uint64_t *, int *); 53 54 #ifdef _KERNEL 55 extern systrace_probe_func_t systrace_probe_func; 56 extern bool systrace_enabled; 57 58 #ifdef KDTRACE_HOOKS 59 #define SYSTRACE_ENABLED() (systrace_enabled) 60 #else 61 #define SYSTRACE_ENABLED() (0) 62 #endif 63 #endif /* _KERNEL */ 64 65 struct sysent { /* system call table */ 66 sy_call_t *sy_call; /* implementing function */ 67 systrace_args_func_t sy_systrace_args_func; 68 /* optional argument conversion function. */ 69 u_int8_t sy_narg; /* number of arguments */ 70 u_int8_t sy_flags; /* General flags for system calls. */ 71 au_event_t sy_auevent; /* audit event associated with syscall */ 72 u_int32_t sy_entry; /* DTrace entry ID for systrace. */ 73 u_int32_t sy_return; /* DTrace return ID for systrace. */ 74 u_int32_t sy_thrcnt; 75 }; 76 77 /* 78 * A system call is permitted in capability mode. 79 */ 80 #define SYF_CAPENABLED 0x00000001 81 82 #define SY_THR_FLAGMASK 0x7 83 #define SY_THR_STATIC 0x1 84 #define SY_THR_DRAINING 0x2 85 #define SY_THR_ABSENT 0x4 86 #define SY_THR_INCR 0x8 87 88 #ifdef KLD_MODULE 89 #define SY_THR_STATIC_KLD 0 90 #else 91 #define SY_THR_STATIC_KLD SY_THR_STATIC 92 #endif 93 94 struct image_params; 95 struct proc; 96 struct __sigset; 97 struct trapframe; 98 struct vnode; 99 struct note_info_list; 100 101 struct sysentvec { 102 int sv_size; /* number of entries */ 103 struct sysent *sv_table; /* pointer to sysent */ 104 int (*sv_fixup)(uintptr_t *, struct image_params *); 105 /* stack fixup function */ 106 void (*sv_sendsig)(void (*)(int), struct ksiginfo *, struct __sigset *); 107 /* send signal */ 108 const char *sv_sigcode; /* start of sigtramp code */ 109 int *sv_szsigcode; /* size of sigtramp code */ 110 int sv_sigcodeoff; 111 char *sv_name; /* name of binary type */ 112 int (*sv_coredump)(struct thread *, struct vnode *, off_t, int); 113 /* function to dump core, or NULL */ 114 int sv_elf_core_osabi; 115 const char *sv_elf_core_abi_vendor; 116 void (*sv_elf_core_prepare_notes)(struct thread *, 117 struct note_info_list *, size_t *); 118 int (*sv_imgact_try)(struct image_params *); 119 int (*sv_copyout_auxargs)(struct image_params *, 120 uintptr_t); 121 int sv_minsigstksz; /* minimum signal stack size */ 122 vm_offset_t sv_minuser; /* VM_MIN_ADDRESS */ 123 vm_offset_t sv_maxuser; /* VM_MAXUSER_ADDRESS */ 124 vm_offset_t sv_usrstack; /* USRSTACK */ 125 vm_offset_t sv_psstrings; /* PS_STRINGS */ 126 size_t sv_psstringssz; /* PS_STRINGS size */ 127 int sv_stackprot; /* vm protection for stack */ 128 int (*sv_copyout_strings)(struct image_params *, 129 uintptr_t *); 130 void (*sv_setregs)(struct thread *, struct image_params *, 131 uintptr_t); 132 void (*sv_fixlimit)(struct rlimit *, int); 133 u_long *sv_maxssiz; 134 u_int sv_flags; 135 void (*sv_set_syscall_retval)(struct thread *, int); 136 int (*sv_fetch_syscall_args)(struct thread *); 137 const char **sv_syscallnames; 138 vm_offset_t sv_timekeep_base; 139 vm_offset_t sv_shared_page_base; 140 vm_offset_t sv_shared_page_len; 141 vm_offset_t sv_sigcode_base; 142 void *sv_shared_page_obj; 143 vm_offset_t sv_vdso_base; 144 void (*sv_schedtail)(struct thread *); 145 void (*sv_thread_detach)(struct thread *); 146 int (*sv_trap)(struct thread *); 147 u_long *sv_hwcap; /* Value passed in AT_HWCAP. */ 148 u_long *sv_hwcap2; /* Value passed in AT_HWCAP2. */ 149 const char *(*sv_machine_arch)(struct proc *); 150 vm_offset_t sv_fxrng_gen_base; 151 void (*sv_onexec_old)(struct thread *td); 152 int (*sv_onexec)(struct proc *, struct image_params *); 153 void (*sv_onexit)(struct proc *); 154 void (*sv_ontdexit)(struct thread *td); 155 int (*sv_setid_allowed)(struct thread *td, 156 struct image_params *imgp); 157 struct regset **sv_regset_begin; 158 struct regset **sv_regset_end; 159 void (*sv_set_fork_retval)(struct thread *); 160 /* Only used on x86 */ 161 }; 162 163 #define SV_ILP32 0x000100 /* 32-bit executable. */ 164 #define SV_LP64 0x000200 /* 64-bit executable. */ 165 #define SV_IA32 0x004000 /* Intel 32-bit executable. */ 166 #define SV_AOUT 0x008000 /* a.out executable. */ 167 #define SV_SHP 0x010000 /* Shared page. */ 168 #define SV_CAPSICUM 0x020000 /* Force cap_enter() on startup. */ 169 #define SV_TIMEKEEP 0x040000 /* Shared page timehands. */ 170 #define SV_ASLR 0x080000 /* ASLR allowed. */ 171 #define SV_RNG_SEED_VER 0x100000 /* random(4) reseed generation. */ 172 #define SV_SIG_DISCIGN 0x200000 /* Do not discard ignored signals */ 173 #define SV_SIG_WAITNDQ 0x400000 /* Wait does not dequeue SIGCHLD */ 174 #define SV_DSO_SIG 0x800000 /* Signal trampoline packed in dso */ 175 #define SV_SIGSYS 0x1000000 /* SIGSYS for non-existing syscall. NOTE: different value from HEAD */ 176 177 #define SV_ABI_MASK 0xff 178 #define SV_PROC_FLAG(p, x) ((p)->p_sysent->sv_flags & (x)) 179 #define SV_PROC_ABI(p) ((p)->p_sysent->sv_flags & SV_ABI_MASK) 180 #define SV_CURPROC_FLAG(x) SV_PROC_FLAG(curproc, x) 181 #define SV_CURPROC_ABI() SV_PROC_ABI(curproc) 182 /* same as ELFOSABI_XXX, to prevent header pollution */ 183 #define SV_ABI_LINUX 3 184 #define SV_ABI_FREEBSD 9 185 #define SV_ABI_CLOUDABI 17 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 extern struct sysent nosys_sysent; 198 199 #define NO_SYSCALL (-1) 200 201 struct module; 202 203 struct syscall_module_data { 204 int (*chainevh)(struct module *, int, void *); /* next handler */ 205 void *chainarg; /* arg for next event handler */ 206 int *offset; /* offset into sysent */ 207 struct sysent *new_sysent; /* new sysent */ 208 struct sysent old_sysent; /* old sysent */ 209 int flags; /* flags for syscall_register */ 210 }; 211 212 /* separate initialization vector so it can be used in a substructure */ 213 #define SYSENT_INIT_VALS(_syscallname) { \ 214 .sy_narg = (sizeof(struct _syscallname ## _args ) \ 215 / sizeof(register_t)), \ 216 .sy_call = (sy_call_t *)&sys_##_syscallname, \ 217 .sy_auevent = SYS_AUE_##_syscallname, \ 218 .sy_systrace_args_func = NULL, \ 219 .sy_entry = 0, \ 220 .sy_return = 0, \ 221 .sy_flags = 0, \ 222 .sy_thrcnt = 0 \ 223 } 224 225 #define MAKE_SYSENT(syscallname) \ 226 static struct sysent syscallname##_sysent = SYSENT_INIT_VALS(syscallname); 227 228 #define MAKE_SYSENT_COMPAT(syscallname) \ 229 static struct sysent syscallname##_sysent = { \ 230 (sizeof(struct syscallname ## _args ) \ 231 / sizeof(register_t)), \ 232 (sy_call_t *)& syscallname, \ 233 SYS_AUE_##syscallname \ 234 } 235 236 #define SYSCALL_MODULE(name, offset, new_sysent, evh, arg) \ 237 static struct syscall_module_data name##_syscall_mod = { \ 238 evh, arg, offset, new_sysent, { 0, NULL, AUE_NULL } \ 239 }; \ 240 \ 241 static moduledata_t name##_mod = { \ 242 "sys/" #name, \ 243 syscall_module_handler, \ 244 &name##_syscall_mod \ 245 }; \ 246 DECLARE_MODULE(name, name##_mod, SI_SUB_SYSCALLS, SI_ORDER_MIDDLE) 247 248 #define SYSCALL_MODULE_HELPER(syscallname) \ 249 static int syscallname##_syscall = SYS_##syscallname; \ 250 MAKE_SYSENT(syscallname); \ 251 SYSCALL_MODULE(syscallname, \ 252 & syscallname##_syscall, & syscallname##_sysent, \ 253 NULL, NULL) 254 255 #define SYSCALL_MODULE_PRESENT(syscallname) \ 256 (sysent[SYS_##syscallname].sy_call != (sy_call_t *)lkmnosys && \ 257 sysent[SYS_##syscallname].sy_call != (sy_call_t *)lkmressys) 258 259 /* 260 * Syscall registration helpers with resource allocation handling. 261 */ 262 struct syscall_helper_data { 263 struct sysent new_sysent; 264 struct sysent old_sysent; 265 int syscall_no; 266 int registered; 267 }; 268 #define SYSCALL_INIT_HELPER_F(syscallname, flags) { \ 269 .new_sysent = { \ 270 .sy_narg = (sizeof(struct syscallname ## _args ) \ 271 / sizeof(register_t)), \ 272 .sy_call = (sy_call_t *)& sys_ ## syscallname, \ 273 .sy_auevent = SYS_AUE_##syscallname, \ 274 .sy_flags = (flags) \ 275 }, \ 276 .syscall_no = SYS_##syscallname \ 277 } 278 #define SYSCALL_INIT_HELPER_COMPAT_F(syscallname, flags) { \ 279 .new_sysent = { \ 280 .sy_narg = (sizeof(struct syscallname ## _args ) \ 281 / sizeof(register_t)), \ 282 .sy_call = (sy_call_t *)& syscallname, \ 283 .sy_auevent = SYS_AUE_##syscallname, \ 284 .sy_flags = (flags) \ 285 }, \ 286 .syscall_no = SYS_##syscallname \ 287 } 288 #define SYSCALL_INIT_HELPER(syscallname) \ 289 SYSCALL_INIT_HELPER_F(syscallname, 0) 290 #define SYSCALL_INIT_HELPER_COMPAT(syscallname) \ 291 SYSCALL_INIT_HELPER_COMPAT_F(syscallname, 0) 292 #define SYSCALL_INIT_LAST { \ 293 .syscall_no = NO_SYSCALL \ 294 } 295 296 int syscall_module_handler(struct module *mod, int what, void *arg); 297 int syscall_helper_register(struct syscall_helper_data *sd, int flags); 298 int syscall_helper_unregister(struct syscall_helper_data *sd); 299 /* Implementation, exposed for COMPAT code */ 300 int kern_syscall_register(struct sysent *sysents, int *offset, 301 struct sysent *new_sysent, struct sysent *old_sysent, int flags); 302 int kern_syscall_deregister(struct sysent *sysents, int offset, 303 const struct sysent *old_sysent); 304 int kern_syscall_module_handler(struct sysent *sysents, 305 struct module *mod, int what, void *arg); 306 int kern_syscall_helper_register(struct sysent *sysents, 307 struct syscall_helper_data *sd, int flags); 308 int kern_syscall_helper_unregister(struct sysent *sysents, 309 struct syscall_helper_data *sd); 310 311 struct proc; 312 const char *syscallname(struct proc *p, u_int code); 313 314 /* Special purpose system call functions. */ 315 struct nosys_args; 316 317 int lkmnosys(struct thread *, struct nosys_args *); 318 int lkmressys(struct thread *, struct nosys_args *); 319 320 int syscall_thread_enter(struct thread *td, struct sysent **se); 321 void syscall_thread_exit(struct thread *td, struct sysent *se); 322 323 int shared_page_alloc(int size, int align); 324 int shared_page_fill(int size, int align, const void *data); 325 void shared_page_write(int base, int size, const void *data); 326 void exec_sysvec_init(void *param); 327 void exec_sysvec_init_secondary(struct sysentvec *sv, struct sysentvec *sv2); 328 void exec_inittk(void); 329 330 void exit_onexit(struct proc *p); 331 void exec_free_abi_mappings(struct proc *p); 332 void exec_onexec_old(struct thread *td); 333 334 #define INIT_SYSENTVEC(name, sv) \ 335 SYSINIT(name, SI_SUB_EXEC, SI_ORDER_ANY, \ 336 (sysinit_cfunc_t)exec_sysvec_init, sv); 337 338 #endif /* _KERNEL */ 339 340 #endif /* !_SYS_SYSENT_H_ */ 341