blob: 27d2bde943a8feae760f15a3a29e0d958928a18c [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001// SPDX-License-Identifier: GPL-2.0
Arnaldo Carvalho de Melofd20e812017-04-17 15:23:08 -03002#include <inttypes.h>
Arnaldo Carvalho de Melo7a8ef4c2017-04-19 20:57:47 -03003#include <sys/types.h>
4#include <sys/stat.h>
5#include <unistd.h>
Stephane Eranian028f12e2013-01-24 16:10:38 +01006#include "builtin.h"
7#include "perf.h"
8
Josh Poimboeuf4b6ab942015-12-15 09:39:39 -06009#include <subcmd/parse-options.h>
Stephane Eranian028f12e2013-01-24 16:10:38 +010010#include "util/trace-event.h"
11#include "util/tool.h"
12#include "util/session.h"
Jiri Olsaf5fc14122013-10-15 16:27:32 +020013#include "util/data.h"
Arnaldo Carvalho de Melod3300a32019-08-30 15:09:54 -030014#include "util/map_symbol.h"
Jiri Olsaacbe6132016-02-15 09:34:34 +010015#include "util/mem-events.h"
Jiri Olsace1e22b2016-02-15 09:34:35 +010016#include "util/debug.h"
Arnaldo Carvalho de Melo4a3cec82019-08-30 11:11:01 -030017#include "util/dso.h"
Arnaldo Carvalho de Melo1101f692019-01-27 13:42:37 +010018#include "util/map.h"
Arnaldo Carvalho de Meloe7ff8922017-04-19 21:34:35 -030019#include "util/symbol.h"
Stephane Eranian028f12e2013-01-24 16:10:38 +010020
Stephane Eranian67121f82014-12-17 16:23:55 +010021#define MEM_OPERATION_LOAD 0x1
22#define MEM_OPERATION_STORE 0x2
Stephane Eranian028f12e2013-01-24 16:10:38 +010023
Stephane Eranian028f12e2013-01-24 16:10:38 +010024struct perf_mem {
25 struct perf_tool tool;
26 char const *input_name;
Stephane Eranian028f12e2013-01-24 16:10:38 +010027 bool hide_unresolved;
28 bool dump_raw;
Yunlong Song62a1a632015-04-02 21:47:15 +080029 bool force;
Kan Liangc35aeb92017-08-29 13:11:10 -040030 bool phys_addr;
Arnaldo Carvalho de Melo66024122014-12-17 13:53:27 -030031 int operation;
Stephane Eranian028f12e2013-01-24 16:10:38 +010032 const char *cpu_list;
33 DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
34};
35
Jiri Olsace1e22b2016-02-15 09:34:35 +010036static int parse_record_events(const struct option *opt,
37 const char *str, int unset __maybe_unused)
38{
39 struct perf_mem *mem = *(struct perf_mem **)opt->value;
40 int j;
41
42 if (strcmp(str, "list")) {
43 if (!perf_mem_events__parse(str)) {
44 mem->operation = 0;
45 return 0;
46 }
47 exit(-1);
48 }
49
50 for (j = 0; j < PERF_MEM_EVENTS__MAX; j++) {
51 struct perf_mem_event *e = &perf_mem_events[j];
52
Jiri Olsa54fbad52016-02-24 09:46:42 +010053 fprintf(stderr, "%-13s%-*s%s\n",
54 e->tag,
Namhyung Kimbb963e12017-02-17 17:17:38 +090055 verbose > 0 ? 25 : 0,
56 verbose > 0 ? perf_mem_events__name(j) : "",
Jiri Olsa54fbad52016-02-24 09:46:42 +010057 e->supported ? ": available" : "");
Jiri Olsace1e22b2016-02-15 09:34:35 +010058 }
59 exit(0);
60}
61
62static const char * const __usage[] = {
63 "perf mem record [<options>] [<command>]",
64 "perf mem record [<options>] -- <command> [<options>]",
65 NULL
66};
67
68static const char * const *record_mem_usage = __usage;
69
Arnaldo Carvalho de Melo66024122014-12-17 13:53:27 -030070static int __cmd_record(int argc, const char **argv, struct perf_mem *mem)
Stephane Eranian028f12e2013-01-24 16:10:38 +010071{
72 int rec_argc, i = 0, j;
73 const char **rec_argv;
Stephane Eranian028f12e2013-01-24 16:10:38 +010074 int ret;
Jiri Olsaad165112016-03-24 13:52:16 +010075 bool all_user = false, all_kernel = false;
Jiri Olsace1e22b2016-02-15 09:34:35 +010076 struct option options[] = {
77 OPT_CALLBACK('e', "event", &mem, "event",
78 "event selector. use 'perf mem record -e list' to list available events",
79 parse_record_events),
Jiri Olsab0d745b2016-06-14 20:19:11 +020080 OPT_UINTEGER(0, "ldlat", &perf_mem_events__loads_ldlat, "mem-loads latency"),
Jiri Olsace1e22b2016-02-15 09:34:35 +010081 OPT_INCR('v', "verbose", &verbose,
82 "be more verbose (show counter open errors, etc)"),
Jiri Olsa631ac412016-12-12 11:35:39 +010083 OPT_BOOLEAN('U', "all-user", &all_user, "collect only user level data"),
84 OPT_BOOLEAN('K', "all-kernel", &all_kernel, "collect only kernel level data"),
Jiri Olsace1e22b2016-02-15 09:34:35 +010085 OPT_END()
86 };
87
88 argc = parse_options(argc, argv, options, record_mem_usage,
Andi Kleena7e9eab2018-04-06 13:38:09 -070089 PARSE_OPT_KEEP_UNKNOWN);
Stephane Eranian028f12e2013-01-24 16:10:38 +010090
Jiri Olsaad165112016-03-24 13:52:16 +010091 rec_argc = argc + 9; /* max number of arguments */
Stephane Eranian028f12e2013-01-24 16:10:38 +010092 rec_argv = calloc(rec_argc + 1, sizeof(char *));
93 if (!rec_argv)
94 return -1;
95
Stephane Eranian67121f82014-12-17 16:23:55 +010096 rec_argv[i++] = "record";
Stephane Eranian028f12e2013-01-24 16:10:38 +010097
Jiri Olsace1e22b2016-02-15 09:34:35 +010098 if (mem->operation & MEM_OPERATION_LOAD)
Jiri Olsaacbe6132016-02-15 09:34:34 +010099 perf_mem_events[PERF_MEM_EVENTS__LOAD].record = true;
Jiri Olsace1e22b2016-02-15 09:34:35 +0100100
Jiri Olsa33da54f2016-08-11 10:50:57 +0200101 if (mem->operation & MEM_OPERATION_STORE)
102 perf_mem_events[PERF_MEM_EVENTS__STORE].record = true;
103
Jiri Olsace1e22b2016-02-15 09:34:35 +0100104 if (perf_mem_events[PERF_MEM_EVENTS__LOAD].record)
Stephane Eranian67121f82014-12-17 16:23:55 +0100105 rec_argv[i++] = "-W";
Stephane Eranian028f12e2013-01-24 16:10:38 +0100106
Stephane Eranian67121f82014-12-17 16:23:55 +0100107 rec_argv[i++] = "-d";
108
Kan Liangc35aeb92017-08-29 13:11:10 -0400109 if (mem->phys_addr)
110 rec_argv[i++] = "--phys-data";
111
Jiri Olsaacbe6132016-02-15 09:34:34 +0100112 for (j = 0; j < PERF_MEM_EVENTS__MAX; j++) {
113 if (!perf_mem_events[j].record)
114 continue;
Stephane Eranian67121f82014-12-17 16:23:55 +0100115
Jiri Olsa54fbad52016-02-24 09:46:42 +0100116 if (!perf_mem_events[j].supported) {
117 pr_err("failed: event '%s' not supported\n",
Jiri Olsa2ba7ac52016-02-24 09:46:43 +0100118 perf_mem_events__name(j));
Martin Kepplingerc896f852017-09-13 21:14:19 +0200119 free(rec_argv);
Jiri Olsa54fbad52016-02-24 09:46:42 +0100120 return -1;
121 }
122
Stephane Eranian67121f82014-12-17 16:23:55 +0100123 rec_argv[i++] = "-e";
Jiri Olsa2ba7ac52016-02-24 09:46:43 +0100124 rec_argv[i++] = perf_mem_events__name(j);
Jiri Olsaacbe6132016-02-15 09:34:34 +0100125 };
Stephane Eranian67121f82014-12-17 16:23:55 +0100126
Jiri Olsaad165112016-03-24 13:52:16 +0100127 if (all_user)
128 rec_argv[i++] = "--all-user";
129
130 if (all_kernel)
131 rec_argv[i++] = "--all-kernel";
132
Jiri Olsace1e22b2016-02-15 09:34:35 +0100133 for (j = 0; j < argc; j++, i++)
Stephane Eranian028f12e2013-01-24 16:10:38 +0100134 rec_argv[i] = argv[j];
135
Jiri Olsace1e22b2016-02-15 09:34:35 +0100136 if (verbose > 0) {
137 pr_debug("calling: record ");
138
139 while (rec_argv[j]) {
140 pr_debug("%s ", rec_argv[j]);
141 j++;
142 }
143 pr_debug("\n");
144 }
145
Arnaldo Carvalho de Melob0ad8ea2017-03-27 11:47:20 -0300146 ret = cmd_record(i, rec_argv);
Stephane Eranian028f12e2013-01-24 16:10:38 +0100147 free(rec_argv);
148 return ret;
149}
150
151static int
152dump_raw_samples(struct perf_tool *tool,
153 union perf_event *event,
154 struct perf_sample *sample,
Stephane Eranian028f12e2013-01-24 16:10:38 +0100155 struct machine *machine)
156{
157 struct perf_mem *mem = container_of(tool, struct perf_mem, tool);
158 struct addr_location al;
159 const char *fmt;
160
Arnaldo Carvalho de Melobb3eb562016-03-22 18:39:09 -0300161 if (machine__resolve(machine, &al, sample) < 0) {
Stephane Eranian028f12e2013-01-24 16:10:38 +0100162 fprintf(stderr, "problem processing %d event, skipping it.\n",
163 event->header.type);
164 return -1;
165 }
166
167 if (al.filtered || (mem->hide_unresolved && al.sym == NULL))
Arnaldo Carvalho de Melob91fc392015-04-06 20:43:22 -0300168 goto out_put;
Stephane Eranian028f12e2013-01-24 16:10:38 +0100169
170 if (al.map != NULL)
171 al.map->dso->hit = 1;
172
Kan Liangc35aeb92017-08-29 13:11:10 -0400173 if (mem->phys_addr) {
174 if (symbol_conf.field_sep) {
175 fmt = "%d%s%d%s0x%"PRIx64"%s0x%"PRIx64"%s0x%016"PRIx64
176 "%s%"PRIu64"%s0x%"PRIx64"%s%s:%s\n";
177 } else {
178 fmt = "%5d%s%5d%s0x%016"PRIx64"%s0x016%"PRIx64
179 "%s0x%016"PRIx64"%s%5"PRIu64"%s0x%06"PRIx64
180 "%s%s:%s\n";
181 symbol_conf.field_sep = " ";
182 }
Stephane Eranian028f12e2013-01-24 16:10:38 +0100183
Kan Liangc35aeb92017-08-29 13:11:10 -0400184 printf(fmt,
185 sample->pid,
186 symbol_conf.field_sep,
187 sample->tid,
188 symbol_conf.field_sep,
189 sample->ip,
190 symbol_conf.field_sep,
191 sample->addr,
192 symbol_conf.field_sep,
193 sample->phys_addr,
194 symbol_conf.field_sep,
195 sample->weight,
196 symbol_conf.field_sep,
197 sample->data_src,
198 symbol_conf.field_sep,
199 al.map ? (al.map->dso ? al.map->dso->long_name : "???") : "???",
200 al.sym ? al.sym->name : "???");
201 } else {
202 if (symbol_conf.field_sep) {
203 fmt = "%d%s%d%s0x%"PRIx64"%s0x%"PRIx64"%s%"PRIu64
204 "%s0x%"PRIx64"%s%s:%s\n";
205 } else {
206 fmt = "%5d%s%5d%s0x%016"PRIx64"%s0x016%"PRIx64
207 "%s%5"PRIu64"%s0x%06"PRIx64"%s%s:%s\n";
208 symbol_conf.field_sep = " ";
209 }
210
211 printf(fmt,
212 sample->pid,
213 symbol_conf.field_sep,
214 sample->tid,
215 symbol_conf.field_sep,
216 sample->ip,
217 symbol_conf.field_sep,
218 sample->addr,
219 symbol_conf.field_sep,
220 sample->weight,
221 symbol_conf.field_sep,
222 sample->data_src,
223 symbol_conf.field_sep,
224 al.map ? (al.map->dso ? al.map->dso->long_name : "???") : "???",
225 al.sym ? al.sym->name : "???");
226 }
Arnaldo Carvalho de Melob91fc392015-04-06 20:43:22 -0300227out_put:
228 addr_location__put(&al);
Stephane Eranian028f12e2013-01-24 16:10:38 +0100229 return 0;
230}
231
232static int process_sample_event(struct perf_tool *tool,
233 union perf_event *event,
234 struct perf_sample *sample,
Jiri Olsa32dcd022019-07-21 13:23:51 +0200235 struct evsel *evsel __maybe_unused,
Stephane Eranian028f12e2013-01-24 16:10:38 +0100236 struct machine *machine)
237{
Arnaldo Carvalho de Melo8b640cc2013-12-19 17:00:45 -0300238 return dump_raw_samples(tool, event, sample, machine);
Stephane Eranian028f12e2013-01-24 16:10:38 +0100239}
240
241static int report_raw_events(struct perf_mem *mem)
242{
Jiri Olsa8ceb41d2017-01-23 22:07:59 +0100243 struct perf_data data = {
Jiri Olsa2d4f2792019-02-21 10:41:30 +0100244 .path = input_name,
245 .mode = PERF_DATA_MODE_READ,
246 .force = mem->force,
Jiri Olsaf5fc14122013-10-15 16:27:32 +0200247 };
Stephane Eranian028f12e2013-01-24 16:10:38 +0100248 int ret;
Jiri Olsa8ceb41d2017-01-23 22:07:59 +0100249 struct perf_session *session = perf_session__new(&data, false,
Jiri Olsaf5fc14122013-10-15 16:27:32 +0200250 &mem->tool);
Stephane Eranian028f12e2013-01-24 16:10:38 +0100251
252 if (session == NULL)
Taeung Song52e028342014-09-24 10:33:37 +0900253 return -1;
Stephane Eranian028f12e2013-01-24 16:10:38 +0100254
255 if (mem->cpu_list) {
256 ret = perf_session__cpu_bitmap(session, mem->cpu_list,
257 mem->cpu_bitmap);
Taeung Song1df9fade2015-07-01 21:08:19 +0900258 if (ret < 0)
Stephane Eranian028f12e2013-01-24 16:10:38 +0100259 goto out_delete;
260 }
261
Taeung Song1df9fade2015-07-01 21:08:19 +0900262 ret = symbol__init(&session->header.env);
263 if (ret < 0)
264 goto out_delete;
Stephane Eranian028f12e2013-01-24 16:10:38 +0100265
Kan Liangc35aeb92017-08-29 13:11:10 -0400266 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");
Stephane Eranian028f12e2013-01-24 16:10:38 +0100270
Taeung Song1df9fade2015-07-01 21:08:19 +0900271 ret = perf_session__process_events(session);
Stephane Eranian028f12e2013-01-24 16:10:38 +0100272
273out_delete:
274 perf_session__delete(session);
Taeung Song1df9fade2015-07-01 21:08:19 +0900275 return ret;
Stephane Eranian028f12e2013-01-24 16:10:38 +0100276}
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
Stephane Eranian67121f82014-12-17 16:23:55 +0100291 rep_argv[i++] = "report";
292 rep_argv[i++] = "--mem-mode";
293 rep_argv[i++] = "-n"; /* display number of samples */
Stephane Eranian028f12e2013-01-24 16:10:38 +0100294
295 /*
296 * there is no weight (cost) associated with stores, so don't print
297 * the column
298 */
Kan Liangc35aeb92017-08-29 13:11:10 -0400299 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";
Stephane Eranian028f12e2013-01-24 16:10:38 +0100309
310 for (j = 1; j < argc; j++, i++)
311 rep_argv[i] = argv[j];
312
Arnaldo Carvalho de Melob0ad8ea2017-03-27 11:47:20 -0300313 ret = cmd_report(i, rep_argv);
Stephane Eranian028f12e2013-01-24 16:10:38 +0100314 free(rep_argv);
315 return ret;
316}
317
Stephane Eranian67121f82014-12-17 16:23:55 +0100318struct 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
Arnaldo Carvalho de Melob0ad8ea2017-03-27 11:47:20 -0300387int cmd_mem(int argc, const char **argv)
Stephane Eranian028f12e2013-01-24 16:10:38 +0100388{
389 struct stat st;
390 struct perf_mem mem = {
391 .tool = {
392 .sample = process_sample_event,
393 .mmap = perf_event__process_mmap,
Stephane Eranian5c5e8542013-08-21 12:10:25 +0200394 .mmap2 = perf_event__process_mmap2,
Stephane Eranian028f12e2013-01-24 16:10:38 +0100395 .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,
Hari Bathinif3b36142017-03-08 02:11:43 +0530399 .namespaces = perf_event__process_namespaces,
Jiri Olsa0a8cb852014-07-06 14:18:21 +0200400 .ordered_events = true,
Stephane Eranian028f12e2013-01-24 16:10:38 +0100401 },
402 .input_name = "perf.data",
Arnaldo Carvalho de Melo66024122014-12-17 13:53:27 -0300403 /*
404 * default to both load an store sampling
405 */
406 .operation = MEM_OPERATION_LOAD | MEM_OPERATION_STORE,
Stephane Eranian028f12e2013-01-24 16:10:38 +0100407 };
408 const struct option mem_options[] = {
Arnaldo Carvalho de Melo66024122014-12-17 13:53:27 -0300409 OPT_CALLBACK('t', "type", &mem.operation,
Stephane Eranian67121f82014-12-17 16:23:55 +0100410 "type", "memory operations(load,store) Default load,store",
411 parse_mem_ops),
Stephane Eranian028f12e2013-01-24 16:10:38 +0100412 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"),
Wang Nan8b8ca6e2015-03-20 02:57:52 +0000420 OPT_STRING_NOEMPTY('x', "field-separator", &symbol_conf.field_sep,
Stephane Eranian028f12e2013-01-24 16:10:38 +0100421 "separator",
422 "separator for columns, no spaces will be added"
423 " between columns '.' is reserved."),
Yunlong Song62a1a632015-04-02 21:47:15 +0800424 OPT_BOOLEAN('f', "force", &mem.force, "don't complain, do it"),
Kan Liangc35aeb92017-08-29 13:11:10 -0400425 OPT_BOOLEAN('p', "phys-data", &mem.phys_addr, "Record/Report sample physical addresses"),
Stephane Eranian028f12e2013-01-24 16:10:38 +0100426 OPT_END()
427 };
Ramkumar Ramachandra8d2a2a12014-03-14 23:17:52 -0400428 const char *const mem_subcommands[] = { "record", "report", NULL };
429 const char *mem_usage[] = {
430 NULL,
431 NULL
432 };
Stephane Eranian028f12e2013-01-24 16:10:38 +0100433
Jiri Olsa54fbad52016-02-24 09:46:42 +0100434 if (perf_mem_events__init()) {
435 pr_err("failed: memory events not supported\n");
436 return -1;
437 }
438
Ramkumar Ramachandra8d2a2a12014-03-14 23:17:52 -0400439 argc = parse_options_subcommand(argc, argv, mem_options, mem_subcommands,
Andi Kleena7e9eab2018-04-06 13:38:09 -0700440 mem_usage, PARSE_OPT_KEEP_UNKNOWN);
Stephane Eranian028f12e2013-01-24 16:10:38 +0100441
Arnaldo Carvalho de Melo66024122014-12-17 13:53:27 -0300442 if (!argc || !(strncmp(argv[0], "rec", 3) || mem.operation))
Stephane Eranian028f12e2013-01-24 16:10:38 +0100443 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))
Arnaldo Carvalho de Melo66024122014-12-17 13:53:27 -0300453 return __cmd_record(argc, argv, &mem);
Stephane Eranian028f12e2013-01-24 16:10:38 +0100454 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}