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>
4
5 Modified for x86_64 by Max Asbock <masbock@us.ibm.com>
6
7This file is part of libunwind.
8
9Permission is hereby granted, free of charge, to any person obtaining
10a copy of this software and associated documentation files (the
11"Software"), to deal in the Software without restriction, including
12without limitation the rights to use, copy, modify, merge, publish,
13distribute, sublicense, and/or sell copies of the Software, and to
14permit persons to whom the Software is furnished to do so, subject to
15the following conditions:
16
17The above copyright notice and this permission notice shall be
18included in all copies or substantial portions of the Software.
19
20THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
24LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
25OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
26WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
27
28#ifndef X86_64_LIBUNWIND_I_H
29#define X86_64_LIBUNWIND_I_H
30
31/* Target-dependent definitions that are internal to libunwind but need
32 to be shared with target-independent code. */
33
34#include <stdlib.h>
35#include <libunwind.h>
36
37#include "elf64.h"
38#include "mempool.h"
39#include "dwarf.h"
40
41typedef enum
42 {
43 UNW_X86_64_FRAME_ALIGNED = -3, /* frame stack pointer aligned */
44 UNW_X86_64_FRAME_STANDARD = -2, /* regular rbp, rsp +/- offset */
45 UNW_X86_64_FRAME_SIGRETURN = -1, /* special sigreturn frame */
46 UNW_X86_64_FRAME_OTHER = 0, /* not cacheable (special or unrecognised) */
47 UNW_X86_64_FRAME_GUESSED = 1 /* guessed it was regular, but not known */
48 }
49unw_tdep_frame_type_t;
50
51typedef struct
52 {
53 uint64_t virtual_address;
54 int64_t frame_type : 3; /* unw_tdep_frame_type_t classification */
55 int64_t last_frame : 1; /* non-zero if last frame in chain */
56 int64_t cfa_reg_rsp : 1; /* cfa dwarf base register is rsp vs. rbp */
57 int64_t cfa_reg_offset : 29; /* cfa is at this offset from base register value */
58 int64_t rbp_cfa_offset : 15; /* rbp saved at this offset from cfa (-1 = not saved) */
59 int64_t rsp_cfa_offset : 15; /* rsp saved at this offset from cfa (-1 = not saved) */
60 }
61unw_tdep_frame_t;
62
63struct unw_addr_space
64 {
65 struct unw_accessors acc;
66 unw_caching_policy_t caching_policy;
67#ifdef HAVE_ATOMIC_OPS_H
68 AO_t cache_generation;
69#else
70 uint32_t cache_generation;
71#endif
72 unw_word_t dyn_generation; /* see dyn-common.h */
73 unw_word_t dyn_info_list_addr; /* (cached) dyn_info_list_addr */
74 struct dwarf_rs_cache global_cache;
75 struct unw_debug_frame_list *debug_frames;
76 };
77
78struct cursor
79 {
80 struct dwarf_cursor dwarf; /* must be first */
81
82 unw_tdep_frame_t frame_info; /* quick tracing assist info */
83
84 /* Format of sigcontext structure and address at which it is
85 stored: */
86 enum
87 {
88 X86_64_SCF_NONE, /* no signal frame encountered */
89 X86_64_SCF_LINUX_RT_SIGFRAME, /* Linux ucontext_t */
90 X86_64_SCF_FREEBSD_SIGFRAME, /* FreeBSD signal frame */
91 X86_64_SCF_FREEBSD_SYSCALL, /* FreeBSD syscall */
92 }
93 sigcontext_format;
94 unw_word_t sigcontext_addr;
95 int validate;
96 ucontext_t *uc;
97 };
98
99static inline ucontext_t *
100dwarf_get_uc(const struct dwarf_cursor *cursor)
101{
102 const struct cursor *c = (struct cursor *) cursor->as_arg;
103 return c->uc;
104}
105
106#define DWARF_GET_LOC(l) ((l).val)
107# define DWARF_LOC_TYPE_MEM (0 << 0)
108# define DWARF_LOC_TYPE_FP (1 << 0)
109# define DWARF_LOC_TYPE_REG (1 << 1)
110# define DWARF_LOC_TYPE_VAL (1 << 2)
111
112# define DWARF_IS_REG_LOC(l) (((l).type & DWARF_LOC_TYPE_REG) != 0)
113# define DWARF_IS_FP_LOC(l) (((l).type & DWARF_LOC_TYPE_FP) != 0)
114# define DWARF_IS_MEM_LOC(l) ((l).type == DWARF_LOC_TYPE_MEM)
115# define DWARF_IS_VAL_LOC(l) (((l).type & DWARF_LOC_TYPE_VAL) != 0)
116
117# define DWARF_LOC(r, t) ((dwarf_loc_t) { .val = (r), .type = (t) })
118# define DWARF_VAL_LOC(c,v) DWARF_LOC ((v), DWARF_LOC_TYPE_VAL)
119# define DWARF_MEM_LOC(c,m) DWARF_LOC ((m), DWARF_LOC_TYPE_MEM)
120
121#ifdef UNW_LOCAL_ONLY
122# define DWARF_NULL_LOC DWARF_LOC (0, 0)
123# define DWARF_IS_NULL_LOC(l) (DWARF_GET_LOC (l) == 0)
124# define DWARF_REG_LOC(c,r) (DWARF_LOC((unw_word_t) \
125 x86_64_r_uc_addr(dwarf_get_uc(c), (r)), 0))
126# define DWARF_FPREG_LOC(c,r) (DWARF_LOC((unw_word_t) \
127 x86_64_r_uc_addr(dwarf_get_uc(c), (r)), 0))
128
129#else /* !UNW_LOCAL_ONLY */
130
131# define DWARF_NULL_LOC DWARF_LOC (0, 0)
132# define DWARF_IS_NULL_LOC(l) \
133 ({ dwarf_loc_t _l = (l); _l.val == 0 && _l.type == 0; })
134# define DWARF_REG_LOC(c,r) DWARF_LOC((r), DWARF_LOC_TYPE_REG)
135# define DWARF_FPREG_LOC(c,r) DWARF_LOC((r), (DWARF_LOC_TYPE_REG \
136 | DWARF_LOC_TYPE_FP))
137
138#endif /* !UNW_LOCAL_ONLY */
139
140static inline int
141dwarf_getfp (struct dwarf_cursor *c, dwarf_loc_t loc, unw_fpreg_t *val)
142{
143 if (DWARF_IS_NULL_LOC (loc))
144 return -UNW_EBADREG;
145
146 abort ();
147}
148
149static inline int
150dwarf_putfp (struct dwarf_cursor *c, dwarf_loc_t loc, unw_fpreg_t val)
151{
152 if (DWARF_IS_NULL_LOC (loc))
153 return -UNW_EBADREG;
154
155 abort ();
156}
157
158static inline int
159dwarf_get (struct dwarf_cursor *c, dwarf_loc_t loc, unw_word_t *val)
160{
161 if (DWARF_IS_NULL_LOC (loc))
162 return -UNW_EBADREG;
163
164 if (DWARF_IS_REG_LOC (loc))
165 return (*c->as->acc.access_reg) (c->as, DWARF_GET_LOC (loc), val,
166 0, c->as_arg);
167 if (DWARF_IS_MEM_LOC (loc))
168 return (*c->as->acc.access_mem) (c->as, DWARF_GET_LOC (loc), val,
169 0, c->as_arg);
170 assert(DWARF_IS_VAL_LOC (loc));
171 *val = DWARF_GET_LOC (loc);
172 return 0;
173}
174
175static inline int
176dwarf_put (struct dwarf_cursor *c, dwarf_loc_t loc, unw_word_t val)
177{
178 assert(!DWARF_IS_VAL_LOC (loc));
179
180 if (DWARF_IS_NULL_LOC (loc))
181 return -UNW_EBADREG;
182
183 if (DWARF_IS_REG_LOC (loc))
184 return (*c->as->acc.access_reg) (c->as, DWARF_GET_LOC (loc), &val,
185 1, c->as_arg);
186 else
187 return (*c->as->acc.access_mem) (c->as, DWARF_GET_LOC (loc), &val,
188 1, c->as_arg);
189}
190
191#define tdep_getcontext_trace UNW_ARCH_OBJ(getcontext_trace)
192#define tdep_init_done UNW_OBJ(init_done)
193#define tdep_init_mem_validate UNW_OBJ(init_mem_validate)
194#define tdep_init UNW_OBJ(init)
195/* Platforms that support UNW_INFO_FORMAT_TABLE need to define
196 tdep_search_unwind_table. */
197#define tdep_search_unwind_table dwarf_search_unwind_table
198#define tdep_find_unwind_table dwarf_find_unwind_table
199#define tdep_get_elf_image UNW_ARCH_OBJ(get_elf_image)
200#define tdep_get_exe_image_path UNW_ARCH_OBJ(get_exe_image_path)
201#define tdep_access_reg UNW_OBJ(access_reg)
202#define tdep_access_fpreg UNW_OBJ(access_fpreg)
203#if __linux__
204# define tdep_fetch_frame UNW_OBJ(fetch_frame)
205# define tdep_cache_frame UNW_OBJ(cache_frame)
206# define tdep_reuse_frame UNW_OBJ(reuse_frame)
207#else
208# define tdep_fetch_frame(c,ip,n) do {} while(0)
209# define tdep_cache_frame(c) 0
210# define tdep_reuse_frame(c,frame) do {} while(0)
211#endif
212#define tdep_stash_frame UNW_OBJ(stash_frame)
213#define tdep_trace UNW_OBJ(tdep_trace)
214#define x86_64_r_uc_addr UNW_OBJ(r_uc_addr)
215
216#ifdef UNW_LOCAL_ONLY
217# define tdep_find_proc_info(c,ip,n) \
218 dwarf_find_proc_info((c)->as, (ip), &(c)->pi, (n), \
219 (c)->as_arg)
220# define tdep_put_unwind_info(as,pi,arg) \
221 dwarf_put_unwind_info((as), (pi), (arg))
222#else
223# define tdep_find_proc_info(c,ip,n) \
224 (*(c)->as->acc.find_proc_info)((c)->as, (ip), &(c)->pi, (n), \
225 (c)->as_arg)
226# define tdep_put_unwind_info(as,pi,arg) \
227 (*(as)->acc.put_unwind_info)((as), (pi), (arg))
228#endif
229
230#define tdep_get_as(c) ((c)->dwarf.as)
231#define tdep_get_as_arg(c) ((c)->dwarf.as_arg)
232#define tdep_get_ip(c) ((c)->dwarf.ip)
233#define tdep_big_endian(as) 0
234
235extern int tdep_init_done;
236
237extern void tdep_init (void);
238extern void tdep_init_mem_validate (void);
239extern int tdep_search_unwind_table (unw_addr_space_t as, unw_word_t ip,
240 unw_dyn_info_t *di, unw_proc_info_t *pi,
241 int need_unwind_info, void *arg);
242extern void *x86_64_r_uc_addr (ucontext_t *uc, int reg);
243extern int tdep_get_elf_image (struct elf_image *ei, pid_t pid, unw_word_t ip,
244 unsigned long *segbase, unsigned long *mapoff,
245 char *path, size_t pathlen);
246extern void tdep_get_exe_image_path (char *path);
247extern int tdep_access_reg (struct cursor *c, unw_regnum_t reg,
248 unw_word_t *valp, int write);
249extern int tdep_access_fpreg (struct cursor *c, unw_regnum_t reg,
250 unw_fpreg_t *valp, int write);
251#if __linux__
252extern void tdep_fetch_frame (struct dwarf_cursor *c, unw_word_t ip,
253 int need_unwind_info);
254extern int tdep_cache_frame (struct dwarf_cursor *c);
255extern void tdep_reuse_frame (struct dwarf_cursor *c,
256 int frame);
257extern void tdep_stash_frame (struct dwarf_cursor *c,
258 struct dwarf_reg_state *rs);
259#endif
260
261extern int tdep_getcontext_trace (unw_tdep_context_t *);
262extern int tdep_trace (unw_cursor_t *cursor, void **addresses, int *n);
263
264#endif /* X86_64_LIBUNWIND_I_H */
265