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 void auxtrace_queues__free(struct auxtrace_queues *queues)
 348 {
 349         unsigned int i;
 350
 351         for (i = 0; i < queues->nr_queues; i++) {
 352                 while (!list_empty(&queues->queue_array[i].head)) {
 353                         struct auxtrace_buffer *buffer;
 354
 355                         buffer = list_entry(queues->queue_array[i].head.next,
 356                                             struct auxtrace_buffer, list);
 357                         list_del(&buffer->list);
 358                         auxtrace_buffer__free(buffer);
 359                 }
 360         }
 361
 362         zfree(&queues->queue_array);
 363         queues->nr_queues = 0;
 364 }
 365
 366 static void auxtrace_heapify(struct auxtrace_heap_item *heap_array,
 367                              unsigned int pos, unsigned int queue_nr,
 368                              u64 ordinal)
 369 {
 370         unsigned int parent;
 371
 372         while (pos) {
 373                 parent = (pos - 1) >> 1;
 374                 if (heap_array[parent].ordinal <= ordinal)
 375                         break;
 376                 heap_array[pos] = heap_array[parent];
 377                 pos = parent;
 378         }
 379         heap_array[pos].queue_nr = queue_nr;
 380         heap_array[pos].ordinal = ordinal;
 381 }
 382
 383 int auxtrace_heap__add(struct auxtrace_heap *heap, unsigned int queue_nr,
 384                        u64 ordinal)
 385 {
 386         struct auxtrace_heap_item *heap_array;
 387
 388         if (queue_nr >= heap->heap_sz) {
 389                 unsigned int heap_sz = AUXTRACE_INIT_NR_QUEUES;
 390
 391                 while (heap_sz <= queue_nr)
 392                         heap_sz <<= 1;
 393                 heap_array = realloc(heap->heap_array,
 394                                      heap_sz * sizeof(struct auxtrace_heap_item));
 395                 if (!heap_array)
 396                         return -ENOMEM;
 397                 heap->heap_array = heap_array;
 398                 heap->heap_sz = heap_sz;
 399         }
 400
 401         auxtrace_heapify(heap->heap_array, heap->heap_cnt++, queue_nr, ordinal);
 402
 403         return 0;
 404 }
 405
 406 void auxtrace_heap__free(struct auxtrace_heap *heap)
 407 {
 408         zfree(&heap->heap_array);
 409         heap->heap_cnt = 0;
 410         heap->heap_sz = 0;
 411 }
 412
 413 void auxtrace_heap__pop(struct auxtrace_heap *heap)
 414 {
 415         unsigned int pos, last, heap_cnt = heap->heap_cnt;
 416         struct auxtrace_heap_item *heap_array;
 417
 418         if (!heap_cnt)
 419                 return;
 420
 421         heap->heap_cnt -= 1;
 422
 423         heap_array = heap->heap_array;
 424
 425         pos = 0;
 426         while (1) {
 427                 unsigned int left, right;
 428
 429                 left = (pos << 1) + 1;
 430                 if (left >= heap_cnt)
 431                         break;
 432                 right = left + 1;
 433                 if (right >= heap_cnt) {
 434                         heap_array[pos] = heap_array[left];
 435                         return;
 436                 }
 437                 if (heap_array[left].ordinal < heap_array[right].ordinal) {
 438                         heap_array[pos] = heap_array[left];
 439                         pos = left;
 440                 } else {
 441                         heap_array[pos] = heap_array[right];
 442                         pos = right;
 443                 }
 444         }
 445
 446         last = heap_cnt - 1;
 447         auxtrace_heapify(heap_array, pos, heap_array[last].queue_nr,
 448                          heap_array[last].ordinal);
 449 }
 450
 451 size_t auxtrace_record__info_priv_size(struct auxtrace_record *itr)
 452 {
 453         if (itr)
 454                 return itr->info_priv_size(itr);
 455         return 0;
 456 }
 457
 458 static int auxtrace_not_supported(void)
 459 {
 460         pr_err("AUX area tracing is not supported on this architecture\n");
 461         return -EINVAL;
 462 }
 463
 464 int auxtrace_record__info_fill(struct auxtrace_record *itr,
 465                                struct perf_session *session,
 466                                struct auxtrace_info_event *auxtrace_info,
 467                                size_t priv_size)
 468 {
 469         if (itr)
 470                 return itr->info_fill(itr, session, auxtrace_info, priv_size);
 471         return auxtrace_not_supported();
 472 }
 473
 474 void auxtrace_record__free(struct auxtrace_record *itr)
 475 {
 476         if (itr)
 477                 itr->free(itr);
 478 }
 479
 480 int auxtrace_record__options(struct auxtrace_record *itr,
 481                              struct perf_evlist *evlist,
 482                              struct record_opts *opts)
 483 {
 484         if (itr)
 485                 return itr->recording_options(itr, evlist, opts);
 486         return 0;
 487 }
 488
 489 u64 auxtrace_record__reference(struct auxtrace_record *itr)
 490 {
 491         if (itr)
 492                 return itr->reference(itr);
 493         return 0;
 494 }
 495
 496 struct auxtrace_record *__weak
 497 auxtrace_record__init(struct perf_evlist *evlist __maybe_unused, int *err)
 498 {
 499         *err = 0;
 500         return NULL;
 501 }
 502
 503 struct auxtrace_buffer *auxtrace_buffer__next(struct auxtrace_queue *queue,
 504                                               struct auxtrace_buffer *buffer)
 505 {
 506         if (buffer) {
 507                 if (list_is_last(&buffer->list, &queue->head))
 508                         return NULL;
 509                 return list_entry(buffer->list.next, struct auxtrace_buffer,
 510                                   list);
 511         } else {
 512                 if (list_empty(&queue->head))
 513                         return NULL;
 514                 return list_entry(queue->head.next, struct auxtrace_buffer,
 515                                   list);
 516         }
 517 }
 518
 519 void *auxtrace_buffer__get_data(struct auxtrace_buffer *buffer, int fd)
 520 {
 521         size_t adj = buffer->data_offset & (page_size - 1);
 522         size_t size = buffer->size + adj;
 523         off_t file_offset = buffer->data_offset - adj;
 524         void *addr;
 525
 526         if (buffer->data)
 527                 return buffer->data;
 528
 529         addr = mmap(NULL, size, PROT_READ, MAP_SHARED, fd, file_offset);
 530         if (addr == MAP_FAILED)
 531                 return NULL;
 532
 533         buffer->mmap_addr = addr;
 534         buffer->mmap_size = size;
 535
 536         buffer->data = addr + adj;
 537
 538         return buffer->data;
 539 }
 540
 541 void auxtrace_buffer__put_data(struct auxtrace_buffer *buffer)
 542 {
 543         if (!buffer->data || !buffer->mmap_addr)
 544                 return;
 545         munmap(buffer->mmap_addr, buffer->mmap_size);
 546         buffer->mmap_addr = NULL;
 547         buffer->mmap_size = 0;
 548         buffer->data = NULL;
 549         buffer->use_data = NULL;
 550 }
 551
 552 void auxtrace_buffer__drop_data(struct auxtrace_buffer *buffer)
 553 {
 554         auxtrace_buffer__put_data(buffer);
 555         if (buffer->data_needs_freeing) {
 556                 buffer->data_needs_freeing = false;
 557                 zfree(&buffer->data);
 558                 buffer->use_data = NULL;
 559                 buffer->size = 0;
 560         }
 561 }
 562
 563 void auxtrace_buffer__free(struct auxtrace_buffer *buffer)
 564 {
 565         auxtrace_buffer__drop_data(buffer);
 566         free(buffer);
 567 }
 568
 569 void auxtrace_synth_error(struct auxtrace_error_event *auxtrace_error, int type,
 570                           int code, int cpu, pid_t pid, pid_t tid, u64 ip,
 571                           const char *msg)
 572 {
 573         size_t size;
 574
 575         memset(auxtrace_error, 0, sizeof(struct auxtrace_error_event));
 576
 577         auxtrace_error->header.type = PERF_RECORD_AUXTRACE_ERROR;
 578         auxtrace_error->type = type;
 579         auxtrace_error->code = code;
 580         auxtrace_error->cpu = cpu;
 581         auxtrace_error->pid = pid;
 582         auxtrace_error->tid = tid;
 583         auxtrace_error->ip = ip;
 584         strlcpy(auxtrace_error->msg, msg, MAX_AUXTRACE_ERROR_MSG);
 585
 586         size = (void *)auxtrace_error->msg - (void *)auxtrace_error +
 587                strlen(auxtrace_error->msg) + 1;
 588         auxtrace_error->header.size = PERF_ALIGN(size, sizeof(u64));
 589 }
 590
 591 int perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr,
 592                                          struct perf_tool *tool,
 593                                          struct perf_session *session,
 594                                          perf_event__handler_t process)
 595 {
 596         union perf_event *ev;
 597         size_t priv_size;
 598         int err;
 599
 600         pr_debug2("Synthesizing auxtrace information\n");
 601         priv_size = auxtrace_record__info_priv_size(itr);
 602         ev = zalloc(sizeof(struct auxtrace_info_event) + priv_size);
 603         if (!ev)
 604                 return -ENOMEM;
 605
 606         ev->auxtrace_info.header.type = PERF_RECORD_AUXTRACE_INFO;
 607         ev->auxtrace_info.header.size = sizeof(struct auxtrace_info_event) +
 608                                         priv_size;
 609         err = auxtrace_record__info_fill(itr, session, &ev->auxtrace_info,
 610                                          priv_size);
 611         if (err)
 612                 goto out_free;
 613
 614         err = process(tool, ev, NULL, NULL);
 615 out_free:
 616         free(ev);
 617         return err;
 618 }
 619
 620 static bool auxtrace__dont_decode(struct perf_session *session)
 621 {
 622         return !session->itrace_synth_opts ||
 623                session->itrace_synth_opts->dont_decode;
 624 }
 625
 626 int perf_event__process_auxtrace_info(struct perf_tool *tool __maybe_unused,
 627                                       union perf_event *event,
 628                                       struct perf_session *session __maybe_unused)
 629 {
 630         enum auxtrace_type type = event->auxtrace_info.type;
 631
 632         if (dump_trace)
 633                 fprintf(stdout, " type: %u\n", type);
 634
 635         switch (type) {
 636         case PERF_AUXTRACE_UNKNOWN:
 637         default:
 638                 return -EINVAL;
 639         }
 640 }
 641
 642 s64 perf_event__process_auxtrace(struct perf_tool *tool,
 643                                  union perf_event *event,
 644                                  struct perf_session *session)
 645 {
 646         s64 err;
 647
 648         if (dump_trace)
 649                 fprintf(stdout, " size: %#"PRIx64"  offset: %#"PRIx64"  ref: %#"PRIx64"  idx: %u  tid: %d  cpu: %d\n",
 650                         event->auxtrace.size, event->auxtrace.offset,
 651                         event->auxtrace.reference, event->auxtrace.idx,
 652                         event->auxtrace.tid, event->auxtrace.cpu);
 653
 654         if (auxtrace__dont_decode(session))
 655                 return event->auxtrace.size;
 656
 657         if (!session->auxtrace || event->header.type != PERF_RECORD_AUXTRACE)
 658                 return -EINVAL;
 659
 660         err = session->auxtrace->process_auxtrace_event(session, event, tool);
 661         if (err < 0)
 662                 return err;
 663
 664         return event->auxtrace.size;
 665 }
 666
 667 #define PERF_ITRACE_DEFAULT_PERIOD_TYPE         PERF_ITRACE_PERIOD_NANOSECS
 668 #define PERF_ITRACE_DEFAULT_PERIOD              100000
 669 #define PERF_ITRACE_DEFAULT_CALLCHAIN_SZ        16
 670 #define PERF_ITRACE_MAX_CALLCHAIN_SZ            1024
 671
 672 void itrace_synth_opts__set_default(struct itrace_synth_opts *synth_opts)
 673 {
 674         synth_opts->instructions = true;
 675         synth_opts->branches = true;
 676         synth_opts->errors = true;
 677         synth_opts->period_type = PERF_ITRACE_DEFAULT_PERIOD_TYPE;
 678         synth_opts->period = PERF_ITRACE_DEFAULT_PERIOD;
 679         synth_opts->callchain_sz = PERF_ITRACE_DEFAULT_CALLCHAIN_SZ;
 680 }
 681
 682 /*
 683  * Please check tools/perf/Documentation/perf-script.txt for information
 684  * about the options parsed here, which is introduced after this cset,
 685  * when support in 'perf script' for these options is introduced.
 686  */
 687 int itrace_parse_synth_opts(const struct option *opt, const char *str,
 688                             int unset)
 689 {
 690         struct itrace_synth_opts *synth_opts = opt->value;
 691         const char *p;
 692         char *endptr;
 693
 694         synth_opts->set = true;
 695
 696         if (unset) {
 697                 synth_opts->dont_decode = true;
 698                 return 0;
 699         }
 700
 701         if (!str) {
 702                 itrace_synth_opts__set_default(synth_opts);
 703                 return 0;
 704         }
 705
 706         for (p = str; *p;) {
 707                 switch (*p++) {
 708                 case 'i':
 709                         synth_opts->instructions = true;
 710                         while (*p == ' ' || *p == ',')
 711                                 p += 1;
 712                         if (isdigit(*p)) {
 713                                 synth_opts->period = strtoull(p, &endptr, 10);
 714                                 p = endptr;
 715                                 while (*p == ' ' || *p == ',')
 716                                         p += 1;
 717                                 switch (*p++) {
 718                                 case 'i':
 719                                         synth_opts->period_type =
 720                                                 PERF_ITRACE_PERIOD_INSTRUCTIONS;
 721                                         break;
 722                                 case 't':
 723                                         synth_opts->period_type =
 724                                                 PERF_ITRACE_PERIOD_TICKS;
 725                                         break;
 726                                 case 'm':
 727                                         synth_opts->period *= 1000;
 728                                         /* Fall through */
 729                                 case 'u':
 730                                         synth_opts->period *= 1000;
 731                                         /* Fall through */
 732                                 case 'n':
 733                                         if (*p++ != 's')
 734                                                 goto out_err;
 735                                         synth_opts->period_type =
 736                                                 PERF_ITRACE_PERIOD_NANOSECS;
 737                                         break;
 738                                 case '\0':
 739                                         goto out;
 740                                 default:
 741                                         goto out_err;
 742                                 }
 743                         }
 744                         break;
 745                 case 'b':
 746                         synth_opts->branches = true;
 747                         break;
 748                 case 'e':
 749                         synth_opts->errors = true;
 750                         break;
 751                 case 'd':
 752                         synth_opts->log = true;
 753                         break;
 754                 case 'c':
 755                         synth_opts->branches = true;
 756                         synth_opts->calls = true;
 757                         break;
 758                 case 'r':
 759                         synth_opts->branches = true;
 760                         synth_opts->returns = true;
 761                         break;
 762                 case 'g':
 763                         synth_opts->instructions = true;
 764                         synth_opts->callchain = true;
 765                         synth_opts->callchain_sz =
 766                                         PERF_ITRACE_DEFAULT_CALLCHAIN_SZ;
 767                         while (*p == ' ' || *p == ',')
 768                                 p += 1;
 769                         if (isdigit(*p)) {
 770                                 unsigned int val;
 771
 772                                 val = strtoul(p, &endptr, 10);
 773                                 p = endptr;
 774                                 if (!val || val > PERF_ITRACE_MAX_CALLCHAIN_SZ)
 775                                         goto out_err;
 776                                 synth_opts->callchain_sz = val;
 777                         }
 778                         break;
 779                 case ' ':
 780                 case ',':
 781                         break;
 782                 default:
 783                         goto out_err;
 784                 }
 785         }
 786 out:
 787         if (synth_opts->instructions) {
 788                 if (!synth_opts->period_type)
 789                         synth_opts->period_type =
 790                                         PERF_ITRACE_DEFAULT_PERIOD_TYPE;
 791                 if (!synth_opts->period)
 792                         synth_opts->period = PERF_ITRACE_DEFAULT_PERIOD;
 793         }
 794
 795         return 0;
 796
 797 out_err:
 798         pr_err("Bad Instruction Tracing options '%s'\n", str);
 799         return -EINVAL;
 800 }
 801
 802 static const char * const auxtrace_error_type_name[] = {
 803         [PERF_AUXTRACE_ERROR_ITRACE] = "instruction trace",
 804 };
 805
 806 static const char *auxtrace_error_name(int type)
 807 {
 808         const char *error_type_name = NULL;
 809
 810         if (type < PERF_AUXTRACE_ERROR_MAX)
 811                 error_type_name = auxtrace_error_type_name[type];
 812         if (!error_type_name)
 813                 error_type_name = "unknown AUX";
 814         return error_type_name;
 815 }
 816
 817 size_t perf_event__fprintf_auxtrace_error(union perf_event *event, FILE *fp)
 818 {
 819         struct auxtrace_error_event *e = &event->auxtrace_error;
 820         int ret;
 821
 822         ret = fprintf(fp, " %s error type %u",
 823                       auxtrace_error_name(e->type), e->type);
 824         ret += fprintf(fp, " cpu %d pid %d tid %d ip %#"PRIx64" code %u: %s\n",
 825                        e->cpu, e->pid, e->tid, e->ip, e->code, e->msg);
 826         return ret;
 827 }
 828
 829 void perf_session__auxtrace_error_inc(struct perf_session *session,
 830                                       union perf_event *event)
 831 {
 832         struct auxtrace_error_event *e = &event->auxtrace_error;
 833
 834         if (e->type < PERF_AUXTRACE_ERROR_MAX)
 835                 session->evlist->stats.nr_auxtrace_errors[e->type] += 1;
 836 }
 837
 838 void events_stats__auxtrace_error_warn(const struct events_stats *stats)
 839 {
 840         int i;
 841
 842         for (i = 0; i < PERF_AUXTRACE_ERROR_MAX; i++) {
 843                 if (!stats->nr_auxtrace_errors[i])
 844                         continue;
 845                 ui__warning("%u %s errors\n",
 846                             stats->nr_auxtrace_errors[i],
 847                             auxtrace_error_name(i));
 848         }
 849 }
 850
 851 int perf_event__process_auxtrace_error(struct perf_tool *tool __maybe_unused,
 852                                        union perf_event *event,
 853                                        struct perf_session *session)
 854 {
 855         if (auxtrace__dont_decode(session))
 856                 return 0;
 857
 858         perf_event__fprintf_auxtrace_error(event, stdout);
 859         return 0;
 860 }
 861
 862 int auxtrace_mmap__read(struct auxtrace_mmap *mm, struct auxtrace_record *itr,
 863                         struct perf_tool *tool, process_auxtrace_t fn)
 864 {
 865         u64 head = auxtrace_mmap__read_head(mm);
 866         u64 old = mm->prev, offset, ref;
 867         unsigned char *data = mm->base;
 868         size_t size, head_off, old_off, len1, len2, padding;
 869         union perf_event ev;
 870         void *data1, *data2;
 871
 872         if (old == head)
 873                 return 0;
 874
 875         pr_debug3("auxtrace idx %d old %#"PRIx64" head %#"PRIx64" diff %#"PRIx64"\n",
 876                   mm->idx, old, head, head - old);
 877
 878         if (mm->mask) {
 879                 head_off = head & mm->mask;
 880                 old_off = old & mm->mask;
 881         } else {
 882                 head_off = head % mm->len;
 883                 old_off = old % mm->len;
 884         }
 885
 886         if (head_off > old_off)
 887                 size = head_off - old_off;
 888         else
 889                 size = mm->len - (old_off - head_off);
 890
 891         ref = auxtrace_record__reference(itr);
 892
 893         if (head > old || size <= head || mm->mask) {
 894                 offset = head - size;
 895         } else {
 896                 /*
 897                  * When the buffer size is not a power of 2, 'head' wraps at the
 898                  * highest multiple of the buffer size, so we have to subtract
 899                  * the remainder here.
 900                  */
 901                 u64 rem = (0ULL - mm->len) % mm->len;
 902
 903                 offset = head - size - rem;
 904         }
 905
 906         if (size > head_off) {
 907                 len1 = size - head_off;
 908                 data1 = &data[mm->len - len1];
 909                 len2 = head_off;
 910                 data2 = &data[0];
 911         } else {
 912                 len1 = size;
 913                 data1 = &data[head_off - len1];
 914                 len2 = 0;
 915                 data2 = NULL;
 916         }
 917
 918         /* padding must be written by fn() e.g. record__process_auxtrace() */
 919         padding = size & 7;
 920         if (padding)
 921                 padding = 8 - padding;
 922
 923         memset(&ev, 0, sizeof(ev));
 924         ev.auxtrace.header.type = PERF_RECORD_AUXTRACE;
 925         ev.auxtrace.header.size = sizeof(ev.auxtrace);
 926         ev.auxtrace.size = size + padding;
 927         ev.auxtrace.offset = offset;
 928         ev.auxtrace.reference = ref;
 929         ev.auxtrace.idx = mm->idx;
 930         ev.auxtrace.tid = mm->tid;
 931         ev.auxtrace.cpu = mm->cpu;
 932
 933         if (fn(tool, &ev, data1, len1, data2, len2))
 934                 return -1;
 935
 936         mm->prev = head;
 937
 938         auxtrace_mmap__write_tail(mm, head);
 939         if (itr->read_finish) {
 940                 int err;
 941
 942                 err = itr->read_finish(itr, mm->idx);
 943                 if (err < 0)
 944                         return err;
 945         }
 946
 947         return 1;
 948 }
 949
 950 /**
 951  * struct auxtrace_cache - hash table to implement a cache
 952  * @hashtable: the hashtable
 953  * @sz: hashtable size (number of hlists)
 954  * @entry_size: size of an entry
 955  * @limit: limit the number of entries to this maximum, when reached the cache
 956  *         is dropped and caching begins again with an empty cache
 957  * @cnt: current number of entries
 958  * @bits: hashtable size (@sz = 2^@bits)
 959  */
 960 struct auxtrace_cache {
 961         struct hlist_head *hashtable;
 962         size_t sz;
 963         size_t entry_size;
 964         size_t limit;
 965         size_t cnt;
 966         unsigned int bits;
 967 };
 968
 969 struct auxtrace_cache *auxtrace_cache__new(unsigned int bits, size_t entry_size,
 970                                            unsigned int limit_percent)
 971 {
 972         struct auxtrace_cache *c;
 973         struct hlist_head *ht;
 974         size_t sz, i;
 975
 976         c = zalloc(sizeof(struct auxtrace_cache));
 977         if (!c)
 978                 return NULL;
 979
 980         sz = 1UL << bits;
 981
 982         ht = calloc(sz, sizeof(struct hlist_head));
 983         if (!ht)
 984                 goto out_free;
 985
 986         for (i = 0; i < sz; i++)
 987                 INIT_HLIST_HEAD(&ht[i]);
 988
 989         c->hashtable = ht;
 990         c->sz = sz;
 991         c->entry_size = entry_size;
 992         c->limit = (c->sz * limit_percent) / 100;
 993         c->bits = bits;
 994
 995         return c;
 996
 997 out_free:
 998         free(c);
 999         return NULL;
1000 }
1001
1002 static void auxtrace_cache__drop(struct auxtrace_cache *c)
1003 {
1004         struct auxtrace_cache_entry *entry;
1005         struct hlist_node *tmp;
1006         size_t i;
1007
1008         if (!c)
1009                 return;
1010
1011         for (i = 0; i < c->sz; i++) {
1012                 hlist_for_each_entry_safe(entry, tmp, &c->hashtable[i], hash) {
1013                         hlist_del(&entry->hash);
1014                         auxtrace_cache__free_entry(c, entry);
1015                 }
1016         }
1017
1018         c->cnt = 0;
1019 }
1020
1021 void auxtrace_cache__free(struct auxtrace_cache *c)
1022 {
1023         if (!c)
1024                 return;
1025
1026         auxtrace_cache__drop(c);
1027         free(c->hashtable);
1028         free(c);
1029 }
1030
1031 void *auxtrace_cache__alloc_entry(struct auxtrace_cache *c)
1032 {
1033         return malloc(c->entry_size);
1034 }
1035
1036 void auxtrace_cache__free_entry(struct auxtrace_cache *c __maybe_unused,
1037                                 void *entry)
1038 {
1039         free(entry);
1040 }
1041
1042 int auxtrace_cache__add(struct auxtrace_cache *c, u32 key,
1043                         struct auxtrace_cache_entry *entry)
1044 {
1045         if (c->limit && ++c->cnt > c->limit)
1046                 auxtrace_cache__drop(c);
1047
1048         entry->key = key;
1049         hlist_add_head(&entry->hash, &c->hashtable[hash_32(key, c->bits)]);
1050
1051         return 0;
1052 }
1053
1054 void *auxtrace_cache__lookup(struct auxtrace_cache *c, u32 key)
1055 {
1056         struct auxtrace_cache_entry *entry;
1057         struct hlist_head *hlist;
1058
1059         if (!c)
1060                 return NULL;
1061
1062         hlist = &c->hashtable[hash_32(key, c->bits)];
1063         hlist_for_each_entry(entry, hlist, hash) {
1064                 if (entry->key == key)
1065                         return entry;
1066         }
1067
1068         return NULL;
1069 }