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