1 // SPDX-License-Identifier: GPL-2.0
9 #include <subcmd/parse-options.h>
10 #include "util/auxtrace.h"
11 #include "util/trace-event.h"
12 #include "util/tool.h"
13 #include "util/session.h"
14 #include "util/data.h"
15 #include "util/map_symbol.h"
16 #include "util/mem-events.h"
17 #include "util/debug.h"
20 #include "util/symbol.h"
21 #include <linux/err.h>
23 #define MEM_OPERATION_LOAD 0x1
24 #define MEM_OPERATION_STORE 0x2
27 struct perf_tool tool;
28 char const *input_name;
36 DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
39 static int parse_record_events(const struct option *opt,
40 const char *str, int unset __maybe_unused)
42 struct perf_mem *mem = *(struct perf_mem **)opt->value;
44 if (!strcmp(str, "list")) {
45 perf_mem_events__list();
48 if (perf_mem_events__parse(str))
55 static const char * const __usage[] = {
56 "perf mem record [<options>] [<command>]",
57 "perf mem record [<options>] -- <command> [<options>]",
61 static const char * const *record_mem_usage = __usage;
63 static int __cmd_record(int argc, const char **argv, struct perf_mem *mem)
65 int rec_argc, i = 0, j;
66 const char **rec_argv;
68 bool all_user = false, all_kernel = false;
69 struct perf_mem_event *e;
70 struct option options[] = {
71 OPT_CALLBACK('e', "event", &mem, "event",
72 "event selector. use 'perf mem record -e list' to list available events",
74 OPT_UINTEGER(0, "ldlat", &perf_mem_events__loads_ldlat, "mem-loads latency"),
75 OPT_INCR('v', "verbose", &verbose,
76 "be more verbose (show counter open errors, etc)"),
77 OPT_BOOLEAN('U', "all-user", &all_user, "collect only user level data"),
78 OPT_BOOLEAN('K', "all-kernel", &all_kernel, "collect only kernel level data"),
82 if (perf_mem_events__init()) {
83 pr_err("failed: memory events not supported\n");
87 argc = parse_options(argc, argv, options, record_mem_usage,
88 PARSE_OPT_KEEP_UNKNOWN);
90 rec_argc = argc + 9; /* max number of arguments */
91 rec_argv = calloc(rec_argc + 1, sizeof(char *));
95 rec_argv[i++] = "record";
97 e = perf_mem_events__ptr(PERF_MEM_EVENTS__LOAD_STORE);
100 * The load and store operations are required, use the event
101 * PERF_MEM_EVENTS__LOAD_STORE if it is supported.
104 (mem->operation & MEM_OPERATION_LOAD) &&
105 (mem->operation & MEM_OPERATION_STORE)) {
108 if (mem->operation & MEM_OPERATION_LOAD) {
109 e = perf_mem_events__ptr(PERF_MEM_EVENTS__LOAD);
113 if (mem->operation & MEM_OPERATION_STORE) {
114 e = perf_mem_events__ptr(PERF_MEM_EVENTS__STORE);
119 e = perf_mem_events__ptr(PERF_MEM_EVENTS__LOAD);
121 rec_argv[i++] = "-W";
123 rec_argv[i++] = "-d";
126 rec_argv[i++] = "--phys-data";
128 if (mem->data_page_size)
129 rec_argv[i++] = "--data-page-size";
131 for (j = 0; j < PERF_MEM_EVENTS__MAX; j++) {
132 e = perf_mem_events__ptr(j);
137 pr_err("failed: event '%s' not supported\n",
138 perf_mem_events__name(j));
143 rec_argv[i++] = "-e";
144 rec_argv[i++] = perf_mem_events__name(j);
148 rec_argv[i++] = "--all-user";
151 rec_argv[i++] = "--all-kernel";
153 for (j = 0; j < argc; j++, i++)
154 rec_argv[i] = argv[j];
157 pr_debug("calling: record ");
159 while (rec_argv[j]) {
160 pr_debug("%s ", rec_argv[j]);
166 ret = cmd_record(i, rec_argv);
172 dump_raw_samples(struct perf_tool *tool,
173 union perf_event *event,
174 struct perf_sample *sample,
175 struct machine *machine)
177 struct perf_mem *mem = container_of(tool, struct perf_mem, tool);
178 struct addr_location al;
179 const char *fmt, *field_sep;
180 char str[PAGE_SIZE_NAME_LEN];
182 if (machine__resolve(machine, &al, sample) < 0) {
183 fprintf(stderr, "problem processing %d event, skipping it.\n",
188 if (al.filtered || (mem->hide_unresolved && al.sym == NULL))
192 al.map->dso->hit = 1;
194 field_sep = symbol_conf.field_sep;
196 fmt = "%d%s%d%s0x%"PRIx64"%s0x%"PRIx64"%s";
198 fmt = "%5d%s%5d%s0x%016"PRIx64"%s0x016%"PRIx64"%s";
199 symbol_conf.field_sep = " ";
203 symbol_conf.field_sep,
205 symbol_conf.field_sep,
207 symbol_conf.field_sep,
209 symbol_conf.field_sep);
211 if (mem->phys_addr) {
212 printf("0x%016"PRIx64"%s",
214 symbol_conf.field_sep);
217 if (mem->data_page_size) {
219 get_page_size_name(sample->data_page_size, str),
220 symbol_conf.field_sep);
224 fmt = "%"PRIu64"%s0x%"PRIx64"%s%s:%s\n";
226 fmt = "%5"PRIu64"%s0x%06"PRIx64"%s%s:%s\n";
230 symbol_conf.field_sep,
232 symbol_conf.field_sep,
233 al.map ? (al.map->dso ? al.map->dso->long_name : "???") : "???",
234 al.sym ? al.sym->name : "???");
236 addr_location__put(&al);
240 static int process_sample_event(struct perf_tool *tool,
241 union perf_event *event,
242 struct perf_sample *sample,
243 struct evsel *evsel __maybe_unused,
244 struct machine *machine)
246 return dump_raw_samples(tool, event, sample, machine);
249 static int report_raw_events(struct perf_mem *mem)
251 struct itrace_synth_opts itrace_synth_opts = {
253 .mem = true, /* Only enable memory event */
254 .default_no_sample = true,
257 struct perf_data data = {
259 .mode = PERF_DATA_MODE_READ,
263 struct perf_session *session = perf_session__new(&data, false,
267 return PTR_ERR(session);
269 session->itrace_synth_opts = &itrace_synth_opts;
272 ret = perf_session__cpu_bitmap(session, mem->cpu_list,
278 ret = symbol__init(&session->header.env);
282 printf("# PID, TID, IP, ADDR, ");
285 printf("PHYS ADDR, ");
287 if (mem->data_page_size)
288 printf("DATA PAGE SIZE, ");
290 printf("LOCAL WEIGHT, DSRC, SYMBOL\n");
292 ret = perf_session__process_events(session);
295 perf_session__delete(session);
298 static char *get_sort_order(struct perf_mem *mem)
300 bool has_extra_options = (mem->phys_addr | mem->data_page_size) ? true : false;
304 * there is no weight (cost) associated with stores, so don't print
307 if (!(mem->operation & MEM_OPERATION_LOAD)) {
308 strcpy(sort, "--sort=mem,sym,dso,symbol_daddr,"
309 "dso_daddr,tlb,locked");
310 } else if (has_extra_options) {
311 strcpy(sort, "--sort=local_weight,mem,sym,dso,symbol_daddr,"
312 "dso_daddr,snoop,tlb,locked,blocked");
317 strcat(sort, ",phys_daddr");
319 if (mem->data_page_size)
320 strcat(sort, ",data_page_size");
325 static int report_events(int argc, const char **argv, struct perf_mem *mem)
327 const char **rep_argv;
328 int ret, i = 0, j, rep_argc;
329 char *new_sort_order;
332 return report_raw_events(mem);
335 rep_argv = calloc(rep_argc + 1, sizeof(char *));
339 rep_argv[i++] = "report";
340 rep_argv[i++] = "--mem-mode";
341 rep_argv[i++] = "-n"; /* display number of samples */
343 new_sort_order = get_sort_order(mem);
345 rep_argv[i++] = new_sort_order;
347 for (j = 1; j < argc; j++, i++)
348 rep_argv[i] = argv[j];
350 ret = cmd_report(i, rep_argv);
360 #define MEM_OPT(n, m) \
361 { .name = n, .mode = (m) }
363 #define MEM_END { .name = NULL }
365 static const struct mem_mode mem_modes[]={
366 MEM_OPT("load", MEM_OPERATION_LOAD),
367 MEM_OPT("store", MEM_OPERATION_STORE),
372 parse_mem_ops(const struct option *opt, const char *str, int unset)
374 int *mode = (int *)opt->value;
375 const struct mem_mode *m;
376 char *s, *os = NULL, *p;
382 /* str may be NULL in case no arg is passed to -t */
384 /* because str is read-only */
385 s = os = strdup(str);
397 for (m = mem_modes; m->name; m++) {
398 if (!strcasecmp(s, m->name))
402 fprintf(stderr, "unknown sampling op %s,"
403 " check man page\n", s);
418 *mode = MEM_OPERATION_LOAD;
424 int cmd_mem(int argc, const char **argv)
427 struct perf_mem mem = {
429 .sample = process_sample_event,
430 .mmap = perf_event__process_mmap,
431 .mmap2 = perf_event__process_mmap2,
432 .comm = perf_event__process_comm,
433 .lost = perf_event__process_lost,
434 .fork = perf_event__process_fork,
435 .attr = perf_event__process_attr,
436 .build_id = perf_event__process_build_id,
437 .namespaces = perf_event__process_namespaces,
438 .auxtrace_info = perf_event__process_auxtrace_info,
439 .auxtrace = perf_event__process_auxtrace,
440 .auxtrace_error = perf_event__process_auxtrace_error,
441 .ordered_events = true,
443 .input_name = "perf.data",
445 * default to both load an store sampling
447 .operation = MEM_OPERATION_LOAD | MEM_OPERATION_STORE,
449 const struct option mem_options[] = {
450 OPT_CALLBACK('t', "type", &mem.operation,
451 "type", "memory operations(load,store) Default load,store",
453 OPT_BOOLEAN('D', "dump-raw-samples", &mem.dump_raw,
454 "dump raw samples in ASCII"),
455 OPT_BOOLEAN('U', "hide-unresolved", &mem.hide_unresolved,
456 "Only display entries resolved to a symbol"),
457 OPT_STRING('i', "input", &input_name, "file",
459 OPT_STRING('C', "cpu", &mem.cpu_list, "cpu",
460 "list of cpus to profile"),
461 OPT_STRING_NOEMPTY('x', "field-separator", &symbol_conf.field_sep,
463 "separator for columns, no spaces will be added"
464 " between columns '.' is reserved."),
465 OPT_BOOLEAN('f', "force", &mem.force, "don't complain, do it"),
466 OPT_BOOLEAN('p', "phys-data", &mem.phys_addr, "Record/Report sample physical addresses"),
467 OPT_BOOLEAN(0, "data-page-size", &mem.data_page_size, "Record/Report sample data address page size"),
470 const char *const mem_subcommands[] = { "record", "report", NULL };
471 const char *mem_usage[] = {
476 argc = parse_options_subcommand(argc, argv, mem_options, mem_subcommands,
477 mem_usage, PARSE_OPT_KEEP_UNKNOWN);
479 if (!argc || !(strncmp(argv[0], "rec", 3) || mem.operation))
480 usage_with_options(mem_usage, mem_options);
482 if (!mem.input_name || !strlen(mem.input_name)) {
483 if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
484 mem.input_name = "-";
486 mem.input_name = "perf.data";
489 if (!strncmp(argv[0], "rec", 3))
490 return __cmd_record(argc, argv, &mem);
491 else if (!strncmp(argv[0], "rep", 3))
492 return report_events(argc, argv, &mem);
494 usage_with_options(mem_usage, mem_options);