[mirror_ubuntu-zesty-kernel.git] / tools / perf / util / annotate.h

#ifndef __PERF_ANNOTATE_H
#define __PERF_ANNOTATE_H

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

struct objdump_line {
	struct list_head node;
	s64		 offset;
	char		 *line;
};

void objdump_line__free(struct objdump_line *self);
struct objdump_line *objdump__get_next_ip_line(struct list_head *head,
					       struct objdump_line *pos);

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

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

/** struct annotation - symbols with hits have this attached as in sannotation
 *
 * @histogram: Array of addr hit histograms per event being monitored
 * @src_line: If 'print_lines' is specified, per source code line percentages
 *
 * src_line is allocated, percentages calculated and all sorted by percentage
 * when the annotation is about to be presented, so the percentages are for
 * one of the entries in the histogram array, i.e. for the event/counter being
 * presented. It is deallocated right after symbol__{tui,tty,etc}_annotate
 * returns.
 */
struct annotation {
	struct source_line *src_line;
	struct sym_hist	   *histograms;
	int    		   sizeof_sym_hist;
};

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

static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx)
{
	return ((void *)notes->histograms) + (notes->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, int nevents);

int symbol__annotate(struct symbol *sym, struct map *map,
		     struct list_head *head, size_t privsize);

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

#ifdef NO_NEWT_SUPPORT
static inline int symbol__tui_annotate(symbol *sym __used,
				       struct map *map __used, int evidx __used)
{
	return 0;
}
#else
int symbol__tui_annotate(struct symbol *sym, struct map *map, int evidx);
#endif

#endif	/* __PERF_ANNOTATE_H */
Commit	Line	Data
78f7defe ACM	1	#ifndef __PERF_ANNOTATE_H
	2	#define __PERF_ANNOTATE_H
	3
	4	#include <stdbool.h>
	5	#include "types.h"
	6	#include "symbol.h"
	7	#include <linux/list.h>
	8	#include <linux/rbtree.h>
	9
	10	struct objdump_line {
	11	struct list_head node;
	12	s64 offset;
	13	char *line;
	14	};
	15
	16	void objdump_line__free(struct objdump_line *self);
	17	struct objdump_line objdump__get_next_ip_line(struct list_head head,
	18	struct objdump_line *pos);
	19
	20	struct sym_hist {
	21	u64 sum;
	22	u64 addr[0];
	23	};
	24
	25	struct source_line {
	26	struct rb_node node;
	27	double percent;
	28	char *path;
	29	};
	30
2f525d01 ACM	31	/** struct annotation - symbols with hits have this attached as in sannotation
	32	*
	33	* @histogram: Array of addr hit histograms per event being monitored
	34	* @src_line: If 'print_lines' is specified, per source code line percentages
	35	*
	36	* src_line is allocated, percentages calculated and all sorted by percentage
	37	* when the annotation is about to be presented, so the percentages are for
	38	* one of the entries in the histogram array, i.e. for the event/counter being
	39	* presented. It is deallocated right after symbol__{tui,tty,etc}_annotate
	40	* returns.
	41	*/
78f7defe	42	struct annotation {
78f7defe	43	struct source_line *src_line;
2f525d01 ACM	44	struct sym_hist *histograms;
2f525d01 ACM	45	int sizeof_sym_hist;
78f7defe ACM	46	};
	47
	48	struct sannotation {
	49	struct annotation annotation;
	50	struct symbol symbol;
	51	};
	52
2f525d01 ACM	53	static inline struct sym_hist annotation__histogram(struct annotation notes, int idx)
	54	{
	55	return ((void )notes->histograms) + (notes->sizeof_sym_hist idx);
	56	}
	57
78f7defe ACM	58	static inline struct annotation symbol__annotation(struct symbol sym)
	59	{
	60	struct sannotation *a = container_of(sym, struct sannotation, symbol);
	61	return &a->annotation;
	62	}
	63
2f525d01 ACM	64	int symbol__inc_addr_samples(struct symbol sym, struct map map,
	65	int evidx, u64 addr);
	66	int symbol__alloc_hist(struct symbol *sym, int nevents);
78f7defe ACM	67
	68	int symbol__annotate(struct symbol sym, struct map map,
	69	struct list_head *head, size_t privsize);
	70
2f525d01	71	int symbol__tty_annotate(struct symbol sym, struct map map, int evidx,
78f7defe ACM	72	bool print_lines, bool full_paths);
	73
	74	#ifdef NO_NEWT_SUPPORT
	75	static inline int symbol__tui_annotate(symbol *sym __used,
2f525d01	76	struct map *map __used, int evidx __used)
78f7defe ACM	77	{
	78	return 0;
	79	}
	80	#else
2f525d01	81	int symbol__tui_annotate(struct symbol sym, struct map map, int evidx);
78f7defe ACM	82	#endif
	83
	84	#endif /* __PERF_ANNOTATE_H */