2004-06-06 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
87 /*
88  * Unwind table and descriptor.
89  */
90
91 struct unwind_table_entry
92   {
93     CORE_ADDR region_start;
94     CORE_ADDR region_end;
95
96     unsigned int Cannot_unwind:1;       /* 0 */
97     unsigned int Millicode:1;   /* 1 */
98     unsigned int Millicode_save_sr0:1;  /* 2 */
99     unsigned int Region_description:2;  /* 3..4 */
100     unsigned int reserved1:1;   /* 5 */
101     unsigned int Entry_SR:1;    /* 6 */
102     unsigned int Entry_FR:4;    /* number saved *//* 7..10 */
103     unsigned int Entry_GR:5;    /* number saved *//* 11..15 */
104     unsigned int Args_stored:1; /* 16 */
105     unsigned int Variable_Frame:1;      /* 17 */
106     unsigned int Separate_Package_Body:1;       /* 18 */
107     unsigned int Frame_Extension_Millicode:1;   /* 19 */
108     unsigned int Stack_Overflow_Check:1;        /* 20 */
109     unsigned int Two_Instruction_SP_Increment:1;        /* 21 */
110     unsigned int Ada_Region:1;  /* 22 */
111     unsigned int cxx_info:1;    /* 23 */
112     unsigned int cxx_try_catch:1;       /* 24 */
113     unsigned int sched_entry_seq:1;     /* 25 */
114     unsigned int reserved2:1;   /* 26 */
115     unsigned int Save_SP:1;     /* 27 */
116     unsigned int Save_RP:1;     /* 28 */
117     unsigned int Save_MRP_in_frame:1;   /* 29 */
118     unsigned int extn_ptr_defined:1;    /* 30 */
119     unsigned int Cleanup_defined:1;     /* 31 */
120
121     unsigned int MPE_XL_interrupt_marker:1;     /* 0 */
122     unsigned int HP_UX_interrupt_marker:1;      /* 1 */
123     unsigned int Large_frame:1; /* 2 */
124     unsigned int Pseudo_SP_Set:1;       /* 3 */
125     unsigned int reserved4:1;   /* 4 */
126     unsigned int Total_frame_size:27;   /* 5..31 */
127
128     /* This is *NOT* part of an actual unwind_descriptor in an object
129        file.  It is *ONLY* part of the "internalized" descriptors that
130        we create from those in a file.
131      */
132     struct
133       {
134         unsigned int stub_type:4;       /* 0..3 */
135         unsigned int padding:28;        /* 4..31 */
136       }
137     stub_unwind;
138   };
139
140 /* HP linkers also generate unwinds for various linker-generated stubs.
141    GDB reads in the stubs from the $UNWIND_END$ subspace, then 
142    "converts" them into normal unwind entries using some of the reserved
143    fields to store the stub type.  */
144
145 /* The gaps represent linker stubs used in MPE and space for future
146    expansion.  */
147 enum unwind_stub_types
148   {
149     LONG_BRANCH = 1,
150     PARAMETER_RELOCATION = 2,
151     EXPORT = 10,
152     IMPORT = 11,
153     IMPORT_SHLIB = 12,
154   };
155
156 struct unwind_table_entry *find_unwind_entry (CORE_ADDR);
157
158 /* We use the objfile->obj_private pointer for two things:
159  * 1.  An unwind table;
160  *
161  * 2.  A pointer to any associated shared library object.
162  *
163  * #defines are used to help refer to these objects.
164  */
165
166 /* Info about the unwind table associated with an object file.
167  * This is hung off of the "objfile->obj_private" pointer, and
168  * is allocated in the objfile's psymbol obstack.  This allows
169  * us to have unique unwind info for each executable and shared
170  * library that we are debugging.
171  */
172 struct hppa_unwind_info
173   {
174     struct unwind_table_entry *table;   /* Pointer to unwind info */
175     struct unwind_table_entry *cache;   /* Pointer to last entry we found */
176     int last;                   /* Index of last entry */
177   };
178
179 struct hppa_objfile_private
180   {
181     struct hppa_unwind_info *unwind_info;       /* a pointer */
182     struct so_list *so_info;    /* a pointer  */
183     CORE_ADDR dp;
184   };
185
186 extern const struct objfile_data *hppa_objfile_priv_data;
187
188 int hppa_get_field (unsigned word, int from, int to);
189 int hppa_extract_5_load (unsigned int);
190 unsigned hppa_extract_5R_store (unsigned int);
191 unsigned hppa_extract_5r_store (unsigned int);
192 int hppa_extract_17 (unsigned int);
193 int hppa_extract_21 (unsigned);
194 int hppa_extract_14 (unsigned);
195 int hppa_low_sign_extend (unsigned int, unsigned int);
196 int hppa_sign_extend (unsigned int, unsigned int);
197 CORE_ADDR hppa_symbol_address(const char *sym);
198
199 void
200 hppa_frame_prev_register_helper (struct frame_info *next_frame,
201                                  struct trad_frame_saved_reg *saved_regs,
202                                  int regnum, int *optimizedp,
203                                  enum lval_type *lvalp, CORE_ADDR *addrp,
204                                  int *realnump, void *valuep);
205
206 #endif  /* HPPA_TDEP_H */