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/string.h"
  18 #include "util/callchain.h"
  19 #include "util/strlist.h"
  20 #include "util/values.h"
  21
  22 #include "perf.h"
  23 #include "util/debug.h"
  24 #include "util/header.h"
  25 #include "util/session.h"
  26
  27 #include "util/parse-options.h"
  28 #include "util/parse-events.h"
  29
  30 #include "util/thread.h"
  31 #include "util/sort.h"
  32 #include "util/hist.h"
  33
  34 static char             const *input_name = "perf.data";
  35
  36 static int              force;
  37 static bool             hide_unresolved;
  38
  39 static int              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 int perf_session__add_hist_entry(struct perf_session *self,
  48                                         struct addr_location *al,
  49                                         struct ip_callchain *chain, u64 count)
  50 {
  51         struct symbol **syms = NULL, *parent = NULL;
  52         bool hit;
  53         struct hist_entry *he;
  54
  55         if ((sort__has_parent || symbol_conf.use_callchain) && chain)
  56                 syms = perf_session__resolve_callchain(self, al->thread,
  57                                                        chain, &parent);
  58         he = __perf_session__add_hist_entry(self, al, parent, count, &hit);
  59         if (he == NULL)
  60                 return -ENOMEM;
  61
  62         if (hit)
  63                 he->count += count;
  64
  65         if (symbol_conf.use_callchain) {
  66                 if (!hit)
  67                         callchain_init(&he->callchain);
  68                 append_chain(&he->callchain, chain, syms);
  69                 free(syms);
  70         }
  71
  72         return 0;
  73 }
  74
  75 static int validate_chain(struct ip_callchain *chain, event_t *event)
  76 {
  77         unsigned int chain_size;
  78
  79         chain_size = event->header.size;
  80         chain_size -= (unsigned long)&event->ip.__more_data - (unsigned long)event;
  81
  82         if (chain->nr*sizeof(u64) > chain_size)
  83                 return -1;
  84
  85         return 0;
  86 }
  87
  88 static int process_sample_event(event_t *event, struct perf_session *session)
  89 {
  90         struct sample_data data = { .period = 1, };
  91         struct addr_location al;
  92
  93         event__parse_sample(event, session->sample_type, &data);
  94
  95         dump_printf("(IP, %d): %d/%d: %p period: %Ld\n",
  96                 event->header.misc,
  97                 data.pid, data.tid,
  98                 (void *)(long)data.ip,
  99                 (long long)data.period);
 100
 101         if (session->sample_type & PERF_SAMPLE_CALLCHAIN) {
 102                 unsigned int i;
 103
 104                 dump_printf("... chain: nr:%Lu\n", data.callchain->nr);
 105
 106                 if (validate_chain(data.callchain, event) < 0) {
 107                         pr_debug("call-chain problem with event, "
 108                                  "skipping it.\n");
 109                         return 0;
 110                 }
 111
 112                 if (dump_trace) {
 113                         for (i = 0; i < data.callchain->nr; i++)
 114                                 dump_printf("..... %2d: %016Lx\n",
 115                                             i, data.callchain->ips[i]);
 116                 }
 117         }
 118
 119         if (event__preprocess_sample(event, session, &al, NULL) < 0) {
 120                 fprintf(stderr, "problem processing %d event, skipping it.\n",
 121                         event->header.type);
 122                 return -1;
 123         }
 124
 125         if (al.filtered || (hide_unresolved && al.sym == NULL))
 126                 return 0;
 127
 128         if (perf_session__add_hist_entry(session, &al, data.callchain, data.period)) {
 129                 pr_debug("problem incrementing symbol count, skipping event\n");
 130                 return -1;
 131         }
 132
 133         session->events_stats.total += data.period;
 134         return 0;
 135 }
 136
 137 static int process_read_event(event_t *event, struct perf_session *session __used)
 138 {
 139         struct perf_event_attr *attr;
 140
 141         attr = perf_header__find_attr(event->read.id, &session->header);
 142
 143         if (show_threads) {
 144                 const char *name = attr ? __event_name(attr->type, attr->config)
 145                                    : "unknown";
 146                 perf_read_values_add_value(&show_threads_values,
 147                                            event->read.pid, event->read.tid,
 148                                            event->read.id,
 149                                            name,
 150                                            event->read.value);
 151         }
 152
 153         dump_printf(": %d %d %s %Lu\n", event->read.pid, event->read.tid,
 154                     attr ? __event_name(attr->type, attr->config) : "FAIL",
 155                     event->read.value);
 156
 157         return 0;
 158 }
 159
 160 static int perf_session__setup_sample_type(struct perf_session *self)
 161 {
 162         if (!(self->sample_type & PERF_SAMPLE_CALLCHAIN)) {
 163                 if (sort__has_parent) {
 164                         fprintf(stderr, "selected --sort parent, but no"
 165                                         " callchain data. Did you call"
 166                                         " perf record without -g?\n");
 167                         return -EINVAL;
 168                 }
 169                 if (symbol_conf.use_callchain) {
 170                         fprintf(stderr, "selected -g but no callchain data."
 171                                         " Did you call perf record without"
 172                                         " -g?\n");
 173                         return -1;
 174                 }
 175         } else if (callchain_param.mode != CHAIN_NONE && !symbol_conf.use_callchain) {
 176                         symbol_conf.use_callchain = true;
 177                         if (register_callchain_param(&callchain_param) < 0) {
 178                                 fprintf(stderr, "Can't register callchain"
 179                                                 " params\n");
 180                                 return -EINVAL;
 181                         }
 182         }
 183
 184         return 0;
 185 }
 186
 187 static struct perf_event_ops event_ops = {
 188         .sample = process_sample_event,
 189         .mmap   = event__process_mmap,
 190         .comm   = event__process_comm,
 191         .exit   = event__process_task,
 192         .fork   = event__process_task,
 193         .lost   = event__process_lost,
 194         .read   = process_read_event,
 195 };
 196
 197 static int __cmd_report(void)
 198 {
 199         int ret = -EINVAL;
 200         struct perf_session *session;
 201
 202         session = perf_session__new(input_name, O_RDONLY, force);
 203         if (session == NULL)
 204                 return -ENOMEM;
 205
 206         if (show_threads)
 207                 perf_read_values_init(&show_threads_values);
 208
 209         ret = perf_session__setup_sample_type(session);
 210         if (ret)
 211                 goto out_delete;
 212
 213         ret = perf_session__process_events(session, &event_ops);
 214         if (ret)
 215                 goto out_delete;
 216
 217         if (dump_trace) {
 218                 event__print_totals();
 219                 goto out_delete;
 220         }
 221
 222         if (verbose > 3)
 223                 perf_session__fprintf(session, stdout);
 224
 225         if (verbose > 2)
 226                 dsos__fprintf(stdout);
 227
 228         perf_session__collapse_resort(session);
 229         perf_session__output_resort(session, session->events_stats.total);
 230         fprintf(stdout, "# Samples: %Ld\n#\n", session->events_stats.total);
 231         perf_session__fprintf_hists(session, NULL, false, stdout);
 232         if (sort_order == default_sort_order &&
 233             parent_pattern == default_parent_pattern)
 234                 fprintf(stdout, "#\n# (For a higher level overview, try: perf report --sort comm,dso)\n#\n");
 235
 236         if (show_threads) {
 237                 bool raw_printing_style = !strcmp(pretty_printing_style, "raw");
 238                 perf_read_values_display(stdout, &show_threads_values,
 239                                          raw_printing_style);
 240                 perf_read_values_destroy(&show_threads_values);
 241         }
 242 out_delete:
 243         perf_session__delete(session);
 244         return ret;
 245 }
 246
 247 static int
 248 parse_callchain_opt(const struct option *opt __used, const char *arg,
 249                     int unset __used)
 250 {
 251         char *tok;
 252         char *endptr;
 253
 254         symbol_conf.use_callchain = true;
 255
 256         if (!arg)
 257                 return 0;
 258
 259         tok = strtok((char *)arg, ",");
 260         if (!tok)
 261                 return -1;
 262
 263         /* get the output mode */
 264         if (!strncmp(tok, "graph", strlen(arg)))
 265                 callchain_param.mode = CHAIN_GRAPH_ABS;
 266
 267         else if (!strncmp(tok, "flat", strlen(arg)))
 268                 callchain_param.mode = CHAIN_FLAT;
 269
 270         else if (!strncmp(tok, "fractal", strlen(arg)))
 271                 callchain_param.mode = CHAIN_GRAPH_REL;
 272
 273         else if (!strncmp(tok, "none", strlen(arg))) {
 274                 callchain_param.mode = CHAIN_NONE;
 275                 symbol_conf.use_callchain = true;
 276
 277                 return 0;
 278         }
 279
 280         else
 281                 return -1;
 282
 283         /* get the min percentage */
 284         tok = strtok(NULL, ",");
 285         if (!tok)
 286                 goto setup;
 287
 288         callchain_param.min_percent = strtod(tok, &endptr);
 289         if (tok == endptr)
 290                 return -1;
 291
 292 setup:
 293         if (register_callchain_param(&callchain_param) < 0) {
 294                 fprintf(stderr, "Can't register callchain params\n");
 295                 return -1;
 296         }
 297         return 0;
 298 }
 299
 300 static const char * const report_usage[] = {
 301         "perf report [<options>] <command>",
 302         NULL
 303 };
 304
 305 static const struct option options[] = {
 306         OPT_STRING('i', "input", &input_name, "file",
 307                     "input file name"),
 308         OPT_BOOLEAN('v', "verbose", &verbose,
 309                     "be more verbose (show symbol address, etc)"),
 310         OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
 311                     "dump raw trace in ASCII"),
 312         OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
 313                    "file", "vmlinux pathname"),
 314         OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
 315         OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
 316                     "load module symbols - WARNING: use only with -k and LIVE kernel"),
 317         OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
 318                     "Show a column with the number of samples"),
 319         OPT_BOOLEAN('T', "threads", &show_threads,
 320                     "Show per-thread event counters"),
 321         OPT_STRING(0, "pretty", &pretty_printing_style, "key",
 322                    "pretty printing style key: normal raw"),
 323         OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
 324                    "sort by key(s): pid, comm, dso, symbol, parent"),
 325         OPT_BOOLEAN('P', "full-paths", &symbol_conf.full_paths,
 326                     "Don't shorten the pathnames taking into account the cwd"),
 327         OPT_STRING('p', "parent", &parent_pattern, "regex",
 328                    "regex filter to identify parent, see: '--sort parent'"),
 329         OPT_BOOLEAN('x', "exclude-other", &symbol_conf.exclude_other,
 330                     "Only display entries with parent-match"),
 331         OPT_CALLBACK_DEFAULT('g', "call-graph", NULL, "output_type,min_percent",
 332                      "Display callchains using output_type and min percent threshold. "
 333                      "Default: fractal,0.5", &parse_callchain_opt, callchain_default_opt),
 334         OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
 335                    "only consider symbols in these dsos"),
 336         OPT_STRING('C', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
 337                    "only consider symbols in these comms"),
 338         OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
 339                    "only consider these symbols"),
 340         OPT_STRING('w', "column-widths", &symbol_conf.col_width_list_str,
 341                    "width[,width...]",
 342                    "don't try to adjust column width, use these fixed values"),
 343         OPT_STRING('t', "field-separator", &symbol_conf.field_sep, "separator",
 344                    "separator for columns, no spaces will be added between "
 345                    "columns '.' is reserved."),
 346         OPT_BOOLEAN('U', "hide-unresolved", &hide_unresolved,
 347                     "Only display entries resolved to a symbol"),
 348         OPT_END()
 349 };
 350
 351 int cmd_report(int argc, const char **argv, const char *prefix __used)
 352 {
 353         argc = parse_options(argc, argv, options, report_usage, 0);
 354
 355         setup_pager();
 356
 357         if (symbol__init() < 0)
 358                 return -1;
 359
 360         setup_sorting(report_usage, options);
 361
 362         if (parent_pattern != default_parent_pattern) {
 363                 sort_dimension__add("parent");
 364                 sort_parent.elide = 1;
 365         } else
 366                 symbol_conf.exclude_other = false;
 367
 368         /*
 369          * Any (unrecognized) arguments left?
 370          */
 371         if (argc)
 372                 usage_with_options(report_usage, options);
 373
 374         sort_entry__setup_elide(&sort_dso, symbol_conf.dso_list, "dso", stdout);
 375         sort_entry__setup_elide(&sort_comm, symbol_conf.comm_list, "comm", stdout);
 376         sort_entry__setup_elide(&sort_sym, symbol_conf.sym_list, "symbol", stdout);
 377
 378         return __cmd_report();
 379 }