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.
12 #include "util/build-id.h"
13 #include "util/util.h"
14 #include <subcmd/parse-options.h>
15 #include "util/parse-events.h"
17 #include "util/callchain.h"
18 #include "util/cgroup.h"
19 #include "util/header.h"
20 #include "util/event.h"
21 #include "util/evlist.h"
22 #include "util/evsel.h"
23 #include "util/debug.h"
24 #include "util/session.h"
25 #include "util/tool.h"
26 #include "util/symbol.h"
27 #include "util/cpumap.h"
28 #include "util/thread_map.h"
29 #include "util/data.h"
30 #include "util/perf_regs.h"
31 #include "util/auxtrace.h"
33 #include "util/parse-branch-options.h"
34 #include "util/parse-regs-options.h"
35 #include "util/llvm-utils.h"
36 #include "util/bpf-loader.h"
37 #include "util/trigger.h"
47 struct perf_tool tool
;
48 struct record_opts opts
;
50 struct perf_data_file file
;
51 struct auxtrace_record
*itr
;
52 struct perf_evlist
*evlist
;
53 struct perf_session
*session
;
58 bool no_buildid_cache
;
59 bool no_buildid_cache_set
;
61 bool timestamp_filename
;
63 unsigned long long samples
;
66 static int record__write(struct record
*rec
, void *bf
, size_t size
)
68 if (perf_data_file__write(rec
->session
->file
, bf
, size
) < 0) {
69 pr_err("failed to write perf data, error: %m\n");
73 rec
->bytes_written
+= size
;
77 static int process_synthesized_event(struct perf_tool
*tool
,
78 union perf_event
*event
,
79 struct perf_sample
*sample __maybe_unused
,
80 struct machine
*machine __maybe_unused
)
82 struct record
*rec
= container_of(tool
, struct record
, tool
);
83 return record__write(rec
, event
, event
->header
.size
);
87 backward_rb_find_range(void *buf
, int mask
, u64 head
, u64
*start
, u64
*end
)
89 struct perf_event_header
*pheader
;
93 pr_debug2("backward_rb_find_range: buf=%p, head=%"PRIx64
"\n", buf
, head
);
94 pheader
= (struct perf_event_header
*)(buf
+ (head
& mask
));
97 if (evt_head
- head
>= (unsigned int)size
) {
98 pr_debug("Finshed reading backward ring buffer: rewind\n");
99 if (evt_head
- head
> (unsigned int)size
)
100 evt_head
-= pheader
->size
;
105 pheader
= (struct perf_event_header
*)(buf
+ (evt_head
& mask
));
107 if (pheader
->size
== 0) {
108 pr_debug("Finshed reading backward ring buffer: get start\n");
113 evt_head
+= pheader
->size
;
114 pr_debug3("move evt_head: %"PRIx64
"\n", evt_head
);
116 WARN_ONCE(1, "Shouldn't get here\n");
121 rb_find_range(struct perf_evlist
*evlist
,
122 void *data
, int mask
, u64 head
, u64 old
,
123 u64
*start
, u64
*end
)
125 if (!evlist
->backward
) {
131 return backward_rb_find_range(data
, mask
, head
, start
, end
);
134 static int record__mmap_read(struct record
*rec
, int idx
)
136 struct perf_mmap
*md
= &rec
->evlist
->mmap
[idx
];
137 u64 head
= perf_mmap__read_head(md
);
139 u64 end
= head
, start
= old
;
140 unsigned char *data
= md
->base
+ page_size
;
145 if (rb_find_range(rec
->evlist
, data
, md
->mask
, head
,
155 if (size
> (unsigned long)(md
->mask
) + 1) {
156 WARN_ONCE(1, "failed to keep up with mmap data. (warn only once)\n");
159 perf_evlist__mmap_consume(rec
->evlist
, idx
);
163 if ((start
& md
->mask
) + size
!= (end
& md
->mask
)) {
164 buf
= &data
[start
& md
->mask
];
165 size
= md
->mask
+ 1 - (start
& md
->mask
);
168 if (record__write(rec
, buf
, size
) < 0) {
174 buf
= &data
[start
& md
->mask
];
178 if (record__write(rec
, buf
, size
) < 0) {
184 perf_evlist__mmap_consume(rec
->evlist
, idx
);
189 static volatile int done
;
190 static volatile int signr
= -1;
191 static volatile int child_finished
;
193 static volatile int auxtrace_record__snapshot_started
;
194 static DEFINE_TRIGGER(auxtrace_snapshot_trigger
);
195 static DEFINE_TRIGGER(switch_output_trigger
);
197 static void sig_handler(int sig
)
207 static void record__sig_exit(void)
212 signal(signr
, SIG_DFL
);
216 #ifdef HAVE_AUXTRACE_SUPPORT
218 static int record__process_auxtrace(struct perf_tool
*tool
,
219 union perf_event
*event
, void *data1
,
220 size_t len1
, void *data2
, size_t len2
)
222 struct record
*rec
= container_of(tool
, struct record
, tool
);
223 struct perf_data_file
*file
= &rec
->file
;
227 if (!perf_data_file__is_pipe(file
)) {
229 int fd
= perf_data_file__fd(file
);
232 file_offset
= lseek(fd
, 0, SEEK_CUR
);
233 if (file_offset
== -1)
235 err
= auxtrace_index__auxtrace_event(&rec
->session
->auxtrace_index
,
241 /* event.auxtrace.size includes padding, see __auxtrace_mmap__read() */
242 padding
= (len1
+ len2
) & 7;
244 padding
= 8 - padding
;
246 record__write(rec
, event
, event
->header
.size
);
247 record__write(rec
, data1
, len1
);
249 record__write(rec
, data2
, len2
);
250 record__write(rec
, &pad
, padding
);
255 static int record__auxtrace_mmap_read(struct record
*rec
,
256 struct auxtrace_mmap
*mm
)
260 ret
= auxtrace_mmap__read(mm
, rec
->itr
, &rec
->tool
,
261 record__process_auxtrace
);
271 static int record__auxtrace_mmap_read_snapshot(struct record
*rec
,
272 struct auxtrace_mmap
*mm
)
276 ret
= auxtrace_mmap__read_snapshot(mm
, rec
->itr
, &rec
->tool
,
277 record__process_auxtrace
,
278 rec
->opts
.auxtrace_snapshot_size
);
288 static int record__auxtrace_read_snapshot_all(struct record
*rec
)
293 for (i
= 0; i
< rec
->evlist
->nr_mmaps
; i
++) {
294 struct auxtrace_mmap
*mm
=
295 &rec
->evlist
->mmap
[i
].auxtrace_mmap
;
300 if (record__auxtrace_mmap_read_snapshot(rec
, mm
) != 0) {
309 static void record__read_auxtrace_snapshot(struct record
*rec
)
311 pr_debug("Recording AUX area tracing snapshot\n");
312 if (record__auxtrace_read_snapshot_all(rec
) < 0) {
313 trigger_error(&auxtrace_snapshot_trigger
);
315 if (auxtrace_record__snapshot_finish(rec
->itr
))
316 trigger_error(&auxtrace_snapshot_trigger
);
318 trigger_ready(&auxtrace_snapshot_trigger
);
325 int record__auxtrace_mmap_read(struct record
*rec __maybe_unused
,
326 struct auxtrace_mmap
*mm __maybe_unused
)
332 void record__read_auxtrace_snapshot(struct record
*rec __maybe_unused
)
337 int auxtrace_record__snapshot_start(struct auxtrace_record
*itr __maybe_unused
)
344 static int record__open(struct record
*rec
)
347 struct perf_evsel
*pos
;
348 struct perf_evlist
*evlist
= rec
->evlist
;
349 struct perf_session
*session
= rec
->session
;
350 struct record_opts
*opts
= &rec
->opts
;
353 perf_evlist__config(evlist
, opts
, &callchain_param
);
355 evlist__for_each(evlist
, pos
) {
357 if (perf_evsel__open(pos
, pos
->cpus
, pos
->threads
) < 0) {
358 if (perf_evsel__fallback(pos
, errno
, msg
, sizeof(msg
))) {
360 ui__warning("%s\n", msg
);
365 perf_evsel__open_strerror(pos
, &opts
->target
,
366 errno
, msg
, sizeof(msg
));
367 ui__error("%s\n", msg
);
372 if (perf_evlist__apply_filters(evlist
, &pos
)) {
373 error("failed to set filter \"%s\" on event %s with %d (%s)\n",
374 pos
->filter
, perf_evsel__name(pos
), errno
,
375 strerror_r(errno
, msg
, sizeof(msg
)));
380 if (perf_evlist__mmap_ex(evlist
, opts
->mmap_pages
, false,
381 opts
->auxtrace_mmap_pages
,
382 opts
->auxtrace_snapshot_mode
) < 0) {
383 if (errno
== EPERM
) {
384 pr_err("Permission error mapping pages.\n"
385 "Consider increasing "
386 "/proc/sys/kernel/perf_event_mlock_kb,\n"
387 "or try again with a smaller value of -m/--mmap_pages.\n"
388 "(current value: %u,%u)\n",
389 opts
->mmap_pages
, opts
->auxtrace_mmap_pages
);
392 pr_err("failed to mmap with %d (%s)\n", errno
,
393 strerror_r(errno
, msg
, sizeof(msg
)));
402 session
->evlist
= evlist
;
403 perf_session__set_id_hdr_size(session
);
408 static int process_sample_event(struct perf_tool
*tool
,
409 union perf_event
*event
,
410 struct perf_sample
*sample
,
411 struct perf_evsel
*evsel
,
412 struct machine
*machine
)
414 struct record
*rec
= container_of(tool
, struct record
, tool
);
418 return build_id__mark_dso_hit(tool
, event
, sample
, evsel
, machine
);
421 static int process_buildids(struct record
*rec
)
423 struct perf_data_file
*file
= &rec
->file
;
424 struct perf_session
*session
= rec
->session
;
430 * During this process, it'll load kernel map and replace the
431 * dso->long_name to a real pathname it found. In this case
432 * we prefer the vmlinux path like
433 * /lib/modules/3.16.4/build/vmlinux
435 * rather than build-id path (in debug directory).
436 * $HOME/.debug/.build-id/f0/6e17aa50adf4d00b88925e03775de107611551
438 symbol_conf
.ignore_vmlinux_buildid
= true;
441 * If --buildid-all is given, it marks all DSO regardless of hits,
442 * so no need to process samples.
444 if (rec
->buildid_all
)
445 rec
->tool
.sample
= NULL
;
447 return perf_session__process_events(session
);
450 static void perf_event__synthesize_guest_os(struct machine
*machine
, void *data
)
453 struct perf_tool
*tool
= data
;
455 *As for guest kernel when processing subcommand record&report,
456 *we arrange module mmap prior to guest kernel mmap and trigger
457 *a preload dso because default guest module symbols are loaded
458 *from guest kallsyms instead of /lib/modules/XXX/XXX. This
459 *method is used to avoid symbol missing when the first addr is
460 *in module instead of in guest kernel.
462 err
= perf_event__synthesize_modules(tool
, process_synthesized_event
,
465 pr_err("Couldn't record guest kernel [%d]'s reference"
466 " relocation symbol.\n", machine
->pid
);
469 * We use _stext for guest kernel because guest kernel's /proc/kallsyms
470 * have no _text sometimes.
472 err
= perf_event__synthesize_kernel_mmap(tool
, process_synthesized_event
,
475 pr_err("Couldn't record guest kernel [%d]'s reference"
476 " relocation symbol.\n", machine
->pid
);
479 static struct perf_event_header finished_round_event
= {
480 .size
= sizeof(struct perf_event_header
),
481 .type
= PERF_RECORD_FINISHED_ROUND
,
484 static int record__mmap_read_all(struct record
*rec
)
486 u64 bytes_written
= rec
->bytes_written
;
490 for (i
= 0; i
< rec
->evlist
->nr_mmaps
; i
++) {
491 struct auxtrace_mmap
*mm
= &rec
->evlist
->mmap
[i
].auxtrace_mmap
;
493 if (rec
->evlist
->mmap
[i
].base
) {
494 if (record__mmap_read(rec
, i
) != 0) {
500 if (mm
->base
&& !rec
->opts
.auxtrace_snapshot_mode
&&
501 record__auxtrace_mmap_read(rec
, mm
) != 0) {
508 * Mark the round finished in case we wrote
509 * at least one event.
511 if (bytes_written
!= rec
->bytes_written
)
512 rc
= record__write(rec
, &finished_round_event
, sizeof(finished_round_event
));
518 static void record__init_features(struct record
*rec
)
520 struct perf_session
*session
= rec
->session
;
523 for (feat
= HEADER_FIRST_FEATURE
; feat
< HEADER_LAST_FEATURE
; feat
++)
524 perf_header__set_feat(&session
->header
, feat
);
527 perf_header__clear_feat(&session
->header
, HEADER_BUILD_ID
);
529 if (!have_tracepoints(&rec
->evlist
->entries
))
530 perf_header__clear_feat(&session
->header
, HEADER_TRACING_DATA
);
532 if (!rec
->opts
.branch_stack
)
533 perf_header__clear_feat(&session
->header
, HEADER_BRANCH_STACK
);
535 if (!rec
->opts
.full_auxtrace
)
536 perf_header__clear_feat(&session
->header
, HEADER_AUXTRACE
);
538 perf_header__clear_feat(&session
->header
, HEADER_STAT
);
542 record__finish_output(struct record
*rec
)
544 struct perf_data_file
*file
= &rec
->file
;
545 int fd
= perf_data_file__fd(file
);
550 rec
->session
->header
.data_size
+= rec
->bytes_written
;
551 file
->size
= lseek(perf_data_file__fd(file
), 0, SEEK_CUR
);
553 if (!rec
->no_buildid
) {
554 process_buildids(rec
);
556 if (rec
->buildid_all
)
557 dsos__hit_all(rec
->session
);
559 perf_session__write_header(rec
->session
, rec
->evlist
, fd
, true);
564 static int record__synthesize_workload(struct record
*rec
)
567 struct thread_map map
;
568 struct thread_map_data map_data
;
571 thread_map
.map
.nr
= 1;
572 thread_map
.map
.map
[0].pid
= rec
->evlist
->workload
.pid
;
573 thread_map
.map
.map
[0].comm
= NULL
;
574 return perf_event__synthesize_thread_map(&rec
->tool
, &thread_map
.map
,
575 process_synthesized_event
,
576 &rec
->session
->machines
.host
,
577 rec
->opts
.sample_address
,
578 rec
->opts
.proc_map_timeout
);
581 static int record__synthesize(struct record
*rec
);
584 record__switch_output(struct record
*rec
, bool at_exit
)
586 struct perf_data_file
*file
= &rec
->file
;
589 /* Same Size: "2015122520103046"*/
590 char timestamp
[] = "InvalidTimestamp";
593 record__finish_output(rec
);
594 err
= fetch_current_timestamp(timestamp
, sizeof(timestamp
));
596 pr_err("Failed to get current timestamp\n");
600 fd
= perf_data_file__switch(file
, timestamp
,
601 rec
->session
->header
.data_offset
,
603 if (fd
>= 0 && !at_exit
) {
604 rec
->bytes_written
= 0;
605 rec
->session
->header
.data_size
= 0;
609 fprintf(stderr
, "[ perf record: Dump %s.%s ]\n",
610 file
->path
, timestamp
);
612 /* Output tracking events */
614 record__synthesize(rec
);
617 * In 'perf record --switch-output' without -a,
618 * record__synthesize() in record__switch_output() won't
619 * generate tracking events because there's no thread_map
620 * in evlist. Which causes newly created perf.data doesn't
621 * contain map and comm information.
622 * Create a fake thread_map and directly call
623 * perf_event__synthesize_thread_map() for those events.
625 if (target__none(&rec
->opts
.target
))
626 record__synthesize_workload(rec
);
631 static volatile int workload_exec_errno
;
634 * perf_evlist__prepare_workload will send a SIGUSR1
635 * if the fork fails, since we asked by setting its
636 * want_signal to true.
638 static void workload_exec_failed_signal(int signo __maybe_unused
,
640 void *ucontext __maybe_unused
)
642 workload_exec_errno
= info
->si_value
.sival_int
;
647 static void snapshot_sig_handler(int sig
);
650 perf_event__synth_time_conv(const struct perf_event_mmap_page
*pc __maybe_unused
,
651 struct perf_tool
*tool __maybe_unused
,
652 perf_event__handler_t process __maybe_unused
,
653 struct machine
*machine __maybe_unused
)
658 static int record__synthesize(struct record
*rec
)
660 struct perf_session
*session
= rec
->session
;
661 struct machine
*machine
= &session
->machines
.host
;
662 struct perf_data_file
*file
= &rec
->file
;
663 struct record_opts
*opts
= &rec
->opts
;
664 struct perf_tool
*tool
= &rec
->tool
;
665 int fd
= perf_data_file__fd(file
);
669 err
= perf_event__synthesize_attrs(tool
, session
,
670 process_synthesized_event
);
672 pr_err("Couldn't synthesize attrs.\n");
676 if (have_tracepoints(&rec
->evlist
->entries
)) {
678 * FIXME err <= 0 here actually means that
679 * there were no tracepoints so its not really
680 * an error, just that we don't need to
681 * synthesize anything. We really have to
682 * return this more properly and also
683 * propagate errors that now are calling die()
685 err
= perf_event__synthesize_tracing_data(tool
, fd
, rec
->evlist
,
686 process_synthesized_event
);
688 pr_err("Couldn't record tracing data.\n");
691 rec
->bytes_written
+= err
;
695 err
= perf_event__synth_time_conv(rec
->evlist
->mmap
[0].base
, tool
,
696 process_synthesized_event
, machine
);
700 if (rec
->opts
.full_auxtrace
) {
701 err
= perf_event__synthesize_auxtrace_info(rec
->itr
, tool
,
702 session
, process_synthesized_event
);
707 err
= perf_event__synthesize_kernel_mmap(tool
, process_synthesized_event
,
709 WARN_ONCE(err
< 0, "Couldn't record kernel reference relocation symbol\n"
710 "Symbol resolution may be skewed if relocation was used (e.g. kexec).\n"
711 "Check /proc/kallsyms permission or run as root.\n");
713 err
= perf_event__synthesize_modules(tool
, process_synthesized_event
,
715 WARN_ONCE(err
< 0, "Couldn't record kernel module information.\n"
716 "Symbol resolution may be skewed if relocation was used (e.g. kexec).\n"
717 "Check /proc/modules permission or run as root.\n");
720 machines__process_guests(&session
->machines
,
721 perf_event__synthesize_guest_os
, tool
);
724 err
= __machine__synthesize_threads(machine
, tool
, &opts
->target
, rec
->evlist
->threads
,
725 process_synthesized_event
, opts
->sample_address
,
726 opts
->proc_map_timeout
);
731 static int __cmd_record(struct record
*rec
, int argc
, const char **argv
)
735 unsigned long waking
= 0;
736 const bool forks
= argc
> 0;
737 struct machine
*machine
;
738 struct perf_tool
*tool
= &rec
->tool
;
739 struct record_opts
*opts
= &rec
->opts
;
740 struct perf_data_file
*file
= &rec
->file
;
741 struct perf_session
*session
;
742 bool disabled
= false, draining
= false;
745 rec
->progname
= argv
[0];
747 atexit(record__sig_exit
);
748 signal(SIGCHLD
, sig_handler
);
749 signal(SIGINT
, sig_handler
);
750 signal(SIGTERM
, sig_handler
);
752 if (rec
->opts
.auxtrace_snapshot_mode
|| rec
->switch_output
) {
753 signal(SIGUSR2
, snapshot_sig_handler
);
754 if (rec
->opts
.auxtrace_snapshot_mode
)
755 trigger_on(&auxtrace_snapshot_trigger
);
756 if (rec
->switch_output
)
757 trigger_on(&switch_output_trigger
);
759 signal(SIGUSR2
, SIG_IGN
);
762 session
= perf_session__new(file
, false, tool
);
763 if (session
== NULL
) {
764 pr_err("Perf session creation failed.\n");
768 fd
= perf_data_file__fd(file
);
769 rec
->session
= session
;
771 record__init_features(rec
);
774 err
= perf_evlist__prepare_workload(rec
->evlist
, &opts
->target
,
776 workload_exec_failed_signal
);
778 pr_err("Couldn't run the workload!\n");
780 goto out_delete_session
;
784 if (record__open(rec
) != 0) {
789 err
= bpf__apply_obj_config();
793 bpf__strerror_apply_obj_config(err
, errbuf
, sizeof(errbuf
));
794 pr_err("ERROR: Apply config to BPF failed: %s\n",
800 * Normally perf_session__new would do this, but it doesn't have the
803 if (rec
->tool
.ordered_events
&& !perf_evlist__sample_id_all(rec
->evlist
)) {
804 pr_warning("WARNING: No sample_id_all support, falling back to unordered processing\n");
805 rec
->tool
.ordered_events
= false;
808 if (!rec
->evlist
->nr_groups
)
809 perf_header__clear_feat(&session
->header
, HEADER_GROUP_DESC
);
812 err
= perf_header__write_pipe(fd
);
816 err
= perf_session__write_header(session
, rec
->evlist
, fd
, false);
822 && !perf_header__has_feat(&session
->header
, HEADER_BUILD_ID
)) {
823 pr_err("Couldn't generate buildids. "
824 "Use --no-buildid to profile anyway.\n");
829 machine
= &session
->machines
.host
;
831 err
= record__synthesize(rec
);
835 if (rec
->realtime_prio
) {
836 struct sched_param param
;
838 param
.sched_priority
= rec
->realtime_prio
;
839 if (sched_setscheduler(0, SCHED_FIFO
, ¶m
)) {
840 pr_err("Could not set realtime priority.\n");
847 * When perf is starting the traced process, all the events
848 * (apart from group members) have enable_on_exec=1 set,
849 * so don't spoil it by prematurely enabling them.
851 if (!target__none(&opts
->target
) && !opts
->initial_delay
)
852 perf_evlist__enable(rec
->evlist
);
858 union perf_event
*event
;
860 event
= malloc(sizeof(event
->comm
) + machine
->id_hdr_size
);
867 * Some H/W events are generated before COMM event
868 * which is emitted during exec(), so perf script
869 * cannot see a correct process name for those events.
870 * Synthesize COMM event to prevent it.
872 perf_event__synthesize_comm(tool
, event
,
873 rec
->evlist
->workload
.pid
,
874 process_synthesized_event
,
878 perf_evlist__start_workload(rec
->evlist
);
881 if (opts
->initial_delay
) {
882 usleep(opts
->initial_delay
* 1000);
883 perf_evlist__enable(rec
->evlist
);
886 trigger_ready(&auxtrace_snapshot_trigger
);
887 trigger_ready(&switch_output_trigger
);
889 unsigned long long hits
= rec
->samples
;
891 if (record__mmap_read_all(rec
) < 0) {
892 trigger_error(&auxtrace_snapshot_trigger
);
893 trigger_error(&switch_output_trigger
);
898 if (auxtrace_record__snapshot_started
) {
899 auxtrace_record__snapshot_started
= 0;
900 if (!trigger_is_error(&auxtrace_snapshot_trigger
))
901 record__read_auxtrace_snapshot(rec
);
902 if (trigger_is_error(&auxtrace_snapshot_trigger
)) {
903 pr_err("AUX area tracing snapshot failed\n");
909 if (trigger_is_hit(&switch_output_trigger
)) {
910 trigger_ready(&switch_output_trigger
);
913 fprintf(stderr
, "[ perf record: dump data: Woken up %ld times ]\n",
916 fd
= record__switch_output(rec
, false);
918 pr_err("Failed to switch to new file\n");
919 trigger_error(&switch_output_trigger
);
925 if (hits
== rec
->samples
) {
926 if (done
|| draining
)
928 err
= perf_evlist__poll(rec
->evlist
, -1);
930 * Propagate error, only if there's any. Ignore positive
931 * number of returned events and interrupt error.
933 if (err
> 0 || (err
< 0 && errno
== EINTR
))
937 if (perf_evlist__filter_pollfd(rec
->evlist
, POLLERR
| POLLHUP
) == 0)
942 * When perf is starting the traced process, at the end events
943 * die with the process and we wait for that. Thus no need to
944 * disable events in this case.
946 if (done
&& !disabled
&& !target__none(&opts
->target
)) {
947 trigger_off(&auxtrace_snapshot_trigger
);
948 perf_evlist__disable(rec
->evlist
);
952 trigger_off(&auxtrace_snapshot_trigger
);
953 trigger_off(&switch_output_trigger
);
955 if (forks
&& workload_exec_errno
) {
956 char msg
[STRERR_BUFSIZE
];
957 const char *emsg
= strerror_r(workload_exec_errno
, msg
, sizeof(msg
));
958 pr_err("Workload failed: %s\n", emsg
);
964 fprintf(stderr
, "[ perf record: Woken up %ld times to write data ]\n", waking
);
971 kill(rec
->evlist
->workload
.pid
, SIGTERM
);
977 else if (WIFEXITED(exit_status
))
978 status
= WEXITSTATUS(exit_status
);
979 else if (WIFSIGNALED(exit_status
))
980 signr
= WTERMSIG(exit_status
);
984 /* this will be recalculated during process_buildids() */
988 if (!rec
->timestamp_filename
) {
989 record__finish_output(rec
);
991 fd
= record__switch_output(rec
, true);
994 goto out_delete_session
;
999 if (!err
&& !quiet
) {
1001 const char *postfix
= rec
->timestamp_filename
?
1002 ".<timestamp>" : "";
1004 if (rec
->samples
&& !rec
->opts
.full_auxtrace
)
1005 scnprintf(samples
, sizeof(samples
),
1006 " (%" PRIu64
" samples)", rec
->samples
);
1010 fprintf(stderr
, "[ perf record: Captured and wrote %.3f MB %s%s%s ]\n",
1011 perf_data_file__size(file
) / 1024.0 / 1024.0,
1012 file
->path
, postfix
, samples
);
1016 perf_session__delete(session
);
1020 static void callchain_debug(struct callchain_param
*callchain
)
1022 static const char *str
[CALLCHAIN_MAX
] = { "NONE", "FP", "DWARF", "LBR" };
1024 pr_debug("callchain: type %s\n", str
[callchain
->record_mode
]);
1026 if (callchain
->record_mode
== CALLCHAIN_DWARF
)
1027 pr_debug("callchain: stack dump size %d\n",
1028 callchain
->dump_size
);
1031 int record_opts__parse_callchain(struct record_opts
*record
,
1032 struct callchain_param
*callchain
,
1033 const char *arg
, bool unset
)
1036 callchain
->enabled
= !unset
;
1038 /* --no-call-graph */
1040 callchain
->record_mode
= CALLCHAIN_NONE
;
1041 pr_debug("callchain: disabled\n");
1045 ret
= parse_callchain_record_opt(arg
, callchain
);
1047 /* Enable data address sampling for DWARF unwind. */
1048 if (callchain
->record_mode
== CALLCHAIN_DWARF
)
1049 record
->sample_address
= true;
1050 callchain_debug(callchain
);
1056 int record_parse_callchain_opt(const struct option
*opt
,
1060 return record_opts__parse_callchain(opt
->value
, &callchain_param
, arg
, unset
);
1063 int record_callchain_opt(const struct option
*opt
,
1064 const char *arg __maybe_unused
,
1065 int unset __maybe_unused
)
1067 struct callchain_param
*callchain
= opt
->value
;
1069 callchain
->enabled
= true;
1071 if (callchain
->record_mode
== CALLCHAIN_NONE
)
1072 callchain
->record_mode
= CALLCHAIN_FP
;
1074 callchain_debug(callchain
);
1078 static int perf_record_config(const char *var
, const char *value
, void *cb
)
1080 struct record
*rec
= cb
;
1082 if (!strcmp(var
, "record.build-id")) {
1083 if (!strcmp(value
, "cache"))
1084 rec
->no_buildid_cache
= false;
1085 else if (!strcmp(value
, "no-cache"))
1086 rec
->no_buildid_cache
= true;
1087 else if (!strcmp(value
, "skip"))
1088 rec
->no_buildid
= true;
1093 if (!strcmp(var
, "record.call-graph"))
1094 var
= "call-graph.record-mode"; /* fall-through */
1096 return perf_default_config(var
, value
, cb
);
1099 struct clockid_map
{
1104 #define CLOCKID_MAP(n, c) \
1105 { .name = n, .clockid = (c), }
1107 #define CLOCKID_END { .name = NULL, }
1111 * Add the missing ones, we need to build on many distros...
1113 #ifndef CLOCK_MONOTONIC_RAW
1114 #define CLOCK_MONOTONIC_RAW 4
1116 #ifndef CLOCK_BOOTTIME
1117 #define CLOCK_BOOTTIME 7
1120 #define CLOCK_TAI 11
1123 static const struct clockid_map clockids
[] = {
1124 /* available for all events, NMI safe */
1125 CLOCKID_MAP("monotonic", CLOCK_MONOTONIC
),
1126 CLOCKID_MAP("monotonic_raw", CLOCK_MONOTONIC_RAW
),
1128 /* available for some events */
1129 CLOCKID_MAP("realtime", CLOCK_REALTIME
),
1130 CLOCKID_MAP("boottime", CLOCK_BOOTTIME
),
1131 CLOCKID_MAP("tai", CLOCK_TAI
),
1133 /* available for the lazy */
1134 CLOCKID_MAP("mono", CLOCK_MONOTONIC
),
1135 CLOCKID_MAP("raw", CLOCK_MONOTONIC_RAW
),
1136 CLOCKID_MAP("real", CLOCK_REALTIME
),
1137 CLOCKID_MAP("boot", CLOCK_BOOTTIME
),
1142 static int parse_clockid(const struct option
*opt
, const char *str
, int unset
)
1144 struct record_opts
*opts
= (struct record_opts
*)opt
->value
;
1145 const struct clockid_map
*cm
;
1146 const char *ostr
= str
;
1149 opts
->use_clockid
= 0;
1157 /* no setting it twice */
1158 if (opts
->use_clockid
)
1161 opts
->use_clockid
= true;
1163 /* if its a number, we're done */
1164 if (sscanf(str
, "%d", &opts
->clockid
) == 1)
1167 /* allow a "CLOCK_" prefix to the name */
1168 if (!strncasecmp(str
, "CLOCK_", 6))
1171 for (cm
= clockids
; cm
->name
; cm
++) {
1172 if (!strcasecmp(str
, cm
->name
)) {
1173 opts
->clockid
= cm
->clockid
;
1178 opts
->use_clockid
= false;
1179 ui__warning("unknown clockid %s, check man page\n", ostr
);
1183 static int record__parse_mmap_pages(const struct option
*opt
,
1185 int unset __maybe_unused
)
1187 struct record_opts
*opts
= opt
->value
;
1189 unsigned int mmap_pages
;
1204 ret
= __perf_evlist__parse_mmap_pages(&mmap_pages
, s
);
1207 opts
->mmap_pages
= mmap_pages
;
1215 ret
= __perf_evlist__parse_mmap_pages(&mmap_pages
, p
+ 1);
1219 opts
->auxtrace_mmap_pages
= mmap_pages
;
1226 static const char * const __record_usage
[] = {
1227 "perf record [<options>] [<command>]",
1228 "perf record [<options>] -- <command> [<options>]",
1231 const char * const *record_usage
= __record_usage
;
1234 * XXX Ideally would be local to cmd_record() and passed to a record__new
1235 * because we need to have access to it in record__exit, that is called
1236 * after cmd_record() exits, but since record_options need to be accessible to
1237 * builtin-script, leave it here.
1239 * At least we don't ouch it in all the other functions here directly.
1241 * Just say no to tons of global variables, sigh.
1243 static struct record record
= {
1245 .sample_time
= true,
1246 .mmap_pages
= UINT_MAX
,
1247 .user_freq
= UINT_MAX
,
1248 .user_interval
= ULLONG_MAX
,
1252 .default_per_cpu
= true,
1254 .proc_map_timeout
= 500,
1257 .sample
= process_sample_event
,
1258 .fork
= perf_event__process_fork
,
1259 .exit
= perf_event__process_exit
,
1260 .comm
= perf_event__process_comm
,
1261 .mmap
= perf_event__process_mmap
,
1262 .mmap2
= perf_event__process_mmap2
,
1263 .ordered_events
= true,
1267 const char record_callchain_help
[] = CALLCHAIN_RECORD_HELP
1268 "\n\t\t\t\tDefault: fp";
1271 * XXX Will stay a global variable till we fix builtin-script.c to stop messing
1272 * with it and switch to use the library functions in perf_evlist that came
1273 * from builtin-record.c, i.e. use record_opts,
1274 * perf_evlist__prepare_workload, etc instead of fork+exec'in 'perf record',
1277 struct option __record_options
[] = {
1278 OPT_CALLBACK('e', "event", &record
.evlist
, "event",
1279 "event selector. use 'perf list' to list available events",
1280 parse_events_option
),
1281 OPT_CALLBACK(0, "filter", &record
.evlist
, "filter",
1282 "event filter", parse_filter
),
1283 OPT_CALLBACK_NOOPT(0, "exclude-perf", &record
.evlist
,
1284 NULL
, "don't record events from perf itself",
1286 OPT_STRING('p', "pid", &record
.opts
.target
.pid
, "pid",
1287 "record events on existing process id"),
1288 OPT_STRING('t', "tid", &record
.opts
.target
.tid
, "tid",
1289 "record events on existing thread id"),
1290 OPT_INTEGER('r', "realtime", &record
.realtime_prio
,
1291 "collect data with this RT SCHED_FIFO priority"),
1292 OPT_BOOLEAN(0, "no-buffering", &record
.opts
.no_buffering
,
1293 "collect data without buffering"),
1294 OPT_BOOLEAN('R', "raw-samples", &record
.opts
.raw_samples
,
1295 "collect raw sample records from all opened counters"),
1296 OPT_BOOLEAN('a', "all-cpus", &record
.opts
.target
.system_wide
,
1297 "system-wide collection from all CPUs"),
1298 OPT_STRING('C', "cpu", &record
.opts
.target
.cpu_list
, "cpu",
1299 "list of cpus to monitor"),
1300 OPT_U64('c', "count", &record
.opts
.user_interval
, "event period to sample"),
1301 OPT_STRING('o', "output", &record
.file
.path
, "file",
1302 "output file name"),
1303 OPT_BOOLEAN_SET('i', "no-inherit", &record
.opts
.no_inherit
,
1304 &record
.opts
.no_inherit_set
,
1305 "child tasks do not inherit counters"),
1306 OPT_UINTEGER('F', "freq", &record
.opts
.user_freq
, "profile at this frequency"),
1307 OPT_CALLBACK('m', "mmap-pages", &record
.opts
, "pages[,pages]",
1308 "number of mmap data pages and AUX area tracing mmap pages",
1309 record__parse_mmap_pages
),
1310 OPT_BOOLEAN(0, "group", &record
.opts
.group
,
1311 "put the counters into a counter group"),
1312 OPT_CALLBACK_NOOPT('g', NULL
, &callchain_param
,
1313 NULL
, "enables call-graph recording" ,
1314 &record_callchain_opt
),
1315 OPT_CALLBACK(0, "call-graph", &record
.opts
,
1316 "record_mode[,record_size]", record_callchain_help
,
1317 &record_parse_callchain_opt
),
1318 OPT_INCR('v', "verbose", &verbose
,
1319 "be more verbose (show counter open errors, etc)"),
1320 OPT_BOOLEAN('q', "quiet", &quiet
, "don't print any message"),
1321 OPT_BOOLEAN('s', "stat", &record
.opts
.inherit_stat
,
1322 "per thread counts"),
1323 OPT_BOOLEAN('d', "data", &record
.opts
.sample_address
, "Record the sample addresses"),
1324 OPT_BOOLEAN_SET('T', "timestamp", &record
.opts
.sample_time
,
1325 &record
.opts
.sample_time_set
,
1326 "Record the sample timestamps"),
1327 OPT_BOOLEAN('P', "period", &record
.opts
.period
, "Record the sample period"),
1328 OPT_BOOLEAN('n', "no-samples", &record
.opts
.no_samples
,
1330 OPT_BOOLEAN_SET('N', "no-buildid-cache", &record
.no_buildid_cache
,
1331 &record
.no_buildid_cache_set
,
1332 "do not update the buildid cache"),
1333 OPT_BOOLEAN_SET('B', "no-buildid", &record
.no_buildid
,
1334 &record
.no_buildid_set
,
1335 "do not collect buildids in perf.data"),
1336 OPT_CALLBACK('G', "cgroup", &record
.evlist
, "name",
1337 "monitor event in cgroup name only",
1339 OPT_UINTEGER('D', "delay", &record
.opts
.initial_delay
,
1340 "ms to wait before starting measurement after program start"),
1341 OPT_STRING('u', "uid", &record
.opts
.target
.uid_str
, "user",
1344 OPT_CALLBACK_NOOPT('b', "branch-any", &record
.opts
.branch_stack
,
1345 "branch any", "sample any taken branches",
1346 parse_branch_stack
),
1348 OPT_CALLBACK('j', "branch-filter", &record
.opts
.branch_stack
,
1349 "branch filter mask", "branch stack filter modes",
1350 parse_branch_stack
),
1351 OPT_BOOLEAN('W', "weight", &record
.opts
.sample_weight
,
1352 "sample by weight (on special events only)"),
1353 OPT_BOOLEAN(0, "transaction", &record
.opts
.sample_transaction
,
1354 "sample transaction flags (special events only)"),
1355 OPT_BOOLEAN(0, "per-thread", &record
.opts
.target
.per_thread
,
1356 "use per-thread mmaps"),
1357 OPT_CALLBACK_OPTARG('I', "intr-regs", &record
.opts
.sample_intr_regs
, NULL
, "any register",
1358 "sample selected machine registers on interrupt,"
1359 " use -I ? to list register names", parse_regs
),
1360 OPT_BOOLEAN(0, "running-time", &record
.opts
.running_time
,
1361 "Record running/enabled time of read (:S) events"),
1362 OPT_CALLBACK('k', "clockid", &record
.opts
,
1363 "clockid", "clockid to use for events, see clock_gettime()",
1365 OPT_STRING_OPTARG('S', "snapshot", &record
.opts
.auxtrace_snapshot_opts
,
1366 "opts", "AUX area tracing Snapshot Mode", ""),
1367 OPT_UINTEGER(0, "proc-map-timeout", &record
.opts
.proc_map_timeout
,
1368 "per thread proc mmap processing timeout in ms"),
1369 OPT_BOOLEAN(0, "switch-events", &record
.opts
.record_switch_events
,
1370 "Record context switch events"),
1371 OPT_BOOLEAN_FLAG(0, "all-kernel", &record
.opts
.all_kernel
,
1372 "Configure all used events to run in kernel space.",
1373 PARSE_OPT_EXCLUSIVE
),
1374 OPT_BOOLEAN_FLAG(0, "all-user", &record
.opts
.all_user
,
1375 "Configure all used events to run in user space.",
1376 PARSE_OPT_EXCLUSIVE
),
1377 OPT_STRING(0, "clang-path", &llvm_param
.clang_path
, "clang path",
1378 "clang binary to use for compiling BPF scriptlets"),
1379 OPT_STRING(0, "clang-opt", &llvm_param
.clang_opt
, "clang options",
1380 "options passed to clang when compiling BPF scriptlets"),
1381 OPT_STRING(0, "vmlinux", &symbol_conf
.vmlinux_name
,
1382 "file", "vmlinux pathname"),
1383 OPT_BOOLEAN(0, "buildid-all", &record
.buildid_all
,
1384 "Record build-id of all DSOs regardless of hits"),
1385 OPT_BOOLEAN(0, "timestamp-filename", &record
.timestamp_filename
,
1386 "append timestamp to output filename"),
1387 OPT_BOOLEAN(0, "switch-output", &record
.switch_output
,
1388 "Switch output when receive SIGUSR2"),
1392 struct option
*record_options
= __record_options
;
1394 int cmd_record(int argc
, const char **argv
, const char *prefix __maybe_unused
)
1397 struct record
*rec
= &record
;
1398 char errbuf
[BUFSIZ
];
1400 #ifndef HAVE_LIBBPF_SUPPORT
1401 # define set_nobuild(s, l, c) set_option_nobuild(record_options, s, l, "NO_LIBBPF=1", c)
1402 set_nobuild('\0', "clang-path", true);
1403 set_nobuild('\0', "clang-opt", true);
1407 #ifndef HAVE_BPF_PROLOGUE
1408 # if !defined (HAVE_DWARF_SUPPORT)
1409 # define REASON "NO_DWARF=1"
1410 # elif !defined (HAVE_LIBBPF_SUPPORT)
1411 # define REASON "NO_LIBBPF=1"
1413 # define REASON "this architecture doesn't support BPF prologue"
1415 # define set_nobuild(s, l, c) set_option_nobuild(record_options, s, l, REASON, c)
1416 set_nobuild('\0', "vmlinux", true);
1421 rec
->evlist
= perf_evlist__new();
1422 if (rec
->evlist
== NULL
)
1425 perf_config(perf_record_config
, rec
);
1427 argc
= parse_options(argc
, argv
, record_options
, record_usage
,
1428 PARSE_OPT_STOP_AT_NON_OPTION
);
1429 if (!argc
&& target__none(&rec
->opts
.target
))
1430 usage_with_options(record_usage
, record_options
);
1432 if (nr_cgroups
&& !rec
->opts
.target
.system_wide
) {
1433 usage_with_options_msg(record_usage
, record_options
,
1434 "cgroup monitoring only available in system-wide mode");
1437 if (rec
->opts
.record_switch_events
&&
1438 !perf_can_record_switch_events()) {
1439 ui__error("kernel does not support recording context switch events\n");
1440 parse_options_usage(record_usage
, record_options
, "switch-events", 0);
1444 if (rec
->switch_output
)
1445 rec
->timestamp_filename
= true;
1448 rec
->itr
= auxtrace_record__init(rec
->evlist
, &err
);
1453 err
= auxtrace_parse_snapshot_options(rec
->itr
, &rec
->opts
,
1454 rec
->opts
.auxtrace_snapshot_opts
);
1458 err
= bpf__setup_stdout(rec
->evlist
);
1460 bpf__strerror_setup_stdout(rec
->evlist
, err
, errbuf
, sizeof(errbuf
));
1461 pr_err("ERROR: Setup BPF stdout failed: %s\n",
1470 if (symbol_conf
.kptr_restrict
)
1472 "WARNING: Kernel address maps (/proc/{kallsyms,modules}) are restricted,\n"
1473 "check /proc/sys/kernel/kptr_restrict.\n\n"
1474 "Samples in kernel functions may not be resolved if a suitable vmlinux\n"
1475 "file is not found in the buildid cache or in the vmlinux path.\n\n"
1476 "Samples in kernel modules won't be resolved at all.\n\n"
1477 "If some relocation was applied (e.g. kexec) symbols may be misresolved\n"
1478 "even with a suitable vmlinux or kallsyms file.\n\n");
1480 if (rec
->no_buildid_cache
|| rec
->no_buildid
) {
1481 disable_buildid_cache();
1482 } else if (rec
->switch_output
) {
1484 * In 'perf record --switch-output', disable buildid
1485 * generation by default to reduce data file switching
1486 * overhead. Still generate buildid if they are required
1489 * perf record --signal-trigger --no-no-buildid \
1490 * --no-no-buildid-cache
1492 * Following code equals to:
1494 * if ((rec->no_buildid || !rec->no_buildid_set) &&
1495 * (rec->no_buildid_cache || !rec->no_buildid_cache_set))
1496 * disable_buildid_cache();
1498 bool disable
= true;
1500 if (rec
->no_buildid_set
&& !rec
->no_buildid
)
1502 if (rec
->no_buildid_cache_set
&& !rec
->no_buildid_cache
)
1505 rec
->no_buildid
= true;
1506 rec
->no_buildid_cache
= true;
1507 disable_buildid_cache();
1511 if (rec
->evlist
->nr_entries
== 0 &&
1512 perf_evlist__add_default(rec
->evlist
) < 0) {
1513 pr_err("Not enough memory for event selector list\n");
1514 goto out_symbol_exit
;
1517 if (rec
->opts
.target
.tid
&& !rec
->opts
.no_inherit_set
)
1518 rec
->opts
.no_inherit
= true;
1520 err
= target__validate(&rec
->opts
.target
);
1522 target__strerror(&rec
->opts
.target
, err
, errbuf
, BUFSIZ
);
1523 ui__warning("%s", errbuf
);
1526 err
= target__parse_uid(&rec
->opts
.target
);
1528 int saved_errno
= errno
;
1530 target__strerror(&rec
->opts
.target
, err
, errbuf
, BUFSIZ
);
1531 ui__error("%s", errbuf
);
1534 goto out_symbol_exit
;
1538 if (perf_evlist__create_maps(rec
->evlist
, &rec
->opts
.target
) < 0)
1539 usage_with_options(record_usage
, record_options
);
1541 err
= auxtrace_record__options(rec
->itr
, rec
->evlist
, &rec
->opts
);
1543 goto out_symbol_exit
;
1546 * We take all buildids when the file contains
1547 * AUX area tracing data because we do not decode the
1548 * trace because it would take too long.
1550 if (rec
->opts
.full_auxtrace
)
1551 rec
->buildid_all
= true;
1553 if (record_opts__config(&rec
->opts
)) {
1555 goto out_symbol_exit
;
1558 err
= __cmd_record(&record
, argc
, argv
);
1560 perf_evlist__delete(rec
->evlist
);
1562 auxtrace_record__free(rec
->itr
);
1566 static void snapshot_sig_handler(int sig __maybe_unused
)
1568 if (trigger_is_ready(&auxtrace_snapshot_trigger
)) {
1569 trigger_hit(&auxtrace_snapshot_trigger
);
1570 auxtrace_record__snapshot_started
= 1;
1571 if (auxtrace_record__snapshot_start(record
.itr
))
1572 trigger_error(&auxtrace_snapshot_trigger
);
1575 if (trigger_is_ready(&switch_output_trigger
))
1576 trigger_hit(&switch_output_trigger
);