1 // SPDX-License-Identifier: GPL-2.0
8 #include <subcmd/parse-options.h>
9 #include "util/auxtrace.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"
19 #include "util/symbol.h"
20 #include "util/pmus.h"
21 #include "util/sample.h"
22 #include "util/string2.h"
23 #include "util/util.h"
24 #include <linux/err.h>
26 #define MEM_OPERATION_LOAD 0x1
27 #define MEM_OPERATION_STORE 0x2
30 struct perf_tool tool;
31 char const *input_name;
39 DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
42 static int parse_record_events(const struct option *opt,
43 const char *str, int unset __maybe_unused)
45 struct perf_mem *mem = *(struct perf_mem **)opt->value;
47 if (!strcmp(str, "list")) {
48 perf_mem_events__list();
51 if (perf_mem_events__parse(str))
58 static const char * const __usage[] = {
59 "perf mem record [<options>] [<command>]",
60 "perf mem record [<options>] -- <command> [<options>]",
64 static const char * const *record_mem_usage = __usage;
66 static int __cmd_record(int argc, const char **argv, struct perf_mem *mem)
68 int rec_argc, i = 0, j, tmp_nr = 0;
70 const char **rec_argv;
73 bool all_user = false, all_kernel = false;
74 struct perf_mem_event *e;
75 struct option options[] = {
76 OPT_CALLBACK('e', "event", &mem, "event",
77 "event selector. use 'perf mem record -e list' to list available events",
79 OPT_UINTEGER(0, "ldlat", &perf_mem_events__loads_ldlat, "mem-loads latency"),
80 OPT_INCR('v', "verbose", &verbose,
81 "be more verbose (show counter open errors, etc)"),
82 OPT_BOOLEAN('U', "all-user", &all_user, "collect only user level data"),
83 OPT_BOOLEAN('K', "all-kernel", &all_kernel, "collect only kernel level data"),
87 if (perf_mem_events__init()) {
88 pr_err("failed: memory events not supported\n");
92 argc = parse_options(argc, argv, options, record_mem_usage,
93 PARSE_OPT_KEEP_UNKNOWN);
95 /* Max number of arguments multiplied by number of PMUs that can support them. */
96 rec_argc = argc + 9 * perf_pmus__num_mem_pmus();
101 rec_argv = calloc(rec_argc + 1, sizeof(char *));
106 * Save the allocated event name strings.
108 rec_tmp = calloc(rec_argc + 1, sizeof(char *));
114 rec_argv[i++] = "record";
116 e = perf_mem_events__ptr(PERF_MEM_EVENTS__LOAD_STORE);
119 * The load and store operations are required, use the event
120 * PERF_MEM_EVENTS__LOAD_STORE if it is supported.
123 (mem->operation & MEM_OPERATION_LOAD) &&
124 (mem->operation & MEM_OPERATION_STORE)) {
126 rec_argv[i++] = "-W";
128 if (mem->operation & MEM_OPERATION_LOAD) {
129 e = perf_mem_events__ptr(PERF_MEM_EVENTS__LOAD);
133 if (mem->operation & MEM_OPERATION_STORE) {
134 e = perf_mem_events__ptr(PERF_MEM_EVENTS__STORE);
139 e = perf_mem_events__ptr(PERF_MEM_EVENTS__LOAD);
141 rec_argv[i++] = "-W";
143 rec_argv[i++] = "-d";
146 rec_argv[i++] = "--phys-data";
148 if (mem->data_page_size)
149 rec_argv[i++] = "--data-page-size";
152 ret = perf_mem_events__record_args(rec_argv, &i, rec_tmp, &tmp_nr);
158 rec_argv[i++] = "--all-user";
161 rec_argv[i++] = "--all-kernel";
164 rec_argv[i++] = "-C";
165 rec_argv[i++] = mem->cpu_list;
168 for (j = 0; j < argc; j++, i++)
169 rec_argv[i] = argv[j];
172 pr_debug("calling: record ");
174 for (j = start; j < end; j++)
175 pr_debug("%s ", rec_argv[j]);
180 ret = cmd_record(i, rec_argv);
182 for (i = 0; i < tmp_nr; i++)
191 dump_raw_samples(struct perf_tool *tool,
192 union perf_event *event,
193 struct perf_sample *sample,
194 struct machine *machine)
196 struct perf_mem *mem = container_of(tool, struct perf_mem, tool);
197 struct addr_location al;
198 const char *fmt, *field_sep;
199 char str[PAGE_SIZE_NAME_LEN];
200 struct dso *dso = NULL;
202 addr_location__init(&al);
203 if (machine__resolve(machine, &al, sample) < 0) {
204 fprintf(stderr, "problem processing %d event, skipping it.\n",
206 addr_location__exit(&al);
210 if (al.filtered || (mem->hide_unresolved && al.sym == NULL))
213 if (al.map != NULL) {
214 dso = map__dso(al.map);
219 field_sep = symbol_conf.field_sep;
221 fmt = "%d%s%d%s0x%"PRIx64"%s0x%"PRIx64"%s";
223 fmt = "%5d%s%5d%s0x%016"PRIx64"%s0x016%"PRIx64"%s";
224 symbol_conf.field_sep = " ";
228 symbol_conf.field_sep,
230 symbol_conf.field_sep,
232 symbol_conf.field_sep,
234 symbol_conf.field_sep);
236 if (mem->phys_addr) {
237 printf("0x%016"PRIx64"%s",
239 symbol_conf.field_sep);
242 if (mem->data_page_size) {
244 get_page_size_name(sample->data_page_size, str),
245 symbol_conf.field_sep);
249 fmt = "%"PRIu64"%s0x%"PRIx64"%s%s:%s\n";
251 fmt = "%5"PRIu64"%s0x%06"PRIx64"%s%s:%s\n";
255 symbol_conf.field_sep,
257 symbol_conf.field_sep,
258 dso ? dso->long_name : "???",
259 al.sym ? al.sym->name : "???");
261 addr_location__exit(&al);
265 static int process_sample_event(struct perf_tool *tool,
266 union perf_event *event,
267 struct perf_sample *sample,
268 struct evsel *evsel __maybe_unused,
269 struct machine *machine)
271 return dump_raw_samples(tool, event, sample, machine);
274 static int report_raw_events(struct perf_mem *mem)
276 struct itrace_synth_opts itrace_synth_opts = {
278 .mem = true, /* Only enable memory event */
279 .default_no_sample = true,
282 struct perf_data data = {
284 .mode = PERF_DATA_MODE_READ,
288 struct perf_session *session = perf_session__new(&data, &mem->tool);
291 return PTR_ERR(session);
293 session->itrace_synth_opts = &itrace_synth_opts;
296 ret = perf_session__cpu_bitmap(session, mem->cpu_list,
302 ret = symbol__init(&session->header.env);
306 printf("# PID, TID, IP, ADDR, ");
309 printf("PHYS ADDR, ");
311 if (mem->data_page_size)
312 printf("DATA PAGE SIZE, ");
314 printf("LOCAL WEIGHT, DSRC, SYMBOL\n");
316 ret = perf_session__process_events(session);
319 perf_session__delete(session);
322 static char *get_sort_order(struct perf_mem *mem)
324 bool has_extra_options = (mem->phys_addr | mem->data_page_size) ? true : false;
328 * there is no weight (cost) associated with stores, so don't print
331 if (!(mem->operation & MEM_OPERATION_LOAD)) {
332 strcpy(sort, "--sort=mem,sym,dso,symbol_daddr,"
333 "dso_daddr,tlb,locked");
334 } else if (has_extra_options) {
335 strcpy(sort, "--sort=local_weight,mem,sym,dso,symbol_daddr,"
336 "dso_daddr,snoop,tlb,locked,blocked");
341 strcat(sort, ",phys_daddr");
343 if (mem->data_page_size)
344 strcat(sort, ",data_page_size");
349 static int report_events(int argc, const char **argv, struct perf_mem *mem)
351 const char **rep_argv;
352 int ret, i = 0, j, rep_argc;
353 char *new_sort_order;
356 return report_raw_events(mem);
359 rep_argv = calloc(rep_argc + 1, sizeof(char *));
363 rep_argv[i++] = "report";
364 rep_argv[i++] = "--mem-mode";
365 rep_argv[i++] = "-n"; /* display number of samples */
367 new_sort_order = get_sort_order(mem);
369 rep_argv[i++] = new_sort_order;
371 for (j = 1; j < argc; j++, i++)
372 rep_argv[i] = argv[j];
374 ret = cmd_report(i, rep_argv);
384 #define MEM_OPT(n, m) \
385 { .name = n, .mode = (m) }
387 #define MEM_END { .name = NULL }
389 static const struct mem_mode mem_modes[]={
390 MEM_OPT("load", MEM_OPERATION_LOAD),
391 MEM_OPT("store", MEM_OPERATION_STORE),
396 parse_mem_ops(const struct option *opt, const char *str, int unset)
398 int *mode = (int *)opt->value;
399 const struct mem_mode *m;
400 char *s, *os = NULL, *p;
406 /* str may be NULL in case no arg is passed to -t */
408 /* because str is read-only */
409 s = os = strdup(str);
421 for (m = mem_modes; m->name; m++) {
422 if (!strcasecmp(s, m->name))
426 fprintf(stderr, "unknown sampling op %s,"
427 " check man page\n", s);
442 *mode = MEM_OPERATION_LOAD;
448 int cmd_mem(int argc, const char **argv)
451 struct perf_mem mem = {
453 .sample = process_sample_event,
454 .mmap = perf_event__process_mmap,
455 .mmap2 = perf_event__process_mmap2,
456 .comm = perf_event__process_comm,
457 .lost = perf_event__process_lost,
458 .fork = perf_event__process_fork,
459 .attr = perf_event__process_attr,
460 .build_id = perf_event__process_build_id,
461 .namespaces = perf_event__process_namespaces,
462 .auxtrace_info = perf_event__process_auxtrace_info,
463 .auxtrace = perf_event__process_auxtrace,
464 .auxtrace_error = perf_event__process_auxtrace_error,
465 .ordered_events = true,
467 .input_name = "perf.data",
469 * default to both load an store sampling
471 .operation = MEM_OPERATION_LOAD | MEM_OPERATION_STORE,
473 const struct option mem_options[] = {
474 OPT_CALLBACK('t', "type", &mem.operation,
475 "type", "memory operations(load,store) Default load,store",
477 OPT_BOOLEAN('D', "dump-raw-samples", &mem.dump_raw,
478 "dump raw samples in ASCII"),
479 OPT_BOOLEAN('U', "hide-unresolved", &mem.hide_unresolved,
480 "Only display entries resolved to a symbol"),
481 OPT_STRING('i', "input", &input_name, "file",
483 OPT_STRING('C', "cpu", &mem.cpu_list, "cpu",
484 "list of cpus to profile"),
485 OPT_STRING_NOEMPTY('x', "field-separator", &symbol_conf.field_sep,
487 "separator for columns, no spaces will be added"
488 " between columns '.' is reserved."),
489 OPT_BOOLEAN('f', "force", &mem.force, "don't complain, do it"),
490 OPT_BOOLEAN('p', "phys-data", &mem.phys_addr, "Record/Report sample physical addresses"),
491 OPT_BOOLEAN(0, "data-page-size", &mem.data_page_size, "Record/Report sample data address page size"),
494 const char *const mem_subcommands[] = { "record", "report", NULL };
495 const char *mem_usage[] = {
500 argc = parse_options_subcommand(argc, argv, mem_options, mem_subcommands,
501 mem_usage, PARSE_OPT_KEEP_UNKNOWN);
503 if (!argc || !(strncmp(argv[0], "rec", 3) || mem.operation))
504 usage_with_options(mem_usage, mem_options);
506 if (!mem.input_name || !strlen(mem.input_name)) {
507 if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
508 mem.input_name = "-";
510 mem.input_name = "perf.data";
513 if (strlen(argv[0]) > 2 && strstarts("record", argv[0]))
514 return __cmd_record(argc, argv, &mem);
515 else if (strlen(argv[0]) > 2 && strstarts("report", argv[0]))
516 return report_events(argc, argv, &mem);
518 usage_with_options(mem_usage, mem_options);