blob: eb524f91bffe5d9098d582e07050734a1c3e5343 [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 Weisbecker8f28827a2009-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 Olsaf5fc1412013-10-15 16:27:32 +020027#include "util/data.h"
Peter Zijlstra7c6a1c62009-06-25 17:05:54 +020028
Peter Zijlstra97124d52009-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 Melo8c6f45a2013-12-19 14:38:03 -030065struct record {
Arnaldo Carvalho de Melo45694aa2011-11-28 08:30:20 -020066 struct perf_tool tool;
Arnaldo Carvalho de Melob4006792013-12-19 14:43:45 -030067 struct record_opts opts;
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -020068 u64 bytes_written;
Jiri Olsaf5fc1412013-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
Arnaldo Carvalho de Melo8c6f45a2013-12-19 14:38:03 -030079static int record__write(struct record *rec, void *bf, size_t size)
Peter Zijlstraf5970552009-06-18 23:22:55 +020080{
Arnaldo Carvalho de Melocf8b2e62013-12-19 14:26:26 -030081 if (perf_data_file__write(rec->session->file, bf, size) < 0) {
Jiri Olsa50a9b862013-11-22 13:11:24 +010082 pr_err("failed to write perf data, error: %m\n");
83 return -1;
Peter Zijlstraf5970552009-06-18 23:22:55 +020084 }
David Ahern8d3eca22012-08-26 12:24:47 -060085
Arnaldo Carvalho de Melocf8b2e62013-12-19 14:26:26 -030086 rec->bytes_written += size;
David Ahern8d3eca22012-08-26 12:24:47 -060087 return 0;
Peter Zijlstraf5970552009-06-18 23:22:55 +020088}
89
Arnaldo Carvalho de Melo45694aa2011-11-28 08:30:20 -020090static int process_synthesized_event(struct perf_tool *tool,
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -020091 union perf_event *event,
Irina Tirdea1d037ca2012-09-11 01:15:03 +030092 struct perf_sample *sample __maybe_unused,
93 struct machine *machine __maybe_unused)
Arnaldo Carvalho de Melo234fbbf2009-10-26 19:23:18 -020094{
Arnaldo Carvalho de Melo8c6f45a2013-12-19 14:38:03 -030095 struct record *rec = container_of(tool, struct record, tool);
96 return record__write(rec, event, event->header.size);
Arnaldo Carvalho de Melo234fbbf2009-10-26 19:23:18 -020097}
98
Arnaldo Carvalho de Melo8c6f45a2013-12-19 14:38:03 -030099static int record__mmap_read(struct record *rec, struct perf_mmap *md)
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200100{
Arnaldo Carvalho de Melo744bd8a2011-01-12 17:07:28 -0200101 unsigned int head = perf_mmap__read_head(md);
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200102 unsigned int old = md->prev;
Jiri Olsa918512b2013-09-12 18:39:35 +0200103 unsigned char *data = md->base + page_size;
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200104 unsigned long size;
105 void *buf;
David Ahern8d3eca22012-08-26 12:24:47 -0600106 int rc = 0;
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200107
Arnaldo Carvalho de Melodc820092011-01-28 14:49:19 -0200108 if (old == head)
David Ahern8d3eca22012-08-26 12:24:47 -0600109 return 0;
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200110
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200111 rec->samples++;
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200112
113 size = head - old;
114
115 if ((old & md->mask) + size != (head & md->mask)) {
116 buf = &data[old & md->mask];
117 size = md->mask + 1 - (old & md->mask);
118 old += size;
Ingo Molnar021e9f42009-06-03 19:27:19 +0200119
Arnaldo Carvalho de Melo8c6f45a2013-12-19 14:38:03 -0300120 if (record__write(rec, buf, size) < 0) {
David Ahern8d3eca22012-08-26 12:24:47 -0600121 rc = -1;
122 goto out;
123 }
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200124 }
125
126 buf = &data[old & md->mask];
127 size = head - old;
128 old += size;
Ingo Molnar021e9f42009-06-03 19:27:19 +0200129
Arnaldo Carvalho de Melo8c6f45a2013-12-19 14:38:03 -0300130 if (record__write(rec, buf, size) < 0) {
David Ahern8d3eca22012-08-26 12:24:47 -0600131 rc = -1;
132 goto out;
133 }
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200134
135 md->prev = old;
Arnaldo Carvalho de Melo115d2d82011-01-12 17:11:53 -0200136 perf_mmap__write_tail(md, old);
David Ahern8d3eca22012-08-26 12:24:47 -0600137
138out:
139 return rc;
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200140}
141
142static volatile int done = 0;
Peter Zijlstraf7b7c262009-06-10 15:55:59 +0200143static volatile int signr = -1;
Andi Kleen33e49ea2011-09-15 14:31:40 -0700144static volatile int child_finished = 0;
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200145
Peter Zijlstra16c8a102009-05-05 17:50:27 +0200146static void sig_handler(int sig)
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200147{
Andi Kleen33e49ea2011-09-15 14:31:40 -0700148 if (sig == SIGCHLD)
149 child_finished = 1;
150
Peter Zijlstra16c8a102009-05-05 17:50:27 +0200151 done = 1;
Peter Zijlstraf7b7c262009-06-10 15:55:59 +0200152 signr = sig;
153}
154
Arnaldo Carvalho de Melo8c6f45a2013-12-19 14:38:03 -0300155static void record__sig_exit(int exit_status __maybe_unused, void *arg)
Peter Zijlstraf7b7c262009-06-10 15:55:59 +0200156{
Arnaldo Carvalho de Melo8c6f45a2013-12-19 14:38:03 -0300157 struct record *rec = arg;
Andi Kleen33e49ea2011-09-15 14:31:40 -0700158 int status;
159
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200160 if (rec->evlist->workload.pid > 0) {
Andi Kleen33e49ea2011-09-15 14:31:40 -0700161 if (!child_finished)
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200162 kill(rec->evlist->workload.pid, SIGTERM);
Andi Kleen33e49ea2011-09-15 14:31:40 -0700163
164 wait(&status);
165 if (WIFSIGNALED(status))
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200166 psignal(WTERMSIG(status), rec->progname);
Andi Kleen33e49ea2011-09-15 14:31:40 -0700167 }
Chris Wilson933da832009-10-04 01:35:01 +0100168
Arnaldo Carvalho de Melo18483b82010-12-06 15:13:38 -0200169 if (signr == -1 || signr == SIGUSR1)
Peter Zijlstraf7b7c262009-06-10 15:55:59 +0200170 return;
171
172 signal(signr, SIG_DFL);
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200173}
174
Arnaldo Carvalho de Melo8c6f45a2013-12-19 14:38:03 -0300175static int record__open(struct record *rec)
Arnaldo Carvalho de Melodd7927f2011-01-12 14:28:51 -0200176{
Arnaldo Carvalho de Melo56e52e82012-12-13 15:10:58 -0300177 char msg[512];
Jiri Olsa6a4bb042012-08-08 12:22:36 +0200178 struct perf_evsel *pos;
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200179 struct perf_evlist *evlist = rec->evlist;
180 struct perf_session *session = rec->session;
Arnaldo Carvalho de Melob4006792013-12-19 14:43:45 -0300181 struct record_opts *opts = &rec->opts;
David Ahern8d3eca22012-08-26 12:24:47 -0600182 int rc = 0;
Arnaldo Carvalho de Melodd7927f2011-01-12 14:28:51 -0200183
Arnaldo Carvalho de Melof77a9512012-12-10 16:41:31 -0300184 perf_evlist__config(evlist, opts);
Jiri Olsacac21422012-11-12 18:34:00 +0100185
Arnaldo Carvalho de Melo0050f7a2014-01-10 10:37:27 -0300186 evlist__for_each(evlist, pos) {
Ingo Molnar3da297a2009-06-07 17:39:02 +0200187try_again:
Jiri Olsa6a4bb042012-08-08 12:22:36 +0200188 if (perf_evsel__open(pos, evlist->cpus, evlist->threads) < 0) {
Arnaldo Carvalho de Melo56e52e82012-12-13 15:10:58 -0300189 if (perf_evsel__fallback(pos, errno, msg, sizeof(msg))) {
Zhang, Yanmind6d901c2010-03-18 11:36:05 -0300190 if (verbose)
Arnaldo Carvalho de Meloc0a54342012-12-13 14:16:30 -0300191 ui__warning("%s\n", msg);
Zhang, Yanmind6d901c2010-03-18 11:36:05 -0300192 goto try_again;
193 }
David Ahernca6a4252011-03-25 13:11:11 -0600194
Arnaldo Carvalho de Melo56e52e82012-12-13 15:10:58 -0300195 rc = -errno;
196 perf_evsel__open_strerror(pos, &opts->target,
197 errno, msg, sizeof(msg));
198 ui__error("%s\n", msg);
David Ahern8d3eca22012-08-26 12:24:47 -0600199 goto out;
Zhang, Yanmind6d901c2010-03-18 11:36:05 -0300200 }
Li Zefanc171b552009-10-15 11:22:07 +0800201 }
Arnaldo Carvalho de Meloa43d3f02010-12-25 12:12:25 -0200202
Arnaldo Carvalho de Melo1491a632012-09-26 14:43:13 -0300203 if (perf_evlist__apply_filters(evlist)) {
Frederic Weisbecker0a102472011-02-26 04:51:54 +0100204 error("failed to set filter with %d (%s)\n", errno,
205 strerror(errno));
David Ahern8d3eca22012-08-26 12:24:47 -0600206 rc = -1;
207 goto out;
Frederic Weisbecker0a102472011-02-26 04:51:54 +0100208 }
209
Nelson Elhage18e60932011-12-19 08:39:31 -0500210 if (perf_evlist__mmap(evlist, opts->mmap_pages, false) < 0) {
David Ahern8d3eca22012-08-26 12:24:47 -0600211 if (errno == EPERM) {
212 pr_err("Permission error mapping pages.\n"
213 "Consider increasing "
214 "/proc/sys/kernel/perf_event_mlock_kb,\n"
215 "or try again with a smaller value of -m/--mmap_pages.\n"
Adrian Hunter53653d72013-12-09 15:18:40 +0200216 "(current value: %u)\n", opts->mmap_pages);
David Ahern8d3eca22012-08-26 12:24:47 -0600217 rc = -errno;
David Ahern8d3eca22012-08-26 12:24:47 -0600218 } else {
219 pr_err("failed to mmap with %d (%s)\n", errno, strerror(errno));
220 rc = -errno;
221 }
222 goto out;
Nelson Elhage18e60932011-12-19 08:39:31 -0500223 }
Arnaldo Carvalho de Melo0a27d7f2011-01-14 15:50:51 -0200224
Jiri Olsa563aecb2013-06-05 13:35:06 +0200225 session->evlist = evlist;
Arnaldo Carvalho de Melo7b56cce2012-08-01 19:31:00 -0300226 perf_session__set_id_hdr_size(session);
David Ahern8d3eca22012-08-26 12:24:47 -0600227out:
228 return rc;
Peter Zijlstra16c8a102009-05-05 17:50:27 +0200229}
230
Arnaldo Carvalho de Melo8c6f45a2013-12-19 14:38:03 -0300231static int process_buildids(struct record *rec)
Arnaldo Carvalho de Melo6122e4e2010-02-03 16:52:05 -0200232{
Jiri Olsaf5fc1412013-10-15 16:27:32 +0200233 struct perf_data_file *file = &rec->file;
234 struct perf_session *session = rec->session;
David Ahern7ab75cf2013-11-06 11:41:36 -0700235 u64 start = session->header.data_offset;
Arnaldo Carvalho de Melo6122e4e2010-02-03 16:52:05 -0200236
Jiri Olsaf5fc1412013-10-15 16:27:32 +0200237 u64 size = lseek(file->fd, 0, SEEK_CUR);
Arnaldo Carvalho de Melo9f591fd2010-03-11 15:53:11 -0300238 if (size == 0)
239 return 0;
240
David Ahern7ab75cf2013-11-06 11:41:36 -0700241 return __perf_session__process_events(session, start,
242 size - start,
Arnaldo Carvalho de Melo6122e4e2010-02-03 16:52:05 -0200243 size, &build_id__mark_dso_hit_ops);
244}
245
Arnaldo Carvalho de Melo8c6f45a2013-12-19 14:38:03 -0300246static void record__exit(int status, void *arg)
Peter Zijlstraf5970552009-06-18 23:22:55 +0200247{
Arnaldo Carvalho de Melo8c6f45a2013-12-19 14:38:03 -0300248 struct record *rec = arg;
Jiri Olsaf5fc1412013-10-15 16:27:32 +0200249 struct perf_data_file *file = &rec->file;
Peter Zijlstraf5970552009-06-18 23:22:55 +0200250
David Ahern8d3eca22012-08-26 12:24:47 -0600251 if (status != 0)
252 return;
253
Jiri Olsaf5fc1412013-10-15 16:27:32 +0200254 if (!file->is_pipe) {
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200255 rec->session->header.data_size += rec->bytes_written;
256
257 if (!rec->no_buildid)
258 process_buildids(rec);
259 perf_session__write_header(rec->session, rec->evlist,
Jiri Olsaf5fc1412013-10-15 16:27:32 +0200260 file->fd, true);
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200261 perf_session__delete(rec->session);
262 perf_evlist__delete(rec->evlist);
Arnaldo Carvalho de Melod65a4582010-07-30 18:31:28 -0300263 symbol__exit();
Tom Zanussic7929e42010-04-01 23:59:22 -0500264 }
Peter Zijlstraf5970552009-06-18 23:22:55 +0200265}
266
Arnaldo Carvalho de Melo8115d602011-01-29 14:01:45 -0200267static void perf_event__synthesize_guest_os(struct machine *machine, void *data)
Zhang, Yanmina1645ce2010-04-19 13:32:50 +0800268{
269 int err;
Arnaldo Carvalho de Melo45694aa2011-11-28 08:30:20 -0200270 struct perf_tool *tool = data;
Zhang, Yanmina1645ce2010-04-19 13:32:50 +0800271 /*
272 *As for guest kernel when processing subcommand record&report,
273 *we arrange module mmap prior to guest kernel mmap and trigger
274 *a preload dso because default guest module symbols are loaded
275 *from guest kallsyms instead of /lib/modules/XXX/XXX. This
276 *method is used to avoid symbol missing when the first addr is
277 *in module instead of in guest kernel.
278 */
Arnaldo Carvalho de Melo45694aa2011-11-28 08:30:20 -0200279 err = perf_event__synthesize_modules(tool, process_synthesized_event,
Arnaldo Carvalho de Melo743eb862011-11-28 07:56:39 -0200280 machine);
Zhang, Yanmina1645ce2010-04-19 13:32:50 +0800281 if (err < 0)
282 pr_err("Couldn't record guest kernel [%d]'s reference"
Arnaldo Carvalho de Melo23346f22010-04-27 21:17:50 -0300283 " relocation symbol.\n", machine->pid);
Zhang, Yanmina1645ce2010-04-19 13:32:50 +0800284
Zhang, Yanmina1645ce2010-04-19 13:32:50 +0800285 /*
286 * We use _stext for guest kernel because guest kernel's /proc/kallsyms
287 * have no _text sometimes.
288 */
Arnaldo Carvalho de Melo45694aa2011-11-28 08:30:20 -0200289 err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
Adrian Hunter0ae617b2014-01-29 16:14:40 +0200290 machine);
Zhang, Yanmina1645ce2010-04-19 13:32:50 +0800291 if (err < 0)
292 pr_err("Couldn't record guest kernel [%d]'s reference"
Arnaldo Carvalho de Melo23346f22010-04-27 21:17:50 -0300293 " relocation symbol.\n", machine->pid);
Zhang, Yanmina1645ce2010-04-19 13:32:50 +0800294}
295
Frederic Weisbecker98402802010-05-02 22:05:29 +0200296static struct perf_event_header finished_round_event = {
297 .size = sizeof(struct perf_event_header),
298 .type = PERF_RECORD_FINISHED_ROUND,
299};
300
Arnaldo Carvalho de Melo8c6f45a2013-12-19 14:38:03 -0300301static int record__mmap_read_all(struct record *rec)
Frederic Weisbecker98402802010-05-02 22:05:29 +0200302{
Peter Zijlstra0e2e63d2010-05-20 14:45:26 +0200303 int i;
David Ahern8d3eca22012-08-26 12:24:47 -0600304 int rc = 0;
Frederic Weisbecker98402802010-05-02 22:05:29 +0200305
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200306 for (i = 0; i < rec->evlist->nr_mmaps; i++) {
David Ahern8d3eca22012-08-26 12:24:47 -0600307 if (rec->evlist->mmap[i].base) {
Arnaldo Carvalho de Melo8c6f45a2013-12-19 14:38:03 -0300308 if (record__mmap_read(rec, &rec->evlist->mmap[i]) != 0) {
David Ahern8d3eca22012-08-26 12:24:47 -0600309 rc = -1;
310 goto out;
311 }
312 }
Frederic Weisbecker98402802010-05-02 22:05:29 +0200313 }
314
Stephane Eranian2eeaaa02012-05-15 13:28:13 +0200315 if (perf_header__has_feat(&rec->session->header, HEADER_TRACING_DATA))
Arnaldo Carvalho de Melo8c6f45a2013-12-19 14:38:03 -0300316 rc = record__write(rec, &finished_round_event, sizeof(finished_round_event));
David Ahern8d3eca22012-08-26 12:24:47 -0600317
318out:
319 return rc;
Frederic Weisbecker98402802010-05-02 22:05:29 +0200320}
321
Arnaldo Carvalho de Melo8c6f45a2013-12-19 14:38:03 -0300322static void record__init_features(struct record *rec)
David Ahern57706ab2013-11-06 11:41:34 -0700323{
David Ahern57706ab2013-11-06 11:41:34 -0700324 struct perf_session *session = rec->session;
325 int feat;
326
327 for (feat = HEADER_FIRST_FEATURE; feat < HEADER_LAST_FEATURE; feat++)
328 perf_header__set_feat(&session->header, feat);
329
330 if (rec->no_buildid)
331 perf_header__clear_feat(&session->header, HEADER_BUILD_ID);
332
Arnaldo Carvalho de Melo3e2be2d2014-01-03 15:03:26 -0300333 if (!have_tracepoints(&rec->evlist->entries))
David Ahern57706ab2013-11-06 11:41:34 -0700334 perf_header__clear_feat(&session->header, HEADER_TRACING_DATA);
335
336 if (!rec->opts.branch_stack)
337 perf_header__clear_feat(&session->header, HEADER_BRANCH_STACK);
338}
339
Arnaldo Carvalho de Melof33cbe72014-01-02 15:11:25 -0300340static volatile int workload_exec_errno;
341
342/*
343 * perf_evlist__prepare_workload will send a SIGUSR1
344 * if the fork fails, since we asked by setting its
345 * want_signal to true.
346 */
347static void workload_exec_failed_signal(int signo, siginfo_t *info,
348 void *ucontext __maybe_unused)
349{
350 workload_exec_errno = info->si_value.sival_int;
351 done = 1;
352 signr = signo;
353 child_finished = 1;
354}
355
Arnaldo Carvalho de Melo8c6f45a2013-12-19 14:38:03 -0300356static int __cmd_record(struct 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 Melob4006792013-12-19 14:43:45 -0300363 struct record_opts *opts = &rec->opts;
Jiri Olsaf5fc1412013-10-15 16:27:32 +0200364 struct perf_data_file *file = &rec->file;
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200365 struct perf_session *session;
Jiri Olsa27119262012-11-12 18:34:02 +0100366 bool disabled = false;
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200367
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200368 rec->progname = argv[0];
Andi Kleen33e49ea2011-09-15 14:31:40 -0700369
Arnaldo Carvalho de Melo8c6f45a2013-12-19 14:38:03 -0300370 on_exit(record__sig_exit, rec);
Peter Zijlstraf5970552009-06-18 23:22:55 +0200371 signal(SIGCHLD, sig_handler);
372 signal(SIGINT, sig_handler);
David Ahern804f7ac2013-05-06 12:24:23 -0600373 signal(SIGTERM, sig_handler);
Peter Zijlstraf5970552009-06-18 23:22:55 +0200374
Jiri Olsaf5fc1412013-10-15 16:27:32 +0200375 session = perf_session__new(file, false, NULL);
Arnaldo Carvalho de Melo94c744b2009-12-11 21:24:02 -0200376 if (session == NULL) {
Arnaldo Carvalho de Meloa9a70bb2009-11-17 01:18:11 -0200377 pr_err("Not enough memory for reading perf file header\n");
378 return -1;
379 }
380
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200381 rec->session = session;
382
Arnaldo Carvalho de Melo8c6f45a2013-12-19 14:38:03 -0300383 record__init_features(rec);
Stephane Eranian330aa672012-03-08 23:47:46 +0100384
Arnaldo Carvalho de Melod4db3f12009-12-27 21:36:57 -0200385 if (forks) {
Arnaldo Carvalho de Melo3e2be2d2014-01-03 15:03:26 -0300386 err = perf_evlist__prepare_workload(rec->evlist, &opts->target,
Jiri Olsaf5fc1412013-10-15 16:27:32 +0200387 argv, file->is_pipe,
Arnaldo Carvalho de Melo735f7e02014-01-03 14:56:49 -0300388 workload_exec_failed_signal);
Arnaldo Carvalho de Melo35b9d882011-11-09 08:47:15 -0200389 if (err < 0) {
390 pr_err("Couldn't run the workload!\n");
391 goto out_delete_session;
Jens Axboe0a5ac842009-08-12 11:18:01 +0200392 }
Peter Zijlstra856e9662009-12-16 17:55:55 +0100393 }
394
Arnaldo Carvalho de Melo8c6f45a2013-12-19 14:38:03 -0300395 if (record__open(rec) != 0) {
David Ahern8d3eca22012-08-26 12:24:47 -0600396 err = -1;
397 goto out_delete_session;
398 }
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200399
Arnaldo Carvalho de Melo3e2be2d2014-01-03 15:03:26 -0300400 if (!rec->evlist->nr_groups)
Namhyung Kima8bb5592013-01-22 18:09:31 +0900401 perf_header__clear_feat(&session->header, HEADER_GROUP_DESC);
402
Arnaldo Carvalho de Melo712a4b62011-02-17 12:18:42 -0200403 /*
Arnaldo Carvalho de Melo8c6f45a2013-12-19 14:38:03 -0300404 * perf_session__delete(session) will be called at record__exit()
Arnaldo Carvalho de Melo712a4b62011-02-17 12:18:42 -0200405 */
Arnaldo Carvalho de Melo8c6f45a2013-12-19 14:38:03 -0300406 on_exit(record__exit, rec);
Arnaldo Carvalho de Melo712a4b62011-02-17 12:18:42 -0200407
Jiri Olsaf5fc1412013-10-15 16:27:32 +0200408 if (file->is_pipe) {
409 err = perf_header__write_pipe(file->fd);
Tom Zanussi529870e2010-04-01 23:59:16 -0500410 if (err < 0)
David Ahern8d3eca22012-08-26 12:24:47 -0600411 goto out_delete_session;
Jiri Olsa563aecb2013-06-05 13:35:06 +0200412 } else {
Arnaldo Carvalho de Melo3e2be2d2014-01-03 15:03:26 -0300413 err = perf_session__write_header(session, rec->evlist,
Jiri Olsaf5fc1412013-10-15 16:27:32 +0200414 file->fd, false);
Arnaldo Carvalho de Melod5eed902009-11-19 14:55:56 -0200415 if (err < 0)
David Ahern8d3eca22012-08-26 12:24:47 -0600416 goto out_delete_session;
Arnaldo Carvalho de Melod5eed902009-11-19 14:55:56 -0200417 }
Peter Zijlstra7c6a1c62009-06-25 17:05:54 +0200418
David Ahernd3665492012-02-06 15:27:52 -0700419 if (!rec->no_buildid
Robert Richtere20960c2011-12-07 10:02:55 +0100420 && !perf_header__has_feat(&session->header, HEADER_BUILD_ID)) {
David Ahernd3665492012-02-06 15:27:52 -0700421 pr_err("Couldn't generate buildids. "
Robert Richtere20960c2011-12-07 10:02:55 +0100422 "Use --no-buildid to profile anyway.\n");
David Ahern8d3eca22012-08-26 12:24:47 -0600423 err = -1;
424 goto out_delete_session;
Robert Richtere20960c2011-12-07 10:02:55 +0100425 }
426
Arnaldo Carvalho de Melo34ba5122012-12-19 09:04:24 -0300427 machine = &session->machines.host;
Arnaldo Carvalho de Melo743eb862011-11-28 07:56:39 -0200428
Jiri Olsaf5fc1412013-10-15 16:27:32 +0200429 if (file->is_pipe) {
Arnaldo Carvalho de Melo45694aa2011-11-28 08:30:20 -0200430 err = perf_event__synthesize_attrs(tool, session,
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200431 process_synthesized_event);
Tom Zanussi2c46dbb2010-04-01 23:59:19 -0500432 if (err < 0) {
433 pr_err("Couldn't synthesize attrs.\n");
David Ahern8d3eca22012-08-26 12:24:47 -0600434 goto out_delete_session;
Tom Zanussi2c46dbb2010-04-01 23:59:19 -0500435 }
Tom Zanussicd19a032010-04-01 23:59:20 -0500436
Arnaldo Carvalho de Melo3e2be2d2014-01-03 15:03:26 -0300437 if (have_tracepoints(&rec->evlist->entries)) {
Tom Zanussi63e0c772010-05-03 00:14:48 -0500438 /*
439 * FIXME err <= 0 here actually means that
440 * there were no tracepoints so its not really
441 * an error, just that we don't need to
442 * synthesize anything. We really have to
443 * return this more properly and also
444 * propagate errors that now are calling die()
445 */
Arnaldo Carvalho de Melo3e2be2d2014-01-03 15:03:26 -0300446 err = perf_event__synthesize_tracing_data(tool, file->fd, rec->evlist,
Arnaldo Carvalho de Melo743eb862011-11-28 07:56:39 -0200447 process_synthesized_event);
Tom Zanussi63e0c772010-05-03 00:14:48 -0500448 if (err <= 0) {
449 pr_err("Couldn't record tracing data.\n");
David Ahern8d3eca22012-08-26 12:24:47 -0600450 goto out_delete_session;
Tom Zanussi63e0c772010-05-03 00:14:48 -0500451 }
David Ahernf34b9002013-11-06 11:41:35 -0700452 rec->bytes_written += err;
Tom Zanussi63e0c772010-05-03 00:14:48 -0500453 }
Tom Zanussi2c46dbb2010-04-01 23:59:19 -0500454 }
455
Arnaldo Carvalho de Melo45694aa2011-11-28 08:30:20 -0200456 err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
Adrian Hunter0ae617b2014-01-29 16:14:40 +0200457 machine);
Arnaldo Carvalho de Meloc1a3a4b2010-11-22 14:01:55 -0200458 if (err < 0)
459 pr_err("Couldn't record kernel reference relocation symbol\n"
460 "Symbol resolution may be skewed if relocation was used (e.g. kexec).\n"
461 "Check /proc/kallsyms permission or run as root.\n");
Arnaldo Carvalho de Melo56b03f32010-01-05 16:50:31 -0200462
Arnaldo Carvalho de Melo45694aa2011-11-28 08:30:20 -0200463 err = perf_event__synthesize_modules(tool, process_synthesized_event,
Arnaldo Carvalho de Melo743eb862011-11-28 07:56:39 -0200464 machine);
Arnaldo Carvalho de Meloc1a3a4b2010-11-22 14:01:55 -0200465 if (err < 0)
466 pr_err("Couldn't record kernel module information.\n"
467 "Symbol resolution may be skewed if relocation was used (e.g. kexec).\n"
468 "Check /proc/modules permission or run as root.\n");
469
Arnaldo Carvalho de Melo7e383de2012-12-18 15:49:27 -0300470 if (perf_guest) {
Arnaldo Carvalho de Melo876650e2012-12-18 19:15:48 -0300471 machines__process_guests(&session->machines,
472 perf_event__synthesize_guest_os, tool);
Arnaldo Carvalho de Melo7e383de2012-12-18 15:49:27 -0300473 }
Arnaldo Carvalho de Melob7cece72010-01-13 13:22:17 -0200474
Arnaldo Carvalho de Melo3e2be2d2014-01-03 15:03:26 -0300475 err = __machine__synthesize_threads(machine, tool, &opts->target, rec->evlist->threads,
Arnaldo Carvalho de Meloa33fbd52013-11-11 11:36:12 -0300476 process_synthesized_event, opts->sample_address);
David Ahern8d3eca22012-08-26 12:24:47 -0600477 if (err != 0)
478 goto out_delete_session;
479
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200480 if (rec->realtime_prio) {
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200481 struct sched_param param;
482
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200483 param.sched_priority = rec->realtime_prio;
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200484 if (sched_setscheduler(0, SCHED_FIFO, &param)) {
Arnaldo Carvalho de Melo6beba7a2009-10-21 17:34:06 -0200485 pr_err("Could not set realtime priority.\n");
David Ahern8d3eca22012-08-26 12:24:47 -0600486 err = -1;
487 goto out_delete_session;
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200488 }
489 }
490
Jiri Olsa774cb492012-11-12 18:34:01 +0100491 /*
492 * When perf is starting the traced process, all the events
493 * (apart from group members) have enable_on_exec=1 set,
494 * so don't spoil it by prematurely enabling them.
495 */
Andi Kleen6619a532014-01-11 13:38:27 -0800496 if (!target__none(&opts->target) && !opts->initial_delay)
Arnaldo Carvalho de Melo3e2be2d2014-01-03 15:03:26 -0300497 perf_evlist__enable(rec->evlist);
David Ahern764e16a32011-08-25 10:17:55 -0600498
Peter Zijlstra856e9662009-12-16 17:55:55 +0100499 /*
500 * Let the child rip
501 */
Arnaldo Carvalho de Melo735f7e02014-01-03 14:56:49 -0300502 if (forks)
Arnaldo Carvalho de Melo3e2be2d2014-01-03 15:03:26 -0300503 perf_evlist__start_workload(rec->evlist);
Peter Zijlstra856e9662009-12-16 17:55:55 +0100504
Andi Kleen6619a532014-01-11 13:38:27 -0800505 if (opts->initial_delay) {
506 usleep(opts->initial_delay * 1000);
507 perf_evlist__enable(rec->evlist);
508 }
509
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
Arnaldo Carvalho de Melo8c6f45a2013-12-19 14:38:03 -0300513 if (record__mmap_read_all(rec) < 0) {
David Ahern8d3eca22012-08-26 12:24:47 -0600514 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 Melo3e2be2d2014-01-03 15:03:26 -0300521 err = poll(rec->evlist->pollfd, rec->evlist->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 Melo3e2be2d2014-01-03 15:03:26 -0300531 perf_evlist__disable(rec->evlist);
Jiri Olsa27119262012-11-12 18:34:02 +0100532 disabled = true;
533 }
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200534 }
535
Arnaldo Carvalho de Melof33cbe72014-01-02 15:11:25 -0300536 if (forks && workload_exec_errno) {
537 char msg[512];
538 const char *emsg = strerror_r(workload_exec_errno, msg, sizeof(msg));
539 pr_err("Workload failed: %s\n", emsg);
540 err = -1;
541 goto out_delete_session;
542 }
543
Arnaldo Carvalho de Melo18483b82010-12-06 15:13:38 -0200544 if (quiet || signr == SIGUSR1)
Arnaldo Carvalho de Melob44308f2010-10-26 15:20:09 -0200545 return 0;
546
Peter Zijlstra8b412662009-09-17 19:59:05 +0200547 fprintf(stderr, "[ perf record: Woken up %ld times to write data ]\n", waking);
548
Ingo Molnar021e9f42009-06-03 19:27:19 +0200549 /*
550 * Approximate RIP event size: 24 bytes.
551 */
552 fprintf(stderr,
Arnaldo Carvalho de Melo9486aa32011-01-22 20:37:02 -0200553 "[ perf record: Captured and wrote %.3f MB %s (~%" PRIu64 " samples) ]\n",
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200554 (double)rec->bytes_written / 1024.0 / 1024.0,
Jiri Olsa6a4d98d2013-10-15 16:27:33 +0200555 file->path,
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200556 rec->bytes_written / 24);
Ingo Molnaraddc2782009-06-02 23:43:11 +0200557
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200558 return 0;
Arnaldo Carvalho de Melo39d17da2010-07-29 14:08:55 -0300559
560out_delete_session:
561 perf_session__delete(session);
562 return err;
Peter Zijlstrade9ac072009-04-08 15:01:31 +0200563}
Ingo Molnar0e9b20b2009-05-26 09:17:18 +0200564
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100565#define BRANCH_OPT(n, m) \
566 { .name = n, .mode = (m) }
567
568#define BRANCH_END { .name = NULL }
569
570struct branch_mode {
571 const char *name;
572 int mode;
573};
574
575static const struct branch_mode branch_modes[] = {
576 BRANCH_OPT("u", PERF_SAMPLE_BRANCH_USER),
577 BRANCH_OPT("k", PERF_SAMPLE_BRANCH_KERNEL),
578 BRANCH_OPT("hv", PERF_SAMPLE_BRANCH_HV),
579 BRANCH_OPT("any", PERF_SAMPLE_BRANCH_ANY),
580 BRANCH_OPT("any_call", PERF_SAMPLE_BRANCH_ANY_CALL),
581 BRANCH_OPT("any_ret", PERF_SAMPLE_BRANCH_ANY_RETURN),
582 BRANCH_OPT("ind_call", PERF_SAMPLE_BRANCH_IND_CALL),
Andi Kleen0126d492013-09-20 07:40:42 -0700583 BRANCH_OPT("abort_tx", PERF_SAMPLE_BRANCH_ABORT_TX),
584 BRANCH_OPT("in_tx", PERF_SAMPLE_BRANCH_IN_TX),
585 BRANCH_OPT("no_tx", PERF_SAMPLE_BRANCH_NO_TX),
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100586 BRANCH_END
587};
588
589static int
Stephane Eraniana5aabda2012-03-08 23:47:45 +0100590parse_branch_stack(const struct option *opt, const char *str, int unset)
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100591{
592#define ONLY_PLM \
593 (PERF_SAMPLE_BRANCH_USER |\
594 PERF_SAMPLE_BRANCH_KERNEL |\
595 PERF_SAMPLE_BRANCH_HV)
596
597 uint64_t *mode = (uint64_t *)opt->value;
598 const struct branch_mode *br;
Stephane Eraniana5aabda2012-03-08 23:47:45 +0100599 char *s, *os = NULL, *p;
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100600 int ret = -1;
601
Stephane Eraniana5aabda2012-03-08 23:47:45 +0100602 if (unset)
603 return 0;
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100604
Stephane Eraniana5aabda2012-03-08 23:47:45 +0100605 /*
606 * cannot set it twice, -b + --branch-filter for instance
607 */
608 if (*mode)
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100609 return -1;
610
Stephane Eraniana5aabda2012-03-08 23:47:45 +0100611 /* str may be NULL in case no arg is passed to -b */
612 if (str) {
613 /* because str is read-only */
614 s = os = strdup(str);
615 if (!s)
616 return -1;
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100617
Stephane Eraniana5aabda2012-03-08 23:47:45 +0100618 for (;;) {
619 p = strchr(s, ',');
620 if (p)
621 *p = '\0';
622
623 for (br = branch_modes; br->name; br++) {
624 if (!strcasecmp(s, br->name))
625 break;
626 }
627 if (!br->name) {
628 ui__warning("unknown branch filter %s,"
629 " check man page\n", s);
630 goto error;
631 }
632
633 *mode |= br->mode;
634
635 if (!p)
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100636 break;
Stephane Eraniana5aabda2012-03-08 23:47:45 +0100637
638 s = p + 1;
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100639 }
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100640 }
641 ret = 0;
642
Stephane Eraniana5aabda2012-03-08 23:47:45 +0100643 /* default to any branch */
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100644 if ((*mode & ~ONLY_PLM) == 0) {
Stephane Eraniana5aabda2012-03-08 23:47:45 +0100645 *mode = PERF_SAMPLE_BRANCH_ANY;
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100646 }
647error:
648 free(os);
649 return ret;
650}
651
Jiri Olsa9ff125d2014-01-07 13:47:28 +0100652#ifdef HAVE_DWARF_UNWIND_SUPPORT
Jiri Olsa26d33022012-08-07 15:20:47 +0200653static int get_stack_size(char *str, unsigned long *_size)
654{
655 char *endptr;
656 unsigned long size;
657 unsigned long max_size = round_down(USHRT_MAX, sizeof(u64));
658
659 size = strtoul(str, &endptr, 0);
660
661 do {
662 if (*endptr)
663 break;
664
665 size = round_up(size, sizeof(u64));
666 if (!size || size > max_size)
667 break;
668
669 *_size = size;
670 return 0;
671
672 } while (0);
673
674 pr_err("callchain: Incorrect stack dump size (max %ld): %s\n",
675 max_size, str);
676 return -1;
677}
Jiri Olsa9ff125d2014-01-07 13:47:28 +0100678#endif /* HAVE_DWARF_UNWIND_SUPPORT */
Jiri Olsa26d33022012-08-07 15:20:47 +0200679
Arnaldo Carvalho de Melob4006792013-12-19 14:43:45 -0300680int record_parse_callchain(const char *arg, struct record_opts *opts)
Jiri Olsa26d33022012-08-07 15:20:47 +0200681{
Jiri Olsa26d33022012-08-07 15:20:47 +0200682 char *tok, *name, *saveptr = NULL;
683 char *buf;
684 int ret = -1;
685
Jiri Olsa26d33022012-08-07 15:20:47 +0200686 /* We need buffer that we know we can write to. */
687 buf = malloc(strlen(arg) + 1);
688 if (!buf)
689 return -ENOMEM;
690
691 strcpy(buf, arg);
692
693 tok = strtok_r((char *)buf, ",", &saveptr);
694 name = tok ? : (char *)buf;
695
696 do {
697 /* Framepointer style */
698 if (!strncmp(name, "fp", sizeof("fp"))) {
699 if (!strtok_r(NULL, ",", &saveptr)) {
Arnaldo Carvalho de Meloc5ff78c2012-12-11 16:16:47 -0300700 opts->call_graph = CALLCHAIN_FP;
Jiri Olsa26d33022012-08-07 15:20:47 +0200701 ret = 0;
702 } else
703 pr_err("callchain: No more arguments "
704 "needed for -g fp\n");
705 break;
706
Jiri Olsa9ff125d2014-01-07 13:47:28 +0100707#ifdef HAVE_DWARF_UNWIND_SUPPORT
Jiri Olsa26d33022012-08-07 15:20:47 +0200708 /* Dwarf style */
709 } else if (!strncmp(name, "dwarf", sizeof("dwarf"))) {
Arnaldo Carvalho de Melo61eaa3b2012-10-01 15:20:58 -0300710 const unsigned long default_stack_dump_size = 8192;
711
Jiri Olsa26d33022012-08-07 15:20:47 +0200712 ret = 0;
Arnaldo Carvalho de Meloc5ff78c2012-12-11 16:16:47 -0300713 opts->call_graph = CALLCHAIN_DWARF;
714 opts->stack_dump_size = default_stack_dump_size;
Jiri Olsa26d33022012-08-07 15:20:47 +0200715
716 tok = strtok_r(NULL, ",", &saveptr);
717 if (tok) {
718 unsigned long size = 0;
719
720 ret = get_stack_size(tok, &size);
Arnaldo Carvalho de Meloc5ff78c2012-12-11 16:16:47 -0300721 opts->stack_dump_size = size;
Jiri Olsa26d33022012-08-07 15:20:47 +0200722 }
Jiri Olsa9ff125d2014-01-07 13:47:28 +0100723#endif /* HAVE_DWARF_UNWIND_SUPPORT */
Jiri Olsa26d33022012-08-07 15:20:47 +0200724 } else {
Jiri Olsa09b0fd42013-10-26 16:25:33 +0200725 pr_err("callchain: Unknown --call-graph option "
Jiri Olsa26d33022012-08-07 15:20:47 +0200726 "value: %s\n", arg);
727 break;
728 }
729
730 } while (0);
731
732 free(buf);
Jiri Olsa09b0fd42013-10-26 16:25:33 +0200733 return ret;
734}
Jiri Olsa26d33022012-08-07 15:20:47 +0200735
Arnaldo Carvalho de Melob4006792013-12-19 14:43:45 -0300736static void callchain_debug(struct record_opts *opts)
Jiri Olsa09b0fd42013-10-26 16:25:33 +0200737{
Jiri Olsaa601fdf2014-02-03 12:44:43 +0100738 static const char *str[CALLCHAIN_MAX] = { "NONE", "FP", "DWARF" };
739
740 pr_debug("callchain: type %s\n", str[opts->call_graph]);
Jiri Olsa09b0fd42013-10-26 16:25:33 +0200741
742 if (opts->call_graph == CALLCHAIN_DWARF)
743 pr_debug("callchain: stack dump size %d\n",
744 opts->stack_dump_size);
745}
746
747int record_parse_callchain_opt(const struct option *opt,
748 const char *arg,
749 int unset)
750{
Arnaldo Carvalho de Melob4006792013-12-19 14:43:45 -0300751 struct record_opts *opts = opt->value;
Jiri Olsa09b0fd42013-10-26 16:25:33 +0200752 int ret;
753
Jiri Olsaeb853e82014-02-03 12:44:42 +0100754 opts->call_graph_enabled = !unset;
755
Jiri Olsa09b0fd42013-10-26 16:25:33 +0200756 /* --no-call-graph */
757 if (unset) {
758 opts->call_graph = CALLCHAIN_NONE;
759 pr_debug("callchain: disabled\n");
760 return 0;
761 }
762
763 ret = record_parse_callchain(arg, opts);
Jiri Olsa26d33022012-08-07 15:20:47 +0200764 if (!ret)
Jiri Olsa09b0fd42013-10-26 16:25:33 +0200765 callchain_debug(opts);
Jiri Olsa26d33022012-08-07 15:20:47 +0200766
767 return ret;
768}
769
Jiri Olsa09b0fd42013-10-26 16:25:33 +0200770int record_callchain_opt(const struct option *opt,
771 const char *arg __maybe_unused,
772 int unset __maybe_unused)
773{
Arnaldo Carvalho de Melob4006792013-12-19 14:43:45 -0300774 struct record_opts *opts = opt->value;
Jiri Olsa09b0fd42013-10-26 16:25:33 +0200775
Jiri Olsaeb853e82014-02-03 12:44:42 +0100776 opts->call_graph_enabled = !unset;
777
Jiri Olsa09b0fd42013-10-26 16:25:33 +0200778 if (opts->call_graph == CALLCHAIN_NONE)
779 opts->call_graph = CALLCHAIN_FP;
780
781 callchain_debug(opts);
782 return 0;
783}
784
Jiri Olsaeb853e82014-02-03 12:44:42 +0100785static int perf_record_config(const char *var, const char *value, void *cb)
786{
787 struct record *rec = cb;
788
789 if (!strcmp(var, "record.call-graph"))
790 return record_parse_callchain(value, &rec->opts);
791
792 return perf_default_config(var, value, cb);
793}
794
Ingo Molnar0e9b20b2009-05-26 09:17:18 +0200795static const char * const record_usage[] = {
Mike Galbraith9e0967532009-05-28 16:25:34 +0200796 "perf record [<options>] [<command>]",
797 "perf record [<options>] -- <command> [<options>]",
Ingo Molnar0e9b20b2009-05-26 09:17:18 +0200798 NULL
799};
800
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200801/*
Arnaldo Carvalho de Melo8c6f45a2013-12-19 14:38:03 -0300802 * XXX Ideally would be local to cmd_record() and passed to a record__new
803 * because we need to have access to it in record__exit, that is called
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200804 * after cmd_record() exits, but since record_options need to be accessible to
805 * builtin-script, leave it here.
806 *
807 * At least we don't ouch it in all the other functions here directly.
808 *
809 * Just say no to tons of global variables, sigh.
810 */
Arnaldo Carvalho de Melo8c6f45a2013-12-19 14:38:03 -0300811static struct record record = {
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200812 .opts = {
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200813 .mmap_pages = UINT_MAX,
814 .user_freq = UINT_MAX,
815 .user_interval = ULLONG_MAX,
Arnaldo Carvalho de Melo447a6012012-05-22 13:14:18 -0300816 .freq = 4000,
Namhyung Kimd1cb9fc2012-05-16 18:45:49 +0900817 .target = {
818 .uses_mmap = true,
Adrian Hunter3aa59392013-11-15 15:52:29 +0200819 .default_per_cpu = true,
Namhyung Kimd1cb9fc2012-05-16 18:45:49 +0900820 },
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200821 },
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200822};
Frederic Weisbecker7865e812010-04-14 19:42:07 +0200823
Jiri Olsa09b0fd42013-10-26 16:25:33 +0200824#define CALLCHAIN_HELP "setup and enables call-graph (stack chain/backtrace) recording: "
Arnaldo Carvalho de Melo61eaa3b2012-10-01 15:20:58 -0300825
Jiri Olsa9ff125d2014-01-07 13:47:28 +0100826#ifdef HAVE_DWARF_UNWIND_SUPPORT
Jiri Olsa09b0fd42013-10-26 16:25:33 +0200827const char record_callchain_help[] = CALLCHAIN_HELP "fp dwarf";
Arnaldo Carvalho de Melo61eaa3b2012-10-01 15:20:58 -0300828#else
Jiri Olsa09b0fd42013-10-26 16:25:33 +0200829const char record_callchain_help[] = CALLCHAIN_HELP "fp";
Arnaldo Carvalho de Melo61eaa3b2012-10-01 15:20:58 -0300830#endif
831
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200832/*
833 * XXX Will stay a global variable till we fix builtin-script.c to stop messing
834 * with it and switch to use the library functions in perf_evlist that came
Arnaldo Carvalho de Melob4006792013-12-19 14:43:45 -0300835 * from builtin-record.c, i.e. use record_opts,
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200836 * perf_evlist__prepare_workload, etc instead of fork+exec'in 'perf record',
837 * using pipes, etc.
838 */
Tom Zanussibca647a2010-11-10 08:11:30 -0600839const struct option record_options[] = {
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200840 OPT_CALLBACK('e', "event", &record.evlist, "event",
Thomas Gleixner86847b62009-06-06 12:24:17 +0200841 "event selector. use 'perf list' to list available events",
Jiri Olsaf120f9d2011-07-14 11:25:32 +0200842 parse_events_option),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200843 OPT_CALLBACK(0, "filter", &record.evlist, "filter",
Li Zefanc171b552009-10-15 11:22:07 +0800844 "event filter", parse_filter),
Namhyung Kimbea03402012-04-26 14:15:15 +0900845 OPT_STRING('p', "pid", &record.opts.target.pid, "pid",
Zhang, Yanmind6d901c2010-03-18 11:36:05 -0300846 "record events on existing process id"),
Namhyung Kimbea03402012-04-26 14:15:15 +0900847 OPT_STRING('t', "tid", &record.opts.target.tid, "tid",
Zhang, Yanmind6d901c2010-03-18 11:36:05 -0300848 "record events on existing thread id"),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200849 OPT_INTEGER('r', "realtime", &record.realtime_prio,
Ingo Molnar0e9b20b2009-05-26 09:17:18 +0200850 "collect data with this RT SCHED_FIFO priority"),
Arnaldo Carvalho de Melo509051e2014-01-14 17:52:14 -0300851 OPT_BOOLEAN(0, "no-buffering", &record.opts.no_buffering,
Kirill Smelkovacac03f2011-01-12 17:59:36 +0300852 "collect data without buffering"),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200853 OPT_BOOLEAN('R', "raw-samples", &record.opts.raw_samples,
Frederic Weisbeckerdaac07b2009-08-13 10:27:19 +0200854 "collect raw sample records from all opened counters"),
Namhyung Kimbea03402012-04-26 14:15:15 +0900855 OPT_BOOLEAN('a', "all-cpus", &record.opts.target.system_wide,
Ingo Molnar0e9b20b2009-05-26 09:17:18 +0200856 "system-wide collection from all CPUs"),
Namhyung Kimbea03402012-04-26 14:15:15 +0900857 OPT_STRING('C', "cpu", &record.opts.target.cpu_list, "cpu",
Stephane Eranianc45c6ea2010-05-28 12:00:01 +0200858 "list of cpus to monitor"),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200859 OPT_U64('c', "count", &record.opts.user_interval, "event period to sample"),
Jiri Olsaf5fc1412013-10-15 16:27:32 +0200860 OPT_STRING('o', "output", &record.file.path, "file",
Ingo Molnarabaff322009-06-02 22:59:57 +0200861 "output file name"),
Adrian Hunter69e7e5b2013-11-18 11:55:57 +0200862 OPT_BOOLEAN_SET('i', "no-inherit", &record.opts.no_inherit,
863 &record.opts.no_inherit_set,
864 "child tasks do not inherit counters"),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200865 OPT_UINTEGER('F', "freq", &record.opts.user_freq, "profile at this frequency"),
Jiri Olsa994a1f72013-09-01 12:36:12 +0200866 OPT_CALLBACK('m', "mmap-pages", &record.opts.mmap_pages, "pages",
867 "number of mmap data pages",
868 perf_evlist__parse_mmap_pages),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200869 OPT_BOOLEAN(0, "group", &record.opts.group,
Lin Ming43bece72011-08-17 18:42:07 +0800870 "put the counters into a counter group"),
Jiri Olsa09b0fd42013-10-26 16:25:33 +0200871 OPT_CALLBACK_NOOPT('g', NULL, &record.opts,
872 NULL, "enables call-graph recording" ,
873 &record_callchain_opt),
874 OPT_CALLBACK(0, "call-graph", &record.opts,
875 "mode[,dump_size]", record_callchain_help,
876 &record_parse_callchain_opt),
Ian Munsiec0555642010-04-13 18:37:33 +1000877 OPT_INCR('v', "verbose", &verbose,
Ingo Molnar3da297a2009-06-07 17:39:02 +0200878 "be more verbose (show counter open errors, etc)"),
Arnaldo Carvalho de Melob44308f2010-10-26 15:20:09 -0200879 OPT_BOOLEAN('q', "quiet", &quiet, "don't print any message"),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200880 OPT_BOOLEAN('s', "stat", &record.opts.inherit_stat,
Peter Zijlstra649c48a2009-06-24 21:12:48 +0200881 "per thread counts"),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200882 OPT_BOOLEAN('d', "data", &record.opts.sample_address,
Anton Blanchard4bba8282009-07-16 15:44:29 +0200883 "Sample addresses"),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200884 OPT_BOOLEAN('T', "timestamp", &record.opts.sample_time, "Sample timestamps"),
Andrew Vagin3e76ac72011-12-20 17:32:45 +0300885 OPT_BOOLEAN('P', "period", &record.opts.period, "Sample period"),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200886 OPT_BOOLEAN('n', "no-samples", &record.opts.no_samples,
Peter Zijlstra649c48a2009-06-24 21:12:48 +0200887 "don't sample"),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200888 OPT_BOOLEAN('N', "no-buildid-cache", &record.no_buildid_cache,
Stephane Eraniana1ac1d32010-06-17 11:39:01 +0200889 "do not update the buildid cache"),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200890 OPT_BOOLEAN('B', "no-buildid", &record.no_buildid,
Arnaldo Carvalho de Melobaa2f6c2010-11-26 19:39:15 -0200891 "do not collect buildids in perf.data"),
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200892 OPT_CALLBACK('G', "cgroup", &record.evlist, "name",
Stephane Eranian023695d2011-02-14 11:20:01 +0200893 "monitor event in cgroup name only",
894 parse_cgroups),
Arnaldo Carvalho de Meloa6205a32014-01-14 17:58:12 -0300895 OPT_UINTEGER('D', "delay", &record.opts.initial_delay,
Andi Kleen6619a532014-01-11 13:38:27 -0800896 "ms to wait before starting measurement after program start"),
Namhyung Kimbea03402012-04-26 14:15:15 +0900897 OPT_STRING('u', "uid", &record.opts.target.uid_str, "user",
898 "user to profile"),
Stephane Eraniana5aabda2012-03-08 23:47:45 +0100899
900 OPT_CALLBACK_NOOPT('b', "branch-any", &record.opts.branch_stack,
901 "branch any", "sample any taken branches",
902 parse_branch_stack),
903
904 OPT_CALLBACK('j', "branch-filter", &record.opts.branch_stack,
905 "branch filter mask", "branch stack filter modes",
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100906 parse_branch_stack),
Andi Kleen05484292013-01-24 16:10:29 +0100907 OPT_BOOLEAN('W', "weight", &record.opts.sample_weight,
908 "sample by weight (on special events only)"),
Andi Kleen475eeab2013-09-20 07:40:43 -0700909 OPT_BOOLEAN(0, "transaction", &record.opts.sample_transaction,
910 "sample transaction flags (special events only)"),
Adrian Hunter3aa59392013-11-15 15:52:29 +0200911 OPT_BOOLEAN(0, "per-thread", &record.opts.target.per_thread,
912 "use per-thread mmaps"),
Ingo Molnar0e9b20b2009-05-26 09:17:18 +0200913 OPT_END()
914};
915
Irina Tirdea1d037ca2012-09-11 01:15:03 +0300916int cmd_record(int argc, const char **argv, const char *prefix __maybe_unused)
Ingo Molnar0e9b20b2009-05-26 09:17:18 +0200917{
Arnaldo Carvalho de Melo69aad6f2011-01-03 16:39:04 -0200918 int err = -ENOMEM;
Arnaldo Carvalho de Melo8c6f45a2013-12-19 14:38:03 -0300919 struct record *rec = &record;
Namhyung Kim16ad2ff2012-05-07 14:09:02 +0900920 char errbuf[BUFSIZ];
Ingo Molnar0e9b20b2009-05-26 09:17:18 +0200921
Arnaldo Carvalho de Melo3e2be2d2014-01-03 15:03:26 -0300922 rec->evlist = perf_evlist__new();
923 if (rec->evlist == NULL)
Arnaldo Carvalho de Melo361c99a2011-01-11 20:56:53 -0200924 return -ENOMEM;
925
Jiri Olsaeb853e82014-02-03 12:44:42 +0100926 perf_config(perf_record_config, rec);
927
Tom Zanussibca647a2010-11-10 08:11:30 -0600928 argc = parse_options(argc, argv, record_options, record_usage,
Arnaldo Carvalho de Melo655000e2009-12-15 20:04:40 -0200929 PARSE_OPT_STOP_AT_NON_OPTION);
Arnaldo Carvalho de Melo602ad872013-11-12 16:46:16 -0300930 if (!argc && target__none(&rec->opts.target))
Tom Zanussibca647a2010-11-10 08:11:30 -0600931 usage_with_options(record_usage, record_options);
Ingo Molnar0e9b20b2009-05-26 09:17:18 +0200932
Namhyung Kimbea03402012-04-26 14:15:15 +0900933 if (nr_cgroups && !rec->opts.target.system_wide) {
Namhyung Kim3780f482012-05-29 13:22:57 +0900934 ui__error("cgroup monitoring only available in"
935 " system-wide mode\n");
Stephane Eranian023695d2011-02-14 11:20:01 +0200936 usage_with_options(record_usage, record_options);
937 }
938
Arnaldo Carvalho de Melo655000e2009-12-15 20:04:40 -0200939 symbol__init();
Arnaldo Carvalho de Melobaa2f6c2010-11-26 19:39:15 -0200940
Arnaldo Carvalho de Meloec80fde2011-05-26 09:53:51 -0300941 if (symbol_conf.kptr_restrict)
Arnaldo Carvalho de Melo646aaea2011-05-27 11:00:41 -0300942 pr_warning(
943"WARNING: Kernel address maps (/proc/{kallsyms,modules}) are restricted,\n"
944"check /proc/sys/kernel/kptr_restrict.\n\n"
945"Samples in kernel functions may not be resolved if a suitable vmlinux\n"
946"file is not found in the buildid cache or in the vmlinux path.\n\n"
947"Samples in kernel modules won't be resolved at all.\n\n"
948"If some relocation was applied (e.g. kexec) symbols may be misresolved\n"
949"even with a suitable vmlinux or kallsyms file.\n\n");
Arnaldo Carvalho de Meloec80fde2011-05-26 09:53:51 -0300950
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200951 if (rec->no_buildid_cache || rec->no_buildid)
Stephane Eraniana1ac1d32010-06-17 11:39:01 +0200952 disable_buildid_cache();
Arnaldo Carvalho de Melo655000e2009-12-15 20:04:40 -0200953
Arnaldo Carvalho de Melo3e2be2d2014-01-03 15:03:26 -0300954 if (rec->evlist->nr_entries == 0 &&
955 perf_evlist__add_default(rec->evlist) < 0) {
Arnaldo Carvalho de Melo69aad6f2011-01-03 16:39:04 -0200956 pr_err("Not enough memory for event selector list\n");
957 goto out_symbol_exit;
Peter Zijlstrabbd36e52009-06-11 23:11:50 +0200958 }
Ingo Molnar0e9b20b2009-05-26 09:17:18 +0200959
Adrian Hunter69e7e5b2013-11-18 11:55:57 +0200960 if (rec->opts.target.tid && !rec->opts.no_inherit_set)
961 rec->opts.no_inherit = true;
962
Arnaldo Carvalho de Melo602ad872013-11-12 16:46:16 -0300963 err = target__validate(&rec->opts.target);
Namhyung Kim16ad2ff2012-05-07 14:09:02 +0900964 if (err) {
Arnaldo Carvalho de Melo602ad872013-11-12 16:46:16 -0300965 target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
Namhyung Kim16ad2ff2012-05-07 14:09:02 +0900966 ui__warning("%s", errbuf);
967 }
Namhyung Kim4bd0f2d2012-04-26 14:15:18 +0900968
Arnaldo Carvalho de Melo602ad872013-11-12 16:46:16 -0300969 err = target__parse_uid(&rec->opts.target);
Namhyung Kim16ad2ff2012-05-07 14:09:02 +0900970 if (err) {
971 int saved_errno = errno;
972
Arnaldo Carvalho de Melo602ad872013-11-12 16:46:16 -0300973 target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
Namhyung Kim3780f482012-05-29 13:22:57 +0900974 ui__error("%s", errbuf);
Namhyung Kim16ad2ff2012-05-07 14:09:02 +0900975
976 err = -saved_errno;
Namhyung Kim8fa60e12013-03-15 14:48:51 +0900977 goto out_symbol_exit;
Namhyung Kim16ad2ff2012-05-07 14:09:02 +0900978 }
Arnaldo Carvalho de Melo0d37aa32012-01-19 14:08:15 -0200979
Namhyung Kim16ad2ff2012-05-07 14:09:02 +0900980 err = -ENOMEM;
Arnaldo Carvalho de Melo3e2be2d2014-01-03 15:03:26 -0300981 if (perf_evlist__create_maps(rec->evlist, &rec->opts.target) < 0)
Arnaldo Carvalho de Melodd7927f2011-01-12 14:28:51 -0200982 usage_with_options(record_usage, record_options);
Arnaldo Carvalho de Melo69aad6f2011-01-03 16:39:04 -0200983
Arnaldo Carvalho de Melob4006792013-12-19 14:43:45 -0300984 if (record_opts__config(&rec->opts)) {
Arnaldo Carvalho de Melo39d17da2010-07-29 14:08:55 -0300985 err = -EINVAL;
Arnaldo Carvalho de Melo03ad9742014-01-03 15:56:06 -0300986 goto out_symbol_exit;
Mike Galbraith7e4ff9e2009-10-12 07:56:03 +0200987 }
988
Arnaldo Carvalho de Melod20deb62011-11-25 08:19:45 -0200989 err = __cmd_record(&record, argc, argv);
Arnaldo Carvalho de Melod65a4582010-07-30 18:31:28 -0300990out_symbol_exit:
991 symbol__exit();
Arnaldo Carvalho de Melo39d17da2010-07-29 14:08:55 -0300992 return err;
Ingo Molnar0e9b20b2009-05-26 09:17:18 +0200993}