#include "builtin.h" #include "perf.h" #include "util/cache.h" #include "util/debug.h" #include #include "util/header.h" #include #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/thread-stack.h" #include "util/time-utils.h" #include #include #include #include #include "asm/bug.h" #include "util/mem-events.h" #include "util/dump-insn.h" #include #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, }; 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 = "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}, }; /* 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[PERF_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_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_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_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_DSO | PERF_OUTPUT_PERIOD | PERF_OUTPUT_ADDR | PERF_OUTPUT_DATA_SRC | PERF_OUTPUT_WEIGHT, .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_DSO | PERF_OUTPUT_PERIOD, .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT, }, }; static bool output_set_by_user(void) { int j; for (j = 0; j < PERF_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[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 = 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) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) { pr_err("Display of symbols requested but neither sample IP nor " "sample address\nis selected. 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) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) { pr_err("Display of DSO requested but neither sample IP nor " "sample address\nis selected. Hence, no addresses to convert " "to DSO.\n"); return -EINVAL; } if (PRINT_FIELD(SRCLINE) && !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(PERIOD) && perf_evsel__check_stype(evsel, PERF_SAMPLE_PERIOD, "PERIOD", PERF_OUTPUT_PERIOD)) return -EINVAL; if (PRINT_FIELD(IREGS) && perf_evsel__check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS", PERF_OUTPUT_IREGS)) return -EINVAL; return 0; } static void set_print_ip_opts(struct perf_event_attr *attr) { unsigned int 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 < PERF_TYPE_MAX; ++j) { evsel = perf_session__find_first_evtype(session, 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) { 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->attr.sample_type & PERF_SAMPLE_CALLCHAIN) { 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) { struct perf_event_attr *attr; j = PERF_TYPE_TRACEPOINT; evlist__for_each_entry(session->evlist, evsel) { if (evsel->attr.type != j) continue; attr = &evsel->attr; if (attr->sample_type & PERF_SAMPLE_CALLCHAIN) { output[j].fields |= PERF_OUTPUT_IP; output[j].fields |= PERF_OUTPUT_SYM; output[j].fields |= PERF_OUTPUT_DSO; set_print_ip_opts(attr); goto out; } } } out: return 0; } static void print_sample_iregs(struct perf_sample *sample, struct perf_event_attr *attr) { struct regs_dump *regs = &sample->intr_regs; uint64_t mask = attr->sample_regs_intr; unsigned i = 0, r; if (!regs) return; for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) { u64 val = regs->regs[i++]; printf("%5s:0x%"PRIx64" ", perf_reg_name(r), val); } } static void print_sample_start(struct perf_sample *sample, struct thread *thread, struct perf_evsel *evsel) { struct perf_event_attr *attr = &evsel->attr; unsigned long secs; unsigned long long nsecs; if (PRINT_FIELD(COMM)) { if (latency_format) printf("%8.8s ", thread__comm_str(thread)); else if (PRINT_FIELD(IP) && symbol_conf.use_callchain) printf("%s ", thread__comm_str(thread)); else printf("%16s ", thread__comm_str(thread)); } if (PRINT_FIELD(PID) && PRINT_FIELD(TID)) printf("%5d/%-5d ", sample->pid, sample->tid); else if (PRINT_FIELD(PID)) printf("%5d ", sample->pid); else if (PRINT_FIELD(TID)) printf("%5d ", sample->tid); if (PRINT_FIELD(CPU)) { if (latency_format) printf("%3d ", sample->cpu); else printf("[%03d] ", sample->cpu); } if (PRINT_FIELD(TIME)) { nsecs = sample->time; secs = nsecs / NSEC_PER_SEC; nsecs -= secs * NSEC_PER_SEC; if (nanosecs) printf("%5lu.%09llu: ", secs, nsecs); else { char sample_time[32]; timestamp__scnprintf_usec(sample->time, sample_time, sizeof(sample_time)); printf("%12s: ", sample_time); } } } static inline char mispred_str(struct branch_entry *br) { if (!(br->flags.mispred || br->flags.predicted)) return '-'; return br->flags.predicted ? 'P' : 'M'; } static void print_sample_brstack(struct perf_sample *sample) { struct branch_stack *br = sample->branch_stack; u64 i; if (!(br && br->nr)) return; for (i = 0; i < br->nr; i++) { printf(" 0x%"PRIx64"/0x%"PRIx64"/%c/%c/%c/%d ", br->entries[i].from, br->entries[i].to, mispred_str( br->entries + i), br->entries[i].flags.in_tx? 'X' : '-', br->entries[i].flags.abort? 'A' : '-', br->entries[i].flags.cycles); } } static void print_sample_brstacksym(struct perf_sample *sample, struct thread *thread) { struct branch_stack *br = sample->branch_stack; struct addr_location alf, alt; u64 i, from, to; if (!(br && br->nr)) return; 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_addr_map(thread, sample->cpumode, MAP__FUNCTION, from, &alf); if (alf.map) alf.sym = map__find_symbol(alf.map, alf.addr); thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, to, &alt); if (alt.map) alt.sym = map__find_symbol(alt.map, alt.addr); symbol__fprintf_symname_offs(alf.sym, &alf, stdout); putchar('/'); symbol__fprintf_symname_offs(alt.sym, &alt, stdout); printf("/%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); } } #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)) { printf("\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) printf("\tbrstack does not reach to final jump (%" PRIx64 "-%" PRIx64 ")\n", start, end); else printf("\tblock %" PRIx64 "-%" PRIx64 " (%" PRIu64 ") too long to dump\n", start, end, end - start); return 0; } thread__find_addr_map(thread, *cpumode, MAP__FUNCTION, start, &al); if (!al.map || !al.map->dso) { printf("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end); return 0; } if (al.map->dso->data.status == DSO_DATA_STATUS_ERROR) { printf("\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) printf("\tcannot fetch code for block at %" PRIx64 "-%" PRIx64 "\n", start, end); return len; } static void print_jump(uint64_t ip, struct branch_entry *en, struct perf_insn *x, u8 *inbuf, int len, int insn) { printf("\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) { printf(" %d cycles", en->flags.cycles); if (insn) printf(" %.2f IPC", (float)insn / en->flags.cycles); } putchar('\n'); } static void print_ip_sym(struct thread *thread, u8 cpumode, int cpu, uint64_t addr, struct symbol **lastsym, struct perf_event_attr *attr) { struct addr_location al; int off; memset(&al, 0, sizeof(al)); thread__find_addr_map(thread, cpumode, MAP__FUNCTION, addr, &al); if (!al.map) thread__find_addr_map(thread, cpumode, MAP__VARIABLE, addr, &al); if ((*lastsym) && al.addr >= (*lastsym)->start && al.addr < (*lastsym)->end) return; al.cpu = cpu; al.sym = NULL; if (al.map) al.sym = map__find_symbol(al.map, al.addr); if (!al.sym) return; if (al.addr < al.sym->end) off = al.addr - al.sym->start; else off = al.addr - al.map->start - al.sym->start; printf("\t%s", al.sym->name); if (off) printf("%+d", off); putchar(':'); if (PRINT_FIELD(SRCLINE)) map__fprintf_srcline(al.map, al.addr, "\t", stdout); putchar('\n'); *lastsym = al.sym; } static void print_sample_brstackinsn(struct perf_sample *sample, struct thread *thread, struct perf_event_attr *attr, struct machine *machine) { struct branch_stack *br = sample->branch_stack; u64 start, end; int i, insn, len, nr, ilen; struct perf_insn x; u8 buffer[MAXBB]; unsigned off; struct symbol *lastsym = NULL; if (!(br && br->nr)) return; nr = br->nr; if (max_blocks && nr > max_blocks + 1) nr = max_blocks + 1; x.thread = thread; x.cpu = sample->cpu; putchar('\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) { print_ip_sym(thread, x.cpumode, x.cpu, br->entries[nr - 1].from, &lastsym, attr); print_jump(br->entries[nr - 1].from, &br->entries[nr - 1], &x, buffer, len, 0); } /* 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; print_ip_sym(thread, x.cpumode, x.cpu, ip, &lastsym, attr); if (ip == end) { print_jump(ip, &br->entries[i], &x, buffer + off, len - off, insn); break; } else { printf("\t%016" PRIx64 "\t%s\n", ip, dump_insn(&x, ip, buffer + off, len - off, &ilen)); if (ilen == 0) break; 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) return; if (br->entries[0].flags.abort) return; /* * Print final block upto sample */ start = br->entries[0].to; end = sample->ip; len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, true); print_ip_sym(thread, x.cpumode, x.cpu, start, &lastsym, attr); 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) return; printf("\t%016" PRIx64 "\t%s\n", sample->ip, dump_insn(&x, sample->ip, buffer, len, NULL)); return; } for (off = 0; off <= end - start; off += ilen) { printf("\t%016" PRIx64 "\t%s\n", start + off, dump_insn(&x, start + off, buffer + off, len - off, &ilen)); if (ilen == 0) break; } } static void print_sample_addr(struct perf_sample *sample, struct thread *thread, struct perf_event_attr *attr) { struct addr_location al; printf("%16" PRIx64, sample->addr); if (!sample_addr_correlates_sym(attr)) return; thread__resolve(thread, &al, sample); if (PRINT_FIELD(SYM)) { printf(" "); if (PRINT_FIELD(SYMOFFSET)) symbol__fprintf_symname_offs(al.sym, &al, stdout); else symbol__fprintf_symname(al.sym, stdout); } if (PRINT_FIELD(DSO)) { printf(" ("); map__fprintf_dsoname(al.map, stdout); printf(")"); } } static void print_sample_callindent(struct perf_sample *sample, struct perf_evsel *evsel, struct thread *thread, struct addr_location *al) { struct perf_event_attr *attr = &evsel->attr; size_t depth = thread_stack__depth(thread); struct addr_location addr_al; const char *name = NULL; static int spacing; int len = 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; 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; } if (name) len = printf("%*s%s", (int)depth * 4, "", name); else if (ip) len = printf("%*s%16" PRIx64, (int)depth * 4, "", ip); if (len < 0) return; /* * 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) printf("%*s", spacing - len, ""); } static void print_insn(struct perf_sample *sample, struct perf_event_attr *attr, struct thread *thread, struct machine *machine) { if (PRINT_FIELD(INSNLEN)) printf(" ilen: %d", sample->insn_len); if (PRINT_FIELD(INSN)) { int i; printf(" insn:"); for (i = 0; i < sample->insn_len; i++) printf(" %02x", (unsigned char)sample->insn[i]); } if (PRINT_FIELD(BRSTACKINSN)) print_sample_brstackinsn(sample, thread, attr, machine); } static void print_sample_bts(struct perf_sample *sample, struct perf_evsel *evsel, struct thread *thread, struct addr_location *al, struct machine *machine) { struct perf_event_attr *attr = &evsel->attr; bool print_srcline_last = false; if (PRINT_FIELD(CALLINDENT)) print_sample_callindent(sample, evsel, thread, al); /* print branch_from information */ if (PRINT_FIELD(IP)) { unsigned int print_opts = output[attr->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) { putchar(' '); if (print_opts & EVSEL__PRINT_SRCLINE) { print_srcline_last = true; print_opts &= ~EVSEL__PRINT_SRCLINE; } } else putchar('\n'); sample__fprintf_sym(sample, al, 0, print_opts, cursor, stdout); } /* print branch_to information */ if (PRINT_FIELD(ADDR) || ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) && !output[attr->type].user_set)) { printf(" => "); print_sample_addr(sample, thread, attr); } if (print_srcline_last) map__fprintf_srcline(al->map, al->addr, "\n ", stdout); print_insn(sample, attr, thread, machine); printf("\n"); } 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 void print_sample_flags(u32 flags) { 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; for (i = 0; sample_flags[i].name ; i++) { if (sample_flags[i].flags == (flags & ~PERF_IP_FLAG_IN_TX)) { name = sample_flags[i].name; break; } } 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; if (name) printf(" %-7s%4s ", name, in_tx ? "(x)" : ""); else printf(" %-11s ", str); } struct printer_data { int line_no; bool hit_nul; bool is_printable; }; static void print_sample_bpf_output_printer(enum binary_printer_ops op, unsigned int val, void *extra) { unsigned char ch = (unsigned char)val; struct printer_data *printer_data = extra; switch (op) { case BINARY_PRINT_DATA_BEGIN: printf("\n"); break; case BINARY_PRINT_LINE_BEGIN: printf("%17s", !printer_data->line_no ? "BPF output:" : " "); break; case BINARY_PRINT_ADDR: printf(" %04x:", val); break; case BINARY_PRINT_NUM_DATA: printf(" %02x", val); break; case BINARY_PRINT_NUM_PAD: printf(" "); break; case BINARY_PRINT_SEP: printf(" "); break; case BINARY_PRINT_CHAR_DATA: if (printer_data->hit_nul && ch) printer_data->is_printable = false; if (!isprint(ch)) { printf("%c", '.'); if (!printer_data->is_printable) break; if (ch == '\0') printer_data->hit_nul = true; else printer_data->is_printable = false; } else { printf("%c", ch); } break; case BINARY_PRINT_CHAR_PAD: printf(" "); break; case BINARY_PRINT_LINE_END: printf("\n"); printer_data->line_no++; break; case BINARY_PRINT_DATA_END: default: break; } } static void print_sample_bpf_output(struct perf_sample *sample) { unsigned int nr_bytes = sample->raw_size; struct printer_data printer_data = {0, false, true}; print_binary(sample->raw_data, nr_bytes, 8, print_sample_bpf_output_printer, &printer_data); if (printer_data.is_printable && printer_data.hit_nul) printf("%17s \"%s\"\n", "BPF string:", (char *)(sample->raw_data)); } 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 allocated; struct cpu_map *cpus; struct thread_map *threads; int name_width; const char *time_str; struct perf_time_interval ptime; }; 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 size_t data_src__printf(u64 data_src) { 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 printf("%-*s", maxlen, out); } 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; if (output[attr->type].fields == 0) return; print_sample_start(sample, thread, evsel); if (PRINT_FIELD(PERIOD)) printf("%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); printf("%*s: ", script->name_width, evname ? evname : "[unknown]"); } if (print_flags) print_sample_flags(sample->flags); if (is_bts_event(attr)) { print_sample_bts(sample, evsel, thread, al, machine); return; } if (PRINT_FIELD(TRACE)) event_format__print(evsel->tp_format, sample->cpu, sample->raw_data, sample->raw_size); if (PRINT_FIELD(ADDR)) print_sample_addr(sample, thread, attr); if (PRINT_FIELD(DATA_SRC)) data_src__printf(sample->data_src); if (PRINT_FIELD(WEIGHT)) printf("%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; putchar(cursor ? '\n' : ' '); sample__fprintf_sym(sample, al, 0, output[attr->type].print_ip_opts, cursor, stdout); } if (PRINT_FIELD(IREGS)) print_sample_iregs(sample, attr); if (PRINT_FIELD(BRSTACK)) print_sample_brstack(sample); else if (PRINT_FIELD(BRSTACKSYM)) print_sample_brstacksym(sample, thread); if (perf_evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT)) print_sample_bpf_output(sample); print_insn(sample, attr, thread, machine); printf("\n"); } 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__skip_sample(&scr->ptime, 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; err = perf_event__process_attr(tool, event, pevlist); if (err) return err; evlist = *pevlist; evsel = perf_evlist__last(*pevlist); if (evsel->attr.type >= PERF_TYPE_MAX) 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; } print_sample_start(sample, thread, evsel); 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; } print_sample_start(sample, thread, evsel); 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; } print_sample_start(sample, thread, evsel); 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; } print_sample_start(sample, thread, evsel); 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; } print_sample_start(sample, thread, evsel); 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; } print_sample_start(sample, thread, evsel); 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; } print_sample_start(sample, thread, evsel); perf_event__fprintf(event, stdout); thread__put(thread); return 0; } static void sig_handler(int sig __maybe_unused) { session_done = 1; } static int __cmd_script(struct perf_script *script) { int ret; signal(SIGINT, sig_handler); /* 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; ret = perf_session__process_events(script->session); 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; 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 { 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; } if (output_set_by_user()) pr_warning("Overriding previous field request for all events.\n"); for (j = 0; j < PERF_TYPE_MAX; ++j) { output[j].fields = 0; output[j].user_set = true; output[j].wildcard_set = true; } } for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) { 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 = 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 < PERF_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 output[j].fields |= all_output_options[i].field; } } 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].fields |= all_output_options[i].field; } } 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)); } } out: free(str); return rc; } /* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */ static int is_directory(const char *base_path, const struct dirent *dent) { char path[PATH_MAX]; struct stat st; sprintf(path, "%s/%s", base_path, dent->d_name); if (stat(path, &st)) return 0; return S_ISDIR(st.st_mode); } #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) goto out_delete_desc; script_desc__add(s); return s; out_delete_desc: script_desc__delete(s); return NULL; } 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) { snprintf(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); snprintf(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; sprintf(filename, "%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_file file = { .path = input_name, .mode = PERF_DATA_MODE_READ, }; char *temp; int i = 0; session = perf_session__new(&file, 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) { snprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path, lang_dirent->d_name); #ifdef NO_LIBPERL if (strstr(lang_path, "perl")) continue; #endif #ifdef NO_LIBPYTHON 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); } closedir(scripts_dir); perf_session__delete(session); return i; } static char *get_script_path(const char *script_root, const char *suffix) { struct dirent *script_dirent, *lang_dirent; char scripts_path[MAXPATHLEN]; char script_path[MAXPATHLEN]; DIR *scripts_dir, *lang_dir; char lang_path[MAXPATHLEN]; char *__script_root; snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path()); scripts_dir = opendir(scripts_path); if (!scripts_dir) return NULL; for_each_lang(scripts_path, scripts_dir, lang_dirent) { snprintf(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, suffix); if (__script_root && !strcmp(script_root, __script_root)) { free(__script_root); closedir(lang_dir); closedir(scripts_dir); snprintf(script_path, MAXPATHLEN, "%s/%s", lang_path, script_dirent->d_name); return strdup(script_path); } free(__script_root); } closedir(lang_dir); } closedir(scripts_dir); return NULL; } static bool is_top_script(const char *script_path) { return ends_with(script_path, "top") == NULL ? false : true; } static int has_required_arg(char *script_path) { struct script_desc *desc; int n_args = 0; char *p; desc = script_desc__new(NULL); if (read_script_info(desc, script_path)) goto out; if (!desc->args) goto out; for (p = desc->args; *p; p++) if (*p == '<') n_args++; out: script_desc__delete(desc); return n_args; } static int have_cmd(int argc, const char **argv) { char **__argv = malloc(sizeof(const char *) * argc); if (!__argv) { pr_err("malloc failed\n"); return -1; } memcpy(__argv, argv, sizeof(const char *) * argc); argc = parse_options(argc, (const char **)__argv, record_options, NULL, PARSE_OPT_STOP_AT_NON_OPTION); free(__argv); system_wide = (argc == 0); return 0; } static void script__setup_sample_type(struct perf_script *script) { struct perf_session *session = script->session; u64 sample_type = perf_evlist__combined_sample_type(session->evlist); if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) { if ((sample_type & PERF_SAMPLE_REGS_USER) && (sample_type & PERF_SAMPLE_STACK_USER)) callchain_param.record_mode = CALLCHAIN_DWARF; else if (sample_type & PERF_SAMPLE_BRANCH_STACK) callchain_param.record_mode = CALLCHAIN_LBR; else callchain_param.record_mode = CALLCHAIN_FP; } } static int process_stat_round_event(struct perf_tool *tool __maybe_unused, union perf_event *event, struct perf_session *session) { struct stat_round_event *round = &event->stat_round; struct perf_evsel *counter; evlist__for_each_entry(session->evlist, counter) { perf_stat_process_counter(&stat_config, counter); process_stat(counter, round->time); } process_stat_interval(round->time); return 0; } static int process_stat_config_event(struct perf_tool *tool __maybe_unused, union perf_event *event, struct perf_session *session __maybe_unused) { perf_event__read_stat_config(&stat_config, &event->stat_config); return 0; } static int set_maps(struct perf_script *script) { struct perf_evlist *evlist = script->session->evlist; if (!script->cpus || !script->threads) return 0; if (WARN_ONCE(script->allocated, "stats double allocation\n")) return -EINVAL; perf_evlist__set_maps(evlist, script->cpus, script->threads); if (perf_evlist__alloc_stats(evlist, true)) return -ENOMEM; script->allocated = true; return 0; } static int process_thread_map_event(struct perf_tool *tool, union perf_event *event, struct perf_session *session __maybe_unused) { struct perf_script *script = container_of(tool, struct perf_script, tool); if (script->threads) { pr_warning("Extra thread map event, ignoring.\n"); return 0; } script->threads = thread_map__new_event(&event->thread_map); if (!script->threads) return -ENOMEM; return set_maps(script); } static int process_cpu_map_event(struct perf_tool *tool __maybe_unused, union perf_event *event, struct perf_session *session __maybe_unused) { struct perf_script *script = container_of(tool, struct perf_script, tool); if (script->cpus) { pr_warning("Extra cpu map event, ignoring.\n"); return 0; } script->cpus = cpu_map__new_data(&event->cpu_map.data); if (!script->cpus) return -ENOMEM; return set_maps(script); } int cmd_script(int argc, const char **argv) { bool show_full_info = false; bool header = false; bool header_only = false; bool script_started = false; char *rec_script_path = NULL; char *rep_script_path = NULL; struct perf_session *session; struct itrace_synth_opts itrace_synth_opts = { .set = false, }; char *script_path = NULL; const char **__argv; int i, j, err = 0; struct perf_script script = { .tool = { .sample = process_sample_event, .mmap = perf_event__process_mmap, .mmap2 = perf_event__process_mmap2, .comm = perf_event__process_comm, .namespaces = perf_event__process_namespaces, .exit = perf_event__process_exit, .fork = perf_event__process_fork, .attr = process_attr, .event_update = perf_event__process_event_update, .tracing_data = perf_event__process_tracing_data, .build_id = perf_event__process_build_id, .id_index = perf_event__process_id_index, .auxtrace_info = perf_event__process_auxtrace_info, .auxtrace = perf_event__process_auxtrace, .auxtrace_error = perf_event__process_auxtrace_error, .stat = perf_event__process_stat_event, .stat_round = process_stat_round_event, .stat_config = process_stat_config_event, .thread_map = process_thread_map_event, .cpu_map = process_cpu_map_event, .ordered_events = true, .ordering_requires_timestamps = true, }, }; struct perf_data_file file = { .mode = PERF_DATA_MODE_READ, }; const struct option options[] = { OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace, "dump raw trace in ASCII"), OPT_INCR('v', "verbose", &verbose, "be more verbose (show symbol address, etc)"), OPT_BOOLEAN('L', "Latency", &latency_format, "show latency attributes (irqs/preemption disabled, etc)"), OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts", list_available_scripts), OPT_CALLBACK('s', "script", NULL, "name", "script file name (lang:script name, script name, or *)", parse_scriptname), OPT_STRING('g', "gen-script", &generate_script_lang, "lang", "generate perf-script.xx script in specified language"), OPT_STRING('i', "input", &input_name, "file", "input file name"), OPT_BOOLEAN('d', "debug-mode", &debug_mode, "do various checks like samples ordering and lost events"), OPT_BOOLEAN(0, "header", &header, "Show data header."), OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."), OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name, "file", "vmlinux pathname"), OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name, "file", "kallsyms pathname"), OPT_BOOLEAN('G', "hide-call-graph", &no_callchain, "When printing symbols do not display call chain"), OPT_CALLBACK(0, "symfs", NULL, "directory", "Look for files with symbols relative to this directory", symbol__config_symfs), OPT_CALLBACK('F', "fields", NULL, "str", "comma separated output fields prepend with 'type:'. " "Valid types: hw,sw,trace,raw. " "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso," "addr,symoff,period,iregs,brstack,brstacksym,flags," "bpf-output,callindent,insn,insnlen,brstackinsn", parse_output_fields), OPT_BOOLEAN('a', "all-cpus", &system_wide, "system-wide collection from all CPUs"), OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]", "only consider these symbols"), OPT_STRING(0, "stop-bt", &symbol_conf.bt_stop_list_str, "symbol[,symbol...]", "Stop display of callgraph at these symbols"), OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"), OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]", "only display events for these comms"), OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]", "only consider symbols in these pids"), OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]", "only consider symbols in these tids"), OPT_UINTEGER(0, "max-stack", &scripting_max_stack, "Set the maximum stack depth when parsing the callchain, " "anything beyond the specified depth will be ignored. " "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)), OPT_BOOLEAN('I', "show-info", &show_full_info, "display extended information from perf.data file"), OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path, "Show the path of [kernel.kallsyms]"), OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events, "Show the fork/comm/exit events"), OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events, "Show the mmap events"), OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events, "Show context switch events (if recorded)"), OPT_BOOLEAN('\0', "show-namespace-events", &script.show_namespace_events, "Show namespace events (if recorded)"), OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"), OPT_INTEGER(0, "max-blocks", &max_blocks, "Maximum number of code blocks to dump with brstackinsn"), OPT_BOOLEAN(0, "ns", &nanosecs, "Use 9 decimal places when displaying time"), OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts", "Instruction Tracing options", itrace_parse_synth_opts), OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename, "Show full source file name path for source lines"), OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle, "Enable symbol demangling"), OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel, "Enable kernel symbol demangling"), OPT_STRING(0, "time", &script.time_str, "str", "Time span of interest (start,stop)"), OPT_END() }; const char * const script_subcommands[] = { "record", "report", NULL }; const char *script_usage[] = { "perf script []", "perf script [] record