2004-05-15 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 enum { HPPA_INSTRUCTION_SIZE = 4 };
27
28 /* Register numbers of various important registers.
29    Note that some of these values are "real" register numbers,
30    and correspond to the general registers of the machine,
31    and some are "phony" register numbers which are too large
32    to be actual register numbers as far as the user is concerned
33    but do serve to get the desired values when passed to read_register.  */
34
35 enum hppa_regnum
36 {
37   HPPA_R0_REGNUM = 0,           /* Doesn't actually exist, used as base for
38                                    other r registers.  */
39   HPPA_R1_REGNUM = 1,
40   HPPA_FLAGS_REGNUM = 0,        /* Various status flags */
41   HPPA_RP_REGNUM = 2,           /* return pointer */
42   HPPA_FP_REGNUM = 3,           /* The ABI's frame pointer, when used */
43   HPPA_SP_REGNUM = 30,          /* Stack pointer.  */
44   HPPA_SAR_REGNUM = 32,         /* Shift Amount Register */
45   HPPA_IPSW_REGNUM = 41,        /* Interrupt Processor Status Word */
46   HPPA_PCOQ_HEAD_REGNUM = 33,   /* instruction offset queue head */
47   HPPA_PCSQ_HEAD_REGNUM = 34,   /* instruction space queue head */
48   HPPA_PCOQ_TAIL_REGNUM = 35,   /* instruction offset queue tail */
49   HPPA_PCSQ_TAIL_REGNUM = 36,   /* instruction space queue tail */
50   HPPA_EIEM_REGNUM = 37,        /* External Interrupt Enable Mask */
51   HPPA_IIR_REGNUM = 38,         /* Interrupt Instruction Register */
52   HPPA_ISR_REGNUM = 39,         /* Interrupt Space Register */
53   HPPA_IOR_REGNUM = 40,         /* Interrupt Offset Register */
54   HPPA_SR4_REGNUM = 43,         /* space register 4 */
55   HPPA_RCR_REGNUM = 51,         /* Recover Counter (also known as cr0) */
56   HPPA_PID0_REGNUM = 52,        /* Protection ID */
57   HPPA_PID1_REGNUM = 53,        /* Protection ID */
58   HPPA_PID2_REGNUM = 55,        /* Protection ID */
59   HPPA_PID3_REGNUM = 56,        /* Protection ID */
60   HPPA_CCR_REGNUM = 54,         /* Coprocessor Configuration Register */
61   HPPA_TR0_REGNUM = 57,         /* Temporary Registers (cr24 -> cr31) */
62   HPPA_CR27_REGNUM = 60,        /* Base register for thread-local storage, cr27 */
63   HPPA_FP0_REGNUM = 64,         /* First floating-point.  */
64   HPPA_FP4_REGNUM = 72,
65
66   HPPA_ARG0_REGNUM = 26,        /* The first argument of a callee. */
67   HPPA_ARG1_REGNUM = 25,        /* The second argument of a callee. */
68   HPPA_ARG2_REGNUM = 24,        /* The third argument of a callee. */
69   HPPA_ARG3_REGNUM = 23         /* The fourth argument of a callee. */
70 };
71
72 /* Target-dependent structure in gdbarch.  */
73 struct gdbarch_tdep
74 {
75   /* The number of bytes in an address.  For now, this field is designed
76      to allow us to differentiate hppa32 from hppa64 targets.  */
77   int bytes_per_address;
78
79   /* Is this an ELF target? This can be 64-bit HP-UX, or a 32/64-bit GNU/Linux
80      system.  */
81   int is_elf;
82 };
83
84 /*
85  * Unwind table and descriptor.
86  */
87
88 struct unwind_table_entry
89   {
90     CORE_ADDR region_start;
91     CORE_ADDR region_end;
92
93     unsigned int Cannot_unwind:1;       /* 0 */
94     unsigned int Millicode:1;   /* 1 */
95     unsigned int Millicode_save_sr0:1;  /* 2 */
96     unsigned int Region_description:2;  /* 3..4 */
97     unsigned int reserved1:1;   /* 5 */
98     unsigned int Entry_SR:1;    /* 6 */
99     unsigned int Entry_FR:4;    /* number saved *//* 7..10 */
100     unsigned int Entry_GR:5;    /* number saved *//* 11..15 */
101     unsigned int Args_stored:1; /* 16 */
102     unsigned int Variable_Frame:1;      /* 17 */
103     unsigned int Separate_Package_Body:1;       /* 18 */
104     unsigned int Frame_Extension_Millicode:1;   /* 19 */
105     unsigned int Stack_Overflow_Check:1;        /* 20 */
106     unsigned int Two_Instruction_SP_Increment:1;        /* 21 */
107     unsigned int Ada_Region:1;  /* 22 */
108     unsigned int cxx_info:1;    /* 23 */
109     unsigned int cxx_try_catch:1;       /* 24 */
110     unsigned int sched_entry_seq:1;     /* 25 */
111     unsigned int reserved2:1;   /* 26 */
112     unsigned int Save_SP:1;     /* 27 */
113     unsigned int Save_RP:1;     /* 28 */
114     unsigned int Save_MRP_in_frame:1;   /* 29 */
115     unsigned int extn_ptr_defined:1;    /* 30 */
116     unsigned int Cleanup_defined:1;     /* 31 */
117
118     unsigned int MPE_XL_interrupt_marker:1;     /* 0 */
119     unsigned int HP_UX_interrupt_marker:1;      /* 1 */
120     unsigned int Large_frame:1; /* 2 */
121     unsigned int Pseudo_SP_Set:1;       /* 3 */
122     unsigned int reserved4:1;   /* 4 */
123     unsigned int Total_frame_size:27;   /* 5..31 */
124
125     /* This is *NOT* part of an actual unwind_descriptor in an object
126        file.  It is *ONLY* part of the "internalized" descriptors that
127        we create from those in a file.
128      */
129     struct
130       {
131         unsigned int stub_type:4;       /* 0..3 */
132         unsigned int padding:28;        /* 4..31 */
133       }
134     stub_unwind;
135   };
136
137 /* HP linkers also generate unwinds for various linker-generated stubs.
138    GDB reads in the stubs from the $UNWIND_END$ subspace, then 
139    "converts" them into normal unwind entries using some of the reserved
140    fields to store the stub type.  */
141
142 /* The gaps represent linker stubs used in MPE and space for future
143    expansion.  */
144 enum unwind_stub_types
145   {
146     LONG_BRANCH = 1,
147     PARAMETER_RELOCATION = 2,
148     EXPORT = 10,
149     IMPORT = 11,
150     IMPORT_SHLIB = 12,
151   };
152
153 struct unwind_table_entry *find_unwind_entry (CORE_ADDR);
154
155 /* We use the objfile->obj_private pointer for two things:
156  * 1.  An unwind table;
157  *
158  * 2.  A pointer to any associated shared library object.
159  *
160  * #defines are used to help refer to these objects.
161  */
162
163 /* Info about the unwind table associated with an object file.
164  * This is hung off of the "objfile->obj_private" pointer, and
165  * is allocated in the objfile's psymbol obstack.  This allows
166  * us to have unique unwind info for each executable and shared
167  * library that we are debugging.
168  */
169 struct hppa_unwind_info
170   {
171     struct unwind_table_entry *table;   /* Pointer to unwind info */
172     struct unwind_table_entry *cache;   /* Pointer to last entry we found */
173     int last;                   /* Index of last entry */
174   };
175
176 struct hppa_objfile_private
177   {
178     struct hppa_unwind_info *unwind_info;       /* a pointer */
179     struct so_list *so_info;    /* a pointer  */
180     CORE_ADDR dp;
181   };
182
183 extern const struct objfile_data *hppa_objfile_priv_data;
184
185 int hppa_get_field (unsigned word, int from, int to);
186 int hppa_extract_5_load (unsigned int);
187 unsigned hppa_extract_5R_store (unsigned int);
188 unsigned hppa_extract_5r_store (unsigned int);
189 int hppa_extract_17 (unsigned int);
190 int hppa_extract_21 (unsigned);
191 int hppa_extract_14 (unsigned);
192 int hppa_low_sign_extend (unsigned int, unsigned int);
193 int hppa_sign_extend (unsigned int, unsigned int);
194
195 void
196 hppa_frame_prev_register_helper (struct frame_info *next_frame,
197                                  struct trad_frame_saved_reg *saved_regs,
198                                  int regnum, int *optimizedp,
199                                  enum lval_type *lvalp, CORE_ADDR *addrp,
200                                  int *realnump, void *valuep);
201
202 #endif  /* HPPA_TDEP_H */