trace_events.c 33.9 KB
Newer Older
1 2 3 4 5
/*
 * event tracer
 *
 * Copyright (C) 2008 Red Hat Inc, Steven Rostedt <srostedt@redhat.com>
 *
6 7 8
 *  - Added format output of fields of the trace point.
 *    This was based off of work by Tom Zanussi <tzanussi@gmail.com>.
 *
9 10
 */

11 12 13
#include <linux/workqueue.h>
#include <linux/spinlock.h>
#include <linux/kthread.h>
14 15 16 17
#include <linux/debugfs.h>
#include <linux/uaccess.h>
#include <linux/module.h>
#include <linux/ctype.h>
18
#include <linux/slab.h>
19
#include <linux/delay.h>
20

21 22
#include <asm/setup.h>

23
#include "trace_output.h"
24

25
#undef TRACE_SYSTEM
26 27
#define TRACE_SYSTEM "TRACE_SYSTEM"

28
DEFINE_MUTEX(event_mutex);
29

30
LIST_HEAD(ftrace_events);
31
LIST_HEAD(ftrace_common_fields);
32

33 34 35 36 37 38 39 40
struct list_head *
trace_get_fields(struct ftrace_event_call *event_call)
{
	if (!event_call->class->get_fields)
		return &event_call->class->fields;
	return event_call->class->get_fields(event_call);
}

41 42 43
static int __trace_define_field(struct list_head *head, const char *type,
				const char *name, int offset, int size,
				int is_signed, int filter_type)
44 45 46
{
	struct ftrace_event_field *field;

47
	field = kzalloc(sizeof(*field), GFP_KERNEL);
48 49
	if (!field)
		goto err;
50

51 52 53
	field->name = kstrdup(name, GFP_KERNEL);
	if (!field->name)
		goto err;
54

55 56 57
	field->type = kstrdup(type, GFP_KERNEL);
	if (!field->type)
		goto err;
58

59 60 61 62 63
	if (filter_type == FILTER_OTHER)
		field->filter_type = filter_assign_type(type);
	else
		field->filter_type = filter_type;

64 65
	field->offset = offset;
	field->size = size;
66
	field->is_signed = is_signed;
67

68
	list_add(&field->link, head);
69 70

	return 0;
71

72
err:
73
	if (field)
74 75
		kfree(field->name);
	kfree(field);
76

77 78
	return -ENOMEM;
}
79 80 81 82 83 84 85 86 87 88 89 90 91 92

int trace_define_field(struct ftrace_event_call *call, const char *type,
		       const char *name, int offset, int size, int is_signed,
		       int filter_type)
{
	struct list_head *head;

	if (WARN_ON(!call->class))
		return 0;

	head = trace_get_fields(call);
	return __trace_define_field(head, type, name, offset, size,
				    is_signed, filter_type);
}
93
EXPORT_SYMBOL_GPL(trace_define_field);
94

95
#define __common_field(type, item)					\
96 97 98 99 100
	ret = __trace_define_field(&ftrace_common_fields, #type,	\
				   "common_" #item,			\
				   offsetof(typeof(ent), item),		\
				   sizeof(ent.item),			\
				   is_signed_type(type), FILTER_OTHER);	\
101 102 103
	if (ret)							\
		return ret;

104
static int trace_define_common_fields(void)
105 106 107 108 109 110 111 112
{
	int ret;
	struct trace_entry ent;

	__common_field(unsigned short, type);
	__common_field(unsigned char, flags);
	__common_field(unsigned char, preempt_count);
	__common_field(int, pid);
113
	__common_field(int, lock_depth);
114 115 116 117

	return ret;
}

118
void trace_destroy_fields(struct ftrace_event_call *call)
119 120
{
	struct ftrace_event_field *field, *next;
121
	struct list_head *head;
122

123 124
	head = trace_get_fields(call);
	list_for_each_entry_safe(field, next, head, link) {
125 126 127 128 129 130 131
		list_del(&field->link);
		kfree(field->type);
		kfree(field->name);
		kfree(field);
	}
}

132 133 134 135
int trace_event_raw_init(struct ftrace_event_call *call)
{
	int id;

136
	id = register_ftrace_event(&call->event);
137 138 139 140 141 142 143
	if (!id)
		return -ENODEV;

	return 0;
}
EXPORT_SYMBOL_GPL(trace_event_raw_init);

144
static int ftrace_event_enable_disable(struct ftrace_event_call *call,
145 146
					int enable)
{
147 148
	int ret = 0;

149 150
	switch (enable) {
	case 0:
151 152
		if (call->flags & TRACE_EVENT_FL_ENABLED) {
			call->flags &= ~TRACE_EVENT_FL_ENABLED;
153
			tracing_stop_cmdline_record();
154 155 156 157 158 159
			if (call->class->reg)
				call->class->reg(call, TRACE_REG_UNREGISTER);
			else
				tracepoint_probe_unregister(call->name,
							    call->class->probe,
							    call);
160 161 162
		}
		break;
	case 1:
163
		if (!(call->flags & TRACE_EVENT_FL_ENABLED)) {
164
			tracing_start_cmdline_record();
165 166 167 168 169 170
			if (call->class->reg)
				ret = call->class->reg(call, TRACE_REG_REGISTER);
			else
				ret = tracepoint_probe_register(call->name,
								call->class->probe,
								call);
171 172 173 174 175 176
			if (ret) {
				tracing_stop_cmdline_record();
				pr_info("event trace: Could not enable event "
					"%s\n", call->name);
				break;
			}
177
			call->flags |= TRACE_EVENT_FL_ENABLED;
178 179 180
		}
		break;
	}
181 182

	return ret;
183 184
}

185 186 187 188 189 190 191 192 193 194 195
static void ftrace_clear_events(void)
{
	struct ftrace_event_call *call;

	mutex_lock(&event_mutex);
	list_for_each_entry(call, &ftrace_events, list) {
		ftrace_event_enable_disable(call, 0);
	}
	mutex_unlock(&event_mutex);
}

196 197 198 199 200
/*
 * __ftrace_set_clr_event(NULL, NULL, NULL, set) will set/unset all events.
 */
static int __ftrace_set_clr_event(const char *match, const char *sub,
				  const char *event, int set)
201
{
202
	struct ftrace_event_call *call;
203
	int ret = -EINVAL;
204 205 206 207

	mutex_lock(&event_mutex);
	list_for_each_entry(call, &ftrace_events, list) {

208 209
		if (!call->name || !call->class ||
		    (!call->class->probe && !call->class->reg))
210 211 212 213
			continue;

		if (match &&
		    strcmp(match, call->name) != 0 &&
214
		    strcmp(match, call->class->system) != 0)
215 216
			continue;

217
		if (sub && strcmp(sub, call->class->system) != 0)
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
			continue;

		if (event && strcmp(event, call->name) != 0)
			continue;

		ftrace_event_enable_disable(call, set);

		ret = 0;
	}
	mutex_unlock(&event_mutex);

	return ret;
}

static int ftrace_set_clr_event(char *buf, int set)
{
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
	char *event = NULL, *sub = NULL, *match;

	/*
	 * The buf format can be <subsystem>:<event-name>
	 *  *:<event-name> means any event by that name.
	 *  :<event-name> is the same.
	 *
	 *  <subsystem>:* means all events in that subsystem
	 *  <subsystem>: means the same.
	 *
	 *  <name> (no ':') means all events in a subsystem with
	 *  the name <name> or any event that matches <name>
	 */

	match = strsep(&buf, ":");
	if (buf) {
		sub = match;
		event = buf;
		match = NULL;

		if (!strlen(sub) || strcmp(sub, "*") == 0)
			sub = NULL;
		if (!strlen(event) || strcmp(event, "*") == 0)
			event = NULL;
	}
259

260
	return __ftrace_set_clr_event(match, sub, event, set);
261 262
}

263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
/**
 * trace_set_clr_event - enable or disable an event
 * @system: system name to match (NULL for any system)
 * @event: event name to match (NULL for all events, within system)
 * @set: 1 to enable, 0 to disable
 *
 * This is a way for other parts of the kernel to enable or disable
 * event recording.
 *
 * Returns 0 on success, -EINVAL if the parameters do not match any
 * registered events.
 */
int trace_set_clr_event(const char *system, const char *event, int set)
{
	return __ftrace_set_clr_event(NULL, system, event, set);
}

280 281 282 283 284 285 286
/* 128 should be much more than enough */
#define EVENT_BUF_SIZE		127

static ssize_t
ftrace_event_write(struct file *file, const char __user *ubuf,
		   size_t cnt, loff_t *ppos)
{
287
	struct trace_parser parser;
288
	ssize_t read, ret;
289

290
	if (!cnt)
291 292
		return 0;

293 294 295 296
	ret = tracing_update_buffers();
	if (ret < 0)
		return ret;

297
	if (trace_parser_get_init(&parser, EVENT_BUF_SIZE + 1))
298 299
		return -ENOMEM;

300 301
	read = trace_get_user(&parser, ubuf, cnt, ppos);

302
	if (read >= 0 && trace_parser_loaded((&parser))) {
303
		int set = 1;
304

305
		if (*parser.buffer == '!')
306 307
			set = 0;

308 309 310
		parser.buffer[parser.idx] = 0;

		ret = ftrace_set_clr_event(parser.buffer + !set, set);
311
		if (ret)
312
			goto out_put;
313 314 315 316
	}

	ret = read;

317 318
 out_put:
	trace_parser_put(&parser);
319 320 321 322 323 324 325

	return ret;
}

static void *
t_next(struct seq_file *m, void *v, loff_t *pos)
{
326
	struct ftrace_event_call *call = v;
327 328 329

	(*pos)++;

330
	list_for_each_entry_continue(call, &ftrace_events, list) {
331 332 333 334
		/*
		 * The ftrace subsystem is for showing formats only.
		 * They can not be enabled or disabled via the event files.
		 */
335
		if (call->class && (call->class->probe || call->class->reg))
336
			return call;
337
	}
338

339
	return NULL;
340 341 342 343
}

static void *t_start(struct seq_file *m, loff_t *pos)
{
344
	struct ftrace_event_call *call;
345 346
	loff_t l;

347
	mutex_lock(&event_mutex);
348

349
	call = list_entry(&ftrace_events, struct ftrace_event_call, list);
350
	for (l = 0; l <= *pos; ) {
351
		call = t_next(m, call, &l);
352 353 354 355
		if (!call)
			break;
	}
	return call;
356 357 358 359 360
}

static void *
s_next(struct seq_file *m, void *v, loff_t *pos)
{
361
	struct ftrace_event_call *call = v;
362 363 364

	(*pos)++;

365
	list_for_each_entry_continue(call, &ftrace_events, list) {
366
		if (call->flags & TRACE_EVENT_FL_ENABLED)
367
			return call;
368 369
	}

370
	return NULL;
371 372 373 374
}

static void *s_start(struct seq_file *m, loff_t *pos)
{
375
	struct ftrace_event_call *call;
376 377
	loff_t l;

378
	mutex_lock(&event_mutex);
379

380
	call = list_entry(&ftrace_events, struct ftrace_event_call, list);
381
	for (l = 0; l <= *pos; ) {
382
		call = s_next(m, call, &l);
383 384 385 386
		if (!call)
			break;
	}
	return call;
387 388 389 390 391 392
}

static int t_show(struct seq_file *m, void *v)
{
	struct ftrace_event_call *call = v;

393 394
	if (strcmp(call->class->system, TRACE_SYSTEM) != 0)
		seq_printf(m, "%s:", call->class->system);
395 396 397 398 399 400 401
	seq_printf(m, "%s\n", call->name);

	return 0;
}

static void t_stop(struct seq_file *m, void *p)
{
402
	mutex_unlock(&event_mutex);
403 404 405 406 407 408 409 410
}

static int
ftrace_event_seq_open(struct inode *inode, struct file *file)
{
	const struct seq_operations *seq_ops;

	if ((file->f_mode & FMODE_WRITE) &&
411
	    (file->f_flags & O_TRUNC))
412 413 414
		ftrace_clear_events();

	seq_ops = inode->i_private;
415
	return seq_open(file, seq_ops);
416 417
}

418 419 420 421 422 423 424
static ssize_t
event_enable_read(struct file *filp, char __user *ubuf, size_t cnt,
		  loff_t *ppos)
{
	struct ftrace_event_call *call = filp->private_data;
	char *buf;

425
	if (call->flags & TRACE_EVENT_FL_ENABLED)
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
		buf = "1\n";
	else
		buf = "0\n";

	return simple_read_from_buffer(ubuf, cnt, ppos, buf, 2);
}

static ssize_t
event_enable_write(struct file *filp, const char __user *ubuf, size_t cnt,
		   loff_t *ppos)
{
	struct ftrace_event_call *call = filp->private_data;
	char buf[64];
	unsigned long val;
	int ret;

	if (cnt >= sizeof(buf))
		return -EINVAL;

	if (copy_from_user(&buf, ubuf, cnt))
		return -EFAULT;

	buf[cnt] = 0;

	ret = strict_strtoul(buf, 10, &val);
	if (ret < 0)
		return ret;

454 455 456 457
	ret = tracing_update_buffers();
	if (ret < 0)
		return ret;

458 459 460
	switch (val) {
	case 0:
	case 1:
461
		mutex_lock(&event_mutex);
462
		ret = ftrace_event_enable_disable(call, val);
463
		mutex_unlock(&event_mutex);
464 465 466 467 468 469 470 471
		break;

	default:
		return -EINVAL;
	}

	*ppos += cnt;

472
	return ret ? ret : cnt;
473 474
}

475 476 477 478
static ssize_t
system_enable_read(struct file *filp, char __user *ubuf, size_t cnt,
		   loff_t *ppos)
{
479
	const char set_to_char[4] = { '?', '0', '1', 'X' };
480 481 482
	const char *system = filp->private_data;
	struct ftrace_event_call *call;
	char buf[2];
483
	int set = 0;
484 485 486 487
	int ret;

	mutex_lock(&event_mutex);
	list_for_each_entry(call, &ftrace_events, list) {
488 489
		if (!call->name || !call->class ||
		    (!call->class->probe && !call->class->reg))
490 491
			continue;

492
		if (system && strcmp(call->class->system, system) != 0)
493 494 495 496 497 498 499
			continue;

		/*
		 * We need to find out if all the events are set
		 * or if all events or cleared, or if we have
		 * a mixture.
		 */
500
		set |= (1 << !!(call->flags & TRACE_EVENT_FL_ENABLED));
501

502 503 504
		/*
		 * If we have a mixture, no need to look further.
		 */
505
		if (set == 3)
506 507 508 509
			break;
	}
	mutex_unlock(&event_mutex);

510
	buf[0] = set_to_char[set];
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
	buf[1] = '\n';

	ret = simple_read_from_buffer(ubuf, cnt, ppos, buf, 2);

	return ret;
}

static ssize_t
system_enable_write(struct file *filp, const char __user *ubuf, size_t cnt,
		    loff_t *ppos)
{
	const char *system = filp->private_data;
	unsigned long val;
	char buf[64];
	ssize_t ret;

	if (cnt >= sizeof(buf))
		return -EINVAL;

	if (copy_from_user(&buf, ubuf, cnt))
		return -EFAULT;

	buf[cnt] = 0;

	ret = strict_strtoul(buf, 10, &val);
	if (ret < 0)
		return ret;

	ret = tracing_update_buffers();
	if (ret < 0)
		return ret;

543
	if (val != 0 && val != 1)
544 545
		return -EINVAL;

546
	ret = __ftrace_set_clr_event(NULL, system, NULL, val);
547
	if (ret)
548
		goto out;
549 550 551

	ret = cnt;

552
out:
553 554 555 556 557
	*ppos += cnt;

	return ret;
}

558
static void print_event_fields(struct trace_seq *s, struct list_head *head)
559
{
560
	struct ftrace_event_field *field;
561

562
	list_for_each_entry_reverse(field, head, link) {
563 564 565 566 567 568 569 570 571 572 573 574 575
		/*
		 * Smartly shows the array type(except dynamic array).
		 * Normal:
		 *	field:TYPE VAR
		 * If TYPE := TYPE[LEN], it is shown:
		 *	field:TYPE VAR[LEN]
		 */
		const char *array_descriptor = strchr(field->type, '[');

		if (!strncmp(field->type, "__data_loc", 10))
			array_descriptor = NULL;

		if (!array_descriptor) {
576
			trace_seq_printf(s, "\tfield:%s %s;\toffset:%u;"
577 578 579 580
					"\tsize:%u;\tsigned:%d;\n",
					field->type, field->name, field->offset,
					field->size, !!field->is_signed);
		} else {
581
			trace_seq_printf(s, "\tfield:%.*s %s%s;\toffset:%u;"
582 583 584 585 586 587
					"\tsize:%u;\tsigned:%d;\n",
					(int)(array_descriptor - field->type),
					field->type, field->name,
					array_descriptor, field->offset,
					field->size, !!field->is_signed);
		}
588 589
	}
}
590

591 592 593 594 595 596 597 598 599
static ssize_t
event_format_read(struct file *filp, char __user *ubuf, size_t cnt,
		  loff_t *ppos)
{
	struct ftrace_event_call *call = filp->private_data;
	struct list_head *head;
	struct trace_seq *s;
	char *buf;
	int r;
600

601 602
	if (*ppos)
		return 0;
603

604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
	s = kmalloc(sizeof(*s), GFP_KERNEL);
	if (!s)
		return -ENOMEM;

	trace_seq_init(s);

	trace_seq_printf(s, "name: %s\n", call->name);
	trace_seq_printf(s, "ID: %d\n", call->event.type);
	trace_seq_printf(s, "format:\n");

	/* print common fields */
	print_event_fields(s, &ftrace_common_fields);

	trace_seq_putc(s, '\n');

	/* print event specific fields */
	head = trace_get_fields(call);
	print_event_fields(s, head);

	r = trace_seq_printf(s, "\nprint fmt: %s\n", call->print_fmt);
624

625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
	if (!r) {
		/*
		 * ug!  The format output is bigger than a PAGE!!
		 */
		buf = "FORMAT TOO BIG\n";
		r = simple_read_from_buffer(ubuf, cnt, ppos,
					      buf, strlen(buf));
		goto out;
	}

	r = simple_read_from_buffer(ubuf, cnt, ppos,
				    s->buffer, s->len);
 out:
	kfree(s);
	return r;
}

642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
static ssize_t
event_id_read(struct file *filp, char __user *ubuf, size_t cnt, loff_t *ppos)
{
	struct ftrace_event_call *call = filp->private_data;
	struct trace_seq *s;
	int r;

	if (*ppos)
		return 0;

	s = kmalloc(sizeof(*s), GFP_KERNEL);
	if (!s)
		return -ENOMEM;

	trace_seq_init(s);
657
	trace_seq_printf(s, "%d\n", call->event.type);
658 659 660 661 662 663 664

	r = simple_read_from_buffer(ubuf, cnt, ppos,
				    s->buffer, s->len);
	kfree(s);
	return r;
}

T
Tom Zanussi 已提交
665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
static ssize_t
event_filter_read(struct file *filp, char __user *ubuf, size_t cnt,
		  loff_t *ppos)
{
	struct ftrace_event_call *call = filp->private_data;
	struct trace_seq *s;
	int r;

	if (*ppos)
		return 0;

	s = kmalloc(sizeof(*s), GFP_KERNEL);
	if (!s)
		return -ENOMEM;

	trace_seq_init(s);

682
	print_event_filter(call, s);
683
	r = simple_read_from_buffer(ubuf, cnt, ppos, s->buffer, s->len);
T
Tom Zanussi 已提交
684 685 686 687 688 689 690 691 692 693 694

	kfree(s);

	return r;
}

static ssize_t
event_filter_write(struct file *filp, const char __user *ubuf, size_t cnt,
		   loff_t *ppos)
{
	struct ftrace_event_call *call = filp->private_data;
695
	char *buf;
T
Tom Zanussi 已提交
696 697
	int err;

698
	if (cnt >= PAGE_SIZE)
T
Tom Zanussi 已提交
699 700
		return -EINVAL;

701 702
	buf = (char *)__get_free_page(GFP_TEMPORARY);
	if (!buf)
T
Tom Zanussi 已提交
703 704
		return -ENOMEM;

705 706 707
	if (copy_from_user(buf, ubuf, cnt)) {
		free_page((unsigned long) buf);
		return -EFAULT;
T
Tom Zanussi 已提交
708
	}
709
	buf[cnt] = '\0';
T
Tom Zanussi 已提交
710

711 712 713
	err = apply_event_filter(call, buf);
	free_page((unsigned long) buf);
	if (err < 0)
714
		return err;
715

T
Tom Zanussi 已提交
716 717 718 719 720
	*ppos += cnt;

	return cnt;
}

721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
static ssize_t
subsystem_filter_read(struct file *filp, char __user *ubuf, size_t cnt,
		      loff_t *ppos)
{
	struct event_subsystem *system = filp->private_data;
	struct trace_seq *s;
	int r;

	if (*ppos)
		return 0;

	s = kmalloc(sizeof(*s), GFP_KERNEL);
	if (!s)
		return -ENOMEM;

	trace_seq_init(s);

738
	print_subsystem_event_filter(system, s);
739
	r = simple_read_from_buffer(ubuf, cnt, ppos, s->buffer, s->len);
740 741 742 743 744 745 746 747 748 749 750

	kfree(s);

	return r;
}

static ssize_t
subsystem_filter_write(struct file *filp, const char __user *ubuf, size_t cnt,
		       loff_t *ppos)
{
	struct event_subsystem *system = filp->private_data;
751
	char *buf;
752 753
	int err;

754
	if (cnt >= PAGE_SIZE)
755 756
		return -EINVAL;

757 758
	buf = (char *)__get_free_page(GFP_TEMPORARY);
	if (!buf)
759 760
		return -ENOMEM;

761 762 763
	if (copy_from_user(buf, ubuf, cnt)) {
		free_page((unsigned long) buf);
		return -EFAULT;
764
	}
765
	buf[cnt] = '\0';
766

767 768 769
	err = apply_subsystem_event_filter(system, buf);
	free_page((unsigned long) buf);
	if (err < 0)
770
		return err;
771 772 773 774 775 776

	*ppos += cnt;

	return cnt;
}

777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800
static ssize_t
show_header(struct file *filp, char __user *ubuf, size_t cnt, loff_t *ppos)
{
	int (*func)(struct trace_seq *s) = filp->private_data;
	struct trace_seq *s;
	int r;

	if (*ppos)
		return 0;

	s = kmalloc(sizeof(*s), GFP_KERNEL);
	if (!s)
		return -ENOMEM;

	trace_seq_init(s);

	func(s);
	r = simple_read_from_buffer(ubuf, cnt, ppos, s->buffer, s->len);

	kfree(s);

	return r;
}

801 802 803 804 805 806 807 808 809 810 811 812 813 814
static const struct seq_operations show_event_seq_ops = {
	.start = t_start,
	.next = t_next,
	.show = t_show,
	.stop = t_stop,
};

static const struct seq_operations show_set_event_seq_ops = {
	.start = s_start,
	.next = s_next,
	.show = t_show,
	.stop = t_stop,
};

815 816 817 818 819 820 821
static const struct file_operations ftrace_avail_fops = {
	.open = ftrace_event_seq_open,
	.read = seq_read,
	.llseek = seq_lseek,
	.release = seq_release,
};

822 823 824 825 826 827 828 829
static const struct file_operations ftrace_set_event_fops = {
	.open = ftrace_event_seq_open,
	.read = seq_read,
	.write = ftrace_event_write,
	.llseek = seq_lseek,
	.release = seq_release,
};

830 831 832 833 834 835
static const struct file_operations ftrace_enable_fops = {
	.open = tracing_open_generic,
	.read = event_enable_read,
	.write = event_enable_write,
};

836 837 838 839 840
static const struct file_operations ftrace_event_format_fops = {
	.open = tracing_open_generic,
	.read = event_format_read,
};

841 842 843 844 845
static const struct file_operations ftrace_event_id_fops = {
	.open = tracing_open_generic,
	.read = event_id_read,
};

T
Tom Zanussi 已提交
846 847 848 849 850 851
static const struct file_operations ftrace_event_filter_fops = {
	.open = tracing_open_generic,
	.read = event_filter_read,
	.write = event_filter_write,
};

852 853 854 855 856 857
static const struct file_operations ftrace_subsystem_filter_fops = {
	.open = tracing_open_generic,
	.read = subsystem_filter_read,
	.write = subsystem_filter_write,
};

858 859 860 861 862 863
static const struct file_operations ftrace_system_enable_fops = {
	.open = tracing_open_generic,
	.read = system_enable_read,
	.write = system_enable_write,
};

864 865 866 867 868
static const struct file_operations ftrace_show_header_fops = {
	.open = tracing_open_generic,
	.read = show_header,
};

869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
static struct dentry *event_trace_events_dir(void)
{
	static struct dentry *d_tracer;
	static struct dentry *d_events;

	if (d_events)
		return d_events;

	d_tracer = tracing_init_dentry();
	if (!d_tracer)
		return NULL;

	d_events = debugfs_create_dir("events", d_tracer);
	if (!d_events)
		pr_warning("Could not create debugfs "
			   "'events' directory\n");

	return d_events;
}

889 890 891 892 893 894
static LIST_HEAD(event_subsystems);

static struct dentry *
event_subsystem_dir(const char *name, struct dentry *d_events)
{
	struct event_subsystem *system;
895
	struct dentry *entry;
896 897 898

	/* First see if we did not already create this dir */
	list_for_each_entry(system, &event_subsystems, list) {
899 900
		if (strcmp(system->name, name) == 0) {
			system->nr_events++;
901
			return system->entry;
902
		}
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
	}

	/* need to create new entry */
	system = kmalloc(sizeof(*system), GFP_KERNEL);
	if (!system) {
		pr_warning("No memory to create event subsystem %s\n",
			   name);
		return d_events;
	}

	system->entry = debugfs_create_dir(name, d_events);
	if (!system->entry) {
		pr_warning("Could not create event subsystem %s\n",
			   name);
		kfree(system);
		return d_events;
	}

921
	system->nr_events = 1;
922 923 924 925 926 927 928
	system->name = kstrdup(name, GFP_KERNEL);
	if (!system->name) {
		debugfs_remove(system->entry);
		kfree(system);
		return d_events;
	}

929 930
	list_add(&system->list, &event_subsystems);

931
	system->filter = NULL;
932

933 934 935 936 937 938 939
	system->filter = kzalloc(sizeof(struct event_filter), GFP_KERNEL);
	if (!system->filter) {
		pr_warning("Could not allocate filter for subsystem "
			   "'%s'\n", name);
		return system->entry;
	}

940 941
	entry = debugfs_create_file("filter", 0644, system->entry, system,
				    &ftrace_subsystem_filter_fops);
942 943 944
	if (!entry) {
		kfree(system->filter);
		system->filter = NULL;
945 946
		pr_warning("Could not create debugfs "
			   "'%s/filter' entry\n", name);
947
	}
948

949 950 951
	trace_create_file("enable", 0644, system->entry,
			  (void *)system->name,
			  &ftrace_system_enable_fops);
952

953 954 955
	return system->entry;
}

956
static int
957 958 959 960 961
event_create_dir(struct ftrace_event_call *call, struct dentry *d_events,
		 const struct file_operations *id,
		 const struct file_operations *enable,
		 const struct file_operations *filter,
		 const struct file_operations *format)
962
{
963
	struct list_head *head;
964
	int ret;
965

966 967 968 969
	/*
	 * If the trace point header did not define TRACE_SYSTEM
	 * then the system would be called "TRACE_SYSTEM".
	 */
970 971
	if (strcmp(call->class->system, TRACE_SYSTEM) != 0)
		d_events = event_subsystem_dir(call->class->system, d_events);
972

973 974 975 976 977 978 979
	call->dir = debugfs_create_dir(call->name, d_events);
	if (!call->dir) {
		pr_warning("Could not create debugfs "
			   "'%s' directory\n", call->name);
		return -1;
	}

980
	if (call->class->probe || call->class->reg)
981 982
		trace_create_file("enable", 0644, call->dir, call,
				  enable);
983

984
#ifdef CONFIG_PERF_EVENTS
985
	if (call->event.type && (call->class->perf_probe || call->class->reg))
986 987
		trace_create_file("id", 0444, call->dir, call,
		 		  id);
988
#endif
989

990 991 992 993 994 995 996 997 998 999 1000
	/*
	 * Other events may have the same class. Only update
	 * the fields if they are not already defined.
	 */
	head = trace_get_fields(call);
	if (list_empty(head)) {
		ret = call->class->define_fields(call);
		if (ret < 0) {
			pr_warning("Could not initialize trace point"
				   " events/%s\n", call->name);
			return ret;
1001 1002
		}
	}
1003 1004
	trace_create_file("filter", 0644, call->dir, call,
			  filter);
1005

1006 1007
	trace_create_file("format", 0444, call->dir, call,
			  format);
1008 1009 1010 1011

	return 0;
}

1012 1013 1014 1015
static int __trace_add_event_call(struct ftrace_event_call *call)
{
	struct dentry *d_events;
	int ret;
1016

1017 1018
	if (!call->name)
		return -EINVAL;
1019

1020 1021
	if (call->class->raw_init) {
		ret = call->class->raw_init(call);
1022 1023 1024 1025 1026 1027 1028
		if (ret < 0) {
			if (ret != -ENOSYS)
				pr_warning("Could not initialize trace "
				"events/%s\n", call->name);
			return ret;
		}
	}
1029

1030 1031 1032 1033
	d_events = event_trace_events_dir();
	if (!d_events)
		return -ENOENT;

1034
	ret = event_create_dir(call, d_events, &ftrace_event_id_fops,
1035 1036
				&ftrace_enable_fops, &ftrace_event_filter_fops,
				&ftrace_event_format_fops);
1037 1038 1039
	if (!ret)
		list_add(&call->list, &ftrace_events);

1040
	return ret;
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
}

/* Add an additional event_call dynamically */
int trace_add_event_call(struct ftrace_event_call *call)
{
	int ret;
	mutex_lock(&event_mutex);
	ret = __trace_add_event_call(call);
	mutex_unlock(&event_mutex);
	return ret;
}
1052

1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
static void remove_subsystem_dir(const char *name)
{
	struct event_subsystem *system;

	if (strcmp(name, TRACE_SYSTEM) == 0)
		return;

	list_for_each_entry(system, &event_subsystems, list) {
		if (strcmp(system->name, name) == 0) {
			if (!--system->nr_events) {
				struct event_filter *filter = system->filter;

				debugfs_remove_recursive(system->entry);
				list_del(&system->list);
				if (filter) {
					kfree(filter->filter_string);
					kfree(filter);
				}
				kfree(system->name);
				kfree(system);
			}
			break;
		}
	}
}

1079 1080 1081
/*
 * Must be called under locking both of event_mutex and trace_event_mutex.
 */
1082 1083 1084
static void __trace_remove_event_call(struct ftrace_event_call *call)
{
	ftrace_event_enable_disable(call, 0);
1085 1086
	if (call->event.funcs)
		__unregister_ftrace_event(&call->event);
1087 1088 1089 1090
	debugfs_remove_recursive(call->dir);
	list_del(&call->list);
	trace_destroy_fields(call);
	destroy_preds(call);
1091
	remove_subsystem_dir(call->class->system);
1092 1093 1094 1095 1096 1097
}

/* Remove an event_call */
void trace_remove_event_call(struct ftrace_event_call *call)
{
	mutex_lock(&event_mutex);
1098
	down_write(&trace_event_mutex);
1099
	__trace_remove_event_call(call);
1100
	up_write(&trace_event_mutex);
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
	mutex_unlock(&event_mutex);
}

#define for_each_event(event, start, end)			\
	for (event = start;					\
	     (unsigned long)event < (unsigned long)end;		\
	     event++)

#ifdef CONFIG_MODULES

static LIST_HEAD(ftrace_module_file_list);

/*
 * Modules must own their file_operations to keep up with
 * reference counting.
 */
struct ftrace_module_file_ops {
	struct list_head		list;
	struct module			*mod;
	struct file_operations		id;
	struct file_operations		enable;
	struct file_operations		format;
	struct file_operations		filter;
};

1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160
static struct ftrace_module_file_ops *
trace_create_file_ops(struct module *mod)
{
	struct ftrace_module_file_ops *file_ops;

	/*
	 * This is a bit of a PITA. To allow for correct reference
	 * counting, modules must "own" their file_operations.
	 * To do this, we allocate the file operations that will be
	 * used in the event directory.
	 */

	file_ops = kmalloc(sizeof(*file_ops), GFP_KERNEL);
	if (!file_ops)
		return NULL;

	file_ops->mod = mod;

	file_ops->id = ftrace_event_id_fops;
	file_ops->id.owner = mod;

	file_ops->enable = ftrace_enable_fops;
	file_ops->enable.owner = mod;

	file_ops->filter = ftrace_event_filter_fops;
	file_ops->filter.owner = mod;

	file_ops->format = ftrace_event_format_fops;
	file_ops->format.owner = mod;

	list_add(&file_ops->list, &ftrace_module_file_list);

	return file_ops;
}

1161 1162
static void trace_module_add_events(struct module *mod)
{
1163
	struct ftrace_module_file_ops *file_ops = NULL;
1164 1165
	struct ftrace_event_call *call, *start, *end;
	struct dentry *d_events;
1166
	int ret;
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181

	start = mod->trace_events;
	end = mod->trace_events + mod->num_trace_events;

	if (start == end)
		return;

	d_events = event_trace_events_dir();
	if (!d_events)
		return;

	for_each_event(call, start, end) {
		/* The linker may leave blanks */
		if (!call->name)
			continue;
1182 1183
		if (call->class->raw_init) {
			ret = call->class->raw_init(call);
1184 1185 1186 1187 1188 1189 1190
			if (ret < 0) {
				if (ret != -ENOSYS)
					pr_warning("Could not initialize trace "
					"point events/%s\n", call->name);
				continue;
			}
		}
1191 1192 1193 1194 1195 1196 1197 1198 1199
		/*
		 * This module has events, create file ops for this module
		 * if not already done.
		 */
		if (!file_ops) {
			file_ops = trace_create_file_ops(mod);
			if (!file_ops)
				return;
		}
1200
		call->mod = mod;
1201 1202 1203 1204 1205
		ret = event_create_dir(call, d_events,
				       &file_ops->id, &file_ops->enable,
				       &file_ops->filter, &file_ops->format);
		if (!ret)
			list_add(&call->list, &ftrace_events);
1206 1207 1208 1209 1210
	}
}

static void trace_module_remove_events(struct module *mod)
{
1211
	struct ftrace_module_file_ops *file_ops;
1212
	struct ftrace_event_call *call, *p;
1213
	bool found = false;
1214

1215
	down_write(&trace_event_mutex);
1216 1217
	list_for_each_entry_safe(call, p, &ftrace_events, list) {
		if (call->mod == mod) {
1218
			found = true;
1219
			__trace_remove_event_call(call);
1220 1221
		}
	}
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231

	/* Now free the file_operations */
	list_for_each_entry(file_ops, &ftrace_module_file_list, list) {
		if (file_ops->mod == mod)
			break;
	}
	if (&file_ops->list != &ftrace_module_file_list) {
		list_del(&file_ops->list);
		kfree(file_ops);
	}
1232 1233 1234 1235 1236 1237 1238

	/*
	 * It is safest to reset the ring buffer if the module being unloaded
	 * registered any events.
	 */
	if (found)
		tracing_reset_current_online_cpus();
1239
	up_write(&trace_event_mutex);
1240 1241
}

1242 1243
static int trace_module_notify(struct notifier_block *self,
			       unsigned long val, void *data)
1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256
{
	struct module *mod = data;

	mutex_lock(&event_mutex);
	switch (val) {
	case MODULE_STATE_COMING:
		trace_module_add_events(mod);
		break;
	case MODULE_STATE_GOING:
		trace_module_remove_events(mod);
		break;
	}
	mutex_unlock(&event_mutex);
1257

1258 1259
	return 0;
}
1260 1261 1262 1263 1264 1265 1266
#else
static int trace_module_notify(struct notifier_block *self,
			       unsigned long val, void *data)
{
	return 0;
}
#endif /* CONFIG_MODULES */
1267

1268
static struct notifier_block trace_module_nb = {
1269 1270 1271 1272
	.notifier_call = trace_module_notify,
	.priority = 0,
};

1273 1274 1275
extern struct ftrace_event_call __start_ftrace_events[];
extern struct ftrace_event_call __stop_ftrace_events[];

1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287
static char bootup_event_buf[COMMAND_LINE_SIZE] __initdata;

static __init int setup_trace_event(char *str)
{
	strlcpy(bootup_event_buf, str, COMMAND_LINE_SIZE);
	ring_buffer_expanded = 1;
	tracing_selftest_disabled = 1;

	return 1;
}
__setup("trace_event=", setup_trace_event);

1288 1289
static __init int event_trace_init(void)
{
1290
	struct ftrace_event_call *call;
1291 1292
	struct dentry *d_tracer;
	struct dentry *entry;
1293
	struct dentry *d_events;
1294
	int ret;
1295 1296
	char *buf = bootup_event_buf;
	char *token;
1297 1298 1299 1300 1301

	d_tracer = tracing_init_dentry();
	if (!d_tracer)
		return 0;

1302 1303 1304 1305 1306 1307 1308
	entry = debugfs_create_file("available_events", 0444, d_tracer,
				    (void *)&show_event_seq_ops,
				    &ftrace_avail_fops);
	if (!entry)
		pr_warning("Could not create debugfs "
			   "'available_events' entry\n");

1309 1310 1311 1312 1313 1314 1315
	entry = debugfs_create_file("set_event", 0644, d_tracer,
				    (void *)&show_set_event_seq_ops,
				    &ftrace_set_event_fops);
	if (!entry)
		pr_warning("Could not create debugfs "
			   "'set_event' entry\n");

1316 1317 1318 1319
	d_events = event_trace_events_dir();
	if (!d_events)
		return 0;

1320 1321 1322 1323 1324 1325 1326 1327 1328
	/* ring buffer internal formats */
	trace_create_file("header_page", 0444, d_events,
			  ring_buffer_print_page_header,
			  &ftrace_show_header_fops);

	trace_create_file("header_event", 0444, d_events,
			  ring_buffer_print_entry_header,
			  &ftrace_show_header_fops);

1329
	trace_create_file("enable", 0644, d_events,
1330
			  NULL, &ftrace_system_enable_fops);
1331

1332 1333 1334
	if (trace_define_common_fields())
		pr_warning("tracing: Failed to allocate common fields");

1335
	for_each_event(call, __start_ftrace_events, __stop_ftrace_events) {
1336 1337 1338
		/* The linker may leave blanks */
		if (!call->name)
			continue;
1339 1340
		if (call->class->raw_init) {
			ret = call->class->raw_init(call);
1341 1342 1343 1344 1345 1346 1347
			if (ret < 0) {
				if (ret != -ENOSYS)
					pr_warning("Could not initialize trace "
					"point events/%s\n", call->name);
				continue;
			}
		}
1348 1349 1350 1351 1352 1353
		ret = event_create_dir(call, d_events, &ftrace_event_id_fops,
				       &ftrace_enable_fops,
				       &ftrace_event_filter_fops,
				       &ftrace_event_format_fops);
		if (!ret)
			list_add(&call->list, &ftrace_events);
1354 1355
	}

1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368
	while (true) {
		token = strsep(&buf, ",");

		if (!token)
			break;
		if (!*token)
			continue;

		ret = ftrace_set_clr_event(token, 1);
		if (ret)
			pr_warning("Failed to enable trace event: %s\n", token);
	}

1369
	ret = register_module_notifier(&trace_module_nb);
1370
	if (ret)
1371 1372
		pr_warning("Failed to register trace events module notifier\n");

1373 1374 1375
	return 0;
}
fs_initcall(event_trace_init);
1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430

#ifdef CONFIG_FTRACE_STARTUP_TEST

static DEFINE_SPINLOCK(test_spinlock);
static DEFINE_SPINLOCK(test_spinlock_irq);
static DEFINE_MUTEX(test_mutex);

static __init void test_work(struct work_struct *dummy)
{
	spin_lock(&test_spinlock);
	spin_lock_irq(&test_spinlock_irq);
	udelay(1);
	spin_unlock_irq(&test_spinlock_irq);
	spin_unlock(&test_spinlock);

	mutex_lock(&test_mutex);
	msleep(1);
	mutex_unlock(&test_mutex);
}

static __init int event_test_thread(void *unused)
{
	void *test_malloc;

	test_malloc = kmalloc(1234, GFP_KERNEL);
	if (!test_malloc)
		pr_info("failed to kmalloc\n");

	schedule_on_each_cpu(test_work);

	kfree(test_malloc);

	set_current_state(TASK_INTERRUPTIBLE);
	while (!kthread_should_stop())
		schedule();

	return 0;
}

/*
 * Do various things that may trigger events.
 */
static __init void event_test_stuff(void)
{
	struct task_struct *test_thread;

	test_thread = kthread_run(event_test_thread, NULL, "test-events");
	msleep(1);
	kthread_stop(test_thread);
}

/*
 * For every trace event defined, we will test each trace point separately,
 * and then by groups, and finally all trace points.
 */
1431
static __init void event_trace_self_tests(void)
1432 1433 1434 1435 1436 1437 1438 1439 1440
{
	struct ftrace_event_call *call;
	struct event_subsystem *system;
	int ret;

	pr_info("Running tests on trace events:\n");

	list_for_each_entry(call, &ftrace_events, list) {

1441 1442
		/* Only test those that have a probe */
		if (!call->class || !call->class->probe)
1443 1444
			continue;

1445 1446 1447 1448 1449 1450 1451
/*
 * Testing syscall events here is pretty useless, but
 * we still do it if configured. But this is time consuming.
 * What we really need is a user thread to perform the
 * syscalls as we test.
 */
#ifndef CONFIG_EVENT_TRACE_TEST_SYSCALLS
1452 1453
		if (call->class->system &&
		    strcmp(call->class->system, "syscalls") == 0)
1454 1455 1456
			continue;
#endif

1457 1458 1459 1460 1461 1462
		pr_info("Testing event %s: ", call->name);

		/*
		 * If an event is already enabled, someone is using
		 * it and the self test should not be on.
		 */
1463
		if (call->flags & TRACE_EVENT_FL_ENABLED) {
1464 1465 1466 1467 1468
			pr_warning("Enabled event during self test!\n");
			WARN_ON_ONCE(1);
			continue;
		}

1469
		ftrace_event_enable_disable(call, 1);
1470
		event_test_stuff();
1471
		ftrace_event_enable_disable(call, 0);
1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487

		pr_cont("OK\n");
	}

	/* Now test at the sub system level */

	pr_info("Running tests on trace event systems:\n");

	list_for_each_entry(system, &event_subsystems, list) {

		/* the ftrace system is special, skip it */
		if (strcmp(system->name, "ftrace") == 0)
			continue;

		pr_info("Testing event system %s: ", system->name);

1488
		ret = __ftrace_set_clr_event(NULL, system->name, NULL, 1);
1489 1490 1491 1492 1493 1494 1495 1496
		if (WARN_ON_ONCE(ret)) {
			pr_warning("error enabling system %s\n",
				   system->name);
			continue;
		}

		event_test_stuff();

1497
		ret = __ftrace_set_clr_event(NULL, system->name, NULL, 0);
1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509
		if (WARN_ON_ONCE(ret))
			pr_warning("error disabling system %s\n",
				   system->name);

		pr_cont("OK\n");
	}

	/* Test with all events enabled */

	pr_info("Running tests on all trace events:\n");
	pr_info("Testing all events: ");

1510
	ret = __ftrace_set_clr_event(NULL, NULL, NULL, 1);
1511 1512
	if (WARN_ON_ONCE(ret)) {
		pr_warning("error enabling all events\n");
1513
		return;
1514 1515 1516 1517 1518
	}

	event_test_stuff();

	/* reset sysname */
1519
	ret = __ftrace_set_clr_event(NULL, NULL, NULL, 0);
1520 1521
	if (WARN_ON_ONCE(ret)) {
		pr_warning("error disabling all events\n");
1522
		return;
1523 1524 1525
	}

	pr_cont("OK\n");
1526 1527 1528 1529
}

#ifdef CONFIG_FUNCTION_TRACER

1530
static DEFINE_PER_CPU(atomic_t, ftrace_test_event_disable);
1531 1532 1533 1534 1535

static void
function_test_events_call(unsigned long ip, unsigned long parent_ip)
{
	struct ring_buffer_event *event;
1536
	struct ring_buffer *buffer;
1537 1538 1539 1540 1541 1542 1543
	struct ftrace_entry *entry;
	unsigned long flags;
	long disabled;
	int cpu;
	int pc;

	pc = preempt_count();
1544
	preempt_disable_notrace();
1545
	cpu = raw_smp_processor_id();
1546
	disabled = atomic_inc_return(&per_cpu(ftrace_test_event_disable, cpu));
1547 1548 1549 1550 1551 1552

	if (disabled != 1)
		goto out;

	local_save_flags(flags);

1553 1554
	event = trace_current_buffer_lock_reserve(&buffer,
						  TRACE_FN, sizeof(*entry),
1555 1556 1557 1558 1559 1560 1561
						  flags, pc);
	if (!event)
		goto out;
	entry	= ring_buffer_event_data(event);
	entry->ip			= ip;
	entry->parent_ip		= parent_ip;

1562
	trace_nowake_buffer_unlock_commit(buffer, event, flags, pc);
1563 1564

 out:
1565
	atomic_dec(&per_cpu(ftrace_test_event_disable, cpu));
1566
	preempt_enable_notrace();
1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588
}

static struct ftrace_ops trace_ops __initdata  =
{
	.func = function_test_events_call,
};

static __init void event_trace_self_test_with_function(void)
{
	register_ftrace_function(&trace_ops);
	pr_info("Running tests again, along with the function tracer\n");
	event_trace_self_tests();
	unregister_ftrace_function(&trace_ops);
}
#else
static __init void event_trace_self_test_with_function(void)
{
}
#endif

static __init int event_trace_self_tests_init(void)
{
1589 1590 1591 1592
	if (!tracing_selftest_disabled) {
		event_trace_self_tests();
		event_trace_self_test_with_function();
	}
1593 1594 1595 1596

	return 0;
}

1597
late_initcall(event_trace_self_tests_init);
1598 1599

#endif