perf tools: Add option macro OPT_BOOLEAN_SET
[linux-2.6-block.git] / tools / perf / builtin-record.c
CommitLineData
abaff32a 1/*
bf9e1876
IM
2 * builtin-record.c
3 *
4 * Builtin record command: Record the profile of a workload
5 * (or a CPU, or a PID) into the perf.data output file - for
6 * later analysis via perf report.
abaff32a 7 */
16f762a2 8#include "builtin.h"
bf9e1876
IM
9
10#include "perf.h"
11
6122e4e4 12#include "util/build-id.h"
6eda5838 13#include "util/util.h"
0e9b20b8 14#include "util/parse-options.h"
8ad8db37 15#include "util/parse-events.h"
6eda5838 16
7c6a1c65 17#include "util/header.h"
66e274f3 18#include "util/event.h"
361c99a6 19#include "util/evlist.h"
69aad6f1 20#include "util/evsel.h"
8f28827a 21#include "util/debug.h"
94c744b6 22#include "util/session.h"
45694aa7 23#include "util/tool.h"
8d06367f 24#include "util/symbol.h"
a12b51c4 25#include "util/cpumap.h"
fd78260b 26#include "util/thread_map.h"
f5fc1412 27#include "util/data.h"
7c6a1c65 28
97124d5e 29#include <unistd.h>
de9ac07b 30#include <sched.h>
a41794cd 31#include <sys/mman.h>
de9ac07b 32
89fe808a 33#ifndef HAVE_ON_EXIT_SUPPORT
78da39fa
BR
34#ifndef ATEXIT_MAX
35#define ATEXIT_MAX 32
36#endif
37static int __on_exit_count = 0;
38typedef void (*on_exit_func_t) (int, void *);
39static on_exit_func_t __on_exit_funcs[ATEXIT_MAX];
40static void *__on_exit_args[ATEXIT_MAX];
41static int __exitcode = 0;
42static void __handle_on_exit_funcs(void);
43static int on_exit(on_exit_func_t function, void *arg);
44#define exit(x) (exit)(__exitcode = (x))
45
46static int on_exit(on_exit_func_t function, void *arg)
47{
48 if (__on_exit_count == ATEXIT_MAX)
49 return -ENOMEM;
50 else if (__on_exit_count == 0)
51 atexit(__handle_on_exit_funcs);
52 __on_exit_funcs[__on_exit_count] = function;
53 __on_exit_args[__on_exit_count++] = arg;
54 return 0;
55}
56
57static void __handle_on_exit_funcs(void)
58{
59 int i;
60 for (i = 0; i < __on_exit_count; i++)
61 __on_exit_funcs[i] (__exitcode, __on_exit_args[i]);
62}
63#endif
64
d20deb64 65struct perf_record {
45694aa7 66 struct perf_tool tool;
d20deb64
ACM
67 struct perf_record_opts opts;
68 u64 bytes_written;
f5fc1412 69 struct perf_data_file file;
d20deb64
ACM
70 struct perf_evlist *evlist;
71 struct perf_session *session;
72 const char *progname;
d20deb64 73 int realtime_prio;
d20deb64
ACM
74 bool no_buildid;
75 bool no_buildid_cache;
d20deb64 76 long samples;
0f82ebc4 77};
a21ca2ca 78
a9986fad 79static int do_write_output(struct perf_record *rec, void *buf, size_t size)
f5970550 80{
f5fc1412
JO
81 struct perf_data_file *file = &rec->file;
82
f5970550 83 while (size) {
410f1786 84 ssize_t ret = write(file->fd, buf, size);
f5970550 85
8d3eca20 86 if (ret < 0) {
4f624685 87 pr_err("failed to write perf data, error: %m\n");
8d3eca20
DA
88 return -1;
89 }
f5970550
PZ
90
91 size -= ret;
92 buf += ret;
93
d20deb64 94 rec->bytes_written += ret;
f5970550 95 }
8d3eca20
DA
96
97 return 0;
f5970550
PZ
98}
99
a9986fad
DA
100static int write_output(struct perf_record *rec, void *buf, size_t size)
101{
102 return do_write_output(rec, buf, size);
103}
104
45694aa7 105static int process_synthesized_event(struct perf_tool *tool,
d20deb64 106 union perf_event *event,
1d037ca1
IT
107 struct perf_sample *sample __maybe_unused,
108 struct machine *machine __maybe_unused)
234fbbf5 109{
45694aa7 110 struct perf_record *rec = container_of(tool, struct perf_record, tool);
8d3eca20
DA
111 if (write_output(rec, event, event->header.size) < 0)
112 return -1;
113
234fbbf5
ACM
114 return 0;
115}
116
8d3eca20 117static int perf_record__mmap_read(struct perf_record *rec,
d20deb64 118 struct perf_mmap *md)
de9ac07b 119{
744bd8aa 120 unsigned int head = perf_mmap__read_head(md);
de9ac07b 121 unsigned int old = md->prev;
918512b4 122 unsigned char *data = md->base + page_size;
de9ac07b
PZ
123 unsigned long size;
124 void *buf;
8d3eca20 125 int rc = 0;
de9ac07b 126
dc82009a 127 if (old == head)
8d3eca20 128 return 0;
dc82009a 129
d20deb64 130 rec->samples++;
de9ac07b
PZ
131
132 size = head - old;
133
134 if ((old & md->mask) + size != (head & md->mask)) {
135 buf = &data[old & md->mask];
136 size = md->mask + 1 - (old & md->mask);
137 old += size;
021e9f47 138
8d3eca20
DA
139 if (write_output(rec, buf, size) < 0) {
140 rc = -1;
141 goto out;
142 }
de9ac07b
PZ
143 }
144
145 buf = &data[old & md->mask];
146 size = head - old;
147 old += size;
021e9f47 148
8d3eca20
DA
149 if (write_output(rec, buf, size) < 0) {
150 rc = -1;
151 goto out;
152 }
de9ac07b
PZ
153
154 md->prev = old;
115d2d89 155 perf_mmap__write_tail(md, old);
8d3eca20
DA
156
157out:
158 return rc;
de9ac07b
PZ
159}
160
161static volatile int done = 0;
f7b7c26e 162static volatile int signr = -1;
33e49ea7 163static volatile int child_finished = 0;
de9ac07b 164
16c8a109 165static void sig_handler(int sig)
de9ac07b 166{
33e49ea7
AK
167 if (sig == SIGCHLD)
168 child_finished = 1;
169
16c8a109 170 done = 1;
f7b7c26e
PZ
171 signr = sig;
172}
173
1d037ca1 174static void perf_record__sig_exit(int exit_status __maybe_unused, void *arg)
f7b7c26e 175{
d20deb64 176 struct perf_record *rec = arg;
33e49ea7
AK
177 int status;
178
d20deb64 179 if (rec->evlist->workload.pid > 0) {
33e49ea7 180 if (!child_finished)
d20deb64 181 kill(rec->evlist->workload.pid, SIGTERM);
33e49ea7
AK
182
183 wait(&status);
184 if (WIFSIGNALED(status))
d20deb64 185 psignal(WTERMSIG(status), rec->progname);
33e49ea7 186 }
933da83a 187
18483b81 188 if (signr == -1 || signr == SIGUSR1)
f7b7c26e
PZ
189 return;
190
191 signal(signr, SIG_DFL);
de9ac07b
PZ
192}
193
8d3eca20 194static int perf_record__open(struct perf_record *rec)
dd7927f4 195{
56e52e85 196 char msg[512];
6a4bb04c 197 struct perf_evsel *pos;
d20deb64
ACM
198 struct perf_evlist *evlist = rec->evlist;
199 struct perf_session *session = rec->session;
200 struct perf_record_opts *opts = &rec->opts;
8d3eca20 201 int rc = 0;
dd7927f4 202
f77a9518 203 perf_evlist__config(evlist, opts);
cac21425 204
dd7927f4 205 list_for_each_entry(pos, &evlist->entries, node) {
dd7927f4 206try_again:
6a4bb04c 207 if (perf_evsel__open(pos, evlist->cpus, evlist->threads) < 0) {
56e52e85 208 if (perf_evsel__fallback(pos, errno, msg, sizeof(msg))) {
d6d901c2 209 if (verbose)
c0a54341 210 ui__warning("%s\n", msg);
d6d901c2
ZY
211 goto try_again;
212 }
ca6a4258 213
56e52e85
ACM
214 rc = -errno;
215 perf_evsel__open_strerror(pos, &opts->target,
216 errno, msg, sizeof(msg));
217 ui__error("%s\n", msg);
8d3eca20 218 goto out;
c171b552
LZ
219 }
220 }
a43d3f08 221
1491a632 222 if (perf_evlist__apply_filters(evlist)) {
0a102479
FW
223 error("failed to set filter with %d (%s)\n", errno,
224 strerror(errno));
8d3eca20
DA
225 rc = -1;
226 goto out;
0a102479
FW
227 }
228
18e60939 229 if (perf_evlist__mmap(evlist, opts->mmap_pages, false) < 0) {
8d3eca20
DA
230 if (errno == EPERM) {
231 pr_err("Permission error mapping pages.\n"
232 "Consider increasing "
233 "/proc/sys/kernel/perf_event_mlock_kb,\n"
234 "or try again with a smaller value of -m/--mmap_pages.\n"
235 "(current value: %d)\n", opts->mmap_pages);
236 rc = -errno;
8d3eca20
DA
237 } else {
238 pr_err("failed to mmap with %d (%s)\n", errno, strerror(errno));
239 rc = -errno;
240 }
241 goto out;
18e60939 242 }
0a27d7f9 243
563aecb2 244 session->evlist = evlist;
7b56cce2 245 perf_session__set_id_hdr_size(session);
8d3eca20
DA
246out:
247 return rc;
16c8a109
PZ
248}
249
d20deb64 250static int process_buildids(struct perf_record *rec)
6122e4e4 251{
f5fc1412
JO
252 struct perf_data_file *file = &rec->file;
253 struct perf_session *session = rec->session;
7ab75cff 254 u64 start = session->header.data_offset;
6122e4e4 255
f5fc1412 256 u64 size = lseek(file->fd, 0, SEEK_CUR);
9f591fd7
ACM
257 if (size == 0)
258 return 0;
259
7ab75cff
DA
260 return __perf_session__process_events(session, start,
261 size - start,
6122e4e4
ACM
262 size, &build_id__mark_dso_hit_ops);
263}
264
8d3eca20 265static void perf_record__exit(int status, void *arg)
f5970550 266{
d20deb64 267 struct perf_record *rec = arg;
f5fc1412 268 struct perf_data_file *file = &rec->file;
d20deb64 269
8d3eca20
DA
270 if (status != 0)
271 return;
272
f5fc1412 273 if (!file->is_pipe) {
d20deb64
ACM
274 rec->session->header.data_size += rec->bytes_written;
275
276 if (!rec->no_buildid)
277 process_buildids(rec);
278 perf_session__write_header(rec->session, rec->evlist,
f5fc1412 279 file->fd, true);
d20deb64
ACM
280 perf_session__delete(rec->session);
281 perf_evlist__delete(rec->evlist);
d65a458b 282 symbol__exit();
c7929e47 283 }
f5970550
PZ
284}
285
8115d60c 286static void perf_event__synthesize_guest_os(struct machine *machine, void *data)
a1645ce1
ZY
287{
288 int err;
45694aa7 289 struct perf_tool *tool = data;
a1645ce1
ZY
290 /*
291 *As for guest kernel when processing subcommand record&report,
292 *we arrange module mmap prior to guest kernel mmap and trigger
293 *a preload dso because default guest module symbols are loaded
294 *from guest kallsyms instead of /lib/modules/XXX/XXX. This
295 *method is used to avoid symbol missing when the first addr is
296 *in module instead of in guest kernel.
297 */
45694aa7 298 err = perf_event__synthesize_modules(tool, process_synthesized_event,
743eb868 299 machine);
a1645ce1
ZY
300 if (err < 0)
301 pr_err("Couldn't record guest kernel [%d]'s reference"
23346f21 302 " relocation symbol.\n", machine->pid);
a1645ce1 303
a1645ce1
ZY
304 /*
305 * We use _stext for guest kernel because guest kernel's /proc/kallsyms
306 * have no _text sometimes.
307 */
45694aa7 308 err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
743eb868 309 machine, "_text");
a1645ce1 310 if (err < 0)
45694aa7 311 err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
743eb868 312 machine, "_stext");
a1645ce1
ZY
313 if (err < 0)
314 pr_err("Couldn't record guest kernel [%d]'s reference"
23346f21 315 " relocation symbol.\n", machine->pid);
a1645ce1
ZY
316}
317
98402807
FW
318static struct perf_event_header finished_round_event = {
319 .size = sizeof(struct perf_event_header),
320 .type = PERF_RECORD_FINISHED_ROUND,
321};
322
8d3eca20 323static int perf_record__mmap_read_all(struct perf_record *rec)
98402807 324{
0e2e63dd 325 int i;
8d3eca20 326 int rc = 0;
98402807 327
d20deb64 328 for (i = 0; i < rec->evlist->nr_mmaps; i++) {
8d3eca20
DA
329 if (rec->evlist->mmap[i].base) {
330 if (perf_record__mmap_read(rec, &rec->evlist->mmap[i]) != 0) {
331 rc = -1;
332 goto out;
333 }
334 }
98402807
FW
335 }
336
2eeaaa09 337 if (perf_header__has_feat(&rec->session->header, HEADER_TRACING_DATA))
8d3eca20
DA
338 rc = write_output(rec, &finished_round_event,
339 sizeof(finished_round_event));
340
341out:
342 return rc;
98402807
FW
343}
344
57706abc
DA
345static void perf_record__init_features(struct perf_record *rec)
346{
347 struct perf_evlist *evsel_list = rec->evlist;
348 struct perf_session *session = rec->session;
349 int feat;
350
351 for (feat = HEADER_FIRST_FEATURE; feat < HEADER_LAST_FEATURE; feat++)
352 perf_header__set_feat(&session->header, feat);
353
354 if (rec->no_buildid)
355 perf_header__clear_feat(&session->header, HEADER_BUILD_ID);
356
357 if (!have_tracepoints(&evsel_list->entries))
358 perf_header__clear_feat(&session->header, HEADER_TRACING_DATA);
359
360 if (!rec->opts.branch_stack)
361 perf_header__clear_feat(&session->header, HEADER_BRANCH_STACK);
362}
363
d20deb64 364static int __cmd_record(struct perf_record *rec, int argc, const char **argv)
16c8a109 365{
57706abc 366 int err;
8b412664 367 unsigned long waking = 0;
46be604b 368 const bool forks = argc > 0;
23346f21 369 struct machine *machine;
45694aa7 370 struct perf_tool *tool = &rec->tool;
d20deb64
ACM
371 struct perf_record_opts *opts = &rec->opts;
372 struct perf_evlist *evsel_list = rec->evlist;
f5fc1412 373 struct perf_data_file *file = &rec->file;
d20deb64 374 struct perf_session *session;
2711926a 375 bool disabled = false;
de9ac07b 376
d20deb64 377 rec->progname = argv[0];
33e49ea7 378
d20deb64 379 on_exit(perf_record__sig_exit, rec);
f5970550
PZ
380 signal(SIGCHLD, sig_handler);
381 signal(SIGINT, sig_handler);
18483b81 382 signal(SIGUSR1, sig_handler);
804f7ac7 383 signal(SIGTERM, sig_handler);
f5970550 384
f5fc1412 385 session = perf_session__new(file, false, NULL);
94c744b6 386 if (session == NULL) {
a9a70bbc
ACM
387 pr_err("Not enough memory for reading perf file header\n");
388 return -1;
389 }
390
d20deb64
ACM
391 rec->session = session;
392
57706abc 393 perf_record__init_features(rec);
330aa675 394
d4db3f16 395 if (forks) {
6ef73ec4 396 err = perf_evlist__prepare_workload(evsel_list, &opts->target,
f5fc1412 397 argv, file->is_pipe,
55e162ea 398 true);
35b9d88e
ACM
399 if (err < 0) {
400 pr_err("Couldn't run the workload!\n");
401 goto out_delete_session;
856e9660 402 }
856e9660
PZ
403 }
404
8d3eca20
DA
405 if (perf_record__open(rec) != 0) {
406 err = -1;
407 goto out_delete_session;
408 }
de9ac07b 409
a8bb559b
NK
410 if (!evsel_list->nr_groups)
411 perf_header__clear_feat(&session->header, HEADER_GROUP_DESC);
412
712a4b60 413 /*
d20deb64 414 * perf_session__delete(session) will be called at perf_record__exit()
712a4b60 415 */
d20deb64 416 on_exit(perf_record__exit, rec);
712a4b60 417
f5fc1412
JO
418 if (file->is_pipe) {
419 err = perf_header__write_pipe(file->fd);
529870e3 420 if (err < 0)
8d3eca20 421 goto out_delete_session;
563aecb2 422 } else {
a91e5431 423 err = perf_session__write_header(session, evsel_list,
f5fc1412 424 file->fd, false);
d5eed904 425 if (err < 0)
8d3eca20 426 goto out_delete_session;
56b03f3c
ACM
427 }
428
d3665498 429 if (!rec->no_buildid
e20960c0 430 && !perf_header__has_feat(&session->header, HEADER_BUILD_ID)) {
d3665498 431 pr_err("Couldn't generate buildids. "
e20960c0 432 "Use --no-buildid to profile anyway.\n");
8d3eca20
DA
433 err = -1;
434 goto out_delete_session;
e20960c0
RR
435 }
436
34ba5122 437 machine = &session->machines.host;
743eb868 438
f5fc1412 439 if (file->is_pipe) {
45694aa7 440 err = perf_event__synthesize_attrs(tool, session,
d20deb64 441 process_synthesized_event);
2c46dbb5
TZ
442 if (err < 0) {
443 pr_err("Couldn't synthesize attrs.\n");
8d3eca20 444 goto out_delete_session;
2c46dbb5 445 }
cd19a035 446
361c99a6 447 if (have_tracepoints(&evsel_list->entries)) {
63e0c771
TZ
448 /*
449 * FIXME err <= 0 here actually means that
450 * there were no tracepoints so its not really
451 * an error, just that we don't need to
452 * synthesize anything. We really have to
453 * return this more properly and also
454 * propagate errors that now are calling die()
455 */
f5fc1412 456 err = perf_event__synthesize_tracing_data(tool, file->fd, evsel_list,
743eb868 457 process_synthesized_event);
63e0c771
TZ
458 if (err <= 0) {
459 pr_err("Couldn't record tracing data.\n");
8d3eca20 460 goto out_delete_session;
63e0c771 461 }
f34b9001 462 rec->bytes_written += err;
63e0c771 463 }
2c46dbb5
TZ
464 }
465
45694aa7 466 err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
743eb868 467 machine, "_text");
70162138 468 if (err < 0)
45694aa7 469 err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
743eb868 470 machine, "_stext");
c1a3a4b9
ACM
471 if (err < 0)
472 pr_err("Couldn't record kernel reference relocation symbol\n"
473 "Symbol resolution may be skewed if relocation was used (e.g. kexec).\n"
474 "Check /proc/kallsyms permission or run as root.\n");
b7cece76 475
45694aa7 476 err = perf_event__synthesize_modules(tool, process_synthesized_event,
743eb868 477 machine);
c1a3a4b9
ACM
478 if (err < 0)
479 pr_err("Couldn't record kernel module information.\n"
480 "Symbol resolution may be skewed if relocation was used (e.g. kexec).\n"
481 "Check /proc/modules permission or run as root.\n");
482
7e383de4 483 if (perf_guest) {
876650e6
ACM
484 machines__process_guests(&session->machines,
485 perf_event__synthesize_guest_os, tool);
7e383de4 486 }
7c6a1c65 487
a33fbd56
ACM
488 err = __machine__synthesize_threads(machine, tool, &opts->target, evsel_list->threads,
489 process_synthesized_event, opts->sample_address);
8d3eca20
DA
490 if (err != 0)
491 goto out_delete_session;
492
d20deb64 493 if (rec->realtime_prio) {
de9ac07b
PZ
494 struct sched_param param;
495
d20deb64 496 param.sched_priority = rec->realtime_prio;
de9ac07b 497 if (sched_setscheduler(0, SCHED_FIFO, &param)) {
6beba7ad 498 pr_err("Could not set realtime priority.\n");
8d3eca20
DA
499 err = -1;
500 goto out_delete_session;
de9ac07b
PZ
501 }
502 }
503
774cb499
JO
504 /*
505 * When perf is starting the traced process, all the events
506 * (apart from group members) have enable_on_exec=1 set,
507 * so don't spoil it by prematurely enabling them.
508 */
602ad878 509 if (!target__none(&opts->target))
774cb499 510 perf_evlist__enable(evsel_list);
764e16a3 511
856e9660
PZ
512 /*
513 * Let the child rip
514 */
d4db3f16 515 if (forks)
35b9d88e 516 perf_evlist__start_workload(evsel_list);
856e9660 517
649c48a9 518 for (;;) {
d20deb64 519 int hits = rec->samples;
de9ac07b 520
8d3eca20
DA
521 if (perf_record__mmap_read_all(rec) < 0) {
522 err = -1;
523 goto out_delete_session;
524 }
de9ac07b 525
d20deb64 526 if (hits == rec->samples) {
649c48a9
PZ
527 if (done)
528 break;
5c581041 529 err = poll(evsel_list->pollfd, evsel_list->nr_fds, -1);
8b412664
PZ
530 waking++;
531 }
532
774cb499
JO
533 /*
534 * When perf is starting the traced process, at the end events
535 * die with the process and we wait for that. Thus no need to
536 * disable events in this case.
537 */
602ad878 538 if (done && !disabled && !target__none(&opts->target)) {
4152ab37 539 perf_evlist__disable(evsel_list);
2711926a
JO
540 disabled = true;
541 }
de9ac07b
PZ
542 }
543
18483b81 544 if (quiet || signr == SIGUSR1)
b44308f5
ACM
545 return 0;
546
8b412664
PZ
547 fprintf(stderr, "[ perf record: Woken up %ld times to write data ]\n", waking);
548
021e9f47
IM
549 /*
550 * Approximate RIP event size: 24 bytes.
551 */
552 fprintf(stderr,
9486aa38 553 "[ perf record: Captured and wrote %.3f MB %s (~%" PRIu64 " samples) ]\n",
d20deb64 554 (double)rec->bytes_written / 1024.0 / 1024.0,
6a4d98d7 555 file->path,
d20deb64 556 rec->bytes_written / 24);
addc2785 557
de9ac07b 558 return 0;
39d17dac
ACM
559
560out_delete_session:
561 perf_session__delete(session);
562 return err;
de9ac07b 563}
0e9b20b8 564
bdfebd84
RAV
565#define BRANCH_OPT(n, m) \
566 { .name = n, .mode = (m) }
567
568#define BRANCH_END { .name = NULL }
569
570struct branch_mode {
571 const char *name;
572 int mode;
573};
574
575static const struct branch_mode branch_modes[] = {
576 BRANCH_OPT("u", PERF_SAMPLE_BRANCH_USER),
577 BRANCH_OPT("k", PERF_SAMPLE_BRANCH_KERNEL),
578 BRANCH_OPT("hv", PERF_SAMPLE_BRANCH_HV),
579 BRANCH_OPT("any", PERF_SAMPLE_BRANCH_ANY),
580 BRANCH_OPT("any_call", PERF_SAMPLE_BRANCH_ANY_CALL),
581 BRANCH_OPT("any_ret", PERF_SAMPLE_BRANCH_ANY_RETURN),
582 BRANCH_OPT("ind_call", PERF_SAMPLE_BRANCH_IND_CALL),
0126d493
AK
583 BRANCH_OPT("abort_tx", PERF_SAMPLE_BRANCH_ABORT_TX),
584 BRANCH_OPT("in_tx", PERF_SAMPLE_BRANCH_IN_TX),
585 BRANCH_OPT("no_tx", PERF_SAMPLE_BRANCH_NO_TX),
bdfebd84
RAV
586 BRANCH_END
587};
588
589static int
a5aabdac 590parse_branch_stack(const struct option *opt, const char *str, int unset)
bdfebd84
RAV
591{
592#define ONLY_PLM \
593 (PERF_SAMPLE_BRANCH_USER |\
594 PERF_SAMPLE_BRANCH_KERNEL |\
595 PERF_SAMPLE_BRANCH_HV)
596
597 uint64_t *mode = (uint64_t *)opt->value;
598 const struct branch_mode *br;
a5aabdac 599 char *s, *os = NULL, *p;
bdfebd84
RAV
600 int ret = -1;
601
a5aabdac
SE
602 if (unset)
603 return 0;
bdfebd84 604
a5aabdac
SE
605 /*
606 * cannot set it twice, -b + --branch-filter for instance
607 */
608 if (*mode)
bdfebd84
RAV
609 return -1;
610
a5aabdac
SE
611 /* str may be NULL in case no arg is passed to -b */
612 if (str) {
613 /* because str is read-only */
614 s = os = strdup(str);
615 if (!s)
616 return -1;
617
618 for (;;) {
619 p = strchr(s, ',');
620 if (p)
621 *p = '\0';
622
623 for (br = branch_modes; br->name; br++) {
624 if (!strcasecmp(s, br->name))
625 break;
626 }
627 if (!br->name) {
628 ui__warning("unknown branch filter %s,"
629 " check man page\n", s);
630 goto error;
631 }
bdfebd84 632
a5aabdac 633 *mode |= br->mode;
bdfebd84 634
a5aabdac
SE
635 if (!p)
636 break;
bdfebd84 637
a5aabdac
SE
638 s = p + 1;
639 }
bdfebd84
RAV
640 }
641 ret = 0;
642
a5aabdac 643 /* default to any branch */
bdfebd84 644 if ((*mode & ~ONLY_PLM) == 0) {
a5aabdac 645 *mode = PERF_SAMPLE_BRANCH_ANY;
bdfebd84
RAV
646 }
647error:
648 free(os);
649 return ret;
650}
651
89fe808a 652#ifdef HAVE_LIBUNWIND_SUPPORT
26d33022
JO
653static int get_stack_size(char *str, unsigned long *_size)
654{
655 char *endptr;
656 unsigned long size;
657 unsigned long max_size = round_down(USHRT_MAX, sizeof(u64));
658
659 size = strtoul(str, &endptr, 0);
660
661 do {
662 if (*endptr)
663 break;
664
665 size = round_up(size, sizeof(u64));
666 if (!size || size > max_size)
667 break;
668
669 *_size = size;
670 return 0;
671
672 } while (0);
673
674 pr_err("callchain: Incorrect stack dump size (max %ld): %s\n",
675 max_size, str);
676 return -1;
677}
89fe808a 678#endif /* HAVE_LIBUNWIND_SUPPORT */
26d33022 679
09b0fd45 680int record_parse_callchain(const char *arg, struct perf_record_opts *opts)
26d33022 681{
26d33022
JO
682 char *tok, *name, *saveptr = NULL;
683 char *buf;
684 int ret = -1;
685
26d33022
JO
686 /* We need buffer that we know we can write to. */
687 buf = malloc(strlen(arg) + 1);
688 if (!buf)
689 return -ENOMEM;
690
691 strcpy(buf, arg);
692
693 tok = strtok_r((char *)buf, ",", &saveptr);
694 name = tok ? : (char *)buf;
695
696 do {
697 /* Framepointer style */
698 if (!strncmp(name, "fp", sizeof("fp"))) {
699 if (!strtok_r(NULL, ",", &saveptr)) {
c5ff78c3 700 opts->call_graph = CALLCHAIN_FP;
26d33022
JO
701 ret = 0;
702 } else
703 pr_err("callchain: No more arguments "
704 "needed for -g fp\n");
705 break;
706
89fe808a 707#ifdef HAVE_LIBUNWIND_SUPPORT
26d33022
JO
708 /* Dwarf style */
709 } else if (!strncmp(name, "dwarf", sizeof("dwarf"))) {
61eaa3be
ACM
710 const unsigned long default_stack_dump_size = 8192;
711
26d33022 712 ret = 0;
c5ff78c3
ACM
713 opts->call_graph = CALLCHAIN_DWARF;
714 opts->stack_dump_size = default_stack_dump_size;
26d33022
JO
715
716 tok = strtok_r(NULL, ",", &saveptr);
717 if (tok) {
718 unsigned long size = 0;
719
720 ret = get_stack_size(tok, &size);
c5ff78c3 721 opts->stack_dump_size = size;
26d33022 722 }
89fe808a 723#endif /* HAVE_LIBUNWIND_SUPPORT */
26d33022 724 } else {
09b0fd45 725 pr_err("callchain: Unknown --call-graph option "
26d33022
JO
726 "value: %s\n", arg);
727 break;
728 }
729
730 } while (0);
731
732 free(buf);
09b0fd45
JO
733 return ret;
734}
735
736static void callchain_debug(struct perf_record_opts *opts)
737{
738 pr_debug("callchain: type %d\n", opts->call_graph);
26d33022 739
09b0fd45
JO
740 if (opts->call_graph == CALLCHAIN_DWARF)
741 pr_debug("callchain: stack dump size %d\n",
742 opts->stack_dump_size);
743}
744
745int record_parse_callchain_opt(const struct option *opt,
746 const char *arg,
747 int unset)
748{
749 struct perf_record_opts *opts = opt->value;
750 int ret;
751
752 /* --no-call-graph */
753 if (unset) {
754 opts->call_graph = CALLCHAIN_NONE;
755 pr_debug("callchain: disabled\n");
756 return 0;
757 }
758
759 ret = record_parse_callchain(arg, opts);
26d33022 760 if (!ret)
09b0fd45 761 callchain_debug(opts);
26d33022
JO
762
763 return ret;
764}
765
09b0fd45
JO
766int record_callchain_opt(const struct option *opt,
767 const char *arg __maybe_unused,
768 int unset __maybe_unused)
769{
770 struct perf_record_opts *opts = opt->value;
771
772 if (opts->call_graph == CALLCHAIN_NONE)
773 opts->call_graph = CALLCHAIN_FP;
774
775 callchain_debug(opts);
776 return 0;
777}
778
0e9b20b8 779static const char * const record_usage[] = {
9e096753
MG
780 "perf record [<options>] [<command>]",
781 "perf record [<options>] -- <command> [<options>]",
0e9b20b8
IM
782 NULL
783};
784
d20deb64
ACM
785/*
786 * XXX Ideally would be local to cmd_record() and passed to a perf_record__new
787 * because we need to have access to it in perf_record__exit, that is called
788 * after cmd_record() exits, but since record_options need to be accessible to
789 * builtin-script, leave it here.
790 *
791 * At least we don't ouch it in all the other functions here directly.
792 *
793 * Just say no to tons of global variables, sigh.
794 */
795static struct perf_record record = {
796 .opts = {
d20deb64
ACM
797 .mmap_pages = UINT_MAX,
798 .user_freq = UINT_MAX,
799 .user_interval = ULLONG_MAX,
447a6013 800 .freq = 4000,
d1cb9fce
NK
801 .target = {
802 .uses_mmap = true,
3aa5939d 803 .default_per_cpu = true,
d1cb9fce 804 },
d20deb64 805 },
d20deb64 806};
7865e817 807
09b0fd45 808#define CALLCHAIN_HELP "setup and enables call-graph (stack chain/backtrace) recording: "
61eaa3be 809
89fe808a 810#ifdef HAVE_LIBUNWIND_SUPPORT
09b0fd45 811const char record_callchain_help[] = CALLCHAIN_HELP "fp dwarf";
61eaa3be 812#else
09b0fd45 813const char record_callchain_help[] = CALLCHAIN_HELP "fp";
61eaa3be
ACM
814#endif
815
d20deb64
ACM
816/*
817 * XXX Will stay a global variable till we fix builtin-script.c to stop messing
818 * with it and switch to use the library functions in perf_evlist that came
819 * from builtin-record.c, i.e. use perf_record_opts,
820 * perf_evlist__prepare_workload, etc instead of fork+exec'in 'perf record',
821 * using pipes, etc.
822 */
bca647aa 823const struct option record_options[] = {
d20deb64 824 OPT_CALLBACK('e', "event", &record.evlist, "event",
86847b62 825 "event selector. use 'perf list' to list available events",
f120f9d5 826 parse_events_option),
d20deb64 827 OPT_CALLBACK(0, "filter", &record.evlist, "filter",
c171b552 828 "event filter", parse_filter),
bea03405 829 OPT_STRING('p', "pid", &record.opts.target.pid, "pid",
d6d901c2 830 "record events on existing process id"),
bea03405 831 OPT_STRING('t', "tid", &record.opts.target.tid, "tid",
d6d901c2 832 "record events on existing thread id"),
d20deb64 833 OPT_INTEGER('r', "realtime", &record.realtime_prio,
0e9b20b8 834 "collect data with this RT SCHED_FIFO priority"),
d20deb64 835 OPT_BOOLEAN('D', "no-delay", &record.opts.no_delay,
acac03fa 836 "collect data without buffering"),
d20deb64 837 OPT_BOOLEAN('R', "raw-samples", &record.opts.raw_samples,
daac07b2 838 "collect raw sample records from all opened counters"),
bea03405 839 OPT_BOOLEAN('a', "all-cpus", &record.opts.target.system_wide,
0e9b20b8 840 "system-wide collection from all CPUs"),
bea03405 841 OPT_STRING('C', "cpu", &record.opts.target.cpu_list, "cpu",
c45c6ea2 842 "list of cpus to monitor"),
d20deb64 843 OPT_U64('c', "count", &record.opts.user_interval, "event period to sample"),
f5fc1412 844 OPT_STRING('o', "output", &record.file.path, "file",
abaff32a 845 "output file name"),
d20deb64 846 OPT_BOOLEAN('i', "no-inherit", &record.opts.no_inherit,
2e6cdf99 847 "child tasks do not inherit counters"),
d20deb64 848 OPT_UINTEGER('F', "freq", &record.opts.user_freq, "profile at this frequency"),
994a1f78
JO
849 OPT_CALLBACK('m', "mmap-pages", &record.opts.mmap_pages, "pages",
850 "number of mmap data pages",
851 perf_evlist__parse_mmap_pages),
d20deb64 852 OPT_BOOLEAN(0, "group", &record.opts.group,
43bece79 853 "put the counters into a counter group"),
09b0fd45
JO
854 OPT_CALLBACK_NOOPT('g', NULL, &record.opts,
855 NULL, "enables call-graph recording" ,
856 &record_callchain_opt),
857 OPT_CALLBACK(0, "call-graph", &record.opts,
858 "mode[,dump_size]", record_callchain_help,
859 &record_parse_callchain_opt),
c0555642 860 OPT_INCR('v', "verbose", &verbose,
3da297a6 861 "be more verbose (show counter open errors, etc)"),
b44308f5 862 OPT_BOOLEAN('q', "quiet", &quiet, "don't print any message"),
d20deb64 863 OPT_BOOLEAN('s', "stat", &record.opts.inherit_stat,
649c48a9 864 "per thread counts"),
d20deb64 865 OPT_BOOLEAN('d', "data", &record.opts.sample_address,
4bba828d 866 "Sample addresses"),
d20deb64 867 OPT_BOOLEAN('T', "timestamp", &record.opts.sample_time, "Sample timestamps"),
3e76ac78 868 OPT_BOOLEAN('P', "period", &record.opts.period, "Sample period"),
d20deb64 869 OPT_BOOLEAN('n', "no-samples", &record.opts.no_samples,
649c48a9 870 "don't sample"),
d20deb64 871 OPT_BOOLEAN('N', "no-buildid-cache", &record.no_buildid_cache,
a1ac1d3c 872 "do not update the buildid cache"),
d20deb64 873 OPT_BOOLEAN('B', "no-buildid", &record.no_buildid,
baa2f6ce 874 "do not collect buildids in perf.data"),
d20deb64 875 OPT_CALLBACK('G', "cgroup", &record.evlist, "name",
023695d9
SE
876 "monitor event in cgroup name only",
877 parse_cgroups),
bea03405
NK
878 OPT_STRING('u', "uid", &record.opts.target.uid_str, "user",
879 "user to profile"),
a5aabdac
SE
880
881 OPT_CALLBACK_NOOPT('b', "branch-any", &record.opts.branch_stack,
882 "branch any", "sample any taken branches",
883 parse_branch_stack),
884
885 OPT_CALLBACK('j', "branch-filter", &record.opts.branch_stack,
886 "branch filter mask", "branch stack filter modes",
bdfebd84 887 parse_branch_stack),
05484298
AK
888 OPT_BOOLEAN('W', "weight", &record.opts.sample_weight,
889 "sample by weight (on special events only)"),
475eeab9
AK
890 OPT_BOOLEAN(0, "transaction", &record.opts.sample_transaction,
891 "sample transaction flags (special events only)"),
3aa5939d
AH
892 OPT_BOOLEAN(0, "per-thread", &record.opts.target.per_thread,
893 "use per-thread mmaps"),
0e9b20b8
IM
894 OPT_END()
895};
896
1d037ca1 897int cmd_record(int argc, const char **argv, const char *prefix __maybe_unused)
0e9b20b8 898{
69aad6f1 899 int err = -ENOMEM;
d20deb64
ACM
900 struct perf_evlist *evsel_list;
901 struct perf_record *rec = &record;
16ad2ffb 902 char errbuf[BUFSIZ];
0e9b20b8 903
334fe7a3 904 evsel_list = perf_evlist__new();
361c99a6
ACM
905 if (evsel_list == NULL)
906 return -ENOMEM;
907
d20deb64
ACM
908 rec->evlist = evsel_list;
909
bca647aa 910 argc = parse_options(argc, argv, record_options, record_usage,
655000e7 911 PARSE_OPT_STOP_AT_NON_OPTION);
602ad878 912 if (!argc && target__none(&rec->opts.target))
bca647aa 913 usage_with_options(record_usage, record_options);
0e9b20b8 914
bea03405 915 if (nr_cgroups && !rec->opts.target.system_wide) {
3780f488
NK
916 ui__error("cgroup monitoring only available in"
917 " system-wide mode\n");
023695d9
SE
918 usage_with_options(record_usage, record_options);
919 }
920
655000e7 921 symbol__init();
baa2f6ce 922
ec80fde7 923 if (symbol_conf.kptr_restrict)
646aaea6
ACM
924 pr_warning(
925"WARNING: Kernel address maps (/proc/{kallsyms,modules}) are restricted,\n"
926"check /proc/sys/kernel/kptr_restrict.\n\n"
927"Samples in kernel functions may not be resolved if a suitable vmlinux\n"
928"file is not found in the buildid cache or in the vmlinux path.\n\n"
929"Samples in kernel modules won't be resolved at all.\n\n"
930"If some relocation was applied (e.g. kexec) symbols may be misresolved\n"
931"even with a suitable vmlinux or kallsyms file.\n\n");
ec80fde7 932
d20deb64 933 if (rec->no_buildid_cache || rec->no_buildid)
a1ac1d3c 934 disable_buildid_cache();
655000e7 935
361c99a6
ACM
936 if (evsel_list->nr_entries == 0 &&
937 perf_evlist__add_default(evsel_list) < 0) {
69aad6f1
ACM
938 pr_err("Not enough memory for event selector list\n");
939 goto out_symbol_exit;
bbd36e5e 940 }
0e9b20b8 941
602ad878 942 err = target__validate(&rec->opts.target);
16ad2ffb 943 if (err) {
602ad878 944 target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
16ad2ffb
NK
945 ui__warning("%s", errbuf);
946 }
947
602ad878 948 err = target__parse_uid(&rec->opts.target);
16ad2ffb
NK
949 if (err) {
950 int saved_errno = errno;
4bd0f2d2 951
602ad878 952 target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
3780f488 953 ui__error("%s", errbuf);
16ad2ffb
NK
954
955 err = -saved_errno;
8fa60e1f 956 goto out_symbol_exit;
16ad2ffb 957 }
0d37aa34 958
16ad2ffb 959 err = -ENOMEM;
b809ac10 960 if (perf_evlist__create_maps(evsel_list, &rec->opts.target) < 0)
dd7927f4 961 usage_with_options(record_usage, record_options);
69aad6f1 962
714647bd 963 if (perf_record_opts__config(&rec->opts)) {
39d17dac 964 err = -EINVAL;
5c581041 965 goto out_free_fd;
7e4ff9e3
MG
966 }
967
d20deb64 968 err = __cmd_record(&record, argc, argv);
8fa60e1f
NK
969
970 perf_evlist__munmap(evsel_list);
971 perf_evlist__close(evsel_list);
39d17dac 972out_free_fd:
7e2ed097 973 perf_evlist__delete_maps(evsel_list);
d65a458b
ACM
974out_symbol_exit:
975 symbol__exit();
39d17dac 976 return err;
0e9b20b8 977}