sys/x86/include/reg.h

   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  * $FreeBSD$
  37  */
  38
  39 #ifndef _MACHINE_REG_H_
  40 #define _MACHINE_REG_H_
  41
  42 #include <machine/_types.h>
  43
  44 #ifdef __i386__
  45 /*
  46  * Indices for registers in `struct trapframe' and `struct regs'.
  47  *
  48  * This interface is deprecated.  In the kernel, it is only used in FPU
  49  * emulators to convert from register numbers encoded in instructions to
  50  * register values.  Everything else just accesses the relevant struct
  51  * members.  In userland, debuggers tend to abuse this interface since
  52  * they don't understand that `struct regs' is a struct.  I hope they have
  53  * stopped accessing the registers in the trap frame via PT_{READ,WRITE}_U
  54  * and we can stop supporting the user area soon.
  55  */
  56 #define tFS     (0)
  57 #define tES     (1)
  58 #define tDS     (2)
  59 #define tEDI    (3)
  60 #define tESI    (4)
  61 #define tEBP    (5)
  62 #define tISP    (6)
  63 #define tEBX    (7)
  64 #define tEDX    (8)
  65 #define tECX    (9)
  66 #define tEAX    (10)
  67 #define tERR    (12)
  68 #define tEIP    (13)
  69 #define tCS     (14)
  70 #define tEFLAGS (15)
  71 #define tESP    (16)
  72 #define tSS     (17)
  73
  74 /*
  75  * Indices for registers in `struct regs' only.
  76  *
  77  * Some registers live in the pcb and are only in an "array" with the
  78  * other registers in application interfaces that copy all the registers
  79  * to or from a `struct regs'.
  80  */
  81 #define tGS     (18)
  82 #endif /* __i386__ */
  83
  84 /* Rename the structs below depending on the machine architecture. */
  85 #ifdef  __i386__
  86 #define __reg32         reg
  87 #define __fpreg32       fpreg
  88 #define __dbreg32       dbreg
  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 __HAVE_REG32
  97 #endif
  98
  99 /*
 100  * Register set accessible via /proc/$pid/regs and PT_{SET,GET}REGS.
 101  */
 102 struct __reg32 {
 103         __uint32_t      r_fs;
 104         __uint32_t      r_es;
 105         __uint32_t      r_ds;
 106         __uint32_t      r_edi;
 107         __uint32_t      r_esi;
 108         __uint32_t      r_ebp;
 109         __uint32_t      r_isp;
 110         __uint32_t      r_ebx;
 111         __uint32_t      r_edx;
 112         __uint32_t      r_ecx;
 113         __uint32_t      r_eax;
 114         __uint32_t      r_trapno;
 115         __uint32_t      r_err;
 116         __uint32_t      r_eip;
 117         __uint32_t      r_cs;
 118         __uint32_t      r_eflags;
 119         __uint32_t      r_esp;
 120         __uint32_t      r_ss;
 121         __uint32_t      r_gs;
 122 };
 123
 124 struct __reg64 {
 125         __int64_t       r_r15;
 126         __int64_t       r_r14;
 127         __int64_t       r_r13;
 128         __int64_t       r_r12;
 129         __int64_t       r_r11;
 130         __int64_t       r_r10;
 131         __int64_t       r_r9;
 132         __int64_t       r_r8;
 133         __int64_t       r_rdi;
 134         __int64_t       r_rsi;
 135         __int64_t       r_rbp;
 136         __int64_t       r_rbx;
 137         __int64_t       r_rdx;
 138         __int64_t       r_rcx;
 139         __int64_t       r_rax;
 140         __uint32_t      r_trapno;
 141         __uint16_t      r_fs;
 142         __uint16_t      r_gs;
 143         __uint32_t      r_err;
 144         __uint16_t      r_es;
 145         __uint16_t      r_ds;
 146         __int64_t       r_rip;
 147         __int64_t       r_cs;
 148         __int64_t       r_rflags;
 149         __int64_t       r_rsp;
 150         __int64_t       r_ss;
 151 };
 152
 153 /*
 154  * Register set accessible via /proc/$pid/fpregs.
 155  *
 156  * XXX should get struct from fpu.h.  Here we give a slightly
 157  * simplified struct.  This may be too much detail.  Perhaps
 158  * an array of unsigned longs is best.
 159  */
 160 struct __fpreg32 {
 161         __uint32_t      fpr_env[7];
 162         __uint8_t       fpr_acc[8][10];
 163         __uint32_t      fpr_ex_sw;
 164         __uint8_t       fpr_pad[64];
 165 };
 166
 167 struct __fpreg64 {
 168         __uint64_t      fpr_env[4];
 169         __uint8_t       fpr_acc[8][16];
 170         __uint8_t       fpr_xacc[16][16];
 171         __uint64_t      fpr_spare[12];
 172 };
 173
 174 /*
 175  * Register set accessible via PT_GETXMMREGS (i386).
 176  */
 177 struct xmmreg {
 178         /*
 179          * XXX should get struct from npx.h.  Here we give a slightly
 180          * simplified struct.  This may be too much detail.  Perhaps
 181          * an array of unsigned longs is best.
 182          */
 183         __uint32_t      xmm_env[8];
 184         __uint8_t       xmm_acc[8][16];
 185         __uint8_t       xmm_reg[8][16];
 186         __uint8_t       xmm_pad[224];
 187 };
 188
 189 /*
 190  * Register set accessible via /proc/$pid/dbregs.
 191  */
 192 struct __dbreg32 {
 193         __uint32_t      dr[8];  /* debug registers */
 194                                 /* Index 0-3: debug address registers */
 195                                 /* Index 4-5: reserved */
 196                                 /* Index 6: debug status */
 197                                 /* Index 7: debug control */
 198 };
 199
 200 struct __dbreg64 {
 201         __uint64_t      dr[16]; /* debug registers */
 202                                 /* Index 0-3: debug address registers */
 203                                 /* Index 4-5: reserved */
 204                                 /* Index 6: debug status */
 205                                 /* Index 7: debug control */
 206                                 /* Index 8-15: reserved */
 207 };
 208
 209 #define DBREG_DR6_RESERVED1     0xffff0ff0
 210 #define DBREG_DR6_BMASK         0x000f
 211 #define DBREG_DR6_B(i)          (1 << (i))
 212 #define DBREG_DR6_BD            0x2000
 213 #define DBREG_DR6_BS            0x4000
 214 #define DBREG_DR6_BT            0x8000
 215
 216 #define DBREG_DR7_RESERVED1     0x0400
 217 #define DBREG_DR7_LOCAL_ENABLE  0x01
 218 #define DBREG_DR7_GLOBAL_ENABLE 0x02
 219 #define DBREG_DR7_LEN_1         0x00    /* 1 byte length          */
 220 #define DBREG_DR7_LEN_2         0x01
 221 #define DBREG_DR7_LEN_4         0x03
 222 #define DBREG_DR7_LEN_8         0x02
 223 #define DBREG_DR7_EXEC          0x00    /* break on execute       */
 224 #define DBREG_DR7_WRONLY        0x01    /* break on write         */
 225 #define DBREG_DR7_RDWR          0x03    /* break on read or write */
 226 #define DBREG_DR7_MASK(i)       \
 227         ((__u_register_t)(0xf) << ((i) * 4 + 16) | 0x3 << (i) * 2)
 228 #define DBREG_DR7_SET(i, len, access, enable)                           \
 229         ((__u_register_t)((len) << 2 | (access)) << ((i) * 4 + 16) |    \
 230         (enable) << (i) * 2)
 231 #define DBREG_DR7_GD            0x2000
 232 #define DBREG_DR7_ENABLED(d, i) (((d) & 0x3 << (i) * 2) != 0)
 233 #define DBREG_DR7_ACCESS(d, i)  ((d) >> ((i) * 4 + 16) & 0x3)
 234 #define DBREG_DR7_LEN(d, i)     ((d) >> ((i) * 4 + 18) & 0x3)
 235
 236 #define DBREG_DRX(d,x)  ((d)->dr[(x)])  /* reference dr0 - dr7 by
 237                                            register number */
 238
 239 #undef __reg32
 240 #undef __reg64
 241 #undef __fpreg32
 242 #undef __fpreg64
 243 #undef __dbreg32
 244 #undef __dbreg64
 245
 246 #ifdef _KERNEL
 247 struct thread;
 248
 249 /*
 250  * XXX these interfaces are MI, so they should be declared in a MI place.
 251  */
 252 int     fill_regs(struct thread *, struct reg *);
 253 int     fill_frame_regs(struct trapframe *, struct reg *);
 254 int     set_regs(struct thread *, struct reg *);
 255 int     fill_fpregs(struct thread *, struct fpreg *);
 256 int     set_fpregs(struct thread *, struct fpreg *);
 257 int     fill_dbregs(struct thread *, struct dbreg *);
 258 int     set_dbregs(struct thread *, struct dbreg *);
 259 #ifdef COMPAT_FREEBSD32
 260 int     fill_regs32(struct thread *, struct reg32 *);
 261 int     set_regs32(struct thread *, struct reg32 *);
 262 int     fill_fpregs32(struct thread *, struct fpreg32 *);
 263 int     set_fpregs32(struct thread *, struct fpreg32 *);
 264 int     fill_dbregs32(struct thread *, struct dbreg32 *);
 265 int     set_dbregs32(struct thread *, struct dbreg32 *);
 266 #endif
 267 #endif
 268
 269 #endif /* !_MACHINE_REG_H_ */