builtin-record.c 44.5 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/drv_configs.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"
40
#include "asm/bug.h"
41

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

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

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

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

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

88 89 90 91 92 93 94 95 96 97 98 99
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) {
100
			pr_debug("Finished reading backward ring buffer: rewind\n");
101 102 103 104 105 106 107 108 109
			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) {
110
			pr_debug("Finished reading backward ring buffer: get start\n");
111 112 113 114 115 116 117 118 119 120 121 122
			*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
123 124
rb_find_range(void *data, int mask, u64 head, u64 old,
	      u64 *start, u64 *end, bool backward)
125
{
126
	if (!backward) {
127 128 129 130 131 132 133 134
		*start = old;
		*end = head;
		return 0;
	}

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

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

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

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

154
	rec->samples++;
155

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

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

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

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

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

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

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

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

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

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

218 219
#ifdef HAVE_AUXTRACE_SUPPORT

220 221 222 223 224
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);
225
	struct perf_data_file *file = &rec->file;
226 227 228
	size_t padding;
	u8 pad[8] = {0};

229 230 231 232 233 234 235 236 237 238 239 240 241 242
	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;
	}

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

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

324 325 326 327 328 329 330 331 332
#else

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

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

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

344 345
#endif

346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
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,
365
				str_error_r(errno, msg, sizeof(msg)));
366 367 368 369 370 371 372 373 374 375 376 377 378 379
			if (errno)
				return -errno;
			else
				return -EINVAL;
		}
	}
	return 0;
}

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

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

390
	perf_evlist__config(evlist, opts, &callchain_param);
391

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

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

409 410 411
	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,
412
			str_error_r(errno, msg, sizeof(msg)));
413
		rc = -1;
414 415 416 417 418 419 420 421
		goto out;
	}

	if (perf_evlist__apply_drv_configs(evlist, &pos, &err_term)) {
		error("failed to set config \"%s\" on event %s with %d (%s)\n",
		      err_term->val.drv_cfg, perf_evsel__name(pos), errno,
		      str_error_r(errno, msg, sizeof(msg)));
		rc = -1;
422
		goto out;
423 424
	}

425 426
	rc = record__mmap(rec);
	if (rc)
427
		goto out;
428

429
	session->evlist = evlist;
430
	perf_session__set_id_hdr_size(session);
431 432
out:
	return rc;
433 434
}

435 436 437 438 439 440 441 442 443 444 445 446 447
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);
}

448
static int process_buildids(struct record *rec)
449
{
450 451
	struct perf_data_file *file  = &rec->file;
	struct perf_session *session = rec->session;
452

453
	if (file->size == 0)
454 455
		return 0;

456 457 458 459 460 461 462 463 464 465 466
	/*
	 * 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;

467 468 469 470 471 472 473
	/*
	 * 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;

474
	return perf_session__process_events(session);
475 476
}

477
static void perf_event__synthesize_guest_os(struct machine *machine, void *data)
478 479
{
	int err;
480
	struct perf_tool *tool = data;
481 482 483 484 485 486 487 488
	/*
	 *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.
	 */
489
	err = perf_event__synthesize_modules(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

	/*
	 * We use _stext for guest kernel because guest kernel's /proc/kallsyms
	 * have no _text sometimes.
	 */
499
	err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
500
						 machine);
501 502
	if (err < 0)
		pr_err("Couldn't record guest kernel [%d]'s reference"
503
		       " relocation symbol.\n", machine->pid);
504 505
}

506 507 508 509 510
static struct perf_event_header finished_round_event = {
	.size = sizeof(struct perf_event_header),
	.type = PERF_RECORD_FINISHED_ROUND,
};

511 512
static int record__mmap_read_evlist(struct record *rec, struct perf_evlist *evlist,
				    bool backward)
513
{
514
	u64 bytes_written = rec->bytes_written;
515
	int i;
516
	int rc = 0;
517
	struct perf_mmap *maps;
518

519 520
	if (!evlist)
		return 0;
521

522
	maps = backward ? evlist->backward_mmap : evlist->mmap;
523 524 525
	if (!maps)
		return 0;

526 527 528
	if (backward && evlist->bkw_mmap_state != BKW_MMAP_DATA_PENDING)
		return 0;

529
	for (i = 0; i < evlist->nr_mmaps; i++) {
530
		struct auxtrace_mmap *mm = &maps[i].auxtrace_mmap;
531

532 533 534
		if (maps[i].base) {
			if (record__mmap_read(rec, &maps[i],
					      evlist->overwrite, backward) != 0) {
535 536 537 538
				rc = -1;
				goto out;
			}
		}
539

540
		if (mm->base && !rec->opts.auxtrace_snapshot_mode &&
541 542 543 544
		    record__auxtrace_mmap_read(rec, mm) != 0) {
			rc = -1;
			goto out;
		}
545 546
	}

547 548 549 550 551 552
	/*
	 * 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));
553

554 555
	if (backward)
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_EMPTY);
556 557
out:
	return rc;
558 559
}

560 561 562 563
static int record__mmap_read_all(struct record *rec)
{
	int err;

564
	err = record__mmap_read_evlist(rec, rec->evlist, false);
565 566 567
	if (err)
		return err;

568
	return record__mmap_read_evlist(rec, rec->evlist, true);
569 570
}

571
static void record__init_features(struct record *rec)
572 573 574 575 576 577 578 579 580 581
{
	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);

582
	if (!have_tracepoints(&rec->evlist->entries))
583 584 585 586
		perf_header__clear_feat(&session->header, HEADER_TRACING_DATA);

	if (!rec->opts.branch_stack)
		perf_header__clear_feat(&session->header, HEADER_BRANCH_STACK);
587 588 589

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

	perf_header__clear_feat(&session->header, HEADER_STAT);
592 593
}

594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
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;
}

617
static int record__synthesize_workload(struct record *rec, bool tail)
618 619 620 621 622 623
{
	struct {
		struct thread_map map;
		struct thread_map_data map_data;
	} thread_map;

624 625 626
	if (rec->opts.tail_synthesize != tail)
		return 0;

627 628 629 630 631 632 633 634 635 636
	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);
}

637
static int record__synthesize(struct record *rec, bool tail);
638

639 640 641 642 643 644 645 646 647
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";

648 649 650 651
	record__synthesize(rec, true);
	if (target__none(&rec->opts.target))
		record__synthesize_workload(rec, true);

652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
	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);
671 672

	/* Output tracking events */
673
	if (!at_exit) {
674
		record__synthesize(rec, false);
675

676 677 678 679 680 681 682 683 684 685
		/*
		 * 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))
686
			record__synthesize_workload(rec, false);
687
	}
688 689 690
	return fd;
}

691 692 693 694 695 696 697
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.
 */
698 699
static void workload_exec_failed_signal(int signo __maybe_unused,
					siginfo_t *info,
700 701 702 703 704 705 706
					void *ucontext __maybe_unused)
{
	workload_exec_errno = info->si_value.sival_int;
	done = 1;
	child_finished = 1;
}

707 708
static void snapshot_sig_handler(int sig);

709 710 711 712 713 714 715 716 717
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;
}

718 719 720
static const struct perf_event_mmap_page *
perf_evlist__pick_pc(struct perf_evlist *evlist)
{
721 722 723 724 725 726
	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;
	}
727 728 729
	return NULL;
}

730 731
static const struct perf_event_mmap_page *record__pick_pc(struct record *rec)
{
732 733 734 735 736
	const struct perf_event_mmap_page *pc;

	pc = perf_evlist__pick_pc(rec->evlist);
	if (pc)
		return pc;
737 738 739
	return NULL;
}

740
static int record__synthesize(struct record *rec, bool tail)
741 742 743 744 745 746 747 748 749
{
	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;

750 751 752
	if (rec->opts.tail_synthesize != tail)
		return 0;

753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779
	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;
		}
	}

780
	err = perf_event__synth_time_conv(record__pick_pc(rec), tool,
781 782 783 784
					  process_synthesized_event, machine);
	if (err)
		goto out;

785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
	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;
}

816
static int __cmd_record(struct record *rec, int argc, const char **argv)
817
{
818
	int err;
819
	int status = 0;
820
	unsigned long waking = 0;
821
	const bool forks = argc > 0;
822
	struct machine *machine;
823
	struct perf_tool *tool = &rec->tool;
824
	struct record_opts *opts = &rec->opts;
825
	struct perf_data_file *file = &rec->file;
826
	struct perf_session *session;
827
	bool disabled = false, draining = false;
828
	int fd;
829

830
	rec->progname = argv[0];
831

832
	atexit(record__sig_exit);
833 834
	signal(SIGCHLD, sig_handler);
	signal(SIGINT, sig_handler);
835
	signal(SIGTERM, sig_handler);
836

837
	if (rec->opts.auxtrace_snapshot_mode || rec->switch_output) {
838
		signal(SIGUSR2, snapshot_sig_handler);
839 840 841 842
		if (rec->opts.auxtrace_snapshot_mode)
			trigger_on(&auxtrace_snapshot_trigger);
		if (rec->switch_output)
			trigger_on(&switch_output_trigger);
843
	} else {
844
		signal(SIGUSR2, SIG_IGN);
845
	}
846

847
	session = perf_session__new(file, false, tool);
848
	if (session == NULL) {
A
Adrien BAK 已提交
849
		pr_err("Perf session creation failed.\n");
850 851 852
		return -1;
	}

853
	fd = perf_data_file__fd(file);
854 855
	rec->session = session;

856
	record__init_features(rec);
857

858
	if (forks) {
859
		err = perf_evlist__prepare_workload(rec->evlist, &opts->target,
860
						    argv, file->is_pipe,
861
						    workload_exec_failed_signal);
862 863
		if (err < 0) {
			pr_err("Couldn't run the workload!\n");
864
			status = err;
865
			goto out_delete_session;
866 867 868
		}
	}

869
	if (record__open(rec) != 0) {
870
		err = -1;
871
		goto out_child;
872
	}
873

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

884 885 886 887 888 889 890 891 892
	/*
	 * 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;
	}

893
	if (!rec->evlist->nr_groups)
894 895
		perf_header__clear_feat(&session->header, HEADER_GROUP_DESC);

896
	if (file->is_pipe) {
897
		err = perf_header__write_pipe(fd);
898
		if (err < 0)
899
			goto out_child;
900
	} else {
901
		err = perf_session__write_header(session, rec->evlist, fd, false);
902
		if (err < 0)
903
			goto out_child;
904 905
	}

906
	if (!rec->no_buildid
907
	    && !perf_header__has_feat(&session->header, HEADER_BUILD_ID)) {
908
		pr_err("Couldn't generate buildids. "
909
		       "Use --no-buildid to profile anyway.\n");
910
		err = -1;
911
		goto out_child;
912 913
	}

914
	machine = &session->machines.host;
915

916
	err = record__synthesize(rec, false);
917
	if (err < 0)
918
		goto out_child;
919

920
	if (rec->realtime_prio) {
921 922
		struct sched_param param;

923
		param.sched_priority = rec->realtime_prio;
924
		if (sched_setscheduler(0, SCHED_FIFO, &param)) {
925
			pr_err("Could not set realtime priority.\n");
926
			err = -1;
927
			goto out_child;
928 929 930
		}
	}

931 932 933 934 935
	/*
	 * 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.
	 */
936
	if (!target__none(&opts->target) && !opts->initial_delay)
937
		perf_evlist__enable(rec->evlist);
938

939 940 941
	/*
	 * Let the child rip
	 */
942
	if (forks) {
943 944 945 946 947 948 949 950
		union perf_event *event;

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

951 952 953 954 955 956
		/*
		 * 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.
		 */
957
		perf_event__synthesize_comm(tool, event,
958 959 960
					    rec->evlist->workload.pid,
					    process_synthesized_event,
					    machine);
961
		free(event);
962

963
		perf_evlist__start_workload(rec->evlist);
964
	}
965

966
	if (opts->initial_delay) {
967
		usleep(opts->initial_delay * USEC_PER_MSEC);
968 969 970
		perf_evlist__enable(rec->evlist);
	}

971
	trigger_ready(&auxtrace_snapshot_trigger);
972
	trigger_ready(&switch_output_trigger);
973
	for (;;) {
974
		unsigned long long hits = rec->samples;
975

976 977 978 979 980 981 982 983 984 985 986
		/*
		 * 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);

987
		if (record__mmap_read_all(rec) < 0) {
988
			trigger_error(&auxtrace_snapshot_trigger);
989
			trigger_error(&switch_output_trigger);
990
			err = -1;
991
			goto out_child;
992
		}
993

994 995
		if (auxtrace_record__snapshot_started) {
			auxtrace_record__snapshot_started = 0;
996
			if (!trigger_is_error(&auxtrace_snapshot_trigger))
997
				record__read_auxtrace_snapshot(rec);
998
			if (trigger_is_error(&auxtrace_snapshot_trigger)) {
999 1000 1001 1002 1003 1004
				pr_err("AUX area tracing snapshot failed\n");
				err = -1;
				goto out_child;
			}
		}

1005
		if (trigger_is_hit(&switch_output_trigger)) {
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
			/*
			 * 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;
1017 1018
			trigger_ready(&switch_output_trigger);

1019 1020 1021 1022 1023 1024 1025
			/*
			 * 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);

1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
			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;
			}
		}

1039
		if (hits == rec->samples) {
1040
			if (done || draining)
1041
				break;
1042
			err = perf_evlist__poll(rec->evlist, -1);
1043 1044 1045 1046 1047
			/*
			 * Propagate error, only if there's any. Ignore positive
			 * number of returned events and interrupt error.
			 */
			if (err > 0 || (err < 0 && errno == EINTR))
1048
				err = 0;
1049
			waking++;
1050 1051 1052

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

1055 1056 1057 1058 1059
		/*
		 * 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.
		 */
1060
		if (done && !disabled && !target__none(&opts->target)) {
1061
			trigger_off(&auxtrace_snapshot_trigger);
1062
			perf_evlist__disable(rec->evlist);
1063 1064
			disabled = true;
		}
1065
	}
1066
	trigger_off(&auxtrace_snapshot_trigger);
1067
	trigger_off(&switch_output_trigger);
1068

1069
	if (forks && workload_exec_errno) {
1070
		char msg[STRERR_BUFSIZE];
1071
		const char *emsg = str_error_r(workload_exec_errno, msg, sizeof(msg));
1072 1073
		pr_err("Workload failed: %s\n", emsg);
		err = -1;
1074
		goto out_child;
1075 1076
	}

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

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

1083 1084 1085
out_child:
	if (forks) {
		int exit_status;
1086

1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
		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;

1101
	record__synthesize(rec, true);
1102 1103 1104
	/* this will be recalculated during process_buildids() */
	rec->samples = 0;

1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
	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;
			}
		}
	}
1116

1117 1118
	if (!err && !quiet) {
		char samples[128];
1119 1120
		const char *postfix = rec->timestamp_filename ?
					".<timestamp>" : "";
1121

1122
		if (rec->samples && !rec->opts.full_auxtrace)
1123 1124 1125 1126 1127
			scnprintf(samples, sizeof(samples),
				  " (%" PRIu64 " samples)", rec->samples);
		else
			samples[0] = '\0';

1128
		fprintf(stderr,	"[ perf record: Captured and wrote %.3f MB %s%s%s ]\n",
1129
			perf_data_file__size(file) / 1024.0 / 1024.0,
1130
			file->path, postfix, samples);
1131 1132
	}

1133 1134
out_delete_session:
	perf_session__delete(session);
1135
	return status;
1136
}
1137

1138
static void callchain_debug(struct callchain_param *callchain)
J
Jiri Olsa 已提交
1139
{
1140
	static const char *str[CALLCHAIN_MAX] = { "NONE", "FP", "DWARF", "LBR" };
1141

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

1144
	if (callchain->record_mode == CALLCHAIN_DWARF)
J
Jiri Olsa 已提交
1145
		pr_debug("callchain: stack dump size %d\n",
1146
			 callchain->dump_size);
J
Jiri Olsa 已提交
1147 1148
}

1149 1150 1151
int record_opts__parse_callchain(struct record_opts *record,
				 struct callchain_param *callchain,
				 const char *arg, bool unset)
J
Jiri Olsa 已提交
1152 1153
{
	int ret;
1154
	callchain->enabled = !unset;
1155

J
Jiri Olsa 已提交
1156 1157
	/* --no-call-graph */
	if (unset) {
1158
		callchain->record_mode = CALLCHAIN_NONE;
J
Jiri Olsa 已提交
1159 1160 1161 1162
		pr_debug("callchain: disabled\n");
		return 0;
	}

1163
	ret = parse_callchain_record_opt(arg, callchain);
1164 1165
	if (!ret) {
		/* Enable data address sampling for DWARF unwind. */
1166
		if (callchain->record_mode == CALLCHAIN_DWARF)
1167
			record->sample_address = true;
1168
		callchain_debug(callchain);
1169
	}
1170 1171 1172 1173

	return ret;
}

1174 1175 1176 1177 1178 1179 1180
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);
}

1181
int record_callchain_opt(const struct option *opt,
J
Jiri Olsa 已提交
1182 1183 1184
			 const char *arg __maybe_unused,
			 int unset __maybe_unused)
{
1185
	struct callchain_param *callchain = opt->value;
1186

1187
	callchain->enabled = true;
J
Jiri Olsa 已提交
1188

1189 1190
	if (callchain->record_mode == CALLCHAIN_NONE)
		callchain->record_mode = CALLCHAIN_FP;
1191

1192
	callchain_debug(callchain);
J
Jiri Olsa 已提交
1193 1194 1195
	return 0;
}

1196 1197
static int perf_record_config(const char *var, const char *value, void *cb)
{
1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210
	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;
	}
1211
	if (!strcmp(var, "record.call-graph"))
1212
		var = "call-graph.record-mode"; /* fall-through */
1213 1214 1215 1216

	return perf_default_config(var, value, cb);
}

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 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300
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;
}

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 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343
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;
}

1344
static const char * const __record_usage[] = {
1345 1346
	"perf record [<options>] [<command>]",
	"perf record [<options>] -- <command> [<options>]",
1347 1348
	NULL
};
1349
const char * const *record_usage = __record_usage;
1350

1351
/*
1352 1353
 * 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
1354 1355 1356 1357 1358 1359 1360
 * 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.
 */
1361
static struct record record = {
1362
	.opts = {
1363
		.sample_time	     = true,
1364 1365 1366
		.mmap_pages	     = UINT_MAX,
		.user_freq	     = UINT_MAX,
		.user_interval	     = ULLONG_MAX,
1367
		.freq		     = 4000,
N
Namhyung Kim 已提交
1368 1369
		.target		     = {
			.uses_mmap   = true,
1370
			.default_per_cpu = true,
N
Namhyung Kim 已提交
1371
		},
1372
		.proc_map_timeout     = 500,
1373
	},
1374 1375 1376
	.tool = {
		.sample		= process_sample_event,
		.fork		= perf_event__process_fork,
1377
		.exit		= perf_event__process_exit,
1378 1379 1380
		.comm		= perf_event__process_comm,
		.mmap		= perf_event__process_mmap,
		.mmap2		= perf_event__process_mmap2,
1381
		.ordered_events	= true,
1382
	},
1383
};
1384

1385 1386
const char record_callchain_help[] = CALLCHAIN_RECORD_HELP
	"\n\t\t\t\tDefault: fp";
1387

1388 1389
static bool dry_run;

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

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

1518 1519
struct option *record_options = __record_options;

1520
int cmd_record(int argc, const char **argv, const char *prefix __maybe_unused)
1521
{
1522
	int err;
1523
	struct record *rec = &record;
1524
	char errbuf[BUFSIZ];
1525

1526 1527 1528 1529 1530
#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
1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544
#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
1545 1546
#endif

1547 1548
	rec->evlist = perf_evlist__new();
	if (rec->evlist == NULL)
1549 1550
		return -ENOMEM;

1551 1552
	perf_config(perf_record_config, rec);

1553
	argc = parse_options(argc, argv, record_options, record_usage,
1554
			    PARSE_OPT_STOP_AT_NON_OPTION);
1555
	if (!argc && target__none(&rec->opts.target))
1556
		usage_with_options(record_usage, record_options);
1557

1558
	if (nr_cgroups && !rec->opts.target.system_wide) {
1559 1560 1561
		usage_with_options_msg(record_usage, record_options,
			"cgroup monitoring only available in system-wide mode");

S
Stephane Eranian 已提交
1562
	}
1563 1564
	if (rec->opts.record_switch_events &&
	    !perf_can_record_switch_events()) {
1565 1566 1567
		ui__error("kernel does not support recording context switch events\n");
		parse_options_usage(record_usage, record_options, "switch-events", 0);
		return -EINVAL;
1568
	}
S
Stephane Eranian 已提交
1569

1570 1571 1572
	if (rec->switch_output)
		rec->timestamp_filename = true;

1573 1574 1575
	if (!rec->itr) {
		rec->itr = auxtrace_record__init(rec->evlist, &err);
		if (err)
A
Adrian Hunter 已提交
1576
			goto out;
1577 1578
	}

1579 1580 1581
	err = auxtrace_parse_snapshot_options(rec->itr, &rec->opts,
					      rec->opts.auxtrace_snapshot_opts);
	if (err)
A
Adrian Hunter 已提交
1582
		goto out;
1583

1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595
	/*
	 * Allow aliases to facilitate the lookup of symbols for address
	 * filters. Refer to auxtrace_parse_filters().
	 */
	symbol_conf.allow_aliases = true;

	symbol__init(NULL);

	err = auxtrace_parse_filters(rec->evlist);
	if (err)
		goto out;

1596
	if (dry_run)
A
Adrian Hunter 已提交
1597
		goto out;
1598

1599 1600 1601 1602 1603
	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 已提交
1604
		goto out;
1605 1606
	}

1607 1608
	err = -ENOMEM;

1609
	if (symbol_conf.kptr_restrict)
1610 1611 1612 1613 1614 1615 1616 1617
		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");
1618

1619
	if (rec->no_buildid_cache || rec->no_buildid) {
1620
		disable_buildid_cache();
1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648
	} 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();
		}
	}
1649

1650 1651 1652
	if (record.opts.overwrite)
		record.opts.tail_synthesize = true;

1653 1654
	if (rec->evlist->nr_entries == 0 &&
	    perf_evlist__add_default(rec->evlist) < 0) {
1655
		pr_err("Not enough memory for event selector list\n");
1656
		goto out;
1657
	}
1658

1659 1660 1661
	if (rec->opts.target.tid && !rec->opts.no_inherit_set)
		rec->opts.no_inherit = true;

1662
	err = target__validate(&rec->opts.target);
1663
	if (err) {
1664
		target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
1665 1666 1667
		ui__warning("%s", errbuf);
	}

1668
	err = target__parse_uid(&rec->opts.target);
1669 1670
	if (err) {
		int saved_errno = errno;
1671

1672
		target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
1673
		ui__error("%s", errbuf);
1674 1675

		err = -saved_errno;
1676
		goto out;
1677
	}
1678

1679
	err = -ENOMEM;
1680
	if (perf_evlist__create_maps(rec->evlist, &rec->opts.target) < 0)
1681
		usage_with_options(record_usage, record_options);
1682

1683 1684
	err = auxtrace_record__options(rec->itr, rec->evlist, &rec->opts);
	if (err)
1685
		goto out;
1686

1687 1688 1689 1690 1691 1692 1693 1694
	/*
	 * 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;

1695
	if (record_opts__config(&rec->opts)) {
1696
		err = -EINVAL;
1697
		goto out;
1698 1699
	}

1700
	err = __cmd_record(&record, argc, argv);
1701
out:
1702
	perf_evlist__delete(rec->evlist);
1703
	symbol__exit();
1704
	auxtrace_record__free(rec->itr);
1705
	return err;
1706
}
1707 1708 1709

static void snapshot_sig_handler(int sig __maybe_unused)
{
1710 1711 1712 1713 1714 1715
	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);
	}
1716 1717 1718

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