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___CACHE_PER_THREAD) && HAVE___CACHE_PER_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 #include <errno.h>
59 #include <stdio.h>
60 #ifdef PARSE_BUILD_ID
61 #include <link.h>
62 #endif
63
64 #if defined(HAVE_ELF_H)
65 # include <elf.h>
66 #elif defined(HAVE_SYS_ELF_H)
67 # include <sys/elf.h>
68 #else
69 # error Could not locate <elf.h>
70 #endif
71 #if defined(ELFCLASS32)
72 # define UNW_ELFCLASS32 ELFCLASS32
73 #else
74 # define UNW_ELFCLASS32 1
75 #endif
76 #if defined(ELFCLASS64)
77 # define UNW_ELFCLASS64 ELFCLASS64
78 #else
79 # define UNW_ELFCLASS64 2
80 #endif
81
82 #if defined(HAVE_ENDIAN_H)
83 # include <endian.h>
84 #elif defined(HAVE_SYS_ENDIAN_H)
85 # include <sys/endian.h>
86 #elif defined(HAVE_SYS_PARAM_H)
87 # include <sys/param.h>
88 #endif
89
90 #if defined(__LITTLE_ENDIAN)
91 # define UNW_LITTLE_ENDIAN __LITTLE_ENDIAN
92 #elif defined(_LITTLE_ENDIAN)
93 # define UNW_LITTLE_ENDIAN _LITTLE_ENDIAN
94 #elif defined(LITTLE_ENDIAN)
95 # define UNW_LITTLE_ENDIAN LITTLE_ENDIAN
96 #else
97 # define UNW_LITTLE_ENDIAN 1234
98 #endif
99
100 #if defined(__BIG_ENDIAN)
101 # define UNW_BIG_ENDIAN __BIG_ENDIAN
102 #elif defined(_BIG_ENDIAN)
103 # define UNW_BIG_ENDIAN _BIG_ENDIAN
104 #elif defined(BIG_ENDIAN)
105 # define UNW_BIG_ENDIAN BIG_ENDIAN
106 #else
107 # define UNW_BIG_ENDIAN 4321
108 #endif
109
110 #if defined(__BYTE_ORDER)
111 # define UNW_BYTE_ORDER __BYTE_ORDER
112 #elif defined(_BYTE_ORDER)
113 # define UNW_BYTE_ORDER _BYTE_ORDER
114 #elif defined(BIG_ENDIAN)
115 # define UNW_BYTE_ORDER BYTE_ORDER
116 #else
117 # if defined(__hpux)
118 # define UNW_BYTE_ORDER UNW_BIG_ENDIAN
119 # else
120 # error Target has unknown byte ordering.
121 # endif
122 #endif
123
124 static inline int
byte_order_is_valid(int byte_order)125 byte_order_is_valid(int byte_order)
126 {
127 return byte_order != UNW_BIG_ENDIAN
128 && byte_order != UNW_LITTLE_ENDIAN;
129 }
130
131 static inline int
byte_order_is_big_endian(int byte_order)132 byte_order_is_big_endian(int byte_order)
133 {
134 return byte_order == UNW_BIG_ENDIAN;
135 }
136
137 static inline int
target_is_big_endian(void)138 target_is_big_endian(void)
139 {
140 return byte_order_is_big_endian(UNW_BYTE_ORDER);
141 }
142
143 #if defined(HAVE__BUILTIN_UNREACHABLE)
144 # define unreachable() __builtin_unreachable()
145 #else
146 # define unreachable() do { } while (1)
147 #endif
148
149 #ifdef DEBUG
150 # define UNW_DEBUG 1
151 #else
152 # define UNW_DEBUG 0
153 #endif
154
155 /* Make it easy to write thread-safe code which may or may not be
156 linked against libpthread. The macros below can be used
157 unconditionally and if -lpthread is around, they'll call the
158 corresponding routines otherwise, they do nothing. */
159
160 #pragma weak pthread_mutex_init
161 #pragma weak pthread_mutex_lock
162 #pragma weak pthread_mutex_unlock
163
164 #define mutex_init(l) \
165 (pthread_mutex_init != NULL ? pthread_mutex_init ((l), NULL) : 0)
166 #define mutex_lock(l) \
167 (pthread_mutex_lock != NULL ? pthread_mutex_lock (l) : 0)
168 #define mutex_unlock(l) \
169 (pthread_mutex_unlock != NULL ? pthread_mutex_unlock (l) : 0)
170
171 #define UNWI_OBJ(fn) UNW_PASTE(UNW_PREFIX,UNW_PASTE(I,fn))
172 #define UNWI_ARCH_OBJ(fn) UNW_PASTE(UNW_PASTE(UNW_PASTE(_UI,UNW_TARGET),_), fn)
173
174 #define unwi_full_mask UNWI_ARCH_OBJ(full_mask)
175
176 /* Type of a mask that can be used to inhibit preemption. At the
177 userlevel, preemption is caused by signals and hence sigset_t is
178 appropriate. In contrast, the Linux kernel uses "unsigned long"
179 to hold the processor "flags" instead. */
180 typedef sigset_t intrmask_t;
181
182 extern intrmask_t unwi_full_mask;
183
184 /* Silence compiler warnings about variables which are used only if libunwind
185 is configured in a certain way */
mark_as_used(void * v UNUSED)186 static inline void mark_as_used(void *v UNUSED) {
187 }
188
189 #if defined(CONFIG_BLOCK_SIGNALS)
190 # define SIGPROCMASK(how, new_mask, old_mask) \
191 sigprocmask((how), (new_mask), (old_mask))
192 #else
193 # define SIGPROCMASK(how, new_mask, old_mask) mark_as_used(old_mask)
194 #endif
195
196 /* Prefer adaptive mutexes if available */
197 #ifdef PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP
198 #define UNW_PTHREAD_MUTEX_INITIALIZER PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP
199 #else
200 #define UNW_PTHREAD_MUTEX_INITIALIZER PTHREAD_MUTEX_INITIALIZER
201 #endif
202
203 #define define_lock(name) \
204 pthread_mutex_t name = UNW_PTHREAD_MUTEX_INITIALIZER
205 #define lock_init(l) mutex_init (l)
206 #define lock_acquire(l,m) \
207 do { \
208 SIGPROCMASK (SIG_SETMASK, &unwi_full_mask, &(m)); \
209 mutex_lock (l); \
210 } while (0)
211 #define lock_release(l,m) \
212 do { \
213 mutex_unlock (l); \
214 SIGPROCMASK (SIG_SETMASK, &(m), NULL); \
215 } while (0)
216
217 #define SOS_MEMORY_SIZE 16384 /* see src/mi/mempool.c */
218
219 #ifndef MAP_ANONYMOUS
220 # define MAP_ANONYMOUS MAP_ANON
221 #endif
222 #define GET_MEMORY(mem, size) \
223 do { \
224 /* Hopefully, mmap() goes straight through to a system call stub... */ \
225 mem = mmap (NULL, size, PROT_READ | PROT_WRITE, \
226 MAP_PRIVATE | MAP_ANONYMOUS, -1, 0); \
227 if (mem == MAP_FAILED) \
228 mem = NULL; \
229 } while (0)
230
231 #define unwi_find_dynamic_proc_info UNWI_OBJ(find_dynamic_proc_info)
232 #define unwi_extract_dynamic_proc_info UNWI_OBJ(extract_dynamic_proc_info)
233 #define unwi_put_dynamic_unwind_info UNWI_OBJ(put_dynamic_unwind_info)
234 #define unwi_dyn_remote_find_proc_info UNWI_OBJ(dyn_remote_find_proc_info)
235 #define unwi_dyn_remote_put_unwind_info UNWI_OBJ(dyn_remote_put_unwind_info)
236 #define unwi_dyn_validate_cache UNWI_OBJ(dyn_validate_cache)
237
238 extern int unwi_find_dynamic_proc_info (unw_addr_space_t as,
239 unw_word_t ip,
240 unw_proc_info_t *pi,
241 int need_unwind_info, void *arg);
242 extern int unwi_extract_dynamic_proc_info (unw_addr_space_t as,
243 unw_word_t ip,
244 unw_proc_info_t *pi,
245 unw_dyn_info_t *di,
246 int need_unwind_info,
247 void *arg);
248 extern void unwi_put_dynamic_unwind_info (unw_addr_space_t as,
249 unw_proc_info_t *pi, void *arg);
250
251 /* These handle the remote (cross-address-space) case of accessing
252 dynamic unwind info. */
253
254 extern int unwi_dyn_remote_find_proc_info (unw_addr_space_t as,
255 unw_word_t ip,
256 unw_proc_info_t *pi,
257 int need_unwind_info,
258 void *arg);
259 extern void unwi_dyn_remote_put_unwind_info (unw_addr_space_t as,
260 unw_proc_info_t *pi,
261 void *arg);
262 extern int unwi_dyn_validate_cache (unw_addr_space_t as, void *arg);
263
264 extern unw_dyn_info_list_t _U_dyn_info_list;
265 extern pthread_mutex_t _U_dyn_info_list_lock;
266
267 #if UNW_DEBUG
268 #define unwi_debug_level UNWI_ARCH_OBJ(debug_level)
269 extern long unwi_debug_level;
270
271 # include <stdio.h>
272 # define Debug(level, /* format */ ...) \
273 do { \
274 if (unwi_debug_level >= level) \
275 { \
276 int _n = level; \
277 if (_n > 16) \
278 _n = 16; \
279 fprintf (stderr, "%*c>%s: ", _n, ' ', __FUNCTION__); \
280 fprintf (stderr, /* format */ __VA_ARGS__); \
281 } \
282 } while (0)
283 # define Dprintf(/* format */ ...) \
284 fprintf (stderr, /* format */ __VA_ARGS__)
285 #else
286 # define Debug(level, /* format */ ...)
287 # define Dprintf(/* format */ ...) \
288 fprintf (stderr, /* format */ __VA_ARGS__)
289 #endif
290
291 static ALWAYS_INLINE int
print_error(const char * string)292 print_error (const char *string)
293 {
294 return write (2, string, strlen (string));
295 }
296
297 #define mi_init UNWI_ARCH_OBJ(mi_init)
298
299 extern void mi_init (void); /* machine-independent initializations */
300 extern unw_word_t _U_dyn_info_list_addr (void);
301
302 /* This is needed/used by ELF targets only. */
303
304 struct elf_dyn_info
305 {
306 /* Add For Cache MAP And ELF*/
307 /* Removed: struct elf_image ei; */
308 /* Add For Cache MAP And ELF */
309 unw_word_t start_ip;
310 unw_word_t end_ip;
311 unw_dyn_info_t di_cache;
312 unw_dyn_info_t di_debug; /* additional table info for .debug_frame */
313 #if UNW_TARGET_IA64
314 unw_dyn_info_t ktab;
315 #endif
316 #if UNW_TARGET_ARM
317 unw_dyn_info_t di_arm; /* additional table info for .ARM.exidx */
318 #endif
319 };
320 #ifdef PARSE_BUILD_ID
321 struct build_id_note {
322 ElfW(Nhdr) nhdr;
323 char name[4];
324 uint8_t build_id[0];
325 };
326 #endif
327 struct elf_image
328 {
329 void *image; /* pointer to mmap'd image */
330 size_t size; /* (file-) size of the image */
331 int has_dyn_info;
332 struct elf_dyn_info elf_dyn_info;
333 int load_bias;
334 int load_offset;
335 char* strtab;
336 #ifdef PARSE_BUILD_ID
337 struct build_id_note* build_id_note;
338 #endif
339 struct elf_image* mdi;
340 int has_try_load;
341 };
342
invalidate_edi(struct elf_dyn_info * edi)343 static inline void invalidate_edi (struct elf_dyn_info *edi)
344 {
345 /* Add For Cache MAP And ELF*/
346 /* Removed: if (edi->ei.image) */
347 /* munmap (edi->ei.image, edi->ei.size); */
348 /* Add For Cache MAP And ELF */
349 memset (edi, 0, sizeof (*edi));
350 edi->di_cache.format = -1;
351 edi->di_debug.format = -1;
352 #if UNW_TARGET_ARM
353 edi->di_arm.format = -1;
354 #endif
355 }
356
357
358 /* Provide a place holder for architecture to override for fast access
359 to memory when known not to need to validate and know the access
360 will be local to the process. A suitable override will improve
361 unw_tdep_trace() performance in particular. */
362 #define ACCESS_MEM_FAST(ret,validate,cur,addr,to) \
363 do { (ret) = dwarf_get ((cur), DWARF_MEM_LOC ((cur), (addr)), &(to)); } \
364 while (0)
365
366 /* Define GNU and processor specific values for the Phdr p_type field in case
367 they aren't defined by <elf.h>. */
368 #ifndef PT_GNU_EH_FRAME
369 # define PT_GNU_EH_FRAME 0x6474e550
370 #endif /* !PT_GNU_EH_FRAME */
371 #ifndef PT_ARM_EXIDX
372 # define PT_ARM_EXIDX 0x70000001 /* ARM unwind segment */
373 #endif /* !PT_ARM_EXIDX */
374
375 #include "tdep/libunwind_i.h"
376
377 #ifndef TDEP_DWARF_SP
378 #define TDEP_DWARF_SP UNW_TDEP_SP
379 #endif
380
381 #ifndef tdep_get_func_addr
382 # define tdep_get_func_addr(as,addr,v) (*(v) = addr, 0)
383 #endif
384
385 #ifndef DWARF_VAL_LOC
386 # define DWARF_IS_VAL_LOC(l) 0
387 # define DWARF_VAL_LOC(c,v) DWARF_NULL_LOC
388 #endif
389
390 #define UNW_ALIGN(x,a) (((x)+(a)-1UL)&~((a)-1UL))
391
392 #endif /* libunwind_i_h */
393