perf report: Add consistent spacing rules
[deliverable/linux.git] / Documentation / perf_counter / builtin-report.c
index 33b3b15fb014a873a59d764b6243e6b68cdf10a7..e930b4e02335d50a03dc8135064c02a7bbe55c4c 100644 (file)
 
 static char            const *input_name = "perf.data";
 static char            *vmlinux = NULL;
-static char            *sort_order = "comm,dso";
+
+static char            default_sort_order[] = "comm,dso";
+static char            *sort_order = default_sort_order;
+
 static int             input;
 static int             show_mask = SHOW_KERNEL | SHOW_USER | SHOW_HV;
 
@@ -50,6 +53,7 @@ struct ip_event {
        __u64 ip;
        __u32 pid, tid;
 };
+
 struct mmap_event {
        struct perf_event_header header;
        __u32 pid, tid;
@@ -58,9 +62,10 @@ struct mmap_event {
        __u64 pgoff;
        char filename[PATH_MAX];
 };
+
 struct comm_event {
        struct perf_event_header header;
-       __u32 pid,tid;
+       __u32 pid, tid;
        char comm[16];
 };
 
@@ -101,9 +106,10 @@ static struct dso *dsos__findnew(const char *name)
        if (!dso)
                goto out_delete_dso;
 
-       nr = dso__load(dso, NULL);
+       nr = dso__load(dso, NULL, verbose);
        if (nr < 0) {
-               fprintf(stderr, "Failed to open: %s\n", name);
+               if (verbose)
+                       fprintf(stderr, "Failed to open: %s\n", name);
                goto out_delete_dso;
        }
        if (!nr && verbose) {
@@ -137,7 +143,7 @@ static int load_kernel(void)
        if (!kernel_dso)
                return -1;
 
-       err = dso__load_kernel(kernel_dso, vmlinux, NULL);
+       err = dso__load_kernel(kernel_dso, vmlinux, NULL, verbose);
        if (err) {
                dso__delete(kernel_dso);
                kernel_dso = NULL;
@@ -147,7 +153,11 @@ static int load_kernel(void)
        return err;
 }
 
-static int strcommon(const char *pathname, const char *cwd, int cwdlen)
+static char __cwd[PATH_MAX];
+static char *cwd = __cwd;
+static int cwdlen;
+
+static int strcommon(const char *pathname)
 {
        int n = 0;
 
@@ -165,7 +175,7 @@ struct map {
        struct dso       *dso;
 };
 
-static struct map *map__new(struct mmap_event *event, char *cwd, int cwdlen)
+static struct map *map__new(struct mmap_event *event)
 {
        struct map *self = malloc(sizeof(*self));
 
@@ -174,7 +184,8 @@ static struct map *map__new(struct mmap_event *event, char *cwd, int cwdlen)
                char newfilename[PATH_MAX];
 
                if (cwd) {
-                       int n = strcommon(filename, cwd, cwdlen);
+                       int n = strcommon(filename);
+
                        if (n == cwdlen) {
                                snprintf(newfilename, sizeof(newfilename),
                                         ".%s", filename + n);
@@ -333,11 +344,11 @@ sort__thread_cmp(struct hist_entry *left, struct hist_entry *right)
 static size_t
 sort__thread_print(FILE *fp, struct hist_entry *self)
 {
-       return fprintf(fp, " %16s:%5d", self->thread->comm ?: "", self->thread->pid);
+       return fprintf(fp, "%16s:%5d", self->thread->comm ?: "", self->thread->pid);
 }
 
 static struct sort_entry sort_thread = {
-       .header = "         Command: Pid ",
+       .header = "         Command:  Pid",
        .cmp    = sort__thread_cmp,
        .print  = sort__thread_print,
 };
@@ -371,11 +382,11 @@ sort__comm_collapse(struct hist_entry *left, struct hist_entry *right)
 static size_t
 sort__comm_print(FILE *fp, struct hist_entry *self)
 {
-       return fprintf(fp, "  %16s", self->thread->comm);
+       return fprintf(fp, "%16s", self->thread->comm);
 }
 
 static struct sort_entry sort_comm = {
-       .header         = "          Command",
+       .header         = "         Command",
        .cmp            = sort__comm_cmp,
        .collapse       = sort__comm_collapse,
        .print          = sort__comm_print,
@@ -405,13 +416,13 @@ static size_t
 sort__dso_print(FILE *fp, struct hist_entry *self)
 {
        if (self->dso)
-               return fprintf(fp, "  %-25s", self->dso->name);
+               return fprintf(fp, "%-25s", self->dso->name);
 
-       return fprintf(fp, "  %016llx", (__u64)self->ip);
+       return fprintf(fp, "%016llx         ", (__u64)self->ip);
 }
 
 static struct sort_entry sort_dso = {
-       .header = " Shared Object          ",
+       .header = "Shared Object            ",
        .cmp    = sort__dso_cmp,
        .print  = sort__dso_print,
 };
@@ -438,12 +449,7 @@ sort__sym_print(FILE *fp, struct hist_entry *self)
        size_t ret = 0;
 
        if (verbose)
-               ret += fprintf(fp, "  %#018llx", (__u64)self->ip);
-
-       if (self->dso)
-               ret += fprintf(fp, "  %s: ", self->dso->name);
-       else
-               ret += fprintf(fp, "  %#016llx: ", (__u64)self->ip);
+               ret += fprintf(fp, "%#018llx  ", (__u64)self->ip);
 
        if (self->sym)
                ret += fprintf(fp, "%s", self->sym->name);
@@ -454,7 +460,7 @@ sort__sym_print(FILE *fp, struct hist_entry *self)
 }
 
 static struct sort_entry sort_sym = {
-       .header = " Shared Object: Symbol",
+       .header = "Symbol",
        .cmp    = sort__sym_cmp,
        .print  = sort__sym_print,
 };
@@ -547,8 +553,10 @@ hist_entry__fprintf(FILE *fp, struct hist_entry *self, uint64_t total_samples)
        } else
                ret = fprintf(fp, "%12d ", self->count);
 
-       list_for_each_entry(se, &hist_entry__sort_list, list)
+       list_for_each_entry(se, &hist_entry__sort_list, list) {
+               fprintf(fp, "  ");
                ret += se->print(fp, self);
+       }
 
        ret += fprintf(fp, "\n");
 
@@ -692,17 +700,18 @@ static void output__resort(void)
 {
        struct rb_node *next;
        struct hist_entry *n;
+       struct rb_root *tree = &hist;
 
        if (sort__need_collapse)
-               next = rb_first(&collapse_hists);
-       else
-               next = rb_first(&hist);
+               tree = &collapse_hists;
+
+       next = rb_first(tree);
 
        while (next) {
                n = rb_entry(next, struct hist_entry, rb_node);
                next = rb_next(&n->rb_node);
 
-               rb_erase(&n->rb_node, &hist);
+               rb_erase(&n->rb_node, tree);
                output__insert_entry(n);
        }
 }
@@ -714,11 +723,14 @@ static size_t output__fprintf(FILE *fp, uint64_t total_samples)
        struct rb_node *nd;
        size_t ret = 0;
 
+       fprintf(fp, "\n");
+       fprintf(fp, "#\n");
+       fprintf(fp, "# (%Ld profiler events)\n", (__u64)total_samples);
        fprintf(fp, "#\n");
 
        fprintf(fp, "# Overhead");
        list_for_each_entry(se, &hist_entry__sort_list, list)
-               fprintf(fp, " %s", se->header);
+               fprintf(fp, "  %s", se->header);
        fprintf(fp, "\n");
 
        fprintf(fp, "# ........");
@@ -726,7 +738,7 @@ static size_t output__fprintf(FILE *fp, uint64_t total_samples)
                int i;
 
                fprintf(fp, "  ");
-               for (i = 0; i < strlen(se->header)-1; i++)
+               for (i = 0; i < strlen(se->header); i++)
                        fprintf(fp, ".");
        }
        fprintf(fp, "\n");
@@ -738,6 +750,13 @@ static size_t output__fprintf(FILE *fp, uint64_t total_samples)
                ret += hist_entry__fprintf(fp, pos, total_samples);
        }
 
+       if (!strcmp(sort_order, default_sort_order)) {
+               fprintf(fp, "#\n");
+               fprintf(fp, "# (For more details, try: perf report --sort comm,dso,symbol)\n");
+               fprintf(fp, "#\n");
+       }
+       fprintf(fp, "\n");
+
        return ret;
 }
 
@@ -752,19 +771,165 @@ static void register_idle_thread(void)
        }
 }
 
+static unsigned long total = 0, total_mmap = 0, total_comm = 0, total_unknown = 0;
+
+static int
+process_overflow_event(event_t *event, unsigned long offset, unsigned long head)
+{
+       char level;
+       int show = 0;
+       struct dso *dso = NULL;
+       struct thread *thread = threads__findnew(event->ip.pid);
+       uint64_t ip = event->ip.ip;
+       struct map *map = NULL;
+
+       dprintf("%p [%p]: PERF_EVENT (IP, %d): %d: %p\n",
+               (void *)(offset + head),
+               (void *)(long)(event->header.size),
+               event->header.misc,
+               event->ip.pid,
+               (void *)(long)ip);
+
+       dprintf(" ... thread: %s:%d\n", thread->comm, thread->pid);
+
+       if (thread == NULL) {
+               fprintf(stderr, "problem processing %d event, skipping it.\n",
+                       event->header.type);
+               return -1;
+       }
+
+       if (event->header.misc & PERF_EVENT_MISC_KERNEL) {
+               show = SHOW_KERNEL;
+               level = 'k';
+
+               dso = kernel_dso;
+
+               dprintf(" ...... dso: %s\n", dso->name);
+
+       } else if (event->header.misc & PERF_EVENT_MISC_USER) {
+
+               show = SHOW_USER;
+               level = '.';
+
+               map = thread__find_map(thread, ip);
+               if (map != NULL) {
+                       dso = map->dso;
+                       ip -= map->start + map->pgoff;
+               } else {
+                       /*
+                        * If this is outside of all known maps,
+                        * and is a negative address, try to look it
+                        * up in the kernel dso, as it might be a
+                        * vsyscall (which executes in user-mode):
+                        */
+                       if ((long long)ip < 0)
+                               dso = kernel_dso;
+               }
+               dprintf(" ...... dso: %s\n", dso ? dso->name : "<not found>");
+
+       } else {
+               show = SHOW_HV;
+               level = 'H';
+               dprintf(" ...... dso: [hypervisor]\n");
+       }
+
+       if (show & show_mask) {
+               struct symbol *sym = dso__find_symbol(dso, ip);
+
+               if (hist_entry__add(thread, map, dso, sym, ip, level)) {
+                       fprintf(stderr,
+               "problem incrementing symbol count, skipping event\n");
+                       return -1;
+               }
+       }
+       total++;
+
+       return 0;
+}
+
+static int
+process_mmap_event(event_t *event, unsigned long offset, unsigned long head)
+{
+       struct thread *thread = threads__findnew(event->mmap.pid);
+       struct map *map = map__new(&event->mmap);
+
+       dprintf("%p [%p]: PERF_EVENT_MMAP: [%p(%p) @ %p]: %s\n",
+               (void *)(offset + head),
+               (void *)(long)(event->header.size),
+               (void *)(long)event->mmap.start,
+               (void *)(long)event->mmap.len,
+               (void *)(long)event->mmap.pgoff,
+               event->mmap.filename);
+
+       if (thread == NULL || map == NULL) {
+               dprintf("problem processing PERF_EVENT_MMAP, skipping event.\n");
+               return 0;
+       }
+
+       thread__insert_map(thread, map);
+       total_mmap++;
+
+       return 0;
+}
+
+static int
+process_comm_event(event_t *event, unsigned long offset, unsigned long head)
+{
+       struct thread *thread = threads__findnew(event->comm.pid);
+
+       dprintf("%p [%p]: PERF_EVENT_COMM: %s:%d\n",
+               (void *)(offset + head),
+               (void *)(long)(event->header.size),
+               event->comm.comm, event->comm.pid);
+
+       if (thread == NULL ||
+           thread__set_comm(thread, event->comm.comm)) {
+               dprintf("problem processing PERF_EVENT_COMM, skipping event.\n");
+               return -1;
+       }
+       total_comm++;
+
+       return 0;
+}
+
+static int
+process_event(event_t *event, unsigned long offset, unsigned long head)
+{
+       if (event->header.misc & PERF_EVENT_MISC_OVERFLOW)
+               return process_overflow_event(event, offset, head);
+
+       switch (event->header.type) {
+       case PERF_EVENT_MMAP:
+               return process_mmap_event(event, offset, head);
+
+       case PERF_EVENT_COMM:
+               return process_comm_event(event, offset, head);
+
+       /*
+        * We dont process them right now but they are fine:
+        */
+       case PERF_EVENT_MUNMAP:
+       case PERF_EVENT_PERIOD:
+       case PERF_EVENT_THROTTLE:
+       case PERF_EVENT_UNTHROTTLE:
+               return 0;
+
+       default:
+               return -1;
+       }
+
+       return 0;
+}
 
 static int __cmd_report(void)
 {
+       int ret, rc = EXIT_FAILURE;
        unsigned long offset = 0;
        unsigned long head = 0;
        struct stat stat;
-       char *buf;
        event_t *event;
-       int ret, rc = EXIT_FAILURE;
        uint32_t size;
-       unsigned long total = 0, total_mmap = 0, total_comm = 0, total_unknown = 0;
-       char cwd[PATH_MAX], *cwdp = cwd;
-       int cwdlen;
+       char *buf;
 
        register_idle_thread();
 
@@ -791,13 +956,13 @@ static int __cmd_report(void)
        }
 
        if (!full_paths) {
-               if (getcwd(cwd, sizeof(cwd)) == NULL) {
+               if (getcwd(__cwd, sizeof(__cwd)) == NULL) {
                        perror("failed to get the current directory");
                        return EXIT_FAILURE;
                }
                cwdlen = strlen(cwd);
        } else {
-               cwdp = NULL;
+               cwd = NULL;
                cwdlen = 0;
        }
 remap:
@@ -828,117 +993,9 @@ more:
        }
 
        size = event->header.size;
-       if (!size)
-               goto broken_event;
-
-       if (event->header.misc & PERF_EVENT_MISC_OVERFLOW) {
-               char level;
-               int show = 0;
-               struct dso *dso = NULL;
-               struct thread *thread = threads__findnew(event->ip.pid);
-               uint64_t ip = event->ip.ip;
-               struct map *map = NULL;
-
-               dprintf("%p [%p]: PERF_EVENT (IP, %d): %d: %p\n",
-                       (void *)(offset + head),
-                       (void *)(long)(event->header.size),
-                       event->header.misc,
-                       event->ip.pid,
-                       (void *)(long)ip);
-
-               dprintf(" ... thread: %s:%d\n", thread->comm, thread->pid);
-
-               if (thread == NULL) {
-                       fprintf(stderr, "problem processing %d event, skipping it.\n",
-                               event->header.type);
-                       goto broken_event;
-               }
-
-               if (event->header.misc & PERF_EVENT_MISC_KERNEL) {
-                       show = SHOW_KERNEL;
-                       level = 'k';
-
-                       dso = kernel_dso;
-
-                       dprintf(" ...... dso: %s\n", dso->name);
-
-               } else if (event->header.misc & PERF_EVENT_MISC_USER) {
-
-                       show = SHOW_USER;
-                       level = '.';
-
-                       map = thread__find_map(thread, ip);
-                       if (map != NULL) {
-                               dso = map->dso;
-                               ip -= map->start + map->pgoff;
-                       } else {
-                               /*
-                                * If this is outside of all known maps,
-                                * and is a negative address, try to look it
-                                * up in the kernel dso, as it might be a
-                                * vsyscall (which executes in user-mode):
-                                */
-                               if ((long long)ip < 0)
-                                       dso = kernel_dso;
-                       }
-                       dprintf(" ...... dso: %s\n", dso ? dso->name : "<not found>");
-
-               } else {
-                       show = SHOW_HV;
-                       level = 'H';
-                       dprintf(" ...... dso: [hypervisor]\n");
-               }
 
-               if (show & show_mask) {
-                       struct symbol *sym = dso__find_symbol(dso, ip);
+       if (!size || process_event(event, offset, head) < 0) {
 
-                       if (hist_entry__add(thread, map, dso, sym, ip, level)) {
-                               fprintf(stderr,
-               "problem incrementing symbol count, skipping event\n");
-                               goto broken_event;
-                       }
-               }
-               total++;
-       } else switch (event->header.type) {
-       case PERF_EVENT_MMAP: {
-               struct thread *thread = threads__findnew(event->mmap.pid);
-               struct map *map = map__new(&event->mmap, cwdp, cwdlen);
-
-               dprintf("%p [%p]: PERF_EVENT_MMAP: [%p(%p) @ %p]: %s\n",
-                       (void *)(offset + head),
-                       (void *)(long)(event->header.size),
-                       (void *)(long)event->mmap.start,
-                       (void *)(long)event->mmap.len,
-                       (void *)(long)event->mmap.pgoff,
-                       event->mmap.filename);
-
-               if (thread == NULL || map == NULL) {
-                       if (verbose)
-                               fprintf(stderr, "problem processing PERF_EVENT_MMAP, skipping event.\n");
-                       goto broken_event;
-               }
-               thread__insert_map(thread, map);
-               total_mmap++;
-               break;
-       }
-       case PERF_EVENT_COMM: {
-               struct thread *thread = threads__findnew(event->comm.pid);
-
-               dprintf("%p [%p]: PERF_EVENT_COMM: %s:%d\n",
-                       (void *)(offset + head),
-                       (void *)(long)(event->header.size),
-                       event->comm.comm, event->comm.pid);
-
-               if (thread == NULL ||
-                   thread__set_comm(thread, event->comm.comm)) {
-                       fprintf(stderr, "problem processing PERF_EVENT_COMM, skipping event.\n");
-                       goto broken_event;
-               }
-               total_comm++;
-               break;
-       }
-       default: {
-broken_event:
                dprintf("%p [%p]: skipping unknown header type: %d\n",
                        (void *)(offset + head),
                        (void *)(long)(event->header.size),
@@ -956,7 +1013,6 @@ broken_event:
 
                size = 8;
        }
-       }
 
        head += size;
 
This page took 0.035278 seconds and 5 git commands to generate.