* i386-tdep.h: Put opaque declarations in alphabetical
[platform/upstream/binutils.git] / gdb / i387-tdep.h
1 /* Target-dependent code for the i387.
2
3    Copyright 2000, 2001, 2002, 2003 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 2 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, write to the Free Software
19    Foundation, Inc., 59 Temple Place - Suite 330,
20    Boston, MA 02111-1307, USA.  */
21
22 #ifndef I387_TDEP_H
23 #define I387_TDEP_H
24
25 struct gdbarch;
26 struct ui_file;
27 struct frame_info;
28 struct type;
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 /* Read a value of type TYPE from register REGNUM in frame FRAME, and
59    return its contents in TO.  */
60
61 extern void i387_register_to_value (struct frame_info *frame, int regnum,
62                                     struct type *type, void *to);
63
64 /* Write the contents FROM of a value of type TYPE into register
65    REGNUM in frame FRAME.  */
66
67 extern void i387_value_to_register (struct frame_info *frame, int regnum,
68                                     struct type *type, const void *from);
69 \f
70
71 /* Size of the memory area use by the 'fsave' and 'fxsave'
72    instructions.  */
73 #define I387_SIZEOF_FSAVE       108
74 #define I387_SIZEOF_FXSAVE      512
75
76 /* Fill register REGNUM in GDB's register cache with the appropriate
77    value from *FSAVE.  This function masks off any of the reserved
78    bits in *FSAVE.  */
79
80 extern void i387_supply_fsave (const void *fsave, int regnum);
81
82 /* Fill register REGNUM (if it is a floating-point register) in *FSAVE
83    with the value in GDB's register cache.  If REGNUM is -1, do this
84    for all registers.  This function doesn't touch any of the reserved
85    bits in *FSAVE.  */
86
87 extern void i387_fill_fsave (void *fsave, int regnum);
88
89 /* Fill register REGNUM in GDB's register cache with the appropriate
90    floating-point or SSE register value from *FXSAVE.  This function
91    masks off any of the reserved bits in *FXSAVE.  */
92
93 extern void i387_supply_fxsave (const void *fxsave, int regnum);
94
95 /* Fill register REGNUM (if it is a floating-point or SSE register) in
96    *FXSAVE with the value in GDB's register cache.  If REGNUM is -1, do
97    this for all registers.  This function doesn't touch any of the
98    reserved bits in *FXSAVE.  */
99
100 extern void i387_fill_fxsave (void *fxsave, int regnum);
101
102 #endif /* i387-tdep.h */