* hppa-tdep.h (HPPA_INSN_SIZE): New define.
[platform/upstream/binutils.git] / gdb / hppa-tdep.h
1 /* Target-dependent code for the HP PA-RISC architecture.
2
3    Copyright 2003, 2004, 2005 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., 59 Temple Place - Suite 330,
20    Boston, MA 02111-1307, 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
72   HPPA_ARG0_REGNUM = 26,        /* The first argument of a callee. */
73   HPPA_ARG1_REGNUM = 25,        /* The second argument of a callee. */
74   HPPA_ARG2_REGNUM = 24,        /* The third argument of a callee. */
75   HPPA_ARG3_REGNUM = 23         /* The fourth argument of a callee. */
76 };
77
78 /* Instruction size.  */
79 #define HPPA_INSN_SIZE 4
80
81 /* Target-dependent structure in gdbarch.  */
82 struct gdbarch_tdep
83 {
84   /* The number of bytes in an address.  For now, this field is designed
85      to allow us to differentiate hppa32 from hppa64 targets.  */
86   int bytes_per_address;
87
88   /* Is this an ELF target? This can be 64-bit HP-UX, or a 32/64-bit GNU/Linux
89      system.  */
90   int is_elf;
91
92   /* Given a function address, try to find the global pointer for the 
93      corresponding shared object.  */
94   CORE_ADDR (*find_global_pointer) (struct value *);
95
96   /* For shared libraries, each call goes through a small piece of
97      trampoline code in the ".plt", or equivalent, section.
98      IN_SOLIB_CALL_TRAMPOLINE evaluates to nonzero if we are currently
99      stopped in one of these.  */
100   int (*in_solib_call_trampoline) (CORE_ADDR pc, char *name);
101
102   /* For targets that support multiple spaces, we may have additional stubs
103      in the return path.  These stubs are internal to the ABI, and users are
104      not interested in them.  If we detect that we are returning to a stub,
105      adjust the pc to the real caller.  This improves the behavior of commands
106      that traverse frames such as "up" and "finish".  */
107   void (*unwind_adjust_stub) (struct frame_info *next_frame, CORE_ADDR base,
108                               struct trad_frame_saved_reg *saved_regs);
109
110   /* These are solib-dependent methods.  They are really HPUX only, but
111      we don't have a HPUX-specific tdep vector at the moment.  */
112   CORE_ADDR (*solib_thread_start_addr) (struct so_list *so);
113   CORE_ADDR (*solib_get_got_by_pc) (CORE_ADDR addr);
114   CORE_ADDR (*solib_get_solib_by_pc) (CORE_ADDR addr);
115   CORE_ADDR (*solib_get_text_base) (struct objfile *objfile);
116 };
117
118 /*
119  * Unwind table and descriptor.
120  */
121
122 struct unwind_table_entry
123   {
124     CORE_ADDR region_start;
125     CORE_ADDR region_end;
126
127     unsigned int Cannot_unwind:1;       /* 0 */
128     unsigned int Millicode:1;   /* 1 */
129     unsigned int Millicode_save_sr0:1;  /* 2 */
130     unsigned int Region_description:2;  /* 3..4 */
131     unsigned int reserved1:1;   /* 5 */
132     unsigned int Entry_SR:1;    /* 6 */
133     unsigned int Entry_FR:4;    /* number saved *//* 7..10 */
134     unsigned int Entry_GR:5;    /* number saved *//* 11..15 */
135     unsigned int Args_stored:1; /* 16 */
136     unsigned int Variable_Frame:1;      /* 17 */
137     unsigned int Separate_Package_Body:1;       /* 18 */
138     unsigned int Frame_Extension_Millicode:1;   /* 19 */
139     unsigned int Stack_Overflow_Check:1;        /* 20 */
140     unsigned int Two_Instruction_SP_Increment:1;        /* 21 */
141     unsigned int Ada_Region:1;  /* 22 */
142     unsigned int cxx_info:1;    /* 23 */
143     unsigned int cxx_try_catch:1;       /* 24 */
144     unsigned int sched_entry_seq:1;     /* 25 */
145     unsigned int reserved2:1;   /* 26 */
146     unsigned int Save_SP:1;     /* 27 */
147     unsigned int Save_RP:1;     /* 28 */
148     unsigned int Save_MRP_in_frame:1;   /* 29 */
149     unsigned int extn_ptr_defined:1;    /* 30 */
150     unsigned int Cleanup_defined:1;     /* 31 */
151
152     unsigned int MPE_XL_interrupt_marker:1;     /* 0 */
153     unsigned int HP_UX_interrupt_marker:1;      /* 1 */
154     unsigned int Large_frame:1; /* 2 */
155     unsigned int Pseudo_SP_Set:1;       /* 3 */
156     unsigned int reserved4:1;   /* 4 */
157     unsigned int Total_frame_size:27;   /* 5..31 */
158
159     /* This is *NOT* part of an actual unwind_descriptor in an object
160        file.  It is *ONLY* part of the "internalized" descriptors that
161        we create from those in a file.
162      */
163     struct
164       {
165         unsigned int stub_type:4;       /* 0..3 */
166         unsigned int padding:28;        /* 4..31 */
167       }
168     stub_unwind;
169   };
170
171 /* HP linkers also generate unwinds for various linker-generated stubs.
172    GDB reads in the stubs from the $UNWIND_END$ subspace, then 
173    "converts" them into normal unwind entries using some of the reserved
174    fields to store the stub type.  */
175
176 /* The gaps represent linker stubs used in MPE and space for future
177    expansion.  */
178 enum unwind_stub_types
179   {
180     LONG_BRANCH = 1,
181     PARAMETER_RELOCATION = 2,
182     EXPORT = 10,
183     IMPORT = 11,
184     IMPORT_SHLIB = 12,
185   };
186
187 struct unwind_table_entry *find_unwind_entry (CORE_ADDR);
188
189 /* We use the objfile->obj_private pointer for two things:
190  * 1.  An unwind table;
191  *
192  * 2.  A pointer to any associated shared library object.
193  *
194  * #defines are used to help refer to these objects.
195  */
196
197 /* Info about the unwind table associated with an object file.
198  * This is hung off of the "objfile->obj_private" pointer, and
199  * is allocated in the objfile's psymbol obstack.  This allows
200  * us to have unique unwind info for each executable and shared
201  * library that we are debugging.
202  */
203 struct hppa_unwind_info
204   {
205     struct unwind_table_entry *table;   /* Pointer to unwind info */
206     struct unwind_table_entry *cache;   /* Pointer to last entry we found */
207     int last;                   /* Index of last entry */
208   };
209
210 struct hppa_objfile_private
211   {
212     struct hppa_unwind_info *unwind_info;       /* a pointer */
213     struct so_list *so_info;    /* a pointer  */
214     CORE_ADDR dp;
215
216     int dummy_call_sequence_reg;
217     CORE_ADDR dummy_call_sequence_addr;
218   };
219
220 extern const struct objfile_data *hppa_objfile_priv_data;
221
222 int hppa_get_field (unsigned word, int from, int to);
223 int hppa_extract_5_load (unsigned int);
224 unsigned hppa_extract_5R_store (unsigned int);
225 unsigned hppa_extract_5r_store (unsigned int);
226 int hppa_extract_17 (unsigned int);
227 int hppa_extract_21 (unsigned);
228 int hppa_extract_14 (unsigned);
229 int hppa_low_sign_extend (unsigned int, unsigned int);
230 int hppa_sign_extend (unsigned int, unsigned int);
231 CORE_ADDR hppa_symbol_address(const char *sym);
232
233 extern void
234   hppa_frame_prev_register_helper (struct frame_info *next_frame,
235                                    struct trad_frame_saved_reg *saved_regs,
236                                    int regnum, int *optimizedp,
237                                    enum lval_type *lvalp, CORE_ADDR *addrp,
238                                    int *realnump, gdb_byte *valuep);
239
240 extern CORE_ADDR hppa_read_pc (ptid_t ptid);
241 extern void hppa_write_pc (CORE_ADDR pc, ptid_t ptid);
242 extern CORE_ADDR hppa_unwind_pc (struct gdbarch *gdbarch,
243                                  struct frame_info *next_frame);
244
245 extern struct minimal_symbol *
246   hppa_lookup_stub_minimal_symbol (const char *name,
247                                    enum unwind_stub_types stub_type);
248
249 extern struct hppa_objfile_private *
250 hppa_init_objfile_priv_data (struct objfile *objfile);
251
252 #endif  /* HPPA_TDEP_H */