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   /* The map for registers because the AMD64's registers order
 115      in GDB is not same as I386 instructions.  */
 116   const int *record_regmap;
 117   /* Parse intx80 args.  */
 118   int (*i386_intx80_record) (struct regcache *regcache);
 119   /* Parse sysenter args.  */
 120   int (*i386_sysenter_record) (struct regcache *regcache);
 121   /* Parse syscall args.  */
 122   int (*i386_syscall_record) (struct regcache *regcache);
 123 };
 124
 125 /* Floating-point registers.  */
 126
 127 /* All FPU control regusters (except for FIOFF and FOOFF) are 16-bit
 128    (at most) in the FPU, but are zero-extended to 32 bits in GDB's
 129    register cache.  */
 130
 131 /* Return non-zero if REGNUM matches the FP register and the FP
 132    register set is active.  */
 133 extern int i386_fp_regnum_p (struct gdbarch *, int);
 134 extern int i386_fpc_regnum_p (struct gdbarch *, int);
 135
 136 /* Register numbers of various important registers.  */
 137
 138 enum i386_regnum
 139 {
 140   I386_EAX_REGNUM,              /* %eax */
 141   I386_ECX_REGNUM,              /* %ecx */
 142   I386_EDX_REGNUM,              /* %edx */
 143   I386_EBX_REGNUM,              /* %ebx */
 144   I386_ESP_REGNUM,              /* %esp */
 145   I386_EBP_REGNUM,              /* %ebp */
 146   I386_ESI_REGNUM,              /* %esi */
 147   I386_EDI_REGNUM,              /* %edi */
 148   I386_EIP_REGNUM,              /* %eip */
 149   I386_EFLAGS_REGNUM,           /* %eflags */
 150   I386_CS_REGNUM,               /* %cs */
 151   I386_SS_REGNUM,               /* %ss */
 152   I386_DS_REGNUM,               /* %ds */
 153   I386_ES_REGNUM,               /* %es */
 154   I386_FS_REGNUM,               /* %fs */
 155   I386_GS_REGNUM,               /* %gs */
 156   I386_ST0_REGNUM               /* %st(0) */
 157 };
 158
 159 /* Register numbers of RECORD_REGMAP.  */
 160
 161 enum record_i386_regnum
 162 {
 163   X86_RECORD_REAX_REGNUM,
 164   X86_RECORD_RECX_REGNUM,
 165   X86_RECORD_REDX_REGNUM,
 166   X86_RECORD_REBX_REGNUM,
 167   X86_RECORD_RESP_REGNUM,
 168   X86_RECORD_REBP_REGNUM,
 169   X86_RECORD_RESI_REGNUM,
 170   X86_RECORD_REDI_REGNUM,
 171   X86_RECORD_R8_REGNUM,
 172   X86_RECORD_R9_REGNUM,
 173   X86_RECORD_R10_REGNUM,
 174   X86_RECORD_R11_REGNUM,
 175   X86_RECORD_R12_REGNUM,
 176   X86_RECORD_R13_REGNUM,
 177   X86_RECORD_R14_REGNUM,
 178   X86_RECORD_R15_REGNUM,
 179   X86_RECORD_REIP_REGNUM,
 180   X86_RECORD_EFLAGS_REGNUM,
 181   X86_RECORD_CS_REGNUM,
 182   X86_RECORD_SS_REGNUM,
 183   X86_RECORD_DS_REGNUM,
 184   X86_RECORD_ES_REGNUM,
 185   X86_RECORD_FS_REGNUM,
 186   X86_RECORD_GS_REGNUM,
 187 };
 188
 189 #define I386_NUM_GREGS  16
 190 #define I386_NUM_FREGS  16
 191 #define I386_NUM_XREGS  9
 192
 193 #define I386_SSE_NUM_REGS       (I386_NUM_GREGS + I386_NUM_FREGS \
 194                                  + I386_NUM_XREGS)
 195
 196 /* Size of the largest register.  */
 197 #define I386_MAX_REGISTER_SIZE  16
 198
 199 /* Types for i386-specific registers.  */
 200 extern struct type *i386_eflags_type (struct gdbarch *gdbarch);
 201 extern struct type *i386_mxcsr_type (struct gdbarch *gdbarch);
 202 extern struct type *i386_mmx_type (struct gdbarch *gdbarch);
 203 extern struct type *i386_sse_type (struct gdbarch *gdbarch);
 204 extern struct type *i387_ext_type (struct gdbarch *gdbarch);
 205
 206 /* Segment selectors.  */
 207 #define I386_SEL_RPL    0x0003  /* Requester's Privilege Level mask.  */
 208 #define I386_SEL_UPL    0x0003  /* User Privilige Level. */
 209 #define I386_SEL_KPL    0x0000  /* Kernel Privilige Level. */
 210
 211 /* The length of the longest i386 instruction (according to
 212    include/asm-i386/kprobes.h in Linux 2.6.  */
 213 #define I386_MAX_INSN_LEN (16)
 214
 215 /* Functions exported from i386-tdep.c.  */
 216 extern CORE_ADDR i386_pe_skip_trampoline_code (struct frame_info *frame,
 217                                                CORE_ADDR pc, char *name);
 218 extern CORE_ADDR i386_skip_main_prologue (struct gdbarch *gdbarch, CORE_ADDR pc);
 219
 220 /* Return whether the THIS_FRAME corresponds to a sigtramp routine.  */
 221 extern int i386_sigtramp_p (struct frame_info *this_frame);
 222
 223 /* Return the name of register REGNUM.  */
 224 extern char const *i386_register_name (struct gdbarch * gdbarch, int regnum);
 225
 226 /* Return non-zero if REGNUM is a member of the specified group.  */
 227 extern int i386_register_reggroup_p (struct gdbarch *gdbarch, int regnum,
 228                                      struct reggroup *group);
 229
 230 /* Supply register REGNUM from the general-purpose register set REGSET
 231    to register cache REGCACHE.  If REGNUM is -1, do this for all
 232    registers in REGSET.  */
 233 extern void i386_supply_gregset (const struct regset *regset,
 234                                  struct regcache *regcache, int regnum,
 235                                  const void *gregs, size_t len);
 236
 237 /* Collect register REGNUM from the register cache REGCACHE and store
 238    it in the buffer specified by GREGS and LEN as described by the
 239    general-purpose register set REGSET.  If REGNUM is -1, do this for
 240    all registers in REGSET.  */
 241 extern void i386_collect_gregset (const struct regset *regset,
 242                                   const struct regcache *regcache,
 243                                   int regnum, void *gregs, size_t len);
 244
 245 /* Return the appropriate register set for the core section identified
 246    by SECT_NAME and SECT_SIZE.  */
 247 extern const struct regset *
 248   i386_regset_from_core_section (struct gdbarch *gdbarch,
 249                                  const char *sect_name, size_t sect_size);
 250
 251
 252 extern void i386_displaced_step_fixup (struct gdbarch *gdbarch,
 253                                        struct displaced_step_closure *closure,
 254                                        CORE_ADDR from, CORE_ADDR to,
 255                                        struct regcache *regs);
 256
 257 /* Initialize a basic ELF architecture variant.  */
 258 extern void i386_elf_init_abi (struct gdbarch_info, struct gdbarch *);
 259
 260 /* Initialize a SVR4 architecture variant.  */
 261 extern void i386_svr4_init_abi (struct gdbarch_info, struct gdbarch *);
 262
 263 extern int i386_process_record (struct gdbarch *gdbarch,
 264                                 struct regcache *regcache, CORE_ADDR addr);
 265 \f
 266
 267 /* Functions and variables exported from i386bsd-tdep.c.  */
 268
 269 extern void i386bsd_init_abi (struct gdbarch_info, struct gdbarch *);
 270 extern CORE_ADDR i386fbsd_sigtramp_start_addr;
 271 extern CORE_ADDR i386fbsd_sigtramp_end_addr;
 272 extern CORE_ADDR i386obsd_sigtramp_start_addr;
 273 extern CORE_ADDR i386obsd_sigtramp_end_addr;
 274 extern int i386fbsd4_sc_reg_offset[];
 275 extern int i386fbsd_sc_reg_offset[];
 276 extern int i386nbsd_sc_reg_offset[];
 277 extern int i386obsd_sc_reg_offset[];
 278 extern int i386bsd_sc_reg_offset[];
 279
 280 #endif /* i386-tdep.h */