SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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;
  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 char             default_pretty_printing_style[] = "normal";
  43 static 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 = append_chain(he->callchain, data->callchain, syms);
 111                 if (err)
 112                         goto out_free_syms;
 113         }
 114         /*
 115          * Only in the newt browser we are doing integrated annotation,
 116          * so we don't allocated the extra space needed because the stdio
 117          * code will not use it.
 118          */
 119         if (use_browser)
 120                 err = hist_entry__inc_addr_samples(he, al->addr);
 121 out_free_syms:
 122         free(syms);
 123         return err;
 124 }
 125
 126 static int add_event_total(struct perf_session *session,
 127                            struct sample_data *data,
 128                            struct perf_event_attr *attr)
 129 {
 130         struct hists *hists;
 131
 132         if (attr)
 133                 hists = perf_session__hists_findnew(session, data->id,
 134                                                     attr->type, attr->config);
 135         else
 136                 hists = perf_session__hists_findnew(session, data->id, 0, 0);
 137
 138         if (!hists)
 139                 return -ENOMEM;
 140
 141         hists->stats.total += data->period;
 142         session->hists.stats.total += data->period;
 143         return 0;
 144 }
 145
 146 static int process_sample_event(event_t *event, struct perf_session *session)
 147 {
 148         struct sample_data data = { .period = 1, };
 149         struct addr_location al;
 150         struct perf_event_attr *attr;
 151
 152         event__parse_sample(event, session->sample_type, &data);
 153
 154         dump_printf("(IP, %d): %d/%d: %#Lx period: %Ld\n", event->header.misc,
 155                     data.pid, data.tid, data.ip, data.period);
 156
 157         if (session->sample_type & PERF_SAMPLE_CALLCHAIN) {
 158                 unsigned int i;
 159
 160                 dump_printf("... chain: nr:%Lu\n", data.callchain->nr);
 161
 162                 if (!ip_callchain__valid(data.callchain, event)) {
 163                         pr_debug("call-chain problem with event, "
 164                                  "skipping it.\n");
 165                         return 0;
 166                 }
 167
 168                 if (dump_trace) {
 169                         for (i = 0; i < data.callchain->nr; i++)
 170                                 dump_printf("..... %2d: %016Lx\n",
 171                                             i, data.callchain->ips[i]);
 172                 }
 173         }
 174
 175         if (event__preprocess_sample(event, session, &al, NULL) < 0) {
 176                 fprintf(stderr, "problem processing %d event, skipping it.\n",
 177                         event->header.type);
 178                 return -1;
 179         }
 180
 181         if (al.filtered || (hide_unresolved && al.sym == NULL))
 182                 return 0;
 183
 184         if (perf_session__add_hist_entry(session, &al, &data)) {
 185                 pr_debug("problem incrementing symbol count, skipping event\n");
 186                 return -1;
 187         }
 188
 189         attr = perf_header__find_attr(data.id, &session->header);
 190
 191         if (add_event_total(session, &data, attr)) {
 192                 pr_debug("problem adding event count\n");
 193                 return -1;
 194         }
 195
 196         return 0;
 197 }
 198
 199 static int process_read_event(event_t *event, struct perf_session *session __used)
 200 {
 201         struct perf_event_attr *attr;
 202
 203         attr = perf_header__find_attr(event->read.id, &session->header);
 204
 205         if (show_threads) {
 206                 const char *name = attr ? __event_name(attr->type, attr->config)
 207                                    : "unknown";
 208                 perf_read_values_add_value(&show_threads_values,
 209                                            event->read.pid, event->read.tid,
 210                                            event->read.id,
 211                                            name,
 212                                            event->read.value);
 213         }
 214
 215         dump_printf(": %d %d %s %Lu\n", event->read.pid, event->read.tid,
 216                     attr ? __event_name(attr->type, attr->config) : "FAIL",
 217                     event->read.value);
 218
 219         return 0;
 220 }
 221
 222 static int perf_session__setup_sample_type(struct perf_session *self)
 223 {
 224         if (!(self->sample_type & PERF_SAMPLE_CALLCHAIN)) {
 225                 if (sort__has_parent) {
 226                         fprintf(stderr, "selected --sort parent, but no"
 227                                         " callchain data. Did you call"
 228                                         " perf record without -g?\n");
 229                         return -EINVAL;
 230                 }
 231                 if (symbol_conf.use_callchain) {
 232                         fprintf(stderr, "selected -g but no callchain data."
 233                                         " Did you call perf record without"
 234                                         " -g?\n");
 235                         return -1;
 236                 }
 237         } else if (!dont_use_callchains && callchain_param.mode != CHAIN_NONE &&
 238                    !symbol_conf.use_callchain) {
 239                         symbol_conf.use_callchain = true;
 240                         if (register_callchain_param(&callchain_param) < 0) {
 241                                 fprintf(stderr, "Can't register callchain"
 242                                                 " params\n");
 243                                 return -EINVAL;
 244                         }
 245         }
 246
 247         return 0;
 248 }
 249
 250 static struct perf_event_ops event_ops = {
 251         .sample = process_sample_event,
 252         .mmap   = event__process_mmap,
 253         .comm   = event__process_comm,
 254         .exit   = event__process_task,
 255         .fork   = event__process_task,
 256         .lost   = event__process_lost,
 257         .read   = process_read_event,
 258         .attr   = event__process_attr,
 259         .event_type = event__process_event_type,
 260         .tracing_data = event__process_tracing_data,
 261         .build_id = event__process_build_id,
 262 };
 263
 264 extern volatile int session_done;
 265
 266 static void sig_handler(int sig __attribute__((__unused__)))
 267 {
 268         session_done = 1;
 269 }
 270
 271 static int __cmd_report(void)
 272 {
 273         int ret = -EINVAL;
 274         struct perf_session *session;
 275         struct rb_node *next;
 276         const char *help = "For a higher level overview, try: perf report --sort comm,dso";
 277
 278         signal(SIGINT, sig_handler);
 279
 280         session = perf_session__new(input_name, O_RDONLY, force, false);
 281         if (session == NULL)
 282                 return -ENOMEM;
 283
 284         if (show_threads)
 285                 perf_read_values_init(&show_threads_values);
 286
 287         ret = perf_session__setup_sample_type(session);
 288         if (ret)
 289                 goto out_delete;
 290
 291         ret = perf_session__process_events(session, &event_ops);
 292         if (ret)
 293                 goto out_delete;
 294
 295         if (dump_trace) {
 296                 event__print_totals();
 297                 goto out_delete;
 298         }
 299
 300         if (verbose > 3)
 301                 perf_session__fprintf(session, stdout);
 302
 303         if (verbose > 2)
 304                 perf_session__fprintf_dsos(session, stdout);
 305
 306         next = rb_first(&session->hists_tree);
 307         while (next) {
 308                 struct hists *hists;
 309
 310                 hists = rb_entry(next, struct hists, rb_node);
 311                 hists__collapse_resort(hists);
 312                 hists__output_resort(hists);
 313                 if (use_browser)
 314                         hists__browse(hists, help, input_name);
 315                 else {
 316                         if (rb_first(&session->hists.entries) ==
 317                             rb_last(&session->hists.entries))
 318                                 fprintf(stdout, "# Samples: %Ld\n#\n",
 319                                         hists->stats.total);
 320                         else
 321                                 fprintf(stdout, "# Samples: %Ld %s\n#\n",
 322                                         hists->stats.total,
 323                                         __event_name(hists->type, hists->config));
 324
 325                         hists__fprintf(hists, NULL, false, stdout);
 326                         fprintf(stdout, "\n\n");
 327                 }
 328
 329                 next = rb_next(&hists->rb_node);
 330         }
 331
 332         if (!use_browser && sort_order == default_sort_order &&
 333             parent_pattern == default_parent_pattern) {
 334                 fprintf(stdout, "#\n# (%s)\n#\n", help);
 335
 336                 if (show_threads) {
 337                         bool style = !strcmp(pretty_printing_style, "raw");
 338                         perf_read_values_display(stdout, &show_threads_values,
 339                                                  style);
 340                         perf_read_values_destroy(&show_threads_values);
 341                 }
 342         }
 343 out_delete:
 344         perf_session__delete(session);
 345         return ret;
 346 }
 347
 348 static int
 349 parse_callchain_opt(const struct option *opt __used, const char *arg,
 350                     int unset)
 351 {
 352         char *tok, *tok2;
 353         char *endptr;
 354
 355         /*
 356          * --no-call-graph
 357          */
 358         if (unset) {
 359                 dont_use_callchains = true;
 360                 return 0;
 361         }
 362
 363         symbol_conf.use_callchain = true;
 364
 365         if (!arg)
 366                 return 0;
 367
 368         tok = strtok((char *)arg, ",");
 369         if (!tok)
 370                 return -1;
 371
 372         /* get the output mode */
 373         if (!strncmp(tok, "graph", strlen(arg)))
 374                 callchain_param.mode = CHAIN_GRAPH_ABS;
 375
 376         else if (!strncmp(tok, "flat", strlen(arg)))
 377                 callchain_param.mode = CHAIN_FLAT;
 378
 379         else if (!strncmp(tok, "fractal", strlen(arg)))
 380                 callchain_param.mode = CHAIN_GRAPH_REL;
 381
 382         else if (!strncmp(tok, "none", strlen(arg))) {
 383                 callchain_param.mode = CHAIN_NONE;
 384                 symbol_conf.use_callchain = false;
 385
 386                 return 0;
 387         }
 388
 389         else
 390                 return -1;
 391
 392         /* get the min percentage */
 393         tok = strtok(NULL, ",");
 394         if (!tok)
 395                 goto setup;
 396
 397         tok2 = strtok(NULL, ",");
 398         callchain_param.min_percent = strtod(tok, &endptr);
 399         if (tok == endptr)
 400                 return -1;
 401
 402         if (tok2)
 403                 callchain_param.print_limit = strtod(tok2, &endptr);
 404 setup:
 405         if (register_callchain_param(&callchain_param) < 0) {
 406                 fprintf(stderr, "Can't register callchain params\n");
 407                 return -1;
 408         }
 409         return 0;
 410 }
 411
 412 static const char * const report_usage[] = {
 413         "perf report [<options>] <command>",
 414         NULL
 415 };
 416
 417 static const struct option options[] = {
 418         OPT_STRING('i', "input", &input_name, "file",
 419                     "input file name"),
 420         OPT_INCR('v', "verbose", &verbose,
 421                     "be more verbose (show symbol address, etc)"),
 422         OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
 423                     "dump raw trace in ASCII"),
 424         OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
 425                    "file", "vmlinux pathname"),
 426         OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
 427         OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
 428                     "load module symbols - WARNING: use only with -k and LIVE kernel"),
 429         OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
 430                     "Show a column with the number of samples"),
 431         OPT_BOOLEAN('T', "threads", &show_threads,
 432                     "Show per-thread event counters"),
 433         OPT_STRING(0, "pretty", &pretty_printing_style, "key",
 434                    "pretty printing style key: normal raw"),
 435         OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
 436                    "sort by key(s): pid, comm, dso, symbol, parent"),
 437         OPT_BOOLEAN('P', "full-paths", &symbol_conf.full_paths,
 438                     "Don't shorten the pathnames taking into account the cwd"),
 439         OPT_BOOLEAN(0, "showcpuutilization", &symbol_conf.show_cpu_utilization,
 440                     "Show sample percentage for different cpu modes"),
 441         OPT_STRING('p', "parent", &parent_pattern, "regex",
 442                    "regex filter to identify parent, see: '--sort parent'"),
 443         OPT_BOOLEAN('x', "exclude-other", &symbol_conf.exclude_other,
 444                     "Only display entries with parent-match"),
 445         OPT_CALLBACK_DEFAULT('g', "call-graph", NULL, "output_type,min_percent",
 446                      "Display callchains using output_type (graph, flat, fractal, or none) and min percent threshold. "
 447                      "Default: fractal,0.5", &parse_callchain_opt, callchain_default_opt),
 448         OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
 449                    "only consider symbols in these dsos"),
 450         OPT_STRING('C', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
 451                    "only consider symbols in these comms"),
 452         OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
 453                    "only consider these symbols"),
 454         OPT_STRING('w', "column-widths", &symbol_conf.col_width_list_str,
 455                    "width[,width...]",
 456                    "don't try to adjust column width, use these fixed values"),
 457         OPT_STRING('t', "field-separator", &symbol_conf.field_sep, "separator",
 458                    "separator for columns, no spaces will be added between "
 459                    "columns '.' is reserved."),
 460         OPT_BOOLEAN('U', "hide-unresolved", &hide_unresolved,
 461                     "Only display entries resolved to a symbol"),
 462         OPT_END()
 463 };
 464
 465 int cmd_report(int argc, const char **argv, const char *prefix __used)
 466 {
 467         argc = parse_options(argc, argv, options, report_usage, 0);
 468
 469         if (strcmp(input_name, "-") != 0)
 470                 setup_browser();
 471         /*
 472          * Only in the newt browser we are doing integrated annotation,
 473          * so don't allocate extra space that won't be used in the stdio
 474          * implementation.
 475          */
 476         if (use_browser)
 477                 symbol_conf.priv_size = sizeof(struct sym_priv);
 478
 479         if (symbol__init() < 0)
 480                 return -1;
 481
 482         setup_sorting(report_usage, options);
 483
 484         if (parent_pattern != default_parent_pattern) {
 485                 if (sort_dimension__add("parent") < 0)
 486                         return -1;
 487                 sort_parent.elide = 1;
 488         } else
 489                 symbol_conf.exclude_other = false;
 490
 491         /*
 492          * Any (unrecognized) arguments left?
 493          */
 494         if (argc)
 495                 usage_with_options(report_usage, options);
 496
 497         sort_entry__setup_elide(&sort_dso, symbol_conf.dso_list, "dso", stdout);
 498         sort_entry__setup_elide(&sort_comm, symbol_conf.comm_list, "comm", stdout);
 499         sort_entry__setup_elide(&sort_sym, symbol_conf.sym_list, "symbol", stdout);
 500
 501         return __cmd_report();
 502 }