include/libunwind-aarch64.h

   1 /* libunwind - a platform-independent unwind library
   2    Copyright (C) 2001-2004 Hewlett-Packard Co
   3         Contributed by David Mosberger-Tang <davidm@hpl.hp.com>
   4    Copyright (C) 2013 Linaro Limited
   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 #ifndef LIBUNWIND_H
  28 #define LIBUNWIND_H
  29
  30 #if defined(__cplusplus) || defined(c_plusplus)
  31 extern "C" {
  32 #endif
  33
  34 #include <inttypes.h>
  35 #include <stddef.h>
  36 #include <ucontext.h>
  37
  38 #define UNW_TARGET      aarch64
  39 #define UNW_TARGET_AARCH64      1
  40
  41 #define _U_TDEP_QP_TRUE 0       /* see libunwind-dynamic.h  */
  42
  43 /* This needs to be big enough to accommodate "struct cursor", while
  44    leaving some slack for future expansion.  Changing this value will
  45    require recompiling all users of this library.  Stack allocation is
  46    relatively cheap and unwind-state copying is relatively rare, so we
  47    want to err on making it rather too big than too small.  */
  48
  49 #define UNW_TDEP_CURSOR_LEN     512
  50
  51 typedef uint64_t unw_word_t;
  52 typedef int64_t unw_sword_t;
  53
  54 typedef long double unw_tdep_fpreg_t;
  55
  56 typedef struct
  57   {
  58     /* no aarch64-specific auxiliary proc-info */
  59   }
  60 unw_tdep_proc_info_t;
  61
  62 typedef enum
  63   {
  64     /* 64-bit general registers.  */
  65     UNW_AARCH64_X0,
  66     UNW_AARCH64_X1,
  67     UNW_AARCH64_X2,
  68     UNW_AARCH64_X3,
  69     UNW_AARCH64_X4,
  70     UNW_AARCH64_X5,
  71     UNW_AARCH64_X6,
  72     UNW_AARCH64_X7,
  73     UNW_AARCH64_X8,
  74
  75     /* Temporary registers.  */
  76     UNW_AARCH64_X9,
  77     UNW_AARCH64_X10,
  78     UNW_AARCH64_X11,
  79     UNW_AARCH64_X12,
  80     UNW_AARCH64_X13,
  81     UNW_AARCH64_X14,
  82     UNW_AARCH64_X15,
  83
  84     /* Intra-procedure-call temporary registers.  */
  85     UNW_AARCH64_X16,
  86     UNW_AARCH64_X17,
  87
  88     /* Callee-saved registers.  */
  89     UNW_AARCH64_X18,
  90     UNW_AARCH64_X19,
  91     UNW_AARCH64_X20,
  92     UNW_AARCH64_X21,
  93     UNW_AARCH64_X22,
  94     UNW_AARCH64_X23,
  95     UNW_AARCH64_X24,
  96     UNW_AARCH64_X25,
  97     UNW_AARCH64_X26,
  98     UNW_AARCH64_X27,
  99     UNW_AARCH64_X28,
 100
 101     /* 64-bit frame pointer.  */
 102     UNW_AARCH64_X29,
 103
 104     /* 64-bit link register.  */
 105     UNW_AARCH64_X30,
 106
 107     /* 64-bit stack pointer.  */
 108     UNW_AARCH64_SP =  31,
 109     UNW_AARCH64_PC,
 110     UNW_AARCH64_PSTATE,
 111
 112     /* 128-bit FP/Advanced SIMD registers.  */
 113     UNW_AARCH64_V0 = 64,
 114     UNW_AARCH64_V1,
 115     UNW_AARCH64_V2,
 116     UNW_AARCH64_V3,
 117     UNW_AARCH64_V4,
 118     UNW_AARCH64_V5,
 119     UNW_AARCH64_V6,
 120     UNW_AARCH64_V7,
 121     UNW_AARCH64_V8,
 122     UNW_AARCH64_V9,
 123     UNW_AARCH64_V10,
 124     UNW_AARCH64_V11,
 125     UNW_AARCH64_V12,
 126     UNW_AARCH64_V13,
 127     UNW_AARCH64_V14,
 128     UNW_AARCH64_V15,
 129     UNW_AARCH64_V16,
 130     UNW_AARCH64_V17,
 131     UNW_AARCH64_V18,
 132     UNW_AARCH64_V19,
 133     UNW_AARCH64_V20,
 134     UNW_AARCH64_V21,
 135     UNW_AARCH64_V22,
 136     UNW_AARCH64_V23,
 137     UNW_AARCH64_V24,
 138     UNW_AARCH64_V25,
 139     UNW_AARCH64_V26,
 140     UNW_AARCH64_V27,
 141     UNW_AARCH64_V28,
 142     UNW_AARCH64_V29,
 143     UNW_AARCH64_V30,
 144     UNW_AARCH64_V31,
 145
 146     UNW_AARCH64_FPSR,
 147     UNW_AARCH64_FPCR,
 148
 149     /* For AArch64, the CFA is the value of SP (x31) at the call site of the
 150        previous frame.  */
 151     UNW_AARCH64_CFA = UNW_AARCH64_SP,
 152
 153     UNW_TDEP_LAST_REG = UNW_AARCH64_FPCR,
 154
 155     UNW_TDEP_IP = UNW_AARCH64_X30,
 156     UNW_TDEP_SP = UNW_AARCH64_SP,
 157     UNW_TDEP_EH = UNW_AARCH64_X0,
 158
 159   }
 160 aarch64_regnum_t;
 161
 162 /* Use R0 through R3 to pass exception handling information.  */
 163 #define UNW_TDEP_NUM_EH_REGS    4
 164
 165 typedef struct unw_tdep_save_loc
 166   {
 167     /* Additional target-dependent info on a save location.  */
 168   }
 169 unw_tdep_save_loc_t;
 170
 171
 172 /* On AArch64, we can directly use ucontext_t as the unwind context.  */
 173 typedef ucontext_t unw_tdep_context_t;
 174
 175 #include "libunwind-common.h"
 176 #include "libunwind-dynamic.h"
 177
 178 #define unw_tdep_getcontext(uc) (({                                     \
 179   unw_tdep_context_t *unw_ctx = (uc);                                   \
 180   register uint64_t *unw_base asm ("x0") = (uint64_t*) unw_ctx->uc_mcontext.regs;               \
 181   __asm__ __volatile__ (                                                \
 182      "stp x0, x1, [%[base], #0]\n" \
 183      "stp x2, x3, [%[base], #16]\n" \
 184      "stp x4, x5, [%[base], #32]\n" \
 185      "stp x6, x7, [%[base], #48]\n" \
 186      "stp x8, x9, [%[base], #64]\n" \
 187      "stp x10, x11, [%[base], #80]\n" \
 188      "stp x12, x13, [%[base], #96]\n" \
 189      "stp x14, x13, [%[base], #112]\n" \
 190      "stp x16, x17, [%[base], #128]\n" \
 191      "stp x18, x19, [%[base], #144]\n" \
 192      "stp x20, x21, [%[base], #160]\n" \
 193      "stp x22, x23, [%[base], #176]\n" \
 194      "stp x24, x25, [%[base], #192]\n" \
 195      "stp x26, x27, [%[base], #208]\n" \
 196      "stp x28, x29, [%[base], #224]\n" \
 197      "str x30, [%[base], #240]\n" \
 198      "mov x1, sp\n" \
 199      "stp x1, x30, [%[base], #248]\n" \
 200      : [base] "+r" (unw_base) : : "x1", "memory"); \
 201   }), 0)
 202 #define unw_tdep_is_fpreg               UNW_ARCH_OBJ(is_fpreg)
 203
 204 extern int unw_tdep_is_fpreg (int);
 205
 206 #if defined(__cplusplus) || defined(c_plusplus)
 207 }
 208 #endif
 209
 210 #endif /* LIBUNWIND_H */