arch/arm64/kernel/stacktrace.c

   1 /*
   2  * Stack tracing support
   3  *
   4  * Copyright (C) 2012 ARM Ltd.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 as
   8  * published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 #include <linux/kernel.h>
  19 #include <linux/export.h>
  20 #include <linux/ftrace.h>
  21 #include <linux/sched.h>
  22 #include <linux/stacktrace.h>
  23
  24 #include <asm/irq.h>
  25 #include <asm/stacktrace.h>
  26
  27 /*
  28  * AArch64 PCS assigns the frame pointer to x29.
  29  *
  30  * A simple function prologue looks like this:
  31  *      sub     sp, sp, #0x10
  32  *      stp     x29, x30, [sp]
  33  *      mov     x29, sp
  34  *
  35  * A simple function epilogue looks like this:
  36  *      mov     sp, x29
  37  *      ldp     x29, x30, [sp]
  38  *      add     sp, sp, #0x10
  39  */
  40 int notrace unwind_frame(struct task_struct *tsk, struct stackframe *frame)
  41 {
  42         unsigned long high, low;
  43         unsigned long fp = frame->fp;
  44         unsigned long irq_stack_ptr;
  45
  46         if (!tsk)
  47                 tsk = current;
  48
  49         /*
  50          * Switching between stacks is valid when tracing current and in
  51          * non-preemptible context.
  52          */
  53         if (tsk == current && !preemptible())
  54                 irq_stack_ptr = IRQ_STACK_PTR(smp_processor_id());
  55         else
  56                 irq_stack_ptr = 0;
  57
  58         low  = frame->sp;
  59         /* irq stacks are not THREAD_SIZE aligned */
  60         if (on_irq_stack(frame->sp, raw_smp_processor_id()))
  61                 high = irq_stack_ptr;
  62         else
  63                 high = ALIGN(low, THREAD_SIZE) - 0x20;
  64
  65         if (fp < low || fp > high || fp & 0xf)
  66                 return -EINVAL;
  67
  68         frame->sp = fp + 0x10;
  69         frame->fp = READ_ONCE_NOCHECK(*(unsigned long *)(fp));
  70         frame->pc = READ_ONCE_NOCHECK(*(unsigned long *)(fp + 8));
  71
  72 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
  73         if (tsk->ret_stack &&
  74                         (frame->pc == (unsigned long)return_to_handler)) {
  75                 if (WARN_ON_ONCE(frame->graph == -1))
  76                         return -EINVAL;
  77                 if (frame->graph < -1)
  78                         frame->graph += FTRACE_NOTRACE_DEPTH;
  79
  80                 /*
  81                  * This is a case where function graph tracer has
  82                  * modified a return address (LR) in a stack frame
  83                  * to hook a function return.
  84                  * So replace it to an original value.
  85                  */
  86                 frame->pc = tsk->ret_stack[frame->graph--].ret;
  87         }
  88 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
  89
  90         /*
  91          * Check whether we are going to walk through from interrupt stack
  92          * to task stack.
  93          * If we reach the end of the stack - and its an interrupt stack,
  94          * unpack the dummy frame to find the original elr.
  95          *
  96          * Check the frame->fp we read from the bottom of the irq_stack,
  97          * and the original task stack pointer are both in current->stack.
  98          */
  99         if (frame->sp == irq_stack_ptr) {
 100                 struct pt_regs *irq_args;
 101                 unsigned long orig_sp = IRQ_STACK_TO_TASK_STACK(irq_stack_ptr);
 102
 103                 if (object_is_on_stack((void *)orig_sp) &&
 104                    object_is_on_stack((void *)frame->fp)) {
 105                         frame->sp = orig_sp;
 106
 107                         /* orig_sp is the saved pt_regs, find the elr */
 108                         irq_args = (struct pt_regs *)orig_sp;
 109                         frame->pc = irq_args->pc;
 110                 } else {
 111                         /*
 112                          * This frame has a non-standard format, and we
 113                          * didn't fix it, because the data looked wrong.
 114                          * Refuse to output this frame.
 115                          */
 116                         return -EINVAL;
 117                 }
 118         }
 119
 120         return 0;
 121 }
 122
 123 void notrace walk_stackframe(struct task_struct *tsk, struct stackframe *frame,
 124                      int (*fn)(struct stackframe *, void *), void *data)
 125 {
 126         while (1) {
 127                 int ret;
 128
 129                 if (fn(frame, data))
 130                         break;
 131                 ret = unwind_frame(tsk, frame);
 132                 if (ret < 0)
 133                         break;
 134         }
 135 }
 136 EXPORT_SYMBOL(walk_stackframe);
 137
 138 #ifdef CONFIG_STACKTRACE
 139 struct stack_trace_data {
 140         struct stack_trace *trace;
 141         unsigned int no_sched_functions;
 142         unsigned int skip;
 143 };
 144
 145 static int save_trace(struct stackframe *frame, void *d)
 146 {
 147         struct stack_trace_data *data = d;
 148         struct stack_trace *trace = data->trace;
 149         unsigned long addr = frame->pc;
 150
 151         if (data->no_sched_functions && in_sched_functions(addr))
 152                 return 0;
 153         if (data->skip) {
 154                 data->skip--;
 155                 return 0;
 156         }
 157
 158         trace->entries[trace->nr_entries++] = addr;
 159
 160         return trace->nr_entries >= trace->max_entries;
 161 }
 162
 163 void save_stack_trace_regs(struct pt_regs *regs, struct stack_trace *trace)
 164 {
 165         struct stack_trace_data data;
 166         struct stackframe frame;
 167
 168         data.trace = trace;
 169         data.skip = trace->skip;
 170         data.no_sched_functions = 0;
 171
 172         frame.fp = regs->regs[29];
 173         frame.sp = regs->sp;
 174         frame.pc = regs->pc;
 175 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
 176         frame.graph = current->curr_ret_stack;
 177 #endif
 178
 179         walk_stackframe(current, &frame, save_trace, &data);
 180         if (trace->nr_entries < trace->max_entries)
 181                 trace->entries[trace->nr_entries++] = ULONG_MAX;
 182 }
 183
 184 void save_stack_trace_tsk(struct task_struct *tsk, struct stack_trace *trace)
 185 {
 186         struct stack_trace_data data;
 187         struct stackframe frame;
 188
 189         data.trace = trace;
 190         data.skip = trace->skip;
 191
 192         if (tsk != current) {
 193                 data.no_sched_functions = 1;
 194                 frame.fp = thread_saved_fp(tsk);
 195                 frame.sp = thread_saved_sp(tsk);
 196                 frame.pc = thread_saved_pc(tsk);
 197         } else {
 198                 data.no_sched_functions = 0;
 199                 frame.fp = (unsigned long)__builtin_frame_address(0);
 200                 frame.sp = current_stack_pointer;
 201                 frame.pc = (unsigned long)save_stack_trace_tsk;
 202         }
 203 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
 204         frame.graph = tsk->curr_ret_stack;
 205 #endif
 206
 207         walk_stackframe(tsk, &frame, save_trace, &data);
 208         if (trace->nr_entries < trace->max_entries)
 209                 trace->entries[trace->nr_entries++] = ULONG_MAX;
 210 }
 211
 212 void save_stack_trace(struct stack_trace *trace)
 213 {
 214         save_stack_trace_tsk(current, trace);
 215 }
 216 EXPORT_SYMBOL_GPL(save_stack_trace);
 217 #endif