gdb/i387-tdep.h

   1 /* Target-dependent code for the i387.
   2
   3    Copyright (C) 2000-2024 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef I387_TDEP_H
  21 #define I387_TDEP_H
  22
  23 struct gdbarch;
  24 class frame_info_ptr;
  25 struct regcache;
  26 struct type;
  27 struct ui_file;
  28 struct x86_xsave_layout;
  29
  30 /* Number of i387 floating point registers.  */
  31 #define I387_NUM_REGS   16
  32
  33 #define I387_ST0_REGNUM(tdep) ((tdep)->st0_regnum)
  34 #define I387_NUM_XMM_REGS(tdep) ((tdep)->num_xmm_regs)
  35 #define I387_NUM_XMM_AVX512_REGS(tdep) ((tdep)->num_xmm_avx512_regs)
  36 #define I387_MM0_REGNUM(tdep) ((tdep)->mm0_regnum)
  37 #define I387_NUM_YMM_REGS(tdep) ((tdep)->num_ymm_regs)
  38 #define I387_YMM0H_REGNUM(tdep) ((tdep)->ymm0h_regnum)
  39
  40 /* Set of constants used for 32 and 64-bit.  */
  41 #define I387_NUM_K_REGS 8
  42 #define I387_NUM_PKEYS_REGS 1
  43
  44 #define I387_PKRU_REGNUM(tdep) ((tdep)->pkru_regnum)
  45 #define I387_K0_REGNUM(tdep) ((tdep)->k0_regnum)
  46 #define I387_NUM_ZMMH_REGS(tdep) ((tdep)->num_zmm_regs)
  47 #define I387_ZMM0H_REGNUM(tdep) ((tdep)->zmm0h_regnum)
  48 #define I387_ZMM16H_REGNUM(tdep) ((tdep)->zmm0h_regnum + 16)
  49 #define I387_NUM_YMM_AVX512_REGS(tdep) ((tdep)->num_ymm_avx512_regs)
  50 #define I387_YMM16H_REGNUM(tdep) ((tdep)->ymm16h_regnum)
  51
  52 #define I387_FCTRL_REGNUM(tdep) (I387_ST0_REGNUM (tdep) + 8)
  53 #define I387_FSTAT_REGNUM(tdep) (I387_FCTRL_REGNUM (tdep) + 1)
  54 #define I387_FTAG_REGNUM(tdep) (I387_FCTRL_REGNUM (tdep) + 2)
  55 #define I387_FISEG_REGNUM(tdep) (I387_FCTRL_REGNUM (tdep) + 3)
  56 #define I387_FIOFF_REGNUM(tdep) (I387_FCTRL_REGNUM (tdep) + 4)
  57 #define I387_FOSEG_REGNUM(tdep) (I387_FCTRL_REGNUM (tdep) + 5)
  58 #define I387_FOOFF_REGNUM(tdep) (I387_FCTRL_REGNUM (tdep) + 6)
  59 #define I387_FOP_REGNUM(tdep) (I387_FCTRL_REGNUM (tdep) + 7)
  60 #define I387_XMM0_REGNUM(tdep) (I387_ST0_REGNUM (tdep) + 16)
  61 #define I387_XMM16_REGNUM(tdep) ((tdep)->xmm16_regnum)
  62 #define I387_MXCSR_REGNUM(tdep) \
  63   (I387_XMM0_REGNUM (tdep) + I387_NUM_XMM_REGS (tdep))
  64 #define I387_YMM0_REGNUM(tdep) (I387_MXCSR_REGNUM(tdep) + 1)
  65 #define I387_YMMENDH_REGNUM(tdep) \
  66   (I387_YMM0H_REGNUM (tdep) + I387_NUM_YMM_REGS (tdep))
  67
  68
  69 #define I387_KEND_REGNUM(tdep) \
  70   (I387_K0_REGNUM (tdep) + I387_NUM_K_REGS)
  71 #define I387_ZMMENDH_REGNUM(tdep) \
  72   (I387_ZMM0H_REGNUM (tdep) + I387_NUM_ZMMH_REGS (tdep))
  73 #define I387_YMMH_AVX512_END_REGNUM(tdep) \
  74   (I387_YMM16H_REGNUM (tdep) + I387_NUM_YMM_AVX512_REGS (tdep))
  75 #define I387_XMM_AVX512_END_REGNUM(tdep) \
  76   (I387_XMM16_REGNUM (tdep) + I387_NUM_XMM_AVX512_REGS (tdep))
  77
  78 #define I387_PKEYSEND_REGNUM(tdep) \
  79   (I387_PKRU_REGNUM (tdep) + I387_NUM_PKEYS_REGS)
  80
  81 /* Print out the i387 floating point state.  */
  82
  83 extern void i387_print_float_info (struct gdbarch *gdbarch,
  84                                    struct ui_file *file,
  85                                    const frame_info_ptr &frame,
  86                                    const char *args);
  87
  88 /* Return nonzero if a value of type TYPE stored in register REGNUM
  89    needs any special handling.  */
  90
  91 extern int i387_convert_register_p (struct gdbarch *gdbarch, int regnum,
  92                                     struct type *type);
  93
  94 /* Read a value of type TYPE from register REGNUM in frame FRAME, and
  95    return its contents in TO.  */
  96
  97 extern int i387_register_to_value (const frame_info_ptr &frame, int regnum,
  98                                    struct type *type, gdb_byte *to,
  99                                    int *optimizedp, int *unavailablep);
 100
 101 /* Write the contents FROM of a value of type TYPE into register
 102    REGNUM in frame FRAME.  */
 103
 104 extern void i387_value_to_register (const frame_info_ptr &frame, int regnum,
 105                                     struct type *type, const gdb_byte *from);
 106 \f
 107
 108 /* Size of the memory area use by the 'fsave' and 'fxsave'
 109    instructions.  */
 110 #define I387_SIZEOF_FSAVE       108
 111 #define I387_SIZEOF_FXSAVE      512
 112
 113 /* Fill register REGNUM in REGCACHE with the appropriate value from
 114    *FSAVE.  This function masks off any of the reserved bits in
 115    *FSAVE.  */
 116
 117 extern void i387_supply_fsave (struct regcache *regcache, int regnum,
 118                                const void *fsave);
 119
 120 /* Fill register REGNUM (if it is a floating-point register) in *FSAVE
 121    with the value from REGCACHE.  If REGNUM is -1, do this for all
 122    registers.  This function doesn't touch any of the reserved bits in
 123    *FSAVE.  */
 124
 125 extern void i387_collect_fsave (const struct regcache *regcache, int regnum,
 126                                 void *fsave);
 127
 128 /* Fill register REGNUM in REGCACHE with the appropriate
 129    floating-point or SSE register value from *FXSAVE.  This function
 130    masks off any of the reserved bits in *FXSAVE.  */
 131
 132 extern void i387_supply_fxsave (struct regcache *regcache, int regnum,
 133                                 const void *fxsave);
 134
 135 /* Select an XSAVE layout based on the XCR0 bitmask and total XSAVE
 136    extended state size.  Returns true if the bitmask and size matched
 137    a known layout.  */
 138
 139 extern bool i387_guess_xsave_layout (uint64_t xcr0, size_t xsave_size,
 140                                      x86_xsave_layout &layout);
 141
 142 /* Compute an XSAVE layout based on the XCR0 bitmask.  This is used
 143    as a fallback if a target does not provide an XSAVE layout.  */
 144
 145 extern x86_xsave_layout i387_fallback_xsave_layout (uint64_t xcr0);
 146
 147 /* Similar to i387_supply_fxsave, but use XSAVE extended state.  */
 148
 149 extern void i387_supply_xsave (struct regcache *regcache, int regnum,
 150                                const void *xsave);
 151
 152 /* Fill register REGNUM (if it is a floating-point or SSE register) in
 153    *FXSAVE with the value from REGCACHE.  If REGNUM is -1, do this for
 154    all registers.  This function doesn't touch any of the reserved
 155    bits in *FXSAVE.  */
 156
 157 extern void i387_collect_fxsave (const struct regcache *regcache, int regnum,
 158                                  void *fxsave);
 159
 160 /* Similar to i387_collect_fxsave, but use XSAVE extended state.  */
 161
 162 extern void i387_collect_xsave (const struct regcache *regcache,
 163                                 int regnum, void *xsave, int gcore);
 164
 165 /* Extract a bitset from XSAVE indicating which features are available in
 166    the inferior, but not yet initialised.  */
 167
 168 extern ULONGEST i387_xsave_get_clear_bv (struct gdbarch *gdbarch,
 169                                          const void *xsave);
 170
 171 /* Prepare the FPU stack in REGCACHE for a function return.  */
 172
 173 extern void i387_return_value (struct gdbarch *gdbarch,
 174                                struct regcache *regcache);
 175
 176 #endif /* i387-tdep.h */