[deliverable/binutils-gdb.git] / gdb / i386-tdep.h

/* Target-dependent code for the i386.

   Copyright (C) 2001-2020 Free Software Foundation, Inc.

   This file is part of GDB.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */

#ifndef I386_TDEP_H
#define I386_TDEP_H

#include "gdbarch.h"
#include "infrun.h"

struct frame_info;
struct gdbarch;
struct reggroup;
struct regset;
struct regcache;

/* GDB's i386 target supports both the 32-bit Intel Architecture
   (IA-32) and the 64-bit AMD x86-64 architecture.  Internally it uses
   a similar register layout for both.

   - General purpose registers
   - FPU data registers
   - FPU control registers
   - SSE data registers
   - SSE control register

   The general purpose registers for the x86-64 architecture are quite
   different from IA-32.  Therefore, gdbarch_fp0_regnum
   determines the register number at which the FPU data registers
   start.  The number of FPU data and control registers is the same
   for both architectures.  The number of SSE registers however,
   differs and is determined by the num_xmm_regs member of `struct
   gdbarch_tdep'.  */

/* Convention for returning structures.  */

enum struct_return
{
  pcc_struct_return,		/* Return "short" structures in memory.  */
  reg_struct_return		/* Return "short" structures in registers.  */
};

/* i386 architecture specific information.  */
struct gdbarch_tdep
{
  /* General-purpose registers.  */
  int *gregset_reg_offset;
  int gregset_num_regs;
  size_t sizeof_gregset;

  /* Floating-point registers.  */
  size_t sizeof_fpregset;

  /* Register number for %st(0).  The register numbers for the other
     registers follow from this one.  Set this to -1 to indicate the
     absence of an FPU.  */
  int st0_regnum;

  /* Number of MMX registers.  */
  int num_mmx_regs;

  /* Register number for %mm0.  Set this to -1 to indicate the absence
     of MMX support.  */
  int mm0_regnum;

  /* Number of pseudo YMM registers.  */
  int num_ymm_regs;

  /* Register number for %ymm0.  Set this to -1 to indicate the absence
     of pseudo YMM register support.  */
  int ymm0_regnum;

  /* Number of AVX512 OpMask registers (K-registers)  */
  int num_k_regs;

  /* Register number for %k0.  Set this to -1 to indicate the absence
     of AVX512 OpMask register support.  */
  int k0_regnum;

  /* Number of pseudo ZMM registers ($zmm0-$zmm31).  */
  int num_zmm_regs;

  /* Register number for %zmm0.  Set this to -1 to indicate the absence
     of pseudo ZMM register support.  */
  int zmm0_regnum;

  /* Number of byte registers.  */
  int num_byte_regs;

  /* Register pseudo number for %al.  */
  int al_regnum;

  /* Number of pseudo word registers.  */
  int num_word_regs;

  /* Register number for %ax.  */
  int ax_regnum;

  /* Number of pseudo dword registers.  */
  int num_dword_regs;

  /* Register number for %eax.  Set this to -1 to indicate the absence
     of pseudo dword register support.  */
  int eax_regnum;

  /* Number of core registers.  */
  int num_core_regs;

  /* Number of SSE registers.  */
  int num_xmm_regs;

  /* Number of SSE registers added in AVX512.  */
  int num_xmm_avx512_regs;

  /* Register number of XMM16, the first XMM register added in AVX512.  */
  int xmm16_regnum;

  /* Number of YMM registers added in AVX512.  */
  int num_ymm_avx512_regs;

  /* Register number of YMM16, the first YMM register added in AVX512.  */
  int ymm16_regnum;

  /* Bits of the extended control register 0 (the XFEATURE_ENABLED_MASK
     register), excluding the x87 bit, which are supported by this GDB.  */

  uint64_t xcr0;

  /* Offset of XCR0 in XSAVE extended state.  */
  int xsave_xcr0_offset;

  /* Register names.  */
  const char **register_names;

  /* Register number for %ymm0h.  Set this to -1 to indicate the absence
     of upper YMM register support.  */
  int ymm0h_regnum;

  /* Upper YMM register names.  Only used for tdesc_numbered_register.  */
  const char **ymmh_register_names;

  /* Register number for %ymm16h.  Set this to -1 to indicate the absence
  of support for YMM16-31.  */
  int ymm16h_regnum;

  /* YMM16-31 register names.  Only used for tdesc_numbered_register.  */
  const char **ymm16h_register_names;

  /* Register number for %bnd0r.  Set this to -1 to indicate the absence
     bound registers.  */
  int bnd0r_regnum;

  /* Register number for pseudo register %bnd0.  Set this to -1 to indicate the absence
     bound registers.  */
  int bnd0_regnum;

  /* Register number for %bndcfgu. Set this to -1 to indicate the absence
     bound control registers.  */
  int bndcfgu_regnum;

  /* MPX register names.  Only used for tdesc_numbered_register.  */
  const char **mpx_register_names;

  /* Register number for %zmm0h.  Set this to -1 to indicate the absence
     of ZMM_HI256 register support.  */
  int zmm0h_regnum;

  /* OpMask register names.  */
  const char **k_register_names;

  /* ZMM register names.  Only used for tdesc_numbered_register.  */
  const char **zmmh_register_names;

  /* XMM16-31 register names.  Only used for tdesc_numbered_register.  */
  const char **xmm_avx512_register_names;

  /* YMM16-31 register names.  Only used for tdesc_numbered_register.  */
  const char **ymm_avx512_register_names;

  /* Number of PKEYS registers.  */
  int num_pkeys_regs;

  /* Register number for PKRU register.  */
  int pkru_regnum;

  /* PKEYS register names.  */
  const char **pkeys_register_names;

  /* Register number for %fsbase.  Set this to -1 to indicate the
     absence of segment base registers.  */
  int fsbase_regnum;

  /* Target description.  */
  const struct target_desc *tdesc;

  /* Register group function.  */
  gdbarch_register_reggroup_p_ftype *register_reggroup_p;

  /* Offset of saved PC in jmp_buf.  */
  int jb_pc_offset;

  /* Convention for returning structures.  */
  enum struct_return struct_return;

  /* Address range where sigtramp lives.  */
  CORE_ADDR sigtramp_start;
  CORE_ADDR sigtramp_end;

  /* Detect sigtramp.  */
  int (*sigtramp_p) (struct frame_info *);

  /* Get address of sigcontext for sigtramp.  */
  CORE_ADDR (*sigcontext_addr) (struct frame_info *);

  /* Offset of registers in `struct sigcontext'.  */
  int *sc_reg_offset;
  int sc_num_regs;

  /* Offset of saved PC and SP in `struct sigcontext'.  Usage of these
     is deprecated, please use `sc_reg_offset' instead.  */
  int sc_pc_offset;
  int sc_sp_offset;

  /* ISA-specific data types.  */
  struct type *i386_mmx_type;
  struct type *i386_ymm_type;
  struct type *i386_zmm_type;
  struct type *i387_ext_type;
  struct type *i386_bnd_type;

  /* Process record/replay target.  */
  /* The map for registers because the AMD64's registers order
     in GDB is not same as I386 instructions.  */
  const int *record_regmap;
  /* Parse intx80 args.  */
  int (*i386_intx80_record) (struct regcache *regcache);
  /* Parse sysenter args.  */
  int (*i386_sysenter_record) (struct regcache *regcache);
  /* Parse syscall args.  */
  int (*i386_syscall_record) (struct regcache *regcache);

  /* Regsets. */
  const struct regset *fpregset;
};

/* Floating-point registers.  */

/* All FPU control registers (except for FIOFF and FOOFF) are 16-bit
   (at most) in the FPU, but are zero-extended to 32 bits in GDB's
   register cache.  */

/* Return non-zero if REGNUM matches the FP register and the FP
   register set is active.  */
extern int i386_fp_regnum_p (struct gdbarch *, int);
extern int i386_fpc_regnum_p (struct gdbarch *, int);

/* Register numbers of various important registers.  */

enum i386_regnum
{
  I386_EAX_REGNUM,		/* %eax */
  I386_ECX_REGNUM,		/* %ecx */
  I386_EDX_REGNUM,		/* %edx */
  I386_EBX_REGNUM,		/* %ebx */
  I386_ESP_REGNUM,		/* %esp */
  I386_EBP_REGNUM,		/* %ebp */
  I386_ESI_REGNUM,		/* %esi */
  I386_EDI_REGNUM,		/* %edi */
  I386_EIP_REGNUM,		/* %eip */
  I386_EFLAGS_REGNUM,		/* %eflags */
  I386_CS_REGNUM,		/* %cs */
  I386_SS_REGNUM,		/* %ss */
  I386_DS_REGNUM,		/* %ds */
  I386_ES_REGNUM,		/* %es */
  I386_FS_REGNUM,		/* %fs */
  I386_GS_REGNUM,		/* %gs */
  I386_ST0_REGNUM,		/* %st(0) */
  I386_MXCSR_REGNUM = 40,	/* %mxcsr */ 
  I386_YMM0H_REGNUM,		/* %ymm0h */
  I386_YMM7H_REGNUM = I386_YMM0H_REGNUM + 7,
  I386_BND0R_REGNUM,
  I386_BND3R_REGNUM = I386_BND0R_REGNUM + 3,
  I386_BNDCFGU_REGNUM,
  I386_BNDSTATUS_REGNUM,
  I386_K0_REGNUM,		/* %k0 */
  I386_K7_REGNUM = I386_K0_REGNUM + 7,
  I386_ZMM0H_REGNUM,		/* %zmm0h */
  I386_ZMM7H_REGNUM = I386_ZMM0H_REGNUM + 7,
  I386_PKRU_REGNUM,
  I386_FSBASE_REGNUM,
  I386_GSBASE_REGNUM
};

/* Register numbers of RECORD_REGMAP.  */

enum record_i386_regnum
{
  X86_RECORD_REAX_REGNUM,
  X86_RECORD_RECX_REGNUM,
  X86_RECORD_REDX_REGNUM,
  X86_RECORD_REBX_REGNUM,
  X86_RECORD_RESP_REGNUM,
  X86_RECORD_REBP_REGNUM,
  X86_RECORD_RESI_REGNUM,
  X86_RECORD_REDI_REGNUM,
  X86_RECORD_R8_REGNUM,
  X86_RECORD_R9_REGNUM,
  X86_RECORD_R10_REGNUM,
  X86_RECORD_R11_REGNUM,
  X86_RECORD_R12_REGNUM,
  X86_RECORD_R13_REGNUM,
  X86_RECORD_R14_REGNUM,
  X86_RECORD_R15_REGNUM,
  X86_RECORD_REIP_REGNUM,
  X86_RECORD_EFLAGS_REGNUM,
  X86_RECORD_CS_REGNUM,
  X86_RECORD_SS_REGNUM,
  X86_RECORD_DS_REGNUM,
  X86_RECORD_ES_REGNUM,
  X86_RECORD_FS_REGNUM,
  X86_RECORD_GS_REGNUM,
};

#define I386_NUM_GREGS	16
#define I386_NUM_XREGS  9

#define I386_SSE_NUM_REGS	(I386_MXCSR_REGNUM + 1)
#define I386_AVX_NUM_REGS	(I386_YMM7H_REGNUM + 1)
#define I386_MPX_NUM_REGS	(I386_BNDSTATUS_REGNUM + 1)
#define I386_AVX512_NUM_REGS	(I386_ZMM7H_REGNUM + 1)
#define I386_PKEYS_NUM_REGS	(I386_PKRU_REGNUM + 1)
#define I386_NUM_REGS		(I386_GSBASE_REGNUM + 1)

/* Size of the largest register.  */
#define I386_MAX_REGISTER_SIZE	64

/* Types for i386-specific registers.  */
extern struct type *i387_ext_type (struct gdbarch *gdbarch);

/* Checks of different pseudo-registers.  */
extern int i386_byte_regnum_p (struct gdbarch *gdbarch, int regnum);
extern int i386_word_regnum_p (struct gdbarch *gdbarch, int regnum);
extern int i386_dword_regnum_p (struct gdbarch *gdbarch, int regnum);
extern int i386_xmm_regnum_p (struct gdbarch *gdbarch, int regnum);
extern int i386_xmm_avx512_regnum_p (struct gdbarch * gdbarch, int regnum);
extern int i386_ymm_regnum_p (struct gdbarch *gdbarch, int regnum);
extern int i386_ymm_avx512_regnum_p (struct gdbarch *gdbarch, int regnum);
extern int i386_bnd_regnum_p (struct gdbarch *gdbarch, int regnum);
extern int i386_k_regnum_p (struct gdbarch *gdbarch, int regnum);
extern int i386_zmm_regnum_p (struct gdbarch *gdbarch, int regnum);
extern int i386_zmmh_regnum_p (struct gdbarch *gdbarch, int regnum);
extern bool i386_pkru_regnum_p (struct gdbarch *gdbarch, int regnum);

extern const char *i386_pseudo_register_name (struct gdbarch *gdbarch,
					      int regnum);
extern struct type *i386_pseudo_register_type (struct gdbarch *gdbarch,
					       int regnum);

extern void i386_pseudo_register_read_into_value (struct gdbarch *gdbarch,
						  readable_regcache *regcache,
						  int regnum,
						  struct value *result);

extern void i386_pseudo_register_write (struct gdbarch *gdbarch,
					struct regcache *regcache,
					int regnum, const gdb_byte *buf);

extern int i386_ax_pseudo_register_collect (struct gdbarch *gdbarch,
					    struct agent_expr *ax,
					    int regnum);

/* Segment selectors.  */
#define I386_SEL_RPL	0x0003  /* Requester's Privilege Level mask.  */
#define I386_SEL_UPL	0x0003	/* User Privilige Level.  */
#define I386_SEL_KPL	0x0000	/* Kernel Privilige Level.  */

/* The length of the longest i386 instruction (according to
   include/asm-i386/kprobes.h in Linux 2.6.  */
#define I386_MAX_INSN_LEN (16)

/* Functions exported from i386-tdep.c.  */
extern CORE_ADDR i386_pe_skip_trampoline_code (struct frame_info *frame,
					       CORE_ADDR pc, char *name);
extern CORE_ADDR i386_skip_main_prologue (struct gdbarch *gdbarch,
					  CORE_ADDR pc);

/* Return whether the THIS_FRAME corresponds to a sigtramp routine.  */
extern int i386_sigtramp_p (struct frame_info *this_frame);

/* Return non-zero if REGNUM is a member of the specified group.  */
extern int i386_register_reggroup_p (struct gdbarch *gdbarch, int regnum,
				     struct reggroup *group);

/* Supply register REGNUM from the general-purpose register set REGSET
   to register cache REGCACHE.  If REGNUM is -1, do this for all
   registers in REGSET.  */
extern void i386_supply_gregset (const struct regset *regset,
				 struct regcache *regcache, int regnum,
				 const void *gregs, size_t len);

/* General-purpose register set. */
extern const struct regset i386_gregset;

/* Floating-point register set. */
extern const struct regset i386_fpregset;

/* Default iterator over core file register note sections.  */
extern void
  i386_iterate_over_regset_sections (struct gdbarch *gdbarch,
				     iterate_over_regset_sections_cb *cb,
				     void *cb_data,
				     const struct regcache *regcache);

typedef buf_displaced_step_closure i386_displaced_step_closure;

extern struct displaced_step_closure *i386_displaced_step_copy_insn
  (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to,
   struct regcache *regs);
extern void i386_displaced_step_fixup (struct gdbarch *gdbarch,
				       struct displaced_step_closure *closure,
				       CORE_ADDR from, CORE_ADDR to,
				       struct regcache *regs);

/* Initialize a basic ELF architecture variant.  */
extern void i386_elf_init_abi (struct gdbarch_info, struct gdbarch *);

/* Initialize a SVR4 architecture variant.  */
extern void i386_svr4_init_abi (struct gdbarch_info, struct gdbarch *);

/* Convert SVR4 register number REG to the appropriate register number
   used by GDB.  */
extern int i386_svr4_reg_to_regnum (struct gdbarch *gdbarch, int reg);

extern int i386_process_record (struct gdbarch *gdbarch,
                                struct regcache *regcache, CORE_ADDR addr);
extern const struct target_desc *i386_target_description (uint64_t xcr0,
							  bool segments);

/* Return true iff the current target is MPX enabled.  */
extern int i386_mpx_enabled (void);
\f

/* Functions and variables exported from i386-bsd-tdep.c.  */

extern void i386bsd_init_abi (struct gdbarch_info, struct gdbarch *);
extern CORE_ADDR i386fbsd_sigtramp_start_addr;
extern CORE_ADDR i386fbsd_sigtramp_end_addr;
extern CORE_ADDR i386obsd_sigtramp_start_addr;
extern CORE_ADDR i386obsd_sigtramp_end_addr;
extern int i386fbsd4_sc_reg_offset[];
extern int i386fbsd_sc_reg_offset[];
extern int i386nbsd_sc_reg_offset[];
extern int i386obsd_sc_reg_offset[];
extern int i386bsd_sc_reg_offset[];

/* SystemTap related functions.  */

extern int i386_stap_is_single_operand (struct gdbarch *gdbarch,
					const char *s);

extern int i386_stap_parse_special_token (struct gdbarch *gdbarch,
					  struct stap_parse_info *p);

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