include/asm-ia64/unwind.h

   1 #ifndef _ASM_IA64_UNWIND_H
   2 #define _ASM_IA64_UNWIND_H
   3
   4 /*
   5  * Copyright (C) 1999-2000 Hewlett-Packard Co
   6  * Copyright (C) 1999-2000 David Mosberger-Tang <davidm@hpl.hp.com>
   7  *
   8  * A simple API for unwinding kernel stacks.  This is used for
   9  * debugging and error reporting purposes.  The kernel doesn't need
  10  * full-blown stack unwinding with all the bells and whitles, so there
  11  * is not much point in implementing the full IA-64 unwind API (though
  12  * it would of course be possible to implement the kernel API on top
  13  * of it).
  14  */
  15
  16 struct task_struct;     /* forward declaration */
  17 struct switch_stack;    /* forward declaration */
  18
  19 enum unw_application_register {
  20         UNW_AR_BSP,
  21         UNW_AR_BSPSTORE,
  22         UNW_AR_PFS,
  23         UNW_AR_RNAT,
  24         UNW_AR_UNAT,
  25         UNW_AR_LC,
  26         UNW_AR_EC,
  27         UNW_AR_FPSR,
  28         UNW_AR_RSC,
  29         UNW_AR_CCV
  30 };
  31
  32 /*
  33  * The following declarations are private to the unwind
  34  * implementation:
  35  */
  36
  37 struct unw_stack {
  38         unsigned long limit;
  39         unsigned long top;
  40 };
  41
  42 #define UNW_FLAG_INTERRUPT_FRAME        (1UL << 0)
  43
  44 /*
  45  * No user of this module should every access this structure directly
  46  * as it is subject to change.  It is declared here solely so we can
  47  * use automatic variables.
  48  */
  49 struct unw_frame_info {
  50         struct unw_stack regstk;
  51         struct unw_stack memstk;
  52         unsigned int flags;
  53         short hint;
  54         short prev_script;
  55
  56         /* current frame info: */
  57         unsigned long bsp;              /* backing store pointer value */
  58         unsigned long sp;               /* stack pointer value */
  59         unsigned long psp;              /* previous sp value */
  60         unsigned long ip;               /* instruction pointer value */
  61         unsigned long pr;               /* current predicate values */
  62         unsigned long *cfm_loc;         /* cfm save location (or NULL) */
  63
  64         struct task_struct *task;
  65         struct switch_stack *sw;
  66
  67         /* preserved state: */
  68         unsigned long *bsp_loc;         /* previous bsp save location */
  69         unsigned long *bspstore_loc;
  70         unsigned long *pfs_loc;
  71         unsigned long *rnat_loc;
  72         unsigned long *rp_loc;
  73         unsigned long *pri_unat_loc;
  74         unsigned long *unat_loc;
  75         unsigned long *pr_loc;
  76         unsigned long *lc_loc;
  77         unsigned long *fpsr_loc;
  78         struct unw_ireg {
  79                 unsigned long *loc;
  80                 struct unw_ireg_nat {
  81                         long type : 3;                  /* enum unw_nat_type */
  82                         signed long off : 61;           /* NaT word is at loc+nat.off */
  83                 } nat;
  84         } r4, r5, r6, r7;
  85         unsigned long *b1_loc, *b2_loc, *b3_loc, *b4_loc, *b5_loc;
  86         struct ia64_fpreg *f2_loc, *f3_loc, *f4_loc, *f5_loc, *fr_loc[16];
  87 };
  88
  89 /*
  90  * The official API follows below:
  91  */
  92
  93 /*
  94  * Initialize unwind support.
  95  */
  96 extern void unw_init (void);
  97 extern void unw_create_gate_table (void);
  98
  99 extern void *unw_add_unwind_table (const char *name, unsigned long segment_base, unsigned long gp,
 100                                    const void *table_start, const void *table_end);
 101
 102 extern void unw_remove_unwind_table (void *handle);
 103
 104 /*
 105  * Prepare to unwind blocked task t.
 106  */
 107 extern void unw_init_from_blocked_task (struct unw_frame_info *info, struct task_struct *t);
 108
 109 extern void unw_init_frame_info (struct unw_frame_info *info, struct task_struct *t,
 110                                  struct switch_stack *sw);
 111
 112 /*
 113  * Prepare to unwind the currently running thread.
 114  */
 115 extern void unw_init_running (void (*callback)(struct unw_frame_info *info, void *arg), void *arg);
 116
 117 /*
 118  * Unwind to previous to frame.  Returns 0 if successful, negative
 119  * number in case of an error.
 120  */
 121 extern int unw_unwind (struct unw_frame_info *info);
 122
 123 /*
 124  * Unwind until the return pointer is in user-land (or until an error
 125  * occurs).  Returns 0 if successful, negative number in case of
 126  * error.
 127  */
 128 extern int unw_unwind_to_user (struct unw_frame_info *info);
 129
 130 #define unw_is_intr_frame(info) (((info)->flags & UNW_FLAG_INTERRUPT_FRAME) != 0)
 131
 132 static inline int
 133 unw_get_ip (struct unw_frame_info *info, unsigned long *valp)
 134 {
 135         *valp = (info)->ip;
 136         return 0;
 137 }
 138
 139 static inline int
 140 unw_get_sp (struct unw_frame_info *info, unsigned long *valp)
 141 {
 142         *valp = (info)->sp;
 143         return 0;
 144 }
 145
 146 static inline int
 147 unw_get_psp (struct unw_frame_info *info, unsigned long *valp)
 148 {
 149         *valp = (info)->psp;
 150         return 0;
 151 }
 152
 153 static inline int
 154 unw_get_bsp (struct unw_frame_info *info, unsigned long *valp)
 155 {
 156         *valp = (info)->bsp;
 157         return 0;
 158 }
 159
 160 static inline int
 161 unw_get_cfm (struct unw_frame_info *info, unsigned long *valp)
 162 {
 163         *valp = *(info)->cfm_loc;
 164         return 0;
 165 }
 166
 167 static inline int
 168 unw_set_cfm (struct unw_frame_info *info, unsigned long val)
 169 {
 170         *(info)->cfm_loc = val;
 171         return 0;
 172 }
 173
 174 static inline int
 175 unw_get_rp (struct unw_frame_info *info, unsigned long *val)
 176 {
 177         if (!info->rp_loc)
 178                 return -1;
 179         *val = *info->rp_loc;
 180         return 0;
 181 }
 182
 183 extern int unw_access_gr (struct unw_frame_info *, int, unsigned long *, char *, int);
 184 extern int unw_access_br (struct unw_frame_info *, int, unsigned long *, int);
 185 extern int unw_access_fr (struct unw_frame_info *, int, struct ia64_fpreg *, int);
 186 extern int unw_access_ar (struct unw_frame_info *, int, unsigned long *, int);
 187 extern int unw_access_pr (struct unw_frame_info *, unsigned long *, int);
 188
 189 static inline int
 190 unw_set_gr (struct unw_frame_info *i, int n, unsigned long v, char nat)
 191 {
 192         return unw_access_gr(i, n, &v, &nat, 1);
 193 }
 194
 195 static inline int
 196 unw_set_br (struct unw_frame_info *i, int n, unsigned long v)
 197 {
 198         return unw_access_br(i, n, &v, 1);
 199 }
 200
 201 static inline int
 202 unw_set_fr (struct unw_frame_info *i, int n, struct ia64_fpreg v)
 203 {
 204         return unw_access_fr(i, n, &v, 1);
 205 }
 206
 207 static inline int
 208 unw_set_ar (struct unw_frame_info *i, int n, unsigned long v)
 209 {
 210         return unw_access_ar(i, n, &v, 1);
 211 }
 212
 213 static inline int
 214 unw_set_pr (struct unw_frame_info *i, unsigned long v)
 215 {
 216         return unw_access_pr(i, &v, 1);
 217 }
 218
 219 #define unw_get_gr(i,n,v,nat)   unw_access_gr(i,n,v,nat,0)
 220 #define unw_get_br(i,n,v)       unw_access_br(i,n,v,0)
 221 #define unw_get_fr(i,n,v)       unw_access_fr(i,n,v,0)
 222 #define unw_get_ar(i,n,v)       unw_access_ar(i,n,v,0)
 223 #define unw_get_pr(i,v)         unw_access_pr(i,v,0)
 224
 225 #endif /* _ASM_UNWIND_H */