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