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

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

   Copyright (C) 2003-2021 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_SR0_REGNUM = 44,		/* space register 0 */
  HPPA_SR1_REGNUM = 45,		/* space register 1 */
  HPPA_SR2_REGNUM = 46,		/* space register 2 */
  HPPA_SR3_REGNUM = 47,		/* space register 3 */
  HPPA_SR5_REGNUM = 48,		/* space register 5 */
  HPPA_SR6_REGNUM = 49,		/* space register 6 */
  HPPA_SR7_REGNUM = 50,		/* space register 7 */
  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 gdbarch *, struct value *);

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

  /* 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 *this_frame, CORE_ADDR base,
			      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);

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);
CORE_ADDR hppa_symbol_address(const char *sym);

extern struct value *
  hppa_frame_prev_register_helper (struct frame_info *this_frame,
				   trad_frame_saved_reg *saved_regs,
				   int regnum);

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 bound_minimal_symbol
  hppa_lookup_stub_minimal_symbol (const char *name,
				   enum unwind_stub_types stub_type);

extern int hppa_in_solib_call_trampoline (struct gdbarch *gdbarch,
					  CORE_ADDR pc);
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
3666a048	3	Copyright (C) 2003-2021 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 */
cbb6aada MK	53	HPPA_SR0_REGNUM = 44, /* space register 0 */
	54	HPPA_SR1_REGNUM = 45, /* space register 1 */
	55	HPPA_SR2_REGNUM = 46, /* space register 2 */
	56	HPPA_SR3_REGNUM = 47, /* space register 3 */
	57	HPPA_SR5_REGNUM = 48, /* space register 5 */
	58	HPPA_SR6_REGNUM = 49, /* space register 6 */
	59	HPPA_SR7_REGNUM = 50, /* space register 7 */
34f75cc1 RC	60	HPPA_RCR_REGNUM = 51, /* Recover Counter (also known as cr0) */
	61	HPPA_PID0_REGNUM = 52, /* Protection ID */
	62	HPPA_PID1_REGNUM = 53, /* Protection ID */
	63	HPPA_PID2_REGNUM = 55, /* Protection ID */
	64	HPPA_PID3_REGNUM = 56, /* Protection ID */
	65	HPPA_CCR_REGNUM = 54, /* Coprocessor Configuration Register */
	66	HPPA_TR0_REGNUM = 57, /* Temporary Registers (cr24 -> cr31) */
d037d088	67	HPPA_CR26_REGNUM = 59,
1777feb0 MS	68	HPPA_CR27_REGNUM = 60, /* Base register for thread-local
1777feb0 MS	69	storage, cr27 */
34f75cc1 RC	70	HPPA_FP0_REGNUM = 64, /* First floating-point. */
34f75cc1 RC	71	HPPA_FP4_REGNUM = 72,
38ca4e0c	72	HPPA64_FP4_REGNUM = 68,
20776c7d	73	HPPA_FP31R_REGNUM = 127, /* Last floating-point. */
34f75cc1	74
1777feb0 MS	75	HPPA_ARG0_REGNUM = 26, /* The first argument of a callee. */
	76	HPPA_ARG1_REGNUM = 25, /* The second argument of a callee. */
	77	HPPA_ARG2_REGNUM = 24, /* The third argument of a callee. */
	78	HPPA_ARG3_REGNUM = 23 /* The fourth argument of a callee. */
34f75cc1 RC	79	};
34f75cc1 RC	80
d275c051 MK	81	/* Instruction size. */
	82	#define HPPA_INSN_SIZE 4
	83
3ff7cf9e JB	84	/* Target-dependent structure in gdbarch. */
	85	struct gdbarch_tdep
	86	{
	87	/* The number of bytes in an address. For now, this field is designed
	88	to allow us to differentiate hppa32 from hppa64 targets. */
	89	int bytes_per_address;
fdd72f95 RC	90
	91	/* Is this an ELF target? This can be 64-bit HP-UX, or a 32/64-bit GNU/Linux
	92	system. */
	93	int is_elf;
d49771ef RC	94
	95	/* Given a function address, try to find the global pointer for the
	96	corresponding shared object. */
e38c262f	97	CORE_ADDR (find_global_pointer) (struct gdbarch , struct value *);
84674fe1 AC	98
84674fe1 AC	99	/* For shared libraries, each call goes through a small piece of
3e5d3a5a MR	100	trampoline code in the ".plt" section. IN_SOLIB_CALL_TRAMPOLINE
	101	evaluates to nonzero if we are currently stopped in one of these. */
	102	int (in_solib_call_trampoline) (struct gdbarch gdbarch, CORE_ADDR pc);
f77a2124 RC	103
	104	/* For targets that support multiple spaces, we may have additional stubs
	105	in the return path. These stubs are internal to the ABI, and users are
	106	not interested in them. If we detect that we are returning to a stub,
	107	adjust the pc to the real caller. This improves the behavior of commands
	108	that traverse frames such as "up" and "finish". */
227e86ad	109	void (unwind_adjust_stub) (struct frame_info this_frame, CORE_ADDR base,
098caef4	110	trad_frame_saved_reg *saved_regs);
f77a2124	111
acf86d54 RC	112	/* These are solib-dependent methods. They are really HPUX only, but
	113	we don't have a HPUX-specific tdep vector at the moment. */
	114	CORE_ADDR (solib_thread_start_addr) (struct so_list so);
	115	CORE_ADDR (*solib_get_got_by_pc) (CORE_ADDR addr);
	116	CORE_ADDR (*solib_get_solib_by_pc) (CORE_ADDR addr);
	117	CORE_ADDR (solib_get_text_base) (struct objfile objfile);
3ff7cf9e JB	118	};
3ff7cf9e JB	119
7c46b9fb RC	120	/*
	121	* Unwind table and descriptor.
	122	*/
	123
	124	struct unwind_table_entry
	125	{
	126	CORE_ADDR region_start;
	127	CORE_ADDR region_end;
	128
	129	unsigned int Cannot_unwind:1; /* 0 */
	130	unsigned int Millicode:1; /* 1 */
	131	unsigned int Millicode_save_sr0:1; /* 2 */
	132	unsigned int Region_description:2; /* 3..4 */
6fcecea0	133	unsigned int reserved:1; /* 5 */
7c46b9fb RC	134	unsigned int Entry_SR:1; /* 6 */
	135	unsigned int Entry_FR:4; /* number saved // 7..10 */
	136	unsigned int Entry_GR:5; /* number saved // 11..15 */
	137	unsigned int Args_stored:1; /* 16 */
	138	unsigned int Variable_Frame:1; /* 17 */
	139	unsigned int Separate_Package_Body:1; /* 18 */
	140	unsigned int Frame_Extension_Millicode:1; /* 19 */
	141	unsigned int Stack_Overflow_Check:1; /* 20 */
	142	unsigned int Two_Instruction_SP_Increment:1; /* 21 */
6fcecea0	143	unsigned int sr4export:1; /* 22 */
7c46b9fb RC	144	unsigned int cxx_info:1; /* 23 */
	145	unsigned int cxx_try_catch:1; /* 24 */
	146	unsigned int sched_entry_seq:1; /* 25 */
6fcecea0	147	unsigned int reserved1:1; /* 26 */
7c46b9fb RC	148	unsigned int Save_SP:1; /* 27 */
	149	unsigned int Save_RP:1; /* 28 */
	150	unsigned int Save_MRP_in_frame:1; /* 29 */
6fcecea0	151	unsigned int save_r19:1; /* 30 */
7c46b9fb RC	152	unsigned int Cleanup_defined:1; /* 31 */
	153
	154	unsigned int MPE_XL_interrupt_marker:1; /* 0 */
	155	unsigned int HP_UX_interrupt_marker:1; /* 1 */
	156	unsigned int Large_frame:1; /* 2 */
6fcecea0 RC	157	unsigned int alloca_frame:1; /* 3 */
6fcecea0 RC	158	unsigned int reserved2:1; /* 4 */
7c46b9fb RC	159	unsigned int Total_frame_size:27; /* 5..31 */
	160
	161	/* This is NOT part of an actual unwind_descriptor in an object
	162	file. It is ONLY part of the "internalized" descriptors that
1777feb0 MS	163	we create from those in a file. */
1777feb0 MS	164
7c46b9fb RC	165	struct
	166	{
	167	unsigned int stub_type:4; /* 0..3 */
	168	unsigned int padding:28; /* 4..31 */
	169	}
	170	stub_unwind;
	171	};
	172
	173	/* HP linkers also generate unwinds for various linker-generated stubs.
	174	GDB reads in the stubs from the $UNWIND_END$ subspace, then
	175	"converts" them into normal unwind entries using some of the reserved
	176	fields to store the stub type. */
	177
	178	/* The gaps represent linker stubs used in MPE and space for future
	179	expansion. */
	180	enum unwind_stub_types
	181	{
	182	LONG_BRANCH = 1,
	183	PARAMETER_RELOCATION = 2,
	184	EXPORT = 10,
	185	IMPORT = 11,
	186	IMPORT_SHLIB = 12,
	187	};
	188
abc485a1 RC	189	struct unwind_table_entry *find_unwind_entry (CORE_ADDR);
abc485a1 RC	190
abc485a1 RC	191	int hppa_get_field (unsigned word, int from, int to);
	192	int hppa_extract_5_load (unsigned int);
	193	unsigned hppa_extract_5R_store (unsigned int);
	194	unsigned hppa_extract_5r_store (unsigned int);
	195	int hppa_extract_17 (unsigned int);
	196	int hppa_extract_21 (unsigned);
	197	int hppa_extract_14 (unsigned);
3388d7ff	198	CORE_ADDR hppa_symbol_address(const char *sym);
abc485a1	199
227e86ad JB	200	extern struct value *
227e86ad JB	201	hppa_frame_prev_register_helper (struct frame_info *this_frame,
098caef4	202	trad_frame_saved_reg *saved_regs,
227e86ad	203	int regnum);
0da28f8a	204
61a1198a UW	205	extern CORE_ADDR hppa_read_pc (struct regcache *regcache);
61a1198a UW	206	extern void hppa_write_pc (struct regcache *regcache, CORE_ADDR pc);
cc72850f MK	207	extern CORE_ADDR hppa_unwind_pc (struct gdbarch *gdbarch,
	208	struct frame_info *next_frame);
	209
3b7344d5	210	extern struct bound_minimal_symbol
ff644745	211	hppa_lookup_stub_minimal_symbol (const char *name,
dda83cd7	212	enum unwind_stub_types stub_type);
ff644745	213
e17a4113	214	extern int hppa_in_solib_call_trampoline (struct gdbarch *gdbarch,
3e5d3a5a	215	CORE_ADDR pc);
52f729a7	216	extern CORE_ADDR hppa_skip_trampoline_code (struct frame_info *, CORE_ADDR pc);
34f55018 MK	217
34f55018 MK	218	#endif /* hppa-tdep.h */