pref tools: Add missing map.h includes
[linux-2.6-block.git] / tools / perf / builtin-mem.c
CommitLineData
b2441318 1// SPDX-License-Identifier: GPL-2.0
fd20e811 2#include <inttypes.h>
7a8ef4c4
ACM
3#include <sys/types.h>
4#include <sys/stat.h>
5#include <unistd.h>
028f12ee
SE
6#include "builtin.h"
7#include "perf.h"
8
4b6ab94e 9#include <subcmd/parse-options.h>
028f12ee
SE
10#include "util/trace-event.h"
11#include "util/tool.h"
12#include "util/session.h"
f5fc1412 13#include "util/data.h"
acbe613e 14#include "util/mem-events.h"
ce1e22b0 15#include "util/debug.h"
1101f69a 16#include "util/map.h"
e7ff8920 17#include "util/symbol.h"
028f12ee 18
67121f85
SE
19#define MEM_OPERATION_LOAD 0x1
20#define MEM_OPERATION_STORE 0x2
028f12ee 21
028f12ee
SE
22struct perf_mem {
23 struct perf_tool tool;
24 char const *input_name;
028f12ee
SE
25 bool hide_unresolved;
26 bool dump_raw;
62a1a63a 27 bool force;
c35aeb9d 28 bool phys_addr;
66024122 29 int operation;
028f12ee
SE
30 const char *cpu_list;
31 DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
32};
33
ce1e22b0
JO
34static int parse_record_events(const struct option *opt,
35 const char *str, int unset __maybe_unused)
36{
37 struct perf_mem *mem = *(struct perf_mem **)opt->value;
38 int j;
39
40 if (strcmp(str, "list")) {
41 if (!perf_mem_events__parse(str)) {
42 mem->operation = 0;
43 return 0;
44 }
45 exit(-1);
46 }
47
48 for (j = 0; j < PERF_MEM_EVENTS__MAX; j++) {
49 struct perf_mem_event *e = &perf_mem_events[j];
50
54fbad54
JO
51 fprintf(stderr, "%-13s%-*s%s\n",
52 e->tag,
bb963e16
NK
53 verbose > 0 ? 25 : 0,
54 verbose > 0 ? perf_mem_events__name(j) : "",
54fbad54 55 e->supported ? ": available" : "");
ce1e22b0
JO
56 }
57 exit(0);
58}
59
60static const char * const __usage[] = {
61 "perf mem record [<options>] [<command>]",
62 "perf mem record [<options>] -- <command> [<options>]",
63 NULL
64};
65
66static const char * const *record_mem_usage = __usage;
67
66024122 68static int __cmd_record(int argc, const char **argv, struct perf_mem *mem)
028f12ee
SE
69{
70 int rec_argc, i = 0, j;
71 const char **rec_argv;
028f12ee 72 int ret;
ad16511b 73 bool all_user = false, all_kernel = false;
ce1e22b0
JO
74 struct option options[] = {
75 OPT_CALLBACK('e', "event", &mem, "event",
76 "event selector. use 'perf mem record -e list' to list available events",
77 parse_record_events),
b0d745b3 78 OPT_UINTEGER(0, "ldlat", &perf_mem_events__loads_ldlat, "mem-loads latency"),
ce1e22b0
JO
79 OPT_INCR('v', "verbose", &verbose,
80 "be more verbose (show counter open errors, etc)"),
631ac41b
JO
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"),
ce1e22b0
JO
83 OPT_END()
84 };
85
86 argc = parse_options(argc, argv, options, record_mem_usage,
a7e9eab3 87 PARSE_OPT_KEEP_UNKNOWN);
028f12ee 88
ad16511b 89 rec_argc = argc + 9; /* max number of arguments */
028f12ee
SE
90 rec_argv = calloc(rec_argc + 1, sizeof(char *));
91 if (!rec_argv)
92 return -1;
93
67121f85 94 rec_argv[i++] = "record";
028f12ee 95
ce1e22b0 96 if (mem->operation & MEM_OPERATION_LOAD)
acbe613e 97 perf_mem_events[PERF_MEM_EVENTS__LOAD].record = true;
ce1e22b0 98
33da54fa
JO
99 if (mem->operation & MEM_OPERATION_STORE)
100 perf_mem_events[PERF_MEM_EVENTS__STORE].record = true;
101
ce1e22b0 102 if (perf_mem_events[PERF_MEM_EVENTS__LOAD].record)
67121f85
SE
103 rec_argv[i++] = "-W";
104
105 rec_argv[i++] = "-d";
106
c35aeb9d
KL
107 if (mem->phys_addr)
108 rec_argv[i++] = "--phys-data";
109
acbe613e
JO
110 for (j = 0; j < PERF_MEM_EVENTS__MAX; j++) {
111 if (!perf_mem_events[j].record)
112 continue;
67121f85 113
54fbad54
JO
114 if (!perf_mem_events[j].supported) {
115 pr_err("failed: event '%s' not supported\n",
2ba7ac58 116 perf_mem_events__name(j));
c896f85a 117 free(rec_argv);
54fbad54
JO
118 return -1;
119 }
120
67121f85 121 rec_argv[i++] = "-e";
2ba7ac58 122 rec_argv[i++] = perf_mem_events__name(j);
acbe613e 123 };
028f12ee 124
ad16511b
JO
125 if (all_user)
126 rec_argv[i++] = "--all-user";
127
128 if (all_kernel)
129 rec_argv[i++] = "--all-kernel";
130
ce1e22b0 131 for (j = 0; j < argc; j++, i++)
028f12ee
SE
132 rec_argv[i] = argv[j];
133
ce1e22b0
JO
134 if (verbose > 0) {
135 pr_debug("calling: record ");
136
137 while (rec_argv[j]) {
138 pr_debug("%s ", rec_argv[j]);
139 j++;
140 }
141 pr_debug("\n");
142 }
143
b0ad8ea6 144 ret = cmd_record(i, rec_argv);
028f12ee
SE
145 free(rec_argv);
146 return ret;
147}
148
149static int
150dump_raw_samples(struct perf_tool *tool,
151 union perf_event *event,
152 struct perf_sample *sample,
028f12ee
SE
153 struct machine *machine)
154{
155 struct perf_mem *mem = container_of(tool, struct perf_mem, tool);
156 struct addr_location al;
157 const char *fmt;
158
bb3eb566 159 if (machine__resolve(machine, &al, sample) < 0) {
028f12ee
SE
160 fprintf(stderr, "problem processing %d event, skipping it.\n",
161 event->header.type);
162 return -1;
163 }
164
165 if (al.filtered || (mem->hide_unresolved && al.sym == NULL))
b91fc39f 166 goto out_put;
028f12ee
SE
167
168 if (al.map != NULL)
169 al.map->dso->hit = 1;
170
c35aeb9d
KL
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";
175 } else {
176 fmt = "%5d%s%5d%s0x%016"PRIx64"%s0x016%"PRIx64
177 "%s0x%016"PRIx64"%s%5"PRIu64"%s0x%06"PRIx64
178 "%s%s:%s\n";
179 symbol_conf.field_sep = " ";
180 }
181
182 printf(fmt,
183 sample->pid,
184 symbol_conf.field_sep,
185 sample->tid,
186 symbol_conf.field_sep,
187 sample->ip,
188 symbol_conf.field_sep,
189 sample->addr,
190 symbol_conf.field_sep,
191 sample->phys_addr,
192 symbol_conf.field_sep,
193 sample->weight,
194 symbol_conf.field_sep,
195 sample->data_src,
196 symbol_conf.field_sep,
197 al.map ? (al.map->dso ? al.map->dso->long_name : "???") : "???",
198 al.sym ? al.sym->name : "???");
028f12ee 199 } else {
c35aeb9d
KL
200 if (symbol_conf.field_sep) {
201 fmt = "%d%s%d%s0x%"PRIx64"%s0x%"PRIx64"%s%"PRIu64
202 "%s0x%"PRIx64"%s%s:%s\n";
203 } else {
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 = " ";
207 }
028f12ee 208
c35aeb9d
KL
209 printf(fmt,
210 sample->pid,
211 symbol_conf.field_sep,
212 sample->tid,
213 symbol_conf.field_sep,
214 sample->ip,
215 symbol_conf.field_sep,
216 sample->addr,
217 symbol_conf.field_sep,
218 sample->weight,
219 symbol_conf.field_sep,
220 sample->data_src,
221 symbol_conf.field_sep,
222 al.map ? (al.map->dso ? al.map->dso->long_name : "???") : "???",
223 al.sym ? al.sym->name : "???");
224 }
b91fc39f
ACM
225out_put:
226 addr_location__put(&al);
028f12ee
SE
227 return 0;
228}
229
230static int process_sample_event(struct perf_tool *tool,
231 union perf_event *event,
232 struct perf_sample *sample,
8b640cc4 233 struct perf_evsel *evsel __maybe_unused,
028f12ee
SE
234 struct machine *machine)
235{
8b640cc4 236 return dump_raw_samples(tool, event, sample, machine);
028f12ee
SE
237}
238
239static int report_raw_events(struct perf_mem *mem)
240{
8ceb41d7 241 struct perf_data data = {
eae8ad80
JO
242 .file = {
243 .path = input_name,
244 },
245 .mode = PERF_DATA_MODE_READ,
246 .force = mem->force,
f5fc1412 247 };
028f12ee 248 int ret;
8ceb41d7 249 struct perf_session *session = perf_session__new(&data, false,
f5fc1412 250 &mem->tool);
028f12ee
SE
251
252 if (session == NULL)
52e02834 253 return -1;
028f12ee
SE
254
255 if (mem->cpu_list) {
256 ret = perf_session__cpu_bitmap(session, mem->cpu_list,
257 mem->cpu_bitmap);
1df9fade 258 if (ret < 0)
028f12ee
SE
259 goto out_delete;
260 }
261
1df9fade
TS
262 ret = symbol__init(&session->header.env);
263 if (ret < 0)
264 goto out_delete;
028f12ee 265
c35aeb9d
KL
266 if (mem->phys_addr)
267 printf("# PID, TID, IP, ADDR, PHYS ADDR, LOCAL WEIGHT, DSRC, SYMBOL\n");
268 else
269 printf("# PID, TID, IP, ADDR, LOCAL WEIGHT, DSRC, SYMBOL\n");
028f12ee 270
1df9fade 271 ret = perf_session__process_events(session);
028f12ee
SE
272
273out_delete:
274 perf_session__delete(session);
1df9fade 275 return ret;
028f12ee
SE
276}
277
278static int report_events(int argc, const char **argv, struct perf_mem *mem)
279{
280 const char **rep_argv;
281 int ret, i = 0, j, rep_argc;
282
283 if (mem->dump_raw)
284 return report_raw_events(mem);
285
286 rep_argc = argc + 3;
287 rep_argv = calloc(rep_argc + 1, sizeof(char *));
288 if (!rep_argv)
289 return -1;
290
67121f85
SE
291 rep_argv[i++] = "report";
292 rep_argv[i++] = "--mem-mode";
293 rep_argv[i++] = "-n"; /* display number of samples */
028f12ee
SE
294
295 /*
296 * there is no weight (cost) associated with stores, so don't print
297 * the column
298 */
c35aeb9d
KL
299 if (!(mem->operation & MEM_OPERATION_LOAD)) {
300 if (mem->phys_addr)
301 rep_argv[i++] = "--sort=mem,sym,dso,symbol_daddr,"
302 "dso_daddr,tlb,locked,phys_daddr";
303 else
304 rep_argv[i++] = "--sort=mem,sym,dso,symbol_daddr,"
305 "dso_daddr,tlb,locked";
306 } else if (mem->phys_addr)
307 rep_argv[i++] = "--sort=local_weight,mem,sym,dso,symbol_daddr,"
308 "dso_daddr,snoop,tlb,locked,phys_daddr";
028f12ee
SE
309
310 for (j = 1; j < argc; j++, i++)
311 rep_argv[i] = argv[j];
312
b0ad8ea6 313 ret = cmd_report(i, rep_argv);
028f12ee
SE
314 free(rep_argv);
315 return ret;
316}
317
67121f85
SE
318struct mem_mode {
319 const char *name;
320 int mode;
321};
322
323#define MEM_OPT(n, m) \
324 { .name = n, .mode = (m) }
325
326#define MEM_END { .name = NULL }
327
328static const struct mem_mode mem_modes[]={
329 MEM_OPT("load", MEM_OPERATION_LOAD),
330 MEM_OPT("store", MEM_OPERATION_STORE),
331 MEM_END
332};
333
334static int
335parse_mem_ops(const struct option *opt, const char *str, int unset)
336{
337 int *mode = (int *)opt->value;
338 const struct mem_mode *m;
339 char *s, *os = NULL, *p;
340 int ret = -1;
341
342 if (unset)
343 return 0;
344
345 /* str may be NULL in case no arg is passed to -t */
346 if (str) {
347 /* because str is read-only */
348 s = os = strdup(str);
349 if (!s)
350 return -1;
351
352 /* reset mode */
353 *mode = 0;
354
355 for (;;) {
356 p = strchr(s, ',');
357 if (p)
358 *p = '\0';
359
360 for (m = mem_modes; m->name; m++) {
361 if (!strcasecmp(s, m->name))
362 break;
363 }
364 if (!m->name) {
365 fprintf(stderr, "unknown sampling op %s,"
366 " check man page\n", s);
367 goto error;
368 }
369
370 *mode |= m->mode;
371
372 if (!p)
373 break;
374
375 s = p + 1;
376 }
377 }
378 ret = 0;
379
380 if (*mode == 0)
381 *mode = MEM_OPERATION_LOAD;
382error:
383 free(os);
384 return ret;
385}
386
b0ad8ea6 387int cmd_mem(int argc, const char **argv)
028f12ee
SE
388{
389 struct stat st;
390 struct perf_mem mem = {
391 .tool = {
392 .sample = process_sample_event,
393 .mmap = perf_event__process_mmap,
5c5e854b 394 .mmap2 = perf_event__process_mmap2,
028f12ee
SE
395 .comm = perf_event__process_comm,
396 .lost = perf_event__process_lost,
397 .fork = perf_event__process_fork,
398 .build_id = perf_event__process_build_id,
f3b3614a 399 .namespaces = perf_event__process_namespaces,
0a8cb85c 400 .ordered_events = true,
028f12ee
SE
401 },
402 .input_name = "perf.data",
66024122
ACM
403 /*
404 * default to both load an store sampling
405 */
406 .operation = MEM_OPERATION_LOAD | MEM_OPERATION_STORE,
028f12ee
SE
407 };
408 const struct option mem_options[] = {
66024122 409 OPT_CALLBACK('t', "type", &mem.operation,
67121f85
SE
410 "type", "memory operations(load,store) Default load,store",
411 parse_mem_ops),
028f12ee
SE
412 OPT_BOOLEAN('D', "dump-raw-samples", &mem.dump_raw,
413 "dump raw samples in ASCII"),
414 OPT_BOOLEAN('U', "hide-unresolved", &mem.hide_unresolved,
415 "Only display entries resolved to a symbol"),
416 OPT_STRING('i', "input", &input_name, "file",
417 "input file name"),
418 OPT_STRING('C', "cpu", &mem.cpu_list, "cpu",
419 "list of cpus to profile"),
8b8ca6e1 420 OPT_STRING_NOEMPTY('x', "field-separator", &symbol_conf.field_sep,
028f12ee
SE
421 "separator",
422 "separator for columns, no spaces will be added"
423 " between columns '.' is reserved."),
62a1a63a 424 OPT_BOOLEAN('f', "force", &mem.force, "don't complain, do it"),
c35aeb9d 425 OPT_BOOLEAN('p', "phys-data", &mem.phys_addr, "Record/Report sample physical addresses"),
028f12ee
SE
426 OPT_END()
427 };
8d2a2a1d
RR
428 const char *const mem_subcommands[] = { "record", "report", NULL };
429 const char *mem_usage[] = {
430 NULL,
431 NULL
432 };
433
54fbad54
JO
434 if (perf_mem_events__init()) {
435 pr_err("failed: memory events not supported\n");
436 return -1;
437 }
438
8d2a2a1d 439 argc = parse_options_subcommand(argc, argv, mem_options, mem_subcommands,
a7e9eab3 440 mem_usage, PARSE_OPT_KEEP_UNKNOWN);
028f12ee 441
66024122 442 if (!argc || !(strncmp(argv[0], "rec", 3) || mem.operation))
028f12ee
SE
443 usage_with_options(mem_usage, mem_options);
444
445 if (!mem.input_name || !strlen(mem.input_name)) {
446 if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
447 mem.input_name = "-";
448 else
449 mem.input_name = "perf.data";
450 }
451
452 if (!strncmp(argv[0], "rec", 3))
66024122 453 return __cmd_record(argc, argv, &mem);
028f12ee
SE
454 else if (!strncmp(argv[0], "rep", 3))
455 return report_events(argc, argv, &mem);
456 else
457 usage_with_options(mem_usage, mem_options);
458
459 return 0;
460}