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