builtin-record.c 44.9 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
struct record {
50
	struct perf_tool	tool;
51
	struct record_opts	opts;
52
	u64			bytes_written;
53
	struct perf_data_file	file;
54
	struct auxtrace_record	*itr;
55 56 57 58 59
	struct perf_evlist	*evlist;
	struct perf_session	*session;
	const char		*progname;
	int			realtime_prio;
	bool			no_buildid;
60
	bool			no_buildid_set;
61
	bool			no_buildid_cache;
62
	bool			no_buildid_cache_set;
63
	bool			buildid_all;
64
	bool			timestamp_filename;
65
	bool			switch_output;
66
	unsigned long long	samples;
67
};
68

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

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

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

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

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

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

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

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

155
	rec->samples++;
156

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

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

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

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

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

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

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

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

196
static volatile int auxtrace_record__snapshot_started;
197
static DEFINE_TRIGGER(auxtrace_snapshot_trigger);
198
static DEFINE_TRIGGER(switch_output_trigger);
199 200 201 202 203 204 205 206 207 208 209

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

	done = 1;
}

W
Wang Nan 已提交
210 211 212 213 214 215
static void sigsegv_handler(int sig)
{
	perf_hooks__recover();
	sighandler_dump_stack(sig);
}

216 217 218 219 220 221 222 223 224
static void record__sig_exit(void)
{
	if (signr == -1)
		return;

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

225 226
#ifdef HAVE_AUXTRACE_SUPPORT

227 228 229 230 231
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);
232
	struct perf_data_file *file = &rec->file;
233 234 235
	size_t padding;
	u8 pad[8] = {0};

236 237 238 239 240 241 242 243 244 245 246 247 248 249
	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;
	}

250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
	/* 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;
}

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

331 332 333 334 335 336 337 338 339
#else

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

340 341
static inline
void record__read_auxtrace_snapshot(struct record *rec __maybe_unused)
342
{
343 344
}

345 346
static inline
int auxtrace_record__snapshot_start(struct auxtrace_record *itr __maybe_unused)
347
{
348
	return 0;
349 350
}

351 352
#endif

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

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

387
static int record__open(struct record *rec)
388
{
389
	char msg[512];
390
	struct perf_evsel *pos;
391 392
	struct perf_evlist *evlist = rec->evlist;
	struct perf_session *session = rec->session;
393
	struct record_opts *opts = &rec->opts;
394
	struct perf_evsel_config_term *err_term;
395
	int rc = 0;
396

397
	perf_evlist__config(evlist, opts, &callchain_param);
398

399
	evlist__for_each_entry(evlist, pos) {
400
try_again:
401
		if (perf_evsel__open(pos, pos->cpus, pos->threads) < 0) {
402
			if (perf_evsel__fallback(pos, errno, msg, sizeof(msg))) {
403
				if (verbose)
404
					ui__warning("%s\n", msg);
405 406
				goto try_again;
			}
407

408 409 410 411
			rc = -errno;
			perf_evsel__open_strerror(pos, &opts->target,
						  errno, msg, sizeof(msg));
			ui__error("%s\n", msg);
412
			goto out;
L
Li Zefan 已提交
413 414
		}
	}
415

416 417 418
	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,
419
			str_error_r(errno, msg, sizeof(msg)));
420
		rc = -1;
421 422 423 424 425 426 427 428
		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;
429
		goto out;
430 431
	}

432 433
	rc = record__mmap(rec);
	if (rc)
434
		goto out;
435

436
	session->evlist = evlist;
437
	perf_session__set_id_hdr_size(session);
438 439
out:
	return rc;
440 441
}

442 443 444 445 446 447 448 449 450 451 452 453 454
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);
}

455
static int process_buildids(struct record *rec)
456
{
457 458
	struct perf_data_file *file  = &rec->file;
	struct perf_session *session = rec->session;
459

460
	if (file->size == 0)
461 462
		return 0;

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

474 475 476 477 478 479 480
	/*
	 * 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;

481
	return perf_session__process_events(session);
482 483
}

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

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

513 514 515 516 517
static struct perf_event_header finished_round_event = {
	.size = sizeof(struct perf_event_header),
	.type = PERF_RECORD_FINISHED_ROUND,
};

518 519
static int record__mmap_read_evlist(struct record *rec, struct perf_evlist *evlist,
				    bool backward)
520
{
521
	u64 bytes_written = rec->bytes_written;
522
	int i;
523
	int rc = 0;
524
	struct perf_mmap *maps;
525

526 527
	if (!evlist)
		return 0;
528

529
	maps = backward ? evlist->backward_mmap : evlist->mmap;
530 531 532
	if (!maps)
		return 0;

533 534 535
	if (backward && evlist->bkw_mmap_state != BKW_MMAP_DATA_PENDING)
		return 0;

536
	for (i = 0; i < evlist->nr_mmaps; i++) {
537
		struct auxtrace_mmap *mm = &maps[i].auxtrace_mmap;
538

539 540 541
		if (maps[i].base) {
			if (record__mmap_read(rec, &maps[i],
					      evlist->overwrite, backward) != 0) {
542 543 544 545
				rc = -1;
				goto out;
			}
		}
546

547
		if (mm->base && !rec->opts.auxtrace_snapshot_mode &&
548 549 550 551
		    record__auxtrace_mmap_read(rec, mm) != 0) {
			rc = -1;
			goto out;
		}
552 553
	}

554 555 556 557 558 559
	/*
	 * 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));
560

561 562
	if (backward)
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_EMPTY);
563 564
out:
	return rc;
565 566
}

567 568 569 570
static int record__mmap_read_all(struct record *rec)
{
	int err;

571
	err = record__mmap_read_evlist(rec, rec->evlist, false);
572 573 574
	if (err)
		return err;

575
	return record__mmap_read_evlist(rec, rec->evlist, true);
576 577
}

578
static void record__init_features(struct record *rec)
579 580 581 582 583 584 585 586 587 588
{
	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);

589
	if (!have_tracepoints(&rec->evlist->entries))
590 591 592 593
		perf_header__clear_feat(&session->header, HEADER_TRACING_DATA);

	if (!rec->opts.branch_stack)
		perf_header__clear_feat(&session->header, HEADER_BRANCH_STACK);
594 595 596

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

	perf_header__clear_feat(&session->header, HEADER_STAT);
599 600
}

601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
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;
}

624
static int record__synthesize_workload(struct record *rec, bool tail)
625 626 627 628 629 630
{
	struct {
		struct thread_map map;
		struct thread_map_data map_data;
	} thread_map;

631 632 633
	if (rec->opts.tail_synthesize != tail)
		return 0;

634 635 636 637 638 639 640 641 642 643
	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);
}

644
static int record__synthesize(struct record *rec, bool tail);
645

646 647 648 649 650 651 652 653 654
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";

655 656 657 658
	record__synthesize(rec, true);
	if (target__none(&rec->opts.target))
		record__synthesize_workload(rec, true);

659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677
	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);
678 679

	/* Output tracking events */
680
	if (!at_exit) {
681
		record__synthesize(rec, false);
682

683 684 685 686 687 688 689 690 691 692
		/*
		 * 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))
693
			record__synthesize_workload(rec, false);
694
	}
695 696 697
	return fd;
}

698 699 700 701 702 703 704
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.
 */
705 706
static void workload_exec_failed_signal(int signo __maybe_unused,
					siginfo_t *info,
707 708 709 710 711 712 713
					void *ucontext __maybe_unused)
{
	workload_exec_errno = info->si_value.sival_int;
	done = 1;
	child_finished = 1;
}

714 715
static void snapshot_sig_handler(int sig);

716 717 718 719 720 721 722 723 724
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;
}

725 726 727
static const struct perf_event_mmap_page *
perf_evlist__pick_pc(struct perf_evlist *evlist)
{
728 729 730 731 732 733
	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;
	}
734 735 736
	return NULL;
}

737 738
static const struct perf_event_mmap_page *record__pick_pc(struct record *rec)
{
739 740 741 742 743
	const struct perf_event_mmap_page *pc;

	pc = perf_evlist__pick_pc(rec->evlist);
	if (pc)
		return pc;
744 745 746
	return NULL;
}

747
static int record__synthesize(struct record *rec, bool tail)
748 749 750 751 752 753 754 755 756
{
	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;

757 758 759
	if (rec->opts.tail_synthesize != tail)
		return 0;

760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786
	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;
		}
	}

787
	err = perf_event__synth_time_conv(record__pick_pc(rec), tool,
788 789 790 791
					  process_synthesized_event, machine);
	if (err)
		goto out;

792 793 794 795 796 797 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
	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;
}

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

837
	rec->progname = argv[0];
838

839
	atexit(record__sig_exit);
840 841
	signal(SIGCHLD, sig_handler);
	signal(SIGINT, sig_handler);
842
	signal(SIGTERM, sig_handler);
W
Wang Nan 已提交
843
	signal(SIGSEGV, sigsegv_handler);
844

845
	if (rec->opts.auxtrace_snapshot_mode || rec->switch_output) {
846
		signal(SIGUSR2, snapshot_sig_handler);
847 848 849 850
		if (rec->opts.auxtrace_snapshot_mode)
			trigger_on(&auxtrace_snapshot_trigger);
		if (rec->switch_output)
			trigger_on(&switch_output_trigger);
851
	} else {
852
		signal(SIGUSR2, SIG_IGN);
853
	}
854

855
	session = perf_session__new(file, false, tool);
856
	if (session == NULL) {
A
Adrien BAK 已提交
857
		pr_err("Perf session creation failed.\n");
858 859 860
		return -1;
	}

861
	fd = perf_data_file__fd(file);
862 863
	rec->session = session;

864
	record__init_features(rec);
865

866
	if (forks) {
867
		err = perf_evlist__prepare_workload(rec->evlist, &opts->target,
868
						    argv, file->is_pipe,
869
						    workload_exec_failed_signal);
870 871
		if (err < 0) {
			pr_err("Couldn't run the workload!\n");
872
			status = err;
873
			goto out_delete_session;
874 875 876
		}
	}

877
	if (record__open(rec) != 0) {
878
		err = -1;
879
		goto out_child;
880
	}
881

882 883 884 885 886 887 888 889 890 891
	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;
	}

892 893 894 895 896 897 898 899 900
	/*
	 * 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;
	}

901
	if (!rec->evlist->nr_groups)
902 903
		perf_header__clear_feat(&session->header, HEADER_GROUP_DESC);

904
	if (file->is_pipe) {
905
		err = perf_header__write_pipe(fd);
906
		if (err < 0)
907
			goto out_child;
908
	} else {
909
		err = perf_session__write_header(session, rec->evlist, fd, false);
910
		if (err < 0)
911
			goto out_child;
912 913
	}

914
	if (!rec->no_buildid
915
	    && !perf_header__has_feat(&session->header, HEADER_BUILD_ID)) {
916
		pr_err("Couldn't generate buildids. "
917
		       "Use --no-buildid to profile anyway.\n");
918
		err = -1;
919
		goto out_child;
920 921
	}

922
	machine = &session->machines.host;
923

924
	err = record__synthesize(rec, false);
925
	if (err < 0)
926
		goto out_child;
927

928
	if (rec->realtime_prio) {
929 930
		struct sched_param param;

931
		param.sched_priority = rec->realtime_prio;
932
		if (sched_setscheduler(0, SCHED_FIFO, &param)) {
933
			pr_err("Could not set realtime priority.\n");
934
			err = -1;
935
			goto out_child;
936 937 938
		}
	}

939 940 941 942 943
	/*
	 * 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.
	 */
944
	if (!target__none(&opts->target) && !opts->initial_delay)
945
		perf_evlist__enable(rec->evlist);
946

947 948 949
	/*
	 * Let the child rip
	 */
950
	if (forks) {
951 952 953 954 955 956 957 958
		union perf_event *event;

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

959 960 961 962 963 964
		/*
		 * 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.
		 */
965
		perf_event__synthesize_comm(tool, event,
966 967 968
					    rec->evlist->workload.pid,
					    process_synthesized_event,
					    machine);
969
		free(event);
970

971
		perf_evlist__start_workload(rec->evlist);
972
	}
973

974
	if (opts->initial_delay) {
975
		usleep(opts->initial_delay * USEC_PER_MSEC);
976 977 978
		perf_evlist__enable(rec->evlist);
	}

979
	trigger_ready(&auxtrace_snapshot_trigger);
980
	trigger_ready(&switch_output_trigger);
W
Wang Nan 已提交
981
	perf_hooks__invoke_record_start();
982
	for (;;) {
983
		unsigned long long hits = rec->samples;
984

985 986 987 988 989 990 991 992 993 994 995
		/*
		 * 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);

996
		if (record__mmap_read_all(rec) < 0) {
997
			trigger_error(&auxtrace_snapshot_trigger);
998
			trigger_error(&switch_output_trigger);
999
			err = -1;
1000
			goto out_child;
1001
		}
1002

1003 1004
		if (auxtrace_record__snapshot_started) {
			auxtrace_record__snapshot_started = 0;
1005
			if (!trigger_is_error(&auxtrace_snapshot_trigger))
1006
				record__read_auxtrace_snapshot(rec);
1007
			if (trigger_is_error(&auxtrace_snapshot_trigger)) {
1008 1009 1010 1011 1012 1013
				pr_err("AUX area tracing snapshot failed\n");
				err = -1;
				goto out_child;
			}
		}

1014
		if (trigger_is_hit(&switch_output_trigger)) {
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
			/*
			 * 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;
1026 1027
			trigger_ready(&switch_output_trigger);

1028 1029 1030 1031 1032 1033 1034
			/*
			 * 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);

1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
			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;
			}
		}

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

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

1064 1065 1066 1067 1068
		/*
		 * 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.
		 */
1069
		if (done && !disabled && !target__none(&opts->target)) {
1070
			trigger_off(&auxtrace_snapshot_trigger);
1071
			perf_evlist__disable(rec->evlist);
1072 1073
			disabled = true;
		}
1074
	}
1075
	trigger_off(&auxtrace_snapshot_trigger);
1076
	trigger_off(&switch_output_trigger);
1077

1078
	if (forks && workload_exec_errno) {
1079
		char msg[STRERR_BUFSIZE];
1080
		const char *emsg = str_error_r(workload_exec_errno, msg, sizeof(msg));
1081 1082
		pr_err("Workload failed: %s\n", emsg);
		err = -1;
1083
		goto out_child;
1084 1085
	}

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

1089 1090 1091
	if (target__none(&rec->opts.target))
		record__synthesize_workload(rec, true);

1092 1093 1094
out_child:
	if (forks) {
		int exit_status;
1095

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

1110
	record__synthesize(rec, true);
1111 1112 1113
	/* this will be recalculated during process_buildids() */
	rec->samples = 0;

1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
	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;
			}
		}
	}
1125

W
Wang Nan 已提交
1126 1127
	perf_hooks__invoke_record_end();

1128 1129
	if (!err && !quiet) {
		char samples[128];
1130 1131
		const char *postfix = rec->timestamp_filename ?
					".<timestamp>" : "";
1132

1133
		if (rec->samples && !rec->opts.full_auxtrace)
1134 1135 1136 1137 1138
			scnprintf(samples, sizeof(samples),
				  " (%" PRIu64 " samples)", rec->samples);
		else
			samples[0] = '\0';

1139
		fprintf(stderr,	"[ perf record: Captured and wrote %.3f MB %s%s%s ]\n",
1140
			perf_data_file__size(file) / 1024.0 / 1024.0,
1141
			file->path, postfix, samples);
1142 1143
	}

1144 1145
out_delete_session:
	perf_session__delete(session);
1146
	return status;
1147
}
1148

1149
static void callchain_debug(struct callchain_param *callchain)
J
Jiri Olsa 已提交
1150
{
1151
	static const char *str[CALLCHAIN_MAX] = { "NONE", "FP", "DWARF", "LBR" };
1152

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

1155
	if (callchain->record_mode == CALLCHAIN_DWARF)
J
Jiri Olsa 已提交
1156
		pr_debug("callchain: stack dump size %d\n",
1157
			 callchain->dump_size);
J
Jiri Olsa 已提交
1158 1159
}

1160 1161 1162
int record_opts__parse_callchain(struct record_opts *record,
				 struct callchain_param *callchain,
				 const char *arg, bool unset)
J
Jiri Olsa 已提交
1163 1164
{
	int ret;
1165
	callchain->enabled = !unset;
1166

J
Jiri Olsa 已提交
1167 1168
	/* --no-call-graph */
	if (unset) {
1169
		callchain->record_mode = CALLCHAIN_NONE;
J
Jiri Olsa 已提交
1170 1171 1172 1173
		pr_debug("callchain: disabled\n");
		return 0;
	}

1174
	ret = parse_callchain_record_opt(arg, callchain);
1175 1176
	if (!ret) {
		/* Enable data address sampling for DWARF unwind. */
1177
		if (callchain->record_mode == CALLCHAIN_DWARF)
1178
			record->sample_address = true;
1179
		callchain_debug(callchain);
1180
	}
1181 1182 1183 1184

	return ret;
}

1185 1186 1187 1188 1189 1190 1191
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);
}

1192
int record_callchain_opt(const struct option *opt,
J
Jiri Olsa 已提交
1193 1194 1195
			 const char *arg __maybe_unused,
			 int unset __maybe_unused)
{
1196
	struct callchain_param *callchain = opt->value;
1197

1198
	callchain->enabled = true;
J
Jiri Olsa 已提交
1199

1200 1201
	if (callchain->record_mode == CALLCHAIN_NONE)
		callchain->record_mode = CALLCHAIN_FP;
1202

1203
	callchain_debug(callchain);
J
Jiri Olsa 已提交
1204 1205 1206
	return 0;
}

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

	return perf_default_config(var, value, cb);
}

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 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311
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;
}

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 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354
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;
}

1355
static const char * const __record_usage[] = {
1356 1357
	"perf record [<options>] [<command>]",
	"perf record [<options>] -- <command> [<options>]",
1358 1359
	NULL
};
1360
const char * const *record_usage = __record_usage;
1361

1362
/*
1363 1364
 * 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
1365 1366 1367 1368 1369 1370 1371
 * 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.
 */
1372
static struct record record = {
1373
	.opts = {
1374
		.sample_time	     = true,
1375 1376 1377
		.mmap_pages	     = UINT_MAX,
		.user_freq	     = UINT_MAX,
		.user_interval	     = ULLONG_MAX,
1378
		.freq		     = 4000,
N
Namhyung Kim 已提交
1379 1380
		.target		     = {
			.uses_mmap   = true,
1381
			.default_per_cpu = true,
N
Namhyung Kim 已提交
1382
		},
1383
		.proc_map_timeout     = 500,
1384
	},
1385 1386 1387
	.tool = {
		.sample		= process_sample_event,
		.fork		= perf_event__process_fork,
1388
		.exit		= perf_event__process_exit,
1389 1390 1391
		.comm		= perf_event__process_comm,
		.mmap		= perf_event__process_mmap,
		.mmap2		= perf_event__process_mmap2,
1392
		.ordered_events	= true,
1393
	},
1394
};
1395

1396 1397
const char record_callchain_help[] = CALLCHAIN_RECORD_HELP
	"\n\t\t\t\tDefault: fp";
1398

1399 1400
static bool dry_run;

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

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

1529 1530
struct option *record_options = __record_options;

1531
int cmd_record(int argc, const char **argv, const char *prefix __maybe_unused)
1532
{
1533
	int err;
1534
	struct record *rec = &record;
1535
	char errbuf[BUFSIZ];
1536

1537 1538 1539 1540 1541
#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
1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555
#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
1556 1557
#endif

1558 1559
	rec->evlist = perf_evlist__new();
	if (rec->evlist == NULL)
1560 1561
		return -ENOMEM;

1562 1563
	perf_config(perf_record_config, rec);

1564
	argc = parse_options(argc, argv, record_options, record_usage,
1565
			    PARSE_OPT_STOP_AT_NON_OPTION);
1566
	if (!argc && target__none(&rec->opts.target))
1567
		usage_with_options(record_usage, record_options);
1568

1569
	if (nr_cgroups && !rec->opts.target.system_wide) {
1570 1571 1572
		usage_with_options_msg(record_usage, record_options,
			"cgroup monitoring only available in system-wide mode");

S
Stephane Eranian 已提交
1573
	}
1574 1575
	if (rec->opts.record_switch_events &&
	    !perf_can_record_switch_events()) {
1576 1577 1578
		ui__error("kernel does not support recording context switch events\n");
		parse_options_usage(record_usage, record_options, "switch-events", 0);
		return -EINVAL;
1579
	}
S
Stephane Eranian 已提交
1580

1581 1582 1583
	if (rec->switch_output)
		rec->timestamp_filename = true;

1584 1585 1586
	if (!rec->itr) {
		rec->itr = auxtrace_record__init(rec->evlist, &err);
		if (err)
A
Adrian Hunter 已提交
1587
			goto out;
1588 1589
	}

1590 1591 1592
	err = auxtrace_parse_snapshot_options(rec->itr, &rec->opts,
					      rec->opts.auxtrace_snapshot_opts);
	if (err)
A
Adrian Hunter 已提交
1593
		goto out;
1594

1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606
	/*
	 * 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;

1607
	if (dry_run)
A
Adrian Hunter 已提交
1608
		goto out;
1609

1610 1611 1612 1613 1614
	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 已提交
1615
		goto out;
1616 1617
	}

1618 1619
	err = -ENOMEM;

1620
	if (symbol_conf.kptr_restrict)
1621 1622 1623 1624 1625 1626 1627 1628
		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");
1629

1630
	if (rec->no_buildid_cache || rec->no_buildid) {
1631
		disable_buildid_cache();
1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659
	} 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();
		}
	}
1660

1661 1662 1663
	if (record.opts.overwrite)
		record.opts.tail_synthesize = true;

1664 1665
	if (rec->evlist->nr_entries == 0 &&
	    perf_evlist__add_default(rec->evlist) < 0) {
1666
		pr_err("Not enough memory for event selector list\n");
1667
		goto out;
1668
	}
1669

1670 1671 1672
	if (rec->opts.target.tid && !rec->opts.no_inherit_set)
		rec->opts.no_inherit = true;

1673
	err = target__validate(&rec->opts.target);
1674
	if (err) {
1675
		target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
1676 1677 1678
		ui__warning("%s", errbuf);
	}

1679
	err = target__parse_uid(&rec->opts.target);
1680 1681
	if (err) {
		int saved_errno = errno;
1682

1683
		target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
1684
		ui__error("%s", errbuf);
1685 1686

		err = -saved_errno;
1687
		goto out;
1688
	}
1689

1690 1691 1692
	/* Enable ignoring missing threads when -u option is defined. */
	rec->opts.ignore_missing_thread = rec->opts.target.uid != UINT_MAX;

1693
	err = -ENOMEM;
1694
	if (perf_evlist__create_maps(rec->evlist, &rec->opts.target) < 0)
1695
		usage_with_options(record_usage, record_options);
1696

1697 1698
	err = auxtrace_record__options(rec->itr, rec->evlist, &rec->opts);
	if (err)
1699
		goto out;
1700

1701 1702 1703 1704 1705 1706 1707 1708
	/*
	 * 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;

1709
	if (record_opts__config(&rec->opts)) {
1710
		err = -EINVAL;
1711
		goto out;
1712 1713
	}

1714
	err = __cmd_record(&record, argc, argv);
1715
out:
1716
	perf_evlist__delete(rec->evlist);
1717
	symbol__exit();
1718
	auxtrace_record__free(rec->itr);
1719
	return err;
1720
}
1721 1722 1723

static void snapshot_sig_handler(int sig __maybe_unused)
{
1724 1725 1726 1727 1728 1729
	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);
	}
1730 1731 1732

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