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