2 * auxtrace.c: AUX area trace support
3 * Copyright (c) 2013-2015, Intel Corporation.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
17 #include <sys/types.h>
24 #include <linux/kernel.h>
25 #include <linux/perf_event.h>
26 #include <linux/types.h>
27 #include <linux/bitops.h>
28 #include <linux/log2.h>
29 #include <linux/string.h>
31 #include <sys/param.h>
37 #include <linux/list.h>
47 #include "thread_map.h"
51 #include <linux/hash.h>
56 #include <subcmd/parse-options.h>
59 #include "intel-bts.h"
61 #include "sane_ctype.h"
62 #include "symbol/kallsyms.h"
64 int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
65 struct auxtrace_mmap_params *mp,
68 struct perf_event_mmap_page *pc = userpg;
70 WARN_ONCE(mm->base, "Uninitialized auxtrace_mmap\n");
85 #if BITS_PER_LONG != 64 && !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
86 pr_err("Cannot use AUX area tracing mmaps\n");
90 pc->aux_offset = mp->offset;
91 pc->aux_size = mp->len;
93 mm->base = mmap(NULL, mp->len, mp->prot, MAP_SHARED, fd, mp->offset);
94 if (mm->base == MAP_FAILED) {
95 pr_debug2("failed to mmap AUX area\n");
103 void auxtrace_mmap__munmap(struct auxtrace_mmap *mm)
106 munmap(mm->base, mm->len);
111 void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
112 off_t auxtrace_offset,
113 unsigned int auxtrace_pages,
114 bool auxtrace_overwrite)
116 if (auxtrace_pages) {
117 mp->offset = auxtrace_offset;
118 mp->len = auxtrace_pages * (size_t)page_size;
119 mp->mask = is_power_of_2(mp->len) ? mp->len - 1 : 0;
120 mp->prot = PROT_READ | (auxtrace_overwrite ? 0 : PROT_WRITE);
121 pr_debug2("AUX area mmap length %zu\n", mp->len);
127 void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
128 struct perf_evlist *evlist, int idx,
134 mp->cpu = evlist->cpus->map[idx];
136 mp->tid = thread_map__pid(evlist->threads, 0);
141 mp->tid = thread_map__pid(evlist->threads, idx);
145 #define AUXTRACE_INIT_NR_QUEUES 32
147 static struct auxtrace_queue *auxtrace_alloc_queue_array(unsigned int nr_queues)
149 struct auxtrace_queue *queue_array;
150 unsigned int max_nr_queues, i;
152 max_nr_queues = UINT_MAX / sizeof(struct auxtrace_queue);
153 if (nr_queues > max_nr_queues)
156 queue_array = calloc(nr_queues, sizeof(struct auxtrace_queue));
160 for (i = 0; i < nr_queues; i++) {
161 INIT_LIST_HEAD(&queue_array[i].head);
162 queue_array[i].priv = NULL;
168 int auxtrace_queues__init(struct auxtrace_queues *queues)
170 queues->nr_queues = AUXTRACE_INIT_NR_QUEUES;
171 queues->queue_array = auxtrace_alloc_queue_array(queues->nr_queues);
172 if (!queues->queue_array)
177 static int auxtrace_queues__grow(struct auxtrace_queues *queues,
178 unsigned int new_nr_queues)
180 unsigned int nr_queues = queues->nr_queues;
181 struct auxtrace_queue *queue_array;
185 nr_queues = AUXTRACE_INIT_NR_QUEUES;
187 while (nr_queues && nr_queues < new_nr_queues)
190 if (nr_queues < queues->nr_queues || nr_queues < new_nr_queues)
193 queue_array = auxtrace_alloc_queue_array(nr_queues);
197 for (i = 0; i < queues->nr_queues; i++) {
198 list_splice_tail(&queues->queue_array[i].head,
199 &queue_array[i].head);
200 queue_array[i].priv = queues->queue_array[i].priv;
203 queues->nr_queues = nr_queues;
204 queues->queue_array = queue_array;
209 static void *auxtrace_copy_data(u64 size, struct perf_session *session)
211 int fd = perf_data_file__fd(session->file);
215 if (size > SSIZE_MAX)
222 ret = readn(fd, p, size);
223 if (ret != (ssize_t)size) {
231 static int auxtrace_queues__add_buffer(struct auxtrace_queues *queues,
233 struct auxtrace_buffer *buffer)
235 struct auxtrace_queue *queue;
238 if (idx >= queues->nr_queues) {
239 err = auxtrace_queues__grow(queues, idx + 1);
244 queue = &queues->queue_array[idx];
248 queue->tid = buffer->tid;
249 queue->cpu = buffer->cpu;
250 } else if (buffer->cpu != queue->cpu || buffer->tid != queue->tid) {
251 pr_err("auxtrace queue conflict: cpu %d, tid %d vs cpu %d, tid %d\n",
252 queue->cpu, queue->tid, buffer->cpu, buffer->tid);
256 buffer->buffer_nr = queues->next_buffer_nr++;
258 list_add_tail(&buffer->list, &queue->head);
260 queues->new_data = true;
261 queues->populated = true;
266 /* Limit buffers to 32MiB on 32-bit */
267 #define BUFFER_LIMIT_FOR_32_BIT (32 * 1024 * 1024)
269 static int auxtrace_queues__split_buffer(struct auxtrace_queues *queues,
271 struct auxtrace_buffer *buffer)
273 u64 sz = buffer->size;
274 bool consecutive = false;
275 struct auxtrace_buffer *b;
278 while (sz > BUFFER_LIMIT_FOR_32_BIT) {
279 b = memdup(buffer, sizeof(struct auxtrace_buffer));
282 b->size = BUFFER_LIMIT_FOR_32_BIT;
283 b->consecutive = consecutive;
284 err = auxtrace_queues__add_buffer(queues, idx, b);
286 auxtrace_buffer__free(b);
289 buffer->data_offset += BUFFER_LIMIT_FOR_32_BIT;
290 sz -= BUFFER_LIMIT_FOR_32_BIT;
295 buffer->consecutive = consecutive;
300 static int auxtrace_queues__add_event_buffer(struct auxtrace_queues *queues,
301 struct perf_session *session,
303 struct auxtrace_buffer *buffer)
305 if (session->one_mmap) {
306 buffer->data = buffer->data_offset - session->one_mmap_offset +
307 session->one_mmap_addr;
308 } else if (perf_data_file__is_pipe(session->file)) {
309 buffer->data = auxtrace_copy_data(buffer->size, session);
312 buffer->data_needs_freeing = true;
313 } else if (BITS_PER_LONG == 32 &&
314 buffer->size > BUFFER_LIMIT_FOR_32_BIT) {
317 err = auxtrace_queues__split_buffer(queues, idx, buffer);
322 return auxtrace_queues__add_buffer(queues, idx, buffer);
325 int auxtrace_queues__add_event(struct auxtrace_queues *queues,
326 struct perf_session *session,
327 union perf_event *event, off_t data_offset,
328 struct auxtrace_buffer **buffer_ptr)
330 struct auxtrace_buffer *buffer;
334 buffer = zalloc(sizeof(struct auxtrace_buffer));
339 buffer->tid = event->auxtrace.tid;
340 buffer->cpu = event->auxtrace.cpu;
341 buffer->data_offset = data_offset;
342 buffer->offset = event->auxtrace.offset;
343 buffer->reference = event->auxtrace.reference;
344 buffer->size = event->auxtrace.size;
345 idx = event->auxtrace.idx;
347 err = auxtrace_queues__add_event_buffer(queues, session, idx, buffer);
352 *buffer_ptr = buffer;
357 auxtrace_buffer__free(buffer);
361 static int auxtrace_queues__add_indexed_event(struct auxtrace_queues *queues,
362 struct perf_session *session,
363 off_t file_offset, size_t sz)
365 union perf_event *event;
367 char buf[PERF_SAMPLE_MAX_SIZE];
369 err = perf_session__peek_event(session, file_offset, buf,
370 PERF_SAMPLE_MAX_SIZE, &event, NULL);
374 if (event->header.type == PERF_RECORD_AUXTRACE) {
375 if (event->header.size < sizeof(struct auxtrace_event) ||
376 event->header.size != sz) {
380 file_offset += event->header.size;
381 err = auxtrace_queues__add_event(queues, session, event,
388 void auxtrace_queues__free(struct auxtrace_queues *queues)
392 for (i = 0; i < queues->nr_queues; i++) {
393 while (!list_empty(&queues->queue_array[i].head)) {
394 struct auxtrace_buffer *buffer;
396 buffer = list_entry(queues->queue_array[i].head.next,
397 struct auxtrace_buffer, list);
398 list_del(&buffer->list);
399 auxtrace_buffer__free(buffer);
403 zfree(&queues->queue_array);
404 queues->nr_queues = 0;
407 static void auxtrace_heapify(struct auxtrace_heap_item *heap_array,
408 unsigned int pos, unsigned int queue_nr,
414 parent = (pos - 1) >> 1;
415 if (heap_array[parent].ordinal <= ordinal)
417 heap_array[pos] = heap_array[parent];
420 heap_array[pos].queue_nr = queue_nr;
421 heap_array[pos].ordinal = ordinal;
424 int auxtrace_heap__add(struct auxtrace_heap *heap, unsigned int queue_nr,
427 struct auxtrace_heap_item *heap_array;
429 if (queue_nr >= heap->heap_sz) {
430 unsigned int heap_sz = AUXTRACE_INIT_NR_QUEUES;
432 while (heap_sz <= queue_nr)
434 heap_array = realloc(heap->heap_array,
435 heap_sz * sizeof(struct auxtrace_heap_item));
438 heap->heap_array = heap_array;
439 heap->heap_sz = heap_sz;
442 auxtrace_heapify(heap->heap_array, heap->heap_cnt++, queue_nr, ordinal);
447 void auxtrace_heap__free(struct auxtrace_heap *heap)
449 zfree(&heap->heap_array);
454 void auxtrace_heap__pop(struct auxtrace_heap *heap)
456 unsigned int pos, last, heap_cnt = heap->heap_cnt;
457 struct auxtrace_heap_item *heap_array;
464 heap_array = heap->heap_array;
468 unsigned int left, right;
470 left = (pos << 1) + 1;
471 if (left >= heap_cnt)
474 if (right >= heap_cnt) {
475 heap_array[pos] = heap_array[left];
478 if (heap_array[left].ordinal < heap_array[right].ordinal) {
479 heap_array[pos] = heap_array[left];
482 heap_array[pos] = heap_array[right];
488 auxtrace_heapify(heap_array, pos, heap_array[last].queue_nr,
489 heap_array[last].ordinal);
492 size_t auxtrace_record__info_priv_size(struct auxtrace_record *itr,
493 struct perf_evlist *evlist)
496 return itr->info_priv_size(itr, evlist);
500 static int auxtrace_not_supported(void)
502 pr_err("AUX area tracing is not supported on this architecture\n");
506 int auxtrace_record__info_fill(struct auxtrace_record *itr,
507 struct perf_session *session,
508 struct auxtrace_info_event *auxtrace_info,
512 return itr->info_fill(itr, session, auxtrace_info, priv_size);
513 return auxtrace_not_supported();
516 void auxtrace_record__free(struct auxtrace_record *itr)
522 int auxtrace_record__snapshot_start(struct auxtrace_record *itr)
524 if (itr && itr->snapshot_start)
525 return itr->snapshot_start(itr);
529 int auxtrace_record__snapshot_finish(struct auxtrace_record *itr)
531 if (itr && itr->snapshot_finish)
532 return itr->snapshot_finish(itr);
536 int auxtrace_record__find_snapshot(struct auxtrace_record *itr, int idx,
537 struct auxtrace_mmap *mm,
538 unsigned char *data, u64 *head, u64 *old)
540 if (itr && itr->find_snapshot)
541 return itr->find_snapshot(itr, idx, mm, data, head, old);
545 int auxtrace_record__options(struct auxtrace_record *itr,
546 struct perf_evlist *evlist,
547 struct record_opts *opts)
550 return itr->recording_options(itr, evlist, opts);
554 u64 auxtrace_record__reference(struct auxtrace_record *itr)
557 return itr->reference(itr);
561 int auxtrace_parse_snapshot_options(struct auxtrace_record *itr,
562 struct record_opts *opts, const char *str)
568 return itr->parse_snapshot_options(itr, opts, str);
570 pr_err("No AUX area tracing to snapshot\n");
574 struct auxtrace_record *__weak
575 auxtrace_record__init(struct perf_evlist *evlist __maybe_unused, int *err)
581 static int auxtrace_index__alloc(struct list_head *head)
583 struct auxtrace_index *auxtrace_index;
585 auxtrace_index = malloc(sizeof(struct auxtrace_index));
589 auxtrace_index->nr = 0;
590 INIT_LIST_HEAD(&auxtrace_index->list);
592 list_add_tail(&auxtrace_index->list, head);
597 void auxtrace_index__free(struct list_head *head)
599 struct auxtrace_index *auxtrace_index, *n;
601 list_for_each_entry_safe(auxtrace_index, n, head, list) {
602 list_del(&auxtrace_index->list);
603 free(auxtrace_index);
607 static struct auxtrace_index *auxtrace_index__last(struct list_head *head)
609 struct auxtrace_index *auxtrace_index;
612 if (list_empty(head)) {
613 err = auxtrace_index__alloc(head);
618 auxtrace_index = list_entry(head->prev, struct auxtrace_index, list);
620 if (auxtrace_index->nr >= PERF_AUXTRACE_INDEX_ENTRY_COUNT) {
621 err = auxtrace_index__alloc(head);
624 auxtrace_index = list_entry(head->prev, struct auxtrace_index,
628 return auxtrace_index;
631 int auxtrace_index__auxtrace_event(struct list_head *head,
632 union perf_event *event, off_t file_offset)
634 struct auxtrace_index *auxtrace_index;
637 auxtrace_index = auxtrace_index__last(head);
641 nr = auxtrace_index->nr;
642 auxtrace_index->entries[nr].file_offset = file_offset;
643 auxtrace_index->entries[nr].sz = event->header.size;
644 auxtrace_index->nr += 1;
649 static int auxtrace_index__do_write(int fd,
650 struct auxtrace_index *auxtrace_index)
652 struct auxtrace_index_entry ent;
655 for (i = 0; i < auxtrace_index->nr; i++) {
656 ent.file_offset = auxtrace_index->entries[i].file_offset;
657 ent.sz = auxtrace_index->entries[i].sz;
658 if (writen(fd, &ent, sizeof(ent)) != sizeof(ent))
664 int auxtrace_index__write(int fd, struct list_head *head)
666 struct auxtrace_index *auxtrace_index;
670 list_for_each_entry(auxtrace_index, head, list)
671 total += auxtrace_index->nr;
673 if (writen(fd, &total, sizeof(total)) != sizeof(total))
676 list_for_each_entry(auxtrace_index, head, list) {
677 err = auxtrace_index__do_write(fd, auxtrace_index);
685 static int auxtrace_index__process_entry(int fd, struct list_head *head,
688 struct auxtrace_index *auxtrace_index;
689 struct auxtrace_index_entry ent;
692 if (readn(fd, &ent, sizeof(ent)) != sizeof(ent))
695 auxtrace_index = auxtrace_index__last(head);
699 nr = auxtrace_index->nr;
701 auxtrace_index->entries[nr].file_offset =
702 bswap_64(ent.file_offset);
703 auxtrace_index->entries[nr].sz = bswap_64(ent.sz);
705 auxtrace_index->entries[nr].file_offset = ent.file_offset;
706 auxtrace_index->entries[nr].sz = ent.sz;
709 auxtrace_index->nr = nr + 1;
714 int auxtrace_index__process(int fd, u64 size, struct perf_session *session,
717 struct list_head *head = &session->auxtrace_index;
720 if (readn(fd, &nr, sizeof(u64)) != sizeof(u64))
726 if (sizeof(u64) + nr * sizeof(struct auxtrace_index_entry) > size)
732 err = auxtrace_index__process_entry(fd, head, needs_swap);
740 static int auxtrace_queues__process_index_entry(struct auxtrace_queues *queues,
741 struct perf_session *session,
742 struct auxtrace_index_entry *ent)
744 return auxtrace_queues__add_indexed_event(queues, session,
745 ent->file_offset, ent->sz);
748 int auxtrace_queues__process_index(struct auxtrace_queues *queues,
749 struct perf_session *session)
751 struct auxtrace_index *auxtrace_index;
752 struct auxtrace_index_entry *ent;
756 list_for_each_entry(auxtrace_index, &session->auxtrace_index, list) {
757 for (i = 0; i < auxtrace_index->nr; i++) {
758 ent = &auxtrace_index->entries[i];
759 err = auxtrace_queues__process_index_entry(queues,
769 struct auxtrace_buffer *auxtrace_buffer__next(struct auxtrace_queue *queue,
770 struct auxtrace_buffer *buffer)
773 if (list_is_last(&buffer->list, &queue->head))
775 return list_entry(buffer->list.next, struct auxtrace_buffer,
778 if (list_empty(&queue->head))
780 return list_entry(queue->head.next, struct auxtrace_buffer,
785 void *auxtrace_buffer__get_data(struct auxtrace_buffer *buffer, int fd)
787 size_t adj = buffer->data_offset & (page_size - 1);
788 size_t size = buffer->size + adj;
789 off_t file_offset = buffer->data_offset - adj;
795 addr = mmap(NULL, size, PROT_READ, MAP_SHARED, fd, file_offset);
796 if (addr == MAP_FAILED)
799 buffer->mmap_addr = addr;
800 buffer->mmap_size = size;
802 buffer->data = addr + adj;
807 void auxtrace_buffer__put_data(struct auxtrace_buffer *buffer)
809 if (!buffer->data || !buffer->mmap_addr)
811 munmap(buffer->mmap_addr, buffer->mmap_size);
812 buffer->mmap_addr = NULL;
813 buffer->mmap_size = 0;
815 buffer->use_data = NULL;
818 void auxtrace_buffer__drop_data(struct auxtrace_buffer *buffer)
820 auxtrace_buffer__put_data(buffer);
821 if (buffer->data_needs_freeing) {
822 buffer->data_needs_freeing = false;
823 zfree(&buffer->data);
824 buffer->use_data = NULL;
829 void auxtrace_buffer__free(struct auxtrace_buffer *buffer)
831 auxtrace_buffer__drop_data(buffer);
835 void auxtrace_synth_error(struct auxtrace_error_event *auxtrace_error, int type,
836 int code, int cpu, pid_t pid, pid_t tid, u64 ip,
841 memset(auxtrace_error, 0, sizeof(struct auxtrace_error_event));
843 auxtrace_error->header.type = PERF_RECORD_AUXTRACE_ERROR;
844 auxtrace_error->type = type;
845 auxtrace_error->code = code;
846 auxtrace_error->cpu = cpu;
847 auxtrace_error->pid = pid;
848 auxtrace_error->tid = tid;
849 auxtrace_error->ip = ip;
850 strlcpy(auxtrace_error->msg, msg, MAX_AUXTRACE_ERROR_MSG);
852 size = (void *)auxtrace_error->msg - (void *)auxtrace_error +
853 strlen(auxtrace_error->msg) + 1;
854 auxtrace_error->header.size = PERF_ALIGN(size, sizeof(u64));
857 int perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr,
858 struct perf_tool *tool,
859 struct perf_session *session,
860 perf_event__handler_t process)
862 union perf_event *ev;
866 pr_debug2("Synthesizing auxtrace information\n");
867 priv_size = auxtrace_record__info_priv_size(itr, session->evlist);
868 ev = zalloc(sizeof(struct auxtrace_info_event) + priv_size);
872 ev->auxtrace_info.header.type = PERF_RECORD_AUXTRACE_INFO;
873 ev->auxtrace_info.header.size = sizeof(struct auxtrace_info_event) +
875 err = auxtrace_record__info_fill(itr, session, &ev->auxtrace_info,
880 err = process(tool, ev, NULL, NULL);
886 static bool auxtrace__dont_decode(struct perf_session *session)
888 return !session->itrace_synth_opts ||
889 session->itrace_synth_opts->dont_decode;
892 int perf_event__process_auxtrace_info(struct perf_tool *tool __maybe_unused,
893 union perf_event *event,
894 struct perf_session *session)
896 enum auxtrace_type type = event->auxtrace_info.type;
899 fprintf(stdout, " type: %u\n", type);
902 case PERF_AUXTRACE_INTEL_PT:
903 return intel_pt_process_auxtrace_info(event, session);
904 case PERF_AUXTRACE_INTEL_BTS:
905 return intel_bts_process_auxtrace_info(event, session);
906 case PERF_AUXTRACE_CS_ETM:
907 case PERF_AUXTRACE_UNKNOWN:
913 s64 perf_event__process_auxtrace(struct perf_tool *tool,
914 union perf_event *event,
915 struct perf_session *session)
920 fprintf(stdout, " size: %#"PRIx64" offset: %#"PRIx64" ref: %#"PRIx64" idx: %u tid: %d cpu: %d\n",
921 event->auxtrace.size, event->auxtrace.offset,
922 event->auxtrace.reference, event->auxtrace.idx,
923 event->auxtrace.tid, event->auxtrace.cpu);
925 if (auxtrace__dont_decode(session))
926 return event->auxtrace.size;
928 if (!session->auxtrace || event->header.type != PERF_RECORD_AUXTRACE)
931 err = session->auxtrace->process_auxtrace_event(session, event, tool);
935 return event->auxtrace.size;
938 #define PERF_ITRACE_DEFAULT_PERIOD_TYPE PERF_ITRACE_PERIOD_NANOSECS
939 #define PERF_ITRACE_DEFAULT_PERIOD 100000
940 #define PERF_ITRACE_DEFAULT_CALLCHAIN_SZ 16
941 #define PERF_ITRACE_MAX_CALLCHAIN_SZ 1024
942 #define PERF_ITRACE_DEFAULT_LAST_BRANCH_SZ 64
943 #define PERF_ITRACE_MAX_LAST_BRANCH_SZ 1024
945 void itrace_synth_opts__set_default(struct itrace_synth_opts *synth_opts)
947 synth_opts->instructions = true;
948 synth_opts->branches = true;
949 synth_opts->transactions = true;
950 synth_opts->errors = true;
951 synth_opts->period_type = PERF_ITRACE_DEFAULT_PERIOD_TYPE;
952 synth_opts->period = PERF_ITRACE_DEFAULT_PERIOD;
953 synth_opts->callchain_sz = PERF_ITRACE_DEFAULT_CALLCHAIN_SZ;
954 synth_opts->last_branch_sz = PERF_ITRACE_DEFAULT_LAST_BRANCH_SZ;
955 synth_opts->initial_skip = 0;
959 * Please check tools/perf/Documentation/perf-script.txt for information
960 * about the options parsed here, which is introduced after this cset,
961 * when support in 'perf script' for these options is introduced.
963 int itrace_parse_synth_opts(const struct option *opt, const char *str,
966 struct itrace_synth_opts *synth_opts = opt->value;
969 bool period_type_set = false;
970 bool period_set = false;
972 synth_opts->set = true;
975 synth_opts->dont_decode = true;
980 itrace_synth_opts__set_default(synth_opts);
987 synth_opts->instructions = true;
988 while (*p == ' ' || *p == ',')
991 synth_opts->period = strtoull(p, &endptr, 10);
994 while (*p == ' ' || *p == ',')
998 synth_opts->period_type =
999 PERF_ITRACE_PERIOD_INSTRUCTIONS;
1000 period_type_set = true;
1003 synth_opts->period_type =
1004 PERF_ITRACE_PERIOD_TICKS;
1005 period_type_set = true;
1008 synth_opts->period *= 1000;
1011 synth_opts->period *= 1000;
1016 synth_opts->period_type =
1017 PERF_ITRACE_PERIOD_NANOSECS;
1018 period_type_set = true;
1028 synth_opts->branches = true;
1031 synth_opts->transactions = true;
1034 synth_opts->errors = true;
1037 synth_opts->log = true;
1040 synth_opts->branches = true;
1041 synth_opts->calls = true;
1044 synth_opts->branches = true;
1045 synth_opts->returns = true;
1048 synth_opts->callchain = true;
1049 synth_opts->callchain_sz =
1050 PERF_ITRACE_DEFAULT_CALLCHAIN_SZ;
1051 while (*p == ' ' || *p == ',')
1056 val = strtoul(p, &endptr, 10);
1058 if (!val || val > PERF_ITRACE_MAX_CALLCHAIN_SZ)
1060 synth_opts->callchain_sz = val;
1064 synth_opts->last_branch = true;
1065 synth_opts->last_branch_sz =
1066 PERF_ITRACE_DEFAULT_LAST_BRANCH_SZ;
1067 while (*p == ' ' || *p == ',')
1072 val = strtoul(p, &endptr, 10);
1075 val > PERF_ITRACE_MAX_LAST_BRANCH_SZ)
1077 synth_opts->last_branch_sz = val;
1081 synth_opts->initial_skip = strtoul(p, &endptr, 10);
1094 if (synth_opts->instructions) {
1095 if (!period_type_set)
1096 synth_opts->period_type =
1097 PERF_ITRACE_DEFAULT_PERIOD_TYPE;
1099 synth_opts->period = PERF_ITRACE_DEFAULT_PERIOD;
1105 pr_err("Bad Instruction Tracing options '%s'\n", str);
1109 static const char * const auxtrace_error_type_name[] = {
1110 [PERF_AUXTRACE_ERROR_ITRACE] = "instruction trace",
1113 static const char *auxtrace_error_name(int type)
1115 const char *error_type_name = NULL;
1117 if (type < PERF_AUXTRACE_ERROR_MAX)
1118 error_type_name = auxtrace_error_type_name[type];
1119 if (!error_type_name)
1120 error_type_name = "unknown AUX";
1121 return error_type_name;
1124 size_t perf_event__fprintf_auxtrace_error(union perf_event *event, FILE *fp)
1126 struct auxtrace_error_event *e = &event->auxtrace_error;
1129 ret = fprintf(fp, " %s error type %u",
1130 auxtrace_error_name(e->type), e->type);
1131 ret += fprintf(fp, " cpu %d pid %d tid %d ip %#"PRIx64" code %u: %s\n",
1132 e->cpu, e->pid, e->tid, e->ip, e->code, e->msg);
1136 void perf_session__auxtrace_error_inc(struct perf_session *session,
1137 union perf_event *event)
1139 struct auxtrace_error_event *e = &event->auxtrace_error;
1141 if (e->type < PERF_AUXTRACE_ERROR_MAX)
1142 session->evlist->stats.nr_auxtrace_errors[e->type] += 1;
1145 void events_stats__auxtrace_error_warn(const struct events_stats *stats)
1149 for (i = 0; i < PERF_AUXTRACE_ERROR_MAX; i++) {
1150 if (!stats->nr_auxtrace_errors[i])
1152 ui__warning("%u %s errors\n",
1153 stats->nr_auxtrace_errors[i],
1154 auxtrace_error_name(i));
1158 int perf_event__process_auxtrace_error(struct perf_tool *tool __maybe_unused,
1159 union perf_event *event,
1160 struct perf_session *session)
1162 if (auxtrace__dont_decode(session))
1165 perf_event__fprintf_auxtrace_error(event, stdout);
1169 static int __auxtrace_mmap__read(struct auxtrace_mmap *mm,
1170 struct auxtrace_record *itr,
1171 struct perf_tool *tool, process_auxtrace_t fn,
1172 bool snapshot, size_t snapshot_size)
1174 u64 head, old = mm->prev, offset, ref;
1175 unsigned char *data = mm->base;
1176 size_t size, head_off, old_off, len1, len2, padding;
1177 union perf_event ev;
1178 void *data1, *data2;
1181 head = auxtrace_mmap__read_snapshot_head(mm);
1182 if (auxtrace_record__find_snapshot(itr, mm->idx, mm, data,
1186 head = auxtrace_mmap__read_head(mm);
1192 pr_debug3("auxtrace idx %d old %#"PRIx64" head %#"PRIx64" diff %#"PRIx64"\n",
1193 mm->idx, old, head, head - old);
1196 head_off = head & mm->mask;
1197 old_off = old & mm->mask;
1199 head_off = head % mm->len;
1200 old_off = old % mm->len;
1203 if (head_off > old_off)
1204 size = head_off - old_off;
1206 size = mm->len - (old_off - head_off);
1208 if (snapshot && size > snapshot_size)
1209 size = snapshot_size;
1211 ref = auxtrace_record__reference(itr);
1213 if (head > old || size <= head || mm->mask) {
1214 offset = head - size;
1217 * When the buffer size is not a power of 2, 'head' wraps at the
1218 * highest multiple of the buffer size, so we have to subtract
1219 * the remainder here.
1221 u64 rem = (0ULL - mm->len) % mm->len;
1223 offset = head - size - rem;
1226 if (size > head_off) {
1227 len1 = size - head_off;
1228 data1 = &data[mm->len - len1];
1233 data1 = &data[head_off - len1];
1238 if (itr->alignment) {
1239 unsigned int unwanted = len1 % itr->alignment;
1245 /* padding must be written by fn() e.g. record__process_auxtrace() */
1248 padding = 8 - padding;
1250 memset(&ev, 0, sizeof(ev));
1251 ev.auxtrace.header.type = PERF_RECORD_AUXTRACE;
1252 ev.auxtrace.header.size = sizeof(ev.auxtrace);
1253 ev.auxtrace.size = size + padding;
1254 ev.auxtrace.offset = offset;
1255 ev.auxtrace.reference = ref;
1256 ev.auxtrace.idx = mm->idx;
1257 ev.auxtrace.tid = mm->tid;
1258 ev.auxtrace.cpu = mm->cpu;
1260 if (fn(tool, &ev, data1, len1, data2, len2))
1266 auxtrace_mmap__write_tail(mm, head);
1267 if (itr->read_finish) {
1270 err = itr->read_finish(itr, mm->idx);
1279 int auxtrace_mmap__read(struct auxtrace_mmap *mm, struct auxtrace_record *itr,
1280 struct perf_tool *tool, process_auxtrace_t fn)
1282 return __auxtrace_mmap__read(mm, itr, tool, fn, false, 0);
1285 int auxtrace_mmap__read_snapshot(struct auxtrace_mmap *mm,
1286 struct auxtrace_record *itr,
1287 struct perf_tool *tool, process_auxtrace_t fn,
1288 size_t snapshot_size)
1290 return __auxtrace_mmap__read(mm, itr, tool, fn, true, snapshot_size);
1294 * struct auxtrace_cache - hash table to implement a cache
1295 * @hashtable: the hashtable
1296 * @sz: hashtable size (number of hlists)
1297 * @entry_size: size of an entry
1298 * @limit: limit the number of entries to this maximum, when reached the cache
1299 * is dropped and caching begins again with an empty cache
1300 * @cnt: current number of entries
1301 * @bits: hashtable size (@sz = 2^@bits)
1303 struct auxtrace_cache {
1304 struct hlist_head *hashtable;
1312 struct auxtrace_cache *auxtrace_cache__new(unsigned int bits, size_t entry_size,
1313 unsigned int limit_percent)
1315 struct auxtrace_cache *c;
1316 struct hlist_head *ht;
1319 c = zalloc(sizeof(struct auxtrace_cache));
1325 ht = calloc(sz, sizeof(struct hlist_head));
1329 for (i = 0; i < sz; i++)
1330 INIT_HLIST_HEAD(&ht[i]);
1334 c->entry_size = entry_size;
1335 c->limit = (c->sz * limit_percent) / 100;
1345 static void auxtrace_cache__drop(struct auxtrace_cache *c)
1347 struct auxtrace_cache_entry *entry;
1348 struct hlist_node *tmp;
1354 for (i = 0; i < c->sz; i++) {
1355 hlist_for_each_entry_safe(entry, tmp, &c->hashtable[i], hash) {
1356 hlist_del(&entry->hash);
1357 auxtrace_cache__free_entry(c, entry);
1364 void auxtrace_cache__free(struct auxtrace_cache *c)
1369 auxtrace_cache__drop(c);
1374 void *auxtrace_cache__alloc_entry(struct auxtrace_cache *c)
1376 return malloc(c->entry_size);
1379 void auxtrace_cache__free_entry(struct auxtrace_cache *c __maybe_unused,
1385 int auxtrace_cache__add(struct auxtrace_cache *c, u32 key,
1386 struct auxtrace_cache_entry *entry)
1388 if (c->limit && ++c->cnt > c->limit)
1389 auxtrace_cache__drop(c);
1392 hlist_add_head(&entry->hash, &c->hashtable[hash_32(key, c->bits)]);
1397 void *auxtrace_cache__lookup(struct auxtrace_cache *c, u32 key)
1399 struct auxtrace_cache_entry *entry;
1400 struct hlist_head *hlist;
1405 hlist = &c->hashtable[hash_32(key, c->bits)];
1406 hlist_for_each_entry(entry, hlist, hash) {
1407 if (entry->key == key)
1414 static void addr_filter__free_str(struct addr_filter *filt)
1417 filt->action = NULL;
1418 filt->sym_from = NULL;
1419 filt->sym_to = NULL;
1420 filt->filename = NULL;
1424 static struct addr_filter *addr_filter__new(void)
1426 struct addr_filter *filt = zalloc(sizeof(*filt));
1429 INIT_LIST_HEAD(&filt->list);
1434 static void addr_filter__free(struct addr_filter *filt)
1437 addr_filter__free_str(filt);
1441 static void addr_filters__add(struct addr_filters *filts,
1442 struct addr_filter *filt)
1444 list_add_tail(&filt->list, &filts->head);
1448 static void addr_filters__del(struct addr_filters *filts,
1449 struct addr_filter *filt)
1451 list_del_init(&filt->list);
1455 void addr_filters__init(struct addr_filters *filts)
1457 INIT_LIST_HEAD(&filts->head);
1461 void addr_filters__exit(struct addr_filters *filts)
1463 struct addr_filter *filt, *n;
1465 list_for_each_entry_safe(filt, n, &filts->head, list) {
1466 addr_filters__del(filts, filt);
1467 addr_filter__free(filt);
1471 static int parse_num_or_str(char **inp, u64 *num, const char **str,
1472 const char *str_delim)
1474 *inp += strspn(*inp, " ");
1476 if (isdigit(**inp)) {
1482 *num = strtoull(*inp, &endptr, 0);
1493 *inp += strspn(*inp, " ");
1495 n = strcspn(*inp, str_delim);
1507 static int parse_action(struct addr_filter *filt)
1509 if (!strcmp(filt->action, "filter")) {
1512 } else if (!strcmp(filt->action, "start")) {
1514 } else if (!strcmp(filt->action, "stop")) {
1515 filt->start = false;
1516 } else if (!strcmp(filt->action, "tracestop")) {
1517 filt->start = false;
1519 filt->action += 5; /* Change 'tracestop' to 'stop' */
1526 static int parse_sym_idx(char **inp, int *idx)
1530 *inp += strspn(*inp, " ");
1537 if (**inp == 'g' || **inp == 'G') {
1545 num = strtoul(*inp, &endptr, 0);
1548 if (endptr == *inp || num > INT_MAX)
1557 static int parse_addr_size(char **inp, u64 *num, const char **str, int *idx)
1559 int err = parse_num_or_str(inp, num, str, " ");
1562 err = parse_sym_idx(inp, idx);
1567 static int parse_one_filter(struct addr_filter *filt, const char **filter_inp)
1572 filt->str = fstr = strdup(*filter_inp);
1576 err = parse_num_or_str(&fstr, NULL, &filt->action, " ");
1580 err = parse_action(filt);
1584 err = parse_addr_size(&fstr, &filt->addr, &filt->sym_from,
1585 &filt->sym_from_idx);
1589 fstr += strspn(fstr, " ");
1593 err = parse_addr_size(&fstr, &filt->size, &filt->sym_to,
1600 fstr += strspn(fstr, " ");
1604 err = parse_num_or_str(&fstr, NULL, &filt->filename, " ,");
1609 fstr += strspn(fstr, " ,");
1611 *filter_inp += fstr - filt->str;
1616 addr_filter__free_str(filt);
1621 int addr_filters__parse_bare_filter(struct addr_filters *filts,
1624 struct addr_filter *filt;
1625 const char *fstr = filter;
1629 filt = addr_filter__new();
1630 err = parse_one_filter(filt, &fstr);
1632 addr_filter__free(filt);
1633 addr_filters__exit(filts);
1636 addr_filters__add(filts, filt);
1655 static bool kern_sym_match(struct sym_args *args, const char *name, char type)
1657 /* A function with the same name, and global or the n'th found or any */
1658 return symbol_type__is_a(type, MAP__FUNCTION) &&
1659 !strcmp(name, args->name) &&
1660 ((args->global && isupper(type)) ||
1661 (args->selected && ++(args->cnt) == args->idx) ||
1662 (!args->global && !args->selected));
1665 static int find_kern_sym_cb(void *arg, const char *name, char type, u64 start)
1667 struct sym_args *args = arg;
1669 if (args->started) {
1671 args->size = start - args->start;
1672 if (args->selected) {
1675 } else if (kern_sym_match(args, name, type)) {
1676 args->duplicate = true;
1679 } else if (kern_sym_match(args, name, type)) {
1680 args->started = true;
1681 args->start = start;
1687 static int print_kern_sym_cb(void *arg, const char *name, char type, u64 start)
1689 struct sym_args *args = arg;
1691 if (kern_sym_match(args, name, type)) {
1692 pr_err("#%d\t0x%"PRIx64"\t%c\t%s\n",
1693 ++args->cnt, start, type, name);
1695 } else if (args->near) {
1697 pr_err("\t\twhich is near\t\t%s\n", name);
1703 static int sym_not_found_error(const char *sym_name, int idx)
1706 pr_err("N'th occurrence (N=%d) of symbol '%s' not found.\n",
1709 pr_err("Global symbol '%s' not found.\n", sym_name);
1711 pr_err("Symbol '%s' not found.\n", sym_name);
1713 pr_err("Note that symbols must be functions.\n");
1718 static int find_kern_sym(const char *sym_name, u64 *start, u64 *size, int idx)
1720 struct sym_args args = {
1724 .selected = idx > 0,
1731 err = kallsyms__parse("/proc/kallsyms", &args, find_kern_sym_cb);
1733 pr_err("Failed to parse /proc/kallsyms\n");
1737 if (args.duplicate) {
1738 pr_err("Multiple kernel symbols with name '%s'\n", sym_name);
1740 kallsyms__parse("/proc/kallsyms", &args, print_kern_sym_cb);
1741 pr_err("Disambiguate symbol name by inserting #n after the name e.g. %s #2\n",
1743 pr_err("Or select a global symbol by inserting #0 or #g or #G\n");
1747 if (!args.started) {
1748 pr_err("Kernel symbol lookup: ");
1749 return sym_not_found_error(sym_name, idx);
1752 *start = args.start;
1758 static int find_entire_kern_cb(void *arg, const char *name __maybe_unused,
1759 char type, u64 start)
1761 struct sym_args *args = arg;
1763 if (!symbol_type__is_a(type, MAP__FUNCTION))
1766 if (!args->started) {
1767 args->started = true;
1768 args->start = start;
1770 /* Don't know exactly where the kernel ends, so we add a page */
1771 args->size = round_up(start, page_size) + page_size - args->start;
1776 static int addr_filter__entire_kernel(struct addr_filter *filt)
1778 struct sym_args args = { .started = false };
1781 err = kallsyms__parse("/proc/kallsyms", &args, find_entire_kern_cb);
1782 if (err < 0 || !args.started) {
1783 pr_err("Failed to parse /proc/kallsyms\n");
1787 filt->addr = args.start;
1788 filt->size = args.size;
1793 static int check_end_after_start(struct addr_filter *filt, u64 start, u64 size)
1795 if (start + size >= filt->addr)
1798 if (filt->sym_from) {
1799 pr_err("Symbol '%s' (0x%"PRIx64") comes before '%s' (0x%"PRIx64")\n",
1800 filt->sym_to, start, filt->sym_from, filt->addr);
1802 pr_err("Symbol '%s' (0x%"PRIx64") comes before address 0x%"PRIx64")\n",
1803 filt->sym_to, start, filt->addr);
1809 static int addr_filter__resolve_kernel_syms(struct addr_filter *filt)
1811 bool no_size = false;
1815 if (symbol_conf.kptr_restrict) {
1816 pr_err("Kernel addresses are restricted. Unable to resolve kernel symbols.\n");
1820 if (filt->sym_from && !strcmp(filt->sym_from, "*"))
1821 return addr_filter__entire_kernel(filt);
1823 if (filt->sym_from) {
1824 err = find_kern_sym(filt->sym_from, &start, &size,
1825 filt->sym_from_idx);
1829 if (filt->range && !filt->size && !filt->sym_to) {
1836 err = find_kern_sym(filt->sym_to, &start, &size,
1841 err = check_end_after_start(filt, start, size);
1844 filt->size = start + size - filt->addr;
1848 /* The very last symbol in kallsyms does not imply a particular size */
1850 pr_err("Cannot determine size of symbol '%s'\n",
1851 filt->sym_to ? filt->sym_to : filt->sym_from);
1858 static struct dso *load_dso(const char *name)
1863 map = dso__new_map(name);
1869 dso = dso__get(map->dso);
1876 static bool dso_sym_match(struct symbol *sym, const char *name, int *cnt,
1879 /* Same name, and global or the n'th found or any */
1880 return !arch__compare_symbol_names(name, sym->name) &&
1881 ((!idx && sym->binding == STB_GLOBAL) ||
1882 (idx > 0 && ++*cnt == idx) ||
1886 static void print_duplicate_syms(struct dso *dso, const char *sym_name)
1892 pr_err("Multiple symbols with name '%s'\n", sym_name);
1894 sym = dso__first_symbol(dso, MAP__FUNCTION);
1896 if (dso_sym_match(sym, sym_name, &cnt, -1)) {
1897 pr_err("#%d\t0x%"PRIx64"\t%c\t%s\n",
1899 sym->binding == STB_GLOBAL ? 'g' :
1900 sym->binding == STB_LOCAL ? 'l' : 'w',
1905 pr_err("\t\twhich is near\t\t%s\n", sym->name);
1907 sym = dso__next_symbol(sym);
1910 pr_err("Disambiguate symbol name by inserting #n after the name e.g. %s #2\n",
1912 pr_err("Or select a global symbol by inserting #0 or #g or #G\n");
1915 static int find_dso_sym(struct dso *dso, const char *sym_name, u64 *start,
1924 sym = dso__first_symbol(dso, MAP__FUNCTION);
1928 *size = sym->start - *start;
1932 } else if (dso_sym_match(sym, sym_name, &cnt, idx)) {
1933 print_duplicate_syms(dso, sym_name);
1936 } else if (dso_sym_match(sym, sym_name, &cnt, idx)) {
1937 *start = sym->start;
1938 *size = sym->end - sym->start;
1940 sym = dso__next_symbol(sym);
1944 return sym_not_found_error(sym_name, idx);
1949 static int addr_filter__entire_dso(struct addr_filter *filt, struct dso *dso)
1951 struct symbol *first_sym = dso__first_symbol(dso, MAP__FUNCTION);
1952 struct symbol *last_sym = dso__last_symbol(dso, MAP__FUNCTION);
1954 if (!first_sym || !last_sym) {
1955 pr_err("Failed to determine filter for %s\nNo symbols found.\n",
1960 filt->addr = first_sym->start;
1961 filt->size = last_sym->end - first_sym->start;
1966 static int addr_filter__resolve_syms(struct addr_filter *filt)
1972 if (!filt->sym_from && !filt->sym_to)
1975 if (!filt->filename)
1976 return addr_filter__resolve_kernel_syms(filt);
1978 dso = load_dso(filt->filename);
1980 pr_err("Failed to load symbols from: %s\n", filt->filename);
1984 if (filt->sym_from && !strcmp(filt->sym_from, "*")) {
1985 err = addr_filter__entire_dso(filt, dso);
1989 if (filt->sym_from) {
1990 err = find_dso_sym(dso, filt->sym_from, &start, &size,
1991 filt->sym_from_idx);
1995 if (filt->range && !filt->size && !filt->sym_to)
2000 err = find_dso_sym(dso, filt->sym_to, &start, &size,
2005 err = check_end_after_start(filt, start, size);
2009 filt->size = start + size - filt->addr;
2018 static char *addr_filter__to_str(struct addr_filter *filt)
2020 char filename_buf[PATH_MAX];
2021 const char *at = "";
2022 const char *fn = "";
2026 if (filt->filename) {
2028 fn = realpath(filt->filename, filename_buf);
2034 err = asprintf(&filter, "%s 0x%"PRIx64"/0x%"PRIx64"%s%s",
2035 filt->action, filt->addr, filt->size, at, fn);
2037 err = asprintf(&filter, "%s 0x%"PRIx64"%s%s",
2038 filt->action, filt->addr, at, fn);
2041 return err < 0 ? NULL : filter;
2044 static int parse_addr_filter(struct perf_evsel *evsel, const char *filter,
2047 struct addr_filters filts;
2048 struct addr_filter *filt;
2051 addr_filters__init(&filts);
2053 err = addr_filters__parse_bare_filter(&filts, filter);
2057 if (filts.cnt > max_nr) {
2058 pr_err("Error: number of address filters (%d) exceeds maximum (%d)\n",
2064 list_for_each_entry(filt, &filts.head, list) {
2067 err = addr_filter__resolve_syms(filt);
2071 new_filter = addr_filter__to_str(filt);
2077 if (perf_evsel__append_addr_filter(evsel, new_filter)) {
2084 addr_filters__exit(&filts);
2087 pr_err("Failed to parse address filter: '%s'\n", filter);
2088 pr_err("Filter format is: filter|start|stop|tracestop <start symbol or address> [/ <end symbol or size>] [@<file name>]\n");
2089 pr_err("Where multiple filters are separated by space or comma.\n");
2095 static struct perf_pmu *perf_evsel__find_pmu(struct perf_evsel *evsel)
2097 struct perf_pmu *pmu = NULL;
2099 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
2100 if (pmu->type == evsel->attr.type)
2107 static int perf_evsel__nr_addr_filter(struct perf_evsel *evsel)
2109 struct perf_pmu *pmu = perf_evsel__find_pmu(evsel);
2110 int nr_addr_filters = 0;
2115 perf_pmu__scan_file(pmu, "nr_addr_filters", "%d", &nr_addr_filters);
2117 return nr_addr_filters;
2120 int auxtrace_parse_filters(struct perf_evlist *evlist)
2122 struct perf_evsel *evsel;
2126 evlist__for_each_entry(evlist, evsel) {
2127 filter = evsel->filter;
2128 max_nr = perf_evsel__nr_addr_filter(evsel);
2129 if (!filter || !max_nr)
2131 evsel->filter = NULL;
2132 err = parse_addr_filter(evsel, filter, max_nr);
2136 pr_debug("Address filter: %s\n", evsel->filter);