annotate.h

Go to the documentation of this file.

#ifndef __PERF_ANNOTATE_H
#define __PERF_ANNOTATE_H

#include <stdbool.h>
#include <stdint.h>
#include "types.h"
#include "symbol.h"
#include <linux/list.h>
#include <linux/rbtree.h>
#include <pthread.h>

struct ins;

struct ins_operands {
    char    *raw;
    struct {
        char    *raw;
        char    *name;
        u64 addr;
        u64 offset;
    } target;
    union {
        struct {
            char    *raw;
            char    *name;
            u64 addr;
        } source;
        struct {
            struct ins *ins;
            struct ins_operands *ops;
        } locked;
    };
};

struct ins_ops {
    void (*free)(struct ins_operands *ops);
    int (*parse)(struct ins_operands *ops);
    int (*scnprintf)(struct ins *ins, char *bf, size_t size,
             struct ins_operands *ops);
};

struct ins {
    const char     *name;
    struct ins_ops *ops;
};

bool ins__is_jump(const struct ins *ins);
bool ins__is_call(const struct ins *ins);
int ins__scnprintf(struct ins *ins, char *bf, size_t size, struct ins_operands *ops);

struct disasm_line {
    struct list_head    node;
    s64         offset;
    char            *line;
    char            *name;
    struct ins      *ins;
    struct ins_operands ops;
};

static inline bool disasm_line__has_offset(const struct disasm_line *dl)
{
    return dl->ops.target.offset != UINT64_MAX;
}

void disasm_line__free(struct disasm_line *dl);
struct disasm_line *disasm__get_next_ip_line(struct list_head *head, struct disasm_line *pos);
int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw);
size_t disasm__fprintf(struct list_head *head, FILE *fp);

struct sym_hist {
    u64     sum;
    u64     addr[0];
};

struct source_line {
    struct rb_node  node;
    double      percent;
    char        *path;
};

struct annotated_source {
    struct list_head   source;
    struct source_line *lines;
    int            nr_histograms;
    int            sizeof_sym_hist;
    struct sym_hist    histograms[0];
};

struct annotation {
    pthread_mutex_t     lock;
    struct annotated_source *src;
};

struct sannotation {
    struct annotation annotation;
    struct symbol     symbol;
};

static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx)
{
    return (((void *)&notes->src->histograms) +
        (notes->src->sizeof_sym_hist * idx));
}

static inline struct annotation *symbol__annotation(struct symbol *sym)
{
    struct sannotation *a = container_of(sym, struct sannotation, symbol);
    return &a->annotation;
}

int symbol__inc_addr_samples(struct symbol *sym, struct map *map,
                 int evidx, u64 addr);
int symbol__alloc_hist(struct symbol *sym);
void symbol__annotate_zero_histograms(struct symbol *sym);

int symbol__annotate(struct symbol *sym, struct map *map, size_t privsize);
int symbol__annotate_init(struct map *map __maybe_unused, struct symbol *sym);
int symbol__annotate_printf(struct symbol *sym, struct map *map, int evidx,
                bool full_paths, int min_pcnt, int max_lines,
                int context);
void symbol__annotate_zero_histogram(struct symbol *sym, int evidx);
void symbol__annotate_decay_histogram(struct symbol *sym, int evidx);
void disasm__purge(struct list_head *head);

int symbol__tty_annotate(struct symbol *sym, struct map *map, int evidx,
             bool print_lines, bool full_paths, int min_pcnt,
             int max_lines);

#ifdef NEWT_SUPPORT
int symbol__tui_annotate(struct symbol *sym, struct map *map, int evidx,
             void(*timer)(void *arg), void *arg, int delay_secs);
#else
static inline int symbol__tui_annotate(struct symbol *sym __maybe_unused,
                       struct map *map __maybe_unused,
                       int evidx __maybe_unused,
                       void(*timer)(void *arg) __maybe_unused,
                       void *arg __maybe_unused,
                       int delay_secs __maybe_unused)
{
    return 0;
}
#endif

extern const char   *disassembler_style;
extern const char   *objdump_path;

#endif  /* __PERF_ANNOTATE_H */