trace_stack.c 9.11 KB
Newer Older
Steven Rostedt's avatar
Steven Rostedt committed
1 2 3 4 5 6 7 8 9 10 11 12
/*
 * 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/debugfs.h>
#include <linux/ftrace.h>
#include <linux/module.h>
13
#include <linux/sysctl.h>
Steven Rostedt's avatar
Steven Rostedt committed
14 15
#include <linux/init.h>
#include <linux/fs.h>
16 17 18

#include <asm/setup.h>

Steven Rostedt's avatar
Steven Rostedt committed
19 20 21 22
#include "trace.h"

#define STACK_TRACE_ENTRIES 500

23 24 25 26 27 28 29 30 31 32 33 34 35 36
/*
 * If fentry is used, then the function being traced will
 * jump to fentry directly before it sets up its stack frame.
 * We need to ignore that one and record the parent. Since
 * the stack frame for the traced function wasn't set up yet,
 * the stack_trace wont see the parent. That needs to be added
 * manually to stack_dump_trace[] as the first element.
 */
#ifdef CC_USING_FENTRY
# define add_func	1
#else
# define add_func	0
#endif

37 38 39 40
static unsigned long stack_dump_trace[STACK_TRACE_ENTRIES+1] =
	 { [0 ... (STACK_TRACE_ENTRIES)] = ULONG_MAX };
static unsigned stack_dump_index[STACK_TRACE_ENTRIES];

Steven Rostedt's avatar
Steven Rostedt committed
41
static struct stack_trace max_stack_trace = {
42 43
	.max_entries		= STACK_TRACE_ENTRIES - add_func,
	.entries		= &stack_dump_trace[add_func],
Steven Rostedt's avatar
Steven Rostedt committed
44 45 46
};

static unsigned long max_stack_size;
47
static arch_spinlock_t max_stack_lock =
48
	(arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
Steven Rostedt's avatar
Steven Rostedt committed
49 50

static DEFINE_PER_CPU(int, trace_active);
51 52 53 54
static DEFINE_MUTEX(stack_sysctl_mutex);

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

56
static inline void
57
check_stack(unsigned long ip, unsigned long *stack)
Steven Rostedt's avatar
Steven Rostedt committed
58
{
59 60 61
	unsigned long this_size, flags;
	unsigned long *p, *top, *start;
	int i;
Steven Rostedt's avatar
Steven Rostedt committed
62

63
	this_size = ((unsigned long)stack) & (THREAD_SIZE-1);
Steven Rostedt's avatar
Steven Rostedt committed
64 65 66 67 68
	this_size = THREAD_SIZE - this_size;

	if (this_size <= max_stack_size)
		return;

69
	/* we do not handle interrupt stacks yet */
70
	if (!object_is_on_stack(stack))
71 72
		return;

73
	local_irq_save(flags);
74
	arch_spin_lock(&max_stack_lock);
Steven Rostedt's avatar
Steven Rostedt committed
75 76 77 78 79 80 81 82

	/* a race could have already updated it */
	if (this_size <= max_stack_size)
		goto out;

	max_stack_size = this_size;

	max_stack_trace.nr_entries	= 0;
83
	max_stack_trace.skip		= 3;
Steven Rostedt's avatar
Steven Rostedt committed
84 85 86

	save_stack_trace(&max_stack_trace);

87 88 89 90 91 92 93 94 95 96 97
	/*
	 * When fentry is used, the traced function does not get
	 * its stack frame set up, and we lose the parent.
	 * Add that one in manally. We set up save_stack_trace()
	 * to not touch the first element in this case.
	 */
	if (add_func) {
		stack_dump_trace[0] = ip;
		max_stack_trace.nr_entries++;
	}

98 99 100 101
	/*
	 * Now find where in the stack these are.
	 */
	i = 0;
102
	start = stack;
103 104 105 106 107 108 109 110 111 112 113
	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.
	 */
	while (i < max_stack_trace.nr_entries) {
114
		int found = 0;
115 116 117 118 119 120 121 122

		stack_dump_index[i] = this_size;
		p = start;

		for (; p < top && i < max_stack_trace.nr_entries; p++) {
			if (*p == stack_dump_trace[i]) {
				this_size = stack_dump_index[i++] =
					(top - p) * sizeof(unsigned long);
123
				found = 1;
124 125 126 127 128
				/* Start the search from here */
				start = p + 1;
			}
		}

129 130
		if (!found)
			i++;
131 132
	}

Steven Rostedt's avatar
Steven Rostedt committed
133
 out:
134
	arch_spin_unlock(&max_stack_lock);
135
	local_irq_restore(flags);
Steven Rostedt's avatar
Steven Rostedt committed
136 137 138
}

static void
139 140
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
141
{
142
	unsigned long stack;
143
	int cpu;
Steven Rostedt's avatar
Steven Rostedt committed
144

145
	preempt_disable_notrace();
Steven Rostedt's avatar
Steven Rostedt committed
146 147 148 149 150 151

	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;

152
	check_stack(parent_ip, &stack);
Steven Rostedt's avatar
Steven Rostedt committed
153 154 155 156

 out:
	per_cpu(trace_active, cpu)--;
	/* prevent recursion in schedule */
157
	preempt_enable_notrace();
Steven Rostedt's avatar
Steven Rostedt committed
158 159 160 161 162
}

static struct ftrace_ops trace_ops __read_mostly =
{
	.func = stack_trace_call,
163
	.flags = FTRACE_OPS_FL_RECURSION_SAFE,
Steven Rostedt's avatar
Steven Rostedt committed
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
};

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

189 190
	ret = kstrtoul_from_user(ubuf, count, 10, &val);
	if (ret)
Steven Rostedt's avatar
Steven Rostedt committed
191 192
		return ret;

193
	local_irq_save(flags);
194 195 196 197 198 199 200 201 202

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

203
	arch_spin_lock(&max_stack_lock);
Steven Rostedt's avatar
Steven Rostedt committed
204
	*ptr = val;
205
	arch_spin_unlock(&max_stack_lock);
206 207

	per_cpu(trace_active, cpu)--;
208
	local_irq_restore(flags);
Steven Rostedt's avatar
Steven Rostedt committed
209 210 211 212

	return count;
}

213
static const struct file_operations stack_max_size_fops = {
Steven Rostedt's avatar
Steven Rostedt committed
214 215 216
	.open		= tracing_open_generic,
	.read		= stack_max_size_read,
	.write		= stack_max_size_write,
217
	.llseek		= default_llseek,
Steven Rostedt's avatar
Steven Rostedt committed
218 219 220
};

static void *
Li Zefan's avatar
Li Zefan committed
221
__next(struct seq_file *m, loff_t *pos)
Steven Rostedt's avatar
Steven Rostedt committed
222
{
Li Zefan's avatar
Li Zefan committed
223
	long n = *pos - 1;
Steven Rostedt's avatar
Steven Rostedt committed
224

Li Zefan's avatar
Li Zefan committed
225
	if (n >= max_stack_trace.nr_entries || stack_dump_trace[n] == ULONG_MAX)
Steven Rostedt's avatar
Steven Rostedt committed
226 227
		return NULL;

Li Zefan's avatar
Li Zefan committed
228
	m->private = (void *)n;
229
	return &m->private;
Steven Rostedt's avatar
Steven Rostedt committed
230 231
}

Li Zefan's avatar
Li Zefan committed
232 233
static void *
t_next(struct seq_file *m, void *v, loff_t *pos)
Steven Rostedt's avatar
Steven Rostedt committed
234
{
Li Zefan's avatar
Li Zefan committed
235 236 237
	(*pos)++;
	return __next(m, pos);
}
Steven Rostedt's avatar
Steven Rostedt committed
238

Li Zefan's avatar
Li Zefan committed
239 240
static void *t_start(struct seq_file *m, loff_t *pos)
{
241 242
	int cpu;

Steven Rostedt's avatar
Steven Rostedt committed
243
	local_irq_disable();
244 245 246 247

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

248
	arch_spin_lock(&max_stack_lock);
Steven Rostedt's avatar
Steven Rostedt committed
249

250 251 252
	if (*pos == 0)
		return SEQ_START_TOKEN;

Li Zefan's avatar
Li Zefan committed
253
	return __next(m, pos);
Steven Rostedt's avatar
Steven Rostedt committed
254 255 256 257
}

static void t_stop(struct seq_file *m, void *p)
{
258 259
	int cpu;

260
	arch_spin_unlock(&max_stack_lock);
261 262 263 264

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

Steven Rostedt's avatar
Steven Rostedt committed
265 266 267
	local_irq_enable();
}

268
static int trace_lookup_stack(struct seq_file *m, long i)
Steven Rostedt's avatar
Steven Rostedt committed
269
{
270
	unsigned long addr = stack_dump_trace[i];
Steven Rostedt's avatar
Steven Rostedt committed
271

272
	return seq_printf(m, "%pS\n", (void *)addr);
Steven Rostedt's avatar
Steven Rostedt committed
273 274
}

275 276 277 278 279 280 281 282 283 284 285
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
286 287
static int t_show(struct seq_file *m, void *v)
{
288
	long i;
289 290
	int size;

291
	if (v == SEQ_START_TOKEN) {
292
		seq_printf(m, "        Depth    Size   Location"
293
			   "    (%d entries)\n"
294
			   "        -----    ----   --------\n",
295
			   max_stack_trace.nr_entries - 1);
296 297 298 299

		if (!stack_tracer_enabled && !max_stack_size)
			print_disabled(m);

300 301
		return 0;
	}
Steven Rostedt's avatar
Steven Rostedt committed
302

303 304
	i = *(long *)v;

305 306
	if (i >= max_stack_trace.nr_entries ||
	    stack_dump_trace[i] == ULONG_MAX)
Steven Rostedt's avatar
Steven Rostedt committed
307 308
		return 0;

309 310 311 312 313 314 315 316 317
	if (i+1 == max_stack_trace.nr_entries ||
	    stack_dump_trace[i+1] == ULONG_MAX)
		size = stack_dump_index[i];
	else
		size = stack_dump_index[i] - stack_dump_index[i+1];

	seq_printf(m, "%3ld) %8d   %5d   ", i, stack_dump_index[i], size);

	trace_lookup_stack(m, i);
Steven Rostedt's avatar
Steven Rostedt committed
318 319 320 321

	return 0;
}

322
static const struct seq_operations stack_trace_seq_ops = {
Steven Rostedt's avatar
Steven Rostedt committed
323 324 325 326 327 328 329 330
	.start		= t_start,
	.next		= t_next,
	.stop		= t_stop,
	.show		= t_show,
};

static int stack_trace_open(struct inode *inode, struct file *file)
{
331
	return seq_open(file, &stack_trace_seq_ops);
Steven Rostedt's avatar
Steven Rostedt committed
332 333
}

334
static const struct file_operations stack_trace_fops = {
Steven Rostedt's avatar
Steven Rostedt committed
335 336 337
	.open		= stack_trace_open,
	.read		= seq_read,
	.llseek		= seq_lseek,
338
	.release	= seq_release,
Steven Rostedt's avatar
Steven Rostedt committed
339 340
};

341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
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,
	.llseek = ftrace_regex_lseek,
	.release = ftrace_regex_release,
};

356 357
int
stack_trace_sysctl(struct ctl_table *table, int write,
358
		   void __user *buffer, size_t *lenp,
359 360 361 362 363 364
		   loff_t *ppos)
{
	int ret;

	mutex_lock(&stack_sysctl_mutex);

365
	ret = proc_dointvec(table, write, buffer, lenp, ppos);
366 367

	if (ret || !write ||
368
	    (last_stack_tracer_enabled == !!stack_tracer_enabled))
369 370
		goto out;

371
	last_stack_tracer_enabled = !!stack_tracer_enabled;
372 373 374 375 376 377 378 379 380 381 382

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

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

383 384
static char stack_trace_filter_buf[COMMAND_LINE_SIZE+1] __initdata;

385 386
static __init int enable_stacktrace(char *str)
{
387 388 389
	if (strncmp(str, "_filter=", 8) == 0)
		strncpy(stack_trace_filter_buf, str+8, COMMAND_LINE_SIZE);

390 391
	stack_tracer_enabled = 1;
	last_stack_tracer_enabled = 1;
392 393 394 395
	return 1;
}
__setup("stacktrace", enable_stacktrace);

Steven Rostedt's avatar
Steven Rostedt committed
396 397 398 399 400 401
static __init int stack_trace_init(void)
{
	struct dentry *d_tracer;

	d_tracer = tracing_init_dentry();

402 403
	trace_create_file("stack_max_size", 0644, d_tracer,
			&max_stack_size, &stack_max_size_fops);
Steven Rostedt's avatar
Steven Rostedt committed
404

405 406
	trace_create_file("stack_trace", 0444, d_tracer,
			NULL, &stack_trace_fops);
Steven Rostedt's avatar
Steven Rostedt committed
407

408 409 410
	trace_create_file("stack_trace_filter", 0444, d_tracer,
			NULL, &stack_trace_filter_fops);

411 412 413
	if (stack_trace_filter_buf[0])
		ftrace_set_early_filter(&trace_ops, stack_trace_filter_buf, 1);

414
	if (stack_tracer_enabled)
415
		register_ftrace_function(&trace_ops);
Steven Rostedt's avatar
Steven Rostedt committed
416 417 418 419 420

	return 0;
}

device_initcall(stack_trace_init);