perf record: Implement control commands handling
[linux-2.6-block.git] / tools / perf / builtin-record.c
CommitLineData
b2441318 1// SPDX-License-Identifier: GPL-2.0
abaff32a 2/*
bf9e1876
IM
3 * builtin-record.c
4 *
5 * Builtin record command: Record the profile of a workload
6 * (or a CPU, or a PID) into the perf.data output file - for
7 * later analysis via perf report.
abaff32a 8 */
16f762a2 9#include "builtin.h"
bf9e1876 10
6122e4e4 11#include "util/build-id.h"
4b6ab94e 12#include <subcmd/parse-options.h>
8ad8db37 13#include "util/parse-events.h"
41840d21 14#include "util/config.h"
6eda5838 15
8f651eae 16#include "util/callchain.h"
f14d5707 17#include "util/cgroup.h"
7c6a1c65 18#include "util/header.h"
66e274f3 19#include "util/event.h"
361c99a6 20#include "util/evlist.h"
69aad6f1 21#include "util/evsel.h"
8f28827a 22#include "util/debug.h"
e0fcfb08 23#include "util/mmap.h"
aeb00b1a 24#include "util/target.h"
94c744b6 25#include "util/session.h"
45694aa7 26#include "util/tool.h"
8d06367f 27#include "util/symbol.h"
aeb00b1a 28#include "util/record.h"
a12b51c4 29#include "util/cpumap.h"
fd78260b 30#include "util/thread_map.h"
f5fc1412 31#include "util/data.h"
bcc84ec6 32#include "util/perf_regs.h"
ef149c25 33#include "util/auxtrace.h"
46bc29b9 34#include "util/tsc.h"
f00898f4 35#include "util/parse-branch-options.h"
bcc84ec6 36#include "util/parse-regs-options.h"
40c7d246 37#include "util/perf_api_probe.h"
71dc2326 38#include "util/llvm-utils.h"
8690a2a7 39#include "util/bpf-loader.h"
5f9cf599 40#include "util/trigger.h"
a074865e 41#include "util/perf-hooks.h"
f13de660 42#include "util/cpu-set-sched.h"
ea49e01c 43#include "util/synthetic-events.h"
c5e4027e 44#include "util/time-utils.h"
58db1d6e 45#include "util/units.h"
7b612e29 46#include "util/bpf-event.h"
d99c22ea 47#include "util/util.h"
70943490 48#include "util/pfm.h"
d8871ea7 49#include "asm/bug.h"
c1a604df 50#include "perf.h"
7c6a1c65 51
a43783ae 52#include <errno.h>
fd20e811 53#include <inttypes.h>
67230479 54#include <locale.h>
4208735d 55#include <poll.h>
d99c22ea 56#include <pthread.h>
97124d5e 57#include <unistd.h>
de9ac07b 58#include <sched.h>
9607ad3a 59#include <signal.h>
da231338
AM
60#ifdef HAVE_EVENTFD_SUPPORT
61#include <sys/eventfd.h>
62#endif
a41794cd 63#include <sys/mman.h>
4208735d 64#include <sys/wait.h>
eeb399b5
AH
65#include <sys/types.h>
66#include <sys/stat.h>
67#include <fcntl.h>
6ef81c55 68#include <linux/err.h>
8520a98d 69#include <linux/string.h>
0693e680 70#include <linux/time64.h>
d8f9da24 71#include <linux/zalloc.h>
8384a260 72#include <linux/bitmap.h>
78da39fa 73
1b43b704 74struct switch_output {
dc0c6127 75 bool enabled;
1b43b704 76 bool signal;
dc0c6127 77 unsigned long size;
bfacbe3b 78 unsigned long time;
cb4e1ebb
JO
79 const char *str;
80 bool set;
03724b2e
AK
81 char **filenames;
82 int num_files;
83 int cur_file;
1b43b704
JO
84};
85
8c6f45a7 86struct record {
45694aa7 87 struct perf_tool tool;
b4006796 88 struct record_opts opts;
d20deb64 89 u64 bytes_written;
8ceb41d7 90 struct perf_data data;
ef149c25 91 struct auxtrace_record *itr;
63503dba 92 struct evlist *evlist;
d20deb64 93 struct perf_session *session;
bc477d79 94 struct evlist *sb_evlist;
899e5ffb 95 pthread_t thread_id;
d20deb64 96 int realtime_prio;
899e5ffb 97 bool switch_output_event_set;
d20deb64 98 bool no_buildid;
d2db9a98 99 bool no_buildid_set;
d20deb64 100 bool no_buildid_cache;
d2db9a98 101 bool no_buildid_cache_set;
6156681b 102 bool buildid_all;
ecfd7a9c 103 bool timestamp_filename;
68588baf 104 bool timestamp_boundary;
1b43b704 105 struct switch_output switch_output;
9f065194 106 unsigned long long samples;
8384a260 107 struct mmap_cpu_mask affinity_mask;
6d575816 108 unsigned long output_max_size; /* = 0: unlimited */
0f82ebc4 109};
a21ca2ca 110
6d575816
JS
111static volatile int done;
112
dc0c6127
JO
113static volatile int auxtrace_record__snapshot_started;
114static DEFINE_TRIGGER(auxtrace_snapshot_trigger);
115static DEFINE_TRIGGER(switch_output_trigger);
116
9d2ed645
AB
117static const char *affinity_tags[PERF_AFFINITY_MAX] = {
118 "SYS", "NODE", "CPU"
119};
120
dc0c6127
JO
121static bool switch_output_signal(struct record *rec)
122{
123 return rec->switch_output.signal &&
124 trigger_is_ready(&switch_output_trigger);
125}
126
127static bool switch_output_size(struct record *rec)
128{
129 return rec->switch_output.size &&
130 trigger_is_ready(&switch_output_trigger) &&
131 (rec->bytes_written >= rec->switch_output.size);
132}
133
bfacbe3b
JO
134static bool switch_output_time(struct record *rec)
135{
136 return rec->switch_output.time &&
137 trigger_is_ready(&switch_output_trigger);
138}
139
6d575816
JS
140static bool record__output_max_size_exceeded(struct record *rec)
141{
142 return rec->output_max_size &&
143 (rec->bytes_written >= rec->output_max_size);
144}
145
a5830532 146static int record__write(struct record *rec, struct mmap *map __maybe_unused,
ded2b8fe 147 void *bf, size_t size)
f5970550 148{
ded2b8fe
JO
149 struct perf_data_file *file = &rec->session->data->file;
150
151 if (perf_data_file__write(file, bf, size) < 0) {
50a9b868
JO
152 pr_err("failed to write perf data, error: %m\n");
153 return -1;
f5970550 154 }
8d3eca20 155
cf8b2e69 156 rec->bytes_written += size;
dc0c6127 157
6d575816
JS
158 if (record__output_max_size_exceeded(rec) && !done) {
159 fprintf(stderr, "[ perf record: perf size limit reached (%" PRIu64 " KB),"
160 " stopping session ]\n",
161 rec->bytes_written >> 10);
162 done = 1;
163 }
164
dc0c6127
JO
165 if (switch_output_size(rec))
166 trigger_hit(&switch_output_trigger);
167
8d3eca20 168 return 0;
f5970550
PZ
169}
170
ef781128
AB
171static int record__aio_enabled(struct record *rec);
172static int record__comp_enabled(struct record *rec);
5d7f4116
AB
173static size_t zstd_compress(struct perf_session *session, void *dst, size_t dst_size,
174 void *src, size_t src_size);
175
d3d1af6f
AB
176#ifdef HAVE_AIO_SUPPORT
177static int record__aio_write(struct aiocb *cblock, int trace_fd,
178 void *buf, size_t size, off_t off)
179{
180 int rc;
181
182 cblock->aio_fildes = trace_fd;
183 cblock->aio_buf = buf;
184 cblock->aio_nbytes = size;
185 cblock->aio_offset = off;
186 cblock->aio_sigevent.sigev_notify = SIGEV_NONE;
187
188 do {
189 rc = aio_write(cblock);
190 if (rc == 0) {
191 break;
192 } else if (errno != EAGAIN) {
193 cblock->aio_fildes = -1;
194 pr_err("failed to queue perf data, error: %m\n");
195 break;
196 }
197 } while (1);
198
199 return rc;
200}
201
a5830532 202static int record__aio_complete(struct mmap *md, struct aiocb *cblock)
d3d1af6f
AB
203{
204 void *rem_buf;
205 off_t rem_off;
206 size_t rem_size;
207 int rc, aio_errno;
208 ssize_t aio_ret, written;
209
210 aio_errno = aio_error(cblock);
211 if (aio_errno == EINPROGRESS)
212 return 0;
213
214 written = aio_ret = aio_return(cblock);
215 if (aio_ret < 0) {
216 if (aio_errno != EINTR)
217 pr_err("failed to write perf data, error: %m\n");
218 written = 0;
219 }
220
221 rem_size = cblock->aio_nbytes - written;
222
223 if (rem_size == 0) {
224 cblock->aio_fildes = -1;
225 /*
ef781128
AB
226 * md->refcount is incremented in record__aio_pushfn() for
227 * every aio write request started in record__aio_push() so
228 * decrement it because the request is now complete.
d3d1af6f 229 */
80e53d11 230 perf_mmap__put(&md->core);
d3d1af6f
AB
231 rc = 1;
232 } else {
233 /*
234 * aio write request may require restart with the
235 * reminder if the kernel didn't write whole
236 * chunk at once.
237 */
238 rem_off = cblock->aio_offset + written;
239 rem_buf = (void *)(cblock->aio_buf + written);
240 record__aio_write(cblock, cblock->aio_fildes,
241 rem_buf, rem_size, rem_off);
242 rc = 0;
243 }
244
245 return rc;
246}
247
a5830532 248static int record__aio_sync(struct mmap *md, bool sync_all)
d3d1af6f 249{
93f20c0f
AB
250 struct aiocb **aiocb = md->aio.aiocb;
251 struct aiocb *cblocks = md->aio.cblocks;
d3d1af6f 252 struct timespec timeout = { 0, 1000 * 1000 * 1 }; /* 1ms */
93f20c0f 253 int i, do_suspend;
d3d1af6f
AB
254
255 do {
93f20c0f
AB
256 do_suspend = 0;
257 for (i = 0; i < md->aio.nr_cblocks; ++i) {
258 if (cblocks[i].aio_fildes == -1 || record__aio_complete(md, &cblocks[i])) {
259 if (sync_all)
260 aiocb[i] = NULL;
261 else
262 return i;
263 } else {
264 /*
265 * Started aio write is not complete yet
266 * so it has to be waited before the
267 * next allocation.
268 */
269 aiocb[i] = &cblocks[i];
270 do_suspend = 1;
271 }
272 }
273 if (!do_suspend)
274 return -1;
d3d1af6f 275
93f20c0f 276 while (aio_suspend((const struct aiocb **)aiocb, md->aio.nr_cblocks, &timeout)) {
d3d1af6f
AB
277 if (!(errno == EAGAIN || errno == EINTR))
278 pr_err("failed to sync perf data, error: %m\n");
279 }
280 } while (1);
281}
282
ef781128
AB
283struct record_aio {
284 struct record *rec;
285 void *data;
286 size_t size;
287};
288
a5830532 289static int record__aio_pushfn(struct mmap *map, void *to, void *buf, size_t size)
d3d1af6f 290{
ef781128 291 struct record_aio *aio = to;
d3d1af6f 292
ef781128 293 /*
547740f7 294 * map->core.base data pointed by buf is copied into free map->aio.data[] buffer
ef781128
AB
295 * to release space in the kernel buffer as fast as possible, calling
296 * perf_mmap__consume() from perf_mmap__push() function.
297 *
298 * That lets the kernel to proceed with storing more profiling data into
299 * the kernel buffer earlier than other per-cpu kernel buffers are handled.
300 *
301 * Coping can be done in two steps in case the chunk of profiling data
302 * crosses the upper bound of the kernel buffer. In this case we first move
303 * part of data from map->start till the upper bound and then the reminder
304 * from the beginning of the kernel buffer till the end of the data chunk.
305 */
306
307 if (record__comp_enabled(aio->rec)) {
308 size = zstd_compress(aio->rec->session, aio->data + aio->size,
bf59b305 309 mmap__mmap_len(map) - aio->size,
ef781128
AB
310 buf, size);
311 } else {
312 memcpy(aio->data + aio->size, buf, size);
313 }
314
315 if (!aio->size) {
316 /*
317 * Increment map->refcount to guard map->aio.data[] buffer
318 * from premature deallocation because map object can be
319 * released earlier than aio write request started on
320 * map->aio.data[] buffer is complete.
321 *
322 * perf_mmap__put() is done at record__aio_complete()
323 * after started aio request completion or at record__aio_push()
324 * if the request failed to start.
325 */
e75710f0 326 perf_mmap__get(&map->core);
ef781128
AB
327 }
328
329 aio->size += size;
330
331 return size;
332}
333
a5830532 334static int record__aio_push(struct record *rec, struct mmap *map, off_t *off)
ef781128
AB
335{
336 int ret, idx;
337 int trace_fd = rec->session->data->file.fd;
338 struct record_aio aio = { .rec = rec, .size = 0 };
d3d1af6f 339
ef781128
AB
340 /*
341 * Call record__aio_sync() to wait till map->aio.data[] buffer
342 * becomes available after previous aio write operation.
343 */
344
345 idx = record__aio_sync(map, false);
346 aio.data = map->aio.data[idx];
347 ret = perf_mmap__push(map, &aio, record__aio_pushfn);
348 if (ret != 0) /* ret > 0 - no data, ret < 0 - error */
349 return ret;
350
351 rec->samples++;
352 ret = record__aio_write(&(map->aio.cblocks[idx]), trace_fd, aio.data, aio.size, *off);
d3d1af6f 353 if (!ret) {
ef781128
AB
354 *off += aio.size;
355 rec->bytes_written += aio.size;
d3d1af6f
AB
356 if (switch_output_size(rec))
357 trigger_hit(&switch_output_trigger);
ef781128
AB
358 } else {
359 /*
360 * Decrement map->refcount incremented in record__aio_pushfn()
361 * back if record__aio_write() operation failed to start, otherwise
362 * map->refcount is decremented in record__aio_complete() after
363 * aio write operation finishes successfully.
364 */
80e53d11 365 perf_mmap__put(&map->core);
d3d1af6f
AB
366 }
367
368 return ret;
369}
370
371static off_t record__aio_get_pos(int trace_fd)
372{
373 return lseek(trace_fd, 0, SEEK_CUR);
374}
375
376static void record__aio_set_pos(int trace_fd, off_t pos)
377{
378 lseek(trace_fd, pos, SEEK_SET);
379}
380
381static void record__aio_mmap_read_sync(struct record *rec)
382{
383 int i;
63503dba 384 struct evlist *evlist = rec->evlist;
a5830532 385 struct mmap *maps = evlist->mmap;
d3d1af6f 386
ef781128 387 if (!record__aio_enabled(rec))
d3d1af6f
AB
388 return;
389
c976ee11 390 for (i = 0; i < evlist->core.nr_mmaps; i++) {
a5830532 391 struct mmap *map = &maps[i];
d3d1af6f 392
547740f7 393 if (map->core.base)
93f20c0f 394 record__aio_sync(map, true);
d3d1af6f
AB
395 }
396}
397
398static int nr_cblocks_default = 1;
93f20c0f 399static int nr_cblocks_max = 4;
d3d1af6f
AB
400
401static int record__aio_parse(const struct option *opt,
93f20c0f 402 const char *str,
d3d1af6f
AB
403 int unset)
404{
405 struct record_opts *opts = (struct record_opts *)opt->value;
406
93f20c0f 407 if (unset) {
d3d1af6f 408 opts->nr_cblocks = 0;
93f20c0f
AB
409 } else {
410 if (str)
411 opts->nr_cblocks = strtol(str, NULL, 0);
412 if (!opts->nr_cblocks)
413 opts->nr_cblocks = nr_cblocks_default;
414 }
d3d1af6f
AB
415
416 return 0;
417}
418#else /* HAVE_AIO_SUPPORT */
93f20c0f
AB
419static int nr_cblocks_max = 0;
420
a5830532 421static int record__aio_push(struct record *rec __maybe_unused, struct mmap *map __maybe_unused,
ef781128 422 off_t *off __maybe_unused)
d3d1af6f
AB
423{
424 return -1;
425}
426
427static off_t record__aio_get_pos(int trace_fd __maybe_unused)
428{
429 return -1;
430}
431
432static void record__aio_set_pos(int trace_fd __maybe_unused, off_t pos __maybe_unused)
433{
434}
435
436static void record__aio_mmap_read_sync(struct record *rec __maybe_unused)
437{
438}
439#endif
440
441static int record__aio_enabled(struct record *rec)
442{
443 return rec->opts.nr_cblocks > 0;
444}
445
470530bb
AB
446#define MMAP_FLUSH_DEFAULT 1
447static int record__mmap_flush_parse(const struct option *opt,
448 const char *str,
449 int unset)
450{
451 int flush_max;
452 struct record_opts *opts = (struct record_opts *)opt->value;
453 static struct parse_tag tags[] = {
454 { .tag = 'B', .mult = 1 },
455 { .tag = 'K', .mult = 1 << 10 },
456 { .tag = 'M', .mult = 1 << 20 },
457 { .tag = 'G', .mult = 1 << 30 },
458 { .tag = 0 },
459 };
460
461 if (unset)
462 return 0;
463
464 if (str) {
465 opts->mmap_flush = parse_tag_value(str, tags);
466 if (opts->mmap_flush == (int)-1)
467 opts->mmap_flush = strtol(str, NULL, 0);
468 }
469
470 if (!opts->mmap_flush)
471 opts->mmap_flush = MMAP_FLUSH_DEFAULT;
472
9521b5f2 473 flush_max = evlist__mmap_size(opts->mmap_pages);
470530bb
AB
474 flush_max /= 4;
475 if (opts->mmap_flush > flush_max)
476 opts->mmap_flush = flush_max;
477
478 return 0;
479}
480
504c1ad1
AB
481#ifdef HAVE_ZSTD_SUPPORT
482static unsigned int comp_level_default = 1;
483
484static int record__parse_comp_level(const struct option *opt, const char *str, int unset)
485{
486 struct record_opts *opts = opt->value;
487
488 if (unset) {
489 opts->comp_level = 0;
490 } else {
491 if (str)
492 opts->comp_level = strtol(str, NULL, 0);
493 if (!opts->comp_level)
494 opts->comp_level = comp_level_default;
495 }
496
497 return 0;
498}
499#endif
51255a8a
AB
500static unsigned int comp_level_max = 22;
501
42e1fd80
AB
502static int record__comp_enabled(struct record *rec)
503{
504 return rec->opts.comp_level > 0;
505}
506
45694aa7 507static int process_synthesized_event(struct perf_tool *tool,
d20deb64 508 union perf_event *event,
1d037ca1
IT
509 struct perf_sample *sample __maybe_unused,
510 struct machine *machine __maybe_unused)
234fbbf5 511{
8c6f45a7 512 struct record *rec = container_of(tool, struct record, tool);
ded2b8fe 513 return record__write(rec, NULL, event, event->header.size);
234fbbf5
ACM
514}
515
d99c22ea
SE
516static int process_locked_synthesized_event(struct perf_tool *tool,
517 union perf_event *event,
518 struct perf_sample *sample __maybe_unused,
519 struct machine *machine __maybe_unused)
520{
521 static pthread_mutex_t synth_lock = PTHREAD_MUTEX_INITIALIZER;
522 int ret;
523
524 pthread_mutex_lock(&synth_lock);
525 ret = process_synthesized_event(tool, event, sample, machine);
526 pthread_mutex_unlock(&synth_lock);
527 return ret;
528}
529
a5830532 530static int record__pushfn(struct mmap *map, void *to, void *bf, size_t size)
d37f1586
ACM
531{
532 struct record *rec = to;
533
5d7f4116 534 if (record__comp_enabled(rec)) {
bf59b305 535 size = zstd_compress(rec->session, map->data, mmap__mmap_len(map), bf, size);
5d7f4116
AB
536 bf = map->data;
537 }
538
d37f1586 539 rec->samples++;
ded2b8fe 540 return record__write(rec, map, bf, size);
d37f1586
ACM
541}
542
2dd6d8a1
AH
543static volatile int signr = -1;
544static volatile int child_finished;
da231338
AM
545#ifdef HAVE_EVENTFD_SUPPORT
546static int done_fd = -1;
547#endif
c0bdc1c4 548
2dd6d8a1
AH
549static void sig_handler(int sig)
550{
551 if (sig == SIGCHLD)
552 child_finished = 1;
553 else
554 signr = sig;
555
556 done = 1;
da231338
AM
557#ifdef HAVE_EVENTFD_SUPPORT
558{
559 u64 tmp = 1;
560 /*
561 * It is possible for this signal handler to run after done is checked
562 * in the main loop, but before the perf counter fds are polled. If this
563 * happens, the poll() will continue to wait even though done is set,
564 * and will only break out if either another signal is received, or the
565 * counters are ready for read. To ensure the poll() doesn't sleep when
566 * done is set, use an eventfd (done_fd) to wake up the poll().
567 */
568 if (write(done_fd, &tmp, sizeof(tmp)) < 0)
569 pr_err("failed to signal wakeup fd, error: %m\n");
570}
571#endif // HAVE_EVENTFD_SUPPORT
2dd6d8a1
AH
572}
573
a074865e
WN
574static void sigsegv_handler(int sig)
575{
576 perf_hooks__recover();
577 sighandler_dump_stack(sig);
578}
579
2dd6d8a1
AH
580static void record__sig_exit(void)
581{
582 if (signr == -1)
583 return;
584
585 signal(signr, SIG_DFL);
586 raise(signr);
587}
588
e31f0d01
AH
589#ifdef HAVE_AUXTRACE_SUPPORT
590
ef149c25 591static int record__process_auxtrace(struct perf_tool *tool,
a5830532 592 struct mmap *map,
ef149c25
AH
593 union perf_event *event, void *data1,
594 size_t len1, void *data2, size_t len2)
595{
596 struct record *rec = container_of(tool, struct record, tool);
8ceb41d7 597 struct perf_data *data = &rec->data;
ef149c25
AH
598 size_t padding;
599 u8 pad[8] = {0};
600
46e201ef 601 if (!perf_data__is_pipe(data) && perf_data__is_single_file(data)) {
99fa2984 602 off_t file_offset;
8ceb41d7 603 int fd = perf_data__fd(data);
99fa2984
AH
604 int err;
605
606 file_offset = lseek(fd, 0, SEEK_CUR);
607 if (file_offset == -1)
608 return -1;
609 err = auxtrace_index__auxtrace_event(&rec->session->auxtrace_index,
610 event, file_offset);
611 if (err)
612 return err;
613 }
614
ef149c25
AH
615 /* event.auxtrace.size includes padding, see __auxtrace_mmap__read() */
616 padding = (len1 + len2) & 7;
617 if (padding)
618 padding = 8 - padding;
619
ded2b8fe
JO
620 record__write(rec, map, event, event->header.size);
621 record__write(rec, map, data1, len1);
ef149c25 622 if (len2)
ded2b8fe
JO
623 record__write(rec, map, data2, len2);
624 record__write(rec, map, &pad, padding);
ef149c25
AH
625
626 return 0;
627}
628
629static int record__auxtrace_mmap_read(struct record *rec,
a5830532 630 struct mmap *map)
ef149c25
AH
631{
632 int ret;
633
e035f4ca 634 ret = auxtrace_mmap__read(map, rec->itr, &rec->tool,
ef149c25
AH
635 record__process_auxtrace);
636 if (ret < 0)
637 return ret;
638
639 if (ret)
640 rec->samples++;
641
642 return 0;
643}
644
2dd6d8a1 645static int record__auxtrace_mmap_read_snapshot(struct record *rec,
a5830532 646 struct mmap *map)
2dd6d8a1
AH
647{
648 int ret;
649
e035f4ca 650 ret = auxtrace_mmap__read_snapshot(map, rec->itr, &rec->tool,
2dd6d8a1
AH
651 record__process_auxtrace,
652 rec->opts.auxtrace_snapshot_size);
653 if (ret < 0)
654 return ret;
655
656 if (ret)
657 rec->samples++;
658
659 return 0;
660}
661
662static int record__auxtrace_read_snapshot_all(struct record *rec)
663{
664 int i;
665 int rc = 0;
666
c976ee11 667 for (i = 0; i < rec->evlist->core.nr_mmaps; i++) {
a5830532 668 struct mmap *map = &rec->evlist->mmap[i];
2dd6d8a1 669
e035f4ca 670 if (!map->auxtrace_mmap.base)
2dd6d8a1
AH
671 continue;
672
e035f4ca 673 if (record__auxtrace_mmap_read_snapshot(rec, map) != 0) {
2dd6d8a1
AH
674 rc = -1;
675 goto out;
676 }
677 }
678out:
679 return rc;
680}
681
ce7b0e42 682static void record__read_auxtrace_snapshot(struct record *rec, bool on_exit)
2dd6d8a1
AH
683{
684 pr_debug("Recording AUX area tracing snapshot\n");
685 if (record__auxtrace_read_snapshot_all(rec) < 0) {
5f9cf599 686 trigger_error(&auxtrace_snapshot_trigger);
2dd6d8a1 687 } else {
ce7b0e42 688 if (auxtrace_record__snapshot_finish(rec->itr, on_exit))
5f9cf599
WN
689 trigger_error(&auxtrace_snapshot_trigger);
690 else
691 trigger_ready(&auxtrace_snapshot_trigger);
2dd6d8a1
AH
692 }
693}
694
ce7b0e42
AS
695static int record__auxtrace_snapshot_exit(struct record *rec)
696{
697 if (trigger_is_error(&auxtrace_snapshot_trigger))
698 return 0;
699
700 if (!auxtrace_record__snapshot_started &&
701 auxtrace_record__snapshot_start(rec->itr))
702 return -1;
703
704 record__read_auxtrace_snapshot(rec, true);
705 if (trigger_is_error(&auxtrace_snapshot_trigger))
706 return -1;
707
708 return 0;
709}
710
4b5ea3bd
AH
711static int record__auxtrace_init(struct record *rec)
712{
713 int err;
714
715 if (!rec->itr) {
716 rec->itr = auxtrace_record__init(rec->evlist, &err);
717 if (err)
718 return err;
719 }
720
721 err = auxtrace_parse_snapshot_options(rec->itr, &rec->opts,
722 rec->opts.auxtrace_snapshot_opts);
723 if (err)
724 return err;
725
c0a6de06
AH
726 err = auxtrace_parse_sample_options(rec->itr, rec->evlist, &rec->opts,
727 rec->opts.auxtrace_sample_opts);
728 if (err)
729 return err;
730
4b5ea3bd
AH
731 return auxtrace_parse_filters(rec->evlist);
732}
733
e31f0d01
AH
734#else
735
736static inline
737int record__auxtrace_mmap_read(struct record *rec __maybe_unused,
a5830532 738 struct mmap *map __maybe_unused)
e31f0d01
AH
739{
740 return 0;
741}
742
2dd6d8a1 743static inline
ce7b0e42
AS
744void record__read_auxtrace_snapshot(struct record *rec __maybe_unused,
745 bool on_exit __maybe_unused)
de9ac07b 746{
f7b7c26e
PZ
747}
748
2dd6d8a1
AH
749static inline
750int auxtrace_record__snapshot_start(struct auxtrace_record *itr __maybe_unused)
f7b7c26e 751{
2dd6d8a1 752 return 0;
de9ac07b
PZ
753}
754
ce7b0e42
AS
755static inline
756int record__auxtrace_snapshot_exit(struct record *rec __maybe_unused)
757{
758 return 0;
759}
760
4b5ea3bd
AH
761static int record__auxtrace_init(struct record *rec __maybe_unused)
762{
763 return 0;
764}
765
2dd6d8a1
AH
766#endif
767
246eba8e
AH
768static int record__config_text_poke(struct evlist *evlist)
769{
770 struct evsel *evsel;
771 int err;
772
773 /* Nothing to do if text poke is already configured */
774 evlist__for_each_entry(evlist, evsel) {
775 if (evsel->core.attr.text_poke)
776 return 0;
777 }
778
779 err = parse_events(evlist, "dummy:u", NULL);
780 if (err)
781 return err;
782
783 evsel = evlist__last(evlist);
784
785 evsel->core.attr.freq = 0;
786 evsel->core.attr.sample_period = 1;
787 evsel->core.attr.text_poke = 1;
788 evsel->core.attr.ksymbol = 1;
789
790 evsel->core.system_wide = true;
791 evsel->no_aux_samples = true;
792 evsel->immediate = true;
793
794 /* Text poke must be collected on all CPUs */
795 perf_cpu_map__put(evsel->core.own_cpus);
796 evsel->core.own_cpus = perf_cpu_map__new(NULL);
797 perf_cpu_map__put(evsel->core.cpus);
798 evsel->core.cpus = perf_cpu_map__get(evsel->core.own_cpus);
799
800 evsel__set_sample_bit(evsel, TIME);
801
802 return 0;
803}
804
eeb399b5
AH
805static bool record__kcore_readable(struct machine *machine)
806{
807 char kcore[PATH_MAX];
808 int fd;
809
810 scnprintf(kcore, sizeof(kcore), "%s/proc/kcore", machine->root_dir);
811
812 fd = open(kcore, O_RDONLY);
813 if (fd < 0)
814 return false;
815
816 close(fd);
817
818 return true;
819}
820
821static int record__kcore_copy(struct machine *machine, struct perf_data *data)
822{
823 char from_dir[PATH_MAX];
824 char kcore_dir[PATH_MAX];
825 int ret;
826
827 snprintf(from_dir, sizeof(from_dir), "%s/proc", machine->root_dir);
828
829 ret = perf_data__make_kcore_dir(data, kcore_dir, sizeof(kcore_dir));
830 if (ret)
831 return ret;
832
833 return kcore_copy(from_dir, kcore_dir);
834}
835
cda57a8c 836static int record__mmap_evlist(struct record *rec,
63503dba 837 struct evlist *evlist)
cda57a8c
WN
838{
839 struct record_opts *opts = &rec->opts;
c0a6de06
AH
840 bool auxtrace_overwrite = opts->auxtrace_snapshot_mode ||
841 opts->auxtrace_sample_mode;
cda57a8c
WN
842 char msg[512];
843
f13de660
AB
844 if (opts->affinity != PERF_AFFINITY_SYS)
845 cpu__setup_cpunode_map();
846
9521b5f2 847 if (evlist__mmap_ex(evlist, opts->mmap_pages,
cda57a8c 848 opts->auxtrace_mmap_pages,
c0a6de06 849 auxtrace_overwrite,
470530bb 850 opts->nr_cblocks, opts->affinity,
51255a8a 851 opts->mmap_flush, opts->comp_level) < 0) {
cda57a8c
WN
852 if (errno == EPERM) {
853 pr_err("Permission error mapping pages.\n"
854 "Consider increasing "
855 "/proc/sys/kernel/perf_event_mlock_kb,\n"
856 "or try again with a smaller value of -m/--mmap_pages.\n"
857 "(current value: %u,%u)\n",
858 opts->mmap_pages, opts->auxtrace_mmap_pages);
859 return -errno;
860 } else {
861 pr_err("failed to mmap with %d (%s)\n", errno,
c8b5f2c9 862 str_error_r(errno, msg, sizeof(msg)));
cda57a8c
WN
863 if (errno)
864 return -errno;
865 else
866 return -EINVAL;
867 }
868 }
869 return 0;
870}
871
872static int record__mmap(struct record *rec)
873{
874 return record__mmap_evlist(rec, rec->evlist);
875}
876
8c6f45a7 877static int record__open(struct record *rec)
dd7927f4 878{
d6195a6a 879 char msg[BUFSIZ];
32dcd021 880 struct evsel *pos;
63503dba 881 struct evlist *evlist = rec->evlist;
d20deb64 882 struct perf_session *session = rec->session;
b4006796 883 struct record_opts *opts = &rec->opts;
8d3eca20 884 int rc = 0;
dd7927f4 885
d3dbf43c 886 /*
0a892c1c
IR
887 * For initial_delay or system wide, we need to add a dummy event so
888 * that we can track PERF_RECORD_MMAP to cover the delay of waiting or
889 * event synthesis.
d3dbf43c 890 */
0a892c1c 891 if (opts->initial_delay || target__has_cpu(&opts->target)) {
442ad225
AH
892 pos = perf_evlist__get_tracking_event(evlist);
893 if (!evsel__is_dummy_event(pos)) {
894 /* Set up dummy event. */
facbf0b9 895 if (evlist__add_dummy(evlist))
442ad225
AH
896 return -ENOMEM;
897 pos = evlist__last(evlist);
898 perf_evlist__set_tracking_event(evlist, pos);
899 }
900
0a892c1c
IR
901 /*
902 * Enable the dummy event when the process is forked for
903 * initial_delay, immediately for system wide.
904 */
442ad225 905 if (opts->initial_delay && !pos->immediate)
0a892c1c
IR
906 pos->core.attr.enable_on_exec = 1;
907 else
908 pos->immediate = 1;
d3dbf43c
ACM
909 }
910
e68ae9cf 911 perf_evlist__config(evlist, opts, &callchain_param);
cac21425 912
e5cadb93 913 evlist__for_each_entry(evlist, pos) {
dd7927f4 914try_again:
af663bd0 915 if (evsel__open(pos, pos->core.cpus, pos->core.threads) < 0) {
ae430892 916 if (evsel__fallback(pos, errno, msg, sizeof(msg))) {
bb963e16 917 if (verbose > 0)
c0a54341 918 ui__warning("%s\n", msg);
d6d901c2
ZY
919 goto try_again;
920 }
cf99ad14
AK
921 if ((errno == EINVAL || errno == EBADF) &&
922 pos->leader != pos &&
923 pos->weak_group) {
4804e011 924 pos = perf_evlist__reset_weak_group(evlist, pos, true);
cf99ad14
AK
925 goto try_again;
926 }
56e52e85 927 rc = -errno;
2bb72dbb 928 evsel__open_strerror(pos, &opts->target, errno, msg, sizeof(msg));
56e52e85 929 ui__error("%s\n", msg);
8d3eca20 930 goto out;
c171b552 931 }
bfd8f72c
AK
932
933 pos->supported = true;
c171b552 934 }
a43d3f08 935
c8b567c8
ACM
936 if (symbol_conf.kptr_restrict && !perf_evlist__exclude_kernel(evlist)) {
937 pr_warning(
938"WARNING: Kernel address maps (/proc/{kallsyms,modules}) are restricted,\n"
939"check /proc/sys/kernel/kptr_restrict and /proc/sys/kernel/perf_event_paranoid.\n\n"
940"Samples in kernel functions may not be resolved if a suitable vmlinux\n"
941"file is not found in the buildid cache or in the vmlinux path.\n\n"
942"Samples in kernel modules won't be resolved at all.\n\n"
943"If some relocation was applied (e.g. kexec) symbols may be misresolved\n"
944"even with a suitable vmlinux or kallsyms file.\n\n");
945 }
946
23d4aad4 947 if (perf_evlist__apply_filters(evlist, &pos)) {
62d94b00 948 pr_err("failed to set filter \"%s\" on event %s with %d (%s)\n",
8ab2e96d 949 pos->filter, evsel__name(pos), errno,
c8b5f2c9 950 str_error_r(errno, msg, sizeof(msg)));
8d3eca20 951 rc = -1;
5d8bb1ec
MP
952 goto out;
953 }
954
cda57a8c
WN
955 rc = record__mmap(rec);
956 if (rc)
8d3eca20 957 goto out;
0a27d7f9 958
563aecb2 959 session->evlist = evlist;
7b56cce2 960 perf_session__set_id_hdr_size(session);
8d3eca20
DA
961out:
962 return rc;
16c8a109
PZ
963}
964
e3d59112
NK
965static int process_sample_event(struct perf_tool *tool,
966 union perf_event *event,
967 struct perf_sample *sample,
32dcd021 968 struct evsel *evsel,
e3d59112
NK
969 struct machine *machine)
970{
971 struct record *rec = container_of(tool, struct record, tool);
972
68588baf
JY
973 if (rec->evlist->first_sample_time == 0)
974 rec->evlist->first_sample_time = sample->time;
975
976 rec->evlist->last_sample_time = sample->time;
e3d59112 977
68588baf
JY
978 if (rec->buildid_all)
979 return 0;
980
981 rec->samples++;
e3d59112
NK
982 return build_id__mark_dso_hit(tool, event, sample, evsel, machine);
983}
984
8c6f45a7 985static int process_buildids(struct record *rec)
6122e4e4 986{
f5fc1412 987 struct perf_session *session = rec->session;
6122e4e4 988
45112e89 989 if (perf_data__size(&rec->data) == 0)
9f591fd7
ACM
990 return 0;
991
00dc8657
NK
992 /*
993 * During this process, it'll load kernel map and replace the
994 * dso->long_name to a real pathname it found. In this case
995 * we prefer the vmlinux path like
996 * /lib/modules/3.16.4/build/vmlinux
997 *
998 * rather than build-id path (in debug directory).
999 * $HOME/.debug/.build-id/f0/6e17aa50adf4d00b88925e03775de107611551
1000 */
1001 symbol_conf.ignore_vmlinux_buildid = true;
1002
6156681b
NK
1003 /*
1004 * If --buildid-all is given, it marks all DSO regardless of hits,
68588baf
JY
1005 * so no need to process samples. But if timestamp_boundary is enabled,
1006 * it still needs to walk on all samples to get the timestamps of
1007 * first/last samples.
6156681b 1008 */
68588baf 1009 if (rec->buildid_all && !rec->timestamp_boundary)
6156681b
NK
1010 rec->tool.sample = NULL;
1011
b7b61cbe 1012 return perf_session__process_events(session);
6122e4e4
ACM
1013}
1014
8115d60c 1015static void perf_event__synthesize_guest_os(struct machine *machine, void *data)
a1645ce1
ZY
1016{
1017 int err;
45694aa7 1018 struct perf_tool *tool = data;
a1645ce1
ZY
1019 /*
1020 *As for guest kernel when processing subcommand record&report,
1021 *we arrange module mmap prior to guest kernel mmap and trigger
1022 *a preload dso because default guest module symbols are loaded
1023 *from guest kallsyms instead of /lib/modules/XXX/XXX. This
1024 *method is used to avoid symbol missing when the first addr is
1025 *in module instead of in guest kernel.
1026 */
45694aa7 1027 err = perf_event__synthesize_modules(tool, process_synthesized_event,
743eb868 1028 machine);
a1645ce1
ZY
1029 if (err < 0)
1030 pr_err("Couldn't record guest kernel [%d]'s reference"
23346f21 1031 " relocation symbol.\n", machine->pid);
a1645ce1 1032
a1645ce1
ZY
1033 /*
1034 * We use _stext for guest kernel because guest kernel's /proc/kallsyms
1035 * have no _text sometimes.
1036 */
45694aa7 1037 err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
0ae617be 1038 machine);
a1645ce1
ZY
1039 if (err < 0)
1040 pr_err("Couldn't record guest kernel [%d]'s reference"
23346f21 1041 " relocation symbol.\n", machine->pid);
a1645ce1
ZY
1042}
1043
98402807
FW
1044static struct perf_event_header finished_round_event = {
1045 .size = sizeof(struct perf_event_header),
1046 .type = PERF_RECORD_FINISHED_ROUND,
1047};
1048
a5830532 1049static void record__adjust_affinity(struct record *rec, struct mmap *map)
f13de660
AB
1050{
1051 if (rec->opts.affinity != PERF_AFFINITY_SYS &&
8384a260
AB
1052 !bitmap_equal(rec->affinity_mask.bits, map->affinity_mask.bits,
1053 rec->affinity_mask.nbits)) {
1054 bitmap_zero(rec->affinity_mask.bits, rec->affinity_mask.nbits);
1055 bitmap_or(rec->affinity_mask.bits, rec->affinity_mask.bits,
1056 map->affinity_mask.bits, rec->affinity_mask.nbits);
1057 sched_setaffinity(0, MMAP_CPU_MASK_BYTES(&rec->affinity_mask),
1058 (cpu_set_t *)rec->affinity_mask.bits);
1059 if (verbose == 2)
1060 mmap_cpu_mask__scnprintf(&rec->affinity_mask, "thread");
f13de660
AB
1061 }
1062}
1063
5d7f4116
AB
1064static size_t process_comp_header(void *record, size_t increment)
1065{
72932371 1066 struct perf_record_compressed *event = record;
5d7f4116
AB
1067 size_t size = sizeof(*event);
1068
1069 if (increment) {
1070 event->header.size += increment;
1071 return increment;
1072 }
1073
1074 event->header.type = PERF_RECORD_COMPRESSED;
1075 event->header.size = size;
1076
1077 return size;
1078}
1079
1080static size_t zstd_compress(struct perf_session *session, void *dst, size_t dst_size,
1081 void *src, size_t src_size)
1082{
1083 size_t compressed;
72932371 1084 size_t max_record_size = PERF_SAMPLE_MAX_SIZE - sizeof(struct perf_record_compressed) - 1;
5d7f4116
AB
1085
1086 compressed = zstd_compress_stream_to_records(&session->zstd_data, dst, dst_size, src, src_size,
1087 max_record_size, process_comp_header);
1088
1089 session->bytes_transferred += src_size;
1090 session->bytes_compressed += compressed;
1091
1092 return compressed;
1093}
1094
63503dba 1095static int record__mmap_read_evlist(struct record *rec, struct evlist *evlist,
470530bb 1096 bool overwrite, bool synch)
98402807 1097{
dcabb507 1098 u64 bytes_written = rec->bytes_written;
0e2e63dd 1099 int i;
8d3eca20 1100 int rc = 0;
a5830532 1101 struct mmap *maps;
d3d1af6f 1102 int trace_fd = rec->data.file.fd;
ef781128 1103 off_t off = 0;
98402807 1104
cb21686b
WN
1105 if (!evlist)
1106 return 0;
ef149c25 1107
0b72d69a 1108 maps = overwrite ? evlist->overwrite_mmap : evlist->mmap;
a4ea0ec4
WN
1109 if (!maps)
1110 return 0;
1111
0b72d69a 1112 if (overwrite && evlist->bkw_mmap_state != BKW_MMAP_DATA_PENDING)
54cc54de
WN
1113 return 0;
1114
d3d1af6f
AB
1115 if (record__aio_enabled(rec))
1116 off = record__aio_get_pos(trace_fd);
1117
c976ee11 1118 for (i = 0; i < evlist->core.nr_mmaps; i++) {
470530bb 1119 u64 flush = 0;
a5830532 1120 struct mmap *map = &maps[i];
cb21686b 1121
547740f7 1122 if (map->core.base) {
f13de660 1123 record__adjust_affinity(rec, map);
470530bb 1124 if (synch) {
65aa2e6b
JO
1125 flush = map->core.flush;
1126 map->core.flush = 1;
470530bb 1127 }
d3d1af6f 1128 if (!record__aio_enabled(rec)) {
ef781128 1129 if (perf_mmap__push(map, rec, record__pushfn) < 0) {
470530bb 1130 if (synch)
65aa2e6b 1131 map->core.flush = flush;
d3d1af6f
AB
1132 rc = -1;
1133 goto out;
1134 }
1135 } else {
ef781128 1136 if (record__aio_push(rec, map, &off) < 0) {
d3d1af6f 1137 record__aio_set_pos(trace_fd, off);
470530bb 1138 if (synch)
65aa2e6b 1139 map->core.flush = flush;
d3d1af6f
AB
1140 rc = -1;
1141 goto out;
1142 }
8d3eca20 1143 }
470530bb 1144 if (synch)
65aa2e6b 1145 map->core.flush = flush;
8d3eca20 1146 }
ef149c25 1147
e035f4ca 1148 if (map->auxtrace_mmap.base && !rec->opts.auxtrace_snapshot_mode &&
c0a6de06 1149 !rec->opts.auxtrace_sample_mode &&
e035f4ca 1150 record__auxtrace_mmap_read(rec, map) != 0) {
ef149c25
AH
1151 rc = -1;
1152 goto out;
1153 }
98402807
FW
1154 }
1155
d3d1af6f
AB
1156 if (record__aio_enabled(rec))
1157 record__aio_set_pos(trace_fd, off);
1158
dcabb507
JO
1159 /*
1160 * Mark the round finished in case we wrote
1161 * at least one event.
1162 */
1163 if (bytes_written != rec->bytes_written)
ded2b8fe 1164 rc = record__write(rec, NULL, &finished_round_event, sizeof(finished_round_event));
8d3eca20 1165
0b72d69a 1166 if (overwrite)
54cc54de 1167 perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_EMPTY);
8d3eca20
DA
1168out:
1169 return rc;
98402807
FW
1170}
1171
470530bb 1172static int record__mmap_read_all(struct record *rec, bool synch)
cb21686b
WN
1173{
1174 int err;
1175
470530bb 1176 err = record__mmap_read_evlist(rec, rec->evlist, false, synch);
cb21686b
WN
1177 if (err)
1178 return err;
1179
470530bb 1180 return record__mmap_read_evlist(rec, rec->evlist, true, synch);
cb21686b
WN
1181}
1182
8c6f45a7 1183static void record__init_features(struct record *rec)
57706abc 1184{
57706abc
DA
1185 struct perf_session *session = rec->session;
1186 int feat;
1187
1188 for (feat = HEADER_FIRST_FEATURE; feat < HEADER_LAST_FEATURE; feat++)
1189 perf_header__set_feat(&session->header, feat);
1190
1191 if (rec->no_buildid)
1192 perf_header__clear_feat(&session->header, HEADER_BUILD_ID);
1193
ce9036a6 1194 if (!have_tracepoints(&rec->evlist->core.entries))
57706abc
DA
1195 perf_header__clear_feat(&session->header, HEADER_TRACING_DATA);
1196
1197 if (!rec->opts.branch_stack)
1198 perf_header__clear_feat(&session->header, HEADER_BRANCH_STACK);
ef149c25
AH
1199
1200 if (!rec->opts.full_auxtrace)
1201 perf_header__clear_feat(&session->header, HEADER_AUXTRACE);
ffa517ad 1202
cf790516
AB
1203 if (!(rec->opts.use_clockid && rec->opts.clockid_res_ns))
1204 perf_header__clear_feat(&session->header, HEADER_CLOCKID);
1205
258031c0 1206 perf_header__clear_feat(&session->header, HEADER_DIR_FORMAT);
42e1fd80
AB
1207 if (!record__comp_enabled(rec))
1208 perf_header__clear_feat(&session->header, HEADER_COMPRESSED);
258031c0 1209
ffa517ad 1210 perf_header__clear_feat(&session->header, HEADER_STAT);
57706abc
DA
1211}
1212
e1ab48ba
WN
1213static void
1214record__finish_output(struct record *rec)
1215{
8ceb41d7
JO
1216 struct perf_data *data = &rec->data;
1217 int fd = perf_data__fd(data);
e1ab48ba 1218
8ceb41d7 1219 if (data->is_pipe)
e1ab48ba
WN
1220 return;
1221
1222 rec->session->header.data_size += rec->bytes_written;
45112e89 1223 data->file.size = lseek(perf_data__fd(data), 0, SEEK_CUR);
e1ab48ba
WN
1224
1225 if (!rec->no_buildid) {
1226 process_buildids(rec);
1227
1228 if (rec->buildid_all)
1229 dsos__hit_all(rec->session);
1230 }
1231 perf_session__write_header(rec->session, rec->evlist, fd, true);
1232
1233 return;
1234}
1235
4ea648ae 1236static int record__synthesize_workload(struct record *rec, bool tail)
be7b0c9e 1237{
9d6aae72 1238 int err;
9749b90e 1239 struct perf_thread_map *thread_map;
be7b0c9e 1240
4ea648ae
WN
1241 if (rec->opts.tail_synthesize != tail)
1242 return 0;
1243
9d6aae72
ACM
1244 thread_map = thread_map__new_by_tid(rec->evlist->workload.pid);
1245 if (thread_map == NULL)
1246 return -1;
1247
1248 err = perf_event__synthesize_thread_map(&rec->tool, thread_map,
be7b0c9e
WN
1249 process_synthesized_event,
1250 &rec->session->machines.host,
3fcb10e4 1251 rec->opts.sample_address);
7836e52e 1252 perf_thread_map__put(thread_map);
9d6aae72 1253 return err;
be7b0c9e
WN
1254}
1255
4ea648ae 1256static int record__synthesize(struct record *rec, bool tail);
3c1cb7e3 1257
ecfd7a9c
WN
1258static int
1259record__switch_output(struct record *rec, bool at_exit)
1260{
8ceb41d7 1261 struct perf_data *data = &rec->data;
ecfd7a9c 1262 int fd, err;
03724b2e 1263 char *new_filename;
ecfd7a9c
WN
1264
1265 /* Same Size: "2015122520103046"*/
1266 char timestamp[] = "InvalidTimestamp";
1267
d3d1af6f
AB
1268 record__aio_mmap_read_sync(rec);
1269
4ea648ae
WN
1270 record__synthesize(rec, true);
1271 if (target__none(&rec->opts.target))
1272 record__synthesize_workload(rec, true);
1273
ecfd7a9c
WN
1274 rec->samples = 0;
1275 record__finish_output(rec);
1276 err = fetch_current_timestamp(timestamp, sizeof(timestamp));
1277 if (err) {
1278 pr_err("Failed to get current timestamp\n");
1279 return -EINVAL;
1280 }
1281
8ceb41d7 1282 fd = perf_data__switch(data, timestamp,
ecfd7a9c 1283 rec->session->header.data_offset,
03724b2e 1284 at_exit, &new_filename);
ecfd7a9c
WN
1285 if (fd >= 0 && !at_exit) {
1286 rec->bytes_written = 0;
1287 rec->session->header.data_size = 0;
1288 }
1289
1290 if (!quiet)
1291 fprintf(stderr, "[ perf record: Dump %s.%s ]\n",
2d4f2799 1292 data->path, timestamp);
3c1cb7e3 1293
03724b2e
AK
1294 if (rec->switch_output.num_files) {
1295 int n = rec->switch_output.cur_file + 1;
1296
1297 if (n >= rec->switch_output.num_files)
1298 n = 0;
1299 rec->switch_output.cur_file = n;
1300 if (rec->switch_output.filenames[n]) {
1301 remove(rec->switch_output.filenames[n]);
d8f9da24 1302 zfree(&rec->switch_output.filenames[n]);
03724b2e
AK
1303 }
1304 rec->switch_output.filenames[n] = new_filename;
1305 } else {
1306 free(new_filename);
1307 }
1308
3c1cb7e3 1309 /* Output tracking events */
be7b0c9e 1310 if (!at_exit) {
4ea648ae 1311 record__synthesize(rec, false);
3c1cb7e3 1312
be7b0c9e
WN
1313 /*
1314 * In 'perf record --switch-output' without -a,
1315 * record__synthesize() in record__switch_output() won't
1316 * generate tracking events because there's no thread_map
1317 * in evlist. Which causes newly created perf.data doesn't
1318 * contain map and comm information.
1319 * Create a fake thread_map and directly call
1320 * perf_event__synthesize_thread_map() for those events.
1321 */
1322 if (target__none(&rec->opts.target))
4ea648ae 1323 record__synthesize_workload(rec, false);
be7b0c9e 1324 }
ecfd7a9c
WN
1325 return fd;
1326}
1327
f33cbe72
ACM
1328static volatile int workload_exec_errno;
1329
1330/*
1331 * perf_evlist__prepare_workload will send a SIGUSR1
1332 * if the fork fails, since we asked by setting its
1333 * want_signal to true.
1334 */
45604710
NK
1335static void workload_exec_failed_signal(int signo __maybe_unused,
1336 siginfo_t *info,
f33cbe72
ACM
1337 void *ucontext __maybe_unused)
1338{
1339 workload_exec_errno = info->si_value.sival_int;
1340 done = 1;
f33cbe72
ACM
1341 child_finished = 1;
1342}
1343
2dd6d8a1 1344static void snapshot_sig_handler(int sig);
bfacbe3b 1345static void alarm_sig_handler(int sig);
2dd6d8a1 1346
ee667f94 1347static const struct perf_event_mmap_page *
63503dba 1348perf_evlist__pick_pc(struct evlist *evlist)
ee667f94 1349{
b2cb615d 1350 if (evlist) {
547740f7
JO
1351 if (evlist->mmap && evlist->mmap[0].core.base)
1352 return evlist->mmap[0].core.base;
1353 if (evlist->overwrite_mmap && evlist->overwrite_mmap[0].core.base)
1354 return evlist->overwrite_mmap[0].core.base;
b2cb615d 1355 }
ee667f94
WN
1356 return NULL;
1357}
1358
c45628b0
WN
1359static const struct perf_event_mmap_page *record__pick_pc(struct record *rec)
1360{
ee667f94
WN
1361 const struct perf_event_mmap_page *pc;
1362
1363 pc = perf_evlist__pick_pc(rec->evlist);
1364 if (pc)
1365 return pc;
c45628b0
WN
1366 return NULL;
1367}
1368
4ea648ae 1369static int record__synthesize(struct record *rec, bool tail)
c45c86eb
WN
1370{
1371 struct perf_session *session = rec->session;
1372 struct machine *machine = &session->machines.host;
8ceb41d7 1373 struct perf_data *data = &rec->data;
c45c86eb
WN
1374 struct record_opts *opts = &rec->opts;
1375 struct perf_tool *tool = &rec->tool;
8ceb41d7 1376 int fd = perf_data__fd(data);
c45c86eb 1377 int err = 0;
d99c22ea 1378 event_op f = process_synthesized_event;
c45c86eb 1379
4ea648ae
WN
1380 if (rec->opts.tail_synthesize != tail)
1381 return 0;
1382
8ceb41d7 1383 if (data->is_pipe) {
a2015516
JO
1384 /*
1385 * We need to synthesize events first, because some
1386 * features works on top of them (on report side).
1387 */
318ec184 1388 err = perf_event__synthesize_attrs(tool, rec->evlist,
c45c86eb
WN
1389 process_synthesized_event);
1390 if (err < 0) {
1391 pr_err("Couldn't synthesize attrs.\n");
1392 goto out;
1393 }
1394
a2015516
JO
1395 err = perf_event__synthesize_features(tool, session, rec->evlist,
1396 process_synthesized_event);
1397 if (err < 0) {
1398 pr_err("Couldn't synthesize features.\n");
1399 return err;
1400 }
1401
ce9036a6 1402 if (have_tracepoints(&rec->evlist->core.entries)) {
c45c86eb
WN
1403 /*
1404 * FIXME err <= 0 here actually means that
1405 * there were no tracepoints so its not really
1406 * an error, just that we don't need to
1407 * synthesize anything. We really have to
1408 * return this more properly and also
1409 * propagate errors that now are calling die()
1410 */
1411 err = perf_event__synthesize_tracing_data(tool, fd, rec->evlist,
1412 process_synthesized_event);
1413 if (err <= 0) {
1414 pr_err("Couldn't record tracing data.\n");
1415 goto out;
1416 }
1417 rec->bytes_written += err;
1418 }
1419 }
1420
c45628b0 1421 err = perf_event__synth_time_conv(record__pick_pc(rec), tool,
46bc29b9
AH
1422 process_synthesized_event, machine);
1423 if (err)
1424 goto out;
1425
c0a6de06
AH
1426 /* Synthesize id_index before auxtrace_info */
1427 if (rec->opts.auxtrace_sample_mode) {
1428 err = perf_event__synthesize_id_index(tool,
1429 process_synthesized_event,
1430 session->evlist, machine);
1431 if (err)
1432 goto out;
1433 }
1434
c45c86eb
WN
1435 if (rec->opts.full_auxtrace) {
1436 err = perf_event__synthesize_auxtrace_info(rec->itr, tool,
1437 session, process_synthesized_event);
1438 if (err)
1439 goto out;
1440 }
1441
6c443954
ACM
1442 if (!perf_evlist__exclude_kernel(rec->evlist)) {
1443 err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
1444 machine);
1445 WARN_ONCE(err < 0, "Couldn't record kernel reference relocation symbol\n"
1446 "Symbol resolution may be skewed if relocation was used (e.g. kexec).\n"
1447 "Check /proc/kallsyms permission or run as root.\n");
1448
1449 err = perf_event__synthesize_modules(tool, process_synthesized_event,
1450 machine);
1451 WARN_ONCE(err < 0, "Couldn't record kernel module information.\n"
1452 "Symbol resolution may be skewed if relocation was used (e.g. kexec).\n"
1453 "Check /proc/modules permission or run as root.\n");
1454 }
c45c86eb
WN
1455
1456 if (perf_guest) {
1457 machines__process_guests(&session->machines,
1458 perf_event__synthesize_guest_os, tool);
1459 }
1460
bfd8f72c
AK
1461 err = perf_event__synthesize_extra_attr(&rec->tool,
1462 rec->evlist,
1463 process_synthesized_event,
1464 data->is_pipe);
1465 if (err)
1466 goto out;
1467
03617c22 1468 err = perf_event__synthesize_thread_map2(&rec->tool, rec->evlist->core.threads,
373565d2
AK
1469 process_synthesized_event,
1470 NULL);
1471 if (err < 0) {
1472 pr_err("Couldn't synthesize thread map.\n");
1473 return err;
1474 }
1475
f72f901d 1476 err = perf_event__synthesize_cpu_map(&rec->tool, rec->evlist->core.cpus,
373565d2
AK
1477 process_synthesized_event, NULL);
1478 if (err < 0) {
1479 pr_err("Couldn't synthesize cpu map.\n");
1480 return err;
1481 }
1482
e5416950 1483 err = perf_event__synthesize_bpf_events(session, process_synthesized_event,
7b612e29
SL
1484 machine, opts);
1485 if (err < 0)
1486 pr_warning("Couldn't synthesize bpf events.\n");
1487
ab64069f
NK
1488 err = perf_event__synthesize_cgroups(tool, process_synthesized_event,
1489 machine);
1490 if (err < 0)
1491 pr_warning("Couldn't synthesize cgroup events.\n");
1492
d99c22ea
SE
1493 if (rec->opts.nr_threads_synthesize > 1) {
1494 perf_set_multithreaded();
1495 f = process_locked_synthesized_event;
1496 }
1497
03617c22 1498 err = __machine__synthesize_threads(machine, tool, &opts->target, rec->evlist->core.threads,
d99c22ea
SE
1499 f, opts->sample_address,
1500 rec->opts.nr_threads_synthesize);
1501
1502 if (rec->opts.nr_threads_synthesize > 1)
1503 perf_set_singlethreaded();
1504
c45c86eb
WN
1505out:
1506 return err;
1507}
1508
899e5ffb
ACM
1509static int record__process_signal_event(union perf_event *event __maybe_unused, void *data)
1510{
1511 struct record *rec = data;
1512 pthread_kill(rec->thread_id, SIGUSR2);
1513 return 0;
1514}
1515
23cbb41c
ACM
1516static int record__setup_sb_evlist(struct record *rec)
1517{
1518 struct record_opts *opts = &rec->opts;
1519
1520 if (rec->sb_evlist != NULL) {
1521 /*
1522 * We get here if --switch-output-event populated the
1523 * sb_evlist, so associate a callback that will send a SIGUSR2
1524 * to the main thread.
1525 */
1526 evlist__set_cb(rec->sb_evlist, record__process_signal_event, rec);
1527 rec->thread_id = pthread_self();
1528 }
1529
1530 if (!opts->no_bpf_event) {
1531 if (rec->sb_evlist == NULL) {
1532 rec->sb_evlist = evlist__new();
1533
1534 if (rec->sb_evlist == NULL) {
1535 pr_err("Couldn't create side band evlist.\n.");
1536 return -1;
1537 }
1538 }
1539
1540 if (evlist__add_bpf_sb_event(rec->sb_evlist, &rec->session->header.env)) {
1541 pr_err("Couldn't ask for PERF_RECORD_BPF_EVENT side band events.\n.");
1542 return -1;
1543 }
1544 }
1545
1546 if (perf_evlist__start_sb_thread(rec->sb_evlist, &rec->opts.target)) {
1547 pr_debug("Couldn't start the BPF side band thread:\nBPF programs starting from now on won't be annotatable\n");
1548 opts->no_bpf_event = true;
1549 }
1550
1551 return 0;
1552}
1553
8c6f45a7 1554static int __cmd_record(struct record *rec, int argc, const char **argv)
16c8a109 1555{
57706abc 1556 int err;
45604710 1557 int status = 0;
8b412664 1558 unsigned long waking = 0;
46be604b 1559 const bool forks = argc > 0;
45694aa7 1560 struct perf_tool *tool = &rec->tool;
b4006796 1561 struct record_opts *opts = &rec->opts;
8ceb41d7 1562 struct perf_data *data = &rec->data;
d20deb64 1563 struct perf_session *session;
6dcf45ef 1564 bool disabled = false, draining = false;
42aa276f 1565 int fd;
d3c8c08e 1566 float ratio = 0;
acce0223 1567 enum evlist_ctl_cmd cmd = EVLIST_CTL_CMD_UNSUPPORTED;
de9ac07b 1568
45604710 1569 atexit(record__sig_exit);
f5970550
PZ
1570 signal(SIGCHLD, sig_handler);
1571 signal(SIGINT, sig_handler);
804f7ac7 1572 signal(SIGTERM, sig_handler);
a074865e 1573 signal(SIGSEGV, sigsegv_handler);
c0bdc1c4 1574
f3b3614a
HB
1575 if (rec->opts.record_namespaces)
1576 tool->namespace_events = true;
1577
8fb4b679
NK
1578 if (rec->opts.record_cgroup) {
1579#ifdef HAVE_FILE_HANDLE
1580 tool->cgroup_events = true;
1581#else
1582 pr_err("cgroup tracking is not supported\n");
1583 return -1;
1584#endif
1585 }
1586
dc0c6127 1587 if (rec->opts.auxtrace_snapshot_mode || rec->switch_output.enabled) {
2dd6d8a1 1588 signal(SIGUSR2, snapshot_sig_handler);
3c1cb7e3
WN
1589 if (rec->opts.auxtrace_snapshot_mode)
1590 trigger_on(&auxtrace_snapshot_trigger);
dc0c6127 1591 if (rec->switch_output.enabled)
3c1cb7e3 1592 trigger_on(&switch_output_trigger);
c0bdc1c4 1593 } else {
2dd6d8a1 1594 signal(SIGUSR2, SIG_IGN);
c0bdc1c4 1595 }
f5970550 1596
8ceb41d7 1597 session = perf_session__new(data, false, tool);
6ef81c55 1598 if (IS_ERR(session)) {
ffa91880 1599 pr_err("Perf session creation failed.\n");
6ef81c55 1600 return PTR_ERR(session);
a9a70bbc
ACM
1601 }
1602
8ceb41d7 1603 fd = perf_data__fd(data);
d20deb64
ACM
1604 rec->session = session;
1605
5d7f4116
AB
1606 if (zstd_init(&session->zstd_data, rec->opts.comp_level) < 0) {
1607 pr_err("Compression initialization failed.\n");
1608 return -1;
1609 }
da231338
AM
1610#ifdef HAVE_EVENTFD_SUPPORT
1611 done_fd = eventfd(0, EFD_NONBLOCK);
1612 if (done_fd < 0) {
1613 pr_err("Failed to create wakeup eventfd, error: %m\n");
1614 status = -1;
1615 goto out_delete_session;
1616 }
1617 err = evlist__add_pollfd(rec->evlist, done_fd);
1618 if (err < 0) {
1619 pr_err("Failed to add wakeup eventfd to poll list\n");
1620 status = err;
1621 goto out_delete_session;
1622 }
1623#endif // HAVE_EVENTFD_SUPPORT
5d7f4116
AB
1624
1625 session->header.env.comp_type = PERF_COMP_ZSTD;
1626 session->header.env.comp_level = rec->opts.comp_level;
1627
eeb399b5
AH
1628 if (rec->opts.kcore &&
1629 !record__kcore_readable(&session->machines.host)) {
1630 pr_err("ERROR: kcore is not readable.\n");
1631 return -1;
1632 }
1633
8c6f45a7 1634 record__init_features(rec);
330aa675 1635
cf790516
AB
1636 if (rec->opts.use_clockid && rec->opts.clockid_res_ns)
1637 session->header.env.clockid_res_ns = rec->opts.clockid_res_ns;
1638
d4db3f16 1639 if (forks) {
3e2be2da 1640 err = perf_evlist__prepare_workload(rec->evlist, &opts->target,
8ceb41d7 1641 argv, data->is_pipe,
735f7e0b 1642 workload_exec_failed_signal);
35b9d88e
ACM
1643 if (err < 0) {
1644 pr_err("Couldn't run the workload!\n");
45604710 1645 status = err;
35b9d88e 1646 goto out_delete_session;
856e9660 1647 }
856e9660
PZ
1648 }
1649
ad46e48c
JO
1650 /*
1651 * If we have just single event and are sending data
1652 * through pipe, we need to force the ids allocation,
1653 * because we synthesize event name through the pipe
1654 * and need the id for that.
1655 */
6484d2f9 1656 if (data->is_pipe && rec->evlist->core.nr_entries == 1)
ad46e48c
JO
1657 rec->opts.sample_id = true;
1658
8c6f45a7 1659 if (record__open(rec) != 0) {
8d3eca20 1660 err = -1;
45604710 1661 goto out_child;
8d3eca20 1662 }
f6fa4375 1663 session->header.env.comp_mmap_len = session->evlist->core.mmap_len;
de9ac07b 1664
eeb399b5
AH
1665 if (rec->opts.kcore) {
1666 err = record__kcore_copy(&session->machines.host, data);
1667 if (err) {
1668 pr_err("ERROR: Failed to copy kcore\n");
1669 goto out_child;
1670 }
1671 }
1672
8690a2a7
WN
1673 err = bpf__apply_obj_config();
1674 if (err) {
1675 char errbuf[BUFSIZ];
1676
1677 bpf__strerror_apply_obj_config(err, errbuf, sizeof(errbuf));
1678 pr_err("ERROR: Apply config to BPF failed: %s\n",
1679 errbuf);
1680 goto out_child;
1681 }
1682
cca8482c
AH
1683 /*
1684 * Normally perf_session__new would do this, but it doesn't have the
1685 * evlist.
1686 */
8cedf3a5 1687 if (rec->tool.ordered_events && !evlist__sample_id_all(rec->evlist)) {
cca8482c
AH
1688 pr_warning("WARNING: No sample_id_all support, falling back to unordered processing\n");
1689 rec->tool.ordered_events = false;
1690 }
1691
3e2be2da 1692 if (!rec->evlist->nr_groups)
a8bb559b
NK
1693 perf_header__clear_feat(&session->header, HEADER_GROUP_DESC);
1694
8ceb41d7 1695 if (data->is_pipe) {
42aa276f 1696 err = perf_header__write_pipe(fd);
529870e3 1697 if (err < 0)
45604710 1698 goto out_child;
563aecb2 1699 } else {
42aa276f 1700 err = perf_session__write_header(session, rec->evlist, fd, false);
d5eed904 1701 if (err < 0)
45604710 1702 goto out_child;
56b03f3c
ACM
1703 }
1704
b38d85ef 1705 err = -1;
d3665498 1706 if (!rec->no_buildid
e20960c0 1707 && !perf_header__has_feat(&session->header, HEADER_BUILD_ID)) {
d3665498 1708 pr_err("Couldn't generate buildids. "
e20960c0 1709 "Use --no-buildid to profile anyway.\n");
45604710 1710 goto out_child;
e20960c0
RR
1711 }
1712
23cbb41c
ACM
1713 err = record__setup_sb_evlist(rec);
1714 if (err)
1715 goto out_child;
657ee553 1716
4ea648ae 1717 err = record__synthesize(rec, false);
c45c86eb 1718 if (err < 0)
45604710 1719 goto out_child;
8d3eca20 1720
d20deb64 1721 if (rec->realtime_prio) {
de9ac07b
PZ
1722 struct sched_param param;
1723
d20deb64 1724 param.sched_priority = rec->realtime_prio;
de9ac07b 1725 if (sched_setscheduler(0, SCHED_FIFO, &param)) {
6beba7ad 1726 pr_err("Could not set realtime priority.\n");
8d3eca20 1727 err = -1;
45604710 1728 goto out_child;
de9ac07b
PZ
1729 }
1730 }
1731
774cb499
JO
1732 /*
1733 * When perf is starting the traced process, all the events
1734 * (apart from group members) have enable_on_exec=1 set,
1735 * so don't spoil it by prematurely enabling them.
1736 */
6619a53e 1737 if (!target__none(&opts->target) && !opts->initial_delay)
1c87f165 1738 evlist__enable(rec->evlist);
764e16a3 1739
856e9660
PZ
1740 /*
1741 * Let the child rip
1742 */
e803cf97 1743 if (forks) {
20a8a3cf 1744 struct machine *machine = &session->machines.host;
e5bed564 1745 union perf_event *event;
e907caf3 1746 pid_t tgid;
e5bed564
NK
1747
1748 event = malloc(sizeof(event->comm) + machine->id_hdr_size);
1749 if (event == NULL) {
1750 err = -ENOMEM;
1751 goto out_child;
1752 }
1753
e803cf97
NK
1754 /*
1755 * Some H/W events are generated before COMM event
1756 * which is emitted during exec(), so perf script
1757 * cannot see a correct process name for those events.
1758 * Synthesize COMM event to prevent it.
1759 */
e907caf3
HB
1760 tgid = perf_event__synthesize_comm(tool, event,
1761 rec->evlist->workload.pid,
1762 process_synthesized_event,
1763 machine);
1764 free(event);
1765
1766 if (tgid == -1)
1767 goto out_child;
1768
1769 event = malloc(sizeof(event->namespaces) +
1770 (NR_NAMESPACES * sizeof(struct perf_ns_link_info)) +
1771 machine->id_hdr_size);
1772 if (event == NULL) {
1773 err = -ENOMEM;
1774 goto out_child;
1775 }
1776
1777 /*
1778 * Synthesize NAMESPACES event for the command specified.
1779 */
1780 perf_event__synthesize_namespaces(tool, event,
1781 rec->evlist->workload.pid,
1782 tgid, process_synthesized_event,
1783 machine);
e5bed564 1784 free(event);
e803cf97 1785
3e2be2da 1786 perf_evlist__start_workload(rec->evlist);
e803cf97 1787 }
856e9660 1788
6619a53e 1789 if (opts->initial_delay) {
68cd3b45
AB
1790 pr_info(EVLIST_DISABLED_MSG);
1791 if (opts->initial_delay > 0) {
1792 usleep(opts->initial_delay * USEC_PER_MSEC);
1793 evlist__enable(rec->evlist);
1794 pr_info(EVLIST_ENABLED_MSG);
1795 }
6619a53e
AK
1796 }
1797
5f9cf599 1798 trigger_ready(&auxtrace_snapshot_trigger);
3c1cb7e3 1799 trigger_ready(&switch_output_trigger);
a074865e 1800 perf_hooks__invoke_record_start();
649c48a9 1801 for (;;) {
9f065194 1802 unsigned long long hits = rec->samples;
de9ac07b 1803
05737464
WN
1804 /*
1805 * rec->evlist->bkw_mmap_state is possible to be
1806 * BKW_MMAP_EMPTY here: when done == true and
1807 * hits != rec->samples in previous round.
1808 *
1809 * perf_evlist__toggle_bkw_mmap ensure we never
1810 * convert BKW_MMAP_EMPTY to BKW_MMAP_DATA_PENDING.
1811 */
1812 if (trigger_is_hit(&switch_output_trigger) || done || draining)
1813 perf_evlist__toggle_bkw_mmap(rec->evlist, BKW_MMAP_DATA_PENDING);
1814
470530bb 1815 if (record__mmap_read_all(rec, false) < 0) {
5f9cf599 1816 trigger_error(&auxtrace_snapshot_trigger);
3c1cb7e3 1817 trigger_error(&switch_output_trigger);
8d3eca20 1818 err = -1;
45604710 1819 goto out_child;
8d3eca20 1820 }
de9ac07b 1821
2dd6d8a1
AH
1822 if (auxtrace_record__snapshot_started) {
1823 auxtrace_record__snapshot_started = 0;
5f9cf599 1824 if (!trigger_is_error(&auxtrace_snapshot_trigger))
ce7b0e42 1825 record__read_auxtrace_snapshot(rec, false);
5f9cf599 1826 if (trigger_is_error(&auxtrace_snapshot_trigger)) {
2dd6d8a1
AH
1827 pr_err("AUX area tracing snapshot failed\n");
1828 err = -1;
1829 goto out_child;
1830 }
1831 }
1832
3c1cb7e3 1833 if (trigger_is_hit(&switch_output_trigger)) {
05737464
WN
1834 /*
1835 * If switch_output_trigger is hit, the data in
1836 * overwritable ring buffer should have been collected,
1837 * so bkw_mmap_state should be set to BKW_MMAP_EMPTY.
1838 *
1839 * If SIGUSR2 raise after or during record__mmap_read_all(),
1840 * record__mmap_read_all() didn't collect data from
1841 * overwritable ring buffer. Read again.
1842 */
1843 if (rec->evlist->bkw_mmap_state == BKW_MMAP_RUNNING)
1844 continue;
3c1cb7e3
WN
1845 trigger_ready(&switch_output_trigger);
1846
05737464
WN
1847 /*
1848 * Reenable events in overwrite ring buffer after
1849 * record__mmap_read_all(): we should have collected
1850 * data from it.
1851 */
1852 perf_evlist__toggle_bkw_mmap(rec->evlist, BKW_MMAP_RUNNING);
1853
3c1cb7e3
WN
1854 if (!quiet)
1855 fprintf(stderr, "[ perf record: dump data: Woken up %ld times ]\n",
1856 waking);
1857 waking = 0;
1858 fd = record__switch_output(rec, false);
1859 if (fd < 0) {
1860 pr_err("Failed to switch to new file\n");
1861 trigger_error(&switch_output_trigger);
1862 err = fd;
1863 goto out_child;
1864 }
bfacbe3b
JO
1865
1866 /* re-arm the alarm */
1867 if (rec->switch_output.time)
1868 alarm(rec->switch_output.time);
3c1cb7e3
WN
1869 }
1870
d20deb64 1871 if (hits == rec->samples) {
6dcf45ef 1872 if (done || draining)
649c48a9 1873 break;
80ab2987 1874 err = evlist__poll(rec->evlist, -1);
a515114f
JO
1875 /*
1876 * Propagate error, only if there's any. Ignore positive
1877 * number of returned events and interrupt error.
1878 */
1879 if (err > 0 || (err < 0 && errno == EINTR))
45604710 1880 err = 0;
8b412664 1881 waking++;
6dcf45ef 1882
f4009e7b 1883 if (evlist__filter_pollfd(rec->evlist, POLLERR | POLLHUP) == 0)
6dcf45ef 1884 draining = true;
8b412664
PZ
1885 }
1886
acce0223
AB
1887 if (evlist__ctlfd_process(rec->evlist, &cmd) > 0) {
1888 switch (cmd) {
1889 case EVLIST_CTL_CMD_ENABLE:
1890 pr_info(EVLIST_ENABLED_MSG);
1891 break;
1892 case EVLIST_CTL_CMD_DISABLE:
1893 pr_info(EVLIST_DISABLED_MSG);
1894 break;
1895 case EVLIST_CTL_CMD_ACK:
1896 case EVLIST_CTL_CMD_UNSUPPORTED:
1897 default:
1898 break;
1899 }
1900 }
1901
774cb499
JO
1902 /*
1903 * When perf is starting the traced process, at the end events
1904 * die with the process and we wait for that. Thus no need to
1905 * disable events in this case.
1906 */
602ad878 1907 if (done && !disabled && !target__none(&opts->target)) {
5f9cf599 1908 trigger_off(&auxtrace_snapshot_trigger);
e74676de 1909 evlist__disable(rec->evlist);
2711926a
JO
1910 disabled = true;
1911 }
de9ac07b 1912 }
ce7b0e42 1913
5f9cf599 1914 trigger_off(&auxtrace_snapshot_trigger);
3c1cb7e3 1915 trigger_off(&switch_output_trigger);
de9ac07b 1916
ce7b0e42
AS
1917 if (opts->auxtrace_snapshot_on_exit)
1918 record__auxtrace_snapshot_exit(rec);
1919
f33cbe72 1920 if (forks && workload_exec_errno) {
35550da3 1921 char msg[STRERR_BUFSIZE];
c8b5f2c9 1922 const char *emsg = str_error_r(workload_exec_errno, msg, sizeof(msg));
f33cbe72
ACM
1923 pr_err("Workload failed: %s\n", emsg);
1924 err = -1;
45604710 1925 goto out_child;
f33cbe72
ACM
1926 }
1927
e3d59112 1928 if (!quiet)
45604710 1929 fprintf(stderr, "[ perf record: Woken up %ld times to write data ]\n", waking);
b44308f5 1930
4ea648ae
WN
1931 if (target__none(&rec->opts.target))
1932 record__synthesize_workload(rec, true);
1933
45604710 1934out_child:
470530bb 1935 record__mmap_read_all(rec, true);
d3d1af6f
AB
1936 record__aio_mmap_read_sync(rec);
1937
d3c8c08e
AB
1938 if (rec->session->bytes_transferred && rec->session->bytes_compressed) {
1939 ratio = (float)rec->session->bytes_transferred/(float)rec->session->bytes_compressed;
1940 session->header.env.comp_ratio = ratio + 0.5;
1941 }
1942
45604710
NK
1943 if (forks) {
1944 int exit_status;
addc2785 1945
45604710
NK
1946 if (!child_finished)
1947 kill(rec->evlist->workload.pid, SIGTERM);
1948
1949 wait(&exit_status);
1950
1951 if (err < 0)
1952 status = err;
1953 else if (WIFEXITED(exit_status))
1954 status = WEXITSTATUS(exit_status);
1955 else if (WIFSIGNALED(exit_status))
1956 signr = WTERMSIG(exit_status);
1957 } else
1958 status = err;
1959
4ea648ae 1960 record__synthesize(rec, true);
e3d59112
NK
1961 /* this will be recalculated during process_buildids() */
1962 rec->samples = 0;
1963
ecfd7a9c
WN
1964 if (!err) {
1965 if (!rec->timestamp_filename) {
1966 record__finish_output(rec);
1967 } else {
1968 fd = record__switch_output(rec, true);
1969 if (fd < 0) {
1970 status = fd;
1971 goto out_delete_session;
1972 }
1973 }
1974 }
39d17dac 1975
a074865e
WN
1976 perf_hooks__invoke_record_end();
1977
e3d59112
NK
1978 if (!err && !quiet) {
1979 char samples[128];
ecfd7a9c
WN
1980 const char *postfix = rec->timestamp_filename ?
1981 ".<timestamp>" : "";
e3d59112 1982
ef149c25 1983 if (rec->samples && !rec->opts.full_auxtrace)
e3d59112
NK
1984 scnprintf(samples, sizeof(samples),
1985 " (%" PRIu64 " samples)", rec->samples);
1986 else
1987 samples[0] = '\0';
1988
d3c8c08e 1989 fprintf(stderr, "[ perf record: Captured and wrote %.3f MB %s%s%s",
8ceb41d7 1990 perf_data__size(data) / 1024.0 / 1024.0,
2d4f2799 1991 data->path, postfix, samples);
d3c8c08e
AB
1992 if (ratio) {
1993 fprintf(stderr, ", compressed (original %.3f MB, ratio is %.3f)",
1994 rec->session->bytes_transferred / 1024.0 / 1024.0,
1995 ratio);
1996 }
1997 fprintf(stderr, " ]\n");
e3d59112
NK
1998 }
1999
39d17dac 2000out_delete_session:
da231338
AM
2001#ifdef HAVE_EVENTFD_SUPPORT
2002 if (done_fd >= 0)
2003 close(done_fd);
2004#endif
5d7f4116 2005 zstd_fini(&session->zstd_data);
39d17dac 2006 perf_session__delete(session);
657ee553
SL
2007
2008 if (!opts->no_bpf_event)
bc477d79 2009 perf_evlist__stop_sb_thread(rec->sb_evlist);
45604710 2010 return status;
de9ac07b 2011}
0e9b20b8 2012
0883e820 2013static void callchain_debug(struct callchain_param *callchain)
09b0fd45 2014{
aad2b21c 2015 static const char *str[CALLCHAIN_MAX] = { "NONE", "FP", "DWARF", "LBR" };
a601fdff 2016
0883e820 2017 pr_debug("callchain: type %s\n", str[callchain->record_mode]);
26d33022 2018
0883e820 2019 if (callchain->record_mode == CALLCHAIN_DWARF)
09b0fd45 2020 pr_debug("callchain: stack dump size %d\n",
0883e820 2021 callchain->dump_size);
09b0fd45
JO
2022}
2023
0883e820
ACM
2024int record_opts__parse_callchain(struct record_opts *record,
2025 struct callchain_param *callchain,
2026 const char *arg, bool unset)
09b0fd45 2027{
09b0fd45 2028 int ret;
0883e820 2029 callchain->enabled = !unset;
eb853e80 2030
09b0fd45
JO
2031 /* --no-call-graph */
2032 if (unset) {
0883e820 2033 callchain->record_mode = CALLCHAIN_NONE;
09b0fd45
JO
2034 pr_debug("callchain: disabled\n");
2035 return 0;
2036 }
2037
0883e820 2038 ret = parse_callchain_record_opt(arg, callchain);
5c0cf224
JO
2039 if (!ret) {
2040 /* Enable data address sampling for DWARF unwind. */
0883e820 2041 if (callchain->record_mode == CALLCHAIN_DWARF)
5c0cf224 2042 record->sample_address = true;
0883e820 2043 callchain_debug(callchain);
5c0cf224 2044 }
26d33022
JO
2045
2046 return ret;
2047}
2048
0883e820
ACM
2049int record_parse_callchain_opt(const struct option *opt,
2050 const char *arg,
2051 int unset)
2052{
2053 return record_opts__parse_callchain(opt->value, &callchain_param, arg, unset);
2054}
2055
c421e80b 2056int record_callchain_opt(const struct option *opt,
09b0fd45
JO
2057 const char *arg __maybe_unused,
2058 int unset __maybe_unused)
2059{
2ddd5c04 2060 struct callchain_param *callchain = opt->value;
c421e80b 2061
2ddd5c04 2062 callchain->enabled = true;
09b0fd45 2063
2ddd5c04
ACM
2064 if (callchain->record_mode == CALLCHAIN_NONE)
2065 callchain->record_mode = CALLCHAIN_FP;
eb853e80 2066
2ddd5c04 2067 callchain_debug(callchain);
09b0fd45
JO
2068 return 0;
2069}
2070
eb853e80
JO
2071static int perf_record_config(const char *var, const char *value, void *cb)
2072{
7a29c087
NK
2073 struct record *rec = cb;
2074
2075 if (!strcmp(var, "record.build-id")) {
2076 if (!strcmp(value, "cache"))
2077 rec->no_buildid_cache = false;
2078 else if (!strcmp(value, "no-cache"))
2079 rec->no_buildid_cache = true;
2080 else if (!strcmp(value, "skip"))
2081 rec->no_buildid = true;
2082 else
2083 return -1;
2084 return 0;
2085 }
cff17205
YX
2086 if (!strcmp(var, "record.call-graph")) {
2087 var = "call-graph.record-mode";
2088 return perf_default_config(var, value, cb);
2089 }
93f20c0f
AB
2090#ifdef HAVE_AIO_SUPPORT
2091 if (!strcmp(var, "record.aio")) {
2092 rec->opts.nr_cblocks = strtol(value, NULL, 0);
2093 if (!rec->opts.nr_cblocks)
2094 rec->opts.nr_cblocks = nr_cblocks_default;
2095 }
2096#endif
eb853e80 2097
cff17205 2098 return 0;
eb853e80
JO
2099}
2100
814c8c38
PZ
2101struct clockid_map {
2102 const char *name;
2103 int clockid;
2104};
2105
2106#define CLOCKID_MAP(n, c) \
2107 { .name = n, .clockid = (c), }
2108
2109#define CLOCKID_END { .name = NULL, }
2110
2111
2112/*
2113 * Add the missing ones, we need to build on many distros...
2114 */
2115#ifndef CLOCK_MONOTONIC_RAW
2116#define CLOCK_MONOTONIC_RAW 4
2117#endif
2118#ifndef CLOCK_BOOTTIME
2119#define CLOCK_BOOTTIME 7
2120#endif
2121#ifndef CLOCK_TAI
2122#define CLOCK_TAI 11
2123#endif
2124
2125static const struct clockid_map clockids[] = {
2126 /* available for all events, NMI safe */
2127 CLOCKID_MAP("monotonic", CLOCK_MONOTONIC),
2128 CLOCKID_MAP("monotonic_raw", CLOCK_MONOTONIC_RAW),
2129
2130 /* available for some events */
2131 CLOCKID_MAP("realtime", CLOCK_REALTIME),
2132 CLOCKID_MAP("boottime", CLOCK_BOOTTIME),
2133 CLOCKID_MAP("tai", CLOCK_TAI),
2134
2135 /* available for the lazy */
2136 CLOCKID_MAP("mono", CLOCK_MONOTONIC),
2137 CLOCKID_MAP("raw", CLOCK_MONOTONIC_RAW),
2138 CLOCKID_MAP("real", CLOCK_REALTIME),
2139 CLOCKID_MAP("boot", CLOCK_BOOTTIME),
2140
2141 CLOCKID_END,
2142};
2143
cf790516
AB
2144static int get_clockid_res(clockid_t clk_id, u64 *res_ns)
2145{
2146 struct timespec res;
2147
2148 *res_ns = 0;
2149 if (!clock_getres(clk_id, &res))
2150 *res_ns = res.tv_nsec + res.tv_sec * NSEC_PER_SEC;
2151 else
2152 pr_warning("WARNING: Failed to determine specified clock resolution.\n");
2153
2154 return 0;
2155}
2156
814c8c38
PZ
2157static int parse_clockid(const struct option *opt, const char *str, int unset)
2158{
2159 struct record_opts *opts = (struct record_opts *)opt->value;
2160 const struct clockid_map *cm;
2161 const char *ostr = str;
2162
2163 if (unset) {
2164 opts->use_clockid = 0;
2165 return 0;
2166 }
2167
2168 /* no arg passed */
2169 if (!str)
2170 return 0;
2171
2172 /* no setting it twice */
2173 if (opts->use_clockid)
2174 return -1;
2175
2176 opts->use_clockid = true;
2177
2178 /* if its a number, we're done */
2179 if (sscanf(str, "%d", &opts->clockid) == 1)
cf790516 2180 return get_clockid_res(opts->clockid, &opts->clockid_res_ns);
814c8c38
PZ
2181
2182 /* allow a "CLOCK_" prefix to the name */
2183 if (!strncasecmp(str, "CLOCK_", 6))
2184 str += 6;
2185
2186 for (cm = clockids; cm->name; cm++) {
2187 if (!strcasecmp(str, cm->name)) {
2188 opts->clockid = cm->clockid;
cf790516
AB
2189 return get_clockid_res(opts->clockid,
2190 &opts->clockid_res_ns);
814c8c38
PZ
2191 }
2192 }
2193
2194 opts->use_clockid = false;
2195 ui__warning("unknown clockid %s, check man page\n", ostr);
2196 return -1;
2197}
2198
f4fe11b7
AB
2199static int record__parse_affinity(const struct option *opt, const char *str, int unset)
2200{
2201 struct record_opts *opts = (struct record_opts *)opt->value;
2202
2203 if (unset || !str)
2204 return 0;
2205
2206 if (!strcasecmp(str, "node"))
2207 opts->affinity = PERF_AFFINITY_NODE;
2208 else if (!strcasecmp(str, "cpu"))
2209 opts->affinity = PERF_AFFINITY_CPU;
2210
2211 return 0;
2212}
2213
6d575816
JS
2214static int parse_output_max_size(const struct option *opt,
2215 const char *str, int unset)
2216{
2217 unsigned long *s = (unsigned long *)opt->value;
2218 static struct parse_tag tags_size[] = {
2219 { .tag = 'B', .mult = 1 },
2220 { .tag = 'K', .mult = 1 << 10 },
2221 { .tag = 'M', .mult = 1 << 20 },
2222 { .tag = 'G', .mult = 1 << 30 },
2223 { .tag = 0 },
2224 };
2225 unsigned long val;
2226
2227 if (unset) {
2228 *s = 0;
2229 return 0;
2230 }
2231
2232 val = parse_tag_value(str, tags_size);
2233 if (val != (unsigned long) -1) {
2234 *s = val;
2235 return 0;
2236 }
2237
2238 return -1;
2239}
2240
e9db1310
AH
2241static int record__parse_mmap_pages(const struct option *opt,
2242 const char *str,
2243 int unset __maybe_unused)
2244{
2245 struct record_opts *opts = opt->value;
2246 char *s, *p;
2247 unsigned int mmap_pages;
2248 int ret;
2249
2250 if (!str)
2251 return -EINVAL;
2252
2253 s = strdup(str);
2254 if (!s)
2255 return -ENOMEM;
2256
2257 p = strchr(s, ',');
2258 if (p)
2259 *p = '\0';
2260
2261 if (*s) {
2262 ret = __perf_evlist__parse_mmap_pages(&mmap_pages, s);
2263 if (ret)
2264 goto out_free;
2265 opts->mmap_pages = mmap_pages;
2266 }
2267
2268 if (!p) {
2269 ret = 0;
2270 goto out_free;
2271 }
2272
2273 ret = __perf_evlist__parse_mmap_pages(&mmap_pages, p + 1);
2274 if (ret)
2275 goto out_free;
2276
2277 opts->auxtrace_mmap_pages = mmap_pages;
2278
2279out_free:
2280 free(s);
2281 return ret;
2282}
2283
0c582449
JO
2284static void switch_output_size_warn(struct record *rec)
2285{
9521b5f2 2286 u64 wakeup_size = evlist__mmap_size(rec->opts.mmap_pages);
0c582449
JO
2287 struct switch_output *s = &rec->switch_output;
2288
2289 wakeup_size /= 2;
2290
2291 if (s->size < wakeup_size) {
2292 char buf[100];
2293
2294 unit_number__scnprintf(buf, sizeof(buf), wakeup_size);
2295 pr_warning("WARNING: switch-output data size lower than "
2296 "wakeup kernel buffer size (%s) "
2297 "expect bigger perf.data sizes\n", buf);
2298 }
2299}
2300
cb4e1ebb
JO
2301static int switch_output_setup(struct record *rec)
2302{
2303 struct switch_output *s = &rec->switch_output;
dc0c6127
JO
2304 static struct parse_tag tags_size[] = {
2305 { .tag = 'B', .mult = 1 },
2306 { .tag = 'K', .mult = 1 << 10 },
2307 { .tag = 'M', .mult = 1 << 20 },
2308 { .tag = 'G', .mult = 1 << 30 },
2309 { .tag = 0 },
2310 };
bfacbe3b
JO
2311 static struct parse_tag tags_time[] = {
2312 { .tag = 's', .mult = 1 },
2313 { .tag = 'm', .mult = 60 },
2314 { .tag = 'h', .mult = 60*60 },
2315 { .tag = 'd', .mult = 60*60*24 },
2316 { .tag = 0 },
2317 };
dc0c6127 2318 unsigned long val;
cb4e1ebb 2319
899e5ffb
ACM
2320 /*
2321 * If we're using --switch-output-events, then we imply its
2322 * --switch-output=signal, as we'll send a SIGUSR2 from the side band
2323 * thread to its parent.
2324 */
2325 if (rec->switch_output_event_set)
2326 goto do_signal;
2327
cb4e1ebb
JO
2328 if (!s->set)
2329 return 0;
2330
2331 if (!strcmp(s->str, "signal")) {
899e5ffb 2332do_signal:
cb4e1ebb
JO
2333 s->signal = true;
2334 pr_debug("switch-output with SIGUSR2 signal\n");
dc0c6127
JO
2335 goto enabled;
2336 }
2337
2338 val = parse_tag_value(s->str, tags_size);
2339 if (val != (unsigned long) -1) {
2340 s->size = val;
2341 pr_debug("switch-output with %s size threshold\n", s->str);
2342 goto enabled;
cb4e1ebb
JO
2343 }
2344
bfacbe3b
JO
2345 val = parse_tag_value(s->str, tags_time);
2346 if (val != (unsigned long) -1) {
2347 s->time = val;
2348 pr_debug("switch-output with %s time threshold (%lu seconds)\n",
2349 s->str, s->time);
2350 goto enabled;
2351 }
2352
cb4e1ebb 2353 return -1;
dc0c6127
JO
2354
2355enabled:
2356 rec->timestamp_filename = true;
2357 s->enabled = true;
0c582449
JO
2358
2359 if (s->size && !rec->opts.no_buffering)
2360 switch_output_size_warn(rec);
2361
dc0c6127 2362 return 0;
cb4e1ebb
JO
2363}
2364
e5b2c207 2365static const char * const __record_usage[] = {
9e096753
MG
2366 "perf record [<options>] [<command>]",
2367 "perf record [<options>] -- <command> [<options>]",
0e9b20b8
IM
2368 NULL
2369};
e5b2c207 2370const char * const *record_usage = __record_usage;
0e9b20b8 2371
6e0a9b3d
ACM
2372static int build_id__process_mmap(struct perf_tool *tool, union perf_event *event,
2373 struct perf_sample *sample, struct machine *machine)
2374{
2375 /*
2376 * We already have the kernel maps, put in place via perf_session__create_kernel_maps()
2377 * no need to add them twice.
2378 */
2379 if (!(event->header.misc & PERF_RECORD_MISC_USER))
2380 return 0;
2381 return perf_event__process_mmap(tool, event, sample, machine);
2382}
2383
2384static int build_id__process_mmap2(struct perf_tool *tool, union perf_event *event,
2385 struct perf_sample *sample, struct machine *machine)
2386{
2387 /*
2388 * We already have the kernel maps, put in place via perf_session__create_kernel_maps()
2389 * no need to add them twice.
2390 */
2391 if (!(event->header.misc & PERF_RECORD_MISC_USER))
2392 return 0;
2393
2394 return perf_event__process_mmap2(tool, event, sample, machine);
2395}
2396
d20deb64 2397/*
8c6f45a7
ACM
2398 * XXX Ideally would be local to cmd_record() and passed to a record__new
2399 * because we need to have access to it in record__exit, that is called
d20deb64
ACM
2400 * after cmd_record() exits, but since record_options need to be accessible to
2401 * builtin-script, leave it here.
2402 *
2403 * At least we don't ouch it in all the other functions here directly.
2404 *
2405 * Just say no to tons of global variables, sigh.
2406 */
8c6f45a7 2407static struct record record = {
d20deb64 2408 .opts = {
8affc2b8 2409 .sample_time = true,
d20deb64
ACM
2410 .mmap_pages = UINT_MAX,
2411 .user_freq = UINT_MAX,
2412 .user_interval = ULLONG_MAX,
447a6013 2413 .freq = 4000,
d1cb9fce
NK
2414 .target = {
2415 .uses_mmap = true,
3aa5939d 2416 .default_per_cpu = true,
d1cb9fce 2417 },
470530bb 2418 .mmap_flush = MMAP_FLUSH_DEFAULT,
d99c22ea 2419 .nr_threads_synthesize = 1,
d20deb64 2420 },
e3d59112
NK
2421 .tool = {
2422 .sample = process_sample_event,
2423 .fork = perf_event__process_fork,
cca8482c 2424 .exit = perf_event__process_exit,
e3d59112 2425 .comm = perf_event__process_comm,
f3b3614a 2426 .namespaces = perf_event__process_namespaces,
6e0a9b3d
ACM
2427 .mmap = build_id__process_mmap,
2428 .mmap2 = build_id__process_mmap2,
cca8482c 2429 .ordered_events = true,
e3d59112 2430 },
d20deb64 2431};
7865e817 2432
76a26549
NK
2433const char record_callchain_help[] = CALLCHAIN_RECORD_HELP
2434 "\n\t\t\t\tDefault: fp";
61eaa3be 2435
0aab2136
WN
2436static bool dry_run;
2437
d20deb64
ACM
2438/*
2439 * XXX Will stay a global variable till we fix builtin-script.c to stop messing
2440 * with it and switch to use the library functions in perf_evlist that came
b4006796 2441 * from builtin-record.c, i.e. use record_opts,
d20deb64
ACM
2442 * perf_evlist__prepare_workload, etc instead of fork+exec'in 'perf record',
2443 * using pipes, etc.
2444 */
efd21307 2445static struct option __record_options[] = {
d20deb64 2446 OPT_CALLBACK('e', "event", &record.evlist, "event",
86847b62 2447 "event selector. use 'perf list' to list available events",
f120f9d5 2448 parse_events_option),
d20deb64 2449 OPT_CALLBACK(0, "filter", &record.evlist, "filter",
c171b552 2450 "event filter", parse_filter),
4ba1faa1
WN
2451 OPT_CALLBACK_NOOPT(0, "exclude-perf", &record.evlist,
2452 NULL, "don't record events from perf itself",
2453 exclude_perf),
bea03405 2454 OPT_STRING('p', "pid", &record.opts.target.pid, "pid",
d6d901c2 2455 "record events on existing process id"),
bea03405 2456 OPT_STRING('t', "tid", &record.opts.target.tid, "tid",
d6d901c2 2457 "record events on existing thread id"),
d20deb64 2458 OPT_INTEGER('r', "realtime", &record.realtime_prio,
0e9b20b8 2459 "collect data with this RT SCHED_FIFO priority"),
509051ea 2460 OPT_BOOLEAN(0, "no-buffering", &record.opts.no_buffering,
acac03fa 2461 "collect data without buffering"),
d20deb64 2462 OPT_BOOLEAN('R', "raw-samples", &record.opts.raw_samples,
daac07b2 2463 "collect raw sample records from all opened counters"),
bea03405 2464 OPT_BOOLEAN('a', "all-cpus", &record.opts.target.system_wide,
0e9b20b8 2465 "system-wide collection from all CPUs"),
bea03405 2466 OPT_STRING('C', "cpu", &record.opts.target.cpu_list, "cpu",
c45c6ea2 2467 "list of cpus to monitor"),
d20deb64 2468 OPT_U64('c', "count", &record.opts.user_interval, "event period to sample"),
2d4f2799 2469 OPT_STRING('o', "output", &record.data.path, "file",
abaff32a 2470 "output file name"),
69e7e5b0
AH
2471 OPT_BOOLEAN_SET('i', "no-inherit", &record.opts.no_inherit,
2472 &record.opts.no_inherit_set,
2473 "child tasks do not inherit counters"),
4ea648ae
WN
2474 OPT_BOOLEAN(0, "tail-synthesize", &record.opts.tail_synthesize,
2475 "synthesize non-sample events at the end of output"),
626a6b78 2476 OPT_BOOLEAN(0, "overwrite", &record.opts.overwrite, "use overwrite mode"),
71184c6a 2477 OPT_BOOLEAN(0, "no-bpf-event", &record.opts.no_bpf_event, "record bpf events"),
b09c2364
ACM
2478 OPT_BOOLEAN(0, "strict-freq", &record.opts.strict_freq,
2479 "Fail if the specified frequency can't be used"),
67230479
ACM
2480 OPT_CALLBACK('F', "freq", &record.opts, "freq or 'max'",
2481 "profile at this frequency",
2482 record__parse_freq),
e9db1310
AH
2483 OPT_CALLBACK('m', "mmap-pages", &record.opts, "pages[,pages]",
2484 "number of mmap data pages and AUX area tracing mmap pages",
2485 record__parse_mmap_pages),
470530bb
AB
2486 OPT_CALLBACK(0, "mmap-flush", &record.opts, "number",
2487 "Minimal number of bytes that is extracted from mmap data pages (default: 1)",
2488 record__mmap_flush_parse),
d20deb64 2489 OPT_BOOLEAN(0, "group", &record.opts.group,
43bece79 2490 "put the counters into a counter group"),
2ddd5c04 2491 OPT_CALLBACK_NOOPT('g', NULL, &callchain_param,
09b0fd45
JO
2492 NULL, "enables call-graph recording" ,
2493 &record_callchain_opt),
2494 OPT_CALLBACK(0, "call-graph", &record.opts,
76a26549 2495 "record_mode[,record_size]", record_callchain_help,
09b0fd45 2496 &record_parse_callchain_opt),
c0555642 2497 OPT_INCR('v', "verbose", &verbose,
3da297a6 2498 "be more verbose (show counter open errors, etc)"),
b44308f5 2499 OPT_BOOLEAN('q', "quiet", &quiet, "don't print any message"),
d20deb64 2500 OPT_BOOLEAN('s', "stat", &record.opts.inherit_stat,
649c48a9 2501 "per thread counts"),
56100321 2502 OPT_BOOLEAN('d', "data", &record.opts.sample_address, "Record the sample addresses"),
3b0a5daa
KL
2503 OPT_BOOLEAN(0, "phys-data", &record.opts.sample_phys_addr,
2504 "Record the sample physical addresses"),
b6f35ed7 2505 OPT_BOOLEAN(0, "sample-cpu", &record.opts.sample_cpu, "Record the sample cpu"),
3abebc55
AH
2506 OPT_BOOLEAN_SET('T', "timestamp", &record.opts.sample_time,
2507 &record.opts.sample_time_set,
2508 "Record the sample timestamps"),
f290aa1f
JO
2509 OPT_BOOLEAN_SET('P', "period", &record.opts.period, &record.opts.period_set,
2510 "Record the sample period"),
d20deb64 2511 OPT_BOOLEAN('n', "no-samples", &record.opts.no_samples,
649c48a9 2512 "don't sample"),
d2db9a98
WN
2513 OPT_BOOLEAN_SET('N', "no-buildid-cache", &record.no_buildid_cache,
2514 &record.no_buildid_cache_set,
2515 "do not update the buildid cache"),
2516 OPT_BOOLEAN_SET('B', "no-buildid", &record.no_buildid,
2517 &record.no_buildid_set,
2518 "do not collect buildids in perf.data"),
d20deb64 2519 OPT_CALLBACK('G', "cgroup", &record.evlist, "name",
023695d9
SE
2520 "monitor event in cgroup name only",
2521 parse_cgroups),
68cd3b45
AB
2522 OPT_INTEGER('D', "delay", &record.opts.initial_delay,
2523 "ms to wait before starting measurement after program start (-1: start with events disabled)"),
eeb399b5 2524 OPT_BOOLEAN(0, "kcore", &record.opts.kcore, "copy /proc/kcore"),
bea03405
NK
2525 OPT_STRING('u', "uid", &record.opts.target.uid_str, "user",
2526 "user to profile"),
a5aabdac
SE
2527
2528 OPT_CALLBACK_NOOPT('b', "branch-any", &record.opts.branch_stack,
2529 "branch any", "sample any taken branches",
2530 parse_branch_stack),
2531
2532 OPT_CALLBACK('j', "branch-filter", &record.opts.branch_stack,
2533 "branch filter mask", "branch stack filter modes",
bdfebd84 2534 parse_branch_stack),
05484298
AK
2535 OPT_BOOLEAN('W', "weight", &record.opts.sample_weight,
2536 "sample by weight (on special events only)"),
475eeab9
AK
2537 OPT_BOOLEAN(0, "transaction", &record.opts.sample_transaction,
2538 "sample transaction flags (special events only)"),
3aa5939d
AH
2539 OPT_BOOLEAN(0, "per-thread", &record.opts.target.per_thread,
2540 "use per-thread mmaps"),
bcc84ec6
SE
2541 OPT_CALLBACK_OPTARG('I', "intr-regs", &record.opts.sample_intr_regs, NULL, "any register",
2542 "sample selected machine registers on interrupt,"
aeea9062 2543 " use '-I?' to list register names", parse_intr_regs),
84c41742
AK
2544 OPT_CALLBACK_OPTARG(0, "user-regs", &record.opts.sample_user_regs, NULL, "any register",
2545 "sample selected machine registers on interrupt,"
aeea9062 2546 " use '--user-regs=?' to list register names", parse_user_regs),
85c273d2
AK
2547 OPT_BOOLEAN(0, "running-time", &record.opts.running_time,
2548 "Record running/enabled time of read (:S) events"),
814c8c38
PZ
2549 OPT_CALLBACK('k', "clockid", &record.opts,
2550 "clockid", "clockid to use for events, see clock_gettime()",
2551 parse_clockid),
2dd6d8a1
AH
2552 OPT_STRING_OPTARG('S', "snapshot", &record.opts.auxtrace_snapshot_opts,
2553 "opts", "AUX area tracing Snapshot Mode", ""),
c0a6de06
AH
2554 OPT_STRING_OPTARG(0, "aux-sample", &record.opts.auxtrace_sample_opts,
2555 "opts", "sample AUX area", ""),
3fcb10e4 2556 OPT_UINTEGER(0, "proc-map-timeout", &proc_map_timeout,
9d9cad76 2557 "per thread proc mmap processing timeout in ms"),
f3b3614a
HB
2558 OPT_BOOLEAN(0, "namespaces", &record.opts.record_namespaces,
2559 "Record namespaces events"),
8fb4b679
NK
2560 OPT_BOOLEAN(0, "all-cgroups", &record.opts.record_cgroup,
2561 "Record cgroup events"),
16b4b4e1
AH
2562 OPT_BOOLEAN_SET(0, "switch-events", &record.opts.record_switch_events,
2563 &record.opts.record_switch_events_set,
2564 "Record context switch events"),
85723885
JO
2565 OPT_BOOLEAN_FLAG(0, "all-kernel", &record.opts.all_kernel,
2566 "Configure all used events to run in kernel space.",
2567 PARSE_OPT_EXCLUSIVE),
2568 OPT_BOOLEAN_FLAG(0, "all-user", &record.opts.all_user,
2569 "Configure all used events to run in user space.",
2570 PARSE_OPT_EXCLUSIVE),
53651b28 2571 OPT_BOOLEAN(0, "kernel-callchains", &record.opts.kernel_callchains,
2572 "collect kernel callchains"),
2573 OPT_BOOLEAN(0, "user-callchains", &record.opts.user_callchains,
2574 "collect user callchains"),
71dc2326
WN
2575 OPT_STRING(0, "clang-path", &llvm_param.clang_path, "clang path",
2576 "clang binary to use for compiling BPF scriptlets"),
2577 OPT_STRING(0, "clang-opt", &llvm_param.clang_opt, "clang options",
2578 "options passed to clang when compiling BPF scriptlets"),
7efe0e03
HK
2579 OPT_STRING(0, "vmlinux", &symbol_conf.vmlinux_name,
2580 "file", "vmlinux pathname"),
6156681b
NK
2581 OPT_BOOLEAN(0, "buildid-all", &record.buildid_all,
2582 "Record build-id of all DSOs regardless of hits"),
ecfd7a9c
WN
2583 OPT_BOOLEAN(0, "timestamp-filename", &record.timestamp_filename,
2584 "append timestamp to output filename"),
68588baf
JY
2585 OPT_BOOLEAN(0, "timestamp-boundary", &record.timestamp_boundary,
2586 "Record timestamp boundary (time of first/last samples)"),
cb4e1ebb 2587 OPT_STRING_OPTARG_SET(0, "switch-output", &record.switch_output.str,
c38dab7d
AK
2588 &record.switch_output.set, "signal or size[BKMG] or time[smhd]",
2589 "Switch output when receiving SIGUSR2 (signal) or cross a size or time threshold",
dc0c6127 2590 "signal"),
899e5ffb
ACM
2591 OPT_CALLBACK_SET(0, "switch-output-event", &record.sb_evlist, &record.switch_output_event_set, "switch output event",
2592 "switch output event selector. use 'perf list' to list available events",
2593 parse_events_option_new_evlist),
03724b2e
AK
2594 OPT_INTEGER(0, "switch-max-files", &record.switch_output.num_files,
2595 "Limit number of switch output generated files"),
0aab2136
WN
2596 OPT_BOOLEAN(0, "dry-run", &dry_run,
2597 "Parse options then exit"),
d3d1af6f 2598#ifdef HAVE_AIO_SUPPORT
93f20c0f
AB
2599 OPT_CALLBACK_OPTARG(0, "aio", &record.opts,
2600 &nr_cblocks_default, "n", "Use <n> control blocks in asynchronous trace writing mode (default: 1, max: 4)",
d3d1af6f
AB
2601 record__aio_parse),
2602#endif
f4fe11b7
AB
2603 OPT_CALLBACK(0, "affinity", &record.opts, "node|cpu",
2604 "Set affinity mask of trace reading thread to NUMA node cpu mask or cpu of processed mmap buffer",
2605 record__parse_affinity),
504c1ad1
AB
2606#ifdef HAVE_ZSTD_SUPPORT
2607 OPT_CALLBACK_OPTARG('z', "compression-level", &record.opts, &comp_level_default,
2608 "n", "Compressed records using specified level (default: 1 - fastest compression, 22 - greatest compression)",
2609 record__parse_comp_level),
2610#endif
6d575816
JS
2611 OPT_CALLBACK(0, "max-size", &record.output_max_size,
2612 "size", "Limit the maximum size of the output file", parse_output_max_size),
d99c22ea
SE
2613 OPT_UINTEGER(0, "num-thread-synthesize",
2614 &record.opts.nr_threads_synthesize,
2615 "number of threads to run for event synthesis"),
70943490
SE
2616#ifdef HAVE_LIBPFM
2617 OPT_CALLBACK(0, "pfm-events", &record.evlist, "event",
2618 "libpfm4 event selector. use 'perf list' to list available events",
2619 parse_libpfm_events_option),
2620#endif
0e9b20b8
IM
2621 OPT_END()
2622};
2623
e5b2c207
NK
2624struct option *record_options = __record_options;
2625
b0ad8ea6 2626int cmd_record(int argc, const char **argv)
0e9b20b8 2627{
ef149c25 2628 int err;
8c6f45a7 2629 struct record *rec = &record;
16ad2ffb 2630 char errbuf[BUFSIZ];
0e9b20b8 2631
67230479
ACM
2632 setlocale(LC_ALL, "");
2633
48e1cab1
WN
2634#ifndef HAVE_LIBBPF_SUPPORT
2635# define set_nobuild(s, l, c) set_option_nobuild(record_options, s, l, "NO_LIBBPF=1", c)
2636 set_nobuild('\0', "clang-path", true);
2637 set_nobuild('\0', "clang-opt", true);
2638# undef set_nobuild
7efe0e03
HK
2639#endif
2640
2641#ifndef HAVE_BPF_PROLOGUE
2642# if !defined (HAVE_DWARF_SUPPORT)
2643# define REASON "NO_DWARF=1"
2644# elif !defined (HAVE_LIBBPF_SUPPORT)
2645# define REASON "NO_LIBBPF=1"
2646# else
2647# define REASON "this architecture doesn't support BPF prologue"
2648# endif
2649# define set_nobuild(s, l, c) set_option_nobuild(record_options, s, l, REASON, c)
2650 set_nobuild('\0', "vmlinux", true);
2651# undef set_nobuild
2652# undef REASON
48e1cab1
WN
2653#endif
2654
9d2ed645
AB
2655 rec->opts.affinity = PERF_AFFINITY_SYS;
2656
0f98b11c 2657 rec->evlist = evlist__new();
3e2be2da 2658 if (rec->evlist == NULL)
361c99a6
ACM
2659 return -ENOMEM;
2660
ecc4c561
ACM
2661 err = perf_config(perf_record_config, rec);
2662 if (err)
2663 return err;
eb853e80 2664
bca647aa 2665 argc = parse_options(argc, argv, record_options, record_usage,
655000e7 2666 PARSE_OPT_STOP_AT_NON_OPTION);
68ba3235
NK
2667 if (quiet)
2668 perf_quiet_option();
483635a9
JO
2669
2670 /* Make system wide (-a) the default target. */
602ad878 2671 if (!argc && target__none(&rec->opts.target))
483635a9 2672 rec->opts.target.system_wide = true;
0e9b20b8 2673
bea03405 2674 if (nr_cgroups && !rec->opts.target.system_wide) {
c7118369
NK
2675 usage_with_options_msg(record_usage, record_options,
2676 "cgroup monitoring only available in system-wide mode");
2677
023695d9 2678 }
504c1ad1 2679
eeb399b5
AH
2680 if (rec->opts.kcore)
2681 rec->data.is_dir = true;
2682
504c1ad1
AB
2683 if (rec->opts.comp_level != 0) {
2684 pr_debug("Compression enabled, disabling build id collection at the end of the session.\n");
2685 rec->no_buildid = true;
2686 }
2687
b757bb09
AH
2688 if (rec->opts.record_switch_events &&
2689 !perf_can_record_switch_events()) {
c7118369
NK
2690 ui__error("kernel does not support recording context switch events\n");
2691 parse_options_usage(record_usage, record_options, "switch-events", 0);
2692 return -EINVAL;
b757bb09 2693 }
023695d9 2694
cb4e1ebb
JO
2695 if (switch_output_setup(rec)) {
2696 parse_options_usage(record_usage, record_options, "switch-output", 0);
2697 return -EINVAL;
2698 }
2699
bfacbe3b
JO
2700 if (rec->switch_output.time) {
2701 signal(SIGALRM, alarm_sig_handler);
2702 alarm(rec->switch_output.time);
2703 }
2704
03724b2e
AK
2705 if (rec->switch_output.num_files) {
2706 rec->switch_output.filenames = calloc(sizeof(char *),
2707 rec->switch_output.num_files);
2708 if (!rec->switch_output.filenames)
2709 return -EINVAL;
2710 }
2711
1b36c03e
AH
2712 /*
2713 * Allow aliases to facilitate the lookup of symbols for address
2714 * filters. Refer to auxtrace_parse_filters().
2715 */
2716 symbol_conf.allow_aliases = true;
2717
2718 symbol__init(NULL);
2719
8384a260
AB
2720 if (rec->opts.affinity != PERF_AFFINITY_SYS) {
2721 rec->affinity_mask.nbits = cpu__max_cpu();
2722 rec->affinity_mask.bits = bitmap_alloc(rec->affinity_mask.nbits);
2723 if (!rec->affinity_mask.bits) {
2724 pr_err("Failed to allocate thread mask for %zd cpus\n", rec->affinity_mask.nbits);
2725 return -ENOMEM;
2726 }
2727 pr_debug2("thread mask[%zd]: empty\n", rec->affinity_mask.nbits);
2728 }
2729
4b5ea3bd 2730 err = record__auxtrace_init(rec);
1b36c03e
AH
2731 if (err)
2732 goto out;
2733
0aab2136 2734 if (dry_run)
5c01ad60 2735 goto out;
0aab2136 2736
d7888573
WN
2737 err = bpf__setup_stdout(rec->evlist);
2738 if (err) {
2739 bpf__strerror_setup_stdout(rec->evlist, err, errbuf, sizeof(errbuf));
2740 pr_err("ERROR: Setup BPF stdout failed: %s\n",
2741 errbuf);
5c01ad60 2742 goto out;
d7888573
WN
2743 }
2744
ef149c25
AH
2745 err = -ENOMEM;
2746
0c1d46a8 2747 if (rec->no_buildid_cache || rec->no_buildid) {
a1ac1d3c 2748 disable_buildid_cache();
dc0c6127 2749 } else if (rec->switch_output.enabled) {
0c1d46a8
WN
2750 /*
2751 * In 'perf record --switch-output', disable buildid
2752 * generation by default to reduce data file switching
2753 * overhead. Still generate buildid if they are required
2754 * explicitly using
2755 *
60437ac0 2756 * perf record --switch-output --no-no-buildid \
0c1d46a8
WN
2757 * --no-no-buildid-cache
2758 *
2759 * Following code equals to:
2760 *
2761 * if ((rec->no_buildid || !rec->no_buildid_set) &&
2762 * (rec->no_buildid_cache || !rec->no_buildid_cache_set))
2763 * disable_buildid_cache();
2764 */
2765 bool disable = true;
2766
2767 if (rec->no_buildid_set && !rec->no_buildid)
2768 disable = false;
2769 if (rec->no_buildid_cache_set && !rec->no_buildid_cache)
2770 disable = false;
2771 if (disable) {
2772 rec->no_buildid = true;
2773 rec->no_buildid_cache = true;
2774 disable_buildid_cache();
2775 }
2776 }
655000e7 2777
4ea648ae
WN
2778 if (record.opts.overwrite)
2779 record.opts.tail_synthesize = true;
2780
6484d2f9 2781 if (rec->evlist->core.nr_entries == 0 &&
e251abee 2782 __evlist__add_default(rec->evlist, !record.opts.no_samples) < 0) {
69aad6f1 2783 pr_err("Not enough memory for event selector list\n");
394c01ed 2784 goto out;
bbd36e5e 2785 }
0e9b20b8 2786
69e7e5b0
AH
2787 if (rec->opts.target.tid && !rec->opts.no_inherit_set)
2788 rec->opts.no_inherit = true;
2789
602ad878 2790 err = target__validate(&rec->opts.target);
16ad2ffb 2791 if (err) {
602ad878 2792 target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
c3dec27b 2793 ui__warning("%s\n", errbuf);
16ad2ffb
NK
2794 }
2795
602ad878 2796 err = target__parse_uid(&rec->opts.target);
16ad2ffb
NK
2797 if (err) {
2798 int saved_errno = errno;
4bd0f2d2 2799
602ad878 2800 target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
3780f488 2801 ui__error("%s", errbuf);
16ad2ffb
NK
2802
2803 err = -saved_errno;
394c01ed 2804 goto out;
16ad2ffb 2805 }
0d37aa34 2806
ca800068
MZ
2807 /* Enable ignoring missing threads when -u/-p option is defined. */
2808 rec->opts.ignore_missing_thread = rec->opts.target.uid != UINT_MAX || rec->opts.target.pid;
23dc4f15 2809
16ad2ffb 2810 err = -ENOMEM;
3e2be2da 2811 if (perf_evlist__create_maps(rec->evlist, &rec->opts.target) < 0)
dd7927f4 2812 usage_with_options(record_usage, record_options);
69aad6f1 2813
ef149c25
AH
2814 err = auxtrace_record__options(rec->itr, rec->evlist, &rec->opts);
2815 if (err)
394c01ed 2816 goto out;
ef149c25 2817
6156681b
NK
2818 /*
2819 * We take all buildids when the file contains
2820 * AUX area tracing data because we do not decode the
2821 * trace because it would take too long.
2822 */
2823 if (rec->opts.full_auxtrace)
2824 rec->buildid_all = true;
2825
246eba8e
AH
2826 if (rec->opts.text_poke) {
2827 err = record__config_text_poke(rec->evlist);
2828 if (err) {
2829 pr_err("record__config_text_poke failed, error %d\n", err);
2830 goto out;
2831 }
2832 }
2833
b4006796 2834 if (record_opts__config(&rec->opts)) {
39d17dac 2835 err = -EINVAL;
394c01ed 2836 goto out;
7e4ff9e3
MG
2837 }
2838
93f20c0f
AB
2839 if (rec->opts.nr_cblocks > nr_cblocks_max)
2840 rec->opts.nr_cblocks = nr_cblocks_max;
5d7f4116 2841 pr_debug("nr_cblocks: %d\n", rec->opts.nr_cblocks);
d3d1af6f 2842
9d2ed645 2843 pr_debug("affinity: %s\n", affinity_tags[rec->opts.affinity]);
470530bb 2844 pr_debug("mmap flush: %d\n", rec->opts.mmap_flush);
9d2ed645 2845
51255a8a
AB
2846 if (rec->opts.comp_level > comp_level_max)
2847 rec->opts.comp_level = comp_level_max;
2848 pr_debug("comp level: %d\n", rec->opts.comp_level);
2849
d20deb64 2850 err = __cmd_record(&record, argc, argv);
394c01ed 2851out:
8384a260 2852 bitmap_free(rec->affinity_mask.bits);
c12995a5 2853 evlist__delete(rec->evlist);
d65a458b 2854 symbol__exit();
ef149c25 2855 auxtrace_record__free(rec->itr);
39d17dac 2856 return err;
0e9b20b8 2857}
2dd6d8a1
AH
2858
2859static void snapshot_sig_handler(int sig __maybe_unused)
2860{
dc0c6127
JO
2861 struct record *rec = &record;
2862
5f9cf599
WN
2863 if (trigger_is_ready(&auxtrace_snapshot_trigger)) {
2864 trigger_hit(&auxtrace_snapshot_trigger);
2865 auxtrace_record__snapshot_started = 1;
2866 if (auxtrace_record__snapshot_start(record.itr))
2867 trigger_error(&auxtrace_snapshot_trigger);
2868 }
3c1cb7e3 2869
dc0c6127 2870 if (switch_output_signal(rec))
3c1cb7e3 2871 trigger_hit(&switch_output_trigger);
2dd6d8a1 2872}
bfacbe3b
JO
2873
2874static void alarm_sig_handler(int sig __maybe_unused)
2875{
2876 struct record *rec = &record;
2877
2878 if (switch_output_time(rec))
2879 trigger_hit(&switch_output_trigger);
2880}