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"
17 #include "util/symbol.h"
19 #define MEM_OPERATION_LOAD 0x1
20 #define MEM_OPERATION_STORE 0x2
23 struct perf_tool tool;
24 char const *input_name;
31 DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
34 static int parse_record_events(const struct option *opt,
35 const char *str, int unset __maybe_unused)
37 struct perf_mem *mem = *(struct perf_mem **)opt->value;
40 if (strcmp(str, "list")) {
41 if (!perf_mem_events__parse(str)) {
48 for (j = 0; j < PERF_MEM_EVENTS__MAX; j++) {
49 struct perf_mem_event *e = &perf_mem_events[j];
51 fprintf(stderr, "%-13s%-*s%s\n",
54 verbose > 0 ? perf_mem_events__name(j) : "",
55 e->supported ? ": available" : "");
60 static const char * const __usage[] = {
61 "perf mem record [<options>] [<command>]",
62 "perf mem record [<options>] -- <command> [<options>]",
66 static const char * const *record_mem_usage = __usage;
68 static int __cmd_record(int argc, const char **argv, struct perf_mem *mem)
70 int rec_argc, i = 0, j;
71 const char **rec_argv;
73 bool all_user = false, all_kernel = false;
74 struct option options[] = {
75 OPT_CALLBACK('e', "event", &mem, "event",
76 "event selector. use 'perf mem record -e list' to list available events",
78 OPT_UINTEGER(0, "ldlat", &perf_mem_events__loads_ldlat, "mem-loads latency"),
79 OPT_INCR('v', "verbose", &verbose,
80 "be more verbose (show counter open errors, etc)"),
81 OPT_BOOLEAN('U', "all-user", &all_user, "collect only user level data"),
82 OPT_BOOLEAN('K', "all-kernel", &all_kernel, "collect only kernel level data"),
86 argc = parse_options(argc, argv, options, record_mem_usage,
87 PARSE_OPT_KEEP_UNKNOWN);
89 rec_argc = argc + 9; /* max number of arguments */
90 rec_argv = calloc(rec_argc + 1, sizeof(char *));
94 rec_argv[i++] = "record";
96 if (mem->operation & MEM_OPERATION_LOAD)
97 perf_mem_events[PERF_MEM_EVENTS__LOAD].record = true;
99 if (mem->operation & MEM_OPERATION_STORE)
100 perf_mem_events[PERF_MEM_EVENTS__STORE].record = true;
102 if (perf_mem_events[PERF_MEM_EVENTS__LOAD].record)
103 rec_argv[i++] = "-W";
105 rec_argv[i++] = "-d";
108 rec_argv[i++] = "--phys-data";
110 for (j = 0; j < PERF_MEM_EVENTS__MAX; j++) {
111 if (!perf_mem_events[j].record)
114 if (!perf_mem_events[j].supported) {
115 pr_err("failed: event '%s' not supported\n",
116 perf_mem_events__name(j));
121 rec_argv[i++] = "-e";
122 rec_argv[i++] = perf_mem_events__name(j);
126 rec_argv[i++] = "--all-user";
129 rec_argv[i++] = "--all-kernel";
131 for (j = 0; j < argc; j++, i++)
132 rec_argv[i] = argv[j];
135 pr_debug("calling: record ");
137 while (rec_argv[j]) {
138 pr_debug("%s ", rec_argv[j]);
144 ret = cmd_record(i, rec_argv);
150 dump_raw_samples(struct perf_tool *tool,
151 union perf_event *event,
152 struct perf_sample *sample,
153 struct machine *machine)
155 struct perf_mem *mem = container_of(tool, struct perf_mem, tool);
156 struct addr_location al;
159 if (machine__resolve(machine, &al, sample) < 0) {
160 fprintf(stderr, "problem processing %d event, skipping it.\n",
165 if (al.filtered || (mem->hide_unresolved && al.sym == NULL))
169 al.map->dso->hit = 1;
171 if (mem->phys_addr) {
172 if (symbol_conf.field_sep) {
173 fmt = "%d%s%d%s0x%"PRIx64"%s0x%"PRIx64"%s0x%016"PRIx64
174 "%s%"PRIu64"%s0x%"PRIx64"%s%s:%s\n";
176 fmt = "%5d%s%5d%s0x%016"PRIx64"%s0x016%"PRIx64
177 "%s0x%016"PRIx64"%s%5"PRIu64"%s0x%06"PRIx64
179 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,
196 symbol_conf.field_sep,
197 al.map ? (al.map->dso ? al.map->dso->long_name : "???") : "???",
198 al.sym ? al.sym->name : "???");
200 if (symbol_conf.field_sep) {
201 fmt = "%d%s%d%s0x%"PRIx64"%s0x%"PRIx64"%s%"PRIu64
202 "%s0x%"PRIx64"%s%s:%s\n";
204 fmt = "%5d%s%5d%s0x%016"PRIx64"%s0x016%"PRIx64
205 "%s%5"PRIu64"%s0x%06"PRIx64"%s%s:%s\n";
206 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,
221 symbol_conf.field_sep,
222 al.map ? (al.map->dso ? al.map->dso->long_name : "???") : "???",
223 al.sym ? al.sym->name : "???");
226 addr_location__put(&al);
230 static int process_sample_event(struct perf_tool *tool,
231 union perf_event *event,
232 struct perf_sample *sample,
233 struct perf_evsel *evsel __maybe_unused,
234 struct machine *machine)
236 return dump_raw_samples(tool, event, sample, machine);
239 static int report_raw_events(struct perf_mem *mem)
241 struct perf_data data = {
243 .mode = PERF_DATA_MODE_READ,
247 struct perf_session *session = perf_session__new(&data, false,
254 ret = perf_session__cpu_bitmap(session, mem->cpu_list,
260 ret = symbol__init(&session->header.env);
265 printf("# PID, TID, IP, ADDR, PHYS ADDR, LOCAL WEIGHT, DSRC, SYMBOL\n");
267 printf("# PID, TID, IP, ADDR, LOCAL WEIGHT, DSRC, SYMBOL\n");
269 ret = perf_session__process_events(session);
272 perf_session__delete(session);
276 static int report_events(int argc, const char **argv, struct perf_mem *mem)
278 const char **rep_argv;
279 int ret, i = 0, j, rep_argc;
282 return report_raw_events(mem);
285 rep_argv = calloc(rep_argc + 1, sizeof(char *));
289 rep_argv[i++] = "report";
290 rep_argv[i++] = "--mem-mode";
291 rep_argv[i++] = "-n"; /* display number of samples */
294 * there is no weight (cost) associated with stores, so don't print
297 if (!(mem->operation & MEM_OPERATION_LOAD)) {
299 rep_argv[i++] = "--sort=mem,sym,dso,symbol_daddr,"
300 "dso_daddr,tlb,locked,phys_daddr";
302 rep_argv[i++] = "--sort=mem,sym,dso,symbol_daddr,"
303 "dso_daddr,tlb,locked";
304 } else if (mem->phys_addr)
305 rep_argv[i++] = "--sort=local_weight,mem,sym,dso,symbol_daddr,"
306 "dso_daddr,snoop,tlb,locked,phys_daddr";
308 for (j = 1; j < argc; j++, i++)
309 rep_argv[i] = argv[j];
311 ret = cmd_report(i, rep_argv);
321 #define MEM_OPT(n, m) \
322 { .name = n, .mode = (m) }
324 #define MEM_END { .name = NULL }
326 static const struct mem_mode mem_modes[]={
327 MEM_OPT("load", MEM_OPERATION_LOAD),
328 MEM_OPT("store", MEM_OPERATION_STORE),
333 parse_mem_ops(const struct option *opt, const char *str, int unset)
335 int *mode = (int *)opt->value;
336 const struct mem_mode *m;
337 char *s, *os = NULL, *p;
343 /* str may be NULL in case no arg is passed to -t */
345 /* because str is read-only */
346 s = os = strdup(str);
358 for (m = mem_modes; m->name; m++) {
359 if (!strcasecmp(s, m->name))
363 fprintf(stderr, "unknown sampling op %s,"
364 " check man page\n", s);
379 *mode = MEM_OPERATION_LOAD;
385 int cmd_mem(int argc, const char **argv)
388 struct perf_mem mem = {
390 .sample = process_sample_event,
391 .mmap = perf_event__process_mmap,
392 .mmap2 = perf_event__process_mmap2,
393 .comm = perf_event__process_comm,
394 .lost = perf_event__process_lost,
395 .fork = perf_event__process_fork,
396 .build_id = perf_event__process_build_id,
397 .namespaces = perf_event__process_namespaces,
398 .ordered_events = true,
400 .input_name = "perf.data",
402 * default to both load an store sampling
404 .operation = MEM_OPERATION_LOAD | MEM_OPERATION_STORE,
406 const struct option mem_options[] = {
407 OPT_CALLBACK('t', "type", &mem.operation,
408 "type", "memory operations(load,store) Default load,store",
410 OPT_BOOLEAN('D', "dump-raw-samples", &mem.dump_raw,
411 "dump raw samples in ASCII"),
412 OPT_BOOLEAN('U', "hide-unresolved", &mem.hide_unresolved,
413 "Only display entries resolved to a symbol"),
414 OPT_STRING('i', "input", &input_name, "file",
416 OPT_STRING('C', "cpu", &mem.cpu_list, "cpu",
417 "list of cpus to profile"),
418 OPT_STRING_NOEMPTY('x', "field-separator", &symbol_conf.field_sep,
420 "separator for columns, no spaces will be added"
421 " between columns '.' is reserved."),
422 OPT_BOOLEAN('f', "force", &mem.force, "don't complain, do it"),
423 OPT_BOOLEAN('p', "phys-data", &mem.phys_addr, "Record/Report sample physical addresses"),
426 const char *const mem_subcommands[] = { "record", "report", NULL };
427 const char *mem_usage[] = {
432 if (perf_mem_events__init()) {
433 pr_err("failed: memory events not supported\n");
437 argc = parse_options_subcommand(argc, argv, mem_options, mem_subcommands,
438 mem_usage, PARSE_OPT_KEEP_UNKNOWN);
440 if (!argc || !(strncmp(argv[0], "rec", 3) || mem.operation))
441 usage_with_options(mem_usage, mem_options);
443 if (!mem.input_name || !strlen(mem.input_name)) {
444 if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
445 mem.input_name = "-";
447 mem.input_name = "perf.data";
450 if (!strncmp(argv[0], "rec", 3))
451 return __cmd_record(argc, argv, &mem);
452 else if (!strncmp(argv[0], "rep", 3))
453 return report_events(argc, argv, &mem);
455 usage_with_options(mem_usage, mem_options);