1 /* libunwind - a platform-independent unwind library
2 Copyright (C) 2001-2005 Hewlett-Packard Co
3 Copyright (C) 2007 David Mosberger-Tang
4 Contributed by David Mosberger-Tang <dmosberger@gmail.com>
5
6 This file is part of libunwind.
7
8 Permission is hereby granted, free of charge, to any person obtaining
9 a copy of this software and associated documentation files (the
10 "Software"), to deal in the Software without restriction, including
11 without limitation the rights to use, copy, modify, merge, publish,
12 distribute, sublicense, and/or sell copies of the Software, and to
13 permit persons to whom the Software is furnished to do so, subject to
14 the following conditions:
15
16 The above copyright notice and this permission notice shall be
17 included in all copies or substantial portions of the Software.
18
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
22 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
23 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
24 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
25 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
26
27 /* This files contains libunwind-internal definitions which are
28 subject to frequent change and are not to be exposed to
29 libunwind-users. */
30
31 #ifndef libunwind_i_h
32 #define libunwind_i_h
33
34 #ifdef HAVE_CONFIG_H
35 # include "config.h"
36 #endif
37
38 #include "compiler.h"
39
40 #if defined(HAVE___THREAD) && HAVE___THREAD
41 #define UNWI_DEFAULT_CACHING_POLICY UNW_CACHE_PER_THREAD
42 #else
43 #define UNWI_DEFAULT_CACHING_POLICY UNW_CACHE_GLOBAL
44 #endif
45
46 /* Platform-independent libunwind-internal declarations. */
47
48 #include <sys/types.h> /* HP-UX needs this before include of pthread.h */
49
50 #include <assert.h>
51 #include <libunwind.h>
52 #include <pthread.h>
53 #include <signal.h>
54 #include <stdlib.h>
55 #include <string.h>
56 #include <unistd.h>
57 #include <sys/mman.h>
58
59 #if defined(HAVE_ELF_H)
60 # include <elf.h>
61 #elif defined(HAVE_SYS_ELF_H)
62 # include <sys/elf.h>
63 #else
64 # error Could not locate <elf.h>
65 #endif
66
67 #if defined(HAVE_ENDIAN_H)
68 # include <endian.h>
69 #elif defined(HAVE_SYS_ENDIAN_H)
70 # include <sys/endian.h>
71 # if defined(_LITTLE_ENDIAN) && !defined(__LITTLE_ENDIAN)
72 # define __LITTLE_ENDIAN _LITTLE_ENDIAN
73 # endif
74 # if defined(_BIG_ENDIAN) && !defined(__BIG_ENDIAN)
75 # define __BIG_ENDIAN _BIG_ENDIAN
76 # endif
77 # if defined(_BYTE_ORDER) && !defined(__BYTE_ORDER)
78 # define __BYTE_ORDER _BYTE_ORDER
79 # endif
80 #else
81 # define __LITTLE_ENDIAN 1234
82 # define __BIG_ENDIAN 4321
83 # if defined(__hpux)
84 # define __BYTE_ORDER __BIG_ENDIAN
85 # elif defined(__QNX__)
86 # if defined(__BIGENDIAN__)
87 # define __BYTE_ORDER __BIG_ENDIAN
88 # elif defined(__LITTLEENDIAN__)
89 # define __BYTE_ORDER __LITTLE_ENDIAN
90 # else
91 # error Host has unknown byte-order.
92 # endif
93 # else
94 # error Host has unknown byte-order.
95 # endif
96 #endif
97
98 #if defined(HAVE__BUILTIN_UNREACHABLE)
99 # define unreachable() __builtin_unreachable()
100 #else
101 # define unreachable() do { } while (1)
102 #endif
103
104 #ifdef DEBUG
105 # define UNW_DEBUG 1
106 #else
107 # define UNW_DEBUG 0
108 #endif
109
110 /* Make it easy to write thread-safe code which may or may not be
111 linked against libpthread. The macros below can be used
112 unconditionally and if -lpthread is around, they'll call the
113 corresponding routines otherwise, they do nothing. */
114
115 #pragma weak pthread_mutex_init
116 #pragma weak pthread_mutex_lock
117 #pragma weak pthread_mutex_unlock
118
119 #define mutex_init(l) \
120 (pthread_mutex_init != NULL ? pthread_mutex_init ((l), NULL) : 0)
121 #define mutex_lock(l) \
122 (pthread_mutex_lock != NULL ? pthread_mutex_lock (l) : 0)
123 #define mutex_unlock(l) \
124 (pthread_mutex_unlock != NULL ? pthread_mutex_unlock (l) : 0)
125
126 #ifdef HAVE_ATOMIC_OPS_H
127 # include <atomic_ops.h>
128 static inline int
cmpxchg_ptr(void * addr,void * old,void * new)129 cmpxchg_ptr (void *addr, void *old, void *new)
130 {
131 union
132 {
133 void *vp;
134 AO_t *aop;
135 }
136 u;
137
138 u.vp = addr;
139 return AO_compare_and_swap(u.aop, (AO_t) old, (AO_t) new);
140 }
141 # define fetch_and_add1(_ptr) AO_fetch_and_add1(_ptr)
142 # define fetch_and_add(_ptr, value) AO_fetch_and_add(_ptr, value)
143 # define atomic_read(ptr) (AO_load(ptr))
144 /* GCC 3.2.0 on HP-UX crashes on cmpxchg_ptr() */
145 # if !(defined(__hpux) && __GNUC__ == 3 && __GNUC_MINOR__ == 2)
146 # define HAVE_CMPXCHG
147 # endif
148 # define HAVE_FETCH_AND_ADD
149 #elif defined(HAVE_SYNC_ATOMICS) || defined(HAVE_IA64INTRIN_H)
150 # ifdef HAVE_IA64INTRIN_H
151 # include <ia64intrin.h>
152 # endif
153 static inline int
cmpxchg_ptr(void * addr,void * old,void * new)154 cmpxchg_ptr (void *addr, void *old, void *new)
155 {
156 union
157 {
158 void *vp;
159 long *vlp;
160 }
161 u;
162
163 u.vp = addr;
164 return __sync_bool_compare_and_swap(u.vlp, (long) old, (long) new);
165 }
166 # define fetch_and_add1(_ptr) __sync_fetch_and_add(_ptr, 1)
167 # define fetch_and_add(_ptr, value) __sync_fetch_and_add(_ptr, value)
168 # define atomic_read(ptr) (__atomic_load_n(ptr,__ATOMIC_RELAXED))
169 # define HAVE_CMPXCHG
170 # define HAVE_FETCH_AND_ADD
171 #endif
172
173 #ifndef atomic_read
174 #define atomic_read(ptr) (*(ptr))
175 #endif
176
177 #define UNWI_OBJ(fn) UNW_PASTE(UNW_PREFIX,UNW_PASTE(I,fn))
178 #define UNWI_ARCH_OBJ(fn) UNW_PASTE(UNW_PASTE(UNW_PASTE(_UI,UNW_TARGET),_), fn)
179
180 #define unwi_full_mask UNWI_ARCH_OBJ(full_mask)
181
182 /* Type of a mask that can be used to inhibit preemption. At the
183 userlevel, preemption is caused by signals and hence sigset_t is
184 appropriate. In constrast, the Linux kernel uses "unsigned long"
185 to hold the processor "flags" instead. */
186 typedef sigset_t intrmask_t;
187
188 extern intrmask_t unwi_full_mask;
189
190 /* Silence compiler warnings about variables which are used only if libunwind
191 is configured in a certain way */
mark_as_used(void * v UNUSED)192 static inline void mark_as_used(void *v UNUSED) {
193 }
194
195 #if defined(CONFIG_BLOCK_SIGNALS)
196 # define SIGPROCMASK(how, new_mask, old_mask) \
197 sigprocmask((how), (new_mask), (old_mask))
198 #else
199 # define SIGPROCMASK(how, new_mask, old_mask) mark_as_used(old_mask)
200 #endif
201
202 /* Prefer adaptive mutexes if available */
203 #ifdef PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP
204 #define UNW_PTHREAD_MUTEX_INITIALIZER PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP
205 #else
206 #define UNW_PTHREAD_MUTEX_INITIALIZER PTHREAD_MUTEX_INITIALIZER
207 #endif
208
209 #define define_lock(name) \
210 pthread_mutex_t name = UNW_PTHREAD_MUTEX_INITIALIZER
211 #define lock_init(l) mutex_init (l)
212 #define lock_acquire(l,m) \
213 do { \
214 SIGPROCMASK (SIG_SETMASK, &unwi_full_mask, &(m)); \
215 mutex_lock (l); \
216 } while (0)
217 #define lock_release(l,m) \
218 do { \
219 mutex_unlock (l); \
220 SIGPROCMASK (SIG_SETMASK, &(m), NULL); \
221 } while (0)
222
223 #define SOS_MEMORY_SIZE 16384 /* see src/mi/mempool.c */
224
225 #ifndef MAP_ANONYMOUS
226 # define MAP_ANONYMOUS MAP_ANON
227 #endif
228 #define GET_MEMORY(mem, size) \
229 do { \
230 /* Hopefully, mmap() goes straight through to a system call stub... */ \
231 mem = mmap (NULL, size, PROT_READ | PROT_WRITE, \
232 MAP_PRIVATE | MAP_ANONYMOUS, -1, 0); \
233 if (mem == MAP_FAILED) \
234 mem = NULL; \
235 } while (0)
236
237 #define unwi_find_dynamic_proc_info UNWI_OBJ(find_dynamic_proc_info)
238 #define unwi_extract_dynamic_proc_info UNWI_OBJ(extract_dynamic_proc_info)
239 #define unwi_put_dynamic_unwind_info UNWI_OBJ(put_dynamic_unwind_info)
240 #define unwi_dyn_remote_find_proc_info UNWI_OBJ(dyn_remote_find_proc_info)
241 #define unwi_dyn_remote_put_unwind_info UNWI_OBJ(dyn_remote_put_unwind_info)
242 #define unwi_dyn_validate_cache UNWI_OBJ(dyn_validate_cache)
243
244 extern int unwi_find_dynamic_proc_info (unw_addr_space_t as,
245 unw_word_t ip,
246 unw_proc_info_t *pi,
247 int need_unwind_info, void *arg);
248 extern int unwi_extract_dynamic_proc_info (unw_addr_space_t as,
249 unw_word_t ip,
250 unw_proc_info_t *pi,
251 unw_dyn_info_t *di,
252 int need_unwind_info,
253 void *arg);
254 extern void unwi_put_dynamic_unwind_info (unw_addr_space_t as,
255 unw_proc_info_t *pi, void *arg);
256
257 /* These handle the remote (cross-address-space) case of accessing
258 dynamic unwind info. */
259
260 extern int unwi_dyn_remote_find_proc_info (unw_addr_space_t as,
261 unw_word_t ip,
262 unw_proc_info_t *pi,
263 int need_unwind_info,
264 void *arg);
265 extern void unwi_dyn_remote_put_unwind_info (unw_addr_space_t as,
266 unw_proc_info_t *pi,
267 void *arg);
268 extern int unwi_dyn_validate_cache (unw_addr_space_t as, void *arg);
269
270 extern unw_dyn_info_list_t _U_dyn_info_list;
271 extern pthread_mutex_t _U_dyn_info_list_lock;
272
273 #if UNW_DEBUG
274 #define unwi_debug_level UNWI_ARCH_OBJ(debug_level)
275 extern long unwi_debug_level;
276
277 # include <stdio.h>
278 # define Debug(level,format...) \
279 do { \
280 if (unwi_debug_level >= level) \
281 { \
282 int _n = level; \
283 if (_n > 16) \
284 _n = 16; \
285 fprintf (stderr, "%*c>%s: ", _n, ' ', __FUNCTION__); \
286 fprintf (stderr, format); \
287 } \
288 } while (0)
289 # define Dprintf(format...) fprintf (stderr, format)
290 #else
291 # define Debug(level,format...)
292 # define Dprintf(format...)
293 #endif
294
295 static ALWAYS_INLINE int
print_error(const char * string)296 print_error (const char *string)
297 {
298 return write (2, string, strlen (string));
299 }
300
301 #define mi_init UNWI_ARCH_OBJ(mi_init)
302
303 extern void mi_init (void); /* machine-independent initializations */
304 extern unw_word_t _U_dyn_info_list_addr (void);
305
306 /* This is needed/used by ELF targets only. */
307
308 struct elf_image
309 {
310 void *image; /* pointer to mmap'd image */
311 size_t size; /* (file-) size of the image */
312 };
313
314 struct elf_dyn_info
315 {
316 struct elf_image ei;
317 unw_dyn_info_t di_cache;
318 unw_dyn_info_t di_debug; /* additional table info for .debug_frame */
319 #if UNW_TARGET_IA64
320 unw_dyn_info_t ktab;
321 #endif
322 #if UNW_TARGET_ARM
323 unw_dyn_info_t di_arm; /* additional table info for .ARM.exidx */
324 #endif
325 };
326
invalidate_edi(struct elf_dyn_info * edi)327 static inline void invalidate_edi (struct elf_dyn_info *edi)
328 {
329 if (edi->ei.image)
330 munmap (edi->ei.image, edi->ei.size);
331 memset (edi, 0, sizeof (*edi));
332 edi->di_cache.format = -1;
333 edi->di_debug.format = -1;
334 #if UNW_TARGET_ARM
335 edi->di_arm.format = -1;
336 #endif
337 }
338
339
340 /* Provide a place holder for architecture to override for fast access
341 to memory when known not to need to validate and know the access
342 will be local to the process. A suitable override will improve
343 unw_tdep_trace() performance in particular. */
344 #define ACCESS_MEM_FAST(ret,validate,cur,addr,to) \
345 do { (ret) = dwarf_get ((cur), DWARF_MEM_LOC ((cur), (addr)), &(to)); } \
346 while (0)
347
348 /* Define GNU and processor specific values for the Phdr p_type field in case
349 they aren't defined by <elf.h>. */
350 #ifndef PT_GNU_EH_FRAME
351 # define PT_GNU_EH_FRAME 0x6474e550
352 #endif /* !PT_GNU_EH_FRAME */
353 #ifndef PT_ARM_EXIDX
354 # define PT_ARM_EXIDX 0x70000001 /* ARM unwind segment */
355 #endif /* !PT_ARM_EXIDX */
356
357 #include "tdep/libunwind_i.h"
358
359 #ifndef tdep_get_func_addr
360 # define tdep_get_func_addr(as,addr,v) (*(v) = addr, 0)
361 #endif
362
363 #ifndef DWARF_VAL_LOC
364 # define DWARF_IS_VAL_LOC(l) 0
365 # define DWARF_VAL_LOC(c,v) DWARF_NULL_LOC
366 #endif
367
368 #define UNW_ALIGN(x,a) (((x)+(a)-1UL)&~((a)-1UL))
369
370 #endif /* libunwind_i_h */
371