builtin-record.c 45.4 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"
W
Wang Nan 已提交
40
#include "util/perf-hooks.h"
41
#include "asm/bug.h"
42

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

49 50
struct switch_output {
	bool		 signal;
51 52
	const char	*str;
	bool		 set;
53 54
};

55
struct record {
56
	struct perf_tool	tool;
57
	struct record_opts	opts;
58
	u64			bytes_written;
59
	struct perf_data_file	file;
60
	struct auxtrace_record	*itr;
61 62 63 64 65
	struct perf_evlist	*evlist;
	struct perf_session	*session;
	const char		*progname;
	int			realtime_prio;
	bool			no_buildid;
66
	bool			no_buildid_set;
67
	bool			no_buildid_cache;
68
	bool			no_buildid_cache_set;
69
	bool			buildid_all;
70
	bool			timestamp_filename;
71
	struct switch_output	switch_output;
72
	unsigned long long	samples;
73
};
74

75
static int record__write(struct record *rec, void *bf, size_t size)
76
{
77
	if (perf_data_file__write(rec->session->file, bf, size) < 0) {
78 79
		pr_err("failed to write perf data, error: %m\n");
		return -1;
80
	}
81

82
	rec->bytes_written += size;
83
	return 0;
84 85
}

86
static int process_synthesized_event(struct perf_tool *tool,
87
				     union perf_event *event,
88 89
				     struct perf_sample *sample __maybe_unused,
				     struct machine *machine __maybe_unused)
90
{
91 92
	struct record *rec = container_of(tool, struct record, tool);
	return record__write(rec, event, event->header.size);
93 94
}

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

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

142 143 144
static int
record__mmap_read(struct record *rec, struct perf_mmap *md,
		  bool overwrite, bool backward)
145
{
146 147
	u64 head = perf_mmap__read_head(md);
	u64 old = md->prev;
148
	u64 end = head, start = old;
J
Jiri Olsa 已提交
149
	unsigned char *data = md->base + page_size;
150 151
	unsigned long size;
	void *buf;
152
	int rc = 0;
153

154 155
	if (rb_find_range(data, md->mask, head,
			  old, &start, &end, backward))
156 157
		return -1;

158
	if (start == end)
159
		return 0;
160

161
	rec->samples++;
162

163
	size = end - start;
164 165 166 167
	if (size > (unsigned long)(md->mask) + 1) {
		WARN_ONCE(1, "failed to keep up with mmap data. (warn only once)\n");

		md->prev = head;
168
		perf_mmap__consume(md, overwrite || backward);
169 170
		return 0;
	}
171

172 173 174 175
	if ((start & md->mask) + size != (end & md->mask)) {
		buf = &data[start & md->mask];
		size = md->mask + 1 - (start & md->mask);
		start += size;
176

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

183 184 185
	buf = &data[start & md->mask];
	size = end - start;
	start += size;
186

187
	if (record__write(rec, buf, size) < 0) {
188 189 190
		rc = -1;
		goto out;
	}
191

192
	md->prev = head;
193
	perf_mmap__consume(md, overwrite || backward);
194 195
out:
	return rc;
196 197
}

198 199 200
static volatile int done;
static volatile int signr = -1;
static volatile int child_finished;
201

202
static volatile int auxtrace_record__snapshot_started;
203
static DEFINE_TRIGGER(auxtrace_snapshot_trigger);
204
static DEFINE_TRIGGER(switch_output_trigger);
205 206 207 208 209 210 211 212 213 214 215

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

	done = 1;
}

W
Wang Nan 已提交
216 217 218 219 220 221
static void sigsegv_handler(int sig)
{
	perf_hooks__recover();
	sighandler_dump_stack(sig);
}

222 223 224 225 226 227 228 229 230
static void record__sig_exit(void)
{
	if (signr == -1)
		return;

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

231 232
#ifdef HAVE_AUXTRACE_SUPPORT

233 234 235 236 237
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);
238
	struct perf_data_file *file = &rec->file;
239 240 241
	size_t padding;
	u8 pad[8] = {0};

242 243 244 245 246 247 248 249 250 251 252 253 254 255
	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;
	}

256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
	/* 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;
}

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 315 316 317 318 319 320 321 322 323 324 325 326 327
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) {
328
		trigger_error(&auxtrace_snapshot_trigger);
329
	} else {
330 331 332 333
		if (auxtrace_record__snapshot_finish(rec->itr))
			trigger_error(&auxtrace_snapshot_trigger);
		else
			trigger_ready(&auxtrace_snapshot_trigger);
334 335 336
	}
}

337 338 339 340 341 342 343 344 345
#else

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

346 347
static inline
void record__read_auxtrace_snapshot(struct record *rec __maybe_unused)
348
{
349 350
}

351 352
static inline
int auxtrace_record__snapshot_start(struct auxtrace_record *itr __maybe_unused)
353
{
354
	return 0;
355 356
}

357 358
#endif

359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
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,
378
				str_error_r(errno, msg, sizeof(msg)));
379 380 381 382 383 384 385 386 387 388 389 390 391 392
			if (errno)
				return -errno;
			else
				return -EINVAL;
		}
	}
	return 0;
}

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

393
static int record__open(struct record *rec)
394
{
395
	char msg[512];
396
	struct perf_evsel *pos;
397 398
	struct perf_evlist *evlist = rec->evlist;
	struct perf_session *session = rec->session;
399
	struct record_opts *opts = &rec->opts;
400
	struct perf_evsel_config_term *err_term;
401
	int rc = 0;
402

403
	perf_evlist__config(evlist, opts, &callchain_param);
404

405
	evlist__for_each_entry(evlist, pos) {
406
try_again:
407
		if (perf_evsel__open(pos, pos->cpus, pos->threads) < 0) {
408
			if (perf_evsel__fallback(pos, errno, msg, sizeof(msg))) {
409
				if (verbose)
410
					ui__warning("%s\n", msg);
411 412
				goto try_again;
			}
413

414 415 416 417
			rc = -errno;
			perf_evsel__open_strerror(pos, &opts->target,
						  errno, msg, sizeof(msg));
			ui__error("%s\n", msg);
418
			goto out;
L
Li Zefan 已提交
419 420
		}
	}
421

422 423 424
	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,
425
			str_error_r(errno, msg, sizeof(msg)));
426
		rc = -1;
427 428 429 430 431 432 433 434
		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;
435
		goto out;
436 437
	}

438 439
	rc = record__mmap(rec);
	if (rc)
440
		goto out;
441

442
	session->evlist = evlist;
443
	perf_session__set_id_hdr_size(session);
444 445
out:
	return rc;
446 447
}

448 449 450 451 452 453 454 455 456 457 458 459 460
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);
}

461
static int process_buildids(struct record *rec)
462
{
463 464
	struct perf_data_file *file  = &rec->file;
	struct perf_session *session = rec->session;
465

466
	if (file->size == 0)
467 468
		return 0;

469 470 471 472 473 474 475 476 477 478 479
	/*
	 * 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;

480 481 482 483 484 485 486
	/*
	 * 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;

487
	return perf_session__process_events(session);
488 489
}

490
static void perf_event__synthesize_guest_os(struct machine *machine, void *data)
491 492
{
	int err;
493
	struct perf_tool *tool = data;
494 495 496 497 498 499 500 501
	/*
	 *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.
	 */
502
	err = perf_event__synthesize_modules(tool, process_synthesized_event,
503
					     machine);
504 505
	if (err < 0)
		pr_err("Couldn't record guest kernel [%d]'s reference"
506
		       " relocation symbol.\n", machine->pid);
507 508 509 510 511

	/*
	 * We use _stext for guest kernel because guest kernel's /proc/kallsyms
	 * have no _text sometimes.
	 */
512
	err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
513
						 machine);
514 515
	if (err < 0)
		pr_err("Couldn't record guest kernel [%d]'s reference"
516
		       " relocation symbol.\n", machine->pid);
517 518
}

519 520 521 522 523
static struct perf_event_header finished_round_event = {
	.size = sizeof(struct perf_event_header),
	.type = PERF_RECORD_FINISHED_ROUND,
};

524 525
static int record__mmap_read_evlist(struct record *rec, struct perf_evlist *evlist,
				    bool backward)
526
{
527
	u64 bytes_written = rec->bytes_written;
528
	int i;
529
	int rc = 0;
530
	struct perf_mmap *maps;
531

532 533
	if (!evlist)
		return 0;
534

535
	maps = backward ? evlist->backward_mmap : evlist->mmap;
536 537 538
	if (!maps)
		return 0;

539 540 541
	if (backward && evlist->bkw_mmap_state != BKW_MMAP_DATA_PENDING)
		return 0;

542
	for (i = 0; i < evlist->nr_mmaps; i++) {
543
		struct auxtrace_mmap *mm = &maps[i].auxtrace_mmap;
544

545 546 547
		if (maps[i].base) {
			if (record__mmap_read(rec, &maps[i],
					      evlist->overwrite, backward) != 0) {
548 549 550 551
				rc = -1;
				goto out;
			}
		}
552

553
		if (mm->base && !rec->opts.auxtrace_snapshot_mode &&
554 555 556 557
		    record__auxtrace_mmap_read(rec, mm) != 0) {
			rc = -1;
			goto out;
		}
558 559
	}

560 561 562 563 564 565
	/*
	 * 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));
566

567 568
	if (backward)
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_EMPTY);
569 570
out:
	return rc;
571 572
}

573 574 575 576
static int record__mmap_read_all(struct record *rec)
{
	int err;

577
	err = record__mmap_read_evlist(rec, rec->evlist, false);
578 579 580
	if (err)
		return err;

581
	return record__mmap_read_evlist(rec, rec->evlist, true);
582 583
}

584
static void record__init_features(struct record *rec)
585 586 587 588 589 590 591 592 593 594
{
	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);

595
	if (!have_tracepoints(&rec->evlist->entries))
596 597 598 599
		perf_header__clear_feat(&session->header, HEADER_TRACING_DATA);

	if (!rec->opts.branch_stack)
		perf_header__clear_feat(&session->header, HEADER_BRANCH_STACK);
600 601 602

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

	perf_header__clear_feat(&session->header, HEADER_STAT);
605 606
}

607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
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;
}

630
static int record__synthesize_workload(struct record *rec, bool tail)
631 632 633 634 635 636
{
	struct {
		struct thread_map map;
		struct thread_map_data map_data;
	} thread_map;

637 638 639
	if (rec->opts.tail_synthesize != tail)
		return 0;

640 641 642 643 644 645 646 647 648 649
	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);
}

650
static int record__synthesize(struct record *rec, bool tail);
651

652 653 654 655 656 657 658 659 660
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";

661 662 663 664
	record__synthesize(rec, true);
	if (target__none(&rec->opts.target))
		record__synthesize_workload(rec, true);

665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
	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);
684 685

	/* Output tracking events */
686
	if (!at_exit) {
687
		record__synthesize(rec, false);
688

689 690 691 692 693 694 695 696 697 698
		/*
		 * 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))
699
			record__synthesize_workload(rec, false);
700
	}
701 702 703
	return fd;
}

704 705 706 707 708 709 710
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.
 */
711 712
static void workload_exec_failed_signal(int signo __maybe_unused,
					siginfo_t *info,
713 714 715 716 717 718 719
					void *ucontext __maybe_unused)
{
	workload_exec_errno = info->si_value.sival_int;
	done = 1;
	child_finished = 1;
}

720 721
static void snapshot_sig_handler(int sig);

722 723 724 725 726 727 728 729 730
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;
}

731 732 733
static const struct perf_event_mmap_page *
perf_evlist__pick_pc(struct perf_evlist *evlist)
{
734 735 736 737 738 739
	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;
	}
740 741 742
	return NULL;
}

743 744
static const struct perf_event_mmap_page *record__pick_pc(struct record *rec)
{
745 746 747 748 749
	const struct perf_event_mmap_page *pc;

	pc = perf_evlist__pick_pc(rec->evlist);
	if (pc)
		return pc;
750 751 752
	return NULL;
}

753
static int record__synthesize(struct record *rec, bool tail)
754 755 756 757 758 759 760 761 762
{
	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;

763 764 765
	if (rec->opts.tail_synthesize != tail)
		return 0;

766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792
	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;
		}
	}

793
	err = perf_event__synth_time_conv(record__pick_pc(rec), tool,
794 795 796 797
					  process_synthesized_event, machine);
	if (err)
		goto out;

798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828
	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;
}

829
static int __cmd_record(struct record *rec, int argc, const char **argv)
830
{
831
	int err;
832
	int status = 0;
833
	unsigned long waking = 0;
834
	const bool forks = argc > 0;
835
	struct machine *machine;
836
	struct perf_tool *tool = &rec->tool;
837
	struct record_opts *opts = &rec->opts;
838
	struct perf_data_file *file = &rec->file;
839
	struct perf_session *session;
840
	bool disabled = false, draining = false;
841
	int fd;
842

843
	rec->progname = argv[0];
844

845
	atexit(record__sig_exit);
846 847
	signal(SIGCHLD, sig_handler);
	signal(SIGINT, sig_handler);
848
	signal(SIGTERM, sig_handler);
W
Wang Nan 已提交
849
	signal(SIGSEGV, sigsegv_handler);
850

851
	if (rec->opts.auxtrace_snapshot_mode || rec->switch_output.signal) {
852
		signal(SIGUSR2, snapshot_sig_handler);
853 854
		if (rec->opts.auxtrace_snapshot_mode)
			trigger_on(&auxtrace_snapshot_trigger);
855
		if (rec->switch_output.signal)
856
			trigger_on(&switch_output_trigger);
857
	} else {
858
		signal(SIGUSR2, SIG_IGN);
859
	}
860

861
	session = perf_session__new(file, false, tool);
862
	if (session == NULL) {
A
Adrien BAK 已提交
863
		pr_err("Perf session creation failed.\n");
864 865 866
		return -1;
	}

867
	fd = perf_data_file__fd(file);
868 869
	rec->session = session;

870
	record__init_features(rec);
871

872
	if (forks) {
873
		err = perf_evlist__prepare_workload(rec->evlist, &opts->target,
874
						    argv, file->is_pipe,
875
						    workload_exec_failed_signal);
876 877
		if (err < 0) {
			pr_err("Couldn't run the workload!\n");
878
			status = err;
879
			goto out_delete_session;
880 881 882
		}
	}

883
	if (record__open(rec) != 0) {
884
		err = -1;
885
		goto out_child;
886
	}
887

888 889 890 891 892 893 894 895 896 897
	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;
	}

898 899 900 901 902 903 904 905 906
	/*
	 * 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;
	}

907
	if (!rec->evlist->nr_groups)
908 909
		perf_header__clear_feat(&session->header, HEADER_GROUP_DESC);

910
	if (file->is_pipe) {
911
		err = perf_header__write_pipe(fd);
912
		if (err < 0)
913
			goto out_child;
914
	} else {
915
		err = perf_session__write_header(session, rec->evlist, fd, false);
916
		if (err < 0)
917
			goto out_child;
918 919
	}

920
	if (!rec->no_buildid
921
	    && !perf_header__has_feat(&session->header, HEADER_BUILD_ID)) {
922
		pr_err("Couldn't generate buildids. "
923
		       "Use --no-buildid to profile anyway.\n");
924
		err = -1;
925
		goto out_child;
926 927
	}

928
	machine = &session->machines.host;
929

930
	err = record__synthesize(rec, false);
931
	if (err < 0)
932
		goto out_child;
933

934
	if (rec->realtime_prio) {
935 936
		struct sched_param param;

937
		param.sched_priority = rec->realtime_prio;
938
		if (sched_setscheduler(0, SCHED_FIFO, &param)) {
939
			pr_err("Could not set realtime priority.\n");
940
			err = -1;
941
			goto out_child;
942 943 944
		}
	}

945 946 947 948 949
	/*
	 * 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.
	 */
950
	if (!target__none(&opts->target) && !opts->initial_delay)
951
		perf_evlist__enable(rec->evlist);
952

953 954 955
	/*
	 * Let the child rip
	 */
956
	if (forks) {
957 958 959 960 961 962 963 964
		union perf_event *event;

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

965 966 967 968 969 970
		/*
		 * 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.
		 */
971
		perf_event__synthesize_comm(tool, event,
972 973 974
					    rec->evlist->workload.pid,
					    process_synthesized_event,
					    machine);
975
		free(event);
976

977
		perf_evlist__start_workload(rec->evlist);
978
	}
979

980
	if (opts->initial_delay) {
981
		usleep(opts->initial_delay * USEC_PER_MSEC);
982 983 984
		perf_evlist__enable(rec->evlist);
	}

985
	trigger_ready(&auxtrace_snapshot_trigger);
986
	trigger_ready(&switch_output_trigger);
W
Wang Nan 已提交
987
	perf_hooks__invoke_record_start();
988
	for (;;) {
989
		unsigned long long hits = rec->samples;
990

991 992 993 994 995 996 997 998 999 1000 1001
		/*
		 * 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);

1002
		if (record__mmap_read_all(rec) < 0) {
1003
			trigger_error(&auxtrace_snapshot_trigger);
1004
			trigger_error(&switch_output_trigger);
1005
			err = -1;
1006
			goto out_child;
1007
		}
1008

1009 1010
		if (auxtrace_record__snapshot_started) {
			auxtrace_record__snapshot_started = 0;
1011
			if (!trigger_is_error(&auxtrace_snapshot_trigger))
1012
				record__read_auxtrace_snapshot(rec);
1013
			if (trigger_is_error(&auxtrace_snapshot_trigger)) {
1014 1015 1016 1017 1018 1019
				pr_err("AUX area tracing snapshot failed\n");
				err = -1;
				goto out_child;
			}
		}

1020
		if (trigger_is_hit(&switch_output_trigger)) {
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
			/*
			 * 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;
1032 1033
			trigger_ready(&switch_output_trigger);

1034 1035 1036 1037 1038 1039 1040
			/*
			 * 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);

1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
			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;
			}
		}

1054
		if (hits == rec->samples) {
1055
			if (done || draining)
1056
				break;
1057
			err = perf_evlist__poll(rec->evlist, -1);
1058 1059 1060 1061 1062
			/*
			 * Propagate error, only if there's any. Ignore positive
			 * number of returned events and interrupt error.
			 */
			if (err > 0 || (err < 0 && errno == EINTR))
1063
				err = 0;
1064
			waking++;
1065 1066 1067

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

1070 1071 1072 1073 1074
		/*
		 * 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.
		 */
1075
		if (done && !disabled && !target__none(&opts->target)) {
1076
			trigger_off(&auxtrace_snapshot_trigger);
1077
			perf_evlist__disable(rec->evlist);
1078 1079
			disabled = true;
		}
1080
	}
1081
	trigger_off(&auxtrace_snapshot_trigger);
1082
	trigger_off(&switch_output_trigger);
1083

1084
	if (forks && workload_exec_errno) {
1085
		char msg[STRERR_BUFSIZE];
1086
		const char *emsg = str_error_r(workload_exec_errno, msg, sizeof(msg));
1087 1088
		pr_err("Workload failed: %s\n", emsg);
		err = -1;
1089
		goto out_child;
1090 1091
	}

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

1095 1096 1097
	if (target__none(&rec->opts.target))
		record__synthesize_workload(rec, true);

1098 1099 1100
out_child:
	if (forks) {
		int exit_status;
1101

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

1116
	record__synthesize(rec, true);
1117 1118 1119
	/* this will be recalculated during process_buildids() */
	rec->samples = 0;

1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
	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;
			}
		}
	}
1131

W
Wang Nan 已提交
1132 1133
	perf_hooks__invoke_record_end();

1134 1135
	if (!err && !quiet) {
		char samples[128];
1136 1137
		const char *postfix = rec->timestamp_filename ?
					".<timestamp>" : "";
1138

1139
		if (rec->samples && !rec->opts.full_auxtrace)
1140 1141 1142 1143 1144
			scnprintf(samples, sizeof(samples),
				  " (%" PRIu64 " samples)", rec->samples);
		else
			samples[0] = '\0';

1145
		fprintf(stderr,	"[ perf record: Captured and wrote %.3f MB %s%s%s ]\n",
1146
			perf_data_file__size(file) / 1024.0 / 1024.0,
1147
			file->path, postfix, samples);
1148 1149
	}

1150 1151
out_delete_session:
	perf_session__delete(session);
1152
	return status;
1153
}
1154

1155
static void callchain_debug(struct callchain_param *callchain)
J
Jiri Olsa 已提交
1156
{
1157
	static const char *str[CALLCHAIN_MAX] = { "NONE", "FP", "DWARF", "LBR" };
1158

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

1161
	if (callchain->record_mode == CALLCHAIN_DWARF)
J
Jiri Olsa 已提交
1162
		pr_debug("callchain: stack dump size %d\n",
1163
			 callchain->dump_size);
J
Jiri Olsa 已提交
1164 1165
}

1166 1167 1168
int record_opts__parse_callchain(struct record_opts *record,
				 struct callchain_param *callchain,
				 const char *arg, bool unset)
J
Jiri Olsa 已提交
1169 1170
{
	int ret;
1171
	callchain->enabled = !unset;
1172

J
Jiri Olsa 已提交
1173 1174
	/* --no-call-graph */
	if (unset) {
1175
		callchain->record_mode = CALLCHAIN_NONE;
J
Jiri Olsa 已提交
1176 1177 1178 1179
		pr_debug("callchain: disabled\n");
		return 0;
	}

1180
	ret = parse_callchain_record_opt(arg, callchain);
1181 1182
	if (!ret) {
		/* Enable data address sampling for DWARF unwind. */
1183
		if (callchain->record_mode == CALLCHAIN_DWARF)
1184
			record->sample_address = true;
1185
		callchain_debug(callchain);
1186
	}
1187 1188 1189 1190

	return ret;
}

1191 1192 1193 1194 1195 1196 1197
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);
}

1198
int record_callchain_opt(const struct option *opt,
J
Jiri Olsa 已提交
1199 1200 1201
			 const char *arg __maybe_unused,
			 int unset __maybe_unused)
{
1202
	struct callchain_param *callchain = opt->value;
1203

1204
	callchain->enabled = true;
J
Jiri Olsa 已提交
1205

1206 1207
	if (callchain->record_mode == CALLCHAIN_NONE)
		callchain->record_mode = CALLCHAIN_FP;
1208

1209
	callchain_debug(callchain);
J
Jiri Olsa 已提交
1210 1211 1212
	return 0;
}

1213 1214
static int perf_record_config(const char *var, const char *value, void *cb)
{
1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227
	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;
	}
1228
	if (!strcmp(var, "record.call-graph"))
1229
		var = "call-graph.record-mode"; /* fall-through */
1230 1231 1232 1233

	return perf_default_config(var, value, cb);
}

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 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317
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;
}

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 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360
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;
}

1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376
static int switch_output_setup(struct record *rec)
{
	struct switch_output *s = &rec->switch_output;

	if (!s->set)
		return 0;

	if (!strcmp(s->str, "signal")) {
		s->signal = true;
		pr_debug("switch-output with SIGUSR2 signal\n");
		return 0;
	}

	return -1;
}

1377
static const char * const __record_usage[] = {
1378 1379
	"perf record [<options>] [<command>]",
	"perf record [<options>] -- <command> [<options>]",
1380 1381
	NULL
};
1382
const char * const *record_usage = __record_usage;
1383

1384
/*
1385 1386
 * 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
1387 1388 1389 1390 1391 1392 1393
 * 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.
 */
1394
static struct record record = {
1395
	.opts = {
1396
		.sample_time	     = true,
1397 1398 1399
		.mmap_pages	     = UINT_MAX,
		.user_freq	     = UINT_MAX,
		.user_interval	     = ULLONG_MAX,
1400
		.freq		     = 4000,
N
Namhyung Kim 已提交
1401 1402
		.target		     = {
			.uses_mmap   = true,
1403
			.default_per_cpu = true,
N
Namhyung Kim 已提交
1404
		},
1405
		.proc_map_timeout     = 500,
1406
	},
1407 1408 1409
	.tool = {
		.sample		= process_sample_event,
		.fork		= perf_event__process_fork,
1410
		.exit		= perf_event__process_exit,
1411 1412 1413
		.comm		= perf_event__process_comm,
		.mmap		= perf_event__process_mmap,
		.mmap2		= perf_event__process_mmap2,
1414
		.ordered_events	= true,
1415
	},
1416
};
1417

1418 1419
const char record_callchain_help[] = CALLCHAIN_RECORD_HELP
	"\n\t\t\t\tDefault: fp";
1420

1421 1422
static bool dry_run;

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

	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",
1507
		     parse_branch_stack),
1508 1509
	OPT_BOOLEAN('W', "weight", &record.opts.sample_weight,
		    "sample by weight (on special events only)"),
1510 1511
	OPT_BOOLEAN(0, "transaction", &record.opts.sample_transaction,
		    "sample transaction flags (special events only)"),
1512 1513
	OPT_BOOLEAN(0, "per-thread", &record.opts.target.per_thread,
		    "use per-thread mmaps"),
1514 1515 1516
	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),
1517 1518
	OPT_BOOLEAN(0, "running-time", &record.opts.running_time,
		    "Record running/enabled time of read (:S) events"),
1519 1520 1521
	OPT_CALLBACK('k', "clockid", &record.opts,
	"clockid", "clockid to use for events, see clock_gettime()",
	parse_clockid),
1522 1523
	OPT_STRING_OPTARG('S', "snapshot", &record.opts.auxtrace_snapshot_opts,
			  "opts", "AUX area tracing Snapshot Mode", ""),
1524 1525
	OPT_UINTEGER(0, "proc-map-timeout", &record.opts.proc_map_timeout,
			"per thread proc mmap processing timeout in ms"),
1526 1527
	OPT_BOOLEAN(0, "switch-events", &record.opts.record_switch_events,
		    "Record context switch events"),
1528 1529 1530 1531 1532 1533
	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),
1534 1535 1536 1537
	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"),
1538 1539
	OPT_STRING(0, "vmlinux", &symbol_conf.vmlinux_name,
		   "file", "vmlinux pathname"),
1540 1541
	OPT_BOOLEAN(0, "buildid-all", &record.buildid_all,
		    "Record build-id of all DSOs regardless of hits"),
1542 1543
	OPT_BOOLEAN(0, "timestamp-filename", &record.timestamp_filename,
		    "append timestamp to output filename"),
1544 1545 1546
	OPT_STRING_OPTARG_SET(0, "switch-output", &record.switch_output.str,
			  &record.switch_output.set, "signal",
			  "Switch output when receive SIGUSR2", "signal"),
1547 1548
	OPT_BOOLEAN(0, "dry-run", &dry_run,
		    "Parse options then exit"),
1549 1550 1551
	OPT_END()
};

1552 1553
struct option *record_options = __record_options;

1554
int cmd_record(int argc, const char **argv, const char *prefix __maybe_unused)
1555
{
1556
	int err;
1557
	struct record *rec = &record;
1558
	char errbuf[BUFSIZ];
1559

1560 1561 1562 1563 1564
#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
1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578
#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
1579 1580
#endif

1581 1582
	rec->evlist = perf_evlist__new();
	if (rec->evlist == NULL)
1583 1584
		return -ENOMEM;

1585 1586
	perf_config(perf_record_config, rec);

1587
	argc = parse_options(argc, argv, record_options, record_usage,
1588
			    PARSE_OPT_STOP_AT_NON_OPTION);
1589
	if (!argc && target__none(&rec->opts.target))
1590
		usage_with_options(record_usage, record_options);
1591

1592
	if (nr_cgroups && !rec->opts.target.system_wide) {
1593 1594 1595
		usage_with_options_msg(record_usage, record_options,
			"cgroup monitoring only available in system-wide mode");

S
Stephane Eranian 已提交
1596
	}
1597 1598
	if (rec->opts.record_switch_events &&
	    !perf_can_record_switch_events()) {
1599 1600 1601
		ui__error("kernel does not support recording context switch events\n");
		parse_options_usage(record_usage, record_options, "switch-events", 0);
		return -EINVAL;
1602
	}
S
Stephane Eranian 已提交
1603

1604 1605 1606 1607 1608
	if (switch_output_setup(rec)) {
		parse_options_usage(record_usage, record_options, "switch-output", 0);
		return -EINVAL;
	}

1609
	if (rec->switch_output.signal)
1610 1611
		rec->timestamp_filename = true;

1612 1613 1614
	if (!rec->itr) {
		rec->itr = auxtrace_record__init(rec->evlist, &err);
		if (err)
A
Adrian Hunter 已提交
1615
			goto out;
1616 1617
	}

1618 1619 1620
	err = auxtrace_parse_snapshot_options(rec->itr, &rec->opts,
					      rec->opts.auxtrace_snapshot_opts);
	if (err)
A
Adrian Hunter 已提交
1621
		goto out;
1622

1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634
	/*
	 * 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;

1635
	if (dry_run)
A
Adrian Hunter 已提交
1636
		goto out;
1637

1638 1639 1640 1641 1642
	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 已提交
1643
		goto out;
1644 1645
	}

1646 1647
	err = -ENOMEM;

1648
	if (symbol_conf.kptr_restrict)
1649 1650 1651 1652 1653 1654 1655 1656
		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");
1657

1658
	if (rec->no_buildid_cache || rec->no_buildid) {
1659
		disable_buildid_cache();
1660
	} else if (rec->switch_output.signal) {
1661 1662 1663 1664 1665 1666
		/*
		 * 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
		 *
1667
		 *  perf record --switch-output --no-no-buildid \
1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687
		 *              --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();
		}
	}
1688

1689 1690 1691
	if (record.opts.overwrite)
		record.opts.tail_synthesize = true;

1692 1693
	if (rec->evlist->nr_entries == 0 &&
	    perf_evlist__add_default(rec->evlist) < 0) {
1694
		pr_err("Not enough memory for event selector list\n");
1695
		goto out;
1696
	}
1697

1698 1699 1700
	if (rec->opts.target.tid && !rec->opts.no_inherit_set)
		rec->opts.no_inherit = true;

1701
	err = target__validate(&rec->opts.target);
1702
	if (err) {
1703
		target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
1704 1705 1706
		ui__warning("%s", errbuf);
	}

1707
	err = target__parse_uid(&rec->opts.target);
1708 1709
	if (err) {
		int saved_errno = errno;
1710

1711
		target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
1712
		ui__error("%s", errbuf);
1713 1714

		err = -saved_errno;
1715
		goto out;
1716
	}
1717

1718 1719 1720
	/* Enable ignoring missing threads when -u option is defined. */
	rec->opts.ignore_missing_thread = rec->opts.target.uid != UINT_MAX;

1721
	err = -ENOMEM;
1722
	if (perf_evlist__create_maps(rec->evlist, &rec->opts.target) < 0)
1723
		usage_with_options(record_usage, record_options);
1724

1725 1726
	err = auxtrace_record__options(rec->itr, rec->evlist, &rec->opts);
	if (err)
1727
		goto out;
1728

1729 1730 1731 1732 1733 1734 1735 1736
	/*
	 * 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;

1737
	if (record_opts__config(&rec->opts)) {
1738
		err = -EINVAL;
1739
		goto out;
1740 1741
	}

1742
	err = __cmd_record(&record, argc, argv);
1743
out:
1744
	perf_evlist__delete(rec->evlist);
1745
	symbol__exit();
1746
	auxtrace_record__free(rec->itr);
1747
	return err;
1748
}
1749 1750 1751

static void snapshot_sig_handler(int sig __maybe_unused)
{
1752 1753 1754 1755 1756 1757
	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);
	}
1758 1759 1760

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