arch/arm64/include/asm/stacktrace.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * Copyright (C) 2012 ARM Ltd.
   4  */
   5 #ifndef __ASM_STACKTRACE_H
   6 #define __ASM_STACKTRACE_H
   7
   8 #include <linux/percpu.h>
   9 #include <linux/sched.h>
  10 #include <linux/sched/task_stack.h>
  11 #include <linux/types.h>
  12 #include <linux/llist.h>
  13
  14 #include <asm/memory.h>
  15 #include <asm/ptrace.h>
  16 #include <asm/sdei.h>
  17
  18 enum stack_type {
  19         STACK_TYPE_UNKNOWN,
  20         STACK_TYPE_TASK,
  21         STACK_TYPE_IRQ,
  22         STACK_TYPE_OVERFLOW,
  23         STACK_TYPE_SDEI_NORMAL,
  24         STACK_TYPE_SDEI_CRITICAL,
  25         __NR_STACK_TYPES
  26 };
  27
  28 struct stack_info {
  29         unsigned long low;
  30         unsigned long high;
  31         enum stack_type type;
  32 };
  33
  34 /*
  35  * A snapshot of a frame record or fp/lr register values, along with some
  36  * accounting information necessary for robust unwinding.
  37  *
  38  * @fp:          The fp value in the frame record (or the real fp)
  39  * @pc:          The lr value in the frame record (or the real lr)
  40  *
  41  * @stacks_done: Stacks which have been entirely unwound, for which it is no
  42  *               longer valid to unwind to.
  43  *
  44  * @prev_fp:     The fp that pointed to this frame record, or a synthetic value
  45  *               of 0. This is used to ensure that within a stack, each
  46  *               subsequent frame record is at an increasing address.
  47  * @prev_type:   The type of stack this frame record was on, or a synthetic
  48  *               value of STACK_TYPE_UNKNOWN. This is used to detect a
  49  *               transition from one stack to another.
  50  *
  51  * @kr_cur:      When KRETPROBES is selected, holds the kretprobe instance
  52  *               associated with the most recently encountered replacement lr
  53  *               value.
  54  */
  55 struct stackframe {
  56         unsigned long fp;
  57         unsigned long pc;
  58         DECLARE_BITMAP(stacks_done, __NR_STACK_TYPES);
  59         unsigned long prev_fp;
  60         enum stack_type prev_type;
  61 #ifdef CONFIG_KRETPROBES
  62         struct llist_node *kr_cur;
  63 #endif
  64 };
  65
  66 extern int unwind_frame(struct task_struct *tsk, struct stackframe *frame);
  67 extern void walk_stackframe(struct task_struct *tsk, struct stackframe *frame,
  68                             bool (*fn)(void *, unsigned long), void *data);
  69 extern void dump_backtrace(struct pt_regs *regs, struct task_struct *tsk,
  70                            const char *loglvl);
  71
  72 DECLARE_PER_CPU(unsigned long *, irq_stack_ptr);
  73
  74 static inline bool on_stack(unsigned long sp, unsigned long size,
  75                             unsigned long low, unsigned long high,
  76                             enum stack_type type, struct stack_info *info)
  77 {
  78         if (!low)
  79                 return false;
  80
  81         if (sp < low || sp + size < sp || sp + size > high)
  82                 return false;
  83
  84         if (info) {
  85                 info->low = low;
  86                 info->high = high;
  87                 info->type = type;
  88         }
  89         return true;
  90 }
  91
  92 static inline bool on_irq_stack(unsigned long sp, unsigned long size,
  93                                 struct stack_info *info)
  94 {
  95         unsigned long low = (unsigned long)raw_cpu_read(irq_stack_ptr);
  96         unsigned long high = low + IRQ_STACK_SIZE;
  97
  98         return on_stack(sp, size, low, high, STACK_TYPE_IRQ, info);
  99 }
 100
 101 static inline bool on_task_stack(const struct task_struct *tsk,
 102                                  unsigned long sp, unsigned long size,
 103                                  struct stack_info *info)
 104 {
 105         unsigned long low = (unsigned long)task_stack_page(tsk);
 106         unsigned long high = low + THREAD_SIZE;
 107
 108         return on_stack(sp, size, low, high, STACK_TYPE_TASK, info);
 109 }
 110
 111 #ifdef CONFIG_VMAP_STACK
 112 DECLARE_PER_CPU(unsigned long [OVERFLOW_STACK_SIZE/sizeof(long)], overflow_stack);
 113
 114 static inline bool on_overflow_stack(unsigned long sp, unsigned long size,
 115                                 struct stack_info *info)
 116 {
 117         unsigned long low = (unsigned long)raw_cpu_ptr(overflow_stack);
 118         unsigned long high = low + OVERFLOW_STACK_SIZE;
 119
 120         return on_stack(sp, size, low, high, STACK_TYPE_OVERFLOW, info);
 121 }
 122 #else
 123 static inline bool on_overflow_stack(unsigned long sp, unsigned long size,
 124                         struct stack_info *info) { return false; }
 125 #endif
 126
 127
 128 /*
 129  * We can only safely access per-cpu stacks from current in a non-preemptible
 130  * context.
 131  */
 132 static inline bool on_accessible_stack(const struct task_struct *tsk,
 133                                        unsigned long sp, unsigned long size,
 134                                        struct stack_info *info)
 135 {
 136         if (info)
 137                 info->type = STACK_TYPE_UNKNOWN;
 138
 139         if (on_task_stack(tsk, sp, size, info))
 140                 return true;
 141         if (tsk != current || preemptible())
 142                 return false;
 143         if (on_irq_stack(sp, size, info))
 144                 return true;
 145         if (on_overflow_stack(sp, size, info))
 146                 return true;
 147         if (on_sdei_stack(sp, size, info))
 148                 return true;
 149
 150         return false;
 151 }
 152
 153 void start_backtrace(struct stackframe *frame, unsigned long fp,
 154                      unsigned long pc);
 155
 156 #endif  /* __ASM_STACKTRACE_H */