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 *);
56 extern systrace_probe_func_t systrace_probe_func;
58 struct sysent { /* system call table */
59 int sy_narg; /* number of arguments */
60 sy_call_t *sy_call; /* implementing function */
61 au_event_t sy_auevent; /* audit event associated with syscall */
62 systrace_args_func_t sy_systrace_args_func;
63 /* optional argument conversion function. */
64 u_int32_t sy_entry; /* DTrace entry ID for systrace. */
65 u_int32_t sy_return; /* DTrace return ID for systrace. */
66 u_int32_t sy_flags; /* General flags for system calls. */
71 * A system call is permitted in capability mode.
73 #define SYF_CAPENABLED 0x00000001
75 #define SY_THR_FLAGMASK 0x7
76 #define SY_THR_STATIC 0x1
77 #define SY_THR_DRAINING 0x2
78 #define SY_THR_ABSENT 0x4
79 #define SY_THR_INCR 0x8
82 #define SY_THR_STATIC_KLD 0
84 #define SY_THR_STATIC_KLD SY_THR_STATIC
93 int sv_size; /* number of entries */
94 struct sysent *sv_table; /* pointer to sysent */
95 u_int sv_mask; /* optional mask to index */
96 int sv_errsize; /* size of errno translation table */
97 const int *sv_errtbl; /* errno translation table */
98 int (*sv_transtrap)(int, int);
99 /* translate trap-to-signal mapping */
100 int (*sv_fixup)(register_t **, struct image_params *);
101 /* stack fixup function */
102 void (*sv_sendsig)(void (*)(int), struct ksiginfo *, struct __sigset *);
104 char *sv_sigcode; /* start of sigtramp code */
105 int *sv_szsigcode; /* size of sigtramp code */
106 char *sv_name; /* name of binary type */
107 int (*sv_coredump)(struct thread *, struct vnode *, off_t, int);
108 /* function to dump core, or NULL */
109 int (*sv_imgact_try)(struct image_params *);
110 int sv_minsigstksz; /* minimum signal stack size */
111 int sv_pagesize; /* pagesize */
112 vm_offset_t sv_minuser; /* VM_MIN_ADDRESS */
113 vm_offset_t sv_maxuser; /* VM_MAXUSER_ADDRESS */
114 vm_offset_t sv_usrstack; /* USRSTACK */
115 vm_offset_t sv_psstrings; /* PS_STRINGS */
116 int sv_stackprot; /* vm protection for stack */
117 register_t *(*sv_copyout_strings)(struct image_params *);
118 void (*sv_setregs)(struct thread *, struct image_params *,
120 void (*sv_fixlimit)(struct rlimit *, int);
123 void (*sv_set_syscall_retval)(struct thread *, int);
124 int (*sv_fetch_syscall_args)(struct thread *);
125 const char **sv_syscallnames;
126 vm_offset_t sv_timekeep_base;
127 vm_offset_t sv_shared_page_base;
128 vm_offset_t sv_shared_page_len;
129 vm_offset_t sv_sigcode_base;
130 void *sv_shared_page_obj;
131 void (*sv_schedtail)(struct thread *);
132 void (*sv_thread_detach)(struct thread *);
133 int (*sv_trap)(struct thread *);
134 u_long *sv_hwcap; /* Value passed in AT_HWCAP. */
135 u_long *sv_hwcap2; /* Value passed in AT_HWCAP2. */
138 #define SV_ILP32 0x000100 /* 32-bit executable. */
139 #define SV_LP64 0x000200 /* 64-bit executable. */
140 #define SV_IA32 0x004000 /* Intel 32-bit executable. */
141 #define SV_AOUT 0x008000 /* a.out executable. */
142 #define SV_SHP 0x010000 /* Shared page. */
143 #define SV_CAPSICUM 0x020000 /* Force cap_enter() on startup. */
144 #define SV_TIMEKEEP 0x040000 /* Shared page timehands. */
146 #define SV_ABI_MASK 0xff
147 #define SV_ABI_ERRNO(p, e) ((p)->p_sysent->sv_errsize <= 0 ? e : \
148 ((e) >= (p)->p_sysent->sv_errsize ? -1 : (p)->p_sysent->sv_errtbl[e]))
149 #define SV_PROC_FLAG(p, x) ((p)->p_sysent->sv_flags & (x))
150 #define SV_PROC_ABI(p) ((p)->p_sysent->sv_flags & SV_ABI_MASK)
151 #define SV_CURPROC_FLAG(x) SV_PROC_FLAG(curproc, x)
152 #define SV_CURPROC_ABI() SV_PROC_ABI(curproc)
153 /* same as ELFOSABI_XXX, to prevent header pollution */
154 #define SV_ABI_LINUX 3
155 #define SV_ABI_FREEBSD 9
156 #define SV_ABI_CLOUDABI 17
157 #define SV_ABI_UNDEF 255
160 extern struct sysentvec aout_sysvec;
161 extern struct sysent sysent[];
162 extern const char *syscallnames[];
164 #if defined(__amd64__)
165 extern int i386_read_exec;
168 #define NO_SYSCALL (-1)
172 struct syscall_module_data {
173 int (*chainevh)(struct module *, int, void *); /* next handler */
174 void *chainarg; /* arg for next event handler */
175 int *offset; /* offset into sysent */
176 struct sysent *new_sysent; /* new sysent */
177 struct sysent old_sysent; /* old sysent */
178 int flags; /* flags for syscall_register */
181 /* separate initialization vector so it can be used in a substructure */
182 #define SYSENT_INIT_VALS(_syscallname) { \
183 .sy_narg = (sizeof(struct _syscallname ## _args ) \
184 / sizeof(register_t)), \
185 .sy_call = (sy_call_t *)&sys_##_syscallname, \
186 .sy_auevent = SYS_AUE_##_syscallname, \
187 .sy_systrace_args_func = NULL, \
194 #define MAKE_SYSENT(syscallname) \
195 static struct sysent syscallname##_sysent = SYSENT_INIT_VALS(syscallname);
197 #define MAKE_SYSENT_COMPAT(syscallname) \
198 static struct sysent syscallname##_sysent = { \
199 (sizeof(struct syscallname ## _args ) \
200 / sizeof(register_t)), \
201 (sy_call_t *)& syscallname, \
202 SYS_AUE_##syscallname \
205 #define SYSCALL_MODULE(name, offset, new_sysent, evh, arg) \
206 static struct syscall_module_data name##_syscall_mod = { \
207 evh, arg, offset, new_sysent, { 0, NULL, AUE_NULL } \
210 static moduledata_t name##_mod = { \
212 syscall_module_handler, \
213 &name##_syscall_mod \
215 DECLARE_MODULE(name, name##_mod, SI_SUB_SYSCALLS, SI_ORDER_MIDDLE)
217 #define SYSCALL_MODULE_HELPER(syscallname) \
218 static int syscallname##_syscall = SYS_##syscallname; \
219 MAKE_SYSENT(syscallname); \
220 SYSCALL_MODULE(syscallname, \
221 & syscallname##_syscall, & syscallname##_sysent, \
224 #define SYSCALL_MODULE_PRESENT(syscallname) \
225 (sysent[SYS_##syscallname].sy_call != (sy_call_t *)lkmnosys && \
226 sysent[SYS_##syscallname].sy_call != (sy_call_t *)lkmressys)
229 * Syscall registration helpers with resource allocation handling.
231 struct syscall_helper_data {
232 struct sysent new_sysent;
233 struct sysent old_sysent;
237 #define SYSCALL_INIT_HELPER_F(syscallname, flags) { \
239 .sy_narg = (sizeof(struct syscallname ## _args ) \
240 / sizeof(register_t)), \
241 .sy_call = (sy_call_t *)& sys_ ## syscallname, \
242 .sy_auevent = SYS_AUE_##syscallname, \
243 .sy_flags = (flags) \
245 .syscall_no = SYS_##syscallname \
247 #define SYSCALL_INIT_HELPER_COMPAT_F(syscallname, flags) { \
249 .sy_narg = (sizeof(struct syscallname ## _args ) \
250 / sizeof(register_t)), \
251 .sy_call = (sy_call_t *)& syscallname, \
252 .sy_auevent = SYS_AUE_##syscallname, \
253 .sy_flags = (flags) \
255 .syscall_no = SYS_##syscallname \
257 #define SYSCALL_INIT_HELPER(syscallname) \
258 SYSCALL_INIT_HELPER_F(syscallname, 0)
259 #define SYSCALL_INIT_HELPER_COMPAT(syscallname) \
260 SYSCALL_INIT_HELPER_COMPAT_F(syscallname, 0)
261 #define SYSCALL_INIT_LAST { \
262 .syscall_no = NO_SYSCALL \
265 int syscall_module_handler(struct module *mod, int what, void *arg);
266 int syscall_helper_register(struct syscall_helper_data *sd, int flags);
267 int syscall_helper_unregister(struct syscall_helper_data *sd);
268 /* Implementation, exposed for COMPAT code */
269 int kern_syscall_register(struct sysent *sysents, int *offset,
270 struct sysent *new_sysent, struct sysent *old_sysent, int flags);
271 int kern_syscall_deregister(struct sysent *sysents, int offset,
272 const struct sysent *old_sysent);
273 int kern_syscall_module_handler(struct sysent *sysents,
274 struct module *mod, int what, void *arg);
275 int kern_syscall_helper_register(struct sysent *sysents,
276 struct syscall_helper_data *sd, int flags);
277 int kern_syscall_helper_unregister(struct sysent *sysents,
278 struct syscall_helper_data *sd);
281 const char *syscallname(struct proc *p, u_int code);
283 /* Special purpose system call functions. */
286 int lkmnosys(struct thread *, struct nosys_args *);
287 int lkmressys(struct thread *, struct nosys_args *);
289 int syscall_thread_enter(struct thread *td, struct sysent *se);
290 void syscall_thread_exit(struct thread *td, struct sysent *se);
292 int shared_page_alloc(int size, int align);
293 int shared_page_fill(int size, int align, const void *data);
294 void shared_page_write(int base, int size, const void *data);
295 void exec_sysvec_init(void *param);
296 void exec_inittk(void);
298 #define INIT_SYSENTVEC(name, sv) \
299 SYSINIT(name, SI_SUB_EXEC, SI_ORDER_ANY, \
300 (sysinit_cfunc_t)exec_sysvec_init, sv);
304 #endif /* !_SYS_SYSENT_H_ */