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