xref: /freebsd/sys/sys/ucontext.h (revision b00ab754)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1999 Marcel Moolenaar
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  *    in this position and unchanged.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. The name of the author may not be used to endorse or promote products
17  *    derived from this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  *
30  * $FreeBSD$
31  */
32 
33 #ifndef _SYS_UCONTEXT_H_
34 #define	_SYS_UCONTEXT_H_
35 
36 #include <sys/signal.h>
37 #include <machine/ucontext.h>
38 #include <sys/_ucontext.h>
39 
40 #define	UCF_SWAPPED	0x00000001	/* Used by swapcontext(3). */
41 
42 #if defined(_KERNEL) && defined(COMPAT_FREEBSD4)
43 #if defined(__i386__)
44 struct ucontext4 {
45 	sigset_t	uc_sigmask;
46 	struct mcontext4 uc_mcontext;
47 	struct ucontext4 *uc_link;
48 	stack_t		uc_stack;
49 	int		__spare__[8];
50 };
51 #else	/* __i386__ */
52 #define ucontext4 ucontext
53 #endif	/* __i386__ */
54 #endif	/* _KERNEL */
55 
56 #ifndef _KERNEL
57 
58 __BEGIN_DECLS
59 
60 int	getcontext(ucontext_t *) __returns_twice;
61 ucontext_t *getcontextx(void);
62 int	setcontext(const ucontext_t *);
63 void	makecontext(ucontext_t *, void (*)(void), int, ...);
64 int	signalcontext(ucontext_t *, int, __sighandler_t *);
65 int	swapcontext(ucontext_t *, const ucontext_t *);
66 
67 #if __BSD_VISIBLE
68 int __getcontextx_size(void);
69 int __fillcontextx(char *ctx) __returns_twice;
70 int __fillcontextx2(char *ctx);
71 #endif
72 
73 __END_DECLS
74 
75 #else /* _KERNEL */
76 
77 struct thread;
78 
79 /*
80  * Flags for get_mcontext().  The low order 4 bits (i.e a mask of 0x0f) are
81  * reserved for use by machine independent code.  All other bits are for use
82  * by machine dependent code.
83  */
84 #define	GET_MC_CLEAR_RET	1
85 
86 /* Machine-dependent functions: */
87 int	get_mcontext(struct thread *, mcontext_t *, int);
88 int	set_mcontext(struct thread *, mcontext_t *);
89 
90 #endif /* !_KERNEL */
91 
92 #endif /* !_SYS_UCONTEXT_H_ */
93