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