include/tdep-x86_64/libunwind_i.h

   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
   7 This file is part of libunwind.
   8
   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:
  16
  17 The above copyright notice and this permission notice shall be
  18 included in all copies or substantial portions of the Software.
  19
  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.  */
  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
  41 typedef enum
  42   {
  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 */
  47   }
  48 unw_tdep_frame_type_t;
  49
  50 typedef struct
  51   {
  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) */
  59   }
  60 unw_tdep_frame_t;
  61
  62 struct unw_addr_space
  63   {
  64     struct unw_accessors acc;
  65     unw_caching_policy_t caching_policy;
  66 #ifdef HAVE_ATOMIC_OPS_H
  67     AO_t cache_generation;
  68 #else
  69     uint32_t cache_generation;
  70 #endif
  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;
  75    };
  76
  77 struct cursor
  78   {
  79     struct dwarf_cursor dwarf;          /* must be first */
  80
  81     unw_tdep_frame_t frame_info;        /* quick tracing assist info */
  82
  83     /* Format of sigcontext structure and address at which it is
  84        stored: */
  85     enum
  86       {
  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 */
  91       }
  92     sigcontext_format;
  93     unw_word_t sigcontext_addr;
  94     int validate;
  95     ucontext_t *uc;
  96   };
  97
  98 static inline ucontext_t *
  99 dwarf_get_uc(const struct dwarf_cursor *cursor)
 100 {
 101   const struct cursor *c = (struct cursor *) cursor->as_arg;
 102   return c->uc;
 103 }
 104
 105 #define DWARF_GET_LOC(l)        ((l).val)
 106 # define DWARF_LOC_TYPE_MEM     (0 << 0)
 107 # define DWARF_LOC_TYPE_FP      (1 << 0)
 108 # define DWARF_LOC_TYPE_REG     (1 << 1)
 109 # define DWARF_LOC_TYPE_VAL     (1 << 2)
 110
 111 # define DWARF_IS_REG_LOC(l)    (((l).type & DWARF_LOC_TYPE_REG) != 0)
 112 # define DWARF_IS_FP_LOC(l)     (((l).type & DWARF_LOC_TYPE_FP) != 0)
 113 # define DWARF_IS_MEM_LOC(l)    ((l).type == DWARF_LOC_TYPE_MEM)
 114 # define DWARF_IS_VAL_LOC(l)    (((l).type & DWARF_LOC_TYPE_VAL) != 0)
 115
 116 # define DWARF_LOC(r, t)        ((dwarf_loc_t) { .val = (r), .type = (t) })
 117 # define DWARF_VAL_LOC(c,v)     DWARF_LOC ((v), DWARF_LOC_TYPE_VAL)
 118 # define DWARF_MEM_LOC(c,m)     DWARF_LOC ((m), DWARF_LOC_TYPE_MEM)
 119
 120 #ifdef UNW_LOCAL_ONLY
 121 # define DWARF_NULL_LOC         DWARF_LOC (0, 0)
 122 # define DWARF_IS_NULL_LOC(l)   (DWARF_GET_LOC (l) == 0)
 123 # define DWARF_REG_LOC(c,r)     (DWARF_LOC((unw_word_t)                      \
 124                                  x86_64_r_uc_addr(dwarf_get_uc(c), (r)), 0))
 125 # define DWARF_FPREG_LOC(c,r)   (DWARF_LOC((unw_word_t)                      \
 126                                  x86_64_r_uc_addr(dwarf_get_uc(c), (r)), 0))
 127
 128 #else /* !UNW_LOCAL_ONLY */
 129
 130 # define DWARF_NULL_LOC         DWARF_LOC (0, 0)
 131 # define DWARF_IS_NULL_LOC(l)                                           \
 132                 ({ dwarf_loc_t _l = (l); _l.val == 0 && _l.type == 0; })
 133 # define DWARF_REG_LOC(c,r)     DWARF_LOC((r), DWARF_LOC_TYPE_REG)
 134 # define DWARF_FPREG_LOC(c,r)   DWARF_LOC((r), (DWARF_LOC_TYPE_REG      \
 135                                                 | DWARF_LOC_TYPE_FP))
 136
 137 #endif /* !UNW_LOCAL_ONLY */
 138
 139 static inline int
 140 dwarf_getfp (struct dwarf_cursor *c, dwarf_loc_t loc, unw_fpreg_t *val)
 141 {
 142   if (DWARF_IS_NULL_LOC (loc))
 143     return -UNW_EBADREG;
 144
 145   abort ();
 146 }
 147
 148 static inline int
 149 dwarf_putfp (struct dwarf_cursor *c, dwarf_loc_t loc, unw_fpreg_t val)
 150 {
 151   if (DWARF_IS_NULL_LOC (loc))
 152     return -UNW_EBADREG;
 153
 154   abort ();
 155 }
 156
 157 static inline int
 158 dwarf_get (struct dwarf_cursor *c, dwarf_loc_t loc, unw_word_t *val)
 159 {
 160   if (DWARF_IS_NULL_LOC (loc))
 161     return -UNW_EBADREG;
 162
 163   if (DWARF_IS_REG_LOC (loc))
 164     return (*c->as->acc.access_reg) (c->as, DWARF_GET_LOC (loc), val,
 165                                      0, c->as_arg);
 166   if (DWARF_IS_MEM_LOC (loc))
 167     return (*c->as->acc.access_mem) (c->as, DWARF_GET_LOC (loc), val,
 168                                      0, c->as_arg);
 169   assert(DWARF_IS_VAL_LOC (loc));
 170   *val = DWARF_GET_LOC (loc);
 171   return 0;
 172 }
 173
 174 static inline int
 175 dwarf_put (struct dwarf_cursor *c, dwarf_loc_t loc, unw_word_t val)
 176 {
 177   assert(!DWARF_IS_VAL_LOC (loc));
 178
 179   if (DWARF_IS_NULL_LOC (loc))
 180     return -UNW_EBADREG;
 181
 182   if (DWARF_IS_REG_LOC (loc))
 183     return (*c->as->acc.access_reg) (c->as, DWARF_GET_LOC (loc), &val,
 184                                      1, c->as_arg);
 185   else
 186     return (*c->as->acc.access_mem) (c->as, DWARF_GET_LOC (loc), &val,
 187                                      1, c->as_arg);
 188 }
 189
 190 #define tdep_getcontext_trace           UNW_ARCH_OBJ(getcontext_trace)
 191 #define tdep_init_done                  UNW_OBJ(init_done)
 192 #define tdep_init_mem_validate          UNW_OBJ(init_mem_validate)
 193 #define tdep_init                       UNW_OBJ(init)
 194 /* Platforms that support UNW_INFO_FORMAT_TABLE need to define
 195    tdep_search_unwind_table.  */
 196 #define tdep_search_unwind_table        dwarf_search_unwind_table
 197 #define tdep_find_unwind_table          dwarf_find_unwind_table
 198 #define tdep_get_elf_image              UNW_ARCH_OBJ(get_elf_image)
 199 #define tdep_access_reg                 UNW_OBJ(access_reg)
 200 #define tdep_access_fpreg               UNW_OBJ(access_fpreg)
 201 #if __linux__
 202 # define tdep_fetch_frame               UNW_OBJ(fetch_frame)
 203 # define tdep_cache_frame               UNW_OBJ(cache_frame)
 204 # define tdep_reuse_frame               UNW_OBJ(reuse_frame)
 205 #else
 206 # define tdep_fetch_frame(c,ip,n)       do {} while(0)
 207 # define tdep_cache_frame(c,rs)         do {} while(0)
 208 # define tdep_reuse_frame(c,rs)         do {} while(0)
 209 #endif
 210 #define tdep_stash_frame                UNW_OBJ(stash_frame)
 211 #define tdep_trace                      UNW_OBJ(tdep_trace)
 212 #define x86_64_r_uc_addr                UNW_OBJ(r_uc_addr)
 213
 214 #ifdef UNW_LOCAL_ONLY
 215 # define tdep_find_proc_info(c,ip,n)                            \
 216         dwarf_find_proc_info((c)->as, (ip), &(c)->pi, (n),      \
 217                                        (c)->as_arg)
 218 # define tdep_put_unwind_info(as,pi,arg)                \
 219         dwarf_put_unwind_info((as), (pi), (arg))
 220 #else
 221 # define tdep_find_proc_info(c,ip,n)                                    \
 222         (*(c)->as->acc.find_proc_info)((c)->as, (ip), &(c)->pi, (n),    \
 223                                        (c)->as_arg)
 224 # define tdep_put_unwind_info(as,pi,arg)                        \
 225         (*(as)->acc.put_unwind_info)((as), (pi), (arg))
 226 #endif
 227
 228 #define tdep_get_as(c)                  ((c)->dwarf.as)
 229 #define tdep_get_as_arg(c)              ((c)->dwarf.as_arg)
 230 #define tdep_get_ip(c)                  ((c)->dwarf.ip)
 231 #define tdep_big_endian(as)             0
 232
 233 extern int tdep_init_done;
 234
 235 extern void tdep_init (void);
 236 extern void tdep_init_mem_validate (void);
 237 extern int tdep_search_unwind_table (unw_addr_space_t as, unw_word_t ip,
 238                                      unw_dyn_info_t *di, unw_proc_info_t *pi,
 239                                      int need_unwind_info, void *arg);
 240 extern void *x86_64_r_uc_addr (ucontext_t *uc, int reg);
 241 extern int tdep_get_elf_image (struct elf_image *ei, pid_t pid, unw_word_t ip,
 242                                unsigned long *segbase, unsigned long *mapoff,
 243                                char *path, size_t pathlen);
 244 extern int tdep_access_reg (struct cursor *c, unw_regnum_t reg,
 245                             unw_word_t *valp, int write);
 246 extern int tdep_access_fpreg (struct cursor *c, unw_regnum_t reg,
 247                               unw_fpreg_t *valp, int write);
 248 #if __linux__
 249 extern void tdep_fetch_frame (struct dwarf_cursor *c, unw_word_t ip,
 250                               int need_unwind_info);
 251 extern void tdep_cache_frame (struct dwarf_cursor *c,
 252                               struct dwarf_reg_state *rs);
 253 extern void tdep_reuse_frame (struct dwarf_cursor *c,
 254                               struct dwarf_reg_state *rs);
 255 extern void tdep_stash_frame (struct dwarf_cursor *c,
 256                               struct dwarf_reg_state *rs);
 257 #endif
 258
 259 extern int tdep_getcontext_trace (unw_tdep_context_t *);
 260 extern int tdep_trace (unw_cursor_t *cursor, void **addresses, int *n);
 261
 262 #endif /* X86_64_LIBUNWIND_I_H */