builtin-record.c 46.3 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 switch_output {
50
	bool		 enabled;
51
	bool		 signal;
52
	unsigned long	 size;
53 54
	const char	*str;
	bool		 set;
55 56
};

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

77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
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);
}

94
static int record__write(struct record *rec, void *bf, size_t size)
95
{
96
	if (perf_data_file__write(rec->session->file, bf, size) < 0) {
97 98
		pr_err("failed to write perf data, error: %m\n");
		return -1;
99
	}
100

101
	rec->bytes_written += size;
102 103 104 105

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

106
	return 0;
107 108
}

109
static int process_synthesized_event(struct perf_tool *tool,
110
				     union perf_event *event,
111 112
				     struct perf_sample *sample __maybe_unused,
				     struct machine *machine __maybe_unused)
113
{
114 115
	struct record *rec = container_of(tool, struct record, tool);
	return record__write(rec, event, event->header.size);
116 117
}

118 119 120 121 122 123 124 125 126 127 128 129
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) {
130
			pr_debug("Finished reading backward ring buffer: rewind\n");
131 132 133 134 135 136 137 138 139
			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) {
140
			pr_debug("Finished reading backward ring buffer: get start\n");
141 142 143 144 145 146 147 148 149 150 151 152
			*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
153 154
rb_find_range(void *data, int mask, u64 head, u64 old,
	      u64 *start, u64 *end, bool backward)
155
{
156
	if (!backward) {
157 158 159 160 161 162 163 164
		*start = old;
		*end = head;
		return 0;
	}

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

165 166 167
static int
record__mmap_read(struct record *rec, struct perf_mmap *md,
		  bool overwrite, bool backward)
168
{
169 170
	u64 head = perf_mmap__read_head(md);
	u64 old = md->prev;
171
	u64 end = head, start = old;
J
Jiri Olsa 已提交
172
	unsigned char *data = md->base + page_size;
173 174
	unsigned long size;
	void *buf;
175
	int rc = 0;
176

177 178
	if (rb_find_range(data, md->mask, head,
			  old, &start, &end, backward))
179 180
		return -1;

181
	if (start == end)
182
		return 0;
183

184
	rec->samples++;
185

186
	size = end - start;
187 188 189 190
	if (size > (unsigned long)(md->mask) + 1) {
		WARN_ONCE(1, "failed to keep up with mmap data. (warn only once)\n");

		md->prev = head;
191
		perf_mmap__consume(md, overwrite || backward);
192 193
		return 0;
	}
194

195 196 197 198
	if ((start & md->mask) + size != (end & md->mask)) {
		buf = &data[start & md->mask];
		size = md->mask + 1 - (start & md->mask);
		start += size;
199

200
		if (record__write(rec, buf, size) < 0) {
201 202 203
			rc = -1;
			goto out;
		}
204 205
	}

206 207 208
	buf = &data[start & md->mask];
	size = end - start;
	start += size;
209

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

215
	md->prev = head;
216
	perf_mmap__consume(md, overwrite || backward);
217 218
out:
	return rc;
219 220
}

221 222 223
static volatile int done;
static volatile int signr = -1;
static volatile int child_finished;
224

225 226 227 228 229 230 231 232 233 234
static void sig_handler(int sig)
{
	if (sig == SIGCHLD)
		child_finished = 1;
	else
		signr = sig;

	done = 1;
}

W
Wang Nan 已提交
235 236 237 238 239 240
static void sigsegv_handler(int sig)
{
	perf_hooks__recover();
	sighandler_dump_stack(sig);
}

241 242 243 244 245 246 247 248 249
static void record__sig_exit(void)
{
	if (signr == -1)
		return;

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

250 251
#ifdef HAVE_AUXTRACE_SUPPORT

252 253 254 255 256
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);
257
	struct perf_data_file *file = &rec->file;
258 259 260
	size_t padding;
	u8 pad[8] = {0};

261 262 263 264 265 266 267 268 269 270 271 272 273 274
	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;
	}

275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
	/* 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;
}

305 306 307 308 309 310 311 312 313 314 315 316 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
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) {
347
		trigger_error(&auxtrace_snapshot_trigger);
348
	} else {
349 350 351 352
		if (auxtrace_record__snapshot_finish(rec->itr))
			trigger_error(&auxtrace_snapshot_trigger);
		else
			trigger_ready(&auxtrace_snapshot_trigger);
353 354 355
	}
}

356 357 358 359 360 361 362 363 364
#else

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

365 366
static inline
void record__read_auxtrace_snapshot(struct record *rec __maybe_unused)
367
{
368 369
}

370 371
static inline
int auxtrace_record__snapshot_start(struct auxtrace_record *itr __maybe_unused)
372
{
373
	return 0;
374 375
}

376 377
#endif

378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
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,
397
				str_error_r(errno, msg, sizeof(msg)));
398 399 400 401 402 403 404 405 406 407 408 409 410 411
			if (errno)
				return -errno;
			else
				return -EINVAL;
		}
	}
	return 0;
}

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

412
static int record__open(struct record *rec)
413
{
414
	char msg[512];
415
	struct perf_evsel *pos;
416 417
	struct perf_evlist *evlist = rec->evlist;
	struct perf_session *session = rec->session;
418
	struct record_opts *opts = &rec->opts;
419
	struct perf_evsel_config_term *err_term;
420
	int rc = 0;
421

422
	perf_evlist__config(evlist, opts, &callchain_param);
423

424
	evlist__for_each_entry(evlist, pos) {
425
try_again:
426
		if (perf_evsel__open(pos, pos->cpus, pos->threads) < 0) {
427
			if (perf_evsel__fallback(pos, errno, msg, sizeof(msg))) {
428
				if (verbose)
429
					ui__warning("%s\n", msg);
430 431
				goto try_again;
			}
432

433 434 435 436
			rc = -errno;
			perf_evsel__open_strerror(pos, &opts->target,
						  errno, msg, sizeof(msg));
			ui__error("%s\n", msg);
437
			goto out;
L
Li Zefan 已提交
438 439
		}
	}
440

441 442 443
	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,
444
			str_error_r(errno, msg, sizeof(msg)));
445
		rc = -1;
446 447 448 449 450 451 452 453
		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;
454
		goto out;
455 456
	}

457 458
	rc = record__mmap(rec);
	if (rc)
459
		goto out;
460

461
	session->evlist = evlist;
462
	perf_session__set_id_hdr_size(session);
463 464
out:
	return rc;
465 466
}

467 468 469 470 471 472 473 474 475 476 477 478 479
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);
}

480
static int process_buildids(struct record *rec)
481
{
482 483
	struct perf_data_file *file  = &rec->file;
	struct perf_session *session = rec->session;
484

485
	if (file->size == 0)
486 487
		return 0;

488 489 490 491 492 493 494 495 496 497 498
	/*
	 * 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;

499 500 501 502 503 504 505
	/*
	 * 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;

506
	return perf_session__process_events(session);
507 508
}

509
static void perf_event__synthesize_guest_os(struct machine *machine, void *data)
510 511
{
	int err;
512
	struct perf_tool *tool = data;
513 514 515 516 517 518 519 520
	/*
	 *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.
	 */
521
	err = perf_event__synthesize_modules(tool, process_synthesized_event,
522
					     machine);
523 524
	if (err < 0)
		pr_err("Couldn't record guest kernel [%d]'s reference"
525
		       " relocation symbol.\n", machine->pid);
526 527 528 529 530

	/*
	 * We use _stext for guest kernel because guest kernel's /proc/kallsyms
	 * have no _text sometimes.
	 */
531
	err = perf_event__synthesize_kernel_mmap(tool, process_synthesized_event,
532
						 machine);
533 534
	if (err < 0)
		pr_err("Couldn't record guest kernel [%d]'s reference"
535
		       " relocation symbol.\n", machine->pid);
536 537
}

538 539 540 541 542
static struct perf_event_header finished_round_event = {
	.size = sizeof(struct perf_event_header),
	.type = PERF_RECORD_FINISHED_ROUND,
};

543 544
static int record__mmap_read_evlist(struct record *rec, struct perf_evlist *evlist,
				    bool backward)
545
{
546
	u64 bytes_written = rec->bytes_written;
547
	int i;
548
	int rc = 0;
549
	struct perf_mmap *maps;
550

551 552
	if (!evlist)
		return 0;
553

554
	maps = backward ? evlist->backward_mmap : evlist->mmap;
555 556 557
	if (!maps)
		return 0;

558 559 560
	if (backward && evlist->bkw_mmap_state != BKW_MMAP_DATA_PENDING)
		return 0;

561
	for (i = 0; i < evlist->nr_mmaps; i++) {
562
		struct auxtrace_mmap *mm = &maps[i].auxtrace_mmap;
563

564 565 566
		if (maps[i].base) {
			if (record__mmap_read(rec, &maps[i],
					      evlist->overwrite, backward) != 0) {
567 568 569 570
				rc = -1;
				goto out;
			}
		}
571

572
		if (mm->base && !rec->opts.auxtrace_snapshot_mode &&
573 574 575 576
		    record__auxtrace_mmap_read(rec, mm) != 0) {
			rc = -1;
			goto out;
		}
577 578
	}

579 580 581 582 583 584
	/*
	 * 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));
585

586 587
	if (backward)
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_EMPTY);
588 589
out:
	return rc;
590 591
}

592 593 594 595
static int record__mmap_read_all(struct record *rec)
{
	int err;

596
	err = record__mmap_read_evlist(rec, rec->evlist, false);
597 598 599
	if (err)
		return err;

600
	return record__mmap_read_evlist(rec, rec->evlist, true);
601 602
}

603
static void record__init_features(struct record *rec)
604 605 606 607 608 609 610 611 612 613
{
	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);

614
	if (!have_tracepoints(&rec->evlist->entries))
615 616 617 618
		perf_header__clear_feat(&session->header, HEADER_TRACING_DATA);

	if (!rec->opts.branch_stack)
		perf_header__clear_feat(&session->header, HEADER_BRANCH_STACK);
619 620 621

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

	perf_header__clear_feat(&session->header, HEADER_STAT);
624 625
}

626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
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;
}

649
static int record__synthesize_workload(struct record *rec, bool tail)
650 651 652 653 654 655
{
	struct {
		struct thread_map map;
		struct thread_map_data map_data;
	} thread_map;

656 657 658
	if (rec->opts.tail_synthesize != tail)
		return 0;

659 660 661 662 663 664 665 666 667 668
	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);
}

669
static int record__synthesize(struct record *rec, bool tail);
670

671 672 673 674 675 676 677 678 679
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";

680 681 682 683
	record__synthesize(rec, true);
	if (target__none(&rec->opts.target))
		record__synthesize_workload(rec, true);

684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702
	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);
703 704

	/* Output tracking events */
705
	if (!at_exit) {
706
		record__synthesize(rec, false);
707

708 709 710 711 712 713 714 715 716 717
		/*
		 * 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))
718
			record__synthesize_workload(rec, false);
719
	}
720 721 722
	return fd;
}

723 724 725 726 727 728 729
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.
 */
730 731
static void workload_exec_failed_signal(int signo __maybe_unused,
					siginfo_t *info,
732 733 734 735 736 737 738
					void *ucontext __maybe_unused)
{
	workload_exec_errno = info->si_value.sival_int;
	done = 1;
	child_finished = 1;
}

739 740
static void snapshot_sig_handler(int sig);

741 742 743 744 745 746 747 748 749
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;
}

750 751 752
static const struct perf_event_mmap_page *
perf_evlist__pick_pc(struct perf_evlist *evlist)
{
753 754 755 756 757 758
	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;
	}
759 760 761
	return NULL;
}

762 763
static const struct perf_event_mmap_page *record__pick_pc(struct record *rec)
{
764 765 766 767 768
	const struct perf_event_mmap_page *pc;

	pc = perf_evlist__pick_pc(rec->evlist);
	if (pc)
		return pc;
769 770 771
	return NULL;
}

772
static int record__synthesize(struct record *rec, bool tail)
773 774 775 776 777 778 779 780 781
{
	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;

782 783 784
	if (rec->opts.tail_synthesize != tail)
		return 0;

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

812
	err = perf_event__synth_time_conv(record__pick_pc(rec), tool,
813 814 815 816
					  process_synthesized_event, machine);
	if (err)
		goto out;

817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847
	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;
}

848
static int __cmd_record(struct record *rec, int argc, const char **argv)
849
{
850
	int err;
851
	int status = 0;
852
	unsigned long waking = 0;
853
	const bool forks = argc > 0;
854
	struct machine *machine;
855
	struct perf_tool *tool = &rec->tool;
856
	struct record_opts *opts = &rec->opts;
857
	struct perf_data_file *file = &rec->file;
858
	struct perf_session *session;
859
	bool disabled = false, draining = false;
860
	int fd;
861

862
	rec->progname = argv[0];
863

864
	atexit(record__sig_exit);
865 866
	signal(SIGCHLD, sig_handler);
	signal(SIGINT, sig_handler);
867
	signal(SIGTERM, sig_handler);
W
Wang Nan 已提交
868
	signal(SIGSEGV, sigsegv_handler);
869

870
	if (rec->opts.auxtrace_snapshot_mode || rec->switch_output.enabled) {
871
		signal(SIGUSR2, snapshot_sig_handler);
872 873
		if (rec->opts.auxtrace_snapshot_mode)
			trigger_on(&auxtrace_snapshot_trigger);
874
		if (rec->switch_output.enabled)
875
			trigger_on(&switch_output_trigger);
876
	} else {
877
		signal(SIGUSR2, SIG_IGN);
878
	}
879

880
	session = perf_session__new(file, false, tool);
881
	if (session == NULL) {
A
Adrien BAK 已提交
882
		pr_err("Perf session creation failed.\n");
883 884 885
		return -1;
	}

886
	fd = perf_data_file__fd(file);
887 888
	rec->session = session;

889
	record__init_features(rec);
890

891
	if (forks) {
892
		err = perf_evlist__prepare_workload(rec->evlist, &opts->target,
893
						    argv, file->is_pipe,
894
						    workload_exec_failed_signal);
895 896
		if (err < 0) {
			pr_err("Couldn't run the workload!\n");
897
			status = err;
898
			goto out_delete_session;
899 900 901
		}
	}

902
	if (record__open(rec) != 0) {
903
		err = -1;
904
		goto out_child;
905
	}
906

907 908 909 910 911 912 913 914 915 916
	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;
	}

917 918 919 920 921 922 923 924 925
	/*
	 * 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;
	}

926
	if (!rec->evlist->nr_groups)
927 928
		perf_header__clear_feat(&session->header, HEADER_GROUP_DESC);

929
	if (file->is_pipe) {
930
		err = perf_header__write_pipe(fd);
931
		if (err < 0)
932
			goto out_child;
933
	} else {
934
		err = perf_session__write_header(session, rec->evlist, fd, false);
935
		if (err < 0)
936
			goto out_child;
937 938
	}

939
	if (!rec->no_buildid
940
	    && !perf_header__has_feat(&session->header, HEADER_BUILD_ID)) {
941
		pr_err("Couldn't generate buildids. "
942
		       "Use --no-buildid to profile anyway.\n");
943
		err = -1;
944
		goto out_child;
945 946
	}

947
	machine = &session->machines.host;
948

949
	err = record__synthesize(rec, false);
950
	if (err < 0)
951
		goto out_child;
952

953
	if (rec->realtime_prio) {
954 955
		struct sched_param param;

956
		param.sched_priority = rec->realtime_prio;
957
		if (sched_setscheduler(0, SCHED_FIFO, &param)) {
958
			pr_err("Could not set realtime priority.\n");
959
			err = -1;
960
			goto out_child;
961 962 963
		}
	}

964 965 966 967 968
	/*
	 * 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.
	 */
969
	if (!target__none(&opts->target) && !opts->initial_delay)
970
		perf_evlist__enable(rec->evlist);
971

972 973 974
	/*
	 * Let the child rip
	 */
975
	if (forks) {
976 977 978 979 980 981 982 983
		union perf_event *event;

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

984 985 986 987 988 989
		/*
		 * 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.
		 */
990
		perf_event__synthesize_comm(tool, event,
991 992 993
					    rec->evlist->workload.pid,
					    process_synthesized_event,
					    machine);
994
		free(event);
995

996
		perf_evlist__start_workload(rec->evlist);
997
	}
998

999
	if (opts->initial_delay) {
1000
		usleep(opts->initial_delay * USEC_PER_MSEC);
1001 1002 1003
		perf_evlist__enable(rec->evlist);
	}

1004
	trigger_ready(&auxtrace_snapshot_trigger);
1005
	trigger_ready(&switch_output_trigger);
W
Wang Nan 已提交
1006
	perf_hooks__invoke_record_start();
1007
	for (;;) {
1008
		unsigned long long hits = rec->samples;
1009

1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
		/*
		 * 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);

1021
		if (record__mmap_read_all(rec) < 0) {
1022
			trigger_error(&auxtrace_snapshot_trigger);
1023
			trigger_error(&switch_output_trigger);
1024
			err = -1;
1025
			goto out_child;
1026
		}
1027

1028 1029
		if (auxtrace_record__snapshot_started) {
			auxtrace_record__snapshot_started = 0;
1030
			if (!trigger_is_error(&auxtrace_snapshot_trigger))
1031
				record__read_auxtrace_snapshot(rec);
1032
			if (trigger_is_error(&auxtrace_snapshot_trigger)) {
1033 1034 1035 1036 1037 1038
				pr_err("AUX area tracing snapshot failed\n");
				err = -1;
				goto out_child;
			}
		}

1039
		if (trigger_is_hit(&switch_output_trigger)) {
1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
			/*
			 * 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;
1051 1052
			trigger_ready(&switch_output_trigger);

1053 1054 1055 1056 1057 1058 1059
			/*
			 * 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);

1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
			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;
			}
		}

1073
		if (hits == rec->samples) {
1074
			if (done || draining)
1075
				break;
1076
			err = perf_evlist__poll(rec->evlist, -1);
1077 1078 1079 1080 1081
			/*
			 * Propagate error, only if there's any. Ignore positive
			 * number of returned events and interrupt error.
			 */
			if (err > 0 || (err < 0 && errno == EINTR))
1082
				err = 0;
1083
			waking++;
1084 1085 1086

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

1089 1090 1091 1092 1093
		/*
		 * 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.
		 */
1094
		if (done && !disabled && !target__none(&opts->target)) {
1095
			trigger_off(&auxtrace_snapshot_trigger);
1096
			perf_evlist__disable(rec->evlist);
1097 1098
			disabled = true;
		}
1099
	}
1100
	trigger_off(&auxtrace_snapshot_trigger);
1101
	trigger_off(&switch_output_trigger);
1102

1103
	if (forks && workload_exec_errno) {
1104
		char msg[STRERR_BUFSIZE];
1105
		const char *emsg = str_error_r(workload_exec_errno, msg, sizeof(msg));
1106 1107
		pr_err("Workload failed: %s\n", emsg);
		err = -1;
1108
		goto out_child;
1109 1110
	}

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

1114 1115 1116
	if (target__none(&rec->opts.target))
		record__synthesize_workload(rec, true);

1117 1118 1119
out_child:
	if (forks) {
		int exit_status;
1120

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

1135
	record__synthesize(rec, true);
1136 1137 1138
	/* this will be recalculated during process_buildids() */
	rec->samples = 0;

1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
	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;
			}
		}
	}
1150

W
Wang Nan 已提交
1151 1152
	perf_hooks__invoke_record_end();

1153 1154
	if (!err && !quiet) {
		char samples[128];
1155 1156
		const char *postfix = rec->timestamp_filename ?
					".<timestamp>" : "";
1157

1158
		if (rec->samples && !rec->opts.full_auxtrace)
1159 1160 1161 1162 1163
			scnprintf(samples, sizeof(samples),
				  " (%" PRIu64 " samples)", rec->samples);
		else
			samples[0] = '\0';

1164
		fprintf(stderr,	"[ perf record: Captured and wrote %.3f MB %s%s%s ]\n",
1165
			perf_data_file__size(file) / 1024.0 / 1024.0,
1166
			file->path, postfix, samples);
1167 1168
	}

1169 1170
out_delete_session:
	perf_session__delete(session);
1171
	return status;
1172
}
1173

1174
static void callchain_debug(struct callchain_param *callchain)
J
Jiri Olsa 已提交
1175
{
1176
	static const char *str[CALLCHAIN_MAX] = { "NONE", "FP", "DWARF", "LBR" };
1177

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

1180
	if (callchain->record_mode == CALLCHAIN_DWARF)
J
Jiri Olsa 已提交
1181
		pr_debug("callchain: stack dump size %d\n",
1182
			 callchain->dump_size);
J
Jiri Olsa 已提交
1183 1184
}

1185 1186 1187
int record_opts__parse_callchain(struct record_opts *record,
				 struct callchain_param *callchain,
				 const char *arg, bool unset)
J
Jiri Olsa 已提交
1188 1189
{
	int ret;
1190
	callchain->enabled = !unset;
1191

J
Jiri Olsa 已提交
1192 1193
	/* --no-call-graph */
	if (unset) {
1194
		callchain->record_mode = CALLCHAIN_NONE;
J
Jiri Olsa 已提交
1195 1196 1197 1198
		pr_debug("callchain: disabled\n");
		return 0;
	}

1199
	ret = parse_callchain_record_opt(arg, callchain);
1200 1201
	if (!ret) {
		/* Enable data address sampling for DWARF unwind. */
1202
		if (callchain->record_mode == CALLCHAIN_DWARF)
1203
			record->sample_address = true;
1204
		callchain_debug(callchain);
1205
	}
1206 1207 1208 1209

	return ret;
}

1210 1211 1212 1213 1214 1215 1216
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);
}

1217
int record_callchain_opt(const struct option *opt,
J
Jiri Olsa 已提交
1218 1219 1220
			 const char *arg __maybe_unused,
			 int unset __maybe_unused)
{
1221
	struct callchain_param *callchain = opt->value;
1222

1223
	callchain->enabled = true;
J
Jiri Olsa 已提交
1224

1225 1226
	if (callchain->record_mode == CALLCHAIN_NONE)
		callchain->record_mode = CALLCHAIN_FP;
1227

1228
	callchain_debug(callchain);
J
Jiri Olsa 已提交
1229 1230 1231
	return 0;
}

1232 1233
static int perf_record_config(const char *var, const char *value, void *cb)
{
1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
	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;
	}
1247
	if (!strcmp(var, "record.call-graph"))
1248
		var = "call-graph.record-mode"; /* fall-through */
1249 1250 1251 1252

	return perf_default_config(var, value, cb);
}

1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
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;
}

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

1380 1381 1382
static int switch_output_setup(struct record *rec)
{
	struct switch_output *s = &rec->switch_output;
1383 1384 1385 1386 1387 1388 1389 1390
	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 },
	};
	unsigned long val;
1391 1392 1393 1394 1395 1396 1397

	if (!s->set)
		return 0;

	if (!strcmp(s->str, "signal")) {
		s->signal = true;
		pr_debug("switch-output with SIGUSR2 signal\n");
1398 1399 1400 1401 1402 1403 1404 1405
		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;
1406 1407 1408
	}

	return -1;
1409 1410 1411 1412 1413

enabled:
	rec->timestamp_filename = true;
	s->enabled              = true;
	return 0;
1414 1415
}

1416
static const char * const __record_usage[] = {
1417 1418
	"perf record [<options>] [<command>]",
	"perf record [<options>] -- <command> [<options>]",
1419 1420
	NULL
};
1421
const char * const *record_usage = __record_usage;
1422

1423
/*
1424 1425
 * 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
1426 1427 1428 1429 1430 1431 1432
 * 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.
 */
1433
static struct record record = {
1434
	.opts = {
1435
		.sample_time	     = true,
1436 1437 1438
		.mmap_pages	     = UINT_MAX,
		.user_freq	     = UINT_MAX,
		.user_interval	     = ULLONG_MAX,
1439
		.freq		     = 4000,
N
Namhyung Kim 已提交
1440 1441
		.target		     = {
			.uses_mmap   = true,
1442
			.default_per_cpu = true,
N
Namhyung Kim 已提交
1443
		},
1444
		.proc_map_timeout     = 500,
1445
	},
1446 1447 1448
	.tool = {
		.sample		= process_sample_event,
		.fork		= perf_event__process_fork,
1449
		.exit		= perf_event__process_exit,
1450 1451 1452
		.comm		= perf_event__process_comm,
		.mmap		= perf_event__process_mmap,
		.mmap2		= perf_event__process_mmap2,
1453
		.ordered_events	= true,
1454
	},
1455
};
1456

1457 1458
const char record_callchain_help[] = CALLCHAIN_RECORD_HELP
	"\n\t\t\t\tDefault: fp";
1459

1460 1461
static bool dry_run;

1462 1463 1464
/*
 * 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
1465
 * from builtin-record.c, i.e. use record_opts,
1466 1467 1468
 * perf_evlist__prepare_workload, etc instead of fork+exec'in 'perf record',
 * using pipes, etc.
 */
1469
static struct option __record_options[] = {
1470
	OPT_CALLBACK('e', "event", &record.evlist, "event",
1471
		     "event selector. use 'perf list' to list available events",
1472
		     parse_events_option),
1473
	OPT_CALLBACK(0, "filter", &record.evlist, "filter",
L
Li Zefan 已提交
1474
		     "event filter", parse_filter),
1475 1476 1477
	OPT_CALLBACK_NOOPT(0, "exclude-perf", &record.evlist,
			   NULL, "don't record events from perf itself",
			   exclude_perf),
1478
	OPT_STRING('p', "pid", &record.opts.target.pid, "pid",
1479
		    "record events on existing process id"),
1480
	OPT_STRING('t', "tid", &record.opts.target.tid, "tid",
1481
		    "record events on existing thread id"),
1482
	OPT_INTEGER('r', "realtime", &record.realtime_prio,
1483
		    "collect data with this RT SCHED_FIFO priority"),
1484
	OPT_BOOLEAN(0, "no-buffering", &record.opts.no_buffering,
1485
		    "collect data without buffering"),
1486
	OPT_BOOLEAN('R', "raw-samples", &record.opts.raw_samples,
1487
		    "collect raw sample records from all opened counters"),
1488
	OPT_BOOLEAN('a', "all-cpus", &record.opts.target.system_wide,
1489
			    "system-wide collection from all CPUs"),
1490
	OPT_STRING('C', "cpu", &record.opts.target.cpu_list, "cpu",
1491
		    "list of cpus to monitor"),
1492
	OPT_U64('c', "count", &record.opts.user_interval, "event period to sample"),
1493
	OPT_STRING('o', "output", &record.file.path, "file",
I
Ingo Molnar 已提交
1494
		    "output file name"),
1495 1496 1497
	OPT_BOOLEAN_SET('i', "no-inherit", &record.opts.no_inherit,
			&record.opts.no_inherit_set,
			"child tasks do not inherit counters"),
1498 1499
	OPT_BOOLEAN(0, "tail-synthesize", &record.opts.tail_synthesize,
		    "synthesize non-sample events at the end of output"),
W
Wang Nan 已提交
1500
	OPT_BOOLEAN(0, "overwrite", &record.opts.overwrite, "use overwrite mode"),
1501
	OPT_UINTEGER('F', "freq", &record.opts.user_freq, "profile at this frequency"),
1502 1503 1504
	OPT_CALLBACK('m', "mmap-pages", &record.opts, "pages[,pages]",
		     "number of mmap data pages and AUX area tracing mmap pages",
		     record__parse_mmap_pages),
1505
	OPT_BOOLEAN(0, "group", &record.opts.group,
1506
		    "put the counters into a counter group"),
1507
	OPT_CALLBACK_NOOPT('g', NULL, &callchain_param,
J
Jiri Olsa 已提交
1508 1509 1510
			   NULL, "enables call-graph recording" ,
			   &record_callchain_opt),
	OPT_CALLBACK(0, "call-graph", &record.opts,
1511
		     "record_mode[,record_size]", record_callchain_help,
J
Jiri Olsa 已提交
1512
		     &record_parse_callchain_opt),
1513
	OPT_INCR('v', "verbose", &verbose,
1514
		    "be more verbose (show counter open errors, etc)"),
1515
	OPT_BOOLEAN('q', "quiet", &quiet, "don't print any message"),
1516
	OPT_BOOLEAN('s', "stat", &record.opts.inherit_stat,
1517
		    "per thread counts"),
1518
	OPT_BOOLEAN('d', "data", &record.opts.sample_address, "Record the sample addresses"),
J
Jiri Olsa 已提交
1519
	OPT_BOOLEAN(0, "sample-cpu", &record.opts.sample_cpu, "Record the sample cpu"),
1520 1521 1522
	OPT_BOOLEAN_SET('T', "timestamp", &record.opts.sample_time,
			&record.opts.sample_time_set,
			"Record the sample timestamps"),
1523
	OPT_BOOLEAN('P', "period", &record.opts.period, "Record the sample period"),
1524
	OPT_BOOLEAN('n', "no-samples", &record.opts.no_samples,
1525
		    "don't sample"),
1526 1527 1528 1529 1530 1531
	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"),
1532
	OPT_CALLBACK('G', "cgroup", &record.evlist, "name",
S
Stephane Eranian 已提交
1533 1534
		     "monitor event in cgroup name only",
		     parse_cgroups),
1535
	OPT_UINTEGER('D', "delay", &record.opts.initial_delay,
1536
		  "ms to wait before starting measurement after program start"),
1537 1538
	OPT_STRING('u', "uid", &record.opts.target.uid_str, "user",
		   "user to profile"),
1539 1540 1541 1542 1543 1544 1545

	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",
1546
		     parse_branch_stack),
1547 1548
	OPT_BOOLEAN('W', "weight", &record.opts.sample_weight,
		    "sample by weight (on special events only)"),
1549 1550
	OPT_BOOLEAN(0, "transaction", &record.opts.sample_transaction,
		    "sample transaction flags (special events only)"),
1551 1552
	OPT_BOOLEAN(0, "per-thread", &record.opts.target.per_thread,
		    "use per-thread mmaps"),
1553 1554 1555
	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),
1556 1557
	OPT_BOOLEAN(0, "running-time", &record.opts.running_time,
		    "Record running/enabled time of read (:S) events"),
1558 1559 1560
	OPT_CALLBACK('k', "clockid", &record.opts,
	"clockid", "clockid to use for events, see clock_gettime()",
	parse_clockid),
1561 1562
	OPT_STRING_OPTARG('S', "snapshot", &record.opts.auxtrace_snapshot_opts,
			  "opts", "AUX area tracing Snapshot Mode", ""),
1563 1564
	OPT_UINTEGER(0, "proc-map-timeout", &record.opts.proc_map_timeout,
			"per thread proc mmap processing timeout in ms"),
1565 1566
	OPT_BOOLEAN(0, "switch-events", &record.opts.record_switch_events,
		    "Record context switch events"),
1567 1568 1569 1570 1571 1572
	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),
1573 1574 1575 1576
	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"),
1577 1578
	OPT_STRING(0, "vmlinux", &symbol_conf.vmlinux_name,
		   "file", "vmlinux pathname"),
1579 1580
	OPT_BOOLEAN(0, "buildid-all", &record.buildid_all,
		    "Record build-id of all DSOs regardless of hits"),
1581 1582
	OPT_BOOLEAN(0, "timestamp-filename", &record.timestamp_filename,
		    "append timestamp to output filename"),
1583
	OPT_STRING_OPTARG_SET(0, "switch-output", &record.switch_output.str,
1584 1585 1586
			  &record.switch_output.set, "signal,size",
			  "Switch output when receive SIGUSR2 or cross size threshold",
			  "signal"),
1587 1588
	OPT_BOOLEAN(0, "dry-run", &dry_run,
		    "Parse options then exit"),
1589 1590 1591
	OPT_END()
};

1592 1593
struct option *record_options = __record_options;

1594
int cmd_record(int argc, const char **argv, const char *prefix __maybe_unused)
1595
{
1596
	int err;
1597
	struct record *rec = &record;
1598
	char errbuf[BUFSIZ];
1599

1600 1601 1602 1603 1604
#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
1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618
#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
1619 1620
#endif

1621 1622
	rec->evlist = perf_evlist__new();
	if (rec->evlist == NULL)
1623 1624
		return -ENOMEM;

1625 1626
	perf_config(perf_record_config, rec);

1627
	argc = parse_options(argc, argv, record_options, record_usage,
1628
			    PARSE_OPT_STOP_AT_NON_OPTION);
1629
	if (!argc && target__none(&rec->opts.target))
1630
		usage_with_options(record_usage, record_options);
1631

1632
	if (nr_cgroups && !rec->opts.target.system_wide) {
1633 1634 1635
		usage_with_options_msg(record_usage, record_options,
			"cgroup monitoring only available in system-wide mode");

S
Stephane Eranian 已提交
1636
	}
1637 1638
	if (rec->opts.record_switch_events &&
	    !perf_can_record_switch_events()) {
1639 1640 1641
		ui__error("kernel does not support recording context switch events\n");
		parse_options_usage(record_usage, record_options, "switch-events", 0);
		return -EINVAL;
1642
	}
S
Stephane Eranian 已提交
1643

1644 1645 1646 1647 1648
	if (switch_output_setup(rec)) {
		parse_options_usage(record_usage, record_options, "switch-output", 0);
		return -EINVAL;
	}

1649 1650 1651
	if (!rec->itr) {
		rec->itr = auxtrace_record__init(rec->evlist, &err);
		if (err)
A
Adrian Hunter 已提交
1652
			goto out;
1653 1654
	}

1655 1656 1657
	err = auxtrace_parse_snapshot_options(rec->itr, &rec->opts,
					      rec->opts.auxtrace_snapshot_opts);
	if (err)
A
Adrian Hunter 已提交
1658
		goto out;
1659

1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671
	/*
	 * 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;

1672
	if (dry_run)
A
Adrian Hunter 已提交
1673
		goto out;
1674

1675 1676 1677 1678 1679
	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 已提交
1680
		goto out;
1681 1682
	}

1683 1684
	err = -ENOMEM;

1685
	if (symbol_conf.kptr_restrict)
1686 1687 1688 1689 1690 1691 1692 1693
		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");
1694

1695
	if (rec->no_buildid_cache || rec->no_buildid) {
1696
		disable_buildid_cache();
1697
	} else if (rec->switch_output.enabled) {
1698 1699 1700 1701 1702 1703
		/*
		 * 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
		 *
1704
		 *  perf record --switch-output --no-no-buildid \
1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724
		 *              --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();
		}
	}
1725

1726 1727 1728
	if (record.opts.overwrite)
		record.opts.tail_synthesize = true;

1729 1730
	if (rec->evlist->nr_entries == 0 &&
	    perf_evlist__add_default(rec->evlist) < 0) {
1731
		pr_err("Not enough memory for event selector list\n");
1732
		goto out;
1733
	}
1734

1735 1736 1737
	if (rec->opts.target.tid && !rec->opts.no_inherit_set)
		rec->opts.no_inherit = true;

1738
	err = target__validate(&rec->opts.target);
1739
	if (err) {
1740
		target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
1741 1742 1743
		ui__warning("%s", errbuf);
	}

1744
	err = target__parse_uid(&rec->opts.target);
1745 1746
	if (err) {
		int saved_errno = errno;
1747

1748
		target__strerror(&rec->opts.target, err, errbuf, BUFSIZ);
1749
		ui__error("%s", errbuf);
1750 1751

		err = -saved_errno;
1752
		goto out;
1753
	}
1754

1755 1756 1757
	/* Enable ignoring missing threads when -u option is defined. */
	rec->opts.ignore_missing_thread = rec->opts.target.uid != UINT_MAX;

1758
	err = -ENOMEM;
1759
	if (perf_evlist__create_maps(rec->evlist, &rec->opts.target) < 0)
1760
		usage_with_options(record_usage, record_options);
1761

1762 1763
	err = auxtrace_record__options(rec->itr, rec->evlist, &rec->opts);
	if (err)
1764
		goto out;
1765

1766 1767 1768 1769 1770 1771 1772 1773
	/*
	 * 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;

1774
	if (record_opts__config(&rec->opts)) {
1775
		err = -EINVAL;
1776
		goto out;
1777 1778
	}

1779
	err = __cmd_record(&record, argc, argv);
1780
out:
1781
	perf_evlist__delete(rec->evlist);
1782
	symbol__exit();
1783
	auxtrace_record__free(rec->itr);
1784
	return err;
1785
}
1786 1787 1788

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

1791 1792 1793 1794 1795 1796
	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);
	}
1797

1798
	if (switch_output_signal(rec))
1799
		trigger_hit(&switch_output_trigger);
1800
}