* i386-tdep.h (struct regset): Declare opaque.
[external/binutils.git] / gdb / i386-tdep.h
1 /* Target-dependent code for the i386.
2
3    Copyright 2001, 2002, 2003
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 2 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, write to the Free Software
20    Foundation, Inc., 59 Temple Place - Suite 330,
21    Boston, MA 02111-1307, USA.  */
22
23 #ifndef I386_TDEP_H
24 #define I386_TDEP_H
25
26 struct frame_info;
27 struct gdbarch;
28 struct reggroup;
29 struct regset;
30
31 /* GDB's i386 target supports both the 32-bit Intel Architecture
32    (IA-32) and the 64-bit AMD x86-64 architecture.  Internally it uses
33    a similar register layout for both.
34
35    - General purpose registers
36    - FPU data registers
37    - FPU control registers
38    - SSE data registers
39    - SSE control register
40
41    The general purpose registers for the x86-64 architecture are quite
42    different from IA-32.  Therefore, the FP0_REGNUM target macro
43    determines the register number at which the FPU data registers
44    start.  The number of FPU data and control registers is the same
45    for both architectures.  The number of SSE registers however,
46    differs and is determined by the num_xmm_regs member of `struct
47    gdbarch_tdep'.  */
48
49 /* Convention for returning structures.  */
50
51 enum struct_return
52 {
53   pcc_struct_return,            /* Return "short" structures in memory.  */
54   reg_struct_return             /* Return "short" structures in registers.  */
55 };
56
57 /* i386 architecture specific information.  */
58 struct gdbarch_tdep
59 {
60   /* General-purpose registers.  */
61   struct regset *gregset;
62   int *gregset_reg_offset;
63   int gregset_num_regs;
64   size_t sizeof_gregset;
65
66   /* Floating-point registers.  */
67   struct regset *fpregset;
68   size_t sizeof_fpregset;
69
70   /* Register number for %st(0).  The register numbers for the other
71      registers follow from this one.  Set this to -1 to indicate the
72      absence of an FPU.  */
73   int st0_regnum;
74
75   /* Register number for %mm0.  Set this to -1 to indicate the absence
76      of MMX support.  */
77   int mm0_regnum;
78
79   /* Number of SSE registers.  */
80   int num_xmm_regs;
81
82   /* Offset of saved PC in jmp_buf.  */
83   int jb_pc_offset;
84
85   /* Convention for returning structures.  */
86   enum struct_return struct_return;
87
88   /* Address range where sigtramp lives.  */
89   CORE_ADDR sigtramp_start;
90   CORE_ADDR sigtramp_end;
91
92   /* Get address of sigcontext for sigtramp.  */
93   CORE_ADDR (*sigcontext_addr) (struct frame_info *);
94
95   /* Offset of registers in `struct sigcontext'.  */
96   int *sc_reg_offset;
97   int sc_num_regs;
98
99   /* Offset of saved PC and SP in `struct sigcontext'.  Usage of these
100      is deprecated, please use `sc_reg_offset' instead.  */
101   int sc_pc_offset;
102   int sc_sp_offset;
103 };
104
105 /* Floating-point registers.  */
106
107 #define FPU_REG_RAW_SIZE 10
108
109 /* All FPU control regusters (except for FIOFF and FOOFF) are 16-bit
110    (at most) in the FPU, but are zero-extended to 32 bits in GDB's
111    register cache.  */
112
113 /* "Generic" floating point control register.  */
114 #define FPC_REGNUM      (FP0_REGNUM + 8)
115
116 /* FPU control word.  */
117 #define FCTRL_REGNUM    FPC_REGNUM
118
119 /* FPU status word.  */
120 #define FSTAT_REGNUM    (FPC_REGNUM + 1)
121
122 /* FPU register tag word.  */
123 #define FTAG_REGNUM     (FPC_REGNUM + 2)
124
125 /* FPU instruction's code segment selector, called "FPU Instruction
126    Pointer Selector" in the IA-32 manuals.  */
127 #define FISEG_REGNUM    (FPC_REGNUM + 3)
128
129 /* FPU instruction's offset within segment.  */
130 #define FIOFF_REGNUM    (FPC_REGNUM + 4)
131
132 /* FPU operand's data segment.  */
133 #define FOSEG_REGNUM    (FPC_REGNUM + 5)
134
135 /* FPU operand's offset within segment */
136 #define FOOFF_REGNUM    (FPC_REGNUM + 6)
137
138 /* FPU opcode, bottom eleven bits.  */
139 #define FOP_REGNUM      (FPC_REGNUM + 7)
140
141 /* Return non-zero if REGNUM matches the FP register and the FP
142    register set is active.  */
143 extern int i386_fp_regnum_p (int regnum);
144 extern int i386_fpc_regnum_p (int regnum);
145
146 /* SSE registers.  */
147
148 /* First SSE data register.  */
149 #define XMM0_REGNUM     (FPC_REGNUM + 8)
150
151 /* SSE control/status register.  */
152 #define MXCSR_REGNUM \
153   (XMM0_REGNUM + gdbarch_tdep (current_gdbarch)->num_xmm_regs)
154
155 /* FIXME: kettenis/2001-11-24: Obsolete macro's.  */
156 #define FCS_REGNUM FISEG_REGNUM
157 #define FCOFF_REGNUM FIOFF_REGNUM
158 #define FDS_REGNUM FOSEG_REGNUM
159 #define FDOFF_REGNUM FOOFF_REGNUM
160
161 /* Register numbers of various important registers.  */
162
163 #define I386_EAX_REGNUM         0 /* %eax */
164 #define I386_EDX_REGNUM         2 /* %edx */
165 #define I386_ESP_REGNUM         4 /* %esp */
166 #define I386_EBP_REGNUM         5 /* %ebp */
167 #define I386_EIP_REGNUM         8 /* %eip */
168 #define I386_EFLAGS_REGNUM      9 /* %eflags */
169 #define I386_ST0_REGNUM         16 /* %st(0) */
170
171 #define I386_NUM_GREGS  16
172 #define I386_NUM_FREGS  16
173 #define I386_NUM_XREGS  9
174
175 #define I386_SSE_NUM_REGS       (I386_NUM_GREGS + I386_NUM_FREGS \
176                                  + I386_NUM_XREGS)
177
178 /* Size of the largest register.  */
179 #define I386_MAX_REGISTER_SIZE  16
180
181 /* Functions exported from i386-tdep.c.  */
182 extern CORE_ADDR i386_pe_skip_trampoline_code (CORE_ADDR pc, char *name);
183 extern int i386_frameless_signal_p (struct frame_info *frame);
184
185 /* Return the name of register REG.  */
186 extern char const *i386_register_name (int reg);
187
188 /* Return non-zero if REGNUM is a member of the specified group.  */
189 extern int i386_register_reggroup_p (struct gdbarch *gdbarch, int regnum,
190                                      struct reggroup *group);
191
192 /* Initialize a basic ELF architecture variant.  */
193 extern void i386_elf_init_abi (struct gdbarch_info, struct gdbarch *);
194
195 /* Initialize a SVR4 architecture variant.  */
196 extern void i386_svr4_init_abi (struct gdbarch_info, struct gdbarch *);
197 \f
198
199 /* Functions and variables exported from i386bsd-tdep.c.  */
200
201 extern void i386bsd_init_abi (struct gdbarch_info, struct gdbarch *);
202 extern CORE_ADDR i386fbsd_sigtramp_start;
203 extern CORE_ADDR i386fbsd_sigtramp_end;
204 extern CORE_ADDR i386obsd_sigtramp_start;
205 extern CORE_ADDR i386obsd_sigtramp_end;
206 extern int i386fbsd4_sc_reg_offset[];
207 extern int i386fbsd_sc_reg_offset[];
208 extern int i386nbsd_sc_reg_offset[];
209 extern int i386obsd_sc_reg_offset[];
210 extern int i386bsd_sc_reg_offset[];
211
212 #endif /* i386-tdep.h */