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