tools/perf/builtin-report.c

   1 /*
   2  * builtin-report.c
   3  *
   4  * Builtin report command: Analyze the perf.data input file,
   5  * look up and read DSOs and symbol information and display
   6  * a histogram of results, along various sorting keys.
   7  */
   8 #include "builtin.h"
   9
  10 #include "util/util.h"
  11
  12 #include "util/color.h"
  13 #include <linux/list.h>
  14 #include "util/cache.h"
  15 #include <linux/rbtree.h>
  16 #include "util/symbol.h"
  17 #include "util/callchain.h"
  18 #include "util/strlist.h"
  19 #include "util/values.h"
  20
  21 #include "perf.h"
  22 #include "util/debug.h"
  23 #include "util/header.h"
  24 #include "util/session.h"
  25
  26 #include "util/parse-options.h"
  27 #include "util/parse-events.h"
  28
  29 #include "util/thread.h"
  30 #include "util/sort.h"
  31 #include "util/hist.h"
  32
  33 static char             const *input_name = "perf.data";
  34
  35 static bool             force, use_tui, use_stdio;
  36 static bool             hide_unresolved;
  37 static bool             dont_use_callchains;
  38
  39 static bool             show_threads;
  40 static struct perf_read_values  show_threads_values;
  41
  42 static const char       default_pretty_printing_style[] = "normal";
  43 static const char       *pretty_printing_style = default_pretty_printing_style;
  44
  45 static char             callchain_default_opt[] = "fractal,0.5";
  46
  47 static struct hists *perf_session__hists_findnew(struct perf_session *self,
  48                                                  u64 event_stream, u32 type,
  49                                                  u64 config)
  50 {
  51         struct rb_node **p = &self->hists_tree.rb_node;
  52         struct rb_node *parent = NULL;
  53         struct hists *iter, *new;
  54
  55         while (*p != NULL) {
  56                 parent = *p;
  57                 iter = rb_entry(parent, struct hists, rb_node);
  58                 if (iter->config == config)
  59                         return iter;
  60
  61
  62                 if (config > iter->config)
  63                         p = &(*p)->rb_right;
  64                 else
  65                         p = &(*p)->rb_left;
  66         }
  67
  68         new = malloc(sizeof(struct hists));
  69         if (new == NULL)
  70                 return NULL;
  71         memset(new, 0, sizeof(struct hists));
  72         new->event_stream = event_stream;
  73         new->config = config;
  74         new->type = type;
  75         rb_link_node(&new->rb_node, parent, p);
  76         rb_insert_color(&new->rb_node, &self->hists_tree);
  77         return new;
  78 }
  79
  80 static int perf_session__add_hist_entry(struct perf_session *self,
  81                                         struct addr_location *al,
  82                                         struct sample_data *data)
  83 {
  84         struct map_symbol *syms = NULL;
  85         struct symbol *parent = NULL;
  86         int err = -ENOMEM;
  87         struct hist_entry *he;
  88         struct hists *hists;
  89         struct perf_event_attr *attr;
  90
  91         if ((sort__has_parent || symbol_conf.use_callchain) && data->callchain) {
  92                 syms = perf_session__resolve_callchain(self, al->thread,
  93                                                        data->callchain, &parent);
  94                 if (syms == NULL)
  95                         return -ENOMEM;
  96         }
  97
  98         attr = perf_header__find_attr(data->id, &self->header);
  99         if (attr)
 100                 hists = perf_session__hists_findnew(self, data->id, attr->type, attr->config);
 101         else
 102                 hists = perf_session__hists_findnew(self, data->id, 0, 0);
 103         if (hists == NULL)
 104                 goto out_free_syms;
 105         he = __hists__add_entry(hists, al, parent, data->period);
 106         if (he == NULL)
 107                 goto out_free_syms;
 108         err = 0;
 109         if (symbol_conf.use_callchain) {
 110                 err = callchain_append(he->callchain, data->callchain, syms,
 111                                        data->period);
 112                 if (err)
 113                         goto out_free_syms;
 114         }
 115         /*
 116          * Only in the newt browser we are doing integrated annotation,
 117          * so we don't allocated the extra space needed because the stdio
 118          * code will not use it.
 119          */
 120         if (use_browser > 0)
 121                 err = hist_entry__inc_addr_samples(he, al->addr);
 122 out_free_syms:
 123         free(syms);
 124         return err;
 125 }
 126
 127 static int add_event_total(struct perf_session *session,
 128                            struct sample_data *data,
 129                            struct perf_event_attr *attr)
 130 {
 131         struct hists *hists;
 132
 133         if (attr)
 134                 hists = perf_session__hists_findnew(session, data->id,
 135                                                     attr->type, attr->config);
 136         else
 137                 hists = perf_session__hists_findnew(session, data->id, 0, 0);
 138
 139         if (!hists)
 140                 return -ENOMEM;
 141
 142         hists->stats.total_period += data->period;
 143         /*
 144          * FIXME: add_event_total should be moved from here to
 145          * perf_session__process_event so that the proper hist is passed to
 146          * the event_op methods.
 147          */
 148         hists__inc_nr_events(hists, PERF_RECORD_SAMPLE);
 149         session->hists.stats.total_period += data->period;
 150         return 0;
 151 }
 152
 153 static int process_sample_event(event_t *event, struct perf_session *session)
 154 {
 155         struct sample_data data = { .period = 1, };
 156         struct addr_location al;
 157         struct perf_event_attr *attr;
 158
 159         if (event__preprocess_sample(event, session, &al, &data, NULL) < 0) {
 160                 fprintf(stderr, "problem processing %d event, skipping it.\n",
 161                         event->header.type);
 162                 return -1;
 163         }
 164
 165         if (al.filtered || (hide_unresolved && al.sym == NULL))
 166                 return 0;
 167
 168         if (perf_session__add_hist_entry(session, &al, &data)) {
 169                 pr_debug("problem incrementing symbol period, skipping event\n");
 170                 return -1;
 171         }
 172
 173         attr = perf_header__find_attr(data.id, &session->header);
 174
 175         if (add_event_total(session, &data, attr)) {
 176                 pr_debug("problem adding event period\n");
 177                 return -1;
 178         }
 179
 180         return 0;
 181 }
 182
 183 static int process_read_event(event_t *event, struct perf_session *session __used)
 184 {
 185         struct perf_event_attr *attr;
 186
 187         attr = perf_header__find_attr(event->read.id, &session->header);
 188
 189         if (show_threads) {
 190                 const char *name = attr ? __event_name(attr->type, attr->config)
 191                                    : "unknown";
 192                 perf_read_values_add_value(&show_threads_values,
 193                                            event->read.pid, event->read.tid,
 194                                            event->read.id,
 195                                            name,
 196                                            event->read.value);
 197         }
 198
 199         dump_printf(": %d %d %s %Lu\n", event->read.pid, event->read.tid,
 200                     attr ? __event_name(attr->type, attr->config) : "FAIL",
 201                     event->read.value);
 202
 203         return 0;
 204 }
 205
 206 static int perf_session__setup_sample_type(struct perf_session *self)
 207 {
 208         if (!(self->sample_type & PERF_SAMPLE_CALLCHAIN)) {
 209                 if (sort__has_parent) {
 210                         fprintf(stderr, "selected --sort parent, but no"
 211                                         " callchain data. Did you call"
 212                                         " perf record without -g?\n");
 213                         return -EINVAL;
 214                 }
 215                 if (symbol_conf.use_callchain) {
 216                         fprintf(stderr, "selected -g but no callchain data."
 217                                         " Did you call perf record without"
 218                                         " -g?\n");
 219                         return -1;
 220                 }
 221         } else if (!dont_use_callchains && callchain_param.mode != CHAIN_NONE &&
 222                    !symbol_conf.use_callchain) {
 223                         symbol_conf.use_callchain = true;
 224                         if (register_callchain_param(&callchain_param) < 0) {
 225                                 fprintf(stderr, "Can't register callchain"
 226                                                 " params\n");
 227                                 return -EINVAL;
 228                         }
 229         }
 230
 231         return 0;
 232 }
 233
 234 static struct perf_event_ops event_ops = {
 235         .sample = process_sample_event,
 236         .mmap   = event__process_mmap,
 237         .comm   = event__process_comm,
 238         .exit   = event__process_task,
 239         .fork   = event__process_task,
 240         .lost   = event__process_lost,
 241         .read   = process_read_event,
 242         .attr   = event__process_attr,
 243         .event_type = event__process_event_type,
 244         .tracing_data = event__process_tracing_data,
 245         .build_id = event__process_build_id,
 246 };
 247
 248 extern volatile int session_done;
 249
 250 static void sig_handler(int sig __used)
 251 {
 252         session_done = 1;
 253 }
 254
 255 static size_t hists__fprintf_nr_sample_events(struct hists *self,
 256                                               const char *evname, FILE *fp)
 257 {
 258         size_t ret;
 259         char unit;
 260         unsigned long nr_events = self->stats.nr_events[PERF_RECORD_SAMPLE];
 261
 262         nr_events = convert_unit(nr_events, &unit);
 263         ret = fprintf(fp, "# Events: %lu%c", nr_events, unit);
 264         if (evname != NULL)
 265                 ret += fprintf(fp, " %s", evname);
 266         return ret + fprintf(fp, "\n#\n");
 267 }
 268
 269 static int hists__tty_browse_tree(struct rb_root *tree, const char *help)
 270 {
 271         struct rb_node *next = rb_first(tree);
 272
 273         while (next) {
 274                 struct hists *hists = rb_entry(next, struct hists, rb_node);
 275                 const char *evname = NULL;
 276
 277                 if (rb_first(&hists->entries) != rb_last(&hists->entries))
 278                         evname = __event_name(hists->type, hists->config);
 279
 280                 hists__fprintf_nr_sample_events(hists, evname, stdout);
 281                 hists__fprintf(hists, NULL, false, stdout);
 282                 fprintf(stdout, "\n\n");
 283                 next = rb_next(&hists->rb_node);
 284         }
 285
 286         if (sort_order == default_sort_order &&
 287             parent_pattern == default_parent_pattern) {
 288                 fprintf(stdout, "#\n# (%s)\n#\n", help);
 289
 290                 if (show_threads) {
 291                         bool style = !strcmp(pretty_printing_style, "raw");
 292                         perf_read_values_display(stdout, &show_threads_values,
 293                                                  style);
 294                         perf_read_values_destroy(&show_threads_values);
 295                 }
 296         }
 297
 298         return 0;
 299 }
 300
 301 static int __cmd_report(void)
 302 {
 303         int ret = -EINVAL;
 304         struct perf_session *session;
 305         struct rb_node *next;
 306         const char *help = "For a higher level overview, try: perf report --sort comm,dso";
 307
 308         signal(SIGINT, sig_handler);
 309
 310         session = perf_session__new(input_name, O_RDONLY, force, false);
 311         if (session == NULL)
 312                 return -ENOMEM;
 313
 314         if (show_threads)
 315                 perf_read_values_init(&show_threads_values);
 316
 317         ret = perf_session__setup_sample_type(session);
 318         if (ret)
 319                 goto out_delete;
 320
 321         ret = perf_session__process_events(session, &event_ops);
 322         if (ret)
 323                 goto out_delete;
 324
 325         if (dump_trace) {
 326                 perf_session__fprintf_nr_events(session, stdout);
 327                 goto out_delete;
 328         }
 329
 330         if (verbose > 3)
 331                 perf_session__fprintf(session, stdout);
 332
 333         if (verbose > 2)
 334                 perf_session__fprintf_dsos(session, stdout);
 335
 336         next = rb_first(&session->hists_tree);
 337         while (next) {
 338                 struct hists *hists;
 339
 340                 hists = rb_entry(next, struct hists, rb_node);
 341                 hists__collapse_resort(hists);
 342                 hists__output_resort(hists);
 343                 next = rb_next(&hists->rb_node);
 344         }
 345
 346         if (use_browser > 0)
 347                 hists__tui_browse_tree(&session->hists_tree, help);
 348         else
 349                 hists__tty_browse_tree(&session->hists_tree, help);
 350
 351 out_delete:
 352         /*
 353          * Speed up the exit process, for large files this can
 354          * take quite a while.
 355          *
 356          * XXX Enable this when using valgrind or if we ever
 357          * librarize this command.
 358          *
 359          * Also experiment with obstacks to see how much speed
 360          * up we'll get here.
 361          *
 362          * perf_session__delete(session);
 363          */
 364         return ret;
 365 }
 366
 367 static int
 368 parse_callchain_opt(const struct option *opt __used, const char *arg,
 369                     int unset)
 370 {
 371         char *tok, *tok2;
 372         char *endptr;
 373
 374         /*
 375          * --no-call-graph
 376          */
 377         if (unset) {
 378                 dont_use_callchains = true;
 379                 return 0;
 380         }
 381
 382         symbol_conf.use_callchain = true;
 383
 384         if (!arg)
 385                 return 0;
 386
 387         tok = strtok((char *)arg, ",");
 388         if (!tok)
 389                 return -1;
 390
 391         /* get the output mode */
 392         if (!strncmp(tok, "graph", strlen(arg)))
 393                 callchain_param.mode = CHAIN_GRAPH_ABS;
 394
 395         else if (!strncmp(tok, "flat", strlen(arg)))
 396                 callchain_param.mode = CHAIN_FLAT;
 397
 398         else if (!strncmp(tok, "fractal", strlen(arg)))
 399                 callchain_param.mode = CHAIN_GRAPH_REL;
 400
 401         else if (!strncmp(tok, "none", strlen(arg))) {
 402                 callchain_param.mode = CHAIN_NONE;
 403                 symbol_conf.use_callchain = false;
 404
 405                 return 0;
 406         }
 407
 408         else
 409                 return -1;
 410
 411         /* get the min percentage */
 412         tok = strtok(NULL, ",");
 413         if (!tok)
 414                 goto setup;
 415
 416         tok2 = strtok(NULL, ",");
 417         callchain_param.min_percent = strtod(tok, &endptr);
 418         if (tok == endptr)
 419                 return -1;
 420
 421         if (tok2)
 422                 callchain_param.print_limit = strtod(tok2, &endptr);
 423 setup:
 424         if (register_callchain_param(&callchain_param) < 0) {
 425                 fprintf(stderr, "Can't register callchain params\n");
 426                 return -1;
 427         }
 428         return 0;
 429 }
 430
 431 static const char * const report_usage[] = {
 432         "perf report [<options>] <command>",
 433         NULL
 434 };
 435
 436 static const struct option options[] = {
 437         OPT_STRING('i', "input", &input_name, "file",
 438                     "input file name"),
 439         OPT_INCR('v', "verbose", &verbose,
 440                     "be more verbose (show symbol address, etc)"),
 441         OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
 442                     "dump raw trace in ASCII"),
 443         OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
 444                    "file", "vmlinux pathname"),
 445         OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
 446         OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
 447                     "load module symbols - WARNING: use only with -k and LIVE kernel"),
 448         OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
 449                     "Show a column with the number of samples"),
 450         OPT_BOOLEAN('T', "threads", &show_threads,
 451                     "Show per-thread event counters"),
 452         OPT_STRING(0, "pretty", &pretty_printing_style, "key",
 453                    "pretty printing style key: normal raw"),
 454         OPT_BOOLEAN(0, "tui", &use_tui, "Use the TUI interface"),
 455         OPT_BOOLEAN(0, "stdio", &use_stdio, "Use the stdio interface"),
 456         OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
 457                    "sort by key(s): pid, comm, dso, symbol, parent"),
 458         OPT_BOOLEAN(0, "showcpuutilization", &symbol_conf.show_cpu_utilization,
 459                     "Show sample percentage for different cpu modes"),
 460         OPT_STRING('p', "parent", &parent_pattern, "regex",
 461                    "regex filter to identify parent, see: '--sort parent'"),
 462         OPT_BOOLEAN('x', "exclude-other", &symbol_conf.exclude_other,
 463                     "Only display entries with parent-match"),
 464         OPT_CALLBACK_DEFAULT('g', "call-graph", NULL, "output_type,min_percent",
 465                      "Display callchains using output_type (graph, flat, fractal, or none) and min percent threshold. "
 466                      "Default: fractal,0.5", &parse_callchain_opt, callchain_default_opt),
 467         OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
 468                    "only consider symbols in these dsos"),
 469         OPT_STRING('C', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
 470                    "only consider symbols in these comms"),
 471         OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
 472                    "only consider these symbols"),
 473         OPT_STRING('w', "column-widths", &symbol_conf.col_width_list_str,
 474                    "width[,width...]",
 475                    "don't try to adjust column width, use these fixed values"),
 476         OPT_STRING('t', "field-separator", &symbol_conf.field_sep, "separator",
 477                    "separator for columns, no spaces will be added between "
 478                    "columns '.' is reserved."),
 479         OPT_BOOLEAN('U', "hide-unresolved", &hide_unresolved,
 480                     "Only display entries resolved to a symbol"),
 481         OPT_END()
 482 };
 483
 484 int cmd_report(int argc, const char **argv, const char *prefix __used)
 485 {
 486         argc = parse_options(argc, argv, options, report_usage, 0);
 487
 488         if (use_stdio)
 489                 use_browser = 0;
 490         else if (use_tui)
 491                 use_browser = 1;
 492
 493         if (strcmp(input_name, "-") != 0)
 494                 setup_browser();
 495         else
 496                 use_browser = 0;
 497         /*
 498          * Only in the newt browser we are doing integrated annotation,
 499          * so don't allocate extra space that won't be used in the stdio
 500          * implementation.
 501          */
 502         if (use_browser > 0) {
 503                 symbol_conf.priv_size = sizeof(struct sym_priv);
 504                 /*
 505                  * For searching by name on the "Browse map details".
 506                  * providing it only in verbose mode not to bloat too
 507                  * much struct symbol.
 508                  */
 509                 if (verbose) {
 510                         /*
 511                          * XXX: Need to provide a less kludgy way to ask for
 512                          * more space per symbol, the u32 is for the index on
 513                          * the ui browser.
 514                          * See symbol__browser_index.
 515                          */
 516                         symbol_conf.priv_size += sizeof(u32);
 517                         symbol_conf.sort_by_name = true;
 518                 }
 519         }
 520
 521         if (symbol__init() < 0)
 522                 return -1;
 523
 524         setup_sorting(report_usage, options);
 525
 526         if (parent_pattern != default_parent_pattern) {
 527                 if (sort_dimension__add("parent") < 0)
 528                         return -1;
 529                 sort_parent.elide = 1;
 530         } else
 531                 symbol_conf.exclude_other = false;
 532
 533         /*
 534          * Any (unrecognized) arguments left?
 535          */
 536         if (argc)
 537                 usage_with_options(report_usage, options);
 538
 539         sort_entry__setup_elide(&sort_dso, symbol_conf.dso_list, "dso", stdout);
 540         sort_entry__setup_elide(&sort_comm, symbol_conf.comm_list, "comm", stdout);
 541         sort_entry__setup_elide(&sort_sym, symbol_conf.sym_list, "symbol", stdout);
 542
 543         return __cmd_report();
 544 }