1 // SPDX-License-Identifier: GPL-2.0
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"
18 #define MEM_OPERATION_LOAD 0x1
19 #define MEM_OPERATION_STORE 0x2
22 struct perf_tool tool;
23 char const *input_name;
30 DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
33 static int parse_record_events(const struct option *opt,
34 const char *str, int unset __maybe_unused)
36 struct perf_mem *mem = *(struct perf_mem **)opt->value;
39 if (strcmp(str, "list")) {
40 if (!perf_mem_events__parse(str)) {
47 for (j = 0; j < PERF_MEM_EVENTS__MAX; j++) {
48 struct perf_mem_event *e = &perf_mem_events[j];
50 fprintf(stderr, "%-13s%-*s%s\n",
53 verbose > 0 ? perf_mem_events__name(j) : "",
54 e->supported ? ": available" : "");
59 static const char * const __usage[] = {
60 "perf mem record [<options>] [<command>]",
61 "perf mem record [<options>] -- <command> [<options>]",
65 static const char * const *record_mem_usage = __usage;
67 static int __cmd_record(int argc, const char **argv, struct perf_mem *mem)
69 int rec_argc, i = 0, j;
70 const char **rec_argv;
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",
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"),
85 argc = parse_options(argc, argv, options, record_mem_usage,
86 PARSE_OPT_STOP_AT_NON_OPTION);
88 rec_argc = argc + 9; /* max number of arguments */
89 rec_argv = calloc(rec_argc + 1, sizeof(char *));
93 rec_argv[i++] = "record";
95 if (mem->operation & MEM_OPERATION_LOAD)
96 perf_mem_events[PERF_MEM_EVENTS__LOAD].record = true;
98 if (mem->operation & MEM_OPERATION_STORE)
99 perf_mem_events[PERF_MEM_EVENTS__STORE].record = true;
101 if (perf_mem_events[PERF_MEM_EVENTS__LOAD].record)
102 rec_argv[i++] = "-W";
104 rec_argv[i++] = "-d";
107 rec_argv[i++] = "--phys-data";
109 for (j = 0; j < PERF_MEM_EVENTS__MAX; j++) {
110 if (!perf_mem_events[j].record)
113 if (!perf_mem_events[j].supported) {
114 pr_err("failed: event '%s' not supported\n",
115 perf_mem_events__name(j));
119 rec_argv[i++] = "-e";
120 rec_argv[i++] = perf_mem_events__name(j);
124 rec_argv[i++] = "--all-user";
127 rec_argv[i++] = "--all-kernel";
129 for (j = 0; j < argc; j++, i++)
130 rec_argv[i] = argv[j];
133 pr_debug("calling: record ");
135 while (rec_argv[j]) {
136 pr_debug("%s ", rec_argv[j]);
142 ret = cmd_record(i, rec_argv);
148 dump_raw_samples(struct perf_tool *tool,
149 union perf_event *event,
150 struct perf_sample *sample,
151 struct machine *machine)
153 struct perf_mem *mem = container_of(tool, struct perf_mem, tool);
154 struct addr_location al;
157 if (machine__resolve(machine, &al, sample) < 0) {
158 fprintf(stderr, "problem processing %d event, skipping it.\n",
163 if (al.filtered || (mem->hide_unresolved && al.sym == NULL))
167 al.map->dso->hit = 1;
169 if (mem->phys_addr) {
170 if (symbol_conf.field_sep) {
171 fmt = "%d%s%d%s0x%"PRIx64"%s0x%"PRIx64"%s0x%016"PRIx64
172 "%s%"PRIu64"%s0x%"PRIx64"%s%s:%s\n";
174 fmt = "%5d%s%5d%s0x%016"PRIx64"%s0x016%"PRIx64
175 "%s0x%016"PRIx64"%s%5"PRIu64"%s0x%06"PRIx64
177 symbol_conf.field_sep = " ";
182 symbol_conf.field_sep,
184 symbol_conf.field_sep,
186 symbol_conf.field_sep,
188 symbol_conf.field_sep,
190 symbol_conf.field_sep,
192 symbol_conf.field_sep,
194 symbol_conf.field_sep,
195 al.map ? (al.map->dso ? al.map->dso->long_name : "???") : "???",
196 al.sym ? al.sym->name : "???");
198 if (symbol_conf.field_sep) {
199 fmt = "%d%s%d%s0x%"PRIx64"%s0x%"PRIx64"%s%"PRIu64
200 "%s0x%"PRIx64"%s%s:%s\n";
202 fmt = "%5d%s%5d%s0x%016"PRIx64"%s0x016%"PRIx64
203 "%s%5"PRIu64"%s0x%06"PRIx64"%s%s:%s\n";
204 symbol_conf.field_sep = " ";
209 symbol_conf.field_sep,
211 symbol_conf.field_sep,
213 symbol_conf.field_sep,
215 symbol_conf.field_sep,
217 symbol_conf.field_sep,
219 symbol_conf.field_sep,
220 al.map ? (al.map->dso ? al.map->dso->long_name : "???") : "???",
221 al.sym ? al.sym->name : "???");
224 addr_location__put(&al);
228 static int process_sample_event(struct perf_tool *tool,
229 union perf_event *event,
230 struct perf_sample *sample,
231 struct perf_evsel *evsel __maybe_unused,
232 struct machine *machine)
234 return dump_raw_samples(tool, event, sample, machine);
237 static int report_raw_events(struct perf_mem *mem)
239 struct perf_data_file file = {
241 .mode = PERF_DATA_MODE_READ,
245 struct perf_session *session = perf_session__new(&file, false,
252 ret = perf_session__cpu_bitmap(session, mem->cpu_list,
258 ret = symbol__init(&session->header.env);
263 printf("# PID, TID, IP, ADDR, PHYS ADDR, LOCAL WEIGHT, DSRC, SYMBOL\n");
265 printf("# PID, TID, IP, ADDR, LOCAL WEIGHT, DSRC, SYMBOL\n");
267 ret = perf_session__process_events(session);
270 perf_session__delete(session);
274 static int report_events(int argc, const char **argv, struct perf_mem *mem)
276 const char **rep_argv;
277 int ret, i = 0, j, rep_argc;
280 return report_raw_events(mem);
283 rep_argv = calloc(rep_argc + 1, sizeof(char *));
287 rep_argv[i++] = "report";
288 rep_argv[i++] = "--mem-mode";
289 rep_argv[i++] = "-n"; /* display number of samples */
292 * there is no weight (cost) associated with stores, so don't print
295 if (!(mem->operation & MEM_OPERATION_LOAD)) {
297 rep_argv[i++] = "--sort=mem,sym,dso,symbol_daddr,"
298 "dso_daddr,tlb,locked,phys_daddr";
300 rep_argv[i++] = "--sort=mem,sym,dso,symbol_daddr,"
301 "dso_daddr,tlb,locked";
302 } else if (mem->phys_addr)
303 rep_argv[i++] = "--sort=local_weight,mem,sym,dso,symbol_daddr,"
304 "dso_daddr,snoop,tlb,locked,phys_daddr";
306 for (j = 1; j < argc; j++, i++)
307 rep_argv[i] = argv[j];
309 ret = cmd_report(i, rep_argv);
319 #define MEM_OPT(n, m) \
320 { .name = n, .mode = (m) }
322 #define MEM_END { .name = NULL }
324 static const struct mem_mode mem_modes[]={
325 MEM_OPT("load", MEM_OPERATION_LOAD),
326 MEM_OPT("store", MEM_OPERATION_STORE),
331 parse_mem_ops(const struct option *opt, const char *str, int unset)
333 int *mode = (int *)opt->value;
334 const struct mem_mode *m;
335 char *s, *os = NULL, *p;
341 /* str may be NULL in case no arg is passed to -t */
343 /* because str is read-only */
344 s = os = strdup(str);
356 for (m = mem_modes; m->name; m++) {
357 if (!strcasecmp(s, m->name))
361 fprintf(stderr, "unknown sampling op %s,"
362 " check man page\n", s);
377 *mode = MEM_OPERATION_LOAD;
383 int cmd_mem(int argc, const char **argv)
386 struct perf_mem mem = {
388 .sample = process_sample_event,
389 .mmap = perf_event__process_mmap,
390 .mmap2 = perf_event__process_mmap2,
391 .comm = perf_event__process_comm,
392 .lost = perf_event__process_lost,
393 .fork = perf_event__process_fork,
394 .build_id = perf_event__process_build_id,
395 .namespaces = perf_event__process_namespaces,
396 .ordered_events = true,
398 .input_name = "perf.data",
400 * default to both load an store sampling
402 .operation = MEM_OPERATION_LOAD | MEM_OPERATION_STORE,
404 const struct option mem_options[] = {
405 OPT_CALLBACK('t', "type", &mem.operation,
406 "type", "memory operations(load,store) Default load,store",
408 OPT_BOOLEAN('D', "dump-raw-samples", &mem.dump_raw,
409 "dump raw samples in ASCII"),
410 OPT_BOOLEAN('U', "hide-unresolved", &mem.hide_unresolved,
411 "Only display entries resolved to a symbol"),
412 OPT_STRING('i', "input", &input_name, "file",
414 OPT_STRING('C', "cpu", &mem.cpu_list, "cpu",
415 "list of cpus to profile"),
416 OPT_STRING_NOEMPTY('x', "field-separator", &symbol_conf.field_sep,
418 "separator for columns, no spaces will be added"
419 " between columns '.' is reserved."),
420 OPT_BOOLEAN('f', "force", &mem.force, "don't complain, do it"),
421 OPT_BOOLEAN('p', "phys-data", &mem.phys_addr, "Record/Report sample physical addresses"),
424 const char *const mem_subcommands[] = { "record", "report", NULL };
425 const char *mem_usage[] = {
430 if (perf_mem_events__init()) {
431 pr_err("failed: memory events not supported\n");
435 argc = parse_options_subcommand(argc, argv, mem_options, mem_subcommands,
436 mem_usage, PARSE_OPT_STOP_AT_NON_OPTION);
438 if (!argc || !(strncmp(argv[0], "rec", 3) || mem.operation))
439 usage_with_options(mem_usage, mem_options);
441 if (!mem.input_name || !strlen(mem.input_name)) {
442 if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
443 mem.input_name = "-";
445 mem.input_name = "perf.data";
448 if (!strncmp(argv[0], "rec", 3))
449 return __cmd_record(argc, argv, &mem);
450 else if (!strncmp(argv[0], "rep", 3))
451 return report_events(argc, argv, &mem);
453 usage_with_options(mem_usage, mem_options);