builtin-record.c 48.7 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 "util/time-utils.h"
42
#include "util/units.h"
43
#include "asm/bug.h"
44

45
#include <errno.h>
46
#include <inttypes.h>
47
#include <unistd.h>
48
#include <sched.h>
49
#include <signal.h>
50
#include <sys/mman.h>
51
#include <asm/bug.h>
52
#include <linux/time64.h>
53

54
struct switch_output {
55
	bool		 enabled;
56
	bool		 signal;
57
	unsigned long	 size;
58
	unsigned long	 time;
59 60
	const char	*str;
	bool		 set;
61 62
};

63
struct record {
64
	struct perf_tool	tool;
65
	struct record_opts	opts;
66
	u64			bytes_written;
67
	struct perf_data_file	file;
68
	struct auxtrace_record	*itr;
69 70 71 72 73
	struct perf_evlist	*evlist;
	struct perf_session	*session;
	const char		*progname;
	int			realtime_prio;
	bool			no_buildid;
74
	bool			no_buildid_set;
75
	bool			no_buildid_cache;
76
	bool			no_buildid_cache_set;
77
	bool			buildid_all;
78
	bool			timestamp_filename;
79
	struct switch_output	switch_output;
80
	unsigned long long	samples;
81
};
82

83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
static volatile int auxtrace_record__snapshot_started;
static DEFINE_TRIGGER(auxtrace_snapshot_trigger);
static DEFINE_TRIGGER(switch_output_trigger);

static bool switch_output_signal(struct record *rec)
{
	return rec->switch_output.signal &&
	       trigger_is_ready(&switch_output_trigger);
}

static bool switch_output_size(struct record *rec)
{
	return rec->switch_output.size &&
	       trigger_is_ready(&switch_output_trigger) &&
	       (rec->bytes_written >= rec->switch_output.size);
}

100 101 102 103 104 105
static bool switch_output_time(struct record *rec)
{
	return rec->switch_output.time &&
	       trigger_is_ready(&switch_output_trigger);
}

106
static int record__write(struct record *rec, void *bf, size_t size)
107
{
108
	if (perf_data_file__write(rec->session->file, bf, size) < 0) {
109 110
		pr_err("failed to write perf data, error: %m\n");
		return -1;
111
	}
112

113
	rec->bytes_written += size;
114 115 116 117

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

118
	return 0;
119 120
}

121
static int process_synthesized_event(struct perf_tool *tool,
122
				     union perf_event *event,
123 124
				     struct perf_sample *sample __maybe_unused,
				     struct machine *machine __maybe_unused)
125
{
126 127
	struct record *rec = container_of(tool, struct record, tool);
	return record__write(rec, event, event->header.size);
128 129
}

130 131 132 133 134 135 136 137 138 139 140 141
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) {
142
			pr_debug("Finished reading backward ring buffer: rewind\n");
143 144 145 146 147 148 149 150 151
			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) {
152
			pr_debug("Finished reading backward ring buffer: get start\n");
153 154 155 156 157 158 159 160 161 162 163 164
			*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
165 166
rb_find_range(void *data, int mask, u64 head, u64 old,
	      u64 *start, u64 *end, bool backward)
167
{
168
	if (!backward) {
169 170 171 172 173 174 175 176
		*start = old;
		*end = head;
		return 0;
	}

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

177 178 179
static int
record__mmap_read(struct record *rec, struct perf_mmap *md,
		  bool overwrite, bool backward)
180
{
181 182
	u64 head = perf_mmap__read_head(md);
	u64 old = md->prev;
183
	u64 end = head, start = old;
J
Jiri Olsa 已提交
184
	unsigned char *data = md->base + page_size;
185 186
	unsigned long size;
	void *buf;
187
	int rc = 0;
188

189 190
	if (rb_find_range(data, md->mask, head,
			  old, &start, &end, backward))
191 192
		return -1;

193
	if (start == end)
194
		return 0;
195

196
	rec->samples++;
197

198
	size = end - start;
199 200 201 202
	if (size > (unsigned long)(md->mask) + 1) {
		WARN_ONCE(1, "failed to keep up with mmap data. (warn only once)\n");

		md->prev = head;
203
		perf_mmap__consume(md, overwrite || backward);
204 205
		return 0;
	}
206

207 208 209 210
	if ((start & md->mask) + size != (end & md->mask)) {
		buf = &data[start & md->mask];
		size = md->mask + 1 - (start & md->mask);
		start += size;
211

212
		if (record__write(rec, buf, size) < 0) {
213 214 215
			rc = -1;
			goto out;
		}
216 217
	}

218 219 220
	buf = &data[start & md->mask];
	size = end - start;
	start += size;
221

222
	if (record__write(rec, buf, size) < 0) {
223 224 225
		rc = -1;
		goto out;
	}
226

227
	md->prev = head;
228
	perf_mmap__consume(md, overwrite || backward);
229 230
out:
	return rc;
231 232
}

233 234 235
static volatile int done;
static volatile int signr = -1;
static volatile int child_finished;
236

237 238 239 240 241 242 243 244 245 246
static void sig_handler(int sig)
{
	if (sig == SIGCHLD)
		child_finished = 1;
	else
		signr = sig;

	done = 1;
}

W
Wang Nan 已提交
247 248 249 250 251 252
static void sigsegv_handler(int sig)
{
	perf_hooks__recover();
	sighandler_dump_stack(sig);
}

253 254 255 256 257 258 259 260 261
static void record__sig_exit(void)
{
	if (signr == -1)
		return;

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

262 263
#ifdef HAVE_AUXTRACE_SUPPORT

264 265 266 267 268
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);
269
	struct perf_data_file *file = &rec->file;
270 271 272
	size_t padding;
	u8 pad[8] = {0};

273 274 275 276 277 278 279 280 281 282 283 284 285 286
	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;
	}

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

317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
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) {
359
		trigger_error(&auxtrace_snapshot_trigger);
360
	} else {
361 362 363 364
		if (auxtrace_record__snapshot_finish(rec->itr))
			trigger_error(&auxtrace_snapshot_trigger);
		else
			trigger_ready(&auxtrace_snapshot_trigger);
365 366 367
	}
}

368 369 370 371 372 373 374 375 376
#else

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

377 378
static inline
void record__read_auxtrace_snapshot(struct record *rec __maybe_unused)
379
{
380 381
}

382 383
static inline
int auxtrace_record__snapshot_start(struct auxtrace_record *itr __maybe_unused)
384
{
385
	return 0;
386 387
}

388 389
#endif

390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
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,
409
				str_error_r(errno, msg, sizeof(msg)));
410 411 412 413 414 415 416 417 418 419 420 421 422 423
			if (errno)
				return -errno;
			else
				return -EINVAL;
		}
	}
	return 0;
}

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

424
static int record__open(struct record *rec)
425
{
426
	char msg[BUFSIZ];
427
	struct perf_evsel *pos;
428 429
	struct perf_evlist *evlist = rec->evlist;
	struct perf_session *session = rec->session;
430
	struct record_opts *opts = &rec->opts;
431
	struct perf_evsel_config_term *err_term;
432
	int rc = 0;
433

434
	perf_evlist__config(evlist, opts, &callchain_param);
435

436
	evlist__for_each_entry(evlist, pos) {
437
try_again:
438
		if (perf_evsel__open(pos, pos->cpus, pos->threads) < 0) {
439
			if (perf_evsel__fallback(pos, errno, msg, sizeof(msg))) {
440
				if (verbose > 0)
441
					ui__warning("%s\n", msg);
442 443
				goto try_again;
			}
444

445 446 447 448
			rc = -errno;
			perf_evsel__open_strerror(pos, &opts->target,
						  errno, msg, sizeof(msg));
			ui__error("%s\n", msg);
449
			goto out;
L
Li Zefan 已提交
450 451
		}
	}
452

453 454 455
	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,
456
			str_error_r(errno, msg, sizeof(msg)));
457
		rc = -1;
458 459 460 461 462 463 464 465
		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;
466
		goto out;
467 468
	}

469 470
	rc = record__mmap(rec);
	if (rc)
471
		goto out;
472

473
	session->evlist = evlist;
474
	perf_session__set_id_hdr_size(session);
475 476
out:
	return rc;
477 478
}

479 480 481 482 483 484 485 486 487 488 489 490 491
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);
}

492
static int process_buildids(struct record *rec)
493
{
494 495
	struct perf_data_file *file  = &rec->file;
	struct perf_session *session = rec->session;
496

497
	if (file->size == 0)
498 499
		return 0;

500 501 502 503 504 505 506 507 508 509 510
	/*
	 * 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;

511 512 513 514 515 516 517
	/*
	 * 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;

518
	return perf_session__process_events(session);
519 520
}

521
static void perf_event__synthesize_guest_os(struct machine *machine, void *data)
522 523
{
	int err;
524
	struct perf_tool *tool = data;
525 526 527 528 529 530 531 532
	/*
	 *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.
	 */
533
	err = perf_event__synthesize_modules(tool, process_synthesized_event,
534
					     machine);
535 536
	if (err < 0)
		pr_err("Couldn't record guest kernel [%d]'s reference"
537
		       " relocation symbol.\n", machine->pid);
538 539 540 541 542

	/*
	 * We use _stext for guest kernel because guest kernel's /proc/kallsyms
	 * have no _text sometimes.
	 */
543
	err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
544
						 machine);
545 546
	if (err < 0)
		pr_err("Couldn't record guest kernel [%d]'s reference"
547
		       " relocation symbol.\n", machine->pid);
548 549
}

550 551 552 553 554
static struct perf_event_header finished_round_event = {
	.size = sizeof(struct perf_event_header),
	.type = PERF_RECORD_FINISHED_ROUND,
};

555 556
static int record__mmap_read_evlist(struct record *rec, struct perf_evlist *evlist,
				    bool backward)
557
{
558
	u64 bytes_written = rec->bytes_written;
559
	int i;
560
	int rc = 0;
561
	struct perf_mmap *maps;
562

563 564
	if (!evlist)
		return 0;
565

566
	maps = backward ? evlist->backward_mmap : evlist->mmap;
567 568 569
	if (!maps)
		return 0;

570 571 572
	if (backward && evlist->bkw_mmap_state != BKW_MMAP_DATA_PENDING)
		return 0;

573
	for (i = 0; i < evlist->nr_mmaps; i++) {
574
		struct auxtrace_mmap *mm = &maps[i].auxtrace_mmap;
575

576 577 578
		if (maps[i].base) {
			if (record__mmap_read(rec, &maps[i],
					      evlist->overwrite, backward) != 0) {
579 580 581 582
				rc = -1;
				goto out;
			}
		}
583

584
		if (mm->base && !rec->opts.auxtrace_snapshot_mode &&
585 586 587 588
		    record__auxtrace_mmap_read(rec, mm) != 0) {
			rc = -1;
			goto out;
		}
589 590
	}

591 592 593 594 595 596
	/*
	 * 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));
597

598 599
	if (backward)
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_EMPTY);
600 601
out:
	return rc;
602 603
}

604 605 606 607
static int record__mmap_read_all(struct record *rec)
{
	int err;

608
	err = record__mmap_read_evlist(rec, rec->evlist, false);
609 610 611
	if (err)
		return err;

612
	return record__mmap_read_evlist(rec, rec->evlist, true);
613 614
}

615
static void record__init_features(struct record *rec)
616 617 618 619 620 621 622 623 624 625
{
	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);

626
	if (!have_tracepoints(&rec->evlist->entries))
627 628 629 630
		perf_header__clear_feat(&session->header, HEADER_TRACING_DATA);

	if (!rec->opts.branch_stack)
		perf_header__clear_feat(&session->header, HEADER_BRANCH_STACK);
631 632 633

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

	perf_header__clear_feat(&session->header, HEADER_STAT);
636 637
}

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

661
static int record__synthesize_workload(struct record *rec, bool tail)
662
{
663 664
	int err;
	struct thread_map *thread_map;
665

666 667 668
	if (rec->opts.tail_synthesize != tail)
		return 0;

669 670 671 672 673
	thread_map = thread_map__new_by_tid(rec->evlist->workload.pid);
	if (thread_map == NULL)
		return -1;

	err = perf_event__synthesize_thread_map(&rec->tool, thread_map,
674 675 676 677
						 process_synthesized_event,
						 &rec->session->machines.host,
						 rec->opts.sample_address,
						 rec->opts.proc_map_timeout);
678 679
	thread_map__put(thread_map);
	return err;
680 681
}

682
static int record__synthesize(struct record *rec, bool tail);
683

684 685 686 687 688 689 690 691 692
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";

693 694 695 696
	record__synthesize(rec, true);
	if (target__none(&rec->opts.target))
		record__synthesize_workload(rec, true);

697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715
	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);
716 717

	/* Output tracking events */
718
	if (!at_exit) {
719
		record__synthesize(rec, false);
720

721 722 723 724 725 726 727 728 729 730
		/*
		 * 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))
731
			record__synthesize_workload(rec, false);
732
	}
733 734 735
	return fd;
}

736 737 738 739 740 741 742
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.
 */
743 744
static void workload_exec_failed_signal(int signo __maybe_unused,
					siginfo_t *info,
745 746 747 748 749 750 751
					void *ucontext __maybe_unused)
{
	workload_exec_errno = info->si_value.sival_int;
	done = 1;
	child_finished = 1;
}

752
static void snapshot_sig_handler(int sig);
753
static void alarm_sig_handler(int sig);
754

755 756 757 758 759 760 761 762 763
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;
}

764 765 766
static const struct perf_event_mmap_page *
perf_evlist__pick_pc(struct perf_evlist *evlist)
{
767 768 769 770 771 772
	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;
	}
773 774 775
	return NULL;
}

776 777
static const struct perf_event_mmap_page *record__pick_pc(struct record *rec)
{
778 779 780 781 782
	const struct perf_event_mmap_page *pc;

	pc = perf_evlist__pick_pc(rec->evlist);
	if (pc)
		return pc;
783 784 785
	return NULL;
}

786
static int record__synthesize(struct record *rec, bool tail)
787 788 789 790 791 792 793 794 795
{
	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;

796 797 798
	if (rec->opts.tail_synthesize != tail)
		return 0;

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

826
	err = perf_event__synth_time_conv(record__pick_pc(rec), tool,
827 828 829 830
					  process_synthesized_event, machine);
	if (err)
		goto out;

831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861
	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;
}

862
static int __cmd_record(struct record *rec, int argc, const char **argv)
863
{
864
	int err;
865
	int status = 0;
866
	unsigned long waking = 0;
867
	const bool forks = argc > 0;
868
	struct machine *machine;
869
	struct perf_tool *tool = &rec->tool;
870
	struct record_opts *opts = &rec->opts;
871
	struct perf_data_file *file = &rec->file;
872
	struct perf_session *session;
873
	bool disabled = false, draining = false;
874
	int fd;
875

876
	rec->progname = argv[0];
877

878
	atexit(record__sig_exit);
879 880
	signal(SIGCHLD, sig_handler);
	signal(SIGINT, sig_handler);
881
	signal(SIGTERM, sig_handler);
W
Wang Nan 已提交
882
	signal(SIGSEGV, sigsegv_handler);
883

884 885 886
	if (rec->opts.record_namespaces)
		tool->namespace_events = true;

887
	if (rec->opts.auxtrace_snapshot_mode || rec->switch_output.enabled) {
888
		signal(SIGUSR2, snapshot_sig_handler);
889 890
		if (rec->opts.auxtrace_snapshot_mode)
			trigger_on(&auxtrace_snapshot_trigger);
891
		if (rec->switch_output.enabled)
892
			trigger_on(&switch_output_trigger);
893
	} else {
894
		signal(SIGUSR2, SIG_IGN);
895
	}
896

897
	session = perf_session__new(file, false, tool);
898
	if (session == NULL) {
A
Adrien BAK 已提交
899
		pr_err("Perf session creation failed.\n");
900 901 902
		return -1;
	}

903
	fd = perf_data_file__fd(file);
904 905
	rec->session = session;

906
	record__init_features(rec);
907

908
	if (forks) {
909
		err = perf_evlist__prepare_workload(rec->evlist, &opts->target,
910
						    argv, file->is_pipe,
911
						    workload_exec_failed_signal);
912 913
		if (err < 0) {
			pr_err("Couldn't run the workload!\n");
914
			status = err;
915
			goto out_delete_session;
916 917 918
		}
	}

919
	if (record__open(rec) != 0) {
920
		err = -1;
921
		goto out_child;
922
	}
923

924 925 926 927 928 929 930 931 932 933
	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;
	}

934 935 936 937 938 939 940 941 942
	/*
	 * 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;
	}

943
	if (!rec->evlist->nr_groups)
944 945
		perf_header__clear_feat(&session->header, HEADER_GROUP_DESC);

946
	if (file->is_pipe) {
947
		err = perf_header__write_pipe(fd);
948
		if (err < 0)
949
			goto out_child;
950
	} else {
951
		err = perf_session__write_header(session, rec->evlist, fd, false);
952
		if (err < 0)
953
			goto out_child;
954 955
	}

956
	if (!rec->no_buildid
957
	    && !perf_header__has_feat(&session->header, HEADER_BUILD_ID)) {
958
		pr_err("Couldn't generate buildids. "
959
		       "Use --no-buildid to profile anyway.\n");
960
		err = -1;
961
		goto out_child;
962 963
	}

964
	machine = &session->machines.host;
965

966
	err = record__synthesize(rec, false);
967
	if (err < 0)
968
		goto out_child;
969

970
	if (rec->realtime_prio) {
971 972
		struct sched_param param;

973
		param.sched_priority = rec->realtime_prio;
974
		if (sched_setscheduler(0, SCHED_FIFO, &param)) {
975
			pr_err("Could not set realtime priority.\n");
976
			err = -1;
977
			goto out_child;
978 979 980
		}
	}

981 982 983 984 985
	/*
	 * 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.
	 */
986
	if (!target__none(&opts->target) && !opts->initial_delay)
987
		perf_evlist__enable(rec->evlist);
988

989 990 991
	/*
	 * Let the child rip
	 */
992
	if (forks) {
993
		union perf_event *event;
994
		pid_t tgid;
995 996 997 998 999 1000 1001

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

1002 1003 1004 1005 1006 1007
		/*
		 * 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.
		 */
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
		tgid = perf_event__synthesize_comm(tool, event,
						   rec->evlist->workload.pid,
						   process_synthesized_event,
						   machine);
		free(event);

		if (tgid == -1)
			goto out_child;

		event = malloc(sizeof(event->namespaces) +
			       (NR_NAMESPACES * sizeof(struct perf_ns_link_info)) +
			       machine->id_hdr_size);
		if (event == NULL) {
			err = -ENOMEM;
			goto out_child;
		}

		/*
		 * Synthesize NAMESPACES event for the command specified.
		 */
		perf_event__synthesize_namespaces(tool, event,
						  rec->evlist->workload.pid,
						  tgid, process_synthesized_event,
						  machine);
1032
		free(event);
1033

1034
		perf_evlist__start_workload(rec->evlist);
1035
	}
1036

1037
	if (opts->initial_delay) {
1038
		usleep(opts->initial_delay * USEC_PER_MSEC);
1039 1040 1041
		perf_evlist__enable(rec->evlist);
	}

1042
	trigger_ready(&auxtrace_snapshot_trigger);
1043
	trigger_ready(&switch_output_trigger);
W
Wang Nan 已提交
1044
	perf_hooks__invoke_record_start();
1045
	for (;;) {
1046
		unsigned long long hits = rec->samples;
1047

1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
		/*
		 * 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);

1059
		if (record__mmap_read_all(rec) < 0) {
1060
			trigger_error(&auxtrace_snapshot_trigger);
1061
			trigger_error(&switch_output_trigger);
1062
			err = -1;
1063
			goto out_child;
1064
		}
1065

1066 1067
		if (auxtrace_record__snapshot_started) {
			auxtrace_record__snapshot_started = 0;
1068
			if (!trigger_is_error(&auxtrace_snapshot_trigger))
1069
				record__read_auxtrace_snapshot(rec);
1070
			if (trigger_is_error(&auxtrace_snapshot_trigger)) {
1071 1072 1073 1074 1075 1076
				pr_err("AUX area tracing snapshot failed\n");
				err = -1;
				goto out_child;
			}
		}

1077
		if (trigger_is_hit(&switch_output_trigger)) {
1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
			/*
			 * 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;
1089 1090
			trigger_ready(&switch_output_trigger);

1091 1092 1093 1094 1095 1096 1097
			/*
			 * 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);

1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
			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;
			}
1109 1110 1111 1112

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

1115
		if (hits == rec->samples) {
1116
			if (done || draining)
1117
				break;
1118
			err = perf_evlist__poll(rec->evlist, -1);
1119 1120 1121 1122 1123
			/*
			 * Propagate error, only if there's any. Ignore positive
			 * number of returned events and interrupt error.
			 */
			if (err > 0 || (err < 0 && errno == EINTR))
1124
				err = 0;
1125
			waking++;
1126 1127 1128

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

1131 1132 1133 1134 1135
		/*
		 * 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.
		 */
1136
		if (done && !disabled && !target__none(&opts->target)) {
1137
			trigger_off(&auxtrace_snapshot_trigger);
1138
			perf_evlist__disable(rec->evlist);
1139 1140
			disabled = true;
		}
1141
	}
1142
	trigger_off(&auxtrace_snapshot_trigger);
1143
	trigger_off(&switch_output_trigger);
1144

1145
	if (forks && workload_exec_errno) {
1146
		char msg[STRERR_BUFSIZE];
1147
		const char *emsg = str_error_r(workload_exec_errno, msg, sizeof(msg));
1148 1149
		pr_err("Workload failed: %s\n", emsg);
		err = -1;
1150
		goto out_child;
1151 1152
	}

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

1156 1157 1158
	if (target__none(&rec->opts.target))
		record__synthesize_workload(rec, true);

1159 1160 1161
out_child:
	if (forks) {
		int exit_status;
1162

1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176
		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;

1177
	record__synthesize(rec, true);
1178 1179 1180
	/* this will be recalculated during process_buildids() */
	rec->samples = 0;

1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191
	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;
			}
		}
	}
1192

W
Wang Nan 已提交
1193 1194
	perf_hooks__invoke_record_end();

1195 1196
	if (!err && !quiet) {
		char samples[128];
1197 1198
		const char *postfix = rec->timestamp_filename ?
					".<timestamp>" : "";
1199

1200
		if (rec->samples && !rec->opts.full_auxtrace)
1201 1202 1203 1204 1205
			scnprintf(samples, sizeof(samples),
				  " (%" PRIu64 " samples)", rec->samples);
		else
			samples[0] = '\0';

1206
		fprintf(stderr,	"[ perf record: Captured and wrote %.3f MB %s%s%s ]\n",
1207
			perf_data_file__size(file) / 1024.0 / 1024.0,
1208
			file->path, postfix, samples);
1209 1210
	}

1211 1212
out_delete_session:
	perf_session__delete(session);
1213
	return status;
1214
}
1215

1216
static void callchain_debug(struct callchain_param *callchain)
J
Jiri Olsa 已提交
1217
{
1218
	static const char *str[CALLCHAIN_MAX] = { "NONE", "FP", "DWARF", "LBR" };
1219

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

1222
	if (callchain->record_mode == CALLCHAIN_DWARF)
J
Jiri Olsa 已提交
1223
		pr_debug("callchain: stack dump size %d\n",
1224
			 callchain->dump_size);
J
Jiri Olsa 已提交
1225 1226
}

1227 1228 1229
int record_opts__parse_callchain(struct record_opts *record,
				 struct callchain_param *callchain,
				 const char *arg, bool unset)
J
Jiri Olsa 已提交
1230 1231
{
	int ret;
1232
	callchain->enabled = !unset;
1233

J
Jiri Olsa 已提交
1234 1235
	/* --no-call-graph */
	if (unset) {
1236
		callchain->record_mode = CALLCHAIN_NONE;
J
Jiri Olsa 已提交
1237 1238 1239 1240
		pr_debug("callchain: disabled\n");
		return 0;
	}

1241
	ret = parse_callchain_record_opt(arg, callchain);
1242 1243
	if (!ret) {
		/* Enable data address sampling for DWARF unwind. */
1244
		if (callchain->record_mode == CALLCHAIN_DWARF)
1245
			record->sample_address = true;
1246
		callchain_debug(callchain);
1247
	}
1248 1249 1250 1251

	return ret;
}

1252 1253 1254 1255 1256 1257 1258
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);
}

1259
int record_callchain_opt(const struct option *opt,
J
Jiri Olsa 已提交
1260 1261 1262
			 const char *arg __maybe_unused,
			 int unset __maybe_unused)
{
1263
	struct callchain_param *callchain = opt->value;
1264

1265
	callchain->enabled = true;
J
Jiri Olsa 已提交
1266

1267 1268
	if (callchain->record_mode == CALLCHAIN_NONE)
		callchain->record_mode = CALLCHAIN_FP;
1269

1270
	callchain_debug(callchain);
J
Jiri Olsa 已提交
1271 1272 1273
	return 0;
}

1274 1275
static int perf_record_config(const char *var, const char *value, void *cb)
{
1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288
	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;
	}
1289
	if (!strcmp(var, "record.call-graph"))
1290
		var = "call-graph.record-mode"; /* fall-through */
1291 1292 1293 1294

	return perf_default_config(var, value, cb);
}

1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 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 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378
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;
}

1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421
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;
}

1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438
static void switch_output_size_warn(struct record *rec)
{
	u64 wakeup_size = perf_evlist__mmap_size(rec->opts.mmap_pages);
	struct switch_output *s = &rec->switch_output;

	wakeup_size /= 2;

	if (s->size < wakeup_size) {
		char buf[100];

		unit_number__scnprintf(buf, sizeof(buf), wakeup_size);
		pr_warning("WARNING: switch-output data size lower than "
			   "wakeup kernel buffer size (%s) "
			   "expect bigger perf.data sizes\n", buf);
	}
}

1439 1440 1441
static int switch_output_setup(struct record *rec)
{
	struct switch_output *s = &rec->switch_output;
1442 1443 1444 1445 1446 1447 1448
	static struct parse_tag tags_size[] = {
		{ .tag  = 'B', .mult = 1       },
		{ .tag  = 'K', .mult = 1 << 10 },
		{ .tag  = 'M', .mult = 1 << 20 },
		{ .tag  = 'G', .mult = 1 << 30 },
		{ .tag  = 0 },
	};
1449 1450 1451 1452 1453 1454 1455
	static struct parse_tag tags_time[] = {
		{ .tag  = 's', .mult = 1        },
		{ .tag  = 'm', .mult = 60       },
		{ .tag  = 'h', .mult = 60*60    },
		{ .tag  = 'd', .mult = 60*60*24 },
		{ .tag  = 0 },
	};
1456
	unsigned long val;
1457 1458 1459 1460 1461 1462 1463

	if (!s->set)
		return 0;

	if (!strcmp(s->str, "signal")) {
		s->signal = true;
		pr_debug("switch-output with SIGUSR2 signal\n");
1464 1465 1466 1467 1468 1469 1470 1471
		goto enabled;
	}

	val = parse_tag_value(s->str, tags_size);
	if (val != (unsigned long) -1) {
		s->size = val;
		pr_debug("switch-output with %s size threshold\n", s->str);
		goto enabled;
1472 1473
	}

1474 1475 1476 1477 1478 1479 1480 1481
	val = parse_tag_value(s->str, tags_time);
	if (val != (unsigned long) -1) {
		s->time = val;
		pr_debug("switch-output with %s time threshold (%lu seconds)\n",
			 s->str, s->time);
		goto enabled;
	}

1482
	return -1;
1483 1484 1485 1486

enabled:
	rec->timestamp_filename = true;
	s->enabled              = true;
1487 1488 1489 1490

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

1491
	return 0;
1492 1493
}

1494
static const char * const __record_usage[] = {
1495 1496
	"perf record [<options>] [<command>]",
	"perf record [<options>] -- <command> [<options>]",
1497 1498
	NULL
};
1499
const char * const *record_usage = __record_usage;
1500

1501
/*
1502 1503
 * 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
1504 1505 1506 1507 1508 1509 1510
 * 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.
 */
1511
static struct record record = {
1512
	.opts = {
1513
		.sample_time	     = true,
1514 1515 1516
		.mmap_pages	     = UINT_MAX,
		.user_freq	     = UINT_MAX,
		.user_interval	     = ULLONG_MAX,
1517
		.freq		     = 4000,
N
Namhyung Kim 已提交
1518 1519
		.target		     = {
			.uses_mmap   = true,
1520
			.default_per_cpu = true,
N
Namhyung Kim 已提交
1521
		},
1522
		.proc_map_timeout     = 500,
1523
	},
1524 1525 1526
	.tool = {
		.sample		= process_sample_event,
		.fork		= perf_event__process_fork,
1527
		.exit		= perf_event__process_exit,
1528
		.comm		= perf_event__process_comm,
1529
		.namespaces	= perf_event__process_namespaces,
1530 1531
		.mmap		= perf_event__process_mmap,
		.mmap2		= perf_event__process_mmap2,
1532
		.ordered_events	= true,
1533
	},
1534
};
1535

1536 1537
const char record_callchain_help[] = CALLCHAIN_RECORD_HELP
	"\n\t\t\t\tDefault: fp";
1538

1539 1540
static bool dry_run;

1541 1542 1543
/*
 * 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
1544
 * from builtin-record.c, i.e. use record_opts,
1545 1546 1547
 * perf_evlist__prepare_workload, etc instead of fork+exec'in 'perf record',
 * using pipes, etc.
 */
1548
static struct option __record_options[] = {
1549
	OPT_CALLBACK('e', "event", &record.evlist, "event",
1550
		     "event selector. use 'perf list' to list available events",
1551
		     parse_events_option),
1552
	OPT_CALLBACK(0, "filter", &record.evlist, "filter",
L
Li Zefan 已提交
1553
		     "event filter", parse_filter),
1554 1555 1556
	OPT_CALLBACK_NOOPT(0, "exclude-perf", &record.evlist,
			   NULL, "don't record events from perf itself",
			   exclude_perf),
1557
	OPT_STRING('p', "pid", &record.opts.target.pid, "pid",
1558
		    "record events on existing process id"),
1559
	OPT_STRING('t', "tid", &record.opts.target.tid, "tid",
1560
		    "record events on existing thread id"),
1561
	OPT_INTEGER('r', "realtime", &record.realtime_prio,
1562
		    "collect data with this RT SCHED_FIFO priority"),
1563
	OPT_BOOLEAN(0, "no-buffering", &record.opts.no_buffering,
1564
		    "collect data without buffering"),
1565
	OPT_BOOLEAN('R', "raw-samples", &record.opts.raw_samples,
1566
		    "collect raw sample records from all opened counters"),
1567
	OPT_BOOLEAN('a', "all-cpus", &record.opts.target.system_wide,
1568
			    "system-wide collection from all CPUs"),
1569
	OPT_STRING('C', "cpu", &record.opts.target.cpu_list, "cpu",
1570
		    "list of cpus to monitor"),
1571
	OPT_U64('c', "count", &record.opts.user_interval, "event period to sample"),
1572
	OPT_STRING('o', "output", &record.file.path, "file",
I
Ingo Molnar 已提交
1573
		    "output file name"),
1574 1575 1576
	OPT_BOOLEAN_SET('i', "no-inherit", &record.opts.no_inherit,
			&record.opts.no_inherit_set,
			"child tasks do not inherit counters"),
1577 1578
	OPT_BOOLEAN(0, "tail-synthesize", &record.opts.tail_synthesize,
		    "synthesize non-sample events at the end of output"),
W
Wang Nan 已提交
1579
	OPT_BOOLEAN(0, "overwrite", &record.opts.overwrite, "use overwrite mode"),
1580
	OPT_UINTEGER('F', "freq", &record.opts.user_freq, "profile at this frequency"),
1581 1582 1583
	OPT_CALLBACK('m', "mmap-pages", &record.opts, "pages[,pages]",
		     "number of mmap data pages and AUX area tracing mmap pages",
		     record__parse_mmap_pages),
1584
	OPT_BOOLEAN(0, "group", &record.opts.group,
1585
		    "put the counters into a counter group"),
1586
	OPT_CALLBACK_NOOPT('g', NULL, &callchain_param,
J
Jiri Olsa 已提交
1587 1588 1589
			   NULL, "enables call-graph recording" ,
			   &record_callchain_opt),
	OPT_CALLBACK(0, "call-graph", &record.opts,
1590
		     "record_mode[,record_size]", record_callchain_help,
J
Jiri Olsa 已提交
1591
		     &record_parse_callchain_opt),
1592
	OPT_INCR('v', "verbose", &verbose,
1593
		    "be more verbose (show counter open errors, etc)"),
1594
	OPT_BOOLEAN('q', "quiet", &quiet, "don't print any message"),
1595
	OPT_BOOLEAN('s', "stat", &record.opts.inherit_stat,
1596
		    "per thread counts"),
1597
	OPT_BOOLEAN('d', "data", &record.opts.sample_address, "Record the sample addresses"),
J
Jiri Olsa 已提交
1598
	OPT_BOOLEAN(0, "sample-cpu", &record.opts.sample_cpu, "Record the sample cpu"),
1599 1600 1601
	OPT_BOOLEAN_SET('T', "timestamp", &record.opts.sample_time,
			&record.opts.sample_time_set,
			"Record the sample timestamps"),
1602
	OPT_BOOLEAN('P', "period", &record.opts.period, "Record the sample period"),
1603
	OPT_BOOLEAN('n', "no-samples", &record.opts.no_samples,
1604
		    "don't sample"),
1605 1606 1607 1608 1609 1610
	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"),
1611
	OPT_CALLBACK('G', "cgroup", &record.evlist, "name",
S
Stephane Eranian 已提交
1612 1613
		     "monitor event in cgroup name only",
		     parse_cgroups),
1614
	OPT_UINTEGER('D', "delay", &record.opts.initial_delay,
1615
		  "ms to wait before starting measurement after program start"),
1616 1617
	OPT_STRING('u', "uid", &record.opts.target.uid_str, "user",
		   "user to profile"),
1618 1619 1620 1621 1622 1623 1624

	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",
1625
		     parse_branch_stack),
1626 1627
	OPT_BOOLEAN('W', "weight", &record.opts.sample_weight,
		    "sample by weight (on special events only)"),
1628 1629
	OPT_BOOLEAN(0, "transaction", &record.opts.sample_transaction,
		    "sample transaction flags (special events only)"),
1630 1631
	OPT_BOOLEAN(0, "per-thread", &record.opts.target.per_thread,
		    "use per-thread mmaps"),
1632 1633 1634
	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),
1635 1636
	OPT_BOOLEAN(0, "running-time", &record.opts.running_time,
		    "Record running/enabled time of read (:S) events"),
1637 1638 1639
	OPT_CALLBACK('k', "clockid", &record.opts,
	"clockid", "clockid to use for events, see clock_gettime()",
	parse_clockid),
1640 1641
	OPT_STRING_OPTARG('S', "snapshot", &record.opts.auxtrace_snapshot_opts,
			  "opts", "AUX area tracing Snapshot Mode", ""),
1642 1643
	OPT_UINTEGER(0, "proc-map-timeout", &record.opts.proc_map_timeout,
			"per thread proc mmap processing timeout in ms"),
1644 1645
	OPT_BOOLEAN(0, "namespaces", &record.opts.record_namespaces,
		    "Record namespaces events"),
1646 1647
	OPT_BOOLEAN(0, "switch-events", &record.opts.record_switch_events,
		    "Record context switch events"),
1648 1649 1650 1651 1652 1653
	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),
1654 1655 1656 1657
	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"),
1658 1659
	OPT_STRING(0, "vmlinux", &symbol_conf.vmlinux_name,
		   "file", "vmlinux pathname"),
1660 1661
	OPT_BOOLEAN(0, "buildid-all", &record.buildid_all,
		    "Record build-id of all DSOs regardless of hits"),
1662 1663
	OPT_BOOLEAN(0, "timestamp-filename", &record.timestamp_filename,
		    "append timestamp to output filename"),
1664
	OPT_STRING_OPTARG_SET(0, "switch-output", &record.switch_output.str,
1665 1666
			  &record.switch_output.set, "signal,size,time",
			  "Switch output when receive SIGUSR2 or cross size,time threshold",
1667
			  "signal"),
1668 1669
	OPT_BOOLEAN(0, "dry-run", &dry_run,
		    "Parse options then exit"),
1670 1671 1672
	OPT_END()
};

1673 1674
struct option *record_options = __record_options;

1675
int cmd_record(int argc, const char **argv)
1676
{
1677
	int err;
1678
	struct record *rec = &record;
1679
	char errbuf[BUFSIZ];
1680

1681 1682 1683 1684 1685
#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
1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699
#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
1700 1701
#endif

1702 1703
	rec->evlist = perf_evlist__new();
	if (rec->evlist == NULL)
1704 1705
		return -ENOMEM;

1706 1707 1708
	err = perf_config(perf_record_config, rec);
	if (err)
		return err;
1709

1710
	argc = parse_options(argc, argv, record_options, record_usage,
1711
			    PARSE_OPT_STOP_AT_NON_OPTION);
1712 1713
	if (quiet)
		perf_quiet_option();
1714 1715

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

1719
	if (nr_cgroups && !rec->opts.target.system_wide) {
1720 1721 1722
		usage_with_options_msg(record_usage, record_options,
			"cgroup monitoring only available in system-wide mode");

S
Stephane Eranian 已提交
1723
	}
1724 1725
	if (rec->opts.record_switch_events &&
	    !perf_can_record_switch_events()) {
1726 1727 1728
		ui__error("kernel does not support recording context switch events\n");
		parse_options_usage(record_usage, record_options, "switch-events", 0);
		return -EINVAL;
1729
	}
S
Stephane Eranian 已提交
1730

1731 1732 1733 1734 1735
	if (switch_output_setup(rec)) {
		parse_options_usage(record_usage, record_options, "switch-output", 0);
		return -EINVAL;
	}

1736 1737 1738 1739 1740
	if (rec->switch_output.time) {
		signal(SIGALRM, alarm_sig_handler);
		alarm(rec->switch_output.time);
	}

1741 1742 1743
	if (!rec->itr) {
		rec->itr = auxtrace_record__init(rec->evlist, &err);
		if (err)
A
Adrian Hunter 已提交
1744
			goto out;
1745 1746
	}

1747 1748 1749
	err = auxtrace_parse_snapshot_options(rec->itr, &rec->opts,
					      rec->opts.auxtrace_snapshot_opts);
	if (err)
A
Adrian Hunter 已提交
1750
		goto out;
1751

1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763
	/*
	 * 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;

1764
	if (dry_run)
A
Adrian Hunter 已提交
1765
		goto out;
1766

1767 1768 1769 1770 1771
	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 已提交
1772
		goto out;
1773 1774
	}

1775 1776
	err = -ENOMEM;

1777
	if (symbol_conf.kptr_restrict)
1778 1779 1780 1781 1782 1783 1784 1785
		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");
1786

1787
	if (rec->no_buildid_cache || rec->no_buildid) {
1788
		disable_buildid_cache();
1789
	} else if (rec->switch_output.enabled) {
1790 1791 1792 1793 1794 1795
		/*
		 * 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
		 *
1796
		 *  perf record --switch-output --no-no-buildid \
1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816
		 *              --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();
		}
	}
1817

1818 1819 1820
	if (record.opts.overwrite)
		record.opts.tail_synthesize = true;

1821 1822
	if (rec->evlist->nr_entries == 0 &&
	    perf_evlist__add_default(rec->evlist) < 0) {
1823
		pr_err("Not enough memory for event selector list\n");
1824
		goto out;
1825
	}
1826

1827 1828 1829
	if (rec->opts.target.tid && !rec->opts.no_inherit_set)
		rec->opts.no_inherit = true;

1830
	err = target__validate(&rec->opts.target);
1831
	if (err) {
1832
		target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
1833 1834 1835
		ui__warning("%s", errbuf);
	}

1836
	err = target__parse_uid(&rec->opts.target);
1837 1838
	if (err) {
		int saved_errno = errno;
1839

1840
		target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
1841
		ui__error("%s", errbuf);
1842 1843

		err = -saved_errno;
1844
		goto out;
1845
	}
1846

1847 1848 1849
	/* Enable ignoring missing threads when -u option is defined. */
	rec->opts.ignore_missing_thread = rec->opts.target.uid != UINT_MAX;

1850
	err = -ENOMEM;
1851
	if (perf_evlist__create_maps(rec->evlist, &rec->opts.target) < 0)
1852
		usage_with_options(record_usage, record_options);
1853

1854 1855
	err = auxtrace_record__options(rec->itr, rec->evlist, &rec->opts);
	if (err)
1856
		goto out;
1857

1858 1859 1860 1861 1862 1863 1864 1865
	/*
	 * 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;

1866
	if (record_opts__config(&rec->opts)) {
1867
		err = -EINVAL;
1868
		goto out;
1869 1870
	}

1871
	err = __cmd_record(&record, argc, argv);
1872
out:
1873
	perf_evlist__delete(rec->evlist);
1874
	symbol__exit();
1875
	auxtrace_record__free(rec->itr);
1876
	return err;
1877
}
1878 1879 1880

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

1883 1884 1885 1886 1887 1888
	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);
	}
1889

1890
	if (switch_output_signal(rec))
1891
		trigger_hit(&switch_output_trigger);
1892
}
1893 1894 1895 1896 1897 1898 1899 1900

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

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