1e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#ifndef __PERF_ANNOTATE_H 2e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#define __PERF_ANNOTATE_H 3e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 4e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#include <stdbool.h> 5e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#include <stdint.h> 6e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#include "types.h" 7e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#include "symbol.h" 8e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#include "hist.h" 9e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#include "sort.h" 10e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#include <linux/list.h> 11e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#include <linux/rbtree.h> 12e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#include <pthread.h> 13e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 14e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstruct ins; 15e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 16e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstruct ins_operands { 17e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng char *raw; 18e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct { 19e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng char *raw; 20e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng char *name; 21e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng u64 addr; 22e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng u64 offset; 23e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng } target; 24e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng union { 25e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct { 26e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng char *raw; 27e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng char *name; 28e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng u64 addr; 29e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng } source; 30e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct { 31e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct ins *ins; 32e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct ins_operands *ops; 33e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng } locked; 34e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng }; 35e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng}; 36e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 37e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstruct ins_ops { 38e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng void (*free)(struct ins_operands *ops); 39e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng int (*parse)(struct ins_operands *ops); 40e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng int (*scnprintf)(struct ins *ins, char *bf, size_t size, 41e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct ins_operands *ops); 42e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng}; 43e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 44e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstruct ins { 45e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng const char *name; 46e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct ins_ops *ops; 47e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng}; 48e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 49e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengbool ins__is_jump(const struct ins *ins); 50e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengbool ins__is_call(const struct ins *ins); 51e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengint ins__scnprintf(struct ins *ins, char *bf, size_t size, struct ins_operands *ops); 52e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 53e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstruct annotation; 54e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 55e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstruct disasm_line { 56e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct list_head node; 57e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng s64 offset; 58e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng char *line; 59e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng char *name; 60e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct ins *ins; 61e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct ins_operands ops; 62e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng}; 63e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 64e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic inline bool disasm_line__has_offset(const struct disasm_line *dl) 65e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 66e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return dl->ops.target.offset != UINT64_MAX; 67e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 68e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 69e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengvoid disasm_line__free(struct disasm_line *dl); 70e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstruct disasm_line *disasm__get_next_ip_line(struct list_head *head, struct disasm_line *pos); 71e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengint disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw); 72e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengsize_t disasm__fprintf(struct list_head *head, FILE *fp); 73e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengdouble disasm__calc_percent(struct annotation *notes, int evidx, s64 offset, 74e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng s64 end, const char **path); 75e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 76e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstruct sym_hist { 77e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng u64 sum; 78e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng u64 addr[0]; 79e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng}; 80e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 81e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstruct source_line_percent { 82e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng double percent; 83e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng double percent_sum; 84e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng}; 85e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 86e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstruct source_line { 87e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct rb_node node; 88e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng char *path; 89e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng int nr_pcnt; 90e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct source_line_percent p[1]; 91e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng}; 92e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 93e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng/** struct annotated_source - symbols with hits have this attached as in sannotation 94e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng * 95e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng * @histogram: Array of addr hit histograms per event being monitored 96e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng * @lines: If 'print_lines' is specified, per source code line percentages 97e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng * @source: source parsed from a disassembler like objdump -dS 98e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng * 99e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng * lines is allocated, percentages calculated and all sorted by percentage 100e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng * when the annotation is about to be presented, so the percentages are for 101e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng * one of the entries in the histogram array, i.e. for the event/counter being 102e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng * presented. It is deallocated right after symbol__{tui,tty,etc}_annotate 103e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng * returns. 104e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng */ 105e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstruct annotated_source { 106e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct list_head source; 107e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct source_line *lines; 108e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng int nr_histograms; 109e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng int sizeof_sym_hist; 110e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct sym_hist histograms[0]; 111e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng}; 112e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 113e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstruct annotation { 114e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng pthread_mutex_t lock; 115e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct annotated_source *src; 116e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng}; 117e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 118e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstruct sannotation { 119e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct annotation annotation; 120e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct symbol symbol; 121e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng}; 122e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 123e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx) 124e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 125e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return (((void *)¬es->src->histograms) + 126e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng (notes->src->sizeof_sym_hist * idx)); 127e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 128e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 129e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic inline struct annotation *symbol__annotation(struct symbol *sym) 130e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 131e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct sannotation *a = container_of(sym, struct sannotation, symbol); 132e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return &a->annotation; 133e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 134e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 135e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengint symbol__inc_addr_samples(struct symbol *sym, struct map *map, 136e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng int evidx, u64 addr); 137e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengint symbol__alloc_hist(struct symbol *sym); 138e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengvoid symbol__annotate_zero_histograms(struct symbol *sym); 139e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 140e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengint symbol__annotate(struct symbol *sym, struct map *map, size_t privsize); 141e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengint symbol__annotate_init(struct map *map __maybe_unused, struct symbol *sym); 142e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengint symbol__annotate_printf(struct symbol *sym, struct map *map, 143e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct perf_evsel *evsel, bool full_paths, 144e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng int min_pcnt, int max_lines, int context); 145e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengvoid symbol__annotate_zero_histogram(struct symbol *sym, int evidx); 146e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengvoid symbol__annotate_decay_histogram(struct symbol *sym, int evidx); 147e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengvoid disasm__purge(struct list_head *head); 148e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 149e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengint symbol__tty_annotate(struct symbol *sym, struct map *map, 150e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct perf_evsel *evsel, bool print_lines, 151e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng bool full_paths, int min_pcnt, int max_lines); 152e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 153e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#ifdef SLANG_SUPPORT 154e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengint symbol__tui_annotate(struct symbol *sym, struct map *map, 155e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct perf_evsel *evsel, 156e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct hist_browser_timer *hbt); 157e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#else 158e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic inline int symbol__tui_annotate(struct symbol *sym __maybe_unused, 159e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct map *map __maybe_unused, 160e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct perf_evsel *evsel __maybe_unused, 161e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct hist_browser_timer *hbt 162e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng __maybe_unused) 163e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 164e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return 0; 165e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 166e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#endif 167e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 168e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#ifdef GTK2_SUPPORT 169e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengint symbol__gtk_annotate(struct symbol *sym, struct map *map, 170e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct perf_evsel *evsel, 171e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct hist_browser_timer *hbt); 172e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 173e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic inline int hist_entry__gtk_annotate(struct hist_entry *he, 174e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct perf_evsel *evsel, 175e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct hist_browser_timer *hbt) 176e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 177e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return symbol__gtk_annotate(he->ms.sym, he->ms.map, evsel, hbt); 178e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 179e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 180e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengvoid perf_gtk__show_annotations(void); 181e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#else 182e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic inline int hist_entry__gtk_annotate(struct hist_entry *he __maybe_unused, 183e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct perf_evsel *evsel __maybe_unused, 184e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct hist_browser_timer *hbt __maybe_unused) 185e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 186e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return 0; 187e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 188e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 189e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic inline void perf_gtk__show_annotations(void) {} 190e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#endif 191e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 192e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengextern const char *disassembler_style; 193e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 194e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#endif /* __PERF_ANNOTATE_H */ 195