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