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

/* Target-dependent code for the HP PA-RISC architecture.

   Copyright (C) 2003, 2004, 2005, 2006, 2007 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 HPPA_TDEP_H
#define HPPA_TDEP_H

struct trad_frame_saved_reg;
struct objfile;
struct so_list;

/* Register numbers of various important registers.  */

enum hppa_regnum
{
  HPPA_R0_REGNUM = 0,		/* Doesn't actually exist, used as base for
				   other r registers.  */
  HPPA_R1_REGNUM = 1,
  HPPA_FLAGS_REGNUM = 0,	/* Various status flags */
  HPPA_RP_REGNUM = 2,		/* return pointer */
  HPPA_FP_REGNUM = 3,		/* The ABI's frame pointer, when used */
  HPPA_DP_REGNUM = 27,
  HPPA_RET0_REGNUM = 28,
  HPPA_RET1_REGNUM = 29,
  HPPA_SP_REGNUM = 30,		/* Stack pointer.  */
  HPPA_R31_REGNUM = 31,
  HPPA_SAR_REGNUM = 32,		/* Shift Amount Register */
  HPPA_IPSW_REGNUM = 41,	/* Interrupt Processor Status Word */
  HPPA_PCOQ_HEAD_REGNUM = 33,	/* instruction offset queue head */
  HPPA_PCSQ_HEAD_REGNUM = 34,	/* instruction space queue head */
  HPPA_PCOQ_TAIL_REGNUM = 35,	/* instruction offset queue tail */
  HPPA_PCSQ_TAIL_REGNUM = 36,	/* instruction space queue tail */
  HPPA_EIEM_REGNUM = 37,	/* External Interrupt Enable Mask */
  HPPA_IIR_REGNUM = 38,		/* Interrupt Instruction Register */
  HPPA_ISR_REGNUM = 39,		/* Interrupt Space Register */
  HPPA_IOR_REGNUM = 40,		/* Interrupt Offset Register */
  HPPA_SR4_REGNUM = 43,		/* space register 4 */
  HPPA_RCR_REGNUM = 51,		/* Recover Counter (also known as cr0) */
  HPPA_PID0_REGNUM = 52,	/* Protection ID */
  HPPA_PID1_REGNUM = 53,	/* Protection ID */
  HPPA_PID2_REGNUM = 55,	/* Protection ID */
  HPPA_PID3_REGNUM = 56,	/* Protection ID */
  HPPA_CCR_REGNUM = 54,		/* Coprocessor Configuration Register */
  HPPA_TR0_REGNUM = 57,		/* Temporary Registers (cr24 -> cr31) */
  HPPA_CR26_REGNUM = 59,
  HPPA_CR27_REGNUM = 60,	/* Base register for thread-local storage, cr27 */
  HPPA_FP0_REGNUM = 64,		/* First floating-point.  */
  HPPA_FP4_REGNUM = 72,
  HPPA64_FP4_REGNUM = 68,
  HPPA_FP31R_REGNUM = 127,	/* Last floating-point.  */

  HPPA_ARG0_REGNUM = 26,	/* The first argument of a callee. */
  HPPA_ARG1_REGNUM = 25,	/* The second argument of a callee. */
  HPPA_ARG2_REGNUM = 24,	/* The third argument of a callee. */
  HPPA_ARG3_REGNUM = 23		/* The fourth argument of a callee. */
};

/* Instruction size.  */
#define HPPA_INSN_SIZE 4

/* Target-dependent structure in gdbarch.  */
struct gdbarch_tdep
{
  /* The number of bytes in an address.  For now, this field is designed
     to allow us to differentiate hppa32 from hppa64 targets.  */
  int bytes_per_address;

  /* Is this an ELF target? This can be 64-bit HP-UX, or a 32/64-bit GNU/Linux
     system.  */
  int is_elf;

  /* Given a function address, try to find the global pointer for the 
     corresponding shared object.  */
  CORE_ADDR (*find_global_pointer) (struct value *);

  /* For shared libraries, each call goes through a small piece of
     trampoline code in the ".plt", or equivalent, section.
     IN_SOLIB_CALL_TRAMPOLINE evaluates to nonzero if we are currently
     stopped in one of these.  */
  int (*in_solib_call_trampoline) (CORE_ADDR pc, char *name);

  /* For targets that support multiple spaces, we may have additional stubs
     in the return path.  These stubs are internal to the ABI, and users are
     not interested in them.  If we detect that we are returning to a stub,
     adjust the pc to the real caller.  This improves the behavior of commands
     that traverse frames such as "up" and "finish".  */
  void (*unwind_adjust_stub) (struct frame_info *next_frame, CORE_ADDR base,
  			      struct trad_frame_saved_reg *saved_regs);

  /* These are solib-dependent methods.  They are really HPUX only, but
     we don't have a HPUX-specific tdep vector at the moment.  */
  CORE_ADDR (*solib_thread_start_addr) (struct so_list *so);
  CORE_ADDR (*solib_get_got_by_pc) (CORE_ADDR addr);
  CORE_ADDR (*solib_get_solib_by_pc) (CORE_ADDR addr);
  CORE_ADDR (*solib_get_text_base) (struct objfile *objfile);
};

/*
 * Unwind table and descriptor.
 */

struct unwind_table_entry
  {
    CORE_ADDR region_start;
    CORE_ADDR region_end;

    unsigned int Cannot_unwind:1;	/* 0 */
    unsigned int Millicode:1;	/* 1 */
    unsigned int Millicode_save_sr0:1;	/* 2 */
    unsigned int Region_description:2;	/* 3..4 */
    unsigned int reserved:1;	/* 5 */
    unsigned int Entry_SR:1;	/* 6 */
    unsigned int Entry_FR:4;	/* number saved *//* 7..10 */
    unsigned int Entry_GR:5;	/* number saved *//* 11..15 */
    unsigned int Args_stored:1;	/* 16 */
    unsigned int Variable_Frame:1;	/* 17 */
    unsigned int Separate_Package_Body:1;	/* 18 */
    unsigned int Frame_Extension_Millicode:1;	/* 19 */
    unsigned int Stack_Overflow_Check:1;	/* 20 */
    unsigned int Two_Instruction_SP_Increment:1;	/* 21 */
    unsigned int sr4export:1;	/* 22 */
    unsigned int cxx_info:1;	/* 23 */
    unsigned int cxx_try_catch:1;	/* 24 */
    unsigned int sched_entry_seq:1;	/* 25 */
    unsigned int reserved1:1;	/* 26 */
    unsigned int Save_SP:1;	/* 27 */
    unsigned int Save_RP:1;	/* 28 */
    unsigned int Save_MRP_in_frame:1;	/* 29 */
    unsigned int save_r19:1;	/* 30 */
    unsigned int Cleanup_defined:1;	/* 31 */

    unsigned int MPE_XL_interrupt_marker:1;	/* 0 */
    unsigned int HP_UX_interrupt_marker:1;	/* 1 */
    unsigned int Large_frame:1;	/* 2 */
    unsigned int alloca_frame:1;	/* 3 */
    unsigned int reserved2:1;	/* 4 */
    unsigned int Total_frame_size:27;	/* 5..31 */

    /* This is *NOT* part of an actual unwind_descriptor in an object
       file.  It is *ONLY* part of the "internalized" descriptors that
       we create from those in a file.
     */
    struct
      {
	unsigned int stub_type:4;	/* 0..3 */
	unsigned int padding:28;	/* 4..31 */
      }
    stub_unwind;
  };

/* HP linkers also generate unwinds for various linker-generated stubs.
   GDB reads in the stubs from the $UNWIND_END$ subspace, then 
   "converts" them into normal unwind entries using some of the reserved
   fields to store the stub type.  */

/* The gaps represent linker stubs used in MPE and space for future
   expansion.  */
enum unwind_stub_types
  {
    LONG_BRANCH = 1,
    PARAMETER_RELOCATION = 2,
    EXPORT = 10,
    IMPORT = 11,
    IMPORT_SHLIB = 12,
  };

struct unwind_table_entry *find_unwind_entry (CORE_ADDR);

/* We use the objfile->obj_private pointer for two things:
 * 1.  An unwind table;
 *
 * 2.  A pointer to any associated shared library object.
 *
 * #defines are used to help refer to these objects.
 */

/* Info about the unwind table associated with an object file.
 * This is hung off of the "objfile->obj_private" pointer, and
 * is allocated in the objfile's psymbol obstack.  This allows
 * us to have unique unwind info for each executable and shared
 * library that we are debugging.
 */
struct hppa_unwind_info
  {
    struct unwind_table_entry *table;	/* Pointer to unwind info */
    struct unwind_table_entry *cache;	/* Pointer to last entry we found */
    int last;			/* Index of last entry */
  };

struct hppa_objfile_private
  {
    struct hppa_unwind_info *unwind_info;	/* a pointer */
    struct so_list *so_info;	/* a pointer  */
    CORE_ADDR dp;

    int dummy_call_sequence_reg;
    CORE_ADDR dummy_call_sequence_addr;
  };

extern const struct objfile_data *hppa_objfile_priv_data;

int hppa_get_field (unsigned word, int from, int to);
int hppa_extract_5_load (unsigned int);
unsigned hppa_extract_5R_store (unsigned int);
unsigned hppa_extract_5r_store (unsigned int);
int hppa_extract_17 (unsigned int);
int hppa_extract_21 (unsigned);
int hppa_extract_14 (unsigned);
int hppa_low_sign_extend (unsigned int, unsigned int);
int hppa_sign_extend (unsigned int, unsigned int);
CORE_ADDR hppa_symbol_address(const char *sym);

extern void
  hppa_frame_prev_register_helper (struct frame_info *next_frame,
				   struct trad_frame_saved_reg *saved_regs,
				   int regnum, int *optimizedp,
				   enum lval_type *lvalp, CORE_ADDR *addrp,
				   int *realnump, gdb_byte *valuep);

extern CORE_ADDR hppa_read_pc (struct regcache *regcache);
extern void hppa_write_pc (struct regcache *regcache, CORE_ADDR pc);
extern CORE_ADDR hppa_unwind_pc (struct gdbarch *gdbarch,
				 struct frame_info *next_frame);

extern struct minimal_symbol *
  hppa_lookup_stub_minimal_symbol (const char *name,
                                   enum unwind_stub_types stub_type);

extern struct hppa_objfile_private *
hppa_init_objfile_priv_data (struct objfile *objfile);

extern int hppa_in_solib_call_trampoline (CORE_ADDR pc, char *name);
extern CORE_ADDR hppa_skip_trampoline_code (struct frame_info *, CORE_ADDR pc);

#endif  /* hppa-tdep.h */
Commit	Line	Data
a7aad9aa MK	1	/* Target-dependent code for the HP PA-RISC architecture.
a7aad9aa MK	2
6aba47ca	3	Copyright (C) 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
3ff7cf9e JB	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
3ff7cf9e JB	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/>. */
3ff7cf9e JB	19
	20	#ifndef HPPA_TDEP_H
	21	#define HPPA_TDEP_H
	22
f626a069	23	struct trad_frame_saved_reg;
acf86d54 RC	24	struct objfile;
acf86d54 RC	25	struct so_list;
f626a069	26
7157eed4	27	/* Register numbers of various important registers. */
34f75cc1	28
c481d1ca MK	29	enum hppa_regnum
c481d1ca MK	30	{
34f75cc1 RC	31	HPPA_R0_REGNUM = 0, /* Doesn't actually exist, used as base for
34f75cc1 RC	32	other r registers. */
c481d1ca	33	HPPA_R1_REGNUM = 1,
34f75cc1 RC	34	HPPA_FLAGS_REGNUM = 0, /* Various status flags */
	35	HPPA_RP_REGNUM = 2, /* return pointer */
	36	HPPA_FP_REGNUM = 3, /* The ABI's frame pointer, when used */
38ca4e0c MK	37	HPPA_DP_REGNUM = 27,
	38	HPPA_RET0_REGNUM = 28,
	39	HPPA_RET1_REGNUM = 29,
34f75cc1	40	HPPA_SP_REGNUM = 30, /* Stack pointer. */
8d1b517b	41	HPPA_R31_REGNUM = 31,
34f75cc1 RC	42	HPPA_SAR_REGNUM = 32, /* Shift Amount Register */
	43	HPPA_IPSW_REGNUM = 41, /* Interrupt Processor Status Word */
	44	HPPA_PCOQ_HEAD_REGNUM = 33, /* instruction offset queue head */
	45	HPPA_PCSQ_HEAD_REGNUM = 34, /* instruction space queue head */
	46	HPPA_PCOQ_TAIL_REGNUM = 35, /* instruction offset queue tail */
	47	HPPA_PCSQ_TAIL_REGNUM = 36, /* instruction space queue tail */
	48	HPPA_EIEM_REGNUM = 37, /* External Interrupt Enable Mask */
	49	HPPA_IIR_REGNUM = 38, /* Interrupt Instruction Register */
	50	HPPA_ISR_REGNUM = 39, /* Interrupt Space Register */
	51	HPPA_IOR_REGNUM = 40, /* Interrupt Offset Register */
	52	HPPA_SR4_REGNUM = 43, /* space register 4 */
	53	HPPA_RCR_REGNUM = 51, /* Recover Counter (also known as cr0) */
	54	HPPA_PID0_REGNUM = 52, /* Protection ID */
	55	HPPA_PID1_REGNUM = 53, /* Protection ID */
	56	HPPA_PID2_REGNUM = 55, /* Protection ID */
	57	HPPA_PID3_REGNUM = 56, /* Protection ID */
	58	HPPA_CCR_REGNUM = 54, /* Coprocessor Configuration Register */
	59	HPPA_TR0_REGNUM = 57, /* Temporary Registers (cr24 -> cr31) */
d037d088	60	HPPA_CR26_REGNUM = 59,
34f75cc1 RC	61	HPPA_CR27_REGNUM = 60, /* Base register for thread-local storage, cr27 */
	62	HPPA_FP0_REGNUM = 64, /* First floating-point. */
	63	HPPA_FP4_REGNUM = 72,
38ca4e0c	64	HPPA64_FP4_REGNUM = 68,
20776c7d	65	HPPA_FP31R_REGNUM = 127, /* Last floating-point. */
34f75cc1 RC	66
	67	HPPA_ARG0_REGNUM = 26, /* The first argument of a callee. */
	68	HPPA_ARG1_REGNUM = 25, /* The second argument of a callee. */
	69	HPPA_ARG2_REGNUM = 24, /* The third argument of a callee. */
	70	HPPA_ARG3_REGNUM = 23 /* The fourth argument of a callee. */
	71	};
	72
d275c051 MK	73	/* Instruction size. */
	74	#define HPPA_INSN_SIZE 4
	75
3ff7cf9e JB	76	/* Target-dependent structure in gdbarch. */
	77	struct gdbarch_tdep
	78	{
	79	/* The number of bytes in an address. For now, this field is designed
	80	to allow us to differentiate hppa32 from hppa64 targets. */
	81	int bytes_per_address;
fdd72f95 RC	82
	83	/* Is this an ELF target? This can be 64-bit HP-UX, or a 32/64-bit GNU/Linux
	84	system. */
	85	int is_elf;
d49771ef RC	86
	87	/* Given a function address, try to find the global pointer for the
	88	corresponding shared object. */
	89	CORE_ADDR (find_global_pointer) (struct value );
84674fe1 AC	90
	91	/* For shared libraries, each call goes through a small piece of
	92	trampoline code in the ".plt", or equivalent, section.
	93	IN_SOLIB_CALL_TRAMPOLINE evaluates to nonzero if we are currently
	94	stopped in one of these. */
	95	int (in_solib_call_trampoline) (CORE_ADDR pc, char name);
f77a2124 RC	96
	97	/* For targets that support multiple spaces, we may have additional stubs
	98	in the return path. These stubs are internal to the ABI, and users are
	99	not interested in them. If we detect that we are returning to a stub,
	100	adjust the pc to the real caller. This improves the behavior of commands
	101	that traverse frames such as "up" and "finish". */
	102	void (unwind_adjust_stub) (struct frame_info next_frame, CORE_ADDR base,
	103	struct trad_frame_saved_reg *saved_regs);
	104
acf86d54 RC	105	/* These are solib-dependent methods. They are really HPUX only, but
	106	we don't have a HPUX-specific tdep vector at the moment. */
	107	CORE_ADDR (solib_thread_start_addr) (struct so_list so);
	108	CORE_ADDR (*solib_get_got_by_pc) (CORE_ADDR addr);
	109	CORE_ADDR (*solib_get_solib_by_pc) (CORE_ADDR addr);
	110	CORE_ADDR (solib_get_text_base) (struct objfile objfile);
3ff7cf9e JB	111	};
3ff7cf9e JB	112
7c46b9fb RC	113	/*
	114	* Unwind table and descriptor.
	115	*/
	116
	117	struct unwind_table_entry
	118	{
	119	CORE_ADDR region_start;
	120	CORE_ADDR region_end;
	121
	122	unsigned int Cannot_unwind:1; /* 0 */
	123	unsigned int Millicode:1; /* 1 */
	124	unsigned int Millicode_save_sr0:1; /* 2 */
	125	unsigned int Region_description:2; /* 3..4 */
6fcecea0	126	unsigned int reserved:1; /* 5 */
7c46b9fb RC	127	unsigned int Entry_SR:1; /* 6 */
	128	unsigned int Entry_FR:4; /* number saved // 7..10 */
	129	unsigned int Entry_GR:5; /* number saved // 11..15 */
	130	unsigned int Args_stored:1; /* 16 */
	131	unsigned int Variable_Frame:1; /* 17 */
	132	unsigned int Separate_Package_Body:1; /* 18 */
	133	unsigned int Frame_Extension_Millicode:1; /* 19 */
	134	unsigned int Stack_Overflow_Check:1; /* 20 */
	135	unsigned int Two_Instruction_SP_Increment:1; /* 21 */
6fcecea0	136	unsigned int sr4export:1; /* 22 */
7c46b9fb RC	137	unsigned int cxx_info:1; /* 23 */
	138	unsigned int cxx_try_catch:1; /* 24 */
	139	unsigned int sched_entry_seq:1; /* 25 */
6fcecea0	140	unsigned int reserved1:1; /* 26 */
7c46b9fb RC	141	unsigned int Save_SP:1; /* 27 */
	142	unsigned int Save_RP:1; /* 28 */
	143	unsigned int Save_MRP_in_frame:1; /* 29 */
6fcecea0	144	unsigned int save_r19:1; /* 30 */
7c46b9fb RC	145	unsigned int Cleanup_defined:1; /* 31 */
	146
	147	unsigned int MPE_XL_interrupt_marker:1; /* 0 */
	148	unsigned int HP_UX_interrupt_marker:1; /* 1 */
	149	unsigned int Large_frame:1; /* 2 */
6fcecea0 RC	150	unsigned int alloca_frame:1; /* 3 */
6fcecea0 RC	151	unsigned int reserved2:1; /* 4 */
7c46b9fb RC	152	unsigned int Total_frame_size:27; /* 5..31 */
	153
	154	/* This is NOT part of an actual unwind_descriptor in an object
	155	file. It is ONLY part of the "internalized" descriptors that
	156	we create from those in a file.
	157	*/
	158	struct
	159	{
	160	unsigned int stub_type:4; /* 0..3 */
	161	unsigned int padding:28; /* 4..31 */
	162	}
	163	stub_unwind;
	164	};
	165
	166	/* HP linkers also generate unwinds for various linker-generated stubs.
	167	GDB reads in the stubs from the $UNWIND_END$ subspace, then
	168	"converts" them into normal unwind entries using some of the reserved
	169	fields to store the stub type. */
	170
	171	/* The gaps represent linker stubs used in MPE and space for future
	172	expansion. */
	173	enum unwind_stub_types
	174	{
	175	LONG_BRANCH = 1,
	176	PARAMETER_RELOCATION = 2,
	177	EXPORT = 10,
	178	IMPORT = 11,
	179	IMPORT_SHLIB = 12,
	180	};
	181
abc485a1 RC	182	struct unwind_table_entry *find_unwind_entry (CORE_ADDR);
abc485a1 RC	183
7c46b9fb RC	184	/* We use the objfile->obj_private pointer for two things:
	185	* 1. An unwind table;
	186	*
	187	* 2. A pointer to any associated shared library object.
	188	*
	189	* #defines are used to help refer to these objects.
	190	*/
	191
	192	/* Info about the unwind table associated with an object file.
	193	* This is hung off of the "objfile->obj_private" pointer, and
	194	* is allocated in the objfile's psymbol obstack. This allows
	195	* us to have unique unwind info for each executable and shared
	196	* library that we are debugging.
	197	*/
	198	struct hppa_unwind_info
	199	{
	200	struct unwind_table_entry table; / Pointer to unwind info */
	201	struct unwind_table_entry cache; / Pointer to last entry we found */
	202	int last; /* Index of last entry */
	203	};
	204
	205	struct hppa_objfile_private
	206	{
	207	struct hppa_unwind_info unwind_info; / a pointer */
	208	struct so_list so_info; / a pointer */
	209	CORE_ADDR dp;
77d18ded RC	210
	211	int dummy_call_sequence_reg;
	212	CORE_ADDR dummy_call_sequence_addr;
7c46b9fb RC	213	};
	214
	215	extern const struct objfile_data *hppa_objfile_priv_data;
	216
abc485a1 RC	217	int hppa_get_field (unsigned word, int from, int to);
	218	int hppa_extract_5_load (unsigned int);
	219	unsigned hppa_extract_5R_store (unsigned int);
	220	unsigned hppa_extract_5r_store (unsigned int);
	221	int hppa_extract_17 (unsigned int);
	222	int hppa_extract_21 (unsigned);
	223	int hppa_extract_14 (unsigned);
	224	int hppa_low_sign_extend (unsigned int, unsigned int);
	225	int hppa_sign_extend (unsigned int, unsigned int);
3388d7ff	226	CORE_ADDR hppa_symbol_address(const char *sym);
abc485a1	227
a7aad9aa MK	228	extern void
	229	hppa_frame_prev_register_helper (struct frame_info *next_frame,
	230	struct trad_frame_saved_reg *saved_regs,
	231	int regnum, int *optimizedp,
	232	enum lval_type lvalp, CORE_ADDR addrp,
	233	int realnump, gdb_byte valuep);
0da28f8a	234
61a1198a UW	235	extern CORE_ADDR hppa_read_pc (struct regcache *regcache);
61a1198a UW	236	extern void hppa_write_pc (struct regcache *regcache, CORE_ADDR pc);
cc72850f MK	237	extern CORE_ADDR hppa_unwind_pc (struct gdbarch *gdbarch,
	238	struct frame_info *next_frame);
	239
ff644745 JB	240	extern struct minimal_symbol *
	241	hppa_lookup_stub_minimal_symbol (const char *name,
	242	enum unwind_stub_types stub_type);
	243
77d18ded RC	244	extern struct hppa_objfile_private *
	245	hppa_init_objfile_priv_data (struct objfile *objfile);
	246
34f55018	247	extern int hppa_in_solib_call_trampoline (CORE_ADDR pc, char *name);
52f729a7	248	extern CORE_ADDR hppa_skip_trampoline_code (struct frame_info *, CORE_ADDR pc);
34f55018 MK	249
34f55018 MK	250	#endif /* hppa-tdep.h */