tools/perf/builtin-mem.c

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