tools/perf/builtin-mem.c

   1 #include "builtin.h"
   2 #include "perf.h"
   3
   4 #include <subcmd/parse-options.h>
   5 #include "util/trace-event.h"
   6 #include "util/tool.h"
   7 #include "util/session.h"
   8 #include "util/data.h"
   9 #include "util/mem-events.h"
  10 #include "util/debug.h"
  11
  12 #define MEM_OPERATION_LOAD      0x1
  13 #define MEM_OPERATION_STORE     0x2
  14
  15 struct perf_mem {
  16         struct perf_tool        tool;
  17         char const              *input_name;
  18         bool                    hide_unresolved;
  19         bool                    dump_raw;
  20         bool                    force;
  21         int                     operation;
  22         const char              *cpu_list;
  23         DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
  24 };
  25
  26 static int parse_record_events(const struct option *opt,
  27                                const char *str, int unset __maybe_unused)
  28 {
  29         struct perf_mem *mem = *(struct perf_mem **)opt->value;
  30         int j;
  31
  32         if (strcmp(str, "list")) {
  33                 if (!perf_mem_events__parse(str)) {
  34                         mem->operation = 0;
  35                         return 0;
  36                 }
  37                 exit(-1);
  38         }
  39
  40         for (j = 0; j < PERF_MEM_EVENTS__MAX; j++) {
  41                 struct perf_mem_event *e = &perf_mem_events[j];
  42
  43                 fprintf(stderr, "%-13s%-*s%s\n",
  44                         e->tag,
  45                         verbose ? 25 : 0,
  46                         verbose ? perf_mem_events__name(j) : "",
  47                         e->supported ? ": available" : "");
  48         }
  49         exit(0);
  50 }
  51
  52 static const char * const __usage[] = {
  53         "perf mem record [<options>] [<command>]",
  54         "perf mem record [<options>] -- <command> [<options>]",
  55         NULL
  56 };
  57
  58 static const char * const *record_mem_usage = __usage;
  59
  60 static int __cmd_record(int argc, const char **argv, struct perf_mem *mem)
  61 {
  62         int rec_argc, i = 0, j;
  63         const char **rec_argv;
  64         int ret;
  65         struct option options[] = {
  66         OPT_CALLBACK('e', "event", &mem, "event",
  67                      "event selector. use 'perf mem record -e list' to list available events",
  68                      parse_record_events),
  69         OPT_INCR('v', "verbose", &verbose,
  70                  "be more verbose (show counter open errors, etc)"),
  71         OPT_END()
  72         };
  73
  74         argc = parse_options(argc, argv, options, record_mem_usage,
  75                              PARSE_OPT_STOP_AT_NON_OPTION);
  76
  77         rec_argc = argc + 7; /* max number of arguments */
  78         rec_argv = calloc(rec_argc + 1, sizeof(char *));
  79         if (!rec_argv)
  80                 return -1;
  81
  82         rec_argv[i++] = "record";
  83
  84         if (mem->operation & MEM_OPERATION_LOAD)
  85                 perf_mem_events[PERF_MEM_EVENTS__LOAD].record = true;
  86
  87         if (perf_mem_events[PERF_MEM_EVENTS__LOAD].record)
  88                 rec_argv[i++] = "-W";
  89
  90         rec_argv[i++] = "-d";
  91
  92         for (j = 0; j < PERF_MEM_EVENTS__MAX; j++) {
  93                 if (!perf_mem_events[j].record)
  94                         continue;
  95
  96                 if (!perf_mem_events[j].supported) {
  97                         pr_err("failed: event '%s' not supported\n",
  98                                perf_mem_events__name(j));
  99                         return -1;
 100                 }
 101
 102                 rec_argv[i++] = "-e";
 103                 rec_argv[i++] = perf_mem_events__name(j);
 104         };
 105
 106         for (j = 0; j < argc; j++, i++)
 107                 rec_argv[i] = argv[j];
 108
 109         if (verbose > 0) {
 110                 pr_debug("calling: record ");
 111
 112                 while (rec_argv[j]) {
 113                         pr_debug("%s ", rec_argv[j]);
 114                         j++;
 115                 }
 116                 pr_debug("\n");
 117         }
 118
 119         ret = cmd_record(i, rec_argv, NULL);
 120         free(rec_argv);
 121         return ret;
 122 }
 123
 124 static int
 125 dump_raw_samples(struct perf_tool *tool,
 126                  union perf_event *event,
 127                  struct perf_sample *sample,
 128                  struct machine *machine)
 129 {
 130         struct perf_mem *mem = container_of(tool, struct perf_mem, tool);
 131         struct addr_location al;
 132         const char *fmt;
 133
 134         if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) {
 135                 fprintf(stderr, "problem processing %d event, skipping it.\n",
 136                                 event->header.type);
 137                 return -1;
 138         }
 139
 140         if (al.filtered || (mem->hide_unresolved && al.sym == NULL))
 141                 goto out_put;
 142
 143         if (al.map != NULL)
 144                 al.map->dso->hit = 1;
 145
 146         if (symbol_conf.field_sep) {
 147                 fmt = "%d%s%d%s0x%"PRIx64"%s0x%"PRIx64"%s%"PRIu64
 148                       "%s0x%"PRIx64"%s%s:%s\n";
 149         } else {
 150                 fmt = "%5d%s%5d%s0x%016"PRIx64"%s0x016%"PRIx64
 151                       "%s%5"PRIu64"%s0x%06"PRIx64"%s%s:%s\n";
 152                 symbol_conf.field_sep = " ";
 153         }
 154
 155         printf(fmt,
 156                 sample->pid,
 157                 symbol_conf.field_sep,
 158                 sample->tid,
 159                 symbol_conf.field_sep,
 160                 sample->ip,
 161                 symbol_conf.field_sep,
 162                 sample->addr,
 163                 symbol_conf.field_sep,
 164                 sample->weight,
 165                 symbol_conf.field_sep,
 166                 sample->data_src,
 167                 symbol_conf.field_sep,
 168                 al.map ? (al.map->dso ? al.map->dso->long_name : "???") : "???",
 169                 al.sym ? al.sym->name : "???");
 170 out_put:
 171         addr_location__put(&al);
 172         return 0;
 173 }
 174
 175 static int process_sample_event(struct perf_tool *tool,
 176                                 union perf_event *event,
 177                                 struct perf_sample *sample,
 178                                 struct perf_evsel *evsel __maybe_unused,
 179                                 struct machine *machine)
 180 {
 181         return dump_raw_samples(tool, event, sample, machine);
 182 }
 183
 184 static int report_raw_events(struct perf_mem *mem)
 185 {
 186         struct perf_data_file file = {
 187                 .path = input_name,
 188                 .mode = PERF_DATA_MODE_READ,
 189                 .force = mem->force,
 190         };
 191         int ret;
 192         struct perf_session *session = perf_session__new(&file, false,
 193                                                          &mem->tool);
 194
 195         if (session == NULL)
 196                 return -1;
 197
 198         if (mem->cpu_list) {
 199                 ret = perf_session__cpu_bitmap(session, mem->cpu_list,
 200                                                mem->cpu_bitmap);
 201                 if (ret < 0)
 202                         goto out_delete;
 203         }
 204
 205         ret = symbol__init(&session->header.env);
 206         if (ret < 0)
 207                 goto out_delete;
 208
 209         printf("# PID, TID, IP, ADDR, LOCAL WEIGHT, DSRC, SYMBOL\n");
 210
 211         ret = perf_session__process_events(session);
 212
 213 out_delete:
 214         perf_session__delete(session);
 215         return ret;
 216 }
 217
 218 static int report_events(int argc, const char **argv, struct perf_mem *mem)
 219 {
 220         const char **rep_argv;
 221         int ret, i = 0, j, rep_argc;
 222
 223         if (mem->dump_raw)
 224                 return report_raw_events(mem);
 225
 226         rep_argc = argc + 3;
 227         rep_argv = calloc(rep_argc + 1, sizeof(char *));
 228         if (!rep_argv)
 229                 return -1;
 230
 231         rep_argv[i++] = "report";
 232         rep_argv[i++] = "--mem-mode";
 233         rep_argv[i++] = "-n"; /* display number of samples */
 234
 235         /*
 236          * there is no weight (cost) associated with stores, so don't print
 237          * the column
 238          */
 239         if (!(mem->operation & MEM_OPERATION_LOAD))
 240                 rep_argv[i++] = "--sort=mem,sym,dso,symbol_daddr,"
 241                                 "dso_daddr,tlb,locked";
 242
 243         for (j = 1; j < argc; j++, i++)
 244                 rep_argv[i] = argv[j];
 245
 246         ret = cmd_report(i, rep_argv, NULL);
 247         free(rep_argv);
 248         return ret;
 249 }
 250
 251 struct mem_mode {
 252         const char *name;
 253         int mode;
 254 };
 255
 256 #define MEM_OPT(n, m) \
 257         { .name = n, .mode = (m) }
 258
 259 #define MEM_END { .name = NULL }
 260
 261 static const struct mem_mode mem_modes[]={
 262         MEM_OPT("load", MEM_OPERATION_LOAD),
 263         MEM_OPT("store", MEM_OPERATION_STORE),
 264         MEM_END
 265 };
 266
 267 static int
 268 parse_mem_ops(const struct option *opt, const char *str, int unset)
 269 {
 270         int *mode = (int *)opt->value;
 271         const struct mem_mode *m;
 272         char *s, *os = NULL, *p;
 273         int ret = -1;
 274
 275         if (unset)
 276                 return 0;
 277
 278         /* str may be NULL in case no arg is passed to -t */
 279         if (str) {
 280                 /* because str is read-only */
 281                 s = os = strdup(str);
 282                 if (!s)
 283                         return -1;
 284
 285                 /* reset mode */
 286                 *mode = 0;
 287
 288                 for (;;) {
 289                         p = strchr(s, ',');
 290                         if (p)
 291                                 *p = '\0';
 292
 293                         for (m = mem_modes; m->name; m++) {
 294                                 if (!strcasecmp(s, m->name))
 295                                         break;
 296                         }
 297                         if (!m->name) {
 298                                 fprintf(stderr, "unknown sampling op %s,"
 299                                             " check man page\n", s);
 300                                 goto error;
 301                         }
 302
 303                         *mode |= m->mode;
 304
 305                         if (!p)
 306                                 break;
 307
 308                         s = p + 1;
 309                 }
 310         }
 311         ret = 0;
 312
 313         if (*mode == 0)
 314                 *mode = MEM_OPERATION_LOAD;
 315 error:
 316         free(os);
 317         return ret;
 318 }
 319
 320 int cmd_mem(int argc, const char **argv, const char *prefix __maybe_unused)
 321 {
 322         struct stat st;
 323         struct perf_mem mem = {
 324                 .tool = {
 325                         .sample         = process_sample_event,
 326                         .mmap           = perf_event__process_mmap,
 327                         .mmap2          = perf_event__process_mmap2,
 328                         .comm           = perf_event__process_comm,
 329                         .lost           = perf_event__process_lost,
 330                         .fork           = perf_event__process_fork,
 331                         .build_id       = perf_event__process_build_id,
 332                         .ordered_events = true,
 333                 },
 334                 .input_name              = "perf.data",
 335                 /*
 336                  * default to both load an store sampling
 337                  */
 338                 .operation               = MEM_OPERATION_LOAD | MEM_OPERATION_STORE,
 339         };
 340         const struct option mem_options[] = {
 341         OPT_CALLBACK('t', "type", &mem.operation,
 342                    "type", "memory operations(load,store) Default load,store",
 343                     parse_mem_ops),
 344         OPT_BOOLEAN('D', "dump-raw-samples", &mem.dump_raw,
 345                     "dump raw samples in ASCII"),
 346         OPT_BOOLEAN('U', "hide-unresolved", &mem.hide_unresolved,
 347                     "Only display entries resolved to a symbol"),
 348         OPT_STRING('i', "input", &input_name, "file",
 349                    "input file name"),
 350         OPT_STRING('C', "cpu", &mem.cpu_list, "cpu",
 351                    "list of cpus to profile"),
 352         OPT_STRING_NOEMPTY('x', "field-separator", &symbol_conf.field_sep,
 353                    "separator",
 354                    "separator for columns, no spaces will be added"
 355                    " between columns '.' is reserved."),
 356         OPT_BOOLEAN('f', "force", &mem.force, "don't complain, do it"),
 357         OPT_END()
 358         };
 359         const char *const mem_subcommands[] = { "record", "report", NULL };
 360         const char *mem_usage[] = {
 361                 NULL,
 362                 NULL
 363         };
 364
 365         if (perf_mem_events__init()) {
 366                 pr_err("failed: memory events not supported\n");
 367                 return -1;
 368         }
 369
 370         argc = parse_options_subcommand(argc, argv, mem_options, mem_subcommands,
 371                                         mem_usage, PARSE_OPT_STOP_AT_NON_OPTION);
 372
 373         if (!argc || !(strncmp(argv[0], "rec", 3) || mem.operation))
 374                 usage_with_options(mem_usage, mem_options);
 375
 376         if (!mem.input_name || !strlen(mem.input_name)) {
 377                 if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
 378                         mem.input_name = "-";
 379                 else
 380                         mem.input_name = "perf.data";
 381         }
 382
 383         if (!strncmp(argv[0], "rec", 3))
 384                 return __cmd_record(argc, argv, &mem);
 385         else if (!strncmp(argv[0], "rep", 3))
 386                 return report_events(argc, argv, &mem);
 387         else
 388                 usage_with_options(mem_usage, mem_options);
 389
 390         return 0;
 391 }