builtin-record.c 49.5 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
I
Ingo Molnar 已提交
2
/*
3 4 5 6 7
 * 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 已提交
8
 */
9
#include "builtin.h"
10 11 12

#include "perf.h"

13
#include "util/build-id.h"
14
#include "util/util.h"
15
#include <subcmd/parse-options.h>
16
#include "util/parse-events.h"
17
#include "util/config.h"
18

19
#include "util/callchain.h"
20
#include "util/cgroup.h"
21
#include "util/header.h"
22
#include "util/event.h"
23
#include "util/evlist.h"
24
#include "util/evsel.h"
25
#include "util/debug.h"
26
#include "util/drv_configs.h"
27
#include "util/session.h"
28
#include "util/tool.h"
29
#include "util/symbol.h"
30
#include "util/cpumap.h"
31
#include "util/thread_map.h"
32
#include "util/data.h"
33
#include "util/perf_regs.h"
34
#include "util/auxtrace.h"
35
#include "util/tsc.h"
36
#include "util/parse-branch-options.h"
37
#include "util/parse-regs-options.h"
38
#include "util/llvm-utils.h"
39
#include "util/bpf-loader.h"
40
#include "util/trigger.h"
W
Wang Nan 已提交
41
#include "util/perf-hooks.h"
42
#include "util/time-utils.h"
43
#include "util/units.h"
44
#include "asm/bug.h"
45

46
#include <errno.h>
47
#include <inttypes.h>
48
#include <locale.h>
49
#include <poll.h>
50
#include <unistd.h>
51
#include <sched.h>
52
#include <signal.h>
53
#include <sys/mman.h>
54
#include <sys/wait.h>
55
#include <linux/time64.h>
56

57
struct switch_output {
58
	bool		 enabled;
59
	bool		 signal;
60
	unsigned long	 size;
61
	unsigned long	 time;
62 63
	const char	*str;
	bool		 set;
64 65
};

66
struct record {
67
	struct perf_tool	tool;
68
	struct record_opts	opts;
69
	u64			bytes_written;
70
	struct perf_data	data;
71
	struct auxtrace_record	*itr;
72 73 74 75
	struct perf_evlist	*evlist;
	struct perf_session	*session;
	int			realtime_prio;
	bool			no_buildid;
76
	bool			no_buildid_set;
77
	bool			no_buildid_cache;
78
	bool			no_buildid_cache_set;
79
	bool			buildid_all;
80
	bool			timestamp_filename;
81
	bool			timestamp_boundary;
82
	struct switch_output	switch_output;
83
	unsigned long long	samples;
84
};
85

86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
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);
}

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

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

116
	rec->bytes_written += size;
117 118 119 120

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

121
	return 0;
122 123
}

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

133 134 135 136 137 138 139 140
static int record__pushfn(void *to, void *bf, size_t size)
{
	struct record *rec = to;

	rec->samples++;
	return record__write(rec, bf, size);
}

141 142 143
static volatile int done;
static volatile int signr = -1;
static volatile int child_finished;
144

145 146 147 148 149 150 151 152 153 154
static void sig_handler(int sig)
{
	if (sig == SIGCHLD)
		child_finished = 1;
	else
		signr = sig;

	done = 1;
}

W
Wang Nan 已提交
155 156 157 158 159 160
static void sigsegv_handler(int sig)
{
	perf_hooks__recover();
	sighandler_dump_stack(sig);
}

161 162 163 164 165 166 167 168 169
static void record__sig_exit(void)
{
	if (signr == -1)
		return;

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

170 171
#ifdef HAVE_AUXTRACE_SUPPORT

172 173 174 175 176
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);
177
	struct perf_data *data = &rec->data;
178 179 180
	size_t padding;
	u8 pad[8] = {0};

181
	if (!perf_data__is_pipe(data)) {
182
		off_t file_offset;
183
		int fd = perf_data__fd(data);
184 185 186 187 188 189 190 191 192 193 194
		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;
	}

195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
	/* 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;
}

225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
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) {
267
		trigger_error(&auxtrace_snapshot_trigger);
268
	} else {
269 270 271 272
		if (auxtrace_record__snapshot_finish(rec->itr))
			trigger_error(&auxtrace_snapshot_trigger);
		else
			trigger_ready(&auxtrace_snapshot_trigger);
273 274 275
	}
}

276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
static int record__auxtrace_init(struct record *rec)
{
	int err;

	if (!rec->itr) {
		rec->itr = auxtrace_record__init(rec->evlist, &err);
		if (err)
			return err;
	}

	err = auxtrace_parse_snapshot_options(rec->itr, &rec->opts,
					      rec->opts.auxtrace_snapshot_opts);
	if (err)
		return err;

	return auxtrace_parse_filters(rec->evlist);
}

294 295 296 297 298 299 300 301 302
#else

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

303 304
static inline
void record__read_auxtrace_snapshot(struct record *rec __maybe_unused)
305
{
306 307
}

308 309
static inline
int auxtrace_record__snapshot_start(struct auxtrace_record *itr __maybe_unused)
310
{
311
	return 0;
312 313
}

314 315 316 317 318
static int record__auxtrace_init(struct record *rec __maybe_unused)
{
	return 0;
}

319 320
#endif

321 322 323 324 325 326
static int record__mmap_evlist(struct record *rec,
			       struct perf_evlist *evlist)
{
	struct record_opts *opts = &rec->opts;
	char msg[512];

327
	if (perf_evlist__mmap_ex(evlist, opts->mmap_pages,
328 329 330 331 332 333 334 335 336 337 338 339
				 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,
340
				str_error_r(errno, msg, sizeof(msg)));
341 342 343 344 345 346 347 348 349 350 351 352 353 354
			if (errno)
				return -errno;
			else
				return -EINVAL;
		}
	}
	return 0;
}

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

355
static int record__open(struct record *rec)
356
{
357
	char msg[BUFSIZ];
358
	struct perf_evsel *pos;
359 360
	struct perf_evlist *evlist = rec->evlist;
	struct perf_session *session = rec->session;
361
	struct record_opts *opts = &rec->opts;
362
	struct perf_evsel_config_term *err_term;
363
	int rc = 0;
364

365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
	/*
	 * For initial_delay we need to add a dummy event so that we can track
	 * PERF_RECORD_MMAP while we wait for the initial delay to enable the
	 * real events, the ones asked by the user.
	 */
	if (opts->initial_delay) {
		if (perf_evlist__add_dummy(evlist))
			return -ENOMEM;

		pos = perf_evlist__first(evlist);
		pos->tracking = 0;
		pos = perf_evlist__last(evlist);
		pos->tracking = 1;
		pos->attr.enable_on_exec = 1;
	}

381
	perf_evlist__config(evlist, opts, &callchain_param);
382

383
	evlist__for_each_entry(evlist, pos) {
384
try_again:
385
		if (perf_evsel__open(pos, pos->cpus, pos->threads) < 0) {
386
			if (perf_evsel__fallback(pos, errno, msg, sizeof(msg))) {
387
				if (verbose > 0)
388
					ui__warning("%s\n", msg);
389 390
				goto try_again;
			}
391

392 393 394 395
			rc = -errno;
			perf_evsel__open_strerror(pos, &opts->target,
						  errno, msg, sizeof(msg));
			ui__error("%s\n", msg);
396
			goto out;
L
Li Zefan 已提交
397
		}
398 399

		pos->supported = true;
L
Li Zefan 已提交
400
	}
401

402
	if (perf_evlist__apply_filters(evlist, &pos)) {
403
		pr_err("failed to set filter \"%s\" on event %s with %d (%s)\n",
404
			pos->filter, perf_evsel__name(pos), errno,
405
			str_error_r(errno, msg, sizeof(msg)));
406
		rc = -1;
407 408 409 410
		goto out;
	}

	if (perf_evlist__apply_drv_configs(evlist, &pos, &err_term)) {
411
		pr_err("failed to set config \"%s\" on event %s with %d (%s)\n",
412 413 414
		      err_term->val.drv_cfg, perf_evsel__name(pos), errno,
		      str_error_r(errno, msg, sizeof(msg)));
		rc = -1;
415
		goto out;
416 417
	}

418 419
	rc = record__mmap(rec);
	if (rc)
420
		goto out;
421

422
	session->evlist = evlist;
423
	perf_session__set_id_hdr_size(session);
424 425
out:
	return rc;
426 427
}

428 429 430 431 432 433 434 435
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);

436 437 438 439
	if (rec->evlist->first_sample_time == 0)
		rec->evlist->first_sample_time = sample->time;

	rec->evlist->last_sample_time = sample->time;
440

441 442 443 444
	if (rec->buildid_all)
		return 0;

	rec->samples++;
445 446 447
	return build_id__mark_dso_hit(tool, event, sample, evsel, machine);
}

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

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

456 457 458 459 460 461 462 463 464 465 466
	/*
	 * During this process, it'll load kernel map and replace the
	 * dso->long_name to a real pathname it found.  In this case
	 * we prefer the vmlinux path like
	 *   /lib/modules/3.16.4/build/vmlinux
	 *
	 * rather than build-id path (in debug directory).
	 *   $HOME/.debug/.build-id/f0/6e17aa50adf4d00b88925e03775de107611551
	 */
	symbol_conf.ignore_vmlinux_buildid = true;

467 468
	/*
	 * If --buildid-all is given, it marks all DSO regardless of hits,
469 470 471
	 * so no need to process samples. But if timestamp_boundary is enabled,
	 * it still needs to walk on all samples to get the timestamps of
	 * first/last samples.
472
	 */
473
	if (rec->buildid_all && !rec->timestamp_boundary)
474 475
		rec->tool.sample = NULL;

476
	return perf_session__process_events(session);
477 478
}

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

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

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

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

521 522
	if (!evlist)
		return 0;
523

524
	maps = overwrite ? evlist->overwrite_mmap : evlist->mmap;
525 526 527
	if (!maps)
		return 0;

528
	if (overwrite && evlist->bkw_mmap_state != BKW_MMAP_DATA_PENDING)
529 530
		return 0;

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

534
		if (maps[i].base) {
535
			if (perf_mmap__push(&maps[i], rec, record__pushfn) != 0) {
536 537 538 539
				rc = -1;
				goto out;
			}
		}
540

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

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

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

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

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

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

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

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

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

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

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

595 596 597
static void
record__finish_output(struct record *rec)
{
598 599
	struct perf_data *data = &rec->data;
	int fd = perf_data__fd(data);
600

601
	if (data->is_pipe)
602 603 604
		return;

	rec->session->header.data_size += rec->bytes_written;
605
	data->size = lseek(perf_data__fd(data), 0, SEEK_CUR);
606 607 608 609 610 611 612 613 614 615 616 617

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

618
static int record__synthesize_workload(struct record *rec, bool tail)
619
{
620 621
	int err;
	struct thread_map *thread_map;
622

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

626 627 628 629 630
	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,
631 632 633 634
						 process_synthesized_event,
						 &rec->session->machines.host,
						 rec->opts.sample_address,
						 rec->opts.proc_map_timeout);
635 636
	thread_map__put(thread_map);
	return err;
637 638
}

639
static int record__synthesize(struct record *rec, bool tail);
640

641 642 643
static int
record__switch_output(struct record *rec, bool at_exit)
{
644
	struct perf_data *data = &rec->data;
645 646 647 648 649
	int fd, err;

	/* Same Size:      "2015122520103046"*/
	char timestamp[] = "InvalidTimestamp";

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

654 655 656 657 658 659 660 661
	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;
	}

662
	fd = perf_data__switch(data, timestamp,
663 664 665 666 667 668 669 670 671
				    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",
J
Jiri Olsa 已提交
672
			data->file.path, timestamp);
673 674

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

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

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

709
static void snapshot_sig_handler(int sig);
710
static void alarm_sig_handler(int sig);
711

712 713 714 715 716 717 718 719 720
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;
}

721 722 723
static const struct perf_event_mmap_page *
perf_evlist__pick_pc(struct perf_evlist *evlist)
{
724 725 726
	if (evlist) {
		if (evlist->mmap && evlist->mmap[0].base)
			return evlist->mmap[0].base;
727 728
		if (evlist->overwrite_mmap && evlist->overwrite_mmap[0].base)
			return evlist->overwrite_mmap[0].base;
729
	}
730 731 732
	return NULL;
}

733 734
static const struct perf_event_mmap_page *record__pick_pc(struct record *rec)
{
735 736 737 738 739
	const struct perf_event_mmap_page *pc;

	pc = perf_evlist__pick_pc(rec->evlist);
	if (pc)
		return pc;
740 741 742
	return NULL;
}

743
static int record__synthesize(struct record *rec, bool tail)
744 745 746
{
	struct perf_session *session = rec->session;
	struct machine *machine = &session->machines.host;
747
	struct perf_data *data = &rec->data;
748 749
	struct record_opts *opts = &rec->opts;
	struct perf_tool *tool = &rec->tool;
750
	int fd = perf_data__fd(data);
751 752
	int err = 0;

753 754 755
	if (rec->opts.tail_synthesize != tail)
		return 0;

756
	if (data->is_pipe) {
757 758 759 760
		/*
		 * We need to synthesize events first, because some
		 * features works on top of them (on report side).
		 */
761 762 763 764 765 766 767
		err = perf_event__synthesize_attrs(tool, session,
						   process_synthesized_event);
		if (err < 0) {
			pr_err("Couldn't synthesize attrs.\n");
			goto out;
		}

768 769 770 771 772 773 774
		err = perf_event__synthesize_features(tool, session, rec->evlist,
						      process_synthesized_event);
		if (err < 0) {
			pr_err("Couldn't synthesize features.\n");
			return err;
		}

775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
		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;
		}
	}

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

799 800 801 802 803 804 805
	if (rec->opts.full_auxtrace) {
		err = perf_event__synthesize_auxtrace_info(rec->itr, tool,
					session, process_synthesized_event);
		if (err)
			goto out;
	}

806 807 808 809 810 811 812 813 814 815 816 817 818
	if (!perf_evlist__exclude_kernel(rec->evlist)) {
		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");
	}
819 820 821 822 823 824

	if (perf_guest) {
		machines__process_guests(&session->machines,
					 perf_event__synthesize_guest_os, tool);
	}

825 826 827 828 829 830 831
	err = perf_event__synthesize_extra_attr(&rec->tool,
						rec->evlist,
						process_synthesized_event,
						data->is_pipe);
	if (err)
		goto out;

832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
	err = perf_event__synthesize_thread_map2(&rec->tool, rec->evlist->threads,
						 process_synthesized_event,
						NULL);
	if (err < 0) {
		pr_err("Couldn't synthesize thread map.\n");
		return err;
	}

	err = perf_event__synthesize_cpu_map(&rec->tool, rec->evlist->cpus,
					     process_synthesized_event, NULL);
	if (err < 0) {
		pr_err("Couldn't synthesize cpu map.\n");
		return err;
	}

847 848
	err = __machine__synthesize_threads(machine, tool, &opts->target, rec->evlist->threads,
					    process_synthesized_event, opts->sample_address,
849
					    opts->proc_map_timeout, 1);
850 851 852 853
out:
	return err;
}

854
static int __cmd_record(struct record *rec, int argc, const char **argv)
855
{
856
	int err;
857
	int status = 0;
858
	unsigned long waking = 0;
859
	const bool forks = argc > 0;
860
	struct perf_tool *tool = &rec->tool;
861
	struct record_opts *opts = &rec->opts;
862
	struct perf_data *data = &rec->data;
863
	struct perf_session *session;
864
	bool disabled = false, draining = false;
865
	int fd;
866

867
	atexit(record__sig_exit);
868 869
	signal(SIGCHLD, sig_handler);
	signal(SIGINT, sig_handler);
870
	signal(SIGTERM, sig_handler);
W
Wang Nan 已提交
871
	signal(SIGSEGV, sigsegv_handler);
872

873 874 875
	if (rec->opts.record_namespaces)
		tool->namespace_events = true;

876
	if (rec->opts.auxtrace_snapshot_mode || rec->switch_output.enabled) {
877
		signal(SIGUSR2, snapshot_sig_handler);
878 879
		if (rec->opts.auxtrace_snapshot_mode)
			trigger_on(&auxtrace_snapshot_trigger);
880
		if (rec->switch_output.enabled)
881
			trigger_on(&switch_output_trigger);
882
	} else {
883
		signal(SIGUSR2, SIG_IGN);
884
	}
885

886
	session = perf_session__new(data, false, tool);
887
	if (session == NULL) {
A
Adrien BAK 已提交
888
		pr_err("Perf session creation failed.\n");
889 890 891
		return -1;
	}

892
	fd = perf_data__fd(data);
893 894
	rec->session = session;

895
	record__init_features(rec);
896

897
	if (forks) {
898
		err = perf_evlist__prepare_workload(rec->evlist, &opts->target,
899
						    argv, data->is_pipe,
900
						    workload_exec_failed_signal);
901 902
		if (err < 0) {
			pr_err("Couldn't run the workload!\n");
903
			status = err;
904
			goto out_delete_session;
905 906 907
		}
	}

J
Jiri Olsa 已提交
908 909 910 911 912 913 914 915 916
	/*
	 * If we have just single event and are sending data
	 * through pipe, we need to force the ids allocation,
	 * because we synthesize event name through the pipe
	 * and need the id for that.
	 */
	if (data->is_pipe && rec->evlist->nr_entries == 1)
		rec->opts.sample_id = true;

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

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

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

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

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

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

962
	err = record__synthesize(rec, false);
963
	if (err < 0)
964
		goto out_child;
965

966
	if (rec->realtime_prio) {
967 968
		struct sched_param param;

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

977 978 979 980 981
	/*
	 * 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.
	 */
982
	if (!target__none(&opts->target) && !opts->initial_delay)
983
		perf_evlist__enable(rec->evlist);
984

985 986 987
	/*
	 * Let the child rip
	 */
988
	if (forks) {
989
		struct machine *machine = &session->machines.host;
990
		union perf_event *event;
991
		pid_t tgid;
992 993 994 995 996 997 998

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

999 1000 1001 1002 1003 1004
		/*
		 * 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.
		 */
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
		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);
1029
		free(event);
1030

1031
		perf_evlist__start_workload(rec->evlist);
1032
	}
1033

1034
	if (opts->initial_delay) {
1035
		usleep(opts->initial_delay * USEC_PER_MSEC);
1036 1037 1038
		perf_evlist__enable(rec->evlist);
	}

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

1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
		/*
		 * 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);

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

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

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

1088 1089 1090 1091 1092 1093 1094
			/*
			 * 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);

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

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

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

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

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

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

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

1153 1154 1155
	if (target__none(&rec->opts.target))
		record__synthesize_workload(rec, true);

1156 1157 1158
out_child:
	if (forks) {
		int exit_status;
1159

1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
		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;

1174
	record__synthesize(rec, true);
1175 1176 1177
	/* this will be recalculated during process_buildids() */
	rec->samples = 0;

1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188
	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;
			}
		}
	}
1189

W
Wang Nan 已提交
1190 1191
	perf_hooks__invoke_record_end();

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

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

1203
		fprintf(stderr,	"[ perf record: Captured and wrote %.3f MB %s%s%s ]\n",
1204
			perf_data__size(data) / 1024.0 / 1024.0,
J
Jiri Olsa 已提交
1205
			data->file.path, postfix, samples);
1206 1207
	}

1208 1209
out_delete_session:
	perf_session__delete(session);
1210
	return status;
1211
}
1212

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

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

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

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

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

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

	return ret;
}

1249 1250 1251 1252 1253 1254 1255
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);
}

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

1262
	callchain->enabled = true;
J
Jiri Olsa 已提交
1263

1264 1265
	if (callchain->record_mode == CALLCHAIN_NONE)
		callchain->record_mode = CALLCHAIN_FP;
1266

1267
	callchain_debug(callchain);
J
Jiri Olsa 已提交
1268 1269 1270
	return 0;
}

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

1291
	return 0;
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 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
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;
}

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

1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437
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);
	}
}

1438 1439 1440
static int switch_output_setup(struct record *rec)
{
	struct switch_output *s = &rec->switch_output;
1441 1442 1443 1444 1445 1446 1447
	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 },
	};
1448 1449 1450 1451 1452 1453 1454
	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 },
	};
1455
	unsigned long val;
1456 1457 1458 1459 1460 1461 1462

	if (!s->set)
		return 0;

	if (!strcmp(s->str, "signal")) {
		s->signal = true;
		pr_debug("switch-output with SIGUSR2 signal\n");
1463 1464 1465 1466 1467 1468 1469 1470
		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;
1471 1472
	}

1473 1474 1475 1476 1477 1478 1479 1480
	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;
	}

1481
	return -1;
1482 1483 1484 1485

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

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

1490
	return 0;
1491 1492
}

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

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

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

1538 1539
static bool dry_run;

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

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

1684 1685
struct option *record_options = __record_options;

1686
int cmd_record(int argc, const char **argv)
1687
{
1688
	int err;
1689
	struct record *rec = &record;
1690
	char errbuf[BUFSIZ];
1691

1692 1693
	setlocale(LC_ALL, "");

1694 1695 1696 1697 1698
#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
1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712
#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
1713 1714
#endif

1715 1716
	rec->evlist = perf_evlist__new();
	if (rec->evlist == NULL)
1717 1718
		return -ENOMEM;

1719 1720 1721
	err = perf_config(perf_record_config, rec);
	if (err)
		return err;
1722

1723
	argc = parse_options(argc, argv, record_options, record_usage,
1724
			    PARSE_OPT_STOP_AT_NON_OPTION);
1725 1726
	if (quiet)
		perf_quiet_option();
1727 1728

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

1732
	if (nr_cgroups && !rec->opts.target.system_wide) {
1733 1734 1735
		usage_with_options_msg(record_usage, record_options,
			"cgroup monitoring only available in system-wide mode");

S
Stephane Eranian 已提交
1736
	}
1737 1738
	if (rec->opts.record_switch_events &&
	    !perf_can_record_switch_events()) {
1739 1740 1741
		ui__error("kernel does not support recording context switch events\n");
		parse_options_usage(record_usage, record_options, "switch-events", 0);
		return -EINVAL;
1742
	}
S
Stephane Eranian 已提交
1743

1744 1745 1746 1747 1748
	if (switch_output_setup(rec)) {
		parse_options_usage(record_usage, record_options, "switch-output", 0);
		return -EINVAL;
	}

1749 1750 1751 1752 1753
	if (rec->switch_output.time) {
		signal(SIGALRM, alarm_sig_handler);
		alarm(rec->switch_output.time);
	}

1754 1755 1756 1757 1758 1759 1760 1761
	/*
	 * Allow aliases to facilitate the lookup of symbols for address
	 * filters. Refer to auxtrace_parse_filters().
	 */
	symbol_conf.allow_aliases = true;

	symbol__init(NULL);

1762
	err = record__auxtrace_init(rec);
1763 1764 1765
	if (err)
		goto out;

1766
	if (dry_run)
A
Adrian Hunter 已提交
1767
		goto out;
1768

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

1777 1778
	err = -ENOMEM;

1779
	if (symbol_conf.kptr_restrict && !perf_evlist__exclude_kernel(rec->evlist))
1780 1781 1782 1783 1784 1785 1786 1787
		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");
1788

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

1820 1821 1822
	if (record.opts.overwrite)
		record.opts.tail_synthesize = true;

1823
	if (rec->evlist->nr_entries == 0 &&
1824
	    __perf_evlist__add_default(rec->evlist, !record.opts.no_samples) < 0) {
1825
		pr_err("Not enough memory for event selector list\n");
1826
		goto out;
1827
	}
1828

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

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

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

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

		err = -saved_errno;
1846
		goto out;
1847
	}
1848

1849 1850
	/* Enable ignoring missing threads when -u/-p option is defined. */
	rec->opts.ignore_missing_thread = rec->opts.target.uid != UINT_MAX || rec->opts.target.pid;
1851

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

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

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

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

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

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

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

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

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

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