trace_stack.c 10.7 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 131 132 133 134
	/*
	 * 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;

135 136 137
	/*
	 * Now find where in the stack these are.
	 */
138
	x = 0;
139
	start = stack;
140 141 142 143 144 145 146 147 148 149
	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.
	 */
150
	while (i < stack_trace_max.nr_entries) {
151
		int found = 0;
152

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

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

181 182
		if (!found)
			i++;
183 184
	}

185
	stack_trace_max.nr_entries = x;
186 187 188
	for (; x < i; x++)
		stack_dump_trace[x] = ULONG_MAX;

189
	if (task_stack_end_corrupted(current)) {
190
		stack_trace_print();
191 192 193
		BUG();
	}

Steven Rostedt's avatar
Steven Rostedt committed
194
 out:
195
	rcu_irq_exit();
196
	arch_spin_unlock(&stack_trace_max_lock);
197
	local_irq_restore(flags);
Steven Rostedt's avatar
Steven Rostedt committed
198 199 200
}

static void
201 202
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
203
{
204
	unsigned long stack;
205
	int cpu;
Steven Rostedt's avatar
Steven Rostedt committed
206

207
	preempt_disable_notrace();
Steven Rostedt's avatar
Steven Rostedt committed
208 209 210 211 212 213

	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;

214
	ip += MCOUNT_INSN_SIZE;
215 216

	check_stack(ip, &stack);
Steven Rostedt's avatar
Steven Rostedt committed
217 218 219 220

 out:
	per_cpu(trace_active, cpu)--;
	/* prevent recursion in schedule */
221
	preempt_enable_notrace();
Steven Rostedt's avatar
Steven Rostedt committed
222 223 224 225 226
}

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

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

253 254
	ret = kstrtoul_from_user(ubuf, count, 10, &val);
	if (ret)
Steven Rostedt's avatar
Steven Rostedt committed
255 256
		return ret;

257
	local_irq_save(flags);
258 259 260 261 262 263 264 265 266

	/*
	 * 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)++;

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

	per_cpu(trace_active, cpu)--;
272
	local_irq_restore(flags);
Steven Rostedt's avatar
Steven Rostedt committed
273 274 275 276

	return count;
}

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

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

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

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

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

Li Zefan's avatar
Li Zefan committed
303 304
static void *t_start(struct seq_file *m, loff_t *pos)
{
305 306
	int cpu;

Steven Rostedt's avatar
Steven Rostedt committed
307
	local_irq_disable();
308 309 310 311

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

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

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

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

static void t_stop(struct seq_file *m, void *p)
{
322 323
	int cpu;

324
	arch_spin_unlock(&stack_trace_max_lock);
325 326 327 328

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

Steven Rostedt's avatar
Steven Rostedt committed
329 330 331
	local_irq_enable();
}

332
static void trace_lookup_stack(struct seq_file *m, long i)
Steven Rostedt's avatar
Steven Rostedt committed
333
{
334
	unsigned long addr = stack_dump_trace[i];
Steven Rostedt's avatar
Steven Rostedt committed
335

336
	seq_printf(m, "%pS\n", (void *)addr);
Steven Rostedt's avatar
Steven Rostedt committed
337 338
}

339 340 341 342 343 344 345 346 347 348 349
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
350 351
static int t_show(struct seq_file *m, void *v)
{
352
	long i;
353 354
	int size;

355
	if (v == SEQ_START_TOKEN) {
356
		seq_printf(m, "        Depth    Size   Location"
357
			   "    (%d entries)\n"
358
			   "        -----    ----   --------\n",
359
			   stack_trace_max.nr_entries);
360

361
		if (!stack_tracer_enabled && !stack_trace_max_size)
362 363
			print_disabled(m);

364 365
		return 0;
	}
Steven Rostedt's avatar
Steven Rostedt committed
366

367 368
	i = *(long *)v;

369
	if (i >= stack_trace_max.nr_entries ||
370
	    stack_dump_trace[i] == ULONG_MAX)
Steven Rostedt's avatar
Steven Rostedt committed
371 372
		return 0;

373
	if (i+1 == stack_trace_max.nr_entries ||
374
	    stack_dump_trace[i+1] == ULONG_MAX)
375
		size = stack_trace_index[i];
376
	else
377
		size = stack_trace_index[i] - stack_trace_index[i+1];
378

379
	seq_printf(m, "%3ld) %8d   %5d   ", i, stack_trace_index[i], size);
380 381

	trace_lookup_stack(m, i);
Steven Rostedt's avatar
Steven Rostedt committed
382 383 384 385

	return 0;
}

386
static const struct seq_operations stack_trace_seq_ops = {
Steven Rostedt's avatar
Steven Rostedt committed
387 388 389 390 391 392 393 394
	.start		= t_start,
	.next		= t_next,
	.stop		= t_stop,
	.show		= t_show,
};

static int stack_trace_open(struct inode *inode, struct file *file)
{
395
	return seq_open(file, &stack_trace_seq_ops);
Steven Rostedt's avatar
Steven Rostedt committed
396 397
}

398
static const struct file_operations stack_trace_fops = {
Steven Rostedt's avatar
Steven Rostedt committed
399 400 401
	.open		= stack_trace_open,
	.read		= seq_read,
	.llseek		= seq_lseek,
402
	.release	= seq_release,
Steven Rostedt's avatar
Steven Rostedt committed
403 404
};

405 406 407 408 409 410 411 412 413 414 415
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,
416
	.llseek = tracing_lseek,
417 418 419
	.release = ftrace_regex_release,
};

420 421
int
stack_trace_sysctl(struct ctl_table *table, int write,
422
		   void __user *buffer, size_t *lenp,
423 424 425 426 427 428
		   loff_t *ppos)
{
	int ret;

	mutex_lock(&stack_sysctl_mutex);

429
	ret = proc_dointvec(table, write, buffer, lenp, ppos);
430 431

	if (ret || !write ||
432
	    (last_stack_tracer_enabled == !!stack_tracer_enabled))
433 434
		goto out;

435
	last_stack_tracer_enabled = !!stack_tracer_enabled;
436 437 438 439 440 441 442 443 444 445 446

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

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

447 448
static char stack_trace_filter_buf[COMMAND_LINE_SIZE+1] __initdata;

449 450
static __init int enable_stacktrace(char *str)
{
451 452 453
	if (strncmp(str, "_filter=", 8) == 0)
		strncpy(stack_trace_filter_buf, str+8, COMMAND_LINE_SIZE);

454 455
	stack_tracer_enabled = 1;
	last_stack_tracer_enabled = 1;
456 457 458 459
	return 1;
}
__setup("stacktrace", enable_stacktrace);

Steven Rostedt's avatar
Steven Rostedt committed
460 461 462 463 464
static __init int stack_trace_init(void)
{
	struct dentry *d_tracer;

	d_tracer = tracing_init_dentry();
465
	if (IS_ERR(d_tracer))
466
		return 0;
Steven Rostedt's avatar
Steven Rostedt committed
467

468
	trace_create_file("stack_max_size", 0644, d_tracer,
469
			&stack_trace_max_size, &stack_max_size_fops);
Steven Rostedt's avatar
Steven Rostedt committed
470

471 472
	trace_create_file("stack_trace", 0444, d_tracer,
			NULL, &stack_trace_fops);
Steven Rostedt's avatar
Steven Rostedt committed
473

474 475 476
	trace_create_file("stack_trace_filter", 0444, d_tracer,
			NULL, &stack_trace_filter_fops);

477 478 479
	if (stack_trace_filter_buf[0])
		ftrace_set_early_filter(&trace_ops, stack_trace_filter_buf, 1);

480
	if (stack_tracer_enabled)
481
		register_ftrace_function(&trace_ops);
Steven Rostedt's avatar
Steven Rostedt committed
482 483 484 485 486

	return 0;
}

device_initcall(stack_trace_init);