NEWS: Remove empty line.
[external/binutils.git] / gdb / i387-tdep.h
1 /* Target-dependent code for the i387.
2
3    Copyright (C) 2000-2016 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 struct frame_info;
25 struct regcache;
26 struct type;
27 struct ui_file;
28
29 /* Number of i387 floating point registers.  */
30 #define I387_NUM_REGS   16
31
32 #define I387_ST0_REGNUM(tdep) ((tdep)->st0_regnum)
33 #define I387_NUM_XMM_REGS(tdep) ((tdep)->num_xmm_regs)
34 #define I387_NUM_XMM_AVX512_REGS(tdep) ((tdep)->num_xmm_avx512_regs)
35 #define I387_MM0_REGNUM(tdep) ((tdep)->mm0_regnum)
36 #define I387_NUM_YMM_REGS(tdep) ((tdep)->num_ymm_regs)
37 #define I387_YMM0H_REGNUM(tdep) ((tdep)->ymm0h_regnum)
38
39 #define I387_BND0R_REGNUM(tdep) ((tdep)->bnd0r_regnum)
40 #define I387_BNDCFGU_REGNUM(tdep) ((tdep)->bndcfgu_regnum)
41
42 /* Set of constants used for 32 and 64-bit.  */
43 #define I387_NUM_MPX_REGS 6
44 #define I387_NUM_BND_REGS 4
45 #define I387_NUM_MPX_CTRL_REGS 2
46 #define I387_NUM_K_REGS 8
47
48 #define I387_K0_REGNUM(tdep) ((tdep)->k0_regnum)
49 #define I387_NUM_ZMMH_REGS(tdep) ((tdep)->num_zmm_regs)
50 #define I387_ZMM0H_REGNUM(tdep) ((tdep)->zmm0h_regnum)
51 #define I387_NUM_YMM_AVX512_REGS(tdep) ((tdep)->num_ymm_avx512_regs)
52 #define I387_YMM16H_REGNUM(tdep) ((tdep)->ymm16h_regnum)
53
54 #define I387_FCTRL_REGNUM(tdep) (I387_ST0_REGNUM (tdep) + 8)
55 #define I387_FSTAT_REGNUM(tdep) (I387_FCTRL_REGNUM (tdep) + 1)
56 #define I387_FTAG_REGNUM(tdep) (I387_FCTRL_REGNUM (tdep) + 2)
57 #define I387_FISEG_REGNUM(tdep) (I387_FCTRL_REGNUM (tdep) + 3)
58 #define I387_FIOFF_REGNUM(tdep) (I387_FCTRL_REGNUM (tdep) + 4)
59 #define I387_FOSEG_REGNUM(tdep) (I387_FCTRL_REGNUM (tdep) + 5)
60 #define I387_FOOFF_REGNUM(tdep) (I387_FCTRL_REGNUM (tdep) + 6)
61 #define I387_FOP_REGNUM(tdep) (I387_FCTRL_REGNUM (tdep) + 7)
62 #define I387_XMM0_REGNUM(tdep) (I387_ST0_REGNUM (tdep) + 16)
63 #define I387_XMM16_REGNUM(tdep) ((tdep)->xmm16_regnum)
64 #define I387_MXCSR_REGNUM(tdep) \
65   (I387_XMM0_REGNUM (tdep) + I387_NUM_XMM_REGS (tdep))
66 #define I387_YMM0_REGNUM(tdep) (I387_MXCSR_REGNUM(tdep) + 1)
67 #define I387_YMMENDH_REGNUM(tdep) \
68   (I387_YMM0H_REGNUM (tdep) + I387_NUM_YMM_REGS (tdep))
69
70 #define I387_MPXEND_REGNUM(tdep) \
71   (I387_BND0R_REGNUM (tdep) + I387_NUM_MPX_REGS)
72
73 #define I387_KEND_REGNUM(tdep) \
74   (I387_K0_REGNUM (tdep) + I387_NUM_K_REGS)
75 #define I387_ZMMENDH_REGNUM(tdep) \
76   (I387_ZMM0H_REGNUM (tdep) + I387_NUM_ZMMH_REGS (tdep))
77 #define I387_YMMH_AVX512_END_REGNUM(tdep) \
78   (I387_YMM16H_REGNUM (tdep) + I387_NUM_YMM_AVX512_REGS (tdep))
79 #define I387_XMM_AVX512_END_REGNUM(tdep) \
80   (I387_XMM16_REGNUM (tdep) + I387_NUM_XMM_AVX512_REGS (tdep))
81
82 /* Print out the i387 floating point state.  */
83
84 extern void i387_print_float_info (struct gdbarch *gdbarch,
85                                    struct ui_file *file,
86                                    struct frame_info *frame,
87                                    const char *args);
88
89 /* Return nonzero if a value of type TYPE stored in register REGNUM
90    needs any special handling.  */
91
92 extern int i387_convert_register_p (struct gdbarch *gdbarch, int regnum,
93                                     struct type *type);
94
95 /* Read a value of type TYPE from register REGNUM in frame FRAME, and
96    return its contents in TO.  */
97
98 extern int i387_register_to_value (struct frame_info *frame, int regnum,
99                                    struct type *type, gdb_byte *to,
100                                    int *optimizedp, int *unavailablep);
101
102 /* Write the contents FROM of a value of type TYPE into register
103    REGNUM in frame FRAME.  */
104
105 extern void i387_value_to_register (struct frame_info *frame, int regnum,
106                                     struct type *type, const gdb_byte *from);
107 \f
108
109 /* Size of the memory area use by the 'fsave' and 'fxsave'
110    instructions.  */
111 #define I387_SIZEOF_FSAVE       108
112 #define I387_SIZEOF_FXSAVE      512
113
114 /* Fill register REGNUM in REGCACHE with the appropriate value from
115    *FSAVE.  This function masks off any of the reserved bits in
116    *FSAVE.  */
117
118 extern void i387_supply_fsave (struct regcache *regcache, int regnum,
119                                const void *fsave);
120
121 /* Fill register REGNUM (if it is a floating-point register) in *FSAVE
122    with the value from REGCACHE.  If REGNUM is -1, do this for all
123    registers.  This function doesn't touch any of the reserved bits in
124    *FSAVE.  */
125
126 extern void i387_collect_fsave (const struct regcache *regcache, int regnum,
127                                 void *fsave);
128
129 /* Fill register REGNUM in REGCACHE with the appropriate
130    floating-point or SSE register value from *FXSAVE.  This function
131    masks off any of the reserved bits in *FXSAVE.  */
132
133 extern void i387_supply_fxsave (struct regcache *regcache, int regnum,
134                                 const void *fxsave);
135
136 /* Similar to i387_supply_fxsave, but use XSAVE extended state.  */
137
138 extern void i387_supply_xsave (struct regcache *regcache, int regnum,
139                                const void *xsave);
140
141 /* Fill register REGNUM (if it is a floating-point or SSE register) in
142    *FXSAVE with the value from REGCACHE.  If REGNUM is -1, do this for
143    all registers.  This function doesn't touch any of the reserved
144    bits in *FXSAVE.  */
145
146 extern void i387_collect_fxsave (const struct regcache *regcache, int regnum,
147                                  void *fxsave);
148
149 /* Similar to i387_collect_fxsave, but use XSAVE extended state.  */
150
151 extern void i387_collect_xsave (const struct regcache *regcache,
152                                 int regnum, void *xsave, int gcore);
153
154 /* Prepare the FPU stack in REGCACHE for a function return.  */
155
156 extern void i387_return_value (struct gdbarch *gdbarch,
157                                struct regcache *regcache);
158
159 #endif /* i387-tdep.h */