tools/perf/arch/x86/util/intel-pt.c

   1 /*
   2  * intel_pt.c: Intel Processor 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 <stdbool.h>
  17 #include <linux/kernel.h>
  18 #include <linux/types.h>
  19 #include <linux/bitops.h>
  20 #include <linux/log2.h>
  21 #include <cpuid.h>
  22
  23 #include "../../perf.h"
  24 #include "../../util/session.h"
  25 #include "../../util/event.h"
  26 #include "../../util/evlist.h"
  27 #include "../../util/evsel.h"
  28 #include "../../util/cpumap.h"
  29 #include "../../util/parse-options.h"
  30 #include "../../util/parse-events.h"
  31 #include "../../util/pmu.h"
  32 #include "../../util/debug.h"
  33 #include "../../util/auxtrace.h"
  34 #include "../../util/tsc.h"
  35 #include "../../util/intel-pt.h"
  36
  37 #define KiB(x) ((x) * 1024)
  38 #define MiB(x) ((x) * 1024 * 1024)
  39 #define KiB_MASK(x) (KiB(x) - 1)
  40 #define MiB_MASK(x) (MiB(x) - 1)
  41
  42 #define INTEL_PT_DEFAULT_SAMPLE_SIZE    KiB(4)
  43
  44 #define INTEL_PT_MAX_SAMPLE_SIZE        KiB(60)
  45
  46 #define INTEL_PT_PSB_PERIOD_NEAR        256
  47
  48 struct intel_pt_snapshot_ref {
  49         void *ref_buf;
  50         size_t ref_offset;
  51         bool wrapped;
  52 };
  53
  54 struct intel_pt_recording {
  55         struct auxtrace_record          itr;
  56         struct perf_pmu                 *intel_pt_pmu;
  57         int                             have_sched_switch;
  58         struct perf_evlist              *evlist;
  59         bool                            snapshot_mode;
  60         bool                            snapshot_init_done;
  61         size_t                          snapshot_size;
  62         size_t                          snapshot_ref_buf_size;
  63         int                             snapshot_ref_cnt;
  64         struct intel_pt_snapshot_ref    *snapshot_refs;
  65 };
  66
  67 static int intel_pt_parse_terms_with_default(struct list_head *formats,
  68                                              const char *str,
  69                                              u64 *config)
  70 {
  71         struct list_head *terms;
  72         struct perf_event_attr attr = { .size = 0, };
  73         int err;
  74
  75         terms = malloc(sizeof(struct list_head));
  76         if (!terms)
  77                 return -ENOMEM;
  78
  79         INIT_LIST_HEAD(terms);
  80
  81         err = parse_events_terms(terms, str);
  82         if (err)
  83                 goto out_free;
  84
  85         attr.config = *config;
  86         err = perf_pmu__config_terms(formats, &attr, terms, true, NULL);
  87         if (err)
  88                 goto out_free;
  89
  90         *config = attr.config;
  91 out_free:
  92         parse_events__free_terms(terms);
  93         return err;
  94 }
  95
  96 static int intel_pt_parse_terms(struct list_head *formats, const char *str,
  97                                 u64 *config)
  98 {
  99         *config = 0;
 100         return intel_pt_parse_terms_with_default(formats, str, config);
 101 }
 102
 103 static u64 intel_pt_masked_bits(u64 mask, u64 bits)
 104 {
 105         const u64 top_bit = 1ULL << 63;
 106         u64 res = 0;
 107         int i;
 108
 109         for (i = 0; i < 64; i++) {
 110                 if (mask & top_bit) {
 111                         res <<= 1;
 112                         if (bits & top_bit)
 113                                 res |= 1;
 114                 }
 115                 mask <<= 1;
 116                 bits <<= 1;
 117         }
 118
 119         return res;
 120 }
 121
 122 static int intel_pt_read_config(struct perf_pmu *intel_pt_pmu, const char *str,
 123                                 struct perf_evlist *evlist, u64 *res)
 124 {
 125         struct perf_evsel *evsel;
 126         u64 mask;
 127
 128         *res = 0;
 129
 130         mask = perf_pmu__format_bits(&intel_pt_pmu->format, str);
 131         if (!mask)
 132                 return -EINVAL;
 133
 134         evlist__for_each(evlist, evsel) {
 135                 if (evsel->attr.type == intel_pt_pmu->type) {
 136                         *res = intel_pt_masked_bits(mask, evsel->attr.config);
 137                         return 0;
 138                 }
 139         }
 140
 141         return -EINVAL;
 142 }
 143
 144 static size_t intel_pt_psb_period(struct perf_pmu *intel_pt_pmu,
 145                                   struct perf_evlist *evlist)
 146 {
 147         u64 val;
 148         int err, topa_multiple_entries;
 149         size_t psb_period;
 150
 151         if (perf_pmu__scan_file(intel_pt_pmu, "caps/topa_multiple_entries",
 152                                 "%d", &topa_multiple_entries) != 1)
 153                 topa_multiple_entries = 0;
 154
 155         /*
 156          * Use caps/topa_multiple_entries to indicate early hardware that had
 157          * extra frequent PSBs.
 158          */
 159         if (!topa_multiple_entries) {
 160                 psb_period = 256;
 161                 goto out;
 162         }
 163
 164         err = intel_pt_read_config(intel_pt_pmu, "psb_period", evlist, &val);
 165         if (err)
 166                 val = 0;
 167
 168         psb_period = 1 << (val + 11);
 169 out:
 170         pr_debug2("%s psb_period %zu\n", intel_pt_pmu->name, psb_period);
 171         return psb_period;
 172 }
 173
 174 static int intel_pt_pick_bit(int bits, int target)
 175 {
 176         int pos, pick = -1;
 177
 178         for (pos = 0; bits; bits >>= 1, pos++) {
 179                 if (bits & 1) {
 180                         if (pos <= target || pick < 0)
 181                                 pick = pos;
 182                         if (pos >= target)
 183                                 break;
 184                 }
 185         }
 186
 187         return pick;
 188 }
 189
 190 static u64 intel_pt_default_config(struct perf_pmu *intel_pt_pmu)
 191 {
 192         char buf[256];
 193         int mtc, mtc_periods = 0, mtc_period;
 194         int psb_cyc, psb_periods, psb_period;
 195         int pos = 0;
 196         u64 config;
 197
 198         pos += scnprintf(buf + pos, sizeof(buf) - pos, "tsc");
 199
 200         if (perf_pmu__scan_file(intel_pt_pmu, "caps/mtc", "%d",
 201                                 &mtc) != 1)
 202                 mtc = 1;
 203
 204         if (mtc) {
 205                 if (perf_pmu__scan_file(intel_pt_pmu, "caps/mtc_periods", "%x",
 206                                         &mtc_periods) != 1)
 207                         mtc_periods = 0;
 208                 if (mtc_periods) {
 209                         mtc_period = intel_pt_pick_bit(mtc_periods, 3);
 210                         pos += scnprintf(buf + pos, sizeof(buf) - pos,
 211                                          ",mtc,mtc_period=%d", mtc_period);
 212                 }
 213         }
 214
 215         if (perf_pmu__scan_file(intel_pt_pmu, "caps/psb_cyc", "%d",
 216                                 &psb_cyc) != 1)
 217                 psb_cyc = 1;
 218
 219         if (psb_cyc && mtc_periods) {
 220                 if (perf_pmu__scan_file(intel_pt_pmu, "caps/psb_periods", "%x",
 221                                         &psb_periods) != 1)
 222                         psb_periods = 0;
 223                 if (psb_periods) {
 224                         psb_period = intel_pt_pick_bit(psb_periods, 3);
 225                         pos += scnprintf(buf + pos, sizeof(buf) - pos,
 226                                          ",psb_period=%d", psb_period);
 227                 }
 228         }
 229
 230         pr_debug2("%s default config: %s\n", intel_pt_pmu->name, buf);
 231
 232         intel_pt_parse_terms(&intel_pt_pmu->format, buf, &config);
 233
 234         return config;
 235 }
 236
 237 static int intel_pt_parse_snapshot_options(struct auxtrace_record *itr,
 238                                            struct record_opts *opts,
 239                                            const char *str)
 240 {
 241         struct intel_pt_recording *ptr =
 242                         container_of(itr, struct intel_pt_recording, itr);
 243         unsigned long long snapshot_size = 0;
 244         char *endptr;
 245
 246         if (str) {
 247                 snapshot_size = strtoull(str, &endptr, 0);
 248                 if (*endptr || snapshot_size > SIZE_MAX)
 249                         return -1;
 250         }
 251
 252         opts->auxtrace_snapshot_mode = true;
 253         opts->auxtrace_snapshot_size = snapshot_size;
 254
 255         ptr->snapshot_size = snapshot_size;
 256
 257         return 0;
 258 }
 259
 260 struct perf_event_attr *
 261 intel_pt_pmu_default_config(struct perf_pmu *intel_pt_pmu)
 262 {
 263         struct perf_event_attr *attr;
 264
 265         attr = zalloc(sizeof(struct perf_event_attr));
 266         if (!attr)
 267                 return NULL;
 268
 269         attr->config = intel_pt_default_config(intel_pt_pmu);
 270
 271         intel_pt_pmu->selectable = true;
 272
 273         return attr;
 274 }
 275
 276 static size_t intel_pt_info_priv_size(struct auxtrace_record *itr __maybe_unused)
 277 {
 278         return INTEL_PT_AUXTRACE_PRIV_SIZE;
 279 }
 280
 281 static void intel_pt_tsc_ctc_ratio(u32 *n, u32 *d)
 282 {
 283         unsigned int eax = 0, ebx = 0, ecx = 0, edx = 0;
 284
 285         __get_cpuid(0x15, &eax, &ebx, &ecx, &edx);
 286         *n = ebx;
 287         *d = eax;
 288 }
 289
 290 static int intel_pt_info_fill(struct auxtrace_record *itr,
 291                               struct perf_session *session,
 292                               struct auxtrace_info_event *auxtrace_info,
 293                               size_t priv_size)
 294 {
 295         struct intel_pt_recording *ptr =
 296                         container_of(itr, struct intel_pt_recording, itr);
 297         struct perf_pmu *intel_pt_pmu = ptr->intel_pt_pmu;
 298         struct perf_event_mmap_page *pc;
 299         struct perf_tsc_conversion tc = { .time_mult = 0, };
 300         bool cap_user_time_zero = false, per_cpu_mmaps;
 301         u64 tsc_bit, mtc_bit, mtc_freq_bits, cyc_bit, noretcomp_bit;
 302         u32 tsc_ctc_ratio_n, tsc_ctc_ratio_d;
 303         int err;
 304
 305         if (priv_size != INTEL_PT_AUXTRACE_PRIV_SIZE)
 306                 return -EINVAL;
 307
 308         intel_pt_parse_terms(&intel_pt_pmu->format, "tsc", &tsc_bit);
 309         intel_pt_parse_terms(&intel_pt_pmu->format, "noretcomp",
 310                              &noretcomp_bit);
 311         intel_pt_parse_terms(&intel_pt_pmu->format, "mtc", &mtc_bit);
 312         mtc_freq_bits = perf_pmu__format_bits(&intel_pt_pmu->format,
 313                                               "mtc_period");
 314         intel_pt_parse_terms(&intel_pt_pmu->format, "cyc", &cyc_bit);
 315
 316         intel_pt_tsc_ctc_ratio(&tsc_ctc_ratio_n, &tsc_ctc_ratio_d);
 317
 318         if (!session->evlist->nr_mmaps)
 319                 return -EINVAL;
 320
 321         pc = session->evlist->mmap[0].base;
 322         if (pc) {
 323                 err = perf_read_tsc_conversion(pc, &tc);
 324                 if (err) {
 325                         if (err != -EOPNOTSUPP)
 326                                 return err;
 327                 } else {
 328                         cap_user_time_zero = tc.time_mult != 0;
 329                 }
 330                 if (!cap_user_time_zero)
 331                         ui__warning("Intel Processor Trace: TSC not available\n");
 332         }
 333
 334         per_cpu_mmaps = !cpu_map__empty(session->evlist->cpus);
 335
 336         auxtrace_info->type = PERF_AUXTRACE_INTEL_PT;
 337         auxtrace_info->priv[INTEL_PT_PMU_TYPE] = intel_pt_pmu->type;
 338         auxtrace_info->priv[INTEL_PT_TIME_SHIFT] = tc.time_shift;
 339         auxtrace_info->priv[INTEL_PT_TIME_MULT] = tc.time_mult;
 340         auxtrace_info->priv[INTEL_PT_TIME_ZERO] = tc.time_zero;
 341         auxtrace_info->priv[INTEL_PT_CAP_USER_TIME_ZERO] = cap_user_time_zero;
 342         auxtrace_info->priv[INTEL_PT_TSC_BIT] = tsc_bit;
 343         auxtrace_info->priv[INTEL_PT_NORETCOMP_BIT] = noretcomp_bit;
 344         auxtrace_info->priv[INTEL_PT_HAVE_SCHED_SWITCH] = ptr->have_sched_switch;
 345         auxtrace_info->priv[INTEL_PT_SNAPSHOT_MODE] = ptr->snapshot_mode;
 346         auxtrace_info->priv[INTEL_PT_PER_CPU_MMAPS] = per_cpu_mmaps;
 347         auxtrace_info->priv[INTEL_PT_MTC_BIT] = mtc_bit;
 348         auxtrace_info->priv[INTEL_PT_MTC_FREQ_BITS] = mtc_freq_bits;
 349         auxtrace_info->priv[INTEL_PT_TSC_CTC_N] = tsc_ctc_ratio_n;
 350         auxtrace_info->priv[INTEL_PT_TSC_CTC_D] = tsc_ctc_ratio_d;
 351         auxtrace_info->priv[INTEL_PT_CYC_BIT] = cyc_bit;
 352
 353         return 0;
 354 }
 355
 356 static int intel_pt_track_switches(struct perf_evlist *evlist)
 357 {
 358         const char *sched_switch = "sched:sched_switch";
 359         struct perf_evsel *evsel;
 360         int err;
 361
 362         if (!perf_evlist__can_select_event(evlist, sched_switch))
 363                 return -EPERM;
 364
 365         err = parse_events(evlist, sched_switch, NULL);
 366         if (err) {
 367                 pr_debug2("%s: failed to parse %s, error %d\n",
 368                           __func__, sched_switch, err);
 369                 return err;
 370         }
 371
 372         evsel = perf_evlist__last(evlist);
 373
 374         perf_evsel__set_sample_bit(evsel, CPU);
 375         perf_evsel__set_sample_bit(evsel, TIME);
 376
 377         evsel->system_wide = true;
 378         evsel->no_aux_samples = true;
 379         evsel->immediate = true;
 380
 381         return 0;
 382 }
 383
 384 static void intel_pt_valid_str(char *str, size_t len, u64 valid)
 385 {
 386         unsigned int val, last = 0, state = 1;
 387         int p = 0;
 388
 389         str[0] = '\0';
 390
 391         for (val = 0; val <= 64; val++, valid >>= 1) {
 392                 if (valid & 1) {
 393                         last = val;
 394                         switch (state) {
 395                         case 0:
 396                                 p += scnprintf(str + p, len - p, ",");
 397                                 /* Fall through */
 398                         case 1:
 399                                 p += scnprintf(str + p, len - p, "%u", val);
 400                                 state = 2;
 401                                 break;
 402                         case 2:
 403                                 state = 3;
 404                                 break;
 405                         case 3:
 406                                 state = 4;
 407                                 break;
 408                         default:
 409                                 break;
 410                         }
 411                 } else {
 412                         switch (state) {
 413                         case 3:
 414                                 p += scnprintf(str + p, len - p, ",%u", last);
 415                                 state = 0;
 416                                 break;
 417                         case 4:
 418                                 p += scnprintf(str + p, len - p, "-%u", last);
 419                                 state = 0;
 420                                 break;
 421                         default:
 422                                 break;
 423                         }
 424                         if (state != 1)
 425                                 state = 0;
 426                 }
 427         }
 428 }
 429
 430 static int intel_pt_val_config_term(struct perf_pmu *intel_pt_pmu,
 431                                     const char *caps, const char *name,
 432                                     const char *supported, u64 config)
 433 {
 434         char valid_str[256];
 435         unsigned int shift;
 436         unsigned long long valid;
 437         u64 bits;
 438         int ok;
 439
 440         if (perf_pmu__scan_file(intel_pt_pmu, caps, "%llx", &valid) != 1)
 441                 valid = 0;
 442
 443         if (supported &&
 444             perf_pmu__scan_file(intel_pt_pmu, supported, "%d", &ok) == 1 && !ok)
 445                 valid = 0;
 446
 447         valid |= 1;
 448
 449         bits = perf_pmu__format_bits(&intel_pt_pmu->format, name);
 450
 451         config &= bits;
 452
 453         for (shift = 0; bits && !(bits & 1); shift++)
 454                 bits >>= 1;
 455
 456         config >>= shift;
 457
 458         if (config > 63)
 459                 goto out_err;
 460
 461         if (valid & (1 << config))
 462                 return 0;
 463 out_err:
 464         intel_pt_valid_str(valid_str, sizeof(valid_str), valid);
 465         pr_err("Invalid %s for %s. Valid values are: %s\n",
 466                name, INTEL_PT_PMU_NAME, valid_str);
 467         return -EINVAL;
 468 }
 469
 470 static int intel_pt_validate_config(struct perf_pmu *intel_pt_pmu,
 471                                     struct perf_evsel *evsel)
 472 {
 473         int err;
 474         char c;
 475
 476         if (!evsel)
 477                 return 0;
 478
 479         /*
 480          * If supported, force pass-through config term (pt=1) even if user
 481          * sets pt=0, which avoids senseless kernel errors.
 482          */
 483         if (perf_pmu__scan_file(intel_pt_pmu, "format/pt", "%c", &c) == 1 &&
 484             !(evsel->attr.config & 1)) {
 485                 pr_warning("pt=0 doesn't make sense, forcing pt=1\n");
 486                 evsel->attr.config |= 1;
 487         }
 488
 489         err = intel_pt_val_config_term(intel_pt_pmu, "caps/cycle_thresholds",
 490                                        "cyc_thresh", "caps/psb_cyc",
 491                                        evsel->attr.config);
 492         if (err)
 493                 return err;
 494
 495         err = intel_pt_val_config_term(intel_pt_pmu, "caps/mtc_periods",
 496                                        "mtc_period", "caps/mtc",
 497                                        evsel->attr.config);
 498         if (err)
 499                 return err;
 500
 501         return intel_pt_val_config_term(intel_pt_pmu, "caps/psb_periods",
 502                                         "psb_period", "caps/psb_cyc",
 503                                         evsel->attr.config);
 504 }
 505
 506 static int intel_pt_recording_options(struct auxtrace_record *itr,
 507                                       struct perf_evlist *evlist,
 508                                       struct record_opts *opts)
 509 {
 510         struct intel_pt_recording *ptr =
 511                         container_of(itr, struct intel_pt_recording, itr);
 512         struct perf_pmu *intel_pt_pmu = ptr->intel_pt_pmu;
 513         bool have_timing_info, need_immediate = false;
 514         struct perf_evsel *evsel, *intel_pt_evsel = NULL;
 515         const struct cpu_map *cpus = evlist->cpus;
 516         bool privileged = geteuid() == 0 || perf_event_paranoid() < 0;
 517         u64 tsc_bit;
 518         int err;
 519
 520         ptr->evlist = evlist;
 521         ptr->snapshot_mode = opts->auxtrace_snapshot_mode;
 522
 523         evlist__for_each(evlist, evsel) {
 524                 if (evsel->attr.type == intel_pt_pmu->type) {
 525                         if (intel_pt_evsel) {
 526                                 pr_err("There may be only one " INTEL_PT_PMU_NAME " event\n");
 527                                 return -EINVAL;
 528                         }
 529                         evsel->attr.freq = 0;
 530                         evsel->attr.sample_period = 1;
 531                         intel_pt_evsel = evsel;
 532                         opts->full_auxtrace = true;
 533                 }
 534         }
 535
 536         if (opts->auxtrace_snapshot_mode && !opts->full_auxtrace) {
 537                 pr_err("Snapshot mode (-S option) requires " INTEL_PT_PMU_NAME " PMU event (-e " INTEL_PT_PMU_NAME ")\n");
 538                 return -EINVAL;
 539         }
 540
 541         if (opts->use_clockid) {
 542                 pr_err("Cannot use clockid (-k option) with " INTEL_PT_PMU_NAME "\n");
 543                 return -EINVAL;
 544         }
 545
 546         if (!opts->full_auxtrace)
 547                 return 0;
 548
 549         err = intel_pt_validate_config(intel_pt_pmu, intel_pt_evsel);
 550         if (err)
 551                 return err;
 552
 553         /* Set default sizes for snapshot mode */
 554         if (opts->auxtrace_snapshot_mode) {
 555                 size_t psb_period = intel_pt_psb_period(intel_pt_pmu, evlist);
 556
 557                 if (!opts->auxtrace_snapshot_size && !opts->auxtrace_mmap_pages) {
 558                         if (privileged) {
 559                                 opts->auxtrace_mmap_pages = MiB(4) / page_size;
 560                         } else {
 561                                 opts->auxtrace_mmap_pages = KiB(128) / page_size;
 562                                 if (opts->mmap_pages == UINT_MAX)
 563                                         opts->mmap_pages = KiB(256) / page_size;
 564                         }
 565                 } else if (!opts->auxtrace_mmap_pages && !privileged &&
 566                            opts->mmap_pages == UINT_MAX) {
 567                         opts->mmap_pages = KiB(256) / page_size;
 568                 }
 569                 if (!opts->auxtrace_snapshot_size)
 570                         opts->auxtrace_snapshot_size =
 571                                 opts->auxtrace_mmap_pages * (size_t)page_size;
 572                 if (!opts->auxtrace_mmap_pages) {
 573                         size_t sz = opts->auxtrace_snapshot_size;
 574
 575                         sz = round_up(sz, page_size) / page_size;
 576                         opts->auxtrace_mmap_pages = roundup_pow_of_two(sz);
 577                 }
 578                 if (opts->auxtrace_snapshot_size >
 579                                 opts->auxtrace_mmap_pages * (size_t)page_size) {
 580                         pr_err("Snapshot size %zu must not be greater than AUX area tracing mmap size %zu\n",
 581                                opts->auxtrace_snapshot_size,
 582                                opts->auxtrace_mmap_pages * (size_t)page_size);
 583                         return -EINVAL;
 584                 }
 585                 if (!opts->auxtrace_snapshot_size || !opts->auxtrace_mmap_pages) {
 586                         pr_err("Failed to calculate default snapshot size and/or AUX area tracing mmap pages\n");
 587                         return -EINVAL;
 588                 }
 589                 pr_debug2("Intel PT snapshot size: %zu\n",
 590                           opts->auxtrace_snapshot_size);
 591                 if (psb_period &&
 592                     opts->auxtrace_snapshot_size <= psb_period +
 593                                                   INTEL_PT_PSB_PERIOD_NEAR)
 594                         ui__warning("Intel PT snapshot size (%zu) may be too small for PSB period (%zu)\n",
 595                                     opts->auxtrace_snapshot_size, psb_period);
 596         }
 597
 598         /* Set default sizes for full trace mode */
 599         if (opts->full_auxtrace && !opts->auxtrace_mmap_pages) {
 600                 if (privileged) {
 601                         opts->auxtrace_mmap_pages = MiB(4) / page_size;
 602                 } else {
 603                         opts->auxtrace_mmap_pages = KiB(128) / page_size;
 604                         if (opts->mmap_pages == UINT_MAX)
 605                                 opts->mmap_pages = KiB(256) / page_size;
 606                 }
 607         }
 608
 609         /* Validate auxtrace_mmap_pages */
 610         if (opts->auxtrace_mmap_pages) {
 611                 size_t sz = opts->auxtrace_mmap_pages * (size_t)page_size;
 612                 size_t min_sz;
 613
 614                 if (opts->auxtrace_snapshot_mode)
 615                         min_sz = KiB(4);
 616                 else
 617                         min_sz = KiB(8);
 618
 619                 if (sz < min_sz || !is_power_of_2(sz)) {
 620                         pr_err("Invalid mmap size for Intel Processor Trace: must be at least %zuKiB and a power of 2\n",
 621                                min_sz / 1024);
 622                         return -EINVAL;
 623                 }
 624         }
 625
 626         intel_pt_parse_terms(&intel_pt_pmu->format, "tsc", &tsc_bit);
 627
 628         if (opts->full_auxtrace && (intel_pt_evsel->attr.config & tsc_bit))
 629                 have_timing_info = true;
 630         else
 631                 have_timing_info = false;
 632
 633         /*
 634          * Per-cpu recording needs sched_switch events to distinguish different
 635          * threads.
 636          */
 637         if (have_timing_info && !cpu_map__empty(cpus)) {
 638                 if (perf_can_record_switch_events()) {
 639                         bool cpu_wide = !target__none(&opts->target) &&
 640                                         !target__has_task(&opts->target);
 641
 642                         if (!cpu_wide && perf_can_record_cpu_wide()) {
 643                                 struct perf_evsel *switch_evsel;
 644
 645                                 err = parse_events(evlist, "dummy:u", NULL);
 646                                 if (err)
 647                                         return err;
 648
 649                                 switch_evsel = perf_evlist__last(evlist);
 650
 651                                 switch_evsel->attr.freq = 0;
 652                                 switch_evsel->attr.sample_period = 1;
 653                                 switch_evsel->attr.context_switch = 1;
 654
 655                                 switch_evsel->system_wide = true;
 656                                 switch_evsel->no_aux_samples = true;
 657                                 switch_evsel->immediate = true;
 658
 659                                 perf_evsel__set_sample_bit(switch_evsel, TID);
 660                                 perf_evsel__set_sample_bit(switch_evsel, TIME);
 661                                 perf_evsel__set_sample_bit(switch_evsel, CPU);
 662
 663                                 opts->record_switch_events = false;
 664                                 ptr->have_sched_switch = 3;
 665                         } else {
 666                                 opts->record_switch_events = true;
 667                                 need_immediate = true;
 668                                 if (cpu_wide)
 669                                         ptr->have_sched_switch = 3;
 670                                 else
 671                                         ptr->have_sched_switch = 2;
 672                         }
 673                 } else {
 674                         err = intel_pt_track_switches(evlist);
 675                         if (err == -EPERM)
 676                                 pr_debug2("Unable to select sched:sched_switch\n");
 677                         else if (err)
 678                                 return err;
 679                         else
 680                                 ptr->have_sched_switch = 1;
 681                 }
 682         }
 683
 684         if (intel_pt_evsel) {
 685                 /*
 686                  * To obtain the auxtrace buffer file descriptor, the auxtrace
 687                  * event must come first.
 688                  */
 689                 perf_evlist__to_front(evlist, intel_pt_evsel);
 690                 /*
 691                  * In the case of per-cpu mmaps, we need the CPU on the
 692                  * AUX event.
 693                  */
 694                 if (!cpu_map__empty(cpus))
 695                         perf_evsel__set_sample_bit(intel_pt_evsel, CPU);
 696         }
 697
 698         /* Add dummy event to keep tracking */
 699         if (opts->full_auxtrace) {
 700                 struct perf_evsel *tracking_evsel;
 701
 702                 err = parse_events(evlist, "dummy:u", NULL);
 703                 if (err)
 704                         return err;
 705
 706                 tracking_evsel = perf_evlist__last(evlist);
 707
 708                 perf_evlist__set_tracking_event(evlist, tracking_evsel);
 709
 710                 tracking_evsel->attr.freq = 0;
 711                 tracking_evsel->attr.sample_period = 1;
 712
 713                 if (need_immediate)
 714                         tracking_evsel->immediate = true;
 715
 716                 /* In per-cpu case, always need the time of mmap events etc */
 717                 if (!cpu_map__empty(cpus)) {
 718                         perf_evsel__set_sample_bit(tracking_evsel, TIME);
 719                         /* And the CPU for switch events */
 720                         perf_evsel__set_sample_bit(tracking_evsel, CPU);
 721                 }
 722         }
 723
 724         /*
 725          * Warn the user when we do not have enough information to decode i.e.
 726          * per-cpu with no sched_switch (except workload-only).
 727          */
 728         if (!ptr->have_sched_switch && !cpu_map__empty(cpus) &&
 729             !target__none(&opts->target))
 730                 ui__warning("Intel Processor Trace decoding will not be possible except for kernel tracing!\n");
 731
 732         return 0;
 733 }
 734
 735 static int intel_pt_snapshot_start(struct auxtrace_record *itr)
 736 {
 737         struct intel_pt_recording *ptr =
 738                         container_of(itr, struct intel_pt_recording, itr);
 739         struct perf_evsel *evsel;
 740
 741         evlist__for_each(ptr->evlist, evsel) {
 742                 if (evsel->attr.type == ptr->intel_pt_pmu->type)
 743                         return perf_evlist__disable_event(ptr->evlist, evsel);
 744         }
 745         return -EINVAL;
 746 }
 747
 748 static int intel_pt_snapshot_finish(struct auxtrace_record *itr)
 749 {
 750         struct intel_pt_recording *ptr =
 751                         container_of(itr, struct intel_pt_recording, itr);
 752         struct perf_evsel *evsel;
 753
 754         evlist__for_each(ptr->evlist, evsel) {
 755                 if (evsel->attr.type == ptr->intel_pt_pmu->type)
 756                         return perf_evlist__enable_event(ptr->evlist, evsel);
 757         }
 758         return -EINVAL;
 759 }
 760
 761 static int intel_pt_alloc_snapshot_refs(struct intel_pt_recording *ptr, int idx)
 762 {
 763         const size_t sz = sizeof(struct intel_pt_snapshot_ref);
 764         int cnt = ptr->snapshot_ref_cnt, new_cnt = cnt * 2;
 765         struct intel_pt_snapshot_ref *refs;
 766
 767         if (!new_cnt)
 768                 new_cnt = 16;
 769
 770         while (new_cnt <= idx)
 771                 new_cnt *= 2;
 772
 773         refs = calloc(new_cnt, sz);
 774         if (!refs)
 775                 return -ENOMEM;
 776
 777         memcpy(refs, ptr->snapshot_refs, cnt * sz);
 778
 779         ptr->snapshot_refs = refs;
 780         ptr->snapshot_ref_cnt = new_cnt;
 781
 782         return 0;
 783 }
 784
 785 static void intel_pt_free_snapshot_refs(struct intel_pt_recording *ptr)
 786 {
 787         int i;
 788
 789         for (i = 0; i < ptr->snapshot_ref_cnt; i++)
 790                 zfree(&ptr->snapshot_refs[i].ref_buf);
 791         zfree(&ptr->snapshot_refs);
 792 }
 793
 794 static void intel_pt_recording_free(struct auxtrace_record *itr)
 795 {
 796         struct intel_pt_recording *ptr =
 797                         container_of(itr, struct intel_pt_recording, itr);
 798
 799         intel_pt_free_snapshot_refs(ptr);
 800         free(ptr);
 801 }
 802
 803 static int intel_pt_alloc_snapshot_ref(struct intel_pt_recording *ptr, int idx,
 804                                        size_t snapshot_buf_size)
 805 {
 806         size_t ref_buf_size = ptr->snapshot_ref_buf_size;
 807         void *ref_buf;
 808
 809         ref_buf = zalloc(ref_buf_size);
 810         if (!ref_buf)
 811                 return -ENOMEM;
 812
 813         ptr->snapshot_refs[idx].ref_buf = ref_buf;
 814         ptr->snapshot_refs[idx].ref_offset = snapshot_buf_size - ref_buf_size;
 815
 816         return 0;
 817 }
 818
 819 static size_t intel_pt_snapshot_ref_buf_size(struct intel_pt_recording *ptr,
 820                                              size_t snapshot_buf_size)
 821 {
 822         const size_t max_size = 256 * 1024;
 823         size_t buf_size = 0, psb_period;
 824
 825         if (ptr->snapshot_size <= 64 * 1024)
 826                 return 0;
 827
 828         psb_period = intel_pt_psb_period(ptr->intel_pt_pmu, ptr->evlist);
 829         if (psb_period)
 830                 buf_size = psb_period * 2;
 831
 832         if (!buf_size || buf_size > max_size)
 833                 buf_size = max_size;
 834
 835         if (buf_size >= snapshot_buf_size)
 836                 return 0;
 837
 838         if (buf_size >= ptr->snapshot_size / 2)
 839                 return 0;
 840
 841         return buf_size;
 842 }
 843
 844 static int intel_pt_snapshot_init(struct intel_pt_recording *ptr,
 845                                   size_t snapshot_buf_size)
 846 {
 847         if (ptr->snapshot_init_done)
 848                 return 0;
 849
 850         ptr->snapshot_init_done = true;
 851
 852         ptr->snapshot_ref_buf_size = intel_pt_snapshot_ref_buf_size(ptr,
 853                                                         snapshot_buf_size);
 854
 855         return 0;
 856 }
 857
 858 /**
 859  * intel_pt_compare_buffers - compare bytes in a buffer to a circular buffer.
 860  * @buf1: first buffer
 861  * @compare_size: number of bytes to compare
 862  * @buf2: second buffer (a circular buffer)
 863  * @offs2: offset in second buffer
 864  * @buf2_size: size of second buffer
 865  *
 866  * The comparison allows for the possibility that the bytes to compare in the
 867  * circular buffer are not contiguous.  It is assumed that @compare_size <=
 868  * @buf2_size.  This function returns %false if the bytes are identical, %true
 869  * otherwise.
 870  */
 871 static bool intel_pt_compare_buffers(void *buf1, size_t compare_size,
 872                                      void *buf2, size_t offs2, size_t buf2_size)
 873 {
 874         size_t end2 = offs2 + compare_size, part_size;
 875
 876         if (end2 <= buf2_size)
 877                 return memcmp(buf1, buf2 + offs2, compare_size);
 878
 879         part_size = end2 - buf2_size;
 880         if (memcmp(buf1, buf2 + offs2, part_size))
 881                 return true;
 882
 883         compare_size -= part_size;
 884
 885         return memcmp(buf1 + part_size, buf2, compare_size);
 886 }
 887
 888 static bool intel_pt_compare_ref(void *ref_buf, size_t ref_offset,
 889                                  size_t ref_size, size_t buf_size,
 890                                  void *data, size_t head)
 891 {
 892         size_t ref_end = ref_offset + ref_size;
 893
 894         if (ref_end > buf_size) {
 895                 if (head > ref_offset || head < ref_end - buf_size)
 896                         return true;
 897         } else if (head > ref_offset && head < ref_end) {
 898                 return true;
 899         }
 900
 901         return intel_pt_compare_buffers(ref_buf, ref_size, data, ref_offset,
 902                                         buf_size);
 903 }
 904
 905 static void intel_pt_copy_ref(void *ref_buf, size_t ref_size, size_t buf_size,
 906                               void *data, size_t head)
 907 {
 908         if (head >= ref_size) {
 909                 memcpy(ref_buf, data + head - ref_size, ref_size);
 910         } else {
 911                 memcpy(ref_buf, data, head);
 912                 ref_size -= head;
 913                 memcpy(ref_buf + head, data + buf_size - ref_size, ref_size);
 914         }
 915 }
 916
 917 static bool intel_pt_wrapped(struct intel_pt_recording *ptr, int idx,
 918                              struct auxtrace_mmap *mm, unsigned char *data,
 919                              u64 head)
 920 {
 921         struct intel_pt_snapshot_ref *ref = &ptr->snapshot_refs[idx];
 922         bool wrapped;
 923
 924         wrapped = intel_pt_compare_ref(ref->ref_buf, ref->ref_offset,
 925                                        ptr->snapshot_ref_buf_size, mm->len,
 926                                        data, head);
 927
 928         intel_pt_copy_ref(ref->ref_buf, ptr->snapshot_ref_buf_size, mm->len,
 929                           data, head);
 930
 931         return wrapped;
 932 }
 933
 934 static bool intel_pt_first_wrap(u64 *data, size_t buf_size)
 935 {
 936         int i, a, b;
 937
 938         b = buf_size >> 3;
 939         a = b - 512;
 940         if (a < 0)
 941                 a = 0;
 942
 943         for (i = a; i < b; i++) {
 944                 if (data[i])
 945                         return true;
 946         }
 947
 948         return false;
 949 }
 950
 951 static int intel_pt_find_snapshot(struct auxtrace_record *itr, int idx,
 952                                   struct auxtrace_mmap *mm, unsigned char *data,
 953                                   u64 *head, u64 *old)
 954 {
 955         struct intel_pt_recording *ptr =
 956                         container_of(itr, struct intel_pt_recording, itr);
 957         bool wrapped;
 958         int err;
 959
 960         pr_debug3("%s: mmap index %d old head %zu new head %zu\n",
 961                   __func__, idx, (size_t)*old, (size_t)*head);
 962
 963         err = intel_pt_snapshot_init(ptr, mm->len);
 964         if (err)
 965                 goto out_err;
 966
 967         if (idx >= ptr->snapshot_ref_cnt) {
 968                 err = intel_pt_alloc_snapshot_refs(ptr, idx);
 969                 if (err)
 970                         goto out_err;
 971         }
 972
 973         if (ptr->snapshot_ref_buf_size) {
 974                 if (!ptr->snapshot_refs[idx].ref_buf) {
 975                         err = intel_pt_alloc_snapshot_ref(ptr, idx, mm->len);
 976                         if (err)
 977                                 goto out_err;
 978                 }
 979                 wrapped = intel_pt_wrapped(ptr, idx, mm, data, *head);
 980         } else {
 981                 wrapped = ptr->snapshot_refs[idx].wrapped;
 982                 if (!wrapped && intel_pt_first_wrap((u64 *)data, mm->len)) {
 983                         ptr->snapshot_refs[idx].wrapped = true;
 984                         wrapped = true;
 985                 }
 986         }
 987
 988         /*
 989          * In full trace mode 'head' continually increases.  However in snapshot
 990          * mode 'head' is an offset within the buffer.  Here 'old' and 'head'
 991          * are adjusted to match the full trace case which expects that 'old' is
 992          * always less than 'head'.
 993          */
 994         if (wrapped) {
 995                 *old = *head;
 996                 *head += mm->len;
 997         } else {
 998                 if (mm->mask)
 999                         *old &= mm->mask;
1000                 else
1001                         *old %= mm->len;
1002                 if (*old > *head)
1003                         *head += mm->len;
1004         }
1005
1006         pr_debug3("%s: wrap-around %sdetected, adjusted old head %zu adjusted new head %zu\n",
1007                   __func__, wrapped ? "" : "not ", (size_t)*old, (size_t)*head);
1008
1009         return 0;
1010
1011 out_err:
1012         pr_err("%s: failed, error %d\n", __func__, err);
1013         return err;
1014 }
1015
1016 static u64 intel_pt_reference(struct auxtrace_record *itr __maybe_unused)
1017 {
1018         return rdtsc();
1019 }
1020
1021 static int intel_pt_read_finish(struct auxtrace_record *itr, int idx)
1022 {
1023         struct intel_pt_recording *ptr =
1024                         container_of(itr, struct intel_pt_recording, itr);
1025         struct perf_evsel *evsel;
1026
1027         evlist__for_each(ptr->evlist, evsel) {
1028                 if (evsel->attr.type == ptr->intel_pt_pmu->type)
1029                         return perf_evlist__enable_event_idx(ptr->evlist, evsel,
1030                                                              idx);
1031         }
1032         return -EINVAL;
1033 }
1034
1035 struct auxtrace_record *intel_pt_recording_init(int *err)
1036 {
1037         struct perf_pmu *intel_pt_pmu = perf_pmu__find(INTEL_PT_PMU_NAME);
1038         struct intel_pt_recording *ptr;
1039
1040         if (!intel_pt_pmu)
1041                 return NULL;
1042
1043         ptr = zalloc(sizeof(struct intel_pt_recording));
1044         if (!ptr) {
1045                 *err = -ENOMEM;
1046                 return NULL;
1047         }
1048
1049         ptr->intel_pt_pmu = intel_pt_pmu;
1050         ptr->itr.recording_options = intel_pt_recording_options;
1051         ptr->itr.info_priv_size = intel_pt_info_priv_size;
1052         ptr->itr.info_fill = intel_pt_info_fill;
1053         ptr->itr.free = intel_pt_recording_free;
1054         ptr->itr.snapshot_start = intel_pt_snapshot_start;
1055         ptr->itr.snapshot_finish = intel_pt_snapshot_finish;
1056         ptr->itr.find_snapshot = intel_pt_find_snapshot;
1057         ptr->itr.parse_snapshot_options = intel_pt_parse_snapshot_options;
1058         ptr->itr.reference = intel_pt_reference;
1059         ptr->itr.read_finish = intel_pt_read_finish;
1060         return &ptr->itr;
1061 }