tools/perf/builtin-script.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 #include "builtin.h"
   3
   4 #include "util/counts.h"
   5 #include "util/debug.h"
   6 #include "util/dso.h"
   7 #include <subcmd/exec-cmd.h>
   8 #include "util/header.h"
   9 #include <subcmd/parse-options.h>
  10 #include "util/perf_regs.h"
  11 #include "util/session.h"
  12 #include "util/tool.h"
  13 #include "util/map.h"
  14 #include "util/srcline.h"
  15 #include "util/symbol.h"
  16 #include "util/thread.h"
  17 #include "util/trace-event.h"
  18 #include "util/env.h"
  19 #include "util/evlist.h"
  20 #include "util/evsel.h"
  21 #include "util/evsel_fprintf.h"
  22 #include "util/evswitch.h"
  23 #include "util/sort.h"
  24 #include "util/data.h"
  25 #include "util/auxtrace.h"
  26 #include "util/cpumap.h"
  27 #include "util/thread_map.h"
  28 #include "util/stat.h"
  29 #include "util/color.h"
  30 #include "util/string2.h"
  31 #include "util/thread-stack.h"
  32 #include "util/time-utils.h"
  33 #include "util/path.h"
  34 #include "util/event.h"
  35 #include "ui/ui.h"
  36 #include "print_binary.h"
  37 #include "archinsn.h"
  38 #include <linux/bitmap.h>
  39 #include <linux/kernel.h>
  40 #include <linux/stringify.h>
  41 #include <linux/time64.h>
  42 #include <linux/zalloc.h>
  43 #include <sys/utsname.h>
  44 #include "asm/bug.h"
  45 #include "util/mem-events.h"
  46 #include "util/dump-insn.h"
  47 #include <dirent.h>
  48 #include <errno.h>
  49 #include <inttypes.h>
  50 #include <signal.h>
  51 #include <sys/param.h>
  52 #include <sys/types.h>
  53 #include <sys/stat.h>
  54 #include <fcntl.h>
  55 #include <unistd.h>
  56 #include <subcmd/pager.h>
  57 #include <perf/evlist.h>
  58 #include <linux/err.h>
  59 #include "util/dlfilter.h"
  60 #include "util/record.h"
  61 #include "util/util.h"
  62 #include "util/cgroup.h"
  63 #include "perf.h"
  64
  65 #include <linux/ctype.h>
  66 #ifdef HAVE_LIBTRACEEVENT
  67 #include <traceevent/event-parse.h>
  68 #endif
  69
  70 static char const               *script_name;
  71 static char const               *generate_script_lang;
  72 static bool                     reltime;
  73 static bool                     deltatime;
  74 static u64                      initial_time;
  75 static u64                      previous_time;
  76 static bool                     debug_mode;
  77 static u64                      last_timestamp;
  78 static u64                      nr_unordered;
  79 static bool                     no_callchain;
  80 static bool                     latency_format;
  81 static bool                     system_wide;
  82 static bool                     print_flags;
  83 static const char               *cpu_list;
  84 static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
  85 static struct perf_stat_config  stat_config;
  86 static int                      max_blocks;
  87 static bool                     native_arch;
  88 static struct dlfilter          *dlfilter;
  89 static int                      dlargc;
  90 static char                     **dlargv;
  91
  92 unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
  93
  94 enum perf_output_field {
  95         PERF_OUTPUT_COMM            = 1ULL << 0,
  96         PERF_OUTPUT_TID             = 1ULL << 1,
  97         PERF_OUTPUT_PID             = 1ULL << 2,
  98         PERF_OUTPUT_TIME            = 1ULL << 3,
  99         PERF_OUTPUT_CPU             = 1ULL << 4,
 100         PERF_OUTPUT_EVNAME          = 1ULL << 5,
 101         PERF_OUTPUT_TRACE           = 1ULL << 6,
 102         PERF_OUTPUT_IP              = 1ULL << 7,
 103         PERF_OUTPUT_SYM             = 1ULL << 8,
 104         PERF_OUTPUT_DSO             = 1ULL << 9,
 105         PERF_OUTPUT_ADDR            = 1ULL << 10,
 106         PERF_OUTPUT_SYMOFFSET       = 1ULL << 11,
 107         PERF_OUTPUT_SRCLINE         = 1ULL << 12,
 108         PERF_OUTPUT_PERIOD          = 1ULL << 13,
 109         PERF_OUTPUT_IREGS           = 1ULL << 14,
 110         PERF_OUTPUT_BRSTACK         = 1ULL << 15,
 111         PERF_OUTPUT_BRSTACKSYM      = 1ULL << 16,
 112         PERF_OUTPUT_DATA_SRC        = 1ULL << 17,
 113         PERF_OUTPUT_WEIGHT          = 1ULL << 18,
 114         PERF_OUTPUT_BPF_OUTPUT      = 1ULL << 19,
 115         PERF_OUTPUT_CALLINDENT      = 1ULL << 20,
 116         PERF_OUTPUT_INSN            = 1ULL << 21,
 117         PERF_OUTPUT_INSNLEN         = 1ULL << 22,
 118         PERF_OUTPUT_BRSTACKINSN     = 1ULL << 23,
 119         PERF_OUTPUT_BRSTACKOFF      = 1ULL << 24,
 120         PERF_OUTPUT_SYNTH           = 1ULL << 25,
 121         PERF_OUTPUT_PHYS_ADDR       = 1ULL << 26,
 122         PERF_OUTPUT_UREGS           = 1ULL << 27,
 123         PERF_OUTPUT_METRIC          = 1ULL << 28,
 124         PERF_OUTPUT_MISC            = 1ULL << 29,
 125         PERF_OUTPUT_SRCCODE         = 1ULL << 30,
 126         PERF_OUTPUT_IPC             = 1ULL << 31,
 127         PERF_OUTPUT_TOD             = 1ULL << 32,
 128         PERF_OUTPUT_DATA_PAGE_SIZE  = 1ULL << 33,
 129         PERF_OUTPUT_CODE_PAGE_SIZE  = 1ULL << 34,
 130         PERF_OUTPUT_INS_LAT         = 1ULL << 35,
 131         PERF_OUTPUT_BRSTACKINSNLEN  = 1ULL << 36,
 132         PERF_OUTPUT_MACHINE_PID     = 1ULL << 37,
 133         PERF_OUTPUT_VCPU            = 1ULL << 38,
 134         PERF_OUTPUT_CGROUP          = 1ULL << 39,
 135         PERF_OUTPUT_RETIRE_LAT      = 1ULL << 40,
 136 };
 137
 138 struct perf_script {
 139         struct perf_tool        tool;
 140         struct perf_session     *session;
 141         bool                    show_task_events;
 142         bool                    show_mmap_events;
 143         bool                    show_switch_events;
 144         bool                    show_namespace_events;
 145         bool                    show_lost_events;
 146         bool                    show_round_events;
 147         bool                    show_bpf_events;
 148         bool                    show_cgroup_events;
 149         bool                    show_text_poke_events;
 150         bool                    allocated;
 151         bool                    per_event_dump;
 152         bool                    stitch_lbr;
 153         struct evswitch         evswitch;
 154         struct perf_cpu_map     *cpus;
 155         struct perf_thread_map *threads;
 156         int                     name_width;
 157         const char              *time_str;
 158         struct perf_time_interval *ptime_range;
 159         int                     range_size;
 160         int                     range_num;
 161 };
 162
 163 struct output_option {
 164         const char *str;
 165         enum perf_output_field field;
 166 } all_output_options[] = {
 167         {.str = "comm",  .field = PERF_OUTPUT_COMM},
 168         {.str = "tid",   .field = PERF_OUTPUT_TID},
 169         {.str = "pid",   .field = PERF_OUTPUT_PID},
 170         {.str = "time",  .field = PERF_OUTPUT_TIME},
 171         {.str = "cpu",   .field = PERF_OUTPUT_CPU},
 172         {.str = "event", .field = PERF_OUTPUT_EVNAME},
 173         {.str = "trace", .field = PERF_OUTPUT_TRACE},
 174         {.str = "ip",    .field = PERF_OUTPUT_IP},
 175         {.str = "sym",   .field = PERF_OUTPUT_SYM},
 176         {.str = "dso",   .field = PERF_OUTPUT_DSO},
 177         {.str = "addr",  .field = PERF_OUTPUT_ADDR},
 178         {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
 179         {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
 180         {.str = "period", .field = PERF_OUTPUT_PERIOD},
 181         {.str = "iregs", .field = PERF_OUTPUT_IREGS},
 182         {.str = "uregs", .field = PERF_OUTPUT_UREGS},
 183         {.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
 184         {.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
 185         {.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
 186         {.str = "weight",   .field = PERF_OUTPUT_WEIGHT},
 187         {.str = "bpf-output",   .field = PERF_OUTPUT_BPF_OUTPUT},
 188         {.str = "callindent", .field = PERF_OUTPUT_CALLINDENT},
 189         {.str = "insn", .field = PERF_OUTPUT_INSN},
 190         {.str = "insnlen", .field = PERF_OUTPUT_INSNLEN},
 191         {.str = "brstackinsn", .field = PERF_OUTPUT_BRSTACKINSN},
 192         {.str = "brstackoff", .field = PERF_OUTPUT_BRSTACKOFF},
 193         {.str = "synth", .field = PERF_OUTPUT_SYNTH},
 194         {.str = "phys_addr", .field = PERF_OUTPUT_PHYS_ADDR},
 195         {.str = "metric", .field = PERF_OUTPUT_METRIC},
 196         {.str = "misc", .field = PERF_OUTPUT_MISC},
 197         {.str = "srccode", .field = PERF_OUTPUT_SRCCODE},
 198         {.str = "ipc", .field = PERF_OUTPUT_IPC},
 199         {.str = "tod", .field = PERF_OUTPUT_TOD},
 200         {.str = "data_page_size", .field = PERF_OUTPUT_DATA_PAGE_SIZE},
 201         {.str = "code_page_size", .field = PERF_OUTPUT_CODE_PAGE_SIZE},
 202         {.str = "ins_lat", .field = PERF_OUTPUT_INS_LAT},
 203         {.str = "brstackinsnlen", .field = PERF_OUTPUT_BRSTACKINSNLEN},
 204         {.str = "machine_pid", .field = PERF_OUTPUT_MACHINE_PID},
 205         {.str = "vcpu", .field = PERF_OUTPUT_VCPU},
 206         {.str = "cgroup", .field = PERF_OUTPUT_CGROUP},
 207         {.str = "retire_lat", .field = PERF_OUTPUT_RETIRE_LAT},
 208 };
 209
 210 enum {
 211         OUTPUT_TYPE_SYNTH = PERF_TYPE_MAX,
 212         OUTPUT_TYPE_OTHER,
 213         OUTPUT_TYPE_MAX
 214 };
 215
 216 /* default set to maintain compatibility with current format */
 217 static struct {
 218         bool user_set;
 219         bool wildcard_set;
 220         unsigned int print_ip_opts;
 221         u64 fields;
 222         u64 invalid_fields;
 223         u64 user_set_fields;
 224         u64 user_unset_fields;
 225 } output[OUTPUT_TYPE_MAX] = {
 226
 227         [PERF_TYPE_HARDWARE] = {
 228                 .user_set = false,
 229
 230                 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
 231                               PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
 232                               PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
 233                               PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
 234                               PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
 235
 236                 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
 237         },
 238
 239         [PERF_TYPE_SOFTWARE] = {
 240                 .user_set = false,
 241
 242                 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
 243                               PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
 244                               PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
 245                               PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
 246                               PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
 247                               PERF_OUTPUT_BPF_OUTPUT,
 248
 249                 .invalid_fields = PERF_OUTPUT_TRACE,
 250         },
 251
 252         [PERF_TYPE_TRACEPOINT] = {
 253                 .user_set = false,
 254
 255                 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
 256                                   PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
 257                                   PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
 258         },
 259
 260         [PERF_TYPE_HW_CACHE] = {
 261                 .user_set = false,
 262
 263                 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
 264                               PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
 265                               PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
 266                               PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
 267                               PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
 268
 269                 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
 270         },
 271
 272         [PERF_TYPE_RAW] = {
 273                 .user_set = false,
 274
 275                 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
 276                               PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
 277                               PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
 278                               PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
 279                               PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
 280                               PERF_OUTPUT_ADDR | PERF_OUTPUT_DATA_SRC |
 281                               PERF_OUTPUT_WEIGHT | PERF_OUTPUT_PHYS_ADDR |
 282                               PERF_OUTPUT_DATA_PAGE_SIZE | PERF_OUTPUT_CODE_PAGE_SIZE |
 283                               PERF_OUTPUT_INS_LAT | PERF_OUTPUT_RETIRE_LAT,
 284
 285                 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
 286         },
 287
 288         [PERF_TYPE_BREAKPOINT] = {
 289                 .user_set = false,
 290
 291                 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
 292                               PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
 293                               PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
 294                               PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
 295                               PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
 296
 297                 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
 298         },
 299
 300         [OUTPUT_TYPE_SYNTH] = {
 301                 .user_set = false,
 302
 303                 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
 304                               PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
 305                               PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
 306                               PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
 307                               PERF_OUTPUT_DSO | PERF_OUTPUT_SYNTH,
 308
 309                 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
 310         },
 311
 312         [OUTPUT_TYPE_OTHER] = {
 313                 .user_set = false,
 314
 315                 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
 316                               PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
 317                               PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
 318                               PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
 319                               PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
 320
 321                 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
 322         },
 323 };
 324
 325 struct evsel_script {
 326        char *filename;
 327        FILE *fp;
 328        u64  samples;
 329        /* For metric output */
 330        u64  val;
 331        int  gnum;
 332 };
 333
 334 static inline struct evsel_script *evsel_script(struct evsel *evsel)
 335 {
 336         return (struct evsel_script *)evsel->priv;
 337 }
 338
 339 static struct evsel_script *evsel_script__new(struct evsel *evsel, struct perf_data *data)
 340 {
 341         struct evsel_script *es = zalloc(sizeof(*es));
 342
 343         if (es != NULL) {
 344                 if (asprintf(&es->filename, "%s.%s.dump", data->file.path, evsel__name(evsel)) < 0)
 345                         goto out_free;
 346                 es->fp = fopen(es->filename, "w");
 347                 if (es->fp == NULL)
 348                         goto out_free_filename;
 349         }
 350
 351         return es;
 352 out_free_filename:
 353         zfree(&es->filename);
 354 out_free:
 355         free(es);
 356         return NULL;
 357 }
 358
 359 static void evsel_script__delete(struct evsel_script *es)
 360 {
 361         zfree(&es->filename);
 362         fclose(es->fp);
 363         es->fp = NULL;
 364         free(es);
 365 }
 366
 367 static int evsel_script__fprintf(struct evsel_script *es, FILE *fp)
 368 {
 369         struct stat st;
 370
 371         fstat(fileno(es->fp), &st);
 372         return fprintf(fp, "[ perf script: Wrote %.3f MB %s (%" PRIu64 " samples) ]\n",
 373                        st.st_size / 1024.0 / 1024.0, es->filename, es->samples);
 374 }
 375
 376 static inline int output_type(unsigned int type)
 377 {
 378         switch (type) {
 379         case PERF_TYPE_SYNTH:
 380                 return OUTPUT_TYPE_SYNTH;
 381         default:
 382                 if (type < PERF_TYPE_MAX)
 383                         return type;
 384         }
 385
 386         return OUTPUT_TYPE_OTHER;
 387 }
 388
 389 static bool output_set_by_user(void)
 390 {
 391         int j;
 392         for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
 393                 if (output[j].user_set)
 394                         return true;
 395         }
 396         return false;
 397 }
 398
 399 static const char *output_field2str(enum perf_output_field field)
 400 {
 401         int i, imax = ARRAY_SIZE(all_output_options);
 402         const char *str = "";
 403
 404         for (i = 0; i < imax; ++i) {
 405                 if (all_output_options[i].field == field) {
 406                         str = all_output_options[i].str;
 407                         break;
 408                 }
 409         }
 410         return str;
 411 }
 412
 413 #define PRINT_FIELD(x)  (output[output_type(attr->type)].fields & PERF_OUTPUT_##x)
 414
 415 static int evsel__do_check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
 416                                  enum perf_output_field field, bool allow_user_set)
 417 {
 418         struct perf_event_attr *attr = &evsel->core.attr;
 419         int type = output_type(attr->type);
 420         const char *evname;
 421
 422         if (attr->sample_type & sample_type)
 423                 return 0;
 424
 425         if (output[type].user_set_fields & field) {
 426                 if (allow_user_set)
 427                         return 0;
 428                 evname = evsel__name(evsel);
 429                 pr_err("Samples for '%s' event do not have %s attribute set. "
 430                        "Cannot print '%s' field.\n",
 431                        evname, sample_msg, output_field2str(field));
 432                 return -1;
 433         }
 434
 435         /* user did not ask for it explicitly so remove from the default list */
 436         output[type].fields &= ~field;
 437         evname = evsel__name(evsel);
 438         pr_debug("Samples for '%s' event do not have %s attribute set. "
 439                  "Skipping '%s' field.\n",
 440                  evname, sample_msg, output_field2str(field));
 441
 442         return 0;
 443 }
 444
 445 static int evsel__check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
 446                               enum perf_output_field field)
 447 {
 448         return evsel__do_check_stype(evsel, sample_type, sample_msg, field, false);
 449 }
 450
 451 static int evsel__check_attr(struct evsel *evsel, struct perf_session *session)
 452 {
 453         struct perf_event_attr *attr = &evsel->core.attr;
 454         bool allow_user_set;
 455
 456         if (evsel__is_dummy_event(evsel))
 457                 return 0;
 458
 459         if (perf_header__has_feat(&session->header, HEADER_STAT))
 460                 return 0;
 461
 462         allow_user_set = perf_header__has_feat(&session->header,
 463                                                HEADER_AUXTRACE);
 464
 465         if (PRINT_FIELD(TRACE) &&
 466             !perf_session__has_traces(session, "record -R"))
 467                 return -EINVAL;
 468
 469         if (PRINT_FIELD(IP)) {
 470                 if (evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP", PERF_OUTPUT_IP))
 471                         return -EINVAL;
 472         }
 473
 474         if (PRINT_FIELD(ADDR) &&
 475             evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR", PERF_OUTPUT_ADDR, allow_user_set))
 476                 return -EINVAL;
 477
 478         if (PRINT_FIELD(DATA_SRC) &&
 479             evsel__do_check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC", PERF_OUTPUT_DATA_SRC, allow_user_set))
 480                 return -EINVAL;
 481
 482         if (PRINT_FIELD(WEIGHT) &&
 483             evsel__do_check_stype(evsel, PERF_SAMPLE_WEIGHT_TYPE, "WEIGHT", PERF_OUTPUT_WEIGHT, allow_user_set))
 484                 return -EINVAL;
 485
 486         if (PRINT_FIELD(SYM) &&
 487             !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
 488                 pr_err("Display of symbols requested but neither sample IP nor "
 489                            "sample address\navailable. Hence, no addresses to convert "
 490                        "to symbols.\n");
 491                 return -EINVAL;
 492         }
 493         if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
 494                 pr_err("Display of offsets requested but symbol is not"
 495                        "selected.\n");
 496                 return -EINVAL;
 497         }
 498         if (PRINT_FIELD(DSO) &&
 499             !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
 500                 pr_err("Display of DSO requested but no address to convert.\n");
 501                 return -EINVAL;
 502         }
 503         if ((PRINT_FIELD(SRCLINE) || PRINT_FIELD(SRCCODE)) && !PRINT_FIELD(IP)) {
 504                 pr_err("Display of source line number requested but sample IP is not\n"
 505                        "selected. Hence, no address to lookup the source line number.\n");
 506                 return -EINVAL;
 507         }
 508         if ((PRINT_FIELD(BRSTACKINSN) || PRINT_FIELD(BRSTACKINSNLEN)) && !allow_user_set &&
 509             !(evlist__combined_branch_type(session->evlist) & PERF_SAMPLE_BRANCH_ANY)) {
 510                 pr_err("Display of branch stack assembler requested, but non all-branch filter set\n"
 511                        "Hint: run 'perf record -b ...'\n");
 512                 return -EINVAL;
 513         }
 514         if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
 515             evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID", PERF_OUTPUT_TID|PERF_OUTPUT_PID))
 516                 return -EINVAL;
 517
 518         if (PRINT_FIELD(TIME) &&
 519             evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME", PERF_OUTPUT_TIME))
 520                 return -EINVAL;
 521
 522         if (PRINT_FIELD(CPU) &&
 523             evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU", PERF_OUTPUT_CPU, allow_user_set))
 524                 return -EINVAL;
 525
 526         if (PRINT_FIELD(IREGS) &&
 527             evsel__do_check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS", PERF_OUTPUT_IREGS, allow_user_set))
 528                 return -EINVAL;
 529
 530         if (PRINT_FIELD(UREGS) &&
 531             evsel__check_stype(evsel, PERF_SAMPLE_REGS_USER, "UREGS", PERF_OUTPUT_UREGS))
 532                 return -EINVAL;
 533
 534         if (PRINT_FIELD(PHYS_ADDR) &&
 535             evsel__do_check_stype(evsel, PERF_SAMPLE_PHYS_ADDR, "PHYS_ADDR", PERF_OUTPUT_PHYS_ADDR, allow_user_set))
 536                 return -EINVAL;
 537
 538         if (PRINT_FIELD(DATA_PAGE_SIZE) &&
 539             evsel__check_stype(evsel, PERF_SAMPLE_DATA_PAGE_SIZE, "DATA_PAGE_SIZE", PERF_OUTPUT_DATA_PAGE_SIZE))
 540                 return -EINVAL;
 541
 542         if (PRINT_FIELD(CODE_PAGE_SIZE) &&
 543             evsel__check_stype(evsel, PERF_SAMPLE_CODE_PAGE_SIZE, "CODE_PAGE_SIZE", PERF_OUTPUT_CODE_PAGE_SIZE))
 544                 return -EINVAL;
 545
 546         if (PRINT_FIELD(INS_LAT) &&
 547             evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT_STRUCT, "WEIGHT_STRUCT", PERF_OUTPUT_INS_LAT))
 548                 return -EINVAL;
 549
 550         if (PRINT_FIELD(CGROUP) &&
 551             evsel__check_stype(evsel, PERF_SAMPLE_CGROUP, "CGROUP", PERF_OUTPUT_CGROUP)) {
 552                 pr_err("Hint: run 'perf record --all-cgroups ...'\n");
 553                 return -EINVAL;
 554         }
 555
 556         if (PRINT_FIELD(RETIRE_LAT) &&
 557             evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT_STRUCT, "WEIGHT_STRUCT", PERF_OUTPUT_RETIRE_LAT))
 558                 return -EINVAL;
 559
 560         return 0;
 561 }
 562
 563 static void set_print_ip_opts(struct perf_event_attr *attr)
 564 {
 565         unsigned int type = output_type(attr->type);
 566
 567         output[type].print_ip_opts = 0;
 568         if (PRINT_FIELD(IP))
 569                 output[type].print_ip_opts |= EVSEL__PRINT_IP;
 570
 571         if (PRINT_FIELD(SYM))
 572                 output[type].print_ip_opts |= EVSEL__PRINT_SYM;
 573
 574         if (PRINT_FIELD(DSO))
 575                 output[type].print_ip_opts |= EVSEL__PRINT_DSO;
 576
 577         if (PRINT_FIELD(SYMOFFSET))
 578                 output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
 579
 580         if (PRINT_FIELD(SRCLINE))
 581                 output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
 582 }
 583
 584 static struct evsel *find_first_output_type(struct evlist *evlist,
 585                                             unsigned int type)
 586 {
 587         struct evsel *evsel;
 588
 589         evlist__for_each_entry(evlist, evsel) {
 590                 if (evsel__is_dummy_event(evsel))
 591                         continue;
 592                 if (output_type(evsel->core.attr.type) == (int)type)
 593                         return evsel;
 594         }
 595         return NULL;
 596 }
 597
 598 /*
 599  * verify all user requested events exist and the samples
 600  * have the expected data
 601  */
 602 static int perf_session__check_output_opt(struct perf_session *session)
 603 {
 604         bool tod = false;
 605         unsigned int j;
 606         struct evsel *evsel;
 607
 608         for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
 609                 evsel = find_first_output_type(session->evlist, j);
 610
 611                 /*
 612                  * even if fields is set to 0 (ie., show nothing) event must
 613                  * exist if user explicitly includes it on the command line
 614                  */
 615                 if (!evsel && output[j].user_set && !output[j].wildcard_set &&
 616                     j != OUTPUT_TYPE_SYNTH) {
 617                         pr_err("%s events do not exist. "
 618                                "Remove corresponding -F option to proceed.\n",
 619                                event_type(j));
 620                         return -1;
 621                 }
 622
 623                 if (evsel && output[j].fields &&
 624                         evsel__check_attr(evsel, session))
 625                         return -1;
 626
 627                 if (evsel == NULL)
 628                         continue;
 629
 630                 set_print_ip_opts(&evsel->core.attr);
 631                 tod |= output[j].fields & PERF_OUTPUT_TOD;
 632         }
 633
 634         if (!no_callchain) {
 635                 bool use_callchain = false;
 636                 bool not_pipe = false;
 637
 638                 evlist__for_each_entry(session->evlist, evsel) {
 639                         not_pipe = true;
 640                         if (evsel__has_callchain(evsel)) {
 641                                 use_callchain = true;
 642                                 break;
 643                         }
 644                 }
 645                 if (not_pipe && !use_callchain)
 646                         symbol_conf.use_callchain = false;
 647         }
 648
 649         /*
 650          * set default for tracepoints to print symbols only
 651          * if callchains are present
 652          */
 653         if (symbol_conf.use_callchain &&
 654             !output[PERF_TYPE_TRACEPOINT].user_set) {
 655                 j = PERF_TYPE_TRACEPOINT;
 656
 657                 evlist__for_each_entry(session->evlist, evsel) {
 658                         if (evsel->core.attr.type != j)
 659                                 continue;
 660
 661                         if (evsel__has_callchain(evsel)) {
 662                                 output[j].fields |= PERF_OUTPUT_IP;
 663                                 output[j].fields |= PERF_OUTPUT_SYM;
 664                                 output[j].fields |= PERF_OUTPUT_SYMOFFSET;
 665                                 output[j].fields |= PERF_OUTPUT_DSO;
 666                                 set_print_ip_opts(&evsel->core.attr);
 667                                 goto out;
 668                         }
 669                 }
 670         }
 671
 672         if (tod && !session->header.env.clock.enabled) {
 673                 pr_err("Can't provide 'tod' time, missing clock data. "
 674                        "Please record with -k/--clockid option.\n");
 675                 return -1;
 676         }
 677 out:
 678         return 0;
 679 }
 680
 681 static int perf_sample__fprintf_regs(struct regs_dump *regs, uint64_t mask, const char *arch,
 682                                      FILE *fp)
 683 {
 684         unsigned i = 0, r;
 685         int printed = 0;
 686
 687         if (!regs || !regs->regs)
 688                 return 0;
 689
 690         printed += fprintf(fp, " ABI:%" PRIu64 " ", regs->abi);
 691
 692         for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
 693                 u64 val = regs->regs[i++];
 694                 printed += fprintf(fp, "%5s:0x%"PRIx64" ", perf_reg_name(r, arch), val);
 695         }
 696
 697         return printed;
 698 }
 699
 700 #define DEFAULT_TOD_FMT "%F %H:%M:%S"
 701
 702 static char*
 703 tod_scnprintf(struct perf_script *script, char *buf, int buflen,
 704              u64 timestamp)
 705 {
 706         u64 tod_ns, clockid_ns;
 707         struct perf_env *env;
 708         unsigned long nsec;
 709         struct tm ltime;
 710         char date[64];
 711         time_t sec;
 712
 713         buf[0] = '\0';
 714         if (buflen < 64 || !script)
 715                 return buf;
 716
 717         env = &script->session->header.env;
 718         if (!env->clock.enabled) {
 719                 scnprintf(buf, buflen, "disabled");
 720                 return buf;
 721         }
 722
 723         clockid_ns = env->clock.clockid_ns;
 724         tod_ns     = env->clock.tod_ns;
 725
 726         if (timestamp > clockid_ns)
 727                 tod_ns += timestamp - clockid_ns;
 728         else
 729                 tod_ns -= clockid_ns - timestamp;
 730
 731         sec  = (time_t) (tod_ns / NSEC_PER_SEC);
 732         nsec = tod_ns - sec * NSEC_PER_SEC;
 733
 734         if (localtime_r(&sec, &ltime) == NULL) {
 735                 scnprintf(buf, buflen, "failed");
 736         } else {
 737                 strftime(date, sizeof(date), DEFAULT_TOD_FMT, &ltime);
 738
 739                 if (symbol_conf.nanosecs) {
 740                         snprintf(buf, buflen, "%s.%09lu", date, nsec);
 741                 } else {
 742                         snprintf(buf, buflen, "%s.%06lu",
 743                                  date, nsec / NSEC_PER_USEC);
 744                 }
 745         }
 746
 747         return buf;
 748 }
 749
 750 static int perf_sample__fprintf_iregs(struct perf_sample *sample,
 751                                       struct perf_event_attr *attr, const char *arch, FILE *fp)
 752 {
 753         return perf_sample__fprintf_regs(&sample->intr_regs,
 754                                          attr->sample_regs_intr, arch, fp);
 755 }
 756
 757 static int perf_sample__fprintf_uregs(struct perf_sample *sample,
 758                                       struct perf_event_attr *attr, const char *arch, FILE *fp)
 759 {
 760         return perf_sample__fprintf_regs(&sample->user_regs,
 761                                          attr->sample_regs_user, arch, fp);
 762 }
 763
 764 static int perf_sample__fprintf_start(struct perf_script *script,
 765                                       struct perf_sample *sample,
 766                                       struct thread *thread,
 767                                       struct evsel *evsel,
 768                                       u32 type, FILE *fp)
 769 {
 770         struct perf_event_attr *attr = &evsel->core.attr;
 771         unsigned long secs;
 772         unsigned long long nsecs;
 773         int printed = 0;
 774         char tstr[128];
 775
 776         if (PRINT_FIELD(MACHINE_PID) && sample->machine_pid)
 777                 printed += fprintf(fp, "VM:%5d ", sample->machine_pid);
 778
 779         /* Print VCPU only for guest events i.e. with machine_pid */
 780         if (PRINT_FIELD(VCPU) && sample->machine_pid)
 781                 printed += fprintf(fp, "VCPU:%03d ", sample->vcpu);
 782
 783         if (PRINT_FIELD(COMM)) {
 784                 const char *comm = thread ? thread__comm_str(thread) : ":-1";
 785
 786                 if (latency_format)
 787                         printed += fprintf(fp, "%8.8s ", comm);
 788                 else if (PRINT_FIELD(IP) && evsel__has_callchain(evsel) && symbol_conf.use_callchain)
 789                         printed += fprintf(fp, "%s ", comm);
 790                 else
 791                         printed += fprintf(fp, "%16s ", comm);
 792         }
 793
 794         if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
 795                 printed += fprintf(fp, "%5d/%-5d ", sample->pid, sample->tid);
 796         else if (PRINT_FIELD(PID))
 797                 printed += fprintf(fp, "%5d ", sample->pid);
 798         else if (PRINT_FIELD(TID))
 799                 printed += fprintf(fp, "%5d ", sample->tid);
 800
 801         if (PRINT_FIELD(CPU)) {
 802                 if (latency_format)
 803                         printed += fprintf(fp, "%3d ", sample->cpu);
 804                 else
 805                         printed += fprintf(fp, "[%03d] ", sample->cpu);
 806         }
 807
 808         if (PRINT_FIELD(MISC)) {
 809                 int ret = 0;
 810
 811                 #define has(m) \
 812                         (sample->misc & PERF_RECORD_MISC_##m) == PERF_RECORD_MISC_##m
 813
 814                 if (has(KERNEL))
 815                         ret += fprintf(fp, "K");
 816                 if (has(USER))
 817                         ret += fprintf(fp, "U");
 818                 if (has(HYPERVISOR))
 819                         ret += fprintf(fp, "H");
 820                 if (has(GUEST_KERNEL))
 821                         ret += fprintf(fp, "G");
 822                 if (has(GUEST_USER))
 823                         ret += fprintf(fp, "g");
 824
 825                 switch (type) {
 826                 case PERF_RECORD_MMAP:
 827                 case PERF_RECORD_MMAP2:
 828                         if (has(MMAP_DATA))
 829                                 ret += fprintf(fp, "M");
 830                         break;
 831                 case PERF_RECORD_COMM:
 832                         if (has(COMM_EXEC))
 833                                 ret += fprintf(fp, "E");
 834                         break;
 835                 case PERF_RECORD_SWITCH:
 836                 case PERF_RECORD_SWITCH_CPU_WIDE:
 837                         if (has(SWITCH_OUT)) {
 838                                 ret += fprintf(fp, "S");
 839                                 if (sample->misc & PERF_RECORD_MISC_SWITCH_OUT_PREEMPT)
 840                                         ret += fprintf(fp, "p");
 841                         }
 842                 default:
 843                         break;
 844                 }
 845
 846                 #undef has
 847
 848                 ret += fprintf(fp, "%*s", 6 - ret, " ");
 849                 printed += ret;
 850         }
 851
 852         if (PRINT_FIELD(TOD)) {
 853                 tod_scnprintf(script, tstr, sizeof(tstr), sample->time);
 854                 printed += fprintf(fp, "%s ", tstr);
 855         }
 856
 857         if (PRINT_FIELD(TIME)) {
 858                 u64 t = sample->time;
 859                 if (reltime) {
 860                         if (!initial_time)
 861                                 initial_time = sample->time;
 862                         t = sample->time - initial_time;
 863                 } else if (deltatime) {
 864                         if (previous_time)
 865                                 t = sample->time - previous_time;
 866                         else {
 867                                 t = 0;
 868                         }
 869                         previous_time = sample->time;
 870                 }
 871                 nsecs = t;
 872                 secs = nsecs / NSEC_PER_SEC;
 873                 nsecs -= secs * NSEC_PER_SEC;
 874
 875                 if (symbol_conf.nanosecs)
 876                         printed += fprintf(fp, "%5lu.%09llu: ", secs, nsecs);
 877                 else {
 878                         char sample_time[32];
 879                         timestamp__scnprintf_usec(t, sample_time, sizeof(sample_time));
 880                         printed += fprintf(fp, "%12s: ", sample_time);
 881                 }
 882         }
 883
 884         return printed;
 885 }
 886
 887 static inline char
 888 mispred_str(struct branch_entry *br)
 889 {
 890         if (!(br->flags.mispred  || br->flags.predicted))
 891                 return '-';
 892
 893         return br->flags.predicted ? 'P' : 'M';
 894 }
 895
 896 static int print_bstack_flags(FILE *fp, struct branch_entry *br)
 897 {
 898         return fprintf(fp, "/%c/%c/%c/%d/%s/%s ",
 899                        mispred_str(br),
 900                        br->flags.in_tx ? 'X' : '-',
 901                        br->flags.abort ? 'A' : '-',
 902                        br->flags.cycles,
 903                        get_branch_type(br),
 904                        br->flags.spec ? branch_spec_desc(br->flags.spec) : "-");
 905 }
 906
 907 static int perf_sample__fprintf_brstack(struct perf_sample *sample,
 908                                         struct thread *thread,
 909                                         struct perf_event_attr *attr, FILE *fp)
 910 {
 911         struct branch_stack *br = sample->branch_stack;
 912         struct branch_entry *entries = perf_sample__branch_entries(sample);
 913         struct addr_location alf, alt;
 914         u64 i, from, to;
 915         int printed = 0;
 916
 917         if (!(br && br->nr))
 918                 return 0;
 919
 920         for (i = 0; i < br->nr; i++) {
 921                 from = entries[i].from;
 922                 to   = entries[i].to;
 923
 924                 if (PRINT_FIELD(DSO)) {
 925                         memset(&alf, 0, sizeof(alf));
 926                         memset(&alt, 0, sizeof(alt));
 927                         thread__find_map_fb(thread, sample->cpumode, from, &alf);
 928                         thread__find_map_fb(thread, sample->cpumode, to, &alt);
 929                 }
 930
 931                 printed += fprintf(fp, " 0x%"PRIx64, from);
 932                 if (PRINT_FIELD(DSO)) {
 933                         printed += fprintf(fp, "(");
 934                         printed += map__fprintf_dsoname(alf.map, fp);
 935                         printed += fprintf(fp, ")");
 936                 }
 937
 938                 printed += fprintf(fp, "/0x%"PRIx64, to);
 939                 if (PRINT_FIELD(DSO)) {
 940                         printed += fprintf(fp, "(");
 941                         printed += map__fprintf_dsoname(alt.map, fp);
 942                         printed += fprintf(fp, ")");
 943                 }
 944
 945                 printed += print_bstack_flags(fp, entries + i);
 946         }
 947
 948         return printed;
 949 }
 950
 951 static int perf_sample__fprintf_brstacksym(struct perf_sample *sample,
 952                                            struct thread *thread,
 953                                            struct perf_event_attr *attr, FILE *fp)
 954 {
 955         struct branch_stack *br = sample->branch_stack;
 956         struct branch_entry *entries = perf_sample__branch_entries(sample);
 957         struct addr_location alf, alt;
 958         u64 i, from, to;
 959         int printed = 0;
 960
 961         if (!(br && br->nr))
 962                 return 0;
 963
 964         for (i = 0; i < br->nr; i++) {
 965
 966                 memset(&alf, 0, sizeof(alf));
 967                 memset(&alt, 0, sizeof(alt));
 968                 from = entries[i].from;
 969                 to   = entries[i].to;
 970
 971                 thread__find_symbol_fb(thread, sample->cpumode, from, &alf);
 972                 thread__find_symbol_fb(thread, sample->cpumode, to, &alt);
 973
 974                 printed += symbol__fprintf_symname_offs(alf.sym, &alf, fp);
 975                 if (PRINT_FIELD(DSO)) {
 976                         printed += fprintf(fp, "(");
 977                         printed += map__fprintf_dsoname(alf.map, fp);
 978                         printed += fprintf(fp, ")");
 979                 }
 980                 printed += fprintf(fp, "%c", '/');
 981                 printed += symbol__fprintf_symname_offs(alt.sym, &alt, fp);
 982                 if (PRINT_FIELD(DSO)) {
 983                         printed += fprintf(fp, "(");
 984                         printed += map__fprintf_dsoname(alt.map, fp);
 985                         printed += fprintf(fp, ")");
 986                 }
 987                 printed += print_bstack_flags(fp, entries + i);
 988         }
 989
 990         return printed;
 991 }
 992
 993 static int perf_sample__fprintf_brstackoff(struct perf_sample *sample,
 994                                            struct thread *thread,
 995                                            struct perf_event_attr *attr, FILE *fp)
 996 {
 997         struct branch_stack *br = sample->branch_stack;
 998         struct branch_entry *entries = perf_sample__branch_entries(sample);
 999         struct addr_location alf, alt;
1000         u64 i, from, to;
1001         int printed = 0;
1002
1003         if (!(br && br->nr))
1004                 return 0;
1005
1006         for (i = 0; i < br->nr; i++) {
1007
1008                 memset(&alf, 0, sizeof(alf));
1009                 memset(&alt, 0, sizeof(alt));
1010                 from = entries[i].from;
1011                 to   = entries[i].to;
1012
1013                 if (thread__find_map_fb(thread, sample->cpumode, from, &alf) &&
1014                     !map__dso(alf.map)->adjust_symbols)
1015                         from = map__dso_map_ip(alf.map, from);
1016
1017                 if (thread__find_map_fb(thread, sample->cpumode, to, &alt) &&
1018                     !map__dso(alt.map)->adjust_symbols)
1019                         to = map__dso_map_ip(alt.map, to);
1020
1021                 printed += fprintf(fp, " 0x%"PRIx64, from);
1022                 if (PRINT_FIELD(DSO)) {
1023                         printed += fprintf(fp, "(");
1024                         printed += map__fprintf_dsoname(alf.map, fp);
1025                         printed += fprintf(fp, ")");
1026                 }
1027                 printed += fprintf(fp, "/0x%"PRIx64, to);
1028                 if (PRINT_FIELD(DSO)) {
1029                         printed += fprintf(fp, "(");
1030                         printed += map__fprintf_dsoname(alt.map, fp);
1031                         printed += fprintf(fp, ")");
1032                 }
1033                 printed += print_bstack_flags(fp, entries + i);
1034         }
1035
1036         return printed;
1037 }
1038 #define MAXBB 16384UL
1039
1040 static int grab_bb(u8 *buffer, u64 start, u64 end,
1041                     struct machine *machine, struct thread *thread,
1042                     bool *is64bit, u8 *cpumode, bool last)
1043 {
1044         long offset, len;
1045         struct addr_location al;
1046         bool kernel;
1047         struct dso *dso;
1048
1049         if (!start || !end)
1050                 return 0;
1051
1052         kernel = machine__kernel_ip(machine, start);
1053         if (kernel)
1054                 *cpumode = PERF_RECORD_MISC_KERNEL;
1055         else
1056                 *cpumode = PERF_RECORD_MISC_USER;
1057
1058         /*
1059          * Block overlaps between kernel and user.
1060          * This can happen due to ring filtering
1061          * On Intel CPUs the entry into the kernel is filtered,
1062          * but the exit is not. Let the caller patch it up.
1063          */
1064         if (kernel != machine__kernel_ip(machine, end)) {
1065                 pr_debug("\tblock %" PRIx64 "-%" PRIx64 " transfers between kernel and user\n", start, end);
1066                 return -ENXIO;
1067         }
1068
1069         memset(&al, 0, sizeof(al));
1070         if (end - start > MAXBB - MAXINSN) {
1071                 if (last)
1072                         pr_debug("\tbrstack does not reach to final jump (%" PRIx64 "-%" PRIx64 ")\n", start, end);
1073                 else
1074                         pr_debug("\tblock %" PRIx64 "-%" PRIx64 " (%" PRIu64 ") too long to dump\n", start, end, end - start);
1075                 return 0;
1076         }
1077
1078         if (!thread__find_map(thread, *cpumode, start, &al) || (dso = map__dso(al.map)) == NULL) {
1079                 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1080                 return 0;
1081         }
1082         if (dso->data.status == DSO_DATA_STATUS_ERROR) {
1083                 pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1084                 return 0;
1085         }
1086
1087         /* Load maps to ensure dso->is_64_bit has been updated */
1088         map__load(al.map);
1089
1090         offset = map__map_ip(al.map, start);
1091         len = dso__data_read_offset(dso, machine, offset, (u8 *)buffer,
1092                                     end - start + MAXINSN);
1093
1094         *is64bit = dso->is_64_bit;
1095         if (len <= 0)
1096                 pr_debug("\tcannot fetch code for block at %" PRIx64 "-%" PRIx64 "\n",
1097                         start, end);
1098         return len;
1099 }
1100
1101 static int map__fprintf_srccode(struct map *map, u64 addr, FILE *fp, struct srccode_state *state)
1102 {
1103         char *srcfile;
1104         int ret = 0;
1105         unsigned line;
1106         int len;
1107         char *srccode;
1108         struct dso *dso;
1109
1110         if (!map || (dso = map__dso(map)) == NULL)
1111                 return 0;
1112         srcfile = get_srcline_split(dso,
1113                                     map__rip_2objdump(map, addr),
1114                                     &line);
1115         if (!srcfile)
1116                 return 0;
1117
1118         /* Avoid redundant printing */
1119         if (state &&
1120             state->srcfile &&
1121             !strcmp(state->srcfile, srcfile) &&
1122             state->line == line) {
1123                 free(srcfile);
1124                 return 0;
1125         }
1126
1127         srccode = find_sourceline(srcfile, line, &len);
1128         if (!srccode)
1129                 goto out_free_line;
1130
1131         ret = fprintf(fp, "|%-8d %.*s", line, len, srccode);
1132
1133         if (state) {
1134                 state->srcfile = srcfile;
1135                 state->line = line;
1136         }
1137         return ret;
1138
1139 out_free_line:
1140         free(srcfile);
1141         return ret;
1142 }
1143
1144 static int print_srccode(struct thread *thread, u8 cpumode, uint64_t addr)
1145 {
1146         struct addr_location al;
1147         int ret = 0;
1148
1149         memset(&al, 0, sizeof(al));
1150         thread__find_map(thread, cpumode, addr, &al);
1151         if (!al.map)
1152                 return 0;
1153         ret = map__fprintf_srccode(al.map, al.addr, stdout,
1154                     &thread->srccode_state);
1155         if (ret)
1156                 ret += printf("\n");
1157         return ret;
1158 }
1159
1160 static int ip__fprintf_jump(uint64_t ip, struct branch_entry *en,
1161                             struct perf_insn *x, u8 *inbuf, int len,
1162                             int insn, FILE *fp, int *total_cycles,
1163                             struct perf_event_attr *attr)
1164 {
1165         int ilen = 0;
1166         int printed = fprintf(fp, "\t%016" PRIx64 "\t%-30s\t", ip,
1167                               dump_insn(x, ip, inbuf, len, &ilen));
1168
1169         if (PRINT_FIELD(BRSTACKINSNLEN))
1170                 printed += fprintf(fp, "ilen: %d\t", ilen);
1171
1172         printed += fprintf(fp, "#%s%s%s%s",
1173                               en->flags.predicted ? " PRED" : "",
1174                               en->flags.mispred ? " MISPRED" : "",
1175                               en->flags.in_tx ? " INTX" : "",
1176                               en->flags.abort ? " ABORT" : "");
1177         if (en->flags.cycles) {
1178                 *total_cycles += en->flags.cycles;
1179                 printed += fprintf(fp, " %d cycles [%d]", en->flags.cycles, *total_cycles);
1180                 if (insn)
1181                         printed += fprintf(fp, " %.2f IPC", (float)insn / en->flags.cycles);
1182         }
1183         return printed + fprintf(fp, "\n");
1184 }
1185
1186 static int ip__fprintf_sym(uint64_t addr, struct thread *thread,
1187                            u8 cpumode, int cpu, struct symbol **lastsym,
1188                            struct perf_event_attr *attr, FILE *fp)
1189 {
1190         struct addr_location al;
1191         int off, printed = 0;
1192
1193         memset(&al, 0, sizeof(al));
1194
1195         thread__find_map(thread, cpumode, addr, &al);
1196
1197         if ((*lastsym) && al.addr >= (*lastsym)->start && al.addr < (*lastsym)->end)
1198                 return 0;
1199
1200         al.cpu = cpu;
1201         al.sym = NULL;
1202         if (al.map)
1203                 al.sym = map__find_symbol(al.map, al.addr);
1204
1205         if (!al.sym)
1206                 return 0;
1207
1208         if (al.addr < al.sym->end)
1209                 off = al.addr - al.sym->start;
1210         else
1211                 off = al.addr - map__start(al.map) - al.sym->start;
1212         printed += fprintf(fp, "\t%s", al.sym->name);
1213         if (off)
1214                 printed += fprintf(fp, "%+d", off);
1215         printed += fprintf(fp, ":");
1216         if (PRINT_FIELD(SRCLINE))
1217                 printed += map__fprintf_srcline(al.map, al.addr, "\t", fp);
1218         printed += fprintf(fp, "\n");
1219         *lastsym = al.sym;
1220
1221         return printed;
1222 }
1223
1224 static int perf_sample__fprintf_brstackinsn(struct perf_sample *sample,
1225                                             struct thread *thread,
1226                                             struct perf_event_attr *attr,
1227                                             struct machine *machine, FILE *fp)
1228 {
1229         struct branch_stack *br = sample->branch_stack;
1230         struct branch_entry *entries = perf_sample__branch_entries(sample);
1231         u64 start, end;
1232         int i, insn, len, nr, ilen, printed = 0;
1233         struct perf_insn x;
1234         u8 buffer[MAXBB];
1235         unsigned off;
1236         struct symbol *lastsym = NULL;
1237         int total_cycles = 0;
1238
1239         if (!(br && br->nr))
1240                 return 0;
1241         nr = br->nr;
1242         if (max_blocks && nr > max_blocks + 1)
1243                 nr = max_blocks + 1;
1244
1245         x.thread = thread;
1246         x.cpu = sample->cpu;
1247
1248         printed += fprintf(fp, "%c", '\n');
1249
1250         /* Handle first from jump, of which we don't know the entry. */
1251         len = grab_bb(buffer, entries[nr-1].from,
1252                         entries[nr-1].from,
1253                         machine, thread, &x.is64bit, &x.cpumode, false);
1254         if (len > 0) {
1255                 printed += ip__fprintf_sym(entries[nr - 1].from, thread,
1256                                            x.cpumode, x.cpu, &lastsym, attr, fp);
1257                 printed += ip__fprintf_jump(entries[nr - 1].from, &entries[nr - 1],
1258                                             &x, buffer, len, 0, fp, &total_cycles,
1259                                             attr);
1260                 if (PRINT_FIELD(SRCCODE))
1261                         printed += print_srccode(thread, x.cpumode, entries[nr - 1].from);
1262         }
1263
1264         /* Print all blocks */
1265         for (i = nr - 2; i >= 0; i--) {
1266                 if (entries[i].from || entries[i].to)
1267                         pr_debug("%d: %" PRIx64 "-%" PRIx64 "\n", i,
1268                                  entries[i].from,
1269                                  entries[i].to);
1270                 start = entries[i + 1].to;
1271                 end   = entries[i].from;
1272
1273                 len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1274                 /* Patch up missing kernel transfers due to ring filters */
1275                 if (len == -ENXIO && i > 0) {
1276                         end = entries[--i].from;
1277                         pr_debug("\tpatching up to %" PRIx64 "-%" PRIx64 "\n", start, end);
1278                         len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1279                 }
1280                 if (len <= 0)
1281                         continue;
1282
1283                 insn = 0;
1284                 for (off = 0; off < (unsigned)len; off += ilen) {
1285                         uint64_t ip = start + off;
1286
1287                         printed += ip__fprintf_sym(ip, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1288                         if (ip == end) {
1289                                 printed += ip__fprintf_jump(ip, &entries[i], &x, buffer + off, len - off, ++insn, fp,
1290                                                             &total_cycles, attr);
1291                                 if (PRINT_FIELD(SRCCODE))
1292                                         printed += print_srccode(thread, x.cpumode, ip);
1293                                 break;
1294                         } else {
1295                                 ilen = 0;
1296                                 printed += fprintf(fp, "\t%016" PRIx64 "\t%s", ip,
1297                                                    dump_insn(&x, ip, buffer + off, len - off, &ilen));
1298                                 if (PRINT_FIELD(BRSTACKINSNLEN))
1299                                         printed += fprintf(fp, "\tilen: %d", ilen);
1300                                 printed += fprintf(fp, "\n");
1301                                 if (ilen == 0)
1302                                         break;
1303                                 if (PRINT_FIELD(SRCCODE))
1304                                         print_srccode(thread, x.cpumode, ip);
1305                                 insn++;
1306                         }
1307                 }
1308                 if (off != end - start)
1309                         printed += fprintf(fp, "\tmismatch of LBR data and executable\n");
1310         }
1311
1312         /*
1313          * Hit the branch? In this case we are already done, and the target
1314          * has not been executed yet.
1315          */
1316         if (entries[0].from == sample->ip)
1317                 goto out;
1318         if (entries[0].flags.abort)
1319                 goto out;
1320
1321         /*
1322          * Print final block up to sample
1323          *
1324          * Due to pipeline delays the LBRs might be missing a branch
1325          * or two, which can result in very large or negative blocks
1326          * between final branch and sample. When this happens just
1327          * continue walking after the last TO until we hit a branch.
1328          */
1329         start = entries[0].to;
1330         end = sample->ip;
1331         if (end < start) {
1332                 /* Missing jump. Scan 128 bytes for the next branch */
1333                 end = start + 128;
1334         }
1335         len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, true);
1336         printed += ip__fprintf_sym(start, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1337         if (len <= 0) {
1338                 /* Print at least last IP if basic block did not work */
1339                 len = grab_bb(buffer, sample->ip, sample->ip,
1340                               machine, thread, &x.is64bit, &x.cpumode, false);
1341                 if (len <= 0)
1342                         goto out;
1343                 ilen = 0;
1344                 printed += fprintf(fp, "\t%016" PRIx64 "\t%s", sample->ip,
1345                         dump_insn(&x, sample->ip, buffer, len, &ilen));
1346                 if (PRINT_FIELD(BRSTACKINSNLEN))
1347                         printed += fprintf(fp, "\tilen: %d", ilen);
1348                 printed += fprintf(fp, "\n");
1349                 if (PRINT_FIELD(SRCCODE))
1350                         print_srccode(thread, x.cpumode, sample->ip);
1351                 goto out;
1352         }
1353         for (off = 0; off <= end - start; off += ilen) {
1354                 ilen = 0;
1355                 printed += fprintf(fp, "\t%016" PRIx64 "\t%s", start + off,
1356                                    dump_insn(&x, start + off, buffer + off, len - off, &ilen));
1357                 if (PRINT_FIELD(BRSTACKINSNLEN))
1358                         printed += fprintf(fp, "\tilen: %d", ilen);
1359                 printed += fprintf(fp, "\n");
1360                 if (ilen == 0)
1361                         break;
1362                 if (arch_is_branch(buffer + off, len - off, x.is64bit) && start + off != sample->ip) {
1363                         /*
1364                          * Hit a missing branch. Just stop.
1365                          */
1366                         printed += fprintf(fp, "\t... not reaching sample ...\n");
1367                         break;
1368                 }
1369                 if (PRINT_FIELD(SRCCODE))
1370                         print_srccode(thread, x.cpumode, start + off);
1371         }
1372 out:
1373         return printed;
1374 }
1375
1376 static int perf_sample__fprintf_addr(struct perf_sample *sample,
1377                                      struct thread *thread,
1378                                      struct perf_event_attr *attr, FILE *fp)
1379 {
1380         struct addr_location al;
1381         int printed = fprintf(fp, "%16" PRIx64, sample->addr);
1382
1383         if (!sample_addr_correlates_sym(attr))
1384                 goto out;
1385
1386         thread__resolve(thread, &al, sample);
1387
1388         if (PRINT_FIELD(SYM)) {
1389                 printed += fprintf(fp, " ");
1390                 if (PRINT_FIELD(SYMOFFSET))
1391                         printed += symbol__fprintf_symname_offs(al.sym, &al, fp);
1392                 else
1393                         printed += symbol__fprintf_symname(al.sym, fp);
1394         }
1395
1396         if (PRINT_FIELD(DSO)) {
1397                 printed += fprintf(fp, " (");
1398                 printed += map__fprintf_dsoname(al.map, fp);
1399                 printed += fprintf(fp, ")");
1400         }
1401 out:
1402         return printed;
1403 }
1404
1405 static const char *resolve_branch_sym(struct perf_sample *sample,
1406                                       struct evsel *evsel,
1407                                       struct thread *thread,
1408                                       struct addr_location *al,
1409                                       struct addr_location *addr_al,
1410                                       u64 *ip)
1411 {
1412         struct perf_event_attr *attr = &evsel->core.attr;
1413         const char *name = NULL;
1414
1415         if (sample->flags & (PERF_IP_FLAG_CALL | PERF_IP_FLAG_TRACE_BEGIN)) {
1416                 if (sample_addr_correlates_sym(attr)) {
1417                         if (!addr_al->thread)
1418                                 thread__resolve(thread, addr_al, sample);
1419                         if (addr_al->sym)
1420                                 name = addr_al->sym->name;
1421                         else
1422                                 *ip = sample->addr;
1423                 } else {
1424                         *ip = sample->addr;
1425                 }
1426         } else if (sample->flags & (PERF_IP_FLAG_RETURN | PERF_IP_FLAG_TRACE_END)) {
1427                 if (al->sym)
1428                         name = al->sym->name;
1429                 else
1430                         *ip = sample->ip;
1431         }
1432         return name;
1433 }
1434
1435 static int perf_sample__fprintf_callindent(struct perf_sample *sample,
1436                                            struct evsel *evsel,
1437                                            struct thread *thread,
1438                                            struct addr_location *al,
1439                                            struct addr_location *addr_al,
1440                                            FILE *fp)
1441 {
1442         struct perf_event_attr *attr = &evsel->core.attr;
1443         size_t depth = thread_stack__depth(thread, sample->cpu);
1444         const char *name = NULL;
1445         static int spacing;
1446         int len = 0;
1447         int dlen = 0;
1448         u64 ip = 0;
1449
1450         /*
1451          * The 'return' has already been popped off the stack so the depth has
1452          * to be adjusted to match the 'call'.
1453          */
1454         if (thread->ts && sample->flags & PERF_IP_FLAG_RETURN)
1455                 depth += 1;
1456
1457         name = resolve_branch_sym(sample, evsel, thread, al, addr_al, &ip);
1458
1459         if (PRINT_FIELD(DSO) && !(PRINT_FIELD(IP) || PRINT_FIELD(ADDR))) {
1460                 dlen += fprintf(fp, "(");
1461                 dlen += map__fprintf_dsoname(al->map, fp);
1462                 dlen += fprintf(fp, ")\t");
1463         }
1464
1465         if (name)
1466                 len = fprintf(fp, "%*s%s", (int)depth * 4, "", name);
1467         else if (ip)
1468                 len = fprintf(fp, "%*s%16" PRIx64, (int)depth * 4, "", ip);
1469
1470         if (len < 0)
1471                 return len;
1472
1473         /*
1474          * Try to keep the output length from changing frequently so that the
1475          * output lines up more nicely.
1476          */
1477         if (len > spacing || (len && len < spacing - 52))
1478                 spacing = round_up(len + 4, 32);
1479
1480         if (len < spacing)
1481                 len += fprintf(fp, "%*s", spacing - len, "");
1482
1483         return len + dlen;
1484 }
1485
1486 __weak void arch_fetch_insn(struct perf_sample *sample __maybe_unused,
1487                             struct thread *thread __maybe_unused,
1488                             struct machine *machine __maybe_unused)
1489 {
1490 }
1491
1492 void script_fetch_insn(struct perf_sample *sample, struct thread *thread,
1493                        struct machine *machine)
1494 {
1495         if (sample->insn_len == 0 && native_arch)
1496                 arch_fetch_insn(sample, thread, machine);
1497 }
1498
1499 static int perf_sample__fprintf_insn(struct perf_sample *sample,
1500                                      struct perf_event_attr *attr,
1501                                      struct thread *thread,
1502                                      struct machine *machine, FILE *fp)
1503 {
1504         int printed = 0;
1505
1506         script_fetch_insn(sample, thread, machine);
1507
1508         if (PRINT_FIELD(INSNLEN))
1509                 printed += fprintf(fp, " ilen: %d", sample->insn_len);
1510         if (PRINT_FIELD(INSN) && sample->insn_len) {
1511                 int i;
1512
1513                 printed += fprintf(fp, " insn:");
1514                 for (i = 0; i < sample->insn_len; i++)
1515                         printed += fprintf(fp, " %02x", (unsigned char)sample->insn[i]);
1516         }
1517         if (PRINT_FIELD(BRSTACKINSN) || PRINT_FIELD(BRSTACKINSNLEN))
1518                 printed += perf_sample__fprintf_brstackinsn(sample, thread, attr, machine, fp);
1519
1520         return printed;
1521 }
1522
1523 static int perf_sample__fprintf_ipc(struct perf_sample *sample,
1524                                     struct perf_event_attr *attr, FILE *fp)
1525 {
1526         unsigned int ipc;
1527
1528         if (!PRINT_FIELD(IPC) || !sample->cyc_cnt || !sample->insn_cnt)
1529                 return 0;
1530
1531         ipc = (sample->insn_cnt * 100) / sample->cyc_cnt;
1532
1533         return fprintf(fp, " \t IPC: %u.%02u (%" PRIu64 "/%" PRIu64 ") ",
1534                        ipc / 100, ipc % 100, sample->insn_cnt, sample->cyc_cnt);
1535 }
1536
1537 static int perf_sample__fprintf_bts(struct perf_sample *sample,
1538                                     struct evsel *evsel,
1539                                     struct thread *thread,
1540                                     struct addr_location *al,
1541                                     struct addr_location *addr_al,
1542                                     struct machine *machine, FILE *fp)
1543 {
1544         struct perf_event_attr *attr = &evsel->core.attr;
1545         unsigned int type = output_type(attr->type);
1546         bool print_srcline_last = false;
1547         int printed = 0;
1548
1549         if (PRINT_FIELD(CALLINDENT))
1550                 printed += perf_sample__fprintf_callindent(sample, evsel, thread, al, addr_al, fp);
1551
1552         /* print branch_from information */
1553         if (PRINT_FIELD(IP)) {
1554                 unsigned int print_opts = output[type].print_ip_opts;
1555                 struct callchain_cursor *cursor = NULL;
1556
1557                 if (symbol_conf.use_callchain && sample->callchain &&
1558                     thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1559                                               sample, NULL, NULL, scripting_max_stack) == 0)
1560                         cursor = &callchain_cursor;
1561
1562                 if (cursor == NULL) {
1563                         printed += fprintf(fp, " ");
1564                         if (print_opts & EVSEL__PRINT_SRCLINE) {
1565                                 print_srcline_last = true;
1566                                 print_opts &= ~EVSEL__PRINT_SRCLINE;
1567                         }
1568                 } else
1569                         printed += fprintf(fp, "\n");
1570
1571                 printed += sample__fprintf_sym(sample, al, 0, print_opts, cursor,
1572                                                symbol_conf.bt_stop_list, fp);
1573         }
1574
1575         /* print branch_to information */
1576         if (PRINT_FIELD(ADDR) ||
1577             ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
1578              !output[type].user_set)) {
1579                 printed += fprintf(fp, " => ");
1580                 printed += perf_sample__fprintf_addr(sample, thread, attr, fp);
1581         }
1582
1583         printed += perf_sample__fprintf_ipc(sample, attr, fp);
1584
1585         if (print_srcline_last)
1586                 printed += map__fprintf_srcline(al->map, al->addr, "\n  ", fp);
1587
1588         printed += perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
1589         printed += fprintf(fp, "\n");
1590         if (PRINT_FIELD(SRCCODE)) {
1591                 int ret = map__fprintf_srccode(al->map, al->addr, stdout,
1592                                          &thread->srccode_state);
1593                 if (ret) {
1594                         printed += ret;
1595                         printed += printf("\n");
1596                 }
1597         }
1598         return printed;
1599 }
1600
1601 static struct {
1602         u32 flags;
1603         const char *name;
1604 } sample_flags[] = {
1605         {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL, "call"},
1606         {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN, "return"},
1607         {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CONDITIONAL, "jcc"},
1608         {PERF_IP_FLAG_BRANCH, "jmp"},
1609         {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_INTERRUPT, "int"},
1610         {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_INTERRUPT, "iret"},
1611         {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_SYSCALLRET, "syscall"},
1612         {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_SYSCALLRET, "sysret"},
1613         {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_ASYNC, "async"},
1614         {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_ASYNC | PERF_IP_FLAG_INTERRUPT, "hw int"},
1615         {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TX_ABORT, "tx abrt"},
1616         {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_BEGIN, "tr strt"},
1617         {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_END, "tr end"},
1618         {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_VMENTRY, "vmentry"},
1619         {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_VMEXIT, "vmexit"},
1620         {0, NULL}
1621 };
1622
1623 static const char *sample_flags_to_name(u32 flags)
1624 {
1625         int i;
1626
1627         for (i = 0; sample_flags[i].name ; i++) {
1628                 if (sample_flags[i].flags == flags)
1629                         return sample_flags[i].name;
1630         }
1631
1632         return NULL;
1633 }
1634
1635 int perf_sample__sprintf_flags(u32 flags, char *str, size_t sz)
1636 {
1637         u32 xf = PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_INTR_DISABLE |
1638                  PERF_IP_FLAG_INTR_TOGGLE;
1639         const char *chars = PERF_IP_FLAG_CHARS;
1640         const size_t n = strlen(PERF_IP_FLAG_CHARS);
1641         const char *name = NULL;
1642         size_t i, pos = 0;
1643         char xs[16] = {0};
1644
1645         if (flags & xf)
1646                 snprintf(xs, sizeof(xs), "(%s%s%s)",
1647                          flags & PERF_IP_FLAG_IN_TX ? "x" : "",
1648                          flags & PERF_IP_FLAG_INTR_DISABLE ? "D" : "",
1649                          flags & PERF_IP_FLAG_INTR_TOGGLE ? "t" : "");
1650
1651         name = sample_flags_to_name(flags & ~xf);
1652         if (name)
1653                 return snprintf(str, sz, "%-15s%6s", name, xs);
1654
1655         if (flags & PERF_IP_FLAG_TRACE_BEGIN) {
1656                 name = sample_flags_to_name(flags & ~(xf | PERF_IP_FLAG_TRACE_BEGIN));
1657                 if (name)
1658                         return snprintf(str, sz, "tr strt %-7s%6s", name, xs);
1659         }
1660
1661         if (flags & PERF_IP_FLAG_TRACE_END) {
1662                 name = sample_flags_to_name(flags & ~(xf | PERF_IP_FLAG_TRACE_END));
1663                 if (name)
1664                         return snprintf(str, sz, "tr end  %-7s%6s", name, xs);
1665         }
1666
1667         for (i = 0; i < n; i++, flags >>= 1) {
1668                 if ((flags & 1) && pos < sz)
1669                         str[pos++] = chars[i];
1670         }
1671         for (; i < 32; i++, flags >>= 1) {
1672                 if ((flags & 1) && pos < sz)
1673                         str[pos++] = '?';
1674         }
1675         if (pos < sz)
1676                 str[pos] = 0;
1677
1678         return pos;
1679 }
1680
1681 static int perf_sample__fprintf_flags(u32 flags, FILE *fp)
1682 {
1683         char str[SAMPLE_FLAGS_BUF_SIZE];
1684
1685         perf_sample__sprintf_flags(flags, str, sizeof(str));
1686         return fprintf(fp, "  %-21s ", str);
1687 }
1688
1689 struct printer_data {
1690         int line_no;
1691         bool hit_nul;
1692         bool is_printable;
1693 };
1694
1695 static int sample__fprintf_bpf_output(enum binary_printer_ops op,
1696                                       unsigned int val,
1697                                       void *extra, FILE *fp)
1698 {
1699         unsigned char ch = (unsigned char)val;
1700         struct printer_data *printer_data = extra;
1701         int printed = 0;
1702
1703         switch (op) {
1704         case BINARY_PRINT_DATA_BEGIN:
1705                 printed += fprintf(fp, "\n");
1706                 break;
1707         case BINARY_PRINT_LINE_BEGIN:
1708                 printed += fprintf(fp, "%17s", !printer_data->line_no ? "BPF output:" :
1709                                                         "           ");
1710                 break;
1711         case BINARY_PRINT_ADDR:
1712                 printed += fprintf(fp, " %04x:", val);
1713                 break;
1714         case BINARY_PRINT_NUM_DATA:
1715                 printed += fprintf(fp, " %02x", val);
1716                 break;
1717         case BINARY_PRINT_NUM_PAD:
1718                 printed += fprintf(fp, "   ");
1719                 break;
1720         case BINARY_PRINT_SEP:
1721                 printed += fprintf(fp, "  ");
1722                 break;
1723         case BINARY_PRINT_CHAR_DATA:
1724                 if (printer_data->hit_nul && ch)
1725                         printer_data->is_printable = false;
1726
1727                 if (!isprint(ch)) {
1728                         printed += fprintf(fp, "%c", '.');
1729
1730                         if (!printer_data->is_printable)
1731                                 break;
1732
1733                         if (ch == '\0')
1734                                 printer_data->hit_nul = true;
1735                         else
1736                                 printer_data->is_printable = false;
1737                 } else {
1738                         printed += fprintf(fp, "%c", ch);
1739                 }
1740                 break;
1741         case BINARY_PRINT_CHAR_PAD:
1742                 printed += fprintf(fp, " ");
1743                 break;
1744         case BINARY_PRINT_LINE_END:
1745                 printed += fprintf(fp, "\n");
1746                 printer_data->line_no++;
1747                 break;
1748         case BINARY_PRINT_DATA_END:
1749         default:
1750                 break;
1751         }
1752
1753         return printed;
1754 }
1755
1756 static int perf_sample__fprintf_bpf_output(struct perf_sample *sample, FILE *fp)
1757 {
1758         unsigned int nr_bytes = sample->raw_size;
1759         struct printer_data printer_data = {0, false, true};
1760         int printed = binary__fprintf(sample->raw_data, nr_bytes, 8,
1761                                       sample__fprintf_bpf_output, &printer_data, fp);
1762
1763         if (printer_data.is_printable && printer_data.hit_nul)
1764                 printed += fprintf(fp, "%17s \"%s\"\n", "BPF string:", (char *)(sample->raw_data));
1765
1766         return printed;
1767 }
1768
1769 static int perf_sample__fprintf_spacing(int len, int spacing, FILE *fp)
1770 {
1771         if (len > 0 && len < spacing)
1772                 return fprintf(fp, "%*s", spacing - len, "");
1773
1774         return 0;
1775 }
1776
1777 static int perf_sample__fprintf_pt_spacing(int len, FILE *fp)
1778 {
1779         return perf_sample__fprintf_spacing(len, 34, fp);
1780 }
1781
1782 /* If a value contains only printable ASCII characters padded with NULLs */
1783 static bool ptw_is_prt(u64 val)
1784 {
1785         char c;
1786         u32 i;
1787
1788         for (i = 0; i < sizeof(val); i++) {
1789                 c = ((char *)&val)[i];
1790                 if (!c)
1791                         break;
1792                 if (!isprint(c) || !isascii(c))
1793                         return false;
1794         }
1795         for (; i < sizeof(val); i++) {
1796                 c = ((char *)&val)[i];
1797                 if (c)
1798                         return false;
1799         }
1800         return true;
1801 }
1802
1803 static int perf_sample__fprintf_synth_ptwrite(struct perf_sample *sample, FILE *fp)
1804 {
1805         struct perf_synth_intel_ptwrite *data = perf_sample__synth_ptr(sample);
1806         char str[sizeof(u64) + 1] = "";
1807         int len;
1808         u64 val;
1809
1810         if (perf_sample__bad_synth_size(sample, *data))
1811                 return 0;
1812
1813         val = le64_to_cpu(data->payload);
1814         if (ptw_is_prt(val)) {
1815                 memcpy(str, &val, sizeof(val));
1816                 str[sizeof(val)] = 0;
1817         }
1818         len = fprintf(fp, " IP: %u payload: %#" PRIx64 " %s ",
1819                       data->ip, val, str);
1820         return len + perf_sample__fprintf_pt_spacing(len, fp);
1821 }
1822
1823 static int perf_sample__fprintf_synth_mwait(struct perf_sample *sample, FILE *fp)
1824 {
1825         struct perf_synth_intel_mwait *data = perf_sample__synth_ptr(sample);
1826         int len;
1827
1828         if (perf_sample__bad_synth_size(sample, *data))
1829                 return 0;
1830
1831         len = fprintf(fp, " hints: %#x extensions: %#x ",
1832                       data->hints, data->extensions);
1833         return len + perf_sample__fprintf_pt_spacing(len, fp);
1834 }
1835
1836 static int perf_sample__fprintf_synth_pwre(struct perf_sample *sample, FILE *fp)
1837 {
1838         struct perf_synth_intel_pwre *data = perf_sample__synth_ptr(sample);
1839         int len;
1840
1841         if (perf_sample__bad_synth_size(sample, *data))
1842                 return 0;
1843
1844         len = fprintf(fp, " hw: %u cstate: %u sub-cstate: %u ",
1845                       data->hw, data->cstate, data->subcstate);
1846         return len + perf_sample__fprintf_pt_spacing(len, fp);
1847 }
1848
1849 static int perf_sample__fprintf_synth_exstop(struct perf_sample *sample, FILE *fp)
1850 {
1851         struct perf_synth_intel_exstop *data = perf_sample__synth_ptr(sample);
1852         int len;
1853
1854         if (perf_sample__bad_synth_size(sample, *data))
1855                 return 0;
1856
1857         len = fprintf(fp, " IP: %u ", data->ip);
1858         return len + perf_sample__fprintf_pt_spacing(len, fp);
1859 }
1860
1861 static int perf_sample__fprintf_synth_pwrx(struct perf_sample *sample, FILE *fp)
1862 {
1863         struct perf_synth_intel_pwrx *data = perf_sample__synth_ptr(sample);
1864         int len;
1865
1866         if (perf_sample__bad_synth_size(sample, *data))
1867                 return 0;
1868
1869         len = fprintf(fp, " deepest cstate: %u last cstate: %u wake reason: %#x ",
1870                      data->deepest_cstate, data->last_cstate,
1871                      data->wake_reason);
1872         return len + perf_sample__fprintf_pt_spacing(len, fp);
1873 }
1874
1875 static int perf_sample__fprintf_synth_cbr(struct perf_sample *sample, FILE *fp)
1876 {
1877         struct perf_synth_intel_cbr *data = perf_sample__synth_ptr(sample);
1878         unsigned int percent, freq;
1879         int len;
1880
1881         if (perf_sample__bad_synth_size(sample, *data))
1882                 return 0;
1883
1884         freq = (le32_to_cpu(data->freq) + 500) / 1000;
1885         len = fprintf(fp, " cbr: %2u freq: %4u MHz ", data->cbr, freq);
1886         if (data->max_nonturbo) {
1887                 percent = (5 + (1000 * data->cbr) / data->max_nonturbo) / 10;
1888                 len += fprintf(fp, "(%3u%%) ", percent);
1889         }
1890         return len + perf_sample__fprintf_pt_spacing(len, fp);
1891 }
1892
1893 static int perf_sample__fprintf_synth_psb(struct perf_sample *sample, FILE *fp)
1894 {
1895         struct perf_synth_intel_psb *data = perf_sample__synth_ptr(sample);
1896         int len;
1897
1898         if (perf_sample__bad_synth_size(sample, *data))
1899                 return 0;
1900
1901         len = fprintf(fp, " psb offs: %#" PRIx64, data->offset);
1902         return len + perf_sample__fprintf_pt_spacing(len, fp);
1903 }
1904
1905 /* Intel PT Event Trace */
1906 static int perf_sample__fprintf_synth_evt(struct perf_sample *sample, FILE *fp)
1907 {
1908         struct perf_synth_intel_evt *data = perf_sample__synth_ptr(sample);
1909         const char *cfe[32] = {NULL, "INTR", "IRET", "SMI", "RSM", "SIPI",
1910                                "INIT", "VMENTRY", "VMEXIT", "VMEXIT_INTR",
1911                                "SHUTDOWN", NULL, "UINTR", "UIRET"};
1912         const char *evd[64] = {"PFA", "VMXQ", "VMXR"};
1913         const char *s;
1914         int len, i;
1915
1916         if (perf_sample__bad_synth_size(sample, *data))
1917                 return 0;
1918
1919         s = cfe[data->type];
1920         if (s) {
1921                 len = fprintf(fp, " cfe: %s IP: %d vector: %u",
1922                               s, data->ip, data->vector);
1923         } else {
1924                 len = fprintf(fp, " cfe: %u IP: %d vector: %u",
1925                               data->type, data->ip, data->vector);
1926         }
1927         for (i = 0; i < data->evd_cnt; i++) {
1928                 unsigned int et = data->evd[i].evd_type & 0x3f;
1929
1930                 s = evd[et];
1931                 if (s) {
1932                         len += fprintf(fp, " %s: %#" PRIx64,
1933                                        s, data->evd[i].payload);
1934                 } else {
1935                         len += fprintf(fp, " EVD_%u: %#" PRIx64,
1936                                        et, data->evd[i].payload);
1937                 }
1938         }
1939         return len + perf_sample__fprintf_pt_spacing(len, fp);
1940 }
1941
1942 static int perf_sample__fprintf_synth_iflag_chg(struct perf_sample *sample, FILE *fp)
1943 {
1944         struct perf_synth_intel_iflag_chg *data = perf_sample__synth_ptr(sample);
1945         int len;
1946
1947         if (perf_sample__bad_synth_size(sample, *data))
1948                 return 0;
1949
1950         len = fprintf(fp, " IFLAG: %d->%d %s branch", !data->iflag, data->iflag,
1951                       data->via_branch ? "via" : "non");
1952         return len + perf_sample__fprintf_pt_spacing(len, fp);
1953 }
1954
1955 static int perf_sample__fprintf_synth(struct perf_sample *sample,
1956                                       struct evsel *evsel, FILE *fp)
1957 {
1958         switch (evsel->core.attr.config) {
1959         case PERF_SYNTH_INTEL_PTWRITE:
1960                 return perf_sample__fprintf_synth_ptwrite(sample, fp);
1961         case PERF_SYNTH_INTEL_MWAIT:
1962                 return perf_sample__fprintf_synth_mwait(sample, fp);
1963         case PERF_SYNTH_INTEL_PWRE:
1964                 return perf_sample__fprintf_synth_pwre(sample, fp);
1965         case PERF_SYNTH_INTEL_EXSTOP:
1966                 return perf_sample__fprintf_synth_exstop(sample, fp);
1967         case PERF_SYNTH_INTEL_PWRX:
1968                 return perf_sample__fprintf_synth_pwrx(sample, fp);
1969         case PERF_SYNTH_INTEL_CBR:
1970                 return perf_sample__fprintf_synth_cbr(sample, fp);
1971         case PERF_SYNTH_INTEL_PSB:
1972                 return perf_sample__fprintf_synth_psb(sample, fp);
1973         case PERF_SYNTH_INTEL_EVT:
1974                 return perf_sample__fprintf_synth_evt(sample, fp);
1975         case PERF_SYNTH_INTEL_IFLAG_CHG:
1976                 return perf_sample__fprintf_synth_iflag_chg(sample, fp);
1977         default:
1978                 break;
1979         }
1980
1981         return 0;
1982 }
1983
1984 static int evlist__max_name_len(struct evlist *evlist)
1985 {
1986         struct evsel *evsel;
1987         int max = 0;
1988
1989         evlist__for_each_entry(evlist, evsel) {
1990                 int len = strlen(evsel__name(evsel));
1991
1992                 max = MAX(len, max);
1993         }
1994
1995         return max;
1996 }
1997
1998 static int data_src__fprintf(u64 data_src, FILE *fp)
1999 {
2000         struct mem_info mi = { .data_src.val = data_src };
2001         char decode[100];
2002         char out[100];
2003         static int maxlen;
2004         int len;
2005
2006         perf_script__meminfo_scnprintf(decode, 100, &mi);
2007
2008         len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
2009         if (maxlen < len)
2010                 maxlen = len;
2011
2012         return fprintf(fp, "%-*s", maxlen, out);
2013 }
2014
2015 struct metric_ctx {
2016         struct perf_sample      *sample;
2017         struct thread           *thread;
2018         struct evsel    *evsel;
2019         FILE                    *fp;
2020 };
2021
2022 static void script_print_metric(struct perf_stat_config *config __maybe_unused,
2023                                 void *ctx, const char *color,
2024                                 const char *fmt,
2025                                 const char *unit, double val)
2026 {
2027         struct metric_ctx *mctx = ctx;
2028
2029         if (!fmt)
2030                 return;
2031         perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
2032                                    PERF_RECORD_SAMPLE, mctx->fp);
2033         fputs("\tmetric: ", mctx->fp);
2034         if (color)
2035                 color_fprintf(mctx->fp, color, fmt, val);
2036         else
2037                 printf(fmt, val);
2038         fprintf(mctx->fp, " %s\n", unit);
2039 }
2040
2041 static void script_new_line(struct perf_stat_config *config __maybe_unused,
2042                             void *ctx)
2043 {
2044         struct metric_ctx *mctx = ctx;
2045
2046         perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
2047                                    PERF_RECORD_SAMPLE, mctx->fp);
2048         fputs("\tmetric: ", mctx->fp);
2049 }
2050
2051 static void perf_sample__fprint_metric(struct perf_script *script,
2052                                        struct thread *thread,
2053                                        struct evsel *evsel,
2054                                        struct perf_sample *sample,
2055                                        FILE *fp)
2056 {
2057         struct evsel *leader = evsel__leader(evsel);
2058         struct perf_stat_output_ctx ctx = {
2059                 .print_metric = script_print_metric,
2060                 .new_line = script_new_line,
2061                 .ctx = &(struct metric_ctx) {
2062                                 .sample = sample,
2063                                 .thread = thread,
2064                                 .evsel  = evsel,
2065                                 .fp     = fp,
2066                          },
2067                 .force_header = false,
2068         };
2069         struct evsel *ev2;
2070         u64 val;
2071
2072         if (!evsel->stats)
2073                 evlist__alloc_stats(&stat_config, script->session->evlist, /*alloc_raw=*/false);
2074         if (evsel_script(leader)->gnum++ == 0)
2075                 perf_stat__reset_shadow_stats();
2076         val = sample->period * evsel->scale;
2077         evsel_script(evsel)->val = val;
2078         if (evsel_script(leader)->gnum == leader->core.nr_members) {
2079                 for_each_group_member (ev2, leader) {
2080                         perf_stat__print_shadow_stats(&stat_config, ev2,
2081                                                       evsel_script(ev2)->val,
2082                                                       sample->cpu,
2083                                                       &ctx,
2084                                                       NULL);
2085                 }
2086                 evsel_script(leader)->gnum = 0;
2087         }
2088 }
2089
2090 static bool show_event(struct perf_sample *sample,
2091                        struct evsel *evsel,
2092                        struct thread *thread,
2093                        struct addr_location *al,
2094                        struct addr_location *addr_al)
2095 {
2096         int depth = thread_stack__depth(thread, sample->cpu);
2097
2098         if (!symbol_conf.graph_function)
2099                 return true;
2100
2101         if (thread->filter) {
2102                 if (depth <= thread->filter_entry_depth) {
2103                         thread->filter = false;
2104                         return false;
2105                 }
2106                 return true;
2107         } else {
2108                 const char *s = symbol_conf.graph_function;
2109                 u64 ip;
2110                 const char *name = resolve_branch_sym(sample, evsel, thread, al, addr_al,
2111                                 &ip);
2112                 unsigned nlen;
2113
2114                 if (!name)
2115                         return false;
2116                 nlen = strlen(name);
2117                 while (*s) {
2118                         unsigned len = strcspn(s, ",");
2119                         if (nlen == len && !strncmp(name, s, len)) {
2120                                 thread->filter = true;
2121                                 thread->filter_entry_depth = depth;
2122                                 return true;
2123                         }
2124                         s += len;
2125                         if (*s == ',')
2126                                 s++;
2127                 }
2128                 return false;
2129         }
2130 }
2131
2132 static void process_event(struct perf_script *script,
2133                           struct perf_sample *sample, struct evsel *evsel,
2134                           struct addr_location *al,
2135                           struct addr_location *addr_al,
2136                           struct machine *machine)
2137 {
2138         struct thread *thread = al->thread;
2139         struct perf_event_attr *attr = &evsel->core.attr;
2140         unsigned int type = output_type(attr->type);
2141         struct evsel_script *es = evsel->priv;
2142         FILE *fp = es->fp;
2143         char str[PAGE_SIZE_NAME_LEN];
2144         const char *arch = perf_env__arch(machine->env);
2145
2146         if (output[type].fields == 0)
2147                 return;
2148
2149         ++es->samples;
2150
2151         perf_sample__fprintf_start(script, sample, thread, evsel,
2152                                    PERF_RECORD_SAMPLE, fp);
2153
2154         if (PRINT_FIELD(PERIOD))
2155                 fprintf(fp, "%10" PRIu64 " ", sample->period);
2156
2157         if (PRINT_FIELD(EVNAME)) {
2158                 const char *evname = evsel__name(evsel);
2159
2160                 if (!script->name_width)
2161                         script->name_width = evlist__max_name_len(script->session->evlist);
2162
2163                 fprintf(fp, "%*s: ", script->name_width, evname ?: "[unknown]");
2164         }
2165
2166         if (print_flags)
2167                 perf_sample__fprintf_flags(sample->flags, fp);
2168
2169         if (is_bts_event(attr)) {
2170                 perf_sample__fprintf_bts(sample, evsel, thread, al, addr_al, machine, fp);
2171                 return;
2172         }
2173 #ifdef HAVE_LIBTRACEEVENT
2174         if (PRINT_FIELD(TRACE) && sample->raw_data) {
2175                 event_format__fprintf(evsel->tp_format, sample->cpu,
2176                                       sample->raw_data, sample->raw_size, fp);
2177         }
2178 #endif
2179         if (attr->type == PERF_TYPE_SYNTH && PRINT_FIELD(SYNTH))
2180                 perf_sample__fprintf_synth(sample, evsel, fp);
2181
2182         if (PRINT_FIELD(ADDR))
2183                 perf_sample__fprintf_addr(sample, thread, attr, fp);
2184
2185         if (PRINT_FIELD(DATA_SRC))
2186                 data_src__fprintf(sample->data_src, fp);
2187
2188         if (PRINT_FIELD(WEIGHT))
2189                 fprintf(fp, "%16" PRIu64, sample->weight);
2190
2191         if (PRINT_FIELD(INS_LAT))
2192                 fprintf(fp, "%16" PRIu16, sample->ins_lat);
2193
2194         if (PRINT_FIELD(RETIRE_LAT))
2195                 fprintf(fp, "%16" PRIu16, sample->retire_lat);
2196
2197         if (PRINT_FIELD(IP)) {
2198                 struct callchain_cursor *cursor = NULL;
2199
2200                 if (script->stitch_lbr)
2201                         al->thread->lbr_stitch_enable = true;
2202
2203                 if (symbol_conf.use_callchain && sample->callchain &&
2204                     thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
2205                                               sample, NULL, NULL, scripting_max_stack) == 0)
2206                         cursor = &callchain_cursor;
2207
2208                 fputc(cursor ? '\n' : ' ', fp);
2209                 sample__fprintf_sym(sample, al, 0, output[type].print_ip_opts, cursor,
2210                                     symbol_conf.bt_stop_list, fp);
2211         }
2212
2213         if (PRINT_FIELD(IREGS))
2214                 perf_sample__fprintf_iregs(sample, attr, arch, fp);
2215
2216         if (PRINT_FIELD(UREGS))
2217                 perf_sample__fprintf_uregs(sample, attr, arch, fp);
2218
2219         if (PRINT_FIELD(BRSTACK))
2220                 perf_sample__fprintf_brstack(sample, thread, attr, fp);
2221         else if (PRINT_FIELD(BRSTACKSYM))
2222                 perf_sample__fprintf_brstacksym(sample, thread, attr, fp);
2223         else if (PRINT_FIELD(BRSTACKOFF))
2224                 perf_sample__fprintf_brstackoff(sample, thread, attr, fp);
2225
2226         if (evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
2227                 perf_sample__fprintf_bpf_output(sample, fp);
2228         perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
2229
2230         if (PRINT_FIELD(PHYS_ADDR))
2231                 fprintf(fp, "%16" PRIx64, sample->phys_addr);
2232
2233         if (PRINT_FIELD(DATA_PAGE_SIZE))
2234                 fprintf(fp, " %s", get_page_size_name(sample->data_page_size, str));
2235
2236         if (PRINT_FIELD(CODE_PAGE_SIZE))
2237                 fprintf(fp, " %s", get_page_size_name(sample->code_page_size, str));
2238
2239         if (PRINT_FIELD(CGROUP)) {
2240                 const char *cgrp_name;
2241                 struct cgroup *cgrp = cgroup__find(machine->env,
2242                                                    sample->cgroup);
2243                 if (cgrp != NULL)
2244                         cgrp_name = cgrp->name;
2245                 else
2246                         cgrp_name = "unknown";
2247                 fprintf(fp, " %s", cgrp_name);
2248         }
2249
2250         perf_sample__fprintf_ipc(sample, attr, fp);
2251
2252         fprintf(fp, "\n");
2253
2254         if (PRINT_FIELD(SRCCODE)) {
2255                 if (map__fprintf_srccode(al->map, al->addr, stdout,
2256                                          &thread->srccode_state))
2257                         printf("\n");
2258         }
2259
2260         if (PRINT_FIELD(METRIC))
2261                 perf_sample__fprint_metric(script, thread, evsel, sample, fp);
2262
2263         if (verbose > 0)
2264                 fflush(fp);
2265 }
2266
2267 static struct scripting_ops     *scripting_ops;
2268
2269 static void __process_stat(struct evsel *counter, u64 tstamp)
2270 {
2271         int nthreads = perf_thread_map__nr(counter->core.threads);
2272         int idx, thread;
2273         struct perf_cpu cpu;
2274         static int header_printed;
2275
2276         if (!header_printed) {
2277                 printf("%3s %8s %15s %15s %15s %15s %s\n",
2278                        "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
2279                 header_printed = 1;
2280         }
2281
2282         for (thread = 0; thread < nthreads; thread++) {
2283                 perf_cpu_map__for_each_cpu(cpu, idx, evsel__cpus(counter)) {
2284                         struct perf_counts_values *counts;
2285
2286                         counts = perf_counts(counter->counts, idx, thread);
2287
2288                         printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
2289                                 cpu.cpu,
2290                                 perf_thread_map__pid(counter->core.threads, thread),
2291                                 counts->val,
2292                                 counts->ena,
2293                                 counts->run,
2294                                 tstamp,
2295                                 evsel__name(counter));
2296                 }
2297         }
2298 }
2299
2300 static void process_stat(struct evsel *counter, u64 tstamp)
2301 {
2302         if (scripting_ops && scripting_ops->process_stat)
2303                 scripting_ops->process_stat(&stat_config, counter, tstamp);
2304         else
2305                 __process_stat(counter, tstamp);
2306 }
2307
2308 static void process_stat_interval(u64 tstamp)
2309 {
2310         if (scripting_ops && scripting_ops->process_stat_interval)
2311                 scripting_ops->process_stat_interval(tstamp);
2312 }
2313
2314 static void setup_scripting(void)
2315 {
2316 #ifdef HAVE_LIBTRACEEVENT
2317         setup_perl_scripting();
2318 #endif
2319         setup_python_scripting();
2320 }
2321
2322 static int flush_scripting(void)
2323 {
2324         return scripting_ops ? scripting_ops->flush_script() : 0;
2325 }
2326
2327 static int cleanup_scripting(void)
2328 {
2329         pr_debug("\nperf script stopped\n");
2330
2331         return scripting_ops ? scripting_ops->stop_script() : 0;
2332 }
2333
2334 static bool filter_cpu(struct perf_sample *sample)
2335 {
2336         if (cpu_list && sample->cpu != (u32)-1)
2337                 return !test_bit(sample->cpu, cpu_bitmap);
2338         return false;
2339 }
2340
2341 static int process_sample_event(struct perf_tool *tool,
2342                                 union perf_event *event,
2343                                 struct perf_sample *sample,
2344                                 struct evsel *evsel,
2345                                 struct machine *machine)
2346 {
2347         struct perf_script *scr = container_of(tool, struct perf_script, tool);
2348         struct addr_location al;
2349         struct addr_location addr_al;
2350         int ret = 0;
2351
2352         /* Set thread to NULL to indicate addr_al and al are not initialized */
2353         addr_al.thread = NULL;
2354         al.thread = NULL;
2355
2356         ret = dlfilter__filter_event_early(dlfilter, event, sample, evsel, machine, &al, &addr_al);
2357         if (ret) {
2358                 if (ret > 0)
2359                         ret = 0;
2360                 goto out_put;
2361         }
2362
2363         if (perf_time__ranges_skip_sample(scr->ptime_range, scr->range_num,
2364                                           sample->time)) {
2365                 goto out_put;
2366         }
2367
2368         if (debug_mode) {
2369                 if (sample->time < last_timestamp) {
2370                         pr_err("Samples misordered, previous: %" PRIu64
2371                                 " this: %" PRIu64 "\n", last_timestamp,
2372                                 sample->time);
2373                         nr_unordered++;
2374                 }
2375                 last_timestamp = sample->time;
2376                 goto out_put;
2377         }
2378
2379         if (filter_cpu(sample))
2380                 goto out_put;
2381
2382         if (!al.thread && machine__resolve(machine, &al, sample) < 0) {
2383                 pr_err("problem processing %d event, skipping it.\n",
2384                        event->header.type);
2385                 ret = -1;
2386                 goto out_put;
2387         }
2388
2389         if (al.filtered)
2390                 goto out_put;
2391
2392         if (!show_event(sample, evsel, al.thread, &al, &addr_al))
2393                 goto out_put;
2394
2395         if (evswitch__discard(&scr->evswitch, evsel))
2396                 goto out_put;
2397
2398         ret = dlfilter__filter_event(dlfilter, event, sample, evsel, machine, &al, &addr_al);
2399         if (ret) {
2400                 if (ret > 0)
2401                         ret = 0;
2402                 goto out_put;
2403         }
2404
2405         if (scripting_ops) {
2406                 struct addr_location *addr_al_ptr = NULL;
2407
2408                 if ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
2409                     sample_addr_correlates_sym(&evsel->core.attr)) {
2410                         if (!addr_al.thread)
2411                                 thread__resolve(al.thread, &addr_al, sample);
2412                         addr_al_ptr = &addr_al;
2413                 }
2414                 scripting_ops->process_event(event, sample, evsel, &al, addr_al_ptr);
2415         } else {
2416                 process_event(scr, sample, evsel, &al, &addr_al, machine);
2417         }
2418
2419 out_put:
2420         if (al.thread)
2421                 addr_location__put(&al);
2422         return ret;
2423 }
2424
2425 static int process_attr(struct perf_tool *tool, union perf_event *event,
2426                         struct evlist **pevlist)
2427 {
2428         struct perf_script *scr = container_of(tool, struct perf_script, tool);
2429         struct evlist *evlist;
2430         struct evsel *evsel, *pos;
2431         u64 sample_type;
2432         int err;
2433         static struct evsel_script *es;
2434
2435         err = perf_event__process_attr(tool, event, pevlist);
2436         if (err)
2437                 return err;
2438
2439         evlist = *pevlist;
2440         evsel = evlist__last(*pevlist);
2441
2442         if (!evsel->priv) {
2443                 if (scr->per_event_dump) {
2444                         evsel->priv = evsel_script__new(evsel, scr->session->data);
2445                 } else {
2446                         es = zalloc(sizeof(*es));
2447                         if (!es)
2448                                 return -ENOMEM;
2449                         es->fp = stdout;
2450                         evsel->priv = es;
2451                 }
2452         }
2453
2454         if (evsel->core.attr.type >= PERF_TYPE_MAX &&
2455             evsel->core.attr.type != PERF_TYPE_SYNTH)
2456                 return 0;
2457
2458         evlist__for_each_entry(evlist, pos) {
2459                 if (pos->core.attr.type == evsel->core.attr.type && pos != evsel)
2460                         return 0;
2461         }
2462
2463         if (evsel->core.attr.sample_type) {
2464                 err = evsel__check_attr(evsel, scr->session);
2465                 if (err)
2466                         return err;
2467         }
2468
2469         /*
2470          * Check if we need to enable callchains based
2471          * on events sample_type.
2472          */
2473         sample_type = evlist__combined_sample_type(evlist);
2474         callchain_param_setup(sample_type, perf_env__arch((*pevlist)->env));
2475
2476         /* Enable fields for callchain entries */
2477         if (symbol_conf.use_callchain &&
2478             (sample_type & PERF_SAMPLE_CALLCHAIN ||
2479              sample_type & PERF_SAMPLE_BRANCH_STACK ||
2480              (sample_type & PERF_SAMPLE_REGS_USER &&
2481               sample_type & PERF_SAMPLE_STACK_USER))) {
2482                 int type = output_type(evsel->core.attr.type);
2483
2484                 if (!(output[type].user_unset_fields & PERF_OUTPUT_IP))
2485                         output[type].fields |= PERF_OUTPUT_IP;
2486                 if (!(output[type].user_unset_fields & PERF_OUTPUT_SYM))
2487                         output[type].fields |= PERF_OUTPUT_SYM;
2488         }
2489         set_print_ip_opts(&evsel->core.attr);
2490         return 0;
2491 }
2492
2493 static int print_event_with_time(struct perf_tool *tool,
2494                                  union perf_event *event,
2495                                  struct perf_sample *sample,
2496                                  struct machine *machine,
2497                                  pid_t pid, pid_t tid, u64 timestamp)
2498 {
2499         struct perf_script *script = container_of(tool, struct perf_script, tool);
2500         struct perf_session *session = script->session;
2501         struct evsel *evsel = evlist__id2evsel(session->evlist, sample->id);
2502         struct thread *thread = NULL;
2503
2504         if (evsel && !evsel->core.attr.sample_id_all) {
2505                 sample->cpu = 0;
2506                 sample->time = timestamp;
2507                 sample->pid = pid;
2508                 sample->tid = tid;
2509         }
2510
2511         if (filter_cpu(sample))
2512                 return 0;
2513
2514         if (tid != -1)
2515                 thread = machine__findnew_thread(machine, pid, tid);
2516
2517         if (evsel) {
2518                 perf_sample__fprintf_start(script, sample, thread, evsel,
2519                                            event->header.type, stdout);
2520         }
2521
2522         perf_event__fprintf(event, machine, stdout);
2523
2524         thread__put(thread);
2525
2526         return 0;
2527 }
2528
2529 static int print_event(struct perf_tool *tool, union perf_event *event,
2530                        struct perf_sample *sample, struct machine *machine,
2531                        pid_t pid, pid_t tid)
2532 {
2533         return print_event_with_time(tool, event, sample, machine, pid, tid, 0);
2534 }
2535
2536 static int process_comm_event(struct perf_tool *tool,
2537                               union perf_event *event,
2538                               struct perf_sample *sample,
2539                               struct machine *machine)
2540 {
2541         if (perf_event__process_comm(tool, event, sample, machine) < 0)
2542                 return -1;
2543
2544         return print_event(tool, event, sample, machine, event->comm.pid,
2545                            event->comm.tid);
2546 }
2547
2548 static int process_namespaces_event(struct perf_tool *tool,
2549                                     union perf_event *event,
2550                                     struct perf_sample *sample,
2551                                     struct machine *machine)
2552 {
2553         if (perf_event__process_namespaces(tool, event, sample, machine) < 0)
2554                 return -1;
2555
2556         return print_event(tool, event, sample, machine, event->namespaces.pid,
2557                            event->namespaces.tid);
2558 }
2559
2560 static int process_cgroup_event(struct perf_tool *tool,
2561                                 union perf_event *event,
2562                                 struct perf_sample *sample,
2563                                 struct machine *machine)
2564 {
2565         if (perf_event__process_cgroup(tool, event, sample, machine) < 0)
2566                 return -1;
2567
2568         return print_event(tool, event, sample, machine, sample->pid,
2569                             sample->tid);
2570 }
2571
2572 static int process_fork_event(struct perf_tool *tool,
2573                               union perf_event *event,
2574                               struct perf_sample *sample,
2575                               struct machine *machine)
2576 {
2577         if (perf_event__process_fork(tool, event, sample, machine) < 0)
2578                 return -1;
2579
2580         return print_event_with_time(tool, event, sample, machine,
2581                                      event->fork.pid, event->fork.tid,
2582                                      event->fork.time);
2583 }
2584 static int process_exit_event(struct perf_tool *tool,
2585                               union perf_event *event,
2586                               struct perf_sample *sample,
2587                               struct machine *machine)
2588 {
2589         /* Print before 'exit' deletes anything */
2590         if (print_event_with_time(tool, event, sample, machine, event->fork.pid,
2591                                   event->fork.tid, event->fork.time))
2592                 return -1;
2593
2594         return perf_event__process_exit(tool, event, sample, machine);
2595 }
2596
2597 static int process_mmap_event(struct perf_tool *tool,
2598                               union perf_event *event,
2599                               struct perf_sample *sample,
2600                               struct machine *machine)
2601 {
2602         if (perf_event__process_mmap(tool, event, sample, machine) < 0)
2603                 return -1;
2604
2605         return print_event(tool, event, sample, machine, event->mmap.pid,
2606                            event->mmap.tid);
2607 }
2608
2609 static int process_mmap2_event(struct perf_tool *tool,
2610                               union perf_event *event,
2611                               struct perf_sample *sample,
2612                               struct machine *machine)
2613 {
2614         if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
2615                 return -1;
2616
2617         return print_event(tool, event, sample, machine, event->mmap2.pid,
2618                            event->mmap2.tid);
2619 }
2620
2621 static int process_switch_event(struct perf_tool *tool,
2622                                 union perf_event *event,
2623                                 struct perf_sample *sample,
2624                                 struct machine *machine)
2625 {
2626         struct perf_script *script = container_of(tool, struct perf_script, tool);
2627
2628         if (perf_event__process_switch(tool, event, sample, machine) < 0)
2629                 return -1;
2630
2631         if (scripting_ops && scripting_ops->process_switch && !filter_cpu(sample))
2632                 scripting_ops->process_switch(event, sample, machine);
2633
2634         if (!script->show_switch_events)
2635                 return 0;
2636
2637         return print_event(tool, event, sample, machine, sample->pid,
2638                            sample->tid);
2639 }
2640
2641 static int process_auxtrace_error(struct perf_session *session,
2642                                   union perf_event *event)
2643 {
2644         if (scripting_ops && scripting_ops->process_auxtrace_error) {
2645                 scripting_ops->process_auxtrace_error(session, event);
2646                 return 0;
2647         }
2648
2649         return perf_event__process_auxtrace_error(session, event);
2650 }
2651
2652 static int
2653 process_lost_event(struct perf_tool *tool,
2654                    union perf_event *event,
2655                    struct perf_sample *sample,
2656                    struct machine *machine)
2657 {
2658         return print_event(tool, event, sample, machine, sample->pid,
2659                            sample->tid);
2660 }
2661
2662 static int
2663 process_throttle_event(struct perf_tool *tool __maybe_unused,
2664                        union perf_event *event,
2665                        struct perf_sample *sample,
2666                        struct machine *machine)
2667 {
2668         if (scripting_ops && scripting_ops->process_throttle)
2669                 scripting_ops->process_throttle(event, sample, machine);
2670         return 0;
2671 }
2672
2673 static int
2674 process_finished_round_event(struct perf_tool *tool __maybe_unused,
2675                              union perf_event *event,
2676                              struct ordered_events *oe __maybe_unused)
2677
2678 {
2679         perf_event__fprintf(event, NULL, stdout);
2680         return 0;
2681 }
2682
2683 static int
2684 process_bpf_events(struct perf_tool *tool __maybe_unused,
2685                    union perf_event *event,
2686                    struct perf_sample *sample,
2687                    struct machine *machine)
2688 {
2689         if (machine__process_ksymbol(machine, event, sample) < 0)
2690                 return -1;
2691
2692         return print_event(tool, event, sample, machine, sample->pid,
2693                            sample->tid);
2694 }
2695
2696 static int process_text_poke_events(struct perf_tool *tool,
2697                                     union perf_event *event,
2698                                     struct perf_sample *sample,
2699                                     struct machine *machine)
2700 {
2701         if (perf_event__process_text_poke(tool, event, sample, machine) < 0)
2702                 return -1;
2703
2704         return print_event(tool, event, sample, machine, sample->pid,
2705                            sample->tid);
2706 }
2707
2708 static void sig_handler(int sig __maybe_unused)
2709 {
2710         session_done = 1;
2711 }
2712
2713 static void perf_script__fclose_per_event_dump(struct perf_script *script)
2714 {
2715         struct evlist *evlist = script->session->evlist;
2716         struct evsel *evsel;
2717
2718         evlist__for_each_entry(evlist, evsel) {
2719                 if (!evsel->priv)
2720                         break;
2721                 evsel_script__delete(evsel->priv);
2722                 evsel->priv = NULL;
2723         }
2724 }
2725
2726 static int perf_script__fopen_per_event_dump(struct perf_script *script)
2727 {
2728         struct evsel *evsel;
2729
2730         evlist__for_each_entry(script->session->evlist, evsel) {
2731                 /*
2732                  * Already setup? I.e. we may be called twice in cases like
2733                  * Intel PT, one for the intel_pt// and dummy events, then
2734                  * for the evsels synthesized from the auxtrace info.
2735                  *
2736                  * Ses perf_script__process_auxtrace_info.
2737                  */
2738                 if (evsel->priv != NULL)
2739                         continue;
2740
2741                 evsel->priv = evsel_script__new(evsel, script->session->data);
2742                 if (evsel->priv == NULL)
2743                         goto out_err_fclose;
2744         }
2745
2746         return 0;
2747
2748 out_err_fclose:
2749         perf_script__fclose_per_event_dump(script);
2750         return -1;
2751 }
2752
2753 static int perf_script__setup_per_event_dump(struct perf_script *script)
2754 {
2755         struct evsel *evsel;
2756         static struct evsel_script es_stdout;
2757
2758         if (script->per_event_dump)
2759                 return perf_script__fopen_per_event_dump(script);
2760
2761         es_stdout.fp = stdout;
2762
2763         evlist__for_each_entry(script->session->evlist, evsel)
2764                 evsel->priv = &es_stdout;
2765
2766         return 0;
2767 }
2768
2769 static void perf_script__exit_per_event_dump_stats(struct perf_script *script)
2770 {
2771         struct evsel *evsel;
2772
2773         evlist__for_each_entry(script->session->evlist, evsel) {
2774                 struct evsel_script *es = evsel->priv;
2775
2776                 evsel_script__fprintf(es, stdout);
2777                 evsel_script__delete(es);
2778                 evsel->priv = NULL;
2779         }
2780 }
2781
2782 static void perf_script__exit(struct perf_script *script)
2783 {
2784         perf_thread_map__put(script->threads);
2785         perf_cpu_map__put(script->cpus);
2786 }
2787
2788 static int __cmd_script(struct perf_script *script)
2789 {
2790         int ret;
2791
2792         signal(SIGINT, sig_handler);
2793
2794         /* override event processing functions */
2795         if (script->show_task_events) {
2796                 script->tool.comm = process_comm_event;
2797                 script->tool.fork = process_fork_event;
2798                 script->tool.exit = process_exit_event;
2799         }
2800         if (script->show_mmap_events) {
2801                 script->tool.mmap = process_mmap_event;
2802                 script->tool.mmap2 = process_mmap2_event;
2803         }
2804         if (script->show_switch_events || (scripting_ops && scripting_ops->process_switch))
2805                 script->tool.context_switch = process_switch_event;
2806         if (scripting_ops && scripting_ops->process_auxtrace_error)
2807                 script->tool.auxtrace_error = process_auxtrace_error;
2808         if (script->show_namespace_events)
2809                 script->tool.namespaces = process_namespaces_event;
2810         if (script->show_cgroup_events)
2811                 script->tool.cgroup = process_cgroup_event;
2812         if (script->show_lost_events)
2813                 script->tool.lost = process_lost_event;
2814         if (script->show_round_events) {
2815                 script->tool.ordered_events = false;
2816                 script->tool.finished_round = process_finished_round_event;
2817         }
2818         if (script->show_bpf_events) {
2819                 script->tool.ksymbol = process_bpf_events;
2820                 script->tool.bpf     = process_bpf_events;
2821         }
2822         if (script->show_text_poke_events) {
2823                 script->tool.ksymbol   = process_bpf_events;
2824                 script->tool.text_poke = process_text_poke_events;
2825         }
2826
2827         if (perf_script__setup_per_event_dump(script)) {
2828                 pr_err("Couldn't create the per event dump files\n");
2829                 return -1;
2830         }
2831
2832         ret = perf_session__process_events(script->session);
2833
2834         if (script->per_event_dump)
2835                 perf_script__exit_per_event_dump_stats(script);
2836
2837         if (debug_mode)
2838                 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
2839
2840         return ret;
2841 }
2842
2843 struct script_spec {
2844         struct list_head        node;
2845         struct scripting_ops    *ops;
2846         char                    spec[];
2847 };
2848
2849 static LIST_HEAD(script_specs);
2850
2851 static struct script_spec *script_spec__new(const char *spec,
2852                                             struct scripting_ops *ops)
2853 {
2854         struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
2855
2856         if (s != NULL) {
2857                 strcpy(s->spec, spec);
2858                 s->ops = ops;
2859         }
2860
2861         return s;
2862 }
2863
2864 static void script_spec__add(struct script_spec *s)
2865 {
2866         list_add_tail(&s->node, &script_specs);
2867 }
2868
2869 static struct script_spec *script_spec__find(const char *spec)
2870 {
2871         struct script_spec *s;
2872
2873         list_for_each_entry(s, &script_specs, node)
2874                 if (strcasecmp(s->spec, spec) == 0)
2875                         return s;
2876         return NULL;
2877 }
2878
2879 int script_spec_register(const char *spec, struct scripting_ops *ops)
2880 {
2881         struct script_spec *s;
2882
2883         s = script_spec__find(spec);
2884         if (s)
2885                 return -1;
2886
2887         s = script_spec__new(spec, ops);
2888         if (!s)
2889                 return -1;
2890         else
2891                 script_spec__add(s);
2892
2893         return 0;
2894 }
2895
2896 static struct scripting_ops *script_spec__lookup(const char *spec)
2897 {
2898         struct script_spec *s = script_spec__find(spec);
2899         if (!s)
2900                 return NULL;
2901
2902         return s->ops;
2903 }
2904
2905 static void list_available_languages(void)
2906 {
2907         struct script_spec *s;
2908
2909         fprintf(stderr, "\n");
2910         fprintf(stderr, "Scripting language extensions (used in "
2911                 "perf script -s [spec:]script.[spec]):\n\n");
2912
2913         list_for_each_entry(s, &script_specs, node)
2914                 fprintf(stderr, "  %-42s [%s]\n", s->spec, s->ops->name);
2915
2916         fprintf(stderr, "\n");
2917 }
2918
2919 /* Find script file relative to current directory or exec path */
2920 static char *find_script(const char *script)
2921 {
2922         char path[PATH_MAX];
2923
2924         if (!scripting_ops) {
2925                 const char *ext = strrchr(script, '.');
2926
2927                 if (!ext)
2928                         return NULL;
2929
2930                 scripting_ops = script_spec__lookup(++ext);
2931                 if (!scripting_ops)
2932                         return NULL;
2933         }
2934
2935         if (access(script, R_OK)) {
2936                 char *exec_path = get_argv_exec_path();
2937
2938                 if (!exec_path)
2939                         return NULL;
2940                 snprintf(path, sizeof(path), "%s/scripts/%s/%s",
2941                          exec_path, scripting_ops->dirname, script);
2942                 free(exec_path);
2943                 script = path;
2944                 if (access(script, R_OK))
2945                         return NULL;
2946         }
2947         return strdup(script);
2948 }
2949
2950 static int parse_scriptname(const struct option *opt __maybe_unused,
2951                             const char *str, int unset __maybe_unused)
2952 {
2953         char spec[PATH_MAX];
2954         const char *script, *ext;
2955         int len;
2956
2957         if (strcmp(str, "lang") == 0) {
2958                 list_available_languages();
2959                 exit(0);
2960         }
2961
2962         script = strchr(str, ':');
2963         if (script) {
2964                 len = script - str;
2965                 if (len >= PATH_MAX) {
2966                         fprintf(stderr, "invalid language specifier");
2967                         return -1;
2968                 }
2969                 strncpy(spec, str, len);
2970                 spec[len] = '\0';
2971                 scripting_ops = script_spec__lookup(spec);
2972                 if (!scripting_ops) {
2973                         fprintf(stderr, "invalid language specifier");
2974                         return -1;
2975                 }
2976                 script++;
2977         } else {
2978                 script = str;
2979                 ext = strrchr(script, '.');
2980                 if (!ext) {
2981                         fprintf(stderr, "invalid script extension");
2982                         return -1;
2983                 }
2984                 scripting_ops = script_spec__lookup(++ext);
2985                 if (!scripting_ops) {
2986                         fprintf(stderr, "invalid script extension");
2987                         return -1;
2988                 }
2989         }
2990
2991         script_name = find_script(script);
2992         if (!script_name)
2993                 script_name = strdup(script);
2994
2995         return 0;
2996 }
2997
2998 static int parse_output_fields(const struct option *opt __maybe_unused,
2999                             const char *arg, int unset __maybe_unused)
3000 {
3001         char *tok, *strtok_saveptr = NULL;
3002         int i, imax = ARRAY_SIZE(all_output_options);
3003         int j;
3004         int rc = 0;
3005         char *str = strdup(arg);
3006         int type = -1;
3007         enum { DEFAULT, SET, ADD, REMOVE } change = DEFAULT;
3008
3009         if (!str)
3010                 return -ENOMEM;
3011
3012         /* first word can state for which event type the user is specifying
3013          * the fields. If no type exists, the specified fields apply to all
3014          * event types found in the file minus the invalid fields for a type.
3015          */
3016         tok = strchr(str, ':');
3017         if (tok) {
3018                 *tok = '\0';
3019                 tok++;
3020                 if (!strcmp(str, "hw"))
3021                         type = PERF_TYPE_HARDWARE;
3022                 else if (!strcmp(str, "sw"))
3023                         type = PERF_TYPE_SOFTWARE;
3024                 else if (!strcmp(str, "trace"))
3025                         type = PERF_TYPE_TRACEPOINT;
3026                 else if (!strcmp(str, "raw"))
3027                         type = PERF_TYPE_RAW;
3028                 else if (!strcmp(str, "break"))
3029                         type = PERF_TYPE_BREAKPOINT;
3030                 else if (!strcmp(str, "synth"))
3031                         type = OUTPUT_TYPE_SYNTH;
3032                 else {
3033                         fprintf(stderr, "Invalid event type in field string.\n");
3034                         rc = -EINVAL;
3035                         goto out;
3036                 }
3037
3038                 if (output[type].user_set)
3039                         pr_warning("Overriding previous field request for %s events.\n",
3040                                    event_type(type));
3041
3042                 /* Don't override defaults for +- */
3043                 if (strchr(tok, '+') || strchr(tok, '-'))
3044                         goto parse;
3045
3046                 output[type].fields = 0;
3047                 output[type].user_set = true;
3048                 output[type].wildcard_set = false;
3049
3050         } else {
3051                 tok = str;
3052                 if (strlen(str) == 0) {
3053                         fprintf(stderr,
3054                                 "Cannot set fields to 'none' for all event types.\n");
3055                         rc = -EINVAL;
3056                         goto out;
3057                 }
3058
3059                 /* Don't override defaults for +- */
3060                 if (strchr(str, '+') || strchr(str, '-'))
3061                         goto parse;
3062
3063                 if (output_set_by_user())
3064                         pr_warning("Overriding previous field request for all events.\n");
3065
3066                 for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
3067                         output[j].fields = 0;
3068                         output[j].user_set = true;
3069                         output[j].wildcard_set = true;
3070                 }
3071         }
3072
3073 parse:
3074         for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) {
3075                 if (*tok == '+') {
3076                         if (change == SET)
3077                                 goto out_badmix;
3078                         change = ADD;
3079                         tok++;
3080                 } else if (*tok == '-') {
3081                         if (change == SET)
3082                                 goto out_badmix;
3083                         change = REMOVE;
3084                         tok++;
3085                 } else {
3086                         if (change != SET && change != DEFAULT)
3087                                 goto out_badmix;
3088                         change = SET;
3089                 }
3090
3091                 for (i = 0; i < imax; ++i) {
3092                         if (strcmp(tok, all_output_options[i].str) == 0)
3093                                 break;
3094                 }
3095                 if (i == imax && strcmp(tok, "flags") == 0) {
3096                         print_flags = change != REMOVE;
3097                         continue;
3098                 }
3099                 if (i == imax) {
3100                         fprintf(stderr, "Invalid field requested.\n");
3101                         rc = -EINVAL;
3102                         goto out;
3103                 }
3104
3105                 if (type == -1) {
3106                         /* add user option to all events types for
3107                          * which it is valid
3108                          */
3109                         for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
3110                                 if (output[j].invalid_fields & all_output_options[i].field) {
3111                                         pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
3112                                                    all_output_options[i].str, event_type(j));
3113                                 } else {
3114                                         if (change == REMOVE) {
3115                                                 output[j].fields &= ~all_output_options[i].field;
3116                                                 output[j].user_set_fields &= ~all_output_options[i].field;
3117                                                 output[j].user_unset_fields |= all_output_options[i].field;
3118                                         } else {
3119                                                 output[j].fields |= all_output_options[i].field;
3120                                                 output[j].user_set_fields |= all_output_options[i].field;
3121                                                 output[j].user_unset_fields &= ~all_output_options[i].field;
3122                                         }
3123                                         output[j].user_set = true;
3124                                         output[j].wildcard_set = true;
3125                                 }
3126                         }
3127                 } else {
3128                         if (output[type].invalid_fields & all_output_options[i].field) {
3129                                 fprintf(stderr, "\'%s\' not valid for %s events.\n",
3130                                          all_output_options[i].str, event_type(type));
3131
3132                                 rc = -EINVAL;
3133                                 goto out;
3134                         }
3135                         if (change == REMOVE)
3136                                 output[type].fields &= ~all_output_options[i].field;
3137                         else
3138                                 output[type].fields |= all_output_options[i].field;
3139                         output[type].user_set = true;
3140                         output[type].wildcard_set = true;
3141                 }
3142         }
3143
3144         if (type >= 0) {
3145                 if (output[type].fields == 0) {
3146                         pr_debug("No fields requested for %s type. "
3147                                  "Events will not be displayed.\n", event_type(type));
3148                 }
3149         }
3150         goto out;
3151
3152 out_badmix:
3153         fprintf(stderr, "Cannot mix +-field with overridden fields\n");
3154         rc = -EINVAL;
3155 out:
3156         free(str);
3157         return rc;
3158 }
3159
3160 #define for_each_lang(scripts_path, scripts_dir, lang_dirent)           \
3161         while ((lang_dirent = readdir(scripts_dir)) != NULL)            \
3162                 if ((lang_dirent->d_type == DT_DIR ||                   \
3163                      (lang_dirent->d_type == DT_UNKNOWN &&              \
3164                       is_directory(scripts_path, lang_dirent))) &&      \
3165                     (strcmp(lang_dirent->d_name, ".")) &&               \
3166                     (strcmp(lang_dirent->d_name, "..")))
3167
3168 #define for_each_script(lang_path, lang_dir, script_dirent)             \
3169         while ((script_dirent = readdir(lang_dir)) != NULL)             \
3170                 if (script_dirent->d_type != DT_DIR &&                  \
3171                     (script_dirent->d_type != DT_UNKNOWN ||             \
3172                      !is_directory(lang_path, script_dirent)))
3173
3174
3175 #define RECORD_SUFFIX                   "-record"
3176 #define REPORT_SUFFIX                   "-report"
3177
3178 struct script_desc {
3179         struct list_head        node;
3180         char                    *name;
3181         char                    *half_liner;
3182         char                    *args;
3183 };
3184
3185 static LIST_HEAD(script_descs);
3186
3187 static struct script_desc *script_desc__new(const char *name)
3188 {
3189         struct script_desc *s = zalloc(sizeof(*s));
3190
3191         if (s != NULL && name)
3192                 s->name = strdup(name);
3193
3194         return s;
3195 }
3196
3197 static void script_desc__delete(struct script_desc *s)
3198 {
3199         zfree(&s->name);
3200         zfree(&s->half_liner);
3201         zfree(&s->args);
3202         free(s);
3203 }
3204
3205 static void script_desc__add(struct script_desc *s)
3206 {
3207         list_add_tail(&s->node, &script_descs);
3208 }
3209
3210 static struct script_desc *script_desc__find(const char *name)
3211 {
3212         struct script_desc *s;
3213
3214         list_for_each_entry(s, &script_descs, node)
3215                 if (strcasecmp(s->name, name) == 0)
3216                         return s;
3217         return NULL;
3218 }
3219
3220 static struct script_desc *script_desc__findnew(const char *name)
3221 {
3222         struct script_desc *s = script_desc__find(name);
3223
3224         if (s)
3225                 return s;
3226
3227         s = script_desc__new(name);
3228         if (!s)
3229                 return NULL;
3230
3231         script_desc__add(s);
3232
3233         return s;
3234 }
3235
3236 static const char *ends_with(const char *str, const char *suffix)
3237 {
3238         size_t suffix_len = strlen(suffix);
3239         const char *p = str;
3240
3241         if (strlen(str) > suffix_len) {
3242                 p = str + strlen(str) - suffix_len;
3243                 if (!strncmp(p, suffix, suffix_len))
3244                         return p;
3245         }
3246
3247         return NULL;
3248 }
3249
3250 static int read_script_info(struct script_desc *desc, const char *filename)
3251 {
3252         char line[BUFSIZ], *p;
3253         FILE *fp;
3254
3255         fp = fopen(filename, "r");
3256         if (!fp)
3257                 return -1;
3258
3259         while (fgets(line, sizeof(line), fp)) {
3260                 p = skip_spaces(line);
3261                 if (strlen(p) == 0)
3262                         continue;
3263                 if (*p != '#')
3264                         continue;
3265                 p++;
3266                 if (strlen(p) && *p == '!')
3267                         continue;
3268
3269                 p = skip_spaces(p);
3270                 if (strlen(p) && p[strlen(p) - 1] == '\n')
3271                         p[strlen(p) - 1] = '\0';
3272
3273                 if (!strncmp(p, "description:", strlen("description:"))) {
3274                         p += strlen("description:");
3275                         desc->half_liner = strdup(skip_spaces(p));
3276                         continue;
3277                 }
3278
3279                 if (!strncmp(p, "args:", strlen("args:"))) {
3280                         p += strlen("args:");
3281                         desc->args = strdup(skip_spaces(p));
3282                         continue;
3283                 }
3284         }
3285
3286         fclose(fp);
3287
3288         return 0;
3289 }
3290
3291 static char *get_script_root(struct dirent *script_dirent, const char *suffix)
3292 {
3293         char *script_root, *str;
3294
3295         script_root = strdup(script_dirent->d_name);
3296         if (!script_root)
3297                 return NULL;
3298
3299         str = (char *)ends_with(script_root, suffix);
3300         if (!str) {
3301                 free(script_root);
3302                 return NULL;
3303         }
3304
3305         *str = '\0';
3306         return script_root;
3307 }
3308
3309 static int list_available_scripts(const struct option *opt __maybe_unused,
3310                                   const char *s __maybe_unused,
3311                                   int unset __maybe_unused)
3312 {
3313         struct dirent *script_dirent, *lang_dirent;
3314         char scripts_path[MAXPATHLEN];
3315         DIR *scripts_dir, *lang_dir;
3316         char script_path[MAXPATHLEN];
3317         char lang_path[MAXPATHLEN];
3318         struct script_desc *desc;
3319         char first_half[BUFSIZ];
3320         char *script_root;
3321
3322         snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3323
3324         scripts_dir = opendir(scripts_path);
3325         if (!scripts_dir) {
3326                 fprintf(stdout,
3327                         "open(%s) failed.\n"
3328                         "Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
3329                         scripts_path);
3330                 exit(-1);
3331         }
3332
3333         for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3334                 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3335                           lang_dirent->d_name);
3336                 lang_dir = opendir(lang_path);
3337                 if (!lang_dir)
3338                         continue;
3339
3340                 for_each_script(lang_path, lang_dir, script_dirent) {
3341                         script_root = get_script_root(script_dirent, REPORT_SUFFIX);
3342                         if (script_root) {
3343                                 desc = script_desc__findnew(script_root);
3344                                 scnprintf(script_path, MAXPATHLEN, "%s/%s",
3345                                           lang_path, script_dirent->d_name);
3346                                 read_script_info(desc, script_path);
3347                                 free(script_root);
3348                         }
3349                 }
3350         }
3351
3352         fprintf(stdout, "List of available trace scripts:\n");
3353         list_for_each_entry(desc, &script_descs, node) {
3354                 sprintf(first_half, "%s %s", desc->name,
3355                         desc->args ? desc->args : "");
3356                 fprintf(stdout, "  %-36s %s\n", first_half,
3357                         desc->half_liner ? desc->half_liner : "");
3358         }
3359
3360         exit(0);
3361 }
3362
3363 static int add_dlarg(const struct option *opt __maybe_unused,
3364                      const char *s, int unset __maybe_unused)
3365 {
3366         char *arg = strdup(s);
3367         void *a;
3368
3369         if (!arg)
3370                 return -1;
3371
3372         a = realloc(dlargv, sizeof(dlargv[0]) * (dlargc + 1));
3373         if (!a) {
3374                 free(arg);
3375                 return -1;
3376         }
3377
3378         dlargv = a;
3379         dlargv[dlargc++] = arg;
3380
3381         return 0;
3382 }
3383
3384 static void free_dlarg(void)
3385 {
3386         while (dlargc--)
3387                 free(dlargv[dlargc]);
3388         free(dlargv);
3389 }
3390
3391 /*
3392  * Some scripts specify the required events in their "xxx-record" file,
3393  * this function will check if the events in perf.data match those
3394  * mentioned in the "xxx-record".
3395  *
3396  * Fixme: All existing "xxx-record" are all in good formats "-e event ",
3397  * which is covered well now. And new parsing code should be added to
3398  * cover the future complex formats like event groups etc.
3399  */
3400 static int check_ev_match(char *dir_name, char *scriptname,
3401                         struct perf_session *session)
3402 {
3403         char filename[MAXPATHLEN], evname[128];
3404         char line[BUFSIZ], *p;
3405         struct evsel *pos;
3406         int match, len;
3407         FILE *fp;
3408
3409         scnprintf(filename, MAXPATHLEN, "%s/bin/%s-record", dir_name, scriptname);
3410
3411         fp = fopen(filename, "r");
3412         if (!fp)
3413                 return -1;
3414
3415         while (fgets(line, sizeof(line), fp)) {
3416                 p = skip_spaces(line);
3417                 if (*p == '#')
3418                         continue;
3419
3420                 while (strlen(p)) {
3421                         p = strstr(p, "-e");
3422                         if (!p)
3423                                 break;
3424
3425                         p += 2;
3426                         p = skip_spaces(p);
3427                         len = strcspn(p, " \t");
3428                         if (!len)
3429                                 break;
3430
3431                         snprintf(evname, len + 1, "%s", p);
3432
3433                         match = 0;
3434                         evlist__for_each_entry(session->evlist, pos) {
3435                                 if (!strcmp(evsel__name(pos), evname)) {
3436                                         match = 1;
3437                                         break;
3438                                 }
3439                         }
3440
3441                         if (!match) {
3442                                 fclose(fp);
3443                                 return -1;
3444                         }
3445                 }
3446         }
3447
3448         fclose(fp);
3449         return 0;
3450 }
3451
3452 /*
3453  * Return -1 if none is found, otherwise the actual scripts number.
3454  *
3455  * Currently the only user of this function is the script browser, which
3456  * will list all statically runnable scripts, select one, execute it and
3457  * show the output in a perf browser.
3458  */
3459 int find_scripts(char **scripts_array, char **scripts_path_array, int num,
3460                  int pathlen)
3461 {
3462         struct dirent *script_dirent, *lang_dirent;
3463         char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
3464         DIR *scripts_dir, *lang_dir;
3465         struct perf_session *session;
3466         struct perf_data data = {
3467                 .path = input_name,
3468                 .mode = PERF_DATA_MODE_READ,
3469         };
3470         char *temp;
3471         int i = 0;
3472
3473         session = perf_session__new(&data, NULL);
3474         if (IS_ERR(session))
3475                 return PTR_ERR(session);
3476
3477         snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3478
3479         scripts_dir = opendir(scripts_path);
3480         if (!scripts_dir) {
3481                 perf_session__delete(session);
3482                 return -1;
3483         }
3484
3485         for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3486                 scnprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
3487                           lang_dirent->d_name);
3488 #ifndef HAVE_LIBPERL_SUPPORT
3489                 if (strstr(lang_path, "perl"))
3490                         continue;
3491 #endif
3492 #ifndef HAVE_LIBPYTHON_SUPPORT
3493                 if (strstr(lang_path, "python"))
3494                         continue;
3495 #endif
3496
3497                 lang_dir = opendir(lang_path);
3498                 if (!lang_dir)
3499                         continue;
3500
3501                 for_each_script(lang_path, lang_dir, script_dirent) {
3502                         /* Skip those real time scripts: xxxtop.p[yl] */
3503                         if (strstr(script_dirent->d_name, "top."))
3504                                 continue;
3505                         if (i >= num)
3506                                 break;
3507                         snprintf(scripts_path_array[i], pathlen, "%s/%s",
3508                                 lang_path,
3509                                 script_dirent->d_name);
3510                         temp = strchr(script_dirent->d_name, '.');
3511                         snprintf(scripts_array[i],
3512                                 (temp - script_dirent->d_name) + 1,
3513                                 "%s", script_dirent->d_name);
3514
3515                         if (check_ev_match(lang_path,
3516                                         scripts_array[i], session))
3517                                 continue;
3518
3519                         i++;
3520                 }
3521                 closedir(lang_dir);
3522         }
3523
3524         closedir(scripts_dir);
3525         perf_session__delete(session);
3526         return i;
3527 }
3528
3529 static char *get_script_path(const char *script_root, const char *suffix)
3530 {
3531         struct dirent *script_dirent, *lang_dirent;
3532         char scripts_path[MAXPATHLEN];
3533         char script_path[MAXPATHLEN];
3534         DIR *scripts_dir, *lang_dir;
3535         char lang_path[MAXPATHLEN];
3536         char *__script_root;
3537
3538         snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3539
3540         scripts_dir = opendir(scripts_path);
3541         if (!scripts_dir)
3542                 return NULL;
3543
3544         for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3545                 scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3546                           lang_dirent->d_name);
3547                 lang_dir = opendir(lang_path);
3548                 if (!lang_dir)
3549                         continue;
3550
3551                 for_each_script(lang_path, lang_dir, script_dirent) {
3552                         __script_root = get_script_root(script_dirent, suffix);
3553                         if (__script_root && !strcmp(script_root, __script_root)) {
3554                                 free(__script_root);
3555                                 closedir(scripts_dir);
3556                                 scnprintf(script_path, MAXPATHLEN, "%s/%s",
3557                                           lang_path, script_dirent->d_name);
3558                                 closedir(lang_dir);
3559                                 return strdup(script_path);
3560                         }
3561                         free(__script_root);
3562                 }
3563                 closedir(lang_dir);
3564         }
3565         closedir(scripts_dir);
3566
3567         return NULL;
3568 }
3569
3570 static bool is_top_script(const char *script_path)
3571 {
3572         return ends_with(script_path, "top") != NULL;
3573 }
3574
3575 static int has_required_arg(char *script_path)
3576 {
3577         struct script_desc *desc;
3578         int n_args = 0;
3579         char *p;
3580
3581         desc = script_desc__new(NULL);
3582
3583         if (read_script_info(desc, script_path))
3584                 goto out;
3585
3586         if (!desc->args)
3587                 goto out;
3588
3589         for (p = desc->args; *p; p++)
3590                 if (*p == '<')
3591                         n_args++;
3592 out:
3593         script_desc__delete(desc);
3594
3595         return n_args;
3596 }
3597
3598 static int have_cmd(int argc, const char **argv)
3599 {
3600         char **__argv = malloc(sizeof(const char *) * argc);
3601
3602         if (!__argv) {
3603                 pr_err("malloc failed\n");
3604                 return -1;
3605         }
3606
3607         memcpy(__argv, argv, sizeof(const char *) * argc);
3608         argc = parse_options(argc, (const char **)__argv, record_options,
3609                              NULL, PARSE_OPT_STOP_AT_NON_OPTION);
3610         free(__argv);
3611
3612         system_wide = (argc == 0);
3613
3614         return 0;
3615 }
3616
3617 static void script__setup_sample_type(struct perf_script *script)
3618 {
3619         struct perf_session *session = script->session;
3620         u64 sample_type = evlist__combined_sample_type(session->evlist);
3621
3622         callchain_param_setup(sample_type, perf_env__arch(session->machines.host.env));
3623
3624         if (script->stitch_lbr && (callchain_param.record_mode != CALLCHAIN_LBR)) {
3625                 pr_warning("Can't find LBR callchain. Switch off --stitch-lbr.\n"
3626                            "Please apply --call-graph lbr when recording.\n");
3627                 script->stitch_lbr = false;
3628         }
3629 }
3630
3631 static int process_stat_round_event(struct perf_session *session,
3632                                     union perf_event *event)
3633 {
3634         struct perf_record_stat_round *round = &event->stat_round;
3635         struct evsel *counter;
3636
3637         evlist__for_each_entry(session->evlist, counter) {
3638                 perf_stat_process_counter(&stat_config, counter);
3639                 process_stat(counter, round->time);
3640         }
3641
3642         process_stat_interval(round->time);
3643         return 0;
3644 }
3645
3646 static int process_stat_config_event(struct perf_session *session __maybe_unused,
3647                                      union perf_event *event)
3648 {
3649         perf_event__read_stat_config(&stat_config, &event->stat_config);
3650         return 0;
3651 }
3652
3653 static int set_maps(struct perf_script *script)
3654 {
3655         struct evlist *evlist = script->session->evlist;
3656
3657         if (!script->cpus || !script->threads)
3658                 return 0;
3659
3660         if (WARN_ONCE(script->allocated, "stats double allocation\n"))
3661                 return -EINVAL;
3662
3663         perf_evlist__set_maps(&evlist->core, script->cpus, script->threads);
3664
3665         if (evlist__alloc_stats(&stat_config, evlist, /*alloc_raw=*/true))
3666                 return -ENOMEM;
3667
3668         script->allocated = true;
3669         return 0;
3670 }
3671
3672 static
3673 int process_thread_map_event(struct perf_session *session,
3674                              union perf_event *event)
3675 {
3676         struct perf_tool *tool = session->tool;
3677         struct perf_script *script = container_of(tool, struct perf_script, tool);
3678
3679         if (dump_trace)
3680                 perf_event__fprintf_thread_map(event, stdout);
3681
3682         if (script->threads) {
3683                 pr_warning("Extra thread map event, ignoring.\n");
3684                 return 0;
3685         }
3686
3687         script->threads = thread_map__new_event(&event->thread_map);
3688         if (!script->threads)
3689                 return -ENOMEM;
3690
3691         return set_maps(script);
3692 }
3693
3694 static
3695 int process_cpu_map_event(struct perf_session *session,
3696                           union perf_event *event)
3697 {
3698         struct perf_tool *tool = session->tool;
3699         struct perf_script *script = container_of(tool, struct perf_script, tool);
3700
3701         if (dump_trace)
3702                 perf_event__fprintf_cpu_map(event, stdout);
3703
3704         if (script->cpus) {
3705                 pr_warning("Extra cpu map event, ignoring.\n");
3706                 return 0;
3707         }
3708
3709         script->cpus = cpu_map__new_data(&event->cpu_map.data);
3710         if (!script->cpus)
3711                 return -ENOMEM;
3712
3713         return set_maps(script);
3714 }
3715
3716 static int process_feature_event(struct perf_session *session,
3717                                  union perf_event *event)
3718 {
3719         if (event->feat.feat_id < HEADER_LAST_FEATURE)
3720                 return perf_event__process_feature(session, event);
3721         return 0;
3722 }
3723
3724 #ifdef HAVE_AUXTRACE_SUPPORT
3725 static int perf_script__process_auxtrace_info(struct perf_session *session,
3726                                               union perf_event *event)
3727 {
3728         struct perf_tool *tool = session->tool;
3729
3730         int ret = perf_event__process_auxtrace_info(session, event);
3731
3732         if (ret == 0) {
3733                 struct perf_script *script = container_of(tool, struct perf_script, tool);
3734
3735                 ret = perf_script__setup_per_event_dump(script);
3736         }
3737
3738         return ret;
3739 }
3740 #else
3741 #define perf_script__process_auxtrace_info 0
3742 #endif
3743
3744 static int parse_insn_trace(const struct option *opt __maybe_unused,
3745                             const char *str __maybe_unused,
3746                             int unset __maybe_unused)
3747 {
3748         parse_output_fields(NULL, "+insn,-event,-period", 0);
3749         itrace_parse_synth_opts(opt, "i0ns", 0);
3750         symbol_conf.nanosecs = true;
3751         return 0;
3752 }
3753
3754 static int parse_xed(const struct option *opt __maybe_unused,
3755                      const char *str __maybe_unused,
3756                      int unset __maybe_unused)
3757 {
3758         if (isatty(1))
3759                 force_pager("xed -F insn: -A -64 | less");
3760         else
3761                 force_pager("xed -F insn: -A -64");
3762         return 0;
3763 }
3764
3765 static int parse_call_trace(const struct option *opt __maybe_unused,
3766                             const char *str __maybe_unused,
3767                             int unset __maybe_unused)
3768 {
3769         parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent", 0);
3770         itrace_parse_synth_opts(opt, "cewp", 0);
3771         symbol_conf.nanosecs = true;
3772         symbol_conf.pad_output_len_dso = 50;
3773         return 0;
3774 }
3775
3776 static int parse_callret_trace(const struct option *opt __maybe_unused,
3777                             const char *str __maybe_unused,
3778                             int unset __maybe_unused)
3779 {
3780         parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent,+flags", 0);
3781         itrace_parse_synth_opts(opt, "crewp", 0);
3782         symbol_conf.nanosecs = true;
3783         return 0;
3784 }
3785
3786 int cmd_script(int argc, const char **argv)
3787 {
3788         bool show_full_info = false;
3789         bool header = false;
3790         bool header_only = false;
3791         bool script_started = false;
3792         bool unsorted_dump = false;
3793         char *rec_script_path = NULL;
3794         char *rep_script_path = NULL;
3795         struct perf_session *session;
3796         struct itrace_synth_opts itrace_synth_opts = {
3797                 .set = false,
3798                 .default_no_sample = true,
3799         };
3800         struct utsname uts;
3801         char *script_path = NULL;
3802         const char *dlfilter_file = NULL;
3803         const char **__argv;
3804         int i, j, err = 0;
3805         struct perf_script script = {
3806                 .tool = {
3807                         .sample          = process_sample_event,
3808                         .mmap            = perf_event__process_mmap,
3809                         .mmap2           = perf_event__process_mmap2,
3810                         .comm            = perf_event__process_comm,
3811                         .namespaces      = perf_event__process_namespaces,
3812                         .cgroup          = perf_event__process_cgroup,
3813                         .exit            = perf_event__process_exit,
3814                         .fork            = perf_event__process_fork,
3815                         .attr            = process_attr,
3816                         .event_update   = perf_event__process_event_update,
3817 #ifdef HAVE_LIBTRACEEVENT
3818                         .tracing_data    = perf_event__process_tracing_data,
3819 #endif
3820                         .feature         = process_feature_event,
3821                         .build_id        = perf_event__process_build_id,
3822                         .id_index        = perf_event__process_id_index,
3823                         .auxtrace_info   = perf_script__process_auxtrace_info,
3824                         .auxtrace        = perf_event__process_auxtrace,
3825                         .auxtrace_error  = perf_event__process_auxtrace_error,
3826                         .stat            = perf_event__process_stat_event,
3827                         .stat_round      = process_stat_round_event,
3828                         .stat_config     = process_stat_config_event,
3829                         .thread_map      = process_thread_map_event,
3830                         .cpu_map         = process_cpu_map_event,
3831                         .throttle        = process_throttle_event,
3832                         .unthrottle      = process_throttle_event,
3833                         .ordered_events  = true,
3834                         .ordering_requires_timestamps = true,
3835                 },
3836         };
3837         struct perf_data data = {
3838                 .mode = PERF_DATA_MODE_READ,
3839         };
3840         const struct option options[] = {
3841         OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
3842                     "dump raw trace in ASCII"),
3843         OPT_BOOLEAN(0, "dump-unsorted-raw-trace", &unsorted_dump,
3844                     "dump unsorted raw trace in ASCII"),
3845         OPT_INCR('v', "verbose", &verbose,
3846                  "be more verbose (show symbol address, etc)"),
3847         OPT_BOOLEAN('L', "Latency", &latency_format,
3848                     "show latency attributes (irqs/preemption disabled, etc)"),
3849         OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
3850                            list_available_scripts),
3851         OPT_CALLBACK_NOOPT(0, "list-dlfilters", NULL, NULL, "list available dlfilters",
3852                            list_available_dlfilters),
3853         OPT_CALLBACK('s', "script", NULL, "name",
3854                      "script file name (lang:script name, script name, or *)",
3855                      parse_scriptname),
3856         OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
3857                    "generate perf-script.xx script in specified language"),
3858         OPT_STRING(0, "dlfilter", &dlfilter_file, "file", "filter .so file name"),
3859         OPT_CALLBACK(0, "dlarg", NULL, "argument", "filter argument",
3860                      add_dlarg),
3861         OPT_STRING('i', "input", &input_name, "file", "input file name"),
3862         OPT_BOOLEAN('d', "debug-mode", &debug_mode,
3863                    "do various checks like samples ordering and lost events"),
3864         OPT_BOOLEAN(0, "header", &header, "Show data header."),
3865         OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
3866         OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
3867                    "file", "vmlinux pathname"),
3868         OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
3869                    "file", "kallsyms pathname"),
3870         OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
3871                     "When printing symbols do not display call chain"),
3872         OPT_CALLBACK(0, "symfs", NULL, "directory",
3873                      "Look for files with symbols relative to this directory",
3874                      symbol__config_symfs),
3875         OPT_CALLBACK('F', "fields", NULL, "str",
3876                      "comma separated output fields prepend with 'type:'. "
3877                      "+field to add and -field to remove."
3878                      "Valid types: hw,sw,trace,raw,synth. "
3879                      "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
3880                      "addr,symoff,srcline,period,iregs,uregs,brstack,"
3881                      "brstacksym,flags,data_src,weight,bpf-output,brstackinsn,"
3882                      "brstackinsnlen,brstackoff,callindent,insn,insnlen,synth,"
3883                      "phys_addr,metric,misc,srccode,ipc,tod,data_page_size,"
3884                      "code_page_size,ins_lat,machine_pid,vcpu,cgroup,retire_lat",
3885                      parse_output_fields),
3886         OPT_BOOLEAN('a', "all-cpus", &system_wide,
3887                     "system-wide collection from all CPUs"),
3888         OPT_STRING(0, "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
3889                    "only consider symbols in these DSOs"),
3890         OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
3891                    "only consider these symbols"),
3892         OPT_INTEGER(0, "addr-range", &symbol_conf.addr_range,
3893                     "Use with -S to list traced records within address range"),
3894         OPT_CALLBACK_OPTARG(0, "insn-trace", &itrace_synth_opts, NULL, NULL,
3895                         "Decode instructions from itrace", parse_insn_trace),
3896         OPT_CALLBACK_OPTARG(0, "xed", NULL, NULL, NULL,
3897                         "Run xed disassembler on output", parse_xed),
3898         OPT_CALLBACK_OPTARG(0, "call-trace", &itrace_synth_opts, NULL, NULL,
3899                         "Decode calls from itrace", parse_call_trace),
3900         OPT_CALLBACK_OPTARG(0, "call-ret-trace", &itrace_synth_opts, NULL, NULL,
3901                         "Decode calls and returns from itrace", parse_callret_trace),
3902         OPT_STRING(0, "graph-function", &symbol_conf.graph_function, "symbol[,symbol...]",
3903                         "Only print symbols and callees with --call-trace/--call-ret-trace"),
3904         OPT_STRING(0, "stop-bt", &symbol_conf.bt_stop_list_str, "symbol[,symbol...]",
3905                    "Stop display of callgraph at these symbols"),
3906         OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
3907         OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
3908                    "only display events for these comms"),
3909         OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
3910                    "only consider symbols in these pids"),
3911         OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
3912                    "only consider symbols in these tids"),
3913         OPT_UINTEGER(0, "max-stack", &scripting_max_stack,
3914                      "Set the maximum stack depth when parsing the callchain, "
3915                      "anything beyond the specified depth will be ignored. "
3916                      "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
3917         OPT_BOOLEAN(0, "reltime", &reltime, "Show time stamps relative to start"),
3918         OPT_BOOLEAN(0, "deltatime", &deltatime, "Show time stamps relative to previous event"),
3919         OPT_BOOLEAN('I', "show-info", &show_full_info,
3920                     "display extended information from perf.data file"),
3921         OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
3922                     "Show the path of [kernel.kallsyms]"),
3923         OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
3924                     "Show the fork/comm/exit events"),
3925         OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
3926                     "Show the mmap events"),
3927         OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
3928                     "Show context switch events (if recorded)"),
3929         OPT_BOOLEAN('\0', "show-namespace-events", &script.show_namespace_events,
3930                     "Show namespace events (if recorded)"),
3931         OPT_BOOLEAN('\0', "show-cgroup-events", &script.show_cgroup_events,
3932                     "Show cgroup events (if recorded)"),
3933         OPT_BOOLEAN('\0', "show-lost-events", &script.show_lost_events,
3934                     "Show lost events (if recorded)"),
3935         OPT_BOOLEAN('\0', "show-round-events", &script.show_round_events,
3936                     "Show round events (if recorded)"),
3937         OPT_BOOLEAN('\0', "show-bpf-events", &script.show_bpf_events,
3938                     "Show bpf related events (if recorded)"),
3939         OPT_BOOLEAN('\0', "show-text-poke-events", &script.show_text_poke_events,
3940                     "Show text poke related events (if recorded)"),
3941         OPT_BOOLEAN('\0', "per-event-dump", &script.per_event_dump,
3942                     "Dump trace output to files named by the monitored events"),
3943         OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
3944         OPT_INTEGER(0, "max-blocks", &max_blocks,
3945                     "Maximum number of code blocks to dump with brstackinsn"),
3946         OPT_BOOLEAN(0, "ns", &symbol_conf.nanosecs,
3947                     "Use 9 decimal places when displaying time"),
3948         OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
3949                             "Instruction Tracing options\n" ITRACE_HELP,
3950                             itrace_parse_synth_opts),
3951         OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
3952                         "Show full source file name path for source lines"),
3953         OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
3954                         "Enable symbol demangling"),
3955         OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
3956                         "Enable kernel symbol demangling"),
3957         OPT_STRING(0, "time", &script.time_str, "str",
3958                    "Time span of interest (start,stop)"),
3959         OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
3960                     "Show inline function"),
3961         OPT_STRING(0, "guestmount", &symbol_conf.guestmount, "directory",
3962                    "guest mount directory under which every guest os"
3963                    " instance has a subdir"),
3964         OPT_STRING(0, "guestvmlinux", &symbol_conf.default_guest_vmlinux_name,
3965                    "file", "file saving guest os vmlinux"),
3966         OPT_STRING(0, "guestkallsyms", &symbol_conf.default_guest_kallsyms,
3967                    "file", "file saving guest os /proc/kallsyms"),
3968         OPT_STRING(0, "guestmodules", &symbol_conf.default_guest_modules,
3969                    "file", "file saving guest os /proc/modules"),
3970         OPT_BOOLEAN(0, "guest-code", &symbol_conf.guest_code,
3971                     "Guest code can be found in hypervisor process"),
3972         OPT_BOOLEAN('\0', "stitch-lbr", &script.stitch_lbr,
3973                     "Enable LBR callgraph stitching approach"),
3974         OPTS_EVSWITCH(&script.evswitch),
3975         OPT_END()
3976         };
3977         const char * const script_subcommands[] = { "record", "report", NULL };
3978         const char *script_usage[] = {
3979                 "perf script [<options>]",
3980                 "perf script [<options>] record <script> [<record-options>] <command>",
3981                 "perf script [<options>] report <script> [script-args]",
3982                 "perf script [<options>] <script> [<record-options>] <command>",
3983                 "perf script [<options>] <top-script> [script-args]",
3984                 NULL
3985         };
3986
3987         perf_set_singlethreaded();
3988
3989         setup_scripting();
3990
3991         argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
3992                              PARSE_OPT_STOP_AT_NON_OPTION);
3993
3994         if (symbol_conf.guestmount ||
3995             symbol_conf.default_guest_vmlinux_name ||
3996             symbol_conf.default_guest_kallsyms ||
3997             symbol_conf.default_guest_modules ||
3998             symbol_conf.guest_code) {
3999                 /*
4000                  * Enable guest sample processing.
4001                  */
4002                 perf_guest = true;
4003         }
4004
4005         data.path  = input_name;
4006         data.force = symbol_conf.force;
4007
4008         if (unsorted_dump) {
4009                 dump_trace = true;
4010                 script.tool.ordered_events = false;
4011         }
4012
4013         if (symbol__validate_sym_arguments())
4014                 return -1;
4015
4016         if (argc > 1 && strlen(argv[0]) > 2 && strstarts("record", argv[0])) {
4017                 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
4018                 if (!rec_script_path)
4019                         return cmd_record(argc, argv);
4020         }
4021
4022         if (argc > 1 && strlen(argv[0]) > 2 && strstarts("report", argv[0])) {
4023                 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
4024                 if (!rep_script_path) {
4025                         fprintf(stderr,
4026                                 "Please specify a valid report script"
4027                                 "(see 'perf script -l' for listing)\n");
4028                         return -1;
4029                 }
4030         }
4031
4032         if (reltime && deltatime) {
4033                 fprintf(stderr,
4034                         "reltime and deltatime - the two don't get along well. "
4035                         "Please limit to --reltime or --deltatime.\n");
4036                 return -1;
4037         }
4038
4039         if ((itrace_synth_opts.callchain || itrace_synth_opts.add_callchain) &&
4040             itrace_synth_opts.callchain_sz > scripting_max_stack)
4041                 scripting_max_stack = itrace_synth_opts.callchain_sz;
4042
4043         /* make sure PERF_EXEC_PATH is set for scripts */
4044         set_argv_exec_path(get_argv_exec_path());
4045
4046         if (argc && !script_name && !rec_script_path && !rep_script_path) {
4047                 int live_pipe[2];
4048                 int rep_args;
4049                 pid_t pid;
4050
4051                 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
4052                 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
4053
4054                 if (!rec_script_path && !rep_script_path) {
4055                         script_name = find_script(argv[0]);
4056                         if (script_name) {
4057                                 argc -= 1;
4058                                 argv += 1;
4059                                 goto script_found;
4060                         }
4061                         usage_with_options_msg(script_usage, options,
4062                                 "Couldn't find script `%s'\n\n See perf"
4063                                 " script -l for available scripts.\n", argv[0]);
4064                 }
4065
4066                 if (is_top_script(argv[0])) {
4067                         rep_args = argc - 1;
4068                 } else {
4069                         int rec_args;
4070
4071                         rep_args = has_required_arg(rep_script_path);
4072                         rec_args = (argc - 1) - rep_args;
4073                         if (rec_args < 0) {
4074                                 usage_with_options_msg(script_usage, options,
4075                                         "`%s' script requires options."
4076                                         "\n\n See perf script -l for available "
4077                                         "scripts and options.\n", argv[0]);
4078                         }
4079                 }
4080
4081                 if (pipe(live_pipe) < 0) {
4082                         perror("failed to create pipe");
4083                         return -1;
4084                 }
4085
4086                 pid = fork();
4087                 if (pid < 0) {
4088                         perror("failed to fork");
4089                         return -1;
4090                 }
4091
4092                 if (!pid) {
4093                         j = 0;
4094
4095                         dup2(live_pipe[1], 1);
4096                         close(live_pipe[0]);
4097
4098                         if (is_top_script(argv[0])) {
4099                                 system_wide = true;
4100                         } else if (!system_wide) {
4101                                 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
4102                                         err = -1;
4103                                         goto out;
4104                                 }
4105                         }
4106
4107                         __argv = malloc((argc + 6) * sizeof(const char *));
4108                         if (!__argv) {
4109                                 pr_err("malloc failed\n");
4110                                 err = -ENOMEM;
4111                                 goto out;
4112                         }
4113
4114                         __argv[j++] = "/bin/sh";
4115                         __argv[j++] = rec_script_path;
4116                         if (system_wide)
4117                                 __argv[j++] = "-a";
4118                         __argv[j++] = "-q";
4119                         __argv[j++] = "-o";
4120                         __argv[j++] = "-";
4121                         for (i = rep_args + 1; i < argc; i++)
4122                                 __argv[j++] = argv[i];
4123                         __argv[j++] = NULL;
4124
4125                         execvp("/bin/sh", (char **)__argv);
4126                         free(__argv);
4127                         exit(-1);
4128                 }
4129
4130                 dup2(live_pipe[0], 0);
4131                 close(live_pipe[1]);
4132
4133                 __argv = malloc((argc + 4) * sizeof(const char *));
4134                 if (!__argv) {
4135                         pr_err("malloc failed\n");
4136                         err = -ENOMEM;
4137                         goto out;
4138                 }
4139
4140                 j = 0;
4141                 __argv[j++] = "/bin/sh";
4142                 __argv[j++] = rep_script_path;
4143                 for (i = 1; i < rep_args + 1; i++)
4144                         __argv[j++] = argv[i];
4145                 __argv[j++] = "-i";
4146                 __argv[j++] = "-";
4147                 __argv[j++] = NULL;
4148
4149                 execvp("/bin/sh", (char **)__argv);
4150                 free(__argv);
4151                 exit(-1);
4152         }
4153 script_found:
4154         if (rec_script_path)
4155                 script_path = rec_script_path;
4156         if (rep_script_path)
4157                 script_path = rep_script_path;
4158
4159         if (script_path) {
4160                 j = 0;
4161
4162                 if (!rec_script_path)
4163                         system_wide = false;
4164                 else if (!system_wide) {
4165                         if (have_cmd(argc - 1, &argv[1]) != 0) {
4166                                 err = -1;
4167                                 goto out;
4168                         }
4169                 }
4170
4171                 __argv = malloc((argc + 2) * sizeof(const char *));
4172                 if (!__argv) {
4173                         pr_err("malloc failed\n");
4174                         err = -ENOMEM;
4175                         goto out;
4176                 }
4177
4178                 __argv[j++] = "/bin/sh";
4179                 __argv[j++] = script_path;
4180                 if (system_wide)
4181                         __argv[j++] = "-a";
4182                 for (i = 2; i < argc; i++)
4183                         __argv[j++] = argv[i];
4184                 __argv[j++] = NULL;
4185
4186                 execvp("/bin/sh", (char **)__argv);
4187                 free(__argv);
4188                 exit(-1);
4189         }
4190
4191         if (dlfilter_file) {
4192                 dlfilter = dlfilter__new(dlfilter_file, dlargc, dlargv);
4193                 if (!dlfilter)
4194                         return -1;
4195         }
4196
4197         if (!script_name) {
4198                 setup_pager();
4199                 use_browser = 0;
4200         }
4201
4202         session = perf_session__new(&data, &script.tool);
4203         if (IS_ERR(session))
4204                 return PTR_ERR(session);
4205
4206         if (header || header_only) {
4207                 script.tool.show_feat_hdr = SHOW_FEAT_HEADER;
4208                 perf_session__fprintf_info(session, stdout, show_full_info);
4209                 if (header_only)
4210                         goto out_delete;
4211         }
4212         if (show_full_info)
4213                 script.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
4214
4215         if (symbol__init(&session->header.env) < 0)
4216                 goto out_delete;
4217
4218         uname(&uts);
4219         if (data.is_pipe) { /* Assume pipe_mode indicates native_arch */
4220                 native_arch = true;
4221         } else if (session->header.env.arch) {
4222                 if (!strcmp(uts.machine, session->header.env.arch))
4223                         native_arch = true;
4224                 else if (!strcmp(uts.machine, "x86_64") &&
4225                          !strcmp(session->header.env.arch, "i386"))
4226                         native_arch = true;
4227         }
4228
4229         script.session = session;
4230         script__setup_sample_type(&script);
4231
4232         if ((output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT) ||
4233             symbol_conf.graph_function)
4234                 itrace_synth_opts.thread_stack = true;
4235
4236         session->itrace_synth_opts = &itrace_synth_opts;
4237
4238         if (cpu_list) {
4239                 err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
4240                 if (err < 0)
4241                         goto out_delete;
4242                 itrace_synth_opts.cpu_bitmap = cpu_bitmap;
4243         }
4244
4245         if (!no_callchain)
4246                 symbol_conf.use_callchain = true;
4247         else
4248                 symbol_conf.use_callchain = false;
4249
4250 #ifdef HAVE_LIBTRACEEVENT
4251         if (session->tevent.pevent &&
4252             tep_set_function_resolver(session->tevent.pevent,
4253                                       machine__resolve_kernel_addr,
4254                                       &session->machines.host) < 0) {
4255                 pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
4256                 err = -1;
4257                 goto out_delete;
4258         }
4259 #endif
4260         if (generate_script_lang) {
4261                 struct stat perf_stat;
4262                 int input;
4263
4264                 if (output_set_by_user()) {
4265                         fprintf(stderr,
4266                                 "custom fields not supported for generated scripts");
4267                         err = -EINVAL;
4268                         goto out_delete;
4269                 }
4270
4271                 input = open(data.path, O_RDONLY);      /* input_name */
4272                 if (input < 0) {
4273                         err = -errno;
4274                         perror("failed to open file");
4275                         goto out_delete;
4276                 }
4277
4278                 err = fstat(input, &perf_stat);
4279                 if (err < 0) {
4280                         perror("failed to stat file");
4281                         goto out_delete;
4282                 }
4283
4284                 if (!perf_stat.st_size) {
4285                         fprintf(stderr, "zero-sized file, nothing to do!\n");
4286                         goto out_delete;
4287                 }
4288
4289                 scripting_ops = script_spec__lookup(generate_script_lang);
4290                 if (!scripting_ops) {
4291                         fprintf(stderr, "invalid language specifier");
4292                         err = -ENOENT;
4293                         goto out_delete;
4294                 }
4295 #ifdef HAVE_LIBTRACEEVENT
4296                 err = scripting_ops->generate_script(session->tevent.pevent,
4297                                                      "perf-script");
4298 #else
4299                 err = scripting_ops->generate_script(NULL, "perf-script");
4300 #endif
4301                 goto out_delete;
4302         }
4303
4304         err = dlfilter__start(dlfilter, session);
4305         if (err)
4306                 goto out_delete;
4307
4308         if (script_name) {
4309                 err = scripting_ops->start_script(script_name, argc, argv, session);
4310                 if (err)
4311                         goto out_delete;
4312                 pr_debug("perf script started with script %s\n\n", script_name);
4313                 script_started = true;
4314         }
4315
4316
4317         err = perf_session__check_output_opt(session);
4318         if (err < 0)
4319                 goto out_delete;
4320
4321         if (script.time_str) {
4322                 err = perf_time__parse_for_ranges_reltime(script.time_str, session,
4323                                                   &script.ptime_range,
4324                                                   &script.range_size,
4325                                                   &script.range_num,
4326                                                   reltime);
4327                 if (err < 0)
4328                         goto out_delete;
4329
4330                 itrace_synth_opts__set_time_range(&itrace_synth_opts,
4331                                                   script.ptime_range,
4332                                                   script.range_num);
4333         }
4334
4335         err = evswitch__init(&script.evswitch, session->evlist, stderr);
4336         if (err)
4337                 goto out_delete;
4338
4339         if (zstd_init(&(session->zstd_data), 0) < 0)
4340                 pr_warning("Decompression initialization failed. Reported data may be incomplete.\n");
4341
4342         err = __cmd_script(&script);
4343
4344         flush_scripting();
4345
4346 out_delete:
4347         if (script.ptime_range) {
4348                 itrace_synth_opts__clear_time_range(&itrace_synth_opts);
4349                 zfree(&script.ptime_range);
4350         }
4351
4352         zstd_fini(&(session->zstd_data));
4353         evlist__free_stats(session->evlist);
4354         perf_session__delete(session);
4355         perf_script__exit(&script);
4356
4357         if (script_started)
4358                 cleanup_scripting();
4359         dlfilter__cleanup(dlfilter);
4360         free_dlarg();
4361 out:
4362         return err;
4363 }