trace_stack.c 10.5 KB
Newer Older
Steven Rostedt's avatar
Steven Rostedt committed
1 2 3 4 5 6 7 8 9 10 11
/*
 * Copyright (C) 2008 Steven Rostedt <srostedt@redhat.com>
 *
 */
#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>
12
#include <linux/sysctl.h>
Steven Rostedt's avatar
Steven Rostedt committed
13
#include <linux/init.h>
14 15 16

#include <asm/setup.h>

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

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

23 24 25 26 27
/*
 * 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.
 */
28
struct stack_trace stack_trace_max = {
29
	.max_entries		= STACK_TRACE_ENTRIES - 1,
30
	.entries		= &stack_dump_trace[0],
Steven Rostedt's avatar
Steven Rostedt committed
31 32
};

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

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

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

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

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

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

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

66 67
/*
 * When arch-specific code overides this function, the following
68
 * data should be filled up, assuming stack_trace_max_lock is held to
69 70 71 72 73 74
 * prevent concurrent updates.
 *     stack_trace_index[]
 *     stack_trace_max
 *     stack_trace_max_size
 */
void __weak
75
check_stack(unsigned long ip, unsigned long *stack)
Steven Rostedt's avatar
Steven Rostedt committed
76
{
77
	unsigned long this_size, flags; unsigned long *p, *top, *start;
78 79
	static int tracer_frame;
	int frame_size = ACCESS_ONCE(tracer_frame);
80
	int i, x;
Steven Rostedt's avatar
Steven Rostedt committed
81

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

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

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

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

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

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

107 108 109 110
	/* 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
111
	/* a race could have already updated it */
112
	if (this_size <= stack_trace_max_size)
Steven Rostedt's avatar
Steven Rostedt committed
113 114
		goto out;

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

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

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

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

128 129 130
	/*
	 * Now find where in the stack these are.
	 */
131
	x = 0;
132
	start = stack;
133 134 135 136 137 138 139 140 141 142
	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.
	 */
143
	while (i < stack_trace_max.nr_entries) {
144
		int found = 0;
145

146
		stack_trace_index[x] = this_size;
147 148
		p = start;

149
		for (; p < top && i < stack_trace_max.nr_entries; p++) {
150 151
			if (stack_dump_trace[i] == ULONG_MAX)
				break;
152
			if (*p == stack_dump_trace[i]) {
153
				stack_dump_trace[x] = stack_dump_trace[i++];
154
				this_size = stack_trace_index[x++] =
155
					(top - p) * sizeof(unsigned long);
156
				found = 1;
157 158
				/* Start the search from here */
				start = p + 1;
159 160 161 162 163 164 165
				/*
				 * 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.
				 */
166
				if (unlikely(!tracer_frame)) {
167 168
					tracer_frame = (p - stack) *
						sizeof(unsigned long);
169
					stack_trace_max_size -= tracer_frame;
170
				}
171 172 173
			}
		}

174 175
		if (!found)
			i++;
176 177
	}

178
	stack_trace_max.nr_entries = x;
179 180 181
	for (; x < i; x++)
		stack_dump_trace[x] = ULONG_MAX;

182
	if (task_stack_end_corrupted(current)) {
183
		stack_trace_print();
184 185 186
		BUG();
	}

Steven Rostedt's avatar
Steven Rostedt committed
187
 out:
188
	rcu_irq_exit();
189
	arch_spin_unlock(&stack_trace_max_lock);
190
	local_irq_restore(flags);
Steven Rostedt's avatar
Steven Rostedt committed
191 192 193
}

static void
194 195
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
196
{
197
	unsigned long stack;
198
	int cpu;
Steven Rostedt's avatar
Steven Rostedt committed
199

200
	preempt_disable_notrace();
Steven Rostedt's avatar
Steven Rostedt committed
201 202 203 204 205 206

	cpu = raw_smp_processor_id();
	/* no atomic needed, we only modify this variable by this cpu */
	if (per_cpu(trace_active, cpu)++ != 0)
		goto out;

207
	ip += MCOUNT_INSN_SIZE;
208 209

	check_stack(ip, &stack);
Steven Rostedt's avatar
Steven Rostedt committed
210 211 212 213

 out:
	per_cpu(trace_active, cpu)--;
	/* prevent recursion in schedule */
214
	preempt_enable_notrace();
Steven Rostedt's avatar
Steven Rostedt committed
215 216 217 218 219
}

static struct ftrace_ops trace_ops __read_mostly =
{
	.func = stack_trace_call,
220
	.flags = FTRACE_OPS_FL_RECURSION_SAFE,
Steven Rostedt's avatar
Steven Rostedt committed
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
};

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;
244
	int cpu;
Steven Rostedt's avatar
Steven Rostedt committed
245

246 247
	ret = kstrtoul_from_user(ubuf, count, 10, &val);
	if (ret)
Steven Rostedt's avatar
Steven Rostedt committed
248 249
		return ret;

250
	local_irq_save(flags);
251 252 253 254 255 256 257 258 259

	/*
	 * In case we trace inside arch_spin_lock() or after (NMI),
	 * we will cause circular lock, so we also need to increase
	 * the percpu trace_active here.
	 */
	cpu = smp_processor_id();
	per_cpu(trace_active, cpu)++;

260
	arch_spin_lock(&stack_trace_max_lock);
Steven Rostedt's avatar
Steven Rostedt committed
261
	*ptr = val;
262
	arch_spin_unlock(&stack_trace_max_lock);
263 264

	per_cpu(trace_active, cpu)--;
265
	local_irq_restore(flags);
Steven Rostedt's avatar
Steven Rostedt committed
266 267 268 269

	return count;
}

270
static const struct file_operations stack_max_size_fops = {
Steven Rostedt's avatar
Steven Rostedt committed
271 272 273
	.open		= tracing_open_generic,
	.read		= stack_max_size_read,
	.write		= stack_max_size_write,
274
	.llseek		= default_llseek,
Steven Rostedt's avatar
Steven Rostedt committed
275 276 277
};

static void *
Li Zefan's avatar
Li Zefan committed
278
__next(struct seq_file *m, loff_t *pos)
Steven Rostedt's avatar
Steven Rostedt committed
279
{
Li Zefan's avatar
Li Zefan committed
280
	long n = *pos - 1;
Steven Rostedt's avatar
Steven Rostedt committed
281

282
	if (n > stack_trace_max.nr_entries || stack_dump_trace[n] == ULONG_MAX)
Steven Rostedt's avatar
Steven Rostedt committed
283 284
		return NULL;

Li Zefan's avatar
Li Zefan committed
285
	m->private = (void *)n;
286
	return &m->private;
Steven Rostedt's avatar
Steven Rostedt committed
287 288
}

Li Zefan's avatar
Li Zefan committed
289 290
static void *
t_next(struct seq_file *m, void *v, loff_t *pos)
Steven Rostedt's avatar
Steven Rostedt committed
291
{
Li Zefan's avatar
Li Zefan committed
292 293 294
	(*pos)++;
	return __next(m, pos);
}
Steven Rostedt's avatar
Steven Rostedt committed
295

Li Zefan's avatar
Li Zefan committed
296 297
static void *t_start(struct seq_file *m, loff_t *pos)
{
298 299
	int cpu;

Steven Rostedt's avatar
Steven Rostedt committed
300
	local_irq_disable();
301 302 303 304

	cpu = smp_processor_id();
	per_cpu(trace_active, cpu)++;

305
	arch_spin_lock(&stack_trace_max_lock);
Steven Rostedt's avatar
Steven Rostedt committed
306

307 308 309
	if (*pos == 0)
		return SEQ_START_TOKEN;

Li Zefan's avatar
Li Zefan committed
310
	return __next(m, pos);
Steven Rostedt's avatar
Steven Rostedt committed
311 312 313 314
}

static void t_stop(struct seq_file *m, void *p)
{
315 316
	int cpu;

317
	arch_spin_unlock(&stack_trace_max_lock);
318 319 320 321

	cpu = smp_processor_id();
	per_cpu(trace_active, cpu)--;

Steven Rostedt's avatar
Steven Rostedt committed
322 323 324
	local_irq_enable();
}

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

329
	seq_printf(m, "%pS\n", (void *)addr);
Steven Rostedt's avatar
Steven Rostedt committed
330 331
}

332 333 334 335 336 337 338 339 340 341 342
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
343 344
static int t_show(struct seq_file *m, void *v)
{
345
	long i;
346 347
	int size;

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

354
		if (!stack_tracer_enabled && !stack_trace_max_size)
355 356
			print_disabled(m);

357 358
		return 0;
	}
Steven Rostedt's avatar
Steven Rostedt committed
359

360 361
	i = *(long *)v;

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

366
	if (i+1 == stack_trace_max.nr_entries ||
367
	    stack_dump_trace[i+1] == ULONG_MAX)
368
		size = stack_trace_index[i];
369
	else
370
		size = stack_trace_index[i] - stack_trace_index[i+1];
371

372
	seq_printf(m, "%3ld) %8d   %5d   ", i, stack_trace_index[i], size);
373 374

	trace_lookup_stack(m, i);
Steven Rostedt's avatar
Steven Rostedt committed
375 376 377 378

	return 0;
}

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

static int stack_trace_open(struct inode *inode, struct file *file)
{
388
	return seq_open(file, &stack_trace_seq_ops);
Steven Rostedt's avatar
Steven Rostedt committed
389 390
}

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

398 399 400 401 402 403 404 405 406 407 408
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,
409
	.llseek = tracing_lseek,
410 411 412
	.release = ftrace_regex_release,
};

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

	mutex_lock(&stack_sysctl_mutex);

422
	ret = proc_dointvec(table, write, buffer, lenp, ppos);
423 424

	if (ret || !write ||
425
	    (last_stack_tracer_enabled == !!stack_tracer_enabled))
426 427
		goto out;

428
	last_stack_tracer_enabled = !!stack_tracer_enabled;
429 430 431 432 433 434 435 436 437 438 439

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

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

440 441
static char stack_trace_filter_buf[COMMAND_LINE_SIZE+1] __initdata;

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

447 448
	stack_tracer_enabled = 1;
	last_stack_tracer_enabled = 1;
449 450 451 452
	return 1;
}
__setup("stacktrace", enable_stacktrace);

Steven Rostedt's avatar
Steven Rostedt committed
453 454 455 456 457
static __init int stack_trace_init(void)
{
	struct dentry *d_tracer;

	d_tracer = tracing_init_dentry();
458
	if (IS_ERR(d_tracer))
459
		return 0;
Steven Rostedt's avatar
Steven Rostedt committed
460

461
	trace_create_file("stack_max_size", 0644, d_tracer,
462
			&stack_trace_max_size, &stack_max_size_fops);
Steven Rostedt's avatar
Steven Rostedt committed
463

464 465
	trace_create_file("stack_trace", 0444, d_tracer,
			NULL, &stack_trace_fops);
Steven Rostedt's avatar
Steven Rostedt committed
466

467 468 469
	trace_create_file("stack_trace_filter", 0444, d_tracer,
			NULL, &stack_trace_filter_fops);

470 471 472
	if (stack_trace_filter_buf[0])
		ftrace_set_early_filter(&trace_ops, stack_trace_filter_buf, 1);

473
	if (stack_tracer_enabled)
474
		register_ftrace_function(&trace_ops);
Steven Rostedt's avatar
Steven Rostedt committed
475 476 477 478 479

	return 0;
}

device_initcall(stack_trace_init);