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_KEEP_UNKNOWN);
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));
120 rec_argv[i++] = "-e";
121 rec_argv[i++] = perf_mem_events__name(j);
125 rec_argv[i++] = "--all-user";
128 rec_argv[i++] = "--all-kernel";
130 for (j = 0; j < argc; j++, i++)
131 rec_argv[i] = argv[j];
134 pr_debug("calling: record ");
136 while (rec_argv[j]) {
137 pr_debug("%s ", rec_argv[j]);
143 ret = cmd_record(i, rec_argv);
149 dump_raw_samples(struct perf_tool *tool,
150 union perf_event *event,
151 struct perf_sample *sample,
152 struct machine *machine)
154 struct perf_mem *mem = container_of(tool, struct perf_mem, tool);
155 struct addr_location al;
158 if (machine__resolve(machine, &al, sample) < 0) {
159 fprintf(stderr, "problem processing %d event, skipping it.\n",
164 if (al.filtered || (mem->hide_unresolved && al.sym == NULL))
168 al.map->dso->hit = 1;
170 if (mem->phys_addr) {
171 if (symbol_conf.field_sep) {
172 fmt = "%d%s%d%s0x%"PRIx64"%s0x%"PRIx64"%s0x%016"PRIx64
173 "%s%"PRIu64"%s0x%"PRIx64"%s%s:%s\n";
175 fmt = "%5d%s%5d%s0x%016"PRIx64"%s0x016%"PRIx64
176 "%s0x%016"PRIx64"%s%5"PRIu64"%s0x%06"PRIx64
178 symbol_conf.field_sep = " ";
183 symbol_conf.field_sep,
185 symbol_conf.field_sep,
187 symbol_conf.field_sep,
189 symbol_conf.field_sep,
191 symbol_conf.field_sep,
193 symbol_conf.field_sep,
195 symbol_conf.field_sep,
196 al.map ? (al.map->dso ? al.map->dso->long_name : "???") : "???",
197 al.sym ? al.sym->name : "???");
199 if (symbol_conf.field_sep) {
200 fmt = "%d%s%d%s0x%"PRIx64"%s0x%"PRIx64"%s%"PRIu64
201 "%s0x%"PRIx64"%s%s:%s\n";
203 fmt = "%5d%s%5d%s0x%016"PRIx64"%s0x016%"PRIx64
204 "%s%5"PRIu64"%s0x%06"PRIx64"%s%s:%s\n";
205 symbol_conf.field_sep = " ";
210 symbol_conf.field_sep,
212 symbol_conf.field_sep,
214 symbol_conf.field_sep,
216 symbol_conf.field_sep,
218 symbol_conf.field_sep,
220 symbol_conf.field_sep,
221 al.map ? (al.map->dso ? al.map->dso->long_name : "???") : "???",
222 al.sym ? al.sym->name : "???");
225 addr_location__put(&al);
229 static int process_sample_event(struct perf_tool *tool,
230 union perf_event *event,
231 struct perf_sample *sample,
232 struct perf_evsel *evsel __maybe_unused,
233 struct machine *machine)
235 return dump_raw_samples(tool, event, sample, machine);
238 static int report_raw_events(struct perf_mem *mem)
240 struct perf_data data = {
244 .mode = PERF_DATA_MODE_READ,
248 struct perf_session *session = perf_session__new(&data, false,
255 ret = perf_session__cpu_bitmap(session, mem->cpu_list,
261 ret = symbol__init(&session->header.env);
266 printf("# PID, TID, IP, ADDR, PHYS ADDR, LOCAL WEIGHT, DSRC, SYMBOL\n");
268 printf("# PID, TID, IP, ADDR, LOCAL WEIGHT, DSRC, SYMBOL\n");
270 ret = perf_session__process_events(session);
273 perf_session__delete(session);
277 static int report_events(int argc, const char **argv, struct perf_mem *mem)
279 const char **rep_argv;
280 int ret, i = 0, j, rep_argc;
283 return report_raw_events(mem);
286 rep_argv = calloc(rep_argc + 1, sizeof(char *));
290 rep_argv[i++] = "report";
291 rep_argv[i++] = "--mem-mode";
292 rep_argv[i++] = "-n"; /* display number of samples */
295 * there is no weight (cost) associated with stores, so don't print
298 if (!(mem->operation & MEM_OPERATION_LOAD)) {
300 rep_argv[i++] = "--sort=mem,sym,dso,symbol_daddr,"
301 "dso_daddr,tlb,locked,phys_daddr";
303 rep_argv[i++] = "--sort=mem,sym,dso,symbol_daddr,"
304 "dso_daddr,tlb,locked";
305 } else if (mem->phys_addr)
306 rep_argv[i++] = "--sort=local_weight,mem,sym,dso,symbol_daddr,"
307 "dso_daddr,snoop,tlb,locked,phys_daddr";
309 for (j = 1; j < argc; j++, i++)
310 rep_argv[i] = argv[j];
312 ret = cmd_report(i, rep_argv);
322 #define MEM_OPT(n, m) \
323 { .name = n, .mode = (m) }
325 #define MEM_END { .name = NULL }
327 static const struct mem_mode mem_modes[]={
328 MEM_OPT("load", MEM_OPERATION_LOAD),
329 MEM_OPT("store", MEM_OPERATION_STORE),
334 parse_mem_ops(const struct option *opt, const char *str, int unset)
336 int *mode = (int *)opt->value;
337 const struct mem_mode *m;
338 char *s, *os = NULL, *p;
344 /* str may be NULL in case no arg is passed to -t */
346 /* because str is read-only */
347 s = os = strdup(str);
359 for (m = mem_modes; m->name; m++) {
360 if (!strcasecmp(s, m->name))
364 fprintf(stderr, "unknown sampling op %s,"
365 " check man page\n", s);
380 *mode = MEM_OPERATION_LOAD;
386 int cmd_mem(int argc, const char **argv)
389 struct perf_mem mem = {
391 .sample = process_sample_event,
392 .mmap = perf_event__process_mmap,
393 .mmap2 = perf_event__process_mmap2,
394 .comm = perf_event__process_comm,
395 .lost = perf_event__process_lost,
396 .fork = perf_event__process_fork,
397 .build_id = perf_event__process_build_id,
398 .namespaces = perf_event__process_namespaces,
399 .ordered_events = true,
401 .input_name = "perf.data",
403 * default to both load an store sampling
405 .operation = MEM_OPERATION_LOAD | MEM_OPERATION_STORE,
407 const struct option mem_options[] = {
408 OPT_CALLBACK('t', "type", &mem.operation,
409 "type", "memory operations(load,store) Default load,store",
411 OPT_BOOLEAN('D', "dump-raw-samples", &mem.dump_raw,
412 "dump raw samples in ASCII"),
413 OPT_BOOLEAN('U', "hide-unresolved", &mem.hide_unresolved,
414 "Only display entries resolved to a symbol"),
415 OPT_STRING('i', "input", &input_name, "file",
417 OPT_STRING('C', "cpu", &mem.cpu_list, "cpu",
418 "list of cpus to profile"),
419 OPT_STRING_NOEMPTY('x', "field-separator", &symbol_conf.field_sep,
421 "separator for columns, no spaces will be added"
422 " between columns '.' is reserved."),
423 OPT_BOOLEAN('f', "force", &mem.force, "don't complain, do it"),
424 OPT_BOOLEAN('p', "phys-data", &mem.phys_addr, "Record/Report sample physical addresses"),
427 const char *const mem_subcommands[] = { "record", "report", NULL };
428 const char *mem_usage[] = {
433 if (perf_mem_events__init()) {
434 pr_err("failed: memory events not supported\n");
438 argc = parse_options_subcommand(argc, argv, mem_options, mem_subcommands,
439 mem_usage, PARSE_OPT_KEEP_UNKNOWN);
441 if (!argc || !(strncmp(argv[0], "rec", 3) || mem.operation))
442 usage_with_options(mem_usage, mem_options);
444 if (!mem.input_name || !strlen(mem.input_name)) {
445 if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
446 mem.input_name = "-";
448 mem.input_name = "perf.data";
451 if (!strncmp(argv[0], "rec", 3))
452 return __cmd_record(argc, argv, &mem);
453 else if (!strncmp(argv[0], "rep", 3))
454 return report_events(argc, argv, &mem);
456 usage_with_options(mem_usage, mem_options);