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

/* Target-dependent code for the i386.

   Copyright (C) 2001, 2002, 2003, 2004, 2006, 2007, 2008, 2009
   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

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.  */
  struct regset *gregset;
  int *gregset_reg_offset;
  int gregset_num_regs;
  size_t sizeof_gregset;

  /* Floating-point registers.  */
  struct regset *fpregset;
  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;

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

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

  /* 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_eflags_type;
  struct type *i386_mxcsr_type;
  struct type *i386_mmx_type;
  struct type *i386_sse_type;
  struct type *i387_ext_type;

  /* Process record/replay target.  */
  /* Parse intx80 args.  */
  int (*i386_intx80_record) (struct regcache *regcache);
  /* Parse sysenter args.  */
  int (*i386_sysenter_record) (struct regcache *regcache);
};

/* Floating-point registers.  */

/* All FPU control regusters (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) */
};

#define I386_NUM_GREGS	16
#define I386_NUM_FREGS	16
#define I386_NUM_XREGS  9

#define I386_SSE_NUM_REGS	(I386_NUM_GREGS + I386_NUM_FREGS \
				 + I386_NUM_XREGS)

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

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

/* 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 the name of register REGNUM.  */
extern char const *i386_register_name (struct gdbarch * gdbarch, int regnum);

/* 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);

/* Collect register REGNUM from the register cache REGCACHE and store
   it in the buffer specified by GREGS and LEN as described by the
   general-purpose register set REGSET.  If REGNUM is -1, do this for
   all registers in REGSET.  */
extern void i386_collect_gregset (const struct regset *regset,
				  const struct regcache *regcache,
				  int regnum, void *gregs, size_t len);

/* Return the appropriate register set for the core section identified
   by SECT_NAME and SECT_SIZE.  */
extern const struct regset *
  i386_regset_from_core_section (struct gdbarch *gdbarch,
				 const char *sect_name, size_t sect_size);


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 *);

extern int i386_process_record (struct gdbarch *gdbarch,
                                struct regcache *regcache, CORE_ADDR addr);
\f

/* Functions and variables exported from i386bsd-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[];

#endif /* i386-tdep.h */
Commit	Line	Data
5716833c MK	1	/* Target-dependent code for the i386.
5716833c MK	2
0fb0cc75	3	Copyright (C) 2001, 2002, 2003, 2004, 2006, 2007, 2008, 2009
5ae96ec1	4	Free Software Foundation, Inc.
9a82579f JS	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
a9762ec7	10	the Free Software Foundation; either version 3 of the License, or
9a82579f JS	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
a9762ec7	19	along with this program. If not, see <http://www.gnu.org/licenses/>. */
9a82579f JS	20
	21	#ifndef I386_TDEP_H
	22	#define I386_TDEP_H
	23
da3331ec	24	struct frame_info;
5716833c MK	25	struct gdbarch;
5716833c MK	26	struct reggroup;
c783cbd6	27	struct regset;
5439edaa	28	struct regcache;
da3331ec	29
96297dab MK	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
3e8c568d	41	different from IA-32. Therefore, gdbarch_fp0_regnum
96297dab MK	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
8201327c	48	/* Convention for returning structures. */
3ce1502b	49
8201327c MK	50	enum struct_return
	51	{
	52	pcc_struct_return, /* Return "short" structures in memory. */
	53	reg_struct_return /* Return "short" structures in registers. */
3ce1502b MK	54	};
3ce1502b MK	55
96297dab MK	56	/* i386 architecture specific information. */
	57	struct gdbarch_tdep
	58	{
473f17b0 MK	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
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
	74	/* Register number for %mm0. Set this to -1 to indicate the absence
	75	of MMX support. */
	76	int mm0_regnum;
	77
96297dab MK	78	/* Number of SSE registers. */
96297dab MK	79	int num_xmm_regs;
8201327c MK	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
8201327c MK	87	/* Address range where sigtramp lives. */
	88	CORE_ADDR sigtramp_start;
	89	CORE_ADDR sigtramp_end;
	90
911bc6ee MK	91	/* Detect sigtramp. */
	92	int (sigtramp_p) (struct frame_info );
	93
21d0e8a4 MK	94	/* Get address of sigcontext for sigtramp. */
	95	CORE_ADDR (sigcontext_addr) (struct frame_info );
	96
a3386186 MK	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. */
8201327c	103	int sc_pc_offset;
21d0e8a4	104	int sc_sp_offset;
794ac428 UW	105
794ac428 UW	106	/* ISA-specific data types. */
209bd28e UW	107	struct type *i386_eflags_type;
209bd28e UW	108	struct type *i386_mxcsr_type;
794ac428 UW	109	struct type *i386_mmx_type;
794ac428 UW	110	struct type *i386_sse_type;
27067745	111	struct type *i387_ext_type;
7ad10968 HZ	112
	113	/* Process record/replay target. */
	114	/* Parse intx80 args. */
	115	int (i386_intx80_record) (struct regcache regcache);
	116	/* Parse sysenter args. */
	117	int (i386_sysenter_record) (struct regcache regcache);
96297dab MK	118	};
	119
	120	/* Floating-point registers. */
	121
96297dab MK	122	/* All FPU control regusters (except for FIOFF and FOOFF) are 16-bit
	123	(at most) in the FPU, but are zero-extended to 32 bits in GDB's
	124	register cache. */
	125
23a34459 AC	126	/* Return non-zero if REGNUM matches the FP register and the FP
23a34459 AC	127	register set is active. */
20a6ec49 MD	128	extern int i386_fp_regnum_p (struct gdbarch *, int);
20a6ec49 MD	129	extern int i386_fpc_regnum_p (struct gdbarch *, int);
96297dab	130
a3386186 MK	131	/* Register numbers of various important registers. */
a3386186 MK	132
bcf48cc7 MK	133	enum i386_regnum
	134	{
	135	I386_EAX_REGNUM, /* %eax */
	136	I386_ECX_REGNUM, /* %ecx */
	137	I386_EDX_REGNUM, /* %edx */
	138	I386_EBX_REGNUM, /* %ebx */
	139	I386_ESP_REGNUM, /* %esp */
	140	I386_EBP_REGNUM, /* %ebp */
	141	I386_ESI_REGNUM, /* %esi */
	142	I386_EDI_REGNUM, /* %edi */
	143	I386_EIP_REGNUM, /* %eip */
	144	I386_EFLAGS_REGNUM, /* %eflags */
2666fb59 MK	145	I386_CS_REGNUM, /* %cs */
2666fb59 MK	146	I386_SS_REGNUM, /* %ss */
e9ff708b AC	147	I386_DS_REGNUM, /* %ds */
	148	I386_ES_REGNUM, /* %es */
	149	I386_FS_REGNUM, /* %fs */
	150	I386_GS_REGNUM, /* %gs */
	151	I386_ST0_REGNUM /* %st(0) */
bcf48cc7	152	};
a3386186	153
8201327c MK	154	#define I386_NUM_GREGS 16
	155	#define I386_NUM_FREGS 16
	156	#define I386_NUM_XREGS 9
	157
	158	#define I386_SSE_NUM_REGS (I386_NUM_GREGS + I386_NUM_FREGS \
	159	+ I386_NUM_XREGS)
	160
00f8375e MK	161	/* Size of the largest register. */
	162	#define I386_MAX_REGISTER_SIZE 16
	163
5ae96ec1	164	/* Types for i386-specific registers. */
209bd28e UW	165	extern struct type i386_eflags_type (struct gdbarch gdbarch);
209bd28e UW	166	extern struct type i386_mxcsr_type (struct gdbarch gdbarch);
794ac428 UW	167	extern struct type i386_mmx_type (struct gdbarch gdbarch);
794ac428 UW	168	extern struct type i386_sse_type (struct gdbarch gdbarch);
27067745	169	extern struct type i387_ext_type (struct gdbarch gdbarch);
794ac428	170
508fbfea MK	171	/* Segment selectors. */
	172	#define I386_SEL_RPL 0x0003 /* Requester's Privilege Level mask. */
	173	#define I386_SEL_UPL 0x0003 /* User Privilige Level. */
	174	#define I386_SEL_KPL 0x0000 /* Kernel Privilige Level. */
	175
237fc4c9 PA	176	/* The length of the longest i386 instruction (according to
	177	include/asm-i386/kprobes.h in Linux 2.6. */
	178	#define I386_MAX_INSN_LEN (16)
	179
1cce71eb	180	/* Functions exported from i386-tdep.c. */
e17a4113 UW	181	extern CORE_ADDR i386_pe_skip_trampoline_code (struct frame_info *frame,
e17a4113 UW	182	CORE_ADDR pc, char *name);
4309257c	183	extern CORE_ADDR i386_skip_main_prologue (struct gdbarch *gdbarch, CORE_ADDR pc);
1cce71eb	184
4bd207ef TG	185	/* Return whether the THIS_FRAME corresponds to a sigtramp routine. */
	186	extern int i386_sigtramp_p (struct frame_info *this_frame);
	187
f6792ef4	188	/* Return the name of register REGNUM. */
d93859e2	189	extern char const i386_register_name (struct gdbarch gdbarch, int regnum);
8201327c	190
38c968cf AC	191	/* Return non-zero if REGNUM is a member of the specified group. */
	192	extern int i386_register_reggroup_p (struct gdbarch *gdbarch, int regnum,
	193	struct reggroup *group);
	194
20187ed5 MK	195	/* Supply register REGNUM from the general-purpose register set REGSET
	196	to register cache REGCACHE. If REGNUM is -1, do this for all
	197	registers in REGSET. */
	198	extern void i386_supply_gregset (const struct regset *regset,
	199	struct regcache *regcache, int regnum,
	200	const void *gregs, size_t len);
3d171c85 MK	201
	202	/* Collect register REGNUM from the register cache REGCACHE and store
	203	it in the buffer specified by GREGS and LEN as described by the
	204	general-purpose register set REGSET. If REGNUM is -1, do this for
	205	all registers in REGSET. */
	206	extern void i386_collect_gregset (const struct regset *regset,
	207	const struct regcache *regcache,
	208	int regnum, void *gregs, size_t len);
20187ed5	209
8446b36a MK	210	/* Return the appropriate register set for the core section identified
	211	by SECT_NAME and SECT_SIZE. */
	212	extern const struct regset *
	213	i386_regset_from_core_section (struct gdbarch *gdbarch,
	214	const char *sect_name, size_t sect_size);
	215
237fc4c9 PA	216
	217	extern void i386_displaced_step_fixup (struct gdbarch *gdbarch,
	218	struct displaced_step_closure *closure,
	219	CORE_ADDR from, CORE_ADDR to,
	220	struct regcache *regs);
	221
8201327c MK	222	/* Initialize a basic ELF architecture variant. */
	223	extern void i386_elf_init_abi (struct gdbarch_info, struct gdbarch *);
	224
	225	/* Initialize a SVR4 architecture variant. */
	226	extern void i386_svr4_init_abi (struct gdbarch_info, struct gdbarch *);
a6b808b4 HZ	227
	228	extern int i386_process_record (struct gdbarch *gdbarch,
	229	struct regcache *regcache, CORE_ADDR addr);
de0b6abb	230	\f
8201327c	231
de0b6abb	232	/* Functions and variables exported from i386bsd-tdep.c. */
8201327c	233
3cac699e	234	extern void i386bsd_init_abi (struct gdbarch_info, struct gdbarch *);
5d93ae8c MK	235	extern CORE_ADDR i386fbsd_sigtramp_start_addr;
	236	extern CORE_ADDR i386fbsd_sigtramp_end_addr;
	237	extern CORE_ADDR i386obsd_sigtramp_start_addr;
	238	extern CORE_ADDR i386obsd_sigtramp_end_addr;
de0b6abb MK	239	extern int i386fbsd4_sc_reg_offset[];
	240	extern int i386fbsd_sc_reg_offset[];
	241	extern int i386nbsd_sc_reg_offset[];
	242	extern int i386obsd_sc_reg_offset[];
	243	extern int i386bsd_sc_reg_offset[];
3ce1502b	244
96297dab	245	#endif /* i386-tdep.h */