xref: /freebsd/sys/sys/sysent.h (revision a31070e90de2602a7364c81c45f25f69aa9e9d3e)
1 /*-
2  * Copyright (c) 1982, 1988, 1991 The Regents of the University of California.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 4. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * $FreeBSD$
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 
42 typedef	int	sy_call_t(struct thread *, void *);
43 
44 /* Used by the machine dependent syscall() code. */
45 typedef	void (*systrace_probe_func_t)(u_int32_t, int, struct sysent *, void *,
46     int);
47 
48 /*
49  * Used by loaded syscalls to convert arguments to a DTrace array
50  * of 64-bit arguments.
51  */
52 typedef	void (*systrace_args_func_t)(int, void *, u_int64_t *, int *);
53 
54 extern systrace_probe_func_t	systrace_probe_func;
55 
56 struct sysent {			/* system call table */
57 	int	sy_narg;	/* number of arguments */
58 	sy_call_t *sy_call;	/* implementing function */
59 	au_event_t sy_auevent;	/* audit event associated with syscall */
60 	systrace_args_func_t sy_systrace_args_func;
61 				/* optional argument conversion function. */
62 	u_int32_t sy_entry;	/* DTrace entry ID for systrace. */
63 	u_int32_t sy_return;	/* DTrace return ID for systrace. */
64 	u_int32_t sy_flags;	/* General flags for system calls. */
65 	u_int32_t sy_thrcnt;
66 };
67 
68 /*
69  * A system call is permitted in capability mode.
70  */
71 #define	SYF_CAPENABLED	0x00000001
72 
73 #define	SY_THR_FLAGMASK	0x7
74 #define	SY_THR_STATIC	0x1
75 #define	SY_THR_DRAINING	0x2
76 #define	SY_THR_ABSENT	0x4
77 #define	SY_THR_INCR	0x8
78 
79 #ifdef KLD_MODULE
80 #define	SY_THR_STATIC_KLD	0
81 #else
82 #define	SY_THR_STATIC_KLD	SY_THR_STATIC
83 #endif
84 
85 struct image_params;
86 struct __sigset;
87 struct syscall_args;
88 struct trapframe;
89 struct vnode;
90 
91 struct sysentvec {
92 	int		sv_size;	/* number of entries */
93 	struct sysent	*sv_table;	/* pointer to sysent */
94 	u_int		sv_mask;	/* optional mask to index */
95 	int		sv_sigsize;	/* size of signal translation table */
96 	int		*sv_sigtbl;	/* signal translation table */
97 	int		sv_errsize;	/* size of errno translation table */
98 	int 		*sv_errtbl;	/* errno translation table */
99 	int		(*sv_transtrap)(int, int);
100 					/* translate trap-to-signal mapping */
101 	int		(*sv_fixup)(register_t **, struct image_params *);
102 					/* stack fixup function */
103 	void		(*sv_sendsig)(void (*)(int), struct ksiginfo *, struct __sigset *);
104 			    		/* send signal */
105 	char 		*sv_sigcode;	/* start of sigtramp code */
106 	int 		*sv_szsigcode;	/* size of sigtramp code */
107 	void		(*sv_prepsyscall)(struct trapframe *, int *, u_int *,
108 			    caddr_t *);
109 	char		*sv_name;	/* name of binary type */
110 	int		(*sv_coredump)(struct thread *, struct vnode *, off_t, int);
111 					/* function to dump core, or NULL */
112 	int		(*sv_imgact_try)(struct image_params *);
113 	int		sv_minsigstksz;	/* minimum signal stack size */
114 	int		sv_pagesize;	/* pagesize */
115 	vm_offset_t	sv_minuser;	/* VM_MIN_ADDRESS */
116 	vm_offset_t	sv_maxuser;	/* VM_MAXUSER_ADDRESS */
117 	vm_offset_t	sv_usrstack;	/* USRSTACK */
118 	vm_offset_t	sv_psstrings;	/* PS_STRINGS */
119 	int		sv_stackprot;	/* vm protection for stack */
120 	register_t	*(*sv_copyout_strings)(struct image_params *);
121 	void		(*sv_setregs)(struct thread *, struct image_params *,
122 			    u_long);
123 	void		(*sv_fixlimit)(struct rlimit *, int);
124 	u_long		*sv_maxssiz;
125 	u_int		sv_flags;
126 	void		(*sv_set_syscall_retval)(struct thread *, int);
127 	int		(*sv_fetch_syscall_args)(struct thread *, struct
128 			    syscall_args *);
129 	const char	**sv_syscallnames;
130 	vm_offset_t	sv_shared_page_base;
131 	vm_offset_t	sv_shared_page_len;
132 	vm_offset_t	sv_sigcode_base;
133 	vm_offset_t	sv_timekeep_base;
134 	int		sv_timekeep_off;
135 	int		sv_timekeep_curr;
136 	uint32_t	sv_timekeep_gen;
137 	void		*sv_shared_page_obj;
138 	void		(*sv_schedtail)(struct thread *);
139 };
140 
141 #define	SV_ILP32	0x000100
142 #define	SV_LP64		0x000200
143 #define	SV_IA32		0x004000
144 #define	SV_AOUT		0x008000
145 #define	SV_SHP		0x010000
146 
147 #define	SV_ABI_MASK	0xff
148 #define	SV_PROC_FLAG(p, x)	((p)->p_sysent->sv_flags & (x))
149 #define	SV_PROC_ABI(p)		((p)->p_sysent->sv_flags & SV_ABI_MASK)
150 #define	SV_CURPROC_FLAG(x)	SV_PROC_FLAG(curproc, x)
151 #define	SV_CURPROC_ABI()	SV_PROC_ABI(curproc)
152 /* same as ELFOSABI_XXX, to prevent header pollution */
153 #define	SV_ABI_LINUX	3
154 #define	SV_ABI_FREEBSD 	9
155 #define	SV_ABI_UNDEF	255
156 
157 #ifdef _KERNEL
158 extern struct sysentvec aout_sysvec;
159 extern struct sysentvec elf_freebsd_sysvec;
160 extern struct sysentvec null_sysvec;
161 extern struct sysent sysent[];
162 extern const char *syscallnames[];
163 
164 #if defined(__amd64__)
165 extern int i386_read_exec;
166 #endif
167 
168 #define	NO_SYSCALL (-1)
169 
170 struct module;
171 
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 */
179 };
180 
181 #define	MAKE_SYSENT(syscallname)				\
182 static struct sysent syscallname##_sysent = {			\
183 	(sizeof(struct syscallname ## _args )			\
184 	    / sizeof(register_t)),				\
185 	(sy_call_t *)& sys_##syscallname,	       		\
186 	SYS_AUE_##syscallname					\
187 }
188 
189 #define	MAKE_SYSENT_COMPAT(syscallname)				\
190 static struct sysent syscallname##_sysent = {			\
191 	(sizeof(struct syscallname ## _args )			\
192 	    / sizeof(register_t)),				\
193 	(sy_call_t *)& syscallname,				\
194 	SYS_AUE_##syscallname					\
195 }
196 
197 #define SYSCALL_MODULE(name, offset, new_sysent, evh, arg)	\
198 static struct syscall_module_data name##_syscall_mod = {	\
199 	evh, arg, offset, new_sysent, { 0, NULL, AUE_NULL }	\
200 };								\
201 								\
202 static moduledata_t name##_mod = {				\
203 	"sys/" #name,						\
204 	syscall_module_handler,					\
205 	&name##_syscall_mod					\
206 };								\
207 DECLARE_MODULE(name, name##_mod, SI_SUB_SYSCALLS, SI_ORDER_MIDDLE)
208 
209 #define	SYSCALL_MODULE_HELPER(syscallname)			\
210 static int syscallname##_syscall = SYS_##syscallname;		\
211 MAKE_SYSENT(syscallname);					\
212 SYSCALL_MODULE(syscallname,					\
213     & syscallname##_syscall, & syscallname##_sysent,		\
214     NULL, NULL)
215 
216 #define	SYSCALL_MODULE_PRESENT(syscallname)				\
217 	(sysent[SYS_##syscallname].sy_call != (sy_call_t *)lkmnosys &&	\
218 	sysent[SYS_##syscallname].sy_call != (sy_call_t *)lkmressys)
219 
220 /*
221  * Syscall registration helpers with resource allocation handling.
222  */
223 struct syscall_helper_data {
224 	struct sysent new_sysent;
225 	struct sysent old_sysent;
226 	int syscall_no;
227 	int registered;
228 };
229 #define SYSCALL_INIT_HELPER(syscallname) {			\
230     .new_sysent = {						\
231 	.sy_narg = (sizeof(struct syscallname ## _args )	\
232 	    / sizeof(register_t)),				\
233 	.sy_call = (sy_call_t *)& sys_ ## syscallname,		\
234 	.sy_auevent = SYS_AUE_##syscallname			\
235     },								\
236     .syscall_no = SYS_##syscallname				\
237 }
238 #define SYSCALL_INIT_HELPER_COMPAT(syscallname) {		\
239     .new_sysent = {						\
240 	.sy_narg = (sizeof(struct syscallname ## _args )	\
241 	    / sizeof(register_t)),				\
242 	.sy_call = (sy_call_t *)& syscallname,			\
243 	.sy_auevent = SYS_AUE_##syscallname			\
244     },								\
245     .syscall_no = SYS_##syscallname				\
246 }
247 #define SYSCALL_INIT_LAST {					\
248     .syscall_no = NO_SYSCALL					\
249 }
250 
251 int	syscall_register(int *offset, struct sysent *new_sysent,
252 	    struct sysent *old_sysent, int flags);
253 int	syscall_deregister(int *offset, struct sysent *old_sysent);
254 int	syscall_module_handler(struct module *mod, int what, void *arg);
255 int	syscall_helper_register(struct syscall_helper_data *sd, int flags);
256 int	syscall_helper_unregister(struct syscall_helper_data *sd);
257 
258 struct proc;
259 const char *syscallname(struct proc *p, u_int code);
260 
261 /* Special purpose system call functions. */
262 struct nosys_args;
263 
264 int	lkmnosys(struct thread *, struct nosys_args *);
265 int	lkmressys(struct thread *, struct nosys_args *);
266 
267 int	syscall_thread_enter(struct thread *td, struct sysent *se);
268 void	syscall_thread_exit(struct thread *td, struct sysent *se);
269 
270 int shared_page_alloc(int size, int align);
271 int shared_page_fill(int size, int align, const void *data);
272 void shared_page_write(int base, int size, const void *data);
273 void exec_sysvec_init(void *param);
274 
275 #define INIT_SYSENTVEC(name, sv)					\
276     SYSINIT(name, SI_SUB_EXEC, SI_ORDER_ANY,				\
277 	(sysinit_cfunc_t)exec_sysvec_init, sv);
278 
279 #endif /* _KERNEL */
280 
281 #endif /* !_SYS_SYSENT_H_ */
282