blob: c1c1200d2f0a69555111aa9872c3d4be04d786dc [file] [log] [blame]
Ingo Molnarabaff322009-06-02 22:59:57 +02001/*
Ingo Molnarbf9e1872009-06-02 23:37:05 +02002 * 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.
Ingo Molnarabaff322009-06-02 22:59:57 +02007 */
Ingo Molnar16f762a2009-05-27 09:10:38 +02008#include "builtin.h"
Ingo Molnarbf9e1872009-06-02 23:37:05 +02009
10#include "perf.h"
11
Arnaldo Carvalho de Melo6122e4e2010-02-03 16:52:05 -020012#include "util/build-id.h"
Thomas Gleixner6eda5832009-05-01 18:29:57 +020013#include "util/util.h"
Ingo Molnar0e9b20b2009-05-26 09:17:18 +020014#include "util/parse-options.h"
Ingo Molnar8ad8db32009-05-26 11:10:09 +020015#include "util/parse-events.h"
Thomas Gleixner6eda5832009-05-01 18:29:57 +020016
Peter Zijlstra7c6a1c62009-06-25 17:05:54 +020017#include "util/header.h"
Frederic Weisbecker66e274f2009-08-12 11:07:25 +020018#include "util/event.h"
Arnaldo Carvalho de Melo361c99a2011-01-11 20:56:53 -020019#include "util/evlist.h"
Arnaldo Carvalho de Melo69aad6f2011-01-03 16:39:04 -020020#include "util/evsel.h"
Frederic Weisbecker8f288272009-08-16 22:05:48 +020021#include "util/debug.h"
Arnaldo Carvalho de Melo94c744b2009-12-11 21:24:02 -020022#include "util/session.h"
Arnaldo Carvalho de Melo45694aa2011-11-28 08:30:20 -020023#include "util/tool.h"
Arnaldo Carvalho de Melo8d063672009-11-04 18:50:43 -020024#include "util/symbol.h"
Paul Mackerrasa12b51c2010-03-10 20:36:09 +110025#include "util/cpumap.h"
Arnaldo Carvalho de Melofd782602011-01-18 15:15:24 -020026#include "util/thread_map.h"
Jiri Olsaf5fc14122013-10-15 16:27:32 +020027#include "util/data.h"
Peter Zijlstra7c6a1c62009-06-25 17:05:54 +020028
Peter Zijlstra97124d5e2009-06-02 15:52:24 +020029#include <unistd.h>
Peter Zijlstrade9ac072009-04-08 15:01:31 +020030#include <sched.h>
Arnaldo Carvalho de Meloa41794c2010-05-18 18:29:23 -030031#include <sys/mman.h>
Peter Zijlstrade9ac072009-04-08 15:01:31 +020032
Ingo Molnar89fe8082013-09-30 12:07:11 +020033#ifndef HAVE_ON_EXIT_SUPPORT
Bernhard Rosenkraenzer78da39f2012-10-08 09:43:26 +030034#ifndef ATEXIT_MAX
35#define ATEXIT_MAX 32
36#endif
37static int __on_exit_count = 0;
38typedef void (*on_exit_func_t) (int, void *);
39static on_exit_func_t __on_exit_funcs[ATEXIT_MAX];
40static void *__on_exit_args[ATEXIT_MAX];
41static int __exitcode = 0;
42static void __handle_on_exit_funcs(void);
43static int on_exit(on_exit_func_t function, void *arg);
44#define exit(x) (exit)(__exitcode = (x))
45
46static int on_exit(on_exit_func_t function, void *arg)
47{
48 if (__on_exit_count == ATEXIT_MAX)
49 return -ENOMEM;
50 else if (__on_exit_count == 0)
51 atexit(__handle_on_exit_funcs);
52 __on_exit_funcs[__on_exit_count] = function;
53 __on_exit_args[__on_exit_count++] = arg;
54 return 0;
55}
56
57static void __handle_on_exit_funcs(void)
58{
59 int i;
60 for (i = 0; i < __on_exit_count; i++)
61 __on_exit_funcs[i] (__exitcode, __on_exit_args[i]);
62}
63#endif
64
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -020065struct perf_record {
Arnaldo Carvalho de Melo45694aa2011-11-28 08:30:20 -020066 struct perf_tool tool;
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -020067 struct perf_record_opts opts;
68 u64 bytes_written;
Jiri Olsaf5fc14122013-10-15 16:27:32 +020069 struct perf_data_file file;
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -020070 struct perf_evlist *evlist;
71 struct perf_session *session;
72 const char *progname;
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -020073 int realtime_prio;
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -020074 bool no_buildid;
75 bool no_buildid_cache;
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -020076 long samples;
Arnaldo Carvalho de Melo0f82ebc2011-11-08 14:41:57 -020077};
Ingo Molnara21ca2c2009-06-06 09:58:57 +020078
Jiri Olsa6233dd52013-11-28 11:30:13 +010079static int perf_record__write(struct perf_record *rec, void *buf, size_t size)
Peter Zijlstraf5970552009-06-18 23:22:55 +020080{
Jiri Olsaf5fc14122013-10-15 16:27:32 +020081 struct perf_data_file *file = &rec->file;
82
Peter Zijlstraf5970552009-06-18 23:22:55 +020083 while (size) {
Adrian Hunter410f1782013-11-08 12:27:50 +020084 ssize_t ret = write(file->fd, buf, size);
Peter Zijlstraf5970552009-06-18 23:22:55 +020085
David Ahern8d3eca22012-08-26 12:24:47 -060086 if (ret < 0) {
Adrian Hunter4f624682013-10-18 15:29:00 +030087 pr_err("failed to write perf data, error: %m\n");
David Ahern8d3eca22012-08-26 12:24:47 -060088 return -1;
89 }
Peter Zijlstraf5970552009-06-18 23:22:55 +020090
91 size -= ret;
92 buf += ret;
93
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -020094 rec->bytes_written += ret;
Peter Zijlstraf5970552009-06-18 23:22:55 +020095 }
David Ahern8d3eca22012-08-26 12:24:47 -060096
97 return 0;
Peter Zijlstraf5970552009-06-18 23:22:55 +020098}
99
Arnaldo Carvalho de Melo45694aa2011-11-28 08:30:20 -0200100static int process_synthesized_event(struct perf_tool *tool,
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200101 union perf_event *event,
Irina Tirdea1d037ca2012-09-11 01:15:03 +0300102 struct perf_sample *sample __maybe_unused,
103 struct machine *machine __maybe_unused)
Arnaldo Carvalho de Melo234fbbf2009-10-26 19:23:18 -0200104{
Arnaldo Carvalho de Melo45694aa2011-11-28 08:30:20 -0200105 struct perf_record *rec = container_of(tool, struct perf_record, tool);
Jiri Olsa6233dd52013-11-28 11:30:13 +0100106 return perf_record__write(rec, event, event->header.size);
Arnaldo Carvalho de Melo234fbbf2009-10-26 19:23:18 -0200107}
108
David Ahern8d3eca22012-08-26 12:24:47 -0600109static int perf_record__mmap_read(struct perf_record *rec,
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200110 struct perf_mmap *md)
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200111{
Arnaldo Carvalho de Melo744bd8a2011-01-12 17:07:28 -0200112 unsigned int head = perf_mmap__read_head(md);
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200113 unsigned int old = md->prev;
Jiri Olsa918512b2013-09-12 18:39:35 +0200114 unsigned char *data = md->base + page_size;
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200115 unsigned long size;
116 void *buf;
David Ahern8d3eca22012-08-26 12:24:47 -0600117 int rc = 0;
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200118
Arnaldo Carvalho de Melodc820092011-01-28 14:49:19 -0200119 if (old == head)
David Ahern8d3eca22012-08-26 12:24:47 -0600120 return 0;
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200121
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200122 rec->samples++;
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200123
124 size = head - old;
125
126 if ((old & md->mask) + size != (head & md->mask)) {
127 buf = &data[old & md->mask];
128 size = md->mask + 1 - (old & md->mask);
129 old += size;
Ingo Molnar021e9f42009-06-03 19:27:19 +0200130
Jiri Olsa6233dd52013-11-28 11:30:13 +0100131 if (perf_record__write(rec, buf, size) < 0) {
David Ahern8d3eca22012-08-26 12:24:47 -0600132 rc = -1;
133 goto out;
134 }
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200135 }
136
137 buf = &data[old & md->mask];
138 size = head - old;
139 old += size;
Ingo Molnar021e9f42009-06-03 19:27:19 +0200140
Jiri Olsa6233dd52013-11-28 11:30:13 +0100141 if (perf_record__write(rec, buf, size) < 0) {
David Ahern8d3eca22012-08-26 12:24:47 -0600142 rc = -1;
143 goto out;
144 }
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200145
146 md->prev = old;
Arnaldo Carvalho de Melo115d2d82011-01-12 17:11:53 -0200147 perf_mmap__write_tail(md, old);
David Ahern8d3eca22012-08-26 12:24:47 -0600148
149out:
150 return rc;
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200151}
152
153static volatile int done = 0;
Peter Zijlstraf7b7c262009-06-10 15:55:59 +0200154static volatile int signr = -1;
Andi Kleen33e49ea2011-09-15 14:31:40 -0700155static volatile int child_finished = 0;
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200156
Peter Zijlstra16c8a102009-05-05 17:50:27 +0200157static void sig_handler(int sig)
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200158{
Andi Kleen33e49ea2011-09-15 14:31:40 -0700159 if (sig == SIGCHLD)
160 child_finished = 1;
161
Peter Zijlstra16c8a102009-05-05 17:50:27 +0200162 done = 1;
Peter Zijlstraf7b7c262009-06-10 15:55:59 +0200163 signr = sig;
164}
165
Irina Tirdea1d037ca2012-09-11 01:15:03 +0300166static void perf_record__sig_exit(int exit_status __maybe_unused, void *arg)
Peter Zijlstraf7b7c262009-06-10 15:55:59 +0200167{
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200168 struct perf_record *rec = arg;
Andi Kleen33e49ea2011-09-15 14:31:40 -0700169 int status;
170
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200171 if (rec->evlist->workload.pid > 0) {
Andi Kleen33e49ea2011-09-15 14:31:40 -0700172 if (!child_finished)
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200173 kill(rec->evlist->workload.pid, SIGTERM);
Andi Kleen33e49ea2011-09-15 14:31:40 -0700174
175 wait(&status);
176 if (WIFSIGNALED(status))
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200177 psignal(WTERMSIG(status), rec->progname);
Andi Kleen33e49ea2011-09-15 14:31:40 -0700178 }
Chris Wilson933da832009-10-04 01:35:01 +0100179
Arnaldo Carvalho de Melo18483b82010-12-06 15:13:38 -0200180 if (signr == -1 || signr == SIGUSR1)
Peter Zijlstraf7b7c262009-06-10 15:55:59 +0200181 return;
182
183 signal(signr, SIG_DFL);
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200184}
185
David Ahern8d3eca22012-08-26 12:24:47 -0600186static int perf_record__open(struct perf_record *rec)
Arnaldo Carvalho de Melodd7927f2011-01-12 14:28:51 -0200187{
Arnaldo Carvalho de Melo56e52e82012-12-13 15:10:58 -0300188 char msg[512];
Jiri Olsa6a4bb042012-08-08 12:22:36 +0200189 struct perf_evsel *pos;
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200190 struct perf_evlist *evlist = rec->evlist;
191 struct perf_session *session = rec->session;
192 struct perf_record_opts *opts = &rec->opts;
David Ahern8d3eca22012-08-26 12:24:47 -0600193 int rc = 0;
Arnaldo Carvalho de Melodd7927f2011-01-12 14:28:51 -0200194
Arnaldo Carvalho de Melof77a9512012-12-10 16:41:31 -0300195 perf_evlist__config(evlist, opts);
Jiri Olsacac21422012-11-12 18:34:00 +0100196
Arnaldo Carvalho de Melodd7927f2011-01-12 14:28:51 -0200197 list_for_each_entry(pos, &evlist->entries, node) {
Ingo Molnar3da297a2009-06-07 17:39:02 +0200198try_again:
Jiri Olsa6a4bb042012-08-08 12:22:36 +0200199 if (perf_evsel__open(pos, evlist->cpus, evlist->threads) < 0) {
Arnaldo Carvalho de Melo56e52e82012-12-13 15:10:58 -0300200 if (perf_evsel__fallback(pos, errno, msg, sizeof(msg))) {
Zhang, Yanmind6d901c2010-03-18 11:36:05 -0300201 if (verbose)
Arnaldo Carvalho de Meloc0a54342012-12-13 14:16:30 -0300202 ui__warning("%s\n", msg);
Zhang, Yanmind6d901c2010-03-18 11:36:05 -0300203 goto try_again;
204 }
David Ahernca6a4252011-03-25 13:11:11 -0600205
Arnaldo Carvalho de Melo56e52e82012-12-13 15:10:58 -0300206 rc = -errno;
207 perf_evsel__open_strerror(pos, &opts->target,
208 errno, msg, sizeof(msg));
209 ui__error("%s\n", msg);
David Ahern8d3eca22012-08-26 12:24:47 -0600210 goto out;
Zhang, Yanmind6d901c2010-03-18 11:36:05 -0300211 }
Li Zefanc171b552009-10-15 11:22:07 +0800212 }
Arnaldo Carvalho de Meloa43d3f02010-12-25 12:12:25 -0200213
Arnaldo Carvalho de Melo1491a632012-09-26 14:43:13 -0300214 if (perf_evlist__apply_filters(evlist)) {
Frederic Weisbecker0a102472011-02-26 04:51:54 +0100215 error("failed to set filter with %d (%s)\n", errno,
216 strerror(errno));
David Ahern8d3eca22012-08-26 12:24:47 -0600217 rc = -1;
218 goto out;
Frederic Weisbecker0a102472011-02-26 04:51:54 +0100219 }
220
Nelson Elhage18e60932011-12-19 08:39:31 -0500221 if (perf_evlist__mmap(evlist, opts->mmap_pages, false) < 0) {
David Ahern8d3eca22012-08-26 12:24:47 -0600222 if (errno == EPERM) {
223 pr_err("Permission error mapping pages.\n"
224 "Consider increasing "
225 "/proc/sys/kernel/perf_event_mlock_kb,\n"
226 "or try again with a smaller value of -m/--mmap_pages.\n"
Adrian Hunter53653d72013-12-09 15:18:40 +0200227 "(current value: %u)\n", opts->mmap_pages);
David Ahern8d3eca22012-08-26 12:24:47 -0600228 rc = -errno;
David Ahern8d3eca22012-08-26 12:24:47 -0600229 } else {
230 pr_err("failed to mmap with %d (%s)\n", errno, strerror(errno));
231 rc = -errno;
232 }
233 goto out;
Nelson Elhage18e60932011-12-19 08:39:31 -0500234 }
Arnaldo Carvalho de Melo0a27d7f2011-01-14 15:50:51 -0200235
Jiri Olsa563aecb2013-06-05 13:35:06 +0200236 session->evlist = evlist;
Arnaldo Carvalho de Melo7b56cce2012-08-01 19:31:00 -0300237 perf_session__set_id_hdr_size(session);
David Ahern8d3eca22012-08-26 12:24:47 -0600238out:
239 return rc;
Peter Zijlstra16c8a102009-05-05 17:50:27 +0200240}
241
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200242static int process_buildids(struct perf_record *rec)
Arnaldo Carvalho de Melo6122e4e2010-02-03 16:52:05 -0200243{
Jiri Olsaf5fc14122013-10-15 16:27:32 +0200244 struct perf_data_file *file = &rec->file;
245 struct perf_session *session = rec->session;
David Ahern7ab75cf2013-11-06 11:41:36 -0700246 u64 start = session->header.data_offset;
Arnaldo Carvalho de Melo6122e4e2010-02-03 16:52:05 -0200247
Jiri Olsaf5fc14122013-10-15 16:27:32 +0200248 u64 size = lseek(file->fd, 0, SEEK_CUR);
Arnaldo Carvalho de Melo9f591fd2010-03-11 15:53:11 -0300249 if (size == 0)
250 return 0;
251
David Ahern7ab75cf2013-11-06 11:41:36 -0700252 return __perf_session__process_events(session, start,
253 size - start,
Arnaldo Carvalho de Melo6122e4e2010-02-03 16:52:05 -0200254 size, &build_id__mark_dso_hit_ops);
255}
256
David Ahern8d3eca22012-08-26 12:24:47 -0600257static void perf_record__exit(int status, void *arg)
Peter Zijlstraf5970552009-06-18 23:22:55 +0200258{
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200259 struct perf_record *rec = arg;
Jiri Olsaf5fc14122013-10-15 16:27:32 +0200260 struct perf_data_file *file = &rec->file;
Peter Zijlstraf5970552009-06-18 23:22:55 +0200261
David Ahern8d3eca22012-08-26 12:24:47 -0600262 if (status != 0)
263 return;
264
Jiri Olsaf5fc14122013-10-15 16:27:32 +0200265 if (!file->is_pipe) {
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200266 rec->session->header.data_size += rec->bytes_written;
267
268 if (!rec->no_buildid)
269 process_buildids(rec);
270 perf_session__write_header(rec->session, rec->evlist,
Jiri Olsaf5fc14122013-10-15 16:27:32 +0200271 file->fd, true);
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200272 perf_session__delete(rec->session);
273 perf_evlist__delete(rec->evlist);
Arnaldo Carvalho de Melod65a4582010-07-30 18:31:28 -0300274 symbol__exit();
Tom Zanussic7929e42010-04-01 23:59:22 -0500275 }
Peter Zijlstraf5970552009-06-18 23:22:55 +0200276}
277
Arnaldo Carvalho de Melo8115d602011-01-29 14:01:45 -0200278static void perf_event__synthesize_guest_os(struct machine *machine, void *data)
Zhang, Yanmina1645ce2010-04-19 13:32:50 +0800279{
280 int err;
Arnaldo Carvalho de Melo45694aa2011-11-28 08:30:20 -0200281 struct perf_tool *tool = data;
Zhang, Yanmina1645ce2010-04-19 13:32:50 +0800282 /*
283 *As for guest kernel when processing subcommand record&report,
284 *we arrange module mmap prior to guest kernel mmap and trigger
285 *a preload dso because default guest module symbols are loaded
286 *from guest kallsyms instead of /lib/modules/XXX/XXX. This
287 *method is used to avoid symbol missing when the first addr is
288 *in module instead of in guest kernel.
289 */
Arnaldo Carvalho de Melo45694aa2011-11-28 08:30:20 -0200290 err = perf_event__synthesize_modules(tool, process_synthesized_event,
Arnaldo Carvalho de Melo743eb862011-11-28 07:56:39 -0200291 machine);
Zhang, Yanmina1645ce2010-04-19 13:32:50 +0800292 if (err < 0)
293 pr_err("Couldn't record guest kernel [%d]'s reference"
Arnaldo Carvalho de Melo23346f22010-04-27 21:17:50 -0300294 " relocation symbol.\n", machine->pid);
Zhang, Yanmina1645ce2010-04-19 13:32:50 +0800295
Zhang, Yanmina1645ce2010-04-19 13:32:50 +0800296 /*
297 * We use _stext for guest kernel because guest kernel's /proc/kallsyms
298 * have no _text sometimes.
299 */
Arnaldo Carvalho de Melo45694aa2011-11-28 08:30:20 -0200300 err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
Arnaldo Carvalho de Melo743eb862011-11-28 07:56:39 -0200301 machine, "_text");
Zhang, Yanmina1645ce2010-04-19 13:32:50 +0800302 if (err < 0)
Arnaldo Carvalho de Melo45694aa2011-11-28 08:30:20 -0200303 err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
Arnaldo Carvalho de Melo743eb862011-11-28 07:56:39 -0200304 machine, "_stext");
Zhang, Yanmina1645ce2010-04-19 13:32:50 +0800305 if (err < 0)
306 pr_err("Couldn't record guest kernel [%d]'s reference"
Arnaldo Carvalho de Melo23346f22010-04-27 21:17:50 -0300307 " relocation symbol.\n", machine->pid);
Zhang, Yanmina1645ce2010-04-19 13:32:50 +0800308}
309
Frederic Weisbecker98402802010-05-02 22:05:29 +0200310static struct perf_event_header finished_round_event = {
311 .size = sizeof(struct perf_event_header),
312 .type = PERF_RECORD_FINISHED_ROUND,
313};
314
David Ahern8d3eca22012-08-26 12:24:47 -0600315static int perf_record__mmap_read_all(struct perf_record *rec)
Frederic Weisbecker98402802010-05-02 22:05:29 +0200316{
Peter Zijlstra0e2e63d2010-05-20 14:45:26 +0200317 int i;
David Ahern8d3eca22012-08-26 12:24:47 -0600318 int rc = 0;
Frederic Weisbecker98402802010-05-02 22:05:29 +0200319
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200320 for (i = 0; i < rec->evlist->nr_mmaps; i++) {
David Ahern8d3eca22012-08-26 12:24:47 -0600321 if (rec->evlist->mmap[i].base) {
322 if (perf_record__mmap_read(rec, &rec->evlist->mmap[i]) != 0) {
323 rc = -1;
324 goto out;
325 }
326 }
Frederic Weisbecker98402802010-05-02 22:05:29 +0200327 }
328
Stephane Eranian2eeaaa02012-05-15 13:28:13 +0200329 if (perf_header__has_feat(&rec->session->header, HEADER_TRACING_DATA))
Jiri Olsa6233dd52013-11-28 11:30:13 +0100330 rc = perf_record__write(rec, &finished_round_event,
331 sizeof(finished_round_event));
David Ahern8d3eca22012-08-26 12:24:47 -0600332
333out:
334 return rc;
Frederic Weisbecker98402802010-05-02 22:05:29 +0200335}
336
David Ahern57706ab2013-11-06 11:41:34 -0700337static void perf_record__init_features(struct perf_record *rec)
338{
339 struct perf_evlist *evsel_list = rec->evlist;
340 struct perf_session *session = rec->session;
341 int feat;
342
343 for (feat = HEADER_FIRST_FEATURE; feat < HEADER_LAST_FEATURE; feat++)
344 perf_header__set_feat(&session->header, feat);
345
346 if (rec->no_buildid)
347 perf_header__clear_feat(&session->header, HEADER_BUILD_ID);
348
349 if (!have_tracepoints(&evsel_list->entries))
350 perf_header__clear_feat(&session->header, HEADER_TRACING_DATA);
351
352 if (!rec->opts.branch_stack)
353 perf_header__clear_feat(&session->header, HEADER_BRANCH_STACK);
354}
355
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200356static int __cmd_record(struct perf_record *rec, int argc, const char **argv)
Peter Zijlstra16c8a102009-05-05 17:50:27 +0200357{
David Ahern57706ab2013-11-06 11:41:34 -0700358 int err;
Peter Zijlstra8b412662009-09-17 19:59:05 +0200359 unsigned long waking = 0;
Zhang, Yanmin46be6042010-03-18 11:36:04 -0300360 const bool forks = argc > 0;
Arnaldo Carvalho de Melo23346f22010-04-27 21:17:50 -0300361 struct machine *machine;
Arnaldo Carvalho de Melo45694aa2011-11-28 08:30:20 -0200362 struct perf_tool *tool = &rec->tool;
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200363 struct perf_record_opts *opts = &rec->opts;
364 struct perf_evlist *evsel_list = rec->evlist;
Jiri Olsaf5fc14122013-10-15 16:27:32 +0200365 struct perf_data_file *file = &rec->file;
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200366 struct perf_session *session;
Jiri Olsa27119262012-11-12 18:34:02 +0100367 bool disabled = false;
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200368
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200369 rec->progname = argv[0];
Andi Kleen33e49ea2011-09-15 14:31:40 -0700370
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200371 on_exit(perf_record__sig_exit, rec);
Peter Zijlstraf5970552009-06-18 23:22:55 +0200372 signal(SIGCHLD, sig_handler);
373 signal(SIGINT, sig_handler);
Arnaldo Carvalho de Melo18483b82010-12-06 15:13:38 -0200374 signal(SIGUSR1, sig_handler);
David Ahern804f7ac2013-05-06 12:24:23 -0600375 signal(SIGTERM, sig_handler);
Peter Zijlstraf5970552009-06-18 23:22:55 +0200376
Jiri Olsaf5fc14122013-10-15 16:27:32 +0200377 session = perf_session__new(file, false, NULL);
Arnaldo Carvalho de Melo94c744b2009-12-11 21:24:02 -0200378 if (session == NULL) {
Arnaldo Carvalho de Meloa9a70bb2009-11-17 01:18:11 -0200379 pr_err("Not enough memory for reading perf file header\n");
380 return -1;
381 }
382
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200383 rec->session = session;
384
David Ahern57706ab2013-11-06 11:41:34 -0700385 perf_record__init_features(rec);
Stephane Eranian330aa672012-03-08 23:47:46 +0100386
Arnaldo Carvalho de Melod4db3f12009-12-27 21:36:57 -0200387 if (forks) {
Namhyung Kim6ef73ec2013-03-11 16:43:15 +0900388 err = perf_evlist__prepare_workload(evsel_list, &opts->target,
Jiri Olsaf5fc14122013-10-15 16:27:32 +0200389 argv, file->is_pipe,
Namhyung Kim55e162e2013-03-11 16:43:17 +0900390 true);
Arnaldo Carvalho de Melo35b9d882011-11-09 08:47:15 -0200391 if (err < 0) {
392 pr_err("Couldn't run the workload!\n");
393 goto out_delete_session;
Jens Axboe0a5ac842009-08-12 11:18:01 +0200394 }
Peter Zijlstra856e9662009-12-16 17:55:55 +0100395 }
396
David Ahern8d3eca22012-08-26 12:24:47 -0600397 if (perf_record__open(rec) != 0) {
398 err = -1;
399 goto out_delete_session;
400 }
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200401
Namhyung Kima8bb5592013-01-22 18:09:31 +0900402 if (!evsel_list->nr_groups)
403 perf_header__clear_feat(&session->header, HEADER_GROUP_DESC);
404
Arnaldo Carvalho de Melo712a4b62011-02-17 12:18:42 -0200405 /*
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200406 * perf_session__delete(session) will be called at perf_record__exit()
Arnaldo Carvalho de Melo712a4b62011-02-17 12:18:42 -0200407 */
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200408 on_exit(perf_record__exit, rec);
Arnaldo Carvalho de Melo712a4b62011-02-17 12:18:42 -0200409
Jiri Olsaf5fc14122013-10-15 16:27:32 +0200410 if (file->is_pipe) {
411 err = perf_header__write_pipe(file->fd);
Tom Zanussi529870e2010-04-01 23:59:16 -0500412 if (err < 0)
David Ahern8d3eca22012-08-26 12:24:47 -0600413 goto out_delete_session;
Jiri Olsa563aecb2013-06-05 13:35:06 +0200414 } else {
Arnaldo Carvalho de Meloa91e5432011-03-10 11:15:54 -0300415 err = perf_session__write_header(session, evsel_list,
Jiri Olsaf5fc14122013-10-15 16:27:32 +0200416 file->fd, false);
Arnaldo Carvalho de Melod5eed902009-11-19 14:55:56 -0200417 if (err < 0)
David Ahern8d3eca22012-08-26 12:24:47 -0600418 goto out_delete_session;
Arnaldo Carvalho de Melod5eed902009-11-19 14:55:56 -0200419 }
Peter Zijlstra7c6a1c62009-06-25 17:05:54 +0200420
David Ahernd3665492012-02-06 15:27:52 -0700421 if (!rec->no_buildid
Robert Richtere20960c2011-12-07 10:02:55 +0100422 && !perf_header__has_feat(&session->header, HEADER_BUILD_ID)) {
David Ahernd3665492012-02-06 15:27:52 -0700423 pr_err("Couldn't generate buildids. "
Robert Richtere20960c2011-12-07 10:02:55 +0100424 "Use --no-buildid to profile anyway.\n");
David Ahern8d3eca22012-08-26 12:24:47 -0600425 err = -1;
426 goto out_delete_session;
Robert Richtere20960c2011-12-07 10:02:55 +0100427 }
428
Arnaldo Carvalho de Melo34ba5122012-12-19 09:04:24 -0300429 machine = &session->machines.host;
Arnaldo Carvalho de Melo743eb862011-11-28 07:56:39 -0200430
Jiri Olsaf5fc14122013-10-15 16:27:32 +0200431 if (file->is_pipe) {
Arnaldo Carvalho de Melo45694aa2011-11-28 08:30:20 -0200432 err = perf_event__synthesize_attrs(tool, session,
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200433 process_synthesized_event);
Tom Zanussi2c46dbb2010-04-01 23:59:19 -0500434 if (err < 0) {
435 pr_err("Couldn't synthesize attrs.\n");
David Ahern8d3eca22012-08-26 12:24:47 -0600436 goto out_delete_session;
Tom Zanussi2c46dbb2010-04-01 23:59:19 -0500437 }
Tom Zanussicd19a032010-04-01 23:59:20 -0500438
Arnaldo Carvalho de Melo361c99a2011-01-11 20:56:53 -0200439 if (have_tracepoints(&evsel_list->entries)) {
Tom Zanussi63e0c772010-05-03 00:14:48 -0500440 /*
441 * FIXME err <= 0 here actually means that
442 * there were no tracepoints so its not really
443 * an error, just that we don't need to
444 * synthesize anything. We really have to
445 * return this more properly and also
446 * propagate errors that now are calling die()
447 */
Jiri Olsaf5fc14122013-10-15 16:27:32 +0200448 err = perf_event__synthesize_tracing_data(tool, file->fd, evsel_list,
Arnaldo Carvalho de Melo743eb862011-11-28 07:56:39 -0200449 process_synthesized_event);
Tom Zanussi63e0c772010-05-03 00:14:48 -0500450 if (err <= 0) {
451 pr_err("Couldn't record tracing data.\n");
David Ahern8d3eca22012-08-26 12:24:47 -0600452 goto out_delete_session;
Tom Zanussi63e0c772010-05-03 00:14:48 -0500453 }
David Ahernf34b9002013-11-06 11:41:35 -0700454 rec->bytes_written += err;
Tom Zanussi63e0c772010-05-03 00:14:48 -0500455 }
Tom Zanussi2c46dbb2010-04-01 23:59:19 -0500456 }
457
Arnaldo Carvalho de Melo45694aa2011-11-28 08:30:20 -0200458 err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
Arnaldo Carvalho de Melo743eb862011-11-28 07:56:39 -0200459 machine, "_text");
Arnaldo Carvalho de Melo70162132010-03-30 18:27:39 -0300460 if (err < 0)
Arnaldo Carvalho de Melo45694aa2011-11-28 08:30:20 -0200461 err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
Arnaldo Carvalho de Melo743eb862011-11-28 07:56:39 -0200462 machine, "_stext");
Arnaldo Carvalho de Meloc1a3a4b2010-11-22 14:01:55 -0200463 if (err < 0)
464 pr_err("Couldn't record kernel reference relocation symbol\n"
465 "Symbol resolution may be skewed if relocation was used (e.g. kexec).\n"
466 "Check /proc/kallsyms permission or run as root.\n");
Arnaldo Carvalho de Melo56b03f32010-01-05 16:50:31 -0200467
Arnaldo Carvalho de Melo45694aa2011-11-28 08:30:20 -0200468 err = perf_event__synthesize_modules(tool, process_synthesized_event,
Arnaldo Carvalho de Melo743eb862011-11-28 07:56:39 -0200469 machine);
Arnaldo Carvalho de Meloc1a3a4b2010-11-22 14:01:55 -0200470 if (err < 0)
471 pr_err("Couldn't record kernel module information.\n"
472 "Symbol resolution may be skewed if relocation was used (e.g. kexec).\n"
473 "Check /proc/modules permission or run as root.\n");
474
Arnaldo Carvalho de Melo7e383de2012-12-18 15:49:27 -0300475 if (perf_guest) {
Arnaldo Carvalho de Melo876650e2012-12-18 19:15:48 -0300476 machines__process_guests(&session->machines,
477 perf_event__synthesize_guest_os, tool);
Arnaldo Carvalho de Melo7e383de2012-12-18 15:49:27 -0300478 }
Arnaldo Carvalho de Melob7cece762010-01-13 13:22:17 -0200479
Arnaldo Carvalho de Meloa33fbd52013-11-11 11:36:12 -0300480 err = __machine__synthesize_threads(machine, tool, &opts->target, evsel_list->threads,
481 process_synthesized_event, opts->sample_address);
David Ahern8d3eca22012-08-26 12:24:47 -0600482 if (err != 0)
483 goto out_delete_session;
484
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200485 if (rec->realtime_prio) {
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200486 struct sched_param param;
487
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200488 param.sched_priority = rec->realtime_prio;
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200489 if (sched_setscheduler(0, SCHED_FIFO, &param)) {
Arnaldo Carvalho de Melo6beba7a2009-10-21 17:34:06 -0200490 pr_err("Could not set realtime priority.\n");
David Ahern8d3eca22012-08-26 12:24:47 -0600491 err = -1;
492 goto out_delete_session;
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200493 }
494 }
495
Jiri Olsa774cb492012-11-12 18:34:01 +0100496 /*
497 * When perf is starting the traced process, all the events
498 * (apart from group members) have enable_on_exec=1 set,
499 * so don't spoil it by prematurely enabling them.
500 */
Arnaldo Carvalho de Melo602ad872013-11-12 16:46:16 -0300501 if (!target__none(&opts->target))
Jiri Olsa774cb492012-11-12 18:34:01 +0100502 perf_evlist__enable(evsel_list);
David Ahern764e16a32011-08-25 10:17:55 -0600503
Peter Zijlstra856e9662009-12-16 17:55:55 +0100504 /*
505 * Let the child rip
506 */
Arnaldo Carvalho de Melod4db3f12009-12-27 21:36:57 -0200507 if (forks)
Arnaldo Carvalho de Melo35b9d882011-11-09 08:47:15 -0200508 perf_evlist__start_workload(evsel_list);
Peter Zijlstra856e9662009-12-16 17:55:55 +0100509
Peter Zijlstra649c48a2009-06-24 21:12:48 +0200510 for (;;) {
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200511 int hits = rec->samples;
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200512
David Ahern8d3eca22012-08-26 12:24:47 -0600513 if (perf_record__mmap_read_all(rec) < 0) {
514 err = -1;
515 goto out_delete_session;
516 }
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200517
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200518 if (hits == rec->samples) {
Peter Zijlstra649c48a2009-06-24 21:12:48 +0200519 if (done)
520 break;
Arnaldo Carvalho de Melo5c581042011-01-11 22:30:02 -0200521 err = poll(evsel_list->pollfd, evsel_list->nr_fds, -1);
Peter Zijlstra8b412662009-09-17 19:59:05 +0200522 waking++;
523 }
524
Jiri Olsa774cb492012-11-12 18:34:01 +0100525 /*
526 * When perf is starting the traced process, at the end events
527 * die with the process and we wait for that. Thus no need to
528 * disable events in this case.
529 */
Arnaldo Carvalho de Melo602ad872013-11-12 16:46:16 -0300530 if (done && !disabled && !target__none(&opts->target)) {
Arnaldo Carvalho de Melo4152ab32011-07-25 11:06:19 -0300531 perf_evlist__disable(evsel_list);
Jiri Olsa27119262012-11-12 18:34:02 +0100532 disabled = true;
533 }
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200534 }
535
Arnaldo Carvalho de Melo18483b82010-12-06 15:13:38 -0200536 if (quiet || signr == SIGUSR1)
Arnaldo Carvalho de Melob44308f2010-10-26 15:20:09 -0200537 return 0;
538
Peter Zijlstra8b412662009-09-17 19:59:05 +0200539 fprintf(stderr, "[ perf record: Woken up %ld times to write data ]\n", waking);
540
Ingo Molnar021e9f42009-06-03 19:27:19 +0200541 /*
542 * Approximate RIP event size: 24 bytes.
543 */
544 fprintf(stderr,
Arnaldo Carvalho de Melo9486aa32011-01-22 20:37:02 -0200545 "[ perf record: Captured and wrote %.3f MB %s (~%" PRIu64 " samples) ]\n",
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200546 (double)rec->bytes_written / 1024.0 / 1024.0,
Jiri Olsa6a4d98d2013-10-15 16:27:33 +0200547 file->path,
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200548 rec->bytes_written / 24);
Ingo Molnaraddc2782009-06-02 23:43:11 +0200549
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200550 return 0;
Arnaldo Carvalho de Melo39d17da2010-07-29 14:08:55 -0300551
552out_delete_session:
553 perf_session__delete(session);
554 return err;
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200555}
Ingo Molnar0e9b20b2009-05-26 09:17:18 +0200556
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100557#define BRANCH_OPT(n, m) \
558 { .name = n, .mode = (m) }
559
560#define BRANCH_END { .name = NULL }
561
562struct branch_mode {
563 const char *name;
564 int mode;
565};
566
567static const struct branch_mode branch_modes[] = {
568 BRANCH_OPT("u", PERF_SAMPLE_BRANCH_USER),
569 BRANCH_OPT("k", PERF_SAMPLE_BRANCH_KERNEL),
570 BRANCH_OPT("hv", PERF_SAMPLE_BRANCH_HV),
571 BRANCH_OPT("any", PERF_SAMPLE_BRANCH_ANY),
572 BRANCH_OPT("any_call", PERF_SAMPLE_BRANCH_ANY_CALL),
573 BRANCH_OPT("any_ret", PERF_SAMPLE_BRANCH_ANY_RETURN),
574 BRANCH_OPT("ind_call", PERF_SAMPLE_BRANCH_IND_CALL),
Andi Kleen0126d492013-09-20 07:40:42 -0700575 BRANCH_OPT("abort_tx", PERF_SAMPLE_BRANCH_ABORT_TX),
576 BRANCH_OPT("in_tx", PERF_SAMPLE_BRANCH_IN_TX),
577 BRANCH_OPT("no_tx", PERF_SAMPLE_BRANCH_NO_TX),
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100578 BRANCH_END
579};
580
581static int
Stephane Eraniana5aabda2012-03-08 23:47:45 +0100582parse_branch_stack(const struct option *opt, const char *str, int unset)
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100583{
584#define ONLY_PLM \
585 (PERF_SAMPLE_BRANCH_USER |\
586 PERF_SAMPLE_BRANCH_KERNEL |\
587 PERF_SAMPLE_BRANCH_HV)
588
589 uint64_t *mode = (uint64_t *)opt->value;
590 const struct branch_mode *br;
Stephane Eraniana5aabda2012-03-08 23:47:45 +0100591 char *s, *os = NULL, *p;
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100592 int ret = -1;
593
Stephane Eraniana5aabda2012-03-08 23:47:45 +0100594 if (unset)
595 return 0;
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100596
Stephane Eraniana5aabda2012-03-08 23:47:45 +0100597 /*
598 * cannot set it twice, -b + --branch-filter for instance
599 */
600 if (*mode)
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100601 return -1;
602
Stephane Eraniana5aabda2012-03-08 23:47:45 +0100603 /* str may be NULL in case no arg is passed to -b */
604 if (str) {
605 /* because str is read-only */
606 s = os = strdup(str);
607 if (!s)
608 return -1;
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100609
Stephane Eraniana5aabda2012-03-08 23:47:45 +0100610 for (;;) {
611 p = strchr(s, ',');
612 if (p)
613 *p = '\0';
614
615 for (br = branch_modes; br->name; br++) {
616 if (!strcasecmp(s, br->name))
617 break;
618 }
619 if (!br->name) {
620 ui__warning("unknown branch filter %s,"
621 " check man page\n", s);
622 goto error;
623 }
624
625 *mode |= br->mode;
626
627 if (!p)
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100628 break;
Stephane Eraniana5aabda2012-03-08 23:47:45 +0100629
630 s = p + 1;
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100631 }
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100632 }
633 ret = 0;
634
Stephane Eraniana5aabda2012-03-08 23:47:45 +0100635 /* default to any branch */
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100636 if ((*mode & ~ONLY_PLM) == 0) {
Stephane Eraniana5aabda2012-03-08 23:47:45 +0100637 *mode = PERF_SAMPLE_BRANCH_ANY;
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100638 }
639error:
640 free(os);
641 return ret;
642}
643
Ingo Molnar89fe8082013-09-30 12:07:11 +0200644#ifdef HAVE_LIBUNWIND_SUPPORT
Jiri Olsa26d33022012-08-07 15:20:47 +0200645static int get_stack_size(char *str, unsigned long *_size)
646{
647 char *endptr;
648 unsigned long size;
649 unsigned long max_size = round_down(USHRT_MAX, sizeof(u64));
650
651 size = strtoul(str, &endptr, 0);
652
653 do {
654 if (*endptr)
655 break;
656
657 size = round_up(size, sizeof(u64));
658 if (!size || size > max_size)
659 break;
660
661 *_size = size;
662 return 0;
663
664 } while (0);
665
666 pr_err("callchain: Incorrect stack dump size (max %ld): %s\n",
667 max_size, str);
668 return -1;
669}
Ingo Molnar89fe8082013-09-30 12:07:11 +0200670#endif /* HAVE_LIBUNWIND_SUPPORT */
Jiri Olsa26d33022012-08-07 15:20:47 +0200671
Jiri Olsa09b0fd42013-10-26 16:25:33 +0200672int record_parse_callchain(const char *arg, struct perf_record_opts *opts)
Jiri Olsa26d33022012-08-07 15:20:47 +0200673{
Jiri Olsa26d33022012-08-07 15:20:47 +0200674 char *tok, *name, *saveptr = NULL;
675 char *buf;
676 int ret = -1;
677
Jiri Olsa26d33022012-08-07 15:20:47 +0200678 /* We need buffer that we know we can write to. */
679 buf = malloc(strlen(arg) + 1);
680 if (!buf)
681 return -ENOMEM;
682
683 strcpy(buf, arg);
684
685 tok = strtok_r((char *)buf, ",", &saveptr);
686 name = tok ? : (char *)buf;
687
688 do {
689 /* Framepointer style */
690 if (!strncmp(name, "fp", sizeof("fp"))) {
691 if (!strtok_r(NULL, ",", &saveptr)) {
Arnaldo Carvalho de Meloc5ff78c2012-12-11 16:16:47 -0300692 opts->call_graph = CALLCHAIN_FP;
Jiri Olsa26d33022012-08-07 15:20:47 +0200693 ret = 0;
694 } else
695 pr_err("callchain: No more arguments "
696 "needed for -g fp\n");
697 break;
698
Ingo Molnar89fe8082013-09-30 12:07:11 +0200699#ifdef HAVE_LIBUNWIND_SUPPORT
Jiri Olsa26d33022012-08-07 15:20:47 +0200700 /* Dwarf style */
701 } else if (!strncmp(name, "dwarf", sizeof("dwarf"))) {
Arnaldo Carvalho de Melo61eaa3b2012-10-01 15:20:58 -0300702 const unsigned long default_stack_dump_size = 8192;
703
Jiri Olsa26d33022012-08-07 15:20:47 +0200704 ret = 0;
Arnaldo Carvalho de Meloc5ff78c2012-12-11 16:16:47 -0300705 opts->call_graph = CALLCHAIN_DWARF;
706 opts->stack_dump_size = default_stack_dump_size;
Jiri Olsa26d33022012-08-07 15:20:47 +0200707
708 tok = strtok_r(NULL, ",", &saveptr);
709 if (tok) {
710 unsigned long size = 0;
711
712 ret = get_stack_size(tok, &size);
Arnaldo Carvalho de Meloc5ff78c2012-12-11 16:16:47 -0300713 opts->stack_dump_size = size;
Jiri Olsa26d33022012-08-07 15:20:47 +0200714 }
Ingo Molnar89fe8082013-09-30 12:07:11 +0200715#endif /* HAVE_LIBUNWIND_SUPPORT */
Jiri Olsa26d33022012-08-07 15:20:47 +0200716 } else {
Jiri Olsa09b0fd42013-10-26 16:25:33 +0200717 pr_err("callchain: Unknown --call-graph option "
Jiri Olsa26d33022012-08-07 15:20:47 +0200718 "value: %s\n", arg);
719 break;
720 }
721
722 } while (0);
723
724 free(buf);
Jiri Olsa09b0fd42013-10-26 16:25:33 +0200725 return ret;
726}
Jiri Olsa26d33022012-08-07 15:20:47 +0200727
Jiri Olsa09b0fd42013-10-26 16:25:33 +0200728static void callchain_debug(struct perf_record_opts *opts)
729{
730 pr_debug("callchain: type %d\n", opts->call_graph);
731
732 if (opts->call_graph == CALLCHAIN_DWARF)
733 pr_debug("callchain: stack dump size %d\n",
734 opts->stack_dump_size);
735}
736
737int record_parse_callchain_opt(const struct option *opt,
738 const char *arg,
739 int unset)
740{
741 struct perf_record_opts *opts = opt->value;
742 int ret;
743
744 /* --no-call-graph */
745 if (unset) {
746 opts->call_graph = CALLCHAIN_NONE;
747 pr_debug("callchain: disabled\n");
748 return 0;
749 }
750
751 ret = record_parse_callchain(arg, opts);
Jiri Olsa26d33022012-08-07 15:20:47 +0200752 if (!ret)
Jiri Olsa09b0fd42013-10-26 16:25:33 +0200753 callchain_debug(opts);
Jiri Olsa26d33022012-08-07 15:20:47 +0200754
755 return ret;
756}
757
Jiri Olsa09b0fd42013-10-26 16:25:33 +0200758int record_callchain_opt(const struct option *opt,
759 const char *arg __maybe_unused,
760 int unset __maybe_unused)
761{
762 struct perf_record_opts *opts = opt->value;
763
764 if (opts->call_graph == CALLCHAIN_NONE)
765 opts->call_graph = CALLCHAIN_FP;
766
767 callchain_debug(opts);
768 return 0;
769}
770
Ingo Molnar0e9b20b2009-05-26 09:17:18 +0200771static const char * const record_usage[] = {
Mike Galbraith9e0967532009-05-28 16:25:34 +0200772 "perf record [<options>] [<command>]",
773 "perf record [<options>] -- <command> [<options>]",
Ingo Molnar0e9b20b2009-05-26 09:17:18 +0200774 NULL
775};
776
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200777/*
778 * XXX Ideally would be local to cmd_record() and passed to a perf_record__new
779 * because we need to have access to it in perf_record__exit, that is called
780 * after cmd_record() exits, but since record_options need to be accessible to
781 * builtin-script, leave it here.
782 *
783 * At least we don't ouch it in all the other functions here directly.
784 *
785 * Just say no to tons of global variables, sigh.
786 */
787static struct perf_record record = {
788 .opts = {
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200789 .mmap_pages = UINT_MAX,
790 .user_freq = UINT_MAX,
791 .user_interval = ULLONG_MAX,
Arnaldo Carvalho de Melo447a6012012-05-22 13:14:18 -0300792 .freq = 4000,
Namhyung Kimd1cb9fc2012-05-16 18:45:49 +0900793 .target = {
794 .uses_mmap = true,
Adrian Hunter3aa59392013-11-15 15:52:29 +0200795 .default_per_cpu = true,
Namhyung Kimd1cb9fc2012-05-16 18:45:49 +0900796 },
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200797 },
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200798};
Frederic Weisbecker7865e812010-04-14 19:42:07 +0200799
Jiri Olsa09b0fd42013-10-26 16:25:33 +0200800#define CALLCHAIN_HELP "setup and enables call-graph (stack chain/backtrace) recording: "
Arnaldo Carvalho de Melo61eaa3b2012-10-01 15:20:58 -0300801
Ingo Molnar89fe8082013-09-30 12:07:11 +0200802#ifdef HAVE_LIBUNWIND_SUPPORT
Jiri Olsa09b0fd42013-10-26 16:25:33 +0200803const char record_callchain_help[] = CALLCHAIN_HELP "fp dwarf";
Arnaldo Carvalho de Melo61eaa3b2012-10-01 15:20:58 -0300804#else
Jiri Olsa09b0fd42013-10-26 16:25:33 +0200805const char record_callchain_help[] = CALLCHAIN_HELP "fp";
Arnaldo Carvalho de Melo61eaa3b2012-10-01 15:20:58 -0300806#endif
807
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200808/*
809 * XXX Will stay a global variable till we fix builtin-script.c to stop messing
810 * with it and switch to use the library functions in perf_evlist that came
811 * from builtin-record.c, i.e. use perf_record_opts,
812 * perf_evlist__prepare_workload, etc instead of fork+exec'in 'perf record',
813 * using pipes, etc.
814 */
Tom Zanussibca647a2010-11-10 08:11:30 -0600815const struct option record_options[] = {
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200816 OPT_CALLBACK('e', "event", &record.evlist, "event",
Thomas Gleixner86847b62009-06-06 12:24:17 +0200817 "event selector. use 'perf list' to list available events",
Jiri Olsaf120f9d2011-07-14 11:25:32 +0200818 parse_events_option),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200819 OPT_CALLBACK(0, "filter", &record.evlist, "filter",
Li Zefanc171b552009-10-15 11:22:07 +0800820 "event filter", parse_filter),
Namhyung Kimbea03402012-04-26 14:15:15 +0900821 OPT_STRING('p', "pid", &record.opts.target.pid, "pid",
Zhang, Yanmind6d901c2010-03-18 11:36:05 -0300822 "record events on existing process id"),
Namhyung Kimbea03402012-04-26 14:15:15 +0900823 OPT_STRING('t', "tid", &record.opts.target.tid, "tid",
Zhang, Yanmind6d901c2010-03-18 11:36:05 -0300824 "record events on existing thread id"),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200825 OPT_INTEGER('r', "realtime", &record.realtime_prio,
Ingo Molnar0e9b20b2009-05-26 09:17:18 +0200826 "collect data with this RT SCHED_FIFO priority"),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200827 OPT_BOOLEAN('D', "no-delay", &record.opts.no_delay,
Kirill Smelkovacac03f2011-01-12 17:59:36 +0300828 "collect data without buffering"),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200829 OPT_BOOLEAN('R', "raw-samples", &record.opts.raw_samples,
Frederic Weisbeckerdaac07b2009-08-13 10:27:19 +0200830 "collect raw sample records from all opened counters"),
Namhyung Kimbea03402012-04-26 14:15:15 +0900831 OPT_BOOLEAN('a', "all-cpus", &record.opts.target.system_wide,
Ingo Molnar0e9b20b2009-05-26 09:17:18 +0200832 "system-wide collection from all CPUs"),
Namhyung Kimbea03402012-04-26 14:15:15 +0900833 OPT_STRING('C', "cpu", &record.opts.target.cpu_list, "cpu",
Stephane Eranianc45c6ea2010-05-28 12:00:01 +0200834 "list of cpus to monitor"),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200835 OPT_U64('c', "count", &record.opts.user_interval, "event period to sample"),
Jiri Olsaf5fc14122013-10-15 16:27:32 +0200836 OPT_STRING('o', "output", &record.file.path, "file",
Ingo Molnarabaff322009-06-02 22:59:57 +0200837 "output file name"),
Adrian Hunter69e7e5b2013-11-18 11:55:57 +0200838 OPT_BOOLEAN_SET('i', "no-inherit", &record.opts.no_inherit,
839 &record.opts.no_inherit_set,
840 "child tasks do not inherit counters"),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200841 OPT_UINTEGER('F', "freq", &record.opts.user_freq, "profile at this frequency"),
Jiri Olsa994a1f72013-09-01 12:36:12 +0200842 OPT_CALLBACK('m', "mmap-pages", &record.opts.mmap_pages, "pages",
843 "number of mmap data pages",
844 perf_evlist__parse_mmap_pages),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200845 OPT_BOOLEAN(0, "group", &record.opts.group,
Lin Ming43bece72011-08-17 18:42:07 +0800846 "put the counters into a counter group"),
Jiri Olsa09b0fd42013-10-26 16:25:33 +0200847 OPT_CALLBACK_NOOPT('g', NULL, &record.opts,
848 NULL, "enables call-graph recording" ,
849 &record_callchain_opt),
850 OPT_CALLBACK(0, "call-graph", &record.opts,
851 "mode[,dump_size]", record_callchain_help,
852 &record_parse_callchain_opt),
Ian Munsiec0555642010-04-13 18:37:33 +1000853 OPT_INCR('v', "verbose", &verbose,
Ingo Molnar3da297a2009-06-07 17:39:02 +0200854 "be more verbose (show counter open errors, etc)"),
Arnaldo Carvalho de Melob44308f2010-10-26 15:20:09 -0200855 OPT_BOOLEAN('q', "quiet", &quiet, "don't print any message"),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200856 OPT_BOOLEAN('s', "stat", &record.opts.inherit_stat,
Peter Zijlstra649c48a2009-06-24 21:12:48 +0200857 "per thread counts"),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200858 OPT_BOOLEAN('d', "data", &record.opts.sample_address,
Anton Blanchard4bba8282009-07-16 15:44:29 +0200859 "Sample addresses"),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200860 OPT_BOOLEAN('T', "timestamp", &record.opts.sample_time, "Sample timestamps"),
Andrew Vagin3e76ac72011-12-20 17:32:45 +0300861 OPT_BOOLEAN('P', "period", &record.opts.period, "Sample period"),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200862 OPT_BOOLEAN('n', "no-samples", &record.opts.no_samples,
Peter Zijlstra649c48a2009-06-24 21:12:48 +0200863 "don't sample"),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200864 OPT_BOOLEAN('N', "no-buildid-cache", &record.no_buildid_cache,
Stephane Eraniana1ac1d32010-06-17 11:39:01 +0200865 "do not update the buildid cache"),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200866 OPT_BOOLEAN('B', "no-buildid", &record.no_buildid,
Arnaldo Carvalho de Melobaa2f6c2010-11-26 19:39:15 -0200867 "do not collect buildids in perf.data"),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200868 OPT_CALLBACK('G', "cgroup", &record.evlist, "name",
Stephane Eranian023695d2011-02-14 11:20:01 +0200869 "monitor event in cgroup name only",
870 parse_cgroups),
Namhyung Kimbea03402012-04-26 14:15:15 +0900871 OPT_STRING('u', "uid", &record.opts.target.uid_str, "user",
872 "user to profile"),
Stephane Eraniana5aabda2012-03-08 23:47:45 +0100873
874 OPT_CALLBACK_NOOPT('b', "branch-any", &record.opts.branch_stack,
875 "branch any", "sample any taken branches",
876 parse_branch_stack),
877
878 OPT_CALLBACK('j', "branch-filter", &record.opts.branch_stack,
879 "branch filter mask", "branch stack filter modes",
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100880 parse_branch_stack),
Andi Kleen05484292013-01-24 16:10:29 +0100881 OPT_BOOLEAN('W', "weight", &record.opts.sample_weight,
882 "sample by weight (on special events only)"),
Andi Kleen475eeab2013-09-20 07:40:43 -0700883 OPT_BOOLEAN(0, "transaction", &record.opts.sample_transaction,
884 "sample transaction flags (special events only)"),
Adrian Hunter3aa59392013-11-15 15:52:29 +0200885 OPT_BOOLEAN(0, "per-thread", &record.opts.target.per_thread,
886 "use per-thread mmaps"),
Ingo Molnar0e9b20b2009-05-26 09:17:18 +0200887 OPT_END()
888};
889
Irina Tirdea1d037ca2012-09-11 01:15:03 +0300890int cmd_record(int argc, const char **argv, const char *prefix __maybe_unused)
Ingo Molnar0e9b20b2009-05-26 09:17:18 +0200891{
Arnaldo Carvalho de Melo69aad6f2011-01-03 16:39:04 -0200892 int err = -ENOMEM;
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200893 struct perf_evlist *evsel_list;
894 struct perf_record *rec = &record;
Namhyung Kim16ad2ff2012-05-07 14:09:02 +0900895 char errbuf[BUFSIZ];
Ingo Molnar0e9b20b2009-05-26 09:17:18 +0200896
Namhyung Kim334fe7a2013-03-11 16:43:12 +0900897 evsel_list = perf_evlist__new();
Arnaldo Carvalho de Melo361c99a2011-01-11 20:56:53 -0200898 if (evsel_list == NULL)
899 return -ENOMEM;
900
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200901 rec->evlist = evsel_list;
902
Tom Zanussibca647a2010-11-10 08:11:30 -0600903 argc = parse_options(argc, argv, record_options, record_usage,
Arnaldo Carvalho de Melo655000e2009-12-15 20:04:40 -0200904 PARSE_OPT_STOP_AT_NON_OPTION);
Arnaldo Carvalho de Melo602ad872013-11-12 16:46:16 -0300905 if (!argc && target__none(&rec->opts.target))
Tom Zanussibca647a2010-11-10 08:11:30 -0600906 usage_with_options(record_usage, record_options);
Ingo Molnar0e9b20b2009-05-26 09:17:18 +0200907
Namhyung Kimbea03402012-04-26 14:15:15 +0900908 if (nr_cgroups && !rec->opts.target.system_wide) {
Namhyung Kim3780f482012-05-29 13:22:57 +0900909 ui__error("cgroup monitoring only available in"
910 " system-wide mode\n");
Stephane Eranian023695d2011-02-14 11:20:01 +0200911 usage_with_options(record_usage, record_options);
912 }
913
Arnaldo Carvalho de Melo655000e2009-12-15 20:04:40 -0200914 symbol__init();
Arnaldo Carvalho de Melobaa2f6c2010-11-26 19:39:15 -0200915
Arnaldo Carvalho de Meloec80fde2011-05-26 09:53:51 -0300916 if (symbol_conf.kptr_restrict)
Arnaldo Carvalho de Melo646aaea2011-05-27 11:00:41 -0300917 pr_warning(
918"WARNING: Kernel address maps (/proc/{kallsyms,modules}) are restricted,\n"
919"check /proc/sys/kernel/kptr_restrict.\n\n"
920"Samples in kernel functions may not be resolved if a suitable vmlinux\n"
921"file is not found in the buildid cache or in the vmlinux path.\n\n"
922"Samples in kernel modules won't be resolved at all.\n\n"
923"If some relocation was applied (e.g. kexec) symbols may be misresolved\n"
924"even with a suitable vmlinux or kallsyms file.\n\n");
Arnaldo Carvalho de Meloec80fde2011-05-26 09:53:51 -0300925
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200926 if (rec->no_buildid_cache || rec->no_buildid)
Stephane Eraniana1ac1d32010-06-17 11:39:01 +0200927 disable_buildid_cache();
Arnaldo Carvalho de Melo655000e2009-12-15 20:04:40 -0200928
Arnaldo Carvalho de Melo361c99a2011-01-11 20:56:53 -0200929 if (evsel_list->nr_entries == 0 &&
930 perf_evlist__add_default(evsel_list) < 0) {
Arnaldo Carvalho de Melo69aad6f2011-01-03 16:39:04 -0200931 pr_err("Not enough memory for event selector list\n");
932 goto out_symbol_exit;
Peter Zijlstrabbd36e52009-06-11 23:11:50 +0200933 }
Ingo Molnar0e9b20b2009-05-26 09:17:18 +0200934
Adrian Hunter69e7e5b2013-11-18 11:55:57 +0200935 if (rec->opts.target.tid && !rec->opts.no_inherit_set)
936 rec->opts.no_inherit = true;
937
Arnaldo Carvalho de Melo602ad872013-11-12 16:46:16 -0300938 err = target__validate(&rec->opts.target);
Namhyung Kim16ad2ff2012-05-07 14:09:02 +0900939 if (err) {
Arnaldo Carvalho de Melo602ad872013-11-12 16:46:16 -0300940 target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
Namhyung Kim16ad2ff2012-05-07 14:09:02 +0900941 ui__warning("%s", errbuf);
942 }
Namhyung Kim4bd0f2d2012-04-26 14:15:18 +0900943
Arnaldo Carvalho de Melo602ad872013-11-12 16:46:16 -0300944 err = target__parse_uid(&rec->opts.target);
Namhyung Kim16ad2ff2012-05-07 14:09:02 +0900945 if (err) {
946 int saved_errno = errno;
947
Arnaldo Carvalho de Melo602ad872013-11-12 16:46:16 -0300948 target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
Namhyung Kim3780f482012-05-29 13:22:57 +0900949 ui__error("%s", errbuf);
Namhyung Kim16ad2ff2012-05-07 14:09:02 +0900950
951 err = -saved_errno;
Namhyung Kim8fa60e12013-03-15 14:48:51 +0900952 goto out_symbol_exit;
Namhyung Kim16ad2ff2012-05-07 14:09:02 +0900953 }
Arnaldo Carvalho de Melo0d37aa32012-01-19 14:08:15 -0200954
Namhyung Kim16ad2ff2012-05-07 14:09:02 +0900955 err = -ENOMEM;
Namhyung Kimb809ac12012-04-26 14:15:19 +0900956 if (perf_evlist__create_maps(evsel_list, &rec->opts.target) < 0)
Arnaldo Carvalho de Melodd7927f2011-01-12 14:28:51 -0200957 usage_with_options(record_usage, record_options);
Arnaldo Carvalho de Melo69aad6f2011-01-03 16:39:04 -0200958
Jiri Olsa714647b2013-11-05 15:14:47 +0100959 if (perf_record_opts__config(&rec->opts)) {
Arnaldo Carvalho de Melo39d17da2010-07-29 14:08:55 -0300960 err = -EINVAL;
Arnaldo Carvalho de Melo5c581042011-01-11 22:30:02 -0200961 goto out_free_fd;
Mike Galbraith7e4ff9e2009-10-12 07:56:03 +0200962 }
963
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200964 err = __cmd_record(&record, argc, argv);
Namhyung Kim8fa60e12013-03-15 14:48:51 +0900965
966 perf_evlist__munmap(evsel_list);
967 perf_evlist__close(evsel_list);
Arnaldo Carvalho de Melo39d17da2010-07-29 14:08:55 -0300968out_free_fd:
Arnaldo Carvalho de Melo7e2ed092011-01-30 11:59:43 -0200969 perf_evlist__delete_maps(evsel_list);
Arnaldo Carvalho de Melod65a4582010-07-30 18:31:28 -0300970out_symbol_exit:
971 symbol__exit();
Arnaldo Carvalho de Melo39d17da2010-07-29 14:08:55 -0300972 return err;
Ingo Molnar0e9b20b2009-05-26 09:17:18 +0200973}