blob: f45c8b502f63f2d9207671710ab99a13f1c2e7ae [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"
Jiri Olsaacbe6132016-02-15 09:34:34 +010014#include "util/mem-events.h"
Jiri Olsace1e22b2016-02-15 09:34:35 +010015#include "util/debug.h"
Arnaldo Carvalho de Melo1101f692019-01-27 13:42:37 +010016#include "util/map.h"
Arnaldo Carvalho de Meloe7ff8922017-04-19 21:34:35 -030017#include "util/symbol.h"
Stephane Eranian028f12e2013-01-24 16:10:38 +010018
Stephane Eranian67121f82014-12-17 16:23:55 +010019#define MEM_OPERATION_LOAD 0x1
20#define MEM_OPERATION_STORE 0x2
Stephane Eranian028f12e2013-01-24 16:10:38 +010021
Stephane Eranian028f12e2013-01-24 16:10:38 +010022struct perf_mem {
23 struct perf_tool tool;
24 char const *input_name;
Stephane Eranian028f12e2013-01-24 16:10:38 +010025 bool hide_unresolved;
26 bool dump_raw;
Yunlong Song62a1a632015-04-02 21:47:15 +080027 bool force;
Kan Liangc35aeb92017-08-29 13:11:10 -040028 bool phys_addr;
Arnaldo Carvalho de Melo66024122014-12-17 13:53:27 -030029 int operation;
Stephane Eranian028f12e2013-01-24 16:10:38 +010030 const char *cpu_list;
31 DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
32};
33
Jiri Olsace1e22b2016-02-15 09:34:35 +010034static 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
Jiri Olsa54fbad52016-02-24 09:46:42 +010051 fprintf(stderr, "%-13s%-*s%s\n",
52 e->tag,
Namhyung Kimbb963e12017-02-17 17:17:38 +090053 verbose > 0 ? 25 : 0,
54 verbose > 0 ? perf_mem_events__name(j) : "",
Jiri Olsa54fbad52016-02-24 09:46:42 +010055 e->supported ? ": available" : "");
Jiri Olsace1e22b2016-02-15 09:34:35 +010056 }
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
Arnaldo Carvalho de Melo66024122014-12-17 13:53:27 -030068static int __cmd_record(int argc, const char **argv, struct perf_mem *mem)
Stephane Eranian028f12e2013-01-24 16:10:38 +010069{
70 int rec_argc, i = 0, j;
71 const char **rec_argv;
Stephane Eranian028f12e2013-01-24 16:10:38 +010072 int ret;
Jiri Olsaad165112016-03-24 13:52:16 +010073 bool all_user = false, all_kernel = false;
Jiri Olsace1e22b2016-02-15 09:34:35 +010074 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),
Jiri Olsab0d745b2016-06-14 20:19:11 +020078 OPT_UINTEGER(0, "ldlat", &perf_mem_events__loads_ldlat, "mem-loads latency"),
Jiri Olsace1e22b2016-02-15 09:34:35 +010079 OPT_INCR('v', "verbose", &verbose,
80 "be more verbose (show counter open errors, etc)"),
Jiri Olsa631ac412016-12-12 11:35:39 +010081 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"),
Jiri Olsace1e22b2016-02-15 09:34:35 +010083 OPT_END()
84 };
85
86 argc = parse_options(argc, argv, options, record_mem_usage,
Andi Kleena7e9eab2018-04-06 13:38:09 -070087 PARSE_OPT_KEEP_UNKNOWN);
Stephane Eranian028f12e2013-01-24 16:10:38 +010088
Jiri Olsaad165112016-03-24 13:52:16 +010089 rec_argc = argc + 9; /* max number of arguments */
Stephane Eranian028f12e2013-01-24 16:10:38 +010090 rec_argv = calloc(rec_argc + 1, sizeof(char *));
91 if (!rec_argv)
92 return -1;
93
Stephane Eranian67121f82014-12-17 16:23:55 +010094 rec_argv[i++] = "record";
Stephane Eranian028f12e2013-01-24 16:10:38 +010095
Jiri Olsace1e22b2016-02-15 09:34:35 +010096 if (mem->operation & MEM_OPERATION_LOAD)
Jiri Olsaacbe6132016-02-15 09:34:34 +010097 perf_mem_events[PERF_MEM_EVENTS__LOAD].record = true;
Jiri Olsace1e22b2016-02-15 09:34:35 +010098
Jiri Olsa33da54f2016-08-11 10:50:57 +020099 if (mem->operation & MEM_OPERATION_STORE)
100 perf_mem_events[PERF_MEM_EVENTS__STORE].record = true;
101
Jiri Olsace1e22b2016-02-15 09:34:35 +0100102 if (perf_mem_events[PERF_MEM_EVENTS__LOAD].record)
Stephane Eranian67121f82014-12-17 16:23:55 +0100103 rec_argv[i++] = "-W";
Stephane Eranian028f12e2013-01-24 16:10:38 +0100104
Stephane Eranian67121f82014-12-17 16:23:55 +0100105 rec_argv[i++] = "-d";
106
Kan Liangc35aeb92017-08-29 13:11:10 -0400107 if (mem->phys_addr)
108 rec_argv[i++] = "--phys-data";
109
Jiri Olsaacbe6132016-02-15 09:34:34 +0100110 for (j = 0; j < PERF_MEM_EVENTS__MAX; j++) {
111 if (!perf_mem_events[j].record)
112 continue;
Stephane Eranian67121f82014-12-17 16:23:55 +0100113
Jiri Olsa54fbad52016-02-24 09:46:42 +0100114 if (!perf_mem_events[j].supported) {
115 pr_err("failed: event '%s' not supported\n",
Jiri Olsa2ba7ac52016-02-24 09:46:43 +0100116 perf_mem_events__name(j));
Martin Kepplingerc896f852017-09-13 21:14:19 +0200117 free(rec_argv);
Jiri Olsa54fbad52016-02-24 09:46:42 +0100118 return -1;
119 }
120
Stephane Eranian67121f82014-12-17 16:23:55 +0100121 rec_argv[i++] = "-e";
Jiri Olsa2ba7ac52016-02-24 09:46:43 +0100122 rec_argv[i++] = perf_mem_events__name(j);
Jiri Olsaacbe6132016-02-15 09:34:34 +0100123 };
Stephane Eranian67121f82014-12-17 16:23:55 +0100124
Jiri Olsaad165112016-03-24 13:52:16 +0100125 if (all_user)
126 rec_argv[i++] = "--all-user";
127
128 if (all_kernel)
129 rec_argv[i++] = "--all-kernel";
130
Jiri Olsace1e22b2016-02-15 09:34:35 +0100131 for (j = 0; j < argc; j++, i++)
Stephane Eranian028f12e2013-01-24 16:10:38 +0100132 rec_argv[i] = argv[j];
133
Jiri Olsace1e22b2016-02-15 09:34:35 +0100134 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
Arnaldo Carvalho de Melob0ad8ea2017-03-27 11:47:20 -0300144 ret = cmd_record(i, rec_argv);
Stephane Eranian028f12e2013-01-24 16:10:38 +0100145 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,
Stephane Eranian028f12e2013-01-24 16:10:38 +0100153 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
Arnaldo Carvalho de Melobb3eb562016-03-22 18:39:09 -0300159 if (machine__resolve(machine, &al, sample) < 0) {
Stephane Eranian028f12e2013-01-24 16:10:38 +0100160 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))
Arnaldo Carvalho de Melob91fc392015-04-06 20:43:22 -0300166 goto out_put;
Stephane Eranian028f12e2013-01-24 16:10:38 +0100167
168 if (al.map != NULL)
169 al.map->dso->hit = 1;
170
Kan Liangc35aeb92017-08-29 13:11:10 -0400171 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 }
Stephane Eranian028f12e2013-01-24 16:10:38 +0100181
Kan Liangc35aeb92017-08-29 13:11:10 -0400182 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 : "???");
199 } else {
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 }
208
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 }
Arnaldo Carvalho de Melob91fc392015-04-06 20:43:22 -0300225out_put:
226 addr_location__put(&al);
Stephane Eranian028f12e2013-01-24 16:10:38 +0100227 return 0;
228}
229
230static int process_sample_event(struct perf_tool *tool,
231 union perf_event *event,
232 struct perf_sample *sample,
Arnaldo Carvalho de Melo8b640cc2013-12-19 17:00:45 -0300233 struct perf_evsel *evsel __maybe_unused,
Stephane Eranian028f12e2013-01-24 16:10:38 +0100234 struct machine *machine)
235{
Arnaldo Carvalho de Melo8b640cc2013-12-19 17:00:45 -0300236 return dump_raw_samples(tool, event, sample, machine);
Stephane Eranian028f12e2013-01-24 16:10:38 +0100237}
238
239static int report_raw_events(struct perf_mem *mem)
240{
Jiri Olsa8ceb41d2017-01-23 22:07:59 +0100241 struct perf_data data = {
Jiri Olsa2d4f2792019-02-21 10:41:30 +0100242 .path = input_name,
243 .mode = PERF_DATA_MODE_READ,
244 .force = mem->force,
Jiri Olsaf5fc14122013-10-15 16:27:32 +0200245 };
Stephane Eranian028f12e2013-01-24 16:10:38 +0100246 int ret;
Jiri Olsa8ceb41d2017-01-23 22:07:59 +0100247 struct perf_session *session = perf_session__new(&data, false,
Jiri Olsaf5fc14122013-10-15 16:27:32 +0200248 &mem->tool);
Stephane Eranian028f12e2013-01-24 16:10:38 +0100249
250 if (session == NULL)
Taeung Song52e028342014-09-24 10:33:37 +0900251 return -1;
Stephane Eranian028f12e2013-01-24 16:10:38 +0100252
253 if (mem->cpu_list) {
254 ret = perf_session__cpu_bitmap(session, mem->cpu_list,
255 mem->cpu_bitmap);
Taeung Song1df9fade2015-07-01 21:08:19 +0900256 if (ret < 0)
Stephane Eranian028f12e2013-01-24 16:10:38 +0100257 goto out_delete;
258 }
259
Taeung Song1df9fade2015-07-01 21:08:19 +0900260 ret = symbol__init(&session->header.env);
261 if (ret < 0)
262 goto out_delete;
Stephane Eranian028f12e2013-01-24 16:10:38 +0100263
Kan Liangc35aeb92017-08-29 13:11:10 -0400264 if (mem->phys_addr)
265 printf("# PID, TID, IP, ADDR, PHYS ADDR, LOCAL WEIGHT, DSRC, SYMBOL\n");
266 else
267 printf("# PID, TID, IP, ADDR, LOCAL WEIGHT, DSRC, SYMBOL\n");
Stephane Eranian028f12e2013-01-24 16:10:38 +0100268
Taeung Song1df9fade2015-07-01 21:08:19 +0900269 ret = perf_session__process_events(session);
Stephane Eranian028f12e2013-01-24 16:10:38 +0100270
271out_delete:
272 perf_session__delete(session);
Taeung Song1df9fade2015-07-01 21:08:19 +0900273 return ret;
Stephane Eranian028f12e2013-01-24 16:10:38 +0100274}
275
276static int report_events(int argc, const char **argv, struct perf_mem *mem)
277{
278 const char **rep_argv;
279 int ret, i = 0, j, rep_argc;
280
281 if (mem->dump_raw)
282 return report_raw_events(mem);
283
284 rep_argc = argc + 3;
285 rep_argv = calloc(rep_argc + 1, sizeof(char *));
286 if (!rep_argv)
287 return -1;
288
Stephane Eranian67121f82014-12-17 16:23:55 +0100289 rep_argv[i++] = "report";
290 rep_argv[i++] = "--mem-mode";
291 rep_argv[i++] = "-n"; /* display number of samples */
Stephane Eranian028f12e2013-01-24 16:10:38 +0100292
293 /*
294 * there is no weight (cost) associated with stores, so don't print
295 * the column
296 */
Kan Liangc35aeb92017-08-29 13:11:10 -0400297 if (!(mem->operation & MEM_OPERATION_LOAD)) {
298 if (mem->phys_addr)
299 rep_argv[i++] = "--sort=mem,sym,dso,symbol_daddr,"
300 "dso_daddr,tlb,locked,phys_daddr";
301 else
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";
Stephane Eranian028f12e2013-01-24 16:10:38 +0100307
308 for (j = 1; j < argc; j++, i++)
309 rep_argv[i] = argv[j];
310
Arnaldo Carvalho de Melob0ad8ea2017-03-27 11:47:20 -0300311 ret = cmd_report(i, rep_argv);
Stephane Eranian028f12e2013-01-24 16:10:38 +0100312 free(rep_argv);
313 return ret;
314}
315
Stephane Eranian67121f82014-12-17 16:23:55 +0100316struct mem_mode {
317 const char *name;
318 int mode;
319};
320
321#define MEM_OPT(n, m) \
322 { .name = n, .mode = (m) }
323
324#define MEM_END { .name = NULL }
325
326static const struct mem_mode mem_modes[]={
327 MEM_OPT("load", MEM_OPERATION_LOAD),
328 MEM_OPT("store", MEM_OPERATION_STORE),
329 MEM_END
330};
331
332static int
333parse_mem_ops(const struct option *opt, const char *str, int unset)
334{
335 int *mode = (int *)opt->value;
336 const struct mem_mode *m;
337 char *s, *os = NULL, *p;
338 int ret = -1;
339
340 if (unset)
341 return 0;
342
343 /* str may be NULL in case no arg is passed to -t */
344 if (str) {
345 /* because str is read-only */
346 s = os = strdup(str);
347 if (!s)
348 return -1;
349
350 /* reset mode */
351 *mode = 0;
352
353 for (;;) {
354 p = strchr(s, ',');
355 if (p)
356 *p = '\0';
357
358 for (m = mem_modes; m->name; m++) {
359 if (!strcasecmp(s, m->name))
360 break;
361 }
362 if (!m->name) {
363 fprintf(stderr, "unknown sampling op %s,"
364 " check man page\n", s);
365 goto error;
366 }
367
368 *mode |= m->mode;
369
370 if (!p)
371 break;
372
373 s = p + 1;
374 }
375 }
376 ret = 0;
377
378 if (*mode == 0)
379 *mode = MEM_OPERATION_LOAD;
380error:
381 free(os);
382 return ret;
383}
384
Arnaldo Carvalho de Melob0ad8ea2017-03-27 11:47:20 -0300385int cmd_mem(int argc, const char **argv)
Stephane Eranian028f12e2013-01-24 16:10:38 +0100386{
387 struct stat st;
388 struct perf_mem mem = {
389 .tool = {
390 .sample = process_sample_event,
391 .mmap = perf_event__process_mmap,
Stephane Eranian5c5e8542013-08-21 12:10:25 +0200392 .mmap2 = perf_event__process_mmap2,
Stephane Eranian028f12e2013-01-24 16:10:38 +0100393 .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,
Hari Bathinif3b36142017-03-08 02:11:43 +0530397 .namespaces = perf_event__process_namespaces,
Jiri Olsa0a8cb852014-07-06 14:18:21 +0200398 .ordered_events = true,
Stephane Eranian028f12e2013-01-24 16:10:38 +0100399 },
400 .input_name = "perf.data",
Arnaldo Carvalho de Melo66024122014-12-17 13:53:27 -0300401 /*
402 * default to both load an store sampling
403 */
404 .operation = MEM_OPERATION_LOAD | MEM_OPERATION_STORE,
Stephane Eranian028f12e2013-01-24 16:10:38 +0100405 };
406 const struct option mem_options[] = {
Arnaldo Carvalho de Melo66024122014-12-17 13:53:27 -0300407 OPT_CALLBACK('t', "type", &mem.operation,
Stephane Eranian67121f82014-12-17 16:23:55 +0100408 "type", "memory operations(load,store) Default load,store",
409 parse_mem_ops),
Stephane Eranian028f12e2013-01-24 16:10:38 +0100410 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",
415 "input file name"),
416 OPT_STRING('C', "cpu", &mem.cpu_list, "cpu",
417 "list of cpus to profile"),
Wang Nan8b8ca6e2015-03-20 02:57:52 +0000418 OPT_STRING_NOEMPTY('x', "field-separator", &symbol_conf.field_sep,
Stephane Eranian028f12e2013-01-24 16:10:38 +0100419 "separator",
420 "separator for columns, no spaces will be added"
421 " between columns '.' is reserved."),
Yunlong Song62a1a632015-04-02 21:47:15 +0800422 OPT_BOOLEAN('f', "force", &mem.force, "don't complain, do it"),
Kan Liangc35aeb92017-08-29 13:11:10 -0400423 OPT_BOOLEAN('p', "phys-data", &mem.phys_addr, "Record/Report sample physical addresses"),
Stephane Eranian028f12e2013-01-24 16:10:38 +0100424 OPT_END()
425 };
Ramkumar Ramachandra8d2a2a12014-03-14 23:17:52 -0400426 const char *const mem_subcommands[] = { "record", "report", NULL };
427 const char *mem_usage[] = {
428 NULL,
429 NULL
430 };
Stephane Eranian028f12e2013-01-24 16:10:38 +0100431
Jiri Olsa54fbad52016-02-24 09:46:42 +0100432 if (perf_mem_events__init()) {
433 pr_err("failed: memory events not supported\n");
434 return -1;
435 }
436
Ramkumar Ramachandra8d2a2a12014-03-14 23:17:52 -0400437 argc = parse_options_subcommand(argc, argv, mem_options, mem_subcommands,
Andi Kleena7e9eab2018-04-06 13:38:09 -0700438 mem_usage, PARSE_OPT_KEEP_UNKNOWN);
Stephane Eranian028f12e2013-01-24 16:10:38 +0100439
Arnaldo Carvalho de Melo66024122014-12-17 13:53:27 -0300440 if (!argc || !(strncmp(argv[0], "rec", 3) || mem.operation))
Stephane Eranian028f12e2013-01-24 16:10:38 +0100441 usage_with_options(mem_usage, mem_options);
442
443 if (!mem.input_name || !strlen(mem.input_name)) {
444 if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
445 mem.input_name = "-";
446 else
447 mem.input_name = "perf.data";
448 }
449
450 if (!strncmp(argv[0], "rec", 3))
Arnaldo Carvalho de Melo66024122014-12-17 13:53:27 -0300451 return __cmd_record(argc, argv, &mem);
Stephane Eranian028f12e2013-01-24 16:10:38 +0100452 else if (!strncmp(argv[0], "rep", 3))
453 return report_events(argc, argv, &mem);
454 else
455 usage_with_options(mem_usage, mem_options);
456
457 return 0;
458}