gdb/i386-tdep.h

   1 /* Target-dependent code for the i386.
   2
   3    Copyright (C) 2001-2013 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 3 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, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef I386_TDEP_H
  21 #define I386_TDEP_H
  22
  23 struct frame_info;
  24 struct gdbarch;
  25 struct reggroup;
  26 struct regset;
  27 struct regcache;
  28
  29 /* GDB's i386 target supports both the 32-bit Intel Architecture
  30    (IA-32) and the 64-bit AMD x86-64 architecture.  Internally it uses
  31    a similar register layout for both.
  32
  33    - General purpose registers
  34    - FPU data registers
  35    - FPU control registers
  36    - SSE data registers
  37    - SSE control register
  38
  39    The general purpose registers for the x86-64 architecture are quite
  40    different from IA-32.  Therefore, gdbarch_fp0_regnum
  41    determines the register number at which the FPU data registers
  42    start.  The number of FPU data and control registers is the same
  43    for both architectures.  The number of SSE registers however,
  44    differs and is determined by the num_xmm_regs member of `struct
  45    gdbarch_tdep'.  */
  46
  47 /* Convention for returning structures.  */
  48
  49 enum struct_return
  50 {
  51   pcc_struct_return,            /* Return "short" structures in memory.  */
  52   reg_struct_return             /* Return "short" structures in registers.  */
  53 };
  54
  55 /* i386 architecture specific information.  */
  56 struct gdbarch_tdep
  57 {
  58   /* General-purpose registers.  */
  59   struct regset *gregset;
  60   int *gregset_reg_offset;
  61   int gregset_num_regs;
  62   size_t sizeof_gregset;
  63
  64   /* Floating-point registers.  */
  65   struct regset *fpregset;
  66   size_t sizeof_fpregset;
  67
  68   /* XSAVE extended state.  */
  69   struct regset *xstateregset;
  70
  71   /* Register number for %st(0).  The register numbers for the other
  72      registers follow from this one.  Set this to -1 to indicate the
  73      absence of an FPU.  */
  74   int st0_regnum;
  75
  76   /* Number of MMX registers.  */
  77   int num_mmx_regs;
  78
  79   /* Register number for %mm0.  Set this to -1 to indicate the absence
  80      of MMX support.  */
  81   int mm0_regnum;
  82
  83   /* Number of pseudo YMM registers.  */
  84   int num_ymm_regs;
  85
  86   /* Register number for %ymm0.  Set this to -1 to indicate the absence
  87      of pseudo YMM register support.  */
  88   int ymm0_regnum;
  89
  90   /* Number of byte registers.  */
  91   int num_byte_regs;
  92
  93   /* Register pseudo number for %al.  */
  94   int al_regnum;
  95
  96   /* Number of pseudo word registers.  */
  97   int num_word_regs;
  98
  99   /* Register number for %ax.  */
 100   int ax_regnum;
 101
 102   /* Number of pseudo dword registers.  */
 103   int num_dword_regs;
 104
 105   /* Register number for %eax.  Set this to -1 to indicate the absence
 106      of pseudo dword register support.  */
 107   int eax_regnum;
 108
 109   /* Number of core registers.  */
 110   int num_core_regs;
 111
 112   /* Number of SSE registers.  */
 113   int num_xmm_regs;
 114
 115   /* Bits of the extended control register 0 (the XFEATURE_ENABLED_MASK
 116      register), excluding the x87 bit, which are supported by this GDB.  */
 117
 118   uint64_t xcr0;
 119
 120   /* Offset of XCR0 in XSAVE extended state.  */
 121   int xsave_xcr0_offset;
 122
 123   /* Register names.  */
 124   const char **register_names;
 125
 126   /* Register number for %ymm0h.  Set this to -1 to indicate the absence
 127      of upper YMM register support.  */
 128   int ymm0h_regnum;
 129
 130   /* Upper YMM register names.  Only used for tdesc_numbered_register.  */
 131   const char **ymmh_register_names;
 132
 133   /* Target description.  */
 134   const struct target_desc *tdesc;
 135
 136   /* Register group function.  */
 137   const void *register_reggroup_p;
 138
 139   /* Offset of saved PC in jmp_buf.  */
 140   int jb_pc_offset;
 141
 142   /* Convention for returning structures.  */
 143   enum struct_return struct_return;
 144
 145   /* Address range where sigtramp lives.  */
 146   CORE_ADDR sigtramp_start;
 147   CORE_ADDR sigtramp_end;
 148
 149   /* Detect sigtramp.  */
 150   int (*sigtramp_p) (struct frame_info *);
 151
 152   /* Get address of sigcontext for sigtramp.  */
 153   CORE_ADDR (*sigcontext_addr) (struct frame_info *);
 154
 155   /* Offset of registers in `struct sigcontext'.  */
 156   int *sc_reg_offset;
 157   int sc_num_regs;
 158
 159   /* Offset of saved PC and SP in `struct sigcontext'.  Usage of these
 160      is deprecated, please use `sc_reg_offset' instead.  */
 161   int sc_pc_offset;
 162   int sc_sp_offset;
 163
 164   /* ISA-specific data types.  */
 165   struct type *i386_mmx_type;
 166   struct type *i386_ymm_type;
 167   struct type *i387_ext_type;
 168
 169   /* Process record/replay target.  */
 170   /* The map for registers because the AMD64's registers order
 171      in GDB is not same as I386 instructions.  */
 172   const int *record_regmap;
 173   /* Parse intx80 args.  */
 174   int (*i386_intx80_record) (struct regcache *regcache);
 175   /* Parse sysenter args.  */
 176   int (*i386_sysenter_record) (struct regcache *regcache);
 177   /* Parse syscall args.  */
 178   int (*i386_syscall_record) (struct regcache *regcache);
 179 };
 180
 181 /* Floating-point registers.  */
 182
 183 /* All FPU control regusters (except for FIOFF and FOOFF) are 16-bit
 184    (at most) in the FPU, but are zero-extended to 32 bits in GDB's
 185    register cache.  */
 186
 187 /* Return non-zero if REGNUM matches the FP register and the FP
 188    register set is active.  */
 189 extern int i386_fp_regnum_p (struct gdbarch *, int);
 190 extern int i386_fpc_regnum_p (struct gdbarch *, int);
 191
 192 /* Register numbers of various important registers.  */
 193
 194 enum i386_regnum
 195 {
 196   I386_EAX_REGNUM,              /* %eax */
 197   I386_ECX_REGNUM,              /* %ecx */
 198   I386_EDX_REGNUM,              /* %edx */
 199   I386_EBX_REGNUM,              /* %ebx */
 200   I386_ESP_REGNUM,              /* %esp */
 201   I386_EBP_REGNUM,              /* %ebp */
 202   I386_ESI_REGNUM,              /* %esi */
 203   I386_EDI_REGNUM,              /* %edi */
 204   I386_EIP_REGNUM,              /* %eip */
 205   I386_EFLAGS_REGNUM,           /* %eflags */
 206   I386_CS_REGNUM,               /* %cs */
 207   I386_SS_REGNUM,               /* %ss */
 208   I386_DS_REGNUM,               /* %ds */
 209   I386_ES_REGNUM,               /* %es */
 210   I386_FS_REGNUM,               /* %fs */
 211   I386_GS_REGNUM,               /* %gs */
 212   I386_ST0_REGNUM,              /* %st(0) */
 213   I386_MXCSR_REGNUM = 40,       /* %mxcsr */
 214   I386_YMM0H_REGNUM,            /* %ymm0h */
 215   I386_YMM7H_REGNUM = I386_YMM0H_REGNUM + 7
 216 };
 217
 218 /* Register numbers of RECORD_REGMAP.  */
 219
 220 enum record_i386_regnum
 221 {
 222   X86_RECORD_REAX_REGNUM,
 223   X86_RECORD_RECX_REGNUM,
 224   X86_RECORD_REDX_REGNUM,
 225   X86_RECORD_REBX_REGNUM,
 226   X86_RECORD_RESP_REGNUM,
 227   X86_RECORD_REBP_REGNUM,
 228   X86_RECORD_RESI_REGNUM,
 229   X86_RECORD_REDI_REGNUM,
 230   X86_RECORD_R8_REGNUM,
 231   X86_RECORD_R9_REGNUM,
 232   X86_RECORD_R10_REGNUM,
 233   X86_RECORD_R11_REGNUM,
 234   X86_RECORD_R12_REGNUM,
 235   X86_RECORD_R13_REGNUM,
 236   X86_RECORD_R14_REGNUM,
 237   X86_RECORD_R15_REGNUM,
 238   X86_RECORD_REIP_REGNUM,
 239   X86_RECORD_EFLAGS_REGNUM,
 240   X86_RECORD_CS_REGNUM,
 241   X86_RECORD_SS_REGNUM,
 242   X86_RECORD_DS_REGNUM,
 243   X86_RECORD_ES_REGNUM,
 244   X86_RECORD_FS_REGNUM,
 245   X86_RECORD_GS_REGNUM,
 246 };
 247
 248 #define I386_NUM_GREGS  16
 249 #define I386_NUM_XREGS  9
 250
 251 #define I386_SSE_NUM_REGS       (I386_MXCSR_REGNUM + 1)
 252 #define I386_AVX_NUM_REGS       (I386_YMM7H_REGNUM + 1)
 253
 254 /* Size of the largest register.  */
 255 #define I386_MAX_REGISTER_SIZE  16
 256
 257 /* Types for i386-specific registers.  */
 258 extern struct type *i387_ext_type (struct gdbarch *gdbarch);
 259
 260 /* Checks of different pseudo-registers.  */
 261 extern int i386_byte_regnum_p (struct gdbarch *gdbarch, int regnum);
 262 extern int i386_word_regnum_p (struct gdbarch *gdbarch, int regnum);
 263 extern int i386_dword_regnum_p (struct gdbarch *gdbarch, int regnum);
 264 extern int i386_xmm_regnum_p (struct gdbarch *gdbarch, int regnum);
 265 extern int i386_ymm_regnum_p (struct gdbarch *gdbarch, int regnum);
 266
 267 extern const char *i386_pseudo_register_name (struct gdbarch *gdbarch,
 268                                               int regnum);
 269 extern struct type *i386_pseudo_register_type (struct gdbarch *gdbarch,
 270                                                int regnum);
 271
 272 extern void i386_pseudo_register_read_into_value (struct gdbarch *gdbarch,
 273                                                   struct regcache *regcache,
 274                                                   int regnum,
 275                                                   struct value *result);
 276
 277 extern void i386_pseudo_register_write (struct gdbarch *gdbarch,
 278                                         struct regcache *regcache,
 279                                         int regnum, const gdb_byte *buf);
 280
 281 /* Segment selectors.  */
 282 #define I386_SEL_RPL    0x0003  /* Requester's Privilege Level mask.  */
 283 #define I386_SEL_UPL    0x0003  /* User Privilige Level.  */
 284 #define I386_SEL_KPL    0x0000  /* Kernel Privilige Level.  */
 285
 286 /* The length of the longest i386 instruction (according to
 287    include/asm-i386/kprobes.h in Linux 2.6.  */
 288 #define I386_MAX_INSN_LEN (16)
 289
 290 /* Functions exported from i386-tdep.c.  */
 291 extern CORE_ADDR i386_pe_skip_trampoline_code (struct frame_info *frame,
 292                                                CORE_ADDR pc, char *name);
 293 extern CORE_ADDR i386_skip_main_prologue (struct gdbarch *gdbarch,
 294                                           CORE_ADDR pc);
 295
 296 /* Return whether the THIS_FRAME corresponds to a sigtramp routine.  */
 297 extern int i386_sigtramp_p (struct frame_info *this_frame);
 298
 299 /* Return non-zero if REGNUM is a member of the specified group.  */
 300 extern int i386_register_reggroup_p (struct gdbarch *gdbarch, int regnum,
 301                                      struct reggroup *group);
 302
 303 /* Supply register REGNUM from the general-purpose register set REGSET
 304    to register cache REGCACHE.  If REGNUM is -1, do this for all
 305    registers in REGSET.  */
 306 extern void i386_supply_gregset (const struct regset *regset,
 307                                  struct regcache *regcache, int regnum,
 308                                  const void *gregs, size_t len);
 309
 310 /* Collect register REGNUM from the register cache REGCACHE and store
 311    it in the buffer specified by GREGS and LEN as described by the
 312    general-purpose register set REGSET.  If REGNUM is -1, do this for
 313    all registers in REGSET.  */
 314 extern void i386_collect_gregset (const struct regset *regset,
 315                                   const struct regcache *regcache,
 316                                   int regnum, void *gregs, size_t len);
 317
 318 /* Return the appropriate register set for the core section identified
 319    by SECT_NAME and SECT_SIZE.  */
 320 extern const struct regset *
 321   i386_regset_from_core_section (struct gdbarch *gdbarch,
 322                                  const char *sect_name, size_t sect_size);
 323
 324
 325 extern struct displaced_step_closure *i386_displaced_step_copy_insn
 326   (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to,
 327    struct regcache *regs);
 328 extern void i386_displaced_step_fixup (struct gdbarch *gdbarch,
 329                                        struct displaced_step_closure *closure,
 330                                        CORE_ADDR from, CORE_ADDR to,
 331                                        struct regcache *regs);
 332
 333 /* Initialize a basic ELF architecture variant.  */
 334 extern void i386_elf_init_abi (struct gdbarch_info, struct gdbarch *);
 335
 336 /* Initialize a SVR4 architecture variant.  */
 337 extern void i386_svr4_init_abi (struct gdbarch_info, struct gdbarch *);
 338
 339 extern int i386_process_record (struct gdbarch *gdbarch,
 340                                 struct regcache *regcache, CORE_ADDR addr);
 341
 342 \f
 343
 344 /* Functions and variables exported from i386bsd-tdep.c.  */
 345
 346 extern void i386bsd_init_abi (struct gdbarch_info, struct gdbarch *);
 347 extern CORE_ADDR i386fbsd_sigtramp_start_addr;
 348 extern CORE_ADDR i386fbsd_sigtramp_end_addr;
 349 extern CORE_ADDR i386obsd_sigtramp_start_addr;
 350 extern CORE_ADDR i386obsd_sigtramp_end_addr;
 351 extern int i386fbsd4_sc_reg_offset[];
 352 extern int i386fbsd_sc_reg_offset[];
 353 extern int i386nbsd_sc_reg_offset[];
 354 extern int i386obsd_sc_reg_offset[];
 355 extern int i386bsd_sc_reg_offset[];
 356
 357 /* SystemTap related functions.  */
 358
 359 extern int i386_stap_is_single_operand (struct gdbarch *gdbarch,
 360                                         const char *s);
 361
 362 extern int i386_stap_parse_special_token (struct gdbarch *gdbarch,
 363                                           struct stap_parse_info *p);
 364
 365 #endif /* i386-tdep.h */