// SPDX-License-Identifier: GPL-2.0
#include "builtin.h"

#include "perf.h"
#include "util/cache.h"
#include "util/debug.h"
#include <subcmd/exec-cmd.h>
#include "util/header.h"
#include <subcmd/parse-options.h>
#include "util/perf_regs.h"
#include "util/session.h"
#include "util/tool.h"
#include "util/symbol.h"
#include "util/thread.h"
#include "util/trace-event.h"
#include "util/util.h"
#include "util/evlist.h"
#include "util/evsel.h"
#include "util/sort.h"
#include "util/data.h"
#include "util/auxtrace.h"
#include "util/cpumap.h"
#include "util/thread_map.h"
#include "util/stat.h"
#include "util/color.h"
#include "util/string2.h"
#include "util/thread-stack.h"
#include "util/time-utils.h"
#include "util/path.h"
#include "print_binary.h"
#include <linux/bitmap.h>
#include <linux/kernel.h>
#include <linux/stringify.h>
#include <linux/time64.h>
#include "asm/bug.h"
#include "util/mem-events.h"
#include "util/dump-insn.h"
#include <dirent.h>
#include <errno.h>
#include <inttypes.h>
#include <signal.h>
#include <sys/param.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <unistd.h>
#include <subcmd/pager.h>

#include "sane_ctype.h"

static char const               *script_name;
static char const               *generate_script_lang;
static bool                     debug_mode;
static u64                      last_timestamp;
static u64                      nr_unordered;
static bool                     no_callchain;
static bool                     latency_format;
static bool                     system_wide;
static bool                     print_flags;
static bool                     nanosecs;
static const char               *cpu_list;
static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
static struct perf_stat_config  stat_config;
static int                      max_blocks;

unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;

enum perf_output_field {
        PERF_OUTPUT_COMM            = 1U << 0,
        PERF_OUTPUT_TID             = 1U << 1,
        PERF_OUTPUT_PID             = 1U << 2,
        PERF_OUTPUT_TIME            = 1U << 3,
        PERF_OUTPUT_CPU             = 1U << 4,
        PERF_OUTPUT_EVNAME          = 1U << 5,
        PERF_OUTPUT_TRACE           = 1U << 6,
        PERF_OUTPUT_IP              = 1U << 7,
        PERF_OUTPUT_SYM             = 1U << 8,
        PERF_OUTPUT_DSO             = 1U << 9,
        PERF_OUTPUT_ADDR            = 1U << 10,
        PERF_OUTPUT_SYMOFFSET       = 1U << 11,
        PERF_OUTPUT_SRCLINE         = 1U << 12,
        PERF_OUTPUT_PERIOD          = 1U << 13,
        PERF_OUTPUT_IREGS           = 1U << 14,
        PERF_OUTPUT_BRSTACK         = 1U << 15,
        PERF_OUTPUT_BRSTACKSYM      = 1U << 16,
        PERF_OUTPUT_DATA_SRC        = 1U << 17,
        PERF_OUTPUT_WEIGHT          = 1U << 18,
        PERF_OUTPUT_BPF_OUTPUT      = 1U << 19,
        PERF_OUTPUT_CALLINDENT      = 1U << 20,
        PERF_OUTPUT_INSN            = 1U << 21,
        PERF_OUTPUT_INSNLEN         = 1U << 22,
        PERF_OUTPUT_BRSTACKINSN     = 1U << 23,
        PERF_OUTPUT_BRSTACKOFF      = 1U << 24,
        PERF_OUTPUT_SYNTH           = 1U << 25,
        PERF_OUTPUT_PHYS_ADDR       = 1U << 26,
        PERF_OUTPUT_UREGS           = 1U << 27,
        PERF_OUTPUT_METRIC          = 1U << 28,
        PERF_OUTPUT_MISC            = 1U << 29,
        PERF_OUTPUT_SRCCODE         = 1U << 30,
};

struct output_option {
        const char *str;
        enum perf_output_field field;
} all_output_options[] = {
        {.str = "comm",  .field = PERF_OUTPUT_COMM},
        {.str = "tid",   .field = PERF_OUTPUT_TID},
        {.str = "pid",   .field = PERF_OUTPUT_PID},
        {.str = "time",  .field = PERF_OUTPUT_TIME},
        {.str = "cpu",   .field = PERF_OUTPUT_CPU},
        {.str = "event", .field = PERF_OUTPUT_EVNAME},
        {.str = "trace", .field = PERF_OUTPUT_TRACE},
        {.str = "ip",    .field = PERF_OUTPUT_IP},
        {.str = "sym",   .field = PERF_OUTPUT_SYM},
        {.str = "dso",   .field = PERF_OUTPUT_DSO},
        {.str = "addr",  .field = PERF_OUTPUT_ADDR},
        {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
        {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
        {.str = "period", .field = PERF_OUTPUT_PERIOD},
        {.str = "iregs", .field = PERF_OUTPUT_IREGS},
        {.str = "uregs", .field = PERF_OUTPUT_UREGS},
        {.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
        {.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
        {.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
        {.str = "weight",   .field = PERF_OUTPUT_WEIGHT},
        {.str = "bpf-output",   .field = PERF_OUTPUT_BPF_OUTPUT},
        {.str = "callindent", .field = PERF_OUTPUT_CALLINDENT},
        {.str = "insn", .field = PERF_OUTPUT_INSN},
        {.str = "insnlen", .field = PERF_OUTPUT_INSNLEN},
        {.str = "brstackinsn", .field = PERF_OUTPUT_BRSTACKINSN},
        {.str = "brstackoff", .field = PERF_OUTPUT_BRSTACKOFF},
        {.str = "synth", .field = PERF_OUTPUT_SYNTH},
        {.str = "phys_addr", .field = PERF_OUTPUT_PHYS_ADDR},
        {.str = "metric", .field = PERF_OUTPUT_METRIC},
        {.str = "misc", .field = PERF_OUTPUT_MISC},
        {.str = "srccode", .field = PERF_OUTPUT_SRCCODE},
};

enum {
        OUTPUT_TYPE_SYNTH = PERF_TYPE_MAX,
        OUTPUT_TYPE_MAX
};

/* default set to maintain compatibility with current format */
static struct {
        bool user_set;
        bool wildcard_set;
        unsigned int print_ip_opts;
        u64 fields;
        u64 invalid_fields;
} output[OUTPUT_TYPE_MAX] = {

        [PERF_TYPE_HARDWARE] = {
                .user_set = false,

                .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
                              PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
                              PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
                              PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
                              PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,

                .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
        },

        [PERF_TYPE_SOFTWARE] = {
                .user_set = false,

                .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
                              PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
                              PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
                              PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
                              PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
                              PERF_OUTPUT_BPF_OUTPUT,

                .invalid_fields = PERF_OUTPUT_TRACE,
        },

        [PERF_TYPE_TRACEPOINT] = {
                .user_set = false,

                .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
                                  PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
                                  PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
        },

        [PERF_TYPE_HW_CACHE] = {
                .user_set = false,

                .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
                              PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
                              PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
                              PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
                              PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,

                .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
        },

        [PERF_TYPE_RAW] = {
                .user_set = false,

                .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
                              PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
                              PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
                              PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
                              PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
                              PERF_OUTPUT_ADDR | PERF_OUTPUT_DATA_SRC |
                              PERF_OUTPUT_WEIGHT | PERF_OUTPUT_PHYS_ADDR,

                .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
        },

        [PERF_TYPE_BREAKPOINT] = {
                .user_set = false,

                .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
                              PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
                              PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
                              PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
                              PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,

                .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
        },

        [OUTPUT_TYPE_SYNTH] = {
                .user_set = false,

                .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
                              PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
                              PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
                              PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
                              PERF_OUTPUT_DSO | PERF_OUTPUT_SYNTH,

                .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
        },
};

struct perf_evsel_script {
       char *filename;
       FILE *fp;
       u64  samples;
       /* For metric output */
       u64  val;
       int  gnum;
};

static inline struct perf_evsel_script *evsel_script(struct perf_evsel *evsel)
{
        return (struct perf_evsel_script *)evsel->priv;
}

static struct perf_evsel_script *perf_evsel_script__new(struct perf_evsel *evsel,
                                                        struct perf_data *data)
{
        struct perf_evsel_script *es = zalloc(sizeof(*es));

        if (es != NULL) {
                if (asprintf(&es->filename, "%s.%s.dump", data->file.path, perf_evsel__name(evsel)) < 0)
                        goto out_free;
                es->fp = fopen(es->filename, "w");
                if (es->fp == NULL)
                        goto out_free_filename;
        }

        return es;
out_free_filename:
        zfree(&es->filename);
out_free:
        free(es);
        return NULL;
}

static void perf_evsel_script__delete(struct perf_evsel_script *es)
{
        zfree(&es->filename);
        fclose(es->fp);
        es->fp = NULL;
        free(es);
}

static int perf_evsel_script__fprintf(struct perf_evsel_script *es, FILE *fp)
{
        struct stat st;

        fstat(fileno(es->fp), &st);
        return fprintf(fp, "[ perf script: Wrote %.3f MB %s (%" PRIu64 " samples) ]\n",
                       st.st_size / 1024.0 / 1024.0, es->filename, es->samples);
}

static inline int output_type(unsigned int type)
{
        switch (type) {
        case PERF_TYPE_SYNTH:
                return OUTPUT_TYPE_SYNTH;
        default:
                return type;
        }
}

static inline unsigned int attr_type(unsigned int type)
{
        switch (type) {
        case OUTPUT_TYPE_SYNTH:
                return PERF_TYPE_SYNTH;
        default:
                return type;
        }
}

static bool output_set_by_user(void)
{
        int j;
        for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
                if (output[j].user_set)
                        return true;
        }
        return false;
}

static const char *output_field2str(enum perf_output_field field)
{
        int i, imax = ARRAY_SIZE(all_output_options);
        const char *str = "";

        for (i = 0; i < imax; ++i) {
                if (all_output_options[i].field == field) {
                        str = all_output_options[i].str;
                        break;
                }
        }
        return str;
}

#define PRINT_FIELD(x)  (output[output_type(attr->type)].fields & PERF_OUTPUT_##x)

static int perf_evsel__do_check_stype(struct perf_evsel *evsel,
                                      u64 sample_type, const char *sample_msg,
                                      enum perf_output_field field,
                                      bool allow_user_set)
{
        struct perf_event_attr *attr = &evsel->attr;
        int type = output_type(attr->type);
        const char *evname;

        if (attr->sample_type & sample_type)
                return 0;

        if (output[type].user_set) {
                if (allow_user_set)
                        return 0;
                evname = perf_evsel__name(evsel);
                pr_err("Samples for '%s' event do not have %s attribute set. "
                       "Cannot print '%s' field.\n",
                       evname, sample_msg, output_field2str(field));
                return -1;
        }

        /* user did not ask for it explicitly so remove from the default list */
        output[type].fields &= ~field;
        evname = perf_evsel__name(evsel);
        pr_debug("Samples for '%s' event do not have %s attribute set. "
                 "Skipping '%s' field.\n",
                 evname, sample_msg, output_field2str(field));

        return 0;
}

static int perf_evsel__check_stype(struct perf_evsel *evsel,
                                   u64 sample_type, const char *sample_msg,
                                   enum perf_output_field field)
{
        return perf_evsel__do_check_stype(evsel, sample_type, sample_msg, field,
                                          false);
}

static int perf_evsel__check_attr(struct perf_evsel *evsel,
                                  struct perf_session *session)
{
        struct perf_event_attr *attr = &evsel->attr;
        bool allow_user_set;

        if (perf_header__has_feat(&session->header, HEADER_STAT))
                return 0;

        allow_user_set = perf_header__has_feat(&session->header,
                                               HEADER_AUXTRACE);

        if (PRINT_FIELD(TRACE) &&
                !perf_session__has_traces(session, "record -R"))
                return -EINVAL;

        if (PRINT_FIELD(IP)) {
                if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
                                            PERF_OUTPUT_IP))
                        return -EINVAL;
        }

        if (PRINT_FIELD(ADDR) &&
                perf_evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
                                           PERF_OUTPUT_ADDR, allow_user_set))
                return -EINVAL;

        if (PRINT_FIELD(DATA_SRC) &&
                perf_evsel__check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC",
                                        PERF_OUTPUT_DATA_SRC))
                return -EINVAL;

        if (PRINT_FIELD(WEIGHT) &&
                perf_evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT, "WEIGHT",
                                        PERF_OUTPUT_WEIGHT))
                return -EINVAL;

        if (PRINT_FIELD(SYM) &&
                !(evsel->attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
                pr_err("Display of symbols requested but neither sample IP nor "
                           "sample address\navailable. Hence, no addresses to convert "
                       "to symbols.\n");
                return -EINVAL;
        }
        if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
                pr_err("Display of offsets requested but symbol is not"
                       "selected.\n");
                return -EINVAL;
        }
        if (PRINT_FIELD(DSO) &&
                !(evsel->attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
                pr_err("Display of DSO requested but no address to convert.\n");
                return -EINVAL;
        }
        if ((PRINT_FIELD(SRCLINE) || PRINT_FIELD(SRCCODE)) && !PRINT_FIELD(IP)) {
                pr_err("Display of source line number requested but sample IP is not\n"
                       "selected. Hence, no address to lookup the source line number.\n");
                return -EINVAL;
        }
        if (PRINT_FIELD(BRSTACKINSN) &&
            !(perf_evlist__combined_branch_type(session->evlist) &
              PERF_SAMPLE_BRANCH_ANY)) {
                pr_err("Display of branch stack assembler requested, but non all-branch filter set\n"
                       "Hint: run 'perf record -b ...'\n");
                return -EINVAL;
        }
        if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
                perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
                                        PERF_OUTPUT_TID|PERF_OUTPUT_PID))
                return -EINVAL;

        if (PRINT_FIELD(TIME) &&
                perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
                                        PERF_OUTPUT_TIME))
                return -EINVAL;

        if (PRINT_FIELD(CPU) &&
                perf_evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
                                           PERF_OUTPUT_CPU, allow_user_set))
                return -EINVAL;

        if (PRINT_FIELD(IREGS) &&
                perf_evsel__check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS",
                                        PERF_OUTPUT_IREGS))
                return -EINVAL;

        if (PRINT_FIELD(UREGS) &&
                perf_evsel__check_stype(evsel, PERF_SAMPLE_REGS_USER, "UREGS",
                                        PERF_OUTPUT_UREGS))
                return -EINVAL;

        if (PRINT_FIELD(PHYS_ADDR) &&
                perf_evsel__check_stype(evsel, PERF_SAMPLE_PHYS_ADDR, "PHYS_ADDR",
                                        PERF_OUTPUT_PHYS_ADDR))
                return -EINVAL;

        return 0;
}

static void set_print_ip_opts(struct perf_event_attr *attr)
{
        unsigned int type = output_type(attr->type);

        output[type].print_ip_opts = 0;
        if (PRINT_FIELD(IP))
                output[type].print_ip_opts |= EVSEL__PRINT_IP;

        if (PRINT_FIELD(SYM))
                output[type].print_ip_opts |= EVSEL__PRINT_SYM;

        if (PRINT_FIELD(DSO))
                output[type].print_ip_opts |= EVSEL__PRINT_DSO;

        if (PRINT_FIELD(SYMOFFSET))
                output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;

        if (PRINT_FIELD(SRCLINE))
                output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
}

/*
 * verify all user requested events exist and the samples
 * have the expected data
 */
static int perf_session__check_output_opt(struct perf_session *session)
{
        unsigned int j;
        struct perf_evsel *evsel;

        for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
                evsel = perf_session__find_first_evtype(session, attr_type(j));

                /*
                 * even if fields is set to 0 (ie., show nothing) event must
                 * exist if user explicitly includes it on the command line
                 */
                if (!evsel && output[j].user_set && !output[j].wildcard_set &&
                    j != OUTPUT_TYPE_SYNTH) {
                        pr_err("%s events do not exist. "
                               "Remove corresponding -F option to proceed.\n",
                               event_type(j));
                        return -1;
                }

                if (evsel && output[j].fields &&
                        perf_evsel__check_attr(evsel, session))
                        return -1;

                if (evsel == NULL)
                        continue;

                set_print_ip_opts(&evsel->attr);
        }

        if (!no_callchain) {
                bool use_callchain = false;
                bool not_pipe = false;

                evlist__for_each_entry(session->evlist, evsel) {
                        not_pipe = true;
                        if (evsel__has_callchain(evsel)) {
                                use_callchain = true;
                                break;
                        }
                }
                if (not_pipe && !use_callchain)
                        symbol_conf.use_callchain = false;
        }

        /*
         * set default for tracepoints to print symbols only
         * if callchains are present
         */
        if (symbol_conf.use_callchain &&
            !output[PERF_TYPE_TRACEPOINT].user_set) {
                j = PERF_TYPE_TRACEPOINT;

                evlist__for_each_entry(session->evlist, evsel) {
                        if (evsel->attr.type != j)
                                continue;

                        if (evsel__has_callchain(evsel)) {
                                output[j].fields |= PERF_OUTPUT_IP;
                                output[j].fields |= PERF_OUTPUT_SYM;
                                output[j].fields |= PERF_OUTPUT_SYMOFFSET;
                                output[j].fields |= PERF_OUTPUT_DSO;
                                set_print_ip_opts(&evsel->attr);
                                goto out;
                        }
                }
        }

out:
        return 0;
}

static int perf_sample__fprintf_regs(struct regs_dump *regs, uint64_t mask,
                                     FILE *fp
)
{
        unsigned i = 0, r;
        int printed = 0;

        if (!regs || !regs->regs)
                return 0;

        printed += fprintf(fp, " ABI:%" PRIu64 " ", regs->abi);

        for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
                u64 val = regs->regs[i++];
                printed += fprintf(fp, "%5s:0x%"PRIx64" ", perf_reg_name(r), val);
        }

        fprintf(fp, "\n");

        return printed;
}

static int perf_sample__fprintf_iregs(struct perf_sample *sample,
                                      struct perf_event_attr *attr, FILE *fp)
{
        return perf_sample__fprintf_regs(&sample->intr_regs,
                                         attr->sample_regs_intr, fp);
}

static int perf_sample__fprintf_uregs(struct perf_sample *sample,
                                      struct perf_event_attr *attr, FILE *fp)
{
        return perf_sample__fprintf_regs(&sample->user_regs,
                                         attr->sample_regs_user, fp);
}

static int perf_sample__fprintf_start(struct perf_sample *sample,
                                      struct thread *thread,
                                      struct perf_evsel *evsel,
                                      u32 type, FILE *fp)
{
        struct perf_event_attr *attr = &evsel->attr;
        unsigned long secs;
        unsigned long long nsecs;
        int printed = 0;

        if (PRINT_FIELD(COMM)) {
                if (latency_format)
                        printed += fprintf(fp, "%8.8s ", thread__comm_str(thread));
                else if (PRINT_FIELD(IP) && evsel__has_callchain(evsel) && symbol_conf.use_callchain)
                        printed += fprintf(fp, "%s ", thread__comm_str(thread));
                else
                        printed += fprintf(fp, "%16s ", thread__comm_str(thread));
        }

        if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
                printed += fprintf(fp, "%5d/%-5d ", sample->pid, sample->tid);
        else if (PRINT_FIELD(PID))
                printed += fprintf(fp, "%5d ", sample->pid);
        else if (PRINT_FIELD(TID))
                printed += fprintf(fp, "%5d ", sample->tid);

        if (PRINT_FIELD(CPU)) {
                if (latency_format)
                        printed += fprintf(fp, "%3d ", sample->cpu);
                else
                        printed += fprintf(fp, "[%03d] ", sample->cpu);
        }

        if (PRINT_FIELD(MISC)) {
                int ret = 0;

                #define has(m) \
                        (sample->misc & PERF_RECORD_MISC_##m) == PERF_RECORD_MISC_##m

                if (has(KERNEL))
                        ret += fprintf(fp, "K");
                if (has(USER))
                        ret += fprintf(fp, "U");
                if (has(HYPERVISOR))
                        ret += fprintf(fp, "H");
                if (has(GUEST_KERNEL))
                        ret += fprintf(fp, "G");
                if (has(GUEST_USER))
                        ret += fprintf(fp, "g");

                switch (type) {
                case PERF_RECORD_MMAP:
                case PERF_RECORD_MMAP2:
                        if (has(MMAP_DATA))
                                ret += fprintf(fp, "M");
                        break;
                case PERF_RECORD_COMM:
                        if (has(COMM_EXEC))
                                ret += fprintf(fp, "E");
                        break;
                case PERF_RECORD_SWITCH:
                case PERF_RECORD_SWITCH_CPU_WIDE:
                        if (has(SWITCH_OUT)) {
                                ret += fprintf(fp, "S");
                                if (sample->misc & PERF_RECORD_MISC_SWITCH_OUT_PREEMPT)
                                        ret += fprintf(fp, "p");
                        }
                default:
                        break;
                }

                #undef has

                ret += fprintf(fp, "%*s", 6 - ret, " ");
                printed += ret;
        }

        if (PRINT_FIELD(TIME)) {
                nsecs = sample->time;
                secs = nsecs / NSEC_PER_SEC;
                nsecs -= secs * NSEC_PER_SEC;

                if (nanosecs)
                        printed += fprintf(fp, "%5lu.%09llu: ", secs, nsecs);
                else {
                        char sample_time[32];
                        timestamp__scnprintf_usec(sample->time, sample_time, sizeof(sample_time));
                        printed += fprintf(fp, "%12s: ", sample_time);
                }
        }

        return printed;
}

static inline char
mispred_str(struct branch_entry *br)
{
        if (!(br->flags.mispred  || br->flags.predicted))
                return '-';

        return br->flags.predicted ? 'P' : 'M';
}

static int perf_sample__fprintf_brstack(struct perf_sample *sample,
                                        struct thread *thread,
                                        struct perf_event_attr *attr, FILE *fp)
{
        struct branch_stack *br = sample->branch_stack;
        struct addr_location alf, alt;
        u64 i, from, to;
        int printed = 0;

        if (!(br && br->nr))
                return 0;

        for (i = 0; i < br->nr; i++) {
                from = br->entries[i].from;
                to   = br->entries[i].to;

                if (PRINT_FIELD(DSO)) {
                        memset(&alf, 0, sizeof(alf));
                        memset(&alt, 0, sizeof(alt));
                        thread__find_map_fb(thread, sample->cpumode, from, &alf);
                        thread__find_map_fb(thread, sample->cpumode, to, &alt);
                }

                printed += fprintf(fp, " 0x%"PRIx64, from);
                if (PRINT_FIELD(DSO)) {
                        printed += fprintf(fp, "(");
                        printed += map__fprintf_dsoname(alf.map, fp);
                        printed += fprintf(fp, ")");
                }

                printed += fprintf(fp, "/0x%"PRIx64, to);
                if (PRINT_FIELD(DSO)) {
                        printed += fprintf(fp, "(");
                        printed += map__fprintf_dsoname(alt.map, fp);
                        printed += fprintf(fp, ")");
                }

                printed += fprintf(fp, "/%c/%c/%c/%d ",
                        mispred_str( br->entries + i),
                        br->entries[i].flags.in_tx? 'X' : '-',
                        br->entries[i].flags.abort? 'A' : '-',
                        br->entries[i].flags.cycles);
        }

        return printed;
}

static int perf_sample__fprintf_brstacksym(struct perf_sample *sample,
                                           struct thread *thread,
                                           struct perf_event_attr *attr, FILE *fp)
{
        struct branch_stack *br = sample->branch_stack;
        struct addr_location alf, alt;
        u64 i, from, to;
        int printed = 0;

        if (!(br && br->nr))
                return 0;

        for (i = 0; i < br->nr; i++) {

                memset(&alf, 0, sizeof(alf));
                memset(&alt, 0, sizeof(alt));
                from = br->entries[i].from;
                to   = br->entries[i].to;

                thread__find_symbol_fb(thread, sample->cpumode, from, &alf);
                thread__find_symbol_fb(thread, sample->cpumode, to, &alt);

                printed += symbol__fprintf_symname_offs(alf.sym, &alf, fp);
                if (PRINT_FIELD(DSO)) {
                        printed += fprintf(fp, "(");
                        printed += map__fprintf_dsoname(alf.map, fp);
                        printed += fprintf(fp, ")");
                }
                printed += fprintf(fp, "%c", '/');
                printed += symbol__fprintf_symname_offs(alt.sym, &alt, fp);
                if (PRINT_FIELD(DSO)) {
                        printed += fprintf(fp, "(");
                        printed += map__fprintf_dsoname(alt.map, fp);
                        printed += fprintf(fp, ")");
                }
                printed += fprintf(fp, "/%c/%c/%c/%d ",
                        mispred_str( br->entries + i),
                        br->entries[i].flags.in_tx? 'X' : '-',
                        br->entries[i].flags.abort? 'A' : '-',
                        br->entries[i].flags.cycles);
        }

        return printed;
}

static int perf_sample__fprintf_brstackoff(struct perf_sample *sample,
                                           struct thread *thread,
                                           struct perf_event_attr *attr, FILE *fp)
{
        struct branch_stack *br = sample->branch_stack;
        struct addr_location alf, alt;
        u64 i, from, to;
        int printed = 0;

        if (!(br && br->nr))
                return 0;

        for (i = 0; i < br->nr; i++) {

                memset(&alf, 0, sizeof(alf));
                memset(&alt, 0, sizeof(alt));
                from = br->entries[i].from;
                to   = br->entries[i].to;

                if (thread__find_map_fb(thread, sample->cpumode, from, &alf) &&
                    !alf.map->dso->adjust_symbols)
                        from = map__map_ip(alf.map, from);

                if (thread__find_map_fb(thread, sample->cpumode, to, &alt) &&
                    !alt.map->dso->adjust_symbols)
                        to = map__map_ip(alt.map, to);

                printed += fprintf(fp, " 0x%"PRIx64, from);
                if (PRINT_FIELD(DSO)) {
                        printed += fprintf(fp, "(");
                        printed += map__fprintf_dsoname(alf.map, fp);
                        printed += fprintf(fp, ")");
                }
                printed += fprintf(fp, "/0x%"PRIx64, to);
                if (PRINT_FIELD(DSO)) {
                        printed += fprintf(fp, "(");
                        printed += map__fprintf_dsoname(alt.map, fp);
                        printed += fprintf(fp, ")");
                }
                printed += fprintf(fp, "/%c/%c/%c/%d ",
                        mispred_str(br->entries + i),
                        br->entries[i].flags.in_tx ? 'X' : '-',
                        br->entries[i].flags.abort ? 'A' : '-',
                        br->entries[i].flags.cycles);
        }

        return printed;
}
#define MAXBB 16384UL

static int grab_bb(u8 *buffer, u64 start, u64 end,
                    struct machine *machine, struct thread *thread,
                    bool *is64bit, u8 *cpumode, bool last)
{
        long offset, len;
        struct addr_location al;
        bool kernel;

        if (!start || !end)
                return 0;

        kernel = machine__kernel_ip(machine, start);
        if (kernel)
                *cpumode = PERF_RECORD_MISC_KERNEL;
        else
                *cpumode = PERF_RECORD_MISC_USER;

        /*
         * Block overlaps between kernel and user.
         * This can happen due to ring filtering
         * On Intel CPUs the entry into the kernel is filtered,
         * but the exit is not. Let the caller patch it up.
         */
        if (kernel != machine__kernel_ip(machine, end)) {
                pr_debug("\tblock %" PRIx64 "-%" PRIx64 " transfers between kernel and user\n", start, end);
                return -ENXIO;
        }

        memset(&al, 0, sizeof(al));
        if (end - start > MAXBB - MAXINSN) {
                if (last)
                        pr_debug("\tbrstack does not reach to final jump (%" PRIx64 "-%" PRIx64 ")\n", start, end);
                else
                        pr_debug("\tblock %" PRIx64 "-%" PRIx64 " (%" PRIu64 ") too long to dump\n", start, end, end - start);
                return 0;
        }

        if (!thread__find_map(thread, *cpumode, start, &al) || !al.map->dso) {
                pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
                return 0;
        }
        if (al.map->dso->data.status == DSO_DATA_STATUS_ERROR) {
                pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
                return 0;
        }

        /* Load maps to ensure dso->is_64_bit has been updated */
        map__load(al.map);

        offset = al.map->map_ip(al.map, start);
        len = dso__data_read_offset(al.map->dso, machine, offset, (u8 *)buffer,
                                    end - start + MAXINSN);

        *is64bit = al.map->dso->is_64_bit;
        if (len <= 0)
                pr_debug("\tcannot fetch code for block at %" PRIx64 "-%" PRIx64 "\n",
                        start, end);
        return len;
}

static int print_srccode(struct thread *thread, u8 cpumode, uint64_t addr)
{
        struct addr_location al;
        int ret = 0;

        memset(&al, 0, sizeof(al));
        thread__find_map(thread, cpumode, addr, &al);
        if (!al.map)
                return 0;
        ret = map__fprintf_srccode(al.map, al.addr, stdout,
                    &thread->srccode_state);
        if (ret)
                ret += printf("\n");
        return ret;
}

static int ip__fprintf_jump(uint64_t ip, struct branch_entry *en,
                            struct perf_insn *x, u8 *inbuf, int len,
                            int insn, FILE *fp, int *total_cycles)
{
        int printed = fprintf(fp, "\t%016" PRIx64 "\t%-30s\t#%s%s%s%s", ip,
                              dump_insn(x, ip, inbuf, len, NULL),
                              en->flags.predicted ? " PRED" : "",
                              en->flags.mispred ? " MISPRED" : "",
                              en->flags.in_tx ? " INTX" : "",
                              en->flags.abort ? " ABORT" : "");
        if (en->flags.cycles) {
                *total_cycles += en->flags.cycles;
                printed += fprintf(fp, " %d cycles [%d]", en->flags.cycles, *total_cycles);
                if (insn)
                        printed += fprintf(fp, " %.2f IPC", (float)insn / en->flags.cycles);
        }
        return printed + fprintf(fp, "\n");
}

static int ip__fprintf_sym(uint64_t addr, struct thread *thread,
                           u8 cpumode, int cpu, struct symbol **lastsym,
                           struct perf_event_attr *attr, FILE *fp)
{
        struct addr_location al;
        int off, printed = 0;

        memset(&al, 0, sizeof(al));

        thread__find_map(thread, cpumode, addr, &al);

        if ((*lastsym) && al.addr >= (*lastsym)->start && al.addr < (*lastsym)->end)
                return 0;

        al.cpu = cpu;
        al.sym = NULL;
        if (al.map)
                al.sym = map__find_symbol(al.map, al.addr);

        if (!al.sym)
                return 0;

        if (al.addr < al.sym->end)
                off = al.addr - al.sym->start;
        else
                off = al.addr - al.map->start - al.sym->start;
        printed += fprintf(fp, "\t%s", al.sym->name);
        if (off)
                printed += fprintf(fp, "%+d", off);
        printed += fprintf(fp, ":");
        if (PRINT_FIELD(SRCLINE))
                printed += map__fprintf_srcline(al.map, al.addr, "\t", fp);
        printed += fprintf(fp, "\n");
        *lastsym = al.sym;

        return printed;
}

static int perf_sample__fprintf_brstackinsn(struct perf_sample *sample,
                                            struct thread *thread,
                                            struct perf_event_attr *attr,
                                            struct machine *machine, FILE *fp)
{
        struct branch_stack *br = sample->branch_stack;
        u64 start, end;
        int i, insn, len, nr, ilen, printed = 0;
        struct perf_insn x;
        u8 buffer[MAXBB];
        unsigned off;
        struct symbol *lastsym = NULL;
        int total_cycles = 0;

        if (!(br && br->nr))
                return 0;

        nr = br->nr;
        if (max_blocks && nr > max_blocks + 1)
                nr = max_blocks + 1;

        x.thread = thread;
        x.cpu = sample->cpu;

        printed += fprintf(fp, "%c", '\n');

        /* Handle first from jump, of which we don't know the entry. */
        len = grab_bb(buffer, br->entries[nr-1].from,
                        br->entries[nr-1].from,
                        machine, thread, &x.is64bit, &x.cpumode, false);
        if (len > 0) {
                printed += ip__fprintf_sym(br->entries[nr - 1].from, thread,
                                           x.cpumode, x.cpu, &lastsym, attr, fp);
                printed += ip__fprintf_jump(br->entries[nr - 1].from, &br->entries[nr - 1],
                                            &x, buffer, len, 0, fp, &total_cycles);
                if (PRINT_FIELD(SRCCODE))
                        printed += print_srccode(thread, x.cpumode, br->entries[nr - 1].from);
        }

        /* Print all blocks */
        for (i = nr - 2; i >= 0; i--) {
                if (br->entries[i].from || br->entries[i].to)
                        pr_debug("%d: %" PRIx64 "-%" PRIx64 "\n", i,
                                 br->entries[i].from,
                                 br->entries[i].to);
                start = br->entries[i + 1].to;
                end   = br->entries[i].from;

                len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
                /* Patch up missing kernel transfers due to ring filters */
                if (len == -ENXIO && i > 0) {
                        end = br->entries[--i].from;
                        pr_debug("\tpatching up to %" PRIx64 "-%" PRIx64 "\n", start, end);
                        len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
                }
                if (len <= 0)
                        continue;

                insn = 0;
                for (off = 0;; off += ilen) {
                        uint64_t ip = start + off;

                        printed += ip__fprintf_sym(ip, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
                        if (ip == end) {
                                printed += ip__fprintf_jump(ip, &br->entries[i], &x, buffer + off, len - off, insn, fp,
                                                            &total_cycles);
                                if (PRINT_FIELD(SRCCODE))
                                        printed += print_srccode(thread, x.cpumode, ip);
                                break;
                        } else {
                                printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", ip,
                                                   dump_insn(&x, ip, buffer + off, len - off, &ilen));
                                if (ilen == 0)
                                        break;
                                if (PRINT_FIELD(SRCCODE))
                                        print_srccode(thread, x.cpumode, ip);
                                insn++;
                        }
                }
        }

        /*
         * Hit the branch? In this case we are already done, and the target
         * has not been executed yet.
         */
        if (br->entries[0].from == sample->ip)
                goto out;
        if (br->entries[0].flags.abort)
                goto out;

        /*
         * Print final block upto sample
         *
         * Due to pipeline delays the LBRs might be missing a branch
         * or two, which can result in very large or negative blocks
         * between final branch and sample. When this happens just
         * continue walking after the last TO until we hit a branch.
         */
        start = br->entries[0].to;
        end = sample->ip;
        if (end < start) {
                /* Missing jump. Scan 128 bytes for the next branch */
                end = start + 128;
        }
        len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, true);
        printed += ip__fprintf_sym(start, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
        if (len <= 0) {
                /* Print at least last IP if basic block did not work */
                len = grab_bb(buffer, sample->ip, sample->ip,
                              machine, thread, &x.is64bit, &x.cpumode, false);
                if (len <= 0)
                        goto out;
                printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", sample->ip,
                        dump_insn(&x, sample->ip, buffer, len, NULL));
                if (PRINT_FIELD(SRCCODE))
                        print_srccode(thread, x.cpumode, sample->ip);
                goto out;
        }
        for (off = 0; off <= end - start; off += ilen) {
                printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", start + off,
                                   dump_insn(&x, start + off, buffer + off, len - off, &ilen));
                if (ilen == 0)
                        break;
                if (arch_is_branch(buffer + off, len - off, x.is64bit) && start + off != sample->ip) {
                        /*
                         * Hit a missing branch. Just stop.
                         */
                        printed += fprintf(fp, "\t... not reaching sample ...\n");
                        break;
                }
                if (PRINT_FIELD(SRCCODE))
                        print_srccode(thread, x.cpumode, start + off);
        }
out:
        return printed;
}

static int perf_sample__fprintf_addr(struct perf_sample *sample,
                                     struct thread *thread,
                                     struct perf_event_attr *attr, FILE *fp)
{
        struct addr_location al;
        int printed = fprintf(fp, "%16" PRIx64, sample->addr);

        if (!sample_addr_correlates_sym(attr))
                goto out;

        thread__resolve(thread, &al, sample);

        if (PRINT_FIELD(SYM)) {
                printed += fprintf(fp, " ");
                if (PRINT_FIELD(SYMOFFSET))
                        printed += symbol__fprintf_symname_offs(al.sym, &al, fp);
                else
                        printed += symbol__fprintf_symname(al.sym, fp);
        }

        if (PRINT_FIELD(DSO)) {
                printed += fprintf(fp, " (");
                printed += map__fprintf_dsoname(al.map, fp);
                printed += fprintf(fp, ")");
        }
out:
        return printed;
}

static const char *resolve_branch_sym(struct perf_sample *sample,
                                      struct perf_evsel *evsel,
                                      struct thread *thread,
                                      struct addr_location *al,
                                      u64 *ip)
{
        struct addr_location addr_al;
        struct perf_event_attr *attr = &evsel->attr;
        const char *name = NULL;

        if (sample->flags & (PERF_IP_FLAG_CALL | PERF_IP_FLAG_TRACE_BEGIN)) {
                if (sample_addr_correlates_sym(attr)) {
                        thread__resolve(thread, &addr_al, sample);
                        if (addr_al.sym)
                                name = addr_al.sym->name;
                        else
                                *ip = sample->addr;
                } else {
                        *ip = sample->addr;
                }
        } else if (sample->flags & (PERF_IP_FLAG_RETURN | PERF_IP_FLAG_TRACE_END)) {
                if (al->sym)
                        name = al->sym->name;
                else
                        *ip = sample->ip;
        }
        return name;
}

static int perf_sample__fprintf_callindent(struct perf_sample *sample,
                                           struct perf_evsel *evsel,
                                           struct thread *thread,
                                           struct addr_location *al, FILE *fp)
{
        struct perf_event_attr *attr = &evsel->attr;
        size_t depth = thread_stack__depth(thread, sample->cpu);
        const char *name = NULL;
        static int spacing;
        int len = 0;
        int dlen = 0;
        u64 ip = 0;

        /*
         * The 'return' has already been popped off the stack so the depth has
         * to be adjusted to match the 'call'.
         */
        if (thread->ts && sample->flags & PERF_IP_FLAG_RETURN)
                depth += 1;

        name = resolve_branch_sym(sample, evsel, thread, al, &ip);

        if (PRINT_FIELD(DSO) && !(PRINT_FIELD(IP) || PRINT_FIELD(ADDR))) {
                dlen += fprintf(fp, "(");
                dlen += map__fprintf_dsoname(al->map, fp);
                dlen += fprintf(fp, ")\t");
        }

        if (name)
                len = fprintf(fp, "%*s%s", (int)depth * 4, "", name);
        else if (ip)
                len = fprintf(fp, "%*s%16" PRIx64, (int)depth * 4, "", ip);

        if (len < 0)
                return len;

        /*
         * Try to keep the output length from changing frequently so that the
         * output lines up more nicely.
         */
        if (len > spacing || (len && len < spacing - 52))
                spacing = round_up(len + 4, 32);

        if (len < spacing)
                len += fprintf(fp, "%*s", spacing - len, "");

        return len + dlen;
}

static int perf_sample__fprintf_insn(struct perf_sample *sample,
                                     struct perf_event_attr *attr,
                                     struct thread *thread,
                                     struct machine *machine, FILE *fp)
{
        int printed = 0;

        if (PRINT_FIELD(INSNLEN))
                printed += fprintf(fp, " ilen: %d", sample->insn_len);
        if (PRINT_FIELD(INSN)) {
                int i;

                printed += fprintf(fp, " insn:");
                for (i = 0; i < sample->insn_len; i++)
                        printed += fprintf(fp, " %02x", (unsigned char)sample->insn[i]);
        }
        if (PRINT_FIELD(BRSTACKINSN))
                printed += perf_sample__fprintf_brstackinsn(sample, thread, attr, machine, fp);

        return printed;
}

static int perf_sample__fprintf_bts(struct perf_sample *sample,
                                    struct perf_evsel *evsel,
                                    struct thread *thread,
                                    struct addr_location *al,
                                    struct machine *machine, FILE *fp)
{
        struct perf_event_attr *attr = &evsel->attr;
        unsigned int type = output_type(attr->type);
        bool print_srcline_last = false;
        int printed = 0;

        if (PRINT_FIELD(CALLINDENT))
                printed += perf_sample__fprintf_callindent(sample, evsel, thread, al, fp);

        /* print branch_from information */
        if (PRINT_FIELD(IP)) {
                unsigned int print_opts = output[type].print_ip_opts;
                struct callchain_cursor *cursor = NULL;

                if (symbol_conf.use_callchain && sample->callchain &&
                    thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
                                              sample, NULL, NULL, scripting_max_stack) == 0)
                        cursor = &callchain_cursor;

                if (cursor == NULL) {
                        printed += fprintf(fp, " ");
                        if (print_opts & EVSEL__PRINT_SRCLINE) {
                                print_srcline_last = true;
                                print_opts &= ~EVSEL__PRINT_SRCLINE;
                        }
                } else
                        printed += fprintf(fp, "\n");

                printed += sample__fprintf_sym(sample, al, 0, print_opts, cursor, fp);
        }

        /* print branch_to information */
        if (PRINT_FIELD(ADDR) ||
            ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) &&
             !output[type].user_set)) {
                printed += fprintf(fp, " => ");
                printed += perf_sample__fprintf_addr(sample, thread, attr, fp);
        }

        if (print_srcline_last)
                printed += map__fprintf_srcline(al->map, al->addr, "\n  ", fp);

        printed += perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
        printed += fprintf(fp, "\n");
        if (PRINT_FIELD(SRCCODE)) {
                int ret = map__fprintf_srccode(al->map, al->addr, stdout,
                                         &thread->srccode_state);
                if (ret) {
                        printed += ret;
                        printed += printf("\n");
                }
        }
        return printed;
}

static struct {
        u32 flags;
        const char *name;
} sample_flags[] = {
        {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL, "call"},
        {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN, "return"},
        {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CONDITIONAL, "jcc"},
        {PERF_IP_FLAG_BRANCH, "jmp"},
        {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_INTERRUPT, "int"},
        {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_INTERRUPT, "iret"},
        {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_SYSCALLRET, "syscall"},
        {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_SYSCALLRET, "sysret"},
        {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_ASYNC, "async"},
        {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_ASYNC | PERF_IP_FLAG_INTERRUPT, "hw int"},
        {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TX_ABORT, "tx abrt"},
        {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_BEGIN, "tr strt"},
        {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_END, "tr end"},
        {0, NULL}
};

static const char *sample_flags_to_name(u32 flags)
{
        int i;

        for (i = 0; sample_flags[i].name ; i++) {
                if (sample_flags[i].flags == flags)
                        return sample_flags[i].name;
        }

        return NULL;
}

static int perf_sample__fprintf_flags(u32 flags, FILE *fp)
{
        const char *chars = PERF_IP_FLAG_CHARS;
        const int n = strlen(PERF_IP_FLAG_CHARS);
        bool in_tx = flags & PERF_IP_FLAG_IN_TX;
        const char *name = NULL;
        char str[33];
        int i, pos = 0;

        name = sample_flags_to_name(flags & ~PERF_IP_FLAG_IN_TX);
        if (name)
                return fprintf(fp, "  %-15s%4s ", name, in_tx ? "(x)" : "");

        if (flags & PERF_IP_FLAG_TRACE_BEGIN) {
                name = sample_flags_to_name(flags & ~(PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_TRACE_BEGIN));
                if (name)
                        return fprintf(fp, "  tr strt %-7s%4s ", name, in_tx ? "(x)" : "");
        }

        if (flags & PERF_IP_FLAG_TRACE_END) {
                name = sample_flags_to_name(flags & ~(PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_TRACE_END));
                if (name)
                        return fprintf(fp, "  tr end  %-7s%4s ", name, in_tx ? "(x)" : "");
        }

        for (i = 0; i < n; i++, flags >>= 1) {
                if (flags & 1)
                        str[pos++] = chars[i];
        }
        for (; i < 32; i++, flags >>= 1) {
                if (flags & 1)
                        str[pos++] = '?';
        }
        str[pos] = 0;

        return fprintf(fp, "  %-19s ", str);
}

struct printer_data {
        int line_no;
        bool hit_nul;
        bool is_printable;
};

static int sample__fprintf_bpf_output(enum binary_printer_ops op,
                                      unsigned int val,
                                      void *extra, FILE *fp)
{
        unsigned char ch = (unsigned char)val;
        struct printer_data *printer_data = extra;
        int printed = 0;

        switch (op) {
        case BINARY_PRINT_DATA_BEGIN:
                printed += fprintf(fp, "\n");
                break;
        case BINARY_PRINT_LINE_BEGIN:
                printed += fprintf(fp, "%17s", !printer_data->line_no ? "BPF output:" :
                                                        "           ");
                break;
        case BINARY_PRINT_ADDR:
                printed += fprintf(fp, " %04x:", val);
                break;
        case BINARY_PRINT_NUM_DATA:
                printed += fprintf(fp, " %02x", val);
                break;
        case BINARY_PRINT_NUM_PAD:
                printed += fprintf(fp, "   ");
                break;
        case BINARY_PRINT_SEP:
                printed += fprintf(fp, "  ");
                break;
        case BINARY_PRINT_CHAR_DATA:
                if (printer_data->hit_nul && ch)
                        printer_data->is_printable = false;

                if (!isprint(ch)) {
                        printed += fprintf(fp, "%c", '.');

                        if (!printer_data->is_printable)
                                break;

                        if (ch == '\0')
                                printer_data->hit_nul = true;
                        else
                                printer_data->is_printable = false;
                } else {
                        printed += fprintf(fp, "%c", ch);
                }
                break;
        case BINARY_PRINT_CHAR_PAD:
                printed += fprintf(fp, " ");
                break;
        case BINARY_PRINT_LINE_END:
                printed += fprintf(fp, "\n");
                printer_data->line_no++;
                break;
        case BINARY_PRINT_DATA_END:
        default:
                break;
        }

        return printed;
}

static int perf_sample__fprintf_bpf_output(struct perf_sample *sample, FILE *fp)
{
        unsigned int nr_bytes = sample->raw_size;
        struct printer_data printer_data = {0, false, true};
        int printed = binary__fprintf(sample->raw_data, nr_bytes, 8,
                                      sample__fprintf_bpf_output, &printer_data, fp);

        if (printer_data.is_printable && printer_data.hit_nul)
                printed += fprintf(fp, "%17s \"%s\"\n", "BPF string:", (char *)(sample->raw_data));

        return printed;
}

static int perf_sample__fprintf_spacing(int len, int spacing, FILE *fp)
{
        if (len > 0 && len < spacing)
                return fprintf(fp, "%*s", spacing - len, "");

        return 0;
}

static int perf_sample__fprintf_pt_spacing(int len, FILE *fp)
{
        return perf_sample__fprintf_spacing(len, 34, fp);
}

static int perf_sample__fprintf_synth_ptwrite(struct perf_sample *sample, FILE *fp)
{
        struct perf_synth_intel_ptwrite *data = perf_sample__synth_ptr(sample);
        int len;

        if (perf_sample__bad_synth_size(sample, *data))
                return 0;

        len = fprintf(fp, " IP: %u payload: %#" PRIx64 " ",
                     data->ip, le64_to_cpu(data->payload));
        return len + perf_sample__fprintf_pt_spacing(len, fp);
}

static int perf_sample__fprintf_synth_mwait(struct perf_sample *sample, FILE *fp)
{
        struct perf_synth_intel_mwait *data = perf_sample__synth_ptr(sample);
        int len;

        if (perf_sample__bad_synth_size(sample, *data))
                return 0;

        len = fprintf(fp, " hints: %#x extensions: %#x ",
                      data->hints, data->extensions);
        return len + perf_sample__fprintf_pt_spacing(len, fp);
}

static int perf_sample__fprintf_synth_pwre(struct perf_sample *sample, FILE *fp)
{
        struct perf_synth_intel_pwre *data = perf_sample__synth_ptr(sample);
        int len;

        if (perf_sample__bad_synth_size(sample, *data))
                return 0;

        len = fprintf(fp, " hw: %u cstate: %u sub-cstate: %u ",
                      data->hw, data->cstate, data->subcstate);
        return len + perf_sample__fprintf_pt_spacing(len, fp);
}

static int perf_sample__fprintf_synth_exstop(struct perf_sample *sample, FILE *fp)
{
        struct perf_synth_intel_exstop *data = perf_sample__synth_ptr(sample);
        int len;

        if (perf_sample__bad_synth_size(sample, *data))
                return 0;

        len = fprintf(fp, " IP: %u ", data->ip);
        return len + perf_sample__fprintf_pt_spacing(len, fp);
}

static int perf_sample__fprintf_synth_pwrx(struct perf_sample *sample, FILE *fp)
{
        struct perf_synth_intel_pwrx *data = perf_sample__synth_ptr(sample);
        int len;

        if (perf_sample__bad_synth_size(sample, *data))
                return 0;

        len = fprintf(fp, " deepest cstate: %u last cstate: %u wake reason: %#x ",
                     data->deepest_cstate, data->last_cstate,
                     data->wake_reason);
        return len + perf_sample__fprintf_pt_spacing(len, fp);
}

static int perf_sample__fprintf_synth_cbr(struct perf_sample *sample, FILE *fp)
{
        struct perf_synth_intel_cbr *data = perf_sample__synth_ptr(sample);
        unsigned int percent, freq;
        int len;

        if (perf_sample__bad_synth_size(sample, *data))
                return 0;

        freq = (le32_to_cpu(data->freq) + 500) / 1000;
        len = fprintf(fp, " cbr: %2u freq: %4u MHz ", data->cbr, freq);
        if (data->max_nonturbo) {
                percent = (5 + (1000 * data->cbr) / data->max_nonturbo) / 10;
                len += fprintf(fp, "(%3u%%) ", percent);
        }
        return len + perf_sample__fprintf_pt_spacing(len, fp);
}

static int perf_sample__fprintf_synth(struct perf_sample *sample,
                                      struct perf_evsel *evsel, FILE *fp)
{
        switch (evsel->attr.config) {
        case PERF_SYNTH_INTEL_PTWRITE:
                return perf_sample__fprintf_synth_ptwrite(sample, fp);
        case PERF_SYNTH_INTEL_MWAIT:
                return perf_sample__fprintf_synth_mwait(sample, fp);
        case PERF_SYNTH_INTEL_PWRE:
                return perf_sample__fprintf_synth_pwre(sample, fp);
        case PERF_SYNTH_INTEL_EXSTOP:
                return perf_sample__fprintf_synth_exstop(sample, fp);
        case PERF_SYNTH_INTEL_PWRX:
                return perf_sample__fprintf_synth_pwrx(sample, fp);
        case PERF_SYNTH_INTEL_CBR:
                return perf_sample__fprintf_synth_cbr(sample, fp);
        default:
                break;
        }

        return 0;
}

struct perf_script {
        struct perf_tool        tool;
        struct perf_session     *session;
        bool                    show_task_events;
        bool                    show_mmap_events;
        bool                    show_switch_events;
        bool                    show_namespace_events;
        bool                    show_lost_events;
        bool                    show_round_events;
        bool                    allocated;
        bool                    per_event_dump;
        struct cpu_map          *cpus;
        struct thread_map       *threads;
        int                     name_width;
        const char              *time_str;
        struct perf_time_interval *ptime_range;
        int                     range_size;
        int                     range_num;
};

static int perf_evlist__max_name_len(struct perf_evlist *evlist)
{
        struct perf_evsel *evsel;
        int max = 0;

        evlist__for_each_entry(evlist, evsel) {
                int len = strlen(perf_evsel__name(evsel));

                max = MAX(len, max);
        }

        return max;
}

static int data_src__fprintf(u64 data_src, FILE *fp)
{
        struct mem_info mi = { .data_src.val = data_src };
        char decode[100];
        char out[100];
        static int maxlen;
        int len;

        perf_script__meminfo_scnprintf(decode, 100, &mi);

        len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
        if (maxlen < len)
                maxlen = len;

        return fprintf(fp, "%-*s", maxlen, out);
}

struct metric_ctx {
        struct perf_sample      *sample;
        struct thread           *thread;
        struct perf_evsel       *evsel;
        FILE                    *fp;
};

static void script_print_metric(struct perf_stat_config *config __maybe_unused,
                                void *ctx, const char *color,
                                const char *fmt,
                                const char *unit, double val)
{
        struct metric_ctx *mctx = ctx;

        if (!fmt)
                return;
        perf_sample__fprintf_start(mctx->sample, mctx->thread, mctx->evsel,
                                   PERF_RECORD_SAMPLE, mctx->fp);
        fputs("\tmetric: ", mctx->fp);
        if (color)
                color_fprintf(mctx->fp, color, fmt, val);
        else
                printf(fmt, val);
        fprintf(mctx->fp, " %s\n", unit);
}

static void script_new_line(struct perf_stat_config *config __maybe_unused,
                            void *ctx)
{
        struct metric_ctx *mctx = ctx;

        perf_sample__fprintf_start(mctx->sample, mctx->thread, mctx->evsel,
                                   PERF_RECORD_SAMPLE, mctx->fp);
        fputs("\tmetric: ", mctx->fp);
}

static void perf_sample__fprint_metric(struct perf_script *script,
                                       struct thread *thread,
                                       struct perf_evsel *evsel,
                                       struct perf_sample *sample,
                                       FILE *fp)
{
        struct perf_stat_output_ctx ctx = {
                .print_metric = script_print_metric,
                .new_line = script_new_line,
                .ctx = &(struct metric_ctx) {
                                .sample = sample,
                                .thread = thread,
                                .evsel  = evsel,
                                .fp     = fp,
                         },
                .force_header = false,
        };
        struct perf_evsel *ev2;
        u64 val;

        if (!evsel->stats)
                perf_evlist__alloc_stats(script->session->evlist, false);
        if (evsel_script(evsel->leader)->gnum++ == 0)
                perf_stat__reset_shadow_stats();
        val = sample->period * evsel->scale;
        perf_stat__update_shadow_stats(evsel,
                                       val,
                                       sample->cpu,
                                       &rt_stat);
        evsel_script(evsel)->val = val;
        if (evsel_script(evsel->leader)->gnum == evsel->leader->nr_members) {
                for_each_group_member (ev2, evsel->leader) {
                        perf_stat__print_shadow_stats(&stat_config, ev2,
                                                      evsel_script(ev2)->val,
                                                      sample->cpu,
                                                      &ctx,
                                                      NULL,
                                                      &rt_stat);
                }
                evsel_script(evsel->leader)->gnum = 0;
        }
}

static bool show_event(struct perf_sample *sample,
                       struct perf_evsel *evsel,
                       struct thread *thread,
                       struct addr_location *al)
{
        int depth = thread_stack__depth(thread, sample->cpu);

        if (!symbol_conf.graph_function)
                return true;

        if (thread->filter) {
                if (depth <= thread->filter_entry_depth) {
                        thread->filter = false;
                        return false;
                }
                return true;
        } else {
                const char *s = symbol_conf.graph_function;
                u64 ip;
                const char *name = resolve_branch_sym(sample, evsel, thread, al,
                                &ip);
                unsigned nlen;

                if (!name)
                        return false;
                nlen = strlen(name);
                while (*s) {
                        unsigned len = strcspn(s, ",");
                        if (nlen == len && !strncmp(name, s, len)) {
                                thread->filter = true;
                                thread->filter_entry_depth = depth;
                                return true;
                        }
                        s += len;
                        if (*s == ',')
                                s++;
                }
                return false;
        }
}

static void process_event(struct perf_script *script,
                          struct perf_sample *sample, struct perf_evsel *evsel,
                          struct addr_location *al,
                          struct machine *machine)
{
        struct thread *thread = al->thread;
        struct perf_event_attr *attr = &evsel->attr;
        unsigned int type = output_type(attr->type);
        struct perf_evsel_script *es = evsel->priv;
        FILE *fp = es->fp;

        if (output[type].fields == 0)
                return;

        if (!show_event(sample, evsel, thread, al))
                return;

        ++es->samples;

        perf_sample__fprintf_start(sample, thread, evsel,
                                   PERF_RECORD_SAMPLE, fp);

        if (PRINT_FIELD(PERIOD))
                fprintf(fp, "%10" PRIu64 " ", sample->period);

        if (PRINT_FIELD(EVNAME)) {
                const char *evname = perf_evsel__name(evsel);

                if (!script->name_width)
                        script->name_width = perf_evlist__max_name_len(script->session->evlist);

                fprintf(fp, "%*s: ", script->name_width, evname ?: "[unknown]");
        }

        if (print_flags)
                perf_sample__fprintf_flags(sample->flags, fp);

        if (is_bts_event(attr)) {
                perf_sample__fprintf_bts(sample, evsel, thread, al, machine, fp);
                return;
        }

        if (PRINT_FIELD(TRACE) && sample->raw_data) {
                event_format__fprintf(evsel->tp_format, sample->cpu,
                                      sample->raw_data, sample->raw_size, fp);
        }

        if (attr->type == PERF_TYPE_SYNTH && PRINT_FIELD(SYNTH))
                perf_sample__fprintf_synth(sample, evsel, fp);

        if (PRINT_FIELD(ADDR))
                perf_sample__fprintf_addr(sample, thread, attr, fp);

        if (PRINT_FIELD(DATA_SRC))
                data_src__fprintf(sample->data_src, fp);

        if (PRINT_FIELD(WEIGHT))
                fprintf(fp, "%16" PRIu64, sample->weight);

        if (PRINT_FIELD(IP)) {
                struct callchain_cursor *cursor = NULL;

                if (symbol_conf.use_callchain && sample->callchain &&
                    thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
                                              sample, NULL, NULL, scripting_max_stack) == 0)
                        cursor = &callchain_cursor;

                fputc(cursor ? '\n' : ' ', fp);
                sample__fprintf_sym(sample, al, 0, output[type].print_ip_opts, cursor, fp);
        }

        if (PRINT_FIELD(IREGS))
                perf_sample__fprintf_iregs(sample, attr, fp);

        if (PRINT_FIELD(UREGS))
                perf_sample__fprintf_uregs(sample, attr, fp);

        if (PRINT_FIELD(BRSTACK))
                perf_sample__fprintf_brstack(sample, thread, attr, fp);
        else if (PRINT_FIELD(BRSTACKSYM))
                perf_sample__fprintf_brstacksym(sample, thread, attr, fp);
        else if (PRINT_FIELD(BRSTACKOFF))
                perf_sample__fprintf_brstackoff(sample, thread, attr, fp);

        if (perf_evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
                perf_sample__fprintf_bpf_output(sample, fp);
        perf_sample__fprintf_insn(sample, attr, thread, machine, fp);

        if (PRINT_FIELD(PHYS_ADDR))
                fprintf(fp, "%16" PRIx64, sample->phys_addr);
        fprintf(fp, "\n");

        if (PRINT_FIELD(SRCCODE)) {
                if (map__fprintf_srccode(al->map, al->addr, stdout,
                                         &thread->srccode_state))
                        printf("\n");
        }

        if (PRINT_FIELD(METRIC))
                perf_sample__fprint_metric(script, thread, evsel, sample, fp);

        if (verbose)
                fflush(fp);
}

static struct scripting_ops     *scripting_ops;

static void __process_stat(struct perf_evsel *counter, u64 tstamp)
{
        int nthreads = thread_map__nr(counter->threads);
        int ncpus = perf_evsel__nr_cpus(counter);
        int cpu, thread;
        static int header_printed;

        if (counter->system_wide)
                nthreads = 1;

        if (!header_printed) {
                printf("%3s %8s %15s %15s %15s %15s %s\n",
                       "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
                header_printed = 1;
        }

        for (thread = 0; thread < nthreads; thread++) {
                for (cpu = 0; cpu < ncpus; cpu++) {
                        struct perf_counts_values *counts;

                        counts = perf_counts(counter->counts, cpu, thread);

                        printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
                                counter->cpus->map[cpu],
                                thread_map__pid(counter->threads, thread),
                                counts->val,
                                counts->ena,
                                counts->run,
                                tstamp,
                                perf_evsel__name(counter));
                }
        }
}

static void process_stat(struct perf_evsel *counter, u64 tstamp)
{
        if (scripting_ops && scripting_ops->process_stat)
                scripting_ops->process_stat(&stat_config, counter, tstamp);
        else
                __process_stat(counter, tstamp);
}

static void process_stat_interval(u64 tstamp)
{
        if (scripting_ops && scripting_ops->process_stat_interval)
                scripting_ops->process_stat_interval(tstamp);
}

static void setup_scripting(void)
{
        setup_perl_scripting();
        setup_python_scripting();
}

static int flush_scripting(void)
{
        return scripting_ops ? scripting_ops->flush_script() : 0;
}

static int cleanup_scripting(void)
{
        pr_debug("\nperf script stopped\n");

        return scripting_ops ? scripting_ops->stop_script() : 0;
}

static int process_sample_event(struct perf_tool *tool,
                                union perf_event *event,
                                struct perf_sample *sample,
                                struct perf_evsel *evsel,
                                struct machine *machine)
{
        struct perf_script *scr = container_of(tool, struct perf_script, tool);
        struct addr_location al;

        if (perf_time__ranges_skip_sample(scr->ptime_range, scr->range_num,
                                          sample->time)) {
                return 0;
        }

        if (debug_mode) {
                if (sample->time < last_timestamp) {
                        pr_err("Samples misordered, previous: %" PRIu64
                                " this: %" PRIu64 "\n", last_timestamp,
                                sample->time);
                        nr_unordered++;
                }
                last_timestamp = sample->time;
                return 0;
        }

        if (machine__resolve(machine, &al, sample) < 0) {
                pr_err("problem processing %d event, skipping it.\n",
                       event->header.type);
                return -1;
        }

        if (al.filtered)
                goto out_put;

        if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
                goto out_put;

        if (scripting_ops)
                scripting_ops->process_event(event, sample, evsel, &al);
        else
                process_event(scr, sample, evsel, &al, machine);

out_put:
        addr_location__put(&al);
        return 0;
}

static int process_attr(struct perf_tool *tool, union perf_event *event,
                        struct perf_evlist **pevlist)
{
        struct perf_script *scr = container_of(tool, struct perf_script, tool);
        struct perf_evlist *evlist;
        struct perf_evsel *evsel, *pos;
        int err;
        static struct perf_evsel_script *es;

        err = perf_event__process_attr(tool, event, pevlist);
        if (err)
                return err;

        evlist = *pevlist;
        evsel = perf_evlist__last(*pevlist);

        if (!evsel->priv) {
                if (scr->per_event_dump) {
                        evsel->priv = perf_evsel_script__new(evsel,
                                                scr->session->data);
                } else {
                        es = zalloc(sizeof(*es));
                        if (!es)
                                return -ENOMEM;
                        es->fp = stdout;
                        evsel->priv = es;
                }
        }

        if (evsel->attr.type >= PERF_TYPE_MAX &&
            evsel->attr.type != PERF_TYPE_SYNTH)

                return 0;

        evlist__for_each_entry(evlist, pos) {
                if (pos->attr.type == evsel->attr.type && pos != evsel)
                        return 0;
        }

        set_print_ip_opts(&evsel->attr);

        if (evsel->attr.sample_type)
                err = perf_evsel__check_attr(evsel, scr->session);

        return err;
}

static int process_comm_event(struct perf_tool *tool,
                              union perf_event *event,
                              struct perf_sample *sample,
                              struct machine *machine)
{
        struct thread *thread;
        struct perf_script *script = container_of(tool, struct perf_script, tool);
        struct perf_session *session = script->session;
        struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
        int ret = -1;

        thread = machine__findnew_thread(machine, event->comm.pid, event->comm.tid);
        if (thread == NULL) {
                pr_debug("problem processing COMM event, skipping it.\n");
                return -1;
        }

        if (perf_event__process_comm(tool, event, sample, machine) < 0)
                goto out;

        if (!evsel->attr.sample_id_all) {
                sample->cpu = 0;
                sample->time = 0;
                sample->tid = event->comm.tid;
                sample->pid = event->comm.pid;
        }
        perf_sample__fprintf_start(sample, thread, evsel,
                                   PERF_RECORD_COMM, stdout);
        perf_event__fprintf(event, stdout);
        ret = 0;
out:
        thread__put(thread);
        return ret;
}

static int process_namespaces_event(struct perf_tool *tool,
                                    union perf_event *event,
                                    struct perf_sample *sample,
                                    struct machine *machine)
{
        struct thread *thread;
        struct perf_script *script = container_of(tool, struct perf_script, tool);
        struct perf_session *session = script->session;
        struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
        int ret = -1;

        thread = machine__findnew_thread(machine, event->namespaces.pid,
                                         event->namespaces.tid);
        if (thread == NULL) {
                pr_debug("problem processing NAMESPACES event, skipping it.\n");
                return -1;
        }

        if (perf_event__process_namespaces(tool, event, sample, machine) < 0)
                goto out;

        if (!evsel->attr.sample_id_all) {
                sample->cpu = 0;
                sample->time = 0;
                sample->tid = event->namespaces.tid;
                sample->pid = event->namespaces.pid;
        }
        perf_sample__fprintf_start(sample, thread, evsel,
                                   PERF_RECORD_NAMESPACES, stdout);
        perf_event__fprintf(event, stdout);
        ret = 0;
out:
        thread__put(thread);
        return ret;
}

static int process_fork_event(struct perf_tool *tool,
                              union perf_event *event,
                              struct perf_sample *sample,
                              struct machine *machine)
{
        struct thread *thread;
        struct perf_script *script = container_of(tool, struct perf_script, tool);
        struct perf_session *session = script->session;
        struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);

        if (perf_event__process_fork(tool, event, sample, machine) < 0)
                return -1;

        thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
        if (thread == NULL) {
                pr_debug("problem processing FORK event, skipping it.\n");
                return -1;
        }

        if (!evsel->attr.sample_id_all) {
                sample->cpu = 0;
                sample->time = event->fork.time;
                sample->tid = event->fork.tid;
                sample->pid = event->fork.pid;
        }
        perf_sample__fprintf_start(sample, thread, evsel,
                                   PERF_RECORD_FORK, stdout);
        perf_event__fprintf(event, stdout);
        thread__put(thread);

        return 0;
}
static int process_exit_event(struct perf_tool *tool,
                              union perf_event *event,
                              struct perf_sample *sample,
                              struct machine *machine)
{
        int err = 0;
        struct thread *thread;
        struct perf_script *script = container_of(tool, struct perf_script, tool);
        struct perf_session *session = script->session;
        struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);

        thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
        if (thread == NULL) {
                pr_debug("problem processing EXIT event, skipping it.\n");
                return -1;
        }

        if (!evsel->attr.sample_id_all) {
                sample->cpu = 0;
                sample->time = 0;
                sample->tid = event->fork.tid;
                sample->pid = event->fork.pid;
        }
        perf_sample__fprintf_start(sample, thread, evsel,
                                   PERF_RECORD_EXIT, stdout);
        perf_event__fprintf(event, stdout);

        if (perf_event__process_exit(tool, event, sample, machine) < 0)
                err = -1;

        thread__put(thread);
        return err;
}

static int process_mmap_event(struct perf_tool *tool,
                              union perf_event *event,
                              struct perf_sample *sample,
                              struct machine *machine)
{
        struct thread *thread;
        struct perf_script *script = container_of(tool, struct perf_script, tool);
        struct perf_session *session = script->session;
        struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);

        if (perf_event__process_mmap(tool, event, sample, machine) < 0)
                return -1;

        thread = machine__findnew_thread(machine, event->mmap.pid, event->mmap.tid);
        if (thread == NULL) {
                pr_debug("problem processing MMAP event, skipping it.\n");
                return -1;
        }

        if (!evsel->attr.sample_id_all) {
                sample->cpu = 0;
                sample->time = 0;
                sample->tid = event->mmap.tid;
                sample->pid = event->mmap.pid;
        }
        perf_sample__fprintf_start(sample, thread, evsel,
                                   PERF_RECORD_MMAP, stdout);
        perf_event__fprintf(event, stdout);
        thread__put(thread);
        return 0;
}

static int process_mmap2_event(struct perf_tool *tool,
                              union perf_event *event,
                              struct perf_sample *sample,
                              struct machine *machine)
{
        struct thread *thread;
        struct perf_script *script = container_of(tool, struct perf_script, tool);
        struct perf_session *session = script->session;
        struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);

        if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
                return -1;

        thread = machine__findnew_thread(machine, event->mmap2.pid, event->mmap2.tid);
        if (thread == NULL) {
                pr_debug("problem processing MMAP2 event, skipping it.\n");
                return -1;
        }

        if (!evsel->attr.sample_id_all) {
                sample->cpu = 0;
                sample->time = 0;
                sample->tid = event->mmap2.tid;
                sample->pid = event->mmap2.pid;
        }
        perf_sample__fprintf_start(sample, thread, evsel,
                                   PERF_RECORD_MMAP2, stdout);
        perf_event__fprintf(event, stdout);
        thread__put(thread);
        return 0;
}

static int process_switch_event(struct perf_tool *tool,
                                union perf_event *event,
                                struct perf_sample *sample,
                                struct machine *machine)
{
        struct thread *thread;
        struct perf_script *script = container_of(tool, struct perf_script, tool);
        struct perf_session *session = script->session;
        struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);

        if (perf_event__process_switch(tool, event, sample, machine) < 0)
                return -1;

        thread = machine__findnew_thread(machine, sample->pid,
                                         sample->tid);
        if (thread == NULL) {
                pr_debug("problem processing SWITCH event, skipping it.\n");
                return -1;
        }

        perf_sample__fprintf_start(sample, thread, evsel,
                                   PERF_RECORD_SWITCH, stdout);
        perf_event__fprintf(event, stdout);
        thread__put(thread);
        return 0;
}

static int
process_lost_event(struct perf_tool *tool,
                   union perf_event *event,
                   struct perf_sample *sample,
                   struct machine *machine)
{
        struct perf_script *script = container_of(tool, struct perf_script, tool);
        struct perf_session *session = script->session;
        struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
        struct thread *thread;

        thread = machine__findnew_thread(machine, sample->pid,
                                         sample->tid);
        if (thread == NULL)
                return -1;

        perf_sample__fprintf_start(sample, thread, evsel,
                                   PERF_RECORD_LOST, stdout);
        perf_event__fprintf(event, stdout);
        thread__put(thread);
        return 0;
}

static int
process_finished_round_event(struct perf_tool *tool __maybe_unused,
                             union perf_event *event,
                             struct ordered_events *oe __maybe_unused)

{
        perf_event__fprintf(event, stdout);
        return 0;
}

static void sig_handler(int sig __maybe_unused)
{
        session_done = 1;
}

static void perf_script__fclose_per_event_dump(struct perf_script *script)
{
        struct perf_evlist *evlist = script->session->evlist;
        struct perf_evsel *evsel;

        evlist__for_each_entry(evlist, evsel) {
                if (!evsel->priv)
                        break;
                perf_evsel_script__delete(evsel->priv);
                evsel->priv = NULL;
        }
}

static int perf_script__fopen_per_event_dump(struct perf_script *script)
{
        struct perf_evsel *evsel;

        evlist__for_each_entry(script->session->evlist, evsel) {
                /*
                 * Already setup? I.e. we may be called twice in cases like
                 * Intel PT, one for the intel_pt// and dummy events, then
                 * for the evsels syntheized from the auxtrace info.
                 *
                 * Ses perf_script__process_auxtrace_info.
                 */
                if (evsel->priv != NULL)
                        continue;

                evsel->priv = perf_evsel_script__new(evsel, script->session->data);
                if (evsel->priv == NULL)
                        goto out_err_fclose;
        }

        return 0;

out_err_fclose:
        perf_script__fclose_per_event_dump(script);
        return -1;
}

static int perf_script__setup_per_event_dump(struct perf_script *script)
{
        struct perf_evsel *evsel;
        static struct perf_evsel_script es_stdout;

        if (script->per_event_dump)
                return perf_script__fopen_per_event_dump(script);

        es_stdout.fp = stdout;

        evlist__for_each_entry(script->session->evlist, evsel)
                evsel->priv = &es_stdout;

        return 0;
}

static void perf_script__exit_per_event_dump_stats(struct perf_script *script)
{
        struct perf_evsel *evsel;

        evlist__for_each_entry(script->session->evlist, evsel) {
                struct perf_evsel_script *es = evsel->priv;

                perf_evsel_script__fprintf(es, stdout);
                perf_evsel_script__delete(es);
                evsel->priv = NULL;
        }
}

static int __cmd_script(struct perf_script *script)
{
        int ret;

        signal(SIGINT, sig_handler);

        perf_stat__init_shadow_stats();

        /* override event processing functions */
        if (script->show_task_events) {
                script->tool.comm = process_comm_event;
                script->tool.fork = process_fork_event;
                script->tool.exit = process_exit_event;
        }
        if (script->show_mmap_events) {
                script->tool.mmap = process_mmap_event;
                script->tool.mmap2 = process_mmap2_event;
        }
        if (script->show_switch_events)
                script->tool.context_switch = process_switch_event;
        if (script->show_namespace_events)
                script->tool.namespaces = process_namespaces_event;
        if (script->show_lost_events)
                script->tool.lost = process_lost_event;
        if (script->show_round_events) {
                script->tool.ordered_events = false;
                script->tool.finished_round = process_finished_round_event;
        }

        if (perf_script__setup_per_event_dump(script)) {
                pr_err("Couldn't create the per event dump files\n");
                return -1;
        }

        ret = perf_session__process_events(script->session);

        if (script->per_event_dump)
                perf_script__exit_per_event_dump_stats(script);

        if (debug_mode)
                pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);

        return ret;
}

struct script_spec {
        struct list_head        node;
        struct scripting_ops    *ops;
        char                    spec[0];
};

static LIST_HEAD(script_specs);

static struct script_spec *script_spec__new(const char *spec,
                                            struct scripting_ops *ops)
{
        struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);

        if (s != NULL) {
                strcpy(s->spec, spec);
                s->ops = ops;
        }

        return s;
}

static void script_spec__add(struct script_spec *s)
{
        list_add_tail(&s->node, &script_specs);
}

static struct script_spec *script_spec__find(const char *spec)
{
        struct script_spec *s;

        list_for_each_entry(s, &script_specs, node)
                if (strcasecmp(s->spec, spec) == 0)
                        return s;
        return NULL;
}

int script_spec_register(const char *spec, struct scripting_ops *ops)
{
        struct script_spec *s;

        s = script_spec__find(spec);
        if (s)
                return -1;

        s = script_spec__new(spec, ops);
        if (!s)
                return -1;
        else
                script_spec__add(s);

        return 0;
}

static struct scripting_ops *script_spec__lookup(const char *spec)
{
        struct script_spec *s = script_spec__find(spec);
        if (!s)
                return NULL;

        return s->ops;
}

static void list_available_languages(void)
{
        struct script_spec *s;

        fprintf(stderr, "\n");
        fprintf(stderr, "Scripting language extensions (used in "
                "perf script -s [spec:]script.[spec]):\n\n");

        list_for_each_entry(s, &script_specs, node)
                fprintf(stderr, "  %-42s [%s]\n", s->spec, s->ops->name);

        fprintf(stderr, "\n");
}

static int parse_scriptname(const struct option *opt __maybe_unused,
                            const char *str, int unset __maybe_unused)
{
        char spec[PATH_MAX];
        const char *script, *ext;
        int len;

        if (strcmp(str, "lang") == 0) {
                list_available_languages();
                exit(0);
        }

        script = strchr(str, ':');
        if (script) {
                len = script - str;
                if (len >= PATH_MAX) {
                        fprintf(stderr, "invalid language specifier");
                        return -1;
                }
                strncpy(spec, str, len);
                spec[len] = '\0';
                scripting_ops = script_spec__lookup(spec);
                if (!scripting_ops) {
                        fprintf(stderr, "invalid language specifier");
                        return -1;
                }
                script++;
        } else {
                script = str;
                ext = strrchr(script, '.');
                if (!ext) {
                        fprintf(stderr, "invalid script extension");
                        return -1;
                }
                scripting_ops = script_spec__lookup(++ext);
                if (!scripting_ops) {
                        fprintf(stderr, "invalid script extension");
                        return -1;
                }
        }

        script_name = strdup(script);

        return 0;
}

static int parse_output_fields(const struct option *opt __maybe_unused,
                            const char *arg, int unset __maybe_unused)
{
        char *tok, *strtok_saveptr = NULL;
        int i, imax = ARRAY_SIZE(all_output_options);
        int j;
        int rc = 0;
        char *str = strdup(arg);
        int type = -1;
        enum { DEFAULT, SET, ADD, REMOVE } change = DEFAULT;

        if (!str)
                return -ENOMEM;

        /* first word can state for which event type the user is specifying
         * the fields. If no type exists, the specified fields apply to all
         * event types found in the file minus the invalid fields for a type.
         */
        tok = strchr(str, ':');
        if (tok) {
                *tok = '\0';
                tok++;
                if (!strcmp(str, "hw"))
                        type = PERF_TYPE_HARDWARE;
                else if (!strcmp(str, "sw"))
                        type = PERF_TYPE_SOFTWARE;
                else if (!strcmp(str, "trace"))
                        type = PERF_TYPE_TRACEPOINT;
                else if (!strcmp(str, "raw"))
                        type = PERF_TYPE_RAW;
                else if (!strcmp(str, "break"))
                        type = PERF_TYPE_BREAKPOINT;
                else if (!strcmp(str, "synth"))
                        type = OUTPUT_TYPE_SYNTH;
                else {
                        fprintf(stderr, "Invalid event type in field string.\n");
                        rc = -EINVAL;
                        goto out;
                }

                if (output[type].user_set)
                        pr_warning("Overriding previous field request for %s events.\n",
                                   event_type(type));

                output[type].fields = 0;
                output[type].user_set = true;
                output[type].wildcard_set = false;

        } else {
                tok = str;
                if (strlen(str) == 0) {
                        fprintf(stderr,
                                "Cannot set fields to 'none' for all event types.\n");
                        rc = -EINVAL;
                        goto out;
                }

                /* Don't override defaults for +- */
                if (strchr(str, '+') || strchr(str, '-'))
                        goto parse;

                if (output_set_by_user())
                        pr_warning("Overriding previous field request for all events.\n");

                for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
                        output[j].fields = 0;
                        output[j].user_set = true;
                        output[j].wildcard_set = true;
                }
        }

parse:
        for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) {
                if (*tok == '+') {
                        if (change == SET)
                                goto out_badmix;
                        change = ADD;
                        tok++;
                } else if (*tok == '-') {
                        if (change == SET)
                                goto out_badmix;
                        change = REMOVE;
                        tok++;
                } else {
                        if (change != SET && change != DEFAULT)
                                goto out_badmix;
                        change = SET;
                }

                for (i = 0; i < imax; ++i) {
                        if (strcmp(tok, all_output_options[i].str) == 0)
                                break;
                }
                if (i == imax && strcmp(tok, "flags") == 0) {
                        print_flags = change == REMOVE ? false : true;
                        continue;
                }
                if (i == imax) {
                        fprintf(stderr, "Invalid field requested.\n");
                        rc = -EINVAL;
                        goto out;
                }

                if (type == -1) {
                        /* add user option to all events types for
                         * which it is valid
                         */
                        for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
                                if (output[j].invalid_fields & all_output_options[i].field) {
                                        pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
                                                   all_output_options[i].str, event_type(j));
                                } else {
                                        if (change == REMOVE)
                                                output[j].fields &= ~all_output_options[i].field;
                                        else
                                                output[j].fields |= all_output_options[i].field;
                                        output[j].user_set = true;
                                        output[j].wildcard_set = true;
                                }
                        }
                } else {
                        if (output[type].invalid_fields & all_output_options[i].field) {
                                fprintf(stderr, "\'%s\' not valid for %s events.\n",
                                         all_output_options[i].str, event_type(type));

                                rc = -EINVAL;
                                goto out;
                        }
                        output[type].user_set = true;
                        output[type].wildcard_set = true;
                }
        }

        if (type >= 0) {
                if (output[type].fields == 0) {
                        pr_debug("No fields requested for %s type. "
                                 "Events will not be displayed.\n", event_type(type));
                }
        }
        goto out;

out_badmix:
        fprintf(stderr, "Cannot mix +-field with overridden fields\n");
        rc = -EINVAL;
out:
        free(str);
        return rc;
}

#define for_each_lang(scripts_path, scripts_dir, lang_dirent)           \
        while ((lang_dirent = readdir(scripts_dir)) != NULL)            \
                if ((lang_dirent->d_type == DT_DIR ||                   \
                     (lang_dirent->d_type == DT_UNKNOWN &&              \
                      is_directory(scripts_path, lang_dirent))) &&      \
                    (strcmp(lang_dirent->d_name, ".")) &&               \
                    (strcmp(lang_dirent->d_name, "..")))

#define for_each_script(lang_path, lang_dir, script_dirent)             \
        while ((script_dirent = readdir(lang_dir)) != NULL)             \
                if (script_dirent->d_type != DT_DIR &&                  \
                    (script_dirent->d_type != DT_UNKNOWN ||             \
                     !is_directory(lang_path, script_dirent)))


#define RECORD_SUFFIX                   "-record"
#define REPORT_SUFFIX                   "-report"

struct script_desc {
        struct list_head        node;
        char                    *name;
        char                    *half_liner;
        char                    *args;
};

static LIST_HEAD(script_descs);

static struct script_desc *script_desc__new(const char *name)
{
        struct script_desc *s = zalloc(sizeof(*s));

        if (s != NULL && name)
                s->name = strdup(name);

        return s;
}

static void script_desc__delete(struct script_desc *s)
{
        zfree(&s->name);
        zfree(&s->half_liner);
        zfree(&s->args);
        free(s);
}

static void script_desc__add(struct script_desc *s)
{
        list_add_tail(&s->node, &script_descs);
}

static struct script_desc *script_desc__find(const char *name)
{
        struct script_desc *s;

        list_for_each_entry(s, &script_descs, node)
                if (strcasecmp(s->name, name) == 0)
                        return s;
        return NULL;
}

static struct script_desc *script_desc__findnew(const char *name)
{
        struct script_desc *s = script_desc__find(name);

        if (s)
                return s;

        s = script_desc__new(name);
        if (!s)
                return NULL;

        script_desc__add(s);

        return s;
}

static const char *ends_with(const char *str, const char *suffix)
{
        size_t suffix_len = strlen(suffix);
        const char *p = str;

        if (strlen(str) > suffix_len) {
                p = str + strlen(str) - suffix_len;
                if (!strncmp(p, suffix, suffix_len))
                        return p;
        }

        return NULL;
}

static int read_script_info(struct script_desc *desc, const char *filename)
{
        char line[BUFSIZ], *p;
        FILE *fp;

        fp = fopen(filename, "r");
        if (!fp)
                return -1;

        while (fgets(line, sizeof(line), fp)) {
                p = ltrim(line);
                if (strlen(p) == 0)
                        continue;
                if (*p != '#')
                        continue;
                p++;
                if (strlen(p) && *p == '!')
                        continue;

                p = ltrim(p);
                if (strlen(p) && p[strlen(p) - 1] == '\n')
                        p[strlen(p) - 1] = '\0';

                if (!strncmp(p, "description:", strlen("description:"))) {
                        p += strlen("description:");
                        desc->half_liner = strdup(ltrim(p));
                        continue;
                }

                if (!strncmp(p, "args:", strlen("args:"))) {
                        p += strlen("args:");
                        desc->args = strdup(ltrim(p));
                        continue;
                }
        }

        fclose(fp);

        return 0;
}

static char *get_script_root(struct dirent *script_dirent, const char *suffix)
{
        char *script_root, *str;

        script_root = strdup(script_dirent->d_name);
        if (!script_root)
                return NULL;

        str = (char *)ends_with(script_root, suffix);
        if (!str) {
                free(script_root);
                return NULL;
        }

        *str = '\0';
        return script_root;
}

static int list_available_scripts(const struct option *opt __maybe_unused,
                                  const char *s __maybe_unused,
                                  int unset __maybe_unused)
{
        struct dirent *script_dirent, *lang_dirent;
        char scripts_path[MAXPATHLEN];
        DIR *scripts_dir, *lang_dir;
        char script_path[MAXPATHLEN];
        char lang_path[MAXPATHLEN];
        struct script_desc *desc;
        char first_half[BUFSIZ];
        char *script_root;

        snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());

        scripts_dir = opendir(scripts_path);
        if (!scripts_dir) {
                fprintf(stdout,
                        "open(%s) failed.\n"
                        "Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
                        scripts_path);
                exit(-1);
        }

        for_each_lang(scripts_path, scripts_dir, lang_dirent) {
                scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
                          lang_dirent->d_name);
                lang_dir = opendir(lang_path);
                if (!lang_dir)
                        continue;

                for_each_script(lang_path, lang_dir, script_dirent) {
                        script_root = get_script_root(script_dirent, REPORT_SUFFIX);
                        if (script_root) {
                                desc = script_desc__findnew(script_root);
                                scnprintf(script_path, MAXPATHLEN, "%s/%s",
                                          lang_path, script_dirent->d_name);
                                read_script_info(desc, script_path);
                                free(script_root);
                        }
                }
        }

        fprintf(stdout, "List of available trace scripts:\n");
        list_for_each_entry(desc, &script_descs, node) {
                sprintf(first_half, "%s %s", desc->name,
                        desc->args ? desc->args : "");
                fprintf(stdout, "  %-36s %s\n", first_half,
                        desc->half_liner ? desc->half_liner : "");
        }

        exit(0);
}

/*
 * Some scripts specify the required events in their "xxx-record" file,
 * this function will check if the events in perf.data match those
 * mentioned in the "xxx-record".
 *
 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
 * which is covered well now. And new parsing code should be added to
 * cover the future complexing formats like event groups etc.
 */
static int check_ev_match(char *dir_name, char *scriptname,
                        struct perf_session *session)
{
        char filename[MAXPATHLEN], evname[128];
        char line[BUFSIZ], *p;
        struct perf_evsel *pos;
        int match, len;
        FILE *fp;

        scnprintf(filename, MAXPATHLEN, "%s/bin/%s-record", dir_name, scriptname);

        fp = fopen(filename, "r");
        if (!fp)
                return -1;

        while (fgets(line, sizeof(line), fp)) {
                p = ltrim(line);
                if (*p == '#')
                        continue;

                while (strlen(p)) {
                        p = strstr(p, "-e");
                        if (!p)
                                break;

                        p += 2;
                        p = ltrim(p);
                        len = strcspn(p, " \t");
                        if (!len)
                                break;

                        snprintf(evname, len + 1, "%s", p);

                        match = 0;
                        evlist__for_each_entry(session->evlist, pos) {
                                if (!strcmp(perf_evsel__name(pos), evname)) {
                                        match = 1;
                                        break;
                                }
                        }

                        if (!match) {
                                fclose(fp);
                                return -1;
                        }
                }
        }

        fclose(fp);
        return 0;
}

/*
 * Return -1 if none is found, otherwise the actual scripts number.
 *
 * Currently the only user of this function is the script browser, which
 * will list all statically runnable scripts, select one, execute it and
 * show the output in a perf browser.
 */
int find_scripts(char **scripts_array, char **scripts_path_array)
{
        struct dirent *script_dirent, *lang_dirent;
        char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
        DIR *scripts_dir, *lang_dir;
        struct perf_session *session;
        struct perf_data data = {
                .file      = {
                        .path = input_name,
                },
                .mode      = PERF_DATA_MODE_READ,
        };
        char *temp;
        int i = 0;

        session = perf_session__new(&data, false, NULL);
        if (!session)
                return -1;

        snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());

        scripts_dir = opendir(scripts_path);
        if (!scripts_dir) {
                perf_session__delete(session);
                return -1;
        }

        for_each_lang(scripts_path, scripts_dir, lang_dirent) {
                scnprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
                          lang_dirent->d_name);
#ifndef HAVE_LIBPERL_SUPPORT
                if (strstr(lang_path, "perl"))
                        continue;
#endif
#ifndef HAVE_LIBPYTHON_SUPPORT
                if (strstr(lang_path, "python"))
                        continue;
#endif

                lang_dir = opendir(lang_path);
                if (!lang_dir)
                        continue;

                for_each_script(lang_path, lang_dir, script_dirent) {
                        /* Skip those real time scripts: xxxtop.p[yl] */
                        if (strstr(script_dirent->d_name, "top."))
                                continue;
                        sprintf(scripts_path_array[i], "%s/%s", lang_path,
                                script_dirent->d_name);
                        temp = strchr(script_dirent->d_name, '.');
                        snprintf(scripts_array[i],
                                (temp - script_dirent->d_name) + 1,
                                "%s", script_dirent->d_name);

                        if (check_ev_match(lang_path,
                                        scripts_array[i], session))
                                continue;

                        i++;
                }
                closedir(lang_dir);
        }