1 /* libunwind - a platform-independent unwind library
2 Copyright (C) 2002-2005 Hewlett-Packard Co
3 Contributed by David Mosberger-Tang <davidm@hpl.hp.com>
5 Modified for x86_64 by Max Asbock <masbock@us.ibm.com>
7 This file is part of libunwind.
9 Permission is hereby granted, free of charge, to any person obtaining
10 a copy of this software and associated documentation files (the
11 "Software"), to deal in the Software without restriction, including
12 without limitation the rights to use, copy, modify, merge, publish,
13 distribute, sublicense, and/or sell copies of the Software, and to
14 permit persons to whom the Software is furnished to do so, subject to
15 the following conditions:
17 The above copyright notice and this permission notice shall be
18 included in all copies or substantial portions of the Software.
20 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
24 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
25 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
26 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
28 #ifndef X86_64_LIBUNWIND_I_H
29 #define X86_64_LIBUNWIND_I_H
31 /* Target-dependent definitions that are internal to libunwind but need
32 to be shared with target-independent code. */
35 #include <libunwind.h>
43 UNW_X86_64_FRAME_STANDARD = -2, /* regular rbp, rsp +/- offset */
44 UNW_X86_64_FRAME_SIGRETURN = -1, /* special sigreturn frame */
45 UNW_X86_64_FRAME_OTHER = 0, /* not cacheable (special or unrecognised) */
46 UNW_X86_64_FRAME_GUESSED = 1 /* guessed it was regular, but not known */
48 unw_tdep_frame_type_t;
52 uint64_t virtual_address;
53 int64_t frame_type : 2; /* unw_tdep_frame_type_t classification */
54 int64_t last_frame : 1; /* non-zero if last frame in chain */
55 int64_t cfa_reg_rsp : 1; /* cfa dwarf base register is rsp vs. rbp */
56 int64_t cfa_reg_offset : 30; /* cfa is at this offset from base register value */
57 int64_t rbp_cfa_offset : 15; /* rbp saved at this offset from cfa (-1 = not saved) */
58 int64_t rsp_cfa_offset : 15; /* rsp saved at this offset from cfa (-1 = not saved) */
64 struct unw_accessors acc;
65 unw_caching_policy_t caching_policy;
66 #ifdef HAVE_ATOMIC_OPS_H
67 AO_t cache_generation;
69 uint32_t cache_generation;
71 unw_word_t dyn_generation; /* see dyn-common.h */
72 unw_word_t dyn_info_list_addr; /* (cached) dyn_info_list_addr */
73 struct dwarf_rs_cache global_cache;
74 struct unw_debug_frame_list *debug_frames;
79 struct dwarf_cursor dwarf; /* must be first */
81 unw_tdep_frame_t frame_info; /* quick tracing assist info */
83 /* Format of sigcontext structure and address at which it is
87 X86_64_SCF_NONE, /* no signal frame encountered */
88 X86_64_SCF_LINUX_RT_SIGFRAME, /* Linux ucontext_t */
89 X86_64_SCF_FREEBSD_SIGFRAME, /* FreeBSD signal frame */
90 X86_64_SCF_FREEBSD_SYSCALL, /* FreeBSD syscall */
93 unw_word_t sigcontext_addr;
98 static inline ucontext_t *
99 dwarf_get_uc(const struct dwarf_cursor *cursor)
101 const struct cursor *c = (struct cursor *) cursor->as_arg;
105 #define DWARF_GET_LOC(l) ((l).val)
107 #ifdef UNW_LOCAL_ONLY
108 # define DWARF_NULL_LOC DWARF_LOC (0, 0)
109 # define DWARF_IS_NULL_LOC(l) (DWARF_GET_LOC (l) == 0)
110 # define DWARF_LOC(r, t) ((dwarf_loc_t) { .val = (r) })
111 # define DWARF_IS_REG_LOC(l) 0
112 # define DWARF_REG_LOC(c,r) (DWARF_LOC((unw_word_t) \
113 x86_64_r_uc_addr(dwarf_get_uc(c), (r)), 0))
114 # define DWARF_MEM_LOC(c,m) DWARF_LOC ((m), 0)
115 # define DWARF_FPREG_LOC(c,r) (DWARF_LOC((unw_word_t) \
116 x86_64_r_uc_addr(dwarf_get_uc(c), (r)), 0))
117 #else /* !UNW_LOCAL_ONLY */
119 # define DWARF_LOC_TYPE_FP (1 << 0)
120 # define DWARF_LOC_TYPE_REG (1 << 1)
121 # define DWARF_NULL_LOC DWARF_LOC (0, 0)
122 # define DWARF_IS_NULL_LOC(l) \
123 ({ dwarf_loc_t _l = (l); _l.val == 0 && _l.type == 0; })
124 # define DWARF_LOC(r, t) ((dwarf_loc_t) { .val = (r), .type = (t) })
125 # define DWARF_IS_REG_LOC(l) (((l).type & DWARF_LOC_TYPE_REG) != 0)
126 # define DWARF_IS_FP_LOC(l) (((l).type & DWARF_LOC_TYPE_FP) != 0)
127 # define DWARF_REG_LOC(c,r) DWARF_LOC((r), DWARF_LOC_TYPE_REG)
128 # define DWARF_MEM_LOC(c,m) DWARF_LOC ((m), 0)
129 # define DWARF_FPREG_LOC(c,r) DWARF_LOC((r), (DWARF_LOC_TYPE_REG \
130 | DWARF_LOC_TYPE_FP))
132 #endif /* !UNW_LOCAL_ONLY */
135 dwarf_getfp (struct dwarf_cursor *c, dwarf_loc_t loc, unw_fpreg_t *val)
137 if (DWARF_IS_NULL_LOC (loc))
144 dwarf_putfp (struct dwarf_cursor *c, dwarf_loc_t loc, unw_fpreg_t val)
146 if (DWARF_IS_NULL_LOC (loc))
153 dwarf_get (struct dwarf_cursor *c, dwarf_loc_t loc, unw_word_t *val)
155 if (DWARF_IS_NULL_LOC (loc))
158 if (DWARF_IS_REG_LOC (loc))
159 return (*c->as->acc.access_reg) (c->as, DWARF_GET_LOC (loc), val,
162 return (*c->as->acc.access_mem) (c->as, DWARF_GET_LOC (loc), val,
167 dwarf_put (struct dwarf_cursor *c, dwarf_loc_t loc, unw_word_t val)
169 if (DWARF_IS_NULL_LOC (loc))
172 if (DWARF_IS_REG_LOC (loc))
173 return (*c->as->acc.access_reg) (c->as, DWARF_GET_LOC (loc), &val,
176 return (*c->as->acc.access_mem) (c->as, DWARF_GET_LOC (loc), &val,
180 #define tdep_getcontext_trace UNW_ARCH_OBJ(getcontext_trace)
181 #define tdep_init_done UNW_OBJ(init_done)
182 #define tdep_init_mem_validate UNW_OBJ(init_mem_validate)
183 #define tdep_init UNW_OBJ(init)
184 /* Platforms that support UNW_INFO_FORMAT_TABLE need to define
185 tdep_search_unwind_table. */
186 #define tdep_search_unwind_table dwarf_search_unwind_table
187 #define tdep_find_unwind_table dwarf_find_unwind_table
188 #define tdep_get_elf_image UNW_ARCH_OBJ(get_elf_image)
189 #define tdep_access_reg UNW_OBJ(access_reg)
190 #define tdep_access_fpreg UNW_OBJ(access_fpreg)
192 # define tdep_fetch_frame UNW_OBJ(fetch_frame)
193 # define tdep_cache_frame UNW_OBJ(cache_frame)
194 # define tdep_reuse_frame UNW_OBJ(reuse_frame)
196 # define tdep_fetch_frame(c,ip,n) do {} while(0)
197 # define tdep_cache_frame(c,rs) do {} while(0)
198 # define tdep_reuse_frame(c,rs) do {} while(0)
200 #define tdep_stash_frame UNW_OBJ(stash_frame)
201 #define tdep_trace UNW_OBJ(tdep_trace)
202 #define x86_64_r_uc_addr UNW_OBJ(r_uc_addr)
204 #ifdef UNW_LOCAL_ONLY
205 # define tdep_find_proc_info(c,ip,n) \
206 dwarf_find_proc_info((c)->as, (ip), &(c)->pi, (n), \
208 # define tdep_put_unwind_info(as,pi,arg) \
209 dwarf_put_unwind_info((as), (pi), (arg))
211 # define tdep_find_proc_info(c,ip,n) \
212 (*(c)->as->acc.find_proc_info)((c)->as, (ip), &(c)->pi, (n), \
214 # define tdep_put_unwind_info(as,pi,arg) \
215 (*(as)->acc.put_unwind_info)((as), (pi), (arg))
218 #define tdep_get_as(c) ((c)->dwarf.as)
219 #define tdep_get_as_arg(c) ((c)->dwarf.as_arg)
220 #define tdep_get_ip(c) ((c)->dwarf.ip)
221 #define tdep_big_endian(as) 0
223 extern int tdep_init_done;
225 extern void tdep_init (void);
226 extern void tdep_init_mem_validate (void);
227 extern int tdep_search_unwind_table (unw_addr_space_t as, unw_word_t ip,
228 unw_dyn_info_t *di, unw_proc_info_t *pi,
229 int need_unwind_info, void *arg);
230 extern void *x86_64_r_uc_addr (ucontext_t *uc, int reg);
231 extern int tdep_get_elf_image (struct elf_image *ei, pid_t pid, unw_word_t ip,
232 unsigned long *segbase, unsigned long *mapoff,
233 char *path, size_t pathlen);
234 extern int tdep_access_reg (struct cursor *c, unw_regnum_t reg,
235 unw_word_t *valp, int write);
236 extern int tdep_access_fpreg (struct cursor *c, unw_regnum_t reg,
237 unw_fpreg_t *valp, int write);
239 extern void tdep_fetch_frame (struct dwarf_cursor *c, unw_word_t ip,
240 int need_unwind_info);
241 extern void tdep_cache_frame (struct dwarf_cursor *c,
242 struct dwarf_reg_state *rs);
243 extern void tdep_reuse_frame (struct dwarf_cursor *c,
244 struct dwarf_reg_state *rs);
245 extern void tdep_stash_frame (struct dwarf_cursor *c,
246 struct dwarf_reg_state *rs);
249 extern int tdep_getcontext_trace (unw_tdep_context_t *);
250 extern int tdep_trace (unw_cursor_t *cursor, void **addresses, int *n);
252 #endif /* X86_64_LIBUNWIND_I_H */