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         unsigned long pt;               /* struct pt_regs location */
  64
  65         struct task_struct *task;
  66         struct switch_stack *sw;
  67
  68         /* preserved state: */
  69         unsigned long *bsp_loc;         /* previous bsp save location */
  70         unsigned long *bspstore_loc;
  71         unsigned long *pfs_loc;
  72         unsigned long *rnat_loc;
  73         unsigned long *rp_loc;
  74         unsigned long *pri_unat_loc;
  75         unsigned long *unat_loc;
  76         unsigned long *pr_loc;
  77         unsigned long *lc_loc;
  78         unsigned long *fpsr_loc;
  79         struct unw_ireg {
  80                 unsigned long *loc;
  81                 struct unw_ireg_nat {
  82                         long type : 3;                  /* enum unw_nat_type */
  83                         signed long off : 61;           /* NaT word is at loc+nat.off */
  84                 } nat;
  85         } r4, r5, r6, r7;
  86         unsigned long *b1_loc, *b2_loc, *b3_loc, *b4_loc, *b5_loc;
  87         struct ia64_fpreg *f2_loc, *f3_loc, *f4_loc, *f5_loc, *fr_loc[16];
  88 };
  89
  90 /*
  91  * The official API follows below:
  92  */
  93
  94 /*
  95  * Initialize unwind support.
  96  */
  97 extern void unw_init (void);
  98 extern void unw_create_gate_table (void);
  99
 100 extern void *unw_add_unwind_table (const char *name, unsigned long segment_base, unsigned long gp,
 101                                    const void *table_start, const void *table_end);
 102
 103 extern void unw_remove_unwind_table (void *handle);
 104
 105 /*
 106  * Prepare to unwind blocked task t.
 107  */
 108 extern void unw_init_from_blocked_task (struct unw_frame_info *info, struct task_struct *t);
 109
 110 extern void unw_init_frame_info (struct unw_frame_info *info, struct task_struct *t,
 111                                  struct switch_stack *sw);
 112
 113 /*
 114  * Prepare to unwind the currently running thread.
 115  */
 116 extern void unw_init_running (void (*callback)(struct unw_frame_info *info, void *arg), void *arg);
 117
 118 /*
 119  * Unwind to previous to frame.  Returns 0 if successful, negative
 120  * number in case of an error.
 121  */
 122 extern int unw_unwind (struct unw_frame_info *info);
 123
 124 /*
 125  * Unwind until the return pointer is in user-land (or until an error
 126  * occurs).  Returns 0 if successful, negative number in case of
 127  * error.
 128  */
 129 extern int unw_unwind_to_user (struct unw_frame_info *info);
 130
 131 #define unw_is_intr_frame(info) (((info)->flags & UNW_FLAG_INTERRUPT_FRAME) != 0)
 132
 133 static inline int
 134 unw_get_ip (struct unw_frame_info *info, unsigned long *valp)
 135 {
 136         *valp = (info)->ip;
 137         return 0;
 138 }
 139
 140 static inline int
 141 unw_get_sp (struct unw_frame_info *info, unsigned long *valp)
 142 {
 143         *valp = (info)->sp;
 144         return 0;
 145 }
 146
 147 static inline int
 148 unw_get_psp (struct unw_frame_info *info, unsigned long *valp)
 149 {
 150         *valp = (info)->psp;
 151         return 0;
 152 }
 153
 154 static inline int
 155 unw_get_bsp (struct unw_frame_info *info, unsigned long *valp)
 156 {
 157         *valp = (info)->bsp;
 158         return 0;
 159 }
 160
 161 static inline int
 162 unw_get_cfm (struct unw_frame_info *info, unsigned long *valp)
 163 {
 164         *valp = *(info)->cfm_loc;
 165         return 0;
 166 }
 167
 168 static inline int
 169 unw_set_cfm (struct unw_frame_info *info, unsigned long val)
 170 {
 171         *(info)->cfm_loc = val;
 172         return 0;
 173 }
 174
 175 static inline int
 176 unw_get_rp (struct unw_frame_info *info, unsigned long *val)
 177 {
 178         if (!info->rp_loc)
 179                 return -1;
 180         *val = *info->rp_loc;
 181         return 0;
 182 }
 183
 184 extern int unw_access_gr (struct unw_frame_info *, int, unsigned long *, char *, int);
 185 extern int unw_access_br (struct unw_frame_info *, int, unsigned long *, int);
 186 extern int unw_access_fr (struct unw_frame_info *, int, struct ia64_fpreg *, int);
 187 extern int unw_access_ar (struct unw_frame_info *, int, unsigned long *, int);
 188 extern int unw_access_pr (struct unw_frame_info *, unsigned long *, int);
 189
 190 static inline int
 191 unw_set_gr (struct unw_frame_info *i, int n, unsigned long v, char nat)
 192 {
 193         return unw_access_gr(i, n, &v, &nat, 1);
 194 }
 195
 196 static inline int
 197 unw_set_br (struct unw_frame_info *i, int n, unsigned long v)
 198 {
 199         return unw_access_br(i, n, &v, 1);
 200 }
 201
 202 static inline int
 203 unw_set_fr (struct unw_frame_info *i, int n, struct ia64_fpreg v)
 204 {
 205         return unw_access_fr(i, n, &v, 1);
 206 }
 207
 208 static inline int
 209 unw_set_ar (struct unw_frame_info *i, int n, unsigned long v)
 210 {
 211         return unw_access_ar(i, n, &v, 1);
 212 }
 213
 214 static inline int
 215 unw_set_pr (struct unw_frame_info *i, unsigned long v)
 216 {
 217         return unw_access_pr(i, &v, 1);
 218 }
 219
 220 #define unw_get_gr(i,n,v,nat)   unw_access_gr(i,n,v,nat,0)
 221 #define unw_get_br(i,n,v)       unw_access_br(i,n,v,0)
 222 #define unw_get_fr(i,n,v)       unw_access_fr(i,n,v,0)
 223 #define unw_get_ar(i,n,v)       unw_access_ar(i,n,v,0)
 224 #define unw_get_pr(i,v)         unw_access_pr(i,v,0)
 225
 226 #endif /* _ASM_UNWIND_H */