builtin-record.c 65.3 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
I
Ingo Molnar 已提交
2
/*
3 4 5 6 7
 * builtin-record.c
 *
 * Builtin record command: Record the profile of a workload
 * (or a CPU, or a PID) into the perf.data output file - for
 * later analysis via perf report.
I
Ingo Molnar 已提交
8
 */
9
#include "builtin.h"
10

11
#include "util/build-id.h"
12
#include <subcmd/parse-options.h>
13
#include "util/parse-events.h"
14
#include "util/config.h"
15

16
#include "util/callchain.h"
17
#include "util/cgroup.h"
18
#include "util/header.h"
19
#include "util/event.h"
20
#include "util/evlist.h"
21
#include "util/evsel.h"
22
#include "util/debug.h"
23
#include "util/target.h"
24
#include "util/session.h"
25
#include "util/tool.h"
26
#include "util/symbol.h"
27
#include "util/record.h"
28
#include "util/cpumap.h"
29
#include "util/thread_map.h"
30
#include "util/data.h"
31
#include "util/perf_regs.h"
32
#include "util/auxtrace.h"
33
#include "util/tsc.h"
34
#include "util/parse-branch-options.h"
35
#include "util/parse-regs-options.h"
36
#include "util/llvm-utils.h"
37
#include "util/bpf-loader.h"
38
#include "util/trigger.h"
W
Wang Nan 已提交
39
#include "util/perf-hooks.h"
40
#include "util/cpu-set-sched.h"
41
#include "util/synthetic-events.h"
42
#include "util/time-utils.h"
43
#include "util/units.h"
44
#include "util/bpf-event.h"
45
#include "asm/bug.h"
46
#include "perf.h"
47

48
#include <errno.h>
49
#include <inttypes.h>
50
#include <locale.h>
51
#include <poll.h>
52
#include <unistd.h>
53
#include <sched.h>
54
#include <signal.h>
55
#include <sys/mman.h>
56
#include <sys/wait.h>
57
#include <linux/err.h>
58
#include <linux/string.h>
59
#include <linux/time64.h>
60
#include <linux/zalloc.h>
61

62
struct switch_output {
63
	bool		 enabled;
64
	bool		 signal;
65
	unsigned long	 size;
66
	unsigned long	 time;
67 68
	const char	*str;
	bool		 set;
69 70 71
	char		 **filenames;
	int		 num_files;
	int		 cur_file;
72 73
};

74
struct record {
75
	struct perf_tool	tool;
76
	struct record_opts	opts;
77
	u64			bytes_written;
78
	struct perf_data	data;
79
	struct auxtrace_record	*itr;
80
	struct evlist	*evlist;
81 82 83
	struct perf_session	*session;
	int			realtime_prio;
	bool			no_buildid;
84
	bool			no_buildid_set;
85
	bool			no_buildid_cache;
86
	bool			no_buildid_cache_set;
87
	bool			buildid_all;
88
	bool			timestamp_filename;
89
	bool			timestamp_boundary;
90
	struct switch_output	switch_output;
91
	unsigned long long	samples;
92
	cpu_set_t		affinity_mask;
93
};
94

95 96 97 98
static volatile int auxtrace_record__snapshot_started;
static DEFINE_TRIGGER(auxtrace_snapshot_trigger);
static DEFINE_TRIGGER(switch_output_trigger);

99 100 101 102
static const char *affinity_tags[PERF_AFFINITY_MAX] = {
	"SYS", "NODE", "CPU"
};

103 104 105 106 107 108 109 110 111 112 113 114 115
static bool switch_output_signal(struct record *rec)
{
	return rec->switch_output.signal &&
	       trigger_is_ready(&switch_output_trigger);
}

static bool switch_output_size(struct record *rec)
{
	return rec->switch_output.size &&
	       trigger_is_ready(&switch_output_trigger) &&
	       (rec->bytes_written >= rec->switch_output.size);
}

116 117 118 119 120 121
static bool switch_output_time(struct record *rec)
{
	return rec->switch_output.time &&
	       trigger_is_ready(&switch_output_trigger);
}

122
static int record__write(struct record *rec, struct mmap *map __maybe_unused,
123
			 void *bf, size_t size)
124
{
125 126 127
	struct perf_data_file *file = &rec->session->data->file;

	if (perf_data_file__write(file, bf, size) < 0) {
128 129
		pr_err("failed to write perf data, error: %m\n");
		return -1;
130
	}
131

132
	rec->bytes_written += size;
133 134 135 136

	if (switch_output_size(rec))
		trigger_hit(&switch_output_trigger);

137
	return 0;
138 139
}

140 141
static int record__aio_enabled(struct record *rec);
static int record__comp_enabled(struct record *rec);
142 143 144
static size_t zstd_compress(struct perf_session *session, void *dst, size_t dst_size,
			    void *src, size_t src_size);

145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
#ifdef HAVE_AIO_SUPPORT
static int record__aio_write(struct aiocb *cblock, int trace_fd,
		void *buf, size_t size, off_t off)
{
	int rc;

	cblock->aio_fildes = trace_fd;
	cblock->aio_buf    = buf;
	cblock->aio_nbytes = size;
	cblock->aio_offset = off;
	cblock->aio_sigevent.sigev_notify = SIGEV_NONE;

	do {
		rc = aio_write(cblock);
		if (rc == 0) {
			break;
		} else if (errno != EAGAIN) {
			cblock->aio_fildes = -1;
			pr_err("failed to queue perf data, error: %m\n");
			break;
		}
	} while (1);

	return rc;
}

171
static int record__aio_complete(struct mmap *md, struct aiocb *cblock)
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
{
	void *rem_buf;
	off_t rem_off;
	size_t rem_size;
	int rc, aio_errno;
	ssize_t aio_ret, written;

	aio_errno = aio_error(cblock);
	if (aio_errno == EINPROGRESS)
		return 0;

	written = aio_ret = aio_return(cblock);
	if (aio_ret < 0) {
		if (aio_errno != EINTR)
			pr_err("failed to write perf data, error: %m\n");
		written = 0;
	}

	rem_size = cblock->aio_nbytes - written;

	if (rem_size == 0) {
		cblock->aio_fildes = -1;
		/*
195 196 197
		 * md->refcount is incremented in record__aio_pushfn() for
		 * every aio write request started in record__aio_push() so
		 * decrement it because the request is now complete.
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
		 */
		perf_mmap__put(md);
		rc = 1;
	} else {
		/*
		 * aio write request may require restart with the
		 * reminder if the kernel didn't write whole
		 * chunk at once.
		 */
		rem_off = cblock->aio_offset + written;
		rem_buf = (void *)(cblock->aio_buf + written);
		record__aio_write(cblock, cblock->aio_fildes,
				rem_buf, rem_size, rem_off);
		rc = 0;
	}

	return rc;
}

217
static int record__aio_sync(struct mmap *md, bool sync_all)
218
{
219 220
	struct aiocb **aiocb = md->aio.aiocb;
	struct aiocb *cblocks = md->aio.cblocks;
221
	struct timespec timeout = { 0, 1000 * 1000  * 1 }; /* 1ms */
222
	int i, do_suspend;
223 224

	do {
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
		do_suspend = 0;
		for (i = 0; i < md->aio.nr_cblocks; ++i) {
			if (cblocks[i].aio_fildes == -1 || record__aio_complete(md, &cblocks[i])) {
				if (sync_all)
					aiocb[i] = NULL;
				else
					return i;
			} else {
				/*
				 * Started aio write is not complete yet
				 * so it has to be waited before the
				 * next allocation.
				 */
				aiocb[i] = &cblocks[i];
				do_suspend = 1;
			}
		}
		if (!do_suspend)
			return -1;
244

245
		while (aio_suspend((const struct aiocb **)aiocb, md->aio.nr_cblocks, &timeout)) {
246 247 248 249 250 251
			if (!(errno == EAGAIN || errno == EINTR))
				pr_err("failed to sync perf data, error: %m\n");
		}
	} while (1);
}

252 253 254 255 256 257
struct record_aio {
	struct record	*rec;
	void		*data;
	size_t		size;
};

258
static int record__aio_pushfn(struct mmap *map, void *to, void *buf, size_t size)
259
{
260
	struct record_aio *aio = to;
261

262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
	/*
	 * map->base data pointed by buf is copied into free map->aio.data[] buffer
	 * to release space in the kernel buffer as fast as possible, calling
	 * perf_mmap__consume() from perf_mmap__push() function.
	 *
	 * That lets the kernel to proceed with storing more profiling data into
	 * the kernel buffer earlier than other per-cpu kernel buffers are handled.
	 *
	 * Coping can be done in two steps in case the chunk of profiling data
	 * crosses the upper bound of the kernel buffer. In this case we first move
	 * part of data from map->start till the upper bound and then the reminder
	 * from the beginning of the kernel buffer till the end of the data chunk.
	 */

	if (record__comp_enabled(aio->rec)) {
		size = zstd_compress(aio->rec->session, aio->data + aio->size,
				     perf_mmap__mmap_len(map) - aio->size,
				     buf, size);
	} else {
		memcpy(aio->data + aio->size, buf, size);
	}

	if (!aio->size) {
		/*
		 * Increment map->refcount to guard map->aio.data[] buffer
		 * from premature deallocation because map object can be
		 * released earlier than aio write request started on
		 * map->aio.data[] buffer is complete.
		 *
		 * perf_mmap__put() is done at record__aio_complete()
		 * after started aio request completion or at record__aio_push()
		 * if the request failed to start.
		 */
		perf_mmap__get(map);
	}

	aio->size += size;

	return size;
}

303
static int record__aio_push(struct record *rec, struct mmap *map, off_t *off)
304 305 306 307
{
	int ret, idx;
	int trace_fd = rec->session->data->file.fd;
	struct record_aio aio = { .rec = rec, .size = 0 };
308

309 310 311 312 313 314 315 316 317 318 319 320 321
	/*
	 * Call record__aio_sync() to wait till map->aio.data[] buffer
	 * becomes available after previous aio write operation.
	 */

	idx = record__aio_sync(map, false);
	aio.data = map->aio.data[idx];
	ret = perf_mmap__push(map, &aio, record__aio_pushfn);
	if (ret != 0) /* ret > 0 - no data, ret < 0 - error */
		return ret;

	rec->samples++;
	ret = record__aio_write(&(map->aio.cblocks[idx]), trace_fd, aio.data, aio.size, *off);
322
	if (!ret) {
323 324
		*off += aio.size;
		rec->bytes_written += aio.size;
325 326
		if (switch_output_size(rec))
			trigger_hit(&switch_output_trigger);
327 328 329 330 331 332 333 334
	} else {
		/*
		 * Decrement map->refcount incremented in record__aio_pushfn()
		 * back if record__aio_write() operation failed to start, otherwise
		 * map->refcount is decremented in record__aio_complete() after
		 * aio write operation finishes successfully.
		 */
		perf_mmap__put(map);
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
	}

	return ret;
}

static off_t record__aio_get_pos(int trace_fd)
{
	return lseek(trace_fd, 0, SEEK_CUR);
}

static void record__aio_set_pos(int trace_fd, off_t pos)
{
	lseek(trace_fd, pos, SEEK_SET);
}

static void record__aio_mmap_read_sync(struct record *rec)
{
	int i;
353
	struct evlist *evlist = rec->evlist;
354
	struct mmap *maps = evlist->mmap;
355

356
	if (!record__aio_enabled(rec))
357 358 359
		return;

	for (i = 0; i < evlist->nr_mmaps; i++) {
360
		struct mmap *map = &maps[i];
361 362

		if (map->base)
363
			record__aio_sync(map, true);
364 365 366 367
	}
}

static int nr_cblocks_default = 1;
368
static int nr_cblocks_max = 4;
369 370

static int record__aio_parse(const struct option *opt,
371
			     const char *str,
372 373 374 375
			     int unset)
{
	struct record_opts *opts = (struct record_opts *)opt->value;

376
	if (unset) {
377
		opts->nr_cblocks = 0;
378 379 380 381 382 383
	} else {
		if (str)
			opts->nr_cblocks = strtol(str, NULL, 0);
		if (!opts->nr_cblocks)
			opts->nr_cblocks = nr_cblocks_default;
	}
384 385 386 387

	return 0;
}
#else /* HAVE_AIO_SUPPORT */
388 389
static int nr_cblocks_max = 0;

390
static int record__aio_push(struct record *rec __maybe_unused, struct mmap *map __maybe_unused,
391
			    off_t *off __maybe_unused)
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
{
	return -1;
}

static off_t record__aio_get_pos(int trace_fd __maybe_unused)
{
	return -1;
}

static void record__aio_set_pos(int trace_fd __maybe_unused, off_t pos __maybe_unused)
{
}

static void record__aio_mmap_read_sync(struct record *rec __maybe_unused)
{
}
#endif

static int record__aio_enabled(struct record *rec)
{
	return rec->opts.nr_cblocks > 0;
}

415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
#define MMAP_FLUSH_DEFAULT 1
static int record__mmap_flush_parse(const struct option *opt,
				    const char *str,
				    int unset)
{
	int flush_max;
	struct record_opts *opts = (struct record_opts *)opt->value;
	static struct parse_tag tags[] = {
			{ .tag  = 'B', .mult = 1       },
			{ .tag  = 'K', .mult = 1 << 10 },
			{ .tag  = 'M', .mult = 1 << 20 },
			{ .tag  = 'G', .mult = 1 << 30 },
			{ .tag  = 0 },
	};

	if (unset)
		return 0;

	if (str) {
		opts->mmap_flush = parse_tag_value(str, tags);
		if (opts->mmap_flush == (int)-1)
			opts->mmap_flush = strtol(str, NULL, 0);
	}

	if (!opts->mmap_flush)
		opts->mmap_flush = MMAP_FLUSH_DEFAULT;

	flush_max = perf_evlist__mmap_size(opts->mmap_pages);
	flush_max /= 4;
	if (opts->mmap_flush > flush_max)
		opts->mmap_flush = flush_max;

	return 0;
}

450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
#ifdef HAVE_ZSTD_SUPPORT
static unsigned int comp_level_default = 1;

static int record__parse_comp_level(const struct option *opt, const char *str, int unset)
{
	struct record_opts *opts = opt->value;

	if (unset) {
		opts->comp_level = 0;
	} else {
		if (str)
			opts->comp_level = strtol(str, NULL, 0);
		if (!opts->comp_level)
			opts->comp_level = comp_level_default;
	}

	return 0;
}
#endif
469 470
static unsigned int comp_level_max = 22;

471 472 473 474 475
static int record__comp_enabled(struct record *rec)
{
	return rec->opts.comp_level > 0;
}

476
static int process_synthesized_event(struct perf_tool *tool,
477
				     union perf_event *event,
478 479
				     struct perf_sample *sample __maybe_unused,
				     struct machine *machine __maybe_unused)
480
{
481
	struct record *rec = container_of(tool, struct record, tool);
482
	return record__write(rec, NULL, event, event->header.size);
483 484
}

485
static int record__pushfn(struct mmap *map, void *to, void *bf, size_t size)
486 487 488
{
	struct record *rec = to;

489 490 491 492 493
	if (record__comp_enabled(rec)) {
		size = zstd_compress(rec->session, map->data, perf_mmap__mmap_len(map), bf, size);
		bf   = map->data;
	}

494
	rec->samples++;
495
	return record__write(rec, map, bf, size);
496 497
}

498 499 500
static volatile int done;
static volatile int signr = -1;
static volatile int child_finished;
501

502 503 504 505 506 507 508 509 510 511
static void sig_handler(int sig)
{
	if (sig == SIGCHLD)
		child_finished = 1;
	else
		signr = sig;

	done = 1;
}

W
Wang Nan 已提交
512 513 514 515 516 517
static void sigsegv_handler(int sig)
{
	perf_hooks__recover();
	sighandler_dump_stack(sig);
}

518 519 520 521 522 523 524 525 526
static void record__sig_exit(void)
{
	if (signr == -1)
		return;

	signal(signr, SIG_DFL);
	raise(signr);
}

527 528
#ifdef HAVE_AUXTRACE_SUPPORT

529
static int record__process_auxtrace(struct perf_tool *tool,
530
				    struct mmap *map,
531 532 533 534
				    union perf_event *event, void *data1,
				    size_t len1, void *data2, size_t len2)
{
	struct record *rec = container_of(tool, struct record, tool);
535
	struct perf_data *data = &rec->data;
536 537 538
	size_t padding;
	u8 pad[8] = {0};

539
	if (!perf_data__is_pipe(data) && !perf_data__is_dir(data)) {
540
		off_t file_offset;
541
		int fd = perf_data__fd(data);
542 543 544 545 546 547 548 549 550 551 552
		int err;

		file_offset = lseek(fd, 0, SEEK_CUR);
		if (file_offset == -1)
			return -1;
		err = auxtrace_index__auxtrace_event(&rec->session->auxtrace_index,
						     event, file_offset);
		if (err)
			return err;
	}

553 554 555 556 557
	/* event.auxtrace.size includes padding, see __auxtrace_mmap__read() */
	padding = (len1 + len2) & 7;
	if (padding)
		padding = 8 - padding;

558 559
	record__write(rec, map, event, event->header.size);
	record__write(rec, map, data1, len1);
560
	if (len2)
561 562
		record__write(rec, map, data2, len2);
	record__write(rec, map, &pad, padding);
563 564 565 566 567

	return 0;
}

static int record__auxtrace_mmap_read(struct record *rec,
568
				      struct mmap *map)
569 570 571
{
	int ret;

572
	ret = auxtrace_mmap__read(map, rec->itr, &rec->tool,
573 574 575 576 577 578 579 580 581 582
				  record__process_auxtrace);
	if (ret < 0)
		return ret;

	if (ret)
		rec->samples++;

	return 0;
}

583
static int record__auxtrace_mmap_read_snapshot(struct record *rec,
584
					       struct mmap *map)
585 586 587
{
	int ret;

588
	ret = auxtrace_mmap__read_snapshot(map, rec->itr, &rec->tool,
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
					   record__process_auxtrace,
					   rec->opts.auxtrace_snapshot_size);
	if (ret < 0)
		return ret;

	if (ret)
		rec->samples++;

	return 0;
}

static int record__auxtrace_read_snapshot_all(struct record *rec)
{
	int i;
	int rc = 0;

	for (i = 0; i < rec->evlist->nr_mmaps; i++) {
606
		struct mmap *map = &rec->evlist->mmap[i];
607

608
		if (!map->auxtrace_mmap.base)
609 610
			continue;

611
		if (record__auxtrace_mmap_read_snapshot(rec, map) != 0) {
612 613 614 615 616 617 618 619
			rc = -1;
			goto out;
		}
	}
out:
	return rc;
}

620
static void record__read_auxtrace_snapshot(struct record *rec, bool on_exit)
621 622 623
{
	pr_debug("Recording AUX area tracing snapshot\n");
	if (record__auxtrace_read_snapshot_all(rec) < 0) {
624
		trigger_error(&auxtrace_snapshot_trigger);
625
	} else {
626
		if (auxtrace_record__snapshot_finish(rec->itr, on_exit))
627 628 629
			trigger_error(&auxtrace_snapshot_trigger);
		else
			trigger_ready(&auxtrace_snapshot_trigger);
630 631 632
	}
}

633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
static int record__auxtrace_snapshot_exit(struct record *rec)
{
	if (trigger_is_error(&auxtrace_snapshot_trigger))
		return 0;

	if (!auxtrace_record__snapshot_started &&
	    auxtrace_record__snapshot_start(rec->itr))
		return -1;

	record__read_auxtrace_snapshot(rec, true);
	if (trigger_is_error(&auxtrace_snapshot_trigger))
		return -1;

	return 0;
}

649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
static int record__auxtrace_init(struct record *rec)
{
	int err;

	if (!rec->itr) {
		rec->itr = auxtrace_record__init(rec->evlist, &err);
		if (err)
			return err;
	}

	err = auxtrace_parse_snapshot_options(rec->itr, &rec->opts,
					      rec->opts.auxtrace_snapshot_opts);
	if (err)
		return err;

	return auxtrace_parse_filters(rec->evlist);
}

667 668 669 670
#else

static inline
int record__auxtrace_mmap_read(struct record *rec __maybe_unused,
671
			       struct mmap *map __maybe_unused)
672 673 674 675
{
	return 0;
}

676
static inline
677 678
void record__read_auxtrace_snapshot(struct record *rec __maybe_unused,
				    bool on_exit __maybe_unused)
679
{
680 681
}

682 683
static inline
int auxtrace_record__snapshot_start(struct auxtrace_record *itr __maybe_unused)
684
{
685
	return 0;
686 687
}

688 689 690 691 692 693
static inline
int record__auxtrace_snapshot_exit(struct record *rec __maybe_unused)
{
	return 0;
}

694 695 696 697 698
static int record__auxtrace_init(struct record *rec __maybe_unused)
{
	return 0;
}

699 700
#endif

701
static int record__mmap_evlist(struct record *rec,
702
			       struct evlist *evlist)
703 704 705 706
{
	struct record_opts *opts = &rec->opts;
	char msg[512];

707 708 709
	if (opts->affinity != PERF_AFFINITY_SYS)
		cpu__setup_cpunode_map();

710
	if (perf_evlist__mmap_ex(evlist, opts->mmap_pages,
711
				 opts->auxtrace_mmap_pages,
712
				 opts->auxtrace_snapshot_mode,
713
				 opts->nr_cblocks, opts->affinity,
714
				 opts->mmap_flush, opts->comp_level) < 0) {
715 716 717 718 719 720 721 722 723 724
		if (errno == EPERM) {
			pr_err("Permission error mapping pages.\n"
			       "Consider increasing "
			       "/proc/sys/kernel/perf_event_mlock_kb,\n"
			       "or try again with a smaller value of -m/--mmap_pages.\n"
			       "(current value: %u,%u)\n",
			       opts->mmap_pages, opts->auxtrace_mmap_pages);
			return -errno;
		} else {
			pr_err("failed to mmap with %d (%s)\n", errno,
725
				str_error_r(errno, msg, sizeof(msg)));
726 727 728 729 730 731 732 733 734 735 736 737 738 739
			if (errno)
				return -errno;
			else
				return -EINVAL;
		}
	}
	return 0;
}

static int record__mmap(struct record *rec)
{
	return record__mmap_evlist(rec, rec->evlist);
}

740
static int record__open(struct record *rec)
741
{
742
	char msg[BUFSIZ];
743
	struct evsel *pos;
744
	struct evlist *evlist = rec->evlist;
745
	struct perf_session *session = rec->session;
746
	struct record_opts *opts = &rec->opts;
747
	int rc = 0;
748

749 750 751 752 753 754 755 756 757 758 759 760 761
	/*
	 * For initial_delay we need to add a dummy event so that we can track
	 * PERF_RECORD_MMAP while we wait for the initial delay to enable the
	 * real events, the ones asked by the user.
	 */
	if (opts->initial_delay) {
		if (perf_evlist__add_dummy(evlist))
			return -ENOMEM;

		pos = perf_evlist__first(evlist);
		pos->tracking = 0;
		pos = perf_evlist__last(evlist);
		pos->tracking = 1;
762
		pos->core.attr.enable_on_exec = 1;
763 764
	}

765
	perf_evlist__config(evlist, opts, &callchain_param);
766

767
	evlist__for_each_entry(evlist, pos) {
768
try_again:
769
		if (evsel__open(pos, pos->core.cpus, pos->core.threads) < 0) {
770
			if (perf_evsel__fallback(pos, errno, msg, sizeof(msg))) {
771
				if (verbose > 0)
772
					ui__warning("%s\n", msg);
773 774
				goto try_again;
			}
A
Andi Kleen 已提交
775 776 777 778 779 780
			if ((errno == EINVAL || errno == EBADF) &&
			    pos->leader != pos &&
			    pos->weak_group) {
			        pos = perf_evlist__reset_weak_group(evlist, pos);
				goto try_again;
			}
781 782 783 784
			rc = -errno;
			perf_evsel__open_strerror(pos, &opts->target,
						  errno, msg, sizeof(msg));
			ui__error("%s\n", msg);
785
			goto out;
L
Li Zefan 已提交
786
		}
787 788

		pos->supported = true;
L
Li Zefan 已提交
789
	}
790

791 792 793 794 795 796 797 798 799 800 801
	if (symbol_conf.kptr_restrict && !perf_evlist__exclude_kernel(evlist)) {
		pr_warning(
"WARNING: Kernel address maps (/proc/{kallsyms,modules}) are restricted,\n"
"check /proc/sys/kernel/kptr_restrict and /proc/sys/kernel/perf_event_paranoid.\n\n"
"Samples in kernel functions may not be resolved if a suitable vmlinux\n"
"file is not found in the buildid cache or in the vmlinux path.\n\n"
"Samples in kernel modules won't be resolved at all.\n\n"
"If some relocation was applied (e.g. kexec) symbols may be misresolved\n"
"even with a suitable vmlinux or kallsyms file.\n\n");
	}

802
	if (perf_evlist__apply_filters(evlist, &pos)) {
803
		pr_err("failed to set filter \"%s\" on event %s with %d (%s)\n",
804
			pos->filter, perf_evsel__name(pos), errno,
805
			str_error_r(errno, msg, sizeof(msg)));
806
		rc = -1;
807 808 809
		goto out;
	}

810 811
	rc = record__mmap(rec);
	if (rc)
812
		goto out;
813

814
	session->evlist = evlist;
815
	perf_session__set_id_hdr_size(session);
816 817
out:
	return rc;
818 819
}

820 821 822
static int process_sample_event(struct perf_tool *tool,
				union perf_event *event,
				struct perf_sample *sample,
823
				struct evsel *evsel,
824 825 826 827
				struct machine *machine)
{
	struct record *rec = container_of(tool, struct record, tool);

828 829 830 831
	if (rec->evlist->first_sample_time == 0)
		rec->evlist->first_sample_time = sample->time;

	rec->evlist->last_sample_time = sample->time;
832

833 834 835 836
	if (rec->buildid_all)
		return 0;

	rec->samples++;
837 838 839
	return build_id__mark_dso_hit(tool, event, sample, evsel, machine);
}

840
static int process_buildids(struct record *rec)
841
{
842
	struct perf_session *session = rec->session;
843

844
	if (perf_data__size(&rec->data) == 0)
845 846
		return 0;

847 848 849 850 851 852 853 854 855 856 857
	/*
	 * During this process, it'll load kernel map and replace the
	 * dso->long_name to a real pathname it found.  In this case
	 * we prefer the vmlinux path like
	 *   /lib/modules/3.16.4/build/vmlinux
	 *
	 * rather than build-id path (in debug directory).
	 *   $HOME/.debug/.build-id/f0/6e17aa50adf4d00b88925e03775de107611551
	 */
	symbol_conf.ignore_vmlinux_buildid = true;

858 859
	/*
	 * If --buildid-all is given, it marks all DSO regardless of hits,
860 861 862
	 * so no need to process samples. But if timestamp_boundary is enabled,
	 * it still needs to walk on all samples to get the timestamps of
	 * first/last samples.
863
	 */
864
	if (rec->buildid_all && !rec->timestamp_boundary)
865 866
		rec->tool.sample = NULL;

867
	return perf_session__process_events(session);
868 869
}

870
static void perf_event__synthesize_guest_os(struct machine *machine, void *data)
871 872
{
	int err;
873
	struct perf_tool *tool = data;
874 875 876 877 878 879 880 881
	/*
	 *As for guest kernel when processing subcommand record&report,
	 *we arrange module mmap prior to guest kernel mmap and trigger
	 *a preload dso because default guest module symbols are loaded
	 *from guest kallsyms instead of /lib/modules/XXX/XXX. This
	 *method is used to avoid symbol missing when the first addr is
	 *in module instead of in guest kernel.
	 */
882
	err = perf_event__synthesize_modules(tool, process_synthesized_event,
883
					     machine);
884 885
	if (err < 0)
		pr_err("Couldn't record guest kernel [%d]'s reference"
886
		       " relocation symbol.\n", machine->pid);
887 888 889 890 891

	/*
	 * We use _stext for guest kernel because guest kernel's /proc/kallsyms
	 * have no _text sometimes.
	 */
892
	err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
893
						 machine);
894 895
	if (err < 0)
		pr_err("Couldn't record guest kernel [%d]'s reference"
896
		       " relocation symbol.\n", machine->pid);
897 898
}

899 900 901 902 903
static struct perf_event_header finished_round_event = {
	.size = sizeof(struct perf_event_header),
	.type = PERF_RECORD_FINISHED_ROUND,
};

904
static void record__adjust_affinity(struct record *rec, struct mmap *map)
905 906 907 908 909 910 911 912 913
{
	if (rec->opts.affinity != PERF_AFFINITY_SYS &&
	    !CPU_EQUAL(&rec->affinity_mask, &map->affinity_mask)) {
		CPU_ZERO(&rec->affinity_mask);
		CPU_OR(&rec->affinity_mask, &rec->affinity_mask, &map->affinity_mask);
		sched_setaffinity(0, sizeof(rec->affinity_mask), &rec->affinity_mask);
	}
}

914 915
static size_t process_comp_header(void *record, size_t increment)
{
916
	struct perf_record_compressed *event = record;
917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933
	size_t size = sizeof(*event);

	if (increment) {
		event->header.size += increment;
		return increment;
	}

	event->header.type = PERF_RECORD_COMPRESSED;
	event->header.size = size;

	return size;
}

static size_t zstd_compress(struct perf_session *session, void *dst, size_t dst_size,
			    void *src, size_t src_size)
{
	size_t compressed;
934
	size_t max_record_size = PERF_SAMPLE_MAX_SIZE - sizeof(struct perf_record_compressed) - 1;
935 936 937 938 939 940 941 942 943 944

	compressed = zstd_compress_stream_to_records(&session->zstd_data, dst, dst_size, src, src_size,
						     max_record_size, process_comp_header);

	session->bytes_transferred += src_size;
	session->bytes_compressed  += compressed;

	return compressed;
}

945
static int record__mmap_read_evlist(struct record *rec, struct evlist *evlist,
946
				    bool overwrite, bool synch)
947
{
948
	u64 bytes_written = rec->bytes_written;
949
	int i;
950
	int rc = 0;
951
	struct mmap *maps;
952
	int trace_fd = rec->data.file.fd;
953
	off_t off = 0;
954

955 956
	if (!evlist)
		return 0;
957

958
	maps = overwrite ? evlist->overwrite_mmap : evlist->mmap;
959 960 961
	if (!maps)
		return 0;

962
	if (overwrite && evlist->bkw_mmap_state != BKW_MMAP_DATA_PENDING)
963 964
		return 0;

965 966 967
	if (record__aio_enabled(rec))
		off = record__aio_get_pos(trace_fd);

968
	for (i = 0; i < evlist->nr_mmaps; i++) {
969
		u64 flush = 0;
970
		struct mmap *map = &maps[i];
971

972
		if (map->base) {
973
			record__adjust_affinity(rec, map);
974 975 976 977
			if (synch) {
				flush = map->flush;
				map->flush = 1;
			}
978
			if (!record__aio_enabled(rec)) {
979
				if (perf_mmap__push(map, rec, record__pushfn) < 0) {
980 981
					if (synch)
						map->flush = flush;
982 983 984 985
					rc = -1;
					goto out;
				}
			} else {
986
				if (record__aio_push(rec, map, &off) < 0) {
987
					record__aio_set_pos(trace_fd, off);
988 989
					if (synch)
						map->flush = flush;
990 991 992
					rc = -1;
					goto out;
				}
993
			}
994 995
			if (synch)
				map->flush = flush;
996
		}
997

998 999
		if (map->auxtrace_mmap.base && !rec->opts.auxtrace_snapshot_mode &&
		    record__auxtrace_mmap_read(rec, map) != 0) {
1000 1001 1002
			rc = -1;
			goto out;
		}
1003 1004
	}

1005 1006 1007
	if (record__aio_enabled(rec))
		record__aio_set_pos(trace_fd, off);

1008 1009 1010 1011 1012
	/*
	 * Mark the round finished in case we wrote
	 * at least one event.
	 */
	if (bytes_written != rec->bytes_written)
1013
		rc = record__write(rec, NULL, &finished_round_event, sizeof(finished_round_event));
1014

1015
	if (overwrite)
1016
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_EMPTY);
1017 1018
out:
	return rc;
1019 1020
}

1021
static int record__mmap_read_all(struct record *rec, bool synch)
1022 1023 1024
{
	int err;

1025
	err = record__mmap_read_evlist(rec, rec->evlist, false, synch);
1026 1027 1028
	if (err)
		return err;

1029
	return record__mmap_read_evlist(rec, rec->evlist, true, synch);
1030 1031
}

1032
static void record__init_features(struct record *rec)
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
{
	struct perf_session *session = rec->session;
	int feat;

	for (feat = HEADER_FIRST_FEATURE; feat < HEADER_LAST_FEATURE; feat++)
		perf_header__set_feat(&session->header, feat);

	if (rec->no_buildid)
		perf_header__clear_feat(&session->header, HEADER_BUILD_ID);

1043
	if (!have_tracepoints(&rec->evlist->core.entries))
1044 1045 1046 1047
		perf_header__clear_feat(&session->header, HEADER_TRACING_DATA);

	if (!rec->opts.branch_stack)
		perf_header__clear_feat(&session->header, HEADER_BRANCH_STACK);
1048 1049 1050

	if (!rec->opts.full_auxtrace)
		perf_header__clear_feat(&session->header, HEADER_AUXTRACE);
1051

1052 1053 1054
	if (!(rec->opts.use_clockid && rec->opts.clockid_res_ns))
		perf_header__clear_feat(&session->header, HEADER_CLOCKID);

1055
	perf_header__clear_feat(&session->header, HEADER_DIR_FORMAT);
1056 1057
	if (!record__comp_enabled(rec))
		perf_header__clear_feat(&session->header, HEADER_COMPRESSED);
1058

1059
	perf_header__clear_feat(&session->header, HEADER_STAT);
1060 1061
}

1062 1063 1064
static void
record__finish_output(struct record *rec)
{
1065 1066
	struct perf_data *data = &rec->data;
	int fd = perf_data__fd(data);
1067

1068
	if (data->is_pipe)
1069 1070 1071
		return;

	rec->session->header.data_size += rec->bytes_written;
1072
	data->file.size = lseek(perf_data__fd(data), 0, SEEK_CUR);
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084

	if (!rec->no_buildid) {
		process_buildids(rec);

		if (rec->buildid_all)
			dsos__hit_all(rec->session);
	}
	perf_session__write_header(rec->session, rec->evlist, fd, true);

	return;
}

1085
static int record__synthesize_workload(struct record *rec, bool tail)
1086
{
1087
	int err;
1088
	struct perf_thread_map *thread_map;
1089

1090 1091 1092
	if (rec->opts.tail_synthesize != tail)
		return 0;

1093 1094 1095 1096 1097
	thread_map = thread_map__new_by_tid(rec->evlist->workload.pid);
	if (thread_map == NULL)
		return -1;

	err = perf_event__synthesize_thread_map(&rec->tool, thread_map,
1098 1099
						 process_synthesized_event,
						 &rec->session->machines.host,
1100
						 rec->opts.sample_address);
1101
	perf_thread_map__put(thread_map);
1102
	return err;
1103 1104
}

1105
static int record__synthesize(struct record *rec, bool tail);
1106

1107 1108 1109
static int
record__switch_output(struct record *rec, bool at_exit)
{
1110
	struct perf_data *data = &rec->data;
1111
	int fd, err;
1112
	char *new_filename;
1113 1114 1115 1116

	/* Same Size:      "2015122520103046"*/
	char timestamp[] = "InvalidTimestamp";

1117 1118
	record__aio_mmap_read_sync(rec);

1119 1120 1121 1122
	record__synthesize(rec, true);
	if (target__none(&rec->opts.target))
		record__synthesize_workload(rec, true);

1123 1124 1125 1126 1127 1128 1129 1130
	rec->samples = 0;
	record__finish_output(rec);
	err = fetch_current_timestamp(timestamp, sizeof(timestamp));
	if (err) {
		pr_err("Failed to get current timestamp\n");
		return -EINVAL;
	}

1131
	fd = perf_data__switch(data, timestamp,
1132
				    rec->session->header.data_offset,
1133
				    at_exit, &new_filename);
1134 1135 1136 1137 1138 1139 1140
	if (fd >= 0 && !at_exit) {
		rec->bytes_written = 0;
		rec->session->header.data_size = 0;
	}

	if (!quiet)
		fprintf(stderr, "[ perf record: Dump %s.%s ]\n",
J
Jiri Olsa 已提交
1141
			data->path, timestamp);
1142

1143 1144 1145 1146 1147 1148 1149 1150
	if (rec->switch_output.num_files) {
		int n = rec->switch_output.cur_file + 1;

		if (n >= rec->switch_output.num_files)
			n = 0;
		rec->switch_output.cur_file = n;
		if (rec->switch_output.filenames[n]) {
			remove(rec->switch_output.filenames[n]);
1151
			zfree(&rec->switch_output.filenames[n]);
1152 1153 1154 1155 1156 1157
		}
		rec->switch_output.filenames[n] = new_filename;
	} else {
		free(new_filename);
	}

1158
	/* Output tracking events */
1159
	if (!at_exit) {
1160
		record__synthesize(rec, false);
1161

1162 1163 1164 1165 1166 1167 1168 1169 1170 1171
		/*
		 * In 'perf record --switch-output' without -a,
		 * record__synthesize() in record__switch_output() won't
		 * generate tracking events because there's no thread_map
		 * in evlist. Which causes newly created perf.data doesn't
		 * contain map and comm information.
		 * Create a fake thread_map and directly call
		 * perf_event__synthesize_thread_map() for those events.
		 */
		if (target__none(&rec->opts.target))
1172
			record__synthesize_workload(rec, false);
1173
	}
1174 1175 1176
	return fd;
}

1177 1178 1179 1180 1181 1182 1183
static volatile int workload_exec_errno;

/*
 * perf_evlist__prepare_workload will send a SIGUSR1
 * if the fork fails, since we asked by setting its
 * want_signal to true.
 */
1184 1185
static void workload_exec_failed_signal(int signo __maybe_unused,
					siginfo_t *info,
1186 1187 1188 1189 1190 1191 1192
					void *ucontext __maybe_unused)
{
	workload_exec_errno = info->si_value.sival_int;
	done = 1;
	child_finished = 1;
}

1193
static void snapshot_sig_handler(int sig);
1194
static void alarm_sig_handler(int sig);
1195

1196
static const struct perf_event_mmap_page *
1197
perf_evlist__pick_pc(struct evlist *evlist)
1198
{
1199 1200 1201
	if (evlist) {
		if (evlist->mmap && evlist->mmap[0].base)
			return evlist->mmap[0].base;
1202 1203
		if (evlist->overwrite_mmap && evlist->overwrite_mmap[0].base)
			return evlist->overwrite_mmap[0].base;
1204
	}
1205 1206 1207
	return NULL;
}

1208 1209
static const struct perf_event_mmap_page *record__pick_pc(struct record *rec)
{
1210 1211 1212 1213 1214
	const struct perf_event_mmap_page *pc;

	pc = perf_evlist__pick_pc(rec->evlist);
	if (pc)
		return pc;
1215 1216 1217
	return NULL;
}

1218
static int record__synthesize(struct record *rec, bool tail)
1219 1220 1221
{
	struct perf_session *session = rec->session;
	struct machine *machine = &session->machines.host;
1222
	struct perf_data *data = &rec->data;
1223 1224
	struct record_opts *opts = &rec->opts;
	struct perf_tool *tool = &rec->tool;
1225
	int fd = perf_data__fd(data);
1226 1227
	int err = 0;

1228 1229 1230
	if (rec->opts.tail_synthesize != tail)
		return 0;

1231
	if (data->is_pipe) {
1232 1233 1234 1235
		/*
		 * We need to synthesize events first, because some
		 * features works on top of them (on report side).
		 */
1236
		err = perf_event__synthesize_attrs(tool, rec->evlist,
1237 1238 1239 1240 1241 1242
						   process_synthesized_event);
		if (err < 0) {
			pr_err("Couldn't synthesize attrs.\n");
			goto out;
		}

1243 1244 1245 1246 1247 1248 1249
		err = perf_event__synthesize_features(tool, session, rec->evlist,
						      process_synthesized_event);
		if (err < 0) {
			pr_err("Couldn't synthesize features.\n");
			return err;
		}

1250
		if (have_tracepoints(&rec->evlist->core.entries)) {
1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268
			/*
			 * FIXME err <= 0 here actually means that
			 * there were no tracepoints so its not really
			 * an error, just that we don't need to
			 * synthesize anything.  We really have to
			 * return this more properly and also
			 * propagate errors that now are calling die()
			 */
			err = perf_event__synthesize_tracing_data(tool,	fd, rec->evlist,
								  process_synthesized_event);
			if (err <= 0) {
				pr_err("Couldn't record tracing data.\n");
				goto out;
			}
			rec->bytes_written += err;
		}
	}

1269
	err = perf_event__synth_time_conv(record__pick_pc(rec), tool,
1270 1271 1272 1273
					  process_synthesized_event, machine);
	if (err)
		goto out;

1274 1275 1276 1277 1278 1279 1280
	if (rec->opts.full_auxtrace) {
		err = perf_event__synthesize_auxtrace_info(rec->itr, tool,
					session, process_synthesized_event);
		if (err)
			goto out;
	}

1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293
	if (!perf_evlist__exclude_kernel(rec->evlist)) {
		err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
							 machine);
		WARN_ONCE(err < 0, "Couldn't record kernel reference relocation symbol\n"
				   "Symbol resolution may be skewed if relocation was used (e.g. kexec).\n"
				   "Check /proc/kallsyms permission or run as root.\n");

		err = perf_event__synthesize_modules(tool, process_synthesized_event,
						     machine);
		WARN_ONCE(err < 0, "Couldn't record kernel module information.\n"
				   "Symbol resolution may be skewed if relocation was used (e.g. kexec).\n"
				   "Check /proc/modules permission or run as root.\n");
	}
1294 1295 1296 1297 1298 1299

	if (perf_guest) {
		machines__process_guests(&session->machines,
					 perf_event__synthesize_guest_os, tool);
	}

1300 1301 1302 1303 1304 1305 1306
	err = perf_event__synthesize_extra_attr(&rec->tool,
						rec->evlist,
						process_synthesized_event,
						data->is_pipe);
	if (err)
		goto out;

1307
	err = perf_event__synthesize_thread_map2(&rec->tool, rec->evlist->core.threads,
1308 1309 1310 1311 1312 1313 1314
						 process_synthesized_event,
						NULL);
	if (err < 0) {
		pr_err("Couldn't synthesize thread map.\n");
		return err;
	}

1315
	err = perf_event__synthesize_cpu_map(&rec->tool, rec->evlist->core.cpus,
1316 1317 1318 1319 1320 1321
					     process_synthesized_event, NULL);
	if (err < 0) {
		pr_err("Couldn't synthesize cpu map.\n");
		return err;
	}

1322
	err = perf_event__synthesize_bpf_events(session, process_synthesized_event,
1323 1324 1325 1326
						machine, opts);
	if (err < 0)
		pr_warning("Couldn't synthesize bpf events.\n");

1327
	err = __machine__synthesize_threads(machine, tool, &opts->target, rec->evlist->core.threads,
1328
					    process_synthesized_event, opts->sample_address,
1329
					    1);
1330 1331 1332 1333
out:
	return err;
}

1334
static int __cmd_record(struct record *rec, int argc, const char **argv)
1335
{
1336
	int err;
1337
	int status = 0;
1338
	unsigned long waking = 0;
1339
	const bool forks = argc > 0;
1340
	struct perf_tool *tool = &rec->tool;
1341
	struct record_opts *opts = &rec->opts;
1342
	struct perf_data *data = &rec->data;
1343
	struct perf_session *session;
1344
	bool disabled = false, draining = false;
1345
	struct evlist *sb_evlist = NULL;
1346
	int fd;
1347
	float ratio = 0;
1348

1349
	atexit(record__sig_exit);
1350 1351
	signal(SIGCHLD, sig_handler);
	signal(SIGINT, sig_handler);
1352
	signal(SIGTERM, sig_handler);
W
Wang Nan 已提交
1353
	signal(SIGSEGV, sigsegv_handler);
1354

1355 1356 1357
	if (rec->opts.record_namespaces)
		tool->namespace_events = true;

1358
	if (rec->opts.auxtrace_snapshot_mode || rec->switch_output.enabled) {
1359
		signal(SIGUSR2, snapshot_sig_handler);
1360 1361
		if (rec->opts.auxtrace_snapshot_mode)
			trigger_on(&auxtrace_snapshot_trigger);
1362
		if (rec->switch_output.enabled)
1363
			trigger_on(&switch_output_trigger);
1364
	} else {
1365
		signal(SIGUSR2, SIG_IGN);
1366
	}
1367

1368
	session = perf_session__new(data, false, tool);
1369
	if (IS_ERR(session)) {
A
Adrien BAK 已提交
1370
		pr_err("Perf session creation failed.\n");
1371
		return PTR_ERR(session);
1372 1373
	}

1374
	fd = perf_data__fd(data);
1375 1376
	rec->session = session;

1377 1378 1379 1380 1381 1382 1383 1384
	if (zstd_init(&session->zstd_data, rec->opts.comp_level) < 0) {
		pr_err("Compression initialization failed.\n");
		return -1;
	}

	session->header.env.comp_type  = PERF_COMP_ZSTD;
	session->header.env.comp_level = rec->opts.comp_level;

1385
	record__init_features(rec);
1386

1387 1388 1389
	if (rec->opts.use_clockid && rec->opts.clockid_res_ns)
		session->header.env.clockid_res_ns = rec->opts.clockid_res_ns;

1390
	if (forks) {
1391
		err = perf_evlist__prepare_workload(rec->evlist, &opts->target,
1392
						    argv, data->is_pipe,
1393
						    workload_exec_failed_signal);
1394 1395
		if (err < 0) {
			pr_err("Couldn't run the workload!\n");
1396
			status = err;
1397
			goto out_delete_session;
1398 1399 1400
		}
	}

J
Jiri Olsa 已提交
1401 1402 1403 1404 1405 1406
	/*
	 * If we have just single event and are sending data
	 * through pipe, we need to force the ids allocation,
	 * because we synthesize event name through the pipe
	 * and need the id for that.
	 */
1407
	if (data->is_pipe && rec->evlist->core.nr_entries == 1)
J
Jiri Olsa 已提交
1408 1409
		rec->opts.sample_id = true;

1410
	if (record__open(rec) != 0) {
1411
		err = -1;
1412
		goto out_child;
1413
	}
1414
	session->header.env.comp_mmap_len = session->evlist->mmap_len;
1415

1416 1417 1418 1419 1420 1421 1422 1423 1424 1425
	err = bpf__apply_obj_config();
	if (err) {
		char errbuf[BUFSIZ];

		bpf__strerror_apply_obj_config(err, errbuf, sizeof(errbuf));
		pr_err("ERROR: Apply config to BPF failed: %s\n",
			 errbuf);
		goto out_child;
	}

1426 1427 1428 1429 1430 1431 1432 1433 1434
	/*
	 * Normally perf_session__new would do this, but it doesn't have the
	 * evlist.
	 */
	if (rec->tool.ordered_events && !perf_evlist__sample_id_all(rec->evlist)) {
		pr_warning("WARNING: No sample_id_all support, falling back to unordered processing\n");
		rec->tool.ordered_events = false;
	}

1435
	if (!rec->evlist->nr_groups)
1436 1437
		perf_header__clear_feat(&session->header, HEADER_GROUP_DESC);

1438
	if (data->is_pipe) {
1439
		err = perf_header__write_pipe(fd);
1440
		if (err < 0)
1441
			goto out_child;
1442
	} else {
1443
		err = perf_session__write_header(session, rec->evlist, fd, false);
1444
		if (err < 0)
1445
			goto out_child;
1446 1447
	}

1448
	if (!rec->no_buildid
1449
	    && !perf_header__has_feat(&session->header, HEADER_BUILD_ID)) {
1450
		pr_err("Couldn't generate buildids. "
1451
		       "Use --no-buildid to profile anyway.\n");
1452
		err = -1;
1453
		goto out_child;
1454 1455
	}

1456 1457 1458
	if (!opts->no_bpf_event)
		bpf_event__add_sb_event(&sb_evlist, &session->header.env);

1459 1460 1461 1462 1463
	if (perf_evlist__start_sb_thread(sb_evlist, &rec->opts.target)) {
		pr_debug("Couldn't start the BPF side band thread:\nBPF programs starting from now on won't be annotatable\n");
		opts->no_bpf_event = true;
	}

1464
	err = record__synthesize(rec, false);
1465
	if (err < 0)
1466
		goto out_child;
1467

1468
	if (rec->realtime_prio) {
1469 1470
		struct sched_param param;

1471
		param.sched_priority = rec->realtime_prio;
1472
		if (sched_setscheduler(0, SCHED_FIFO, &param)) {
1473
			pr_err("Could not set realtime priority.\n");
1474
			err = -1;
1475
			goto out_child;
1476 1477 1478
		}
	}

1479 1480 1481 1482 1483
	/*
	 * When perf is starting the traced process, all the events
	 * (apart from group members) have enable_on_exec=1 set,
	 * so don't spoil it by prematurely enabling them.
	 */
1484
	if (!target__none(&opts->target) && !opts->initial_delay)
1485
		evlist__enable(rec->evlist);
1486

1487 1488 1489
	/*
	 * Let the child rip
	 */
1490
	if (forks) {
1491
		struct machine *machine = &session->machines.host;
1492
		union perf_event *event;
1493
		pid_t tgid;
1494 1495 1496 1497 1498 1499 1500

		event = malloc(sizeof(event->comm) + machine->id_hdr_size);
		if (event == NULL) {
			err = -ENOMEM;
			goto out_child;
		}

1501 1502 1503 1504 1505 1506
		/*
		 * Some H/W events are generated before COMM event
		 * which is emitted during exec(), so perf script
		 * cannot see a correct process name for those events.
		 * Synthesize COMM event to prevent it.
		 */
1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530
		tgid = perf_event__synthesize_comm(tool, event,
						   rec->evlist->workload.pid,
						   process_synthesized_event,
						   machine);
		free(event);

		if (tgid == -1)
			goto out_child;

		event = malloc(sizeof(event->namespaces) +
			       (NR_NAMESPACES * sizeof(struct perf_ns_link_info)) +
			       machine->id_hdr_size);
		if (event == NULL) {
			err = -ENOMEM;
			goto out_child;
		}

		/*
		 * Synthesize NAMESPACES event for the command specified.
		 */
		perf_event__synthesize_namespaces(tool, event,
						  rec->evlist->workload.pid,
						  tgid, process_synthesized_event,
						  machine);
1531
		free(event);
1532

1533
		perf_evlist__start_workload(rec->evlist);
1534
	}
1535

1536
	if (opts->initial_delay) {
1537
		usleep(opts->initial_delay * USEC_PER_MSEC);
1538
		evlist__enable(rec->evlist);
1539 1540
	}

1541
	trigger_ready(&auxtrace_snapshot_trigger);
1542
	trigger_ready(&switch_output_trigger);
W
Wang Nan 已提交
1543
	perf_hooks__invoke_record_start();
1544
	for (;;) {
1545
		unsigned long long hits = rec->samples;
1546

1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557
		/*
		 * rec->evlist->bkw_mmap_state is possible to be
		 * BKW_MMAP_EMPTY here: when done == true and
		 * hits != rec->samples in previous round.
		 *
		 * perf_evlist__toggle_bkw_mmap ensure we never
		 * convert BKW_MMAP_EMPTY to BKW_MMAP_DATA_PENDING.
		 */
		if (trigger_is_hit(&switch_output_trigger) || done || draining)
			perf_evlist__toggle_bkw_mmap(rec->evlist, BKW_MMAP_DATA_PENDING);

1558
		if (record__mmap_read_all(rec, false) < 0) {
1559
			trigger_error(&auxtrace_snapshot_trigger);
1560
			trigger_error(&switch_output_trigger);
1561
			err = -1;
1562
			goto out_child;
1563
		}
1564

1565 1566
		if (auxtrace_record__snapshot_started) {
			auxtrace_record__snapshot_started = 0;
1567
			if (!trigger_is_error(&auxtrace_snapshot_trigger))
1568
				record__read_auxtrace_snapshot(rec, false);
1569
			if (trigger_is_error(&auxtrace_snapshot_trigger)) {
1570 1571 1572 1573 1574 1575
				pr_err("AUX area tracing snapshot failed\n");
				err = -1;
				goto out_child;
			}
		}

1576
		if (trigger_is_hit(&switch_output_trigger)) {
1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587
			/*
			 * If switch_output_trigger is hit, the data in
			 * overwritable ring buffer should have been collected,
			 * so bkw_mmap_state should be set to BKW_MMAP_EMPTY.
			 *
			 * If SIGUSR2 raise after or during record__mmap_read_all(),
			 * record__mmap_read_all() didn't collect data from
			 * overwritable ring buffer. Read again.
			 */
			if (rec->evlist->bkw_mmap_state == BKW_MMAP_RUNNING)
				continue;
1588 1589
			trigger_ready(&switch_output_trigger);

1590 1591 1592 1593 1594 1595 1596
			/*
			 * Reenable events in overwrite ring buffer after
			 * record__mmap_read_all(): we should have collected
			 * data from it.
			 */
			perf_evlist__toggle_bkw_mmap(rec->evlist, BKW_MMAP_RUNNING);

1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607
			if (!quiet)
				fprintf(stderr, "[ perf record: dump data: Woken up %ld times ]\n",
					waking);
			waking = 0;
			fd = record__switch_output(rec, false);
			if (fd < 0) {
				pr_err("Failed to switch to new file\n");
				trigger_error(&switch_output_trigger);
				err = fd;
				goto out_child;
			}
1608 1609 1610 1611

			/* re-arm the alarm */
			if (rec->switch_output.time)
				alarm(rec->switch_output.time);
1612 1613
		}

1614
		if (hits == rec->samples) {
1615
			if (done || draining)
1616
				break;
1617
			err = perf_evlist__poll(rec->evlist, -1);
1618 1619 1620 1621 1622
			/*
			 * Propagate error, only if there's any. Ignore positive
			 * number of returned events and interrupt error.
			 */
			if (err > 0 || (err < 0 && errno == EINTR))
1623
				err = 0;
1624
			waking++;
1625 1626 1627

			if (perf_evlist__filter_pollfd(rec->evlist, POLLERR | POLLHUP) == 0)
				draining = true;
1628 1629
		}

1630 1631 1632 1633 1634
		/*
		 * When perf is starting the traced process, at the end events
		 * die with the process and we wait for that. Thus no need to
		 * disable events in this case.
		 */
1635
		if (done && !disabled && !target__none(&opts->target)) {
1636
			trigger_off(&auxtrace_snapshot_trigger);
1637
			evlist__disable(rec->evlist);
1638 1639
			disabled = true;
		}
1640
	}
1641

1642
	trigger_off(&auxtrace_snapshot_trigger);
1643
	trigger_off(&switch_output_trigger);
1644

1645 1646 1647
	if (opts->auxtrace_snapshot_on_exit)
		record__auxtrace_snapshot_exit(rec);

1648
	if (forks && workload_exec_errno) {
1649
		char msg[STRERR_BUFSIZE];
1650
		const char *emsg = str_error_r(workload_exec_errno, msg, sizeof(msg));
1651 1652
		pr_err("Workload failed: %s\n", emsg);
		err = -1;
1653
		goto out_child;
1654 1655
	}

1656
	if (!quiet)
1657
		fprintf(stderr, "[ perf record: Woken up %ld times to write data ]\n", waking);
1658

1659 1660 1661
	if (target__none(&rec->opts.target))
		record__synthesize_workload(rec, true);

1662
out_child:
1663
	record__mmap_read_all(rec, true);
1664 1665
	record__aio_mmap_read_sync(rec);

1666 1667 1668 1669 1670
	if (rec->session->bytes_transferred && rec->session->bytes_compressed) {
		ratio = (float)rec->session->bytes_transferred/(float)rec->session->bytes_compressed;
		session->header.env.comp_ratio = ratio + 0.5;
	}

1671 1672
	if (forks) {
		int exit_status;
1673

1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687
		if (!child_finished)
			kill(rec->evlist->workload.pid, SIGTERM);

		wait(&exit_status);

		if (err < 0)
			status = err;
		else if (WIFEXITED(exit_status))
			status = WEXITSTATUS(exit_status);
		else if (WIFSIGNALED(exit_status))
			signr = WTERMSIG(exit_status);
	} else
		status = err;

1688
	record__synthesize(rec, true);
1689 1690 1691
	/* this will be recalculated during process_buildids() */
	rec->samples = 0;

1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702
	if (!err) {
		if (!rec->timestamp_filename) {
			record__finish_output(rec);
		} else {
			fd = record__switch_output(rec, true);
			if (fd < 0) {
				status = fd;
				goto out_delete_session;
			}
		}
	}
1703

W
Wang Nan 已提交
1704 1705
	perf_hooks__invoke_record_end();

1706 1707
	if (!err && !quiet) {
		char samples[128];
1708 1709
		const char *postfix = rec->timestamp_filename ?
					".<timestamp>" : "";
1710

1711
		if (rec->samples && !rec->opts.full_auxtrace)
1712 1713 1714 1715 1716
			scnprintf(samples, sizeof(samples),
				  " (%" PRIu64 " samples)", rec->samples);
		else
			samples[0] = '\0';

1717
		fprintf(stderr,	"[ perf record: Captured and wrote %.3f MB %s%s%s",
1718
			perf_data__size(data) / 1024.0 / 1024.0,
J
Jiri Olsa 已提交
1719
			data->path, postfix, samples);
1720 1721 1722 1723 1724 1725
		if (ratio) {
			fprintf(stderr,	", compressed (original %.3f MB, ratio is %.3f)",
					rec->session->bytes_transferred / 1024.0 / 1024.0,
					ratio);
		}
		fprintf(stderr, " ]\n");
1726 1727
	}

1728
out_delete_session:
1729
	zstd_fini(&session->zstd_data);
1730
	perf_session__delete(session);
1731 1732 1733

	if (!opts->no_bpf_event)
		perf_evlist__stop_sb_thread(sb_evlist);
1734
	return status;
1735
}
1736

1737
static void callchain_debug(struct callchain_param *callchain)
J
Jiri Olsa 已提交
1738
{
1739
	static const char *str[CALLCHAIN_MAX] = { "NONE", "FP", "DWARF", "LBR" };
1740

1741
	pr_debug("callchain: type %s\n", str[callchain->record_mode]);
1742

1743
	if (callchain->record_mode == CALLCHAIN_DWARF)
J
Jiri Olsa 已提交
1744
		pr_debug("callchain: stack dump size %d\n",
1745
			 callchain->dump_size);
J
Jiri Olsa 已提交
1746 1747
}

1748 1749 1750
int record_opts__parse_callchain(struct record_opts *record,
				 struct callchain_param *callchain,
				 const char *arg, bool unset)
J
Jiri Olsa 已提交
1751 1752
{
	int ret;
1753
	callchain->enabled = !unset;
1754

J
Jiri Olsa 已提交
1755 1756
	/* --no-call-graph */
	if (unset) {
1757
		callchain->record_mode = CALLCHAIN_NONE;
J
Jiri Olsa 已提交
1758 1759 1760 1761
		pr_debug("callchain: disabled\n");
		return 0;
	}

1762
	ret = parse_callchain_record_opt(arg, callchain);
1763 1764
	if (!ret) {
		/* Enable data address sampling for DWARF unwind. */
1765
		if (callchain->record_mode == CALLCHAIN_DWARF)
1766
			record->sample_address = true;
1767
		callchain_debug(callchain);
1768
	}
1769 1770 1771 1772

	return ret;
}

1773 1774 1775 1776 1777 1778 1779
int record_parse_callchain_opt(const struct option *opt,
			       const char *arg,
			       int unset)
{
	return record_opts__parse_callchain(opt->value, &callchain_param, arg, unset);
}

1780
int record_callchain_opt(const struct option *opt,
J
Jiri Olsa 已提交
1781 1782 1783
			 const char *arg __maybe_unused,
			 int unset __maybe_unused)
{
1784
	struct callchain_param *callchain = opt->value;
1785

1786
	callchain->enabled = true;
J
Jiri Olsa 已提交
1787

1788 1789
	if (callchain->record_mode == CALLCHAIN_NONE)
		callchain->record_mode = CALLCHAIN_FP;
1790

1791
	callchain_debug(callchain);
J
Jiri Olsa 已提交
1792 1793 1794
	return 0;
}

1795 1796
static int perf_record_config(const char *var, const char *value, void *cb)
{
1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809
	struct record *rec = cb;

	if (!strcmp(var, "record.build-id")) {
		if (!strcmp(value, "cache"))
			rec->no_buildid_cache = false;
		else if (!strcmp(value, "no-cache"))
			rec->no_buildid_cache = true;
		else if (!strcmp(value, "skip"))
			rec->no_buildid = true;
		else
			return -1;
		return 0;
	}
1810 1811 1812 1813
	if (!strcmp(var, "record.call-graph")) {
		var = "call-graph.record-mode";
		return perf_default_config(var, value, cb);
	}
1814 1815 1816 1817 1818 1819 1820
#ifdef HAVE_AIO_SUPPORT
	if (!strcmp(var, "record.aio")) {
		rec->opts.nr_cblocks = strtol(value, NULL, 0);
		if (!rec->opts.nr_cblocks)
			rec->opts.nr_cblocks = nr_cblocks_default;
	}
#endif
1821

1822
	return 0;
1823 1824
}

1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867
struct clockid_map {
	const char *name;
	int clockid;
};

#define CLOCKID_MAP(n, c)	\
	{ .name = n, .clockid = (c), }

#define CLOCKID_END	{ .name = NULL, }


/*
 * Add the missing ones, we need to build on many distros...
 */
#ifndef CLOCK_MONOTONIC_RAW
#define CLOCK_MONOTONIC_RAW 4
#endif
#ifndef CLOCK_BOOTTIME
#define CLOCK_BOOTTIME 7
#endif
#ifndef CLOCK_TAI
#define CLOCK_TAI 11
#endif

static const struct clockid_map clockids[] = {
	/* available for all events, NMI safe */
	CLOCKID_MAP("monotonic", CLOCK_MONOTONIC),
	CLOCKID_MAP("monotonic_raw", CLOCK_MONOTONIC_RAW),

	/* available for some events */
	CLOCKID_MAP("realtime", CLOCK_REALTIME),
	CLOCKID_MAP("boottime", CLOCK_BOOTTIME),
	CLOCKID_MAP("tai", CLOCK_TAI),

	/* available for the lazy */
	CLOCKID_MAP("mono", CLOCK_MONOTONIC),
	CLOCKID_MAP("raw", CLOCK_MONOTONIC_RAW),
	CLOCKID_MAP("real", CLOCK_REALTIME),
	CLOCKID_MAP("boot", CLOCK_BOOTTIME),

	CLOCKID_END,
};

1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880
static int get_clockid_res(clockid_t clk_id, u64 *res_ns)
{
	struct timespec res;

	*res_ns = 0;
	if (!clock_getres(clk_id, &res))
		*res_ns = res.tv_nsec + res.tv_sec * NSEC_PER_SEC;
	else
		pr_warning("WARNING: Failed to determine specified clock resolution.\n");

	return 0;
}

1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903
static int parse_clockid(const struct option *opt, const char *str, int unset)
{
	struct record_opts *opts = (struct record_opts *)opt->value;
	const struct clockid_map *cm;
	const char *ostr = str;

	if (unset) {
		opts->use_clockid = 0;
		return 0;
	}

	/* no arg passed */
	if (!str)
		return 0;

	/* no setting it twice */
	if (opts->use_clockid)
		return -1;

	opts->use_clockid = true;

	/* if its a number, we're done */
	if (sscanf(str, "%d", &opts->clockid) == 1)
1904
		return get_clockid_res(opts->clockid, &opts->clockid_res_ns);
1905 1906 1907 1908 1909 1910 1911 1912

	/* allow a "CLOCK_" prefix to the name */
	if (!strncasecmp(str, "CLOCK_", 6))
		str += 6;

	for (cm = clockids; cm->name; cm++) {
		if (!strcasecmp(str, cm->name)) {
			opts->clockid = cm->clockid;
1913 1914
			return get_clockid_res(opts->clockid,
					       &opts->clockid_res_ns);
1915 1916 1917 1918 1919 1920 1921 1922
		}
	}

	opts->use_clockid = false;
	ui__warning("unknown clockid %s, check man page\n", ostr);
	return -1;
}

1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937
static int record__parse_affinity(const struct option *opt, const char *str, int unset)
{
	struct record_opts *opts = (struct record_opts *)opt->value;

	if (unset || !str)
		return 0;

	if (!strcasecmp(str, "node"))
		opts->affinity = PERF_AFFINITY_NODE;
	else if (!strcasecmp(str, "cpu"))
		opts->affinity = PERF_AFFINITY_CPU;

	return 0;
}

1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980
static int record__parse_mmap_pages(const struct option *opt,
				    const char *str,
				    int unset __maybe_unused)
{
	struct record_opts *opts = opt->value;
	char *s, *p;
	unsigned int mmap_pages;
	int ret;

	if (!str)
		return -EINVAL;

	s = strdup(str);
	if (!s)
		return -ENOMEM;

	p = strchr(s, ',');
	if (p)
		*p = '\0';

	if (*s) {
		ret = __perf_evlist__parse_mmap_pages(&mmap_pages, s);
		if (ret)
			goto out_free;
		opts->mmap_pages = mmap_pages;
	}

	if (!p) {
		ret = 0;
		goto out_free;
	}

	ret = __perf_evlist__parse_mmap_pages(&mmap_pages, p + 1);
	if (ret)
		goto out_free;

	opts->auxtrace_mmap_pages = mmap_pages;

out_free:
	free(s);
	return ret;
}

1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997
static void switch_output_size_warn(struct record *rec)
{
	u64 wakeup_size = perf_evlist__mmap_size(rec->opts.mmap_pages);
	struct switch_output *s = &rec->switch_output;

	wakeup_size /= 2;

	if (s->size < wakeup_size) {
		char buf[100];

		unit_number__scnprintf(buf, sizeof(buf), wakeup_size);
		pr_warning("WARNING: switch-output data size lower than "
			   "wakeup kernel buffer size (%s) "
			   "expect bigger perf.data sizes\n", buf);
	}
}

1998 1999 2000
static int switch_output_setup(struct record *rec)
{
	struct switch_output *s = &rec->switch_output;
2001 2002 2003 2004 2005 2006 2007
	static struct parse_tag tags_size[] = {
		{ .tag  = 'B', .mult = 1       },
		{ .tag  = 'K', .mult = 1 << 10 },
		{ .tag  = 'M', .mult = 1 << 20 },
		{ .tag  = 'G', .mult = 1 << 30 },
		{ .tag  = 0 },
	};
2008 2009 2010 2011 2012 2013 2014
	static struct parse_tag tags_time[] = {
		{ .tag  = 's', .mult = 1        },
		{ .tag  = 'm', .mult = 60       },
		{ .tag  = 'h', .mult = 60*60    },
		{ .tag  = 'd', .mult = 60*60*24 },
		{ .tag  = 0 },
	};
2015
	unsigned long val;
2016 2017 2018 2019 2020 2021 2022

	if (!s->set)
		return 0;

	if (!strcmp(s->str, "signal")) {
		s->signal = true;
		pr_debug("switch-output with SIGUSR2 signal\n");
2023 2024 2025 2026 2027 2028 2029 2030
		goto enabled;
	}

	val = parse_tag_value(s->str, tags_size);
	if (val != (unsigned long) -1) {
		s->size = val;
		pr_debug("switch-output with %s size threshold\n", s->str);
		goto enabled;
2031 2032
	}

2033 2034 2035 2036 2037 2038 2039 2040
	val = parse_tag_value(s->str, tags_time);
	if (val != (unsigned long) -1) {
		s->time = val;
		pr_debug("switch-output with %s time threshold (%lu seconds)\n",
			 s->str, s->time);
		goto enabled;
	}

2041
	return -1;
2042 2043 2044 2045

enabled:
	rec->timestamp_filename = true;
	s->enabled              = true;
2046 2047 2048 2049

	if (s->size && !rec->opts.no_buffering)
		switch_output_size_warn(rec);

2050
	return 0;
2051 2052
}

2053
static const char * const __record_usage[] = {
2054 2055
	"perf record [<options>] [<command>]",
	"perf record [<options>] -- <command> [<options>]",
2056 2057
	NULL
};
2058
const char * const *record_usage = __record_usage;
2059

2060
/*
2061 2062
 * XXX Ideally would be local to cmd_record() and passed to a record__new
 * because we need to have access to it in record__exit, that is called
2063 2064 2065 2066 2067 2068 2069
 * after cmd_record() exits, but since record_options need to be accessible to
 * builtin-script, leave it here.
 *
 * At least we don't ouch it in all the other functions here directly.
 *
 * Just say no to tons of global variables, sigh.
 */
2070
static struct record record = {
2071
	.opts = {
2072
		.sample_time	     = true,
2073 2074 2075
		.mmap_pages	     = UINT_MAX,
		.user_freq	     = UINT_MAX,
		.user_interval	     = ULLONG_MAX,
2076
		.freq		     = 4000,
N
Namhyung Kim 已提交
2077 2078
		.target		     = {
			.uses_mmap   = true,
2079
			.default_per_cpu = true,
N
Namhyung Kim 已提交
2080
		},
2081
		.mmap_flush          = MMAP_FLUSH_DEFAULT,
2082
	},
2083 2084 2085
	.tool = {
		.sample		= process_sample_event,
		.fork		= perf_event__process_fork,
2086
		.exit		= perf_event__process_exit,
2087
		.comm		= perf_event__process_comm,
2088
		.namespaces	= perf_event__process_namespaces,
2089 2090
		.mmap		= perf_event__process_mmap,
		.mmap2		= perf_event__process_mmap2,
2091
		.ordered_events	= true,
2092
	},
2093
};
2094

2095 2096
const char record_callchain_help[] = CALLCHAIN_RECORD_HELP
	"\n\t\t\t\tDefault: fp";
2097

2098 2099
static bool dry_run;

2100 2101 2102
/*
 * XXX Will stay a global variable till we fix builtin-script.c to stop messing
 * with it and switch to use the library functions in perf_evlist that came
2103
 * from builtin-record.c, i.e. use record_opts,
2104 2105 2106
 * perf_evlist__prepare_workload, etc instead of fork+exec'in 'perf record',
 * using pipes, etc.
 */
2107
static struct option __record_options[] = {
2108
	OPT_CALLBACK('e', "event", &record.evlist, "event",
2109
		     "event selector. use 'perf list' to list available events",
2110
		     parse_events_option),
2111
	OPT_CALLBACK(0, "filter", &record.evlist, "filter",
L
Li Zefan 已提交
2112
		     "event filter", parse_filter),
2113 2114 2115
	OPT_CALLBACK_NOOPT(0, "exclude-perf", &record.evlist,
			   NULL, "don't record events from perf itself",
			   exclude_perf),
2116
	OPT_STRING('p', "pid", &record.opts.target.pid, "pid",
2117
		    "record events on existing process id"),
2118
	OPT_STRING('t', "tid", &record.opts.target.tid, "tid",
2119
		    "record events on existing thread id"),
2120
	OPT_INTEGER('r', "realtime", &record.realtime_prio,
2121
		    "collect data with this RT SCHED_FIFO priority"),
2122
	OPT_BOOLEAN(0, "no-buffering", &record.opts.no_buffering,
2123
		    "collect data without buffering"),
2124
	OPT_BOOLEAN('R', "raw-samples", &record.opts.raw_samples,
2125
		    "collect raw sample records from all opened counters"),
2126
	OPT_BOOLEAN('a', "all-cpus", &record.opts.target.system_wide,
2127
			    "system-wide collection from all CPUs"),
2128
	OPT_STRING('C', "cpu", &record.opts.target.cpu_list, "cpu",
2129
		    "list of cpus to monitor"),
2130
	OPT_U64('c', "count", &record.opts.user_interval, "event period to sample"),
J
Jiri Olsa 已提交
2131
	OPT_STRING('o', "output", &record.data.path, "file",
I
Ingo Molnar 已提交
2132
		    "output file name"),
2133 2134 2135
	OPT_BOOLEAN_SET('i', "no-inherit", &record.opts.no_inherit,
			&record.opts.no_inherit_set,
			"child tasks do not inherit counters"),
2136 2137
	OPT_BOOLEAN(0, "tail-synthesize", &record.opts.tail_synthesize,
		    "synthesize non-sample events at the end of output"),
W
Wang Nan 已提交
2138
	OPT_BOOLEAN(0, "overwrite", &record.opts.overwrite, "use overwrite mode"),
2139
	OPT_BOOLEAN(0, "no-bpf-event", &record.opts.no_bpf_event, "record bpf events"),
2140 2141
	OPT_BOOLEAN(0, "strict-freq", &record.opts.strict_freq,
		    "Fail if the specified frequency can't be used"),
2142 2143 2144
	OPT_CALLBACK('F', "freq", &record.opts, "freq or 'max'",
		     "profile at this frequency",
		      record__parse_freq),
2145 2146 2147
	OPT_CALLBACK('m', "mmap-pages", &record.opts, "pages[,pages]",
		     "number of mmap data pages and AUX area tracing mmap pages",
		     record__parse_mmap_pages),
2148 2149 2150
	OPT_CALLBACK(0, "mmap-flush", &record.opts, "number",
		     "Minimal number of bytes that is extracted from mmap data pages (default: 1)",
		     record__mmap_flush_parse),
2151
	OPT_BOOLEAN(0, "group", &record.opts.group,
2152
		    "put the counters into a counter group"),
2153
	OPT_CALLBACK_NOOPT('g', NULL, &callchain_param,
J
Jiri Olsa 已提交
2154 2155 2156
			   NULL, "enables call-graph recording" ,
			   &record_callchain_opt),
	OPT_CALLBACK(0, "call-graph", &record.opts,
2157
		     "record_mode[,record_size]", record_callchain_help,
J
Jiri Olsa 已提交
2158
		     &record_parse_callchain_opt),
2159
	OPT_INCR('v', "verbose", &verbose,
2160
		    "be more verbose (show counter open errors, etc)"),
2161
	OPT_BOOLEAN('q', "quiet", &quiet, "don't print any message"),
2162
	OPT_BOOLEAN('s', "stat", &record.opts.inherit_stat,
2163
		    "per thread counts"),
2164
	OPT_BOOLEAN('d', "data", &record.opts.sample_address, "Record the sample addresses"),
2165 2166
	OPT_BOOLEAN(0, "phys-data", &record.opts.sample_phys_addr,
		    "Record the sample physical addresses"),
J
Jiri Olsa 已提交
2167
	OPT_BOOLEAN(0, "sample-cpu", &record.opts.sample_cpu, "Record the sample cpu"),
2168 2169 2170
	OPT_BOOLEAN_SET('T', "timestamp", &record.opts.sample_time,
			&record.opts.sample_time_set,
			"Record the sample timestamps"),
2171 2172
	OPT_BOOLEAN_SET('P', "period", &record.opts.period, &record.opts.period_set,
			"Record the sample period"),
2173
	OPT_BOOLEAN('n', "no-samples", &record.opts.no_samples,
2174
		    "don't sample"),
2175 2176 2177 2178 2179 2180
	OPT_BOOLEAN_SET('N', "no-buildid-cache", &record.no_buildid_cache,
			&record.no_buildid_cache_set,
			"do not update the buildid cache"),
	OPT_BOOLEAN_SET('B', "no-buildid", &record.no_buildid,
			&record.no_buildid_set,
			"do not collect buildids in perf.data"),
2181
	OPT_CALLBACK('G', "cgroup", &record.evlist, "name",
S
Stephane Eranian 已提交
2182 2183
		     "monitor event in cgroup name only",
		     parse_cgroups),
2184
	OPT_UINTEGER('D', "delay", &record.opts.initial_delay,
2185
		  "ms to wait before starting measurement after program start"),
2186 2187
	OPT_STRING('u', "uid", &record.opts.target.uid_str, "user",
		   "user to profile"),
2188 2189 2190 2191 2192 2193 2194

	OPT_CALLBACK_NOOPT('b', "branch-any", &record.opts.branch_stack,
		     "branch any", "sample any taken branches",
		     parse_branch_stack),

	OPT_CALLBACK('j', "branch-filter", &record.opts.branch_stack,
		     "branch filter mask", "branch stack filter modes",
2195
		     parse_branch_stack),
2196 2197
	OPT_BOOLEAN('W', "weight", &record.opts.sample_weight,
		    "sample by weight (on special events only)"),
2198 2199
	OPT_BOOLEAN(0, "transaction", &record.opts.sample_transaction,
		    "sample transaction flags (special events only)"),
2200 2201
	OPT_BOOLEAN(0, "per-thread", &record.opts.target.per_thread,
		    "use per-thread mmaps"),
2202 2203
	OPT_CALLBACK_OPTARG('I', "intr-regs", &record.opts.sample_intr_regs, NULL, "any register",
		    "sample selected machine registers on interrupt,"
K
Kan Liang 已提交
2204
		    " use '-I?' to list register names", parse_intr_regs),
2205 2206
	OPT_CALLBACK_OPTARG(0, "user-regs", &record.opts.sample_user_regs, NULL, "any register",
		    "sample selected machine registers on interrupt,"
K
Kan Liang 已提交
2207
		    " use '--user-regs=?' to list register names", parse_user_regs),
2208 2209
	OPT_BOOLEAN(0, "running-time", &record.opts.running_time,
		    "Record running/enabled time of read (:S) events"),
2210 2211 2212
	OPT_CALLBACK('k', "clockid", &record.opts,
	"clockid", "clockid to use for events, see clock_gettime()",
	parse_clockid),
2213 2214
	OPT_STRING_OPTARG('S', "snapshot", &record.opts.auxtrace_snapshot_opts,
			  "opts", "AUX area tracing Snapshot Mode", ""),
2215
	OPT_UINTEGER(0, "proc-map-timeout", &proc_map_timeout,
2216
			"per thread proc mmap processing timeout in ms"),
2217 2218
	OPT_BOOLEAN(0, "namespaces", &record.opts.record_namespaces,
		    "Record namespaces events"),
2219 2220
	OPT_BOOLEAN(0, "switch-events", &record.opts.record_switch_events,
		    "Record context switch events"),
2221 2222 2223 2224 2225 2226
	OPT_BOOLEAN_FLAG(0, "all-kernel", &record.opts.all_kernel,
			 "Configure all used events to run in kernel space.",
			 PARSE_OPT_EXCLUSIVE),
	OPT_BOOLEAN_FLAG(0, "all-user", &record.opts.all_user,
			 "Configure all used events to run in user space.",
			 PARSE_OPT_EXCLUSIVE),
2227 2228 2229 2230
	OPT_BOOLEAN(0, "kernel-callchains", &record.opts.kernel_callchains,
		    "collect kernel callchains"),
	OPT_BOOLEAN(0, "user-callchains", &record.opts.user_callchains,
		    "collect user callchains"),
2231 2232 2233 2234
	OPT_STRING(0, "clang-path", &llvm_param.clang_path, "clang path",
		   "clang binary to use for compiling BPF scriptlets"),
	OPT_STRING(0, "clang-opt", &llvm_param.clang_opt, "clang options",
		   "options passed to clang when compiling BPF scriptlets"),
2235 2236
	OPT_STRING(0, "vmlinux", &symbol_conf.vmlinux_name,
		   "file", "vmlinux pathname"),
2237 2238
	OPT_BOOLEAN(0, "buildid-all", &record.buildid_all,
		    "Record build-id of all DSOs regardless of hits"),
2239 2240
	OPT_BOOLEAN(0, "timestamp-filename", &record.timestamp_filename,
		    "append timestamp to output filename"),
2241 2242
	OPT_BOOLEAN(0, "timestamp-boundary", &record.timestamp_boundary,
		    "Record timestamp boundary (time of first/last samples)"),
2243
	OPT_STRING_OPTARG_SET(0, "switch-output", &record.switch_output.str,
2244 2245
			  &record.switch_output.set, "signal or size[BKMG] or time[smhd]",
			  "Switch output when receiving SIGUSR2 (signal) or cross a size or time threshold",
2246
			  "signal"),
2247 2248
	OPT_INTEGER(0, "switch-max-files", &record.switch_output.num_files,
		   "Limit number of switch output generated files"),
2249 2250
	OPT_BOOLEAN(0, "dry-run", &dry_run,
		    "Parse options then exit"),
2251
#ifdef HAVE_AIO_SUPPORT
2252 2253
	OPT_CALLBACK_OPTARG(0, "aio", &record.opts,
		     &nr_cblocks_default, "n", "Use <n> control blocks in asynchronous trace writing mode (default: 1, max: 4)",
2254 2255
		     record__aio_parse),
#endif
2256 2257 2258
	OPT_CALLBACK(0, "affinity", &record.opts, "node|cpu",
		     "Set affinity mask of trace reading thread to NUMA node cpu mask or cpu of processed mmap buffer",
		     record__parse_affinity),
2259 2260 2261 2262 2263
#ifdef HAVE_ZSTD_SUPPORT
	OPT_CALLBACK_OPTARG('z', "compression-level", &record.opts, &comp_level_default,
			    "n", "Compressed records using specified level (default: 1 - fastest compression, 22 - greatest compression)",
			    record__parse_comp_level),
#endif
2264 2265 2266
	OPT_END()
};

2267 2268
struct option *record_options = __record_options;

2269
int cmd_record(int argc, const char **argv)
2270
{
2271
	int err;
2272
	struct record *rec = &record;
2273
	char errbuf[BUFSIZ];
2274

2275 2276
	setlocale(LC_ALL, "");

2277 2278 2279 2280 2281
#ifndef HAVE_LIBBPF_SUPPORT
# define set_nobuild(s, l, c) set_option_nobuild(record_options, s, l, "NO_LIBBPF=1", c)
	set_nobuild('\0', "clang-path", true);
	set_nobuild('\0', "clang-opt", true);
# undef set_nobuild
2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295
#endif

#ifndef HAVE_BPF_PROLOGUE
# if !defined (HAVE_DWARF_SUPPORT)
#  define REASON  "NO_DWARF=1"
# elif !defined (HAVE_LIBBPF_SUPPORT)
#  define REASON  "NO_LIBBPF=1"
# else
#  define REASON  "this architecture doesn't support BPF prologue"
# endif
# define set_nobuild(s, l, c) set_option_nobuild(record_options, s, l, REASON, c)
	set_nobuild('\0', "vmlinux", true);
# undef set_nobuild
# undef REASON
2296 2297
#endif

2298 2299 2300
	CPU_ZERO(&rec->affinity_mask);
	rec->opts.affinity = PERF_AFFINITY_SYS;

2301
	rec->evlist = evlist__new();
2302
	if (rec->evlist == NULL)
2303 2304
		return -ENOMEM;

2305 2306 2307
	err = perf_config(perf_record_config, rec);
	if (err)
		return err;
2308

2309
	argc = parse_options(argc, argv, record_options, record_usage,
2310
			    PARSE_OPT_STOP_AT_NON_OPTION);
2311 2312
	if (quiet)
		perf_quiet_option();
2313 2314

	/* Make system wide (-a) the default target. */
2315
	if (!argc && target__none(&rec->opts.target))
2316
		rec->opts.target.system_wide = true;
2317

2318
	if (nr_cgroups && !rec->opts.target.system_wide) {
2319 2320 2321
		usage_with_options_msg(record_usage, record_options,
			"cgroup monitoring only available in system-wide mode");

S
Stephane Eranian 已提交
2322
	}
2323 2324 2325 2326 2327 2328

	if (rec->opts.comp_level != 0) {
		pr_debug("Compression enabled, disabling build id collection at the end of the session.\n");
		rec->no_buildid = true;
	}

2329 2330
	if (rec->opts.record_switch_events &&
	    !perf_can_record_switch_events()) {
2331 2332 2333
		ui__error("kernel does not support recording context switch events\n");
		parse_options_usage(record_usage, record_options, "switch-events", 0);
		return -EINVAL;
2334
	}
S
Stephane Eranian 已提交
2335

2336 2337 2338 2339 2340
	if (switch_output_setup(rec)) {
		parse_options_usage(record_usage, record_options, "switch-output", 0);
		return -EINVAL;
	}

2341 2342 2343 2344 2345
	if (rec->switch_output.time) {
		signal(SIGALRM, alarm_sig_handler);
		alarm(rec->switch_output.time);
	}

2346 2347 2348 2349 2350 2351 2352
	if (rec->switch_output.num_files) {
		rec->switch_output.filenames = calloc(sizeof(char *),
						      rec->switch_output.num_files);
		if (!rec->switch_output.filenames)
			return -EINVAL;
	}

2353 2354 2355 2356 2357 2358 2359 2360
	/*
	 * Allow aliases to facilitate the lookup of symbols for address
	 * filters. Refer to auxtrace_parse_filters().
	 */
	symbol_conf.allow_aliases = true;

	symbol__init(NULL);

2361
	err = record__auxtrace_init(rec);
2362 2363 2364
	if (err)
		goto out;

2365
	if (dry_run)
A
Adrian Hunter 已提交
2366
		goto out;
2367

2368 2369 2370 2371 2372
	err = bpf__setup_stdout(rec->evlist);
	if (err) {
		bpf__strerror_setup_stdout(rec->evlist, err, errbuf, sizeof(errbuf));
		pr_err("ERROR: Setup BPF stdout failed: %s\n",
			 errbuf);
A
Adrian Hunter 已提交
2373
		goto out;
2374 2375
	}

2376 2377
	err = -ENOMEM;

2378
	if (rec->no_buildid_cache || rec->no_buildid) {
2379
		disable_buildid_cache();
2380
	} else if (rec->switch_output.enabled) {
2381 2382 2383 2384 2385 2386
		/*
		 * In 'perf record --switch-output', disable buildid
		 * generation by default to reduce data file switching
		 * overhead. Still generate buildid if they are required
		 * explicitly using
		 *
2387
		 *  perf record --switch-output --no-no-buildid \
2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407
		 *              --no-no-buildid-cache
		 *
		 * Following code equals to:
		 *
		 * if ((rec->no_buildid || !rec->no_buildid_set) &&
		 *     (rec->no_buildid_cache || !rec->no_buildid_cache_set))
		 *         disable_buildid_cache();
		 */
		bool disable = true;

		if (rec->no_buildid_set && !rec->no_buildid)
			disable = false;
		if (rec->no_buildid_cache_set && !rec->no_buildid_cache)
			disable = false;
		if (disable) {
			rec->no_buildid = true;
			rec->no_buildid_cache = true;
			disable_buildid_cache();
		}
	}
2408

2409 2410 2411
	if (record.opts.overwrite)
		record.opts.tail_synthesize = true;

2412
	if (rec->evlist->core.nr_entries == 0 &&
2413
	    __perf_evlist__add_default(rec->evlist, !record.opts.no_samples) < 0) {
2414
		pr_err("Not enough memory for event selector list\n");
2415
		goto out;
2416
	}
2417

2418 2419 2420
	if (rec->opts.target.tid && !rec->opts.no_inherit_set)
		rec->opts.no_inherit = true;

2421
	err = target__validate(&rec->opts.target);
2422
	if (err) {
2423
		target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
2424
		ui__warning("%s\n", errbuf);
2425 2426
	}

2427
	err = target__parse_uid(&rec->opts.target);
2428 2429
	if (err) {
		int saved_errno = errno;
2430

2431
		target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
2432
		ui__error("%s", errbuf);
2433 2434

		err = -saved_errno;
2435
		goto out;
2436
	}
2437

2438 2439
	/* Enable ignoring missing threads when -u/-p option is defined. */
	rec->opts.ignore_missing_thread = rec->opts.target.uid != UINT_MAX || rec->opts.target.pid;
2440

2441
	err = -ENOMEM;
2442
	if (perf_evlist__create_maps(rec->evlist, &rec->opts.target) < 0)
2443
		usage_with_options(record_usage, record_options);
2444

2445 2446
	err = auxtrace_record__options(rec->itr, rec->evlist, &rec->opts);
	if (err)
2447
		goto out;
2448

2449 2450 2451 2452 2453 2454 2455 2456
	/*
	 * We take all buildids when the file contains
	 * AUX area tracing data because we do not decode the
	 * trace because it would take too long.
	 */
	if (rec->opts.full_auxtrace)
		rec->buildid_all = true;

2457
	if (record_opts__config(&rec->opts)) {
2458
		err = -EINVAL;
2459
		goto out;
2460 2461
	}

2462 2463
	if (rec->opts.nr_cblocks > nr_cblocks_max)
		rec->opts.nr_cblocks = nr_cblocks_max;
2464
	pr_debug("nr_cblocks: %d\n", rec->opts.nr_cblocks);
2465

2466
	pr_debug("affinity: %s\n", affinity_tags[rec->opts.affinity]);
2467
	pr_debug("mmap flush: %d\n", rec->opts.mmap_flush);
2468

2469 2470 2471 2472
	if (rec->opts.comp_level > comp_level_max)
		rec->opts.comp_level = comp_level_max;
	pr_debug("comp level: %d\n", rec->opts.comp_level);

2473
	err = __cmd_record(&record, argc, argv);
2474
out:
2475
	evlist__delete(rec->evlist);
2476
	symbol__exit();
2477
	auxtrace_record__free(rec->itr);
2478
	return err;
2479
}
2480 2481 2482

static void snapshot_sig_handler(int sig __maybe_unused)
{
2483 2484
	struct record *rec = &record;

2485 2486 2487 2488 2489 2490
	if (trigger_is_ready(&auxtrace_snapshot_trigger)) {
		trigger_hit(&auxtrace_snapshot_trigger);
		auxtrace_record__snapshot_started = 1;
		if (auxtrace_record__snapshot_start(record.itr))
			trigger_error(&auxtrace_snapshot_trigger);
	}
2491

2492
	if (switch_output_signal(rec))
2493
		trigger_hit(&switch_output_trigger);
2494
}
2495 2496 2497 2498 2499 2500 2501 2502

static void alarm_sig_handler(int sig __maybe_unused)
{
	struct record *rec = &record;

	if (switch_output_time(rec))
		trigger_hit(&switch_output_trigger);
}