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