xref: /freebsd/sys/x86/include/ucontext.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 2003 Peter Wemm
5  * Copyright (c) 1999 Marcel Moolenaar
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer
13  *    in this position and unchanged.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. The name of the author may not be used to endorse or promote products
18  *    derived from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #ifndef _X86_UCONTEXT_H_
33 #define	_X86_UCONTEXT_H_
34 
35 #ifdef __i386__
36 /* Keep _MC_* values similar to amd64 */
37 #define	_MC_HASSEGS	0x1
38 #define	_MC_HASBASES	0x2
39 #define	_MC_HASFPXSTATE	0x4
40 #define	_MC_FLAG_MASK	(_MC_HASSEGS | _MC_HASBASES | _MC_HASFPXSTATE)
41 
42 typedef struct __mcontext {
43 	/*
44 	 * The definition of mcontext_t must match the layout of
45 	 * struct sigcontext after the sc_mask member.  This is so
46 	 * that we can support sigcontext and ucontext_t at the same
47 	 * time.
48 	 */
49 	__register_t	mc_onstack;	/* XXX - sigcontext compat. */
50 	__register_t	mc_gs;		/* machine state (struct trapframe) */
51 	__register_t	mc_fs;
52 	__register_t	mc_es;
53 	__register_t	mc_ds;
54 	__register_t	mc_edi;
55 	__register_t	mc_esi;
56 	__register_t	mc_ebp;
57 	__register_t	mc_isp;
58 	__register_t	mc_ebx;
59 	__register_t	mc_edx;
60 	__register_t	mc_ecx;
61 	__register_t	mc_eax;
62 	__register_t	mc_trapno;
63 	__register_t	mc_err;
64 	__register_t	mc_eip;
65 	__register_t	mc_cs;
66 	__register_t	mc_eflags;
67 	__register_t	mc_esp;
68 	__register_t	mc_ss;
69 
70 	int	mc_len;			/* sizeof(mcontext_t) */
71 #define	_MC_FPFMT_NODEV		0x10000	/* device not present or configured */
72 #define	_MC_FPFMT_387		0x10001
73 #define	_MC_FPFMT_XMM		0x10002
74 	int	mc_fpformat;
75 #define	_MC_FPOWNED_NONE	0x20000	/* FP state not used */
76 #define	_MC_FPOWNED_FPU		0x20001	/* FP state came from FPU */
77 #define	_MC_FPOWNED_PCB		0x20002	/* FP state came from PCB */
78 	int	mc_ownedfp;
79 	__register_t mc_flags;
80 	/*
81 	 * See <machine/npx.h> for the internals of mc_fpstate[].
82 	 */
83 	int	mc_fpstate[128] __aligned(16);
84 
85 	__register_t mc_fsbase;
86 	__register_t mc_gsbase;
87 
88 	__register_t mc_xfpustate;
89 	__register_t mc_xfpustate_len;
90 
91 	int	mc_spare2[4];
92 } mcontext_t;
93 #endif /* __i386__ */
94 
95 #ifdef __amd64__
96 /*
97  * mc_flags bits. Shall be in sync with TF_XXX.
98  */
99 #define	_MC_HASSEGS	0x1
100 #define	_MC_HASBASES	0x2
101 #define	_MC_HASFPXSTATE	0x4
102 #define	_MC_FLAG_MASK	(_MC_HASSEGS | _MC_HASBASES | _MC_HASFPXSTATE)
103 
104 typedef struct __mcontext {
105 	/*
106 	 * The definition of mcontext_t must match the layout of
107 	 * struct sigcontext after the sc_mask member.  This is so
108 	 * that we can support sigcontext and ucontext_t at the same
109 	 * time.
110 	 */
111 	__register_t	mc_onstack;	/* XXX - sigcontext compat. */
112 	__register_t	mc_rdi;		/* machine state (struct trapframe) */
113 	__register_t	mc_rsi;
114 	__register_t	mc_rdx;
115 	__register_t	mc_rcx;
116 	__register_t	mc_r8;
117 	__register_t	mc_r9;
118 	__register_t	mc_rax;
119 	__register_t	mc_rbx;
120 	__register_t	mc_rbp;
121 	__register_t	mc_r10;
122 	__register_t	mc_r11;
123 	__register_t	mc_r12;
124 	__register_t	mc_r13;
125 	__register_t	mc_r14;
126 	__register_t	mc_r15;
127 	__uint32_t	mc_trapno;
128 	__uint16_t	mc_fs;
129 	__uint16_t	mc_gs;
130 	__register_t	mc_addr;
131 	__uint32_t	mc_flags;
132 	__uint16_t	mc_es;
133 	__uint16_t	mc_ds;
134 	__register_t	mc_err;
135 	__register_t	mc_rip;
136 	__register_t	mc_cs;
137 	__register_t	mc_rflags;
138 	__register_t	mc_rsp;
139 	__register_t	mc_ss;
140 
141 	long	mc_len;			/* sizeof(mcontext_t) */
142 
143 #define	_MC_FPFMT_NODEV		0x10000	/* device not present or configured */
144 #define	_MC_FPFMT_XMM		0x10002
145 	long	mc_fpformat;
146 #define	_MC_FPOWNED_NONE	0x20000	/* FP state not used */
147 #define	_MC_FPOWNED_FPU		0x20001	/* FP state came from FPU */
148 #define	_MC_FPOWNED_PCB		0x20002	/* FP state came from PCB */
149 	long	mc_ownedfp;
150 	/*
151 	 * See <machine/fpu.h> for the internals of mc_fpstate[].
152 	 */
153 	long	mc_fpstate[64] __aligned(16);
154 
155 	__register_t	mc_fsbase;
156 	__register_t	mc_gsbase;
157 
158 	__register_t	mc_xfpustate;
159 	__register_t	mc_xfpustate_len;
160 
161 	long	mc_spare[4];
162 } mcontext_t;
163 #endif /* __amd64__ */
164 
165 #endif /* !_X86_UCONTEXT_H_ */
166