gdb/
[external/binutils.git] / gdb / hppa-tdep.h
1 /* Target-dependent code for the HP PA-RISC architecture.
2
3    Copyright (C) 2003-2013 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 3 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, see <http://www.gnu.org/licenses/>.  */
19
20 #ifndef HPPA_TDEP_H
21 #define HPPA_TDEP_H
22
23 struct trad_frame_saved_reg;
24 struct objfile;
25 struct so_list;
26
27 /* Register numbers of various important registers.  */
28
29 enum hppa_regnum
30 {
31   HPPA_R0_REGNUM = 0,           /* Doesn't actually exist, used as base for
32                                    other r registers.  */
33   HPPA_R1_REGNUM = 1,
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 */
37   HPPA_DP_REGNUM = 27,
38   HPPA_RET0_REGNUM = 28,
39   HPPA_RET1_REGNUM = 29,
40   HPPA_SP_REGNUM = 30,          /* Stack pointer.  */
41   HPPA_R31_REGNUM = 31,
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) */
60   HPPA_CR26_REGNUM = 59,
61   HPPA_CR27_REGNUM = 60,        /* Base register for thread-local
62                                    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 gdbarch *, 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) (struct gdbarch *gdbarch,
97                                    CORE_ADDR pc, char *name);
98
99   /* For targets that support multiple spaces, we may have additional stubs
100      in the return path.  These stubs are internal to the ABI, and users are
101      not interested in them.  If we detect that we are returning to a stub,
102      adjust the pc to the real caller.  This improves the behavior of commands
103      that traverse frames such as "up" and "finish".  */
104   void (*unwind_adjust_stub) (struct frame_info *this_frame, CORE_ADDR base,
105                               struct trad_frame_saved_reg *saved_regs);
106
107   /* These are solib-dependent methods.  They are really HPUX only, but
108      we don't have a HPUX-specific tdep vector at the moment.  */
109   CORE_ADDR (*solib_thread_start_addr) (struct so_list *so);
110   CORE_ADDR (*solib_get_got_by_pc) (CORE_ADDR addr);
111   CORE_ADDR (*solib_get_solib_by_pc) (CORE_ADDR addr);
112   CORE_ADDR (*solib_get_text_base) (struct objfile *objfile);
113 };
114
115 /*
116  * Unwind table and descriptor.
117  */
118
119 struct unwind_table_entry
120   {
121     CORE_ADDR region_start;
122     CORE_ADDR region_end;
123
124     unsigned int Cannot_unwind:1;       /* 0 */
125     unsigned int Millicode:1;   /* 1 */
126     unsigned int Millicode_save_sr0:1;  /* 2 */
127     unsigned int Region_description:2;  /* 3..4 */
128     unsigned int reserved:1;    /* 5 */
129     unsigned int Entry_SR:1;    /* 6 */
130     unsigned int Entry_FR:4;    /* number saved *//* 7..10 */
131     unsigned int Entry_GR:5;    /* number saved *//* 11..15 */
132     unsigned int Args_stored:1; /* 16 */
133     unsigned int Variable_Frame:1;      /* 17 */
134     unsigned int Separate_Package_Body:1;       /* 18 */
135     unsigned int Frame_Extension_Millicode:1;   /* 19 */
136     unsigned int Stack_Overflow_Check:1;        /* 20 */
137     unsigned int Two_Instruction_SP_Increment:1;        /* 21 */
138     unsigned int sr4export:1;   /* 22 */
139     unsigned int cxx_info:1;    /* 23 */
140     unsigned int cxx_try_catch:1;       /* 24 */
141     unsigned int sched_entry_seq:1;     /* 25 */
142     unsigned int reserved1:1;   /* 26 */
143     unsigned int Save_SP:1;     /* 27 */
144     unsigned int Save_RP:1;     /* 28 */
145     unsigned int Save_MRP_in_frame:1;   /* 29 */
146     unsigned int save_r19:1;    /* 30 */
147     unsigned int Cleanup_defined:1;     /* 31 */
148
149     unsigned int MPE_XL_interrupt_marker:1;     /* 0 */
150     unsigned int HP_UX_interrupt_marker:1;      /* 1 */
151     unsigned int Large_frame:1; /* 2 */
152     unsigned int alloca_frame:1;        /* 3 */
153     unsigned int reserved2:1;   /* 4 */
154     unsigned int Total_frame_size:27;   /* 5..31 */
155
156     /* This is *NOT* part of an actual unwind_descriptor in an object
157        file.  It is *ONLY* part of the "internalized" descriptors that
158        we create from those in a file.  */
159
160     struct
161       {
162         unsigned int stub_type:4;       /* 0..3 */
163         unsigned int padding:28;        /* 4..31 */
164       }
165     stub_unwind;
166   };
167
168 /* HP linkers also generate unwinds for various linker-generated stubs.
169    GDB reads in the stubs from the $UNWIND_END$ subspace, then 
170    "converts" them into normal unwind entries using some of the reserved
171    fields to store the stub type.  */
172
173 /* The gaps represent linker stubs used in MPE and space for future
174    expansion.  */
175 enum unwind_stub_types
176   {
177     LONG_BRANCH = 1,
178     PARAMETER_RELOCATION = 2,
179     EXPORT = 10,
180     IMPORT = 11,
181     IMPORT_SHLIB = 12,
182   };
183
184 struct unwind_table_entry *find_unwind_entry (CORE_ADDR);
185
186 /* We use the objfile->obj_private pointer for two things:
187  * 1.  An unwind table;
188  *
189  * 2.  A pointer to any associated shared library object.
190  *
191  * #defines are used to help refer to these objects.
192  */
193
194 /* Info about the unwind table associated with an object file.
195  * This is hung off of the "objfile->obj_private" pointer, and
196  * is allocated in the objfile's psymbol obstack.  This allows
197  * us to have unique unwind info for each executable and shared
198  * library that we are debugging.
199  */
200 struct hppa_unwind_info
201   {
202     struct unwind_table_entry *table;   /* Pointer to unwind info */
203     struct unwind_table_entry *cache;   /* Pointer to last entry we found */
204     int last;                           /* Index of last entry */
205   };
206
207 struct hppa_objfile_private
208   {
209     struct hppa_unwind_info *unwind_info;       /* a pointer */
210     struct so_list *so_info;                    /* a pointer  */
211     CORE_ADDR dp;
212
213     int dummy_call_sequence_reg;
214     CORE_ADDR dummy_call_sequence_addr;
215   };
216
217 extern const struct objfile_data *hppa_objfile_priv_data;
218
219 int hppa_get_field (unsigned word, int from, int to);
220 int hppa_extract_5_load (unsigned int);
221 unsigned hppa_extract_5R_store (unsigned int);
222 unsigned hppa_extract_5r_store (unsigned int);
223 int hppa_extract_17 (unsigned int);
224 int hppa_extract_21 (unsigned);
225 int hppa_extract_14 (unsigned);
226 CORE_ADDR hppa_symbol_address(const char *sym);
227
228 extern struct value *
229   hppa_frame_prev_register_helper (struct frame_info *this_frame,
230                                    struct trad_frame_saved_reg *saved_regs,
231                                    int regnum);
232
233 extern CORE_ADDR hppa_read_pc (struct regcache *regcache);
234 extern void hppa_write_pc (struct regcache *regcache, CORE_ADDR pc);
235 extern CORE_ADDR hppa_unwind_pc (struct gdbarch *gdbarch,
236                                  struct frame_info *next_frame);
237
238 extern struct minimal_symbol *
239   hppa_lookup_stub_minimal_symbol (const char *name,
240                                    enum unwind_stub_types stub_type);
241
242 extern struct hppa_objfile_private *hppa_init_objfile_priv_data (struct objfile *objfile);
243
244 extern int hppa_in_solib_call_trampoline (struct gdbarch *gdbarch,
245                                           CORE_ADDR pc, char *name);
246 extern CORE_ADDR hppa_skip_trampoline_code (struct frame_info *, CORE_ADDR pc);
247
248 #endif  /* hppa-tdep.h */