master
1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 2003 Peter Wemm.
5 * Copyright (c) 1990 The Regents of the University of California.
6 * All rights reserved.
7 *
8 * This code is derived from software contributed to Berkeley by
9 * William Jolitz.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
34 *
35 * from: @(#)reg.h 5.5 (Berkeley) 1/18/91
36 */
37
38#ifndef _MACHINE_REG_H_
39#define _MACHINE_REG_H_
40
41#include <sys/_types.h>
42
43#ifdef __i386__
44/*
45 * Indices for registers in `struct trapframe' and `struct regs'.
46 *
47 * This interface is deprecated. In the kernel, it is only used in FPU
48 * emulators to convert from register numbers encoded in instructions to
49 * register values. Everything else just accesses the relevant struct
50 * members. In userland, debuggers tend to abuse this interface since
51 * they don't understand that `struct regs' is a struct. I hope they have
52 * stopped accessing the registers in the trap frame via PT_{READ,WRITE}_U
53 * and we can stop supporting the user area soon.
54 */
55#define tFS (0)
56#define tES (1)
57#define tDS (2)
58#define tEDI (3)
59#define tESI (4)
60#define tEBP (5)
61#define tISP (6)
62#define tEBX (7)
63#define tEDX (8)
64#define tECX (9)
65#define tEAX (10)
66#define tERR (12)
67#define tEIP (13)
68#define tCS (14)
69#define tEFLAGS (15)
70#define tESP (16)
71#define tSS (17)
72
73/*
74 * Indices for registers in `struct regs' only.
75 *
76 * Some registers live in the pcb and are only in an "array" with the
77 * other registers in application interfaces that copy all the registers
78 * to or from a `struct regs'.
79 */
80#define tGS (18)
81#endif /* __i386__ */
82
83/* Rename the structs below depending on the machine architecture. */
84#ifdef __i386__
85#define __reg32 reg
86#define __fpreg32 fpreg
87#define __dbreg32 dbreg
88#define __segbasereg32 segbasereg
89#else
90#define __reg32 reg32
91#define __reg64 reg
92#define __fpreg32 fpreg32
93#define __fpreg64 fpreg
94#define __dbreg32 dbreg32
95#define __dbreg64 dbreg
96#define __segbasereg32 segbasereg32
97#define __segbasereg64 segbasereg
98#define __HAVE_REG32
99#endif
100
101/*
102 * Register set accessible via /proc/$pid/regs and PT_{SET,GET}REGS.
103 */
104struct __reg32 {
105 __uint32_t r_fs;
106 __uint32_t r_es;
107 __uint32_t r_ds;
108 __uint32_t r_edi;
109 __uint32_t r_esi;
110 __uint32_t r_ebp;
111 __uint32_t r_isp;
112 __uint32_t r_ebx;
113 __uint32_t r_edx;
114 __uint32_t r_ecx;
115 __uint32_t r_eax;
116 __uint32_t r_trapno;
117 __uint32_t r_err;
118 __uint32_t r_eip;
119 __uint32_t r_cs;
120 __uint32_t r_eflags;
121 __uint32_t r_esp;
122 __uint32_t r_ss;
123 __uint32_t r_gs;
124};
125
126struct __reg64 {
127 __int64_t r_r15;
128 __int64_t r_r14;
129 __int64_t r_r13;
130 __int64_t r_r12;
131 __int64_t r_r11;
132 __int64_t r_r10;
133 __int64_t r_r9;
134 __int64_t r_r8;
135 __int64_t r_rdi;
136 __int64_t r_rsi;
137 __int64_t r_rbp;
138 __int64_t r_rbx;
139 __int64_t r_rdx;
140 __int64_t r_rcx;
141 __int64_t r_rax;
142 __uint32_t r_trapno;
143 __uint16_t r_fs;
144 __uint16_t r_gs;
145 __uint32_t r_err;
146 __uint16_t r_es;
147 __uint16_t r_ds;
148 __int64_t r_rip;
149 __int64_t r_cs;
150 __int64_t r_rflags;
151 __int64_t r_rsp;
152 __int64_t r_ss;
153};
154
155/*
156 * Register set accessible via /proc/$pid/fpregs.
157 *
158 * XXX should get struct from fpu.h. Here we give a slightly
159 * simplified struct. This may be too much detail. Perhaps
160 * an array of unsigned longs is best.
161 */
162struct __fpreg32 {
163 __uint32_t fpr_env[7];
164 __uint8_t fpr_acc[8][10];
165 __uint32_t fpr_ex_sw;
166 __uint8_t fpr_pad[64];
167};
168
169struct __fpreg64 {
170 __uint64_t fpr_env[4];
171 __uint8_t fpr_acc[8][16];
172 __uint8_t fpr_xacc[16][16];
173 __uint64_t fpr_spare[12];
174};
175
176/*
177 * Register set accessible via PT_GETXMMREGS (i386).
178 */
179struct xmmreg {
180 /*
181 * XXX should get struct from npx.h. Here we give a slightly
182 * simplified struct. This may be too much detail. Perhaps
183 * an array of unsigned longs is best.
184 */
185 __uint32_t xmm_env[8];
186 __uint8_t xmm_acc[8][16];
187 __uint8_t xmm_reg[8][16];
188 __uint8_t xmm_pad[224];
189};
190
191/*
192 * Register set accessible via /proc/$pid/dbregs.
193 */
194struct __dbreg32 {
195 __uint32_t dr[8]; /* debug registers */
196 /* Index 0-3: debug address registers */
197 /* Index 4-5: reserved */
198 /* Index 6: debug status */
199 /* Index 7: debug control */
200};
201
202struct __dbreg64 {
203 __uint64_t dr[16]; /* debug registers */
204 /* Index 0-3: debug address registers */
205 /* Index 4-5: reserved */
206 /* Index 6: debug status */
207 /* Index 7: debug control */
208 /* Index 8-15: reserved */
209};
210
211#define DBREG_DR6_RESERVED1 0xffff0ff0
212#define DBREG_DR6_BMASK 0x000f
213#define DBREG_DR6_B(i) (1 << (i))
214#define DBREG_DR6_BD 0x2000
215#define DBREG_DR6_BS 0x4000
216#define DBREG_DR6_BT 0x8000
217
218#define DBREG_DR7_RESERVED1 0x0400
219#define DBREG_DR7_LOCAL_ENABLE 0x01
220#define DBREG_DR7_GLOBAL_ENABLE 0x02
221#define DBREG_DR7_LEN_1 0x00 /* 1 byte length */
222#define DBREG_DR7_LEN_2 0x01
223#define DBREG_DR7_LEN_4 0x03
224#define DBREG_DR7_LEN_8 0x02
225#define DBREG_DR7_EXEC 0x00 /* break on execute */
226#define DBREG_DR7_WRONLY 0x01 /* break on write */
227#define DBREG_DR7_RDWR 0x03 /* break on read or write */
228#define DBREG_DR7_MASK(i) \
229 ((__u_register_t)(0xf) << ((i) * 4 + 16) | 0x3 << (i) * 2)
230#define DBREG_DR7_SET(i, len, access, enable) \
231 ((__u_register_t)((len) << 2 | (access)) << ((i) * 4 + 16) | \
232 (enable) << (i) * 2)
233#define DBREG_DR7_GD 0x2000
234#define DBREG_DR7_ENABLED(d, i) (((d) & 0x3 << (i) * 2) != 0)
235#define DBREG_DR7_ACCESS(d, i) ((d) >> ((i) * 4 + 16) & 0x3)
236#define DBREG_DR7_LEN(d, i) ((d) >> ((i) * 4 + 18) & 0x3)
237
238#define DBREG_DRX(d,x) ((d)->dr[(x)]) /* reference dr0 - dr7 by
239 register number */
240
241/*
242 * Register set accessible via NT_X86_SEGBASES.
243 */
244struct __segbasereg32 {
245 __uint32_t r_fsbase;
246 __uint32_t r_gsbase;
247};
248
249struct __segbasereg64 {
250 __uint64_t r_fsbase;
251 __uint64_t r_gsbase;
252};
253
254#undef __reg32
255#undef __reg64
256#undef __fpreg32
257#undef __fpreg64
258#undef __dbreg32
259#undef __dbreg64
260#undef __segbasereg32
261#undef __segbasereg64
262
263#ifdef _KERNEL
264/*
265 * XXX these interfaces are MI, so they should be declared in a MI place.
266 */
267int fill_frame_regs(struct trapframe *, struct reg *);
268#endif
269
270#endif /* !_MACHINE_REG_H_ */