]> git.ipfire.org Git - thirdparty/kernel/linux.git/blame - tools/perf/builtin-record.c
perf evlist: Make {pause,resume} internal helpers
[thirdparty/kernel/linux.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"
4b6ab94e 14#include <subcmd/parse-options.h>
8ad8db37 15#include "util/parse-events.h"
41840d21 16#include "util/config.h"
6eda5838 17
8f651eae 18#include "util/callchain.h"
f14d5707 19#include "util/cgroup.h"
7c6a1c65 20#include "util/header.h"
66e274f3 21#include "util/event.h"
361c99a6 22#include "util/evlist.h"
69aad6f1 23#include "util/evsel.h"
8f28827a 24#include "util/debug.h"
94c744b6 25#include "util/session.h"
45694aa7 26#include "util/tool.h"
8d06367f 27#include "util/symbol.h"
a12b51c4 28#include "util/cpumap.h"
fd78260b 29#include "util/thread_map.h"
f5fc1412 30#include "util/data.h"
bcc84ec6 31#include "util/perf_regs.h"
ef149c25 32#include "util/auxtrace.h"
46bc29b9 33#include "util/tsc.h"
f00898f4 34#include "util/parse-branch-options.h"
bcc84ec6 35#include "util/parse-regs-options.h"
71dc2326 36#include "util/llvm-utils.h"
8690a2a7 37#include "util/bpf-loader.h"
5f9cf599 38#include "util/trigger.h"
d8871ea7 39#include "asm/bug.h"
7c6a1c65 40
97124d5e 41#include <unistd.h>
de9ac07b 42#include <sched.h>
a41794cd 43#include <sys/mman.h>
2d11c650 44#include <asm/bug.h>
de9ac07b 45
78da39fa 46
8c6f45a7 47struct record {
45694aa7 48 struct perf_tool tool;
b4006796 49 struct record_opts opts;
d20deb64 50 u64 bytes_written;
f5fc1412 51 struct perf_data_file file;
ef149c25 52 struct auxtrace_record *itr;
d20deb64
ACM
53 struct perf_evlist *evlist;
54 struct perf_session *session;
55 const char *progname;
d20deb64 56 int realtime_prio;
d20deb64 57 bool no_buildid;
d2db9a98 58 bool no_buildid_set;
d20deb64 59 bool no_buildid_cache;
d2db9a98 60 bool no_buildid_cache_set;
6156681b 61 bool buildid_all;
ecfd7a9c 62 bool timestamp_filename;
3c1cb7e3 63 bool switch_output;
9f065194 64 unsigned long long samples;
0f82ebc4 65};
a21ca2ca 66
8c6f45a7 67static int record__write(struct record *rec, void *bf, size_t size)
f5970550 68{
cf8b2e69 69 if (perf_data_file__write(rec->session->file, bf, size) < 0) {
50a9b868
JO
70 pr_err("failed to write perf data, error: %m\n");
71 return -1;
f5970550 72 }
8d3eca20 73
cf8b2e69 74 rec->bytes_written += size;
8d3eca20 75 return 0;
f5970550
PZ
76}
77
45694aa7 78static int process_synthesized_event(struct perf_tool *tool,
d20deb64 79 union perf_event *event,
1d037ca1
IT
80 struct perf_sample *sample __maybe_unused,
81 struct machine *machine __maybe_unused)
234fbbf5 82{
8c6f45a7
ACM
83 struct record *rec = container_of(tool, struct record, tool);
84 return record__write(rec, event, event->header.size);
234fbbf5
ACM
85}
86
3a62a7b8
WN
87static int
88backward_rb_find_range(void *buf, int mask, u64 head, u64 *start, u64 *end)
89{
90 struct perf_event_header *pheader;
91 u64 evt_head = head;
92 int size = mask + 1;
93
94 pr_debug2("backward_rb_find_range: buf=%p, head=%"PRIx64"\n", buf, head);
95 pheader = (struct perf_event_header *)(buf + (head & mask));
96 *start = head;
97 while (true) {
98 if (evt_head - head >= (unsigned int)size) {
99 pr_debug("Finshed reading backward ring buffer: rewind\n");
100 if (evt_head - head > (unsigned int)size)
101 evt_head -= pheader->size;
102 *end = evt_head;
103 return 0;
104 }
105
106 pheader = (struct perf_event_header *)(buf + (evt_head & mask));
107
108 if (pheader->size == 0) {
109 pr_debug("Finshed reading backward ring buffer: get start\n");
110 *end = evt_head;
111 return 0;
112 }
113
114 evt_head += pheader->size;
115 pr_debug3("move evt_head: %"PRIx64"\n", evt_head);
116 }
117 WARN_ONCE(1, "Shouldn't get here\n");
118 return -1;
119}
120
121static int
a4ea0ec4
WN
122rb_find_range(void *data, int mask, u64 head, u64 old,
123 u64 *start, u64 *end, bool backward)
3a62a7b8 124{
a4ea0ec4 125 if (!backward) {
3a62a7b8
WN
126 *start = old;
127 *end = head;
128 return 0;
129 }
130
131 return backward_rb_find_range(data, mask, head, start, end);
132}
133
a4ea0ec4
WN
134static int
135record__mmap_read(struct record *rec, struct perf_mmap *md,
136 bool overwrite, bool backward)
de9ac07b 137{
7b8283b5
DA
138 u64 head = perf_mmap__read_head(md);
139 u64 old = md->prev;
09fa4f40 140 u64 end = head, start = old;
918512b4 141 unsigned char *data = md->base + page_size;
de9ac07b
PZ
142 unsigned long size;
143 void *buf;
8d3eca20 144 int rc = 0;
de9ac07b 145
a4ea0ec4
WN
146 if (rb_find_range(data, md->mask, head,
147 old, &start, &end, backward))
3a62a7b8
WN
148 return -1;
149
09fa4f40 150 if (start == end)
8d3eca20 151 return 0;
dc82009a 152
d20deb64 153 rec->samples++;
de9ac07b 154
09fa4f40 155 size = end - start;
2d11c650
WN
156 if (size > (unsigned long)(md->mask) + 1) {
157 WARN_ONCE(1, "failed to keep up with mmap data. (warn only once)\n");
158
159 md->prev = head;
a4ea0ec4 160 perf_mmap__consume(md, overwrite || backward);
2d11c650
WN
161 return 0;
162 }
de9ac07b 163
09fa4f40
WN
164 if ((start & md->mask) + size != (end & md->mask)) {
165 buf = &data[start & md->mask];
166 size = md->mask + 1 - (start & md->mask);
167 start += size;
021e9f47 168
8c6f45a7 169 if (record__write(rec, buf, size) < 0) {
8d3eca20
DA
170 rc = -1;
171 goto out;
172 }
de9ac07b
PZ
173 }
174
09fa4f40
WN
175 buf = &data[start & md->mask];
176 size = end - start;
177 start += size;
021e9f47 178
8c6f45a7 179 if (record__write(rec, buf, size) < 0) {
8d3eca20
DA
180 rc = -1;
181 goto out;
182 }
de9ac07b 183
09fa4f40 184 md->prev = head;
a4ea0ec4 185 perf_mmap__consume(md, overwrite || backward);
8d3eca20
DA
186out:
187 return rc;
de9ac07b
PZ
188}
189
2dd6d8a1
AH
190static volatile int done;
191static volatile int signr = -1;
192static volatile int child_finished;
c0bdc1c4 193
2dd6d8a1 194static volatile int auxtrace_record__snapshot_started;
5f9cf599 195static DEFINE_TRIGGER(auxtrace_snapshot_trigger);
3c1cb7e3 196static DEFINE_TRIGGER(switch_output_trigger);
2dd6d8a1
AH
197
198static void sig_handler(int sig)
199{
200 if (sig == SIGCHLD)
201 child_finished = 1;
202 else
203 signr = sig;
204
205 done = 1;
206}
207
208static void record__sig_exit(void)
209{
210 if (signr == -1)
211 return;
212
213 signal(signr, SIG_DFL);
214 raise(signr);
215}
216
e31f0d01
AH
217#ifdef HAVE_AUXTRACE_SUPPORT
218
ef149c25
AH
219static int record__process_auxtrace(struct perf_tool *tool,
220 union perf_event *event, void *data1,
221 size_t len1, void *data2, size_t len2)
222{
223 struct record *rec = container_of(tool, struct record, tool);
99fa2984 224 struct perf_data_file *file = &rec->file;
ef149c25
AH
225 size_t padding;
226 u8 pad[8] = {0};
227
99fa2984
AH
228 if (!perf_data_file__is_pipe(file)) {
229 off_t file_offset;
230 int fd = perf_data_file__fd(file);
231 int err;
232
233 file_offset = lseek(fd, 0, SEEK_CUR);
234 if (file_offset == -1)
235 return -1;
236 err = auxtrace_index__auxtrace_event(&rec->session->auxtrace_index,
237 event, file_offset);
238 if (err)
239 return err;
240 }
241
ef149c25
AH
242 /* event.auxtrace.size includes padding, see __auxtrace_mmap__read() */
243 padding = (len1 + len2) & 7;
244 if (padding)
245 padding = 8 - padding;
246
247 record__write(rec, event, event->header.size);
248 record__write(rec, data1, len1);
249 if (len2)
250 record__write(rec, data2, len2);
251 record__write(rec, &pad, padding);
252
253 return 0;
254}
255
256static int record__auxtrace_mmap_read(struct record *rec,
257 struct auxtrace_mmap *mm)
258{
259 int ret;
260
261 ret = auxtrace_mmap__read(mm, rec->itr, &rec->tool,
262 record__process_auxtrace);
263 if (ret < 0)
264 return ret;
265
266 if (ret)
267 rec->samples++;
268
269 return 0;
270}
271
2dd6d8a1
AH
272static int record__auxtrace_mmap_read_snapshot(struct record *rec,
273 struct auxtrace_mmap *mm)
274{
275 int ret;
276
277 ret = auxtrace_mmap__read_snapshot(mm, rec->itr, &rec->tool,
278 record__process_auxtrace,
279 rec->opts.auxtrace_snapshot_size);
280 if (ret < 0)
281 return ret;
282
283 if (ret)
284 rec->samples++;
285
286 return 0;
287}
288
289static int record__auxtrace_read_snapshot_all(struct record *rec)
290{
291 int i;
292 int rc = 0;
293
294 for (i = 0; i < rec->evlist->nr_mmaps; i++) {
295 struct auxtrace_mmap *mm =
296 &rec->evlist->mmap[i].auxtrace_mmap;
297
298 if (!mm->base)
299 continue;
300
301 if (record__auxtrace_mmap_read_snapshot(rec, mm) != 0) {
302 rc = -1;
303 goto out;
304 }
305 }
306out:
307 return rc;
308}
309
310static void record__read_auxtrace_snapshot(struct record *rec)
311{
312 pr_debug("Recording AUX area tracing snapshot\n");
313 if (record__auxtrace_read_snapshot_all(rec) < 0) {
5f9cf599 314 trigger_error(&auxtrace_snapshot_trigger);
2dd6d8a1 315 } else {
5f9cf599
WN
316 if (auxtrace_record__snapshot_finish(rec->itr))
317 trigger_error(&auxtrace_snapshot_trigger);
318 else
319 trigger_ready(&auxtrace_snapshot_trigger);
2dd6d8a1
AH
320 }
321}
322
e31f0d01
AH
323#else
324
325static inline
326int record__auxtrace_mmap_read(struct record *rec __maybe_unused,
327 struct auxtrace_mmap *mm __maybe_unused)
328{
329 return 0;
330}
331
2dd6d8a1
AH
332static inline
333void record__read_auxtrace_snapshot(struct record *rec __maybe_unused)
de9ac07b 334{
f7b7c26e
PZ
335}
336
2dd6d8a1
AH
337static inline
338int auxtrace_record__snapshot_start(struct auxtrace_record *itr __maybe_unused)
f7b7c26e 339{
2dd6d8a1 340 return 0;
de9ac07b
PZ
341}
342
2dd6d8a1
AH
343#endif
344
cda57a8c
WN
345static int record__mmap_evlist(struct record *rec,
346 struct perf_evlist *evlist)
347{
348 struct record_opts *opts = &rec->opts;
349 char msg[512];
350
351 if (perf_evlist__mmap_ex(evlist, opts->mmap_pages, false,
352 opts->auxtrace_mmap_pages,
353 opts->auxtrace_snapshot_mode) < 0) {
354 if (errno == EPERM) {
355 pr_err("Permission error mapping pages.\n"
356 "Consider increasing "
357 "/proc/sys/kernel/perf_event_mlock_kb,\n"
358 "or try again with a smaller value of -m/--mmap_pages.\n"
359 "(current value: %u,%u)\n",
360 opts->mmap_pages, opts->auxtrace_mmap_pages);
361 return -errno;
362 } else {
363 pr_err("failed to mmap with %d (%s)\n", errno,
c8b5f2c9 364 str_error_r(errno, msg, sizeof(msg)));
cda57a8c
WN
365 if (errno)
366 return -errno;
367 else
368 return -EINVAL;
369 }
370 }
371 return 0;
372}
373
374static int record__mmap(struct record *rec)
375{
376 return record__mmap_evlist(rec, rec->evlist);
377}
378
8c6f45a7 379static int record__open(struct record *rec)
dd7927f4 380{
56e52e85 381 char msg[512];
6a4bb04c 382 struct perf_evsel *pos;
d20deb64
ACM
383 struct perf_evlist *evlist = rec->evlist;
384 struct perf_session *session = rec->session;
b4006796 385 struct record_opts *opts = &rec->opts;
8d3eca20 386 int rc = 0;
dd7927f4 387
e68ae9cf 388 perf_evlist__config(evlist, opts, &callchain_param);
cac21425 389
e5cadb93 390 evlist__for_each_entry(evlist, pos) {
dd7927f4 391try_again:
d988d5ee 392 if (perf_evsel__open(pos, pos->cpus, pos->threads) < 0) {
56e52e85 393 if (perf_evsel__fallback(pos, errno, msg, sizeof(msg))) {
d6d901c2 394 if (verbose)
c0a54341 395 ui__warning("%s\n", msg);
d6d901c2
ZY
396 goto try_again;
397 }
ca6a4258 398
56e52e85
ACM
399 rc = -errno;
400 perf_evsel__open_strerror(pos, &opts->target,
401 errno, msg, sizeof(msg));
402 ui__error("%s\n", msg);
8d3eca20 403 goto out;
c171b552
LZ
404 }
405 }
a43d3f08 406
23d4aad4
ACM
407 if (perf_evlist__apply_filters(evlist, &pos)) {
408 error("failed to set filter \"%s\" on event %s with %d (%s)\n",
409 pos->filter, perf_evsel__name(pos), errno,
c8b5f2c9 410 str_error_r(errno, msg, sizeof(msg)));
8d3eca20
DA
411 rc = -1;
412 goto out;
0a102479
FW
413 }
414
cda57a8c
WN
415 rc = record__mmap(rec);
416 if (rc)
8d3eca20 417 goto out;
0a27d7f9 418
563aecb2 419 session->evlist = evlist;
7b56cce2 420 perf_session__set_id_hdr_size(session);
8d3eca20
DA
421out:
422 return rc;
16c8a109
PZ
423}
424
e3d59112
NK
425static int process_sample_event(struct perf_tool *tool,
426 union perf_event *event,
427 struct perf_sample *sample,
428 struct perf_evsel *evsel,
429 struct machine *machine)
430{
431 struct record *rec = container_of(tool, struct record, tool);
432
433 rec->samples++;
434
435 return build_id__mark_dso_hit(tool, event, sample, evsel, machine);
436}
437
8c6f45a7 438static int process_buildids(struct record *rec)
6122e4e4 439{
f5fc1412
JO
440 struct perf_data_file *file = &rec->file;
441 struct perf_session *session = rec->session;
6122e4e4 442
457ae94a 443 if (file->size == 0)
9f591fd7
ACM
444 return 0;
445
00dc8657
NK
446 /*
447 * During this process, it'll load kernel map and replace the
448 * dso->long_name to a real pathname it found. In this case
449 * we prefer the vmlinux path like
450 * /lib/modules/3.16.4/build/vmlinux
451 *
452 * rather than build-id path (in debug directory).
453 * $HOME/.debug/.build-id/f0/6e17aa50adf4d00b88925e03775de107611551
454 */
455 symbol_conf.ignore_vmlinux_buildid = true;
456
6156681b
NK
457 /*
458 * If --buildid-all is given, it marks all DSO regardless of hits,
459 * so no need to process samples.
460 */
461 if (rec->buildid_all)
462 rec->tool.sample = NULL;
463
b7b61cbe 464 return perf_session__process_events(session);
6122e4e4
ACM
465}
466
8115d60c 467static void perf_event__synthesize_guest_os(struct machine *machine, void *data)
a1645ce1
ZY
468{
469 int err;
45694aa7 470 struct perf_tool *tool = data;
a1645ce1
ZY
471 /*
472 *As for guest kernel when processing subcommand record&report,
473 *we arrange module mmap prior to guest kernel mmap and trigger
474 *a preload dso because default guest module symbols are loaded
475 *from guest kallsyms instead of /lib/modules/XXX/XXX. This
476 *method is used to avoid symbol missing when the first addr is
477 *in module instead of in guest kernel.
478 */
45694aa7 479 err = perf_event__synthesize_modules(tool, process_synthesized_event,
743eb868 480 machine);
a1645ce1
ZY
481 if (err < 0)
482 pr_err("Couldn't record guest kernel [%d]'s reference"
23346f21 483 " relocation symbol.\n", machine->pid);
a1645ce1 484
a1645ce1
ZY
485 /*
486 * We use _stext for guest kernel because guest kernel's /proc/kallsyms
487 * have no _text sometimes.
488 */
45694aa7 489 err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
0ae617be 490 machine);
a1645ce1
ZY
491 if (err < 0)
492 pr_err("Couldn't record guest kernel [%d]'s reference"
23346f21 493 " relocation symbol.\n", machine->pid);
a1645ce1
ZY
494}
495
98402807
FW
496static struct perf_event_header finished_round_event = {
497 .size = sizeof(struct perf_event_header),
498 .type = PERF_RECORD_FINISHED_ROUND,
499};
500
a4ea0ec4
WN
501static int record__mmap_read_evlist(struct record *rec, struct perf_evlist *evlist,
502 bool backward)
98402807 503{
dcabb507 504 u64 bytes_written = rec->bytes_written;
0e2e63dd 505 int i;
8d3eca20 506 int rc = 0;
a4ea0ec4 507 struct perf_mmap *maps;
98402807 508
cb21686b
WN
509 if (!evlist)
510 return 0;
ef149c25 511
b2cb615d 512 maps = backward ? evlist->backward_mmap : evlist->mmap;
a4ea0ec4
WN
513 if (!maps)
514 return 0;
515
54cc54de
WN
516 if (backward && evlist->bkw_mmap_state != BKW_MMAP_DATA_PENDING)
517 return 0;
518
cb21686b 519 for (i = 0; i < evlist->nr_mmaps; i++) {
a4ea0ec4 520 struct auxtrace_mmap *mm = &maps[i].auxtrace_mmap;
cb21686b 521
a4ea0ec4
WN
522 if (maps[i].base) {
523 if (record__mmap_read(rec, &maps[i],
524 evlist->overwrite, backward) != 0) {
8d3eca20
DA
525 rc = -1;
526 goto out;
527 }
528 }
ef149c25 529
2dd6d8a1 530 if (mm->base && !rec->opts.auxtrace_snapshot_mode &&
ef149c25
AH
531 record__auxtrace_mmap_read(rec, mm) != 0) {
532 rc = -1;
533 goto out;
534 }
98402807
FW
535 }
536
dcabb507
JO
537 /*
538 * Mark the round finished in case we wrote
539 * at least one event.
540 */
541 if (bytes_written != rec->bytes_written)
542 rc = record__write(rec, &finished_round_event, sizeof(finished_round_event));
8d3eca20 543
54cc54de
WN
544 if (backward)
545 perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_EMPTY);
8d3eca20
DA
546out:
547 return rc;
98402807
FW
548}
549
cb21686b
WN
550static int record__mmap_read_all(struct record *rec)
551{
552 int err;
553
a4ea0ec4 554 err = record__mmap_read_evlist(rec, rec->evlist, false);
cb21686b
WN
555 if (err)
556 return err;
557
05737464 558 return record__mmap_read_evlist(rec, rec->evlist, true);
cb21686b
WN
559}
560
8c6f45a7 561static void record__init_features(struct record *rec)
57706abc 562{
57706abc
DA
563 struct perf_session *session = rec->session;
564 int feat;
565
566 for (feat = HEADER_FIRST_FEATURE; feat < HEADER_LAST_FEATURE; feat++)
567 perf_header__set_feat(&session->header, feat);
568
569 if (rec->no_buildid)
570 perf_header__clear_feat(&session->header, HEADER_BUILD_ID);
571
3e2be2da 572 if (!have_tracepoints(&rec->evlist->entries))
57706abc
DA
573 perf_header__clear_feat(&session->header, HEADER_TRACING_DATA);
574
575 if (!rec->opts.branch_stack)
576 perf_header__clear_feat(&session->header, HEADER_BRANCH_STACK);
ef149c25
AH
577
578 if (!rec->opts.full_auxtrace)
579 perf_header__clear_feat(&session->header, HEADER_AUXTRACE);
ffa517ad
JO
580
581 perf_header__clear_feat(&session->header, HEADER_STAT);
57706abc
DA
582}
583
e1ab48ba
WN
584static void
585record__finish_output(struct record *rec)
586{
587 struct perf_data_file *file = &rec->file;
588 int fd = perf_data_file__fd(file);
589
590 if (file->is_pipe)
591 return;
592
593 rec->session->header.data_size += rec->bytes_written;
594 file->size = lseek(perf_data_file__fd(file), 0, SEEK_CUR);
595
596 if (!rec->no_buildid) {
597 process_buildids(rec);
598
599 if (rec->buildid_all)
600 dsos__hit_all(rec->session);
601 }
602 perf_session__write_header(rec->session, rec->evlist, fd, true);
603
604 return;
605}
606
be7b0c9e
WN
607static int record__synthesize_workload(struct record *rec)
608{
609 struct {
610 struct thread_map map;
611 struct thread_map_data map_data;
612 } thread_map;
613
614 thread_map.map.nr = 1;
615 thread_map.map.map[0].pid = rec->evlist->workload.pid;
616 thread_map.map.map[0].comm = NULL;
617 return perf_event__synthesize_thread_map(&rec->tool, &thread_map.map,
618 process_synthesized_event,
619 &rec->session->machines.host,
620 rec->opts.sample_address,
621 rec->opts.proc_map_timeout);
622}
623
3c1cb7e3
WN
624static int record__synthesize(struct record *rec);
625
ecfd7a9c
WN
626static int
627record__switch_output(struct record *rec, bool at_exit)
628{
629 struct perf_data_file *file = &rec->file;
630 int fd, err;
631
632 /* Same Size: "2015122520103046"*/
633 char timestamp[] = "InvalidTimestamp";
634
635 rec->samples = 0;
636 record__finish_output(rec);
637 err = fetch_current_timestamp(timestamp, sizeof(timestamp));
638 if (err) {
639 pr_err("Failed to get current timestamp\n");
640 return -EINVAL;
641 }
642
643 fd = perf_data_file__switch(file, timestamp,
644 rec->session->header.data_offset,
645 at_exit);
646 if (fd >= 0 && !at_exit) {
647 rec->bytes_written = 0;
648 rec->session->header.data_size = 0;
649 }
650
651 if (!quiet)
652 fprintf(stderr, "[ perf record: Dump %s.%s ]\n",
653 file->path, timestamp);
3c1cb7e3
WN
654
655 /* Output tracking events */
be7b0c9e 656 if (!at_exit) {
3c1cb7e3
WN
657 record__synthesize(rec);
658
be7b0c9e
WN
659 /*
660 * In 'perf record --switch-output' without -a,
661 * record__synthesize() in record__switch_output() won't
662 * generate tracking events because there's no thread_map
663 * in evlist. Which causes newly created perf.data doesn't
664 * contain map and comm information.
665 * Create a fake thread_map and directly call
666 * perf_event__synthesize_thread_map() for those events.
667 */
668 if (target__none(&rec->opts.target))
669 record__synthesize_workload(rec);
670 }
ecfd7a9c
WN
671 return fd;
672}
673
f33cbe72
ACM
674static volatile int workload_exec_errno;
675
676/*
677 * perf_evlist__prepare_workload will send a SIGUSR1
678 * if the fork fails, since we asked by setting its
679 * want_signal to true.
680 */
45604710
NK
681static void workload_exec_failed_signal(int signo __maybe_unused,
682 siginfo_t *info,
f33cbe72
ACM
683 void *ucontext __maybe_unused)
684{
685 workload_exec_errno = info->si_value.sival_int;
686 done = 1;
f33cbe72
ACM
687 child_finished = 1;
688}
689
2dd6d8a1
AH
690static void snapshot_sig_handler(int sig);
691
46bc29b9
AH
692int __weak
693perf_event__synth_time_conv(const struct perf_event_mmap_page *pc __maybe_unused,
694 struct perf_tool *tool __maybe_unused,
695 perf_event__handler_t process __maybe_unused,
696 struct machine *machine __maybe_unused)
697{
698 return 0;
699}
700
ee667f94
WN
701static const struct perf_event_mmap_page *
702perf_evlist__pick_pc(struct perf_evlist *evlist)
703{
b2cb615d
WN
704 if (evlist) {
705 if (evlist->mmap && evlist->mmap[0].base)
706 return evlist->mmap[0].base;
707 if (evlist->backward_mmap && evlist->backward_mmap[0].base)
708 return evlist->backward_mmap[0].base;
709 }
ee667f94
WN
710 return NULL;
711}
712
c45628b0
WN
713static const struct perf_event_mmap_page *record__pick_pc(struct record *rec)
714{
ee667f94
WN
715 const struct perf_event_mmap_page *pc;
716
717 pc = perf_evlist__pick_pc(rec->evlist);
718 if (pc)
719 return pc;
c45628b0
WN
720 return NULL;
721}
722
c45c86eb
WN
723static int record__synthesize(struct record *rec)
724{
725 struct perf_session *session = rec->session;
726 struct machine *machine = &session->machines.host;
727 struct perf_data_file *file = &rec->file;
728 struct record_opts *opts = &rec->opts;
729 struct perf_tool *tool = &rec->tool;
730 int fd = perf_data_file__fd(file);
731 int err = 0;
732
733 if (file->is_pipe) {
734 err = perf_event__synthesize_attrs(tool, session,
735 process_synthesized_event);
736 if (err < 0) {
737 pr_err("Couldn't synthesize attrs.\n");
738 goto out;
739 }
740
741 if (have_tracepoints(&rec->evlist->entries)) {
742 /*
743 * FIXME err <= 0 here actually means that
744 * there were no tracepoints so its not really
745 * an error, just that we don't need to
746 * synthesize anything. We really have to
747 * return this more properly and also
748 * propagate errors that now are calling die()
749 */
750 err = perf_event__synthesize_tracing_data(tool, fd, rec->evlist,
751 process_synthesized_event);
752 if (err <= 0) {
753 pr_err("Couldn't record tracing data.\n");
754 goto out;
755 }
756 rec->bytes_written += err;
757 }
758 }
759
c45628b0 760 err = perf_event__synth_time_conv(record__pick_pc(rec), tool,
46bc29b9
AH
761 process_synthesized_event, machine);
762 if (err)
763 goto out;
764
c45c86eb
WN
765 if (rec->opts.full_auxtrace) {
766 err = perf_event__synthesize_auxtrace_info(rec->itr, tool,
767 session, process_synthesized_event);
768 if (err)
769 goto out;
770 }
771
772 err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
773 machine);
774 WARN_ONCE(err < 0, "Couldn't record kernel reference relocation symbol\n"
775 "Symbol resolution may be skewed if relocation was used (e.g. kexec).\n"
776 "Check /proc/kallsyms permission or run as root.\n");
777
778 err = perf_event__synthesize_modules(tool, process_synthesized_event,
779 machine);
780 WARN_ONCE(err < 0, "Couldn't record kernel module information.\n"
781 "Symbol resolution may be skewed if relocation was used (e.g. kexec).\n"
782 "Check /proc/modules permission or run as root.\n");
783
784 if (perf_guest) {
785 machines__process_guests(&session->machines,
786 perf_event__synthesize_guest_os, tool);
787 }
788
789 err = __machine__synthesize_threads(machine, tool, &opts->target, rec->evlist->threads,
790 process_synthesized_event, opts->sample_address,
791 opts->proc_map_timeout);
792out:
793 return err;
794}
795
8c6f45a7 796static int __cmd_record(struct record *rec, int argc, const char **argv)
16c8a109 797{
57706abc 798 int err;
45604710 799 int status = 0;
8b412664 800 unsigned long waking = 0;
46be604b 801 const bool forks = argc > 0;
23346f21 802 struct machine *machine;
45694aa7 803 struct perf_tool *tool = &rec->tool;
b4006796 804 struct record_opts *opts = &rec->opts;
f5fc1412 805 struct perf_data_file *file = &rec->file;
d20deb64 806 struct perf_session *session;
6dcf45ef 807 bool disabled = false, draining = false;
42aa276f 808 int fd;
de9ac07b 809
d20deb64 810 rec->progname = argv[0];
33e49ea7 811
45604710 812 atexit(record__sig_exit);
f5970550
PZ
813 signal(SIGCHLD, sig_handler);
814 signal(SIGINT, sig_handler);
804f7ac7 815 signal(SIGTERM, sig_handler);
c0bdc1c4 816
3c1cb7e3 817 if (rec->opts.auxtrace_snapshot_mode || rec->switch_output) {
2dd6d8a1 818 signal(SIGUSR2, snapshot_sig_handler);
3c1cb7e3
WN
819 if (rec->opts.auxtrace_snapshot_mode)
820 trigger_on(&auxtrace_snapshot_trigger);
821 if (rec->switch_output)
822 trigger_on(&switch_output_trigger);
c0bdc1c4 823 } else {
2dd6d8a1 824 signal(SIGUSR2, SIG_IGN);
c0bdc1c4 825 }
f5970550 826
b7b61cbe 827 session = perf_session__new(file, false, tool);
94c744b6 828 if (session == NULL) {
ffa91880 829 pr_err("Perf session creation failed.\n");
a9a70bbc
ACM
830 return -1;
831 }
832
42aa276f 833 fd = perf_data_file__fd(file);
d20deb64
ACM
834 rec->session = session;
835
8c6f45a7 836 record__init_features(rec);
330aa675 837
d4db3f16 838 if (forks) {
3e2be2da 839 err = perf_evlist__prepare_workload(rec->evlist, &opts->target,
f5fc1412 840 argv, file->is_pipe,
735f7e0b 841 workload_exec_failed_signal);
35b9d88e
ACM
842 if (err < 0) {
843 pr_err("Couldn't run the workload!\n");
45604710 844 status = err;
35b9d88e 845 goto out_delete_session;
856e9660 846 }
856e9660
PZ
847 }
848
8c6f45a7 849 if (record__open(rec) != 0) {
8d3eca20 850 err = -1;
45604710 851 goto out_child;
8d3eca20 852 }
de9ac07b 853
8690a2a7
WN
854 err = bpf__apply_obj_config();
855 if (err) {
856 char errbuf[BUFSIZ];
857
858 bpf__strerror_apply_obj_config(err, errbuf, sizeof(errbuf));
859 pr_err("ERROR: Apply config to BPF failed: %s\n",
860 errbuf);
861 goto out_child;
862 }
863
cca8482c
AH
864 /*
865 * Normally perf_session__new would do this, but it doesn't have the
866 * evlist.
867 */
868 if (rec->tool.ordered_events && !perf_evlist__sample_id_all(rec->evlist)) {
869 pr_warning("WARNING: No sample_id_all support, falling back to unordered processing\n");
870 rec->tool.ordered_events = false;
871 }
872
3e2be2da 873 if (!rec->evlist->nr_groups)
a8bb559b
NK
874 perf_header__clear_feat(&session->header, HEADER_GROUP_DESC);
875
f5fc1412 876 if (file->is_pipe) {
42aa276f 877 err = perf_header__write_pipe(fd);
529870e3 878 if (err < 0)
45604710 879 goto out_child;
563aecb2 880 } else {
42aa276f 881 err = perf_session__write_header(session, rec->evlist, fd, false);
d5eed904 882 if (err < 0)
45604710 883 goto out_child;
56b03f3c
ACM
884 }
885
d3665498 886 if (!rec->no_buildid
e20960c0 887 && !perf_header__has_feat(&session->header, HEADER_BUILD_ID)) {
d3665498 888 pr_err("Couldn't generate buildids. "
e20960c0 889 "Use --no-buildid to profile anyway.\n");
8d3eca20 890 err = -1;
45604710 891 goto out_child;
e20960c0
RR
892 }
893
34ba5122 894 machine = &session->machines.host;
743eb868 895
c45c86eb
WN
896 err = record__synthesize(rec);
897 if (err < 0)
45604710 898 goto out_child;
8d3eca20 899
d20deb64 900 if (rec->realtime_prio) {
de9ac07b
PZ
901 struct sched_param param;
902
d20deb64 903 param.sched_priority = rec->realtime_prio;
de9ac07b 904 if (sched_setscheduler(0, SCHED_FIFO, &param)) {
6beba7ad 905 pr_err("Could not set realtime priority.\n");
8d3eca20 906 err = -1;
45604710 907 goto out_child;
de9ac07b
PZ
908 }
909 }
910
774cb499
JO
911 /*
912 * When perf is starting the traced process, all the events
913 * (apart from group members) have enable_on_exec=1 set,
914 * so don't spoil it by prematurely enabling them.
915 */
6619a53e 916 if (!target__none(&opts->target) && !opts->initial_delay)
3e2be2da 917 perf_evlist__enable(rec->evlist);
764e16a3 918
856e9660
PZ
919 /*
920 * Let the child rip
921 */
e803cf97 922 if (forks) {
e5bed564
NK
923 union perf_event *event;
924
925 event = malloc(sizeof(event->comm) + machine->id_hdr_size);
926 if (event == NULL) {
927 err = -ENOMEM;
928 goto out_child;
929 }
930
e803cf97
NK
931 /*
932 * Some H/W events are generated before COMM event
933 * which is emitted during exec(), so perf script
934 * cannot see a correct process name for those events.
935 * Synthesize COMM event to prevent it.
936 */
e5bed564 937 perf_event__synthesize_comm(tool, event,
e803cf97
NK
938 rec->evlist->workload.pid,
939 process_synthesized_event,
940 machine);
e5bed564 941 free(event);
e803cf97 942
3e2be2da 943 perf_evlist__start_workload(rec->evlist);
e803cf97 944 }
856e9660 945
6619a53e
AK
946 if (opts->initial_delay) {
947 usleep(opts->initial_delay * 1000);
948 perf_evlist__enable(rec->evlist);
949 }
950
5f9cf599 951 trigger_ready(&auxtrace_snapshot_trigger);
3c1cb7e3 952 trigger_ready(&switch_output_trigger);
649c48a9 953 for (;;) {
9f065194 954 unsigned long long hits = rec->samples;
de9ac07b 955
05737464
WN
956 /*
957 * rec->evlist->bkw_mmap_state is possible to be
958 * BKW_MMAP_EMPTY here: when done == true and
959 * hits != rec->samples in previous round.
960 *
961 * perf_evlist__toggle_bkw_mmap ensure we never
962 * convert BKW_MMAP_EMPTY to BKW_MMAP_DATA_PENDING.
963 */
964 if (trigger_is_hit(&switch_output_trigger) || done || draining)
965 perf_evlist__toggle_bkw_mmap(rec->evlist, BKW_MMAP_DATA_PENDING);
966
8c6f45a7 967 if (record__mmap_read_all(rec) < 0) {
5f9cf599 968 trigger_error(&auxtrace_snapshot_trigger);
3c1cb7e3 969 trigger_error(&switch_output_trigger);
8d3eca20 970 err = -1;
45604710 971 goto out_child;
8d3eca20 972 }
de9ac07b 973
2dd6d8a1
AH
974 if (auxtrace_record__snapshot_started) {
975 auxtrace_record__snapshot_started = 0;
5f9cf599 976 if (!trigger_is_error(&auxtrace_snapshot_trigger))
2dd6d8a1 977 record__read_auxtrace_snapshot(rec);
5f9cf599 978 if (trigger_is_error(&auxtrace_snapshot_trigger)) {
2dd6d8a1
AH
979 pr_err("AUX area tracing snapshot failed\n");
980 err = -1;
981 goto out_child;
982 }
983 }
984
3c1cb7e3 985 if (trigger_is_hit(&switch_output_trigger)) {
05737464
WN
986 /*
987 * If switch_output_trigger is hit, the data in
988 * overwritable ring buffer should have been collected,
989 * so bkw_mmap_state should be set to BKW_MMAP_EMPTY.
990 *
991 * If SIGUSR2 raise after or during record__mmap_read_all(),
992 * record__mmap_read_all() didn't collect data from
993 * overwritable ring buffer. Read again.
994 */
995 if (rec->evlist->bkw_mmap_state == BKW_MMAP_RUNNING)
996 continue;
3c1cb7e3
WN
997 trigger_ready(&switch_output_trigger);
998
05737464
WN
999 /*
1000 * Reenable events in overwrite ring buffer after
1001 * record__mmap_read_all(): we should have collected
1002 * data from it.
1003 */
1004 perf_evlist__toggle_bkw_mmap(rec->evlist, BKW_MMAP_RUNNING);
1005
3c1cb7e3
WN
1006 if (!quiet)
1007 fprintf(stderr, "[ perf record: dump data: Woken up %ld times ]\n",
1008 waking);
1009 waking = 0;
1010 fd = record__switch_output(rec, false);
1011 if (fd < 0) {
1012 pr_err("Failed to switch to new file\n");
1013 trigger_error(&switch_output_trigger);
1014 err = fd;
1015 goto out_child;
1016 }
1017 }
1018
d20deb64 1019 if (hits == rec->samples) {
6dcf45ef 1020 if (done || draining)
649c48a9 1021 break;
f66a889d 1022 err = perf_evlist__poll(rec->evlist, -1);
a515114f
JO
1023 /*
1024 * Propagate error, only if there's any. Ignore positive
1025 * number of returned events and interrupt error.
1026 */
1027 if (err > 0 || (err < 0 && errno == EINTR))
45604710 1028 err = 0;
8b412664 1029 waking++;
6dcf45ef
ACM
1030
1031 if (perf_evlist__filter_pollfd(rec->evlist, POLLERR | POLLHUP) == 0)
1032 draining = true;
8b412664
PZ
1033 }
1034
774cb499
JO
1035 /*
1036 * When perf is starting the traced process, at the end events
1037 * die with the process and we wait for that. Thus no need to
1038 * disable events in this case.
1039 */
602ad878 1040 if (done && !disabled && !target__none(&opts->target)) {
5f9cf599 1041 trigger_off(&auxtrace_snapshot_trigger);
3e2be2da 1042 perf_evlist__disable(rec->evlist);
2711926a
JO
1043 disabled = true;
1044 }
de9ac07b 1045 }
5f9cf599 1046 trigger_off(&auxtrace_snapshot_trigger);
3c1cb7e3 1047 trigger_off(&switch_output_trigger);
de9ac07b 1048
f33cbe72 1049 if (forks && workload_exec_errno) {
35550da3 1050 char msg[STRERR_BUFSIZE];
c8b5f2c9 1051 const char *emsg = str_error_r(workload_exec_errno, msg, sizeof(msg));
f33cbe72
ACM
1052 pr_err("Workload failed: %s\n", emsg);
1053 err = -1;
45604710 1054 goto out_child;
f33cbe72
ACM
1055 }
1056
e3d59112 1057 if (!quiet)
45604710 1058 fprintf(stderr, "[ perf record: Woken up %ld times to write data ]\n", waking);
b44308f5 1059
45604710
NK
1060out_child:
1061 if (forks) {
1062 int exit_status;
addc2785 1063
45604710
NK
1064 if (!child_finished)
1065 kill(rec->evlist->workload.pid, SIGTERM);
1066
1067 wait(&exit_status);
1068
1069 if (err < 0)
1070 status = err;
1071 else if (WIFEXITED(exit_status))
1072 status = WEXITSTATUS(exit_status);
1073 else if (WIFSIGNALED(exit_status))
1074 signr = WTERMSIG(exit_status);
1075 } else
1076 status = err;
1077
e3d59112
NK
1078 /* this will be recalculated during process_buildids() */
1079 rec->samples = 0;
1080
ecfd7a9c
WN
1081 if (!err) {
1082 if (!rec->timestamp_filename) {
1083 record__finish_output(rec);
1084 } else {
1085 fd = record__switch_output(rec, true);
1086 if (fd < 0) {
1087 status = fd;
1088 goto out_delete_session;
1089 }
1090 }
1091 }
39d17dac 1092
e3d59112
NK
1093 if (!err && !quiet) {
1094 char samples[128];
ecfd7a9c
WN
1095 const char *postfix = rec->timestamp_filename ?
1096 ".<timestamp>" : "";
e3d59112 1097
ef149c25 1098 if (rec->samples && !rec->opts.full_auxtrace)
e3d59112
NK
1099 scnprintf(samples, sizeof(samples),
1100 " (%" PRIu64 " samples)", rec->samples);
1101 else
1102 samples[0] = '\0';
1103
ecfd7a9c 1104 fprintf(stderr, "[ perf record: Captured and wrote %.3f MB %s%s%s ]\n",
e3d59112 1105 perf_data_file__size(file) / 1024.0 / 1024.0,
ecfd7a9c 1106 file->path, postfix, samples);
e3d59112
NK
1107 }
1108
39d17dac
ACM
1109out_delete_session:
1110 perf_session__delete(session);
45604710 1111 return status;
de9ac07b 1112}
0e9b20b8 1113
0883e820 1114static void callchain_debug(struct callchain_param *callchain)
09b0fd45 1115{
aad2b21c 1116 static const char *str[CALLCHAIN_MAX] = { "NONE", "FP", "DWARF", "LBR" };
a601fdff 1117
0883e820 1118 pr_debug("callchain: type %s\n", str[callchain->record_mode]);
26d33022 1119
0883e820 1120 if (callchain->record_mode == CALLCHAIN_DWARF)
09b0fd45 1121 pr_debug("callchain: stack dump size %d\n",
0883e820 1122 callchain->dump_size);
09b0fd45
JO
1123}
1124
0883e820
ACM
1125int record_opts__parse_callchain(struct record_opts *record,
1126 struct callchain_param *callchain,
1127 const char *arg, bool unset)
09b0fd45 1128{
09b0fd45 1129 int ret;
0883e820 1130 callchain->enabled = !unset;
eb853e80 1131
09b0fd45
JO
1132 /* --no-call-graph */
1133 if (unset) {
0883e820 1134 callchain->record_mode = CALLCHAIN_NONE;
09b0fd45
JO
1135 pr_debug("callchain: disabled\n");
1136 return 0;
1137 }
1138
0883e820 1139 ret = parse_callchain_record_opt(arg, callchain);
5c0cf224
JO
1140 if (!ret) {
1141 /* Enable data address sampling for DWARF unwind. */
0883e820 1142 if (callchain->record_mode == CALLCHAIN_DWARF)
5c0cf224 1143 record->sample_address = true;
0883e820 1144 callchain_debug(callchain);
5c0cf224 1145 }
26d33022
JO
1146
1147 return ret;
1148}
1149
0883e820
ACM
1150int record_parse_callchain_opt(const struct option *opt,
1151 const char *arg,
1152 int unset)
1153{
1154 return record_opts__parse_callchain(opt->value, &callchain_param, arg, unset);
1155}
1156
c421e80b 1157int record_callchain_opt(const struct option *opt,
09b0fd45
JO
1158 const char *arg __maybe_unused,
1159 int unset __maybe_unused)
1160{
2ddd5c04 1161 struct callchain_param *callchain = opt->value;
c421e80b 1162
2ddd5c04 1163 callchain->enabled = true;
09b0fd45 1164
2ddd5c04
ACM
1165 if (callchain->record_mode == CALLCHAIN_NONE)
1166 callchain->record_mode = CALLCHAIN_FP;
eb853e80 1167
2ddd5c04 1168 callchain_debug(callchain);
09b0fd45
JO
1169 return 0;
1170}
1171
eb853e80
JO
1172static int perf_record_config(const char *var, const char *value, void *cb)
1173{
7a29c087
NK
1174 struct record *rec = cb;
1175
1176 if (!strcmp(var, "record.build-id")) {
1177 if (!strcmp(value, "cache"))
1178 rec->no_buildid_cache = false;
1179 else if (!strcmp(value, "no-cache"))
1180 rec->no_buildid_cache = true;
1181 else if (!strcmp(value, "skip"))
1182 rec->no_buildid = true;
1183 else
1184 return -1;
1185 return 0;
1186 }
eb853e80 1187 if (!strcmp(var, "record.call-graph"))
5a2e5e85 1188 var = "call-graph.record-mode"; /* fall-through */
eb853e80
JO
1189
1190 return perf_default_config(var, value, cb);
1191}
1192
814c8c38
PZ
1193struct clockid_map {
1194 const char *name;
1195 int clockid;
1196};
1197
1198#define CLOCKID_MAP(n, c) \
1199 { .name = n, .clockid = (c), }
1200
1201#define CLOCKID_END { .name = NULL, }
1202
1203
1204/*
1205 * Add the missing ones, we need to build on many distros...
1206 */
1207#ifndef CLOCK_MONOTONIC_RAW
1208#define CLOCK_MONOTONIC_RAW 4
1209#endif
1210#ifndef CLOCK_BOOTTIME
1211#define CLOCK_BOOTTIME 7
1212#endif
1213#ifndef CLOCK_TAI
1214#define CLOCK_TAI 11
1215#endif
1216
1217static const struct clockid_map clockids[] = {
1218 /* available for all events, NMI safe */
1219 CLOCKID_MAP("monotonic", CLOCK_MONOTONIC),
1220 CLOCKID_MAP("monotonic_raw", CLOCK_MONOTONIC_RAW),
1221
1222 /* available for some events */
1223 CLOCKID_MAP("realtime", CLOCK_REALTIME),
1224 CLOCKID_MAP("boottime", CLOCK_BOOTTIME),
1225 CLOCKID_MAP("tai", CLOCK_TAI),
1226
1227 /* available for the lazy */
1228 CLOCKID_MAP("mono", CLOCK_MONOTONIC),
1229 CLOCKID_MAP("raw", CLOCK_MONOTONIC_RAW),
1230 CLOCKID_MAP("real", CLOCK_REALTIME),
1231 CLOCKID_MAP("boot", CLOCK_BOOTTIME),
1232
1233 CLOCKID_END,
1234};
1235
1236static int parse_clockid(const struct option *opt, const char *str, int unset)
1237{
1238 struct record_opts *opts = (struct record_opts *)opt->value;
1239 const struct clockid_map *cm;
1240 const char *ostr = str;
1241
1242 if (unset) {
1243 opts->use_clockid = 0;
1244 return 0;
1245 }
1246
1247 /* no arg passed */
1248 if (!str)
1249 return 0;
1250
1251 /* no setting it twice */
1252 if (opts->use_clockid)
1253 return -1;
1254
1255 opts->use_clockid = true;
1256
1257 /* if its a number, we're done */
1258 if (sscanf(str, "%d", &opts->clockid) == 1)
1259 return 0;
1260
1261 /* allow a "CLOCK_" prefix to the name */
1262 if (!strncasecmp(str, "CLOCK_", 6))
1263 str += 6;
1264
1265 for (cm = clockids; cm->name; cm++) {
1266 if (!strcasecmp(str, cm->name)) {
1267 opts->clockid = cm->clockid;
1268 return 0;
1269 }
1270 }
1271
1272 opts->use_clockid = false;
1273 ui__warning("unknown clockid %s, check man page\n", ostr);
1274 return -1;
1275}
1276
e9db1310
AH
1277static int record__parse_mmap_pages(const struct option *opt,
1278 const char *str,
1279 int unset __maybe_unused)
1280{
1281 struct record_opts *opts = opt->value;
1282 char *s, *p;
1283 unsigned int mmap_pages;
1284 int ret;
1285
1286 if (!str)
1287 return -EINVAL;
1288
1289 s = strdup(str);
1290 if (!s)
1291 return -ENOMEM;
1292
1293 p = strchr(s, ',');
1294 if (p)
1295 *p = '\0';
1296
1297 if (*s) {
1298 ret = __perf_evlist__parse_mmap_pages(&mmap_pages, s);
1299 if (ret)
1300 goto out_free;
1301 opts->mmap_pages = mmap_pages;
1302 }
1303
1304 if (!p) {
1305 ret = 0;
1306 goto out_free;
1307 }
1308
1309 ret = __perf_evlist__parse_mmap_pages(&mmap_pages, p + 1);
1310 if (ret)
1311 goto out_free;
1312
1313 opts->auxtrace_mmap_pages = mmap_pages;
1314
1315out_free:
1316 free(s);
1317 return ret;
1318}
1319
e5b2c207 1320static const char * const __record_usage[] = {
9e096753
MG
1321 "perf record [<options>] [<command>]",
1322 "perf record [<options>] -- <command> [<options>]",
0e9b20b8
IM
1323 NULL
1324};
e5b2c207 1325const char * const *record_usage = __record_usage;
0e9b20b8 1326
d20deb64 1327/*
8c6f45a7
ACM
1328 * XXX Ideally would be local to cmd_record() and passed to a record__new
1329 * because we need to have access to it in record__exit, that is called
d20deb64
ACM
1330 * after cmd_record() exits, but since record_options need to be accessible to
1331 * builtin-script, leave it here.
1332 *
1333 * At least we don't ouch it in all the other functions here directly.
1334 *
1335 * Just say no to tons of global variables, sigh.
1336 */
8c6f45a7 1337static struct record record = {
d20deb64 1338 .opts = {
8affc2b8 1339 .sample_time = true,
d20deb64
ACM
1340 .mmap_pages = UINT_MAX,
1341 .user_freq = UINT_MAX,
1342 .user_interval = ULLONG_MAX,
447a6013 1343 .freq = 4000,
d1cb9fce
NK
1344 .target = {
1345 .uses_mmap = true,
3aa5939d 1346 .default_per_cpu = true,
d1cb9fce 1347 },
9d9cad76 1348 .proc_map_timeout = 500,
d20deb64 1349 },
e3d59112
NK
1350 .tool = {
1351 .sample = process_sample_event,
1352 .fork = perf_event__process_fork,
cca8482c 1353 .exit = perf_event__process_exit,
e3d59112
NK
1354 .comm = perf_event__process_comm,
1355 .mmap = perf_event__process_mmap,
1356 .mmap2 = perf_event__process_mmap2,
cca8482c 1357 .ordered_events = true,
e3d59112 1358 },
d20deb64 1359};
7865e817 1360
76a26549
NK
1361const char record_callchain_help[] = CALLCHAIN_RECORD_HELP
1362 "\n\t\t\t\tDefault: fp";
61eaa3be 1363
0aab2136
WN
1364static bool dry_run;
1365
d20deb64
ACM
1366/*
1367 * XXX Will stay a global variable till we fix builtin-script.c to stop messing
1368 * with it and switch to use the library functions in perf_evlist that came
b4006796 1369 * from builtin-record.c, i.e. use record_opts,
d20deb64
ACM
1370 * perf_evlist__prepare_workload, etc instead of fork+exec'in 'perf record',
1371 * using pipes, etc.
1372 */
e5b2c207 1373struct option __record_options[] = {
d20deb64 1374 OPT_CALLBACK('e', "event", &record.evlist, "event",
86847b62 1375 "event selector. use 'perf list' to list available events",
f120f9d5 1376 parse_events_option),
d20deb64 1377 OPT_CALLBACK(0, "filter", &record.evlist, "filter",
c171b552 1378 "event filter", parse_filter),
4ba1faa1
WN
1379 OPT_CALLBACK_NOOPT(0, "exclude-perf", &record.evlist,
1380 NULL, "don't record events from perf itself",
1381 exclude_perf),
bea03405 1382 OPT_STRING('p', "pid", &record.opts.target.pid, "pid",
d6d901c2 1383 "record events on existing process id"),
bea03405 1384 OPT_STRING('t', "tid", &record.opts.target.tid, "tid",
d6d901c2 1385 "record events on existing thread id"),
d20deb64 1386 OPT_INTEGER('r', "realtime", &record.realtime_prio,
0e9b20b8 1387 "collect data with this RT SCHED_FIFO priority"),
509051ea 1388 OPT_BOOLEAN(0, "no-buffering", &record.opts.no_buffering,
acac03fa 1389 "collect data without buffering"),
d20deb64 1390 OPT_BOOLEAN('R', "raw-samples", &record.opts.raw_samples,
daac07b2 1391 "collect raw sample records from all opened counters"),
bea03405 1392 OPT_BOOLEAN('a', "all-cpus", &record.opts.target.system_wide,
0e9b20b8 1393 "system-wide collection from all CPUs"),
bea03405 1394 OPT_STRING('C', "cpu", &record.opts.target.cpu_list, "cpu",
c45c6ea2 1395 "list of cpus to monitor"),
d20deb64 1396 OPT_U64('c', "count", &record.opts.user_interval, "event period to sample"),
f5fc1412 1397 OPT_STRING('o', "output", &record.file.path, "file",
abaff32a 1398 "output file name"),
69e7e5b0
AH
1399 OPT_BOOLEAN_SET('i', "no-inherit", &record.opts.no_inherit,
1400 &record.opts.no_inherit_set,
1401 "child tasks do not inherit counters"),
d20deb64 1402 OPT_UINTEGER('F', "freq", &record.opts.user_freq, "profile at this frequency"),
e9db1310
AH
1403 OPT_CALLBACK('m', "mmap-pages", &record.opts, "pages[,pages]",
1404 "number of mmap data pages and AUX area tracing mmap pages",
1405 record__parse_mmap_pages),
d20deb64 1406 OPT_BOOLEAN(0, "group", &record.opts.group,
43bece79 1407 "put the counters into a counter group"),
2ddd5c04 1408 OPT_CALLBACK_NOOPT('g', NULL, &callchain_param,
09b0fd45
JO
1409 NULL, "enables call-graph recording" ,
1410 &record_callchain_opt),
1411 OPT_CALLBACK(0, "call-graph", &record.opts,
76a26549 1412 "record_mode[,record_size]", record_callchain_help,
09b0fd45 1413 &record_parse_callchain_opt),
c0555642 1414 OPT_INCR('v', "verbose", &verbose,
3da297a6 1415 "be more verbose (show counter open errors, etc)"),
b44308f5 1416 OPT_BOOLEAN('q', "quiet", &quiet, "don't print any message"),
d20deb64 1417 OPT_BOOLEAN('s', "stat", &record.opts.inherit_stat,
649c48a9 1418 "per thread counts"),
56100321 1419 OPT_BOOLEAN('d', "data", &record.opts.sample_address, "Record the sample addresses"),
3abebc55
AH
1420 OPT_BOOLEAN_SET('T', "timestamp", &record.opts.sample_time,
1421 &record.opts.sample_time_set,
1422 "Record the sample timestamps"),
56100321 1423 OPT_BOOLEAN('P', "period", &record.opts.period, "Record the sample period"),
d20deb64 1424 OPT_BOOLEAN('n', "no-samples", &record.opts.no_samples,
649c48a9 1425 "don't sample"),
d2db9a98
WN
1426 OPT_BOOLEAN_SET('N', "no-buildid-cache", &record.no_buildid_cache,
1427 &record.no_buildid_cache_set,
1428 "do not update the buildid cache"),
1429 OPT_BOOLEAN_SET('B', "no-buildid", &record.no_buildid,
1430 &record.no_buildid_set,
1431 "do not collect buildids in perf.data"),
d20deb64 1432 OPT_CALLBACK('G', "cgroup", &record.evlist, "name",
023695d9
SE
1433 "monitor event in cgroup name only",
1434 parse_cgroups),
a6205a35 1435 OPT_UINTEGER('D', "delay", &record.opts.initial_delay,
6619a53e 1436 "ms to wait before starting measurement after program start"),
bea03405
NK
1437 OPT_STRING('u', "uid", &record.opts.target.uid_str, "user",
1438 "user to profile"),
a5aabdac
SE
1439
1440 OPT_CALLBACK_NOOPT('b', "branch-any", &record.opts.branch_stack,
1441 "branch any", "sample any taken branches",
1442 parse_branch_stack),
1443
1444 OPT_CALLBACK('j', "branch-filter", &record.opts.branch_stack,
1445 "branch filter mask", "branch stack filter modes",
bdfebd84 1446 parse_branch_stack),
05484298
AK
1447 OPT_BOOLEAN('W', "weight", &record.opts.sample_weight,
1448 "sample by weight (on special events only)"),
475eeab9
AK
1449 OPT_BOOLEAN(0, "transaction", &record.opts.sample_transaction,
1450 "sample transaction flags (special events only)"),
3aa5939d
AH
1451 OPT_BOOLEAN(0, "per-thread", &record.opts.target.per_thread,
1452 "use per-thread mmaps"),
bcc84ec6
SE
1453 OPT_CALLBACK_OPTARG('I', "intr-regs", &record.opts.sample_intr_regs, NULL, "any register",
1454 "sample selected machine registers on interrupt,"
1455 " use -I ? to list register names", parse_regs),
85c273d2
AK
1456 OPT_BOOLEAN(0, "running-time", &record.opts.running_time,
1457 "Record running/enabled time of read (:S) events"),
814c8c38
PZ
1458 OPT_CALLBACK('k', "clockid", &record.opts,
1459 "clockid", "clockid to use for events, see clock_gettime()",
1460 parse_clockid),
2dd6d8a1
AH
1461 OPT_STRING_OPTARG('S', "snapshot", &record.opts.auxtrace_snapshot_opts,
1462 "opts", "AUX area tracing Snapshot Mode", ""),
9d9cad76
KL
1463 OPT_UINTEGER(0, "proc-map-timeout", &record.opts.proc_map_timeout,
1464 "per thread proc mmap processing timeout in ms"),
b757bb09
AH
1465 OPT_BOOLEAN(0, "switch-events", &record.opts.record_switch_events,
1466 "Record context switch events"),
85723885
JO
1467 OPT_BOOLEAN_FLAG(0, "all-kernel", &record.opts.all_kernel,
1468 "Configure all used events to run in kernel space.",
1469 PARSE_OPT_EXCLUSIVE),
1470 OPT_BOOLEAN_FLAG(0, "all-user", &record.opts.all_user,
1471 "Configure all used events to run in user space.",
1472 PARSE_OPT_EXCLUSIVE),
71dc2326
WN
1473 OPT_STRING(0, "clang-path", &llvm_param.clang_path, "clang path",
1474 "clang binary to use for compiling BPF scriptlets"),
1475 OPT_STRING(0, "clang-opt", &llvm_param.clang_opt, "clang options",
1476 "options passed to clang when compiling BPF scriptlets"),
7efe0e03
HK
1477 OPT_STRING(0, "vmlinux", &symbol_conf.vmlinux_name,
1478 "file", "vmlinux pathname"),
6156681b
NK
1479 OPT_BOOLEAN(0, "buildid-all", &record.buildid_all,
1480 "Record build-id of all DSOs regardless of hits"),
ecfd7a9c
WN
1481 OPT_BOOLEAN(0, "timestamp-filename", &record.timestamp_filename,
1482 "append timestamp to output filename"),
3c1cb7e3
WN
1483 OPT_BOOLEAN(0, "switch-output", &record.switch_output,
1484 "Switch output when receive SIGUSR2"),
0aab2136
WN
1485 OPT_BOOLEAN(0, "dry-run", &dry_run,
1486 "Parse options then exit"),
0e9b20b8
IM
1487 OPT_END()
1488};
1489
e5b2c207
NK
1490struct option *record_options = __record_options;
1491
1d037ca1 1492int cmd_record(int argc, const char **argv, const char *prefix __maybe_unused)
0e9b20b8 1493{
ef149c25 1494 int err;
8c6f45a7 1495 struct record *rec = &record;
16ad2ffb 1496 char errbuf[BUFSIZ];
0e9b20b8 1497
48e1cab1
WN
1498#ifndef HAVE_LIBBPF_SUPPORT
1499# define set_nobuild(s, l, c) set_option_nobuild(record_options, s, l, "NO_LIBBPF=1", c)
1500 set_nobuild('\0', "clang-path", true);
1501 set_nobuild('\0', "clang-opt", true);
1502# undef set_nobuild
7efe0e03
HK
1503#endif
1504
1505#ifndef HAVE_BPF_PROLOGUE
1506# if !defined (HAVE_DWARF_SUPPORT)
1507# define REASON "NO_DWARF=1"
1508# elif !defined (HAVE_LIBBPF_SUPPORT)
1509# define REASON "NO_LIBBPF=1"
1510# else
1511# define REASON "this architecture doesn't support BPF prologue"
1512# endif
1513# define set_nobuild(s, l, c) set_option_nobuild(record_options, s, l, REASON, c)
1514 set_nobuild('\0', "vmlinux", true);
1515# undef set_nobuild
1516# undef REASON
48e1cab1
WN
1517#endif
1518
3e2be2da
ACM
1519 rec->evlist = perf_evlist__new();
1520 if (rec->evlist == NULL)
361c99a6
ACM
1521 return -ENOMEM;
1522
eb853e80
JO
1523 perf_config(perf_record_config, rec);
1524
bca647aa 1525 argc = parse_options(argc, argv, record_options, record_usage,
655000e7 1526 PARSE_OPT_STOP_AT_NON_OPTION);
602ad878 1527 if (!argc && target__none(&rec->opts.target))
bca647aa 1528 usage_with_options(record_usage, record_options);
0e9b20b8 1529
bea03405 1530 if (nr_cgroups && !rec->opts.target.system_wide) {
c7118369
NK
1531 usage_with_options_msg(record_usage, record_options,
1532 "cgroup monitoring only available in system-wide mode");
1533
023695d9 1534 }
b757bb09
AH
1535 if (rec->opts.record_switch_events &&
1536 !perf_can_record_switch_events()) {
c7118369
NK
1537 ui__error("kernel does not support recording context switch events\n");
1538 parse_options_usage(record_usage, record_options, "switch-events", 0);
1539 return -EINVAL;
b757bb09 1540 }
023695d9 1541
eca857ab
WN
1542 if (rec->switch_output)
1543 rec->timestamp_filename = true;
1544
ef149c25
AH
1545 if (!rec->itr) {
1546 rec->itr = auxtrace_record__init(rec->evlist, &err);
1547 if (err)
1548 return err;
1549 }
1550
2dd6d8a1
AH
1551 err = auxtrace_parse_snapshot_options(rec->itr, &rec->opts,
1552 rec->opts.auxtrace_snapshot_opts);
1553 if (err)
1554 return err;
1555
0aab2136
WN
1556 if (dry_run)
1557 return 0;
1558
d7888573
WN
1559 err = bpf__setup_stdout(rec->evlist);
1560 if (err) {
1561 bpf__strerror_setup_stdout(rec->evlist, err, errbuf, sizeof(errbuf));
1562 pr_err("ERROR: Setup BPF stdout failed: %s\n",
1563 errbuf);
1564 return err;
1565 }
1566
ef149c25
AH
1567 err = -ENOMEM;
1568
0a7e6d1b 1569 symbol__init(NULL);
baa2f6ce 1570
ec80fde7 1571 if (symbol_conf.kptr_restrict)
646aaea6
ACM
1572 pr_warning(
1573"WARNING: Kernel address maps (/proc/{kallsyms,modules}) are restricted,\n"
1574"check /proc/sys/kernel/kptr_restrict.\n\n"
1575"Samples in kernel functions may not be resolved if a suitable vmlinux\n"
1576"file is not found in the buildid cache or in the vmlinux path.\n\n"
1577"Samples in kernel modules won't be resolved at all.\n\n"
1578"If some relocation was applied (e.g. kexec) symbols may be misresolved\n"
1579"even with a suitable vmlinux or kallsyms file.\n\n");
ec80fde7 1580
0c1d46a8 1581 if (rec->no_buildid_cache || rec->no_buildid) {
a1ac1d3c 1582 disable_buildid_cache();
0c1d46a8
WN
1583 } else if (rec->switch_output) {
1584 /*
1585 * In 'perf record --switch-output', disable buildid
1586 * generation by default to reduce data file switching
1587 * overhead. Still generate buildid if they are required
1588 * explicitly using
1589 *
1590 * perf record --signal-trigger --no-no-buildid \
1591 * --no-no-buildid-cache
1592 *
1593 * Following code equals to:
1594 *
1595 * if ((rec->no_buildid || !rec->no_buildid_set) &&
1596 * (rec->no_buildid_cache || !rec->no_buildid_cache_set))
1597 * disable_buildid_cache();
1598 */
1599 bool disable = true;
1600
1601 if (rec->no_buildid_set && !rec->no_buildid)
1602 disable = false;
1603 if (rec->no_buildid_cache_set && !rec->no_buildid_cache)
1604 disable = false;
1605 if (disable) {
1606 rec->no_buildid = true;
1607 rec->no_buildid_cache = true;
1608 disable_buildid_cache();
1609 }
1610 }
655000e7 1611
3e2be2da
ACM
1612 if (rec->evlist->nr_entries == 0 &&
1613 perf_evlist__add_default(rec->evlist) < 0) {
69aad6f1
ACM
1614 pr_err("Not enough memory for event selector list\n");
1615 goto out_symbol_exit;
bbd36e5e 1616 }
0e9b20b8 1617
69e7e5b0
AH
1618 if (rec->opts.target.tid && !rec->opts.no_inherit_set)
1619 rec->opts.no_inherit = true;
1620
602ad878 1621 err = target__validate(&rec->opts.target);
16ad2ffb 1622 if (err) {
602ad878 1623 target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
16ad2ffb
NK
1624 ui__warning("%s", errbuf);
1625 }
1626
602ad878 1627 err = target__parse_uid(&rec->opts.target);
16ad2ffb
NK
1628 if (err) {
1629 int saved_errno = errno;
4bd0f2d2 1630
602ad878 1631 target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
3780f488 1632 ui__error("%s", errbuf);
16ad2ffb
NK
1633
1634 err = -saved_errno;
8fa60e1f 1635 goto out_symbol_exit;
16ad2ffb 1636 }
0d37aa34 1637
16ad2ffb 1638 err = -ENOMEM;
3e2be2da 1639 if (perf_evlist__create_maps(rec->evlist, &rec->opts.target) < 0)
dd7927f4 1640 usage_with_options(record_usage, record_options);
69aad6f1 1641
ef149c25
AH
1642 err = auxtrace_record__options(rec->itr, rec->evlist, &rec->opts);
1643 if (err)
1644 goto out_symbol_exit;
1645
6156681b
NK
1646 /*
1647 * We take all buildids when the file contains
1648 * AUX area tracing data because we do not decode the
1649 * trace because it would take too long.
1650 */
1651 if (rec->opts.full_auxtrace)
1652 rec->buildid_all = true;
1653
b4006796 1654 if (record_opts__config(&rec->opts)) {
39d17dac 1655 err = -EINVAL;
03ad9747 1656 goto out_symbol_exit;
7e4ff9e3
MG
1657 }
1658
d20deb64 1659 err = __cmd_record(&record, argc, argv);
d65a458b 1660out_symbol_exit:
45604710 1661 perf_evlist__delete(rec->evlist);
d65a458b 1662 symbol__exit();
ef149c25 1663 auxtrace_record__free(rec->itr);
39d17dac 1664 return err;
0e9b20b8 1665}
2dd6d8a1
AH
1666
1667static void snapshot_sig_handler(int sig __maybe_unused)
1668{
5f9cf599
WN
1669 if (trigger_is_ready(&auxtrace_snapshot_trigger)) {
1670 trigger_hit(&auxtrace_snapshot_trigger);
1671 auxtrace_record__snapshot_started = 1;
1672 if (auxtrace_record__snapshot_start(record.itr))
1673 trigger_error(&auxtrace_snapshot_trigger);
1674 }
3c1cb7e3
WN
1675
1676 if (trigger_is_ready(&switch_output_trigger))
1677 trigger_hit(&switch_output_trigger);
2dd6d8a1 1678}