builtin-record.c 64.7 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 12

#include "perf.h"

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

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

47
#include <errno.h>
48
#include <inttypes.h>
49
#include <locale.h>
50
#include <poll.h>
51
#include <unistd.h>
52
#include <sched.h>
53
#include <signal.h>
54
#include <sys/mman.h>
55
#include <sys/wait.h>
56
#include <linux/time64.h>
57

58
struct switch_output {
59
	bool		 enabled;
60
	bool		 signal;
61
	unsigned long	 size;
62
	unsigned long	 time;
63 64
	const char	*str;
	bool		 set;
65 66 67
	char		 **filenames;
	int		 num_files;
	int		 cur_file;
68 69
};

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

91 92 93 94
static volatile int auxtrace_record__snapshot_started;
static DEFINE_TRIGGER(auxtrace_snapshot_trigger);
static DEFINE_TRIGGER(switch_output_trigger);

95 96 97 98
static const char *affinity_tags[PERF_AFFINITY_MAX] = {
	"SYS", "NODE", "CPU"
};

99 100 101 102 103 104 105 106 107 108 109 110 111
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);
}

112 113 114 115 116 117
static bool switch_output_time(struct record *rec)
{
	return rec->switch_output.time &&
	       trigger_is_ready(&switch_output_trigger);
}

118 119
static int record__write(struct record *rec, struct perf_mmap *map __maybe_unused,
			 void *bf, size_t size)
120
{
121 122 123
	struct perf_data_file *file = &rec->session->data->file;

	if (perf_data_file__write(file, bf, size) < 0) {
124 125
		pr_err("failed to write perf data, error: %m\n");
		return -1;
126
	}
127

128
	rec->bytes_written += size;
129 130 131 132

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

133
	return 0;
134 135
}

136 137
static int record__aio_enabled(struct record *rec);
static int record__comp_enabled(struct record *rec);
138 139 140
static size_t zstd_compress(struct perf_session *session, void *dst, size_t dst_size,
			    void *src, size_t src_size);

141 142 143 144 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 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
#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;
}

static int record__aio_complete(struct perf_mmap *md, struct aiocb *cblock)
{
	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;
		/*
191 192 193
		 * 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.
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
		 */
		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;
}

213
static int record__aio_sync(struct perf_mmap *md, bool sync_all)
214
{
215 216
	struct aiocb **aiocb = md->aio.aiocb;
	struct aiocb *cblocks = md->aio.cblocks;
217
	struct timespec timeout = { 0, 1000 * 1000  * 1 }; /* 1ms */
218
	int i, do_suspend;
219 220

	do {
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
		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;
240

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

248 249 250 251 252 253 254
struct record_aio {
	struct record	*rec;
	void		*data;
	size_t		size;
};

static int record__aio_pushfn(struct perf_mmap *map, void *to, void *buf, size_t size)
255
{
256
	struct record_aio *aio = to;
257

258 259 260 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 303
	/*
	 * 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;
}

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

305 306 307 308 309 310 311 312 313 314 315 316 317
	/*
	 * 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);
318
	if (!ret) {
319 320
		*off += aio.size;
		rec->bytes_written += aio.size;
321 322
		if (switch_output_size(rec))
			trigger_hit(&switch_output_trigger);
323 324 325 326 327 328 329 330
	} 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);
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
	}

	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;
	struct perf_evlist *evlist = rec->evlist;
	struct perf_mmap *maps = evlist->mmap;

352
	if (!record__aio_enabled(rec))
353 354 355 356 357 358
		return;

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

		if (map->base)
359
			record__aio_sync(map, true);
360 361 362 363
	}
}

static int nr_cblocks_default = 1;
364
static int nr_cblocks_max = 4;
365 366

static int record__aio_parse(const struct option *opt,
367
			     const char *str,
368 369 370 371
			     int unset)
{
	struct record_opts *opts = (struct record_opts *)opt->value;

372
	if (unset) {
373
		opts->nr_cblocks = 0;
374 375 376 377 378 379
	} else {
		if (str)
			opts->nr_cblocks = strtol(str, NULL, 0);
		if (!opts->nr_cblocks)
			opts->nr_cblocks = nr_cblocks_default;
	}
380 381 382 383

	return 0;
}
#else /* HAVE_AIO_SUPPORT */
384 385
static int nr_cblocks_max = 0;

386 387
static int record__aio_push(struct record *rec __maybe_unused, struct perf_mmap *map __maybe_unused,
			    off_t *off __maybe_unused)
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
{
	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;
}

411 412 413 414 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
#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;
}

446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
#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
465 466
static unsigned int comp_level_max = 22;

467 468 469 470 471
static int record__comp_enabled(struct record *rec)
{
	return rec->opts.comp_level > 0;
}

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

481
static int record__pushfn(struct perf_mmap *map, void *to, void *bf, size_t size)
482 483 484
{
	struct record *rec = to;

485 486 487 488 489
	if (record__comp_enabled(rec)) {
		size = zstd_compress(rec->session, map->data, perf_mmap__mmap_len(map), bf, size);
		bf   = map->data;
	}

490
	rec->samples++;
491
	return record__write(rec, map, bf, size);
492 493
}

494 495 496
static volatile int done;
static volatile int signr = -1;
static volatile int child_finished;
497

498 499 500 501 502 503 504 505 506 507
static void sig_handler(int sig)
{
	if (sig == SIGCHLD)
		child_finished = 1;
	else
		signr = sig;

	done = 1;
}

W
Wang Nan 已提交
508 509 510 511 512 513
static void sigsegv_handler(int sig)
{
	perf_hooks__recover();
	sighandler_dump_stack(sig);
}

514 515 516 517 518 519 520 521 522
static void record__sig_exit(void)
{
	if (signr == -1)
		return;

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

523 524
#ifdef HAVE_AUXTRACE_SUPPORT

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

535
	if (!perf_data__is_pipe(data) && !perf_data__is_dir(data)) {
536
		off_t file_offset;
537
		int fd = perf_data__fd(data);
538 539 540 541 542 543 544 545 546 547 548
		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;
	}

549 550 551 552 553
	/* event.auxtrace.size includes padding, see __auxtrace_mmap__read() */
	padding = (len1 + len2) & 7;
	if (padding)
		padding = 8 - padding;

554 555
	record__write(rec, map, event, event->header.size);
	record__write(rec, map, data1, len1);
556
	if (len2)
557 558
		record__write(rec, map, data2, len2);
	record__write(rec, map, &pad, padding);
559 560 561 562 563

	return 0;
}

static int record__auxtrace_mmap_read(struct record *rec,
564
				      struct perf_mmap *map)
565 566 567
{
	int ret;

568
	ret = auxtrace_mmap__read(map, rec->itr, &rec->tool,
569 570 571 572 573 574 575 576 577 578
				  record__process_auxtrace);
	if (ret < 0)
		return ret;

	if (ret)
		rec->samples++;

	return 0;
}

579
static int record__auxtrace_mmap_read_snapshot(struct record *rec,
580
					       struct perf_mmap *map)
581 582 583
{
	int ret;

584
	ret = auxtrace_mmap__read_snapshot(map, rec->itr, &rec->tool,
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
					   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++) {
602
		struct perf_mmap *map = &rec->evlist->mmap[i];
603

604
		if (!map->auxtrace_mmap.base)
605 606
			continue;

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

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

629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
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);
}

647 648 649 650
#else

static inline
int record__auxtrace_mmap_read(struct record *rec __maybe_unused,
651
			       struct perf_mmap *map __maybe_unused)
652 653 654 655
{
	return 0;
}

656 657
static inline
void record__read_auxtrace_snapshot(struct record *rec __maybe_unused)
658
{
659 660
}

661 662
static inline
int auxtrace_record__snapshot_start(struct auxtrace_record *itr __maybe_unused)
663
{
664
	return 0;
665 666
}

667 668 669 670 671
static int record__auxtrace_init(struct record *rec __maybe_unused)
{
	return 0;
}

672 673
#endif

674 675 676 677 678 679
static int record__mmap_evlist(struct record *rec,
			       struct perf_evlist *evlist)
{
	struct record_opts *opts = &rec->opts;
	char msg[512];

680 681 682
	if (opts->affinity != PERF_AFFINITY_SYS)
		cpu__setup_cpunode_map();

683
	if (perf_evlist__mmap_ex(evlist, opts->mmap_pages,
684
				 opts->auxtrace_mmap_pages,
685
				 opts->auxtrace_snapshot_mode,
686
				 opts->nr_cblocks, opts->affinity,
687
				 opts->mmap_flush, opts->comp_level) < 0) {
688 689 690 691 692 693 694 695 696 697
		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,
698
				str_error_r(errno, msg, sizeof(msg)));
699 700 701 702 703 704 705 706 707 708 709 710 711 712
			if (errno)
				return -errno;
			else
				return -EINVAL;
		}
	}
	return 0;
}

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

713
static int record__open(struct record *rec)
714
{
715
	char msg[BUFSIZ];
716
	struct perf_evsel *pos;
717 718
	struct perf_evlist *evlist = rec->evlist;
	struct perf_session *session = rec->session;
719
	struct record_opts *opts = &rec->opts;
720
	int rc = 0;
721

722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
	/*
	 * 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;
		pos->attr.enable_on_exec = 1;
	}

738
	perf_evlist__config(evlist, opts, &callchain_param);
739

740
	evlist__for_each_entry(evlist, pos) {
741
try_again:
742
		if (perf_evsel__open(pos, pos->cpus, pos->threads) < 0) {
743
			if (perf_evsel__fallback(pos, errno, msg, sizeof(msg))) {
744
				if (verbose > 0)
745
					ui__warning("%s\n", msg);
746 747
				goto try_again;
			}
A
Andi Kleen 已提交
748 749 750 751 752 753
			if ((errno == EINVAL || errno == EBADF) &&
			    pos->leader != pos &&
			    pos->weak_group) {
			        pos = perf_evlist__reset_weak_group(evlist, pos);
				goto try_again;
			}
754 755 756 757
			rc = -errno;
			perf_evsel__open_strerror(pos, &opts->target,
						  errno, msg, sizeof(msg));
			ui__error("%s\n", msg);
758
			goto out;
L
Li Zefan 已提交
759
		}
760 761

		pos->supported = true;
L
Li Zefan 已提交
762
	}
763

764
	if (perf_evlist__apply_filters(evlist, &pos)) {
765
		pr_err("failed to set filter \"%s\" on event %s with %d (%s)\n",
766
			pos->filter, perf_evsel__name(pos), errno,
767
			str_error_r(errno, msg, sizeof(msg)));
768
		rc = -1;
769 770 771
		goto out;
	}

772 773
	rc = record__mmap(rec);
	if (rc)
774
		goto out;
775

776
	session->evlist = evlist;
777
	perf_session__set_id_hdr_size(session);
778 779
out:
	return rc;
780 781
}

782 783 784 785 786 787 788 789
static int process_sample_event(struct perf_tool *tool,
				union perf_event *event,
				struct perf_sample *sample,
				struct perf_evsel *evsel,
				struct machine *machine)
{
	struct record *rec = container_of(tool, struct record, tool);

790 791 792 793
	if (rec->evlist->first_sample_time == 0)
		rec->evlist->first_sample_time = sample->time;

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

795 796 797 798
	if (rec->buildid_all)
		return 0;

	rec->samples++;
799 800 801
	return build_id__mark_dso_hit(tool, event, sample, evsel, machine);
}

802
static int process_buildids(struct record *rec)
803
{
804
	struct perf_session *session = rec->session;
805

806
	if (perf_data__size(&rec->data) == 0)
807 808
		return 0;

809 810 811 812 813 814 815 816 817 818 819
	/*
	 * 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;

820 821
	/*
	 * If --buildid-all is given, it marks all DSO regardless of hits,
822 823 824
	 * 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.
825
	 */
826
	if (rec->buildid_all && !rec->timestamp_boundary)
827 828
		rec->tool.sample = NULL;

829
	return perf_session__process_events(session);
830 831
}

832
static void perf_event__synthesize_guest_os(struct machine *machine, void *data)
833 834
{
	int err;
835
	struct perf_tool *tool = data;
836 837 838 839 840 841 842 843
	/*
	 *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.
	 */
844
	err = perf_event__synthesize_modules(tool, process_synthesized_event,
845
					     machine);
846 847
	if (err < 0)
		pr_err("Couldn't record guest kernel [%d]'s reference"
848
		       " relocation symbol.\n", machine->pid);
849 850 851 852 853

	/*
	 * We use _stext for guest kernel because guest kernel's /proc/kallsyms
	 * have no _text sometimes.
	 */
854
	err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
855
						 machine);
856 857
	if (err < 0)
		pr_err("Couldn't record guest kernel [%d]'s reference"
858
		       " relocation symbol.\n", machine->pid);
859 860
}

861 862 863 864 865
static struct perf_event_header finished_round_event = {
	.size = sizeof(struct perf_event_header),
	.type = PERF_RECORD_FINISHED_ROUND,
};

866 867 868 869 870 871 872 873 874 875
static void record__adjust_affinity(struct record *rec, struct perf_mmap *map)
{
	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);
	}
}

876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906
static size_t process_comp_header(void *record, size_t increment)
{
	struct compressed_event *event = record;
	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;
	size_t max_record_size = PERF_SAMPLE_MAX_SIZE - sizeof(struct compressed_event) - 1;

	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;
}

907
static int record__mmap_read_evlist(struct record *rec, struct perf_evlist *evlist,
908
				    bool overwrite, bool synch)
909
{
910
	u64 bytes_written = rec->bytes_written;
911
	int i;
912
	int rc = 0;
913
	struct perf_mmap *maps;
914
	int trace_fd = rec->data.file.fd;
915
	off_t off = 0;
916

917 918
	if (!evlist)
		return 0;
919

920
	maps = overwrite ? evlist->overwrite_mmap : evlist->mmap;
921 922 923
	if (!maps)
		return 0;

924
	if (overwrite && evlist->bkw_mmap_state != BKW_MMAP_DATA_PENDING)
925 926
		return 0;

927 928 929
	if (record__aio_enabled(rec))
		off = record__aio_get_pos(trace_fd);

930
	for (i = 0; i < evlist->nr_mmaps; i++) {
931
		u64 flush = 0;
932
		struct perf_mmap *map = &maps[i];
933

934
		if (map->base) {
935
			record__adjust_affinity(rec, map);
936 937 938 939
			if (synch) {
				flush = map->flush;
				map->flush = 1;
			}
940
			if (!record__aio_enabled(rec)) {
941
				if (perf_mmap__push(map, rec, record__pushfn) < 0) {
942 943
					if (synch)
						map->flush = flush;
944 945 946 947
					rc = -1;
					goto out;
				}
			} else {
948
				if (record__aio_push(rec, map, &off) < 0) {
949
					record__aio_set_pos(trace_fd, off);
950 951
					if (synch)
						map->flush = flush;
952 953 954
					rc = -1;
					goto out;
				}
955
			}
956 957
			if (synch)
				map->flush = flush;
958
		}
959

960 961
		if (map->auxtrace_mmap.base && !rec->opts.auxtrace_snapshot_mode &&
		    record__auxtrace_mmap_read(rec, map) != 0) {
962 963 964
			rc = -1;
			goto out;
		}
965 966
	}

967 968 969
	if (record__aio_enabled(rec))
		record__aio_set_pos(trace_fd, off);

970 971 972 973 974
	/*
	 * Mark the round finished in case we wrote
	 * at least one event.
	 */
	if (bytes_written != rec->bytes_written)
975
		rc = record__write(rec, NULL, &finished_round_event, sizeof(finished_round_event));
976

977
	if (overwrite)
978
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_EMPTY);
979 980
out:
	return rc;
981 982
}

983
static int record__mmap_read_all(struct record *rec, bool synch)
984 985 986
{
	int err;

987
	err = record__mmap_read_evlist(rec, rec->evlist, false, synch);
988 989 990
	if (err)
		return err;

991
	return record__mmap_read_evlist(rec, rec->evlist, true, synch);
992 993
}

994
static void record__init_features(struct record *rec)
995 996 997 998 999 1000 1001 1002 1003 1004
{
	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);

1005
	if (!have_tracepoints(&rec->evlist->entries))
1006 1007 1008 1009
		perf_header__clear_feat(&session->header, HEADER_TRACING_DATA);

	if (!rec->opts.branch_stack)
		perf_header__clear_feat(&session->header, HEADER_BRANCH_STACK);
1010 1011 1012

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

1014 1015 1016
	if (!(rec->opts.use_clockid && rec->opts.clockid_res_ns))
		perf_header__clear_feat(&session->header, HEADER_CLOCKID);

1017
	perf_header__clear_feat(&session->header, HEADER_DIR_FORMAT);
1018 1019
	if (!record__comp_enabled(rec))
		perf_header__clear_feat(&session->header, HEADER_COMPRESSED);
1020

1021
	perf_header__clear_feat(&session->header, HEADER_STAT);
1022 1023
}

1024 1025 1026
static void
record__finish_output(struct record *rec)
{
1027 1028
	struct perf_data *data = &rec->data;
	int fd = perf_data__fd(data);
1029

1030
	if (data->is_pipe)
1031 1032 1033
		return;

	rec->session->header.data_size += rec->bytes_written;
1034
	data->file.size = lseek(perf_data__fd(data), 0, SEEK_CUR);
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046

	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;
}

1047
static int record__synthesize_workload(struct record *rec, bool tail)
1048
{
1049 1050
	int err;
	struct thread_map *thread_map;
1051

1052 1053 1054
	if (rec->opts.tail_synthesize != tail)
		return 0;

1055 1056 1057 1058 1059
	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,
1060 1061
						 process_synthesized_event,
						 &rec->session->machines.host,
1062
						 rec->opts.sample_address);
1063 1064
	thread_map__put(thread_map);
	return err;
1065 1066
}

1067
static int record__synthesize(struct record *rec, bool tail);
1068

1069 1070 1071
static int
record__switch_output(struct record *rec, bool at_exit)
{
1072
	struct perf_data *data = &rec->data;
1073
	int fd, err;
1074
	char *new_filename;
1075 1076 1077 1078

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

1079 1080
	record__aio_mmap_read_sync(rec);

1081 1082 1083 1084
	record__synthesize(rec, true);
	if (target__none(&rec->opts.target))
		record__synthesize_workload(rec, true);

1085 1086 1087 1088 1089 1090 1091 1092
	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;
	}

1093
	fd = perf_data__switch(data, timestamp,
1094
				    rec->session->header.data_offset,
1095
				    at_exit, &new_filename);
1096 1097 1098 1099 1100 1101 1102
	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 已提交
1103
			data->path, timestamp);
1104

1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
	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]);
			free(rec->switch_output.filenames[n]);
		}
		rec->switch_output.filenames[n] = new_filename;
	} else {
		free(new_filename);
	}

1120
	/* Output tracking events */
1121
	if (!at_exit) {
1122
		record__synthesize(rec, false);
1123

1124 1125 1126 1127 1128 1129 1130 1131 1132 1133
		/*
		 * 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))
1134
			record__synthesize_workload(rec, false);
1135
	}
1136 1137 1138
	return fd;
}

1139 1140 1141 1142 1143 1144 1145
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.
 */
1146 1147
static void workload_exec_failed_signal(int signo __maybe_unused,
					siginfo_t *info,
1148 1149 1150 1151 1152 1153 1154
					void *ucontext __maybe_unused)
{
	workload_exec_errno = info->si_value.sival_int;
	done = 1;
	child_finished = 1;
}

1155
static void snapshot_sig_handler(int sig);
1156
static void alarm_sig_handler(int sig);
1157

1158 1159 1160 1161 1162 1163 1164 1165 1166
int __weak
perf_event__synth_time_conv(const struct perf_event_mmap_page *pc __maybe_unused,
			    struct perf_tool *tool __maybe_unused,
			    perf_event__handler_t process __maybe_unused,
			    struct machine *machine __maybe_unused)
{
	return 0;
}

1167 1168 1169
static const struct perf_event_mmap_page *
perf_evlist__pick_pc(struct perf_evlist *evlist)
{
1170 1171 1172
	if (evlist) {
		if (evlist->mmap && evlist->mmap[0].base)
			return evlist->mmap[0].base;
1173 1174
		if (evlist->overwrite_mmap && evlist->overwrite_mmap[0].base)
			return evlist->overwrite_mmap[0].base;
1175
	}
1176 1177 1178
	return NULL;
}

1179 1180
static const struct perf_event_mmap_page *record__pick_pc(struct record *rec)
{
1181 1182 1183 1184 1185
	const struct perf_event_mmap_page *pc;

	pc = perf_evlist__pick_pc(rec->evlist);
	if (pc)
		return pc;
1186 1187 1188
	return NULL;
}

1189
static int record__synthesize(struct record *rec, bool tail)
1190 1191 1192
{
	struct perf_session *session = rec->session;
	struct machine *machine = &session->machines.host;
1193
	struct perf_data *data = &rec->data;
1194 1195
	struct record_opts *opts = &rec->opts;
	struct perf_tool *tool = &rec->tool;
1196
	int fd = perf_data__fd(data);
1197 1198
	int err = 0;

1199 1200 1201
	if (rec->opts.tail_synthesize != tail)
		return 0;

1202
	if (data->is_pipe) {
1203 1204 1205 1206
		/*
		 * We need to synthesize events first, because some
		 * features works on top of them (on report side).
		 */
1207
		err = perf_event__synthesize_attrs(tool, rec->evlist,
1208 1209 1210 1211 1212 1213
						   process_synthesized_event);
		if (err < 0) {
			pr_err("Couldn't synthesize attrs.\n");
			goto out;
		}

1214 1215 1216 1217 1218 1219 1220
		err = perf_event__synthesize_features(tool, session, rec->evlist,
						      process_synthesized_event);
		if (err < 0) {
			pr_err("Couldn't synthesize features.\n");
			return err;
		}

1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
		if (have_tracepoints(&rec->evlist->entries)) {
			/*
			 * 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;
		}
	}

1240
	err = perf_event__synth_time_conv(record__pick_pc(rec), tool,
1241 1242 1243 1244
					  process_synthesized_event, machine);
	if (err)
		goto out;

1245 1246 1247 1248 1249 1250 1251
	if (rec->opts.full_auxtrace) {
		err = perf_event__synthesize_auxtrace_info(rec->itr, tool,
					session, process_synthesized_event);
		if (err)
			goto out;
	}

1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264
	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");
	}
1265 1266 1267 1268 1269 1270

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

1271 1272 1273 1274 1275 1276 1277
	err = perf_event__synthesize_extra_attr(&rec->tool,
						rec->evlist,
						process_synthesized_event,
						data->is_pipe);
	if (err)
		goto out;

1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292
	err = perf_event__synthesize_thread_map2(&rec->tool, rec->evlist->threads,
						 process_synthesized_event,
						NULL);
	if (err < 0) {
		pr_err("Couldn't synthesize thread map.\n");
		return err;
	}

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

1293
	err = perf_event__synthesize_bpf_events(session, process_synthesized_event,
1294 1295 1296 1297
						machine, opts);
	if (err < 0)
		pr_warning("Couldn't synthesize bpf events.\n");

1298 1299
	err = __machine__synthesize_threads(machine, tool, &opts->target, rec->evlist->threads,
					    process_synthesized_event, opts->sample_address,
1300
					    1);
1301 1302 1303 1304
out:
	return err;
}

1305
static int __cmd_record(struct record *rec, int argc, const char **argv)
1306
{
1307
	int err;
1308
	int status = 0;
1309
	unsigned long waking = 0;
1310
	const bool forks = argc > 0;
1311
	struct perf_tool *tool = &rec->tool;
1312
	struct record_opts *opts = &rec->opts;
1313
	struct perf_data *data = &rec->data;
1314
	struct perf_session *session;
1315
	bool disabled = false, draining = false;
1316
	struct perf_evlist *sb_evlist = NULL;
1317
	int fd;
1318
	float ratio = 0;
1319

1320
	atexit(record__sig_exit);
1321 1322
	signal(SIGCHLD, sig_handler);
	signal(SIGINT, sig_handler);
1323
	signal(SIGTERM, sig_handler);
W
Wang Nan 已提交
1324
	signal(SIGSEGV, sigsegv_handler);
1325

1326 1327 1328
	if (rec->opts.record_namespaces)
		tool->namespace_events = true;

1329
	if (rec->opts.auxtrace_snapshot_mode || rec->switch_output.enabled) {
1330
		signal(SIGUSR2, snapshot_sig_handler);
1331 1332
		if (rec->opts.auxtrace_snapshot_mode)
			trigger_on(&auxtrace_snapshot_trigger);
1333
		if (rec->switch_output.enabled)
1334
			trigger_on(&switch_output_trigger);
1335
	} else {
1336
		signal(SIGUSR2, SIG_IGN);
1337
	}
1338

1339
	session = perf_session__new(data, false, tool);
1340
	if (session == NULL) {
A
Adrien BAK 已提交
1341
		pr_err("Perf session creation failed.\n");
1342 1343 1344
		return -1;
	}

1345
	fd = perf_data__fd(data);
1346 1347
	rec->session = session;

1348 1349 1350 1351 1352 1353 1354 1355
	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;

1356
	record__init_features(rec);
1357

1358 1359 1360
	if (rec->opts.use_clockid && rec->opts.clockid_res_ns)
		session->header.env.clockid_res_ns = rec->opts.clockid_res_ns;

1361
	if (forks) {
1362
		err = perf_evlist__prepare_workload(rec->evlist, &opts->target,
1363
						    argv, data->is_pipe,
1364
						    workload_exec_failed_signal);
1365 1366
		if (err < 0) {
			pr_err("Couldn't run the workload!\n");
1367
			status = err;
1368
			goto out_delete_session;
1369 1370 1371
		}
	}

J
Jiri Olsa 已提交
1372 1373 1374 1375 1376 1377 1378 1379 1380
	/*
	 * 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.
	 */
	if (data->is_pipe && rec->evlist->nr_entries == 1)
		rec->opts.sample_id = true;

1381
	if (record__open(rec) != 0) {
1382
		err = -1;
1383
		goto out_child;
1384
	}
1385
	session->header.env.comp_mmap_len = session->evlist->mmap_len;
1386

1387 1388 1389 1390 1391 1392 1393 1394 1395 1396
	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;
	}

1397 1398 1399 1400 1401 1402 1403 1404 1405
	/*
	 * 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;
	}

1406
	if (!rec->evlist->nr_groups)
1407 1408
		perf_header__clear_feat(&session->header, HEADER_GROUP_DESC);

1409
	if (data->is_pipe) {
1410
		err = perf_header__write_pipe(fd);
1411
		if (err < 0)
1412
			goto out_child;
1413
	} else {
1414
		err = perf_session__write_header(session, rec->evlist, fd, false);
1415
		if (err < 0)
1416
			goto out_child;
1417 1418
	}

1419
	if (!rec->no_buildid
1420
	    && !perf_header__has_feat(&session->header, HEADER_BUILD_ID)) {
1421
		pr_err("Couldn't generate buildids. "
1422
		       "Use --no-buildid to profile anyway.\n");
1423
		err = -1;
1424
		goto out_child;
1425 1426
	}

1427 1428 1429
	if (!opts->no_bpf_event)
		bpf_event__add_sb_event(&sb_evlist, &session->header.env);

1430 1431 1432 1433 1434
	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;
	}

1435
	err = record__synthesize(rec, false);
1436
	if (err < 0)
1437
		goto out_child;
1438

1439
	if (rec->realtime_prio) {
1440 1441
		struct sched_param param;

1442
		param.sched_priority = rec->realtime_prio;
1443
		if (sched_setscheduler(0, SCHED_FIFO, &param)) {
1444
			pr_err("Could not set realtime priority.\n");
1445
			err = -1;
1446
			goto out_child;
1447 1448 1449
		}
	}

1450 1451 1452 1453 1454
	/*
	 * 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.
	 */
1455
	if (!target__none(&opts->target) && !opts->initial_delay)
1456
		perf_evlist__enable(rec->evlist);
1457

1458 1459 1460
	/*
	 * Let the child rip
	 */
1461
	if (forks) {
1462
		struct machine *machine = &session->machines.host;
1463
		union perf_event *event;
1464
		pid_t tgid;
1465 1466 1467 1468 1469 1470 1471

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

1472 1473 1474 1475 1476 1477
		/*
		 * 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.
		 */
1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501
		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);
1502
		free(event);
1503

1504
		perf_evlist__start_workload(rec->evlist);
1505
	}
1506

1507
	if (opts->initial_delay) {
1508
		usleep(opts->initial_delay * USEC_PER_MSEC);
1509 1510 1511
		perf_evlist__enable(rec->evlist);
	}

1512
	trigger_ready(&auxtrace_snapshot_trigger);
1513
	trigger_ready(&switch_output_trigger);
W
Wang Nan 已提交
1514
	perf_hooks__invoke_record_start();
1515
	for (;;) {
1516
		unsigned long long hits = rec->samples;
1517

1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528
		/*
		 * 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);

1529
		if (record__mmap_read_all(rec, false) < 0) {
1530
			trigger_error(&auxtrace_snapshot_trigger);
1531
			trigger_error(&switch_output_trigger);
1532
			err = -1;
1533
			goto out_child;
1534
		}
1535

1536 1537
		if (auxtrace_record__snapshot_started) {
			auxtrace_record__snapshot_started = 0;
1538
			if (!trigger_is_error(&auxtrace_snapshot_trigger))
1539
				record__read_auxtrace_snapshot(rec);
1540
			if (trigger_is_error(&auxtrace_snapshot_trigger)) {
1541 1542 1543 1544 1545 1546
				pr_err("AUX area tracing snapshot failed\n");
				err = -1;
				goto out_child;
			}
		}

1547
		if (trigger_is_hit(&switch_output_trigger)) {
1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558
			/*
			 * 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;
1559 1560
			trigger_ready(&switch_output_trigger);

1561 1562 1563 1564 1565 1566 1567
			/*
			 * 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);

1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578
			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;
			}
1579 1580 1581 1582

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

1585
		if (hits == rec->samples) {
1586
			if (done || draining)
1587
				break;
1588
			err = perf_evlist__poll(rec->evlist, -1);
1589 1590 1591 1592 1593
			/*
			 * Propagate error, only if there's any. Ignore positive
			 * number of returned events and interrupt error.
			 */
			if (err > 0 || (err < 0 && errno == EINTR))
1594
				err = 0;
1595
			waking++;
1596 1597 1598

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

1601 1602 1603 1604 1605
		/*
		 * 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.
		 */
1606
		if (done && !disabled && !target__none(&opts->target)) {
1607
			trigger_off(&auxtrace_snapshot_trigger);
1608
			perf_evlist__disable(rec->evlist);
1609 1610
			disabled = true;
		}
1611
	}
1612
	trigger_off(&auxtrace_snapshot_trigger);
1613
	trigger_off(&switch_output_trigger);
1614

1615
	if (forks && workload_exec_errno) {
1616
		char msg[STRERR_BUFSIZE];
1617
		const char *emsg = str_error_r(workload_exec_errno, msg, sizeof(msg));
1618 1619
		pr_err("Workload failed: %s\n", emsg);
		err = -1;
1620
		goto out_child;
1621 1622
	}

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

1626 1627 1628
	if (target__none(&rec->opts.target))
		record__synthesize_workload(rec, true);

1629
out_child:
1630
	record__mmap_read_all(rec, true);
1631 1632
	record__aio_mmap_read_sync(rec);

1633 1634 1635 1636 1637
	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;
	}

1638 1639
	if (forks) {
		int exit_status;
1640

1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654
		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;

1655
	record__synthesize(rec, true);
1656 1657 1658
	/* this will be recalculated during process_buildids() */
	rec->samples = 0;

1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669
	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;
			}
		}
	}
1670

W
Wang Nan 已提交
1671 1672
	perf_hooks__invoke_record_end();

1673 1674
	if (!err && !quiet) {
		char samples[128];
1675 1676
		const char *postfix = rec->timestamp_filename ?
					".<timestamp>" : "";
1677

1678
		if (rec->samples && !rec->opts.full_auxtrace)
1679 1680 1681 1682 1683
			scnprintf(samples, sizeof(samples),
				  " (%" PRIu64 " samples)", rec->samples);
		else
			samples[0] = '\0';

1684
		fprintf(stderr,	"[ perf record: Captured and wrote %.3f MB %s%s%s",
1685
			perf_data__size(data) / 1024.0 / 1024.0,
J
Jiri Olsa 已提交
1686
			data->path, postfix, samples);
1687 1688 1689 1690 1691 1692
		if (ratio) {
			fprintf(stderr,	", compressed (original %.3f MB, ratio is %.3f)",
					rec->session->bytes_transferred / 1024.0 / 1024.0,
					ratio);
		}
		fprintf(stderr, " ]\n");
1693 1694
	}

1695
out_delete_session:
1696
	zstd_fini(&session->zstd_data);
1697
	perf_session__delete(session);
1698 1699 1700

	if (!opts->no_bpf_event)
		perf_evlist__stop_sb_thread(sb_evlist);
1701
	return status;
1702
}
1703

1704
static void callchain_debug(struct callchain_param *callchain)
J
Jiri Olsa 已提交
1705
{
1706
	static const char *str[CALLCHAIN_MAX] = { "NONE", "FP", "DWARF", "LBR" };
1707

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

1710
	if (callchain->record_mode == CALLCHAIN_DWARF)
J
Jiri Olsa 已提交
1711
		pr_debug("callchain: stack dump size %d\n",
1712
			 callchain->dump_size);
J
Jiri Olsa 已提交
1713 1714
}

1715 1716 1717
int record_opts__parse_callchain(struct record_opts *record,
				 struct callchain_param *callchain,
				 const char *arg, bool unset)
J
Jiri Olsa 已提交
1718 1719
{
	int ret;
1720
	callchain->enabled = !unset;
1721

J
Jiri Olsa 已提交
1722 1723
	/* --no-call-graph */
	if (unset) {
1724
		callchain->record_mode = CALLCHAIN_NONE;
J
Jiri Olsa 已提交
1725 1726 1727 1728
		pr_debug("callchain: disabled\n");
		return 0;
	}

1729
	ret = parse_callchain_record_opt(arg, callchain);
1730 1731
	if (!ret) {
		/* Enable data address sampling for DWARF unwind. */
1732
		if (callchain->record_mode == CALLCHAIN_DWARF)
1733
			record->sample_address = true;
1734
		callchain_debug(callchain);
1735
	}
1736 1737 1738 1739

	return ret;
}

1740 1741 1742 1743 1744 1745 1746
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);
}

1747
int record_callchain_opt(const struct option *opt,
J
Jiri Olsa 已提交
1748 1749 1750
			 const char *arg __maybe_unused,
			 int unset __maybe_unused)
{
1751
	struct callchain_param *callchain = opt->value;
1752

1753
	callchain->enabled = true;
J
Jiri Olsa 已提交
1754

1755 1756
	if (callchain->record_mode == CALLCHAIN_NONE)
		callchain->record_mode = CALLCHAIN_FP;
1757

1758
	callchain_debug(callchain);
J
Jiri Olsa 已提交
1759 1760 1761
	return 0;
}

1762 1763
static int perf_record_config(const char *var, const char *value, void *cb)
{
1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776
	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;
	}
1777 1778 1779 1780
	if (!strcmp(var, "record.call-graph")) {
		var = "call-graph.record-mode";
		return perf_default_config(var, value, cb);
	}
1781 1782 1783 1784 1785 1786 1787
#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
1788

1789
	return 0;
1790 1791
}

1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834
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,
};

1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847
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;
}

1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870
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)
1871
		return get_clockid_res(opts->clockid, &opts->clockid_res_ns);
1872 1873 1874 1875 1876 1877 1878 1879

	/* 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;
1880 1881
			return get_clockid_res(opts->clockid,
					       &opts->clockid_res_ns);
1882 1883 1884 1885 1886 1887 1888 1889
		}
	}

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

1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904
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;
}

1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947
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;
}

1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964
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);
	}
}

1965 1966 1967
static int switch_output_setup(struct record *rec)
{
	struct switch_output *s = &rec->switch_output;
1968 1969 1970 1971 1972 1973 1974
	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 },
	};
1975 1976 1977 1978 1979 1980 1981
	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 },
	};
1982
	unsigned long val;
1983 1984 1985 1986 1987 1988 1989

	if (!s->set)
		return 0;

	if (!strcmp(s->str, "signal")) {
		s->signal = true;
		pr_debug("switch-output with SIGUSR2 signal\n");
1990 1991 1992 1993 1994 1995 1996 1997
		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;
1998 1999
	}

2000 2001 2002 2003 2004 2005 2006 2007
	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;
	}

2008
	return -1;
2009 2010 2011 2012

enabled:
	rec->timestamp_filename = true;
	s->enabled              = true;
2013 2014 2015 2016

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

2017
	return 0;
2018 2019
}

2020
static const char * const __record_usage[] = {
2021 2022
	"perf record [<options>] [<command>]",
	"perf record [<options>] -- <command> [<options>]",
2023 2024
	NULL
};
2025
const char * const *record_usage = __record_usage;
2026

2027
/*
2028 2029
 * 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
2030 2031 2032 2033 2034 2035 2036
 * 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.
 */
2037
static struct record record = {
2038
	.opts = {
2039
		.sample_time	     = true,
2040 2041 2042
		.mmap_pages	     = UINT_MAX,
		.user_freq	     = UINT_MAX,
		.user_interval	     = ULLONG_MAX,
2043
		.freq		     = 4000,
N
Namhyung Kim 已提交
2044 2045
		.target		     = {
			.uses_mmap   = true,
2046
			.default_per_cpu = true,
N
Namhyung Kim 已提交
2047
		},
2048
		.mmap_flush          = MMAP_FLUSH_DEFAULT,
2049
	},
2050 2051 2052
	.tool = {
		.sample		= process_sample_event,
		.fork		= perf_event__process_fork,
2053
		.exit		= perf_event__process_exit,
2054
		.comm		= perf_event__process_comm,
2055
		.namespaces	= perf_event__process_namespaces,
2056 2057
		.mmap		= perf_event__process_mmap,
		.mmap2		= perf_event__process_mmap2,
2058
		.ordered_events	= true,
2059
	},
2060
};
2061

2062 2063
const char record_callchain_help[] = CALLCHAIN_RECORD_HELP
	"\n\t\t\t\tDefault: fp";
2064

2065 2066
static bool dry_run;

2067 2068 2069
/*
 * 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
2070
 * from builtin-record.c, i.e. use record_opts,
2071 2072 2073
 * perf_evlist__prepare_workload, etc instead of fork+exec'in 'perf record',
 * using pipes, etc.
 */
2074
static struct option __record_options[] = {
2075
	OPT_CALLBACK('e', "event", &record.evlist, "event",
2076
		     "event selector. use 'perf list' to list available events",
2077
		     parse_events_option),
2078
	OPT_CALLBACK(0, "filter", &record.evlist, "filter",
L
Li Zefan 已提交
2079
		     "event filter", parse_filter),
2080 2081 2082
	OPT_CALLBACK_NOOPT(0, "exclude-perf", &record.evlist,
			   NULL, "don't record events from perf itself",
			   exclude_perf),
2083
	OPT_STRING('p', "pid", &record.opts.target.pid, "pid",
2084
		    "record events on existing process id"),
2085
	OPT_STRING('t', "tid", &record.opts.target.tid, "tid",
2086
		    "record events on existing thread id"),
2087
	OPT_INTEGER('r', "realtime", &record.realtime_prio,
2088
		    "collect data with this RT SCHED_FIFO priority"),
2089
	OPT_BOOLEAN(0, "no-buffering", &record.opts.no_buffering,
2090
		    "collect data without buffering"),
2091
	OPT_BOOLEAN('R', "raw-samples", &record.opts.raw_samples,
2092
		    "collect raw sample records from all opened counters"),
2093
	OPT_BOOLEAN('a', "all-cpus", &record.opts.target.system_wide,
2094
			    "system-wide collection from all CPUs"),
2095
	OPT_STRING('C', "cpu", &record.opts.target.cpu_list, "cpu",
2096
		    "list of cpus to monitor"),
2097
	OPT_U64('c', "count", &record.opts.user_interval, "event period to sample"),
J
Jiri Olsa 已提交
2098
	OPT_STRING('o', "output", &record.data.path, "file",
I
Ingo Molnar 已提交
2099
		    "output file name"),
2100 2101 2102
	OPT_BOOLEAN_SET('i', "no-inherit", &record.opts.no_inherit,
			&record.opts.no_inherit_set,
			"child tasks do not inherit counters"),
2103 2104
	OPT_BOOLEAN(0, "tail-synthesize", &record.opts.tail_synthesize,
		    "synthesize non-sample events at the end of output"),
W
Wang Nan 已提交
2105
	OPT_BOOLEAN(0, "overwrite", &record.opts.overwrite, "use overwrite mode"),
2106
	OPT_BOOLEAN(0, "no-bpf-event", &record.opts.no_bpf_event, "record bpf events"),
2107 2108
	OPT_BOOLEAN(0, "strict-freq", &record.opts.strict_freq,
		    "Fail if the specified frequency can't be used"),
2109 2110 2111
	OPT_CALLBACK('F', "freq", &record.opts, "freq or 'max'",
		     "profile at this frequency",
		      record__parse_freq),
2112 2113 2114
	OPT_CALLBACK('m', "mmap-pages", &record.opts, "pages[,pages]",
		     "number of mmap data pages and AUX area tracing mmap pages",
		     record__parse_mmap_pages),
2115 2116 2117
	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),
2118
	OPT_BOOLEAN(0, "group", &record.opts.group,
2119
		    "put the counters into a counter group"),
2120
	OPT_CALLBACK_NOOPT('g', NULL, &callchain_param,
J
Jiri Olsa 已提交
2121 2122 2123
			   NULL, "enables call-graph recording" ,
			   &record_callchain_opt),
	OPT_CALLBACK(0, "call-graph", &record.opts,
2124
		     "record_mode[,record_size]", record_callchain_help,
J
Jiri Olsa 已提交
2125
		     &record_parse_callchain_opt),
2126
	OPT_INCR('v', "verbose", &verbose,
2127
		    "be more verbose (show counter open errors, etc)"),
2128
	OPT_BOOLEAN('q', "quiet", &quiet, "don't print any message"),
2129
	OPT_BOOLEAN('s', "stat", &record.opts.inherit_stat,
2130
		    "per thread counts"),
2131
	OPT_BOOLEAN('d', "data", &record.opts.sample_address, "Record the sample addresses"),
2132 2133
	OPT_BOOLEAN(0, "phys-data", &record.opts.sample_phys_addr,
		    "Record the sample physical addresses"),
J
Jiri Olsa 已提交
2134
	OPT_BOOLEAN(0, "sample-cpu", &record.opts.sample_cpu, "Record the sample cpu"),
2135 2136 2137
	OPT_BOOLEAN_SET('T', "timestamp", &record.opts.sample_time,
			&record.opts.sample_time_set,
			"Record the sample timestamps"),
2138 2139
	OPT_BOOLEAN_SET('P', "period", &record.opts.period, &record.opts.period_set,
			"Record the sample period"),
2140
	OPT_BOOLEAN('n', "no-samples", &record.opts.no_samples,
2141
		    "don't sample"),
2142 2143 2144 2145 2146 2147
	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"),
2148
	OPT_CALLBACK('G', "cgroup", &record.evlist, "name",
S
Stephane Eranian 已提交
2149 2150
		     "monitor event in cgroup name only",
		     parse_cgroups),
2151
	OPT_UINTEGER('D', "delay", &record.opts.initial_delay,
2152
		  "ms to wait before starting measurement after program start"),
2153 2154
	OPT_STRING('u', "uid", &record.opts.target.uid_str, "user",
		   "user to profile"),
2155 2156 2157 2158 2159 2160 2161

	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",
2162
		     parse_branch_stack),
2163 2164
	OPT_BOOLEAN('W', "weight", &record.opts.sample_weight,
		    "sample by weight (on special events only)"),
2165 2166
	OPT_BOOLEAN(0, "transaction", &record.opts.sample_transaction,
		    "sample transaction flags (special events only)"),
2167 2168
	OPT_BOOLEAN(0, "per-thread", &record.opts.target.per_thread,
		    "use per-thread mmaps"),
2169 2170
	OPT_CALLBACK_OPTARG('I', "intr-regs", &record.opts.sample_intr_regs, NULL, "any register",
		    "sample selected machine registers on interrupt,"
2171
		    " use '-I?' to list register names", parse_regs),
2172 2173
	OPT_CALLBACK_OPTARG(0, "user-regs", &record.opts.sample_user_regs, NULL, "any register",
		    "sample selected machine registers on interrupt,"
2174
		    " use '-I?' to list register names", parse_regs),
2175 2176
	OPT_BOOLEAN(0, "running-time", &record.opts.running_time,
		    "Record running/enabled time of read (:S) events"),
2177 2178 2179
	OPT_CALLBACK('k', "clockid", &record.opts,
	"clockid", "clockid to use for events, see clock_gettime()",
	parse_clockid),
2180 2181
	OPT_STRING_OPTARG('S', "snapshot", &record.opts.auxtrace_snapshot_opts,
			  "opts", "AUX area tracing Snapshot Mode", ""),
2182
	OPT_UINTEGER(0, "proc-map-timeout", &proc_map_timeout,
2183
			"per thread proc mmap processing timeout in ms"),
2184 2185
	OPT_BOOLEAN(0, "namespaces", &record.opts.record_namespaces,
		    "Record namespaces events"),
2186 2187
	OPT_BOOLEAN(0, "switch-events", &record.opts.record_switch_events,
		    "Record context switch events"),
2188 2189 2190 2191 2192 2193
	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),
2194 2195 2196 2197
	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"),
2198 2199
	OPT_STRING(0, "vmlinux", &symbol_conf.vmlinux_name,
		   "file", "vmlinux pathname"),
2200 2201
	OPT_BOOLEAN(0, "buildid-all", &record.buildid_all,
		    "Record build-id of all DSOs regardless of hits"),
2202 2203
	OPT_BOOLEAN(0, "timestamp-filename", &record.timestamp_filename,
		    "append timestamp to output filename"),
2204 2205
	OPT_BOOLEAN(0, "timestamp-boundary", &record.timestamp_boundary,
		    "Record timestamp boundary (time of first/last samples)"),
2206
	OPT_STRING_OPTARG_SET(0, "switch-output", &record.switch_output.str,
2207 2208
			  &record.switch_output.set, "signal or size[BKMG] or time[smhd]",
			  "Switch output when receiving SIGUSR2 (signal) or cross a size or time threshold",
2209
			  "signal"),
2210 2211
	OPT_INTEGER(0, "switch-max-files", &record.switch_output.num_files,
		   "Limit number of switch output generated files"),
2212 2213
	OPT_BOOLEAN(0, "dry-run", &dry_run,
		    "Parse options then exit"),
2214
#ifdef HAVE_AIO_SUPPORT
2215 2216
	OPT_CALLBACK_OPTARG(0, "aio", &record.opts,
		     &nr_cblocks_default, "n", "Use <n> control blocks in asynchronous trace writing mode (default: 1, max: 4)",
2217 2218
		     record__aio_parse),
#endif
2219 2220 2221
	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),
2222 2223 2224 2225 2226
#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
2227 2228 2229
	OPT_END()
};

2230 2231
struct option *record_options = __record_options;

2232
int cmd_record(int argc, const char **argv)
2233
{
2234
	int err;
2235
	struct record *rec = &record;
2236
	char errbuf[BUFSIZ];
2237

2238 2239
	setlocale(LC_ALL, "");

2240 2241 2242 2243 2244
#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
2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258
#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
2259 2260
#endif

2261 2262 2263
	CPU_ZERO(&rec->affinity_mask);
	rec->opts.affinity = PERF_AFFINITY_SYS;

2264 2265
	rec->evlist = perf_evlist__new();
	if (rec->evlist == NULL)
2266 2267
		return -ENOMEM;

2268 2269 2270
	err = perf_config(perf_record_config, rec);
	if (err)
		return err;
2271

2272
	argc = parse_options(argc, argv, record_options, record_usage,
2273
			    PARSE_OPT_STOP_AT_NON_OPTION);
2274 2275
	if (quiet)
		perf_quiet_option();
2276 2277

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

2281
	if (nr_cgroups && !rec->opts.target.system_wide) {
2282 2283 2284
		usage_with_options_msg(record_usage, record_options,
			"cgroup monitoring only available in system-wide mode");

S
Stephane Eranian 已提交
2285
	}
2286 2287 2288 2289 2290 2291

	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;
	}

2292 2293
	if (rec->opts.record_switch_events &&
	    !perf_can_record_switch_events()) {
2294 2295 2296
		ui__error("kernel does not support recording context switch events\n");
		parse_options_usage(record_usage, record_options, "switch-events", 0);
		return -EINVAL;
2297
	}
S
Stephane Eranian 已提交
2298

2299 2300 2301 2302 2303
	if (switch_output_setup(rec)) {
		parse_options_usage(record_usage, record_options, "switch-output", 0);
		return -EINVAL;
	}

2304 2305 2306 2307 2308
	if (rec->switch_output.time) {
		signal(SIGALRM, alarm_sig_handler);
		alarm(rec->switch_output.time);
	}

2309 2310 2311 2312 2313 2314 2315
	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;
	}

2316 2317 2318 2319 2320 2321 2322 2323
	/*
	 * Allow aliases to facilitate the lookup of symbols for address
	 * filters. Refer to auxtrace_parse_filters().
	 */
	symbol_conf.allow_aliases = true;

	symbol__init(NULL);

2324
	err = record__auxtrace_init(rec);
2325 2326 2327
	if (err)
		goto out;

2328
	if (dry_run)
A
Adrian Hunter 已提交
2329
		goto out;
2330

2331 2332 2333 2334 2335
	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 已提交
2336
		goto out;
2337 2338
	}

2339 2340
	err = -ENOMEM;

2341
	if (symbol_conf.kptr_restrict && !perf_evlist__exclude_kernel(rec->evlist))
2342 2343 2344 2345 2346 2347 2348 2349
		pr_warning(
"WARNING: Kernel address maps (/proc/{kallsyms,modules}) are restricted,\n"
"check /proc/sys/kernel/kptr_restrict.\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");
2350

2351
	if (rec->no_buildid_cache || rec->no_buildid) {
2352
		disable_buildid_cache();
2353
	} else if (rec->switch_output.enabled) {
2354 2355 2356 2357 2358 2359
		/*
		 * 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
		 *
2360
		 *  perf record --switch-output --no-no-buildid \
2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380
		 *              --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();
		}
	}
2381

2382 2383 2384
	if (record.opts.overwrite)
		record.opts.tail_synthesize = true;

2385
	if (rec->evlist->nr_entries == 0 &&
2386
	    __perf_evlist__add_default(rec->evlist, !record.opts.no_samples) < 0) {
2387
		pr_err("Not enough memory for event selector list\n");
2388
		goto out;
2389
	}
2390

2391 2392 2393
	if (rec->opts.target.tid && !rec->opts.no_inherit_set)
		rec->opts.no_inherit = true;

2394
	err = target__validate(&rec->opts.target);
2395
	if (err) {
2396
		target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
2397
		ui__warning("%s\n", errbuf);
2398 2399
	}

2400
	err = target__parse_uid(&rec->opts.target);
2401 2402
	if (err) {
		int saved_errno = errno;
2403

2404
		target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
2405
		ui__error("%s", errbuf);
2406 2407

		err = -saved_errno;
2408
		goto out;
2409
	}
2410

2411 2412
	/* 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;
2413

2414
	err = -ENOMEM;
2415
	if (perf_evlist__create_maps(rec->evlist, &rec->opts.target) < 0)
2416
		usage_with_options(record_usage, record_options);
2417

2418 2419
	err = auxtrace_record__options(rec->itr, rec->evlist, &rec->opts);
	if (err)
2420
		goto out;
2421

2422 2423 2424 2425 2426 2427 2428 2429
	/*
	 * 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;

2430
	if (record_opts__config(&rec->opts)) {
2431
		err = -EINVAL;
2432
		goto out;
2433 2434
	}

2435 2436
	if (rec->opts.nr_cblocks > nr_cblocks_max)
		rec->opts.nr_cblocks = nr_cblocks_max;
2437
	pr_debug("nr_cblocks: %d\n", rec->opts.nr_cblocks);
2438

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

2442 2443 2444 2445
	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);

2446
	err = __cmd_record(&record, argc, argv);
2447
out:
2448
	perf_evlist__delete(rec->evlist);
2449
	symbol__exit();
2450
	auxtrace_record__free(rec->itr);
2451
	return err;
2452
}
2453 2454 2455

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

2458 2459 2460 2461 2462 2463
	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);
	}
2464

2465
	if (switch_output_signal(rec))
2466
		trigger_hit(&switch_output_trigger);
2467
}
2468 2469 2470 2471 2472 2473 2474 2475

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

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