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.
8 #define _FILE_OFFSET_BITS 64
14 #include "util/build-id.h"
15 #include "util/util.h"
16 #include "util/parse-options.h"
17 #include "util/parse-events.h"
19 #include "util/header.h"
20 #include "util/event.h"
21 #include "util/debug.h"
22 #include "util/session.h"
23 #include "util/symbol.h"
24 #include "util/cpumap.h"
35 static int *fd
[MAX_NR_CPUS
][MAX_COUNTERS
];
37 static u64 user_interval
= ULLONG_MAX
;
38 static u64 default_interval
= 0;
40 static int nr_cpus
= 0;
41 static unsigned int page_size
;
42 static unsigned int mmap_pages
= 128;
43 static unsigned int user_freq
= UINT_MAX
;
44 static int freq
= 1000;
46 static int pipe_output
= 0;
47 static const char *output_name
= "perf.data";
49 static int realtime_prio
= 0;
50 static bool raw_samples
= false;
51 static bool system_wide
= false;
52 static pid_t target_pid
= -1;
53 static pid_t target_tid
= -1;
54 static pid_t
*all_tids
= NULL
;
55 static int thread_num
= 0;
56 static pid_t child_pid
= -1;
57 static bool no_inherit
= false;
58 static enum write_mode_t write_mode
= WRITE_FORCE
;
59 static bool call_graph
= false;
60 static bool inherit_stat
= false;
61 static bool no_samples
= false;
62 static bool sample_address
= false;
64 static long samples
= 0;
65 static u64 bytes_written
= 0;
67 static struct pollfd
*event_array
;
69 static int nr_poll
= 0;
70 static int nr_cpu
= 0;
72 static int file_new
= 1;
73 static off_t post_processing_offset
;
75 static struct perf_session
*session
;
76 static const char *cpu_list
;
85 static struct mmap_data mmap_array
[MAX_NR_CPUS
];
87 static unsigned long mmap_read_head(struct mmap_data
*md
)
89 struct perf_event_mmap_page
*pc
= md
->base
;
98 static void mmap_write_tail(struct mmap_data
*md
, unsigned long tail
)
100 struct perf_event_mmap_page
*pc
= md
->base
;
103 * ensure all reads are done before we write the tail out.
106 pc
->data_tail
= tail
;
109 static void advance_output(size_t size
)
111 bytes_written
+= size
;
114 static void write_output(void *buf
, size_t size
)
117 int ret
= write(output
, buf
, size
);
120 die("failed to write");
125 bytes_written
+= ret
;
129 static int process_synthesized_event(event_t
*event
,
130 struct perf_session
*self __used
)
132 write_output(event
, event
->header
.size
);
136 static void mmap_read(struct mmap_data
*md
)
138 unsigned int head
= mmap_read_head(md
);
139 unsigned int old
= md
->prev
;
140 unsigned char *data
= md
->base
+ page_size
;
146 * If we're further behind than half the buffer, there's a chance
147 * the writer will bite our tail and mess up the samples under us.
149 * If we somehow ended up ahead of the head, we got messed up.
151 * In either case, truncate and restart at head.
155 fprintf(stderr
, "WARNING: failed to keep up with mmap data\n");
157 * head points to a known good entry, start there.
167 if ((old
& md
->mask
) + size
!= (head
& md
->mask
)) {
168 buf
= &data
[old
& md
->mask
];
169 size
= md
->mask
+ 1 - (old
& md
->mask
);
172 write_output(buf
, size
);
175 buf
= &data
[old
& md
->mask
];
179 write_output(buf
, size
);
182 mmap_write_tail(md
, old
);
185 static volatile int done
= 0;
186 static volatile int signr
= -1;
188 static void sig_handler(int sig
)
194 static void sig_atexit(void)
197 kill(child_pid
, SIGTERM
);
202 signal(signr
, SIG_DFL
);
203 kill(getpid(), signr
);
208 static struct perf_header_attr
*get_header_attr(struct perf_event_attr
*a
, int nr
)
210 struct perf_header_attr
*h_attr
;
212 if (nr
< session
->header
.attrs
) {
213 h_attr
= session
->header
.attr
[nr
];
215 h_attr
= perf_header_attr__new(a
);
217 if (perf_header__add_attr(&session
->header
, h_attr
) < 0) {
218 perf_header_attr__delete(h_attr
);
226 static void create_counter(int counter
, int cpu
)
228 char *filter
= filters
[counter
];
229 struct perf_event_attr
*attr
= attrs
+ counter
;
230 struct perf_header_attr
*h_attr
;
231 int track
= !counter
; /* only the first counter needs these */
241 attr
->read_format
= PERF_FORMAT_TOTAL_TIME_ENABLED
|
242 PERF_FORMAT_TOTAL_TIME_RUNNING
|
245 attr
->sample_type
|= PERF_SAMPLE_IP
| PERF_SAMPLE_TID
;
248 attr
->sample_type
|= PERF_SAMPLE_ID
;
251 * We default some events to a 1 default interval. But keep
252 * it a weak assumption overridable by the user.
254 if (!attr
->sample_period
|| (user_freq
!= UINT_MAX
&&
255 user_interval
!= ULLONG_MAX
)) {
257 attr
->sample_type
|= PERF_SAMPLE_PERIOD
;
259 attr
->sample_freq
= freq
;
261 attr
->sample_period
= default_interval
;
266 attr
->sample_freq
= 0;
269 attr
->inherit_stat
= 1;
271 if (sample_address
) {
272 attr
->sample_type
|= PERF_SAMPLE_ADDR
;
273 attr
->mmap_data
= track
;
277 attr
->sample_type
|= PERF_SAMPLE_CALLCHAIN
;
280 attr
->sample_type
|= PERF_SAMPLE_CPU
;
283 attr
->sample_type
|= PERF_SAMPLE_TIME
;
284 attr
->sample_type
|= PERF_SAMPLE_RAW
;
285 attr
->sample_type
|= PERF_SAMPLE_CPU
;
290 attr
->inherit
= !no_inherit
;
291 if (target_pid
== -1 && target_tid
== -1 && !system_wide
) {
293 attr
->enable_on_exec
= 1;
296 for (thread_index
= 0; thread_index
< thread_num
; thread_index
++) {
298 fd
[nr_cpu
][counter
][thread_index
] = sys_perf_event_open(attr
,
299 all_tids
[thread_index
], cpu
, group_fd
, 0);
301 if (fd
[nr_cpu
][counter
][thread_index
] < 0) {
304 if (err
== EPERM
|| err
== EACCES
)
305 die("Permission error - are you root?\n"
306 "\t Consider tweaking"
307 " /proc/sys/kernel/perf_event_paranoid.\n");
308 else if (err
== ENODEV
&& cpu_list
) {
309 die("No such device - did you specify"
310 " an out-of-range profile CPU?\n");
314 * If it's cycles then fall back to hrtimer
315 * based cpu-clock-tick sw counter, which
316 * is always available even if no PMU support:
318 if (attr
->type
== PERF_TYPE_HARDWARE
319 && attr
->config
== PERF_COUNT_HW_CPU_CYCLES
) {
322 warning(" ... trying to fall back to cpu-clock-ticks\n");
323 attr
->type
= PERF_TYPE_SOFTWARE
;
324 attr
->config
= PERF_COUNT_SW_CPU_CLOCK
;
328 error("perfcounter syscall returned with %d (%s)\n",
329 fd
[nr_cpu
][counter
][thread_index
], strerror(err
));
331 #if defined(__i386__) || defined(__x86_64__)
332 if (attr
->type
== PERF_TYPE_HARDWARE
&& err
== EOPNOTSUPP
)
333 die("No hardware sampling interrupt available."
334 " No APIC? If so then you can boot the kernel"
335 " with the \"lapic\" boot parameter to"
336 " force-enable it.\n");
339 die("No CONFIG_PERF_EVENTS=y kernel support configured?\n");
343 h_attr
= get_header_attr(attr
, counter
);
348 if (memcmp(&h_attr
->attr
, attr
, sizeof(*attr
))) {
349 fprintf(stderr
, "incompatible append\n");
354 if (read(fd
[nr_cpu
][counter
][thread_index
], &read_data
, sizeof(read_data
)) == -1) {
355 perror("Unable to read perf file descriptor\n");
359 if (perf_header_attr__add_id(h_attr
, read_data
.id
) < 0) {
360 pr_warning("Not enough memory to add id\n");
364 assert(fd
[nr_cpu
][counter
][thread_index
] >= 0);
365 fcntl(fd
[nr_cpu
][counter
][thread_index
], F_SETFL
, O_NONBLOCK
);
368 * First counter acts as the group leader:
370 if (group
&& group_fd
== -1)
371 group_fd
= fd
[nr_cpu
][counter
][thread_index
];
373 if (counter
|| thread_index
) {
374 ret
= ioctl(fd
[nr_cpu
][counter
][thread_index
],
375 PERF_EVENT_IOC_SET_OUTPUT
,
378 error("failed to set output: %d (%s)\n", errno
,
383 mmap_array
[nr_cpu
].counter
= counter
;
384 mmap_array
[nr_cpu
].prev
= 0;
385 mmap_array
[nr_cpu
].mask
= mmap_pages
*page_size
- 1;
386 mmap_array
[nr_cpu
].base
= mmap(NULL
, (mmap_pages
+1)*page_size
,
387 PROT_READ
|PROT_WRITE
, MAP_SHARED
, fd
[nr_cpu
][counter
][thread_index
], 0);
388 if (mmap_array
[nr_cpu
].base
== MAP_FAILED
) {
389 error("failed to mmap with %d (%s)\n", errno
, strerror(errno
));
393 event_array
[nr_poll
].fd
= fd
[nr_cpu
][counter
][thread_index
];
394 event_array
[nr_poll
].events
= POLLIN
;
398 if (filter
!= NULL
) {
399 ret
= ioctl(fd
[nr_cpu
][counter
][thread_index
],
400 PERF_EVENT_IOC_SET_FILTER
, filter
);
402 error("failed to set filter with %d (%s)\n", errno
,
410 static void open_counters(int cpu
)
415 for (counter
= 0; counter
< nr_counters
; counter
++)
416 create_counter(counter
, cpu
);
421 static int process_buildids(void)
423 u64 size
= lseek(output
, 0, SEEK_CUR
);
428 session
->fd
= output
;
429 return __perf_session__process_events(session
, post_processing_offset
,
430 size
- post_processing_offset
,
431 size
, &build_id__mark_dso_hit_ops
);
434 static void atexit_header(void)
437 session
->header
.data_size
+= bytes_written
;
440 perf_header__write(&session
->header
, output
, true);
444 static void event__synthesize_guest_os(struct machine
*machine
, void *data
)
447 char *guest_kallsyms
;
449 struct perf_session
*psession
= data
;
451 if (machine__is_host(machine
))
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
= event__synthesize_modules(process_synthesized_event
,
465 pr_err("Couldn't record guest kernel [%d]'s reference"
466 " relocation symbol.\n", machine
->pid
);
468 if (machine__is_default_guest(machine
))
469 guest_kallsyms
= (char *) symbol_conf
.default_guest_kallsyms
;
471 sprintf(path
, "%s/proc/kallsyms", machine
->root_dir
);
472 guest_kallsyms
= path
;
476 * We use _stext for guest kernel because guest kernel's /proc/kallsyms
477 * have no _text sometimes.
479 err
= event__synthesize_kernel_mmap(process_synthesized_event
,
480 psession
, machine
, "_text");
482 err
= event__synthesize_kernel_mmap(process_synthesized_event
,
483 psession
, machine
, "_stext");
485 pr_err("Couldn't record guest kernel [%d]'s reference"
486 " relocation symbol.\n", machine
->pid
);
489 static struct perf_event_header finished_round_event
= {
490 .size
= sizeof(struct perf_event_header
),
491 .type
= PERF_RECORD_FINISHED_ROUND
,
494 static void mmap_read_all(void)
498 for (i
= 0; i
< nr_cpu
; i
++) {
499 if (mmap_array
[i
].base
)
500 mmap_read(&mmap_array
[i
]);
503 if (perf_header__has_feat(&session
->header
, HEADER_TRACE_INFO
))
504 write_output(&finished_round_event
, sizeof(finished_round_event
));
507 static int __cmd_record(int argc
, const char **argv
)
513 unsigned long waking
= 0;
514 int child_ready_pipe
[2], go_pipe
[2];
515 const bool forks
= argc
> 0;
517 struct machine
*machine
;
519 page_size
= sysconf(_SC_PAGE_SIZE
);
522 signal(SIGCHLD
, sig_handler
);
523 signal(SIGINT
, sig_handler
);
525 if (forks
&& (pipe(child_ready_pipe
) < 0 || pipe(go_pipe
) < 0)) {
526 perror("failed to create pipes");
530 if (!strcmp(output_name
, "-"))
532 else if (!stat(output_name
, &st
) && st
.st_size
) {
533 if (write_mode
== WRITE_FORCE
) {
534 char oldname
[PATH_MAX
];
535 snprintf(oldname
, sizeof(oldname
), "%s.old",
538 rename(output_name
, oldname
);
540 } else if (write_mode
== WRITE_APPEND
) {
541 write_mode
= WRITE_FORCE
;
544 flags
= O_CREAT
|O_RDWR
;
545 if (write_mode
== WRITE_APPEND
)
551 output
= STDOUT_FILENO
;
553 output
= open(output_name
, flags
, S_IRUSR
| S_IWUSR
);
555 perror("failed to create output file");
559 session
= perf_session__new(output_name
, O_WRONLY
,
560 write_mode
== WRITE_FORCE
, false);
561 if (session
== NULL
) {
562 pr_err("Not enough memory for reading perf file header\n");
567 err
= perf_header__read(session
, output
);
572 if (have_tracepoints(attrs
, nr_counters
))
573 perf_header__set_feat(&session
->header
, HEADER_TRACE_INFO
);
575 atexit(atexit_header
);
580 perror("failed to fork");
587 close(child_ready_pipe
[0]);
589 fcntl(go_pipe
[0], F_SETFD
, FD_CLOEXEC
);
592 * Do a dummy execvp to get the PLT entry resolved,
593 * so we avoid the resolver overhead on the real
596 execvp("", (char **)argv
);
599 * Tell the parent we're ready to go
601 close(child_ready_pipe
[1]);
604 * Wait until the parent tells us to go.
606 if (read(go_pipe
[0], &buf
, 1) == -1)
607 perror("unable to read pipe");
609 execvp(argv
[0], (char **)argv
);
615 if (!system_wide
&& target_tid
== -1 && target_pid
== -1)
616 all_tids
[0] = child_pid
;
618 close(child_ready_pipe
[1]);
621 * wait for child to settle
623 if (read(child_ready_pipe
[0], &buf
, 1) == -1) {
624 perror("unable to read pipe");
627 close(child_ready_pipe
[0]);
630 nr_cpus
= read_cpu_map(cpu_list
);
632 perror("failed to collect number of CPUs\n");
636 if (!system_wide
&& no_inherit
&& !cpu_list
) {
639 for (i
= 0; i
< nr_cpus
; i
++)
640 open_counters(cpumap
[i
]);
644 err
= perf_header__write_pipe(output
);
647 } else if (file_new
) {
648 err
= perf_header__write(&session
->header
, output
, false);
653 post_processing_offset
= lseek(output
, 0, SEEK_CUR
);
656 err
= event__synthesize_attrs(&session
->header
,
657 process_synthesized_event
,
660 pr_err("Couldn't synthesize attrs.\n");
664 err
= event__synthesize_event_types(process_synthesized_event
,
667 pr_err("Couldn't synthesize event_types.\n");
671 if (have_tracepoints(attrs
, nr_counters
)) {
673 * FIXME err <= 0 here actually means that
674 * there were no tracepoints so its not really
675 * an error, just that we don't need to
676 * synthesize anything. We really have to
677 * return this more properly and also
678 * propagate errors that now are calling die()
680 err
= event__synthesize_tracing_data(output
, attrs
,
682 process_synthesized_event
,
685 pr_err("Couldn't record tracing data.\n");
692 machine
= perf_session__find_host_machine(session
);
694 pr_err("Couldn't find native kernel information.\n");
698 err
= event__synthesize_kernel_mmap(process_synthesized_event
,
699 session
, machine
, "_text");
701 err
= event__synthesize_kernel_mmap(process_synthesized_event
,
702 session
, machine
, "_stext");
704 pr_err("Couldn't record kernel reference relocation symbol.\n");
708 err
= event__synthesize_modules(process_synthesized_event
,
711 pr_err("Couldn't record kernel reference relocation symbol.\n");
715 perf_session__process_machines(session
, event__synthesize_guest_os
);
717 if (!system_wide
&& cpu_list
)
718 event__synthesize_thread(target_tid
, process_synthesized_event
,
721 event__synthesize_threads(process_synthesized_event
, session
);
724 struct sched_param param
;
726 param
.sched_priority
= realtime_prio
;
727 if (sched_setscheduler(0, SCHED_FIFO
, ¶m
)) {
728 pr_err("Could not set realtime priority.\n");
745 if (hits
== samples
) {
748 err
= poll(event_array
, nr_poll
, -1);
753 for (i
= 0; i
< nr_cpu
; i
++) {
755 counter
< nr_counters
;
760 ioctl(fd
[i
][counter
][thread
],
761 PERF_EVENT_IOC_DISABLE
);
767 fprintf(stderr
, "[ perf record: Woken up %ld times to write data ]\n", waking
);
770 * Approximate RIP event size: 24 bytes.
773 "[ perf record: Captured and wrote %.3f MB %s (~%lld samples) ]\n",
774 (double)bytes_written
/ 1024.0 / 1024.0,
781 static const char * const record_usage
[] = {
782 "perf record [<options>] [<command>]",
783 "perf record [<options>] -- <command> [<options>]",
787 static bool force
, append_file
;
789 static const struct option options
[] = {
790 OPT_CALLBACK('e', "event", NULL
, "event",
791 "event selector. use 'perf list' to list available events",
793 OPT_CALLBACK(0, "filter", NULL
, "filter",
794 "event filter", parse_filter
),
795 OPT_INTEGER('p', "pid", &target_pid
,
796 "record events on existing process id"),
797 OPT_INTEGER('t', "tid", &target_tid
,
798 "record events on existing thread id"),
799 OPT_INTEGER('r', "realtime", &realtime_prio
,
800 "collect data with this RT SCHED_FIFO priority"),
801 OPT_BOOLEAN('R', "raw-samples", &raw_samples
,
802 "collect raw sample records from all opened counters"),
803 OPT_BOOLEAN('a', "all-cpus", &system_wide
,
804 "system-wide collection from all CPUs"),
805 OPT_BOOLEAN('A', "append", &append_file
,
806 "append to the output file to do incremental profiling"),
807 OPT_STRING('C', "cpu", &cpu_list
, "cpu",
808 "list of cpus to monitor"),
809 OPT_BOOLEAN('f', "force", &force
,
810 "overwrite existing data file (deprecated)"),
811 OPT_U64('c', "count", &user_interval
, "event period to sample"),
812 OPT_STRING('o', "output", &output_name
, "file",
814 OPT_BOOLEAN('i', "no-inherit", &no_inherit
,
815 "child tasks do not inherit counters"),
816 OPT_UINTEGER('F', "freq", &user_freq
, "profile at this frequency"),
817 OPT_UINTEGER('m', "mmap-pages", &mmap_pages
, "number of mmap data pages"),
818 OPT_BOOLEAN('g', "call-graph", &call_graph
,
819 "do call-graph (stack chain/backtrace) recording"),
820 OPT_INCR('v', "verbose", &verbose
,
821 "be more verbose (show counter open errors, etc)"),
822 OPT_BOOLEAN('s', "stat", &inherit_stat
,
823 "per thread counts"),
824 OPT_BOOLEAN('d', "data", &sample_address
,
826 OPT_BOOLEAN('n', "no-samples", &no_samples
,
831 int cmd_record(int argc
, const char **argv
, const char *prefix __used
)
835 argc
= parse_options(argc
, argv
, options
, record_usage
,
836 PARSE_OPT_STOP_AT_NON_OPTION
);
837 if (!argc
&& target_pid
== -1 && target_tid
== -1 &&
838 !system_wide
&& !cpu_list
)
839 usage_with_options(record_usage
, options
);
841 if (force
&& append_file
) {
842 fprintf(stderr
, "Can't overwrite and append at the same time."
843 " You need to choose between -f and -A");
844 usage_with_options(record_usage
, options
);
845 } else if (append_file
) {
846 write_mode
= WRITE_APPEND
;
848 write_mode
= WRITE_FORCE
;
855 attrs
[0].type
= PERF_TYPE_HARDWARE
;
856 attrs
[0].config
= PERF_COUNT_HW_CPU_CYCLES
;
859 if (target_pid
!= -1) {
860 target_tid
= target_pid
;
861 thread_num
= find_all_tid(target_pid
, &all_tids
);
862 if (thread_num
<= 0) {
863 fprintf(stderr
, "Can't find all threads of pid %d\n",
865 usage_with_options(record_usage
, options
);
868 all_tids
=malloc(sizeof(pid_t
));
872 all_tids
[0] = target_tid
;
876 for (i
= 0; i
< MAX_NR_CPUS
; i
++) {
877 for (j
= 0; j
< MAX_COUNTERS
; j
++) {
878 fd
[i
][j
] = malloc(sizeof(int)*thread_num
);
883 event_array
= malloc(
884 sizeof(struct pollfd
)*MAX_NR_CPUS
*MAX_COUNTERS
*thread_num
);
888 if (user_interval
!= ULLONG_MAX
)
889 default_interval
= user_interval
;
890 if (user_freq
!= UINT_MAX
)
894 * User specified count overrides default frequency.
896 if (default_interval
)
899 default_interval
= freq
;
901 fprintf(stderr
, "frequency and count are zero, aborting\n");
905 return __cmd_record(argc
, argv
);