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