tools/perf/builtin-mem.c

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