sys/x86/include/fpu.h

   1 /*-
   2  * Copyright (c) 1990 The Regents of the University of California.
   3  * All rights reserved.
   4  *
   5  * This code is derived from software contributed to Berkeley by
   6  * William Jolitz.
   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  * 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  * 4. Neither the name of the University nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  *      from: @(#)npx.h 5.3 (Berkeley) 1/18/91
  33  * $FreeBSD$
  34  */
  35
  36 /*
  37  * Floating Point Data Structures and Constants
  38  * W. Jolitz 1/90
  39  */
  40
  41 #ifndef _X86_FPU_H_
  42 #define _X86_FPU_H_
  43
  44 /* Environment information of floating point unit. */
  45 struct env87 {
  46         int32_t         en_cw;          /* control word (16bits) */
  47         int32_t         en_sw;          /* status word (16bits) */
  48         int32_t         en_tw;          /* tag word (16bits) */
  49         int32_t         en_fip;         /* fp instruction pointer */
  50         uint16_t        en_fcs;         /* fp code segment selector */
  51         uint16_t        en_opcode;      /* opcode last executed (11 bits) */
  52         int32_t         en_foo;         /* fp operand offset */
  53         int32_t         en_fos;         /* fp operand segment selector */
  54 };
  55
  56 /* Contents of each x87 floating point accumulator. */
  57 struct fpacc87 {
  58         uint8_t         fp_bytes[10];
  59 };
  60
  61 /* Floating point context. (i386 fnsave/frstor) */
  62 struct save87 {
  63         struct env87    sv_env;         /* floating point control/status */
  64         struct fpacc87  sv_ac[8];       /* accumulator contents, 0-7 */
  65         uint8_t         sv_pad0[4];     /* saved status word (now unused) */
  66         /*
  67          * Bogus padding for emulators.  Emulators should use their own
  68          * struct and arrange to store into this struct (ending here)
  69          * before it is inspected for ptracing or for core dumps.  Some
  70          * emulators overwrite the whole struct.  We have no good way of
  71          * knowing how much padding to leave.  Leave just enough for the
  72          * GPL emulator's i387_union (176 bytes total).
  73          */
  74         uint8_t         sv_pad[64];     /* padding; used by emulators */
  75 };
  76
  77 /* Contents of each SSE extended accumulator. */
  78 struct xmmacc {
  79         uint8_t         xmm_bytes[16];
  80 };
  81
  82 /* Contents of the upper 16 bytes of each AVX extended accumulator. */
  83 struct ymmacc {
  84         uint8_t         ymm_bytes[16];
  85 };
  86
  87 /* Rename structs below depending on machine architecture. */
  88 #ifdef __i386__
  89 #define __envxmm32      envxmm
  90 #else
  91 #define __envxmm32      envxmm32
  92 #define __envxmm64      envxmm
  93 #endif
  94
  95 struct __envxmm32 {
  96         uint16_t        en_cw;          /* control word (16bits) */
  97         uint16_t        en_sw;          /* status word (16bits) */
  98         uint16_t        en_tw;          /* tag word (16bits) */
  99         uint16_t        en_opcode;      /* opcode last executed (11 bits) */
 100         uint32_t        en_fip;         /* fp instruction pointer */
 101         uint16_t        en_fcs;         /* fp code segment selector */
 102         uint16_t        en_pad0;        /* padding */
 103         uint32_t        en_foo;         /* fp operand offset */
 104         uint16_t        en_fos;         /* fp operand segment selector */
 105         uint16_t        en_pad1;        /* padding */
 106         uint32_t        en_mxcsr;       /* SSE control/status register */
 107         uint32_t        en_mxcsr_mask;  /* valid bits in mxcsr */
 108 };
 109
 110 struct __envxmm64 {
 111         uint16_t        en_cw;          /* control word (16bits) */
 112         uint16_t        en_sw;          /* status word (16bits) */
 113         uint8_t         en_tw;          /* tag word (8bits) */
 114         uint8_t         en_zero;
 115         uint16_t        en_opcode;      /* opcode last executed (11 bits ) */
 116         uint64_t        en_rip;         /* fp instruction pointer */
 117         uint64_t        en_rdp;         /* fp operand pointer */
 118         uint32_t        en_mxcsr;       /* SSE control/status register */
 119         uint32_t        en_mxcsr_mask;  /* valid bits in mxcsr */
 120 };
 121
 122 /* Floating point context. (i386 fxsave/fxrstor) */
 123 struct savexmm {
 124         struct __envxmm32       sv_env;
 125         struct {
 126                 struct fpacc87  fp_acc;
 127                 uint8_t         fp_pad[6];      /* padding */
 128         } sv_fp[8];
 129         struct xmmacc           sv_xmm[8];
 130         uint8_t                 sv_pad[224];
 131 } __aligned(16);
 132
 133 #ifdef __i386__
 134 union savefpu {
 135         struct save87   sv_87;
 136         struct savexmm  sv_xmm;
 137 };
 138 #else
 139 /* Floating point context. (amd64 fxsave/fxrstor) */
 140 struct savefpu {
 141         struct __envxmm64       sv_env;
 142         struct {
 143                 struct fpacc87  fp_acc;
 144                 uint8_t         fp_pad[6];      /* padding */
 145         } sv_fp[8];
 146         struct xmmacc           sv_xmm[16];
 147         uint8_t                 sv_pad[96];
 148 } __aligned(16);
 149 #endif
 150
 151 struct xstate_hdr {
 152         uint64_t        xstate_bv;
 153         uint8_t         xstate_rsrv0[16];
 154         uint8_t         xstate_rsrv[40];
 155 };
 156
 157 struct savexmm_xstate {
 158         struct xstate_hdr       sx_hd;
 159         struct ymmacc           sx_ymm[16];
 160 };
 161
 162 struct savexmm_ymm {
 163         struct __envxmm32       sv_env;
 164         struct {
 165                 struct fpacc87  fp_acc;
 166                 int8_t          fp_pad[6];      /* padding */
 167         } sv_fp[8];
 168         struct xmmacc           sv_xmm[16];
 169         uint8_t                 sv_pad[96];
 170         struct savexmm_xstate   sv_xstate;
 171 } __aligned(64);
 172
 173 struct savefpu_xstate {
 174         struct xstate_hdr       sx_hd;
 175         struct ymmacc           sx_ymm[16];
 176 };
 177
 178 struct savefpu_ymm {
 179         struct __envxmm64       sv_env;
 180         struct {
 181                 struct fpacc87  fp_acc;
 182                 int8_t          fp_pad[6];      /* padding */
 183         } sv_fp[8];
 184         struct xmmacc           sv_xmm[16];
 185         uint8_t                 sv_pad[96];
 186         struct savefpu_xstate   sv_xstate;
 187 } __aligned(64);
 188
 189 #undef __envxmm32
 190 #undef __envxmm64
 191
 192 /*
 193  * The hardware default control word for i387's and later coprocessors is
 194  * 0x37F, giving:
 195  *
 196  *      round to nearest
 197  *      64-bit precision
 198  *      all exceptions masked.
 199  *
 200  * FreeBSD/i386 uses 53 bit precision for things like fadd/fsub/fsqrt etc
 201  * because of the difference between memory and fpu register stack arguments.
 202  * If its using an intermediate fpu register, it has 80/64 bits to work
 203  * with.  If it uses memory, it has 64/53 bits to work with.  However,
 204  * gcc is aware of this and goes to a fair bit of trouble to make the
 205  * best use of it.
 206  *
 207  * This is mostly academic for AMD64, because the ABI prefers the use
 208  * SSE2 based math.  For FreeBSD/amd64, we go with the default settings.
 209  */
 210 #define __INITIAL_FPUCW__       0x037F
 211 #define __INITIAL_FPUCW_I386__  0x127F
 212 #define __INITIAL_NPXCW__       __INITIAL_FPUCW_I386__
 213 #define __INITIAL_MXCSR__       0x1F80
 214 #define __INITIAL_MXCSR_MASK__  0xFFBF
 215
 216 #endif /* !_X86_FPU_H_ */