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