[binutils.git] / gdb / arm-tdep.h

/* Common target dependent code for GDB on ARM systems.
   Copyright (C) 2002-2016 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 ARM_TDEP_H
#define ARM_TDEP_H

/* Forward declarations.  */
struct gdbarch;
struct regset;
struct address_space;
struct get_next_pcs;
struct arm_get_next_pcs;
struct gdb_get_next_pcs;

#include "arch/arm.h"

/* Say how long FP registers are.  Used for documentation purposes and
   code readability in this header.  IEEE extended doubles are 80
   bits.  DWORD aligned they use 96 bits.  */
#define FP_REGISTER_SIZE	12

/* Say how long VFP double precision registers are.  Used for documentation
   purposes and code readability.  These are fixed at 64 bits.  */
#define VFP_REGISTER_SIZE	8

/* Number of machine registers.  The only define actually required 
   is gdbarch_num_regs.  The other definitions are used for documentation
   purposes and code readability.  */
/* For 26 bit ARM code, a fake copy of the PC is placed in register 25 (PS)
   (and called PS for processor status) so the status bits can be cleared
   from the PC (register 15).  For 32 bit ARM code, a copy of CPSR is placed
   in PS.  */
#define NUM_FREGS	8	/* Number of floating point registers.  */
#define NUM_SREGS	2	/* Number of status registers.  */
#define NUM_GREGS	16	/* Number of general purpose registers.  */


/* Type of floating-point code in use by inferior.  There are really 3 models
   that are traditionally supported (plus the endianness issue), but gcc can
   only generate 2 of those.  The third is APCS_FLOAT, where arguments to
   functions are passed in floating-point registers.  

   In addition to the traditional models, VFP adds two more. 

   If you update this enum, don't forget to update fp_model_strings in 
   arm-tdep.c.  */

enum arm_float_model
{
  ARM_FLOAT_AUTO,	/* Automatic detection.  Do not set in tdep.  */
  ARM_FLOAT_SOFT_FPA,	/* Traditional soft-float (mixed-endian on LE ARM).  */
  ARM_FLOAT_FPA,	/* FPA co-processor.  GCC calling convention.  */
  ARM_FLOAT_SOFT_VFP,	/* Soft-float with pure-endian doubles.  */
  ARM_FLOAT_VFP,	/* Full VFP calling convention.  */
  ARM_FLOAT_LAST	/* Keep at end.  */
};

/* ABI used by the inferior.  */
enum arm_abi_kind
{
  ARM_ABI_AUTO,
  ARM_ABI_APCS,
  ARM_ABI_AAPCS,
  ARM_ABI_LAST
};

/* Convention for returning structures.  */

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

/* Target-dependent structure in gdbarch.  */
struct gdbarch_tdep
{
  /* The ABI for this architecture.  It should never be set to
     ARM_ABI_AUTO.  */
  enum arm_abi_kind arm_abi;

  enum arm_float_model fp_model; /* Floating point calling conventions.  */

  int have_fpa_registers;	/* Does the target report the FPA registers?  */
  int have_wmmx_registers;	/* Does the target report the WMMX registers?  */
  /* The number of VFP registers reported by the target.  It is zero
     if VFP registers are not supported.  */
  int vfp_register_count;
  int have_vfp_pseudos;		/* Are we synthesizing the single precision
				   VFP registers?  */
  int have_neon_pseudos;	/* Are we synthesizing the quad precision
				   NEON registers?  Requires
				   have_vfp_pseudos.  */
  int have_neon;		/* Do we have a NEON unit?  */

  int is_m;			/* Does the target follow the "M" profile.  */
  CORE_ADDR lowest_pc;		/* Lowest address at which instructions 
				   will appear.  */

  const gdb_byte *arm_breakpoint;	/* Breakpoint pattern for an ARM insn.  */
  int arm_breakpoint_size;	/* And its size.  */
  const gdb_byte *thumb_breakpoint;	/* Breakpoint pattern for a Thumb insn.  */
  int thumb_breakpoint_size;	/* And its size.  */

  /* If the Thumb breakpoint is an undefined instruction (which is
     affected by IT blocks) rather than a BKPT instruction (which is
     not), then we need a 32-bit Thumb breakpoint to preserve the
     instruction count in IT blocks.  */
  const gdb_byte *thumb2_breakpoint;
  int thumb2_breakpoint_size;

  int jb_pc;			/* Offset to PC value in jump buffer.
				   If this is negative, longjmp support
				   will be disabled.  */
  size_t jb_elt_size;		/* And the size of each entry in the buf.  */

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

  /* ISA-specific data types.  */
  struct type *arm_ext_type;
  struct type *neon_double_type;
  struct type *neon_quad_type;

   /* syscall record.  */
  int (*arm_syscall_record) (struct regcache *regcache, unsigned long svc_number);
};

/* Structures used for displaced stepping.  */

/* The maximum number of temporaries available for displaced instructions.  */
#define DISPLACED_TEMPS			16
/* The maximum number of modified instructions generated for one single-stepped
   instruction, including the breakpoint (usually at the end of the instruction
   sequence) and any scratch words, etc.  */
#define DISPLACED_MODIFIED_INSNS	8

struct displaced_step_closure
{
  ULONGEST tmp[DISPLACED_TEMPS];
  int rd;
  int wrote_to_pc;
  union
  {
    struct
    {
      int xfersize;
      int rn;			   /* Writeback register.  */
      unsigned int immed : 1;      /* Offset is immediate.  */
      unsigned int writeback : 1;  /* Perform base-register writeback.  */
      unsigned int restore_r4 : 1; /* Used r4 as scratch.  */
    } ldst;

    struct
    {
      unsigned long dest;
      unsigned int link : 1;
      unsigned int exchange : 1;
      unsigned int cond : 4;
    } branch;

    struct
    {
      unsigned int regmask;
      int rn;
      CORE_ADDR xfer_addr;
      unsigned int load : 1;
      unsigned int user : 1;
      unsigned int increment : 1;
      unsigned int before : 1;
      unsigned int writeback : 1;
      unsigned int cond : 4;
    } block;

    struct
    {
      unsigned int immed : 1;
    } preload;

    struct
    {
      /* If non-NULL, override generic SVC handling (e.g. for a particular
         OS).  */
      int (*copy_svc_os) (struct gdbarch *gdbarch, struct regcache *regs,
			  struct displaced_step_closure *dsc);
    } svc;
  } u;

  /* The size of original instruction, 2 or 4.  */
  unsigned int insn_size;
  /* True if the original insn (and thus all replacement insns) are Thumb
     instead of ARM.   */
  unsigned int is_thumb;

  /* The slots in the array is used in this way below,
     - ARM instruction occupies one slot,
     - Thumb 16 bit instruction occupies one slot,
     - Thumb 32-bit instruction occupies *two* slots, one part for each.  */
  unsigned long modinsn[DISPLACED_MODIFIED_INSNS];
  int numinsns;
  CORE_ADDR insn_addr;
  CORE_ADDR scratch_base;
  void (*cleanup) (struct gdbarch *, struct regcache *,
		   struct displaced_step_closure *);
};

/* Values for the WRITE_PC argument to displaced_write_reg.  If the register
   write may write to the PC, specifies the way the CPSR T bit, etc. is
   modified by the instruction.  */

enum pc_write_style
{
  BRANCH_WRITE_PC,
  BX_WRITE_PC,
  LOAD_WRITE_PC,
  ALU_WRITE_PC,
  CANNOT_WRITE_PC
};

extern void
  arm_process_displaced_insn (struct gdbarch *gdbarch, CORE_ADDR from,
			      CORE_ADDR to, struct regcache *regs,
			      struct displaced_step_closure *dsc);
extern void
  arm_displaced_init_closure (struct gdbarch *gdbarch, CORE_ADDR from,
			      CORE_ADDR to, struct displaced_step_closure *dsc);
extern ULONGEST
  displaced_read_reg (struct regcache *regs, struct displaced_step_closure *dsc,
		      int regno);
extern void
  displaced_write_reg (struct regcache *regs,
		       struct displaced_step_closure *dsc, int regno,
		       ULONGEST val, enum pc_write_style write_pc);

CORE_ADDR arm_skip_stub (struct frame_info *, CORE_ADDR);

ULONGEST arm_get_next_pcs_read_memory_unsigned_integer (CORE_ADDR memaddr,
							int len,
							int byte_order);

CORE_ADDR arm_get_next_pcs_addr_bits_remove (struct arm_get_next_pcs *self,
					     CORE_ADDR val);

int arm_get_next_pcs_is_thumb (struct arm_get_next_pcs *self);

void arm_insert_single_step_breakpoint (struct gdbarch *,
					struct address_space *, CORE_ADDR);
int arm_software_single_step (struct frame_info *);
int arm_is_thumb (struct regcache *regcache);
int arm_frame_is_thumb (struct frame_info *frame);

extern void arm_displaced_step_fixup (struct gdbarch *,
				      struct displaced_step_closure *,
				      CORE_ADDR, CORE_ADDR, struct regcache *);

/* Return the bit mask in ARM_PS_REGNUM that indicates Thumb mode.  */
extern int arm_psr_thumb_bit (struct gdbarch *);

/* Is the instruction at the given memory address a Thumb or ARM
   instruction?  */
extern int arm_pc_is_thumb (struct gdbarch *, CORE_ADDR);

extern int arm_process_record (struct gdbarch *gdbarch, 
                               struct regcache *regcache, CORE_ADDR addr);
/* Functions exported from armbsd-tdep.h.  */

/* Return the appropriate register set for the core section identified
   by SECT_NAME and SECT_SIZE.  */

extern void
  armbsd_iterate_over_regset_sections (struct gdbarch *gdbarch,
				       iterate_over_regset_sections_cb *cb,
				       void *cb_data,
				       const struct regcache *regcache);

/* Target descriptions.  */
extern struct target_desc *tdesc_arm_with_m;
extern struct target_desc *tdesc_arm_with_iwmmxt;
extern struct target_desc *tdesc_arm_with_vfpv2;
extern struct target_desc *tdesc_arm_with_vfpv3;
extern struct target_desc *tdesc_arm_with_neon;

#endif /* arm-tdep.h */
Commit	Line	Data
34e8f22d	1	/* Common target dependent code for GDB on ARM systems.
618f726f	2	Copyright (C) 2002-2016 Free Software Foundation, Inc.
34e8f22d RE	3
	4	This file is part of GDB.
	5
	6	This program is free software; you can redistribute it and/or modify
	7	it under the terms of the GNU General Public License as published by
a9762ec7	8	the Free Software Foundation; either version 3 of the License, or
34e8f22d RE	9	(at your option) any later version.
	10
	11	This program is distributed in the hope that it will be useful,
	12	but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	GNU General Public License for more details.
	15
	16	You should have received a copy of the GNU General Public License
a9762ec7	17	along with this program. If not, see <http://www.gnu.org/licenses/>. */
34e8f22d	18
47ccd048 MK	19	#ifndef ARM_TDEP_H
	20	#define ARM_TDEP_H
	21
cb587d83	22	/* Forward declarations. */
47ccd048	23	struct gdbarch;
cb587d83	24	struct regset;
3352110b	25	struct address_space;
d9311bfa AT	26	struct get_next_pcs;
	27	struct arm_get_next_pcs;
	28	struct gdb_get_next_pcs;
cb587d83	29
ec741292	30	#include "arch/arm.h"
34e8f22d	31
34e8f22d RE	32	/* Say how long FP registers are. Used for documentation purposes and
	33	code readability in this header. IEEE extended doubles are 80
	34	bits. DWORD aligned they use 96 bits. */
7a5ea0d4	35	#define FP_REGISTER_SIZE 12
34e8f22d	36
3184d3f9 JL	37	/* Say how long VFP double precision registers are. Used for documentation
	38	purposes and code readability. These are fixed at 64 bits. */
	39	#define VFP_REGISTER_SIZE 8
	40
34e8f22d	41	/* Number of machine registers. The only define actually required
f57d151a	42	is gdbarch_num_regs. The other definitions are used for documentation
34e8f22d RE	43	purposes and code readability. */
	44	/* For 26 bit ARM code, a fake copy of the PC is placed in register 25 (PS)
	45	(and called PS for processor status) so the status bits can be cleared
	46	from the PC (register 15). For 32 bit ARM code, a copy of CPSR is placed
	47	in PS. */
	48	#define NUM_FREGS 8 /* Number of floating point registers. */
	49	#define NUM_SREGS 2 /* Number of status registers. */
	50	#define NUM_GREGS 16 /* Number of general purpose registers. */
	51
	52
9779414d	53
08216dd7 RE	54	/* Type of floating-point code in use by inferior. There are really 3 models
	55	that are traditionally supported (plus the endianness issue), but gcc can
	56	only generate 2 of those. The third is APCS_FLOAT, where arguments to
	57	functions are passed in floating-point registers.
	58
fd50bc42 RE	59	In addition to the traditional models, VFP adds two more.
	60
	61	If you update this enum, don't forget to update fp_model_strings in
	62	arm-tdep.c. */
08216dd7 RE	63
	64	enum arm_float_model
	65	{
fd50bc42 RE	66	ARM_FLOAT_AUTO, /* Automatic detection. Do not set in tdep. */
	67	ARM_FLOAT_SOFT_FPA, /* Traditional soft-float (mixed-endian on LE ARM). */
	68	ARM_FLOAT_FPA, /* FPA co-processor. GCC calling convention. */
	69	ARM_FLOAT_SOFT_VFP, /* Soft-float with pure-endian doubles. */
	70	ARM_FLOAT_VFP, /* Full VFP calling convention. */
	71	ARM_FLOAT_LAST /* Keep at end. */
08216dd7 RE	72	};
08216dd7 RE	73
28e97307 DJ	74	/* ABI used by the inferior. */
	75	enum arm_abi_kind
	76	{
	77	ARM_ABI_AUTO,
	78	ARM_ABI_APCS,
	79	ARM_ABI_AAPCS,
	80	ARM_ABI_LAST
	81	};
fd50bc42	82
7c00367c MK	83	/* Convention for returning structures. */
	84
	85	enum struct_return
	86	{
	87	pcc_struct_return, /* Return "short" structures in memory. */
	88	reg_struct_return /* Return "short" structures in registers. */
	89	};
	90
97e03143 RE	91	/* Target-dependent structure in gdbarch. */
	92	struct gdbarch_tdep
	93	{
28e97307 DJ	94	/* The ABI for this architecture. It should never be set to
	95	ARM_ABI_AUTO. */
	96	enum arm_abi_kind arm_abi;
	97
08216dd7 RE	98	enum arm_float_model fp_model; /* Floating point calling conventions. */
08216dd7 RE	99
ff6f572f	100	int have_fpa_registers; /* Does the target report the FPA registers? */
a56cc1ce	101	int have_wmmx_registers; /* Does the target report the WMMX registers? */
330c6ca9 YQ	102	/* The number of VFP registers reported by the target. It is zero
	103	if VFP registers are not supported. */
	104	int vfp_register_count;
58d6951d DJ	105	int have_vfp_pseudos; /* Are we synthesizing the single precision
	106	VFP registers? */
	107	int have_neon_pseudos; /* Are we synthesizing the quad precision
	108	NEON registers? Requires
	109	have_vfp_pseudos. */
	110	int have_neon; /* Do we have a NEON unit? */
ff6f572f	111
9779414d	112	int is_m; /* Does the target follow the "M" profile. */
97e03143 RE	113	CORE_ADDR lowest_pc; /* Lowest address at which instructions
97e03143 RE	114	will appear. */
9df628e0	115
948f8e3d	116	const gdb_byte arm_breakpoint; / Breakpoint pattern for an ARM insn. */
9df628e0	117	int arm_breakpoint_size; /* And its size. */
948f8e3d	118	const gdb_byte thumb_breakpoint; / Breakpoint pattern for a Thumb insn. */
9df628e0 RE	119	int thumb_breakpoint_size; /* And its size. */
9df628e0 RE	120
177321bd DJ	121	/* If the Thumb breakpoint is an undefined instruction (which is
	122	affected by IT blocks) rather than a BKPT instruction (which is
	123	not), then we need a 32-bit Thumb breakpoint to preserve the
	124	instruction count in IT blocks. */
948f8e3d	125	const gdb_byte *thumb2_breakpoint;
177321bd DJ	126	int thumb2_breakpoint_size;
177321bd DJ	127
0963b4bd	128	int jb_pc; /* Offset to PC value in jump buffer.
9df628e0 RE	129	If this is negative, longjmp support
	130	will be disabled. */
	131	size_t jb_elt_size; /* And the size of each entry in the buf. */
cb587d83	132
7c00367c MK	133	/* Convention for returning structures. */
	134	enum struct_return struct_return;
	135
27067745 UW	136	/* ISA-specific data types. */
27067745 UW	137	struct type *arm_ext_type;
58d6951d DJ	138	struct type *neon_double_type;
58d6951d DJ	139	struct type *neon_quad_type;
25b41d01	140
97dfe206 OJ	141	/* syscall record. */
97dfe206 OJ	142	int (arm_syscall_record) (struct regcache regcache, unsigned long svc_number);
97e03143 RE	143	};
97e03143 RE	144
cca44b1b JB	145	/* Structures used for displaced stepping. */
	146
	147	/* The maximum number of temporaries available for displaced instructions. */
	148	#define DISPLACED_TEMPS 16
	149	/* The maximum number of modified instructions generated for one single-stepped
	150	instruction, including the breakpoint (usually at the end of the instruction
	151	sequence) and any scratch words, etc. */
	152	#define DISPLACED_MODIFIED_INSNS 8
	153
	154	struct displaced_step_closure
	155	{
	156	ULONGEST tmp[DISPLACED_TEMPS];
	157	int rd;
	158	int wrote_to_pc;
	159	union
	160	{
	161	struct
	162	{
	163	int xfersize;
	164	int rn; /* Writeback register. */
	165	unsigned int immed : 1; /* Offset is immediate. */
	166	unsigned int writeback : 1; /* Perform base-register writeback. */
	167	unsigned int restore_r4 : 1; /* Used r4 as scratch. */
	168	} ldst;
	169
	170	struct
	171	{
	172	unsigned long dest;
	173	unsigned int link : 1;
	174	unsigned int exchange : 1;
	175	unsigned int cond : 4;
	176	} branch;
	177
	178	struct
	179	{
	180	unsigned int regmask;
	181	int rn;
	182	CORE_ADDR xfer_addr;
	183	unsigned int load : 1;
	184	unsigned int user : 1;
	185	unsigned int increment : 1;
	186	unsigned int before : 1;
	187	unsigned int writeback : 1;
	188	unsigned int cond : 4;
	189	} block;
	190
	191	struct
	192	{
	193	unsigned int immed : 1;
	194	} preload;
	195
	196	struct
	197	{
	198	/* If non-NULL, override generic SVC handling (e.g. for a particular
	199	OS). */
bd18283a	200	int (copy_svc_os) (struct gdbarch gdbarch, struct regcache *regs,
cca44b1b JB	201	struct displaced_step_closure *dsc);
	202	} svc;
	203	} u;
4db71c0b YQ	204
	205	/* The size of original instruction, 2 or 4. */
	206	unsigned int insn_size;
	207	/* True if the original insn (and thus all replacement insns) are Thumb
	208	instead of ARM. */
	209	unsigned int is_thumb;
	210
	211	/* The slots in the array is used in this way below,
	212	- ARM instruction occupies one slot,
	213	- Thumb 16 bit instruction occupies one slot,
	214	- Thumb 32-bit instruction occupies two slots, one part for each. */
cca44b1b JB	215	unsigned long modinsn[DISPLACED_MODIFIED_INSNS];
	216	int numinsns;
	217	CORE_ADDR insn_addr;
	218	CORE_ADDR scratch_base;
	219	void (cleanup) (struct gdbarch , struct regcache *,
	220	struct displaced_step_closure *);
	221	};
	222
	223	/* Values for the WRITE_PC argument to displaced_write_reg. If the register
	224	write may write to the PC, specifies the way the CPSR T bit, etc. is
	225	modified by the instruction. */
	226
	227	enum pc_write_style
	228	{
	229	BRANCH_WRITE_PC,
	230	BX_WRITE_PC,
	231	LOAD_WRITE_PC,
	232	ALU_WRITE_PC,
	233	CANNOT_WRITE_PC
	234	};
	235
	236	extern void
b434a28f YQ	237	arm_process_displaced_insn (struct gdbarch *gdbarch, CORE_ADDR from,
b434a28f YQ	238	CORE_ADDR to, struct regcache *regs,
cca44b1b JB	239	struct displaced_step_closure *dsc);
	240	extern void
	241	arm_displaced_init_closure (struct gdbarch *gdbarch, CORE_ADDR from,
	242	CORE_ADDR to, struct displaced_step_closure *dsc);
	243	extern ULONGEST
36073a92 YQ	244	displaced_read_reg (struct regcache regs, struct displaced_step_closure dsc,
36073a92 YQ	245	int regno);
cca44b1b JB	246	extern void
	247	displaced_write_reg (struct regcache *regs,
	248	struct displaced_step_closure *dsc, int regno,
	249	ULONGEST val, enum pc_write_style write_pc);
7c00367c	250
6dc13412	251	CORE_ADDR arm_skip_stub (struct frame_info *, CORE_ADDR);
d9311bfa AT	252
	253	ULONGEST arm_get_next_pcs_read_memory_unsigned_integer (CORE_ADDR memaddr,
	254	int len,
	255	int byte_order);
	256
	257	CORE_ADDR arm_get_next_pcs_addr_bits_remove (struct arm_get_next_pcs *self,
	258	CORE_ADDR val);
	259
d9311bfa AT	260	int arm_get_next_pcs_is_thumb (struct arm_get_next_pcs *self);
d9311bfa AT	261
18819fa6 UW	262	void arm_insert_single_step_breakpoint (struct gdbarch *,
18819fa6 UW	263	struct address_space *, CORE_ADDR);
0b1b3e42	264	int arm_software_single_step (struct frame_info *);
d0e59a68	265	int arm_is_thumb (struct regcache *regcache);
25b41d01	266	int arm_frame_is_thumb (struct frame_info *frame);
190dce09	267
cca44b1b JB	268	extern void arm_displaced_step_fixup (struct gdbarch *,
	269	struct displaced_step_closure *,
	270	CORE_ADDR, CORE_ADDR, struct regcache *);
	271
478fd957 UW	272	/* Return the bit mask in ARM_PS_REGNUM that indicates Thumb mode. */
	273	extern int arm_psr_thumb_bit (struct gdbarch *);
	274
e3039479 UW	275	/* Is the instruction at the given memory address a Thumb or ARM
	276	instruction? */
	277	extern int arm_pc_is_thumb (struct gdbarch *, CORE_ADDR);
	278
72508ac0 PO	279	extern int arm_process_record (struct gdbarch *gdbarch,
72508ac0 PO	280	struct regcache *regcache, CORE_ADDR addr);
47ccd048 MK	281	/* Functions exported from armbsd-tdep.h. */
	282
	283	/* Return the appropriate register set for the core section identified
	284	by SECT_NAME and SECT_SIZE. */
	285
ed09174e AA	286	extern void
	287	armbsd_iterate_over_regset_sections (struct gdbarch *gdbarch,
	288	iterate_over_regset_sections_cb *cb,
	289	void *cb_data,
	290	const struct regcache *regcache);
47ccd048	291
ef7e8358 UW	292	/* Target descriptions. */
	293	extern struct target_desc *tdesc_arm_with_m;
	294	extern struct target_desc *tdesc_arm_with_iwmmxt;
	295	extern struct target_desc *tdesc_arm_with_vfpv2;
	296	extern struct target_desc *tdesc_arm_with_vfpv3;
	297	extern struct target_desc *tdesc_arm_with_neon;
	298
47ccd048	299	#endif /* arm-tdep.h */