evlist.c 46.5 KB
Newer Older
1 2 3 4 5 6 7 8
/*
 * Copyright (C) 2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
 *
 * Parts came from builtin-{top,stat,record}.c, see those files for further
 * copyright notes.
 *
 * Released under the GPL v2. (and only v2, not any later version)
 */
9
#include "util.h"
10
#include <api/fs/fs.h>
11
#include <errno.h>
12
#include <inttypes.h>
13
#include <poll.h>
14 15
#include "cpumap.h"
#include "thread_map.h"
16
#include "target.h"
17 18
#include "evlist.h"
#include "evsel.h"
A
Adrian Hunter 已提交
19
#include "debug.h"
20
#include "units.h"
21
#include "asm/bug.h"
22
#include <signal.h>
23
#include <unistd.h>
24

25
#include "parse-events.h"
26
#include <subcmd/parse-options.h>
27

28 29
#include <sys/mman.h>

30 31
#include <linux/bitops.h>
#include <linux/hash.h>
32
#include <linux/log2.h>
33
#include <linux/err.h>
34

35
static void perf_mmap__munmap(struct perf_mmap *map);
36
static void perf_mmap__put(struct perf_mmap *map);
37

38
#define FD(e, x, y) (*(int *)xyarray__entry(e->fd, x, y))
39
#define SID(e, x, y) xyarray__entry(e->sample_id, x, y)
40

41 42
void perf_evlist__init(struct perf_evlist *evlist, struct cpu_map *cpus,
		       struct thread_map *threads)
43 44 45 46 47 48
{
	int i;

	for (i = 0; i < PERF_EVLIST__HLIST_SIZE; ++i)
		INIT_HLIST_HEAD(&evlist->heads[i]);
	INIT_LIST_HEAD(&evlist->entries);
49
	perf_evlist__set_maps(evlist, cpus, threads);
50
	fdarray__init(&evlist->pollfd, 64);
51
	evlist->workload.pid = -1;
52
	evlist->bkw_mmap_state = BKW_MMAP_NOTREADY;
53 54
}

55
struct perf_evlist *perf_evlist__new(void)
56 57 58
{
	struct perf_evlist *evlist = zalloc(sizeof(*evlist));

59
	if (evlist != NULL)
60
		perf_evlist__init(evlist, NULL, NULL);
61 62 63 64

	return evlist;
}

65 66 67 68 69 70 71 72 73 74 75 76
struct perf_evlist *perf_evlist__new_default(void)
{
	struct perf_evlist *evlist = perf_evlist__new();

	if (evlist && perf_evlist__add_default(evlist)) {
		perf_evlist__delete(evlist);
		evlist = NULL;
	}

	return evlist;
}

77 78 79 80 81 82 83 84 85 86 87 88
struct perf_evlist *perf_evlist__new_dummy(void)
{
	struct perf_evlist *evlist = perf_evlist__new();

	if (evlist && perf_evlist__add_dummy(evlist)) {
		perf_evlist__delete(evlist);
		evlist = NULL;
	}

	return evlist;
}

89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
/**
 * perf_evlist__set_id_pos - set the positions of event ids.
 * @evlist: selected event list
 *
 * Events with compatible sample types all have the same id_pos
 * and is_pos.  For convenience, put a copy on evlist.
 */
void perf_evlist__set_id_pos(struct perf_evlist *evlist)
{
	struct perf_evsel *first = perf_evlist__first(evlist);

	evlist->id_pos = first->id_pos;
	evlist->is_pos = first->is_pos;
}

104 105 106 107
static void perf_evlist__update_id_pos(struct perf_evlist *evlist)
{
	struct perf_evsel *evsel;

108
	evlist__for_each_entry(evlist, evsel)
109 110 111 112 113
		perf_evsel__calc_id_pos(evsel);

	perf_evlist__set_id_pos(evlist);
}

114 115 116 117
static void perf_evlist__purge(struct perf_evlist *evlist)
{
	struct perf_evsel *pos, *n;

118
	evlist__for_each_entry_safe(evlist, n, pos) {
119
		list_del_init(&pos->node);
120
		pos->evlist = NULL;
121 122 123 124 125 126
		perf_evsel__delete(pos);
	}

	evlist->nr_entries = 0;
}

127
void perf_evlist__exit(struct perf_evlist *evlist)
128
{
129
	zfree(&evlist->mmap);
130
	zfree(&evlist->backward_mmap);
131
	fdarray__exit(&evlist->pollfd);
132 133 134 135
}

void perf_evlist__delete(struct perf_evlist *evlist)
{
136 137 138
	if (evlist == NULL)
		return;

139
	perf_evlist__munmap(evlist);
140
	perf_evlist__close(evlist);
141
	cpu_map__put(evlist->cpus);
142
	thread_map__put(evlist->threads);
143 144
	evlist->cpus = NULL;
	evlist->threads = NULL;
145 146
	perf_evlist__purge(evlist);
	perf_evlist__exit(evlist);
147 148 149
	free(evlist);
}

150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
static void __perf_evlist__propagate_maps(struct perf_evlist *evlist,
					  struct perf_evsel *evsel)
{
	/*
	 * We already have cpus for evsel (via PMU sysfs) so
	 * keep it, if there's no target cpu list defined.
	 */
	if (!evsel->own_cpus || evlist->has_user_cpus) {
		cpu_map__put(evsel->cpus);
		evsel->cpus = cpu_map__get(evlist->cpus);
	} else if (evsel->cpus != evsel->own_cpus) {
		cpu_map__put(evsel->cpus);
		evsel->cpus = cpu_map__get(evsel->own_cpus);
	}

	thread_map__put(evsel->threads);
	evsel->threads = thread_map__get(evlist->threads);
}

static void perf_evlist__propagate_maps(struct perf_evlist *evlist)
{
	struct perf_evsel *evsel;

173
	evlist__for_each_entry(evlist, evsel)
174 175 176
		__perf_evlist__propagate_maps(evlist, evsel);
}

177 178
void perf_evlist__add(struct perf_evlist *evlist, struct perf_evsel *entry)
{
179
	entry->evlist = evlist;
180
	list_add_tail(&entry->node, &evlist->entries);
181
	entry->idx = evlist->nr_entries;
182
	entry->tracking = !entry->idx;
183

184 185
	if (!evlist->nr_entries++)
		perf_evlist__set_id_pos(evlist);
186 187

	__perf_evlist__propagate_maps(evlist, entry);
188 189
}

190 191 192 193 194 195 196
void perf_evlist__remove(struct perf_evlist *evlist, struct perf_evsel *evsel)
{
	evsel->evlist = NULL;
	list_del_init(&evsel->node);
	evlist->nr_entries -= 1;
}

197
void perf_evlist__splice_list_tail(struct perf_evlist *evlist,
198
				   struct list_head *list)
199
{
200
	struct perf_evsel *evsel, *temp;
201

202
	__evlist__for_each_entry_safe(list, temp, evsel) {
203 204 205
		list_del_init(&evsel->node);
		perf_evlist__add(evlist, evsel);
	}
206 207
}

208 209 210 211 212
void __perf_evlist__set_leader(struct list_head *list)
{
	struct perf_evsel *evsel, *leader;

	leader = list_entry(list->next, struct perf_evsel, node);
213 214 215
	evsel = list_entry(list->prev, struct perf_evsel, node);

	leader->nr_members = evsel->idx - leader->idx + 1;
216

217
	__evlist__for_each_entry(list, evsel) {
218
		evsel->leader = leader;
219 220 221 222
	}
}

void perf_evlist__set_leader(struct perf_evlist *evlist)
223
{
224 225
	if (evlist->nr_entries) {
		evlist->nr_groups = evlist->nr_entries > 1 ? 1 : 0;
226
		__perf_evlist__set_leader(&evlist->entries);
227
	}
228 229
}

230
void perf_event_attr__set_max_precise_ip(struct perf_event_attr *attr)
231 232 233 234 235 236 237 238 239 240 241 242 243
{
	attr->precise_ip = 3;

	while (attr->precise_ip != 0) {
		int fd = sys_perf_event_open(attr, 0, -1, -1, 0);
		if (fd != -1) {
			close(fd);
			break;
		}
		--attr->precise_ip;
	}
}

244 245
int perf_evlist__add_default(struct perf_evlist *evlist)
{
246
	struct perf_evsel *evsel = perf_evsel__new_cycles();
247

248
	if (evsel == NULL)
249
		return -ENOMEM;
250 251 252 253

	perf_evlist__add(evlist, evsel);
	return 0;
}
254

255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
int perf_evlist__add_dummy(struct perf_evlist *evlist)
{
	struct perf_event_attr attr = {
		.type	= PERF_TYPE_SOFTWARE,
		.config = PERF_COUNT_SW_DUMMY,
		.size	= sizeof(attr), /* to capture ABI version */
	};
	struct perf_evsel *evsel = perf_evsel__new(&attr);

	if (evsel == NULL)
		return -ENOMEM;

	perf_evlist__add(evlist, evsel);
	return 0;
}

271 272
static int perf_evlist__add_attrs(struct perf_evlist *evlist,
				  struct perf_event_attr *attrs, size_t nr_attrs)
273 274 275 276 277 278
{
	struct perf_evsel *evsel, *n;
	LIST_HEAD(head);
	size_t i;

	for (i = 0; i < nr_attrs; i++) {
279
		evsel = perf_evsel__new_idx(attrs + i, evlist->nr_entries + i);
280 281 282 283 284
		if (evsel == NULL)
			goto out_delete_partial_list;
		list_add_tail(&evsel->node, &head);
	}

285
	perf_evlist__splice_list_tail(evlist, &head);
286 287 288 289

	return 0;

out_delete_partial_list:
290
	__evlist__for_each_entry_safe(&head, n, evsel)
291 292 293 294
		perf_evsel__delete(evsel);
	return -1;
}

295 296 297 298 299 300 301 302 303 304 305
int __perf_evlist__add_default_attrs(struct perf_evlist *evlist,
				     struct perf_event_attr *attrs, size_t nr_attrs)
{
	size_t i;

	for (i = 0; i < nr_attrs; i++)
		event_attr_init(attrs + i);

	return perf_evlist__add_attrs(evlist, attrs, nr_attrs);
}

306 307
struct perf_evsel *
perf_evlist__find_tracepoint_by_id(struct perf_evlist *evlist, int id)
308 309 310
{
	struct perf_evsel *evsel;

311
	evlist__for_each_entry(evlist, evsel) {
312 313 314 315 316 317 318 319
		if (evsel->attr.type   == PERF_TYPE_TRACEPOINT &&
		    (int)evsel->attr.config == id)
			return evsel;
	}

	return NULL;
}

320 321 322 323 324 325
struct perf_evsel *
perf_evlist__find_tracepoint_by_name(struct perf_evlist *evlist,
				     const char *name)
{
	struct perf_evsel *evsel;

326
	evlist__for_each_entry(evlist, evsel) {
327 328 329 330 331 332 333 334
		if ((evsel->attr.type == PERF_TYPE_TRACEPOINT) &&
		    (strcmp(evsel->name, name) == 0))
			return evsel;
	}

	return NULL;
}

335 336 337
int perf_evlist__add_newtp(struct perf_evlist *evlist,
			   const char *sys, const char *name, void *handler)
{
338
	struct perf_evsel *evsel = perf_evsel__newtp(sys, name);
339

340
	if (IS_ERR(evsel))
341 342
		return -1;

343
	evsel->handler = handler;
344 345 346 347
	perf_evlist__add(evlist, evsel);
	return 0;
}

348 349 350 351 352 353 354 355 356
static int perf_evlist__nr_threads(struct perf_evlist *evlist,
				   struct perf_evsel *evsel)
{
	if (evsel->system_wide)
		return 1;
	else
		return thread_map__nr(evlist->threads);
}

357 358 359
void perf_evlist__disable(struct perf_evlist *evlist)
{
	struct perf_evsel *pos;
360

361
	evlist__for_each_entry(evlist, pos) {
362 363 364
		if (!perf_evsel__is_group_leader(pos) || !pos->fd)
			continue;
		perf_evsel__disable(pos);
365
	}
366 367

	evlist->enabled = false;
368 369
}

370 371 372
void perf_evlist__enable(struct perf_evlist *evlist)
{
	struct perf_evsel *pos;
373

374
	evlist__for_each_entry(evlist, pos) {
375 376 377
		if (!perf_evsel__is_group_leader(pos) || !pos->fd)
			continue;
		perf_evsel__enable(pos);
378
	}
379 380 381 382 383 384 385

	evlist->enabled = true;
}

void perf_evlist__toggle_enable(struct perf_evlist *evlist)
{
	(evlist->enabled ? perf_evlist__disable : perf_evlist__enable)(evlist);
386 387
}

388 389 390
static int perf_evlist__enable_event_cpu(struct perf_evlist *evlist,
					 struct perf_evsel *evsel, int cpu)
{
391
	int thread;
392 393 394 395 396 397
	int nr_threads = perf_evlist__nr_threads(evlist, evsel);

	if (!evsel->fd)
		return -EINVAL;

	for (thread = 0; thread < nr_threads; thread++) {
398
		int err = ioctl(FD(evsel, cpu, thread), PERF_EVENT_IOC_ENABLE, 0);
399 400 401 402 403 404 405 406 407 408
		if (err)
			return err;
	}
	return 0;
}

static int perf_evlist__enable_event_thread(struct perf_evlist *evlist,
					    struct perf_evsel *evsel,
					    int thread)
{
409
	int cpu;
410 411 412 413 414 415
	int nr_cpus = cpu_map__nr(evlist->cpus);

	if (!evsel->fd)
		return -EINVAL;

	for (cpu = 0; cpu < nr_cpus; cpu++) {
416
		int err = ioctl(FD(evsel, cpu, thread), PERF_EVENT_IOC_ENABLE, 0);
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
		if (err)
			return err;
	}
	return 0;
}

int perf_evlist__enable_event_idx(struct perf_evlist *evlist,
				  struct perf_evsel *evsel, int idx)
{
	bool per_cpu_mmaps = !cpu_map__empty(evlist->cpus);

	if (per_cpu_mmaps)
		return perf_evlist__enable_event_cpu(evlist, evsel, idx);
	else
		return perf_evlist__enable_event_thread(evlist, evsel, idx);
}

434
int perf_evlist__alloc_pollfd(struct perf_evlist *evlist)
435
{
436 437
	int nr_cpus = cpu_map__nr(evlist->cpus);
	int nr_threads = thread_map__nr(evlist->threads);
438 439 440
	int nfds = 0;
	struct perf_evsel *evsel;

441
	evlist__for_each_entry(evlist, evsel) {
442 443 444 445 446 447
		if (evsel->system_wide)
			nfds += nr_cpus;
		else
			nfds += nr_cpus * nr_threads;
	}

448 449
	if (fdarray__available_entries(&evlist->pollfd) < nfds &&
	    fdarray__grow(&evlist->pollfd, nfds) < 0)
450 451 452
		return -ENOMEM;

	return 0;
453
}
454

455 456
static int __perf_evlist__add_pollfd(struct perf_evlist *evlist, int fd,
				     struct perf_mmap *map, short revent)
457
{
458
	int pos = fdarray__add(&evlist->pollfd, fd, revent | POLLERR | POLLHUP);
459 460 461 462 463
	/*
	 * Save the idx so that when we filter out fds POLLHUP'ed we can
	 * close the associated evlist->mmap[] entry.
	 */
	if (pos >= 0) {
464
		evlist->pollfd.priv[pos].ptr = map;
465 466 467 468 469 470 471

		fcntl(fd, F_SETFL, O_NONBLOCK);
	}

	return pos;
}

472
int perf_evlist__add_pollfd(struct perf_evlist *evlist, int fd)
473
{
474
	return __perf_evlist__add_pollfd(evlist, fd, NULL, POLLIN);
475 476
}

477 478
static void perf_evlist__munmap_filtered(struct fdarray *fda, int fd,
					 void *arg __maybe_unused)
479
{
480
	struct perf_mmap *map = fda->priv[fd].ptr;
481

482 483
	if (map)
		perf_mmap__put(map);
484
}
485

486 487
int perf_evlist__filter_pollfd(struct perf_evlist *evlist, short revents_and_mask)
{
488
	return fdarray__filter(&evlist->pollfd, revents_and_mask,
489
			       perf_evlist__munmap_filtered, NULL);
490 491
}

492 493
int perf_evlist__poll(struct perf_evlist *evlist, int timeout)
{
494
	return fdarray__poll(&evlist->pollfd, timeout);
495 496
}

497 498 499
static void perf_evlist__id_hash(struct perf_evlist *evlist,
				 struct perf_evsel *evsel,
				 int cpu, int thread, u64 id)
500 501 502 503 504 505 506 507 508 509
{
	int hash;
	struct perf_sample_id *sid = SID(evsel, cpu, thread);

	sid->id = id;
	sid->evsel = evsel;
	hash = hash_64(sid->id, PERF_EVLIST__HLIST_BITS);
	hlist_add_head(&sid->node, &evlist->heads[hash]);
}

510 511 512 513 514 515 516
void perf_evlist__id_add(struct perf_evlist *evlist, struct perf_evsel *evsel,
			 int cpu, int thread, u64 id)
{
	perf_evlist__id_hash(evlist, evsel, cpu, thread, id);
	evsel->id[evsel->ids++] = id;
}

J
Jiri Olsa 已提交
517 518 519
int perf_evlist__id_add_fd(struct perf_evlist *evlist,
			   struct perf_evsel *evsel,
			   int cpu, int thread, int fd)
520 521
{
	u64 read_data[4] = { 0, };
522
	int id_idx = 1; /* The first entry is the counter value */
523 524 525 526 527 528 529 530 531 532 533
	u64 id;
	int ret;

	ret = ioctl(fd, PERF_EVENT_IOC_ID, &id);
	if (!ret)
		goto add;

	if (errno != ENOTTY)
		return -1;

	/* Legacy way to get event id.. All hail to old kernels! */
534

535 536 537 538 539 540 541
	/*
	 * This way does not work with group format read, so bail
	 * out in that case.
	 */
	if (perf_evlist__read_format(evlist) & PERF_FORMAT_GROUP)
		return -1;

542 543 544 545 546 547 548 549 550
	if (!(evsel->attr.read_format & PERF_FORMAT_ID) ||
	    read(fd, &read_data, sizeof(read_data)) == -1)
		return -1;

	if (evsel->attr.read_format & PERF_FORMAT_TOTAL_TIME_ENABLED)
		++id_idx;
	if (evsel->attr.read_format & PERF_FORMAT_TOTAL_TIME_RUNNING)
		++id_idx;

551 552 553 554
	id = read_data[id_idx];

 add:
	perf_evlist__id_add(evlist, evsel, cpu, thread, id);
555 556 557
	return 0;
}

A
Adrian Hunter 已提交
558 559 560 561 562 563 564 565 566 567 568
static void perf_evlist__set_sid_idx(struct perf_evlist *evlist,
				     struct perf_evsel *evsel, int idx, int cpu,
				     int thread)
{
	struct perf_sample_id *sid = SID(evsel, cpu, thread);
	sid->idx = idx;
	if (evlist->cpus && cpu >= 0)
		sid->cpu = evlist->cpus->map[cpu];
	else
		sid->cpu = -1;
	if (!evsel->system_wide && evlist->threads && thread >= 0)
569
		sid->tid = thread_map__pid(evlist->threads, thread);
A
Adrian Hunter 已提交
570 571 572 573
	else
		sid->tid = -1;
}

574
struct perf_sample_id *perf_evlist__id2sid(struct perf_evlist *evlist, u64 id)
575 576 577 578 579 580 581 582
{
	struct hlist_head *head;
	struct perf_sample_id *sid;
	int hash;

	hash = hash_64(id, PERF_EVLIST__HLIST_BITS);
	head = &evlist->heads[hash];

583
	hlist_for_each_entry(sid, head, node)
584
		if (sid->id == id)
585 586 587 588 589 590 591 592 593
			return sid;

	return NULL;
}

struct perf_evsel *perf_evlist__id2evsel(struct perf_evlist *evlist, u64 id)
{
	struct perf_sample_id *sid;

594
	if (evlist->nr_entries == 1 || !id)
595 596 597 598 599
		return perf_evlist__first(evlist);

	sid = perf_evlist__id2sid(evlist, id);
	if (sid)
		return sid->evsel;
600 601

	if (!perf_evlist__sample_id_all(evlist))
602
		return perf_evlist__first(evlist);
603

604 605
	return NULL;
}
606

607 608 609 610 611 612 613 614 615 616 617 618 619 620 621
struct perf_evsel *perf_evlist__id2evsel_strict(struct perf_evlist *evlist,
						u64 id)
{
	struct perf_sample_id *sid;

	if (!id)
		return NULL;

	sid = perf_evlist__id2sid(evlist, id);
	if (sid)
		return sid->evsel;

	return NULL;
}

622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
static int perf_evlist__event2id(struct perf_evlist *evlist,
				 union perf_event *event, u64 *id)
{
	const u64 *array = event->sample.array;
	ssize_t n;

	n = (event->header.size - sizeof(event->header)) >> 3;

	if (event->header.type == PERF_RECORD_SAMPLE) {
		if (evlist->id_pos >= n)
			return -1;
		*id = array[evlist->id_pos];
	} else {
		if (evlist->is_pos > n)
			return -1;
		n -= evlist->is_pos;
		*id = array[n];
	}
	return 0;
}

J
Jiri Olsa 已提交
643 644
struct perf_evsel *perf_evlist__event2evsel(struct perf_evlist *evlist,
					    union perf_event *event)
645
{
646
	struct perf_evsel *first = perf_evlist__first(evlist);
647 648 649 650 651 652
	struct hlist_head *head;
	struct perf_sample_id *sid;
	int hash;
	u64 id;

	if (evlist->nr_entries == 1)
653 654 655 656 657
		return first;

	if (!first->attr.sample_id_all &&
	    event->header.type != PERF_RECORD_SAMPLE)
		return first;
658 659 660 661 662 663

	if (perf_evlist__event2id(evlist, event, &id))
		return NULL;

	/* Synthesized events have an id of zero */
	if (!id)
664
		return first;
665 666 667 668 669 670 671 672 673 674 675

	hash = hash_64(id, PERF_EVLIST__HLIST_BITS);
	head = &evlist->heads[hash];

	hlist_for_each_entry(sid, head, node) {
		if (sid->id == id)
			return sid->evsel;
	}
	return NULL;
}

W
Wang Nan 已提交
676 677 678 679
static int perf_evlist__set_paused(struct perf_evlist *evlist, bool value)
{
	int i;

680 681 682
	if (!evlist->backward_mmap)
		return 0;

W
Wang Nan 已提交
683
	for (i = 0; i < evlist->nr_mmaps; i++) {
684
		int fd = evlist->backward_mmap[i].fd;
W
Wang Nan 已提交
685 686 687 688 689 690 691 692 693 694 695
		int err;

		if (fd < 0)
			continue;
		err = ioctl(fd, PERF_EVENT_IOC_PAUSE_OUTPUT, value ? 1 : 0);
		if (err)
			return err;
	}
	return 0;
}

696
static int perf_evlist__pause(struct perf_evlist *evlist)
W
Wang Nan 已提交
697 698 699 700
{
	return perf_evlist__set_paused(evlist, true);
}

701
static int perf_evlist__resume(struct perf_evlist *evlist)
W
Wang Nan 已提交
702 703 704 705
{
	return perf_evlist__set_paused(evlist, false);
}

706
/* When check_messup is true, 'end' must points to a good entry */
707
static union perf_event *
708 709
perf_mmap__read(struct perf_mmap *md, bool check_messup, u64 start,
		u64 end, u64 *prev)
710 711
{
	unsigned char *data = md->base + page_size;
712
	union perf_event *event = NULL;
713
	int diff = end - start;
714

715
	if (check_messup) {
716
		/*
717 718 719
		 * If we're further behind than half the buffer, there's a chance
		 * the writer will bite our tail and mess up the samples under us.
		 *
720
		 * If we somehow ended up ahead of the 'end', we got messed up.
721
		 *
722
		 * In either case, truncate and restart at 'end'.
723
		 */
724 725 726 727
		if (diff > md->mask / 2 || diff < 0) {
			fprintf(stderr, "WARNING: failed to keep up with mmap data.\n");

			/*
728
			 * 'end' points to a known good entry, start there.
729
			 */
730
			start = end;
731
			diff = 0;
732
		}
733 734
	}

735
	if (diff >= (int)sizeof(event->header)) {
736 737
		size_t size;

738
		event = (union perf_event *)&data[start & md->mask];
739 740
		size = event->header.size;

741 742 743 744 745
		if (size < sizeof(event->header) || diff < (int)size) {
			event = NULL;
			goto broken_event;
		}

746 747 748 749
		/*
		 * Event straddles the mmap boundary -- header should always
		 * be inside due to u64 alignment of output.
		 */
750 751
		if ((start & md->mask) + size != ((start + size) & md->mask)) {
			unsigned int offset = start;
752
			unsigned int len = min(sizeof(*event), size), cpy;
753
			void *dst = md->event_copy;
754 755 756 757 758 759 760 761 762

			do {
				cpy = min(md->mask + 1 - (offset & md->mask), len);
				memcpy(dst, &data[offset & md->mask], cpy);
				offset += cpy;
				dst += cpy;
				len -= cpy;
			} while (len);

763
			event = (union perf_event *) md->event_copy;
764 765
		}

766
		start += size;
767 768
	}

769
broken_event:
770
	if (prev)
771
		*prev = start;
772

773 774
	return event;
}
775

776
union perf_event *perf_mmap__read_forward(struct perf_mmap *md, bool check_messup)
777 778 779 780 781 782 783
{
	u64 head;
	u64 old = md->prev;

	/*
	 * Check if event was unmapped due to a POLLHUP/POLLERR.
	 */
784
	if (!refcount_read(&md->refcnt))
785 786 787 788
		return NULL;

	head = perf_mmap__read_head(md);

789
	return perf_mmap__read(md, check_messup, old, head, &md->prev);
790 791
}

792
union perf_event *
793
perf_mmap__read_backward(struct perf_mmap *md)
794 795 796 797 798 799 800
{
	u64 head, end;
	u64 start = md->prev;

	/*
	 * Check if event was unmapped due to a POLLHUP/POLLERR.
	 */
801
	if (!refcount_read(&md->refcnt))
802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828
		return NULL;

	head = perf_mmap__read_head(md);
	if (!head)
		return NULL;

	/*
	 * 'head' pointer starts from 0. Kernel minus sizeof(record) form
	 * it each time when kernel writes to it, so in fact 'head' is
	 * negative. 'end' pointer is made manually by adding the size of
	 * the ring buffer to 'head' pointer, means the validate data can
	 * read is the whole ring buffer. If 'end' is positive, the ring
	 * buffer has not fully filled, so we must adjust 'end' to 0.
	 *
	 * However, since both 'head' and 'end' is unsigned, we can't
	 * simply compare 'end' against 0. Here we compare '-head' and
	 * the size of the ring buffer, where -head is the number of bytes
	 * kernel write to the ring buffer.
	 */
	if (-head < (u64)(md->mask + 1))
		end = 0;
	else
		end = head + md->mask + 1;

	return perf_mmap__read(md, false, start, end, &md->prev);
}

829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
union perf_event *perf_evlist__mmap_read_forward(struct perf_evlist *evlist, int idx)
{
	struct perf_mmap *md = &evlist->mmap[idx];

	/*
	 * Check messup is required for forward overwritable ring buffer:
	 * memory pointed by md->prev can be overwritten in this case.
	 * No need for read-write ring buffer: kernel stop outputting when
	 * it hit md->prev (perf_mmap__consume()).
	 */
	return perf_mmap__read_forward(md, evlist->overwrite);
}

union perf_event *perf_evlist__mmap_read_backward(struct perf_evlist *evlist, int idx)
{
	struct perf_mmap *md = &evlist->mmap[idx];

	/*
	 * No need to check messup for backward ring buffer:
	 * We can always read arbitrary long data from a backward
	 * ring buffer unless we forget to pause it before reading.
	 */
	return perf_mmap__read_backward(md);
}

854 855
union perf_event *perf_evlist__mmap_read(struct perf_evlist *evlist, int idx)
{
W
Wang Nan 已提交
856
	return perf_evlist__mmap_read_forward(evlist, idx);
857 858
}

859
void perf_mmap__read_catchup(struct perf_mmap *md)
860 861 862
{
	u64 head;

863
	if (!refcount_read(&md->refcnt))
864 865 866 867 868 869
		return;

	head = perf_mmap__read_head(md);
	md->prev = head;
}

870 871 872 873 874
void perf_evlist__mmap_read_catchup(struct perf_evlist *evlist, int idx)
{
	perf_mmap__read_catchup(&evlist->mmap[idx]);
}

875 876
static bool perf_mmap__empty(struct perf_mmap *md)
{
877
	return perf_mmap__read_head(md) == md->prev && !md->auxtrace_mmap.base;
878 879
}

880
static void perf_mmap__get(struct perf_mmap *map)
881
{
882
	refcount_inc(&map->refcnt);
883 884
}

885
static void perf_mmap__put(struct perf_mmap *md)
886
{
887
	BUG_ON(md->base && refcount_read(&md->refcnt) == 0);
888

889
	if (refcount_dec_and_test(&md->refcnt))
890
		perf_mmap__munmap(md);
891 892
}

893 894 895
void perf_mmap__consume(struct perf_mmap *md, bool overwrite)
{
	if (!overwrite) {
896
		u64 old = md->prev;
897 898 899

		perf_mmap__write_tail(md, old);
	}
900

901
	if (refcount_read(&md->refcnt) == 1 && perf_mmap__empty(md))
902 903 904 905 906 907
		perf_mmap__put(md);
}

void perf_evlist__mmap_consume(struct perf_evlist *evlist, int idx)
{
	perf_mmap__consume(&evlist->mmap[idx], evlist->overwrite);
908 909
}

910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937
int __weak auxtrace_mmap__mmap(struct auxtrace_mmap *mm __maybe_unused,
			       struct auxtrace_mmap_params *mp __maybe_unused,
			       void *userpg __maybe_unused,
			       int fd __maybe_unused)
{
	return 0;
}

void __weak auxtrace_mmap__munmap(struct auxtrace_mmap *mm __maybe_unused)
{
}

void __weak auxtrace_mmap_params__init(
			struct auxtrace_mmap_params *mp __maybe_unused,
			off_t auxtrace_offset __maybe_unused,
			unsigned int auxtrace_pages __maybe_unused,
			bool auxtrace_overwrite __maybe_unused)
{
}

void __weak auxtrace_mmap_params__set_idx(
			struct auxtrace_mmap_params *mp __maybe_unused,
			struct perf_evlist *evlist __maybe_unused,
			int idx __maybe_unused,
			bool per_cpu __maybe_unused)
{
}

938
static void perf_mmap__munmap(struct perf_mmap *map)
939
{
940 941 942 943
	if (map->base != NULL) {
		munmap(map->base, perf_mmap__mmap_len(map));
		map->base = NULL;
		map->fd = -1;
944
		refcount_set(&map->refcnt, 0);
945
	}
946 947 948
	auxtrace_mmap__munmap(&map->auxtrace_mmap);
}

949
static void perf_evlist__munmap_nofree(struct perf_evlist *evlist)
950
{
951
	int i;
952

953 954 955
	if (evlist->mmap)
		for (i = 0; i < evlist->nr_mmaps; i++)
			perf_mmap__munmap(&evlist->mmap[i]);
956

957 958 959
	if (evlist->backward_mmap)
		for (i = 0; i < evlist->nr_mmaps; i++)
			perf_mmap__munmap(&evlist->backward_mmap[i]);
960
}
961

962 963 964
void perf_evlist__munmap(struct perf_evlist *evlist)
{
	perf_evlist__munmap_nofree(evlist);
965
	zfree(&evlist->mmap);
966
	zfree(&evlist->backward_mmap);
967 968
}

969
static struct perf_mmap *perf_evlist__alloc_mmap(struct perf_evlist *evlist)
970
{
W
Wang Nan 已提交
971
	int i;
972
	struct perf_mmap *map;
W
Wang Nan 已提交
973

974
	evlist->nr_mmaps = cpu_map__nr(evlist->cpus);
975
	if (cpu_map__empty(evlist->cpus))
976
		evlist->nr_mmaps = thread_map__nr(evlist->threads);
977 978 979
	map = zalloc(evlist->nr_mmaps * sizeof(struct perf_mmap));
	if (!map)
		return NULL;
980

981
	for (i = 0; i < evlist->nr_mmaps; i++) {
982
		map[i].fd = -1;
983 984 985 986 987 988 989 990 991 992 993
		/*
		 * When the perf_mmap() call is made we grab one refcount, plus
		 * one extra to let perf_evlist__mmap_consume() get the last
		 * events after all real references (perf_mmap__get()) are
		 * dropped.
		 *
		 * Each PERF_EVENT_IOC_SET_OUTPUT points to this mmap and
		 * thus does perf_mmap__get() on it.
		 */
		refcount_set(&map[i].refcnt, 0);
	}
994
	return map;
995 996
}

997 998 999
struct mmap_params {
	int prot;
	int mask;
1000
	struct auxtrace_mmap_params auxtrace_mp;
1001 1002
};

1003 1004
static int perf_mmap__mmap(struct perf_mmap *map,
			   struct mmap_params *mp, int fd)
1005
{
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
	/*
	 * The last one will be done at perf_evlist__mmap_consume(), so that we
	 * make sure we don't prevent tools from consuming every last event in
	 * the ring buffer.
	 *
	 * I.e. we can get the POLLHUP meaning that the fd doesn't exist
	 * anymore, but the last events for it are still in the ring buffer,
	 * waiting to be consumed.
	 *
	 * Tools can chose to ignore this at their own discretion, but the
	 * evlist layer can't just drop it when filtering events in
	 * perf_evlist__filter_pollfd().
	 */
1019
	refcount_set(&map->refcnt, 2);
1020 1021 1022 1023 1024
	map->prev = 0;
	map->mask = mp->mask;
	map->base = mmap(NULL, perf_mmap__mmap_len(map), mp->prot,
			 MAP_SHARED, fd, 0);
	if (map->base == MAP_FAILED) {
1025 1026
		pr_debug2("failed to mmap perf event ring buffer, error %d\n",
			  errno);
1027
		map->base = NULL;
1028
		return -1;
1029
	}
1030
	map->fd = fd;
1031

1032 1033
	if (auxtrace_mmap__mmap(&map->auxtrace_mmap,
				&mp->auxtrace_mp, map->base, fd))
1034 1035
		return -1;

1036 1037 1038
	return 0;
}

1039 1040 1041 1042
static bool
perf_evlist__should_poll(struct perf_evlist *evlist __maybe_unused,
			 struct perf_evsel *evsel)
{
1043
	if (evsel->attr.write_backward)
1044 1045 1046 1047
		return false;
	return true;
}

1048
static int perf_evlist__mmap_per_evsel(struct perf_evlist *evlist, int idx,
1049
				       struct mmap_params *mp, int cpu_idx,
1050
				       int thread, int *_output, int *_output_backward)
1051 1052
{
	struct perf_evsel *evsel;
1053
	int revent;
1054
	int evlist_cpu = cpu_map__cpu(evlist->cpus, cpu_idx);
1055

1056
	evlist__for_each_entry(evlist, evsel) {
1057 1058
		struct perf_mmap *maps = evlist->mmap;
		int *output = _output;
1059
		int fd;
1060
		int cpu;
1061

1062 1063 1064 1065 1066 1067 1068 1069 1070
		if (evsel->attr.write_backward) {
			output = _output_backward;
			maps = evlist->backward_mmap;

			if (!maps) {
				maps = perf_evlist__alloc_mmap(evlist);
				if (!maps)
					return -1;
				evlist->backward_mmap = maps;
1071 1072
				if (evlist->bkw_mmap_state == BKW_MMAP_NOTREADY)
					perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_RUNNING);
1073 1074
			}
		}
1075

1076 1077 1078
		if (evsel->system_wide && thread)
			continue;

1079 1080 1081 1082
		cpu = cpu_map__idx(evsel->cpus, evlist_cpu);
		if (cpu == -1)
			continue;

1083
		fd = FD(evsel, cpu, thread);
1084 1085 1086

		if (*output == -1) {
			*output = fd;
1087 1088

			if (perf_mmap__mmap(&maps[idx], mp, *output)  < 0)
1089 1090 1091 1092
				return -1;
		} else {
			if (ioctl(fd, PERF_EVENT_IOC_SET_OUTPUT, *output) != 0)
				return -1;
1093

1094
			perf_mmap__get(&maps[idx]);
1095 1096
		}

1097 1098
		revent = perf_evlist__should_poll(evlist, evsel) ? POLLIN : 0;

1099 1100 1101 1102 1103 1104 1105 1106
		/*
		 * The system_wide flag causes a selected event to be opened
		 * always without a pid.  Consequently it will never get a
		 * POLLHUP, but it is used for tracking in combination with
		 * other events, so it should not need to be polled anyway.
		 * Therefore don't add it for polling.
		 */
		if (!evsel->system_wide &&
1107 1108
		    __perf_evlist__add_pollfd(evlist, fd, &maps[idx], revent) < 0) {
			perf_mmap__put(&maps[idx]);
1109
			return -1;
1110
		}
1111

A
Adrian Hunter 已提交
1112 1113 1114 1115 1116 1117 1118
		if (evsel->attr.read_format & PERF_FORMAT_ID) {
			if (perf_evlist__id_add_fd(evlist, evsel, cpu, thread,
						   fd) < 0)
				return -1;
			perf_evlist__set_sid_idx(evlist, evsel, idx, cpu,
						 thread);
		}
1119 1120 1121 1122 1123
	}

	return 0;
}

1124 1125
static int perf_evlist__mmap_per_cpu(struct perf_evlist *evlist,
				     struct mmap_params *mp)
1126
{
1127
	int cpu, thread;
1128 1129
	int nr_cpus = cpu_map__nr(evlist->cpus);
	int nr_threads = thread_map__nr(evlist->threads);
1130

A
Adrian Hunter 已提交
1131
	pr_debug2("perf event ring buffer mmapped per cpu\n");
1132
	for (cpu = 0; cpu < nr_cpus; cpu++) {
1133
		int output = -1;
1134
		int output_backward = -1;
1135

1136 1137 1138
		auxtrace_mmap_params__set_idx(&mp->auxtrace_mp, evlist, cpu,
					      true);

1139
		for (thread = 0; thread < nr_threads; thread++) {
1140
			if (perf_evlist__mmap_per_evsel(evlist, cpu, mp, cpu,
1141
							thread, &output, &output_backward))
1142
				goto out_unmap;
1143 1144 1145 1146 1147 1148
		}
	}

	return 0;

out_unmap:
1149
	perf_evlist__munmap_nofree(evlist);
1150 1151 1152
	return -1;
}

1153 1154
static int perf_evlist__mmap_per_thread(struct perf_evlist *evlist,
					struct mmap_params *mp)
1155 1156
{
	int thread;
1157
	int nr_threads = thread_map__nr(evlist->threads);
1158

A
Adrian Hunter 已提交
1159
	pr_debug2("perf event ring buffer mmapped per thread\n");
1160
	for (thread = 0; thread < nr_threads; thread++) {
1161
		int output = -1;
1162
		int output_backward = -1;
1163

1164 1165 1166
		auxtrace_mmap_params__set_idx(&mp->auxtrace_mp, evlist, thread,
					      false);

1167
		if (perf_evlist__mmap_per_evsel(evlist, thread, mp, 0, thread,
1168
						&output, &output_backward))
1169
			goto out_unmap;
1170 1171 1172 1173 1174
	}

	return 0;

out_unmap:
1175
	perf_evlist__munmap_nofree(evlist);
1176 1177 1178
	return -1;
}

1179
unsigned long perf_event_mlock_kb_in_pages(void)
1180
{
1181 1182
	unsigned long pages;
	int max;
1183

1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
	if (sysctl__read_int("kernel/perf_event_mlock_kb", &max) < 0) {
		/*
		 * Pick a once upon a time good value, i.e. things look
		 * strange since we can't read a sysctl value, but lets not
		 * die yet...
		 */
		max = 512;
	} else {
		max -= (page_size / 1024);
	}
1194

1195 1196 1197 1198 1199 1200 1201
	pages = (max * 1024) / page_size;
	if (!is_power_of_2(pages))
		pages = rounddown_pow_of_two(pages);

	return pages;
}

1202
size_t perf_evlist__mmap_size(unsigned long pages)
1203 1204 1205 1206
{
	if (pages == UINT_MAX)
		pages = perf_event_mlock_kb_in_pages();
	else if (!is_power_of_2(pages))
1207 1208 1209 1210 1211
		return 0;

	return (pages + 1) * page_size;
}

1212 1213
static long parse_pages_arg(const char *str, unsigned long min,
			    unsigned long max)
1214
{
1215
	unsigned long pages, val;
1216 1217 1218 1219 1220 1221 1222
	static struct parse_tag tags[] = {
		{ .tag  = 'B', .mult = 1       },
		{ .tag  = 'K', .mult = 1 << 10 },
		{ .tag  = 'M', .mult = 1 << 20 },
		{ .tag  = 'G', .mult = 1 << 30 },
		{ .tag  = 0 },
	};
1223

1224
	if (str == NULL)
1225
		return -EINVAL;
1226

1227
	val = parse_tag_value(str, tags);
1228
	if (val != (unsigned long) -1) {
1229 1230 1231 1232 1233 1234
		/* we got file size value */
		pages = PERF_ALIGN(val, page_size) / page_size;
	} else {
		/* we got pages count value */
		char *eptr;
		pages = strtoul(str, &eptr, 10);
1235 1236
		if (*eptr != '\0')
			return -EINVAL;
1237 1238
	}

1239
	if (pages == 0 && min == 0) {
1240
		/* leave number of pages at 0 */
1241
	} else if (!is_power_of_2(pages)) {
1242 1243
		char buf[100];

1244
		/* round pages up to next power of 2 */
1245
		pages = roundup_pow_of_two(pages);
1246 1247
		if (!pages)
			return -EINVAL;
1248 1249 1250 1251

		unit_number__scnprintf(buf, sizeof(buf), pages * page_size);
		pr_info("rounding mmap pages size to %s (%lu pages)\n",
			buf, pages);
1252 1253
	}

1254 1255 1256 1257 1258 1259
	if (pages > max)
		return -EINVAL;

	return pages;
}

1260
int __perf_evlist__parse_mmap_pages(unsigned int *mmap_pages, const char *str)
1261 1262 1263 1264
{
	unsigned long max = UINT_MAX;
	long pages;

A
Adrian Hunter 已提交
1265
	if (max > SIZE_MAX / page_size)
1266 1267 1268 1269 1270
		max = SIZE_MAX / page_size;

	pages = parse_pages_arg(str, 1, max);
	if (pages < 0) {
		pr_err("Invalid argument for --mmap_pages/-m\n");
1271 1272 1273 1274 1275 1276 1277
		return -1;
	}

	*mmap_pages = pages;
	return 0;
}

1278 1279 1280 1281 1282 1283
int perf_evlist__parse_mmap_pages(const struct option *opt, const char *str,
				  int unset __maybe_unused)
{
	return __perf_evlist__parse_mmap_pages(opt->value, str);
}

1284
/**
1285
 * perf_evlist__mmap_ex - Create mmaps to receive events.
1286 1287 1288
 * @evlist: list of events
 * @pages: map length in pages
 * @overwrite: overwrite older events?
1289 1290
 * @auxtrace_pages - auxtrace map length in pages
 * @auxtrace_overwrite - overwrite older auxtrace data?
1291
 *
1292 1293 1294
 * If @overwrite is %false the user needs to signal event consumption using
 * perf_mmap__write_tail().  Using perf_evlist__mmap_read() does this
 * automatically.
1295
 *
1296 1297 1298
 * Similarly, if @auxtrace_overwrite is %false the user needs to signal data
 * consumption using auxtrace_mmap__write_tail().
 *
1299
 * Return: %0 on success, negative error code otherwise.
1300
 */
1301 1302 1303
int perf_evlist__mmap_ex(struct perf_evlist *evlist, unsigned int pages,
			 bool overwrite, unsigned int auxtrace_pages,
			 bool auxtrace_overwrite)
1304
{
1305
	struct perf_evsel *evsel;
1306 1307
	const struct cpu_map *cpus = evlist->cpus;
	const struct thread_map *threads = evlist->threads;
1308 1309 1310
	struct mmap_params mp = {
		.prot = PROT_READ | (overwrite ? 0 : PROT_WRITE),
	};
1311

1312 1313 1314
	if (!evlist->mmap)
		evlist->mmap = perf_evlist__alloc_mmap(evlist);
	if (!evlist->mmap)
1315 1316
		return -ENOMEM;

1317
	if (evlist->pollfd.entries == NULL && perf_evlist__alloc_pollfd(evlist) < 0)
1318 1319 1320
		return -ENOMEM;

	evlist->overwrite = overwrite;
1321
	evlist->mmap_len = perf_evlist__mmap_size(pages);
1322
	pr_debug("mmap size %zuB\n", evlist->mmap_len);
1323
	mp.mask = evlist->mmap_len - page_size - 1;
1324

1325 1326 1327
	auxtrace_mmap_params__init(&mp.auxtrace_mp, evlist->mmap_len,
				   auxtrace_pages, auxtrace_overwrite);

1328
	evlist__for_each_entry(evlist, evsel) {
1329
		if ((evsel->attr.read_format & PERF_FORMAT_ID) &&
1330
		    evsel->sample_id == NULL &&
1331
		    perf_evsel__alloc_id(evsel, cpu_map__nr(cpus), threads->nr) < 0)
1332 1333 1334
			return -ENOMEM;
	}

1335
	if (cpu_map__empty(cpus))
1336
		return perf_evlist__mmap_per_thread(evlist, &mp);
1337

1338
	return perf_evlist__mmap_per_cpu(evlist, &mp);
1339
}
1340

1341 1342 1343 1344 1345 1346
int perf_evlist__mmap(struct perf_evlist *evlist, unsigned int pages,
		      bool overwrite)
{
	return perf_evlist__mmap_ex(evlist, pages, overwrite, 0, false);
}

1347
int perf_evlist__create_maps(struct perf_evlist *evlist, struct target *target)
1348
{
1349 1350
	struct cpu_map *cpus;
	struct thread_map *threads;
1351

1352
	threads = thread_map__new_str(target->pid, target->tid, target->uid);
1353

1354
	if (!threads)
1355 1356
		return -1;

1357
	if (target__uses_dummy_map(target))
1358
		cpus = cpu_map__dummy_new();
1359
	else
1360
		cpus = cpu_map__new(target->cpu_list);
1361

1362
	if (!cpus)
1363 1364
		goto out_delete_threads;

1365 1366
	evlist->has_user_cpus = !!target->cpu_list;

1367
	perf_evlist__set_maps(evlist, cpus, threads);
1368 1369

	return 0;
1370 1371

out_delete_threads:
1372
	thread_map__put(threads);
1373 1374 1375
	return -1;
}

1376 1377
void perf_evlist__set_maps(struct perf_evlist *evlist, struct cpu_map *cpus,
			   struct thread_map *threads)
1378
{
1379 1380 1381 1382 1383 1384 1385 1386
	/*
	 * Allow for the possibility that one or another of the maps isn't being
	 * changed i.e. don't put it.  Note we are assuming the maps that are
	 * being applied are brand new and evlist is taking ownership of the
	 * original reference count of 1.  If that is not the case it is up to
	 * the caller to increase the reference count.
	 */
	if (cpus != evlist->cpus) {
1387
		cpu_map__put(evlist->cpus);
1388
		evlist->cpus = cpu_map__get(cpus);
1389
	}
1390

1391
	if (threads != evlist->threads) {
1392
		thread_map__put(evlist->threads);
1393
		evlist->threads = thread_map__get(threads);
1394
	}
1395

1396
	perf_evlist__propagate_maps(evlist);
1397 1398
}

1399 1400 1401 1402 1403
void __perf_evlist__set_sample_bit(struct perf_evlist *evlist,
				   enum perf_event_sample_format bit)
{
	struct perf_evsel *evsel;

1404
	evlist__for_each_entry(evlist, evsel)
1405 1406 1407 1408 1409 1410 1411 1412
		__perf_evsel__set_sample_bit(evsel, bit);
}

void __perf_evlist__reset_sample_bit(struct perf_evlist *evlist,
				     enum perf_event_sample_format bit)
{
	struct perf_evsel *evsel;

1413
	evlist__for_each_entry(evlist, evsel)
1414 1415 1416
		__perf_evsel__reset_sample_bit(evsel, bit);
}

1417
int perf_evlist__apply_filters(struct perf_evlist *evlist, struct perf_evsel **err_evsel)
1418 1419
{
	struct perf_evsel *evsel;
1420 1421
	int err = 0;
	const int ncpus = cpu_map__nr(evlist->cpus),
1422
		  nthreads = thread_map__nr(evlist->threads);
1423

1424
	evlist__for_each_entry(evlist, evsel) {
1425
		if (evsel->filter == NULL)
1426
			continue;
1427

1428 1429 1430 1431
		/*
		 * filters only work for tracepoint event, which doesn't have cpu limit.
		 * So evlist and evsel should always be same.
		 */
1432
		err = perf_evsel__apply_filter(evsel, ncpus, nthreads, evsel->filter);
1433 1434
		if (err) {
			*err_evsel = evsel;
1435
			break;
1436
		}
1437 1438
	}

1439 1440 1441 1442 1443 1444 1445 1446
	return err;
}

int perf_evlist__set_filter(struct perf_evlist *evlist, const char *filter)
{
	struct perf_evsel *evsel;
	int err = 0;

1447
	evlist__for_each_entry(evlist, evsel) {
1448 1449 1450
		if (evsel->attr.type != PERF_TYPE_TRACEPOINT)
			continue;

1451
		err = perf_evsel__set_filter(evsel, filter);
1452 1453 1454 1455 1456
		if (err)
			break;
	}

	return err;
1457
}
1458

1459
int perf_evlist__set_filter_pids(struct perf_evlist *evlist, size_t npids, pid_t *pids)
1460 1461
{
	char *filter;
1462 1463
	int ret = -1;
	size_t i;
1464

1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478
	for (i = 0; i < npids; ++i) {
		if (i == 0) {
			if (asprintf(&filter, "common_pid != %d", pids[i]) < 0)
				return -1;
		} else {
			char *tmp;

			if (asprintf(&tmp, "%s && common_pid != %d", filter, pids[i]) < 0)
				goto out_free;

			free(filter);
			filter = tmp;
		}
	}
1479 1480

	ret = perf_evlist__set_filter(evlist, filter);
1481
out_free:
1482 1483 1484 1485
	free(filter);
	return ret;
}

1486 1487 1488 1489 1490
int perf_evlist__set_filter_pid(struct perf_evlist *evlist, pid_t pid)
{
	return perf_evlist__set_filter_pids(evlist, 1, &pid);
}

1491
bool perf_evlist__valid_sample_type(struct perf_evlist *evlist)
1492
{
1493
	struct perf_evsel *pos;
1494

1495 1496 1497 1498 1499 1500
	if (evlist->nr_entries == 1)
		return true;

	if (evlist->id_pos < 0 || evlist->is_pos < 0)
		return false;

1501
	evlist__for_each_entry(evlist, pos) {
1502 1503
		if (pos->id_pos != evlist->id_pos ||
		    pos->is_pos != evlist->is_pos)
1504
			return false;
1505 1506
	}

1507
	return true;
1508 1509
}

1510
u64 __perf_evlist__combined_sample_type(struct perf_evlist *evlist)
1511
{
1512 1513 1514 1515 1516
	struct perf_evsel *evsel;

	if (evlist->combined_sample_type)
		return evlist->combined_sample_type;

1517
	evlist__for_each_entry(evlist, evsel)
1518 1519 1520 1521 1522 1523 1524 1525 1526
		evlist->combined_sample_type |= evsel->attr.sample_type;

	return evlist->combined_sample_type;
}

u64 perf_evlist__combined_sample_type(struct perf_evlist *evlist)
{
	evlist->combined_sample_type = 0;
	return __perf_evlist__combined_sample_type(evlist);
1527 1528
}

1529 1530 1531 1532 1533
u64 perf_evlist__combined_branch_type(struct perf_evlist *evlist)
{
	struct perf_evsel *evsel;
	u64 branch_type = 0;

1534
	evlist__for_each_entry(evlist, evsel)
1535 1536 1537 1538
		branch_type |= evsel->attr.branch_sample_type;
	return branch_type;
}

1539 1540 1541 1542 1543 1544
bool perf_evlist__valid_read_format(struct perf_evlist *evlist)
{
	struct perf_evsel *first = perf_evlist__first(evlist), *pos = first;
	u64 read_format = first->attr.read_format;
	u64 sample_type = first->attr.sample_type;

1545
	evlist__for_each_entry(evlist, pos) {
1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564
		if (read_format != pos->attr.read_format)
			return false;
	}

	/* PERF_SAMPLE_READ imples PERF_FORMAT_ID. */
	if ((sample_type & PERF_SAMPLE_READ) &&
	    !(read_format & PERF_FORMAT_ID)) {
		return false;
	}

	return true;
}

u64 perf_evlist__read_format(struct perf_evlist *evlist)
{
	struct perf_evsel *first = perf_evlist__first(evlist);
	return first->attr.read_format;
}

1565
u16 perf_evlist__id_hdr_size(struct perf_evlist *evlist)
1566
{
1567
	struct perf_evsel *first = perf_evlist__first(evlist);
1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590
	struct perf_sample *data;
	u64 sample_type;
	u16 size = 0;

	if (!first->attr.sample_id_all)
		goto out;

	sample_type = first->attr.sample_type;

	if (sample_type & PERF_SAMPLE_TID)
		size += sizeof(data->tid) * 2;

       if (sample_type & PERF_SAMPLE_TIME)
		size += sizeof(data->time);

	if (sample_type & PERF_SAMPLE_ID)
		size += sizeof(data->id);

	if (sample_type & PERF_SAMPLE_STREAM_ID)
		size += sizeof(data->stream_id);

	if (sample_type & PERF_SAMPLE_CPU)
		size += sizeof(data->cpu) * 2;
1591 1592 1593

	if (sample_type & PERF_SAMPLE_IDENTIFIER)
		size += sizeof(data->id);
1594 1595 1596 1597
out:
	return size;
}

1598
bool perf_evlist__valid_sample_id_all(struct perf_evlist *evlist)
1599
{
1600
	struct perf_evsel *first = perf_evlist__first(evlist), *pos = first;
1601

1602
	evlist__for_each_entry_continue(evlist, pos) {
1603 1604
		if (first->attr.sample_id_all != pos->attr.sample_id_all)
			return false;
1605 1606
	}

1607 1608 1609
	return true;
}

1610
bool perf_evlist__sample_id_all(struct perf_evlist *evlist)
1611
{
1612
	struct perf_evsel *first = perf_evlist__first(evlist);
1613
	return first->attr.sample_id_all;
1614
}
1615 1616 1617 1618 1619 1620

void perf_evlist__set_selected(struct perf_evlist *evlist,
			       struct perf_evsel *evsel)
{
	evlist->selected = evsel;
}
1621

1622 1623 1624 1625 1626 1627
void perf_evlist__close(struct perf_evlist *evlist)
{
	struct perf_evsel *evsel;
	int ncpus = cpu_map__nr(evlist->cpus);
	int nthreads = thread_map__nr(evlist->threads);

1628
	evlist__for_each_entry_reverse(evlist, evsel) {
1629
		int n = evsel->cpus ? evsel->cpus->nr : ncpus;
1630 1631
		perf_evsel__close(evsel, n, nthreads);
	}
1632 1633
}

1634 1635
static int perf_evlist__create_syswide_maps(struct perf_evlist *evlist)
{
1636 1637
	struct cpu_map	  *cpus;
	struct thread_map *threads;
1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648
	int err = -ENOMEM;

	/*
	 * Try reading /sys/devices/system/cpu/online to get
	 * an all cpus map.
	 *
	 * FIXME: -ENOMEM is the best we can do here, the cpu_map
	 * code needs an overhaul to properly forward the
	 * error, and we may not want to do that fallback to a
	 * default cpu identity map :-\
	 */
1649 1650
	cpus = cpu_map__new(NULL);
	if (!cpus)
1651 1652
		goto out;

1653 1654 1655
	threads = thread_map__new_dummy();
	if (!threads)
		goto out_put;
1656

1657
	perf_evlist__set_maps(evlist, cpus, threads);
1658 1659
out:
	return err;
1660 1661
out_put:
	cpu_map__put(cpus);
1662 1663 1664
	goto out;
}

1665
int perf_evlist__open(struct perf_evlist *evlist)
1666
{
1667
	struct perf_evsel *evsel;
1668
	int err;
1669

1670 1671 1672 1673 1674 1675 1676 1677 1678 1679
	/*
	 * Default: one fd per CPU, all threads, aka systemwide
	 * as sys_perf_event_open(cpu = -1, thread = -1) is EINVAL
	 */
	if (evlist->threads == NULL && evlist->cpus == NULL) {
		err = perf_evlist__create_syswide_maps(evlist);
		if (err < 0)
			goto out_err;
	}

1680 1681
	perf_evlist__update_id_pos(evlist);

1682
	evlist__for_each_entry(evlist, evsel) {
1683
		err = perf_evsel__open(evsel, evsel->cpus, evsel->threads);
1684 1685 1686 1687 1688 1689
		if (err < 0)
			goto out_err;
	}

	return 0;
out_err:
1690
	perf_evlist__close(evlist);
1691
	errno = -err;
1692 1693
	return err;
}
1694

1695
int perf_evlist__prepare_workload(struct perf_evlist *evlist, struct target *target,
1696
				  const char *argv[], bool pipe_output,
1697
				  void (*exec_error)(int signo, siginfo_t *info, void *ucontext))
1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718
{
	int child_ready_pipe[2], go_pipe[2];
	char bf;

	if (pipe(child_ready_pipe) < 0) {
		perror("failed to create 'ready' pipe");
		return -1;
	}

	if (pipe(go_pipe) < 0) {
		perror("failed to create 'go' pipe");
		goto out_close_ready_pipe;
	}

	evlist->workload.pid = fork();
	if (evlist->workload.pid < 0) {
		perror("failed to fork");
		goto out_close_pipes;
	}

	if (!evlist->workload.pid) {
1719 1720
		int ret;

1721
		if (pipe_output)
1722 1723
			dup2(2, 1);

1724 1725
		signal(SIGTERM, SIG_DFL);

1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737
		close(child_ready_pipe[0]);
		close(go_pipe[1]);
		fcntl(go_pipe[0], F_SETFD, FD_CLOEXEC);

		/*
		 * Tell the parent we're ready to go
		 */
		close(child_ready_pipe[1]);

		/*
		 * Wait until the parent tells us to go.
		 */
1738 1739 1740 1741 1742 1743
		ret = read(go_pipe[0], &bf, 1);
		/*
		 * The parent will ask for the execvp() to be performed by
		 * writing exactly one byte, in workload.cork_fd, usually via
		 * perf_evlist__start_workload().
		 *
1744
		 * For cancelling the workload without actually running it,
1745 1746 1747 1748 1749 1750 1751 1752 1753
		 * the parent will just close workload.cork_fd, without writing
		 * anything, i.e. read will return zero and we just exit()
		 * here.
		 */
		if (ret != 1) {
			if (ret == -1)
				perror("unable to read pipe");
			exit(ret);
		}
1754 1755 1756

		execvp(argv[0], (char **)argv);

1757
		if (exec_error) {
1758 1759 1760 1761 1762 1763 1764
			union sigval val;

			val.sival_int = errno;
			if (sigqueue(getppid(), SIGUSR1, val))
				perror(argv[0]);
		} else
			perror(argv[0]);
1765 1766 1767
		exit(-1);
	}

1768 1769 1770 1771 1772 1773 1774 1775
	if (exec_error) {
		struct sigaction act = {
			.sa_flags     = SA_SIGINFO,
			.sa_sigaction = exec_error,
		};
		sigaction(SIGUSR1, &act, NULL);
	}

1776 1777 1778 1779 1780 1781
	if (target__none(target)) {
		if (evlist->threads == NULL) {
			fprintf(stderr, "FATAL: evlist->threads need to be set at this point (%s:%d).\n",
				__func__, __LINE__);
			goto out_close_pipes;
		}
1782
		thread_map__set_pid(evlist->threads, 0, evlist->workload.pid);
1783
	}
1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794

	close(child_ready_pipe[1]);
	close(go_pipe[0]);
	/*
	 * wait for child to settle
	 */
	if (read(child_ready_pipe[0], &bf, 1) == -1) {
		perror("unable to read pipe");
		goto out_close_pipes;
	}

1795
	fcntl(go_pipe[1], F_SETFD, FD_CLOEXEC);
1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811
	evlist->workload.cork_fd = go_pipe[1];
	close(child_ready_pipe[0]);
	return 0;

out_close_pipes:
	close(go_pipe[0]);
	close(go_pipe[1]);
out_close_ready_pipe:
	close(child_ready_pipe[0]);
	close(child_ready_pipe[1]);
	return -1;
}

int perf_evlist__start_workload(struct perf_evlist *evlist)
{
	if (evlist->workload.cork_fd > 0) {
1812
		char bf = 0;
1813
		int ret;
1814 1815 1816
		/*
		 * Remove the cork, let it rip!
		 */
1817 1818
		ret = write(evlist->workload.cork_fd, &bf, 1);
		if (ret < 0)
1819
			perror("unable to write to pipe");
1820 1821 1822

		close(evlist->workload.cork_fd);
		return ret;
1823 1824 1825 1826
	}

	return 0;
}
1827

1828
int perf_evlist__parse_sample(struct perf_evlist *evlist, union perf_event *event,
1829
			      struct perf_sample *sample)
1830
{
1831 1832 1833 1834
	struct perf_evsel *evsel = perf_evlist__event2evsel(evlist, event);

	if (!evsel)
		return -EFAULT;
1835
	return perf_evsel__parse_sample(evsel, event, sample);
1836
}
1837 1838 1839 1840 1841 1842

size_t perf_evlist__fprintf(struct perf_evlist *evlist, FILE *fp)
{
	struct perf_evsel *evsel;
	size_t printed = 0;

1843
	evlist__for_each_entry(evlist, evsel) {
1844 1845 1846 1847
		printed += fprintf(fp, "%s%s", evsel->idx ? ", " : "",
				   perf_evsel__name(evsel));
	}

1848
	return printed + fprintf(fp, "\n");
1849
}
1850

1851
int perf_evlist__strerror_open(struct perf_evlist *evlist,
1852 1853 1854
			       int err, char *buf, size_t size)
{
	int printed, value;
1855
	char sbuf[STRERR_BUFSIZE], *emsg = str_error_r(err, sbuf, sizeof(sbuf));
1856 1857 1858 1859 1860 1861 1862 1863

	switch (err) {
	case EACCES:
	case EPERM:
		printed = scnprintf(buf, size,
				    "Error:\t%s.\n"
				    "Hint:\tCheck /proc/sys/kernel/perf_event_paranoid setting.", emsg);

1864
		value = perf_event_paranoid();
1865 1866 1867 1868 1869 1870 1871 1872

		printed += scnprintf(buf + printed, size - printed, "\nHint:\t");

		if (value >= 2) {
			printed += scnprintf(buf + printed, size - printed,
					     "For your workloads it needs to be <= 1\nHint:\t");
		}
		printed += scnprintf(buf + printed, size - printed,
1873
				     "For system wide tracing it needs to be set to -1.\n");
1874 1875

		printed += scnprintf(buf + printed, size - printed,
1876 1877
				    "Hint:\tTry: 'sudo sh -c \"echo -1 > /proc/sys/kernel/perf_event_paranoid\"'\n"
				    "Hint:\tThe current value is %d.", value);
1878
		break;
1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895
	case EINVAL: {
		struct perf_evsel *first = perf_evlist__first(evlist);
		int max_freq;

		if (sysctl__read_int("kernel/perf_event_max_sample_rate", &max_freq) < 0)
			goto out_default;

		if (first->attr.sample_freq < (u64)max_freq)
			goto out_default;

		printed = scnprintf(buf, size,
				    "Error:\t%s.\n"
				    "Hint:\tCheck /proc/sys/kernel/perf_event_max_sample_rate.\n"
				    "Hint:\tThe current value is %d and %" PRIu64 " is being requested.",
				    emsg, max_freq, first->attr.sample_freq);
		break;
	}
1896
	default:
1897
out_default:
1898 1899 1900 1901 1902 1903
		scnprintf(buf, size, "%s", emsg);
		break;
	}

	return 0;
}
1904

1905 1906
int perf_evlist__strerror_mmap(struct perf_evlist *evlist, int err, char *buf, size_t size)
{
1907
	char sbuf[STRERR_BUFSIZE], *emsg = str_error_r(err, sbuf, sizeof(sbuf));
1908
	int pages_attempted = evlist->mmap_len / 1024, pages_max_per_user, printed = 0;
1909 1910 1911

	switch (err) {
	case EPERM:
1912
		sysctl__read_int("kernel/perf_event_mlock_kb", &pages_max_per_user);
1913 1914
		printed += scnprintf(buf + printed, size - printed,
				     "Error:\t%s.\n"
1915
				     "Hint:\tCheck /proc/sys/kernel/perf_event_mlock_kb (%d kB) setting.\n"
1916
				     "Hint:\tTried using %zd kB.\n",
1917
				     emsg, pages_max_per_user, pages_attempted);
1918 1919 1920 1921 1922 1923 1924 1925 1926

		if (pages_attempted >= pages_max_per_user) {
			printed += scnprintf(buf + printed, size - printed,
					     "Hint:\tTry 'sudo sh -c \"echo %d > /proc/sys/kernel/perf_event_mlock_kb\"', or\n",
					     pages_max_per_user + pages_attempted);
		}

		printed += scnprintf(buf + printed, size - printed,
				     "Hint:\tTry using a smaller -m/--mmap-pages value.");
1927 1928 1929 1930 1931 1932 1933 1934 1935
		break;
	default:
		scnprintf(buf, size, "%s", emsg);
		break;
	}

	return 0;
}

1936 1937 1938 1939 1940 1941 1942 1943 1944
void perf_evlist__to_front(struct perf_evlist *evlist,
			   struct perf_evsel *move_evsel)
{
	struct perf_evsel *evsel, *n;
	LIST_HEAD(move);

	if (move_evsel == perf_evlist__first(evlist))
		return;

1945
	evlist__for_each_entry_safe(evlist, n, evsel) {
1946 1947 1948 1949 1950 1951
		if (evsel->leader == move_evsel->leader)
			list_move_tail(&evsel->node, &move);
	}

	list_splice(&move, &evlist->entries);
}
1952 1953 1954 1955 1956 1957 1958 1959 1960

void perf_evlist__set_tracking_event(struct perf_evlist *evlist,
				     struct perf_evsel *tracking_evsel)
{
	struct perf_evsel *evsel;

	if (tracking_evsel->tracking)
		return;

1961
	evlist__for_each_entry(evlist, evsel) {
1962 1963 1964 1965 1966 1967
		if (evsel != tracking_evsel)
			evsel->tracking = false;
	}

	tracking_evsel->tracking = true;
}
1968 1969 1970 1971 1972 1973 1974

struct perf_evsel *
perf_evlist__find_evsel_by_str(struct perf_evlist *evlist,
			       const char *str)
{
	struct perf_evsel *evsel;

1975
	evlist__for_each_entry(evlist, evsel) {
1976 1977 1978 1979 1980 1981 1982 1983
		if (!evsel->name)
			continue;
		if (strcmp(str, evsel->name) == 0)
			return evsel;
	}

	return NULL;
}
1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041

void perf_evlist__toggle_bkw_mmap(struct perf_evlist *evlist,
				  enum bkw_mmap_state state)
{
	enum bkw_mmap_state old_state = evlist->bkw_mmap_state;
	enum action {
		NONE,
		PAUSE,
		RESUME,
	} action = NONE;

	if (!evlist->backward_mmap)
		return;

	switch (old_state) {
	case BKW_MMAP_NOTREADY: {
		if (state != BKW_MMAP_RUNNING)
			goto state_err;;
		break;
	}
	case BKW_MMAP_RUNNING: {
		if (state != BKW_MMAP_DATA_PENDING)
			goto state_err;
		action = PAUSE;
		break;
	}
	case BKW_MMAP_DATA_PENDING: {
		if (state != BKW_MMAP_EMPTY)
			goto state_err;
		break;
	}
	case BKW_MMAP_EMPTY: {
		if (state != BKW_MMAP_RUNNING)
			goto state_err;
		action = RESUME;
		break;
	}
	default:
		WARN_ONCE(1, "Shouldn't get there\n");
	}

	evlist->bkw_mmap_state = state;

	switch (action) {
	case PAUSE:
		perf_evlist__pause(evlist);
		break;
	case RESUME:
		perf_evlist__resume(evlist);
		break;
	case NONE:
	default:
		break;
	}

state_err:
	return;
}