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