4 * Copyright (C) 2008 Red Hat Inc, Steven Rostedt <srostedt@redhat.com>
6 * - Added format output of fields of the trace point.
7 * This was based off of work by Tom Zanussi <tzanussi@gmail.com>.
11 #include <linux/workqueue.h>
12 #include <linux/spinlock.h>
13 #include <linux/kthread.h>
14 #include <linux/debugfs.h>
15 #include <linux/uaccess.h>
16 #include <linux/module.h>
17 #include <linux/ctype.h>
18 #include <linux/delay.h>
20 #include "trace_output.h"
22 #define TRACE_SYSTEM "TRACE_SYSTEM"
24 static DEFINE_MUTEX(event_mutex);
26 LIST_HEAD(ftrace_events);
28 int trace_define_field(struct ftrace_event_call *call, char *type,
29 char *name, int offset, int size)
31 struct ftrace_event_field *field;
33 field = kzalloc(sizeof(*field), GFP_KERNEL);
37 field->name = kstrdup(name, GFP_KERNEL);
41 field->type = kstrdup(type, GFP_KERNEL);
45 field->offset = offset;
47 list_add(&field->link, &call->fields);
60 EXPORT_SYMBOL_GPL(trace_define_field);
62 static void ftrace_clear_events(void)
64 struct ftrace_event_call *call;
66 list_for_each_entry(call, &ftrace_events, list) {
75 static void ftrace_event_enable_disable(struct ftrace_event_call *call,
95 static int ftrace_set_clr_event(char *buf, int set)
97 struct ftrace_event_call *call;
98 char *event = NULL, *sub = NULL, *match;
102 * The buf format can be <subsystem>:<event-name>
103 * *:<event-name> means any event by that name.
104 * :<event-name> is the same.
106 * <subsystem>:* means all events in that subsystem
107 * <subsystem>: means the same.
109 * <name> (no ':') means all events in a subsystem with
110 * the name <name> or any event that matches <name>
113 match = strsep(&buf, ":");
119 if (!strlen(sub) || strcmp(sub, "*") == 0)
121 if (!strlen(event) || strcmp(event, "*") == 0)
125 mutex_lock(&event_mutex);
126 list_for_each_entry(call, &ftrace_events, list) {
128 if (!call->name || !call->regfunc)
132 strcmp(match, call->name) != 0 &&
133 strcmp(match, call->system) != 0)
136 if (sub && strcmp(sub, call->system) != 0)
139 if (event && strcmp(event, call->name) != 0)
142 ftrace_event_enable_disable(call, set);
146 mutex_unlock(&event_mutex);
151 /* 128 should be much more than enough */
152 #define EVENT_BUF_SIZE 127
155 ftrace_event_write(struct file *file, const char __user *ubuf,
156 size_t cnt, loff_t *ppos)
167 ret = tracing_update_buffers();
171 ret = get_user(ch, ubuf++);
177 /* skip white space */
178 while (cnt && isspace(ch)) {
179 ret = get_user(ch, ubuf++);
186 /* Only white space found? */
193 buf = kmalloc(EVENT_BUF_SIZE+1, GFP_KERNEL);
197 if (cnt > EVENT_BUF_SIZE)
198 cnt = EVENT_BUF_SIZE;
201 while (cnt && !isspace(ch)) {
207 ret = get_user(ch, ubuf++);
217 ret = ftrace_set_clr_event(buf, set);
230 t_next(struct seq_file *m, void *v, loff_t *pos)
232 struct list_head *list = m->private;
233 struct ftrace_event_call *call;
238 if (list == &ftrace_events)
241 call = list_entry(list, struct ftrace_event_call, list);
244 * The ftrace subsystem is for showing formats only.
245 * They can not be enabled or disabled via the event files.
253 m->private = list->next;
258 static void *t_start(struct seq_file *m, loff_t *pos)
260 return t_next(m, NULL, pos);
264 s_next(struct seq_file *m, void *v, loff_t *pos)
266 struct list_head *list = m->private;
267 struct ftrace_event_call *call;
272 if (list == &ftrace_events)
275 call = list_entry(list, struct ftrace_event_call, list);
277 if (!call->enabled) {
282 m->private = list->next;
287 static void *s_start(struct seq_file *m, loff_t *pos)
289 return s_next(m, NULL, pos);
292 static int t_show(struct seq_file *m, void *v)
294 struct ftrace_event_call *call = v;
296 if (strcmp(call->system, TRACE_SYSTEM) != 0)
297 seq_printf(m, "%s:", call->system);
298 seq_printf(m, "%s\n", call->name);
303 static void t_stop(struct seq_file *m, void *p)
308 ftrace_event_seq_open(struct inode *inode, struct file *file)
311 const struct seq_operations *seq_ops;
313 if ((file->f_mode & FMODE_WRITE) &&
314 !(file->f_flags & O_APPEND))
315 ftrace_clear_events();
317 seq_ops = inode->i_private;
318 ret = seq_open(file, seq_ops);
320 struct seq_file *m = file->private_data;
322 m->private = ftrace_events.next;
328 event_enable_read(struct file *filp, char __user *ubuf, size_t cnt,
331 struct ftrace_event_call *call = filp->private_data;
339 return simple_read_from_buffer(ubuf, cnt, ppos, buf, 2);
343 event_enable_write(struct file *filp, const char __user *ubuf, size_t cnt,
346 struct ftrace_event_call *call = filp->private_data;
351 if (cnt >= sizeof(buf))
354 if (copy_from_user(&buf, ubuf, cnt))
359 ret = strict_strtoul(buf, 10, &val);
363 ret = tracing_update_buffers();
370 mutex_lock(&event_mutex);
371 ftrace_event_enable_disable(call, val);
372 mutex_unlock(&event_mutex);
385 #define FIELD(type, name) \
386 #type, "common_" #name, offsetof(typeof(field), name), \
389 static int trace_write_header(struct trace_seq *s)
391 struct trace_entry field;
393 /* struct trace_entry */
394 return trace_seq_printf(s,
395 "\tfield:%s %s;\toffset:%zu;\tsize:%zu;\n"
396 "\tfield:%s %s;\toffset:%zu;\tsize:%zu;\n"
397 "\tfield:%s %s;\toffset:%zu;\tsize:%zu;\n"
398 "\tfield:%s %s;\toffset:%zu;\tsize:%zu;\n"
399 "\tfield:%s %s;\toffset:%zu;\tsize:%zu;\n"
401 FIELD(unsigned char, type),
402 FIELD(unsigned char, flags),
403 FIELD(unsigned char, preempt_count),
409 event_format_read(struct file *filp, char __user *ubuf, size_t cnt,
412 struct ftrace_event_call *call = filp->private_data;
420 s = kmalloc(sizeof(*s), GFP_KERNEL);
426 /* If any of the first writes fail, so will the show_format. */
428 trace_seq_printf(s, "name: %s\n", call->name);
429 trace_seq_printf(s, "ID: %d\n", call->id);
430 trace_seq_printf(s, "format:\n");
431 trace_write_header(s);
433 r = call->show_format(s);
436 * ug! The format output is bigger than a PAGE!!
438 buf = "FORMAT TOO BIG\n";
439 r = simple_read_from_buffer(ubuf, cnt, ppos,
444 r = simple_read_from_buffer(ubuf, cnt, ppos,
452 event_id_read(struct file *filp, char __user *ubuf, size_t cnt, loff_t *ppos)
454 struct ftrace_event_call *call = filp->private_data;
461 s = kmalloc(sizeof(*s), GFP_KERNEL);
466 trace_seq_printf(s, "%d\n", call->id);
468 r = simple_read_from_buffer(ubuf, cnt, ppos,
475 event_filter_read(struct file *filp, char __user *ubuf, size_t cnt,
478 struct ftrace_event_call *call = filp->private_data;
485 s = kmalloc(sizeof(*s), GFP_KERNEL);
491 filter_print_preds(call, s);
492 r = simple_read_from_buffer(ubuf, cnt, ppos, s->buffer, s->len);
500 event_filter_write(struct file *filp, const char __user *ubuf, size_t cnt,
503 struct ftrace_event_call *call = filp->private_data;
504 char buf[64], *pbuf = buf;
505 struct filter_pred *pred;
508 if (cnt >= sizeof(buf))
511 if (copy_from_user(&buf, ubuf, cnt))
515 pred = kzalloc(sizeof(*pred), GFP_KERNEL);
519 err = filter_parse(&pbuf, pred);
521 filter_free_pred(pred);
526 filter_disable_preds(call);
527 filter_free_pred(pred);
531 err = filter_add_pred(call, pred);
533 filter_free_pred(pred);
537 filter_free_pred(pred);
545 subsystem_filter_read(struct file *filp, char __user *ubuf, size_t cnt,
548 struct event_subsystem *system = filp->private_data;
555 s = kmalloc(sizeof(*s), GFP_KERNEL);
561 filter_print_subsystem_preds(system, s);
562 r = simple_read_from_buffer(ubuf, cnt, ppos, s->buffer, s->len);
570 subsystem_filter_write(struct file *filp, const char __user *ubuf, size_t cnt,
573 struct event_subsystem *system = filp->private_data;
574 char buf[64], *pbuf = buf;
575 struct filter_pred *pred;
578 if (cnt >= sizeof(buf))
581 if (copy_from_user(&buf, ubuf, cnt))
585 pred = kzalloc(sizeof(*pred), GFP_KERNEL);
589 err = filter_parse(&pbuf, pred);
591 filter_free_pred(pred);
596 filter_free_subsystem_preds(system);
597 filter_free_pred(pred);
601 err = filter_add_subsystem_pred(system, pred);
603 filter_free_pred(pred);
613 show_header(struct file *filp, char __user *ubuf, size_t cnt, loff_t *ppos)
615 int (*func)(struct trace_seq *s) = filp->private_data;
622 s = kmalloc(sizeof(*s), GFP_KERNEL);
629 r = simple_read_from_buffer(ubuf, cnt, ppos, s->buffer, s->len);
636 static const struct seq_operations show_event_seq_ops = {
643 static const struct seq_operations show_set_event_seq_ops = {
650 static const struct file_operations ftrace_avail_fops = {
651 .open = ftrace_event_seq_open,
654 .release = seq_release,
657 static const struct file_operations ftrace_set_event_fops = {
658 .open = ftrace_event_seq_open,
660 .write = ftrace_event_write,
662 .release = seq_release,
665 static const struct file_operations ftrace_enable_fops = {
666 .open = tracing_open_generic,
667 .read = event_enable_read,
668 .write = event_enable_write,
671 static const struct file_operations ftrace_event_format_fops = {
672 .open = tracing_open_generic,
673 .read = event_format_read,
676 static const struct file_operations ftrace_event_id_fops = {
677 .open = tracing_open_generic,
678 .read = event_id_read,
681 static const struct file_operations ftrace_event_filter_fops = {
682 .open = tracing_open_generic,
683 .read = event_filter_read,
684 .write = event_filter_write,
687 static const struct file_operations ftrace_subsystem_filter_fops = {
688 .open = tracing_open_generic,
689 .read = subsystem_filter_read,
690 .write = subsystem_filter_write,
693 static const struct file_operations ftrace_show_header_fops = {
694 .open = tracing_open_generic,
698 static struct dentry *event_trace_events_dir(void)
700 static struct dentry *d_tracer;
701 static struct dentry *d_events;
706 d_tracer = tracing_init_dentry();
710 d_events = debugfs_create_dir("events", d_tracer);
712 pr_warning("Could not create debugfs "
713 "'events' directory\n");
718 static LIST_HEAD(event_subsystems);
720 static struct dentry *
721 event_subsystem_dir(const char *name, struct dentry *d_events)
723 struct event_subsystem *system;
724 struct dentry *entry;
726 /* First see if we did not already create this dir */
727 list_for_each_entry(system, &event_subsystems, list) {
728 if (strcmp(system->name, name) == 0)
729 return system->entry;
732 /* need to create new entry */
733 system = kmalloc(sizeof(*system), GFP_KERNEL);
735 pr_warning("No memory to create event subsystem %s\n",
740 system->entry = debugfs_create_dir(name, d_events);
741 if (!system->entry) {
742 pr_warning("Could not create event subsystem %s\n",
748 system->name = kstrdup(name, GFP_KERNEL);
750 debugfs_remove(system->entry);
755 list_add(&system->list, &event_subsystems);
757 system->preds = NULL;
760 entry = debugfs_create_file("filter", 0644, system->entry, system,
761 &ftrace_subsystem_filter_fops);
763 pr_warning("Could not create debugfs "
764 "'%s/filter' entry\n", name);
766 return system->entry;
770 event_create_dir(struct ftrace_event_call *call, struct dentry *d_events)
772 struct dentry *entry;
776 * If the trace point header did not define TRACE_SYSTEM
777 * then the system would be called "TRACE_SYSTEM".
779 if (strcmp(call->system, TRACE_SYSTEM) != 0)
780 d_events = event_subsystem_dir(call->system, d_events);
782 if (call->raw_init) {
783 ret = call->raw_init();
785 pr_warning("Could not initialize trace point"
786 " events/%s\n", call->name);
791 call->dir = debugfs_create_dir(call->name, d_events);
793 pr_warning("Could not create debugfs "
794 "'%s' directory\n", call->name);
799 entry = trace_create_file("enable", 0644, call->dir, call,
800 &ftrace_enable_fops);
803 entry = trace_create_file("id", 0444, call->dir, call,
804 &ftrace_event_id_fops);
806 if (call->define_fields) {
807 ret = call->define_fields();
809 pr_warning("Could not initialize trace point"
810 " events/%s\n", call->name);
813 entry = trace_create_file("filter", 0644, call->dir, call,
814 &ftrace_event_filter_fops);
817 /* A trace may not want to export its format */
818 if (!call->show_format)
821 entry = trace_create_file("format", 0444, call->dir, call,
822 &ftrace_event_format_fops);
827 #define for_each_event(event, start, end) \
828 for (event = start; \
829 (unsigned long)event < (unsigned long)end; \
832 #ifdef CONFIG_MODULES
833 static void trace_module_add_events(struct module *mod)
835 struct ftrace_event_call *call, *start, *end;
836 struct dentry *d_events;
838 start = mod->trace_events;
839 end = mod->trace_events + mod->num_trace_events;
844 d_events = event_trace_events_dir();
848 for_each_event(call, start, end) {
849 /* The linker may leave blanks */
853 list_add(&call->list, &ftrace_events);
854 event_create_dir(call, d_events);
858 static void trace_module_remove_events(struct module *mod)
860 struct ftrace_event_call *call, *p;
862 list_for_each_entry_safe(call, p, &ftrace_events, list) {
863 if (call->mod == mod) {
869 unregister_ftrace_event(call->event);
870 debugfs_remove_recursive(call->dir);
871 list_del(&call->list);
876 static int trace_module_notify(struct notifier_block *self,
877 unsigned long val, void *data)
879 struct module *mod = data;
881 mutex_lock(&event_mutex);
883 case MODULE_STATE_COMING:
884 trace_module_add_events(mod);
886 case MODULE_STATE_GOING:
887 trace_module_remove_events(mod);
890 mutex_unlock(&event_mutex);
895 static int trace_module_notify(struct notifier_block *self,
896 unsigned long val, void *data)
900 #endif /* CONFIG_MODULES */
902 struct notifier_block trace_module_nb = {
903 .notifier_call = trace_module_notify,
907 extern struct ftrace_event_call __start_ftrace_events[];
908 extern struct ftrace_event_call __stop_ftrace_events[];
910 static __init int event_trace_init(void)
912 struct ftrace_event_call *call;
913 struct dentry *d_tracer;
914 struct dentry *entry;
915 struct dentry *d_events;
918 d_tracer = tracing_init_dentry();
922 entry = debugfs_create_file("available_events", 0444, d_tracer,
923 (void *)&show_event_seq_ops,
926 pr_warning("Could not create debugfs "
927 "'available_events' entry\n");
929 entry = debugfs_create_file("set_event", 0644, d_tracer,
930 (void *)&show_set_event_seq_ops,
931 &ftrace_set_event_fops);
933 pr_warning("Could not create debugfs "
934 "'set_event' entry\n");
936 d_events = event_trace_events_dir();
940 /* ring buffer internal formats */
941 trace_create_file("header_page", 0444, d_events,
942 ring_buffer_print_page_header,
943 &ftrace_show_header_fops);
945 trace_create_file("header_event", 0444, d_events,
946 ring_buffer_print_entry_header,
947 &ftrace_show_header_fops);
949 for_each_event(call, __start_ftrace_events, __stop_ftrace_events) {
950 /* The linker may leave blanks */
953 list_add(&call->list, &ftrace_events);
954 event_create_dir(call, d_events);
957 ret = register_module_notifier(&trace_module_nb);
959 pr_warning("Failed to register trace events module notifier\n");
963 fs_initcall(event_trace_init);
965 #ifdef CONFIG_FTRACE_STARTUP_TEST
967 static DEFINE_SPINLOCK(test_spinlock);
968 static DEFINE_SPINLOCK(test_spinlock_irq);
969 static DEFINE_MUTEX(test_mutex);
971 static __init void test_work(struct work_struct *dummy)
973 spin_lock(&test_spinlock);
974 spin_lock_irq(&test_spinlock_irq);
976 spin_unlock_irq(&test_spinlock_irq);
977 spin_unlock(&test_spinlock);
979 mutex_lock(&test_mutex);
981 mutex_unlock(&test_mutex);
984 static __init int event_test_thread(void *unused)
988 test_malloc = kmalloc(1234, GFP_KERNEL);
990 pr_info("failed to kmalloc\n");
992 schedule_on_each_cpu(test_work);
996 set_current_state(TASK_INTERRUPTIBLE);
997 while (!kthread_should_stop())
1004 * Do various things that may trigger events.
1006 static __init void event_test_stuff(void)
1008 struct task_struct *test_thread;
1010 test_thread = kthread_run(event_test_thread, NULL, "test-events");
1012 kthread_stop(test_thread);
1016 * For every trace event defined, we will test each trace point separately,
1017 * and then by groups, and finally all trace points.
1019 static __init void event_trace_self_tests(void)
1021 struct ftrace_event_call *call;
1022 struct event_subsystem *system;
1026 pr_info("Running tests on trace events:\n");
1028 list_for_each_entry(call, &ftrace_events, list) {
1030 /* Only test those that have a regfunc */
1034 pr_info("Testing event %s: ", call->name);
1037 * If an event is already enabled, someone is using
1038 * it and the self test should not be on.
1040 if (call->enabled) {
1041 pr_warning("Enabled event during self test!\n");
1057 /* Now test at the sub system level */
1059 pr_info("Running tests on trace event systems:\n");
1061 list_for_each_entry(system, &event_subsystems, list) {
1063 /* the ftrace system is special, skip it */
1064 if (strcmp(system->name, "ftrace") == 0)
1067 pr_info("Testing event system %s: ", system->name);
1069 /* ftrace_set_clr_event can modify the name passed in. */
1070 sysname = kstrdup(system->name, GFP_KERNEL);
1071 if (WARN_ON(!sysname)) {
1072 pr_warning("Can't allocate memory, giving up!\n");
1075 ret = ftrace_set_clr_event(sysname, 1);
1077 if (WARN_ON_ONCE(ret)) {
1078 pr_warning("error enabling system %s\n",
1085 sysname = kstrdup(system->name, GFP_KERNEL);
1086 if (WARN_ON(!sysname)) {
1087 pr_warning("Can't allocate memory, giving up!\n");
1090 ret = ftrace_set_clr_event(sysname, 0);
1093 if (WARN_ON_ONCE(ret))
1094 pr_warning("error disabling system %s\n",
1100 /* Test with all events enabled */
1102 pr_info("Running tests on all trace events:\n");
1103 pr_info("Testing all events: ");
1105 sysname = kmalloc(4, GFP_KERNEL);
1106 if (WARN_ON(!sysname)) {
1107 pr_warning("Can't allocate memory, giving up!\n");
1110 memcpy(sysname, "*:*", 4);
1111 ret = ftrace_set_clr_event(sysname, 1);
1112 if (WARN_ON_ONCE(ret)) {
1114 pr_warning("error enabling all events\n");
1121 memcpy(sysname, "*:*", 4);
1122 ret = ftrace_set_clr_event(sysname, 0);
1125 if (WARN_ON_ONCE(ret)) {
1126 pr_warning("error disabling all events\n");
1133 #ifdef CONFIG_FUNCTION_TRACER
1135 static DEFINE_PER_CPU(atomic_t, test_event_disable);
1138 function_test_events_call(unsigned long ip, unsigned long parent_ip)
1140 struct ring_buffer_event *event;
1141 struct ftrace_entry *entry;
1142 unsigned long flags;
1148 pc = preempt_count();
1149 resched = ftrace_preempt_disable();
1150 cpu = raw_smp_processor_id();
1151 disabled = atomic_inc_return(&per_cpu(test_event_disable, cpu));
1156 local_save_flags(flags);
1158 event = trace_current_buffer_lock_reserve(TRACE_FN, sizeof(*entry),
1162 entry = ring_buffer_event_data(event);
1164 entry->parent_ip = parent_ip;
1166 trace_nowake_buffer_unlock_commit(event, flags, pc);
1169 atomic_dec(&per_cpu(test_event_disable, cpu));
1170 ftrace_preempt_enable(resched);
1173 static struct ftrace_ops trace_ops __initdata =
1175 .func = function_test_events_call,
1178 static __init void event_trace_self_test_with_function(void)
1180 register_ftrace_function(&trace_ops);
1181 pr_info("Running tests again, along with the function tracer\n");
1182 event_trace_self_tests();
1183 unregister_ftrace_function(&trace_ops);
1186 static __init void event_trace_self_test_with_function(void)
1191 static __init int event_trace_self_tests_init(void)
1194 event_trace_self_tests();
1196 event_trace_self_test_with_function();
1201 late_initcall(event_trace_self_tests_init);