1 // SPDX-License-Identifier: GPL-2.0-only
3 * auxtrace.c: AUX area trace support
4 * Copyright (c) 2013-2015, Intel Corporation.
15 #include <linux/kernel.h>
16 #include <linux/perf_event.h>
17 #include <linux/types.h>
18 #include <linux/bitops.h>
19 #include <linux/log2.h>
20 #include <linux/string.h>
21 #include <linux/time64.h>
23 #include <sys/param.h>
26 #include <linux/list.h>
27 #include <linux/zalloc.h>
34 #include "evsel_config.h"
36 #include "util/perf_api_probe.h"
37 #include "util/synthetic-events.h"
38 #include "thread_map.h"
42 #include <linux/hash.h>
48 #include <subcmd/parse-options.h>
52 #include "intel-bts.h"
54 #include "s390-cpumsf.h"
55 #include "util/mmap.h"
57 #include <linux/ctype.h>
58 #include "symbol/kallsyms.h"
59 #include <internal/lib.h>
62 * Make a group from 'leader' to 'last', requiring that the events were not
63 * already grouped to a different leader.
65 static int evlist__regroup(struct evlist *evlist, struct evsel *leader, struct evsel *last)
70 if (!evsel__is_group_leader(leader))
74 evlist__for_each_entry(evlist, evsel) {
76 if (!(evsel__leader(evsel) == leader ||
77 (evsel__leader(evsel) == evsel &&
78 evsel->core.nr_members <= 1)))
80 } else if (evsel == leader) {
88 evlist__for_each_entry(evlist, evsel) {
90 if (!evsel__has_leader(evsel, leader)) {
91 evsel__set_leader(evsel, leader);
92 if (leader->core.nr_members < 1)
93 leader->core.nr_members = 1;
94 leader->core.nr_members += 1;
96 } else if (evsel == leader) {
106 static bool auxtrace__dont_decode(struct perf_session *session)
108 return !session->itrace_synth_opts ||
109 session->itrace_synth_opts->dont_decode;
112 int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
113 struct auxtrace_mmap_params *mp,
114 void *userpg, int fd)
116 struct perf_event_mmap_page *pc = userpg;
118 WARN_ONCE(mm->base, "Uninitialized auxtrace_mmap\n");
126 mm->cpu = mp->cpu.cpu;
128 if (!mp->len || !mp->mmap_needed) {
133 pc->aux_offset = mp->offset;
134 pc->aux_size = mp->len;
136 mm->base = mmap(NULL, mp->len, mp->prot, MAP_SHARED, fd, mp->offset);
137 if (mm->base == MAP_FAILED) {
138 pr_debug2("failed to mmap AUX area\n");
146 void auxtrace_mmap__munmap(struct auxtrace_mmap *mm)
149 munmap(mm->base, mm->len);
154 void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
155 off_t auxtrace_offset,
156 unsigned int auxtrace_pages,
157 bool auxtrace_overwrite)
159 if (auxtrace_pages) {
160 mp->offset = auxtrace_offset;
161 mp->len = auxtrace_pages * (size_t)page_size;
162 mp->mask = is_power_of_2(mp->len) ? mp->len - 1 : 0;
163 mp->prot = PROT_READ | (auxtrace_overwrite ? 0 : PROT_WRITE);
164 pr_debug2("AUX area mmap length %zu\n", mp->len);
170 void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
171 struct evlist *evlist,
172 struct evsel *evsel, int idx)
174 bool per_cpu = !perf_cpu_map__empty(evlist->core.user_requested_cpus);
176 mp->mmap_needed = evsel->needs_auxtrace_mmap;
178 if (!mp->mmap_needed)
184 mp->cpu = perf_cpu_map__cpu(evlist->core.all_cpus, idx);
185 if (evlist->core.threads)
186 mp->tid = perf_thread_map__pid(evlist->core.threads, 0);
191 mp->tid = perf_thread_map__pid(evlist->core.threads, idx);
195 #define AUXTRACE_INIT_NR_QUEUES 32
197 static struct auxtrace_queue *auxtrace_alloc_queue_array(unsigned int nr_queues)
199 struct auxtrace_queue *queue_array;
200 unsigned int max_nr_queues, i;
202 max_nr_queues = UINT_MAX / sizeof(struct auxtrace_queue);
203 if (nr_queues > max_nr_queues)
206 queue_array = calloc(nr_queues, sizeof(struct auxtrace_queue));
210 for (i = 0; i < nr_queues; i++) {
211 INIT_LIST_HEAD(&queue_array[i].head);
212 queue_array[i].priv = NULL;
218 int auxtrace_queues__init(struct auxtrace_queues *queues)
220 queues->nr_queues = AUXTRACE_INIT_NR_QUEUES;
221 queues->queue_array = auxtrace_alloc_queue_array(queues->nr_queues);
222 if (!queues->queue_array)
227 static int auxtrace_queues__grow(struct auxtrace_queues *queues,
228 unsigned int new_nr_queues)
230 unsigned int nr_queues = queues->nr_queues;
231 struct auxtrace_queue *queue_array;
235 nr_queues = AUXTRACE_INIT_NR_QUEUES;
237 while (nr_queues && nr_queues < new_nr_queues)
240 if (nr_queues < queues->nr_queues || nr_queues < new_nr_queues)
243 queue_array = auxtrace_alloc_queue_array(nr_queues);
247 for (i = 0; i < queues->nr_queues; i++) {
248 list_splice_tail(&queues->queue_array[i].head,
249 &queue_array[i].head);
250 queue_array[i].tid = queues->queue_array[i].tid;
251 queue_array[i].cpu = queues->queue_array[i].cpu;
252 queue_array[i].set = queues->queue_array[i].set;
253 queue_array[i].priv = queues->queue_array[i].priv;
256 queues->nr_queues = nr_queues;
257 queues->queue_array = queue_array;
262 static void *auxtrace_copy_data(u64 size, struct perf_session *session)
264 int fd = perf_data__fd(session->data);
268 if (size > SSIZE_MAX)
275 ret = readn(fd, p, size);
276 if (ret != (ssize_t)size) {
284 static int auxtrace_queues__queue_buffer(struct auxtrace_queues *queues,
286 struct auxtrace_buffer *buffer)
288 struct auxtrace_queue *queue;
291 if (idx >= queues->nr_queues) {
292 err = auxtrace_queues__grow(queues, idx + 1);
297 queue = &queues->queue_array[idx];
301 queue->tid = buffer->tid;
302 queue->cpu = buffer->cpu.cpu;
305 buffer->buffer_nr = queues->next_buffer_nr++;
307 list_add_tail(&buffer->list, &queue->head);
309 queues->new_data = true;
310 queues->populated = true;
315 /* Limit buffers to 32MiB on 32-bit */
316 #define BUFFER_LIMIT_FOR_32_BIT (32 * 1024 * 1024)
318 static int auxtrace_queues__split_buffer(struct auxtrace_queues *queues,
320 struct auxtrace_buffer *buffer)
322 u64 sz = buffer->size;
323 bool consecutive = false;
324 struct auxtrace_buffer *b;
327 while (sz > BUFFER_LIMIT_FOR_32_BIT) {
328 b = memdup(buffer, sizeof(struct auxtrace_buffer));
331 b->size = BUFFER_LIMIT_FOR_32_BIT;
332 b->consecutive = consecutive;
333 err = auxtrace_queues__queue_buffer(queues, idx, b);
335 auxtrace_buffer__free(b);
338 buffer->data_offset += BUFFER_LIMIT_FOR_32_BIT;
339 sz -= BUFFER_LIMIT_FOR_32_BIT;
344 buffer->consecutive = consecutive;
349 static bool filter_cpu(struct perf_session *session, struct perf_cpu cpu)
351 unsigned long *cpu_bitmap = session->itrace_synth_opts->cpu_bitmap;
353 return cpu_bitmap && cpu.cpu != -1 && !test_bit(cpu.cpu, cpu_bitmap);
356 static int auxtrace_queues__add_buffer(struct auxtrace_queues *queues,
357 struct perf_session *session,
359 struct auxtrace_buffer *buffer,
360 struct auxtrace_buffer **buffer_ptr)
364 if (filter_cpu(session, buffer->cpu))
367 buffer = memdup(buffer, sizeof(*buffer));
371 if (session->one_mmap) {
372 buffer->data = buffer->data_offset - session->one_mmap_offset +
373 session->one_mmap_addr;
374 } else if (perf_data__is_pipe(session->data)) {
375 buffer->data = auxtrace_copy_data(buffer->size, session);
378 buffer->data_needs_freeing = true;
379 } else if (BITS_PER_LONG == 32 &&
380 buffer->size > BUFFER_LIMIT_FOR_32_BIT) {
381 err = auxtrace_queues__split_buffer(queues, idx, buffer);
386 err = auxtrace_queues__queue_buffer(queues, idx, buffer);
390 /* FIXME: Doesn't work for split buffer */
392 *buffer_ptr = buffer;
397 auxtrace_buffer__free(buffer);
401 int auxtrace_queues__add_event(struct auxtrace_queues *queues,
402 struct perf_session *session,
403 union perf_event *event, off_t data_offset,
404 struct auxtrace_buffer **buffer_ptr)
406 struct auxtrace_buffer buffer = {
408 .tid = event->auxtrace.tid,
409 .cpu = { event->auxtrace.cpu },
410 .data_offset = data_offset,
411 .offset = event->auxtrace.offset,
412 .reference = event->auxtrace.reference,
413 .size = event->auxtrace.size,
415 unsigned int idx = event->auxtrace.idx;
417 return auxtrace_queues__add_buffer(queues, session, idx, &buffer,
421 static int auxtrace_queues__add_indexed_event(struct auxtrace_queues *queues,
422 struct perf_session *session,
423 off_t file_offset, size_t sz)
425 union perf_event *event;
427 char buf[PERF_SAMPLE_MAX_SIZE];
429 err = perf_session__peek_event(session, file_offset, buf,
430 PERF_SAMPLE_MAX_SIZE, &event, NULL);
434 if (event->header.type == PERF_RECORD_AUXTRACE) {
435 if (event->header.size < sizeof(struct perf_record_auxtrace) ||
436 event->header.size != sz) {
440 file_offset += event->header.size;
441 err = auxtrace_queues__add_event(queues, session, event,
448 void auxtrace_queues__free(struct auxtrace_queues *queues)
452 for (i = 0; i < queues->nr_queues; i++) {
453 while (!list_empty(&queues->queue_array[i].head)) {
454 struct auxtrace_buffer *buffer;
456 buffer = list_entry(queues->queue_array[i].head.next,
457 struct auxtrace_buffer, list);
458 list_del_init(&buffer->list);
459 auxtrace_buffer__free(buffer);
463 zfree(&queues->queue_array);
464 queues->nr_queues = 0;
467 static void auxtrace_heapify(struct auxtrace_heap_item *heap_array,
468 unsigned int pos, unsigned int queue_nr,
474 parent = (pos - 1) >> 1;
475 if (heap_array[parent].ordinal <= ordinal)
477 heap_array[pos] = heap_array[parent];
480 heap_array[pos].queue_nr = queue_nr;
481 heap_array[pos].ordinal = ordinal;
484 int auxtrace_heap__add(struct auxtrace_heap *heap, unsigned int queue_nr,
487 struct auxtrace_heap_item *heap_array;
489 if (queue_nr >= heap->heap_sz) {
490 unsigned int heap_sz = AUXTRACE_INIT_NR_QUEUES;
492 while (heap_sz <= queue_nr)
494 heap_array = realloc(heap->heap_array,
495 heap_sz * sizeof(struct auxtrace_heap_item));
498 heap->heap_array = heap_array;
499 heap->heap_sz = heap_sz;
502 auxtrace_heapify(heap->heap_array, heap->heap_cnt++, queue_nr, ordinal);
507 void auxtrace_heap__free(struct auxtrace_heap *heap)
509 zfree(&heap->heap_array);
514 void auxtrace_heap__pop(struct auxtrace_heap *heap)
516 unsigned int pos, last, heap_cnt = heap->heap_cnt;
517 struct auxtrace_heap_item *heap_array;
524 heap_array = heap->heap_array;
528 unsigned int left, right;
530 left = (pos << 1) + 1;
531 if (left >= heap_cnt)
534 if (right >= heap_cnt) {
535 heap_array[pos] = heap_array[left];
538 if (heap_array[left].ordinal < heap_array[right].ordinal) {
539 heap_array[pos] = heap_array[left];
542 heap_array[pos] = heap_array[right];
548 auxtrace_heapify(heap_array, pos, heap_array[last].queue_nr,
549 heap_array[last].ordinal);
552 size_t auxtrace_record__info_priv_size(struct auxtrace_record *itr,
553 struct evlist *evlist)
556 return itr->info_priv_size(itr, evlist);
560 static int auxtrace_not_supported(void)
562 pr_err("AUX area tracing is not supported on this architecture\n");
566 int auxtrace_record__info_fill(struct auxtrace_record *itr,
567 struct perf_session *session,
568 struct perf_record_auxtrace_info *auxtrace_info,
572 return itr->info_fill(itr, session, auxtrace_info, priv_size);
573 return auxtrace_not_supported();
576 void auxtrace_record__free(struct auxtrace_record *itr)
582 int auxtrace_record__snapshot_start(struct auxtrace_record *itr)
584 if (itr && itr->snapshot_start)
585 return itr->snapshot_start(itr);
589 int auxtrace_record__snapshot_finish(struct auxtrace_record *itr, bool on_exit)
591 if (!on_exit && itr && itr->snapshot_finish)
592 return itr->snapshot_finish(itr);
596 int auxtrace_record__find_snapshot(struct auxtrace_record *itr, int idx,
597 struct auxtrace_mmap *mm,
598 unsigned char *data, u64 *head, u64 *old)
600 if (itr && itr->find_snapshot)
601 return itr->find_snapshot(itr, idx, mm, data, head, old);
605 int auxtrace_record__options(struct auxtrace_record *itr,
606 struct evlist *evlist,
607 struct record_opts *opts)
610 itr->evlist = evlist;
611 return itr->recording_options(itr, evlist, opts);
616 u64 auxtrace_record__reference(struct auxtrace_record *itr)
619 return itr->reference(itr);
623 int auxtrace_parse_snapshot_options(struct auxtrace_record *itr,
624 struct record_opts *opts, const char *str)
629 /* PMU-agnostic options */
632 opts->auxtrace_snapshot_on_exit = true;
639 if (itr && itr->parse_snapshot_options)
640 return itr->parse_snapshot_options(itr, opts, str);
642 pr_err("No AUX area tracing to snapshot\n");
646 static int evlist__enable_event_idx(struct evlist *evlist, struct evsel *evsel, int idx)
648 bool per_cpu_mmaps = !perf_cpu_map__empty(evlist->core.user_requested_cpus);
651 struct perf_cpu evlist_cpu = perf_cpu_map__cpu(evlist->core.all_cpus, idx);
652 int cpu_map_idx = perf_cpu_map__idx(evsel->core.cpus, evlist_cpu);
654 if (cpu_map_idx == -1)
656 return perf_evsel__enable_cpu(&evsel->core, cpu_map_idx);
659 return perf_evsel__enable_thread(&evsel->core, idx);
662 int auxtrace_record__read_finish(struct auxtrace_record *itr, int idx)
666 if (!itr->evlist || !itr->pmu)
669 evlist__for_each_entry(itr->evlist, evsel) {
670 if (evsel->core.attr.type == itr->pmu->type) {
673 return evlist__enable_event_idx(itr->evlist, evsel, idx);
680 * Event record size is 16-bit which results in a maximum size of about 64KiB.
681 * Allow about 4KiB for the rest of the sample record, to give a maximum
682 * AUX area sample size of 60KiB.
684 #define MAX_AUX_SAMPLE_SIZE (60 * 1024)
686 /* Arbitrary default size if no other default provided */
687 #define DEFAULT_AUX_SAMPLE_SIZE (4 * 1024)
689 static int auxtrace_validate_aux_sample_size(struct evlist *evlist,
690 struct record_opts *opts)
693 bool has_aux_leader = false;
696 evlist__for_each_entry(evlist, evsel) {
697 sz = evsel->core.attr.aux_sample_size;
698 if (evsel__is_group_leader(evsel)) {
699 has_aux_leader = evsel__is_aux_event(evsel);
702 pr_err("Cannot add AUX area sampling to an AUX area event\n");
704 pr_err("Cannot add AUX area sampling to a group leader\n");
708 if (sz > MAX_AUX_SAMPLE_SIZE) {
709 pr_err("AUX area sample size %u too big, max. %d\n",
710 sz, MAX_AUX_SAMPLE_SIZE);
714 if (!has_aux_leader) {
715 pr_err("Cannot add AUX area sampling because group leader is not an AUX area event\n");
718 evsel__set_sample_bit(evsel, AUX);
719 opts->auxtrace_sample_mode = true;
721 evsel__reset_sample_bit(evsel, AUX);
725 if (!opts->auxtrace_sample_mode) {
726 pr_err("AUX area sampling requires an AUX area event group leader plus other events to which to add samples\n");
730 if (!perf_can_aux_sample()) {
731 pr_err("AUX area sampling is not supported by kernel\n");
738 int auxtrace_parse_sample_options(struct auxtrace_record *itr,
739 struct evlist *evlist,
740 struct record_opts *opts, const char *str)
742 struct evsel_config_term *term;
743 struct evsel *aux_evsel;
744 bool has_aux_sample_size = false;
745 bool has_aux_leader = false;
754 pr_err("No AUX area event to sample\n");
758 sz = strtoul(str, &endptr, 0);
759 if (*endptr || sz > UINT_MAX) {
760 pr_err("Bad AUX area sampling option: '%s'\n", str);
765 sz = itr->default_aux_sample_size;
768 sz = DEFAULT_AUX_SAMPLE_SIZE;
770 /* Set aux_sample_size based on --aux-sample option */
771 evlist__for_each_entry(evlist, evsel) {
772 if (evsel__is_group_leader(evsel)) {
773 has_aux_leader = evsel__is_aux_event(evsel);
774 } else if (has_aux_leader) {
775 evsel->core.attr.aux_sample_size = sz;
780 /* Override with aux_sample_size from config term */
781 evlist__for_each_entry(evlist, evsel) {
782 if (evsel__is_aux_event(evsel))
784 term = evsel__get_config_term(evsel, AUX_SAMPLE_SIZE);
786 has_aux_sample_size = true;
787 evsel->core.attr.aux_sample_size = term->val.aux_sample_size;
788 /* If possible, group with the AUX event */
789 if (aux_evsel && evsel->core.attr.aux_sample_size)
790 evlist__regroup(evlist, aux_evsel, evsel);
794 if (!str && !has_aux_sample_size)
798 pr_err("No AUX area event to sample\n");
802 return auxtrace_validate_aux_sample_size(evlist, opts);
805 void auxtrace_regroup_aux_output(struct evlist *evlist)
807 struct evsel *evsel, *aux_evsel = NULL;
808 struct evsel_config_term *term;
810 evlist__for_each_entry(evlist, evsel) {
811 if (evsel__is_aux_event(evsel))
813 term = evsel__get_config_term(evsel, AUX_OUTPUT);
814 /* If possible, group with the AUX event */
815 if (term && aux_evsel)
816 evlist__regroup(evlist, aux_evsel, evsel);
820 struct auxtrace_record *__weak
821 auxtrace_record__init(struct evlist *evlist __maybe_unused, int *err)
827 static int auxtrace_index__alloc(struct list_head *head)
829 struct auxtrace_index *auxtrace_index;
831 auxtrace_index = malloc(sizeof(struct auxtrace_index));
835 auxtrace_index->nr = 0;
836 INIT_LIST_HEAD(&auxtrace_index->list);
838 list_add_tail(&auxtrace_index->list, head);
843 void auxtrace_index__free(struct list_head *head)
845 struct auxtrace_index *auxtrace_index, *n;
847 list_for_each_entry_safe(auxtrace_index, n, head, list) {
848 list_del_init(&auxtrace_index->list);
849 free(auxtrace_index);
853 static struct auxtrace_index *auxtrace_index__last(struct list_head *head)
855 struct auxtrace_index *auxtrace_index;
858 if (list_empty(head)) {
859 err = auxtrace_index__alloc(head);
864 auxtrace_index = list_entry(head->prev, struct auxtrace_index, list);
866 if (auxtrace_index->nr >= PERF_AUXTRACE_INDEX_ENTRY_COUNT) {
867 err = auxtrace_index__alloc(head);
870 auxtrace_index = list_entry(head->prev, struct auxtrace_index,
874 return auxtrace_index;
877 int auxtrace_index__auxtrace_event(struct list_head *head,
878 union perf_event *event, off_t file_offset)
880 struct auxtrace_index *auxtrace_index;
883 auxtrace_index = auxtrace_index__last(head);
887 nr = auxtrace_index->nr;
888 auxtrace_index->entries[nr].file_offset = file_offset;
889 auxtrace_index->entries[nr].sz = event->header.size;
890 auxtrace_index->nr += 1;
895 static int auxtrace_index__do_write(int fd,
896 struct auxtrace_index *auxtrace_index)
898 struct auxtrace_index_entry ent;
901 for (i = 0; i < auxtrace_index->nr; i++) {
902 ent.file_offset = auxtrace_index->entries[i].file_offset;
903 ent.sz = auxtrace_index->entries[i].sz;
904 if (writen(fd, &ent, sizeof(ent)) != sizeof(ent))
910 int auxtrace_index__write(int fd, struct list_head *head)
912 struct auxtrace_index *auxtrace_index;
916 list_for_each_entry(auxtrace_index, head, list)
917 total += auxtrace_index->nr;
919 if (writen(fd, &total, sizeof(total)) != sizeof(total))
922 list_for_each_entry(auxtrace_index, head, list) {
923 err = auxtrace_index__do_write(fd, auxtrace_index);
931 static int auxtrace_index__process_entry(int fd, struct list_head *head,
934 struct auxtrace_index *auxtrace_index;
935 struct auxtrace_index_entry ent;
938 if (readn(fd, &ent, sizeof(ent)) != sizeof(ent))
941 auxtrace_index = auxtrace_index__last(head);
945 nr = auxtrace_index->nr;
947 auxtrace_index->entries[nr].file_offset =
948 bswap_64(ent.file_offset);
949 auxtrace_index->entries[nr].sz = bswap_64(ent.sz);
951 auxtrace_index->entries[nr].file_offset = ent.file_offset;
952 auxtrace_index->entries[nr].sz = ent.sz;
955 auxtrace_index->nr = nr + 1;
960 int auxtrace_index__process(int fd, u64 size, struct perf_session *session,
963 struct list_head *head = &session->auxtrace_index;
966 if (readn(fd, &nr, sizeof(u64)) != sizeof(u64))
972 if (sizeof(u64) + nr * sizeof(struct auxtrace_index_entry) > size)
978 err = auxtrace_index__process_entry(fd, head, needs_swap);
986 static int auxtrace_queues__process_index_entry(struct auxtrace_queues *queues,
987 struct perf_session *session,
988 struct auxtrace_index_entry *ent)
990 return auxtrace_queues__add_indexed_event(queues, session,
991 ent->file_offset, ent->sz);
994 int auxtrace_queues__process_index(struct auxtrace_queues *queues,
995 struct perf_session *session)
997 struct auxtrace_index *auxtrace_index;
998 struct auxtrace_index_entry *ent;
1002 if (auxtrace__dont_decode(session))
1005 list_for_each_entry(auxtrace_index, &session->auxtrace_index, list) {
1006 for (i = 0; i < auxtrace_index->nr; i++) {
1007 ent = &auxtrace_index->entries[i];
1008 err = auxtrace_queues__process_index_entry(queues,
1018 struct auxtrace_buffer *auxtrace_buffer__next(struct auxtrace_queue *queue,
1019 struct auxtrace_buffer *buffer)
1022 if (list_is_last(&buffer->list, &queue->head))
1024 return list_entry(buffer->list.next, struct auxtrace_buffer,
1027 if (list_empty(&queue->head))
1029 return list_entry(queue->head.next, struct auxtrace_buffer,
1034 struct auxtrace_queue *auxtrace_queues__sample_queue(struct auxtrace_queues *queues,
1035 struct perf_sample *sample,
1036 struct perf_session *session)
1038 struct perf_sample_id *sid;
1046 sid = evlist__id2sid(session->evlist, id);
1052 if (idx >= queues->nr_queues)
1055 return &queues->queue_array[idx];
1058 int auxtrace_queues__add_sample(struct auxtrace_queues *queues,
1059 struct perf_session *session,
1060 struct perf_sample *sample, u64 data_offset,
1063 struct auxtrace_buffer buffer = {
1065 .data_offset = data_offset,
1066 .reference = reference,
1067 .size = sample->aux_sample.size,
1069 struct perf_sample_id *sid;
1070 u64 id = sample->id;
1076 sid = evlist__id2sid(session->evlist, id);
1081 buffer.tid = sid->tid;
1082 buffer.cpu = sid->cpu;
1084 return auxtrace_queues__add_buffer(queues, session, idx, &buffer, NULL);
1092 static int auxtrace_queue_data_cb(struct perf_session *session,
1093 union perf_event *event, u64 offset,
1096 struct queue_data *qd = data;
1097 struct perf_sample sample;
1100 if (qd->events && event->header.type == PERF_RECORD_AUXTRACE) {
1101 if (event->header.size < sizeof(struct perf_record_auxtrace))
1103 offset += event->header.size;
1104 return session->auxtrace->queue_data(session, NULL, event,
1108 if (!qd->samples || event->header.type != PERF_RECORD_SAMPLE)
1111 err = evlist__parse_sample(session->evlist, event, &sample);
1115 if (!sample.aux_sample.size)
1118 offset += sample.aux_sample.data - (void *)event;
1120 return session->auxtrace->queue_data(session, &sample, NULL, offset);
1123 int auxtrace_queue_data(struct perf_session *session, bool samples, bool events)
1125 struct queue_data qd = {
1130 if (auxtrace__dont_decode(session))
1133 if (!session->auxtrace || !session->auxtrace->queue_data)
1136 return perf_session__peek_events(session, session->header.data_offset,
1137 session->header.data_size,
1138 auxtrace_queue_data_cb, &qd);
1141 void *auxtrace_buffer__get_data_rw(struct auxtrace_buffer *buffer, int fd, bool rw)
1143 int prot = rw ? PROT_READ | PROT_WRITE : PROT_READ;
1144 size_t adj = buffer->data_offset & (page_size - 1);
1145 size_t size = buffer->size + adj;
1146 off_t file_offset = buffer->data_offset - adj;
1150 return buffer->data;
1152 addr = mmap(NULL, size, prot, MAP_SHARED, fd, file_offset);
1153 if (addr == MAP_FAILED)
1156 buffer->mmap_addr = addr;
1157 buffer->mmap_size = size;
1159 buffer->data = addr + adj;
1161 return buffer->data;
1164 void auxtrace_buffer__put_data(struct auxtrace_buffer *buffer)
1166 if (!buffer->data || !buffer->mmap_addr)
1168 munmap(buffer->mmap_addr, buffer->mmap_size);
1169 buffer->mmap_addr = NULL;
1170 buffer->mmap_size = 0;
1171 buffer->data = NULL;
1172 buffer->use_data = NULL;
1175 void auxtrace_buffer__drop_data(struct auxtrace_buffer *buffer)
1177 auxtrace_buffer__put_data(buffer);
1178 if (buffer->data_needs_freeing) {
1179 buffer->data_needs_freeing = false;
1180 zfree(&buffer->data);
1181 buffer->use_data = NULL;
1186 void auxtrace_buffer__free(struct auxtrace_buffer *buffer)
1188 auxtrace_buffer__drop_data(buffer);
1192 void auxtrace_synth_error(struct perf_record_auxtrace_error *auxtrace_error, int type,
1193 int code, int cpu, pid_t pid, pid_t tid, u64 ip,
1194 const char *msg, u64 timestamp)
1198 memset(auxtrace_error, 0, sizeof(struct perf_record_auxtrace_error));
1200 auxtrace_error->header.type = PERF_RECORD_AUXTRACE_ERROR;
1201 auxtrace_error->type = type;
1202 auxtrace_error->code = code;
1203 auxtrace_error->cpu = cpu;
1204 auxtrace_error->pid = pid;
1205 auxtrace_error->tid = tid;
1206 auxtrace_error->fmt = 1;
1207 auxtrace_error->ip = ip;
1208 auxtrace_error->time = timestamp;
1209 strlcpy(auxtrace_error->msg, msg, MAX_AUXTRACE_ERROR_MSG);
1211 size = (void *)auxtrace_error->msg - (void *)auxtrace_error +
1212 strlen(auxtrace_error->msg) + 1;
1213 auxtrace_error->header.size = PERF_ALIGN(size, sizeof(u64));
1216 int perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr,
1217 struct perf_tool *tool,
1218 struct perf_session *session,
1219 perf_event__handler_t process)
1221 union perf_event *ev;
1225 pr_debug2("Synthesizing auxtrace information\n");
1226 priv_size = auxtrace_record__info_priv_size(itr, session->evlist);
1227 ev = zalloc(sizeof(struct perf_record_auxtrace_info) + priv_size);
1231 ev->auxtrace_info.header.type = PERF_RECORD_AUXTRACE_INFO;
1232 ev->auxtrace_info.header.size = sizeof(struct perf_record_auxtrace_info) +
1234 err = auxtrace_record__info_fill(itr, session, &ev->auxtrace_info,
1239 err = process(tool, ev, NULL, NULL);
1245 static void unleader_evsel(struct evlist *evlist, struct evsel *leader)
1247 struct evsel *new_leader = NULL;
1248 struct evsel *evsel;
1250 /* Find new leader for the group */
1251 evlist__for_each_entry(evlist, evsel) {
1252 if (!evsel__has_leader(evsel, leader) || evsel == leader)
1256 evsel__set_leader(evsel, new_leader);
1259 /* Update group information */
1261 zfree(&new_leader->group_name);
1262 new_leader->group_name = leader->group_name;
1263 leader->group_name = NULL;
1265 new_leader->core.nr_members = leader->core.nr_members - 1;
1266 leader->core.nr_members = 1;
1270 static void unleader_auxtrace(struct perf_session *session)
1272 struct evsel *evsel;
1274 evlist__for_each_entry(session->evlist, evsel) {
1275 if (auxtrace__evsel_is_auxtrace(session, evsel) &&
1276 evsel__is_group_leader(evsel)) {
1277 unleader_evsel(session->evlist, evsel);
1282 int perf_event__process_auxtrace_info(struct perf_session *session,
1283 union perf_event *event)
1285 enum auxtrace_type type = event->auxtrace_info.type;
1289 fprintf(stdout, " type: %u\n", type);
1292 case PERF_AUXTRACE_INTEL_PT:
1293 err = intel_pt_process_auxtrace_info(event, session);
1295 case PERF_AUXTRACE_INTEL_BTS:
1296 err = intel_bts_process_auxtrace_info(event, session);
1298 case PERF_AUXTRACE_ARM_SPE:
1299 err = arm_spe_process_auxtrace_info(event, session);
1301 case PERF_AUXTRACE_CS_ETM:
1302 err = cs_etm__process_auxtrace_info(event, session);
1304 case PERF_AUXTRACE_S390_CPUMSF:
1305 err = s390_cpumsf_process_auxtrace_info(event, session);
1307 case PERF_AUXTRACE_UNKNOWN:
1315 unleader_auxtrace(session);
1320 s64 perf_event__process_auxtrace(struct perf_session *session,
1321 union perf_event *event)
1326 fprintf(stdout, " size: %#"PRI_lx64" offset: %#"PRI_lx64" ref: %#"PRI_lx64" idx: %u tid: %d cpu: %d\n",
1327 event->auxtrace.size, event->auxtrace.offset,
1328 event->auxtrace.reference, event->auxtrace.idx,
1329 event->auxtrace.tid, event->auxtrace.cpu);
1331 if (auxtrace__dont_decode(session))
1332 return event->auxtrace.size;
1334 if (!session->auxtrace || event->header.type != PERF_RECORD_AUXTRACE)
1337 err = session->auxtrace->process_auxtrace_event(session, event, session->tool);
1341 return event->auxtrace.size;
1344 #define PERF_ITRACE_DEFAULT_PERIOD_TYPE PERF_ITRACE_PERIOD_NANOSECS
1345 #define PERF_ITRACE_DEFAULT_PERIOD 100000
1346 #define PERF_ITRACE_DEFAULT_CALLCHAIN_SZ 16
1347 #define PERF_ITRACE_MAX_CALLCHAIN_SZ 1024
1348 #define PERF_ITRACE_DEFAULT_LAST_BRANCH_SZ 64
1349 #define PERF_ITRACE_MAX_LAST_BRANCH_SZ 1024
1351 void itrace_synth_opts__set_default(struct itrace_synth_opts *synth_opts,
1354 synth_opts->branches = true;
1355 synth_opts->transactions = true;
1356 synth_opts->ptwrites = true;
1357 synth_opts->pwr_events = true;
1358 synth_opts->other_events = true;
1359 synth_opts->intr_events = true;
1360 synth_opts->errors = true;
1361 synth_opts->flc = true;
1362 synth_opts->llc = true;
1363 synth_opts->tlb = true;
1364 synth_opts->mem = true;
1365 synth_opts->remote_access = true;
1368 synth_opts->period_type = PERF_ITRACE_PERIOD_INSTRUCTIONS;
1369 synth_opts->period = 1;
1370 synth_opts->calls = true;
1372 synth_opts->instructions = true;
1373 synth_opts->period_type = PERF_ITRACE_DEFAULT_PERIOD_TYPE;
1374 synth_opts->period = PERF_ITRACE_DEFAULT_PERIOD;
1376 synth_opts->callchain_sz = PERF_ITRACE_DEFAULT_CALLCHAIN_SZ;
1377 synth_opts->last_branch_sz = PERF_ITRACE_DEFAULT_LAST_BRANCH_SZ;
1378 synth_opts->initial_skip = 0;
1381 static int get_flag(const char **ptr, unsigned int *flags)
1386 if (c >= 'a' && c <= 'z') {
1387 *flags |= 1 << (c - 'a');
1390 } else if (c == ' ') {
1399 static int get_flags(const char **ptr, unsigned int *plus_flags, unsigned int *minus_flags)
1405 if (get_flag(ptr, plus_flags))
1410 if (get_flag(ptr, minus_flags))
1423 * Please check tools/perf/Documentation/perf-script.txt for information
1424 * about the options parsed here, which is introduced after this cset,
1425 * when support in 'perf script' for these options is introduced.
1427 int itrace_do_parse_synth_opts(struct itrace_synth_opts *synth_opts,
1428 const char *str, int unset)
1432 bool period_type_set = false;
1433 bool period_set = false;
1435 synth_opts->set = true;
1438 synth_opts->dont_decode = true;
1443 itrace_synth_opts__set_default(synth_opts,
1444 synth_opts->default_no_sample);
1448 for (p = str; *p;) {
1451 synth_opts->instructions = true;
1452 while (*p == ' ' || *p == ',')
1455 synth_opts->period = strtoull(p, &endptr, 10);
1458 while (*p == ' ' || *p == ',')
1462 synth_opts->period_type =
1463 PERF_ITRACE_PERIOD_INSTRUCTIONS;
1464 period_type_set = true;
1467 synth_opts->period_type =
1468 PERF_ITRACE_PERIOD_TICKS;
1469 period_type_set = true;
1472 synth_opts->period *= 1000;
1475 synth_opts->period *= 1000;
1480 synth_opts->period_type =
1481 PERF_ITRACE_PERIOD_NANOSECS;
1482 period_type_set = true;
1492 synth_opts->branches = true;
1495 synth_opts->transactions = true;
1498 synth_opts->ptwrites = true;
1501 synth_opts->pwr_events = true;
1504 synth_opts->other_events = true;
1507 synth_opts->intr_events = true;
1510 synth_opts->errors = true;
1511 if (get_flags(&p, &synth_opts->error_plus_flags,
1512 &synth_opts->error_minus_flags))
1516 synth_opts->log = true;
1517 if (get_flags(&p, &synth_opts->log_plus_flags,
1518 &synth_opts->log_minus_flags))
1522 synth_opts->branches = true;
1523 synth_opts->calls = true;
1526 synth_opts->branches = true;
1527 synth_opts->returns = true;
1532 synth_opts->add_callchain = true;
1534 synth_opts->callchain = true;
1535 synth_opts->callchain_sz =
1536 PERF_ITRACE_DEFAULT_CALLCHAIN_SZ;
1537 while (*p == ' ' || *p == ',')
1542 val = strtoul(p, &endptr, 10);
1544 if (!val || val > PERF_ITRACE_MAX_CALLCHAIN_SZ)
1546 synth_opts->callchain_sz = val;
1552 synth_opts->add_last_branch = true;
1554 synth_opts->last_branch = true;
1555 synth_opts->last_branch_sz =
1556 PERF_ITRACE_DEFAULT_LAST_BRANCH_SZ;
1557 while (*p == ' ' || *p == ',')
1562 val = strtoul(p, &endptr, 10);
1565 val > PERF_ITRACE_MAX_LAST_BRANCH_SZ)
1567 synth_opts->last_branch_sz = val;
1571 synth_opts->initial_skip = strtoul(p, &endptr, 10);
1577 synth_opts->flc = true;
1580 synth_opts->llc = true;
1583 synth_opts->tlb = true;
1586 synth_opts->remote_access = true;
1589 synth_opts->mem = true;
1592 synth_opts->quick += 1;
1595 synth_opts->approx_ipc = true;
1598 synth_opts->timeless_decoding = true;
1608 if (synth_opts->instructions) {
1609 if (!period_type_set)
1610 synth_opts->period_type =
1611 PERF_ITRACE_DEFAULT_PERIOD_TYPE;
1613 synth_opts->period = PERF_ITRACE_DEFAULT_PERIOD;
1619 pr_err("Bad Instruction Tracing options '%s'\n", str);
1623 int itrace_parse_synth_opts(const struct option *opt, const char *str, int unset)
1625 return itrace_do_parse_synth_opts(opt->value, str, unset);
1628 static const char * const auxtrace_error_type_name[] = {
1629 [PERF_AUXTRACE_ERROR_ITRACE] = "instruction trace",
1632 static const char *auxtrace_error_name(int type)
1634 const char *error_type_name = NULL;
1636 if (type < PERF_AUXTRACE_ERROR_MAX)
1637 error_type_name = auxtrace_error_type_name[type];
1638 if (!error_type_name)
1639 error_type_name = "unknown AUX";
1640 return error_type_name;
1643 size_t perf_event__fprintf_auxtrace_error(union perf_event *event, FILE *fp)
1645 struct perf_record_auxtrace_error *e = &event->auxtrace_error;
1646 unsigned long long nsecs = e->time;
1647 const char *msg = e->msg;
1650 ret = fprintf(fp, " %s error type %u",
1651 auxtrace_error_name(e->type), e->type);
1653 if (e->fmt && nsecs) {
1654 unsigned long secs = nsecs / NSEC_PER_SEC;
1656 nsecs -= secs * NSEC_PER_SEC;
1657 ret += fprintf(fp, " time %lu.%09llu", secs, nsecs);
1659 ret += fprintf(fp, " time 0");
1663 msg = (const char *)&e->time;
1665 ret += fprintf(fp, " cpu %d pid %d tid %d ip %#"PRI_lx64" code %u: %s\n",
1666 e->cpu, e->pid, e->tid, e->ip, e->code, msg);
1670 void perf_session__auxtrace_error_inc(struct perf_session *session,
1671 union perf_event *event)
1673 struct perf_record_auxtrace_error *e = &event->auxtrace_error;
1675 if (e->type < PERF_AUXTRACE_ERROR_MAX)
1676 session->evlist->stats.nr_auxtrace_errors[e->type] += 1;
1679 void events_stats__auxtrace_error_warn(const struct events_stats *stats)
1683 for (i = 0; i < PERF_AUXTRACE_ERROR_MAX; i++) {
1684 if (!stats->nr_auxtrace_errors[i])
1686 ui__warning("%u %s errors\n",
1687 stats->nr_auxtrace_errors[i],
1688 auxtrace_error_name(i));
1692 int perf_event__process_auxtrace_error(struct perf_session *session,
1693 union perf_event *event)
1695 if (auxtrace__dont_decode(session))
1698 perf_event__fprintf_auxtrace_error(event, stdout);
1703 * In the compat mode kernel runs in 64-bit and perf tool runs in 32-bit mode,
1704 * 32-bit perf tool cannot access 64-bit value atomically, which might lead to
1705 * the issues caused by the below sequence on multiple CPUs: when perf tool
1706 * accesses either the load operation or the store operation for 64-bit value,
1707 * on some architectures the operation is divided into two instructions, one
1708 * is for accessing the low 32-bit value and another is for the high 32-bit;
1709 * thus these two user operations can give the kernel chances to access the
1710 * 64-bit value, and thus leads to the unexpected load values.
1712 * kernel (64-bit) user (32-bit)
1714 * if (LOAD ->aux_tail) { --, LOAD ->aux_head_lo
1715 * STORE $aux_data | ,--->
1716 * FLUSH $aux_data | | LOAD ->aux_head_hi
1717 * STORE ->aux_head --|-------` smp_rmb()
1720 * | STORE ->aux_tail_lo
1722 * STORE ->aux_tail_hi
1724 * For this reason, it's impossible for the perf tool to work correctly when
1725 * the AUX head or tail is bigger than 4GB (more than 32 bits length); and we
1726 * can not simply limit the AUX ring buffer to less than 4GB, the reason is
1727 * the pointers can be increased monotonically, whatever the buffer size it is,
1728 * at the end the head and tail can be bigger than 4GB and carry out to the
1731 * To mitigate the issues and improve the user experience, we can allow the
1732 * perf tool working in certain conditions and bail out with error if detect
1733 * any overflow cannot be handled.
1735 * For reading the AUX head, it reads out the values for three times, and
1736 * compares the high 4 bytes of the values between the first time and the last
1737 * time, if there has no change for high 4 bytes injected by the kernel during
1738 * the user reading sequence, it's safe for use the second value.
1740 * When compat_auxtrace_mmap__write_tail() detects any carrying in the high
1741 * 32 bits, it means there have two store operations in user space and it cannot
1742 * promise the atomicity for 64-bit write, so return '-1' in this case to tell
1743 * the caller an overflow error has happened.
1745 u64 __weak compat_auxtrace_mmap__read_head(struct auxtrace_mmap *mm)
1747 struct perf_event_mmap_page *pc = mm->userpg;
1748 u64 first, second, last;
1749 u64 mask = (u64)(UINT32_MAX) << 32;
1752 first = READ_ONCE(pc->aux_head);
1753 /* Ensure all reads are done after we read the head */
1755 second = READ_ONCE(pc->aux_head);
1756 /* Ensure all reads are done after we read the head */
1758 last = READ_ONCE(pc->aux_head);
1759 } while ((first & mask) != (last & mask));
1764 int __weak compat_auxtrace_mmap__write_tail(struct auxtrace_mmap *mm, u64 tail)
1766 struct perf_event_mmap_page *pc = mm->userpg;
1767 u64 mask = (u64)(UINT32_MAX) << 32;
1772 /* Ensure all reads are done before we write the tail out */
1774 WRITE_ONCE(pc->aux_tail, tail);
1778 static int __auxtrace_mmap__read(struct mmap *map,
1779 struct auxtrace_record *itr,
1780 struct perf_tool *tool, process_auxtrace_t fn,
1781 bool snapshot, size_t snapshot_size)
1783 struct auxtrace_mmap *mm = &map->auxtrace_mmap;
1784 u64 head, old = mm->prev, offset, ref;
1785 unsigned char *data = mm->base;
1786 size_t size, head_off, old_off, len1, len2, padding;
1787 union perf_event ev;
1788 void *data1, *data2;
1789 int kernel_is_64_bit = perf_env__kernel_is_64_bit(evsel__env(NULL));
1791 head = auxtrace_mmap__read_head(mm, kernel_is_64_bit);
1794 auxtrace_record__find_snapshot(itr, mm->idx, mm, data, &head, &old))
1800 pr_debug3("auxtrace idx %d old %#"PRIx64" head %#"PRIx64" diff %#"PRIx64"\n",
1801 mm->idx, old, head, head - old);
1804 head_off = head & mm->mask;
1805 old_off = old & mm->mask;
1807 head_off = head % mm->len;
1808 old_off = old % mm->len;
1811 if (head_off > old_off)
1812 size = head_off - old_off;
1814 size = mm->len - (old_off - head_off);
1816 if (snapshot && size > snapshot_size)
1817 size = snapshot_size;
1819 ref = auxtrace_record__reference(itr);
1821 if (head > old || size <= head || mm->mask) {
1822 offset = head - size;
1825 * When the buffer size is not a power of 2, 'head' wraps at the
1826 * highest multiple of the buffer size, so we have to subtract
1827 * the remainder here.
1829 u64 rem = (0ULL - mm->len) % mm->len;
1831 offset = head - size - rem;
1834 if (size > head_off) {
1835 len1 = size - head_off;
1836 data1 = &data[mm->len - len1];
1841 data1 = &data[head_off - len1];
1846 if (itr->alignment) {
1847 unsigned int unwanted = len1 % itr->alignment;
1853 /* padding must be written by fn() e.g. record__process_auxtrace() */
1854 padding = size & (PERF_AUXTRACE_RECORD_ALIGNMENT - 1);
1856 padding = PERF_AUXTRACE_RECORD_ALIGNMENT - padding;
1858 memset(&ev, 0, sizeof(ev));
1859 ev.auxtrace.header.type = PERF_RECORD_AUXTRACE;
1860 ev.auxtrace.header.size = sizeof(ev.auxtrace);
1861 ev.auxtrace.size = size + padding;
1862 ev.auxtrace.offset = offset;
1863 ev.auxtrace.reference = ref;
1864 ev.auxtrace.idx = mm->idx;
1865 ev.auxtrace.tid = mm->tid;
1866 ev.auxtrace.cpu = mm->cpu;
1868 if (fn(tool, map, &ev, data1, len1, data2, len2))
1876 err = auxtrace_mmap__write_tail(mm, head, kernel_is_64_bit);
1880 if (itr->read_finish) {
1881 err = itr->read_finish(itr, mm->idx);
1890 int auxtrace_mmap__read(struct mmap *map, struct auxtrace_record *itr,
1891 struct perf_tool *tool, process_auxtrace_t fn)
1893 return __auxtrace_mmap__read(map, itr, tool, fn, false, 0);
1896 int auxtrace_mmap__read_snapshot(struct mmap *map,
1897 struct auxtrace_record *itr,
1898 struct perf_tool *tool, process_auxtrace_t fn,
1899 size_t snapshot_size)
1901 return __auxtrace_mmap__read(map, itr, tool, fn, true, snapshot_size);
1905 * struct auxtrace_cache - hash table to implement a cache
1906 * @hashtable: the hashtable
1907 * @sz: hashtable size (number of hlists)
1908 * @entry_size: size of an entry
1909 * @limit: limit the number of entries to this maximum, when reached the cache
1910 * is dropped and caching begins again with an empty cache
1911 * @cnt: current number of entries
1912 * @bits: hashtable size (@sz = 2^@bits)
1914 struct auxtrace_cache {
1915 struct hlist_head *hashtable;
1923 struct auxtrace_cache *auxtrace_cache__new(unsigned int bits, size_t entry_size,
1924 unsigned int limit_percent)
1926 struct auxtrace_cache *c;
1927 struct hlist_head *ht;
1930 c = zalloc(sizeof(struct auxtrace_cache));
1936 ht = calloc(sz, sizeof(struct hlist_head));
1940 for (i = 0; i < sz; i++)
1941 INIT_HLIST_HEAD(&ht[i]);
1945 c->entry_size = entry_size;
1946 c->limit = (c->sz * limit_percent) / 100;
1956 static void auxtrace_cache__drop(struct auxtrace_cache *c)
1958 struct auxtrace_cache_entry *entry;
1959 struct hlist_node *tmp;
1965 for (i = 0; i < c->sz; i++) {
1966 hlist_for_each_entry_safe(entry, tmp, &c->hashtable[i], hash) {
1967 hlist_del(&entry->hash);
1968 auxtrace_cache__free_entry(c, entry);
1975 void auxtrace_cache__free(struct auxtrace_cache *c)
1980 auxtrace_cache__drop(c);
1981 zfree(&c->hashtable);
1985 void *auxtrace_cache__alloc_entry(struct auxtrace_cache *c)
1987 return malloc(c->entry_size);
1990 void auxtrace_cache__free_entry(struct auxtrace_cache *c __maybe_unused,
1996 int auxtrace_cache__add(struct auxtrace_cache *c, u32 key,
1997 struct auxtrace_cache_entry *entry)
1999 if (c->limit && ++c->cnt > c->limit)
2000 auxtrace_cache__drop(c);
2003 hlist_add_head(&entry->hash, &c->hashtable[hash_32(key, c->bits)]);
2008 static struct auxtrace_cache_entry *auxtrace_cache__rm(struct auxtrace_cache *c,
2011 struct auxtrace_cache_entry *entry;
2012 struct hlist_head *hlist;
2013 struct hlist_node *n;
2018 hlist = &c->hashtable[hash_32(key, c->bits)];
2019 hlist_for_each_entry_safe(entry, n, hlist, hash) {
2020 if (entry->key == key) {
2021 hlist_del(&entry->hash);
2029 void auxtrace_cache__remove(struct auxtrace_cache *c, u32 key)
2031 struct auxtrace_cache_entry *entry = auxtrace_cache__rm(c, key);
2033 auxtrace_cache__free_entry(c, entry);
2036 void *auxtrace_cache__lookup(struct auxtrace_cache *c, u32 key)
2038 struct auxtrace_cache_entry *entry;
2039 struct hlist_head *hlist;
2044 hlist = &c->hashtable[hash_32(key, c->bits)];
2045 hlist_for_each_entry(entry, hlist, hash) {
2046 if (entry->key == key)
2053 static void addr_filter__free_str(struct addr_filter *filt)
2056 filt->action = NULL;
2057 filt->sym_from = NULL;
2058 filt->sym_to = NULL;
2059 filt->filename = NULL;
2062 static struct addr_filter *addr_filter__new(void)
2064 struct addr_filter *filt = zalloc(sizeof(*filt));
2067 INIT_LIST_HEAD(&filt->list);
2072 static void addr_filter__free(struct addr_filter *filt)
2075 addr_filter__free_str(filt);
2079 static void addr_filters__add(struct addr_filters *filts,
2080 struct addr_filter *filt)
2082 list_add_tail(&filt->list, &filts->head);
2086 static void addr_filters__del(struct addr_filters *filts,
2087 struct addr_filter *filt)
2089 list_del_init(&filt->list);
2093 void addr_filters__init(struct addr_filters *filts)
2095 INIT_LIST_HEAD(&filts->head);
2099 void addr_filters__exit(struct addr_filters *filts)
2101 struct addr_filter *filt, *n;
2103 list_for_each_entry_safe(filt, n, &filts->head, list) {
2104 addr_filters__del(filts, filt);
2105 addr_filter__free(filt);
2109 static int parse_num_or_str(char **inp, u64 *num, const char **str,
2110 const char *str_delim)
2112 *inp += strspn(*inp, " ");
2114 if (isdigit(**inp)) {
2120 *num = strtoull(*inp, &endptr, 0);
2131 *inp += strspn(*inp, " ");
2133 n = strcspn(*inp, str_delim);
2145 static int parse_action(struct addr_filter *filt)
2147 if (!strcmp(filt->action, "filter")) {
2150 } else if (!strcmp(filt->action, "start")) {
2152 } else if (!strcmp(filt->action, "stop")) {
2153 filt->start = false;
2154 } else if (!strcmp(filt->action, "tracestop")) {
2155 filt->start = false;
2157 filt->action += 5; /* Change 'tracestop' to 'stop' */
2164 static int parse_sym_idx(char **inp, int *idx)
2168 *inp += strspn(*inp, " ");
2175 if (**inp == 'g' || **inp == 'G') {
2183 num = strtoul(*inp, &endptr, 0);
2186 if (endptr == *inp || num > INT_MAX)
2195 static int parse_addr_size(char **inp, u64 *num, const char **str, int *idx)
2197 int err = parse_num_or_str(inp, num, str, " ");
2200 err = parse_sym_idx(inp, idx);
2205 static int parse_one_filter(struct addr_filter *filt, const char **filter_inp)
2210 filt->str = fstr = strdup(*filter_inp);
2214 err = parse_num_or_str(&fstr, NULL, &filt->action, " ");
2218 err = parse_action(filt);
2222 err = parse_addr_size(&fstr, &filt->addr, &filt->sym_from,
2223 &filt->sym_from_idx);
2227 fstr += strspn(fstr, " ");
2231 err = parse_addr_size(&fstr, &filt->size, &filt->sym_to,
2238 fstr += strspn(fstr, " ");
2242 err = parse_num_or_str(&fstr, NULL, &filt->filename, " ,");
2247 fstr += strspn(fstr, " ,");
2249 *filter_inp += fstr - filt->str;
2254 addr_filter__free_str(filt);
2259 int addr_filters__parse_bare_filter(struct addr_filters *filts,
2262 struct addr_filter *filt;
2263 const char *fstr = filter;
2267 filt = addr_filter__new();
2268 err = parse_one_filter(filt, &fstr);
2270 addr_filter__free(filt);
2271 addr_filters__exit(filts);
2274 addr_filters__add(filts, filt);
2293 static bool kern_sym_match(struct sym_args *args, const char *name, char type)
2295 /* A function with the same name, and global or the n'th found or any */
2296 return kallsyms__is_function(type) &&
2297 !strcmp(name, args->name) &&
2298 ((args->global && isupper(type)) ||
2299 (args->selected && ++(args->cnt) == args->idx) ||
2300 (!args->global && !args->selected));
2303 static int find_kern_sym_cb(void *arg, const char *name, char type, u64 start)
2305 struct sym_args *args = arg;
2307 if (args->started) {
2309 args->size = start - args->start;
2310 if (args->selected) {
2313 } else if (kern_sym_match(args, name, type)) {
2314 args->duplicate = true;
2317 } else if (kern_sym_match(args, name, type)) {
2318 args->started = true;
2319 args->start = start;
2325 static int print_kern_sym_cb(void *arg, const char *name, char type, u64 start)
2327 struct sym_args *args = arg;
2329 if (kern_sym_match(args, name, type)) {
2330 pr_err("#%d\t0x%"PRIx64"\t%c\t%s\n",
2331 ++args->cnt, start, type, name);
2333 } else if (args->near) {
2335 pr_err("\t\twhich is near\t\t%s\n", name);
2341 static int sym_not_found_error(const char *sym_name, int idx)
2344 pr_err("N'th occurrence (N=%d) of symbol '%s' not found.\n",
2347 pr_err("Global symbol '%s' not found.\n", sym_name);
2349 pr_err("Symbol '%s' not found.\n", sym_name);
2351 pr_err("Note that symbols must be functions.\n");
2356 static int find_kern_sym(const char *sym_name, u64 *start, u64 *size, int idx)
2358 struct sym_args args = {
2362 .selected = idx > 0,
2369 err = kallsyms__parse("/proc/kallsyms", &args, find_kern_sym_cb);
2371 pr_err("Failed to parse /proc/kallsyms\n");
2375 if (args.duplicate) {
2376 pr_err("Multiple kernel symbols with name '%s'\n", sym_name);
2378 kallsyms__parse("/proc/kallsyms", &args, print_kern_sym_cb);
2379 pr_err("Disambiguate symbol name by inserting #n after the name e.g. %s #2\n",
2381 pr_err("Or select a global symbol by inserting #0 or #g or #G\n");
2385 if (!args.started) {
2386 pr_err("Kernel symbol lookup: ");
2387 return sym_not_found_error(sym_name, idx);
2390 *start = args.start;
2396 static int find_entire_kern_cb(void *arg, const char *name __maybe_unused,
2397 char type, u64 start)
2399 struct sym_args *args = arg;
2401 if (!kallsyms__is_function(type))
2404 if (!args->started) {
2405 args->started = true;
2406 args->start = start;
2408 /* Don't know exactly where the kernel ends, so we add a page */
2409 args->size = round_up(start, page_size) + page_size - args->start;
2414 static int addr_filter__entire_kernel(struct addr_filter *filt)
2416 struct sym_args args = { .started = false };
2419 err = kallsyms__parse("/proc/kallsyms", &args, find_entire_kern_cb);
2420 if (err < 0 || !args.started) {
2421 pr_err("Failed to parse /proc/kallsyms\n");
2425 filt->addr = args.start;
2426 filt->size = args.size;
2431 static int check_end_after_start(struct addr_filter *filt, u64 start, u64 size)
2433 if (start + size >= filt->addr)
2436 if (filt->sym_from) {
2437 pr_err("Symbol '%s' (0x%"PRIx64") comes before '%s' (0x%"PRIx64")\n",
2438 filt->sym_to, start, filt->sym_from, filt->addr);
2440 pr_err("Symbol '%s' (0x%"PRIx64") comes before address 0x%"PRIx64")\n",
2441 filt->sym_to, start, filt->addr);
2447 static int addr_filter__resolve_kernel_syms(struct addr_filter *filt)
2449 bool no_size = false;
2453 if (symbol_conf.kptr_restrict) {
2454 pr_err("Kernel addresses are restricted. Unable to resolve kernel symbols.\n");
2458 if (filt->sym_from && !strcmp(filt->sym_from, "*"))
2459 return addr_filter__entire_kernel(filt);
2461 if (filt->sym_from) {
2462 err = find_kern_sym(filt->sym_from, &start, &size,
2463 filt->sym_from_idx);
2467 if (filt->range && !filt->size && !filt->sym_to) {
2474 err = find_kern_sym(filt->sym_to, &start, &size,
2479 err = check_end_after_start(filt, start, size);
2482 filt->size = start + size - filt->addr;
2486 /* The very last symbol in kallsyms does not imply a particular size */
2488 pr_err("Cannot determine size of symbol '%s'\n",
2489 filt->sym_to ? filt->sym_to : filt->sym_from);
2496 static struct dso *load_dso(const char *name)
2501 map = dso__new_map(name);
2505 if (map__load(map) < 0)
2506 pr_err("File '%s' not found or has no symbols.\n", name);
2508 dso = dso__get(map->dso);
2515 static bool dso_sym_match(struct symbol *sym, const char *name, int *cnt,
2518 /* Same name, and global or the n'th found or any */
2519 return !arch__compare_symbol_names(name, sym->name) &&
2520 ((!idx && sym->binding == STB_GLOBAL) ||
2521 (idx > 0 && ++*cnt == idx) ||
2525 static void print_duplicate_syms(struct dso *dso, const char *sym_name)
2531 pr_err("Multiple symbols with name '%s'\n", sym_name);
2533 sym = dso__first_symbol(dso);
2535 if (dso_sym_match(sym, sym_name, &cnt, -1)) {
2536 pr_err("#%d\t0x%"PRIx64"\t%c\t%s\n",
2538 sym->binding == STB_GLOBAL ? 'g' :
2539 sym->binding == STB_LOCAL ? 'l' : 'w',
2544 pr_err("\t\twhich is near\t\t%s\n", sym->name);
2546 sym = dso__next_symbol(sym);
2549 pr_err("Disambiguate symbol name by inserting #n after the name e.g. %s #2\n",
2551 pr_err("Or select a global symbol by inserting #0 or #g or #G\n");
2554 static int find_dso_sym(struct dso *dso, const char *sym_name, u64 *start,
2563 sym = dso__first_symbol(dso);
2567 *size = sym->start - *start;
2571 } else if (dso_sym_match(sym, sym_name, &cnt, idx)) {
2572 print_duplicate_syms(dso, sym_name);
2575 } else if (dso_sym_match(sym, sym_name, &cnt, idx)) {
2576 *start = sym->start;
2577 *size = sym->end - sym->start;
2579 sym = dso__next_symbol(sym);
2583 return sym_not_found_error(sym_name, idx);
2588 static int addr_filter__entire_dso(struct addr_filter *filt, struct dso *dso)
2590 if (dso__data_file_size(dso, NULL)) {
2591 pr_err("Failed to determine filter for %s\nCannot determine file size.\n",
2597 filt->size = dso->data.file_size;
2602 static int addr_filter__resolve_syms(struct addr_filter *filt)
2608 if (!filt->sym_from && !filt->sym_to)
2611 if (!filt->filename)
2612 return addr_filter__resolve_kernel_syms(filt);
2614 dso = load_dso(filt->filename);
2616 pr_err("Failed to load symbols from: %s\n", filt->filename);
2620 if (filt->sym_from && !strcmp(filt->sym_from, "*")) {
2621 err = addr_filter__entire_dso(filt, dso);
2625 if (filt->sym_from) {
2626 err = find_dso_sym(dso, filt->sym_from, &start, &size,
2627 filt->sym_from_idx);
2631 if (filt->range && !filt->size && !filt->sym_to)
2636 err = find_dso_sym(dso, filt->sym_to, &start, &size,
2641 err = check_end_after_start(filt, start, size);
2645 filt->size = start + size - filt->addr;
2654 static char *addr_filter__to_str(struct addr_filter *filt)
2656 char filename_buf[PATH_MAX];
2657 const char *at = "";
2658 const char *fn = "";
2662 if (filt->filename) {
2664 fn = realpath(filt->filename, filename_buf);
2670 err = asprintf(&filter, "%s 0x%"PRIx64"/0x%"PRIx64"%s%s",
2671 filt->action, filt->addr, filt->size, at, fn);
2673 err = asprintf(&filter, "%s 0x%"PRIx64"%s%s",
2674 filt->action, filt->addr, at, fn);
2677 return err < 0 ? NULL : filter;
2680 static int parse_addr_filter(struct evsel *evsel, const char *filter,
2683 struct addr_filters filts;
2684 struct addr_filter *filt;
2687 addr_filters__init(&filts);
2689 err = addr_filters__parse_bare_filter(&filts, filter);
2693 if (filts.cnt > max_nr) {
2694 pr_err("Error: number of address filters (%d) exceeds maximum (%d)\n",
2700 list_for_each_entry(filt, &filts.head, list) {
2703 err = addr_filter__resolve_syms(filt);
2707 new_filter = addr_filter__to_str(filt);
2713 if (evsel__append_addr_filter(evsel, new_filter)) {
2720 addr_filters__exit(&filts);
2723 pr_err("Failed to parse address filter: '%s'\n", filter);
2724 pr_err("Filter format is: filter|start|stop|tracestop <start symbol or address> [/ <end symbol or size>] [@<file name>]\n");
2725 pr_err("Where multiple filters are separated by space or comma.\n");
2731 static int evsel__nr_addr_filter(struct evsel *evsel)
2733 struct perf_pmu *pmu = evsel__find_pmu(evsel);
2734 int nr_addr_filters = 0;
2739 perf_pmu__scan_file(pmu, "nr_addr_filters", "%d", &nr_addr_filters);
2741 return nr_addr_filters;
2744 int auxtrace_parse_filters(struct evlist *evlist)
2746 struct evsel *evsel;
2750 evlist__for_each_entry(evlist, evsel) {
2751 filter = evsel->filter;
2752 max_nr = evsel__nr_addr_filter(evsel);
2753 if (!filter || !max_nr)
2755 evsel->filter = NULL;
2756 err = parse_addr_filter(evsel, filter, max_nr);
2760 pr_debug("Address filter: %s\n", evsel->filter);
2766 int auxtrace__process_event(struct perf_session *session, union perf_event *event,
2767 struct perf_sample *sample, struct perf_tool *tool)
2769 if (!session->auxtrace)
2772 return session->auxtrace->process_event(session, event, sample, tool);
2775 void auxtrace__dump_auxtrace_sample(struct perf_session *session,
2776 struct perf_sample *sample)
2778 if (!session->auxtrace || !session->auxtrace->dump_auxtrace_sample ||
2779 auxtrace__dont_decode(session))
2782 session->auxtrace->dump_auxtrace_sample(session, sample);
2785 int auxtrace__flush_events(struct perf_session *session, struct perf_tool *tool)
2787 if (!session->auxtrace)
2790 return session->auxtrace->flush_events(session, tool);
2793 void auxtrace__free_events(struct perf_session *session)
2795 if (!session->auxtrace)
2798 return session->auxtrace->free_events(session);
2801 void auxtrace__free(struct perf_session *session)
2803 if (!session->auxtrace)
2806 return session->auxtrace->free(session);
2809 bool auxtrace__evsel_is_auxtrace(struct perf_session *session,
2810 struct evsel *evsel)
2812 if (!session->auxtrace || !session->auxtrace->evsel_is_auxtrace)
2815 return session->auxtrace->evsel_is_auxtrace(session, evsel);