perf machine: Set up ref_reloc_sym in machine__create_kernel_maps()
[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
0050f7aa 186 evlist__for_each(evlist, pos) {
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 326{
57706abc
DA
327 struct perf_session *session = rec->session;
328 int feat;
329
330 for (feat = HEADER_FIRST_FEATURE; feat < HEADER_LAST_FEATURE; feat++)
331 perf_header__set_feat(&session->header, feat);
332
333 if (rec->no_buildid)
334 perf_header__clear_feat(&session->header, HEADER_BUILD_ID);
335
3e2be2da 336 if (!have_tracepoints(&rec->evlist->entries))
57706abc
DA
337 perf_header__clear_feat(&session->header, HEADER_TRACING_DATA);
338
339 if (!rec->opts.branch_stack)
340 perf_header__clear_feat(&session->header, HEADER_BRANCH_STACK);
341}
342
f33cbe72
ACM
343static volatile int workload_exec_errno;
344
345/*
346 * perf_evlist__prepare_workload will send a SIGUSR1
347 * if the fork fails, since we asked by setting its
348 * want_signal to true.
349 */
350static void workload_exec_failed_signal(int signo, siginfo_t *info,
351 void *ucontext __maybe_unused)
352{
353 workload_exec_errno = info->si_value.sival_int;
354 done = 1;
355 signr = signo;
356 child_finished = 1;
357}
358
8c6f45a7 359static int __cmd_record(struct record *rec, int argc, const char **argv)
16c8a109 360{
57706abc 361 int err;
8b412664 362 unsigned long waking = 0;
46be604b 363 const bool forks = argc > 0;
23346f21 364 struct machine *machine;
45694aa7 365 struct perf_tool *tool = &rec->tool;
b4006796 366 struct record_opts *opts = &rec->opts;
f5fc1412 367 struct perf_data_file *file = &rec->file;
d20deb64 368 struct perf_session *session;
2711926a 369 bool disabled = false;
de9ac07b 370
d20deb64 371 rec->progname = argv[0];
33e49ea7 372
8c6f45a7 373 on_exit(record__sig_exit, rec);
f5970550
PZ
374 signal(SIGCHLD, sig_handler);
375 signal(SIGINT, sig_handler);
804f7ac7 376 signal(SIGTERM, sig_handler);
f5970550 377
f5fc1412 378 session = perf_session__new(file, false, NULL);
94c744b6 379 if (session == NULL) {
a9a70bbc
ACM
380 pr_err("Not enough memory for reading perf file header\n");
381 return -1;
382 }
383
d20deb64
ACM
384 rec->session = session;
385
8c6f45a7 386 record__init_features(rec);
330aa675 387
d4db3f16 388 if (forks) {
3e2be2da 389 err = perf_evlist__prepare_workload(rec->evlist, &opts->target,
f5fc1412 390 argv, file->is_pipe,
735f7e0b 391 workload_exec_failed_signal);
35b9d88e
ACM
392 if (err < 0) {
393 pr_err("Couldn't run the workload!\n");
394 goto out_delete_session;
856e9660 395 }
856e9660
PZ
396 }
397
8c6f45a7 398 if (record__open(rec) != 0) {
8d3eca20
DA
399 err = -1;
400 goto out_delete_session;
401 }
de9ac07b 402
3e2be2da 403 if (!rec->evlist->nr_groups)
a8bb559b
NK
404 perf_header__clear_feat(&session->header, HEADER_GROUP_DESC);
405
712a4b60 406 /*
8c6f45a7 407 * perf_session__delete(session) will be called at record__exit()
712a4b60 408 */
8c6f45a7 409 on_exit(record__exit, rec);
712a4b60 410
f5fc1412
JO
411 if (file->is_pipe) {
412 err = perf_header__write_pipe(file->fd);
529870e3 413 if (err < 0)
8d3eca20 414 goto out_delete_session;
563aecb2 415 } else {
3e2be2da 416 err = perf_session__write_header(session, rec->evlist,
f5fc1412 417 file->fd, false);
d5eed904 418 if (err < 0)
8d3eca20 419 goto out_delete_session;
56b03f3c
ACM
420 }
421
d3665498 422 if (!rec->no_buildid
e20960c0 423 && !perf_header__has_feat(&session->header, HEADER_BUILD_ID)) {
d3665498 424 pr_err("Couldn't generate buildids. "
e20960c0 425 "Use --no-buildid to profile anyway.\n");
8d3eca20
DA
426 err = -1;
427 goto out_delete_session;
e20960c0
RR
428 }
429
34ba5122 430 machine = &session->machines.host;
743eb868 431
f5fc1412 432 if (file->is_pipe) {
45694aa7 433 err = perf_event__synthesize_attrs(tool, session,
d20deb64 434 process_synthesized_event);
2c46dbb5
TZ
435 if (err < 0) {
436 pr_err("Couldn't synthesize attrs.\n");
8d3eca20 437 goto out_delete_session;
2c46dbb5 438 }
cd19a035 439
3e2be2da 440 if (have_tracepoints(&rec->evlist->entries)) {
63e0c771
TZ
441 /*
442 * FIXME err <= 0 here actually means that
443 * there were no tracepoints so its not really
444 * an error, just that we don't need to
445 * synthesize anything. We really have to
446 * return this more properly and also
447 * propagate errors that now are calling die()
448 */
3e2be2da 449 err = perf_event__synthesize_tracing_data(tool, file->fd, rec->evlist,
743eb868 450 process_synthesized_event);
63e0c771
TZ
451 if (err <= 0) {
452 pr_err("Couldn't record tracing data.\n");
8d3eca20 453 goto out_delete_session;
63e0c771 454 }
f34b9001 455 rec->bytes_written += err;
63e0c771 456 }
2c46dbb5
TZ
457 }
458
45694aa7 459 err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
743eb868 460 machine, "_text");
70162138 461 if (err < 0)
45694aa7 462 err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
743eb868 463 machine, "_stext");
c1a3a4b9
ACM
464 if (err < 0)
465 pr_err("Couldn't record kernel reference relocation symbol\n"
466 "Symbol resolution may be skewed if relocation was used (e.g. kexec).\n"
467 "Check /proc/kallsyms permission or run as root.\n");
b7cece76 468
45694aa7 469 err = perf_event__synthesize_modules(tool, process_synthesized_event,
743eb868 470 machine);
c1a3a4b9
ACM
471 if (err < 0)
472 pr_err("Couldn't record kernel module information.\n"
473 "Symbol resolution may be skewed if relocation was used (e.g. kexec).\n"
474 "Check /proc/modules permission or run as root.\n");
475
7e383de4 476 if (perf_guest) {
876650e6
ACM
477 machines__process_guests(&session->machines,
478 perf_event__synthesize_guest_os, tool);
7e383de4 479 }
7c6a1c65 480
3e2be2da 481 err = __machine__synthesize_threads(machine, tool, &opts->target, rec->evlist->threads,
a33fbd56 482 process_synthesized_event, opts->sample_address);
8d3eca20
DA
483 if (err != 0)
484 goto out_delete_session;
485
d20deb64 486 if (rec->realtime_prio) {
de9ac07b
PZ
487 struct sched_param param;
488
d20deb64 489 param.sched_priority = rec->realtime_prio;
de9ac07b 490 if (sched_setscheduler(0, SCHED_FIFO, &param)) {
6beba7ad 491 pr_err("Could not set realtime priority.\n");
8d3eca20
DA
492 err = -1;
493 goto out_delete_session;
de9ac07b
PZ
494 }
495 }
496
774cb499
JO
497 /*
498 * When perf is starting the traced process, all the events
499 * (apart from group members) have enable_on_exec=1 set,
500 * so don't spoil it by prematurely enabling them.
501 */
6619a53e 502 if (!target__none(&opts->target) && !opts->initial_delay)
3e2be2da 503 perf_evlist__enable(rec->evlist);
764e16a3 504
856e9660
PZ
505 /*
506 * Let the child rip
507 */
735f7e0b 508 if (forks)
3e2be2da 509 perf_evlist__start_workload(rec->evlist);
856e9660 510
6619a53e
AK
511 if (opts->initial_delay) {
512 usleep(opts->initial_delay * 1000);
513 perf_evlist__enable(rec->evlist);
514 }
515
649c48a9 516 for (;;) {
d20deb64 517 int hits = rec->samples;
de9ac07b 518
8c6f45a7 519 if (record__mmap_read_all(rec) < 0) {
8d3eca20
DA
520 err = -1;
521 goto out_delete_session;
522 }
de9ac07b 523
d20deb64 524 if (hits == rec->samples) {
649c48a9
PZ
525 if (done)
526 break;
3e2be2da 527 err = poll(rec->evlist->pollfd, rec->evlist->nr_fds, -1);
8b412664
PZ
528 waking++;
529 }
530
774cb499
JO
531 /*
532 * When perf is starting the traced process, at the end events
533 * die with the process and we wait for that. Thus no need to
534 * disable events in this case.
535 */
602ad878 536 if (done && !disabled && !target__none(&opts->target)) {
3e2be2da 537 perf_evlist__disable(rec->evlist);
2711926a
JO
538 disabled = true;
539 }
de9ac07b
PZ
540 }
541
f33cbe72
ACM
542 if (forks && workload_exec_errno) {
543 char msg[512];
544 const char *emsg = strerror_r(workload_exec_errno, msg, sizeof(msg));
545 pr_err("Workload failed: %s\n", emsg);
546 err = -1;
547 goto out_delete_session;
548 }
549
18483b81 550 if (quiet || signr == SIGUSR1)
b44308f5
ACM
551 return 0;
552
8b412664
PZ
553 fprintf(stderr, "[ perf record: Woken up %ld times to write data ]\n", waking);
554
021e9f47
IM
555 /*
556 * Approximate RIP event size: 24 bytes.
557 */
558 fprintf(stderr,
9486aa38 559 "[ perf record: Captured and wrote %.3f MB %s (~%" PRIu64 " samples) ]\n",
d20deb64 560 (double)rec->bytes_written / 1024.0 / 1024.0,
6a4d98d7 561 file->path,
d20deb64 562 rec->bytes_written / 24);
addc2785 563
de9ac07b 564 return 0;
39d17dac
ACM
565
566out_delete_session:
567 perf_session__delete(session);
568 return err;
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),
bdfebd84
RAV
592 BRANCH_END
593};
594
595static int
a5aabdac 596parse_branch_stack(const struct option *opt, const char *str, int unset)
bdfebd84
RAV
597{
598#define ONLY_PLM \
599 (PERF_SAMPLE_BRANCH_USER |\
600 PERF_SAMPLE_BRANCH_KERNEL |\
601 PERF_SAMPLE_BRANCH_HV)
602
603 uint64_t *mode = (uint64_t *)opt->value;
604 const struct branch_mode *br;
a5aabdac 605 char *s, *os = NULL, *p;
bdfebd84
RAV
606 int ret = -1;
607
a5aabdac
SE
608 if (unset)
609 return 0;
bdfebd84 610
a5aabdac
SE
611 /*
612 * cannot set it twice, -b + --branch-filter for instance
613 */
614 if (*mode)
bdfebd84
RAV
615 return -1;
616
a5aabdac
SE
617 /* str may be NULL in case no arg is passed to -b */
618 if (str) {
619 /* because str is read-only */
620 s = os = strdup(str);
621 if (!s)
622 return -1;
623
624 for (;;) {
625 p = strchr(s, ',');
626 if (p)
627 *p = '\0';
628
629 for (br = branch_modes; br->name; br++) {
630 if (!strcasecmp(s, br->name))
631 break;
632 }
633 if (!br->name) {
634 ui__warning("unknown branch filter %s,"
635 " check man page\n", s);
636 goto error;
637 }
bdfebd84 638
a5aabdac 639 *mode |= br->mode;
bdfebd84 640
a5aabdac
SE
641 if (!p)
642 break;
bdfebd84 643
a5aabdac
SE
644 s = p + 1;
645 }
bdfebd84
RAV
646 }
647 ret = 0;
648
a5aabdac 649 /* default to any branch */
bdfebd84 650 if ((*mode & ~ONLY_PLM) == 0) {
a5aabdac 651 *mode = PERF_SAMPLE_BRANCH_ANY;
bdfebd84
RAV
652 }
653error:
654 free(os);
655 return ret;
656}
657
89fe808a 658#ifdef HAVE_LIBUNWIND_SUPPORT
26d33022
JO
659static int get_stack_size(char *str, unsigned long *_size)
660{
661 char *endptr;
662 unsigned long size;
663 unsigned long max_size = round_down(USHRT_MAX, sizeof(u64));
664
665 size = strtoul(str, &endptr, 0);
666
667 do {
668 if (*endptr)
669 break;
670
671 size = round_up(size, sizeof(u64));
672 if (!size || size > max_size)
673 break;
674
675 *_size = size;
676 return 0;
677
678 } while (0);
679
680 pr_err("callchain: Incorrect stack dump size (max %ld): %s\n",
681 max_size, str);
682 return -1;
683}
89fe808a 684#endif /* HAVE_LIBUNWIND_SUPPORT */
26d33022 685
b4006796 686int record_parse_callchain(const char *arg, struct record_opts *opts)
26d33022 687{
26d33022
JO
688 char *tok, *name, *saveptr = NULL;
689 char *buf;
690 int ret = -1;
691
26d33022
JO
692 /* We need buffer that we know we can write to. */
693 buf = malloc(strlen(arg) + 1);
694 if (!buf)
695 return -ENOMEM;
696
697 strcpy(buf, arg);
698
699 tok = strtok_r((char *)buf, ",", &saveptr);
700 name = tok ? : (char *)buf;
701
702 do {
703 /* Framepointer style */
704 if (!strncmp(name, "fp", sizeof("fp"))) {
705 if (!strtok_r(NULL, ",", &saveptr)) {
c5ff78c3 706 opts->call_graph = CALLCHAIN_FP;
26d33022
JO
707 ret = 0;
708 } else
709 pr_err("callchain: No more arguments "
710 "needed for -g fp\n");
711 break;
712
89fe808a 713#ifdef HAVE_LIBUNWIND_SUPPORT
26d33022
JO
714 /* Dwarf style */
715 } else if (!strncmp(name, "dwarf", sizeof("dwarf"))) {
61eaa3be
ACM
716 const unsigned long default_stack_dump_size = 8192;
717
26d33022 718 ret = 0;
c5ff78c3
ACM
719 opts->call_graph = CALLCHAIN_DWARF;
720 opts->stack_dump_size = default_stack_dump_size;
26d33022
JO
721
722 tok = strtok_r(NULL, ",", &saveptr);
723 if (tok) {
724 unsigned long size = 0;
725
726 ret = get_stack_size(tok, &size);
c5ff78c3 727 opts->stack_dump_size = size;
26d33022 728 }
89fe808a 729#endif /* HAVE_LIBUNWIND_SUPPORT */
26d33022 730 } else {
09b0fd45 731 pr_err("callchain: Unknown --call-graph option "
26d33022
JO
732 "value: %s\n", arg);
733 break;
734 }
735
736 } while (0);
737
738 free(buf);
09b0fd45
JO
739 return ret;
740}
741
b4006796 742static void callchain_debug(struct record_opts *opts)
09b0fd45
JO
743{
744 pr_debug("callchain: type %d\n", opts->call_graph);
26d33022 745
09b0fd45
JO
746 if (opts->call_graph == CALLCHAIN_DWARF)
747 pr_debug("callchain: stack dump size %d\n",
748 opts->stack_dump_size);
749}
750
751int record_parse_callchain_opt(const struct option *opt,
752 const char *arg,
753 int unset)
754{
b4006796 755 struct record_opts *opts = opt->value;
09b0fd45
JO
756 int ret;
757
758 /* --no-call-graph */
759 if (unset) {
760 opts->call_graph = CALLCHAIN_NONE;
761 pr_debug("callchain: disabled\n");
762 return 0;
763 }
764
765 ret = record_parse_callchain(arg, opts);
26d33022 766 if (!ret)
09b0fd45 767 callchain_debug(opts);
26d33022
JO
768
769 return ret;
770}
771
09b0fd45
JO
772int record_callchain_opt(const struct option *opt,
773 const char *arg __maybe_unused,
774 int unset __maybe_unused)
775{
b4006796 776 struct record_opts *opts = opt->value;
09b0fd45
JO
777
778 if (opts->call_graph == CALLCHAIN_NONE)
779 opts->call_graph = CALLCHAIN_FP;
780
781 callchain_debug(opts);
782 return 0;
783}
784
0e9b20b8 785static const char * const record_usage[] = {
9e096753
MG
786 "perf record [<options>] [<command>]",
787 "perf record [<options>] -- <command> [<options>]",
0e9b20b8
IM
788 NULL
789};
790
d20deb64 791/*
8c6f45a7
ACM
792 * XXX Ideally would be local to cmd_record() and passed to a record__new
793 * because we need to have access to it in record__exit, that is called
d20deb64
ACM
794 * after cmd_record() exits, but since record_options need to be accessible to
795 * builtin-script, leave it here.
796 *
797 * At least we don't ouch it in all the other functions here directly.
798 *
799 * Just say no to tons of global variables, sigh.
800 */
8c6f45a7 801static struct record record = {
d20deb64 802 .opts = {
d20deb64
ACM
803 .mmap_pages = UINT_MAX,
804 .user_freq = UINT_MAX,
805 .user_interval = ULLONG_MAX,
447a6013 806 .freq = 4000,
d1cb9fce
NK
807 .target = {
808 .uses_mmap = true,
3aa5939d 809 .default_per_cpu = true,
d1cb9fce 810 },
d20deb64 811 },
d20deb64 812};
7865e817 813
09b0fd45 814#define CALLCHAIN_HELP "setup and enables call-graph (stack chain/backtrace) recording: "
61eaa3be 815
89fe808a 816#ifdef HAVE_LIBUNWIND_SUPPORT
09b0fd45 817const char record_callchain_help[] = CALLCHAIN_HELP "fp dwarf";
61eaa3be 818#else
09b0fd45 819const char record_callchain_help[] = CALLCHAIN_HELP "fp";
61eaa3be
ACM
820#endif
821
d20deb64
ACM
822/*
823 * XXX Will stay a global variable till we fix builtin-script.c to stop messing
824 * with it and switch to use the library functions in perf_evlist that came
b4006796 825 * from builtin-record.c, i.e. use record_opts,
d20deb64
ACM
826 * perf_evlist__prepare_workload, etc instead of fork+exec'in 'perf record',
827 * using pipes, etc.
828 */
bca647aa 829const struct option record_options[] = {
d20deb64 830 OPT_CALLBACK('e', "event", &record.evlist, "event",
86847b62 831 "event selector. use 'perf list' to list available events",
f120f9d5 832 parse_events_option),
d20deb64 833 OPT_CALLBACK(0, "filter", &record.evlist, "filter",
c171b552 834 "event filter", parse_filter),
bea03405 835 OPT_STRING('p', "pid", &record.opts.target.pid, "pid",
d6d901c2 836 "record events on existing process id"),
bea03405 837 OPT_STRING('t', "tid", &record.opts.target.tid, "tid",
d6d901c2 838 "record events on existing thread id"),
d20deb64 839 OPT_INTEGER('r', "realtime", &record.realtime_prio,
0e9b20b8 840 "collect data with this RT SCHED_FIFO priority"),
509051ea 841 OPT_BOOLEAN(0, "no-buffering", &record.opts.no_buffering,
acac03fa 842 "collect data without buffering"),
d20deb64 843 OPT_BOOLEAN('R', "raw-samples", &record.opts.raw_samples,
daac07b2 844 "collect raw sample records from all opened counters"),
bea03405 845 OPT_BOOLEAN('a', "all-cpus", &record.opts.target.system_wide,
0e9b20b8 846 "system-wide collection from all CPUs"),
bea03405 847 OPT_STRING('C', "cpu", &record.opts.target.cpu_list, "cpu",
c45c6ea2 848 "list of cpus to monitor"),
d20deb64 849 OPT_U64('c', "count", &record.opts.user_interval, "event period to sample"),
f5fc1412 850 OPT_STRING('o', "output", &record.file.path, "file",
abaff32a 851 "output file name"),
69e7e5b0
AH
852 OPT_BOOLEAN_SET('i', "no-inherit", &record.opts.no_inherit,
853 &record.opts.no_inherit_set,
854 "child tasks do not inherit counters"),
d20deb64 855 OPT_UINTEGER('F', "freq", &record.opts.user_freq, "profile at this frequency"),
994a1f78
JO
856 OPT_CALLBACK('m', "mmap-pages", &record.opts.mmap_pages, "pages",
857 "number of mmap data pages",
858 perf_evlist__parse_mmap_pages),
d20deb64 859 OPT_BOOLEAN(0, "group", &record.opts.group,
43bece79 860 "put the counters into a counter group"),
09b0fd45
JO
861 OPT_CALLBACK_NOOPT('g', NULL, &record.opts,
862 NULL, "enables call-graph recording" ,
863 &record_callchain_opt),
864 OPT_CALLBACK(0, "call-graph", &record.opts,
865 "mode[,dump_size]", record_callchain_help,
866 &record_parse_callchain_opt),
c0555642 867 OPT_INCR('v', "verbose", &verbose,
3da297a6 868 "be more verbose (show counter open errors, etc)"),
b44308f5 869 OPT_BOOLEAN('q', "quiet", &quiet, "don't print any message"),
d20deb64 870 OPT_BOOLEAN('s', "stat", &record.opts.inherit_stat,
649c48a9 871 "per thread counts"),
d20deb64 872 OPT_BOOLEAN('d', "data", &record.opts.sample_address,
4bba828d 873 "Sample addresses"),
d20deb64 874 OPT_BOOLEAN('T', "timestamp", &record.opts.sample_time, "Sample timestamps"),
3e76ac78 875 OPT_BOOLEAN('P', "period", &record.opts.period, "Sample period"),
d20deb64 876 OPT_BOOLEAN('n', "no-samples", &record.opts.no_samples,
649c48a9 877 "don't sample"),
d20deb64 878 OPT_BOOLEAN('N', "no-buildid-cache", &record.no_buildid_cache,
a1ac1d3c 879 "do not update the buildid cache"),
d20deb64 880 OPT_BOOLEAN('B', "no-buildid", &record.no_buildid,
baa2f6ce 881 "do not collect buildids in perf.data"),
d20deb64 882 OPT_CALLBACK('G', "cgroup", &record.evlist, "name",
023695d9
SE
883 "monitor event in cgroup name only",
884 parse_cgroups),
a6205a35 885 OPT_UINTEGER('D', "delay", &record.opts.initial_delay,
6619a53e 886 "ms to wait before starting measurement after program start"),
bea03405
NK
887 OPT_STRING('u', "uid", &record.opts.target.uid_str, "user",
888 "user to profile"),
a5aabdac
SE
889
890 OPT_CALLBACK_NOOPT('b', "branch-any", &record.opts.branch_stack,
891 "branch any", "sample any taken branches",
892 parse_branch_stack),
893
894 OPT_CALLBACK('j', "branch-filter", &record.opts.branch_stack,
895 "branch filter mask", "branch stack filter modes",
bdfebd84 896 parse_branch_stack),
05484298
AK
897 OPT_BOOLEAN('W', "weight", &record.opts.sample_weight,
898 "sample by weight (on special events only)"),
475eeab9
AK
899 OPT_BOOLEAN(0, "transaction", &record.opts.sample_transaction,
900 "sample transaction flags (special events only)"),
3aa5939d
AH
901 OPT_BOOLEAN(0, "per-thread", &record.opts.target.per_thread,
902 "use per-thread mmaps"),
0e9b20b8
IM
903 OPT_END()
904};
905
1d037ca1 906int cmd_record(int argc, const char **argv, const char *prefix __maybe_unused)
0e9b20b8 907{
69aad6f1 908 int err = -ENOMEM;
8c6f45a7 909 struct record *rec = &record;
16ad2ffb 910 char errbuf[BUFSIZ];
0e9b20b8 911
3e2be2da
ACM
912 rec->evlist = perf_evlist__new();
913 if (rec->evlist == NULL)
361c99a6
ACM
914 return -ENOMEM;
915
bca647aa 916 argc = parse_options(argc, argv, record_options, record_usage,
655000e7 917 PARSE_OPT_STOP_AT_NON_OPTION);
602ad878 918 if (!argc && target__none(&rec->opts.target))
bca647aa 919 usage_with_options(record_usage, record_options);
0e9b20b8 920
bea03405 921 if (nr_cgroups && !rec->opts.target.system_wide) {
3780f488
NK
922 ui__error("cgroup monitoring only available in"
923 " system-wide mode\n");
023695d9
SE
924 usage_with_options(record_usage, record_options);
925 }
926
655000e7 927 symbol__init();
baa2f6ce 928
ec80fde7 929 if (symbol_conf.kptr_restrict)
646aaea6
ACM
930 pr_warning(
931"WARNING: Kernel address maps (/proc/{kallsyms,modules}) are restricted,\n"
932"check /proc/sys/kernel/kptr_restrict.\n\n"
933"Samples in kernel functions may not be resolved if a suitable vmlinux\n"
934"file is not found in the buildid cache or in the vmlinux path.\n\n"
935"Samples in kernel modules won't be resolved at all.\n\n"
936"If some relocation was applied (e.g. kexec) symbols may be misresolved\n"
937"even with a suitable vmlinux or kallsyms file.\n\n");
ec80fde7 938
d20deb64 939 if (rec->no_buildid_cache || rec->no_buildid)
a1ac1d3c 940 disable_buildid_cache();
655000e7 941
3e2be2da
ACM
942 if (rec->evlist->nr_entries == 0 &&
943 perf_evlist__add_default(rec->evlist) < 0) {
69aad6f1
ACM
944 pr_err("Not enough memory for event selector list\n");
945 goto out_symbol_exit;
bbd36e5e 946 }
0e9b20b8 947
69e7e5b0
AH
948 if (rec->opts.target.tid && !rec->opts.no_inherit_set)
949 rec->opts.no_inherit = true;
950
602ad878 951 err = target__validate(&rec->opts.target);
16ad2ffb 952 if (err) {
602ad878 953 target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
16ad2ffb
NK
954 ui__warning("%s", errbuf);
955 }
956
602ad878 957 err = target__parse_uid(&rec->opts.target);
16ad2ffb
NK
958 if (err) {
959 int saved_errno = errno;
4bd0f2d2 960
602ad878 961 target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
3780f488 962 ui__error("%s", errbuf);
16ad2ffb
NK
963
964 err = -saved_errno;
8fa60e1f 965 goto out_symbol_exit;
16ad2ffb 966 }
0d37aa34 967
16ad2ffb 968 err = -ENOMEM;
3e2be2da 969 if (perf_evlist__create_maps(rec->evlist, &rec->opts.target) < 0)
dd7927f4 970 usage_with_options(record_usage, record_options);
69aad6f1 971
b4006796 972 if (record_opts__config(&rec->opts)) {
39d17dac 973 err = -EINVAL;
03ad9747 974 goto out_symbol_exit;
7e4ff9e3
MG
975 }
976
d20deb64 977 err = __cmd_record(&record, argc, argv);
d65a458b
ACM
978out_symbol_exit:
979 symbol__exit();
39d17dac 980 return err;
0e9b20b8 981}