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