libunwind-ia64.h revision 644c9193453c17afe4187ad5a0310b1d7481eeaf
1/* libunwind - a platform-independent unwind library
2   Copyright (C) 2001-2003 Hewlett-Packard Co
3	Contributed by David Mosberger-Tang <davidm@hpl.hp.com>
4
5This file is part of libunwind.
6
7Permission is hereby granted, free of charge, to any person obtaining
8a copy of this software and associated documentation files (the
9"Software"), to deal in the Software without restriction, including
10without limitation the rights to use, copy, modify, merge, publish,
11distribute, sublicense, and/or sell copies of the Software, and to
12permit persons to whom the Software is furnished to do so, subject to
13the following conditions:
14
15The above copyright notice and this permission notice shall be
16included in all copies or substantial portions of the Software.
17
18THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
22LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
23OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
24WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.  */
25
26#ifndef LIBUNWIND_H
27#define LIBUNWIND_H
28
29#include <stdint.h>
30#include <ucontext.h>
31
32#define UNW_TARGET	ia64
33#define UNW_TARGET_IA64	1
34
35/* This needs to be big enough to accommodate "struct cursor", while
36   leaving some slack for future expansion.  Changing this value will
37   require recompiling all users of this library.  Stack allocation is
38   relatively cheap and unwind-state copying is relatively rare, so we
39   want to err on making it rather too big than too small.  */
40#define UNW_TDEP_CURSOR_LEN	511
41
42/* If this bit is it indicates that the procedure saved all of ar.bsp,
43   ar.bspstore, and ar.rnat.  If, additionally, ar.bsp != saved ar.bsp,
44   then this procedure has performed a register-backing-store switch.  */
45#define UNW_PI_FLAG_IA64_RBS_SWITCH_BIT	(UNW_PI_FLAG_FIRST_TDEP_BIT + 0)
46
47#define UNW_PI_FLAG_IA64_RBS_SWITCH	(1 << UNW_PI_FLAG_IA64_RBS_SWITCH_BIT)
48
49typedef uint64_t unw_tdep_word_t;
50
51typedef enum
52  {
53    /* Note: general registers are excepted to start with index 0.
54       This convention facilitates architecture-independent
55       implementation of the C++ exception handling ABI.  See
56       _Unwind_SetGR() and _Unwind_GetGR() for details.  */
57    UNW_IA64_GR = 0,			/* general registers (r0..r127) */
58     UNW_IA64_GP = UNW_IA64_GR + 1,
59     UNW_IA64_TP = UNW_IA64_GR + 13,
60
61    UNW_IA64_NAT = UNW_IA64_GR + 128,	/* NaT registers (nat0..nat127) */
62
63    UNW_IA64_FR = UNW_IA64_NAT + 128,	/* fp registers (f0..f127) */
64
65    UNW_IA64_AR = UNW_IA64_FR + 128,	/* application registers (ar0..r127) */
66     UNW_IA64_AR_RSC = UNW_IA64_AR + 16,
67     UNW_IA64_AR_BSP = UNW_IA64_AR + 17,
68     UNW_IA64_AR_BSPSTORE = UNW_IA64_AR + 18,
69     UNW_IA64_AR_RNAT = UNW_IA64_AR + 19,
70     UNW_IA64_AR_CSD = UNW_IA64_AR + 25,
71     UNW_IA64_AR_26 = UNW_IA64_AR + 26,
72     UNW_IA64_AR_CCV = UNW_IA64_AR + 32,
73     UNW_IA64_AR_UNAT = UNW_IA64_AR + 36,
74     UNW_IA64_AR_FPSR = UNW_IA64_AR + 40,
75     UNW_IA64_AR_PFS = UNW_IA64_AR + 64,
76     UNW_IA64_AR_LC = UNW_IA64_AR + 65,
77     UNW_IA64_AR_EC = UNW_IA64_AR + 66,
78
79    UNW_IA64_BR = UNW_IA64_AR + 128,	/* branch registers (b0..p7) */
80    UNW_IA64_PR = UNW_IA64_BR + 8,	/* predicate registers (p0..p63) */
81    UNW_IA64_CFM,
82
83    /* frame info (read-only): */
84    UNW_IA64_BSP,
85    UNW_IA64_IP,
86    UNW_IA64_SP,
87
88    UNW_TDEP_LAST_REG = UNW_IA64_SP,
89
90    UNW_TDEP_IP = UNW_IA64_IP,
91    UNW_TDEP_SP = UNW_IA64_SP
92  }
93ia64_regnum_t;
94
95typedef struct unw_tdep_save_loc
96  {
97    /* Additional target-dependent info on a save location.  On IA-64,
98       we could use this to specify the bit number in which a NaT bit
99       gets saved.  For now, nobody wants to know this, so it's not
100       currently implemented.  */
101  }
102unw_tdep_save_loc_t;
103
104/* On IA-64, we can directly use ucontext_t as the unwind context.  */
105typedef ucontext_t unw_tdep_context_t;
106
107/* XXX this is not ideal: an application should not be prevented from
108   using the "getcontext" name just because it's using libunwind.  We
109   can't just use __getcontext() either, because that isn't exported
110   by glibc...  */
111#define unw_tdep_getcontext(uc)		(getcontext (uc), 0)
112
113#define unw_tdep_is_fpreg(r)		((unsigned) ((r) - UNW_IA64_FR) < 128)
114
115#include "libunwind-common.h"
116
117/* This is a helper routine to search an ia64 unwind table.  If the
118   address-space argument AS points to something other than the local
119   address-space, the memory for the unwind-info will be allocated
120   with malloc(), and should be free()d during the put_unwind_info()
121   callback.  This routine is signal-safe for the local-address-space
122   case ONLY.  */
123extern int _Uia64_search_unwind_table (unw_addr_space_t as, unw_word_t ip,
124				       unw_dyn_info_t *di, unw_proc_info_t *pi,
125				       int need_unwind_info, void *arg);
126
127/* This is a helper routine which the get_dyn_info_list_addr()
128   callback can use to locate the special dynamic-info list entry in
129   an IA-64 unwind table.  If the entry exists in the table, the
130   list-address is returned.  In all other cases, 0 is returned.  */
131extern unw_word_t _Uia64_find_dyn_list (unw_addr_space_t as,
132					void *table, size_t table_size,
133					unw_word_t segbase, void *arg);
134
135/* This is a helper routine to obtain the kernel-unwind info.  It is
136   signal-safe.  */
137extern int _Uia64_get_kernel_table (unw_dyn_info_t *di);
138
139#endif /* LIBUNWIND_H */
140