2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1982, 1988, 1991 The Regents of the University of California.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
34 #ifndef _SYS_SYSENT_H_
35 #define _SYS_SYSENT_H_
37 #include <bsm/audit.h>
45 enum systrace_probe_t {
50 typedef int sy_call_t(struct thread *, void *);
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 *);
57 extern systrace_probe_func_t systrace_probe_func;
58 extern bool systrace_enabled;
61 #define SYSTRACE_ENABLED() (systrace_enabled)
63 #define SYSTRACE_ENABLED() (0)
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. */
80 * A system call is permitted in capability mode.
82 #define SYF_CAPENABLED 0x00000001
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
91 #define SY_THR_STATIC_KLD 0
93 #define SY_THR_STATIC_KLD SY_THR_STATIC
103 int sv_size; /* number of entries */
104 struct sysent *sv_table; /* pointer to sysent */
105 int (*sv_transtrap)(int, int);
106 /* translate trap-to-signal mapping */
107 int (*sv_fixup)(uintptr_t *, struct image_params *);
108 /* stack fixup function */
109 void (*sv_sendsig)(void (*)(int), struct ksiginfo *, struct __sigset *);
111 const char *sv_sigcode; /* start of sigtramp code */
112 int *sv_szsigcode; /* size of sigtramp code */
114 char *sv_name; /* name of binary type */
115 int (*sv_coredump)(struct thread *, struct vnode *, off_t, int);
116 /* function to dump core, or NULL */
117 int (*sv_imgact_try)(struct image_params *);
118 int (*sv_copyout_auxargs)(struct image_params *,
120 int sv_minsigstksz; /* minimum signal stack size */
121 vm_offset_t sv_minuser; /* VM_MIN_ADDRESS */
122 vm_offset_t sv_maxuser; /* VM_MAXUSER_ADDRESS */
123 vm_offset_t sv_usrstack; /* USRSTACK */
124 vm_offset_t sv_psstrings; /* PS_STRINGS */
125 size_t sv_psstringssz; /* PS_STRINGS size */
126 int sv_stackprot; /* vm protection for stack */
127 int (*sv_copyout_strings)(struct image_params *,
129 void (*sv_setregs)(struct thread *, struct image_params *,
131 void (*sv_fixlimit)(struct rlimit *, int);
134 void (*sv_set_syscall_retval)(struct thread *, int);
135 int (*sv_fetch_syscall_args)(struct thread *);
136 const char **sv_syscallnames;
137 vm_offset_t sv_timekeep_base;
138 vm_offset_t sv_shared_page_base;
139 vm_offset_t sv_shared_page_len;
140 vm_offset_t sv_sigcode_base;
141 void *sv_shared_page_obj;
142 vm_offset_t sv_vdso_base;
143 void (*sv_schedtail)(struct thread *);
144 void (*sv_thread_detach)(struct thread *);
145 int (*sv_trap)(struct thread *);
146 u_long *sv_hwcap; /* Value passed in AT_HWCAP. */
147 u_long *sv_hwcap2; /* Value passed in AT_HWCAP2. */
148 const char *(*sv_machine_arch)(struct proc *);
149 vm_offset_t sv_fxrng_gen_base;
150 void (*sv_onexec_old)(struct thread *td);
151 void (*sv_onexec)(struct proc *, struct image_params *);
152 void (*sv_onexit)(struct proc *);
153 void (*sv_ontdexit)(struct thread *td);
154 int (*sv_setid_allowed)(struct thread *td,
155 struct image_params *imgp);
158 #define SV_ILP32 0x000100 /* 32-bit executable. */
159 #define SV_LP64 0x000200 /* 64-bit executable. */
160 #define SV_IA32 0x004000 /* Intel 32-bit executable. */
161 #define SV_AOUT 0x008000 /* a.out executable. */
162 #define SV_SHP 0x010000 /* Shared page. */
163 #define SV_CAPSICUM 0x020000 /* Force cap_enter() on startup. */
164 #define SV_TIMEKEEP 0x040000 /* Shared page timehands. */
165 #define SV_ASLR 0x080000 /* ASLR allowed. */
166 #define SV_RNG_SEED_VER 0x100000 /* random(4) reseed generation. */
167 #define SV_SIG_DISCIGN 0x200000 /* Do not discard ignored signals */
168 #define SV_SIG_WAITNDQ 0x400000 /* Wait does not dequeue SIGCHLD */
169 #define SV_DSO_SIG 0x800000 /* Signal trampoline packed in dso */
171 #define SV_ABI_MASK 0xff
172 #define SV_PROC_FLAG(p, x) ((p)->p_sysent->sv_flags & (x))
173 #define SV_PROC_ABI(p) ((p)->p_sysent->sv_flags & SV_ABI_MASK)
174 #define SV_CURPROC_FLAG(x) SV_PROC_FLAG(curproc, x)
175 #define SV_CURPROC_ABI() SV_PROC_ABI(curproc)
176 /* same as ELFOSABI_XXX, to prevent header pollution */
177 #define SV_ABI_LINUX 3
178 #define SV_ABI_FREEBSD 9
179 #define SV_ABI_CLOUDABI 17
180 #define SV_ABI_UNDEF 255
182 /* sv_coredump flags */
183 #define SVC_PT_COREDUMP 0x00000001 /* dump requested by ptrace(2) */
184 #define SVC_NOCOMPRESS 0x00000002 /* disable compression. */
185 #define SVC_ALL 0x00000004 /* dump everything */
188 extern struct sysentvec aout_sysvec;
189 extern struct sysent sysent[];
190 extern const char *syscallnames[];
192 #define NO_SYSCALL (-1)
196 struct syscall_module_data {
197 int (*chainevh)(struct module *, int, void *); /* next handler */
198 void *chainarg; /* arg for next event handler */
199 int *offset; /* offset into sysent */
200 struct sysent *new_sysent; /* new sysent */
201 struct sysent old_sysent; /* old sysent */
202 int flags; /* flags for syscall_register */
205 /* separate initialization vector so it can be used in a substructure */
206 #define SYSENT_INIT_VALS(_syscallname) { \
207 .sy_narg = (sizeof(struct _syscallname ## _args ) \
208 / sizeof(register_t)), \
209 .sy_call = (sy_call_t *)&sys_##_syscallname, \
210 .sy_auevent = SYS_AUE_##_syscallname, \
211 .sy_systrace_args_func = NULL, \
218 #define MAKE_SYSENT(syscallname) \
219 static struct sysent syscallname##_sysent = SYSENT_INIT_VALS(syscallname);
221 #define MAKE_SYSENT_COMPAT(syscallname) \
222 static struct sysent syscallname##_sysent = { \
223 (sizeof(struct syscallname ## _args ) \
224 / sizeof(register_t)), \
225 (sy_call_t *)& syscallname, \
226 SYS_AUE_##syscallname \
229 #define SYSCALL_MODULE(name, offset, new_sysent, evh, arg) \
230 static struct syscall_module_data name##_syscall_mod = { \
231 evh, arg, offset, new_sysent, { 0, NULL, AUE_NULL } \
234 static moduledata_t name##_mod = { \
236 syscall_module_handler, \
237 &name##_syscall_mod \
239 DECLARE_MODULE(name, name##_mod, SI_SUB_SYSCALLS, SI_ORDER_MIDDLE)
241 #define SYSCALL_MODULE_HELPER(syscallname) \
242 static int syscallname##_syscall = SYS_##syscallname; \
243 MAKE_SYSENT(syscallname); \
244 SYSCALL_MODULE(syscallname, \
245 & syscallname##_syscall, & syscallname##_sysent, \
248 #define SYSCALL_MODULE_PRESENT(syscallname) \
249 (sysent[SYS_##syscallname].sy_call != (sy_call_t *)lkmnosys && \
250 sysent[SYS_##syscallname].sy_call != (sy_call_t *)lkmressys)
253 * Syscall registration helpers with resource allocation handling.
255 struct syscall_helper_data {
256 struct sysent new_sysent;
257 struct sysent old_sysent;
261 #define SYSCALL_INIT_HELPER_F(syscallname, flags) { \
263 .sy_narg = (sizeof(struct syscallname ## _args ) \
264 / sizeof(register_t)), \
265 .sy_call = (sy_call_t *)& sys_ ## syscallname, \
266 .sy_auevent = SYS_AUE_##syscallname, \
267 .sy_flags = (flags) \
269 .syscall_no = SYS_##syscallname \
271 #define SYSCALL_INIT_HELPER_COMPAT_F(syscallname, flags) { \
273 .sy_narg = (sizeof(struct syscallname ## _args ) \
274 / sizeof(register_t)), \
275 .sy_call = (sy_call_t *)& syscallname, \
276 .sy_auevent = SYS_AUE_##syscallname, \
277 .sy_flags = (flags) \
279 .syscall_no = SYS_##syscallname \
281 #define SYSCALL_INIT_HELPER(syscallname) \
282 SYSCALL_INIT_HELPER_F(syscallname, 0)
283 #define SYSCALL_INIT_HELPER_COMPAT(syscallname) \
284 SYSCALL_INIT_HELPER_COMPAT_F(syscallname, 0)
285 #define SYSCALL_INIT_LAST { \
286 .syscall_no = NO_SYSCALL \
289 int syscall_module_handler(struct module *mod, int what, void *arg);
290 int syscall_helper_register(struct syscall_helper_data *sd, int flags);
291 int syscall_helper_unregister(struct syscall_helper_data *sd);
292 /* Implementation, exposed for COMPAT code */
293 int kern_syscall_register(struct sysent *sysents, int *offset,
294 struct sysent *new_sysent, struct sysent *old_sysent, int flags);
295 int kern_syscall_deregister(struct sysent *sysents, int offset,
296 const struct sysent *old_sysent);
297 int kern_syscall_module_handler(struct sysent *sysents,
298 struct module *mod, int what, void *arg);
299 int kern_syscall_helper_register(struct sysent *sysents,
300 struct syscall_helper_data *sd, int flags);
301 int kern_syscall_helper_unregister(struct sysent *sysents,
302 struct syscall_helper_data *sd);
305 const char *syscallname(struct proc *p, u_int code);
307 /* Special purpose system call functions. */
310 int lkmnosys(struct thread *, struct nosys_args *);
311 int lkmressys(struct thread *, struct nosys_args *);
313 int syscall_thread_enter(struct thread *td, struct sysent *se);
314 void syscall_thread_exit(struct thread *td, struct sysent *se);
316 int shared_page_alloc(int size, int align);
317 int shared_page_fill(int size, int align, const void *data);
318 void shared_page_write(int base, int size, const void *data);
319 void exec_sysvec_init(void *param);
320 void exec_sysvec_init_secondary(struct sysentvec *sv, struct sysentvec *sv2);
321 void exec_inittk(void);
323 void exit_onexit(struct proc *p);
324 void exec_free_abi_mappings(struct proc *p);
325 void exec_onexec_old(struct thread *td);
327 #define INIT_SYSENTVEC(name, sv) \
328 SYSINIT(name, SI_SUB_EXEC, SI_ORDER_ANY, \
329 (sysinit_cfunc_t)exec_sysvec_init, sv);
333 #endif /* !_SYS_SYSENT_H_ */