* i386-tdep.h (struct gdbarch_tdep): Add i386_eflags_type and
[external/binutils.git] / gdb / i386-tdep.h
1 /* Target-dependent code for the i386.
2
3    Copyright (C) 2001, 2002, 2003, 2004, 2006, 2007, 2008, 2009
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 I386_TDEP_H
22 #define I386_TDEP_H
23
24 struct frame_info;
25 struct gdbarch;
26 struct reggroup;
27 struct regset;
28 struct regcache;
29
30 /* GDB's i386 target supports both the 32-bit Intel Architecture
31    (IA-32) and the 64-bit AMD x86-64 architecture.  Internally it uses
32    a similar register layout for both.
33
34    - General purpose registers
35    - FPU data registers
36    - FPU control registers
37    - SSE data registers
38    - SSE control register
39
40    The general purpose registers for the x86-64 architecture are quite
41    different from IA-32.  Therefore, gdbarch_fp0_regnum
42    determines the register number at which the FPU data registers
43    start.  The number of FPU data and control registers is the same
44    for both architectures.  The number of SSE registers however,
45    differs and is determined by the num_xmm_regs member of `struct
46    gdbarch_tdep'.  */
47
48 /* Convention for returning structures.  */
49
50 enum struct_return
51 {
52   pcc_struct_return,            /* Return "short" structures in memory.  */
53   reg_struct_return             /* Return "short" structures in registers.  */
54 };
55
56 /* i386 architecture specific information.  */
57 struct gdbarch_tdep
58 {
59   /* General-purpose registers.  */
60   struct regset *gregset;
61   int *gregset_reg_offset;
62   int gregset_num_regs;
63   size_t sizeof_gregset;
64
65   /* Floating-point registers.  */
66   struct regset *fpregset;
67   size_t sizeof_fpregset;
68
69   /* Register number for %st(0).  The register numbers for the other
70      registers follow from this one.  Set this to -1 to indicate the
71      absence of an FPU.  */
72   int st0_regnum;
73
74   /* Register number for %mm0.  Set this to -1 to indicate the absence
75      of MMX support.  */
76   int mm0_regnum;
77
78   /* Number of SSE registers.  */
79   int num_xmm_regs;
80
81   /* Offset of saved PC in jmp_buf.  */
82   int jb_pc_offset;
83
84   /* Convention for returning structures.  */
85   enum struct_return struct_return;
86
87   /* Address range where sigtramp lives.  */
88   CORE_ADDR sigtramp_start;
89   CORE_ADDR sigtramp_end;
90
91   /* Detect sigtramp.  */
92   int (*sigtramp_p) (struct frame_info *);
93
94   /* Get address of sigcontext for sigtramp.  */
95   CORE_ADDR (*sigcontext_addr) (struct frame_info *);
96
97   /* Offset of registers in `struct sigcontext'.  */
98   int *sc_reg_offset;
99   int sc_num_regs;
100
101   /* Offset of saved PC and SP in `struct sigcontext'.  Usage of these
102      is deprecated, please use `sc_reg_offset' instead.  */
103   int sc_pc_offset;
104   int sc_sp_offset;
105
106   /* ISA-specific data types.  */
107   struct type *i386_eflags_type;
108   struct type *i386_mxcsr_type;
109   struct type *i386_mmx_type;
110   struct type *i386_sse_type;
111   struct type *i387_ext_type;
112
113   /* Process record/replay target.  */
114   /* Parse intx80 args.  */
115   int (*i386_intx80_record) (struct regcache *regcache);
116   /* Parse sysenter args.  */
117   int (*i386_sysenter_record) (struct regcache *regcache);
118 };
119
120 /* Floating-point registers.  */
121
122 /* All FPU control regusters (except for FIOFF and FOOFF) are 16-bit
123    (at most) in the FPU, but are zero-extended to 32 bits in GDB's
124    register cache.  */
125
126 /* Return non-zero if REGNUM matches the FP register and the FP
127    register set is active.  */
128 extern int i386_fp_regnum_p (struct gdbarch *, int);
129 extern int i386_fpc_regnum_p (struct gdbarch *, int);
130
131 /* Register numbers of various important registers.  */
132
133 enum i386_regnum
134 {
135   I386_EAX_REGNUM,              /* %eax */
136   I386_ECX_REGNUM,              /* %ecx */
137   I386_EDX_REGNUM,              /* %edx */
138   I386_EBX_REGNUM,              /* %ebx */
139   I386_ESP_REGNUM,              /* %esp */
140   I386_EBP_REGNUM,              /* %ebp */
141   I386_ESI_REGNUM,              /* %esi */
142   I386_EDI_REGNUM,              /* %edi */
143   I386_EIP_REGNUM,              /* %eip */
144   I386_EFLAGS_REGNUM,           /* %eflags */
145   I386_CS_REGNUM,               /* %cs */
146   I386_SS_REGNUM,               /* %ss */
147   I386_DS_REGNUM,               /* %ds */
148   I386_ES_REGNUM,               /* %es */
149   I386_FS_REGNUM,               /* %fs */
150   I386_GS_REGNUM,               /* %gs */
151   I386_ST0_REGNUM               /* %st(0) */
152 };
153
154 #define I386_NUM_GREGS  16
155 #define I386_NUM_FREGS  16
156 #define I386_NUM_XREGS  9
157
158 #define I386_SSE_NUM_REGS       (I386_NUM_GREGS + I386_NUM_FREGS \
159                                  + I386_NUM_XREGS)
160
161 /* Size of the largest register.  */
162 #define I386_MAX_REGISTER_SIZE  16
163
164 /* Types for i386-specific registers.  */
165 extern struct type *i386_eflags_type (struct gdbarch *gdbarch);
166 extern struct type *i386_mxcsr_type (struct gdbarch *gdbarch);
167 extern struct type *i386_mmx_type (struct gdbarch *gdbarch);
168 extern struct type *i386_sse_type (struct gdbarch *gdbarch);
169 extern struct type *i387_ext_type (struct gdbarch *gdbarch);
170
171 /* Segment selectors.  */
172 #define I386_SEL_RPL    0x0003  /* Requester's Privilege Level mask.  */
173 #define I386_SEL_UPL    0x0003  /* User Privilige Level. */
174 #define I386_SEL_KPL    0x0000  /* Kernel Privilige Level. */
175
176 /* The length of the longest i386 instruction (according to
177    include/asm-i386/kprobes.h in Linux 2.6.  */
178 #define I386_MAX_INSN_LEN (16)
179
180 /* Functions exported from i386-tdep.c.  */
181 extern CORE_ADDR i386_pe_skip_trampoline_code (CORE_ADDR pc, char *name);
182 extern CORE_ADDR i386_skip_main_prologue (struct gdbarch *gdbarch, CORE_ADDR pc);
183
184 /* Return whether the THIS_FRAME corresponds to a sigtramp routine.  */
185 extern int i386_sigtramp_p (struct frame_info *this_frame);
186
187 /* Return the name of register REGNUM.  */
188 extern char const *i386_register_name (struct gdbarch * gdbarch, int regnum);
189
190 /* Return non-zero if REGNUM is a member of the specified group.  */
191 extern int i386_register_reggroup_p (struct gdbarch *gdbarch, int regnum,
192                                      struct reggroup *group);
193
194 /* Supply register REGNUM from the general-purpose register set REGSET
195    to register cache REGCACHE.  If REGNUM is -1, do this for all
196    registers in REGSET.  */
197 extern void i386_supply_gregset (const struct regset *regset,
198                                  struct regcache *regcache, int regnum,
199                                  const void *gregs, size_t len);
200
201 /* Collect register REGNUM from the register cache REGCACHE and store
202    it in the buffer specified by GREGS and LEN as described by the
203    general-purpose register set REGSET.  If REGNUM is -1, do this for
204    all registers in REGSET.  */
205 extern void i386_collect_gregset (const struct regset *regset,
206                                   const struct regcache *regcache,
207                                   int regnum, void *gregs, size_t len);
208
209 /* Return the appropriate register set for the core section identified
210    by SECT_NAME and SECT_SIZE.  */
211 extern const struct regset *
212   i386_regset_from_core_section (struct gdbarch *gdbarch,
213                                  const char *sect_name, size_t sect_size);
214
215
216 extern void i386_displaced_step_fixup (struct gdbarch *gdbarch,
217                                        struct displaced_step_closure *closure,
218                                        CORE_ADDR from, CORE_ADDR to,
219                                        struct regcache *regs);
220
221 /* Initialize a basic ELF architecture variant.  */
222 extern void i386_elf_init_abi (struct gdbarch_info, struct gdbarch *);
223
224 /* Initialize a SVR4 architecture variant.  */
225 extern void i386_svr4_init_abi (struct gdbarch_info, struct gdbarch *);
226
227 extern int i386_process_record (struct gdbarch *gdbarch,
228                                 struct regcache *regcache, CORE_ADDR addr);
229 \f
230
231 /* Functions and variables exported from i386bsd-tdep.c.  */
232
233 extern void i386bsd_init_abi (struct gdbarch_info, struct gdbarch *);
234 extern CORE_ADDR i386fbsd_sigtramp_start_addr;
235 extern CORE_ADDR i386fbsd_sigtramp_end_addr;
236 extern CORE_ADDR i386obsd_sigtramp_start_addr;
237 extern CORE_ADDR i386obsd_sigtramp_end_addr;
238 extern int i386fbsd4_sc_reg_offset[];
239 extern int i386fbsd_sc_reg_offset[];
240 extern int i386nbsd_sc_reg_offset[];
241 extern int i386obsd_sc_reg_offset[];
242 extern int i386bsd_sc_reg_offset[];
243
244 #endif /* i386-tdep.h */