gdb/i386-tdep.h

   1 /* Target-dependent code for the i386.
   2
   3    Copyright (C) 2001-2024 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 #include "gdbarch.h"
  24 #include "infrun.h"
  25 #include "expression.h"
  26 #include "gdbsupport/x86-xstate.h"
  27
  28 class frame_info_ptr;
  29 struct gdbarch;
  30 struct reggroup;
  31 struct regset;
  32 struct regcache;
  33
  34 /* GDB's i386 target supports both the 32-bit Intel Architecture
  35    (IA-32) and the 64-bit AMD x86-64 architecture.  Internally it uses
  36    a similar register layout for both.
  37
  38    - General purpose registers
  39    - FPU data registers
  40    - FPU control registers
  41    - SSE data registers
  42    - SSE control register
  43
  44    The general purpose registers for the x86-64 architecture are quite
  45    different from IA-32.  Therefore, gdbarch_fp0_regnum
  46    determines the register number at which the FPU data registers
  47    start.  The number of FPU data and control registers is the same
  48    for both architectures.  The number of SSE registers however,
  49    differs and is determined by the num_xmm_regs member of `struct
  50    gdbarch_tdep'.  */
  51
  52 /* Convention for returning structures.  */
  53
  54 enum struct_return
  55 {
  56   pcc_struct_return,            /* Return "short" structures in memory.  */
  57   reg_struct_return             /* Return "short" structures in registers.  */
  58 };
  59
  60 /* i386 architecture specific information.  */
  61 struct i386_gdbarch_tdep : gdbarch_tdep_base
  62 {
  63   /* General-purpose registers.  */
  64   int *gregset_reg_offset = 0;
  65   int gregset_num_regs = 0;
  66   size_t sizeof_gregset = 0;
  67
  68   /* Floating-point registers.  */
  69   size_t sizeof_fpregset = 0;
  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 = 0;
  75
  76   /* Number of MMX registers.  */
  77   int num_mmx_regs = 0;
  78
  79   /* Register number for %mm0.  Set this to -1 to indicate the absence
  80      of MMX support.  */
  81   int mm0_regnum = 0;
  82
  83   /* Number of pseudo YMM registers.  */
  84   int num_ymm_regs = 0;
  85
  86   /* Register number for %ymm0.  Set this to -1 to indicate the absence
  87      of pseudo YMM register support.  */
  88   int ymm0_regnum = 0;
  89
  90   /* Number of AVX512 OpMask registers (K-registers)  */
  91   int num_k_regs = 0;
  92
  93   /* Register number for %k0.  Set this to -1 to indicate the absence
  94      of AVX512 OpMask register support.  */
  95   int k0_regnum = 0;
  96
  97   /* Number of pseudo ZMM registers ($zmm0-$zmm31).  */
  98   int num_zmm_regs = 0;
  99
 100   /* Register number for %zmm0.  Set this to -1 to indicate the absence
 101      of pseudo ZMM register support.  */
 102   int zmm0_regnum = 0;
 103
 104   /* Number of byte registers.  */
 105   int num_byte_regs = 0;
 106
 107   /* Register pseudo number for %al.  */
 108   int al_regnum = 0;
 109
 110   /* Number of pseudo word registers.  */
 111   int num_word_regs = 0;
 112
 113   /* Register number for %ax.  */
 114   int ax_regnum = 0;
 115
 116   /* Number of pseudo dword registers.  */
 117   int num_dword_regs = 0;
 118
 119   /* Register number for %eax.  Set this to -1 to indicate the absence
 120      of pseudo dword register support.  */
 121   int eax_regnum = 0;
 122
 123   /* Number of core registers.  */
 124   int num_core_regs = 0;
 125
 126   /* Number of SSE registers.  */
 127   int num_xmm_regs = 0;
 128
 129   /* Number of SSE registers added in AVX512.  */
 130   int num_xmm_avx512_regs = 0;
 131
 132   /* Register number of XMM16, the first XMM register added in AVX512.  */
 133   int xmm16_regnum = 0;
 134
 135   /* Number of YMM registers added in AVX512.  */
 136   int num_ymm_avx512_regs = 0;
 137
 138   /* Register number of YMM16, the first YMM register added in AVX512.  */
 139   int ymm16_regnum = 0;
 140
 141   /* Bits of the extended control register 0 (the XFEATURE_ENABLED_MASK
 142      register), excluding the x87 bit, which are supported by this GDB.  */
 143
 144   uint64_t xcr0 = 0;
 145
 146   /* Offset of XCR0 in XSAVE extended state.  */
 147   int xsave_xcr0_offset = 0;
 148
 149   /* Layout of the XSAVE area extended region.  */
 150   x86_xsave_layout xsave_layout;
 151
 152   /* Register names.  */
 153   const char * const *register_names = nullptr;
 154
 155   /* Register number for %ymm0h.  Set this to -1 to indicate the absence
 156      of upper YMM register support.  */
 157   int ymm0h_regnum = 0;
 158
 159   /* Upper YMM register names.  Only used for tdesc_numbered_register.  */
 160   const char * const *ymmh_register_names = nullptr;
 161
 162   /* Register number for %ymm16h.  Set this to -1 to indicate the absence
 163   of support for YMM16-31.  */
 164   int ymm16h_regnum = 0;
 165
 166   /* YMM16-31 register names.  Only used for tdesc_numbered_register.  */
 167   const char * const *ymm16h_register_names = nullptr;
 168
 169   /* Register number for %zmm0h.  Set this to -1 to indicate the absence
 170      of ZMM_HI256 register support.  */
 171   int zmm0h_regnum = 0;
 172
 173   /* OpMask register names.  */
 174   const char * const *k_register_names = nullptr;
 175
 176   /* ZMM register names.  Only used for tdesc_numbered_register.  */
 177   const char * const *zmmh_register_names = nullptr;
 178
 179   /* XMM16-31 register names.  Only used for tdesc_numbered_register.  */
 180   const char * const *xmm_avx512_register_names = nullptr;
 181
 182   /* YMM16-31 register names.  Only used for tdesc_numbered_register.  */
 183   const char * const *ymm_avx512_register_names = nullptr;
 184
 185   /* Number of PKEYS registers.  */
 186   int num_pkeys_regs = 0;
 187
 188   /* Register number for PKRU register.  */
 189   int pkru_regnum = 0;
 190
 191   /* PKEYS register names.  */
 192   const char * const *pkeys_register_names = nullptr;
 193
 194   /* Register number for %fsbase.  Set this to -1 to indicate the
 195      absence of segment base registers.  */
 196   int fsbase_regnum = 0;
 197
 198   /* Target description.  */
 199   const struct target_desc *tdesc = nullptr;
 200
 201   /* Register group function.  */
 202   gdbarch_register_reggroup_p_ftype *register_reggroup_p = nullptr;
 203
 204   /* Offset of saved PC in jmp_buf.  */
 205   int jb_pc_offset = 0;
 206
 207   /* Convention for returning structures.  */
 208   enum struct_return struct_return {};
 209
 210   /* Address range where sigtramp lives.  */
 211   CORE_ADDR sigtramp_start = 0;
 212   CORE_ADDR sigtramp_end = 0;
 213
 214   /* Detect sigtramp.  */
 215   int (*sigtramp_p) (const frame_info_ptr &) = nullptr;
 216
 217   /* Get address of sigcontext for sigtramp.  */
 218   CORE_ADDR (*sigcontext_addr) (const frame_info_ptr &) = nullptr;
 219
 220   /* Offset of registers in `struct sigcontext'.  */
 221   int *sc_reg_offset = 0;
 222   int sc_num_regs = 0;
 223
 224   /* Offset of saved PC and SP in `struct sigcontext'.  Usage of these
 225      is deprecated, please use `sc_reg_offset' instead.  */
 226   int sc_pc_offset = 0;
 227   int sc_sp_offset = 0;
 228
 229   /* ISA-specific data types.  */
 230   struct type *i386_mmx_type = nullptr;
 231   struct type *i386_ymm_type = nullptr;
 232   struct type *i386_zmm_type = nullptr;
 233   struct type *i387_ext_type = nullptr;
 234
 235   /* Process record/replay target.  */
 236   /* The map for registers because the AMD64's registers order
 237      in GDB is not same as I386 instructions.  */
 238   const int *record_regmap = nullptr;
 239   /* Parse intx80 args.  */
 240   int (*i386_intx80_record) (struct regcache *regcache) = nullptr;
 241   /* Parse sysenter args.  */
 242   int (*i386_sysenter_record) (struct regcache *regcache) = nullptr;
 243   /* Parse syscall args.  */
 244   int (*i386_syscall_record) (struct regcache *regcache) = nullptr;
 245
 246   /* Regsets. */
 247   const struct regset *fpregset = nullptr;
 248 };
 249
 250 /* Floating-point registers.  */
 251
 252 /* All FPU control registers (except for FIOFF and FOOFF) are 16-bit
 253    (at most) in the FPU, but are zero-extended to 32 bits in GDB's
 254    register cache.  */
 255
 256 /* Return non-zero if REGNUM matches the FP register and the FP
 257    register set is active.  */
 258 extern int i386_fp_regnum_p (struct gdbarch *, int);
 259 extern int i386_fpc_regnum_p (struct gdbarch *, int);
 260
 261 /* Register numbers of various important registers.  */
 262
 263 enum i386_regnum
 264 {
 265   I386_EAX_REGNUM,              /* %eax */
 266   I386_ECX_REGNUM,              /* %ecx */
 267   I386_EDX_REGNUM,              /* %edx */
 268   I386_EBX_REGNUM,              /* %ebx */
 269   I386_ESP_REGNUM,              /* %esp */
 270   I386_EBP_REGNUM,              /* %ebp */
 271   I386_ESI_REGNUM,              /* %esi */
 272   I386_EDI_REGNUM,              /* %edi */
 273   I386_EIP_REGNUM,              /* %eip */
 274   I386_EFLAGS_REGNUM,           /* %eflags */
 275   I386_CS_REGNUM,               /* %cs */
 276   I386_SS_REGNUM,               /* %ss */
 277   I386_DS_REGNUM,               /* %ds */
 278   I386_ES_REGNUM,               /* %es */
 279   I386_FS_REGNUM,               /* %fs */
 280   I386_GS_REGNUM,               /* %gs */
 281   I386_ST0_REGNUM,              /* %st(0) */
 282   I386_MXCSR_REGNUM = 40,       /* %mxcsr */
 283   I386_YMM0H_REGNUM,            /* %ymm0h */
 284   I386_YMM7H_REGNUM = I386_YMM0H_REGNUM + 7,
 285   /* MPX is deprecated.  Yet we keep this to not give the registers below
 286      a new number.  That could break older gdbservers.  */
 287   I386_BND0R_REGNUM,
 288   I386_BND3R_REGNUM = I386_BND0R_REGNUM + 3,
 289   I386_BNDCFGU_REGNUM,
 290   I386_BNDSTATUS_REGNUM,
 291   I386_K0_REGNUM,               /* %k0 */
 292   I386_K7_REGNUM = I386_K0_REGNUM + 7,
 293   I386_ZMM0H_REGNUM,            /* %zmm0h */
 294   I386_ZMM7H_REGNUM = I386_ZMM0H_REGNUM + 7,
 295   I386_PKRU_REGNUM,
 296   I386_FSBASE_REGNUM,
 297   I386_GSBASE_REGNUM
 298 };
 299
 300 /* Register numbers of RECORD_REGMAP.  */
 301
 302 enum record_i386_regnum
 303 {
 304   X86_RECORD_REAX_REGNUM,
 305   X86_RECORD_RECX_REGNUM,
 306   X86_RECORD_REDX_REGNUM,
 307   X86_RECORD_REBX_REGNUM,
 308   X86_RECORD_RESP_REGNUM,
 309   X86_RECORD_REBP_REGNUM,
 310   X86_RECORD_RESI_REGNUM,
 311   X86_RECORD_REDI_REGNUM,
 312   X86_RECORD_R8_REGNUM,
 313   X86_RECORD_R9_REGNUM,
 314   X86_RECORD_R10_REGNUM,
 315   X86_RECORD_R11_REGNUM,
 316   X86_RECORD_R12_REGNUM,
 317   X86_RECORD_R13_REGNUM,
 318   X86_RECORD_R14_REGNUM,
 319   X86_RECORD_R15_REGNUM,
 320   X86_RECORD_REIP_REGNUM,
 321   X86_RECORD_EFLAGS_REGNUM,
 322   X86_RECORD_CS_REGNUM,
 323   X86_RECORD_SS_REGNUM,
 324   X86_RECORD_DS_REGNUM,
 325   X86_RECORD_ES_REGNUM,
 326   X86_RECORD_FS_REGNUM,
 327   X86_RECORD_GS_REGNUM,
 328   X86_RECORD_XMM0_REGNUM,
 329 };
 330
 331 #define I386_NUM_GREGS  16
 332 #define I386_NUM_XREGS  9
 333
 334 #define I386_SSE_NUM_REGS       (I386_MXCSR_REGNUM + 1)
 335 #define I386_AVX_NUM_REGS       (I386_YMM7H_REGNUM + 1)
 336 #define I386_AVX512_NUM_REGS    (I386_ZMM7H_REGNUM + 1)
 337 #define I386_PKEYS_NUM_REGS     (I386_PKRU_REGNUM + 1)
 338 #define I386_NUM_REGS           (I386_GSBASE_REGNUM + 1)
 339
 340 /* Size of the largest register.  */
 341 #define I386_MAX_REGISTER_SIZE  64
 342
 343 /* Types for i386-specific registers.  */
 344 extern struct type *i387_ext_type (struct gdbarch *gdbarch);
 345
 346 /* Checks of different registers.  */
 347 extern int i386_byte_regnum_p (struct gdbarch *gdbarch, int regnum);
 348 extern int i386_word_regnum_p (struct gdbarch *gdbarch, int regnum);
 349 extern int i386_dword_regnum_p (struct gdbarch *gdbarch, int regnum);
 350 extern int i386_xmm_regnum_p (struct gdbarch *gdbarch, int regnum);
 351 extern int i386_xmm_avx512_regnum_p (struct gdbarch * gdbarch, int regnum);
 352 extern int i386_ymm_regnum_p (struct gdbarch *gdbarch, int regnum);
 353 extern int i386_ymm_avx512_regnum_p (struct gdbarch *gdbarch, int regnum);
 354 extern int i386_k_regnum_p (struct gdbarch *gdbarch, int regnum);
 355 extern int i386_zmm_regnum_p (struct gdbarch *gdbarch, int regnum);
 356 extern int i386_zmmh_regnum_p (struct gdbarch *gdbarch, int regnum);
 357 extern bool i386_pkru_regnum_p (struct gdbarch *gdbarch, int regnum);
 358
 359 extern const char *i386_pseudo_register_name (struct gdbarch *gdbarch,
 360                                               int regnum);
 361 extern struct type *i386_pseudo_register_type (struct gdbarch *gdbarch,
 362                                                int regnum);
 363
 364 extern value *i386_pseudo_register_read_value (gdbarch *gdbarch,
 365                                                const frame_info_ptr &next_frame,
 366                                                int regnum);
 367
 368 extern void i386_pseudo_register_write (gdbarch *gdbarch,
 369                                         const frame_info_ptr &next_frame, int regnum,
 370                                         gdb::array_view<const gdb_byte> buf);
 371
 372 extern int i386_ax_pseudo_register_collect (struct gdbarch *gdbarch,
 373                                             struct agent_expr *ax,
 374                                             int regnum);
 375
 376 /* Segment selectors.  */
 377 #define I386_SEL_RPL    0x0003  /* Requester's Privilege Level mask.  */
 378 #define I386_SEL_UPL    0x0003  /* User Privilege Level.  */
 379 #define I386_SEL_KPL    0x0000  /* Kernel Privilege Level.  */
 380
 381 /* The length of the longest i386 instruction (according to
 382    include/asm-i386/kprobes.h in Linux 2.6.  */
 383 #define I386_MAX_INSN_LEN (16)
 384
 385 /* Functions exported from i386-tdep.c.  */
 386 extern CORE_ADDR i386_pe_skip_trampoline_code (const frame_info_ptr &frame,
 387                                                CORE_ADDR pc, char *name);
 388 extern CORE_ADDR i386_skip_main_prologue (struct gdbarch *gdbarch,
 389                                           CORE_ADDR pc);
 390
 391 /* The "push_dummy_call" gdbarch method, optionally with the thiscall
 392    calling convention.  */
 393 extern CORE_ADDR i386_thiscall_push_dummy_call (struct gdbarch *gdbarch,
 394                                                 struct value *function,
 395                                                 struct regcache *regcache,
 396                                                 CORE_ADDR bp_addr,
 397                                                 int nargs, struct value **args,
 398                                                 CORE_ADDR sp,
 399                                                 function_call_return_method
 400                                                 return_method,
 401                                                 CORE_ADDR struct_addr,
 402                                                 bool thiscall);
 403
 404 /* Return whether the THIS_FRAME corresponds to a sigtramp routine.  */
 405 extern int i386_sigtramp_p (const frame_info_ptr &this_frame);
 406
 407 /* Return non-zero if REGNUM is a member of the specified group.  */
 408 extern int i386_register_reggroup_p (struct gdbarch *gdbarch, int regnum,
 409                                      const struct reggroup *group);
 410
 411 /* Supply register REGNUM from the general-purpose register set REGSET
 412    to register cache REGCACHE.  If REGNUM is -1, do this for all
 413    registers in REGSET.  */
 414 extern void i386_supply_gregset (const struct regset *regset,
 415                                  struct regcache *regcache, int regnum,
 416                                  const void *gregs, size_t len);
 417
 418 /* General-purpose register set. */
 419 extern const struct regset i386_gregset;
 420
 421 /* Floating-point register set. */
 422 extern const struct regset i386_fpregset;
 423
 424 /* Default iterator over core file register note sections.  */
 425 extern void
 426   i386_iterate_over_regset_sections (struct gdbarch *gdbarch,
 427                                      iterate_over_regset_sections_cb *cb,
 428                                      void *cb_data,
 429                                      const struct regcache *regcache);
 430
 431 typedef buf_displaced_step_copy_insn_closure
 432   i386_displaced_step_copy_insn_closure;
 433
 434 extern displaced_step_copy_insn_closure_up i386_displaced_step_copy_insn
 435   (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to,
 436    struct regcache *regs);
 437 extern void i386_displaced_step_fixup
 438   (struct gdbarch *gdbarch, displaced_step_copy_insn_closure *closure,
 439    CORE_ADDR from, CORE_ADDR to, regcache *regs, bool completed_p);
 440
 441 /* Initialize a basic ELF architecture variant.  */
 442 extern void i386_elf_init_abi (struct gdbarch_info, struct gdbarch *);
 443
 444 /* Initialize a SVR4 architecture variant.  */
 445 extern void i386_svr4_init_abi (struct gdbarch_info, struct gdbarch *);
 446
 447 /* Convert SVR4 register number REG to the appropriate register number
 448    used by GDB.  */
 449 extern int i386_svr4_reg_to_regnum (struct gdbarch *gdbarch, int reg);
 450
 451 extern int i386_process_record (struct gdbarch *gdbarch,
 452                                 struct regcache *regcache, CORE_ADDR addr);
 453 extern const struct target_desc *i386_target_description (uint64_t xcr0,
 454                                                           bool segments);
 455
 456 /* Functions and variables exported from i386-bsd-tdep.c.  */
 457
 458 extern void i386bsd_init_abi (struct gdbarch_info, struct gdbarch *);
 459 extern CORE_ADDR i386obsd_sigtramp_start_addr;
 460 extern CORE_ADDR i386obsd_sigtramp_end_addr;
 461 extern int i386obsd_sc_reg_offset[];
 462 extern int i386bsd_sc_reg_offset[];
 463
 464 /* SystemTap related functions.  */
 465
 466 extern int i386_stap_is_single_operand (struct gdbarch *gdbarch,
 467                                         const char *s);
 468
 469 extern expr::operation_up i386_stap_parse_special_token
 470      (struct gdbarch *gdbarch, struct stap_parse_info *p);
 471
 472 #endif /* i386-tdep.h */