2 * Copyright (C) 2008 Steven Rostedt <srostedt@redhat.com>
5 #include <linux/stacktrace.h>
6 #include <linux/kallsyms.h>
7 #include <linux/seq_file.h>
8 #include <linux/spinlock.h>
9 #include <linux/uaccess.h>
10 #include <linux/debugfs.h>
11 #include <linux/ftrace.h>
12 #include <linux/module.h>
13 #include <linux/sysctl.h>
14 #include <linux/init.h>
17 #include <asm/setup.h>
21 #define STACK_TRACE_ENTRIES 500
23 #ifdef CC_USING_FENTRY
29 static unsigned long stack_dump_trace
[STACK_TRACE_ENTRIES
+1] =
30 { [0 ... (STACK_TRACE_ENTRIES
)] = ULONG_MAX
};
31 static unsigned stack_dump_index
[STACK_TRACE_ENTRIES
];
34 * Reserve one entry for the passed in ip. This will allow
35 * us to remove most or all of the stack size overhead
36 * added by the stack tracer itself.
38 static struct stack_trace max_stack_trace
= {
39 .max_entries
= STACK_TRACE_ENTRIES
- 1,
40 .entries
= &stack_dump_trace
[1],
43 static unsigned long max_stack_size
;
44 static arch_spinlock_t max_stack_lock
=
45 (arch_spinlock_t
)__ARCH_SPIN_LOCK_UNLOCKED
;
47 static DEFINE_PER_CPU(int, trace_active
);
48 static DEFINE_MUTEX(stack_sysctl_mutex
);
50 int stack_tracer_enabled
;
51 static int last_stack_tracer_enabled
;
54 check_stack(unsigned long ip
, unsigned long *stack
)
56 unsigned long this_size
, flags
;
57 unsigned long *p
, *top
, *start
;
58 static int tracer_frame
;
59 int frame_size
= ACCESS_ONCE(tracer_frame
);
62 this_size
= ((unsigned long)stack
) & (THREAD_SIZE
-1);
63 this_size
= THREAD_SIZE
- this_size
;
64 /* Remove the frame of the tracer */
65 this_size
-= frame_size
;
67 if (this_size
<= max_stack_size
)
70 /* we do not handle interrupt stacks yet */
71 if (!object_is_on_stack(stack
))
74 local_irq_save(flags
);
75 arch_spin_lock(&max_stack_lock
);
77 /* In case another CPU set the tracer_frame on us */
78 if (unlikely(!frame_size
))
79 this_size
-= tracer_frame
;
81 /* a race could have already updated it */
82 if (this_size
<= max_stack_size
)
85 max_stack_size
= this_size
;
87 max_stack_trace
.nr_entries
= 0;
88 max_stack_trace
.skip
= 3;
90 save_stack_trace(&max_stack_trace
);
93 * Add the passed in ip from the function tracer.
94 * Searching for this on the stack will skip over
95 * most of the overhead from the stack tracer itself.
97 stack_dump_trace
[0] = ip
;
98 max_stack_trace
.nr_entries
++;
101 * Now find where in the stack these are.
105 top
= (unsigned long *)
106 (((unsigned long)start
& ~(THREAD_SIZE
-1)) + THREAD_SIZE
);
109 * Loop through all the entries. One of the entries may
110 * for some reason be missed on the stack, so we may
111 * have to account for them. If they are all there, this
112 * loop will only happen once. This code only takes place
113 * on a new max, so it is far from a fast path.
115 while (i
< max_stack_trace
.nr_entries
) {
118 stack_dump_index
[i
] = this_size
;
121 for (; p
< top
&& i
< max_stack_trace
.nr_entries
; p
++) {
122 if (*p
== stack_dump_trace
[i
]) {
123 this_size
= stack_dump_index
[i
++] =
124 (top
- p
) * sizeof(unsigned long);
126 /* Start the search from here */
129 * We do not want to show the overhead
130 * of the stack tracer stack in the
131 * max stack. If we haven't figured
132 * out what that is, then figure it out
135 if (unlikely(!tracer_frame
) && i
== 1) {
136 tracer_frame
= (p
- stack
) *
137 sizeof(unsigned long);
138 max_stack_size
-= tracer_frame
;
148 arch_spin_unlock(&max_stack_lock
);
149 local_irq_restore(flags
);
153 stack_trace_call(unsigned long ip
, unsigned long parent_ip
,
154 struct ftrace_ops
*op
, struct pt_regs
*pt_regs
)
159 preempt_disable_notrace();
161 cpu
= raw_smp_processor_id();
162 /* no atomic needed, we only modify this variable by this cpu */
163 if (per_cpu(trace_active
, cpu
)++ != 0)
167 * When fentry is used, the traced function does not get
168 * its stack frame set up, and we lose the parent.
169 * The ip is pretty useless because the function tracer
170 * was called before that function set up its stack frame.
171 * In this case, we use the parent ip.
173 * By adding the return address of either the parent ip
174 * or the current ip we can disregard most of the stack usage
175 * caused by the stack tracer itself.
177 * The function tracer always reports the address of where the
178 * mcount call was, but the stack will hold the return address.
183 ip
+= MCOUNT_INSN_SIZE
;
185 check_stack(ip
, &stack
);
188 per_cpu(trace_active
, cpu
)--;
189 /* prevent recursion in schedule */
190 preempt_enable_notrace();
193 static struct ftrace_ops trace_ops __read_mostly
=
195 .func
= stack_trace_call
,
196 .flags
= FTRACE_OPS_FL_RECURSION_SAFE
,
200 stack_max_size_read(struct file
*filp
, char __user
*ubuf
,
201 size_t count
, loff_t
*ppos
)
203 unsigned long *ptr
= filp
->private_data
;
207 r
= snprintf(buf
, sizeof(buf
), "%ld\n", *ptr
);
210 return simple_read_from_buffer(ubuf
, count
, ppos
, buf
, r
);
214 stack_max_size_write(struct file
*filp
, const char __user
*ubuf
,
215 size_t count
, loff_t
*ppos
)
217 long *ptr
= filp
->private_data
;
218 unsigned long val
, flags
;
222 ret
= kstrtoul_from_user(ubuf
, count
, 10, &val
);
226 local_irq_save(flags
);
229 * In case we trace inside arch_spin_lock() or after (NMI),
230 * we will cause circular lock, so we also need to increase
231 * the percpu trace_active here.
233 cpu
= smp_processor_id();
234 per_cpu(trace_active
, cpu
)++;
236 arch_spin_lock(&max_stack_lock
);
238 arch_spin_unlock(&max_stack_lock
);
240 per_cpu(trace_active
, cpu
)--;
241 local_irq_restore(flags
);
246 static const struct file_operations stack_max_size_fops
= {
247 .open
= tracing_open_generic
,
248 .read
= stack_max_size_read
,
249 .write
= stack_max_size_write
,
250 .llseek
= default_llseek
,
254 __next(struct seq_file
*m
, loff_t
*pos
)
258 if (n
>= max_stack_trace
.nr_entries
|| stack_dump_trace
[n
] == ULONG_MAX
)
261 m
->private = (void *)n
;
266 t_next(struct seq_file
*m
, void *v
, loff_t
*pos
)
269 return __next(m
, pos
);
272 static void *t_start(struct seq_file
*m
, loff_t
*pos
)
278 cpu
= smp_processor_id();
279 per_cpu(trace_active
, cpu
)++;
281 arch_spin_lock(&max_stack_lock
);
284 return SEQ_START_TOKEN
;
286 return __next(m
, pos
);
289 static void t_stop(struct seq_file
*m
, void *p
)
293 arch_spin_unlock(&max_stack_lock
);
295 cpu
= smp_processor_id();
296 per_cpu(trace_active
, cpu
)--;
301 static int trace_lookup_stack(struct seq_file
*m
, long i
)
303 unsigned long addr
= stack_dump_trace
[i
];
305 return seq_printf(m
, "%pS\n", (void *)addr
);
308 static void print_disabled(struct seq_file
*m
)
311 "# Stack tracer disabled\n"
313 "# To enable the stack tracer, either add 'stacktrace' to the\n"
314 "# kernel command line\n"
315 "# or 'echo 1 > /proc/sys/kernel/stack_tracer_enabled'\n"
319 static int t_show(struct seq_file
*m
, void *v
)
324 if (v
== SEQ_START_TOKEN
) {
325 seq_printf(m
, " Depth Size Location"
327 " ----- ---- --------\n",
328 max_stack_trace
.nr_entries
- 1);
330 if (!stack_tracer_enabled
&& !max_stack_size
)
338 if (i
>= max_stack_trace
.nr_entries
||
339 stack_dump_trace
[i
] == ULONG_MAX
)
342 if (i
+1 == max_stack_trace
.nr_entries
||
343 stack_dump_trace
[i
+1] == ULONG_MAX
)
344 size
= stack_dump_index
[i
];
346 size
= stack_dump_index
[i
] - stack_dump_index
[i
+1];
348 seq_printf(m
, "%3ld) %8d %5d ", i
, stack_dump_index
[i
], size
);
350 trace_lookup_stack(m
, i
);
355 static const struct seq_operations stack_trace_seq_ops
= {
362 static int stack_trace_open(struct inode
*inode
, struct file
*file
)
364 return seq_open(file
, &stack_trace_seq_ops
);
367 static const struct file_operations stack_trace_fops
= {
368 .open
= stack_trace_open
,
371 .release
= seq_release
,
375 stack_trace_filter_open(struct inode
*inode
, struct file
*file
)
377 return ftrace_regex_open(&trace_ops
, FTRACE_ITER_FILTER
,
381 static const struct file_operations stack_trace_filter_fops
= {
382 .open
= stack_trace_filter_open
,
384 .write
= ftrace_filter_write
,
385 .llseek
= ftrace_filter_lseek
,
386 .release
= ftrace_regex_release
,
390 stack_trace_sysctl(struct ctl_table
*table
, int write
,
391 void __user
*buffer
, size_t *lenp
,
396 mutex_lock(&stack_sysctl_mutex
);
398 ret
= proc_dointvec(table
, write
, buffer
, lenp
, ppos
);
401 (last_stack_tracer_enabled
== !!stack_tracer_enabled
))
404 last_stack_tracer_enabled
= !!stack_tracer_enabled
;
406 if (stack_tracer_enabled
)
407 register_ftrace_function(&trace_ops
);
409 unregister_ftrace_function(&trace_ops
);
412 mutex_unlock(&stack_sysctl_mutex
);
416 static char stack_trace_filter_buf
[COMMAND_LINE_SIZE
+1] __initdata
;
418 static __init
int enable_stacktrace(char *str
)
420 if (strncmp(str
, "_filter=", 8) == 0)
421 strncpy(stack_trace_filter_buf
, str
+8, COMMAND_LINE_SIZE
);
423 stack_tracer_enabled
= 1;
424 last_stack_tracer_enabled
= 1;
427 __setup("stacktrace", enable_stacktrace
);
429 static __init
int stack_trace_init(void)
431 struct dentry
*d_tracer
;
433 d_tracer
= tracing_init_dentry();
437 trace_create_file("stack_max_size", 0644, d_tracer
,
438 &max_stack_size
, &stack_max_size_fops
);
440 trace_create_file("stack_trace", 0444, d_tracer
,
441 NULL
, &stack_trace_fops
);
443 trace_create_file("stack_trace_filter", 0444, d_tracer
,
444 NULL
, &stack_trace_filter_fops
);
446 if (stack_trace_filter_buf
[0])
447 ftrace_set_early_filter(&trace_ops
, stack_trace_filter_buf
, 1);
449 if (stack_tracer_enabled
)
450 register_ftrace_function(&trace_ops
);
455 device_initcall(stack_trace_init
);