xref: /netbsd-src/sys/arch/amd64/include/mcontext.h (revision 16543c49052c820334cffc5c69b2afde18f02458)
1 /*	$NetBSD: mcontext.h,v 1.24 2024/11/30 01:04:06 christos Exp $	*/
2 
3 /*-
4  * Copyright (c) 1999 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Klaus Klein.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #ifndef _AMD64_MCONTEXT_H_
33 #define _AMD64_MCONTEXT_H_
34 
35 #ifdef __x86_64__
36 
37 #include <machine/frame_regs.h>
38 
39 /*
40  * General register state
41  */
42 #define GREG_OFFSETS(reg, REG, idx) _REG_##REG = idx,
43 enum { _FRAME_GREG(GREG_OFFSETS) _NGREG = 26 };
44 #undef GREG_OFFSETS
45 
46 typedef	unsigned long	__greg_t;
47 typedef	__greg_t	__gregset_t[_NGREG];
48 
49 /* These names are for compatibility */
50 #define	_REG_URSP	_REG_RSP
51 #define	_REG_RFL	_REG_RFLAGS
52 
53 /*
54  * Floating point register state
55  * The format of __fpregset_t is that of the fxsave instruction
56  * which requires 16 byte alignment. However the mcontext version
57  * is never directly accessed.
58  */
59 typedef char __fpregset_t[512] __aligned(8);
60 
61 typedef struct {
62 	__gregset_t	__gregs;
63 	__greg_t	_mc_tlsbase;
64 	__fpregset_t	__fpregs;
65 } mcontext_t;
66 
67 #define _UC_UCONTEXT_ALIGN	(~0xf)
68 
69 /* AMD64 ABI 128-bytes "red zone". */
70 #define _UC_MACHINE_SP(uc)	((uc)->uc_mcontext.__gregs[_REG_RSP] - 128)
71 #define _UC_MACHINE_FP(uc)	((uc)->uc_mcontext.__gregs[_REG_RBP])
72 #define _UC_MACHINE_PC(uc)	((uc)->uc_mcontext.__gregs[_REG_RIP])
73 #define _UC_MACHINE_INTRV(uc)	((uc)->uc_mcontext.__gregs[_REG_RAX])
74 
75 #define	_UC_MACHINE_SET_PC(uc, pc)	_UC_MACHINE_PC(uc) = (pc)
76 
77 #define	_UC_TLSBASE	_UC_MD_BIT19
78 
79 /*
80  * mcontext extensions to handle signal delivery.
81  */
82 #define _UC_SETSTACK	_UC_MD_BIT16
83 #define _UC_CLRSTACK	_UC_MD_BIT17
84 
85 #define	__UCONTEXT_SIZE	784
86 
87 #ifdef _KERNEL
88 
89 /*
90  * 32bit context definitions.
91  */
92 
93 #define _NGREG32	19
94 typedef unsigned int	__greg32_t;
95 typedef __greg32_t	__gregset32_t[_NGREG32];
96 
97 #define _REG32_GS	0
98 #define _REG32_FS	1
99 #define _REG32_ES	2
100 #define _REG32_DS	3
101 #define _REG32_EDI	4
102 #define _REG32_ESI	5
103 #define _REG32_EBP	6
104 #define _REG32_ESP	7
105 #define _REG32_EBX	8
106 #define _REG32_EDX	9
107 #define _REG32_ECX	10
108 #define _REG32_EAX	11
109 #define _REG32_TRAPNO	12
110 #define _REG32_ERR	13
111 #define _REG32_EIP	14
112 #define _REG32_CS	15
113 #define _REG32_EFL	16
114 #define _REG32_UESP	17
115 #define _REG32_SS	18
116 
117 #define _UC_MACHINE32_SP(uc)	((uc)->uc_mcontext.__gregs[_REG32_UESP])
118 
119 /*
120  * Floating point register state
121  */
122 typedef struct {
123 	union {
124 		struct {
125 			int	__fp_state[27];	/* Environment and registers */
126 		} __fpchip_state;
127 		struct {
128 			char	__fp_xmm[512];
129 		} __fp_xmm_state;
130 	} __fp_reg_set;
131 	int	__fp_pad[33];			/* Historic padding */
132 } __fpregset32_t;
133 
134 typedef struct {
135 	__gregset32_t	__gregs;
136 	__fpregset32_t	__fpregs;
137 	uint32_t	_mc_tlsbase;
138 } mcontext32_t;
139 
140 #define _UC_FXSAVE       _UC_MD_BIT5    /* FP state is in FXSAVE format in XMM space */
141 
142 #define	_UC_MACHINE32_PAD	4
143 #define	__UCONTEXT32_SIZE	776
144 
145 #endif /* _KERNEL */
146 
147 #else	/*	__x86_64__	*/
148 
149 #include <i386/mcontext.h>
150 
151 #endif	/*	__x86_64__	*/
152 
153 #endif	/* !_AMD64_MCONTEXT_H_ */
154