1 /* libunwind - a platform-independent unwind library
2    Copyright (C) 2001-2004 Hewlett-Packard Co
3 	Contributed by David Mosberger-Tang <davidm@hpl.hp.com>
4 
5 This file is part of libunwind.
6 
7 Permission is hereby granted, free of charge, to any person obtaining
8 a copy of this software and associated documentation files (the
9 "Software"), to deal in the Software without restriction, including
10 without limitation the rights to use, copy, modify, merge, publish,
11 distribute, sublicense, and/or sell copies of the Software, and to
12 permit persons to whom the Software is furnished to do so, subject to
13 the following conditions:
14 
15 The above copyright notice and this permission notice shall be
16 included in all copies or substantial portions of the Software.
17 
18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
22 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
23 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
24 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.  */
25 
26 #ifndef LIBUNWIND_H
27 #define LIBUNWIND_H
28 
29 #include <inttypes.h>
30 #include <ucontext.h>
31 
32 #if defined(__cplusplus) || defined(c_plusplus)
33 extern "C" {
34 #endif
35 
36 #ifdef ia64
37   /* This works around a bug in Intel's ECC v7.0 which defines "ia64"
38      as "1".  */
39 # undef ia64
40 #endif
41 
42 #ifdef __hpux
43   /* On HP-UX, there is no hope of supporting UNW_LOCAL_ONLY, because
44      it's impossible to obtain the address of the members in the
45      sigcontext structure.  */
46 # undef UNW_LOCAL_ONLY
47 # define UNW_GENERIC_ONLY
48 #endif
49 
50 #define UNW_TARGET	ia64
51 #define UNW_TARGET_IA64	1
52 
53 #define _U_TDEP_QP_TRUE	0	/* see libunwind-dynamic.h  */
54 
55 /* This needs to be big enough to accommodate "struct cursor", while
56    leaving some slack for future expansion.  Changing this value will
57    require recompiling all users of this library.  Stack allocation is
58    relatively cheap and unwind-state copying is relatively rare, so we
59    want to err on making it rather too big than too small.  */
60 #define UNW_TDEP_CURSOR_LEN	511
61 
62 /* If this bit is it indicates that the procedure saved all of ar.bsp,
63    ar.bspstore, and ar.rnat.  If, additionally, ar.bsp != saved ar.bsp,
64    then this procedure has performed a register-backing-store switch.  */
65 #define UNW_PI_FLAG_IA64_RBS_SWITCH_BIT	(UNW_PI_FLAG_FIRST_TDEP_BIT + 0)
66 
67 #define UNW_PI_FLAG_IA64_RBS_SWITCH	(1 << UNW_PI_FLAG_IA64_RBS_SWITCH_BIT)
68 
69 typedef uint64_t unw_word_t;
70 typedef int64_t unw_sword_t;
71 
72 /* On IA-64, we want to access the contents of floating-point
73    registers as a pair of "words", but to ensure 16-byte alignment, we
74    make it a union that contains a "long double".  This will do the
75    Right Thing on all known IA-64 platforms, including HP-UX.  */
76 typedef union
77   {
78     struct { unw_word_t bits[2]; } raw;
79     long double dummy;	/* dummy to force 16-byte alignment */
80   }
81 unw_tdep_fpreg_t;
82 
83 typedef struct
84   {
85     /* no ia64-specific auxiliary proc-info */
86     /* ANDROID support update. */
87     char __reserved;
88     /* End of ANDROID update. */
89   }
90 unw_tdep_proc_info_t;
91 
92 typedef enum
93   {
94     /* Note: general registers are excepted to start with index 0.
95        This convention facilitates architecture-independent
96        implementation of the C++ exception handling ABI.  See
97        _Unwind_SetGR() and _Unwind_GetGR() for details.  */
98     UNW_IA64_GR = 0,			/* general registers (r0..r127) */
99      UNW_IA64_GP = UNW_IA64_GR + 1,
100      UNW_IA64_TP = UNW_IA64_GR + 13,
101 
102     UNW_IA64_NAT = UNW_IA64_GR + 128,	/* NaT registers (nat0..nat127) */
103 
104     UNW_IA64_FR = UNW_IA64_NAT + 128,	/* fp registers (f0..f127) */
105 
106     UNW_IA64_AR = UNW_IA64_FR + 128,	/* application registers (ar0..r127) */
107      UNW_IA64_AR_RSC = UNW_IA64_AR + 16,
108      UNW_IA64_AR_BSP = UNW_IA64_AR + 17,
109      UNW_IA64_AR_BSPSTORE = UNW_IA64_AR + 18,
110      UNW_IA64_AR_RNAT = UNW_IA64_AR + 19,
111      UNW_IA64_AR_CSD = UNW_IA64_AR + 25,
112      UNW_IA64_AR_26 = UNW_IA64_AR + 26,
113      UNW_IA64_AR_SSD = UNW_IA64_AR_26,
114      UNW_IA64_AR_CCV = UNW_IA64_AR + 32,
115      UNW_IA64_AR_UNAT = UNW_IA64_AR + 36,
116      UNW_IA64_AR_FPSR = UNW_IA64_AR + 40,
117      UNW_IA64_AR_PFS = UNW_IA64_AR + 64,
118      UNW_IA64_AR_LC = UNW_IA64_AR + 65,
119      UNW_IA64_AR_EC = UNW_IA64_AR + 66,
120 
121     UNW_IA64_BR = UNW_IA64_AR + 128,	/* branch registers (b0..p7) */
122       UNW_IA64_RP = UNW_IA64_BR + 0,	/* return pointer (rp) */
123     UNW_IA64_PR = UNW_IA64_BR + 8,	/* predicate registers (p0..p63) */
124     UNW_IA64_CFM,
125 
126     /* frame info: */
127     UNW_IA64_BSP,
128     UNW_IA64_IP,
129     UNW_IA64_SP,
130 
131     UNW_TDEP_LAST_REG = UNW_IA64_SP,
132 
133     UNW_TDEP_IP = UNW_IA64_IP,
134     UNW_TDEP_SP = UNW_IA64_SP,
135     UNW_TDEP_EH = UNW_IA64_GR + 15
136   }
137 ia64_regnum_t;
138 
139 #define UNW_TDEP_NUM_EH_REGS	4	/* r15-r18 are exception args */
140 
141 typedef struct unw_tdep_save_loc
142   {
143     /* Additional target-dependent info on a save location.  On IA-64,
144        we use this to provide the bit number in which a NaT bit gets
145        saved.  */
146     uint8_t nat_bitnr;
147 
148     /* Padding reserved for future use.  */
149     uint8_t reserved[7];
150   }
151 unw_tdep_save_loc_t;
152 
153 /* On IA-64, we can directly use ucontext_t as the unwind context.  */
154 typedef ucontext_t unw_tdep_context_t;
155 
156 #define unw_tdep_is_fpreg(r)		((unsigned) ((r) - UNW_IA64_FR) < 128)
157 
158 #include "libunwind-dynamic.h"
159 #include "libunwind-common.h"
160 
161 #ifdef __hpux
162   /* In theory, we could use _Uia64_getcontext() on HP-UX as well, but
163      the benefit of doing so would be marginal given that it can't
164      support UNW_LOCAL_ONLY.  */
165 # define unw_tdep_getcontext		getcontext
166 #else
167 # define unw_tdep_getcontext		UNW_ARCH_OBJ (getcontext)
168   extern int unw_tdep_getcontext (unw_tdep_context_t *);
169 #endif
170 
171 /* This is a helper routine to search an ia64 unwind table.  If the
172    address-space argument AS points to something other than the local
173    address-space, the memory for the unwind-info will be allocated
174    with malloc(), and should be free()d during the put_unwind_info()
175    callback.  This routine is signal-safe for the local-address-space
176    case ONLY.  */
177 #define unw_search_ia64_unwind_table	UNW_OBJ(search_unwind_table)
178 extern int unw_search_ia64_unwind_table (unw_addr_space_t, unw_word_t,
179 					 unw_dyn_info_t *, unw_proc_info_t *,
180 					 int, void *);
181 
182 /* This is a helper routine which the get_dyn_info_list_addr()
183    callback can use to locate the special dynamic-info list entry in
184    an IA-64 unwind table.  If the entry exists in the table, the
185    list-address is returned.  In all other cases, 0 is returned.  */
186 extern unw_word_t _Uia64_find_dyn_list (unw_addr_space_t, unw_dyn_info_t *,
187 					void *);
188 
189 /* This is a helper routine to obtain the kernel-unwind info.  It is
190    signal-safe.  */
191 extern int _Uia64_get_kernel_table (unw_dyn_info_t *);
192 
193 #if defined(__cplusplus) || defined(c_plusplus)
194 }
195 #endif
196 
197 #endif /* LIBUNWIND_H */
198