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 <sys/types.h>
  17 #include <sys/mman.h>
  18 #include <stdbool.h>
  19
  20 #include <linux/kernel.h>
  21 #include <linux/perf_event.h>
  22 #include <linux/types.h>
  23 #include <linux/bitops.h>
  24 #include <linux/log2.h>
  25 #include <linux/string.h>
  26
  27 #include <sys/param.h>
  28 #include <stdlib.h>
  29 #include <stdio.h>
  30 #include <string.h>
  31 #include <limits.h>
  32 #include <errno.h>
  33 #include <linux/list.h>
  34
  35 #include "../perf.h"
  36 #include "util.h"
  37 #include "evlist.h"
  38 #include "cpumap.h"
  39 #include "thread_map.h"
  40 #include "asm/bug.h"
  41 #include "auxtrace.h"
  42
  43 #include <linux/hash.h>
  44
  45 #include "event.h"
  46 #include "session.h"
  47 #include "debug.h"
  48 #include "parse-options.h"
  49
  50 int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
  51                         struct auxtrace_mmap_params *mp,
  52                         void *userpg, int fd)
  53 {
  54         struct perf_event_mmap_page *pc = userpg;
  55
  56 #if BITS_PER_LONG != 64 && !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
  57         pr_err("Cannot use AUX area tracing mmaps\n");
  58         return -1;
  59 #endif
  60
  61         WARN_ONCE(mm->base, "Uninitialized auxtrace_mmap\n");
  62
  63         mm->userpg = userpg;
  64         mm->mask = mp->mask;
  65         mm->len = mp->len;
  66         mm->prev = 0;
  67         mm->idx = mp->idx;
  68         mm->tid = mp->tid;
  69         mm->cpu = mp->cpu;
  70
  71         if (!mp->len) {
  72                 mm->base = NULL;
  73                 return 0;
  74         }
  75
  76         pc->aux_offset = mp->offset;
  77         pc->aux_size = mp->len;
  78
  79         mm->base = mmap(NULL, mp->len, mp->prot, MAP_SHARED, fd, mp->offset);
  80         if (mm->base == MAP_FAILED) {
  81                 pr_debug2("failed to mmap AUX area\n");
  82                 mm->base = NULL;
  83                 return -1;
  84         }
  85
  86         return 0;
  87 }
  88
  89 void auxtrace_mmap__munmap(struct auxtrace_mmap *mm)
  90 {
  91         if (mm->base) {
  92                 munmap(mm->base, mm->len);
  93                 mm->base = NULL;
  94         }
  95 }
  96
  97 void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
  98                                 off_t auxtrace_offset,
  99                                 unsigned int auxtrace_pages,
 100                                 bool auxtrace_overwrite)
 101 {
 102         if (auxtrace_pages) {
 103                 mp->offset = auxtrace_offset;
 104                 mp->len = auxtrace_pages * (size_t)page_size;
 105                 mp->mask = is_power_of_2(mp->len) ? mp->len - 1 : 0;
 106                 mp->prot = PROT_READ | (auxtrace_overwrite ? 0 : PROT_WRITE);
 107                 pr_debug2("AUX area mmap length %zu\n", mp->len);
 108         } else {
 109                 mp->len = 0;
 110         }
 111 }
 112
 113 void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
 114                                    struct perf_evlist *evlist, int idx,
 115                                    bool per_cpu)
 116 {
 117         mp->idx = idx;
 118
 119         if (per_cpu) {
 120                 mp->cpu = evlist->cpus->map[idx];
 121                 if (evlist->threads)
 122                         mp->tid = evlist->threads->map[0];
 123                 else
 124                         mp->tid = -1;
 125         } else {
 126                 mp->cpu = -1;
 127                 mp->tid = evlist->threads->map[idx];
 128         }
 129 }
 130
 131 #define AUXTRACE_INIT_NR_QUEUES 32
 132
 133 static struct auxtrace_queue *auxtrace_alloc_queue_array(unsigned int nr_queues)
 134 {
 135         struct auxtrace_queue *queue_array;
 136         unsigned int max_nr_queues, i;
 137
 138         max_nr_queues = UINT_MAX / sizeof(struct auxtrace_queue);
 139         if (nr_queues > max_nr_queues)
 140                 return NULL;
 141
 142         queue_array = calloc(nr_queues, sizeof(struct auxtrace_queue));
 143         if (!queue_array)
 144                 return NULL;
 145
 146         for (i = 0; i < nr_queues; i++) {
 147                 INIT_LIST_HEAD(&queue_array[i].head);
 148                 queue_array[i].priv = NULL;
 149         }
 150
 151         return queue_array;
 152 }
 153
 154 int auxtrace_queues__init(struct auxtrace_queues *queues)
 155 {
 156         queues->nr_queues = AUXTRACE_INIT_NR_QUEUES;
 157         queues->queue_array = auxtrace_alloc_queue_array(queues->nr_queues);
 158         if (!queues->queue_array)
 159                 return -ENOMEM;
 160         return 0;
 161 }
 162
 163 static int auxtrace_queues__grow(struct auxtrace_queues *queues,
 164                                  unsigned int new_nr_queues)
 165 {
 166         unsigned int nr_queues = queues->nr_queues;
 167         struct auxtrace_queue *queue_array;
 168         unsigned int i;
 169
 170         if (!nr_queues)
 171                 nr_queues = AUXTRACE_INIT_NR_QUEUES;
 172
 173         while (nr_queues && nr_queues < new_nr_queues)
 174                 nr_queues <<= 1;
 175
 176         if (nr_queues < queues->nr_queues || nr_queues < new_nr_queues)
 177                 return -EINVAL;
 178
 179         queue_array = auxtrace_alloc_queue_array(nr_queues);
 180         if (!queue_array)
 181                 return -ENOMEM;
 182
 183         for (i = 0; i < queues->nr_queues; i++) {
 184                 list_splice_tail(&queues->queue_array[i].head,
 185                                  &queue_array[i].head);
 186                 queue_array[i].priv = queues->queue_array[i].priv;
 187         }
 188
 189         queues->nr_queues = nr_queues;
 190         queues->queue_array = queue_array;
 191
 192         return 0;
 193 }
 194
 195 static void *auxtrace_copy_data(u64 size, struct perf_session *session)
 196 {
 197         int fd = perf_data_file__fd(session->file);
 198         void *p;
 199         ssize_t ret;
 200
 201         if (size > SSIZE_MAX)
 202                 return NULL;
 203
 204         p = malloc(size);
 205         if (!p)
 206                 return NULL;
 207
 208         ret = readn(fd, p, size);
 209         if (ret != (ssize_t)size) {
 210                 free(p);
 211                 return NULL;
 212         }
 213
 214         return p;
 215 }
 216
 217 static int auxtrace_queues__add_buffer(struct auxtrace_queues *queues,
 218                                        unsigned int idx,
 219                                        struct auxtrace_buffer *buffer)
 220 {
 221         struct auxtrace_queue *queue;
 222         int err;
 223
 224         if (idx >= queues->nr_queues) {
 225                 err = auxtrace_queues__grow(queues, idx + 1);
 226                 if (err)
 227                         return err;
 228         }
 229
 230         queue = &queues->queue_array[idx];
 231
 232         if (!queue->set) {
 233                 queue->set = true;
 234                 queue->tid = buffer->tid;
 235                 queue->cpu = buffer->cpu;
 236         } else if (buffer->cpu != queue->cpu || buffer->tid != queue->tid) {
 237                 pr_err("auxtrace queue conflict: cpu %d, tid %d vs cpu %d, tid %d\n",
 238                        queue->cpu, queue->tid, buffer->cpu, buffer->tid);
 239                 return -EINVAL;
 240         }
 241
 242         buffer->buffer_nr = queues->next_buffer_nr++;
 243
 244         list_add_tail(&buffer->list, &queue->head);
 245
 246         queues->new_data = true;
 247         queues->populated = true;
 248
 249         return 0;
 250 }
 251
 252 /* Limit buffers to 32MiB on 32-bit */
 253 #define BUFFER_LIMIT_FOR_32_BIT (32 * 1024 * 1024)
 254
 255 static int auxtrace_queues__split_buffer(struct auxtrace_queues *queues,
 256                                          unsigned int idx,
 257                                          struct auxtrace_buffer *buffer)
 258 {
 259         u64 sz = buffer->size;
 260         bool consecutive = false;
 261         struct auxtrace_buffer *b;
 262         int err;
 263
 264         while (sz > BUFFER_LIMIT_FOR_32_BIT) {
 265                 b = memdup(buffer, sizeof(struct auxtrace_buffer));
 266                 if (!b)
 267                         return -ENOMEM;
 268                 b->size = BUFFER_LIMIT_FOR_32_BIT;
 269                 b->consecutive = consecutive;
 270                 err = auxtrace_queues__add_buffer(queues, idx, b);
 271                 if (err) {
 272                         auxtrace_buffer__free(b);
 273                         return err;
 274                 }
 275                 buffer->data_offset += BUFFER_LIMIT_FOR_32_BIT;
 276                 sz -= BUFFER_LIMIT_FOR_32_BIT;
 277                 consecutive = true;
 278         }
 279
 280         buffer->size = sz;
 281         buffer->consecutive = consecutive;
 282
 283         return 0;
 284 }
 285
 286 static int auxtrace_queues__add_event_buffer(struct auxtrace_queues *queues,
 287                                              struct perf_session *session,
 288                                              unsigned int idx,
 289                                              struct auxtrace_buffer *buffer)
 290 {
 291         if (session->one_mmap) {
 292                 buffer->data = buffer->data_offset - session->one_mmap_offset +
 293                                session->one_mmap_addr;
 294         } else if (perf_data_file__is_pipe(session->file)) {
 295                 buffer->data = auxtrace_copy_data(buffer->size, session);
 296                 if (!buffer->data)
 297                         return -ENOMEM;
 298                 buffer->data_needs_freeing = true;
 299         } else if (BITS_PER_LONG == 32 &&
 300                    buffer->size > BUFFER_LIMIT_FOR_32_BIT) {
 301                 int err;
 302
 303                 err = auxtrace_queues__split_buffer(queues, idx, buffer);
 304                 if (err)
 305                         return err;
 306         }
 307
 308         return auxtrace_queues__add_buffer(queues, idx, buffer);
 309 }
 310
 311 int auxtrace_queues__add_event(struct auxtrace_queues *queues,
 312                                struct perf_session *session,
 313                                union perf_event *event, off_t data_offset,
 314                                struct auxtrace_buffer **buffer_ptr)
 315 {
 316         struct auxtrace_buffer *buffer;
 317         unsigned int idx;
 318         int err;
 319
 320         buffer = zalloc(sizeof(struct auxtrace_buffer));
 321         if (!buffer)
 322                 return -ENOMEM;
 323
 324         buffer->pid = -1;
 325         buffer->tid = event->auxtrace.tid;
 326         buffer->cpu = event->auxtrace.cpu;
 327         buffer->data_offset = data_offset;
 328         buffer->offset = event->auxtrace.offset;
 329         buffer->reference = event->auxtrace.reference;
 330         buffer->size = event->auxtrace.size;
 331         idx = event->auxtrace.idx;
 332
 333         err = auxtrace_queues__add_event_buffer(queues, session, idx, buffer);
 334         if (err)
 335                 goto out_err;
 336
 337         if (buffer_ptr)
 338                 *buffer_ptr = buffer;
 339
 340         return 0;
 341
 342 out_err:
 343         auxtrace_buffer__free(buffer);
 344         return err;
 345 }
 346
 347 static int auxtrace_queues__add_indexed_event(struct auxtrace_queues *queues,
 348                                               struct perf_session *session,
 349                                               off_t file_offset, size_t sz)
 350 {
 351         union perf_event *event;
 352         int err;
 353         char buf[PERF_SAMPLE_MAX_SIZE];
 354
 355         err = perf_session__peek_event(session, file_offset, buf,
 356                                        PERF_SAMPLE_MAX_SIZE, &event, NULL);
 357         if (err)
 358                 return err;
 359
 360         if (event->header.type == PERF_RECORD_AUXTRACE) {
 361                 if (event->header.size < sizeof(struct auxtrace_event) ||
 362                     event->header.size != sz) {
 363                         err = -EINVAL;
 364                         goto out;
 365                 }
 366                 file_offset += event->header.size;
 367                 err = auxtrace_queues__add_event(queues, session, event,
 368                                                  file_offset, NULL);
 369         }
 370 out:
 371         return err;
 372 }
 373
 374 void auxtrace_queues__free(struct auxtrace_queues *queues)
 375 {
 376         unsigned int i;
 377
 378         for (i = 0; i < queues->nr_queues; i++) {
 379                 while (!list_empty(&queues->queue_array[i].head)) {
 380                         struct auxtrace_buffer *buffer;
 381
 382                         buffer = list_entry(queues->queue_array[i].head.next,
 383                                             struct auxtrace_buffer, list);
 384                         list_del(&buffer->list);
 385                         auxtrace_buffer__free(buffer);
 386                 }
 387         }
 388
 389         zfree(&queues->queue_array);
 390         queues->nr_queues = 0;
 391 }
 392
 393 static void auxtrace_heapify(struct auxtrace_heap_item *heap_array,
 394                              unsigned int pos, unsigned int queue_nr,
 395                              u64 ordinal)
 396 {
 397         unsigned int parent;
 398
 399         while (pos) {
 400                 parent = (pos - 1) >> 1;
 401                 if (heap_array[parent].ordinal <= ordinal)
 402                         break;
 403                 heap_array[pos] = heap_array[parent];
 404                 pos = parent;
 405         }
 406         heap_array[pos].queue_nr = queue_nr;
 407         heap_array[pos].ordinal = ordinal;
 408 }
 409
 410 int auxtrace_heap__add(struct auxtrace_heap *heap, unsigned int queue_nr,
 411                        u64 ordinal)
 412 {
 413         struct auxtrace_heap_item *heap_array;
 414
 415         if (queue_nr >= heap->heap_sz) {
 416                 unsigned int heap_sz = AUXTRACE_INIT_NR_QUEUES;
 417
 418                 while (heap_sz <= queue_nr)
 419                         heap_sz <<= 1;
 420                 heap_array = realloc(heap->heap_array,
 421                                      heap_sz * sizeof(struct auxtrace_heap_item));
 422                 if (!heap_array)
 423                         return -ENOMEM;
 424                 heap->heap_array = heap_array;
 425                 heap->heap_sz = heap_sz;
 426         }
 427
 428         auxtrace_heapify(heap->heap_array, heap->heap_cnt++, queue_nr, ordinal);
 429
 430         return 0;
 431 }
 432
 433 void auxtrace_heap__free(struct auxtrace_heap *heap)
 434 {
 435         zfree(&heap->heap_array);
 436         heap->heap_cnt = 0;
 437         heap->heap_sz = 0;
 438 }
 439
 440 void auxtrace_heap__pop(struct auxtrace_heap *heap)
 441 {
 442         unsigned int pos, last, heap_cnt = heap->heap_cnt;
 443         struct auxtrace_heap_item *heap_array;
 444
 445         if (!heap_cnt)
 446                 return;
 447
 448         heap->heap_cnt -= 1;
 449
 450         heap_array = heap->heap_array;
 451
 452         pos = 0;
 453         while (1) {
 454                 unsigned int left, right;
 455
 456                 left = (pos << 1) + 1;
 457                 if (left >= heap_cnt)
 458                         break;
 459                 right = left + 1;
 460                 if (right >= heap_cnt) {
 461                         heap_array[pos] = heap_array[left];
 462                         return;
 463                 }
 464                 if (heap_array[left].ordinal < heap_array[right].ordinal) {
 465                         heap_array[pos] = heap_array[left];
 466                         pos = left;
 467                 } else {
 468                         heap_array[pos] = heap_array[right];
 469                         pos = right;
 470                 }
 471         }
 472
 473         last = heap_cnt - 1;
 474         auxtrace_heapify(heap_array, pos, heap_array[last].queue_nr,
 475                          heap_array[last].ordinal);
 476 }
 477
 478 size_t auxtrace_record__info_priv_size(struct auxtrace_record *itr)
 479 {
 480         if (itr)
 481                 return itr->info_priv_size(itr);
 482         return 0;
 483 }
 484
 485 static int auxtrace_not_supported(void)
 486 {
 487         pr_err("AUX area tracing is not supported on this architecture\n");
 488         return -EINVAL;
 489 }
 490
 491 int auxtrace_record__info_fill(struct auxtrace_record *itr,
 492                                struct perf_session *session,
 493                                struct auxtrace_info_event *auxtrace_info,
 494                                size_t priv_size)
 495 {
 496         if (itr)
 497                 return itr->info_fill(itr, session, auxtrace_info, priv_size);
 498         return auxtrace_not_supported();
 499 }
 500
 501 void auxtrace_record__free(struct auxtrace_record *itr)
 502 {
 503         if (itr)
 504                 itr->free(itr);
 505 }
 506
 507 int auxtrace_record__options(struct auxtrace_record *itr,
 508                              struct perf_evlist *evlist,
 509                              struct record_opts *opts)
 510 {
 511         if (itr)
 512                 return itr->recording_options(itr, evlist, opts);
 513         return 0;
 514 }
 515
 516 u64 auxtrace_record__reference(struct auxtrace_record *itr)
 517 {
 518         if (itr)
 519                 return itr->reference(itr);
 520         return 0;
 521 }
 522
 523 struct auxtrace_record *__weak
 524 auxtrace_record__init(struct perf_evlist *evlist __maybe_unused, int *err)
 525 {
 526         *err = 0;
 527         return NULL;
 528 }
 529
 530 static int auxtrace_index__alloc(struct list_head *head)
 531 {
 532         struct auxtrace_index *auxtrace_index;
 533
 534         auxtrace_index = malloc(sizeof(struct auxtrace_index));
 535         if (!auxtrace_index)
 536                 return -ENOMEM;
 537
 538         auxtrace_index->nr = 0;
 539         INIT_LIST_HEAD(&auxtrace_index->list);
 540
 541         list_add_tail(&auxtrace_index->list, head);
 542
 543         return 0;
 544 }
 545
 546 void auxtrace_index__free(struct list_head *head)
 547 {
 548         struct auxtrace_index *auxtrace_index, *n;
 549
 550         list_for_each_entry_safe(auxtrace_index, n, head, list) {
 551                 list_del(&auxtrace_index->list);
 552                 free(auxtrace_index);
 553         }
 554 }
 555
 556 static struct auxtrace_index *auxtrace_index__last(struct list_head *head)
 557 {
 558         struct auxtrace_index *auxtrace_index;
 559         int err;
 560
 561         if (list_empty(head)) {
 562                 err = auxtrace_index__alloc(head);
 563                 if (err)
 564                         return NULL;
 565         }
 566
 567         auxtrace_index = list_entry(head->prev, struct auxtrace_index, list);
 568
 569         if (auxtrace_index->nr >= PERF_AUXTRACE_INDEX_ENTRY_COUNT) {
 570                 err = auxtrace_index__alloc(head);
 571                 if (err)
 572                         return NULL;
 573                 auxtrace_index = list_entry(head->prev, struct auxtrace_index,
 574                                             list);
 575         }
 576
 577         return auxtrace_index;
 578 }
 579
 580 int auxtrace_index__auxtrace_event(struct list_head *head,
 581                                    union perf_event *event, off_t file_offset)
 582 {
 583         struct auxtrace_index *auxtrace_index;
 584         size_t nr;
 585
 586         auxtrace_index = auxtrace_index__last(head);
 587         if (!auxtrace_index)
 588                 return -ENOMEM;
 589
 590         nr = auxtrace_index->nr;
 591         auxtrace_index->entries[nr].file_offset = file_offset;
 592         auxtrace_index->entries[nr].sz = event->header.size;
 593         auxtrace_index->nr += 1;
 594
 595         return 0;
 596 }
 597
 598 static int auxtrace_index__do_write(int fd,
 599                                     struct auxtrace_index *auxtrace_index)
 600 {
 601         struct auxtrace_index_entry ent;
 602         size_t i;
 603
 604         for (i = 0; i < auxtrace_index->nr; i++) {
 605                 ent.file_offset = auxtrace_index->entries[i].file_offset;
 606                 ent.sz = auxtrace_index->entries[i].sz;
 607                 if (writen(fd, &ent, sizeof(ent)) != sizeof(ent))
 608                         return -errno;
 609         }
 610         return 0;
 611 }
 612
 613 int auxtrace_index__write(int fd, struct list_head *head)
 614 {
 615         struct auxtrace_index *auxtrace_index;
 616         u64 total = 0;
 617         int err;
 618
 619         list_for_each_entry(auxtrace_index, head, list)
 620                 total += auxtrace_index->nr;
 621
 622         if (writen(fd, &total, sizeof(total)) != sizeof(total))
 623                 return -errno;
 624
 625         list_for_each_entry(auxtrace_index, head, list) {
 626                 err = auxtrace_index__do_write(fd, auxtrace_index);
 627                 if (err)
 628                         return err;
 629         }
 630
 631         return 0;
 632 }
 633
 634 static int auxtrace_index__process_entry(int fd, struct list_head *head,
 635                                          bool needs_swap)
 636 {
 637         struct auxtrace_index *auxtrace_index;
 638         struct auxtrace_index_entry ent;
 639         size_t nr;
 640
 641         if (readn(fd, &ent, sizeof(ent)) != sizeof(ent))
 642                 return -1;
 643
 644         auxtrace_index = auxtrace_index__last(head);
 645         if (!auxtrace_index)
 646                 return -1;
 647
 648         nr = auxtrace_index->nr;
 649         if (needs_swap) {
 650                 auxtrace_index->entries[nr].file_offset =
 651                                                 bswap_64(ent.file_offset);
 652                 auxtrace_index->entries[nr].sz = bswap_64(ent.sz);
 653         } else {
 654                 auxtrace_index->entries[nr].file_offset = ent.file_offset;
 655                 auxtrace_index->entries[nr].sz = ent.sz;
 656         }
 657
 658         auxtrace_index->nr = nr + 1;
 659
 660         return 0;
 661 }
 662
 663 int auxtrace_index__process(int fd, u64 size, struct perf_session *session,
 664                             bool needs_swap)
 665 {
 666         struct list_head *head = &session->auxtrace_index;
 667         u64 nr;
 668
 669         if (readn(fd, &nr, sizeof(u64)) != sizeof(u64))
 670                 return -1;
 671
 672         if (needs_swap)
 673                 nr = bswap_64(nr);
 674
 675         if (sizeof(u64) + nr * sizeof(struct auxtrace_index_entry) > size)
 676                 return -1;
 677
 678         while (nr--) {
 679                 int err;
 680
 681                 err = auxtrace_index__process_entry(fd, head, needs_swap);
 682                 if (err)
 683                         return -1;
 684         }
 685
 686         return 0;
 687 }
 688
 689 static int auxtrace_queues__process_index_entry(struct auxtrace_queues *queues,
 690                                                 struct perf_session *session,
 691                                                 struct auxtrace_index_entry *ent)
 692 {
 693         return auxtrace_queues__add_indexed_event(queues, session,
 694                                                   ent->file_offset, ent->sz);
 695 }
 696
 697 int auxtrace_queues__process_index(struct auxtrace_queues *queues,
 698                                    struct perf_session *session)
 699 {
 700         struct auxtrace_index *auxtrace_index;
 701         struct auxtrace_index_entry *ent;
 702         size_t i;
 703         int err;
 704
 705         list_for_each_entry(auxtrace_index, &session->auxtrace_index, list) {
 706                 for (i = 0; i < auxtrace_index->nr; i++) {
 707                         ent = &auxtrace_index->entries[i];
 708                         err = auxtrace_queues__process_index_entry(queues,
 709                                                                    session,
 710                                                                    ent);
 711                         if (err)
 712                                 return err;
 713                 }
 714         }
 715         return 0;
 716 }
 717
 718 struct auxtrace_buffer *auxtrace_buffer__next(struct auxtrace_queue *queue,
 719                                               struct auxtrace_buffer *buffer)
 720 {
 721         if (buffer) {
 722                 if (list_is_last(&buffer->list, &queue->head))
 723                         return NULL;
 724                 return list_entry(buffer->list.next, struct auxtrace_buffer,
 725                                   list);
 726         } else {
 727                 if (list_empty(&queue->head))
 728                         return NULL;
 729                 return list_entry(queue->head.next, struct auxtrace_buffer,
 730                                   list);
 731         }
 732 }
 733
 734 void *auxtrace_buffer__get_data(struct auxtrace_buffer *buffer, int fd)
 735 {
 736         size_t adj = buffer->data_offset & (page_size - 1);
 737         size_t size = buffer->size + adj;
 738         off_t file_offset = buffer->data_offset - adj;
 739         void *addr;
 740
 741         if (buffer->data)
 742                 return buffer->data;
 743
 744         addr = mmap(NULL, size, PROT_READ, MAP_SHARED, fd, file_offset);
 745         if (addr == MAP_FAILED)
 746                 return NULL;
 747
 748         buffer->mmap_addr = addr;
 749         buffer->mmap_size = size;
 750
 751         buffer->data = addr + adj;
 752
 753         return buffer->data;
 754 }
 755
 756 void auxtrace_buffer__put_data(struct auxtrace_buffer *buffer)
 757 {
 758         if (!buffer->data || !buffer->mmap_addr)
 759                 return;
 760         munmap(buffer->mmap_addr, buffer->mmap_size);
 761         buffer->mmap_addr = NULL;
 762         buffer->mmap_size = 0;
 763         buffer->data = NULL;
 764         buffer->use_data = NULL;
 765 }
 766
 767 void auxtrace_buffer__drop_data(struct auxtrace_buffer *buffer)
 768 {
 769         auxtrace_buffer__put_data(buffer);
 770         if (buffer->data_needs_freeing) {
 771                 buffer->data_needs_freeing = false;
 772                 zfree(&buffer->data);
 773                 buffer->use_data = NULL;
 774                 buffer->size = 0;
 775         }
 776 }
 777
 778 void auxtrace_buffer__free(struct auxtrace_buffer *buffer)
 779 {
 780         auxtrace_buffer__drop_data(buffer);
 781         free(buffer);
 782 }
 783
 784 void auxtrace_synth_error(struct auxtrace_error_event *auxtrace_error, int type,
 785                           int code, int cpu, pid_t pid, pid_t tid, u64 ip,
 786                           const char *msg)
 787 {
 788         size_t size;
 789
 790         memset(auxtrace_error, 0, sizeof(struct auxtrace_error_event));
 791
 792         auxtrace_error->header.type = PERF_RECORD_AUXTRACE_ERROR;
 793         auxtrace_error->type = type;
 794         auxtrace_error->code = code;
 795         auxtrace_error->cpu = cpu;
 796         auxtrace_error->pid = pid;
 797         auxtrace_error->tid = tid;
 798         auxtrace_error->ip = ip;
 799         strlcpy(auxtrace_error->msg, msg, MAX_AUXTRACE_ERROR_MSG);
 800
 801         size = (void *)auxtrace_error->msg - (void *)auxtrace_error +
 802                strlen(auxtrace_error->msg) + 1;
 803         auxtrace_error->header.size = PERF_ALIGN(size, sizeof(u64));
 804 }
 805
 806 int perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr,
 807                                          struct perf_tool *tool,
 808                                          struct perf_session *session,
 809                                          perf_event__handler_t process)
 810 {
 811         union perf_event *ev;
 812         size_t priv_size;
 813         int err;
 814
 815         pr_debug2("Synthesizing auxtrace information\n");
 816         priv_size = auxtrace_record__info_priv_size(itr);
 817         ev = zalloc(sizeof(struct auxtrace_info_event) + priv_size);
 818         if (!ev)
 819                 return -ENOMEM;
 820
 821         ev->auxtrace_info.header.type = PERF_RECORD_AUXTRACE_INFO;
 822         ev->auxtrace_info.header.size = sizeof(struct auxtrace_info_event) +
 823                                         priv_size;
 824         err = auxtrace_record__info_fill(itr, session, &ev->auxtrace_info,
 825                                          priv_size);
 826         if (err)
 827                 goto out_free;
 828
 829         err = process(tool, ev, NULL, NULL);
 830 out_free:
 831         free(ev);
 832         return err;
 833 }
 834
 835 static bool auxtrace__dont_decode(struct perf_session *session)
 836 {
 837         return !session->itrace_synth_opts ||
 838                session->itrace_synth_opts->dont_decode;
 839 }
 840
 841 int perf_event__process_auxtrace_info(struct perf_tool *tool __maybe_unused,
 842                                       union perf_event *event,
 843                                       struct perf_session *session __maybe_unused)
 844 {
 845         enum auxtrace_type type = event->auxtrace_info.type;
 846
 847         if (dump_trace)
 848                 fprintf(stdout, " type: %u\n", type);
 849
 850         switch (type) {
 851         case PERF_AUXTRACE_UNKNOWN:
 852         default:
 853                 return -EINVAL;
 854         }
 855 }
 856
 857 s64 perf_event__process_auxtrace(struct perf_tool *tool,
 858                                  union perf_event *event,
 859                                  struct perf_session *session)
 860 {
 861         s64 err;
 862
 863         if (dump_trace)
 864                 fprintf(stdout, " size: %#"PRIx64"  offset: %#"PRIx64"  ref: %#"PRIx64"  idx: %u  tid: %d  cpu: %d\n",
 865                         event->auxtrace.size, event->auxtrace.offset,
 866                         event->auxtrace.reference, event->auxtrace.idx,
 867                         event->auxtrace.tid, event->auxtrace.cpu);
 868
 869         if (auxtrace__dont_decode(session))
 870                 return event->auxtrace.size;
 871
 872         if (!session->auxtrace || event->header.type != PERF_RECORD_AUXTRACE)
 873                 return -EINVAL;
 874
 875         err = session->auxtrace->process_auxtrace_event(session, event, tool);
 876         if (err < 0)
 877                 return err;
 878
 879         return event->auxtrace.size;
 880 }
 881
 882 #define PERF_ITRACE_DEFAULT_PERIOD_TYPE         PERF_ITRACE_PERIOD_NANOSECS
 883 #define PERF_ITRACE_DEFAULT_PERIOD              100000
 884 #define PERF_ITRACE_DEFAULT_CALLCHAIN_SZ        16
 885 #define PERF_ITRACE_MAX_CALLCHAIN_SZ            1024
 886
 887 void itrace_synth_opts__set_default(struct itrace_synth_opts *synth_opts)
 888 {
 889         synth_opts->instructions = true;
 890         synth_opts->branches = true;
 891         synth_opts->transactions = true;
 892         synth_opts->errors = true;
 893         synth_opts->period_type = PERF_ITRACE_DEFAULT_PERIOD_TYPE;
 894         synth_opts->period = PERF_ITRACE_DEFAULT_PERIOD;
 895         synth_opts->callchain_sz = PERF_ITRACE_DEFAULT_CALLCHAIN_SZ;
 896 }
 897
 898 /*
 899  * Please check tools/perf/Documentation/perf-script.txt for information
 900  * about the options parsed here, which is introduced after this cset,
 901  * when support in 'perf script' for these options is introduced.
 902  */
 903 int itrace_parse_synth_opts(const struct option *opt, const char *str,
 904                             int unset)
 905 {
 906         struct itrace_synth_opts *synth_opts = opt->value;
 907         const char *p;
 908         char *endptr;
 909
 910         synth_opts->set = true;
 911
 912         if (unset) {
 913                 synth_opts->dont_decode = true;
 914                 return 0;
 915         }
 916
 917         if (!str) {
 918                 itrace_synth_opts__set_default(synth_opts);
 919                 return 0;
 920         }
 921
 922         for (p = str; *p;) {
 923                 switch (*p++) {
 924                 case 'i':
 925                         synth_opts->instructions = true;
 926                         while (*p == ' ' || *p == ',')
 927                                 p += 1;
 928                         if (isdigit(*p)) {
 929                                 synth_opts->period = strtoull(p, &endptr, 10);
 930                                 p = endptr;
 931                                 while (*p == ' ' || *p == ',')
 932                                         p += 1;
 933                                 switch (*p++) {
 934                                 case 'i':
 935                                         synth_opts->period_type =
 936                                                 PERF_ITRACE_PERIOD_INSTRUCTIONS;
 937                                         break;
 938                                 case 't':
 939                                         synth_opts->period_type =
 940                                                 PERF_ITRACE_PERIOD_TICKS;
 941                                         break;
 942                                 case 'm':
 943                                         synth_opts->period *= 1000;
 944                                         /* Fall through */
 945                                 case 'u':
 946                                         synth_opts->period *= 1000;
 947                                         /* Fall through */
 948                                 case 'n':
 949                                         if (*p++ != 's')
 950                                                 goto out_err;
 951                                         synth_opts->period_type =
 952                                                 PERF_ITRACE_PERIOD_NANOSECS;
 953                                         break;
 954                                 case '\0':
 955                                         goto out;
 956                                 default:
 957                                         goto out_err;
 958                                 }
 959                         }
 960                         break;
 961                 case 'b':
 962                         synth_opts->branches = true;
 963                         break;
 964                 case 'x':
 965                         synth_opts->transactions = true;
 966                         break;
 967                 case 'e':
 968                         synth_opts->errors = true;
 969                         break;
 970                 case 'd':
 971                         synth_opts->log = true;
 972                         break;
 973                 case 'c':
 974                         synth_opts->branches = true;
 975                         synth_opts->calls = true;
 976                         break;
 977                 case 'r':
 978                         synth_opts->branches = true;
 979                         synth_opts->returns = true;
 980                         break;
 981                 case 'g':
 982                         synth_opts->callchain = true;
 983                         synth_opts->callchain_sz =
 984                                         PERF_ITRACE_DEFAULT_CALLCHAIN_SZ;
 985                         while (*p == ' ' || *p == ',')
 986                                 p += 1;
 987                         if (isdigit(*p)) {
 988                                 unsigned int val;
 989
 990                                 val = strtoul(p, &endptr, 10);
 991                                 p = endptr;
 992                                 if (!val || val > PERF_ITRACE_MAX_CALLCHAIN_SZ)
 993                                         goto out_err;
 994                                 synth_opts->callchain_sz = val;
 995                         }
 996                         break;
 997                 case ' ':
 998                 case ',':
 999                         break;
1000                 default:
1001                         goto out_err;
1002                 }
1003         }
1004 out:
1005         if (synth_opts->instructions) {
1006                 if (!synth_opts->period_type)
1007                         synth_opts->period_type =
1008                                         PERF_ITRACE_DEFAULT_PERIOD_TYPE;
1009                 if (!synth_opts->period)
1010                         synth_opts->period = PERF_ITRACE_DEFAULT_PERIOD;
1011         }
1012
1013         return 0;
1014
1015 out_err:
1016         pr_err("Bad Instruction Tracing options '%s'\n", str);
1017         return -EINVAL;
1018 }
1019
1020 static const char * const auxtrace_error_type_name[] = {
1021         [PERF_AUXTRACE_ERROR_ITRACE] = "instruction trace",
1022 };
1023
1024 static const char *auxtrace_error_name(int type)
1025 {
1026         const char *error_type_name = NULL;
1027
1028         if (type < PERF_AUXTRACE_ERROR_MAX)
1029                 error_type_name = auxtrace_error_type_name[type];
1030         if (!error_type_name)
1031                 error_type_name = "unknown AUX";
1032         return error_type_name;
1033 }
1034
1035 size_t perf_event__fprintf_auxtrace_error(union perf_event *event, FILE *fp)
1036 {
1037         struct auxtrace_error_event *e = &event->auxtrace_error;
1038         int ret;
1039
1040         ret = fprintf(fp, " %s error type %u",
1041                       auxtrace_error_name(e->type), e->type);
1042         ret += fprintf(fp, " cpu %d pid %d tid %d ip %#"PRIx64" code %u: %s\n",
1043                        e->cpu, e->pid, e->tid, e->ip, e->code, e->msg);
1044         return ret;
1045 }
1046
1047 void perf_session__auxtrace_error_inc(struct perf_session *session,
1048                                       union perf_event *event)
1049 {
1050         struct auxtrace_error_event *e = &event->auxtrace_error;
1051
1052         if (e->type < PERF_AUXTRACE_ERROR_MAX)
1053                 session->evlist->stats.nr_auxtrace_errors[e->type] += 1;
1054 }
1055
1056 void events_stats__auxtrace_error_warn(const struct events_stats *stats)
1057 {
1058         int i;
1059
1060         for (i = 0; i < PERF_AUXTRACE_ERROR_MAX; i++) {
1061                 if (!stats->nr_auxtrace_errors[i])
1062                         continue;
1063                 ui__warning("%u %s errors\n",
1064                             stats->nr_auxtrace_errors[i],
1065                             auxtrace_error_name(i));
1066         }
1067 }
1068
1069 int perf_event__process_auxtrace_error(struct perf_tool *tool __maybe_unused,
1070                                        union perf_event *event,
1071                                        struct perf_session *session)
1072 {
1073         if (auxtrace__dont_decode(session))
1074                 return 0;
1075
1076         perf_event__fprintf_auxtrace_error(event, stdout);
1077         return 0;
1078 }
1079
1080 int auxtrace_mmap__read(struct auxtrace_mmap *mm, struct auxtrace_record *itr,
1081                         struct perf_tool *tool, process_auxtrace_t fn)
1082 {
1083         u64 head = auxtrace_mmap__read_head(mm);
1084         u64 old = mm->prev, offset, ref;
1085         unsigned char *data = mm->base;
1086         size_t size, head_off, old_off, len1, len2, padding;
1087         union perf_event ev;
1088         void *data1, *data2;
1089
1090         if (old == head)
1091                 return 0;
1092
1093         pr_debug3("auxtrace idx %d old %#"PRIx64" head %#"PRIx64" diff %#"PRIx64"\n",
1094                   mm->idx, old, head, head - old);
1095
1096         if (mm->mask) {
1097                 head_off = head & mm->mask;
1098                 old_off = old & mm->mask;
1099         } else {
1100                 head_off = head % mm->len;
1101                 old_off = old % mm->len;
1102         }
1103
1104         if (head_off > old_off)
1105                 size = head_off - old_off;
1106         else
1107                 size = mm->len - (old_off - head_off);
1108
1109         ref = auxtrace_record__reference(itr);
1110
1111         if (head > old || size <= head || mm->mask) {
1112                 offset = head - size;
1113         } else {
1114                 /*
1115                  * When the buffer size is not a power of 2, 'head' wraps at the
1116                  * highest multiple of the buffer size, so we have to subtract
1117                  * the remainder here.
1118                  */
1119                 u64 rem = (0ULL - mm->len) % mm->len;
1120
1121                 offset = head - size - rem;
1122         }
1123
1124         if (size > head_off) {
1125                 len1 = size - head_off;
1126                 data1 = &data[mm->len - len1];
1127                 len2 = head_off;
1128                 data2 = &data[0];
1129         } else {
1130                 len1 = size;
1131                 data1 = &data[head_off - len1];
1132                 len2 = 0;
1133                 data2 = NULL;
1134         }
1135
1136         /* padding must be written by fn() e.g. record__process_auxtrace() */
1137         padding = size & 7;
1138         if (padding)
1139                 padding = 8 - padding;
1140
1141         memset(&ev, 0, sizeof(ev));
1142         ev.auxtrace.header.type = PERF_RECORD_AUXTRACE;
1143         ev.auxtrace.header.size = sizeof(ev.auxtrace);
1144         ev.auxtrace.size = size + padding;
1145         ev.auxtrace.offset = offset;
1146         ev.auxtrace.reference = ref;
1147         ev.auxtrace.idx = mm->idx;
1148         ev.auxtrace.tid = mm->tid;
1149         ev.auxtrace.cpu = mm->cpu;
1150
1151         if (fn(tool, &ev, data1, len1, data2, len2))
1152                 return -1;
1153
1154         mm->prev = head;
1155
1156         auxtrace_mmap__write_tail(mm, head);
1157         if (itr->read_finish) {
1158                 int err;
1159
1160                 err = itr->read_finish(itr, mm->idx);
1161                 if (err < 0)
1162                         return err;
1163         }
1164
1165         return 1;
1166 }
1167
1168 /**
1169  * struct auxtrace_cache - hash table to implement a cache
1170  * @hashtable: the hashtable
1171  * @sz: hashtable size (number of hlists)
1172  * @entry_size: size of an entry
1173  * @limit: limit the number of entries to this maximum, when reached the cache
1174  *         is dropped and caching begins again with an empty cache
1175  * @cnt: current number of entries
1176  * @bits: hashtable size (@sz = 2^@bits)
1177  */
1178 struct auxtrace_cache {
1179         struct hlist_head *hashtable;
1180         size_t sz;
1181         size_t entry_size;
1182         size_t limit;
1183         size_t cnt;
1184         unsigned int bits;
1185 };
1186
1187 struct auxtrace_cache *auxtrace_cache__new(unsigned int bits, size_t entry_size,
1188                                            unsigned int limit_percent)
1189 {
1190         struct auxtrace_cache *c;
1191         struct hlist_head *ht;
1192         size_t sz, i;
1193
1194         c = zalloc(sizeof(struct auxtrace_cache));
1195         if (!c)
1196                 return NULL;
1197
1198         sz = 1UL << bits;
1199
1200         ht = calloc(sz, sizeof(struct hlist_head));
1201         if (!ht)
1202                 goto out_free;
1203
1204         for (i = 0; i < sz; i++)
1205                 INIT_HLIST_HEAD(&ht[i]);
1206
1207         c->hashtable = ht;
1208         c->sz = sz;
1209         c->entry_size = entry_size;
1210         c->limit = (c->sz * limit_percent) / 100;
1211         c->bits = bits;
1212
1213         return c;
1214
1215 out_free:
1216         free(c);
1217         return NULL;
1218 }
1219
1220 static void auxtrace_cache__drop(struct auxtrace_cache *c)
1221 {
1222         struct auxtrace_cache_entry *entry;
1223         struct hlist_node *tmp;
1224         size_t i;
1225
1226         if (!c)
1227                 return;
1228
1229         for (i = 0; i < c->sz; i++) {
1230                 hlist_for_each_entry_safe(entry, tmp, &c->hashtable[i], hash) {
1231                         hlist_del(&entry->hash);
1232                         auxtrace_cache__free_entry(c, entry);
1233                 }
1234         }
1235
1236         c->cnt = 0;
1237 }
1238
1239 void auxtrace_cache__free(struct auxtrace_cache *c)
1240 {
1241         if (!c)
1242                 return;
1243
1244         auxtrace_cache__drop(c);
1245         free(c->hashtable);
1246         free(c);
1247 }
1248
1249 void *auxtrace_cache__alloc_entry(struct auxtrace_cache *c)
1250 {
1251         return malloc(c->entry_size);
1252 }
1253
1254 void auxtrace_cache__free_entry(struct auxtrace_cache *c __maybe_unused,
1255                                 void *entry)
1256 {
1257         free(entry);
1258 }
1259
1260 int auxtrace_cache__add(struct auxtrace_cache *c, u32 key,
1261                         struct auxtrace_cache_entry *entry)
1262 {
1263         if (c->limit && ++c->cnt > c->limit)
1264                 auxtrace_cache__drop(c);
1265
1266         entry->key = key;
1267         hlist_add_head(&entry->hash, &c->hashtable[hash_32(key, c->bits)]);
1268
1269         return 0;
1270 }
1271
1272 void *auxtrace_cache__lookup(struct auxtrace_cache *c, u32 key)
1273 {
1274         struct auxtrace_cache_entry *entry;
1275         struct hlist_head *hlist;
1276
1277         if (!c)
1278                 return NULL;
1279
1280         hlist = &c->hashtable[hash_32(key, c->bits)];
1281         hlist_for_each_entry(entry, hlist, hash) {
1282                 if (entry->key == key)
1283                         return entry;
1284         }
1285
1286         return NULL;
1287 }