builtin-record.c 44.0 KB
Newer Older
I
Ingo Molnar 已提交
1
/*
2 3 4 5 6
 * 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 已提交
7
 */
8
#include "builtin.h"
9 10 11

#include "perf.h"

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

18
#include "util/callchain.h"
19
#include "util/cgroup.h"
20
#include "util/header.h"
21
#include "util/event.h"
22
#include "util/evlist.h"
23
#include "util/evsel.h"
24
#include "util/debug.h"
25
#include "util/session.h"
26
#include "util/tool.h"
27
#include "util/symbol.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"
39
#include "asm/bug.h"
40

41
#include <unistd.h>
42
#include <sched.h>
43
#include <sys/mman.h>
44
#include <asm/bug.h>
45
#include <linux/time64.h>
46

47
struct record {
48
	struct perf_tool	tool;
49
	struct record_opts	opts;
50
	u64			bytes_written;
51
	struct perf_data_file	file;
52
	struct auxtrace_record	*itr;
53 54 55 56 57
	struct perf_evlist	*evlist;
	struct perf_session	*session;
	const char		*progname;
	int			realtime_prio;
	bool			no_buildid;
58
	bool			no_buildid_set;
59
	bool			no_buildid_cache;
60
	bool			no_buildid_cache_set;
61
	bool			buildid_all;
62
	bool			timestamp_filename;
63
	bool			switch_output;
64
	unsigned long long	samples;
65
};
66

67
static int record__write(struct record *rec, void *bf, size_t size)
68
{
69
	if (perf_data_file__write(rec->session->file, bf, size) < 0) {
70 71
		pr_err("failed to write perf data, error: %m\n");
		return -1;
72
	}
73

74
	rec->bytes_written += size;
75
	return 0;
76 77
}

78
static int process_synthesized_event(struct perf_tool *tool,
79
				     union perf_event *event,
80 81
				     struct perf_sample *sample __maybe_unused,
				     struct machine *machine __maybe_unused)
82
{
83 84
	struct record *rec = container_of(tool, struct record, tool);
	return record__write(rec, event, event->header.size);
85 86
}

87 88 89 90 91 92 93 94 95 96 97 98
static int
backward_rb_find_range(void *buf, int mask, u64 head, u64 *start, u64 *end)
{
	struct perf_event_header *pheader;
	u64 evt_head = head;
	int size = mask + 1;

	pr_debug2("backward_rb_find_range: buf=%p, head=%"PRIx64"\n", buf, head);
	pheader = (struct perf_event_header *)(buf + (head & mask));
	*start = head;
	while (true) {
		if (evt_head - head >= (unsigned int)size) {
99
			pr_debug("Finished reading backward ring buffer: rewind\n");
100 101 102 103 104 105 106 107 108
			if (evt_head - head > (unsigned int)size)
				evt_head -= pheader->size;
			*end = evt_head;
			return 0;
		}

		pheader = (struct perf_event_header *)(buf + (evt_head & mask));

		if (pheader->size == 0) {
109
			pr_debug("Finished reading backward ring buffer: get start\n");
110 111 112 113 114 115 116 117 118 119 120 121
			*end = evt_head;
			return 0;
		}

		evt_head += pheader->size;
		pr_debug3("move evt_head: %"PRIx64"\n", evt_head);
	}
	WARN_ONCE(1, "Shouldn't get here\n");
	return -1;
}

static int
122 123
rb_find_range(void *data, int mask, u64 head, u64 old,
	      u64 *start, u64 *end, bool backward)
124
{
125
	if (!backward) {
126 127 128 129 130 131 132 133
		*start = old;
		*end = head;
		return 0;
	}

	return backward_rb_find_range(data, mask, head, start, end);
}

134 135 136
static int
record__mmap_read(struct record *rec, struct perf_mmap *md,
		  bool overwrite, bool backward)
137
{
138 139
	u64 head = perf_mmap__read_head(md);
	u64 old = md->prev;
140
	u64 end = head, start = old;
J
Jiri Olsa 已提交
141
	unsigned char *data = md->base + page_size;
142 143
	unsigned long size;
	void *buf;
144
	int rc = 0;
145

146 147
	if (rb_find_range(data, md->mask, head,
			  old, &start, &end, backward))
148 149
		return -1;

150
	if (start == end)
151
		return 0;
152

153
	rec->samples++;
154

155
	size = end - start;
156 157 158 159
	if (size > (unsigned long)(md->mask) + 1) {
		WARN_ONCE(1, "failed to keep up with mmap data. (warn only once)\n");

		md->prev = head;
160
		perf_mmap__consume(md, overwrite || backward);
161 162
		return 0;
	}
163

164 165 166 167
	if ((start & md->mask) + size != (end & md->mask)) {
		buf = &data[start & md->mask];
		size = md->mask + 1 - (start & md->mask);
		start += size;
168

169
		if (record__write(rec, buf, size) < 0) {
170 171 172
			rc = -1;
			goto out;
		}
173 174
	}

175 176 177
	buf = &data[start & md->mask];
	size = end - start;
	start += size;
178

179
	if (record__write(rec, buf, size) < 0) {
180 181 182
		rc = -1;
		goto out;
	}
183

184
	md->prev = head;
185
	perf_mmap__consume(md, overwrite || backward);
186 187
out:
	return rc;
188 189
}

190 191 192
static volatile int done;
static volatile int signr = -1;
static volatile int child_finished;
193

194
static volatile int auxtrace_record__snapshot_started;
195
static DEFINE_TRIGGER(auxtrace_snapshot_trigger);
196
static DEFINE_TRIGGER(switch_output_trigger);
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216

static void sig_handler(int sig)
{
	if (sig == SIGCHLD)
		child_finished = 1;
	else
		signr = sig;

	done = 1;
}

static void record__sig_exit(void)
{
	if (signr == -1)
		return;

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

217 218
#ifdef HAVE_AUXTRACE_SUPPORT

219 220 221 222 223
static int record__process_auxtrace(struct perf_tool *tool,
				    union perf_event *event, void *data1,
				    size_t len1, void *data2, size_t len2)
{
	struct record *rec = container_of(tool, struct record, tool);
224
	struct perf_data_file *file = &rec->file;
225 226 227
	size_t padding;
	u8 pad[8] = {0};

228 229 230 231 232 233 234 235 236 237 238 239 240 241
	if (!perf_data_file__is_pipe(file)) {
		off_t file_offset;
		int fd = perf_data_file__fd(file);
		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;
	}

242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
	/* event.auxtrace.size includes padding, see __auxtrace_mmap__read() */
	padding = (len1 + len2) & 7;
	if (padding)
		padding = 8 - padding;

	record__write(rec, event, event->header.size);
	record__write(rec, data1, len1);
	if (len2)
		record__write(rec, data2, len2);
	record__write(rec, &pad, padding);

	return 0;
}

static int record__auxtrace_mmap_read(struct record *rec,
				      struct auxtrace_mmap *mm)
{
	int ret;

	ret = auxtrace_mmap__read(mm, rec->itr, &rec->tool,
				  record__process_auxtrace);
	if (ret < 0)
		return ret;

	if (ret)
		rec->samples++;

	return 0;
}

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 304 305 306 307 308 309 310 311 312 313
static int record__auxtrace_mmap_read_snapshot(struct record *rec,
					       struct auxtrace_mmap *mm)
{
	int ret;

	ret = auxtrace_mmap__read_snapshot(mm, rec->itr, &rec->tool,
					   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++) {
		struct auxtrace_mmap *mm =
				&rec->evlist->mmap[i].auxtrace_mmap;

		if (!mm->base)
			continue;

		if (record__auxtrace_mmap_read_snapshot(rec, mm) != 0) {
			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) {
314
		trigger_error(&auxtrace_snapshot_trigger);
315
	} else {
316 317 318 319
		if (auxtrace_record__snapshot_finish(rec->itr))
			trigger_error(&auxtrace_snapshot_trigger);
		else
			trigger_ready(&auxtrace_snapshot_trigger);
320 321 322
	}
}

323 324 325 326 327 328 329 330 331
#else

static inline
int record__auxtrace_mmap_read(struct record *rec __maybe_unused,
			       struct auxtrace_mmap *mm __maybe_unused)
{
	return 0;
}

332 333
static inline
void record__read_auxtrace_snapshot(struct record *rec __maybe_unused)
334
{
335 336
}

337 338
static inline
int auxtrace_record__snapshot_start(struct auxtrace_record *itr __maybe_unused)
339
{
340
	return 0;
341 342
}

343 344
#endif

345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
static int record__mmap_evlist(struct record *rec,
			       struct perf_evlist *evlist)
{
	struct record_opts *opts = &rec->opts;
	char msg[512];

	if (perf_evlist__mmap_ex(evlist, opts->mmap_pages, false,
				 opts->auxtrace_mmap_pages,
				 opts->auxtrace_snapshot_mode) < 0) {
		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,
364
				str_error_r(errno, msg, sizeof(msg)));
365 366 367 368 369 370 371 372 373 374 375 376 377 378
			if (errno)
				return -errno;
			else
				return -EINVAL;
		}
	}
	return 0;
}

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

379
static int record__open(struct record *rec)
380
{
381
	char msg[512];
382
	struct perf_evsel *pos;
383 384
	struct perf_evlist *evlist = rec->evlist;
	struct perf_session *session = rec->session;
385
	struct record_opts *opts = &rec->opts;
386
	int rc = 0;
387

388
	perf_evlist__config(evlist, opts, &callchain_param);
389

390
	evlist__for_each_entry(evlist, pos) {
391
try_again:
392
		if (perf_evsel__open(pos, pos->cpus, pos->threads) < 0) {
393
			if (perf_evsel__fallback(pos, errno, msg, sizeof(msg))) {
394
				if (verbose)
395
					ui__warning("%s\n", msg);
396 397
				goto try_again;
			}
398

399 400 401 402
			rc = -errno;
			perf_evsel__open_strerror(pos, &opts->target,
						  errno, msg, sizeof(msg));
			ui__error("%s\n", msg);
403
			goto out;
L
Li Zefan 已提交
404 405
		}
	}
406

407 408 409
	if (perf_evlist__apply_filters(evlist, &pos)) {
		error("failed to set filter \"%s\" on event %s with %d (%s)\n",
			pos->filter, perf_evsel__name(pos), errno,
410
			str_error_r(errno, msg, sizeof(msg)));
411 412
		rc = -1;
		goto out;
413 414
	}

415 416
	rc = record__mmap(rec);
	if (rc)
417
		goto out;
418

419
	session->evlist = evlist;
420
	perf_session__set_id_hdr_size(session);
421 422
out:
	return rc;
423 424
}

425 426 427 428 429 430 431 432 433 434 435 436 437
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);

	rec->samples++;

	return build_id__mark_dso_hit(tool, event, sample, evsel, machine);
}

438
static int process_buildids(struct record *rec)
439
{
440 441
	struct perf_data_file *file  = &rec->file;
	struct perf_session *session = rec->session;
442

443
	if (file->size == 0)
444 445
		return 0;

446 447 448 449 450 451 452 453 454 455 456
	/*
	 * 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;

457 458 459 460 461 462 463
	/*
	 * If --buildid-all is given, it marks all DSO regardless of hits,
	 * so no need to process samples.
	 */
	if (rec->buildid_all)
		rec->tool.sample = NULL;

464
	return perf_session__process_events(session);
465 466
}

467
static void perf_event__synthesize_guest_os(struct machine *machine, void *data)
468 469
{
	int err;
470
	struct perf_tool *tool = data;
471 472 473 474 475 476 477 478
	/*
	 *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.
	 */
479
	err = perf_event__synthesize_modules(tool, process_synthesized_event,
480
					     machine);
481 482
	if (err < 0)
		pr_err("Couldn't record guest kernel [%d]'s reference"
483
		       " relocation symbol.\n", machine->pid);
484 485 486 487 488

	/*
	 * We use _stext for guest kernel because guest kernel's /proc/kallsyms
	 * have no _text sometimes.
	 */
489
	err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
490
						 machine);
491 492
	if (err < 0)
		pr_err("Couldn't record guest kernel [%d]'s reference"
493
		       " relocation symbol.\n", machine->pid);
494 495
}

496 497 498 499 500
static struct perf_event_header finished_round_event = {
	.size = sizeof(struct perf_event_header),
	.type = PERF_RECORD_FINISHED_ROUND,
};

501 502
static int record__mmap_read_evlist(struct record *rec, struct perf_evlist *evlist,
				    bool backward)
503
{
504
	u64 bytes_written = rec->bytes_written;
505
	int i;
506
	int rc = 0;
507
	struct perf_mmap *maps;
508

509 510
	if (!evlist)
		return 0;
511

512
	maps = backward ? evlist->backward_mmap : evlist->mmap;
513 514 515
	if (!maps)
		return 0;

516 517 518
	if (backward && evlist->bkw_mmap_state != BKW_MMAP_DATA_PENDING)
		return 0;

519
	for (i = 0; i < evlist->nr_mmaps; i++) {
520
		struct auxtrace_mmap *mm = &maps[i].auxtrace_mmap;
521

522 523 524
		if (maps[i].base) {
			if (record__mmap_read(rec, &maps[i],
					      evlist->overwrite, backward) != 0) {
525 526 527 528
				rc = -1;
				goto out;
			}
		}
529

530
		if (mm->base && !rec->opts.auxtrace_snapshot_mode &&
531 532 533 534
		    record__auxtrace_mmap_read(rec, mm) != 0) {
			rc = -1;
			goto out;
		}
535 536
	}

537 538 539 540 541 542
	/*
	 * Mark the round finished in case we wrote
	 * at least one event.
	 */
	if (bytes_written != rec->bytes_written)
		rc = record__write(rec, &finished_round_event, sizeof(finished_round_event));
543

544 545
	if (backward)
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_EMPTY);
546 547
out:
	return rc;
548 549
}

550 551 552 553
static int record__mmap_read_all(struct record *rec)
{
	int err;

554
	err = record__mmap_read_evlist(rec, rec->evlist, false);
555 556 557
	if (err)
		return err;

558
	return record__mmap_read_evlist(rec, rec->evlist, true);
559 560
}

561
static void record__init_features(struct record *rec)
562 563 564 565 566 567 568 569 570 571
{
	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);

572
	if (!have_tracepoints(&rec->evlist->entries))
573 574 575 576
		perf_header__clear_feat(&session->header, HEADER_TRACING_DATA);

	if (!rec->opts.branch_stack)
		perf_header__clear_feat(&session->header, HEADER_BRANCH_STACK);
577 578 579

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

	perf_header__clear_feat(&session->header, HEADER_STAT);
582 583
}

584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
static void
record__finish_output(struct record *rec)
{
	struct perf_data_file *file = &rec->file;
	int fd = perf_data_file__fd(file);

	if (file->is_pipe)
		return;

	rec->session->header.data_size += rec->bytes_written;
	file->size = lseek(perf_data_file__fd(file), 0, SEEK_CUR);

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

607
static int record__synthesize_workload(struct record *rec, bool tail)
608 609 610 611 612 613
{
	struct {
		struct thread_map map;
		struct thread_map_data map_data;
	} thread_map;

614 615 616
	if (rec->opts.tail_synthesize != tail)
		return 0;

617 618 619 620 621 622 623 624 625 626
	thread_map.map.nr = 1;
	thread_map.map.map[0].pid = rec->evlist->workload.pid;
	thread_map.map.map[0].comm = NULL;
	return perf_event__synthesize_thread_map(&rec->tool, &thread_map.map,
						 process_synthesized_event,
						 &rec->session->machines.host,
						 rec->opts.sample_address,
						 rec->opts.proc_map_timeout);
}

627
static int record__synthesize(struct record *rec, bool tail);
628

629 630 631 632 633 634 635 636 637
static int
record__switch_output(struct record *rec, bool at_exit)
{
	struct perf_data_file *file = &rec->file;
	int fd, err;

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

638 639 640 641
	record__synthesize(rec, true);
	if (target__none(&rec->opts.target))
		record__synthesize_workload(rec, true);

642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
	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;
	}

	fd = perf_data_file__switch(file, timestamp,
				    rec->session->header.data_offset,
				    at_exit);
	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",
			file->path, timestamp);
661 662

	/* Output tracking events */
663
	if (!at_exit) {
664
		record__synthesize(rec, false);
665

666 667 668 669 670 671 672 673 674 675
		/*
		 * 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))
676
			record__synthesize_workload(rec, false);
677
	}
678 679 680
	return fd;
}

681 682 683 684 685 686 687
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.
 */
688 689
static void workload_exec_failed_signal(int signo __maybe_unused,
					siginfo_t *info,
690 691 692 693 694 695 696
					void *ucontext __maybe_unused)
{
	workload_exec_errno = info->si_value.sival_int;
	done = 1;
	child_finished = 1;
}

697 698
static void snapshot_sig_handler(int sig);

699 700 701 702 703 704 705 706 707
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;
}

708 709 710
static const struct perf_event_mmap_page *
perf_evlist__pick_pc(struct perf_evlist *evlist)
{
711 712 713 714 715 716
	if (evlist) {
		if (evlist->mmap && evlist->mmap[0].base)
			return evlist->mmap[0].base;
		if (evlist->backward_mmap && evlist->backward_mmap[0].base)
			return evlist->backward_mmap[0].base;
	}
717 718 719
	return NULL;
}

720 721
static const struct perf_event_mmap_page *record__pick_pc(struct record *rec)
{
722 723 724 725 726
	const struct perf_event_mmap_page *pc;

	pc = perf_evlist__pick_pc(rec->evlist);
	if (pc)
		return pc;
727 728 729
	return NULL;
}

730
static int record__synthesize(struct record *rec, bool tail)
731 732 733 734 735 736 737 738 739
{
	struct perf_session *session = rec->session;
	struct machine *machine = &session->machines.host;
	struct perf_data_file *file = &rec->file;
	struct record_opts *opts = &rec->opts;
	struct perf_tool *tool = &rec->tool;
	int fd = perf_data_file__fd(file);
	int err = 0;

740 741 742
	if (rec->opts.tail_synthesize != tail)
		return 0;

743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769
	if (file->is_pipe) {
		err = perf_event__synthesize_attrs(tool, session,
						   process_synthesized_event);
		if (err < 0) {
			pr_err("Couldn't synthesize attrs.\n");
			goto out;
		}

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

770
	err = perf_event__synth_time_conv(record__pick_pc(rec), tool,
771 772 773 774
					  process_synthesized_event, machine);
	if (err)
		goto out;

775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805
	if (rec->opts.full_auxtrace) {
		err = perf_event__synthesize_auxtrace_info(rec->itr, tool,
					session, process_synthesized_event);
		if (err)
			goto out;
	}

	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");

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

	err = __machine__synthesize_threads(machine, tool, &opts->target, rec->evlist->threads,
					    process_synthesized_event, opts->sample_address,
					    opts->proc_map_timeout);
out:
	return err;
}

806
static int __cmd_record(struct record *rec, int argc, const char **argv)
807
{
808
	int err;
809
	int status = 0;
810
	unsigned long waking = 0;
811
	const bool forks = argc > 0;
812
	struct machine *machine;
813
	struct perf_tool *tool = &rec->tool;
814
	struct record_opts *opts = &rec->opts;
815
	struct perf_data_file *file = &rec->file;
816
	struct perf_session *session;
817
	bool disabled = false, draining = false;
818
	int fd;
819

820
	rec->progname = argv[0];
821

822
	atexit(record__sig_exit);
823 824
	signal(SIGCHLD, sig_handler);
	signal(SIGINT, sig_handler);
825
	signal(SIGTERM, sig_handler);
826

827
	if (rec->opts.auxtrace_snapshot_mode || rec->switch_output) {
828
		signal(SIGUSR2, snapshot_sig_handler);
829 830 831 832
		if (rec->opts.auxtrace_snapshot_mode)
			trigger_on(&auxtrace_snapshot_trigger);
		if (rec->switch_output)
			trigger_on(&switch_output_trigger);
833
	} else {
834
		signal(SIGUSR2, SIG_IGN);
835
	}
836

837
	session = perf_session__new(file, false, tool);
838
	if (session == NULL) {
A
Adrien BAK 已提交
839
		pr_err("Perf session creation failed.\n");
840 841 842
		return -1;
	}

843
	fd = perf_data_file__fd(file);
844 845
	rec->session = session;

846
	record__init_features(rec);
847

848
	if (forks) {
849
		err = perf_evlist__prepare_workload(rec->evlist, &opts->target,
850
						    argv, file->is_pipe,
851
						    workload_exec_failed_signal);
852 853
		if (err < 0) {
			pr_err("Couldn't run the workload!\n");
854
			status = err;
855
			goto out_delete_session;
856 857 858
		}
	}

859
	if (record__open(rec) != 0) {
860
		err = -1;
861
		goto out_child;
862
	}
863

864 865 866 867 868 869 870 871 872 873
	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;
	}

874 875 876 877 878 879 880 881 882
	/*
	 * 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;
	}

883
	if (!rec->evlist->nr_groups)
884 885
		perf_header__clear_feat(&session->header, HEADER_GROUP_DESC);

886
	if (file->is_pipe) {
887
		err = perf_header__write_pipe(fd);
888
		if (err < 0)
889
			goto out_child;
890
	} else {
891
		err = perf_session__write_header(session, rec->evlist, fd, false);
892
		if (err < 0)
893
			goto out_child;
894 895
	}

896
	if (!rec->no_buildid
897
	    && !perf_header__has_feat(&session->header, HEADER_BUILD_ID)) {
898
		pr_err("Couldn't generate buildids. "
899
		       "Use --no-buildid to profile anyway.\n");
900
		err = -1;
901
		goto out_child;
902 903
	}

904
	machine = &session->machines.host;
905

906
	err = record__synthesize(rec, false);
907
	if (err < 0)
908
		goto out_child;
909

910
	if (rec->realtime_prio) {
911 912
		struct sched_param param;

913
		param.sched_priority = rec->realtime_prio;
914
		if (sched_setscheduler(0, SCHED_FIFO, &param)) {
915
			pr_err("Could not set realtime priority.\n");
916
			err = -1;
917
			goto out_child;
918 919 920
		}
	}

921 922 923 924 925
	/*
	 * 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.
	 */
926
	if (!target__none(&opts->target) && !opts->initial_delay)
927
		perf_evlist__enable(rec->evlist);
928

929 930 931
	/*
	 * Let the child rip
	 */
932
	if (forks) {
933 934 935 936 937 938 939 940
		union perf_event *event;

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

941 942 943 944 945 946
		/*
		 * 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.
		 */
947
		perf_event__synthesize_comm(tool, event,
948 949 950
					    rec->evlist->workload.pid,
					    process_synthesized_event,
					    machine);
951
		free(event);
952

953
		perf_evlist__start_workload(rec->evlist);
954
	}
955

956
	if (opts->initial_delay) {
957
		usleep(opts->initial_delay * USEC_PER_MSEC);
958 959 960
		perf_evlist__enable(rec->evlist);
	}

961
	trigger_ready(&auxtrace_snapshot_trigger);
962
	trigger_ready(&switch_output_trigger);
963
	for (;;) {
964
		unsigned long long hits = rec->samples;
965

966 967 968 969 970 971 972 973 974 975 976
		/*
		 * 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);

977
		if (record__mmap_read_all(rec) < 0) {
978
			trigger_error(&auxtrace_snapshot_trigger);
979
			trigger_error(&switch_output_trigger);
980
			err = -1;
981
			goto out_child;
982
		}
983

984 985
		if (auxtrace_record__snapshot_started) {
			auxtrace_record__snapshot_started = 0;
986
			if (!trigger_is_error(&auxtrace_snapshot_trigger))
987
				record__read_auxtrace_snapshot(rec);
988
			if (trigger_is_error(&auxtrace_snapshot_trigger)) {
989 990 991 992 993 994
				pr_err("AUX area tracing snapshot failed\n");
				err = -1;
				goto out_child;
			}
		}

995
		if (trigger_is_hit(&switch_output_trigger)) {
996 997 998 999 1000 1001 1002 1003 1004 1005 1006
			/*
			 * 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;
1007 1008
			trigger_ready(&switch_output_trigger);

1009 1010 1011 1012 1013 1014 1015
			/*
			 * 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);

1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
			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;
			}
		}

1029
		if (hits == rec->samples) {
1030
			if (done || draining)
1031
				break;
1032
			err = perf_evlist__poll(rec->evlist, -1);
1033 1034 1035 1036 1037
			/*
			 * Propagate error, only if there's any. Ignore positive
			 * number of returned events and interrupt error.
			 */
			if (err > 0 || (err < 0 && errno == EINTR))
1038
				err = 0;
1039
			waking++;
1040 1041 1042

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

1045 1046 1047 1048 1049
		/*
		 * 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.
		 */
1050
		if (done && !disabled && !target__none(&opts->target)) {
1051
			trigger_off(&auxtrace_snapshot_trigger);
1052
			perf_evlist__disable(rec->evlist);
1053 1054
			disabled = true;
		}
1055
	}
1056
	trigger_off(&auxtrace_snapshot_trigger);
1057
	trigger_off(&switch_output_trigger);
1058

1059
	if (forks && workload_exec_errno) {
1060
		char msg[STRERR_BUFSIZE];
1061
		const char *emsg = str_error_r(workload_exec_errno, msg, sizeof(msg));
1062 1063
		pr_err("Workload failed: %s\n", emsg);
		err = -1;
1064
		goto out_child;
1065 1066
	}

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

1070 1071 1072
	if (target__none(&rec->opts.target))
		record__synthesize_workload(rec, true);

1073 1074 1075
out_child:
	if (forks) {
		int exit_status;
1076

1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
		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;

1091
	record__synthesize(rec, true);
1092 1093 1094
	/* this will be recalculated during process_buildids() */
	rec->samples = 0;

1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
	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;
			}
		}
	}
1106

1107 1108
	if (!err && !quiet) {
		char samples[128];
1109 1110
		const char *postfix = rec->timestamp_filename ?
					".<timestamp>" : "";
1111

1112
		if (rec->samples && !rec->opts.full_auxtrace)
1113 1114 1115 1116 1117
			scnprintf(samples, sizeof(samples),
				  " (%" PRIu64 " samples)", rec->samples);
		else
			samples[0] = '\0';

1118
		fprintf(stderr,	"[ perf record: Captured and wrote %.3f MB %s%s%s ]\n",
1119
			perf_data_file__size(file) / 1024.0 / 1024.0,
1120
			file->path, postfix, samples);
1121 1122
	}

1123 1124
out_delete_session:
	perf_session__delete(session);
1125
	return status;
1126
}
1127

1128
static void callchain_debug(struct callchain_param *callchain)
J
Jiri Olsa 已提交
1129
{
1130
	static const char *str[CALLCHAIN_MAX] = { "NONE", "FP", "DWARF", "LBR" };
1131

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

1134
	if (callchain->record_mode == CALLCHAIN_DWARF)
J
Jiri Olsa 已提交
1135
		pr_debug("callchain: stack dump size %d\n",
1136
			 callchain->dump_size);
J
Jiri Olsa 已提交
1137 1138
}

1139 1140 1141
int record_opts__parse_callchain(struct record_opts *record,
				 struct callchain_param *callchain,
				 const char *arg, bool unset)
J
Jiri Olsa 已提交
1142 1143
{
	int ret;
1144
	callchain->enabled = !unset;
1145

J
Jiri Olsa 已提交
1146 1147
	/* --no-call-graph */
	if (unset) {
1148
		callchain->record_mode = CALLCHAIN_NONE;
J
Jiri Olsa 已提交
1149 1150 1151 1152
		pr_debug("callchain: disabled\n");
		return 0;
	}

1153
	ret = parse_callchain_record_opt(arg, callchain);
1154 1155
	if (!ret) {
		/* Enable data address sampling for DWARF unwind. */
1156
		if (callchain->record_mode == CALLCHAIN_DWARF)
1157
			record->sample_address = true;
1158
		callchain_debug(callchain);
1159
	}
1160 1161 1162 1163

	return ret;
}

1164 1165 1166 1167 1168 1169 1170
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);
}

1171
int record_callchain_opt(const struct option *opt,
J
Jiri Olsa 已提交
1172 1173 1174
			 const char *arg __maybe_unused,
			 int unset __maybe_unused)
{
1175
	struct callchain_param *callchain = opt->value;
1176

1177
	callchain->enabled = true;
J
Jiri Olsa 已提交
1178

1179 1180
	if (callchain->record_mode == CALLCHAIN_NONE)
		callchain->record_mode = CALLCHAIN_FP;
1181

1182
	callchain_debug(callchain);
J
Jiri Olsa 已提交
1183 1184 1185
	return 0;
}

1186 1187
static int perf_record_config(const char *var, const char *value, void *cb)
{
1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200
	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;
	}
1201
	if (!strcmp(var, "record.call-graph"))
1202
		var = "call-graph.record-mode"; /* fall-through */
1203 1204 1205 1206

	return perf_default_config(var, value, cb);
}

1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290
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,
};

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)
		return 0;

	/* 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;
			return 0;
		}
	}

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

1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333
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;
}

1334
static const char * const __record_usage[] = {
1335 1336
	"perf record [<options>] [<command>]",
	"perf record [<options>] -- <command> [<options>]",
1337 1338
	NULL
};
1339
const char * const *record_usage = __record_usage;
1340

1341
/*
1342 1343
 * 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
1344 1345 1346 1347 1348 1349 1350
 * 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.
 */
1351
static struct record record = {
1352
	.opts = {
1353
		.sample_time	     = true,
1354 1355 1356
		.mmap_pages	     = UINT_MAX,
		.user_freq	     = UINT_MAX,
		.user_interval	     = ULLONG_MAX,
1357
		.freq		     = 4000,
N
Namhyung Kim 已提交
1358 1359
		.target		     = {
			.uses_mmap   = true,
1360
			.default_per_cpu = true,
N
Namhyung Kim 已提交
1361
		},
1362
		.proc_map_timeout     = 500,
1363
	},
1364 1365 1366
	.tool = {
		.sample		= process_sample_event,
		.fork		= perf_event__process_fork,
1367
		.exit		= perf_event__process_exit,
1368 1369 1370
		.comm		= perf_event__process_comm,
		.mmap		= perf_event__process_mmap,
		.mmap2		= perf_event__process_mmap2,
1371
		.ordered_events	= true,
1372
	},
1373
};
1374

1375 1376
const char record_callchain_help[] = CALLCHAIN_RECORD_HELP
	"\n\t\t\t\tDefault: fp";
1377

1378 1379
static bool dry_run;

1380 1381 1382
/*
 * 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
1383
 * from builtin-record.c, i.e. use record_opts,
1384 1385 1386
 * perf_evlist__prepare_workload, etc instead of fork+exec'in 'perf record',
 * using pipes, etc.
 */
1387
struct option __record_options[] = {
1388
	OPT_CALLBACK('e', "event", &record.evlist, "event",
1389
		     "event selector. use 'perf list' to list available events",
1390
		     parse_events_option),
1391
	OPT_CALLBACK(0, "filter", &record.evlist, "filter",
L
Li Zefan 已提交
1392
		     "event filter", parse_filter),
1393 1394 1395
	OPT_CALLBACK_NOOPT(0, "exclude-perf", &record.evlist,
			   NULL, "don't record events from perf itself",
			   exclude_perf),
1396
	OPT_STRING('p', "pid", &record.opts.target.pid, "pid",
1397
		    "record events on existing process id"),
1398
	OPT_STRING('t', "tid", &record.opts.target.tid, "tid",
1399
		    "record events on existing thread id"),
1400
	OPT_INTEGER('r', "realtime", &record.realtime_prio,
1401
		    "collect data with this RT SCHED_FIFO priority"),
1402
	OPT_BOOLEAN(0, "no-buffering", &record.opts.no_buffering,
1403
		    "collect data without buffering"),
1404
	OPT_BOOLEAN('R', "raw-samples", &record.opts.raw_samples,
1405
		    "collect raw sample records from all opened counters"),
1406
	OPT_BOOLEAN('a', "all-cpus", &record.opts.target.system_wide,
1407
			    "system-wide collection from all CPUs"),
1408
	OPT_STRING('C', "cpu", &record.opts.target.cpu_list, "cpu",
1409
		    "list of cpus to monitor"),
1410
	OPT_U64('c', "count", &record.opts.user_interval, "event period to sample"),
1411
	OPT_STRING('o', "output", &record.file.path, "file",
I
Ingo Molnar 已提交
1412
		    "output file name"),
1413 1414 1415
	OPT_BOOLEAN_SET('i', "no-inherit", &record.opts.no_inherit,
			&record.opts.no_inherit_set,
			"child tasks do not inherit counters"),
1416 1417
	OPT_BOOLEAN(0, "tail-synthesize", &record.opts.tail_synthesize,
		    "synthesize non-sample events at the end of output"),
W
Wang Nan 已提交
1418
	OPT_BOOLEAN(0, "overwrite", &record.opts.overwrite, "use overwrite mode"),
1419
	OPT_UINTEGER('F', "freq", &record.opts.user_freq, "profile at this frequency"),
1420 1421 1422
	OPT_CALLBACK('m', "mmap-pages", &record.opts, "pages[,pages]",
		     "number of mmap data pages and AUX area tracing mmap pages",
		     record__parse_mmap_pages),
1423
	OPT_BOOLEAN(0, "group", &record.opts.group,
1424
		    "put the counters into a counter group"),
1425
	OPT_CALLBACK_NOOPT('g', NULL, &callchain_param,
J
Jiri Olsa 已提交
1426 1427 1428
			   NULL, "enables call-graph recording" ,
			   &record_callchain_opt),
	OPT_CALLBACK(0, "call-graph", &record.opts,
1429
		     "record_mode[,record_size]", record_callchain_help,
J
Jiri Olsa 已提交
1430
		     &record_parse_callchain_opt),
1431
	OPT_INCR('v', "verbose", &verbose,
1432
		    "be more verbose (show counter open errors, etc)"),
1433
	OPT_BOOLEAN('q', "quiet", &quiet, "don't print any message"),
1434
	OPT_BOOLEAN('s', "stat", &record.opts.inherit_stat,
1435
		    "per thread counts"),
1436
	OPT_BOOLEAN('d', "data", &record.opts.sample_address, "Record the sample addresses"),
J
Jiri Olsa 已提交
1437
	OPT_BOOLEAN(0, "sample-cpu", &record.opts.sample_cpu, "Record the sample cpu"),
1438 1439 1440
	OPT_BOOLEAN_SET('T', "timestamp", &record.opts.sample_time,
			&record.opts.sample_time_set,
			"Record the sample timestamps"),
1441
	OPT_BOOLEAN('P', "period", &record.opts.period, "Record the sample period"),
1442
	OPT_BOOLEAN('n', "no-samples", &record.opts.no_samples,
1443
		    "don't sample"),
1444 1445 1446 1447 1448 1449
	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"),
1450
	OPT_CALLBACK('G', "cgroup", &record.evlist, "name",
S
Stephane Eranian 已提交
1451 1452
		     "monitor event in cgroup name only",
		     parse_cgroups),
1453
	OPT_UINTEGER('D', "delay", &record.opts.initial_delay,
1454
		  "ms to wait before starting measurement after program start"),
1455 1456
	OPT_STRING('u', "uid", &record.opts.target.uid_str, "user",
		   "user to profile"),
1457 1458 1459 1460 1461 1462 1463

	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",
1464
		     parse_branch_stack),
1465 1466
	OPT_BOOLEAN('W', "weight", &record.opts.sample_weight,
		    "sample by weight (on special events only)"),
1467 1468
	OPT_BOOLEAN(0, "transaction", &record.opts.sample_transaction,
		    "sample transaction flags (special events only)"),
1469 1470
	OPT_BOOLEAN(0, "per-thread", &record.opts.target.per_thread,
		    "use per-thread mmaps"),
1471 1472 1473
	OPT_CALLBACK_OPTARG('I', "intr-regs", &record.opts.sample_intr_regs, NULL, "any register",
		    "sample selected machine registers on interrupt,"
		    " use -I ? to list register names", parse_regs),
1474 1475
	OPT_BOOLEAN(0, "running-time", &record.opts.running_time,
		    "Record running/enabled time of read (:S) events"),
1476 1477 1478
	OPT_CALLBACK('k', "clockid", &record.opts,
	"clockid", "clockid to use for events, see clock_gettime()",
	parse_clockid),
1479 1480
	OPT_STRING_OPTARG('S', "snapshot", &record.opts.auxtrace_snapshot_opts,
			  "opts", "AUX area tracing Snapshot Mode", ""),
1481 1482
	OPT_UINTEGER(0, "proc-map-timeout", &record.opts.proc_map_timeout,
			"per thread proc mmap processing timeout in ms"),
1483 1484
	OPT_BOOLEAN(0, "switch-events", &record.opts.record_switch_events,
		    "Record context switch events"),
1485 1486 1487 1488 1489 1490
	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),
1491 1492 1493 1494
	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"),
1495 1496
	OPT_STRING(0, "vmlinux", &symbol_conf.vmlinux_name,
		   "file", "vmlinux pathname"),
1497 1498
	OPT_BOOLEAN(0, "buildid-all", &record.buildid_all,
		    "Record build-id of all DSOs regardless of hits"),
1499 1500
	OPT_BOOLEAN(0, "timestamp-filename", &record.timestamp_filename,
		    "append timestamp to output filename"),
1501 1502
	OPT_BOOLEAN(0, "switch-output", &record.switch_output,
		    "Switch output when receive SIGUSR2"),
1503 1504
	OPT_BOOLEAN(0, "dry-run", &dry_run,
		    "Parse options then exit"),
1505 1506 1507
	OPT_END()
};

1508 1509
struct option *record_options = __record_options;

1510
int cmd_record(int argc, const char **argv, const char *prefix __maybe_unused)
1511
{
1512
	int err;
1513
	struct record *rec = &record;
1514
	char errbuf[BUFSIZ];
1515

1516 1517 1518 1519 1520
#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
1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534
#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
1535 1536
#endif

1537 1538
	rec->evlist = perf_evlist__new();
	if (rec->evlist == NULL)
1539 1540
		return -ENOMEM;

1541 1542
	perf_config(perf_record_config, rec);

1543
	argc = parse_options(argc, argv, record_options, record_usage,
1544
			    PARSE_OPT_STOP_AT_NON_OPTION);
1545
	if (!argc && target__none(&rec->opts.target))
1546
		usage_with_options(record_usage, record_options);
1547

1548
	if (nr_cgroups && !rec->opts.target.system_wide) {
1549 1550 1551
		usage_with_options_msg(record_usage, record_options,
			"cgroup monitoring only available in system-wide mode");

S
Stephane Eranian 已提交
1552
	}
1553 1554
	if (rec->opts.record_switch_events &&
	    !perf_can_record_switch_events()) {
1555 1556 1557
		ui__error("kernel does not support recording context switch events\n");
		parse_options_usage(record_usage, record_options, "switch-events", 0);
		return -EINVAL;
1558
	}
S
Stephane Eranian 已提交
1559

1560 1561 1562
	if (rec->switch_output)
		rec->timestamp_filename = true;

1563 1564 1565 1566 1567 1568
	if (!rec->itr) {
		rec->itr = auxtrace_record__init(rec->evlist, &err);
		if (err)
			return err;
	}

1569 1570 1571 1572 1573
	err = auxtrace_parse_snapshot_options(rec->itr, &rec->opts,
					      rec->opts.auxtrace_snapshot_opts);
	if (err)
		return err;

1574 1575 1576
	if (dry_run)
		return 0;

1577 1578 1579 1580 1581 1582 1583 1584
	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);
		return err;
	}

1585 1586
	err = -ENOMEM;

1587
	symbol__init(NULL);
1588

1589
	if (symbol_conf.kptr_restrict)
1590 1591 1592 1593 1594 1595 1596 1597
		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");
1598

1599
	if (rec->no_buildid_cache || rec->no_buildid) {
1600
		disable_buildid_cache();
1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628
	} else if (rec->switch_output) {
		/*
		 * 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
		 *
		 *  perf record --signal-trigger --no-no-buildid \
		 *              --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();
		}
	}
1629

1630 1631 1632
	if (record.opts.overwrite)
		record.opts.tail_synthesize = true;

1633 1634
	if (rec->evlist->nr_entries == 0 &&
	    perf_evlist__add_default(rec->evlist) < 0) {
1635 1636
		pr_err("Not enough memory for event selector list\n");
		goto out_symbol_exit;
1637
	}
1638

1639 1640 1641
	if (rec->opts.target.tid && !rec->opts.no_inherit_set)
		rec->opts.no_inherit = true;

1642
	err = target__validate(&rec->opts.target);
1643
	if (err) {
1644
		target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
1645 1646 1647
		ui__warning("%s", errbuf);
	}

1648
	err = target__parse_uid(&rec->opts.target);
1649 1650
	if (err) {
		int saved_errno = errno;
1651

1652
		target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
1653
		ui__error("%s", errbuf);
1654 1655

		err = -saved_errno;
1656
		goto out_symbol_exit;
1657
	}
1658

1659
	err = -ENOMEM;
1660
	if (perf_evlist__create_maps(rec->evlist, &rec->opts.target) < 0)
1661
		usage_with_options(record_usage, record_options);
1662

1663 1664 1665 1666
	err = auxtrace_record__options(rec->itr, rec->evlist, &rec->opts);
	if (err)
		goto out_symbol_exit;

1667 1668 1669 1670 1671 1672 1673 1674
	/*
	 * 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;

1675
	if (record_opts__config(&rec->opts)) {
1676
		err = -EINVAL;
1677
		goto out_symbol_exit;
1678 1679
	}

1680
	err = __cmd_record(&record, argc, argv);
1681
out_symbol_exit:
1682
	perf_evlist__delete(rec->evlist);
1683
	symbol__exit();
1684
	auxtrace_record__free(rec->itr);
1685
	return err;
1686
}
1687 1688 1689

static void snapshot_sig_handler(int sig __maybe_unused)
{
1690 1691 1692 1693 1694 1695
	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);
	}
1696 1697 1698

	if (trigger_is_ready(&switch_output_trigger))
		trigger_hit(&switch_output_trigger);
1699
}