trace_stack.c 10.8 KB
Newer Older
Steven Rostedt's avatar
Steven Rostedt committed
1 2 3 4
/*
 * Copyright (C) 2008 Steven Rostedt <srostedt@redhat.com>
 *
 */
5
#include <linux/sched/task_stack.h>
Steven Rostedt's avatar
Steven Rostedt committed
6 7 8 9 10 11 12
#include <linux/stacktrace.h>
#include <linux/kallsyms.h>
#include <linux/seq_file.h>
#include <linux/spinlock.h>
#include <linux/uaccess.h>
#include <linux/ftrace.h>
#include <linux/module.h>
13
#include <linux/sysctl.h>
Steven Rostedt's avatar
Steven Rostedt committed
14
#include <linux/init.h>
15 16 17

#include <asm/setup.h>

Steven Rostedt's avatar
Steven Rostedt committed
18 19
#include "trace.h"

20 21
static unsigned long stack_dump_trace[STACK_TRACE_ENTRIES+1] =
	 { [0 ... (STACK_TRACE_ENTRIES)] = ULONG_MAX };
22
unsigned stack_trace_index[STACK_TRACE_ENTRIES];
23

24 25 26 27 28
/*
 * Reserve one entry for the passed in ip. This will allow
 * us to remove most or all of the stack size overhead
 * 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],
Steven Rostedt's avatar
Steven Rostedt committed
32 33
};

34
unsigned long stack_trace_max_size;
35
arch_spinlock_t stack_trace_max_lock =
36
	(arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
Steven Rostedt's avatar
Steven Rostedt committed
37

38
DEFINE_PER_CPU(int, disable_stack_tracer);
39 40 41 42
static DEFINE_MUTEX(stack_sysctl_mutex);

int stack_tracer_enabled;
static int last_stack_tracer_enabled;
Steven Rostedt's avatar
Steven Rostedt committed
43

44
void stack_trace_print(void)
45 46 47 48 49 50
{
	long i;
	int size;

	pr_emerg("        Depth    Size   Location    (%d entries)\n"
			   "        -----    ----   --------\n",
51
			   stack_trace_max.nr_entries);
52

53
	for (i = 0; i < stack_trace_max.nr_entries; i++) {
54 55
		if (stack_dump_trace[i] == ULONG_MAX)
			break;
56
		if (i+1 == stack_trace_max.nr_entries ||
57
				stack_dump_trace[i+1] == ULONG_MAX)
58
			size = stack_trace_index[i];
59
		else
60
			size = stack_trace_index[i] - stack_trace_index[i+1];
61

62
		pr_emerg("%3ld) %8d   %5d   %pS\n", i, stack_trace_index[i],
63 64 65 66
				size, (void *)stack_dump_trace[i]);
	}
}

67
/*
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 71 72 73 74 75
 * prevent concurrent updates.
 *     stack_trace_index[]
 *     stack_trace_max
 *     stack_trace_max_size
 */
void __weak
76
check_stack(unsigned long ip, unsigned long *stack)
Steven Rostedt's avatar
Steven Rostedt committed
77
{
78
	unsigned long this_size, flags; unsigned long *p, *top, *start;
79 80
	static int tracer_frame;
	int frame_size = ACCESS_ONCE(tracer_frame);
81
	int i, x;
Steven Rostedt's avatar
Steven Rostedt committed
82

83
	this_size = ((unsigned long)stack) & (THREAD_SIZE-1);
Steven Rostedt's avatar
Steven Rostedt committed
84
	this_size = THREAD_SIZE - this_size;
85 86
	/* Remove the frame of the tracer */
	this_size -= frame_size;
Steven Rostedt's avatar
Steven Rostedt committed
87

88
	if (this_size <= stack_trace_max_size)
Steven Rostedt's avatar
Steven Rostedt committed
89 90
		return;

91
	/* we do not handle interrupt stacks yet */
92
	if (!object_is_on_stack(stack))
93 94
		return;

95 96 97 98
	/* Can't do this from NMI context (can cause deadlocks) */
	if (in_nmi())
		return;

99
	local_irq_save(flags);
100
	arch_spin_lock(&stack_trace_max_lock);
Steven Rostedt's avatar
Steven Rostedt committed
101

102 103 104 105 106 107
	/*
	 * RCU may not be watching, make it see us.
	 * The stack trace code uses rcu_sched.
	 */
	rcu_irq_enter();

108 109 110 111
	/* In case another CPU set the tracer_frame on us */
	if (unlikely(!frame_size))
		this_size -= tracer_frame;

Steven Rostedt's avatar
Steven Rostedt committed
112
	/* a race could have already updated it */
113
	if (this_size <= stack_trace_max_size)
Steven Rostedt's avatar
Steven Rostedt committed
114 115
		goto out;

116
	stack_trace_max_size = this_size;
Steven Rostedt's avatar
Steven Rostedt committed
117

118 119
	stack_trace_max.nr_entries = 0;
	stack_trace_max.skip = 3;
Steven Rostedt's avatar
Steven Rostedt committed
120

121
	save_stack_trace(&stack_trace_max);
Steven Rostedt's avatar
Steven Rostedt committed
122

123
	/* Skip over the overhead of the stack tracer itself */
124
	for (i = 0; i < stack_trace_max.nr_entries; i++) {
125 126 127
		if (stack_dump_trace[i] == ip)
			break;
	}
128

129 130 131 132 133 134 135
	/*
	 * Some archs may not have the passed in ip in the dump.
	 * If that happens, we need to show everything.
	 */
	if (i == stack_trace_max.nr_entries)
		i = 0;

136 137 138
	/*
	 * Now find where in the stack these are.
	 */
139
	x = 0;
140
	start = stack;
141 142 143 144 145 146 147 148 149 150
	top = (unsigned long *)
		(((unsigned long)start & ~(THREAD_SIZE-1)) + THREAD_SIZE);

	/*
	 * Loop through all the entries. One of the entries may
	 * for some reason be missed on the stack, so we may
	 * have to account for them. If they are all there, this
	 * loop will only happen once. This code only takes place
	 * on a new max, so it is far from a fast path.
	 */
151
	while (i < stack_trace_max.nr_entries) {
152
		int found = 0;
153

154
		stack_trace_index[x] = this_size;
155 156
		p = start;

157
		for (; p < top && i < stack_trace_max.nr_entries; p++) {
158 159
			if (stack_dump_trace[i] == ULONG_MAX)
				break;
160 161 162 163 164
			/*
			 * The READ_ONCE_NOCHECK is used to let KASAN know that
			 * this is not a stack-out-of-bounds error.
			 */
			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);
168
				found = 1;
169 170
				/* Start the search from here */
				start = p + 1;
171 172 173 174 175 176 177
				/*
				 * We do not want to show the overhead
				 * of the stack tracer stack in the
				 * max stack. If we haven't figured
				 * out what that is, then figure it out
				 * now.
				 */
178
				if (unlikely(!tracer_frame)) {
179 180
					tracer_frame = (p - stack) *
						sizeof(unsigned long);
181
					stack_trace_max_size -= tracer_frame;
182
				}
183 184 185
			}
		}

186 187
		if (!found)
			i++;
188 189
	}

190
	stack_trace_max.nr_entries = x;
191 192 193
	for (; x < i; x++)
		stack_dump_trace[x] = ULONG_MAX;

194
	if (task_stack_end_corrupted(current)) {
195
		stack_trace_print();
196 197 198
		BUG();
	}

Steven Rostedt's avatar
Steven Rostedt committed
199
 out:
200
	rcu_irq_exit();
201
	arch_spin_unlock(&stack_trace_max_lock);
202
	local_irq_restore(flags);
Steven Rostedt's avatar
Steven Rostedt committed
203 204 205
}

static void
206 207
stack_trace_call(unsigned long ip, unsigned long parent_ip,
		 struct ftrace_ops *op, struct pt_regs *pt_regs)
Steven Rostedt's avatar
Steven Rostedt committed
208
{
209
	unsigned long stack;
Steven Rostedt's avatar
Steven Rostedt committed
210

211
	preempt_disable_notrace();
Steven Rostedt's avatar
Steven Rostedt committed
212 213

	/* no atomic needed, we only modify this variable by this cpu */
214 215
	__this_cpu_inc(disable_stack_tracer);
	if (__this_cpu_read(disable_stack_tracer) != 1)
Steven Rostedt's avatar
Steven Rostedt committed
216 217
		goto out;

218
	ip += MCOUNT_INSN_SIZE;
219 220

	check_stack(ip, &stack);
Steven Rostedt's avatar
Steven Rostedt committed
221 222

 out:
223
	__this_cpu_dec(disable_stack_tracer);
Steven Rostedt's avatar
Steven Rostedt committed
224
	/* prevent recursion in schedule */
225
	preempt_enable_notrace();
Steven Rostedt's avatar
Steven Rostedt committed
226 227 228 229 230
}

static struct ftrace_ops trace_ops __read_mostly =
{
	.func = stack_trace_call,
231
	.flags = FTRACE_OPS_FL_RECURSION_SAFE,
Steven Rostedt's avatar
Steven Rostedt committed
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
};

static ssize_t
stack_max_size_read(struct file *filp, char __user *ubuf,
		    size_t count, loff_t *ppos)
{
	unsigned long *ptr = filp->private_data;
	char buf[64];
	int r;

	r = snprintf(buf, sizeof(buf), "%ld\n", *ptr);
	if (r > sizeof(buf))
		r = sizeof(buf);
	return simple_read_from_buffer(ubuf, count, ppos, buf, r);
}

static ssize_t
stack_max_size_write(struct file *filp, const char __user *ubuf,
		     size_t count, loff_t *ppos)
{
	long *ptr = filp->private_data;
	unsigned long val, flags;
	int ret;

256 257
	ret = kstrtoul_from_user(ubuf, count, 10, &val);
	if (ret)
Steven Rostedt's avatar
Steven Rostedt committed
258 259
		return ret;

260
	local_irq_save(flags);
261 262 263 264

	/*
	 * In case we trace inside arch_spin_lock() or after (NMI),
	 * we will cause circular lock, so we also need to increase
265
	 * the percpu disable_stack_tracer here.
266
	 */
267
	__this_cpu_inc(disable_stack_tracer);
268

269
	arch_spin_lock(&stack_trace_max_lock);
Steven Rostedt's avatar
Steven Rostedt committed
270
	*ptr = val;
271
	arch_spin_unlock(&stack_trace_max_lock);
272

273
	__this_cpu_dec(disable_stack_tracer);
274
	local_irq_restore(flags);
Steven Rostedt's avatar
Steven Rostedt committed
275 276 277 278

	return count;
}

279
static const struct file_operations stack_max_size_fops = {
Steven Rostedt's avatar
Steven Rostedt committed
280 281 282
	.open		= tracing_open_generic,
	.read		= stack_max_size_read,
	.write		= stack_max_size_write,
283
	.llseek		= default_llseek,
Steven Rostedt's avatar
Steven Rostedt committed
284 285 286
};

static void *
Li Zefan's avatar
Li Zefan committed
287
__next(struct seq_file *m, loff_t *pos)
Steven Rostedt's avatar
Steven Rostedt committed
288
{
Li Zefan's avatar
Li Zefan committed
289
	long n = *pos - 1;
Steven Rostedt's avatar
Steven Rostedt committed
290

291
	if (n > stack_trace_max.nr_entries || stack_dump_trace[n] == ULONG_MAX)
Steven Rostedt's avatar
Steven Rostedt committed
292 293
		return NULL;

Li Zefan's avatar
Li Zefan committed
294
	m->private = (void *)n;
295
	return &m->private;
Steven Rostedt's avatar
Steven Rostedt committed
296 297
}

Li Zefan's avatar
Li Zefan committed
298 299
static void *
t_next(struct seq_file *m, void *v, loff_t *pos)
Steven Rostedt's avatar
Steven Rostedt committed
300
{
Li Zefan's avatar
Li Zefan committed
301 302 303
	(*pos)++;
	return __next(m, pos);
}
Steven Rostedt's avatar
Steven Rostedt committed
304

Li Zefan's avatar
Li Zefan committed
305 306
static void *t_start(struct seq_file *m, loff_t *pos)
{
Steven Rostedt's avatar
Steven Rostedt committed
307
	local_irq_disable();
308

309
	__this_cpu_inc(disable_stack_tracer);
310

311
	arch_spin_lock(&stack_trace_max_lock);
Steven Rostedt's avatar
Steven Rostedt committed
312

313 314 315
	if (*pos == 0)
		return SEQ_START_TOKEN;

Li Zefan's avatar
Li Zefan committed
316
	return __next(m, pos);
Steven Rostedt's avatar
Steven Rostedt committed
317 318 319 320
}

static void t_stop(struct seq_file *m, void *p)
{
321
	arch_spin_unlock(&stack_trace_max_lock);
322

323
	__this_cpu_dec(disable_stack_tracer);
324

Steven Rostedt's avatar
Steven Rostedt committed
325 326 327
	local_irq_enable();
}

328
static void trace_lookup_stack(struct seq_file *m, long i)
Steven Rostedt's avatar
Steven Rostedt committed
329
{
330
	unsigned long addr = stack_dump_trace[i];
Steven Rostedt's avatar
Steven Rostedt committed
331

332
	seq_printf(m, "%pS\n", (void *)addr);
Steven Rostedt's avatar
Steven Rostedt committed
333 334
}

335 336 337 338 339 340 341 342 343 344 345
static void print_disabled(struct seq_file *m)
{
	seq_puts(m, "#\n"
		 "#  Stack tracer disabled\n"
		 "#\n"
		 "# To enable the stack tracer, either add 'stacktrace' to the\n"
		 "# kernel command line\n"
		 "# or 'echo 1 > /proc/sys/kernel/stack_tracer_enabled'\n"
		 "#\n");
}

Steven Rostedt's avatar
Steven Rostedt committed
346 347
static int t_show(struct seq_file *m, void *v)
{
348
	long i;
349 350
	int size;

351
	if (v == SEQ_START_TOKEN) {
352
		seq_printf(m, "        Depth    Size   Location"
353
			   "    (%d entries)\n"
354
			   "        -----    ----   --------\n",
355
			   stack_trace_max.nr_entries);
356

357
		if (!stack_tracer_enabled && !stack_trace_max_size)
358 359
			print_disabled(m);

360 361
		return 0;
	}
Steven Rostedt's avatar
Steven Rostedt committed
362

363 364
	i = *(long *)v;

365
	if (i >= stack_trace_max.nr_entries ||
366
	    stack_dump_trace[i] == ULONG_MAX)
Steven Rostedt's avatar
Steven Rostedt committed
367 368
		return 0;

369
	if (i+1 == stack_trace_max.nr_entries ||
370
	    stack_dump_trace[i+1] == ULONG_MAX)
371
		size = stack_trace_index[i];
372
	else
373
		size = stack_trace_index[i] - stack_trace_index[i+1];
374

375
	seq_printf(m, "%3ld) %8d   %5d   ", i, stack_trace_index[i], size);
376 377

	trace_lookup_stack(m, i);
Steven Rostedt's avatar
Steven Rostedt committed
378 379 380 381

	return 0;
}

382
static const struct seq_operations stack_trace_seq_ops = {
Steven Rostedt's avatar
Steven Rostedt committed
383 384 385 386 387 388 389 390
	.start		= t_start,
	.next		= t_next,
	.stop		= t_stop,
	.show		= t_show,
};

static int stack_trace_open(struct inode *inode, struct file *file)
{
391
	return seq_open(file, &stack_trace_seq_ops);
Steven Rostedt's avatar
Steven Rostedt committed
392 393
}

394
static const struct file_operations stack_trace_fops = {
Steven Rostedt's avatar
Steven Rostedt committed
395 396 397
	.open		= stack_trace_open,
	.read		= seq_read,
	.llseek		= seq_lseek,
398
	.release	= seq_release,
Steven Rostedt's avatar
Steven Rostedt committed
399 400
};

401 402 403 404 405 406 407 408 409 410 411
static int
stack_trace_filter_open(struct inode *inode, struct file *file)
{
	return ftrace_regex_open(&trace_ops, FTRACE_ITER_FILTER,
				 inode, file);
}

static const struct file_operations stack_trace_filter_fops = {
	.open = stack_trace_filter_open,
	.read = seq_read,
	.write = ftrace_filter_write,
412
	.llseek = tracing_lseek,
413 414 415
	.release = ftrace_regex_release,
};

416 417
int
stack_trace_sysctl(struct ctl_table *table, int write,
418
		   void __user *buffer, size_t *lenp,
419 420 421 422 423 424
		   loff_t *ppos)
{
	int ret;

	mutex_lock(&stack_sysctl_mutex);

425
	ret = proc_dointvec(table, write, buffer, lenp, ppos);
426 427

	if (ret || !write ||
428
	    (last_stack_tracer_enabled == !!stack_tracer_enabled))
429 430
		goto out;

431
	last_stack_tracer_enabled = !!stack_tracer_enabled;
432 433 434 435 436 437 438 439 440 441 442

	if (stack_tracer_enabled)
		register_ftrace_function(&trace_ops);
	else
		unregister_ftrace_function(&trace_ops);

 out:
	mutex_unlock(&stack_sysctl_mutex);
	return ret;
}

443 444
static char stack_trace_filter_buf[COMMAND_LINE_SIZE+1] __initdata;

445 446
static __init int enable_stacktrace(char *str)
{
447 448 449
	if (strncmp(str, "_filter=", 8) == 0)
		strncpy(stack_trace_filter_buf, str+8, COMMAND_LINE_SIZE);

450 451
	stack_tracer_enabled = 1;
	last_stack_tracer_enabled = 1;
452 453 454 455
	return 1;
}
__setup("stacktrace", enable_stacktrace);

Steven Rostedt's avatar
Steven Rostedt committed
456 457 458 459 460
static __init int stack_trace_init(void)
{
	struct dentry *d_tracer;

	d_tracer = tracing_init_dentry();
461
	if (IS_ERR(d_tracer))
462
		return 0;
Steven Rostedt's avatar
Steven Rostedt committed
463

464
	trace_create_file("stack_max_size", 0644, d_tracer,
465
			&stack_trace_max_size, &stack_max_size_fops);
Steven Rostedt's avatar
Steven Rostedt committed
466

467 468
	trace_create_file("stack_trace", 0444, d_tracer,
			NULL, &stack_trace_fops);
Steven Rostedt's avatar
Steven Rostedt committed
469

470 471 472
	trace_create_file("stack_trace_filter", 0444, d_tracer,
			NULL, &stack_trace_filter_fops);

473 474 475
	if (stack_trace_filter_buf[0])
		ftrace_set_early_filter(&trace_ops, stack_trace_filter_buf, 1);

476
	if (stack_tracer_enabled)
477
		register_ftrace_function(&trace_ops);
Steven Rostedt's avatar
Steven Rostedt committed
478 479 480 481 482

	return 0;
}

device_initcall(stack_trace_init);