4 * Copyright (C) 2008 Red Hat Inc, Steven Rostedt <srostedt@redhat.com>
8 #include <linux/module.h>
9 #include <linux/mutex.h>
10 #include <linux/ftrace.h>
12 #include "trace_output.h"
14 /* must be a power of 2 */
15 #define EVENT_HASHSIZE 128
17 static DEFINE_MUTEX(trace_event_mutex);
18 static struct hlist_head event_hash[EVENT_HASHSIZE] __read_mostly;
20 static int next_event_type = __TRACE_LAST_TYPE + 1;
22 void trace_print_seq(struct seq_file *m, struct trace_seq *s)
24 int len = s->len >= PAGE_SIZE ? PAGE_SIZE - 1 : s->len;
27 seq_puts(m, s->buffer);
32 enum print_line_t trace_print_bprintk_msg_only(struct trace_iterator *iter)
34 struct trace_seq *s = &iter->seq;
35 struct trace_entry *entry = iter->ent;
36 struct bprint_entry *field;
39 trace_assign_type(field, entry);
41 ret = trace_seq_bprintf(s, field->fmt, field->buf);
43 return TRACE_TYPE_PARTIAL_LINE;
45 return TRACE_TYPE_HANDLED;
48 enum print_line_t trace_print_printk_msg_only(struct trace_iterator *iter)
50 struct trace_seq *s = &iter->seq;
51 struct trace_entry *entry = iter->ent;
52 struct print_entry *field;
55 trace_assign_type(field, entry);
57 ret = trace_seq_printf(s, "%s", field->buf);
59 return TRACE_TYPE_PARTIAL_LINE;
61 return TRACE_TYPE_HANDLED;
65 * trace_seq_printf - sequence printing of trace information
66 * @s: trace sequence descriptor
67 * @fmt: printf format string
69 * The tracer may use either sequence operations or its own
70 * copy to user routines. To simplify formating of a trace
71 * trace_seq_printf is used to store strings into a special
72 * buffer (@s). Then the output may be either used by
73 * the sequencer or pulled into another buffer.
76 trace_seq_printf(struct trace_seq *s, const char *fmt, ...)
78 int len = (PAGE_SIZE - 1) - s->len;
86 ret = vsnprintf(s->buffer + s->len, len, fmt, ap);
89 /* If we can't write it all, don't bother writing anything */
98 int trace_seq_bprintf(struct trace_seq *s, const char *fmt, const u32 *binary)
100 int len = (PAGE_SIZE - 1) - s->len;
106 ret = bstr_printf(s->buffer + s->len, len, fmt, binary);
108 /* If we can't write it all, don't bother writing anything */
118 * trace_seq_puts - trace sequence printing of simple string
119 * @s: trace sequence descriptor
120 * @str: simple string to record
122 * The tracer may use either the sequence operations or its own
123 * copy to user routines. This function records a simple string
124 * into a special buffer (@s) for later retrieval by a sequencer
125 * or other mechanism.
127 int trace_seq_puts(struct trace_seq *s, const char *str)
129 int len = strlen(str);
131 if (len > ((PAGE_SIZE - 1) - s->len))
134 memcpy(s->buffer + s->len, str, len);
140 int trace_seq_putc(struct trace_seq *s, unsigned char c)
142 if (s->len >= (PAGE_SIZE - 1))
145 s->buffer[s->len++] = c;
150 int trace_seq_putmem(struct trace_seq *s, void *mem, size_t len)
152 if (len > ((PAGE_SIZE - 1) - s->len))
155 memcpy(s->buffer + s->len, mem, len);
161 int trace_seq_putmem_hex(struct trace_seq *s, void *mem, size_t len)
163 unsigned char hex[HEX_CHARS];
164 unsigned char *data = mem;
168 for (i = 0, j = 0; i < len; i++) {
170 for (i = len-1, j = 0; i >= 0; i--) {
172 hex[j++] = hex_asc_hi(data[i]);
173 hex[j++] = hex_asc_lo(data[i]);
177 return trace_seq_putmem(s, hex, j);
180 int trace_seq_path(struct trace_seq *s, struct path *path)
184 if (s->len >= (PAGE_SIZE - 1))
186 p = d_path(path, s->buffer + s->len, PAGE_SIZE - s->len);
188 p = mangle_path(s->buffer + s->len, p, "\n");
190 s->len = p - s->buffer;
194 s->buffer[s->len++] = '?';
201 #ifdef CONFIG_KRETPROBES
202 static inline const char *kretprobed(const char *name)
204 static const char tramp_name[] = "kretprobe_trampoline";
205 int size = sizeof(tramp_name);
207 if (strncmp(tramp_name, name, size) == 0)
208 return "[unknown/kretprobe'd]";
212 static inline const char *kretprobed(const char *name)
216 #endif /* CONFIG_KRETPROBES */
219 seq_print_sym_short(struct trace_seq *s, const char *fmt, unsigned long address)
221 #ifdef CONFIG_KALLSYMS
222 char str[KSYM_SYMBOL_LEN];
225 kallsyms_lookup(address, NULL, NULL, NULL, str);
227 name = kretprobed(str);
229 return trace_seq_printf(s, fmt, name);
235 seq_print_sym_offset(struct trace_seq *s, const char *fmt,
236 unsigned long address)
238 #ifdef CONFIG_KALLSYMS
239 char str[KSYM_SYMBOL_LEN];
242 sprint_symbol(str, address);
243 name = kretprobed(str);
245 return trace_seq_printf(s, fmt, name);
251 # define IP_FMT "%08lx"
253 # define IP_FMT "%016lx"
256 int seq_print_user_ip(struct trace_seq *s, struct mm_struct *mm,
257 unsigned long ip, unsigned long sym_flags)
259 struct file *file = NULL;
260 unsigned long vmstart = 0;
264 const struct vm_area_struct *vma;
266 down_read(&mm->mmap_sem);
267 vma = find_vma(mm, ip);
270 vmstart = vma->vm_start;
273 ret = trace_seq_path(s, &file->f_path);
275 ret = trace_seq_printf(s, "[+0x%lx]",
278 up_read(&mm->mmap_sem);
280 if (ret && ((sym_flags & TRACE_ITER_SYM_ADDR) || !file))
281 ret = trace_seq_printf(s, " <" IP_FMT ">", ip);
286 seq_print_userip_objs(const struct userstack_entry *entry, struct trace_seq *s,
287 unsigned long sym_flags)
289 struct mm_struct *mm = NULL;
293 if (trace_flags & TRACE_ITER_SYM_USEROBJ) {
294 struct task_struct *task;
296 * we do the lookup on the thread group leader,
297 * since individual threads might have already quit!
300 task = find_task_by_vpid(entry->ent.tgid);
302 mm = get_task_mm(task);
306 for (i = 0; i < FTRACE_STACK_ENTRIES; i++) {
307 unsigned long ip = entry->caller[i];
309 if (ip == ULONG_MAX || !ret)
312 ret = trace_seq_puts(s, " <- ");
315 ret = trace_seq_puts(s, "??");
321 ret = seq_print_user_ip(s, mm, ip, sym_flags);
330 seq_print_ip_sym(struct trace_seq *s, unsigned long ip, unsigned long sym_flags)
335 return trace_seq_printf(s, "0");
337 if (sym_flags & TRACE_ITER_SYM_OFFSET)
338 ret = seq_print_sym_offset(s, "%s", ip);
340 ret = seq_print_sym_short(s, "%s", ip);
345 if (sym_flags & TRACE_ITER_SYM_ADDR)
346 ret = trace_seq_printf(s, " <" IP_FMT ">", ip);
351 lat_print_generic(struct trace_seq *s, struct trace_entry *entry, int cpu)
353 int hardirq, softirq;
354 char comm[TASK_COMM_LEN];
356 trace_find_cmdline(entry->pid, comm);
357 hardirq = entry->flags & TRACE_FLAG_HARDIRQ;
358 softirq = entry->flags & TRACE_FLAG_SOFTIRQ;
360 if (!trace_seq_printf(s, "%8.8s-%-5d %3d%c%c%c",
361 comm, entry->pid, cpu,
362 (entry->flags & TRACE_FLAG_IRQS_OFF) ? 'd' :
363 (entry->flags & TRACE_FLAG_IRQS_NOSUPPORT) ?
365 (entry->flags & TRACE_FLAG_NEED_RESCHED) ?
367 (hardirq && softirq) ? 'H' :
368 hardirq ? 'h' : softirq ? 's' : '.'))
371 if (entry->preempt_count)
372 return trace_seq_printf(s, "%x", entry->preempt_count);
373 return trace_seq_puts(s, ".");
376 static unsigned long preempt_mark_thresh = 100;
379 lat_print_timestamp(struct trace_seq *s, u64 abs_usecs,
380 unsigned long rel_usecs)
382 return trace_seq_printf(s, " %4lldus%c: ", abs_usecs,
383 rel_usecs > preempt_mark_thresh ? '!' :
384 rel_usecs > 1 ? '+' : ' ');
387 int trace_print_context(struct trace_iterator *iter)
389 struct trace_seq *s = &iter->seq;
390 struct trace_entry *entry = iter->ent;
391 unsigned long long t = ns2usecs(iter->ts);
392 unsigned long usec_rem = do_div(t, USEC_PER_SEC);
393 unsigned long secs = (unsigned long)t;
394 char comm[TASK_COMM_LEN];
396 trace_find_cmdline(entry->pid, comm);
398 return trace_seq_printf(s, "%16s-%-5d [%03d] %5lu.%06lu: ",
399 comm, entry->pid, iter->cpu, secs, usec_rem);
402 int trace_print_lat_context(struct trace_iterator *iter)
406 struct trace_seq *s = &iter->seq;
407 struct trace_entry *entry = iter->ent,
408 *next_entry = trace_find_next_entry(iter, NULL,
410 unsigned long verbose = (trace_flags & TRACE_ITER_VERBOSE);
411 unsigned long abs_usecs = ns2usecs(iter->ts - iter->tr->time_start);
412 unsigned long rel_usecs;
416 rel_usecs = ns2usecs(next_ts - iter->ts);
419 char comm[TASK_COMM_LEN];
421 trace_find_cmdline(entry->pid, comm);
423 ret = trace_seq_printf(s, "%16s %5d %3d %d %08x %08lx [%08lx]"
424 " %ld.%03ldms (+%ld.%03ldms): ", comm,
425 entry->pid, iter->cpu, entry->flags,
426 entry->preempt_count, iter->idx,
428 abs_usecs / USEC_PER_MSEC,
429 abs_usecs % USEC_PER_MSEC,
430 rel_usecs / USEC_PER_MSEC,
431 rel_usecs % USEC_PER_MSEC);
433 ret = lat_print_generic(s, entry, iter->cpu);
435 ret = lat_print_timestamp(s, abs_usecs, rel_usecs);
441 static const char state_to_char[] = TASK_STATE_TO_CHAR_STR;
443 static int task_state_char(unsigned long state)
445 int bit = state ? __ffs(state) + 1 : 0;
447 return bit < sizeof(state_to_char) - 1 ? state_to_char[bit] : '?';
451 * ftrace_find_event - find a registered event
452 * @type: the type of event to look for
454 * Returns an event of type @type otherwise NULL
456 struct trace_event *ftrace_find_event(int type)
458 struct trace_event *event;
459 struct hlist_node *n;
462 key = type & (EVENT_HASHSIZE - 1);
464 hlist_for_each_entry_rcu(event, n, &event_hash[key], node) {
465 if (event->type == type)
473 * register_ftrace_event - register output for an event type
474 * @event: the event type to register
476 * Event types are stored in a hash and this hash is used to
477 * find a way to print an event. If the @event->type is set
478 * then it will use that type, otherwise it will assign a
481 * If you assign your own type, please make sure it is added
482 * to the trace_type enum in trace.h, to avoid collisions
483 * with the dynamic types.
485 * Returns the event type number or zero on error.
487 int register_ftrace_event(struct trace_event *event)
492 mutex_lock(&trace_event_mutex);
495 ret = next_event_type++;
500 event->type = next_event_type++;
501 else if (event->type > __TRACE_LAST_TYPE) {
502 printk(KERN_WARNING "Need to add type to trace.h\n");
506 if (ftrace_find_event(event->type))
509 if (event->trace == NULL)
510 event->trace = trace_nop_print;
511 if (event->raw == NULL)
512 event->raw = trace_nop_print;
513 if (event->hex == NULL)
514 event->hex = trace_nop_print;
515 if (event->binary == NULL)
516 event->binary = trace_nop_print;
518 key = event->type & (EVENT_HASHSIZE - 1);
520 hlist_add_head_rcu(&event->node, &event_hash[key]);
524 mutex_unlock(&trace_event_mutex);
530 * unregister_ftrace_event - remove a no longer used event
531 * @event: the event to remove
533 int unregister_ftrace_event(struct trace_event *event)
535 mutex_lock(&trace_event_mutex);
536 hlist_del(&event->node);
537 mutex_unlock(&trace_event_mutex);
546 enum print_line_t trace_nop_print(struct trace_iterator *iter, int flags)
548 return TRACE_TYPE_HANDLED;
552 static enum print_line_t trace_fn_trace(struct trace_iterator *iter, int flags)
554 struct ftrace_entry *field;
555 struct trace_seq *s = &iter->seq;
557 trace_assign_type(field, iter->ent);
559 if (!seq_print_ip_sym(s, field->ip, flags))
562 if ((flags & TRACE_ITER_PRINT_PARENT) && field->parent_ip) {
563 if (!trace_seq_printf(s, " <-"))
565 if (!seq_print_ip_sym(s,
570 if (!trace_seq_printf(s, "\n"))
573 return TRACE_TYPE_HANDLED;
576 return TRACE_TYPE_PARTIAL_LINE;
579 static enum print_line_t trace_fn_raw(struct trace_iterator *iter, int flags)
581 struct ftrace_entry *field;
583 trace_assign_type(field, iter->ent);
585 if (!trace_seq_printf(&iter->seq, "%lx %lx\n",
588 return TRACE_TYPE_PARTIAL_LINE;
590 return TRACE_TYPE_HANDLED;
593 static enum print_line_t trace_fn_hex(struct trace_iterator *iter, int flags)
595 struct ftrace_entry *field;
596 struct trace_seq *s = &iter->seq;
598 trace_assign_type(field, iter->ent);
600 SEQ_PUT_HEX_FIELD_RET(s, field->ip);
601 SEQ_PUT_HEX_FIELD_RET(s, field->parent_ip);
603 return TRACE_TYPE_HANDLED;
606 static enum print_line_t trace_fn_bin(struct trace_iterator *iter, int flags)
608 struct ftrace_entry *field;
609 struct trace_seq *s = &iter->seq;
611 trace_assign_type(field, iter->ent);
613 SEQ_PUT_FIELD_RET(s, field->ip);
614 SEQ_PUT_FIELD_RET(s, field->parent_ip);
616 return TRACE_TYPE_HANDLED;
619 static struct trace_event trace_fn_event = {
621 .trace = trace_fn_trace,
624 .binary = trace_fn_bin,
627 /* TRACE_CTX an TRACE_WAKE */
628 static enum print_line_t trace_ctxwake_print(struct trace_iterator *iter,
631 struct ctx_switch_entry *field;
632 char comm[TASK_COMM_LEN];
636 trace_assign_type(field, iter->ent);
638 T = task_state_char(field->next_state);
639 S = task_state_char(field->prev_state);
640 trace_find_cmdline(field->next_pid, comm);
641 if (!trace_seq_printf(&iter->seq,
642 " %5d:%3d:%c %s [%03d] %5d:%3d:%c %s\n",
650 return TRACE_TYPE_PARTIAL_LINE;
652 return TRACE_TYPE_HANDLED;
655 static enum print_line_t trace_ctx_print(struct trace_iterator *iter, int flags)
657 return trace_ctxwake_print(iter, "==>");
660 static enum print_line_t trace_wake_print(struct trace_iterator *iter,
663 return trace_ctxwake_print(iter, " +");
666 static int trace_ctxwake_raw(struct trace_iterator *iter, char S)
668 struct ctx_switch_entry *field;
671 trace_assign_type(field, iter->ent);
674 task_state_char(field->prev_state);
675 T = task_state_char(field->next_state);
676 if (!trace_seq_printf(&iter->seq, "%d %d %c %d %d %d %c\n",
684 return TRACE_TYPE_PARTIAL_LINE;
686 return TRACE_TYPE_HANDLED;
689 static enum print_line_t trace_ctx_raw(struct trace_iterator *iter, int flags)
691 return trace_ctxwake_raw(iter, 0);
694 static enum print_line_t trace_wake_raw(struct trace_iterator *iter, int flags)
696 return trace_ctxwake_raw(iter, '+');
700 static int trace_ctxwake_hex(struct trace_iterator *iter, char S)
702 struct ctx_switch_entry *field;
703 struct trace_seq *s = &iter->seq;
706 trace_assign_type(field, iter->ent);
709 task_state_char(field->prev_state);
710 T = task_state_char(field->next_state);
712 SEQ_PUT_HEX_FIELD_RET(s, field->prev_pid);
713 SEQ_PUT_HEX_FIELD_RET(s, field->prev_prio);
714 SEQ_PUT_HEX_FIELD_RET(s, S);
715 SEQ_PUT_HEX_FIELD_RET(s, field->next_cpu);
716 SEQ_PUT_HEX_FIELD_RET(s, field->next_pid);
717 SEQ_PUT_HEX_FIELD_RET(s, field->next_prio);
718 SEQ_PUT_HEX_FIELD_RET(s, T);
720 return TRACE_TYPE_HANDLED;
723 static enum print_line_t trace_ctx_hex(struct trace_iterator *iter, int flags)
725 return trace_ctxwake_hex(iter, 0);
728 static enum print_line_t trace_wake_hex(struct trace_iterator *iter, int flags)
730 return trace_ctxwake_hex(iter, '+');
733 static enum print_line_t trace_ctxwake_bin(struct trace_iterator *iter,
736 struct ctx_switch_entry *field;
737 struct trace_seq *s = &iter->seq;
739 trace_assign_type(field, iter->ent);
741 SEQ_PUT_FIELD_RET(s, field->prev_pid);
742 SEQ_PUT_FIELD_RET(s, field->prev_prio);
743 SEQ_PUT_FIELD_RET(s, field->prev_state);
744 SEQ_PUT_FIELD_RET(s, field->next_pid);
745 SEQ_PUT_FIELD_RET(s, field->next_prio);
746 SEQ_PUT_FIELD_RET(s, field->next_state);
748 return TRACE_TYPE_HANDLED;
751 static struct trace_event trace_ctx_event = {
753 .trace = trace_ctx_print,
754 .raw = trace_ctx_raw,
755 .hex = trace_ctx_hex,
756 .binary = trace_ctxwake_bin,
759 static struct trace_event trace_wake_event = {
761 .trace = trace_wake_print,
762 .raw = trace_wake_raw,
763 .hex = trace_wake_hex,
764 .binary = trace_ctxwake_bin,
768 static enum print_line_t trace_special_print(struct trace_iterator *iter,
771 struct special_entry *field;
773 trace_assign_type(field, iter->ent);
775 if (!trace_seq_printf(&iter->seq, "# %ld %ld %ld\n",
779 return TRACE_TYPE_PARTIAL_LINE;
781 return TRACE_TYPE_HANDLED;
784 static enum print_line_t trace_special_hex(struct trace_iterator *iter,
787 struct special_entry *field;
788 struct trace_seq *s = &iter->seq;
790 trace_assign_type(field, iter->ent);
792 SEQ_PUT_HEX_FIELD_RET(s, field->arg1);
793 SEQ_PUT_HEX_FIELD_RET(s, field->arg2);
794 SEQ_PUT_HEX_FIELD_RET(s, field->arg3);
796 return TRACE_TYPE_HANDLED;
799 static enum print_line_t trace_special_bin(struct trace_iterator *iter,
802 struct special_entry *field;
803 struct trace_seq *s = &iter->seq;
805 trace_assign_type(field, iter->ent);
807 SEQ_PUT_FIELD_RET(s, field->arg1);
808 SEQ_PUT_FIELD_RET(s, field->arg2);
809 SEQ_PUT_FIELD_RET(s, field->arg3);
811 return TRACE_TYPE_HANDLED;
814 static struct trace_event trace_special_event = {
815 .type = TRACE_SPECIAL,
816 .trace = trace_special_print,
817 .raw = trace_special_print,
818 .hex = trace_special_hex,
819 .binary = trace_special_bin,
824 static enum print_line_t trace_stack_print(struct trace_iterator *iter,
827 struct stack_entry *field;
828 struct trace_seq *s = &iter->seq;
831 trace_assign_type(field, iter->ent);
833 for (i = 0; i < FTRACE_STACK_ENTRIES; i++) {
835 if (!trace_seq_puts(s, " <= "))
838 if (!seq_print_ip_sym(s, field->caller[i], flags))
841 if (!trace_seq_puts(s, "\n"))
845 return TRACE_TYPE_HANDLED;
848 return TRACE_TYPE_PARTIAL_LINE;
851 static struct trace_event trace_stack_event = {
853 .trace = trace_stack_print,
854 .raw = trace_special_print,
855 .hex = trace_special_hex,
856 .binary = trace_special_bin,
859 /* TRACE_USER_STACK */
860 static enum print_line_t trace_user_stack_print(struct trace_iterator *iter,
863 struct userstack_entry *field;
864 struct trace_seq *s = &iter->seq;
866 trace_assign_type(field, iter->ent);
868 if (!seq_print_userip_objs(field, s, flags))
871 if (!trace_seq_putc(s, '\n'))
874 return TRACE_TYPE_HANDLED;
877 return TRACE_TYPE_PARTIAL_LINE;
880 static struct trace_event trace_user_stack_event = {
881 .type = TRACE_USER_STACK,
882 .trace = trace_user_stack_print,
883 .raw = trace_special_print,
884 .hex = trace_special_hex,
885 .binary = trace_special_bin,
889 static enum print_line_t
890 trace_bprint_print(struct trace_iterator *iter, int flags)
892 struct trace_entry *entry = iter->ent;
893 struct trace_seq *s = &iter->seq;
894 struct bprint_entry *field;
896 trace_assign_type(field, entry);
898 if (!seq_print_ip_sym(s, field->ip, flags))
901 if (!trace_seq_puts(s, ": "))
904 if (!trace_seq_bprintf(s, field->fmt, field->buf))
907 return TRACE_TYPE_HANDLED;
910 return TRACE_TYPE_PARTIAL_LINE;
914 static enum print_line_t
915 trace_bprint_raw(struct trace_iterator *iter, int flags)
917 struct bprint_entry *field;
918 struct trace_seq *s = &iter->seq;
920 trace_assign_type(field, iter->ent);
922 if (!trace_seq_printf(s, ": %lx : ", field->ip))
925 if (!trace_seq_bprintf(s, field->fmt, field->buf))
928 return TRACE_TYPE_HANDLED;
931 return TRACE_TYPE_PARTIAL_LINE;
935 static struct trace_event trace_bprint_event = {
936 .type = TRACE_BPRINT,
937 .trace = trace_bprint_print,
938 .raw = trace_bprint_raw,
942 static enum print_line_t trace_print_print(struct trace_iterator *iter,
945 struct print_entry *field;
946 struct trace_seq *s = &iter->seq;
948 trace_assign_type(field, iter->ent);
950 if (!seq_print_ip_sym(s, field->ip, flags))
953 if (!trace_seq_printf(s, ": %s", field->buf))
956 return TRACE_TYPE_HANDLED;
959 return TRACE_TYPE_PARTIAL_LINE;
962 static enum print_line_t trace_print_raw(struct trace_iterator *iter, int flags)
964 struct print_entry *field;
966 trace_assign_type(field, iter->ent);
968 if (!trace_seq_printf(&iter->seq, "# %lx %s", field->ip, field->buf))
971 return TRACE_TYPE_HANDLED;
974 return TRACE_TYPE_PARTIAL_LINE;
977 static struct trace_event trace_print_event = {
979 .trace = trace_print_print,
980 .raw = trace_print_raw,
984 static struct trace_event *events[] __initdata = {
988 &trace_special_event,
990 &trace_user_stack_event,
996 __init static int init_events(void)
998 struct trace_event *event;
1001 for (i = 0; events[i]; i++) {
1004 ret = register_ftrace_event(event);
1006 printk(KERN_WARNING "event %d failed to register\n",
1014 device_initcall(init_events);