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 */
97 EXPORT_SYMBOL_GPL(trace_seq_printf);
99 int trace_seq_bprintf(struct trace_seq *s, const char *fmt, const u32 *binary)
101 int len = (PAGE_SIZE - 1) - s->len;
107 ret = bstr_printf(s->buffer + s->len, len, fmt, binary);
109 /* If we can't write it all, don't bother writing anything */
119 * trace_seq_puts - trace sequence printing of simple string
120 * @s: trace sequence descriptor
121 * @str: simple string to record
123 * The tracer may use either the sequence operations or its own
124 * copy to user routines. This function records a simple string
125 * into a special buffer (@s) for later retrieval by a sequencer
126 * or other mechanism.
128 int trace_seq_puts(struct trace_seq *s, const char *str)
130 int len = strlen(str);
132 if (len > ((PAGE_SIZE - 1) - s->len))
135 memcpy(s->buffer + s->len, str, len);
141 int trace_seq_putc(struct trace_seq *s, unsigned char c)
143 if (s->len >= (PAGE_SIZE - 1))
146 s->buffer[s->len++] = c;
151 int trace_seq_putmem(struct trace_seq *s, const void *mem, size_t len)
153 if (len > ((PAGE_SIZE - 1) - s->len))
156 memcpy(s->buffer + s->len, mem, len);
162 int trace_seq_putmem_hex(struct trace_seq *s, const void *mem, size_t len)
164 unsigned char hex[HEX_CHARS];
165 const unsigned char *data = mem;
169 for (i = 0, j = 0; i < len; i++) {
171 for (i = len-1, j = 0; i >= 0; i--) {
173 hex[j++] = hex_asc_hi(data[i]);
174 hex[j++] = hex_asc_lo(data[i]);
178 return trace_seq_putmem(s, hex, j);
181 void *trace_seq_reserve(struct trace_seq *s, size_t len)
185 if (len > ((PAGE_SIZE - 1) - s->len))
188 ret = s->buffer + s->len;
194 int trace_seq_path(struct trace_seq *s, struct path *path)
198 if (s->len >= (PAGE_SIZE - 1))
200 p = d_path(path, s->buffer + s->len, PAGE_SIZE - s->len);
202 p = mangle_path(s->buffer + s->len, p, "\n");
204 s->len = p - s->buffer;
208 s->buffer[s->len++] = '?';
215 #ifdef CONFIG_KRETPROBES
216 static inline const char *kretprobed(const char *name)
218 static const char tramp_name[] = "kretprobe_trampoline";
219 int size = sizeof(tramp_name);
221 if (strncmp(tramp_name, name, size) == 0)
222 return "[unknown/kretprobe'd]";
226 static inline const char *kretprobed(const char *name)
230 #endif /* CONFIG_KRETPROBES */
233 seq_print_sym_short(struct trace_seq *s, const char *fmt, unsigned long address)
235 #ifdef CONFIG_KALLSYMS
236 char str[KSYM_SYMBOL_LEN];
239 kallsyms_lookup(address, NULL, NULL, NULL, str);
241 name = kretprobed(str);
243 return trace_seq_printf(s, fmt, name);
249 seq_print_sym_offset(struct trace_seq *s, const char *fmt,
250 unsigned long address)
252 #ifdef CONFIG_KALLSYMS
253 char str[KSYM_SYMBOL_LEN];
256 sprint_symbol(str, address);
257 name = kretprobed(str);
259 return trace_seq_printf(s, fmt, name);
265 # define IP_FMT "%08lx"
267 # define IP_FMT "%016lx"
270 int seq_print_user_ip(struct trace_seq *s, struct mm_struct *mm,
271 unsigned long ip, unsigned long sym_flags)
273 struct file *file = NULL;
274 unsigned long vmstart = 0;
278 const struct vm_area_struct *vma;
280 down_read(&mm->mmap_sem);
281 vma = find_vma(mm, ip);
284 vmstart = vma->vm_start;
287 ret = trace_seq_path(s, &file->f_path);
289 ret = trace_seq_printf(s, "[+0x%lx]",
292 up_read(&mm->mmap_sem);
294 if (ret && ((sym_flags & TRACE_ITER_SYM_ADDR) || !file))
295 ret = trace_seq_printf(s, " <" IP_FMT ">", ip);
300 seq_print_userip_objs(const struct userstack_entry *entry, struct trace_seq *s,
301 unsigned long sym_flags)
303 struct mm_struct *mm = NULL;
307 if (trace_flags & TRACE_ITER_SYM_USEROBJ) {
308 struct task_struct *task;
310 * we do the lookup on the thread group leader,
311 * since individual threads might have already quit!
314 task = find_task_by_vpid(entry->ent.tgid);
316 mm = get_task_mm(task);
320 for (i = 0; i < FTRACE_STACK_ENTRIES; i++) {
321 unsigned long ip = entry->caller[i];
323 if (ip == ULONG_MAX || !ret)
326 ret = trace_seq_puts(s, " <- ");
329 ret = trace_seq_puts(s, "??");
335 ret = seq_print_user_ip(s, mm, ip, sym_flags);
344 seq_print_ip_sym(struct trace_seq *s, unsigned long ip, unsigned long sym_flags)
349 return trace_seq_printf(s, "0");
351 if (sym_flags & TRACE_ITER_SYM_OFFSET)
352 ret = seq_print_sym_offset(s, "%s", ip);
354 ret = seq_print_sym_short(s, "%s", ip);
359 if (sym_flags & TRACE_ITER_SYM_ADDR)
360 ret = trace_seq_printf(s, " <" IP_FMT ">", ip);
365 lat_print_generic(struct trace_seq *s, struct trace_entry *entry, int cpu)
367 int hardirq, softirq;
368 char comm[TASK_COMM_LEN];
370 trace_find_cmdline(entry->pid, comm);
371 hardirq = entry->flags & TRACE_FLAG_HARDIRQ;
372 softirq = entry->flags & TRACE_FLAG_SOFTIRQ;
374 if (!trace_seq_printf(s, "%8.8s-%-5d %3d%c%c%c",
375 comm, entry->pid, cpu,
376 (entry->flags & TRACE_FLAG_IRQS_OFF) ? 'd' :
377 (entry->flags & TRACE_FLAG_IRQS_NOSUPPORT) ?
379 (entry->flags & TRACE_FLAG_NEED_RESCHED) ?
381 (hardirq && softirq) ? 'H' :
382 hardirq ? 'h' : softirq ? 's' : '.'))
385 if (entry->preempt_count)
386 return trace_seq_printf(s, "%x", entry->preempt_count);
387 return trace_seq_puts(s, ".");
390 static unsigned long preempt_mark_thresh = 100;
393 lat_print_timestamp(struct trace_seq *s, u64 abs_usecs,
394 unsigned long rel_usecs)
396 return trace_seq_printf(s, " %4lldus%c: ", abs_usecs,
397 rel_usecs > preempt_mark_thresh ? '!' :
398 rel_usecs > 1 ? '+' : ' ');
401 int trace_print_context(struct trace_iterator *iter)
403 struct trace_seq *s = &iter->seq;
404 struct trace_entry *entry = iter->ent;
405 unsigned long long t = ns2usecs(iter->ts);
406 unsigned long usec_rem = do_div(t, USEC_PER_SEC);
407 unsigned long secs = (unsigned long)t;
408 char comm[TASK_COMM_LEN];
410 trace_find_cmdline(entry->pid, comm);
412 return trace_seq_printf(s, "%16s-%-5d [%03d] %5lu.%06lu: ",
413 comm, entry->pid, iter->cpu, secs, usec_rem);
416 int trace_print_lat_context(struct trace_iterator *iter)
420 struct trace_seq *s = &iter->seq;
421 struct trace_entry *entry = iter->ent,
422 *next_entry = trace_find_next_entry(iter, NULL,
424 unsigned long verbose = (trace_flags & TRACE_ITER_VERBOSE);
425 unsigned long abs_usecs = ns2usecs(iter->ts - iter->tr->time_start);
426 unsigned long rel_usecs;
430 rel_usecs = ns2usecs(next_ts - iter->ts);
433 char comm[TASK_COMM_LEN];
435 trace_find_cmdline(entry->pid, comm);
437 ret = trace_seq_printf(s, "%16s %5d %3d %d %08x %08lx [%08llx]"
438 " %ld.%03ldms (+%ld.%03ldms): ", comm,
439 entry->pid, iter->cpu, entry->flags,
440 entry->preempt_count, iter->idx,
442 abs_usecs / USEC_PER_MSEC,
443 abs_usecs % USEC_PER_MSEC,
444 rel_usecs / USEC_PER_MSEC,
445 rel_usecs % USEC_PER_MSEC);
447 ret = lat_print_generic(s, entry, iter->cpu);
449 ret = lat_print_timestamp(s, abs_usecs, rel_usecs);
455 static const char state_to_char[] = TASK_STATE_TO_CHAR_STR;
457 static int task_state_char(unsigned long state)
459 int bit = state ? __ffs(state) + 1 : 0;
461 return bit < sizeof(state_to_char) - 1 ? state_to_char[bit] : '?';
465 * ftrace_find_event - find a registered event
466 * @type: the type of event to look for
468 * Returns an event of type @type otherwise NULL
470 struct trace_event *ftrace_find_event(int type)
472 struct trace_event *event;
473 struct hlist_node *n;
476 key = type & (EVENT_HASHSIZE - 1);
478 hlist_for_each_entry_rcu(event, n, &event_hash[key], node) {
479 if (event->type == type)
487 * register_ftrace_event - register output for an event type
488 * @event: the event type to register
490 * Event types are stored in a hash and this hash is used to
491 * find a way to print an event. If the @event->type is set
492 * then it will use that type, otherwise it will assign a
495 * If you assign your own type, please make sure it is added
496 * to the trace_type enum in trace.h, to avoid collisions
497 * with the dynamic types.
499 * Returns the event type number or zero on error.
501 int register_ftrace_event(struct trace_event *event)
506 mutex_lock(&trace_event_mutex);
509 ret = next_event_type++;
514 event->type = next_event_type++;
515 else if (event->type > __TRACE_LAST_TYPE) {
516 printk(KERN_WARNING "Need to add type to trace.h\n");
520 if (ftrace_find_event(event->type))
523 if (event->trace == NULL)
524 event->trace = trace_nop_print;
525 if (event->raw == NULL)
526 event->raw = trace_nop_print;
527 if (event->hex == NULL)
528 event->hex = trace_nop_print;
529 if (event->binary == NULL)
530 event->binary = trace_nop_print;
532 key = event->type & (EVENT_HASHSIZE - 1);
534 hlist_add_head_rcu(&event->node, &event_hash[key]);
538 mutex_unlock(&trace_event_mutex);
542 EXPORT_SYMBOL_GPL(register_ftrace_event);
545 * unregister_ftrace_event - remove a no longer used event
546 * @event: the event to remove
548 int unregister_ftrace_event(struct trace_event *event)
550 mutex_lock(&trace_event_mutex);
551 hlist_del(&event->node);
552 mutex_unlock(&trace_event_mutex);
556 EXPORT_SYMBOL_GPL(unregister_ftrace_event);
562 enum print_line_t trace_nop_print(struct trace_iterator *iter, int flags)
564 return TRACE_TYPE_HANDLED;
568 static enum print_line_t trace_fn_trace(struct trace_iterator *iter, int flags)
570 struct ftrace_entry *field;
571 struct trace_seq *s = &iter->seq;
573 trace_assign_type(field, iter->ent);
575 if (!seq_print_ip_sym(s, field->ip, flags))
578 if ((flags & TRACE_ITER_PRINT_PARENT) && field->parent_ip) {
579 if (!trace_seq_printf(s, " <-"))
581 if (!seq_print_ip_sym(s,
586 if (!trace_seq_printf(s, "\n"))
589 return TRACE_TYPE_HANDLED;
592 return TRACE_TYPE_PARTIAL_LINE;
595 static enum print_line_t trace_fn_raw(struct trace_iterator *iter, int flags)
597 struct ftrace_entry *field;
599 trace_assign_type(field, iter->ent);
601 if (!trace_seq_printf(&iter->seq, "%lx %lx\n",
604 return TRACE_TYPE_PARTIAL_LINE;
606 return TRACE_TYPE_HANDLED;
609 static enum print_line_t trace_fn_hex(struct trace_iterator *iter, int flags)
611 struct ftrace_entry *field;
612 struct trace_seq *s = &iter->seq;
614 trace_assign_type(field, iter->ent);
616 SEQ_PUT_HEX_FIELD_RET(s, field->ip);
617 SEQ_PUT_HEX_FIELD_RET(s, field->parent_ip);
619 return TRACE_TYPE_HANDLED;
622 static enum print_line_t trace_fn_bin(struct trace_iterator *iter, int flags)
624 struct ftrace_entry *field;
625 struct trace_seq *s = &iter->seq;
627 trace_assign_type(field, iter->ent);
629 SEQ_PUT_FIELD_RET(s, field->ip);
630 SEQ_PUT_FIELD_RET(s, field->parent_ip);
632 return TRACE_TYPE_HANDLED;
635 static struct trace_event trace_fn_event = {
637 .trace = trace_fn_trace,
640 .binary = trace_fn_bin,
643 /* TRACE_CTX an TRACE_WAKE */
644 static enum print_line_t trace_ctxwake_print(struct trace_iterator *iter,
647 struct ctx_switch_entry *field;
648 char comm[TASK_COMM_LEN];
652 trace_assign_type(field, iter->ent);
654 T = task_state_char(field->next_state);
655 S = task_state_char(field->prev_state);
656 trace_find_cmdline(field->next_pid, comm);
657 if (!trace_seq_printf(&iter->seq,
658 " %5d:%3d:%c %s [%03d] %5d:%3d:%c %s\n",
666 return TRACE_TYPE_PARTIAL_LINE;
668 return TRACE_TYPE_HANDLED;
671 static enum print_line_t trace_ctx_print(struct trace_iterator *iter, int flags)
673 return trace_ctxwake_print(iter, "==>");
676 static enum print_line_t trace_wake_print(struct trace_iterator *iter,
679 return trace_ctxwake_print(iter, " +");
682 static int trace_ctxwake_raw(struct trace_iterator *iter, char S)
684 struct ctx_switch_entry *field;
687 trace_assign_type(field, iter->ent);
690 task_state_char(field->prev_state);
691 T = task_state_char(field->next_state);
692 if (!trace_seq_printf(&iter->seq, "%d %d %c %d %d %d %c\n",
700 return TRACE_TYPE_PARTIAL_LINE;
702 return TRACE_TYPE_HANDLED;
705 static enum print_line_t trace_ctx_raw(struct trace_iterator *iter, int flags)
707 return trace_ctxwake_raw(iter, 0);
710 static enum print_line_t trace_wake_raw(struct trace_iterator *iter, int flags)
712 return trace_ctxwake_raw(iter, '+');
716 static int trace_ctxwake_hex(struct trace_iterator *iter, char S)
718 struct ctx_switch_entry *field;
719 struct trace_seq *s = &iter->seq;
722 trace_assign_type(field, iter->ent);
725 task_state_char(field->prev_state);
726 T = task_state_char(field->next_state);
728 SEQ_PUT_HEX_FIELD_RET(s, field->prev_pid);
729 SEQ_PUT_HEX_FIELD_RET(s, field->prev_prio);
730 SEQ_PUT_HEX_FIELD_RET(s, S);
731 SEQ_PUT_HEX_FIELD_RET(s, field->next_cpu);
732 SEQ_PUT_HEX_FIELD_RET(s, field->next_pid);
733 SEQ_PUT_HEX_FIELD_RET(s, field->next_prio);
734 SEQ_PUT_HEX_FIELD_RET(s, T);
736 return TRACE_TYPE_HANDLED;
739 static enum print_line_t trace_ctx_hex(struct trace_iterator *iter, int flags)
741 return trace_ctxwake_hex(iter, 0);
744 static enum print_line_t trace_wake_hex(struct trace_iterator *iter, int flags)
746 return trace_ctxwake_hex(iter, '+');
749 static enum print_line_t trace_ctxwake_bin(struct trace_iterator *iter,
752 struct ctx_switch_entry *field;
753 struct trace_seq *s = &iter->seq;
755 trace_assign_type(field, iter->ent);
757 SEQ_PUT_FIELD_RET(s, field->prev_pid);
758 SEQ_PUT_FIELD_RET(s, field->prev_prio);
759 SEQ_PUT_FIELD_RET(s, field->prev_state);
760 SEQ_PUT_FIELD_RET(s, field->next_pid);
761 SEQ_PUT_FIELD_RET(s, field->next_prio);
762 SEQ_PUT_FIELD_RET(s, field->next_state);
764 return TRACE_TYPE_HANDLED;
767 static struct trace_event trace_ctx_event = {
769 .trace = trace_ctx_print,
770 .raw = trace_ctx_raw,
771 .hex = trace_ctx_hex,
772 .binary = trace_ctxwake_bin,
775 static struct trace_event trace_wake_event = {
777 .trace = trace_wake_print,
778 .raw = trace_wake_raw,
779 .hex = trace_wake_hex,
780 .binary = trace_ctxwake_bin,
784 static enum print_line_t trace_special_print(struct trace_iterator *iter,
787 struct special_entry *field;
789 trace_assign_type(field, iter->ent);
791 if (!trace_seq_printf(&iter->seq, "# %ld %ld %ld\n",
795 return TRACE_TYPE_PARTIAL_LINE;
797 return TRACE_TYPE_HANDLED;
800 static enum print_line_t trace_special_hex(struct trace_iterator *iter,
803 struct special_entry *field;
804 struct trace_seq *s = &iter->seq;
806 trace_assign_type(field, iter->ent);
808 SEQ_PUT_HEX_FIELD_RET(s, field->arg1);
809 SEQ_PUT_HEX_FIELD_RET(s, field->arg2);
810 SEQ_PUT_HEX_FIELD_RET(s, field->arg3);
812 return TRACE_TYPE_HANDLED;
815 static enum print_line_t trace_special_bin(struct trace_iterator *iter,
818 struct special_entry *field;
819 struct trace_seq *s = &iter->seq;
821 trace_assign_type(field, iter->ent);
823 SEQ_PUT_FIELD_RET(s, field->arg1);
824 SEQ_PUT_FIELD_RET(s, field->arg2);
825 SEQ_PUT_FIELD_RET(s, field->arg3);
827 return TRACE_TYPE_HANDLED;
830 static struct trace_event trace_special_event = {
831 .type = TRACE_SPECIAL,
832 .trace = trace_special_print,
833 .raw = trace_special_print,
834 .hex = trace_special_hex,
835 .binary = trace_special_bin,
840 static enum print_line_t trace_stack_print(struct trace_iterator *iter,
843 struct stack_entry *field;
844 struct trace_seq *s = &iter->seq;
847 trace_assign_type(field, iter->ent);
849 for (i = 0; i < FTRACE_STACK_ENTRIES; i++) {
851 if (!trace_seq_puts(s, " <= "))
854 if (!seq_print_ip_sym(s, field->caller[i], flags))
857 if (!trace_seq_puts(s, "\n"))
861 return TRACE_TYPE_HANDLED;
864 return TRACE_TYPE_PARTIAL_LINE;
867 static struct trace_event trace_stack_event = {
869 .trace = trace_stack_print,
870 .raw = trace_special_print,
871 .hex = trace_special_hex,
872 .binary = trace_special_bin,
875 /* TRACE_USER_STACK */
876 static enum print_line_t trace_user_stack_print(struct trace_iterator *iter,
879 struct userstack_entry *field;
880 struct trace_seq *s = &iter->seq;
882 trace_assign_type(field, iter->ent);
884 if (!seq_print_userip_objs(field, s, flags))
887 if (!trace_seq_putc(s, '\n'))
890 return TRACE_TYPE_HANDLED;
893 return TRACE_TYPE_PARTIAL_LINE;
896 static struct trace_event trace_user_stack_event = {
897 .type = TRACE_USER_STACK,
898 .trace = trace_user_stack_print,
899 .raw = trace_special_print,
900 .hex = trace_special_hex,
901 .binary = trace_special_bin,
905 static enum print_line_t
906 trace_bprint_print(struct trace_iterator *iter, int flags)
908 struct trace_entry *entry = iter->ent;
909 struct trace_seq *s = &iter->seq;
910 struct bprint_entry *field;
912 trace_assign_type(field, entry);
914 if (!seq_print_ip_sym(s, field->ip, flags))
917 if (!trace_seq_puts(s, ": "))
920 if (!trace_seq_bprintf(s, field->fmt, field->buf))
923 return TRACE_TYPE_HANDLED;
926 return TRACE_TYPE_PARTIAL_LINE;
930 static enum print_line_t
931 trace_bprint_raw(struct trace_iterator *iter, int flags)
933 struct bprint_entry *field;
934 struct trace_seq *s = &iter->seq;
936 trace_assign_type(field, iter->ent);
938 if (!trace_seq_printf(s, ": %lx : ", field->ip))
941 if (!trace_seq_bprintf(s, field->fmt, field->buf))
944 return TRACE_TYPE_HANDLED;
947 return TRACE_TYPE_PARTIAL_LINE;
951 static struct trace_event trace_bprint_event = {
952 .type = TRACE_BPRINT,
953 .trace = trace_bprint_print,
954 .raw = trace_bprint_raw,
958 static enum print_line_t trace_print_print(struct trace_iterator *iter,
961 struct print_entry *field;
962 struct trace_seq *s = &iter->seq;
964 trace_assign_type(field, iter->ent);
966 if (!seq_print_ip_sym(s, field->ip, flags))
969 if (!trace_seq_printf(s, ": %s", field->buf))
972 return TRACE_TYPE_HANDLED;
975 return TRACE_TYPE_PARTIAL_LINE;
978 static enum print_line_t trace_print_raw(struct trace_iterator *iter, int flags)
980 struct print_entry *field;
982 trace_assign_type(field, iter->ent);
984 if (!trace_seq_printf(&iter->seq, "# %lx %s", field->ip, field->buf))
987 return TRACE_TYPE_HANDLED;
990 return TRACE_TYPE_PARTIAL_LINE;
993 static struct trace_event trace_print_event = {
995 .trace = trace_print_print,
996 .raw = trace_print_raw,
1000 static struct trace_event *events[] __initdata = {
1004 &trace_special_event,
1006 &trace_user_stack_event,
1007 &trace_bprint_event,
1012 __init static int init_events(void)
1014 struct trace_event *event;
1017 for (i = 0; events[i]; i++) {
1020 ret = register_ftrace_event(event);
1022 printk(KERN_WARNING "event %d failed to register\n",
1030 device_initcall(init_events);