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