Updated copyright notices for most files.
[external/binutils.git] / gdb / i387-tdep.h
1 /* Target-dependent code for the i387.
2
3    Copyright (C) 2000, 2001, 2002, 2003, 2004, 2007, 2008
4    Free Software Foundation, Inc.
5
6    This file is part of GDB.
7
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 3 of the License, or
11    (at your option) any later version.
12
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
20
21 #ifndef I387_TDEP_H
22 #define I387_TDEP_H
23
24 struct gdbarch;
25 struct frame_info;
26 struct regcache;
27 struct type;
28 struct ui_file;
29
30 /* Because the number of general-purpose registers is different for
31    AMD64, the floating-point registers and SSE registers get shifted.
32    The following definitions are intended to help writing code that
33    needs the register numbers of floating-point registers and SSE
34    registers.  In order to use these, one should provide a definition
35    for I387_ST0_REGNUM, and possibly I387_NUM_XMM_REGS, preferably by
36    using a local "#define" in the body of the function that uses this.
37    Please "#undef" them before the end of the function.  */
38
39 #define I387_FCTRL_REGNUM       (I387_ST0_REGNUM + 8)
40 #define I387_FSTAT_REGNUM       (I387_FCTRL_REGNUM + 1)
41 #define I387_FTAG_REGNUM        (I387_FCTRL_REGNUM + 2)
42 #define I387_FISEG_REGNUM       (I387_FCTRL_REGNUM + 3)
43 #define I387_FIOFF_REGNUM       (I387_FCTRL_REGNUM + 4)
44 #define I387_FOSEG_REGNUM       (I387_FCTRL_REGNUM + 5)
45 #define I387_FOOFF_REGNUM       (I387_FCTRL_REGNUM + 6)
46 #define I387_FOP_REGNUM         (I387_FCTRL_REGNUM + 7)
47 #define I387_XMM0_REGNUM        (I387_ST0_REGNUM + 16)
48 #define I387_MXCSR_REGNUM       (I387_XMM0_REGNUM + I387_NUM_XMM_REGS)
49 \f
50
51 /* Print out the i387 floating point state.  */
52
53 extern void i387_print_float_info (struct gdbarch *gdbarch,
54                                    struct ui_file *file,
55                                    struct frame_info *frame,
56                                    const char *args);
57
58 /* Return nonzero if a value of type TYPE stored in register REGNUM
59    needs any special handling.  */
60
61 extern int i387_convert_register_p (struct gdbarch *gdbarch, int regnum,
62                                     struct type *type);
63
64 /* Read a value of type TYPE from register REGNUM in frame FRAME, and
65    return its contents in TO.  */
66
67 extern void i387_register_to_value (struct frame_info *frame, int regnum,
68                                     struct type *type, gdb_byte *to);
69
70 /* Write the contents FROM of a value of type TYPE into register
71    REGNUM in frame FRAME.  */
72
73 extern void i387_value_to_register (struct frame_info *frame, int regnum,
74                                     struct type *type, const gdb_byte *from);
75 \f
76
77 /* Size of the memory area use by the 'fsave' and 'fxsave'
78    instructions.  */
79 #define I387_SIZEOF_FSAVE       108
80 #define I387_SIZEOF_FXSAVE      512
81
82 /* Fill register REGNUM in REGCACHE with the appropriate value from
83    *FSAVE.  This function masks off any of the reserved bits in
84    *FSAVE.  */
85
86 extern void i387_supply_fsave (struct regcache *regcache, int regnum,
87                                const void *fsave);
88
89 /* Fill register REGNUM (if it is a floating-point register) in *FSAVE
90    with the value from REGCACHE.  If REGNUM is -1, do this for all
91    registers.  This function doesn't touch any of the reserved bits in
92    *FSAVE.  */
93
94 extern void i387_collect_fsave (const struct regcache *regcache, int regnum,
95                                 void *fsave);
96
97 /* Fill register REGNUM in REGCACHE with the appropriate
98    floating-point or SSE register value from *FXSAVE.  This function
99    masks off any of the reserved bits in *FXSAVE.  */
100
101 extern void i387_supply_fxsave (struct regcache *regcache, int regnum,
102                                 const void *fxsave);
103
104 /* Fill register REGNUM (if it is a floating-point or SSE register) in
105    *FXSAVE with the value from REGCACHE.  If REGNUM is -1, do this for
106    all registers.  This function doesn't touch any of the reserved
107    bits in *FXSAVE.  */
108
109 extern void i387_collect_fxsave (const struct regcache *regcache, int regnum,
110                                  void *fxsave);
111
112 /* Prepare the FPU stack in REGCACHE for a function return.  */
113
114 extern void i387_return_value (struct gdbarch *gdbarch,
115                                struct regcache *regcache);
116
117 #endif /* i387-tdep.h */