2 * Copyright (C) 2008 Steven Rostedt <srostedt@redhat.com>
5 #include <linux/sched/task_stack.h>
6 #include <linux/stacktrace.h>
7 #include <linux/kallsyms.h>
8 #include <linux/seq_file.h>
9 #include <linux/spinlock.h>
10 #include <linux/uaccess.h>
11 #include <linux/ftrace.h>
12 #include <linux/module.h>
13 #include <linux/sysctl.h>
14 #include <linux/init.h>
16 #include <asm/setup.h>
20 static unsigned long stack_dump_trace
[STACK_TRACE_ENTRIES
+1] =
21 { [0 ... (STACK_TRACE_ENTRIES
)] = ULONG_MAX
};
22 unsigned stack_trace_index
[STACK_TRACE_ENTRIES
];
25 * Reserve one entry for the passed in ip. This will allow
26 * us to remove most or all of the stack size overhead
27 * added by the stack tracer itself.
29 struct stack_trace stack_trace_max
= {
30 .max_entries
= STACK_TRACE_ENTRIES
- 1,
31 .entries
= &stack_dump_trace
[0],
34 unsigned long stack_trace_max_size
;
35 arch_spinlock_t stack_trace_max_lock
=
36 (arch_spinlock_t
)__ARCH_SPIN_LOCK_UNLOCKED
;
38 static DEFINE_PER_CPU(int, trace_active
);
39 static DEFINE_MUTEX(stack_sysctl_mutex
);
41 int stack_tracer_enabled
;
42 static int last_stack_tracer_enabled
;
44 void stack_trace_print(void)
49 pr_emerg(" Depth Size Location (%d entries)\n"
50 " ----- ---- --------\n",
51 stack_trace_max
.nr_entries
);
53 for (i
= 0; i
< stack_trace_max
.nr_entries
; i
++) {
54 if (stack_dump_trace
[i
] == ULONG_MAX
)
56 if (i
+1 == stack_trace_max
.nr_entries
||
57 stack_dump_trace
[i
+1] == ULONG_MAX
)
58 size
= stack_trace_index
[i
];
60 size
= stack_trace_index
[i
] - stack_trace_index
[i
+1];
62 pr_emerg("%3ld) %8d %5d %pS\n", i
, stack_trace_index
[i
],
63 size
, (void *)stack_dump_trace
[i
]);
68 * When arch-specific code overrides this function, the following
69 * data should be filled up, assuming stack_trace_max_lock is held to
70 * prevent concurrent updates.
73 * stack_trace_max_size
76 check_stack(unsigned long ip
, unsigned long *stack
)
78 unsigned long this_size
, flags
; unsigned long *p
, *top
, *start
;
79 static int tracer_frame
;
80 int frame_size
= ACCESS_ONCE(tracer_frame
);
83 this_size
= ((unsigned long)stack
) & (THREAD_SIZE
-1);
84 this_size
= THREAD_SIZE
- this_size
;
85 /* Remove the frame of the tracer */
86 this_size
-= frame_size
;
88 if (this_size
<= stack_trace_max_size
)
91 /* we do not handle interrupt stacks yet */
92 if (!object_is_on_stack(stack
))
95 /* Can't do this from NMI context (can cause deadlocks) */
99 local_irq_save(flags
);
100 arch_spin_lock(&stack_trace_max_lock
);
103 * RCU may not be watching, make it see us.
104 * The stack trace code uses rcu_sched.
108 /* In case another CPU set the tracer_frame on us */
109 if (unlikely(!frame_size
))
110 this_size
-= tracer_frame
;
112 /* a race could have already updated it */
113 if (this_size
<= stack_trace_max_size
)
116 stack_trace_max_size
= this_size
;
118 stack_trace_max
.nr_entries
= 0;
119 stack_trace_max
.skip
= 3;
121 save_stack_trace(&stack_trace_max
);
123 /* Skip over the overhead of the stack tracer itself */
124 for (i
= 0; i
< stack_trace_max
.nr_entries
; i
++) {
125 if (stack_dump_trace
[i
] == ip
)
130 * Some archs may not have the passed in ip in the dump.
131 * If that happens, we need to show everything.
133 if (i
== stack_trace_max
.nr_entries
)
137 * Now find where in the stack these are.
141 top
= (unsigned long *)
142 (((unsigned long)start
& ~(THREAD_SIZE
-1)) + THREAD_SIZE
);
145 * Loop through all the entries. One of the entries may
146 * for some reason be missed on the stack, so we may
147 * have to account for them. If they are all there, this
148 * loop will only happen once. This code only takes place
149 * on a new max, so it is far from a fast path.
151 while (i
< stack_trace_max
.nr_entries
) {
154 stack_trace_index
[x
] = this_size
;
157 for (; p
< top
&& i
< stack_trace_max
.nr_entries
; p
++) {
158 if (stack_dump_trace
[i
] == ULONG_MAX
)
161 * The READ_ONCE_NOCHECK is used to let KASAN know that
162 * this is not a stack-out-of-bounds error.
164 if ((READ_ONCE_NOCHECK(*p
)) == stack_dump_trace
[i
]) {
165 stack_dump_trace
[x
] = stack_dump_trace
[i
++];
166 this_size
= stack_trace_index
[x
++] =
167 (top
- p
) * sizeof(unsigned long);
169 /* Start the search from here */
172 * We do not want to show the overhead
173 * of the stack tracer stack in the
174 * max stack. If we haven't figured
175 * out what that is, then figure it out
178 if (unlikely(!tracer_frame
)) {
179 tracer_frame
= (p
- stack
) *
180 sizeof(unsigned long);
181 stack_trace_max_size
-= tracer_frame
;
190 stack_trace_max
.nr_entries
= x
;
192 stack_dump_trace
[x
] = ULONG_MAX
;
194 if (task_stack_end_corrupted(current
)) {
201 arch_spin_unlock(&stack_trace_max_lock
);
202 local_irq_restore(flags
);
206 stack_trace_call(unsigned long ip
, unsigned long parent_ip
,
207 struct ftrace_ops
*op
, struct pt_regs
*pt_regs
)
212 preempt_disable_notrace();
214 cpu
= raw_smp_processor_id();
215 /* no atomic needed, we only modify this variable by this cpu */
216 if (per_cpu(trace_active
, cpu
)++ != 0)
219 ip
+= MCOUNT_INSN_SIZE
;
221 check_stack(ip
, &stack
);
224 per_cpu(trace_active
, cpu
)--;
225 /* prevent recursion in schedule */
226 preempt_enable_notrace();
229 static struct ftrace_ops trace_ops __read_mostly
=
231 .func
= stack_trace_call
,
232 .flags
= FTRACE_OPS_FL_RECURSION_SAFE
,
236 stack_max_size_read(struct file
*filp
, char __user
*ubuf
,
237 size_t count
, loff_t
*ppos
)
239 unsigned long *ptr
= filp
->private_data
;
243 r
= snprintf(buf
, sizeof(buf
), "%ld\n", *ptr
);
246 return simple_read_from_buffer(ubuf
, count
, ppos
, buf
, r
);
250 stack_max_size_write(struct file
*filp
, const char __user
*ubuf
,
251 size_t count
, loff_t
*ppos
)
253 long *ptr
= filp
->private_data
;
254 unsigned long val
, flags
;
258 ret
= kstrtoul_from_user(ubuf
, count
, 10, &val
);
262 local_irq_save(flags
);
265 * In case we trace inside arch_spin_lock() or after (NMI),
266 * we will cause circular lock, so we also need to increase
267 * the percpu trace_active here.
269 cpu
= smp_processor_id();
270 per_cpu(trace_active
, cpu
)++;
272 arch_spin_lock(&stack_trace_max_lock
);
274 arch_spin_unlock(&stack_trace_max_lock
);
276 per_cpu(trace_active
, cpu
)--;
277 local_irq_restore(flags
);
282 static const struct file_operations stack_max_size_fops
= {
283 .open
= tracing_open_generic
,
284 .read
= stack_max_size_read
,
285 .write
= stack_max_size_write
,
286 .llseek
= default_llseek
,
290 __next(struct seq_file
*m
, loff_t
*pos
)
294 if (n
> stack_trace_max
.nr_entries
|| stack_dump_trace
[n
] == ULONG_MAX
)
297 m
->private = (void *)n
;
302 t_next(struct seq_file
*m
, void *v
, loff_t
*pos
)
305 return __next(m
, pos
);
308 static void *t_start(struct seq_file
*m
, loff_t
*pos
)
314 cpu
= smp_processor_id();
315 per_cpu(trace_active
, cpu
)++;
317 arch_spin_lock(&stack_trace_max_lock
);
320 return SEQ_START_TOKEN
;
322 return __next(m
, pos
);
325 static void t_stop(struct seq_file
*m
, void *p
)
329 arch_spin_unlock(&stack_trace_max_lock
);
331 cpu
= smp_processor_id();
332 per_cpu(trace_active
, cpu
)--;
337 static void trace_lookup_stack(struct seq_file
*m
, long i
)
339 unsigned long addr
= stack_dump_trace
[i
];
341 seq_printf(m
, "%pS\n", (void *)addr
);
344 static void print_disabled(struct seq_file
*m
)
347 "# Stack tracer disabled\n"
349 "# To enable the stack tracer, either add 'stacktrace' to the\n"
350 "# kernel command line\n"
351 "# or 'echo 1 > /proc/sys/kernel/stack_tracer_enabled'\n"
355 static int t_show(struct seq_file
*m
, void *v
)
360 if (v
== SEQ_START_TOKEN
) {
361 seq_printf(m
, " Depth Size Location"
363 " ----- ---- --------\n",
364 stack_trace_max
.nr_entries
);
366 if (!stack_tracer_enabled
&& !stack_trace_max_size
)
374 if (i
>= stack_trace_max
.nr_entries
||
375 stack_dump_trace
[i
] == ULONG_MAX
)
378 if (i
+1 == stack_trace_max
.nr_entries
||
379 stack_dump_trace
[i
+1] == ULONG_MAX
)
380 size
= stack_trace_index
[i
];
382 size
= stack_trace_index
[i
] - stack_trace_index
[i
+1];
384 seq_printf(m
, "%3ld) %8d %5d ", i
, stack_trace_index
[i
], size
);
386 trace_lookup_stack(m
, i
);
391 static const struct seq_operations stack_trace_seq_ops
= {
398 static int stack_trace_open(struct inode
*inode
, struct file
*file
)
400 return seq_open(file
, &stack_trace_seq_ops
);
403 static const struct file_operations stack_trace_fops
= {
404 .open
= stack_trace_open
,
407 .release
= seq_release
,
411 stack_trace_filter_open(struct inode
*inode
, struct file
*file
)
413 return ftrace_regex_open(&trace_ops
, FTRACE_ITER_FILTER
,
417 static const struct file_operations stack_trace_filter_fops
= {
418 .open
= stack_trace_filter_open
,
420 .write
= ftrace_filter_write
,
421 .llseek
= tracing_lseek
,
422 .release
= ftrace_regex_release
,
426 stack_trace_sysctl(struct ctl_table
*table
, int write
,
427 void __user
*buffer
, size_t *lenp
,
432 mutex_lock(&stack_sysctl_mutex
);
434 ret
= proc_dointvec(table
, write
, buffer
, lenp
, ppos
);
437 (last_stack_tracer_enabled
== !!stack_tracer_enabled
))
440 last_stack_tracer_enabled
= !!stack_tracer_enabled
;
442 if (stack_tracer_enabled
)
443 register_ftrace_function(&trace_ops
);
445 unregister_ftrace_function(&trace_ops
);
448 mutex_unlock(&stack_sysctl_mutex
);
452 static char stack_trace_filter_buf
[COMMAND_LINE_SIZE
+1] __initdata
;
454 static __init
int enable_stacktrace(char *str
)
456 if (strncmp(str
, "_filter=", 8) == 0)
457 strncpy(stack_trace_filter_buf
, str
+8, COMMAND_LINE_SIZE
);
459 stack_tracer_enabled
= 1;
460 last_stack_tracer_enabled
= 1;
463 __setup("stacktrace", enable_stacktrace
);
465 static __init
int stack_trace_init(void)
467 struct dentry
*d_tracer
;
469 d_tracer
= tracing_init_dentry();
470 if (IS_ERR(d_tracer
))
473 trace_create_file("stack_max_size", 0644, d_tracer
,
474 &stack_trace_max_size
, &stack_max_size_fops
);
476 trace_create_file("stack_trace", 0444, d_tracer
,
477 NULL
, &stack_trace_fops
);
479 trace_create_file("stack_trace_filter", 0444, d_tracer
,
480 NULL
, &stack_trace_filter_fops
);
482 if (stack_trace_filter_buf
[0])
483 ftrace_set_early_filter(&trace_ops
, stack_trace_filter_buf
, 1);
485 if (stack_tracer_enabled
)
486 register_ftrace_function(&trace_ops
);
491 device_initcall(stack_trace_init
);