tools/perf/util/auxtrace.c

   1 /*
   2  * auxtrace.c: AUX area trace support
   3  * Copyright (c) 2013-2015, Intel Corporation.
   4  *
   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.
   8  *
   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
  12  * more details.
  13  *
  14  */
  15
  16 #include <inttypes.h>
  17 #include <sys/types.h>
  18 #include <sys/mman.h>
  19 #include <stdbool.h>
  20 #include <string.h>
  21 #include <limits.h>
  22 #include <errno.h>
  23
  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>
  30
  31 #include <sys/param.h>
  32 #include <stdlib.h>
  33 #include <stdio.h>
  34 #include <linux/list.h>
  35
  36 #include "../perf.h"
  37 #include "util.h"
  38 #include "evlist.h"
  39 #include "dso.h"
  40 #include "map.h"
  41 #include "pmu.h"
  42 #include "evsel.h"
  43 #include "cpumap.h"
  44 #include "thread_map.h"
  45 #include "asm/bug.h"
  46 #include "auxtrace.h"
  47
  48 #include <linux/hash.h>
  49
  50 #include "event.h"
  51 #include "session.h"
  52 #include "debug.h"
  53 #include <subcmd/parse-options.h>
  54
  55 #include "cs-etm.h"
  56 #include "intel-pt.h"
  57 #include "intel-bts.h"
  58 #include "arm-spe.h"
  59 #include "s390-cpumsf.h"
  60
  61 #include "sane_ctype.h"
  62 #include "symbol/kallsyms.h"
  63
  64 static bool auxtrace__dont_decode(struct perf_session *session)
  65 {
  66         return !session->itrace_synth_opts ||
  67                session->itrace_synth_opts->dont_decode;
  68 }
  69
  70 int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
  71                         struct auxtrace_mmap_params *mp,
  72                         void *userpg, int fd)
  73 {
  74         struct perf_event_mmap_page *pc = userpg;
  75
  76         WARN_ONCE(mm->base, "Uninitialized auxtrace_mmap\n");
  77
  78         mm->userpg = userpg;
  79         mm->mask = mp->mask;
  80         mm->len = mp->len;
  81         mm->prev = 0;
  82         mm->idx = mp->idx;
  83         mm->tid = mp->tid;
  84         mm->cpu = mp->cpu;
  85
  86         if (!mp->len) {
  87                 mm->base = NULL;
  88                 return 0;
  89         }
  90
  91 #if BITS_PER_LONG != 64 && !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
  92         pr_err("Cannot use AUX area tracing mmaps\n");
  93         return -1;
  94 #endif
  95
  96         pc->aux_offset = mp->offset;
  97         pc->aux_size = mp->len;
  98
  99         mm->base = mmap(NULL, mp->len, mp->prot, MAP_SHARED, fd, mp->offset);
 100         if (mm->base == MAP_FAILED) {
 101                 pr_debug2("failed to mmap AUX area\n");
 102                 mm->base = NULL;
 103                 return -1;
 104         }
 105
 106         return 0;
 107 }
 108
 109 void auxtrace_mmap__munmap(struct auxtrace_mmap *mm)
 110 {
 111         if (mm->base) {
 112                 munmap(mm->base, mm->len);
 113                 mm->base = NULL;
 114         }
 115 }
 116
 117 void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
 118                                 off_t auxtrace_offset,
 119                                 unsigned int auxtrace_pages,
 120                                 bool auxtrace_overwrite)
 121 {
 122         if (auxtrace_pages) {
 123                 mp->offset = auxtrace_offset;
 124                 mp->len = auxtrace_pages * (size_t)page_size;
 125                 mp->mask = is_power_of_2(mp->len) ? mp->len - 1 : 0;
 126                 mp->prot = PROT_READ | (auxtrace_overwrite ? 0 : PROT_WRITE);
 127                 pr_debug2("AUX area mmap length %zu\n", mp->len);
 128         } else {
 129                 mp->len = 0;
 130         }
 131 }
 132
 133 void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
 134                                    struct perf_evlist *evlist, int idx,
 135                                    bool per_cpu)
 136 {
 137         mp->idx = idx;
 138
 139         if (per_cpu) {
 140                 mp->cpu = evlist->cpus->map[idx];
 141                 if (evlist->threads)
 142                         mp->tid = thread_map__pid(evlist->threads, 0);
 143                 else
 144                         mp->tid = -1;
 145         } else {
 146                 mp->cpu = -1;
 147                 mp->tid = thread_map__pid(evlist->threads, idx);
 148         }
 149 }
 150
 151 #define AUXTRACE_INIT_NR_QUEUES 32
 152
 153 static struct auxtrace_queue *auxtrace_alloc_queue_array(unsigned int nr_queues)
 154 {
 155         struct auxtrace_queue *queue_array;
 156         unsigned int max_nr_queues, i;
 157
 158         max_nr_queues = UINT_MAX / sizeof(struct auxtrace_queue);
 159         if (nr_queues > max_nr_queues)
 160                 return NULL;
 161
 162         queue_array = calloc(nr_queues, sizeof(struct auxtrace_queue));
 163         if (!queue_array)
 164                 return NULL;
 165
 166         for (i = 0; i < nr_queues; i++) {
 167                 INIT_LIST_HEAD(&queue_array[i].head);
 168                 queue_array[i].priv = NULL;
 169         }
 170
 171         return queue_array;
 172 }
 173
 174 int auxtrace_queues__init(struct auxtrace_queues *queues)
 175 {
 176         queues->nr_queues = AUXTRACE_INIT_NR_QUEUES;
 177         queues->queue_array = auxtrace_alloc_queue_array(queues->nr_queues);
 178         if (!queues->queue_array)
 179                 return -ENOMEM;
 180         return 0;
 181 }
 182
 183 static int auxtrace_queues__grow(struct auxtrace_queues *queues,
 184                                  unsigned int new_nr_queues)
 185 {
 186         unsigned int nr_queues = queues->nr_queues;
 187         struct auxtrace_queue *queue_array;
 188         unsigned int i;
 189
 190         if (!nr_queues)
 191                 nr_queues = AUXTRACE_INIT_NR_QUEUES;
 192
 193         while (nr_queues && nr_queues < new_nr_queues)
 194                 nr_queues <<= 1;
 195
 196         if (nr_queues < queues->nr_queues || nr_queues < new_nr_queues)
 197                 return -EINVAL;
 198
 199         queue_array = auxtrace_alloc_queue_array(nr_queues);
 200         if (!queue_array)
 201                 return -ENOMEM;
 202
 203         for (i = 0; i < queues->nr_queues; i++) {
 204                 list_splice_tail(&queues->queue_array[i].head,
 205                                  &queue_array[i].head);
 206                 queue_array[i].tid = queues->queue_array[i].tid;
 207                 queue_array[i].cpu = queues->queue_array[i].cpu;
 208                 queue_array[i].set = queues->queue_array[i].set;
 209                 queue_array[i].priv = queues->queue_array[i].priv;
 210         }
 211
 212         queues->nr_queues = nr_queues;
 213         queues->queue_array = queue_array;
 214
 215         return 0;
 216 }
 217
 218 static void *auxtrace_copy_data(u64 size, struct perf_session *session)
 219 {
 220         int fd = perf_data__fd(session->data);
 221         void *p;
 222         ssize_t ret;
 223
 224         if (size > SSIZE_MAX)
 225                 return NULL;
 226
 227         p = malloc(size);
 228         if (!p)
 229                 return NULL;
 230
 231         ret = readn(fd, p, size);
 232         if (ret != (ssize_t)size) {
 233                 free(p);
 234                 return NULL;
 235         }
 236
 237         return p;
 238 }
 239
 240 static int auxtrace_queues__queue_buffer(struct auxtrace_queues *queues,
 241                                          unsigned int idx,
 242                                          struct auxtrace_buffer *buffer)
 243 {
 244         struct auxtrace_queue *queue;
 245         int err;
 246
 247         if (idx >= queues->nr_queues) {
 248                 err = auxtrace_queues__grow(queues, idx + 1);
 249                 if (err)
 250                         return err;
 251         }
 252
 253         queue = &queues->queue_array[idx];
 254
 255         if (!queue->set) {
 256                 queue->set = true;
 257                 queue->tid = buffer->tid;
 258                 queue->cpu = buffer->cpu;
 259         }
 260
 261         buffer->buffer_nr = queues->next_buffer_nr++;
 262
 263         list_add_tail(&buffer->list, &queue->head);
 264
 265         queues->new_data = true;
 266         queues->populated = true;
 267
 268         return 0;
 269 }
 270
 271 /* Limit buffers to 32MiB on 32-bit */
 272 #define BUFFER_LIMIT_FOR_32_BIT (32 * 1024 * 1024)
 273
 274 static int auxtrace_queues__split_buffer(struct auxtrace_queues *queues,
 275                                          unsigned int idx,
 276                                          struct auxtrace_buffer *buffer)
 277 {
 278         u64 sz = buffer->size;
 279         bool consecutive = false;
 280         struct auxtrace_buffer *b;
 281         int err;
 282
 283         while (sz > BUFFER_LIMIT_FOR_32_BIT) {
 284                 b = memdup(buffer, sizeof(struct auxtrace_buffer));
 285                 if (!b)
 286                         return -ENOMEM;
 287                 b->size = BUFFER_LIMIT_FOR_32_BIT;
 288                 b->consecutive = consecutive;
 289                 err = auxtrace_queues__queue_buffer(queues, idx, b);
 290                 if (err) {
 291                         auxtrace_buffer__free(b);
 292                         return err;
 293                 }
 294                 buffer->data_offset += BUFFER_LIMIT_FOR_32_BIT;
 295                 sz -= BUFFER_LIMIT_FOR_32_BIT;
 296                 consecutive = true;
 297         }
 298
 299         buffer->size = sz;
 300         buffer->consecutive = consecutive;
 301
 302         return 0;
 303 }
 304
 305 static bool filter_cpu(struct perf_session *session, int cpu)
 306 {
 307         unsigned long *cpu_bitmap = session->itrace_synth_opts->cpu_bitmap;
 308
 309         return cpu_bitmap && cpu != -1 && !test_bit(cpu, cpu_bitmap);
 310 }
 311
 312 static int auxtrace_queues__add_buffer(struct auxtrace_queues *queues,
 313                                        struct perf_session *session,
 314                                        unsigned int idx,
 315                                        struct auxtrace_buffer *buffer,
 316                                        struct auxtrace_buffer **buffer_ptr)
 317 {
 318         int err = -ENOMEM;
 319
 320         if (filter_cpu(session, buffer->cpu))
 321                 return 0;
 322
 323         buffer = memdup(buffer, sizeof(*buffer));
 324         if (!buffer)
 325                 return -ENOMEM;
 326
 327         if (session->one_mmap) {
 328                 buffer->data = buffer->data_offset - session->one_mmap_offset +
 329                                session->one_mmap_addr;
 330         } else if (perf_data__is_pipe(session->data)) {
 331                 buffer->data = auxtrace_copy_data(buffer->size, session);
 332                 if (!buffer->data)
 333                         goto out_free;
 334                 buffer->data_needs_freeing = true;
 335         } else if (BITS_PER_LONG == 32 &&
 336                    buffer->size > BUFFER_LIMIT_FOR_32_BIT) {
 337                 err = auxtrace_queues__split_buffer(queues, idx, buffer);
 338                 if (err)
 339                         goto out_free;
 340         }
 341
 342         err = auxtrace_queues__queue_buffer(queues, idx, buffer);
 343         if (err)
 344                 goto out_free;
 345
 346         /* FIXME: Doesn't work for split buffer */
 347         if (buffer_ptr)
 348                 *buffer_ptr = buffer;
 349
 350         return 0;
 351
 352 out_free:
 353         auxtrace_buffer__free(buffer);
 354         return err;
 355 }
 356
 357 int auxtrace_queues__add_event(struct auxtrace_queues *queues,
 358                                struct perf_session *session,
 359                                union perf_event *event, off_t data_offset,
 360                                struct auxtrace_buffer **buffer_ptr)
 361 {
 362         struct auxtrace_buffer buffer = {
 363                 .pid = -1,
 364                 .tid = event->auxtrace.tid,
 365                 .cpu = event->auxtrace.cpu,
 366                 .data_offset = data_offset,
 367                 .offset = event->auxtrace.offset,
 368                 .reference = event->auxtrace.reference,
 369                 .size = event->auxtrace.size,
 370         };
 371         unsigned int idx = event->auxtrace.idx;
 372
 373         return auxtrace_queues__add_buffer(queues, session, idx, &buffer,
 374                                            buffer_ptr);
 375 }
 376
 377 static int auxtrace_queues__add_indexed_event(struct auxtrace_queues *queues,
 378                                               struct perf_session *session,
 379                                               off_t file_offset, size_t sz)
 380 {
 381         union perf_event *event;
 382         int err;
 383         char buf[PERF_SAMPLE_MAX_SIZE];
 384
 385         err = perf_session__peek_event(session, file_offset, buf,
 386                                        PERF_SAMPLE_MAX_SIZE, &event, NULL);
 387         if (err)
 388                 return err;
 389
 390         if (event->header.type == PERF_RECORD_AUXTRACE) {
 391                 if (event->header.size < sizeof(struct auxtrace_event) ||
 392                     event->header.size != sz) {
 393                         err = -EINVAL;
 394                         goto out;
 395                 }
 396                 file_offset += event->header.size;
 397                 err = auxtrace_queues__add_event(queues, session, event,
 398                                                  file_offset, NULL);
 399         }
 400 out:
 401         return err;
 402 }
 403
 404 void auxtrace_queues__free(struct auxtrace_queues *queues)
 405 {
 406         unsigned int i;
 407
 408         for (i = 0; i < queues->nr_queues; i++) {
 409                 while (!list_empty(&queues->queue_array[i].head)) {
 410                         struct auxtrace_buffer *buffer;
 411
 412                         buffer = list_entry(queues->queue_array[i].head.next,
 413                                             struct auxtrace_buffer, list);
 414                         list_del(&buffer->list);
 415                         auxtrace_buffer__free(buffer);
 416                 }
 417         }
 418
 419         zfree(&queues->queue_array);
 420         queues->nr_queues = 0;
 421 }
 422
 423 static void auxtrace_heapify(struct auxtrace_heap_item *heap_array,
 424                              unsigned int pos, unsigned int queue_nr,
 425                              u64 ordinal)
 426 {
 427         unsigned int parent;
 428
 429         while (pos) {
 430                 parent = (pos - 1) >> 1;
 431                 if (heap_array[parent].ordinal <= ordinal)
 432                         break;
 433                 heap_array[pos] = heap_array[parent];
 434                 pos = parent;
 435         }
 436         heap_array[pos].queue_nr = queue_nr;
 437         heap_array[pos].ordinal = ordinal;
 438 }
 439
 440 int auxtrace_heap__add(struct auxtrace_heap *heap, unsigned int queue_nr,
 441                        u64 ordinal)
 442 {
 443         struct auxtrace_heap_item *heap_array;
 444
 445         if (queue_nr >= heap->heap_sz) {
 446                 unsigned int heap_sz = AUXTRACE_INIT_NR_QUEUES;
 447
 448                 while (heap_sz <= queue_nr)
 449                         heap_sz <<= 1;
 450                 heap_array = realloc(heap->heap_array,
 451                                      heap_sz * sizeof(struct auxtrace_heap_item));
 452                 if (!heap_array)
 453                         return -ENOMEM;
 454                 heap->heap_array = heap_array;
 455                 heap->heap_sz = heap_sz;
 456         }
 457
 458         auxtrace_heapify(heap->heap_array, heap->heap_cnt++, queue_nr, ordinal);
 459
 460         return 0;
 461 }
 462
 463 void auxtrace_heap__free(struct auxtrace_heap *heap)
 464 {
 465         zfree(&heap->heap_array);
 466         heap->heap_cnt = 0;
 467         heap->heap_sz = 0;
 468 }
 469
 470 void auxtrace_heap__pop(struct auxtrace_heap *heap)
 471 {
 472         unsigned int pos, last, heap_cnt = heap->heap_cnt;
 473         struct auxtrace_heap_item *heap_array;
 474
 475         if (!heap_cnt)
 476                 return;
 477
 478         heap->heap_cnt -= 1;
 479
 480         heap_array = heap->heap_array;
 481
 482         pos = 0;
 483         while (1) {
 484                 unsigned int left, right;
 485
 486                 left = (pos << 1) + 1;
 487                 if (left >= heap_cnt)
 488                         break;
 489                 right = left + 1;
 490                 if (right >= heap_cnt) {
 491                         heap_array[pos] = heap_array[left];
 492                         return;
 493                 }
 494                 if (heap_array[left].ordinal < heap_array[right].ordinal) {
 495                         heap_array[pos] = heap_array[left];
 496                         pos = left;
 497                 } else {
 498                         heap_array[pos] = heap_array[right];
 499                         pos = right;
 500                 }
 501         }
 502
 503         last = heap_cnt - 1;
 504         auxtrace_heapify(heap_array, pos, heap_array[last].queue_nr,
 505                          heap_array[last].ordinal);
 506 }
 507
 508 size_t auxtrace_record__info_priv_size(struct auxtrace_record *itr,
 509                                        struct perf_evlist *evlist)
 510 {
 511         if (itr)
 512                 return itr->info_priv_size(itr, evlist);
 513         return 0;
 514 }
 515
 516 static int auxtrace_not_supported(void)
 517 {
 518         pr_err("AUX area tracing is not supported on this architecture\n");
 519         return -EINVAL;
 520 }
 521
 522 int auxtrace_record__info_fill(struct auxtrace_record *itr,
 523                                struct perf_session *session,
 524                                struct auxtrace_info_event *auxtrace_info,
 525                                size_t priv_size)
 526 {
 527         if (itr)
 528                 return itr->info_fill(itr, session, auxtrace_info, priv_size);
 529         return auxtrace_not_supported();
 530 }
 531
 532 void auxtrace_record__free(struct auxtrace_record *itr)
 533 {
 534         if (itr)
 535                 itr->free(itr);
 536 }
 537
 538 int auxtrace_record__snapshot_start(struct auxtrace_record *itr)
 539 {
 540         if (itr && itr->snapshot_start)
 541                 return itr->snapshot_start(itr);
 542         return 0;
 543 }
 544
 545 int auxtrace_record__snapshot_finish(struct auxtrace_record *itr)
 546 {
 547         if (itr && itr->snapshot_finish)
 548                 return itr->snapshot_finish(itr);
 549         return 0;
 550 }
 551
 552 int auxtrace_record__find_snapshot(struct auxtrace_record *itr, int idx,
 553                                    struct auxtrace_mmap *mm,
 554                                    unsigned char *data, u64 *head, u64 *old)
 555 {
 556         if (itr && itr->find_snapshot)
 557                 return itr->find_snapshot(itr, idx, mm, data, head, old);
 558         return 0;
 559 }
 560
 561 int auxtrace_record__options(struct auxtrace_record *itr,
 562                              struct perf_evlist *evlist,
 563                              struct record_opts *opts)
 564 {
 565         if (itr)
 566                 return itr->recording_options(itr, evlist, opts);
 567         return 0;
 568 }
 569
 570 u64 auxtrace_record__reference(struct auxtrace_record *itr)
 571 {
 572         if (itr)
 573                 return itr->reference(itr);
 574         return 0;
 575 }
 576
 577 int auxtrace_parse_snapshot_options(struct auxtrace_record *itr,
 578                                     struct record_opts *opts, const char *str)
 579 {
 580         if (!str)
 581                 return 0;
 582
 583         if (itr)
 584                 return itr->parse_snapshot_options(itr, opts, str);
 585
 586         pr_err("No AUX area tracing to snapshot\n");
 587         return -EINVAL;
 588 }
 589
 590 struct auxtrace_record *__weak
 591 auxtrace_record__init(struct perf_evlist *evlist __maybe_unused, int *err)
 592 {
 593         *err = 0;
 594         return NULL;
 595 }
 596
 597 static int auxtrace_index__alloc(struct list_head *head)
 598 {
 599         struct auxtrace_index *auxtrace_index;
 600
 601         auxtrace_index = malloc(sizeof(struct auxtrace_index));
 602         if (!auxtrace_index)
 603                 return -ENOMEM;
 604
 605         auxtrace_index->nr = 0;
 606         INIT_LIST_HEAD(&auxtrace_index->list);
 607
 608         list_add_tail(&auxtrace_index->list, head);
 609
 610         return 0;
 611 }
 612
 613 void auxtrace_index__free(struct list_head *head)
 614 {
 615         struct auxtrace_index *auxtrace_index, *n;
 616
 617         list_for_each_entry_safe(auxtrace_index, n, head, list) {
 618                 list_del(&auxtrace_index->list);
 619                 free(auxtrace_index);
 620         }
 621 }
 622
 623 static struct auxtrace_index *auxtrace_index__last(struct list_head *head)
 624 {
 625         struct auxtrace_index *auxtrace_index;
 626         int err;
 627
 628         if (list_empty(head)) {
 629                 err = auxtrace_index__alloc(head);
 630                 if (err)
 631                         return NULL;
 632         }
 633
 634         auxtrace_index = list_entry(head->prev, struct auxtrace_index, list);
 635
 636         if (auxtrace_index->nr >= PERF_AUXTRACE_INDEX_ENTRY_COUNT) {
 637                 err = auxtrace_index__alloc(head);
 638                 if (err)
 639                         return NULL;
 640                 auxtrace_index = list_entry(head->prev, struct auxtrace_index,
 641                                             list);
 642         }
 643
 644         return auxtrace_index;
 645 }
 646
 647 int auxtrace_index__auxtrace_event(struct list_head *head,
 648                                    union perf_event *event, off_t file_offset)
 649 {
 650         struct auxtrace_index *auxtrace_index;
 651         size_t nr;
 652
 653         auxtrace_index = auxtrace_index__last(head);
 654         if (!auxtrace_index)
 655                 return -ENOMEM;
 656
 657         nr = auxtrace_index->nr;
 658         auxtrace_index->entries[nr].file_offset = file_offset;
 659         auxtrace_index->entries[nr].sz = event->header.size;
 660         auxtrace_index->nr += 1;
 661
 662         return 0;
 663 }
 664
 665 static int auxtrace_index__do_write(int fd,
 666                                     struct auxtrace_index *auxtrace_index)
 667 {
 668         struct auxtrace_index_entry ent;
 669         size_t i;
 670
 671         for (i = 0; i < auxtrace_index->nr; i++) {
 672                 ent.file_offset = auxtrace_index->entries[i].file_offset;
 673                 ent.sz = auxtrace_index->entries[i].sz;
 674                 if (writen(fd, &ent, sizeof(ent)) != sizeof(ent))
 675                         return -errno;
 676         }
 677         return 0;
 678 }
 679
 680 int auxtrace_index__write(int fd, struct list_head *head)
 681 {
 682         struct auxtrace_index *auxtrace_index;
 683         u64 total = 0;
 684         int err;
 685
 686         list_for_each_entry(auxtrace_index, head, list)
 687                 total += auxtrace_index->nr;
 688
 689         if (writen(fd, &total, sizeof(total)) != sizeof(total))
 690                 return -errno;
 691
 692         list_for_each_entry(auxtrace_index, head, list) {
 693                 err = auxtrace_index__do_write(fd, auxtrace_index);
 694                 if (err)
 695                         return err;
 696         }
 697
 698         return 0;
 699 }
 700
 701 static int auxtrace_index__process_entry(int fd, struct list_head *head,
 702                                          bool needs_swap)
 703 {
 704         struct auxtrace_index *auxtrace_index;
 705         struct auxtrace_index_entry ent;
 706         size_t nr;
 707
 708         if (readn(fd, &ent, sizeof(ent)) != sizeof(ent))
 709                 return -1;
 710
 711         auxtrace_index = auxtrace_index__last(head);
 712         if (!auxtrace_index)
 713                 return -1;
 714
 715         nr = auxtrace_index->nr;
 716         if (needs_swap) {
 717                 auxtrace_index->entries[nr].file_offset =
 718                                                 bswap_64(ent.file_offset);
 719                 auxtrace_index->entries[nr].sz = bswap_64(ent.sz);
 720         } else {
 721                 auxtrace_index->entries[nr].file_offset = ent.file_offset;
 722                 auxtrace_index->entries[nr].sz = ent.sz;
 723         }
 724
 725         auxtrace_index->nr = nr + 1;
 726
 727         return 0;
 728 }
 729
 730 int auxtrace_index__process(int fd, u64 size, struct perf_session *session,
 731                             bool needs_swap)
 732 {
 733         struct list_head *head = &session->auxtrace_index;
 734         u64 nr;
 735
 736         if (readn(fd, &nr, sizeof(u64)) != sizeof(u64))
 737                 return -1;
 738
 739         if (needs_swap)
 740                 nr = bswap_64(nr);
 741
 742         if (sizeof(u64) + nr * sizeof(struct auxtrace_index_entry) > size)
 743                 return -1;
 744
 745         while (nr--) {
 746                 int err;
 747
 748                 err = auxtrace_index__process_entry(fd, head, needs_swap);
 749                 if (err)
 750                         return -1;
 751         }
 752
 753         return 0;
 754 }
 755
 756 static int auxtrace_queues__process_index_entry(struct auxtrace_queues *queues,
 757                                                 struct perf_session *session,
 758                                                 struct auxtrace_index_entry *ent)
 759 {
 760         return auxtrace_queues__add_indexed_event(queues, session,
 761                                                   ent->file_offset, ent->sz);
 762 }
 763
 764 int auxtrace_queues__process_index(struct auxtrace_queues *queues,
 765                                    struct perf_session *session)
 766 {
 767         struct auxtrace_index *auxtrace_index;
 768         struct auxtrace_index_entry *ent;
 769         size_t i;
 770         int err;
 771
 772         if (auxtrace__dont_decode(session))
 773                 return 0;
 774
 775         list_for_each_entry(auxtrace_index, &session->auxtrace_index, list) {
 776                 for (i = 0; i < auxtrace_index->nr; i++) {
 777                         ent = &auxtrace_index->entries[i];
 778                         err = auxtrace_queues__process_index_entry(queues,
 779                                                                    session,
 780                                                                    ent);
 781                         if (err)
 782                                 return err;
 783                 }
 784         }
 785         return 0;
 786 }
 787
 788 struct auxtrace_buffer *auxtrace_buffer__next(struct auxtrace_queue *queue,
 789                                               struct auxtrace_buffer *buffer)
 790 {
 791         if (buffer) {
 792                 if (list_is_last(&buffer->list, &queue->head))
 793                         return NULL;
 794                 return list_entry(buffer->list.next, struct auxtrace_buffer,
 795                                   list);
 796         } else {
 797                 if (list_empty(&queue->head))
 798                         return NULL;
 799                 return list_entry(queue->head.next, struct auxtrace_buffer,
 800                                   list);
 801         }
 802 }
 803
 804 void *auxtrace_buffer__get_data(struct auxtrace_buffer *buffer, int fd)
 805 {
 806         size_t adj = buffer->data_offset & (page_size - 1);
 807         size_t size = buffer->size + adj;
 808         off_t file_offset = buffer->data_offset - adj;
 809         void *addr;
 810
 811         if (buffer->data)
 812                 return buffer->data;
 813
 814         addr = mmap(NULL, size, PROT_READ, MAP_SHARED, fd, file_offset);
 815         if (addr == MAP_FAILED)
 816                 return NULL;
 817
 818         buffer->mmap_addr = addr;
 819         buffer->mmap_size = size;
 820
 821         buffer->data = addr + adj;
 822
 823         return buffer->data;
 824 }
 825
 826 void auxtrace_buffer__put_data(struct auxtrace_buffer *buffer)
 827 {
 828         if (!buffer->data || !buffer->mmap_addr)
 829                 return;
 830         munmap(buffer->mmap_addr, buffer->mmap_size);
 831         buffer->mmap_addr = NULL;
 832         buffer->mmap_size = 0;
 833         buffer->data = NULL;
 834         buffer->use_data = NULL;
 835 }
 836
 837 void auxtrace_buffer__drop_data(struct auxtrace_buffer *buffer)
 838 {
 839         auxtrace_buffer__put_data(buffer);
 840         if (buffer->data_needs_freeing) {
 841                 buffer->data_needs_freeing = false;
 842                 zfree(&buffer->data);
 843                 buffer->use_data = NULL;
 844                 buffer->size = 0;
 845         }
 846 }
 847
 848 void auxtrace_buffer__free(struct auxtrace_buffer *buffer)
 849 {
 850         auxtrace_buffer__drop_data(buffer);
 851         free(buffer);
 852 }
 853
 854 void auxtrace_synth_error(struct auxtrace_error_event *auxtrace_error, int type,
 855                           int code, int cpu, pid_t pid, pid_t tid, u64 ip,
 856                           const char *msg)
 857 {
 858         size_t size;
 859
 860         memset(auxtrace_error, 0, sizeof(struct auxtrace_error_event));
 861
 862         auxtrace_error->header.type = PERF_RECORD_AUXTRACE_ERROR;
 863         auxtrace_error->type = type;
 864         auxtrace_error->code = code;
 865         auxtrace_error->cpu = cpu;
 866         auxtrace_error->pid = pid;
 867         auxtrace_error->tid = tid;
 868         auxtrace_error->ip = ip;
 869         strlcpy(auxtrace_error->msg, msg, MAX_AUXTRACE_ERROR_MSG);
 870
 871         size = (void *)auxtrace_error->msg - (void *)auxtrace_error +
 872                strlen(auxtrace_error->msg) + 1;
 873         auxtrace_error->header.size = PERF_ALIGN(size, sizeof(u64));
 874 }
 875
 876 int perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr,
 877                                          struct perf_tool *tool,
 878                                          struct perf_session *session,
 879                                          perf_event__handler_t process)
 880 {
 881         union perf_event *ev;
 882         size_t priv_size;
 883         int err;
 884
 885         pr_debug2("Synthesizing auxtrace information\n");
 886         priv_size = auxtrace_record__info_priv_size(itr, session->evlist);
 887         ev = zalloc(sizeof(struct auxtrace_info_event) + priv_size);
 888         if (!ev)
 889                 return -ENOMEM;
 890
 891         ev->auxtrace_info.header.type = PERF_RECORD_AUXTRACE_INFO;
 892         ev->auxtrace_info.header.size = sizeof(struct auxtrace_info_event) +
 893                                         priv_size;
 894         err = auxtrace_record__info_fill(itr, session, &ev->auxtrace_info,
 895                                          priv_size);
 896         if (err)
 897                 goto out_free;
 898
 899         err = process(tool, ev, NULL, NULL);
 900 out_free:
 901         free(ev);
 902         return err;
 903 }
 904
 905 int perf_event__process_auxtrace_info(struct perf_tool *tool __maybe_unused,
 906                                       union perf_event *event,
 907                                       struct perf_session *session)
 908 {
 909         enum auxtrace_type type = event->auxtrace_info.type;
 910
 911         if (dump_trace)
 912                 fprintf(stdout, " type: %u\n", type);
 913
 914         switch (type) {
 915         case PERF_AUXTRACE_INTEL_PT:
 916                 return intel_pt_process_auxtrace_info(event, session);
 917         case PERF_AUXTRACE_INTEL_BTS:
 918                 return intel_bts_process_auxtrace_info(event, session);
 919         case PERF_AUXTRACE_ARM_SPE:
 920                 return arm_spe_process_auxtrace_info(event, session);
 921         case PERF_AUXTRACE_CS_ETM:
 922                 return cs_etm__process_auxtrace_info(event, session);
 923         case PERF_AUXTRACE_S390_CPUMSF:
 924                 return s390_cpumsf_process_auxtrace_info(event, session);
 925         case PERF_AUXTRACE_UNKNOWN:
 926         default:
 927                 return -EINVAL;
 928         }
 929 }
 930
 931 s64 perf_event__process_auxtrace(struct perf_tool *tool,
 932                                  union perf_event *event,
 933                                  struct perf_session *session)
 934 {
 935         s64 err;
 936
 937         if (dump_trace)
 938                 fprintf(stdout, " size: %#"PRIx64"  offset: %#"PRIx64"  ref: %#"PRIx64"  idx: %u  tid: %d  cpu: %d\n",
 939                         event->auxtrace.size, event->auxtrace.offset,
 940                         event->auxtrace.reference, event->auxtrace.idx,
 941                         event->auxtrace.tid, event->auxtrace.cpu);
 942
 943         if (auxtrace__dont_decode(session))
 944                 return event->auxtrace.size;
 945
 946         if (!session->auxtrace || event->header.type != PERF_RECORD_AUXTRACE)
 947                 return -EINVAL;
 948
 949         err = session->auxtrace->process_auxtrace_event(session, event, tool);
 950         if (err < 0)
 951                 return err;
 952
 953         return event->auxtrace.size;
 954 }
 955
 956 #define PERF_ITRACE_DEFAULT_PERIOD_TYPE         PERF_ITRACE_PERIOD_NANOSECS
 957 #define PERF_ITRACE_DEFAULT_PERIOD              100000
 958 #define PERF_ITRACE_DEFAULT_CALLCHAIN_SZ        16
 959 #define PERF_ITRACE_MAX_CALLCHAIN_SZ            1024
 960 #define PERF_ITRACE_DEFAULT_LAST_BRANCH_SZ      64
 961 #define PERF_ITRACE_MAX_LAST_BRANCH_SZ          1024
 962
 963 void itrace_synth_opts__set_default(struct itrace_synth_opts *synth_opts)
 964 {
 965         synth_opts->instructions = true;
 966         synth_opts->branches = true;
 967         synth_opts->transactions = true;
 968         synth_opts->ptwrites = true;
 969         synth_opts->pwr_events = true;
 970         synth_opts->errors = true;
 971         synth_opts->period_type = PERF_ITRACE_DEFAULT_PERIOD_TYPE;
 972         synth_opts->period = PERF_ITRACE_DEFAULT_PERIOD;
 973         synth_opts->callchain_sz = PERF_ITRACE_DEFAULT_CALLCHAIN_SZ;
 974         synth_opts->last_branch_sz = PERF_ITRACE_DEFAULT_LAST_BRANCH_SZ;
 975         synth_opts->initial_skip = 0;
 976 }
 977
 978 /*
 979  * Please check tools/perf/Documentation/perf-script.txt for information
 980  * about the options parsed here, which is introduced after this cset,
 981  * when support in 'perf script' for these options is introduced.
 982  */
 983 int itrace_parse_synth_opts(const struct option *opt, const char *str,
 984                             int unset)
 985 {
 986         struct itrace_synth_opts *synth_opts = opt->value;
 987         const char *p;
 988         char *endptr;
 989         bool period_type_set = false;
 990         bool period_set = false;
 991
 992         synth_opts->set = true;
 993
 994         if (unset) {
 995                 synth_opts->dont_decode = true;
 996                 return 0;
 997         }
 998
 999         if (!str) {
1000                 itrace_synth_opts__set_default(synth_opts);
1001                 return 0;
1002         }
1003
1004         for (p = str; *p;) {
1005                 switch (*p++) {
1006                 case 'i':
1007                         synth_opts->instructions = true;
1008                         while (*p == ' ' || *p == ',')
1009                                 p += 1;
1010                         if (isdigit(*p)) {
1011                                 synth_opts->period = strtoull(p, &endptr, 10);
1012                                 period_set = true;
1013                                 p = endptr;
1014                                 while (*p == ' ' || *p == ',')
1015                                         p += 1;
1016                                 switch (*p++) {
1017                                 case 'i':
1018                                         synth_opts->period_type =
1019                                                 PERF_ITRACE_PERIOD_INSTRUCTIONS;
1020                                         period_type_set = true;
1021                                         break;
1022                                 case 't':
1023                                         synth_opts->period_type =
1024                                                 PERF_ITRACE_PERIOD_TICKS;
1025                                         period_type_set = true;
1026                                         break;
1027                                 case 'm':
1028                                         synth_opts->period *= 1000;
1029                                         /* Fall through */
1030                                 case 'u':
1031                                         synth_opts->period *= 1000;
1032                                         /* Fall through */
1033                                 case 'n':
1034                                         if (*p++ != 's')
1035                                                 goto out_err;
1036                                         synth_opts->period_type =
1037                                                 PERF_ITRACE_PERIOD_NANOSECS;
1038                                         period_type_set = true;
1039                                         break;
1040                                 case '\0':
1041                                         goto out;
1042                                 default:
1043                                         goto out_err;
1044                                 }
1045                         }
1046                         break;
1047                 case 'b':
1048                         synth_opts->branches = true;
1049                         break;
1050                 case 'x':
1051                         synth_opts->transactions = true;
1052                         break;
1053                 case 'w':
1054                         synth_opts->ptwrites = true;
1055                         break;
1056                 case 'p':
1057                         synth_opts->pwr_events = true;
1058                         break;
1059                 case 'e':
1060                         synth_opts->errors = true;
1061                         break;
1062                 case 'd':
1063                         synth_opts->log = true;
1064                         break;
1065                 case 'c':
1066                         synth_opts->branches = true;
1067                         synth_opts->calls = true;
1068                         break;
1069                 case 'r':
1070                         synth_opts->branches = true;
1071                         synth_opts->returns = true;
1072                         break;
1073                 case 'g':
1074                         synth_opts->callchain = true;
1075                         synth_opts->callchain_sz =
1076                                         PERF_ITRACE_DEFAULT_CALLCHAIN_SZ;
1077                         while (*p == ' ' || *p == ',')
1078                                 p += 1;
1079                         if (isdigit(*p)) {
1080                                 unsigned int val;
1081
1082                                 val = strtoul(p, &endptr, 10);
1083                                 p = endptr;
1084                                 if (!val || val > PERF_ITRACE_MAX_CALLCHAIN_SZ)
1085                                         goto out_err;
1086                                 synth_opts->callchain_sz = val;
1087                         }
1088                         break;
1089                 case 'l':
1090                         synth_opts->last_branch = true;
1091                         synth_opts->last_branch_sz =
1092                                         PERF_ITRACE_DEFAULT_LAST_BRANCH_SZ;
1093                         while (*p == ' ' || *p == ',')
1094                                 p += 1;
1095                         if (isdigit(*p)) {
1096                                 unsigned int val;
1097
1098                                 val = strtoul(p, &endptr, 10);
1099                                 p = endptr;
1100                                 if (!val ||
1101                                     val > PERF_ITRACE_MAX_LAST_BRANCH_SZ)
1102                                         goto out_err;
1103                                 synth_opts->last_branch_sz = val;
1104                         }
1105                         break;
1106                 case 's':
1107                         synth_opts->initial_skip = strtoul(p, &endptr, 10);
1108                         if (p == endptr)
1109                                 goto out_err;
1110                         p = endptr;
1111                         break;
1112                 case ' ':
1113                 case ',':
1114                         break;
1115                 default:
1116                         goto out_err;
1117                 }
1118         }
1119 out:
1120         if (synth_opts->instructions) {
1121                 if (!period_type_set)
1122                         synth_opts->period_type =
1123                                         PERF_ITRACE_DEFAULT_PERIOD_TYPE;
1124                 if (!period_set)
1125                         synth_opts->period = PERF_ITRACE_DEFAULT_PERIOD;
1126         }
1127
1128         return 0;
1129
1130 out_err:
1131         pr_err("Bad Instruction Tracing options '%s'\n", str);
1132         return -EINVAL;
1133 }
1134
1135 static const char * const auxtrace_error_type_name[] = {
1136         [PERF_AUXTRACE_ERROR_ITRACE] = "instruction trace",
1137 };
1138
1139 static const char *auxtrace_error_name(int type)
1140 {
1141         const char *error_type_name = NULL;
1142
1143         if (type < PERF_AUXTRACE_ERROR_MAX)
1144                 error_type_name = auxtrace_error_type_name[type];
1145         if (!error_type_name)
1146                 error_type_name = "unknown AUX";
1147         return error_type_name;
1148 }
1149
1150 size_t perf_event__fprintf_auxtrace_error(union perf_event *event, FILE *fp)
1151 {
1152         struct auxtrace_error_event *e = &event->auxtrace_error;
1153         int ret;
1154
1155         ret = fprintf(fp, " %s error type %u",
1156                       auxtrace_error_name(e->type), e->type);
1157         ret += fprintf(fp, " cpu %d pid %d tid %d ip %#"PRIx64" code %u: %s\n",
1158                        e->cpu, e->pid, e->tid, e->ip, e->code, e->msg);
1159         return ret;
1160 }
1161
1162 void perf_session__auxtrace_error_inc(struct perf_session *session,
1163                                       union perf_event *event)
1164 {
1165         struct auxtrace_error_event *e = &event->auxtrace_error;
1166
1167         if (e->type < PERF_AUXTRACE_ERROR_MAX)
1168                 session->evlist->stats.nr_auxtrace_errors[e->type] += 1;
1169 }
1170
1171 void events_stats__auxtrace_error_warn(const struct events_stats *stats)
1172 {
1173         int i;
1174
1175         for (i = 0; i < PERF_AUXTRACE_ERROR_MAX; i++) {
1176                 if (!stats->nr_auxtrace_errors[i])
1177                         continue;
1178                 ui__warning("%u %s errors\n",
1179                             stats->nr_auxtrace_errors[i],
1180                             auxtrace_error_name(i));
1181         }
1182 }
1183
1184 int perf_event__process_auxtrace_error(struct perf_tool *tool __maybe_unused,
1185                                        union perf_event *event,
1186                                        struct perf_session *session)
1187 {
1188         if (auxtrace__dont_decode(session))
1189                 return 0;
1190
1191         perf_event__fprintf_auxtrace_error(event, stdout);
1192         return 0;
1193 }
1194
1195 static int __auxtrace_mmap__read(struct auxtrace_mmap *mm,
1196                                  struct auxtrace_record *itr,
1197                                  struct perf_tool *tool, process_auxtrace_t fn,
1198                                  bool snapshot, size_t snapshot_size)
1199 {
1200         u64 head, old = mm->prev, offset, ref;
1201         unsigned char *data = mm->base;
1202         size_t size, head_off, old_off, len1, len2, padding;
1203         union perf_event ev;
1204         void *data1, *data2;
1205
1206         if (snapshot) {
1207                 head = auxtrace_mmap__read_snapshot_head(mm);
1208                 if (auxtrace_record__find_snapshot(itr, mm->idx, mm, data,
1209                                                    &head, &old))
1210                         return -1;
1211         } else {
1212                 head = auxtrace_mmap__read_head(mm);
1213         }
1214
1215         if (old == head)
1216                 return 0;
1217
1218         pr_debug3("auxtrace idx %d old %#"PRIx64" head %#"PRIx64" diff %#"PRIx64"\n",
1219                   mm->idx, old, head, head - old);
1220
1221         if (mm->mask) {
1222                 head_off = head & mm->mask;
1223                 old_off = old & mm->mask;
1224         } else {
1225                 head_off = head % mm->len;
1226                 old_off = old % mm->len;
1227         }
1228
1229         if (head_off > old_off)
1230                 size = head_off - old_off;
1231         else
1232                 size = mm->len - (old_off - head_off);
1233
1234         if (snapshot && size > snapshot_size)
1235                 size = snapshot_size;
1236
1237         ref = auxtrace_record__reference(itr);
1238
1239         if (head > old || size <= head || mm->mask) {
1240                 offset = head - size;
1241         } else {
1242                 /*
1243                  * When the buffer size is not a power of 2, 'head' wraps at the
1244                  * highest multiple of the buffer size, so we have to subtract
1245                  * the remainder here.
1246                  */
1247                 u64 rem = (0ULL - mm->len) % mm->len;
1248
1249                 offset = head - size - rem;
1250         }
1251
1252         if (size > head_off) {
1253                 len1 = size - head_off;
1254                 data1 = &data[mm->len - len1];
1255                 len2 = head_off;
1256                 data2 = &data[0];
1257         } else {
1258                 len1 = size;
1259                 data1 = &data[head_off - len1];
1260                 len2 = 0;
1261                 data2 = NULL;
1262         }
1263
1264         if (itr->alignment) {
1265                 unsigned int unwanted = len1 % itr->alignment;
1266
1267                 len1 -= unwanted;
1268                 size -= unwanted;
1269         }
1270
1271         /* padding must be written by fn() e.g. record__process_auxtrace() */
1272         padding = size & (PERF_AUXTRACE_RECORD_ALIGNMENT - 1);
1273         if (padding)
1274                 padding = PERF_AUXTRACE_RECORD_ALIGNMENT - padding;
1275
1276         memset(&ev, 0, sizeof(ev));
1277         ev.auxtrace.header.type = PERF_RECORD_AUXTRACE;
1278         ev.auxtrace.header.size = sizeof(ev.auxtrace);
1279         ev.auxtrace.size = size + padding;
1280         ev.auxtrace.offset = offset;
1281         ev.auxtrace.reference = ref;
1282         ev.auxtrace.idx = mm->idx;
1283         ev.auxtrace.tid = mm->tid;
1284         ev.auxtrace.cpu = mm->cpu;
1285
1286         if (fn(tool, &ev, data1, len1, data2, len2))
1287                 return -1;
1288
1289         mm->prev = head;
1290
1291         if (!snapshot) {
1292                 auxtrace_mmap__write_tail(mm, head);
1293                 if (itr->read_finish) {
1294                         int err;
1295
1296                         err = itr->read_finish(itr, mm->idx);
1297                         if (err < 0)
1298                                 return err;
1299                 }
1300         }
1301
1302         return 1;
1303 }
1304
1305 int auxtrace_mmap__read(struct auxtrace_mmap *mm, struct auxtrace_record *itr,
1306                         struct perf_tool *tool, process_auxtrace_t fn)
1307 {
1308         return __auxtrace_mmap__read(mm, itr, tool, fn, false, 0);
1309 }
1310
1311 int auxtrace_mmap__read_snapshot(struct auxtrace_mmap *mm,
1312                                  struct auxtrace_record *itr,
1313                                  struct perf_tool *tool, process_auxtrace_t fn,
1314                                  size_t snapshot_size)
1315 {
1316         return __auxtrace_mmap__read(mm, itr, tool, fn, true, snapshot_size);
1317 }
1318
1319 /**
1320  * struct auxtrace_cache - hash table to implement a cache
1321  * @hashtable: the hashtable
1322  * @sz: hashtable size (number of hlists)
1323  * @entry_size: size of an entry
1324  * @limit: limit the number of entries to this maximum, when reached the cache
1325  *         is dropped and caching begins again with an empty cache
1326  * @cnt: current number of entries
1327  * @bits: hashtable size (@sz = 2^@bits)
1328  */
1329 struct auxtrace_cache {
1330         struct hlist_head *hashtable;
1331         size_t sz;
1332         size_t entry_size;
1333         size_t limit;
1334         size_t cnt;
1335         unsigned int bits;
1336 };
1337
1338 struct auxtrace_cache *auxtrace_cache__new(unsigned int bits, size_t entry_size,
1339                                            unsigned int limit_percent)
1340 {
1341         struct auxtrace_cache *c;
1342         struct hlist_head *ht;
1343         size_t sz, i;
1344
1345         c = zalloc(sizeof(struct auxtrace_cache));
1346         if (!c)
1347                 return NULL;
1348
1349         sz = 1UL << bits;
1350
1351         ht = calloc(sz, sizeof(struct hlist_head));
1352         if (!ht)
1353                 goto out_free;
1354
1355         for (i = 0; i < sz; i++)
1356                 INIT_HLIST_HEAD(&ht[i]);
1357
1358         c->hashtable = ht;
1359         c->sz = sz;
1360         c->entry_size = entry_size;
1361         c->limit = (c->sz * limit_percent) / 100;
1362         c->bits = bits;
1363
1364         return c;
1365
1366 out_free:
1367         free(c);
1368         return NULL;
1369 }
1370
1371 static void auxtrace_cache__drop(struct auxtrace_cache *c)
1372 {
1373         struct auxtrace_cache_entry *entry;
1374         struct hlist_node *tmp;
1375         size_t i;
1376
1377         if (!c)
1378                 return;
1379
1380         for (i = 0; i < c->sz; i++) {
1381                 hlist_for_each_entry_safe(entry, tmp, &c->hashtable[i], hash) {
1382                         hlist_del(&entry->hash);
1383                         auxtrace_cache__free_entry(c, entry);
1384                 }
1385         }
1386
1387         c->cnt = 0;
1388 }
1389
1390 void auxtrace_cache__free(struct auxtrace_cache *c)
1391 {
1392         if (!c)
1393                 return;
1394
1395         auxtrace_cache__drop(c);
1396         free(c->hashtable);
1397         free(c);
1398 }
1399
1400 void *auxtrace_cache__alloc_entry(struct auxtrace_cache *c)
1401 {
1402         return malloc(c->entry_size);
1403 }
1404
1405 void auxtrace_cache__free_entry(struct auxtrace_cache *c __maybe_unused,
1406                                 void *entry)
1407 {
1408         free(entry);
1409 }
1410
1411 int auxtrace_cache__add(struct auxtrace_cache *c, u32 key,
1412                         struct auxtrace_cache_entry *entry)
1413 {
1414         if (c->limit && ++c->cnt > c->limit)
1415                 auxtrace_cache__drop(c);
1416
1417         entry->key = key;
1418         hlist_add_head(&entry->hash, &c->hashtable[hash_32(key, c->bits)]);
1419
1420         return 0;
1421 }
1422
1423 void *auxtrace_cache__lookup(struct auxtrace_cache *c, u32 key)
1424 {
1425         struct auxtrace_cache_entry *entry;
1426         struct hlist_head *hlist;
1427
1428         if (!c)
1429                 return NULL;
1430
1431         hlist = &c->hashtable[hash_32(key, c->bits)];
1432         hlist_for_each_entry(entry, hlist, hash) {
1433                 if (entry->key == key)
1434                         return entry;
1435         }
1436
1437         return NULL;
1438 }
1439
1440 static void addr_filter__free_str(struct addr_filter *filt)
1441 {
1442         free(filt->str);
1443         filt->action   = NULL;
1444         filt->sym_from = NULL;
1445         filt->sym_to   = NULL;
1446         filt->filename = NULL;
1447         filt->str      = NULL;
1448 }
1449
1450 static struct addr_filter *addr_filter__new(void)
1451 {
1452         struct addr_filter *filt = zalloc(sizeof(*filt));
1453
1454         if (filt)
1455                 INIT_LIST_HEAD(&filt->list);
1456
1457         return filt;
1458 }
1459
1460 static void addr_filter__free(struct addr_filter *filt)
1461 {
1462         if (filt)
1463                 addr_filter__free_str(filt);
1464         free(filt);
1465 }
1466
1467 static void addr_filters__add(struct addr_filters *filts,
1468                               struct addr_filter *filt)
1469 {
1470         list_add_tail(&filt->list, &filts->head);
1471         filts->cnt += 1;
1472 }
1473
1474 static void addr_filters__del(struct addr_filters *filts,
1475                               struct addr_filter *filt)
1476 {
1477         list_del_init(&filt->list);
1478         filts->cnt -= 1;
1479 }
1480
1481 void addr_filters__init(struct addr_filters *filts)
1482 {
1483         INIT_LIST_HEAD(&filts->head);
1484         filts->cnt = 0;
1485 }
1486
1487 void addr_filters__exit(struct addr_filters *filts)
1488 {
1489         struct addr_filter *filt, *n;
1490
1491         list_for_each_entry_safe(filt, n, &filts->head, list) {
1492                 addr_filters__del(filts, filt);
1493                 addr_filter__free(filt);
1494         }
1495 }
1496
1497 static int parse_num_or_str(char **inp, u64 *num, const char **str,
1498                             const char *str_delim)
1499 {
1500         *inp += strspn(*inp, " ");
1501
1502         if (isdigit(**inp)) {
1503                 char *endptr;
1504
1505                 if (!num)
1506                         return -EINVAL;
1507                 errno = 0;
1508                 *num = strtoull(*inp, &endptr, 0);
1509                 if (errno)
1510                         return -errno;
1511                 if (endptr == *inp)
1512                         return -EINVAL;
1513                 *inp = endptr;
1514         } else {
1515                 size_t n;
1516
1517                 if (!str)
1518                         return -EINVAL;
1519                 *inp += strspn(*inp, " ");
1520                 *str = *inp;
1521                 n = strcspn(*inp, str_delim);
1522                 if (!n)
1523                         return -EINVAL;
1524                 *inp += n;
1525                 if (**inp) {
1526                         **inp = '\0';
1527                         *inp += 1;
1528                 }
1529         }
1530         return 0;
1531 }
1532
1533 static int parse_action(struct addr_filter *filt)
1534 {
1535         if (!strcmp(filt->action, "filter")) {
1536                 filt->start = true;
1537                 filt->range = true;
1538         } else if (!strcmp(filt->action, "start")) {
1539                 filt->start = true;
1540         } else if (!strcmp(filt->action, "stop")) {
1541                 filt->start = false;
1542         } else if (!strcmp(filt->action, "tracestop")) {
1543                 filt->start = false;
1544                 filt->range = true;
1545                 filt->action += 5; /* Change 'tracestop' to 'stop' */
1546         } else {
1547                 return -EINVAL;
1548         }
1549         return 0;
1550 }
1551
1552 static int parse_sym_idx(char **inp, int *idx)
1553 {
1554         *idx = -1;
1555
1556         *inp += strspn(*inp, " ");
1557
1558         if (**inp != '#')
1559                 return 0;
1560
1561         *inp += 1;
1562
1563         if (**inp == 'g' || **inp == 'G') {
1564                 *inp += 1;
1565                 *idx = 0;
1566         } else {
1567                 unsigned long num;
1568                 char *endptr;
1569
1570                 errno = 0;
1571                 num = strtoul(*inp, &endptr, 0);
1572                 if (errno)
1573                         return -errno;
1574                 if (endptr == *inp || num > INT_MAX)
1575                         return -EINVAL;
1576                 *inp = endptr;
1577                 *idx = num;
1578         }
1579
1580         return 0;
1581 }
1582
1583 static int parse_addr_size(char **inp, u64 *num, const char **str, int *idx)
1584 {
1585         int err = parse_num_or_str(inp, num, str, " ");
1586
1587         if (!err && *str)
1588                 err = parse_sym_idx(inp, idx);
1589
1590         return err;
1591 }
1592
1593 static int parse_one_filter(struct addr_filter *filt, const char **filter_inp)
1594 {
1595         char *fstr;
1596         int err;
1597
1598         filt->str = fstr = strdup(*filter_inp);
1599         if (!fstr)
1600                 return -ENOMEM;
1601
1602         err = parse_num_or_str(&fstr, NULL, &filt->action, " ");
1603         if (err)
1604                 goto out_err;
1605
1606         err = parse_action(filt);
1607         if (err)
1608                 goto out_err;
1609
1610         err = parse_addr_size(&fstr, &filt->addr, &filt->sym_from,
1611                               &filt->sym_from_idx);
1612         if (err)
1613                 goto out_err;
1614
1615         fstr += strspn(fstr, " ");
1616
1617         if (*fstr == '/') {
1618                 fstr += 1;
1619                 err = parse_addr_size(&fstr, &filt->size, &filt->sym_to,
1620                                       &filt->sym_to_idx);
1621                 if (err)
1622                         goto out_err;
1623                 filt->range = true;
1624         }
1625
1626         fstr += strspn(fstr, " ");
1627
1628         if (*fstr == '@') {
1629                 fstr += 1;
1630                 err = parse_num_or_str(&fstr, NULL, &filt->filename, " ,");
1631                 if (err)
1632                         goto out_err;
1633         }
1634
1635         fstr += strspn(fstr, " ,");
1636
1637         *filter_inp += fstr - filt->str;
1638
1639         return 0;
1640
1641 out_err:
1642         addr_filter__free_str(filt);
1643
1644         return err;
1645 }
1646
1647 int addr_filters__parse_bare_filter(struct addr_filters *filts,
1648                                     const char *filter)
1649 {
1650         struct addr_filter *filt;
1651         const char *fstr = filter;
1652         int err;
1653
1654         while (*fstr) {
1655                 filt = addr_filter__new();
1656                 err = parse_one_filter(filt, &fstr);
1657                 if (err) {
1658                         addr_filter__free(filt);
1659                         addr_filters__exit(filts);
1660                         return err;
1661                 }
1662                 addr_filters__add(filts, filt);
1663         }
1664
1665         return 0;
1666 }
1667
1668 struct sym_args {
1669         const char      *name;
1670         u64             start;
1671         u64             size;
1672         int             idx;
1673         int             cnt;
1674         bool            started;
1675         bool            global;
1676         bool            selected;
1677         bool            duplicate;
1678         bool            near;
1679 };
1680
1681 static bool kern_sym_match(struct sym_args *args, const char *name, char type)
1682 {
1683         /* A function with the same name, and global or the n'th found or any */
1684         return kallsyms__is_function(type) &&
1685                !strcmp(name, args->name) &&
1686                ((args->global && isupper(type)) ||
1687                 (args->selected && ++(args->cnt) == args->idx) ||
1688                 (!args->global && !args->selected));
1689 }
1690
1691 static int find_kern_sym_cb(void *arg, const char *name, char type, u64 start)
1692 {
1693         struct sym_args *args = arg;
1694
1695         if (args->started) {
1696                 if (!args->size)
1697                         args->size = start - args->start;
1698                 if (args->selected) {
1699                         if (args->size)
1700                                 return 1;
1701                 } else if (kern_sym_match(args, name, type)) {
1702                         args->duplicate = true;
1703                         return 1;
1704                 }
1705         } else if (kern_sym_match(args, name, type)) {
1706                 args->started = true;
1707                 args->start = start;
1708         }
1709
1710         return 0;
1711 }
1712
1713 static int print_kern_sym_cb(void *arg, const char *name, char type, u64 start)
1714 {
1715         struct sym_args *args = arg;
1716
1717         if (kern_sym_match(args, name, type)) {
1718                 pr_err("#%d\t0x%"PRIx64"\t%c\t%s\n",
1719                        ++args->cnt, start, type, name);
1720                 args->near = true;
1721         } else if (args->near) {
1722                 args->near = false;
1723                 pr_err("\t\twhich is near\t\t%s\n", name);
1724         }
1725
1726         return 0;
1727 }
1728
1729 static int sym_not_found_error(const char *sym_name, int idx)
1730 {
1731         if (idx > 0) {
1732                 pr_err("N'th occurrence (N=%d) of symbol '%s' not found.\n",
1733                        idx, sym_name);
1734         } else if (!idx) {
1735                 pr_err("Global symbol '%s' not found.\n", sym_name);
1736         } else {
1737                 pr_err("Symbol '%s' not found.\n", sym_name);
1738         }
1739         pr_err("Note that symbols must be functions.\n");
1740
1741         return -EINVAL;
1742 }
1743
1744 static int find_kern_sym(const char *sym_name, u64 *start, u64 *size, int idx)
1745 {
1746         struct sym_args args = {
1747                 .name = sym_name,
1748                 .idx = idx,
1749                 .global = !idx,
1750                 .selected = idx > 0,
1751         };
1752         int err;
1753
1754         *start = 0;
1755         *size = 0;
1756
1757         err = kallsyms__parse("/proc/kallsyms", &args, find_kern_sym_cb);
1758         if (err < 0) {
1759                 pr_err("Failed to parse /proc/kallsyms\n");
1760                 return err;
1761         }
1762
1763         if (args.duplicate) {
1764                 pr_err("Multiple kernel symbols with name '%s'\n", sym_name);
1765                 args.cnt = 0;
1766                 kallsyms__parse("/proc/kallsyms", &args, print_kern_sym_cb);
1767                 pr_err("Disambiguate symbol name by inserting #n after the name e.g. %s #2\n",
1768                        sym_name);
1769                 pr_err("Or select a global symbol by inserting #0 or #g or #G\n");
1770                 return -EINVAL;
1771         }
1772
1773         if (!args.started) {
1774                 pr_err("Kernel symbol lookup: ");
1775                 return sym_not_found_error(sym_name, idx);
1776         }
1777
1778         *start = args.start;
1779         *size = args.size;
1780
1781         return 0;
1782 }
1783
1784 static int find_entire_kern_cb(void *arg, const char *name __maybe_unused,
1785                                char type, u64 start)
1786 {
1787         struct sym_args *args = arg;
1788
1789         if (!kallsyms__is_function(type))
1790                 return 0;
1791
1792         if (!args->started) {
1793                 args->started = true;
1794                 args->start = start;
1795         }
1796         /* Don't know exactly where the kernel ends, so we add a page */
1797         args->size = round_up(start, page_size) + page_size - args->start;
1798
1799         return 0;
1800 }
1801
1802 static int addr_filter__entire_kernel(struct addr_filter *filt)
1803 {
1804         struct sym_args args = { .started = false };
1805         int err;
1806
1807         err = kallsyms__parse("/proc/kallsyms", &args, find_entire_kern_cb);
1808         if (err < 0 || !args.started) {
1809                 pr_err("Failed to parse /proc/kallsyms\n");
1810                 return err;
1811         }
1812
1813         filt->addr = args.start;
1814         filt->size = args.size;
1815
1816         return 0;
1817 }
1818
1819 static int check_end_after_start(struct addr_filter *filt, u64 start, u64 size)
1820 {
1821         if (start + size >= filt->addr)
1822                 return 0;
1823
1824         if (filt->sym_from) {
1825                 pr_err("Symbol '%s' (0x%"PRIx64") comes before '%s' (0x%"PRIx64")\n",
1826                        filt->sym_to, start, filt->sym_from, filt->addr);
1827         } else {
1828                 pr_err("Symbol '%s' (0x%"PRIx64") comes before address 0x%"PRIx64")\n",
1829                        filt->sym_to, start, filt->addr);
1830         }
1831
1832         return -EINVAL;
1833 }
1834
1835 static int addr_filter__resolve_kernel_syms(struct addr_filter *filt)
1836 {
1837         bool no_size = false;
1838         u64 start, size;
1839         int err;
1840
1841         if (symbol_conf.kptr_restrict) {
1842                 pr_err("Kernel addresses are restricted. Unable to resolve kernel symbols.\n");
1843                 return -EINVAL;
1844         }
1845
1846         if (filt->sym_from && !strcmp(filt->sym_from, "*"))
1847                 return addr_filter__entire_kernel(filt);
1848
1849         if (filt->sym_from) {
1850                 err = find_kern_sym(filt->sym_from, &start, &size,
1851                                     filt->sym_from_idx);
1852                 if (err)
1853                         return err;
1854                 filt->addr = start;
1855                 if (filt->range && !filt->size && !filt->sym_to) {
1856                         filt->size = size;
1857                         no_size = !size;
1858                 }
1859         }
1860
1861         if (filt->sym_to) {
1862                 err = find_kern_sym(filt->sym_to, &start, &size,
1863                                     filt->sym_to_idx);
1864                 if (err)
1865                         return err;
1866
1867                 err = check_end_after_start(filt, start, size);
1868                 if (err)
1869                         return err;
1870                 filt->size = start + size - filt->addr;
1871                 no_size = !size;
1872         }
1873
1874         /* The very last symbol in kallsyms does not imply a particular size */
1875         if (no_size) {
1876                 pr_err("Cannot determine size of symbol '%s'\n",
1877                        filt->sym_to ? filt->sym_to : filt->sym_from);
1878                 return -EINVAL;
1879         }
1880
1881         return 0;
1882 }
1883
1884 static struct dso *load_dso(const char *name)
1885 {
1886         struct map *map;
1887         struct dso *dso;
1888
1889         map = dso__new_map(name);
1890         if (!map)
1891                 return NULL;
1892
1893         map__load(map);
1894
1895         dso = dso__get(map->dso);
1896
1897         map__put(map);
1898
1899         return dso;
1900 }
1901
1902 static bool dso_sym_match(struct symbol *sym, const char *name, int *cnt,
1903                           int idx)
1904 {
1905         /* Same name, and global or the n'th found or any */
1906         return !arch__compare_symbol_names(name, sym->name) &&
1907                ((!idx && sym->binding == STB_GLOBAL) ||
1908                 (idx > 0 && ++*cnt == idx) ||
1909                 idx < 0);
1910 }
1911
1912 static void print_duplicate_syms(struct dso *dso, const char *sym_name)
1913 {
1914         struct symbol *sym;
1915         bool near = false;
1916         int cnt = 0;
1917
1918         pr_err("Multiple symbols with name '%s'\n", sym_name);
1919
1920         sym = dso__first_symbol(dso);
1921         while (sym) {
1922                 if (dso_sym_match(sym, sym_name, &cnt, -1)) {
1923                         pr_err("#%d\t0x%"PRIx64"\t%c\t%s\n",
1924                                ++cnt, sym->start,
1925                                sym->binding == STB_GLOBAL ? 'g' :
1926                                sym->binding == STB_LOCAL  ? 'l' : 'w',
1927                                sym->name);
1928                         near = true;
1929                 } else if (near) {
1930                         near = false;
1931                         pr_err("\t\twhich is near\t\t%s\n", sym->name);
1932                 }
1933                 sym = dso__next_symbol(sym);
1934         }
1935
1936         pr_err("Disambiguate symbol name by inserting #n after the name e.g. %s #2\n",
1937                sym_name);
1938         pr_err("Or select a global symbol by inserting #0 or #g or #G\n");
1939 }
1940
1941 static int find_dso_sym(struct dso *dso, const char *sym_name, u64 *start,
1942                         u64 *size, int idx)
1943 {
1944         struct symbol *sym;
1945         int cnt = 0;
1946
1947         *start = 0;
1948         *size = 0;
1949
1950         sym = dso__first_symbol(dso);
1951         while (sym) {
1952                 if (*start) {
1953                         if (!*size)
1954                                 *size = sym->start - *start;
1955                         if (idx > 0) {
1956                                 if (*size)
1957                                         return 1;
1958                         } else if (dso_sym_match(sym, sym_name, &cnt, idx)) {
1959                                 print_duplicate_syms(dso, sym_name);
1960                                 return -EINVAL;
1961                         }
1962                 } else if (dso_sym_match(sym, sym_name, &cnt, idx)) {
1963                         *start = sym->start;
1964                         *size = sym->end - sym->start;
1965                 }
1966                 sym = dso__next_symbol(sym);
1967         }
1968
1969         if (!*start)
1970                 return sym_not_found_error(sym_name, idx);
1971
1972         return 0;
1973 }
1974
1975 static int addr_filter__entire_dso(struct addr_filter *filt, struct dso *dso)
1976 {
1977         struct symbol *first_sym = dso__first_symbol(dso);
1978         struct symbol *last_sym = dso__last_symbol(dso);
1979
1980         if (!first_sym || !last_sym) {
1981                 pr_err("Failed to determine filter for %s\nNo symbols found.\n",
1982                        filt->filename);
1983                 return -EINVAL;
1984         }
1985
1986         filt->addr = first_sym->start;
1987         filt->size = last_sym->end - first_sym->start;
1988
1989         return 0;
1990 }
1991
1992 static int addr_filter__resolve_syms(struct addr_filter *filt)
1993 {
1994         u64 start, size;
1995         struct dso *dso;
1996         int err = 0;
1997
1998         if (!filt->sym_from && !filt->sym_to)
1999                 return 0;
2000
2001         if (!filt->filename)
2002                 return addr_filter__resolve_kernel_syms(filt);
2003
2004         dso = load_dso(filt->filename);
2005         if (!dso) {
2006                 pr_err("Failed to load symbols from: %s\n", filt->filename);
2007                 return -EINVAL;
2008         }
2009
2010         if (filt->sym_from && !strcmp(filt->sym_from, "*")) {
2011                 err = addr_filter__entire_dso(filt, dso);
2012                 goto put_dso;
2013         }
2014
2015         if (filt->sym_from) {
2016                 err = find_dso_sym(dso, filt->sym_from, &start, &size,
2017                                    filt->sym_from_idx);
2018                 if (err)
2019                         goto put_dso;
2020                 filt->addr = start;
2021                 if (filt->range && !filt->size && !filt->sym_to)
2022                         filt->size = size;
2023         }
2024
2025         if (filt->sym_to) {
2026                 err = find_dso_sym(dso, filt->sym_to, &start, &size,
2027                                    filt->sym_to_idx);
2028                 if (err)
2029                         goto put_dso;
2030
2031                 err = check_end_after_start(filt, start, size);
2032                 if (err)
2033                         return err;
2034
2035                 filt->size = start + size - filt->addr;
2036         }
2037
2038 put_dso:
2039         dso__put(dso);
2040
2041         return err;
2042 }
2043
2044 static char *addr_filter__to_str(struct addr_filter *filt)
2045 {
2046         char filename_buf[PATH_MAX];
2047         const char *at = "";
2048         const char *fn = "";
2049         char *filter;
2050         int err;
2051
2052         if (filt->filename) {
2053                 at = "@";
2054                 fn = realpath(filt->filename, filename_buf);
2055                 if (!fn)
2056                         return NULL;
2057         }
2058
2059         if (filt->range) {
2060                 err = asprintf(&filter, "%s 0x%"PRIx64"/0x%"PRIx64"%s%s",
2061                                filt->action, filt->addr, filt->size, at, fn);
2062         } else {
2063                 err = asprintf(&filter, "%s 0x%"PRIx64"%s%s",
2064                                filt->action, filt->addr, at, fn);
2065         }
2066
2067         return err < 0 ? NULL : filter;
2068 }
2069
2070 static int parse_addr_filter(struct perf_evsel *evsel, const char *filter,
2071                              int max_nr)
2072 {
2073         struct addr_filters filts;
2074         struct addr_filter *filt;
2075         int err;
2076
2077         addr_filters__init(&filts);
2078
2079         err = addr_filters__parse_bare_filter(&filts, filter);
2080         if (err)
2081                 goto out_exit;
2082
2083         if (filts.cnt > max_nr) {
2084                 pr_err("Error: number of address filters (%d) exceeds maximum (%d)\n",
2085                        filts.cnt, max_nr);
2086                 err = -EINVAL;
2087                 goto out_exit;
2088         }
2089
2090         list_for_each_entry(filt, &filts.head, list) {
2091                 char *new_filter;
2092
2093                 err = addr_filter__resolve_syms(filt);
2094                 if (err)
2095                         goto out_exit;
2096
2097                 new_filter = addr_filter__to_str(filt);
2098                 if (!new_filter) {
2099                         err = -ENOMEM;
2100                         goto out_exit;
2101                 }
2102
2103                 if (perf_evsel__append_addr_filter(evsel, new_filter)) {
2104                         err = -ENOMEM;
2105                         goto out_exit;
2106                 }
2107         }
2108
2109 out_exit:
2110         addr_filters__exit(&filts);
2111
2112         if (err) {
2113                 pr_err("Failed to parse address filter: '%s'\n", filter);
2114                 pr_err("Filter format is: filter|start|stop|tracestop <start symbol or address> [/ <end symbol or size>] [@<file name>]\n");
2115                 pr_err("Where multiple filters are separated by space or comma.\n");
2116         }
2117
2118         return err;
2119 }
2120
2121 static struct perf_pmu *perf_evsel__find_pmu(struct perf_evsel *evsel)
2122 {
2123         struct perf_pmu *pmu = NULL;
2124
2125         while ((pmu = perf_pmu__scan(pmu)) != NULL) {
2126                 if (pmu->type == evsel->attr.type)
2127                         break;
2128         }
2129
2130         return pmu;
2131 }
2132
2133 static int perf_evsel__nr_addr_filter(struct perf_evsel *evsel)
2134 {
2135         struct perf_pmu *pmu = perf_evsel__find_pmu(evsel);
2136         int nr_addr_filters = 0;
2137
2138         if (!pmu)
2139                 return 0;
2140
2141         perf_pmu__scan_file(pmu, "nr_addr_filters", "%d", &nr_addr_filters);
2142
2143         return nr_addr_filters;
2144 }
2145
2146 int auxtrace_parse_filters(struct perf_evlist *evlist)
2147 {
2148         struct perf_evsel *evsel;
2149         char *filter;
2150         int err, max_nr;
2151
2152         evlist__for_each_entry(evlist, evsel) {
2153                 filter = evsel->filter;
2154                 max_nr = perf_evsel__nr_addr_filter(evsel);
2155                 if (!filter || !max_nr)
2156                         continue;
2157                 evsel->filter = NULL;
2158                 err = parse_addr_filter(evsel, filter, max_nr);
2159                 free(filter);
2160                 if (err)
2161                         return err;
2162                 pr_debug("Address filter: %s\n", evsel->filter);
2163         }
2164
2165         return 0;
2166 }