1/* Common target dependent code for GDB on HPPA systems.
2   Copyright 2003, 2004 Free Software Foundation, Inc.
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
8   the Free Software Foundation; either version 2 of the License, or
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
17   along with this program; if not, write to the Free Software
18   Foundation, Inc., 59 Temple Place - Suite 330,
19   Boston, MA 02111-1307, USA.  */
20
21#ifndef HPPA_TDEP_H
22#define HPPA_TDEP_H
23
24struct trad_frame_saved_reg;
25
26/* Register numbers of various important registers.
27   Note that some of these values are "real" register numbers,
28   and correspond to the general registers of the machine,
29   and some are "phony" register numbers which are too large
30   to be actual register numbers as far as the user is concerned
31   but do serve to get the desired values when passed to read_register.  */
32
33enum hppa_regnum
34{
35  HPPA_R0_REGNUM = 0,		/* Doesn't actually exist, used as base for
36				   other r registers.  */
37  HPPA_R1_REGNUM = 1,
38  HPPA_FLAGS_REGNUM = 0,	/* Various status flags */
39  HPPA_RP_REGNUM = 2,		/* return pointer */
40  HPPA_FP_REGNUM = 3,		/* The ABI's frame pointer, when used */
41  HPPA_SP_REGNUM = 30,		/* Stack pointer.  */
42  HPPA_R31_REGNUM = 31,
43  HPPA_SAR_REGNUM = 32,		/* Shift Amount Register */
44  HPPA_IPSW_REGNUM = 41,	/* Interrupt Processor Status Word */
45  HPPA_PCOQ_HEAD_REGNUM = 33,	/* instruction offset queue head */
46  HPPA_PCSQ_HEAD_REGNUM = 34,	/* instruction space queue head */
47  HPPA_PCOQ_TAIL_REGNUM = 35,	/* instruction offset queue tail */
48  HPPA_PCSQ_TAIL_REGNUM = 36,	/* instruction space queue tail */
49  HPPA_EIEM_REGNUM = 37,	/* External Interrupt Enable Mask */
50  HPPA_IIR_REGNUM = 38,		/* Interrupt Instruction Register */
51  HPPA_ISR_REGNUM = 39,		/* Interrupt Space Register */
52  HPPA_IOR_REGNUM = 40,		/* Interrupt Offset Register */
53  HPPA_SR4_REGNUM = 43,		/* space register 4 */
54  HPPA_SR0_REGNUM = 44,		/* space register 0 */
55  HPPA_SR1_REGNUM = 45,		/* space register 1 */
56  HPPA_SR2_REGNUM = 46,		/* space register 2 */
57  HPPA_SR3_REGNUM = 47,		/* space register 3 */
58  HPPA_SR5_REGNUM = 48,		/* space register 5 */
59  HPPA_SR6_REGNUM = 49,		/* space register 6 */
60  HPPA_SR7_REGNUM = 50,		/* space register 7 */
61  HPPA_RCR_REGNUM = 51,		/* Recover Counter (also known as cr0) */
62  HPPA_PID0_REGNUM = 52,	/* Protection ID */
63  HPPA_PID1_REGNUM = 53,	/* Protection ID */
64  HPPA_PID2_REGNUM = 55,	/* Protection ID */
65  HPPA_PID3_REGNUM = 56,	/* Protection ID */
66  HPPA_CCR_REGNUM = 54,		/* Coprocessor Configuration Register */
67  HPPA_TR0_REGNUM = 57,		/* Temporary Registers (cr24 -> cr31) */
68  HPPA_CR26_REGNUM = 59,
69  HPPA_CR27_REGNUM = 60,	/* Base register for thread-local storage, cr27 */
70  HPPA_FP0_REGNUM = 64,		/* First floating-point.  */
71  HPPA_FP4_REGNUM = 72,
72
73  HPPA_ARG0_REGNUM = 26,	/* The first argument of a callee. */
74  HPPA_ARG1_REGNUM = 25,	/* The second argument of a callee. */
75  HPPA_ARG2_REGNUM = 24,	/* The third argument of a callee. */
76  HPPA_ARG3_REGNUM = 23		/* The fourth argument of a callee. */
77};
78
79/* Target-dependent structure in gdbarch.  */
80struct gdbarch_tdep
81{
82  /* The number of bytes in an address.  For now, this field is designed
83     to allow us to differentiate hppa32 from hppa64 targets.  */
84  int bytes_per_address;
85
86  /* Is this an ELF target? This can be 64-bit HP-UX, or a 32/64-bit GNU/Linux
87     system.  */
88  int is_elf;
89
90  /* Given a function address, try to find the global pointer for the
91     corresponding shared object.  */
92  CORE_ADDR (*find_global_pointer) (struct value *);
93};
94
95/*
96 * Unwind table and descriptor.
97 */
98
99struct unwind_table_entry
100  {
101    CORE_ADDR region_start;
102    CORE_ADDR region_end;
103
104    unsigned int Cannot_unwind:1;	/* 0 */
105    unsigned int Millicode:1;	/* 1 */
106    unsigned int Millicode_save_sr0:1;	/* 2 */
107    unsigned int Region_description:2;	/* 3..4 */
108    unsigned int reserved1:1;	/* 5 */
109    unsigned int Entry_SR:1;	/* 6 */
110    unsigned int Entry_FR:4;	/* number saved *//* 7..10 */
111    unsigned int Entry_GR:5;	/* number saved *//* 11..15 */
112    unsigned int Args_stored:1;	/* 16 */
113    unsigned int Variable_Frame:1;	/* 17 */
114    unsigned int Separate_Package_Body:1;	/* 18 */
115    unsigned int Frame_Extension_Millicode:1;	/* 19 */
116    unsigned int Stack_Overflow_Check:1;	/* 20 */
117    unsigned int Two_Instruction_SP_Increment:1;	/* 21 */
118    unsigned int Ada_Region:1;	/* 22 */
119    unsigned int cxx_info:1;	/* 23 */
120    unsigned int cxx_try_catch:1;	/* 24 */
121    unsigned int sched_entry_seq:1;	/* 25 */
122    unsigned int reserved2:1;	/* 26 */
123    unsigned int Save_SP:1;	/* 27 */
124    unsigned int Save_RP:1;	/* 28 */
125    unsigned int Save_MRP_in_frame:1;	/* 29 */
126    unsigned int extn_ptr_defined:1;	/* 30 */
127    unsigned int Cleanup_defined:1;	/* 31 */
128
129    unsigned int MPE_XL_interrupt_marker:1;	/* 0 */
130    unsigned int HP_UX_interrupt_marker:1;	/* 1 */
131    unsigned int Large_frame:1;	/* 2 */
132    unsigned int Pseudo_SP_Set:1;	/* 3 */
133    unsigned int reserved4:1;	/* 4 */
134    unsigned int Total_frame_size:27;	/* 5..31 */
135
136    /* This is *NOT* part of an actual unwind_descriptor in an object
137       file.  It is *ONLY* part of the "internalized" descriptors that
138       we create from those in a file.
139     */
140    struct
141      {
142	unsigned int stub_type:4;	/* 0..3 */
143	unsigned int padding:28;	/* 4..31 */
144      }
145    stub_unwind;
146  };
147
148/* HP linkers also generate unwinds for various linker-generated stubs.
149   GDB reads in the stubs from the $UNWIND_END$ subspace, then
150   "converts" them into normal unwind entries using some of the reserved
151   fields to store the stub type.  */
152
153/* The gaps represent linker stubs used in MPE and space for future
154   expansion.  */
155enum unwind_stub_types
156  {
157    LONG_BRANCH = 1,
158    PARAMETER_RELOCATION = 2,
159    EXPORT = 10,
160    IMPORT = 11,
161    IMPORT_SHLIB = 12,
162  };
163
164struct unwind_table_entry *find_unwind_entry (CORE_ADDR);
165
166/* We use the objfile->obj_private pointer for two things:
167 * 1.  An unwind table;
168 *
169 * 2.  A pointer to any associated shared library object.
170 *
171 * #defines are used to help refer to these objects.
172 */
173
174/* Info about the unwind table associated with an object file.
175 * This is hung off of the "objfile->obj_private" pointer, and
176 * is allocated in the objfile's psymbol obstack.  This allows
177 * us to have unique unwind info for each executable and shared
178 * library that we are debugging.
179 */
180struct hppa_unwind_info
181  {
182    struct unwind_table_entry *table;	/* Pointer to unwind info */
183    struct unwind_table_entry *cache;	/* Pointer to last entry we found */
184    int last;			/* Index of last entry */
185  };
186
187struct hppa_objfile_private
188  {
189    struct hppa_unwind_info *unwind_info;	/* a pointer */
190    struct so_list *so_info;	/* a pointer  */
191    CORE_ADDR dp;
192  };
193
194extern const struct objfile_data *hppa_objfile_priv_data;
195
196int hppa_get_field (unsigned word, int from, int to);
197int hppa_extract_5_load (unsigned int);
198unsigned hppa_extract_5R_store (unsigned int);
199unsigned hppa_extract_5r_store (unsigned int);
200int hppa_extract_17 (unsigned int);
201int hppa_extract_21 (unsigned);
202int hppa_extract_14 (unsigned);
203int hppa_low_sign_extend (unsigned int, unsigned int);
204int hppa_sign_extend (unsigned int, unsigned int);
205CORE_ADDR hppa_symbol_address(const char *sym);
206
207void
208hppa_frame_prev_register_helper (struct frame_info *next_frame,
209			         struct trad_frame_saved_reg *saved_regs,
210				 int regnum, int *optimizedp,
211				 enum lval_type *lvalp, CORE_ADDR *addrp,
212				 int *realnump, void *valuep);
213
214#endif  /* HPPA_TDEP_H */
215