1 /* Frame unwinder for ia64 frames using the libunwind library.
3 Copyright (C) 2003-2017 Free Software Foundation, Inc.
5 Written by Jeff Johnston, contributed by Red Hat Inc.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
26 #include "frame-base.h"
27 #include "frame-unwind.h"
36 #include "ia64-libunwind-tdep.h"
38 #include "complaints.h"
40 /* IA-64 is the only target that currently uses ia64-libunwind-tdep.
41 Note how UNW_TARGET, UNW_OBJ, etc. are compile time constants below.
42 Those come from libunwind's headers, and are target dependent.
43 Also, some of libunwind's typedefs are target dependent, as e.g.,
44 unw_word_t. If some other target wants to use this, we will need
45 to do some abstracting in order to make it possible to select which
46 libunwind we're talking to at runtime (and have one per arch). */
48 /* The following two macros are normally defined in <endian.h>.
49 But systems such as ia64-hpux do not provide such header, so
50 we just define them here if not already defined. */
51 #ifndef __LITTLE_ENDIAN
52 #define __LITTLE_ENDIAN 1234
55 #define __BIG_ENDIAN 4321
58 static int libunwind_initialized;
59 static struct gdbarch_data *libunwind_descr_handle;
61 /* Required function pointers from libunwind. */
62 typedef int (unw_get_reg_p_ftype) (unw_cursor_t *, unw_regnum_t, unw_word_t *);
63 static unw_get_reg_p_ftype *unw_get_reg_p;
64 typedef int (unw_get_fpreg_p_ftype) (unw_cursor_t *, unw_regnum_t,
66 static unw_get_fpreg_p_ftype *unw_get_fpreg_p;
67 typedef int (unw_get_saveloc_p_ftype) (unw_cursor_t *, unw_regnum_t,
69 static unw_get_saveloc_p_ftype *unw_get_saveloc_p;
70 typedef int (unw_is_signal_frame_p_ftype) (unw_cursor_t *);
71 static unw_is_signal_frame_p_ftype *unw_is_signal_frame_p;
72 typedef int (unw_step_p_ftype) (unw_cursor_t *);
73 static unw_step_p_ftype *unw_step_p;
74 typedef int (unw_init_remote_p_ftype) (unw_cursor_t *, unw_addr_space_t,
76 static unw_init_remote_p_ftype *unw_init_remote_p;
77 typedef unw_addr_space_t (unw_create_addr_space_p_ftype) (unw_accessors_t *,
79 static unw_create_addr_space_p_ftype *unw_create_addr_space_p;
80 typedef void (unw_destroy_addr_space_p_ftype) (unw_addr_space_t);
81 static unw_destroy_addr_space_p_ftype *unw_destroy_addr_space_p;
82 typedef int (unw_search_unwind_table_p_ftype) (unw_addr_space_t, unw_word_t,
84 unw_proc_info_t *, int, void *);
85 static unw_search_unwind_table_p_ftype *unw_search_unwind_table_p;
86 typedef unw_word_t (unw_find_dyn_list_p_ftype) (unw_addr_space_t,
87 unw_dyn_info_t *, void *);
88 static unw_find_dyn_list_p_ftype *unw_find_dyn_list_p;
91 struct libunwind_frame_cache
99 /* We need to qualify the function names with a platform-specific prefix
100 to match the names used by the libunwind library. The UNW_OBJ macro is
101 provided by the libunwind.h header file. */
102 #define STRINGIFY2(name) #name
103 #define STRINGIFY(name) STRINGIFY2(name)
106 /* Use the stable ABI major version number. `libunwind-ia64.so' is a link time
107 only library, not a runtime one. */
108 #define LIBUNWIND_SO "libunwind-" STRINGIFY(UNW_TARGET) ".so.8"
110 /* Provide also compatibility with older .so. The two APIs are compatible, .8
111 is only extended a bit, GDB does not use the extended API at all. */
112 #define LIBUNWIND_SO_7 "libunwind-" STRINGIFY(UNW_TARGET) ".so.7"
115 static char *get_reg_name = STRINGIFY(UNW_OBJ(get_reg));
116 static char *get_fpreg_name = STRINGIFY(UNW_OBJ(get_fpreg));
117 static char *get_saveloc_name = STRINGIFY(UNW_OBJ(get_save_loc));
118 static char *is_signal_frame_name = STRINGIFY(UNW_OBJ(is_signal_frame));
119 static char *step_name = STRINGIFY(UNW_OBJ(step));
120 static char *init_remote_name = STRINGIFY(UNW_OBJ(init_remote));
121 static char *create_addr_space_name = STRINGIFY(UNW_OBJ(create_addr_space));
122 static char *destroy_addr_space_name = STRINGIFY(UNW_OBJ(destroy_addr_space));
123 static char *search_unwind_table_name
124 = STRINGIFY(UNW_OBJ(search_unwind_table));
125 static char *find_dyn_list_name = STRINGIFY(UNW_OBJ(find_dyn_list));
127 static struct libunwind_descr *
128 libunwind_descr (struct gdbarch *gdbarch)
130 return ((struct libunwind_descr *)
131 gdbarch_data (gdbarch, libunwind_descr_handle));
135 libunwind_descr_init (struct gdbarch *gdbarch)
137 struct libunwind_descr *descr
138 = GDBARCH_OBSTACK_ZALLOC (gdbarch, struct libunwind_descr);
144 libunwind_frame_set_descr (struct gdbarch *gdbarch,
145 struct libunwind_descr *descr)
147 struct libunwind_descr *arch_descr;
149 gdb_assert (gdbarch != NULL);
151 arch_descr = ((struct libunwind_descr *)
152 gdbarch_data (gdbarch, libunwind_descr_handle));
154 if (arch_descr == NULL)
156 /* First time here. Must initialize data area. */
157 arch_descr = (struct libunwind_descr *) libunwind_descr_init (gdbarch);
158 deprecated_set_gdbarch_data (gdbarch,
159 libunwind_descr_handle, arch_descr);
162 /* Copy new descriptor info into arch descriptor. */
163 arch_descr->gdb2uw = descr->gdb2uw;
164 arch_descr->uw2gdb = descr->uw2gdb;
165 arch_descr->is_fpreg = descr->is_fpreg;
166 arch_descr->accessors = descr->accessors;
167 arch_descr->special_accessors = descr->special_accessors;
170 static struct libunwind_frame_cache *
171 libunwind_frame_cache (struct frame_info *this_frame, void **this_cache)
173 unw_accessors_t *acc;
176 unw_regnum_t uw_sp_regnum;
177 struct libunwind_frame_cache *cache;
178 struct libunwind_descr *descr;
179 struct gdbarch *gdbarch = get_frame_arch (this_frame);
183 return (struct libunwind_frame_cache *) *this_cache;
185 /* Allocate a new cache. */
186 cache = FRAME_OBSTACK_ZALLOC (struct libunwind_frame_cache);
188 cache->func_addr = get_frame_func (this_frame);
189 if (cache->func_addr == 0)
190 /* This can happen when the frame corresponds to a function for which
191 there is no debugging information nor any entry in the symbol table.
192 This is probably a static function for which an entry in the symbol
193 table was not created when the objfile got linked (observed in
194 libpthread.so on ia64-hpux).
196 The best we can do, in that case, is use the frame PC as the function
197 address. We don't need to give up since we still have the unwind
198 record to help us perform the unwinding. There is also another
199 compelling to continue, because abandonning now means stopping
200 the backtrace, which can never be helpful for the user. */
201 cache->func_addr = get_frame_pc (this_frame);
203 /* Get a libunwind cursor to the previous frame.
205 We do this by initializing a cursor. Libunwind treats a new cursor
206 as the top of stack and will get the current register set via the
207 libunwind register accessor. Now, we provide the platform-specific
208 accessors and we set up the register accessor to use the frame
209 register unwinding interfaces so that we properly get the registers
210 for the current frame rather than the top. We then use the unw_step
211 function to move the libunwind cursor back one frame. We can later
212 use this cursor to find previous registers via the unw_get_reg
213 interface which will invoke libunwind's special logic. */
214 descr = libunwind_descr (gdbarch);
215 acc = (unw_accessors_t *) descr->accessors;
216 as = unw_create_addr_space_p (acc,
217 gdbarch_byte_order (gdbarch)
222 unw_init_remote_p (&cache->cursor, as, this_frame);
223 if (unw_step_p (&cache->cursor) < 0)
225 unw_destroy_addr_space_p (as);
229 /* To get base address, get sp from previous frame. */
230 uw_sp_regnum = descr->gdb2uw (gdbarch_sp_regnum (gdbarch));
231 ret = unw_get_reg_p (&cache->cursor, uw_sp_regnum, &fp);
234 unw_destroy_addr_space_p (as);
235 error (_("Can't get libunwind sp register."));
238 cache->base = (CORE_ADDR)fp;
246 libunwind_frame_dealloc_cache (struct frame_info *self, void *this_cache)
248 struct libunwind_frame_cache *cache
249 = (struct libunwind_frame_cache *) this_cache;
252 unw_destroy_addr_space_p (cache->as);
256 libunwind_find_dyn_list (unw_addr_space_t as, unw_dyn_info_t *di, void *arg)
258 return unw_find_dyn_list_p (as, di, arg);
261 /* Verify if there is sufficient libunwind information for the frame to use
262 libunwind frame unwinding. */
264 libunwind_frame_sniffer (const struct frame_unwind *self,
265 struct frame_info *this_frame, void **this_cache)
268 unw_accessors_t *acc;
270 struct libunwind_descr *descr;
271 struct gdbarch *gdbarch = get_frame_arch (this_frame);
274 /* To test for libunwind unwind support, initialize a cursor to
275 the current frame and try to back up. We use this same method
276 when setting up the frame cache (see libunwind_frame_cache()).
277 If libunwind returns success for this operation, it means that
278 it has found sufficient libunwind unwinding information to do so. */
280 descr = libunwind_descr (gdbarch);
281 acc = (unw_accessors_t *) descr->accessors;
282 as = unw_create_addr_space_p (acc,
283 gdbarch_byte_order (gdbarch)
288 ret = unw_init_remote_p (&cursor, as, this_frame);
292 unw_destroy_addr_space_p (as);
297 /* Check to see if we have libunwind info by checking if we are in a
298 signal frame. If it doesn't return an error, we have libunwind info
299 and can use libunwind. */
300 ret = unw_is_signal_frame_p (&cursor);
301 unw_destroy_addr_space_p (as);
310 libunwind_frame_this_id (struct frame_info *this_frame, void **this_cache,
311 struct frame_id *this_id)
313 struct libunwind_frame_cache *cache =
314 libunwind_frame_cache (this_frame, this_cache);
317 (*this_id) = frame_id_build (cache->base, cache->func_addr);
321 libunwind_frame_prev_register (struct frame_info *this_frame,
322 void **this_cache, int regnum)
324 struct libunwind_frame_cache *cache =
325 libunwind_frame_cache (this_frame, this_cache);
326 struct gdbarch *gdbarch = get_frame_arch (this_frame);
334 unw_regnum_t uw_regnum;
335 struct libunwind_descr *descr;
336 struct value *val = NULL;
339 return frame_unwind_got_constant (this_frame, regnum, 0);
341 /* Convert from gdb register number to libunwind register number. */
342 descr = libunwind_descr (get_frame_arch (this_frame));
343 uw_regnum = descr->gdb2uw (regnum);
345 gdb_assert (regnum >= 0);
347 if (!target_has_registers)
348 error (_("No registers."));
351 return frame_unwind_got_constant (this_frame, regnum, 0);
353 if (unw_get_saveloc_p (&cache->cursor, uw_regnum, &sl) < 0)
354 return frame_unwind_got_constant (this_frame, regnum, 0);
359 val = frame_unwind_got_memory (this_frame, regnum, sl.u.addr);
363 val = frame_unwind_got_register (this_frame, regnum,
364 descr->uw2gdb (sl.u.regnum));
368 /* The register is not stored at a specific memory address nor
369 inside another register. So use libunwind to fetch the register
370 value for us, and create a constant value with the result. */
371 if (descr->is_fpreg (uw_regnum))
373 ret = unw_get_fpreg_p (&cache->cursor, uw_regnum, &fpval);
375 return frame_unwind_got_constant (this_frame, regnum, 0);
376 val = frame_unwind_got_bytes (this_frame, regnum,
377 (gdb_byte *) &fpval);
381 ret = unw_get_reg_p (&cache->cursor, uw_regnum, &intval);
383 return frame_unwind_got_constant (this_frame, regnum, 0);
384 val = frame_unwind_got_constant (this_frame, regnum, intval);
393 /* The following is a glue routine to call the libunwind unwind table
394 search function to get unwind information for a specified ip address. */
396 libunwind_search_unwind_table (void *as, long ip, void *di,
397 void *pi, int need_unwind_info, void *args)
399 return unw_search_unwind_table_p (*(unw_addr_space_t *) as, (unw_word_t) ip,
400 (unw_dyn_info_t *) di,
401 (unw_proc_info_t *) pi, need_unwind_info,
405 /* Verify if we are in a sigtramp frame and we can use libunwind to unwind. */
407 libunwind_sigtramp_frame_sniffer (const struct frame_unwind *self,
408 struct frame_info *this_frame,
412 unw_accessors_t *acc;
414 struct libunwind_descr *descr;
415 struct gdbarch *gdbarch = get_frame_arch (this_frame);
418 /* To test for libunwind unwind support, initialize a cursor to the
419 current frame and try to back up. We use this same method when
420 setting up the frame cache (see libunwind_frame_cache()). If
421 libunwind returns success for this operation, it means that it
422 has found sufficient libunwind unwinding information to do
425 descr = libunwind_descr (gdbarch);
426 acc = (unw_accessors_t *) descr->accessors;
427 as = unw_create_addr_space_p (acc,
428 gdbarch_byte_order (gdbarch)
433 ret = unw_init_remote_p (&cursor, as, this_frame);
437 unw_destroy_addr_space_p (as);
441 /* Check to see if we are in a signal frame. */
442 ret = unw_is_signal_frame_p (&cursor);
443 unw_destroy_addr_space_p (as);
450 /* The following routine is for accessing special registers of the top frame.
451 A special set of accessors must be given that work without frame info.
452 This is used by ia64 to access the rse registers r32-r127. While they
453 are usually located at BOF, this is not always true and only the libunwind
454 info can decipher where they actually are. */
456 libunwind_get_reg_special (struct gdbarch *gdbarch, struct regcache *regcache,
457 int regnum, void *buf)
460 unw_accessors_t *acc;
462 struct libunwind_descr *descr;
464 unw_regnum_t uw_regnum;
470 descr = libunwind_descr (gdbarch);
471 acc = (unw_accessors_t *) descr->special_accessors;
472 as = unw_create_addr_space_p (acc,
473 gdbarch_byte_order (gdbarch)
478 ret = unw_init_remote_p (&cursor, as, regcache);
481 unw_destroy_addr_space_p (as);
485 uw_regnum = descr->gdb2uw (regnum);
487 if (descr->is_fpreg (uw_regnum))
489 ret = unw_get_fpreg_p (&cursor, uw_regnum, &fpval);
494 ret = unw_get_reg_p (&cursor, uw_regnum, &intval);
498 unw_destroy_addr_space_p (as);
504 memcpy (buf, ptr, register_size (gdbarch, regnum));
510 libunwind_load (void)
513 char *so_error = NULL;
515 handle = dlopen (LIBUNWIND_SO, RTLD_NOW);
518 so_error = xstrdup (dlerror ());
519 #ifdef LIBUNWIND_SO_7
520 handle = dlopen (LIBUNWIND_SO_7, RTLD_NOW);
521 #endif /* LIBUNWIND_SO_7 */
525 fprintf_unfiltered (gdb_stderr, _("[GDB failed to load %s: %s]\n"),
526 LIBUNWIND_SO, so_error);
527 #ifdef LIBUNWIND_SO_7
528 fprintf_unfiltered (gdb_stderr, _("[GDB failed to load %s: %s]\n"),
529 LIBUNWIND_SO_7, dlerror ());
530 #endif /* LIBUNWIND_SO_7 */
536 /* Initialize pointers to the dynamic library functions we will use. */
538 unw_get_reg_p = (unw_get_reg_p_ftype *) dlsym (handle, get_reg_name);
539 if (unw_get_reg_p == NULL)
542 unw_get_fpreg_p = (unw_get_fpreg_p_ftype *) dlsym (handle, get_fpreg_name);
543 if (unw_get_fpreg_p == NULL)
547 = (unw_get_saveloc_p_ftype *) dlsym (handle, get_saveloc_name);
548 if (unw_get_saveloc_p == NULL)
551 unw_is_signal_frame_p
552 = (unw_is_signal_frame_p_ftype *) dlsym (handle, is_signal_frame_name);
553 if (unw_is_signal_frame_p == NULL)
556 unw_step_p = (unw_step_p_ftype *) dlsym (handle, step_name);
557 if (unw_step_p == NULL)
561 = (unw_init_remote_p_ftype *) dlsym (handle, init_remote_name);
562 if (unw_init_remote_p == NULL)
565 unw_create_addr_space_p
566 = (unw_create_addr_space_p_ftype *) dlsym (handle, create_addr_space_name);
567 if (unw_create_addr_space_p == NULL)
570 unw_destroy_addr_space_p
571 = (unw_destroy_addr_space_p_ftype *) dlsym (handle,
572 destroy_addr_space_name);
573 if (unw_destroy_addr_space_p == NULL)
576 unw_search_unwind_table_p
577 = (unw_search_unwind_table_p_ftype *) dlsym (handle,
578 search_unwind_table_name);
579 if (unw_search_unwind_table_p == NULL)
583 = (unw_find_dyn_list_p_ftype *) dlsym (handle, find_dyn_list_name);
584 if (unw_find_dyn_list_p == NULL)
591 libunwind_is_initialized (void)
593 return libunwind_initialized;
596 /* Provide a prototype to silence -Wmissing-prototypes. */
597 void _initialize_libunwind_frame (void);
600 _initialize_libunwind_frame (void)
602 libunwind_descr_handle
603 = gdbarch_data_register_post_init (libunwind_descr_init);
605 libunwind_initialized = libunwind_load ();