* objfiles.h (pc_in_section): New prototype.
[platform/upstream/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" section.  IN_SOLIB_CALL_TRAMPOLINE
94      evaluates to nonzero if we are currently stopped in one of these.  */
95   int (*in_solib_call_trampoline) (struct gdbarch *gdbarch, CORE_ADDR pc);
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 *this_frame, CORE_ADDR base,
103                               struct trad_frame_saved_reg *saved_regs);
104
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);
111 };
112
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 */
126     unsigned int reserved:1;    /* 5 */
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 */
136     unsigned int sr4export:1;   /* 22 */
137     unsigned int cxx_info:1;    /* 23 */
138     unsigned int cxx_try_catch:1;       /* 24 */
139     unsigned int sched_entry_seq:1;     /* 25 */
140     unsigned int reserved1:1;   /* 26 */
141     unsigned int Save_SP:1;     /* 27 */
142     unsigned int Save_RP:1;     /* 28 */
143     unsigned int Save_MRP_in_frame:1;   /* 29 */
144     unsigned int save_r19:1;    /* 30 */
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 */
150     unsigned int alloca_frame:1;        /* 3 */
151     unsigned int reserved2:1;   /* 4 */
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
182 struct unwind_table_entry *find_unwind_entry (CORE_ADDR);
183
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;
210
211     int dummy_call_sequence_reg;
212     CORE_ADDR dummy_call_sequence_addr;
213   };
214
215 extern const struct objfile_data *hppa_objfile_priv_data;
216
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 CORE_ADDR hppa_symbol_address(const char *sym);
225
226 extern struct value *
227   hppa_frame_prev_register_helper (struct frame_info *this_frame,
228                                    struct trad_frame_saved_reg *saved_regs,
229                                    int regnum);
230
231 extern CORE_ADDR hppa_read_pc (struct regcache *regcache);
232 extern void hppa_write_pc (struct regcache *regcache, CORE_ADDR pc);
233 extern CORE_ADDR hppa_unwind_pc (struct gdbarch *gdbarch,
234                                  struct frame_info *next_frame);
235
236 extern struct minimal_symbol *
237   hppa_lookup_stub_minimal_symbol (const char *name,
238                                    enum unwind_stub_types stub_type);
239
240 extern struct hppa_objfile_private *hppa_init_objfile_priv_data (struct objfile *objfile);
241
242 extern int hppa_in_solib_call_trampoline (struct gdbarch *gdbarch,
243                                           CORE_ADDR pc);
244 extern CORE_ADDR hppa_skip_trampoline_code (struct frame_info *, CORE_ADDR pc);
245
246 #endif  /* hppa-tdep.h */