[net-next-2.6.git] / tools / perf / builtin-annotate.c

/*
 * builtin-annotate.c
 *
 * Builtin annotate command: Analyze the perf.data input file,
 * look up and read DSOs and symbol information and display
 * a histogram of results, along various sorting keys.
 */
#include "builtin.h"

#include "util/util.h"

#include "util/color.h"
#include <linux/list.h>
#include "util/cache.h"
#include <linux/rbtree.h>
#include "util/symbol.h"
#include "util/string.h"

#include "perf.h"
#include "util/debug.h"

#include "util/parse-options.h"
#include "util/parse-events.h"
#include "util/thread.h"
#include "util/sort.h"
#include "util/hist.h"

static char		const *input_name = "perf.data";

static int		force;
static int		input;
static int		show_mask = SHOW_KERNEL | SHOW_USER | SHOW_HV;

static int		full_paths;

static int		print_line;

static unsigned long	page_size;
static unsigned long	mmap_window = 32;

static struct rb_root	threads;
static struct thread	*last_match;


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


/*
 * collect histogram counts
 */
static void hist_hit(struct hist_entry *he, u64 ip)
{
	unsigned int sym_size, offset;
	struct symbol *sym = he->sym;

	he->count++;

	if (!sym || !sym->hist)
		return;

	sym_size = sym->end - sym->start;
	offset = ip - sym->start;

	if (offset >= sym_size)
		return;

	sym->hist_sum++;
	sym->hist[offset]++;

	if (verbose >= 3)
		printf("%p %s: count++ [ip: %p, %08Lx] => %Ld\n",
			(void *)(unsigned long)he->sym->start,
			he->sym->name,
			(void *)(unsigned long)ip, ip - he->sym->start,
			sym->hist[offset]);
}

static int
hist_entry__add(struct thread *thread, struct map *map, struct dso *dso,
		struct symbol *sym, u64 ip, char level)
{
	struct rb_node **p = &hist.rb_node;
	struct rb_node *parent = NULL;
	struct hist_entry *he;
	struct hist_entry entry = {
		.thread	= thread,
		.map	= map,
		.dso	= dso,
		.sym	= sym,
		.ip	= ip,
		.level	= level,
		.count	= 1,
	};
	int cmp;

	while (*p != NULL) {
		parent = *p;
		he = rb_entry(parent, struct hist_entry, rb_node);

		cmp = hist_entry__cmp(&entry, he);

		if (!cmp) {
			hist_hit(he, ip);

			return 0;
		}

		if (cmp < 0)
			p = &(*p)->rb_left;
		else
			p = &(*p)->rb_right;
	}

	he = malloc(sizeof(*he));
	if (!he)
		return -ENOMEM;
	*he = entry;
	rb_link_node(&he->rb_node, parent, p);
	rb_insert_color(&he->rb_node, &hist);

	return 0;
}

static int
process_sample_event(event_t *event, unsigned long offset, unsigned long head)
{
	char level;
	int show = 0;
	struct dso *dso = NULL;
	struct thread *thread;
	u64 ip = event->ip.ip;
	struct map *map = NULL;

	thread = threads__findnew(event->ip.pid, &threads, &last_match);

	dump_printf("%p [%p]: PERF_EVENT (IP, %d): %d: %p\n",
		(void *)(offset + head),
		(void *)(long)(event->header.size),
		event->header.misc,
		event->ip.pid,
		(void *)(long)ip);

	dump_printf(" ... thread: %s:%d\n", thread->comm, thread->pid);

	if (thread == NULL) {
		fprintf(stderr, "problem processing %d event, skipping it.\n",
			event->header.type);
		return -1;
	}

	if (event->header.misc & PERF_RECORD_MISC_KERNEL) {
		show = SHOW_KERNEL;
		level = 'k';

		dso = kernel_dso;

		dump_printf(" ...... dso: %s\n", dso->name);

	} else if (event->header.misc & PERF_RECORD_MISC_USER) {

		show = SHOW_USER;
		level = '.';

		map = thread__find_map(thread, ip);
		if (map != NULL) {
			ip = map->map_ip(map, ip);
			dso = map->dso;
		} else {
			/*
			 * If this is outside of all known maps,
			 * and is a negative address, try to look it
			 * up in the kernel dso, as it might be a
			 * vsyscall (which executes in user-mode):
			 */
			if ((long long)ip < 0)
				dso = kernel_dso;
		}
		dump_printf(" ...... dso: %s\n", dso ? dso->name : "<not found>");

	} else {
		show = SHOW_HV;
		level = 'H';
		dump_printf(" ...... dso: [hypervisor]\n");
	}

	if (show & show_mask) {
		struct symbol *sym = NULL;

		if (dso)
			sym = dso->find_symbol(dso, ip);

		if (hist_entry__add(thread, map, dso, sym, ip, level)) {
			fprintf(stderr,
		"problem incrementing symbol count, skipping event\n");
			return -1;
		}
	}
	total++;

	return 0;
}

static int
process_mmap_event(event_t *event, unsigned long offset, unsigned long head)
{
	struct thread *thread;
	struct map *map = map__new(&event->mmap, NULL, 0);

	thread = threads__findnew(event->mmap.pid, &threads, &last_match);

	dump_printf("%p [%p]: PERF_RECORD_MMAP %d: [%p(%p) @ %p]: %s\n",
		(void *)(offset + head),
		(void *)(long)(event->header.size),
		event->mmap.pid,
		(void *)(long)event->mmap.start,
		(void *)(long)event->mmap.len,
		(void *)(long)event->mmap.pgoff,
		event->mmap.filename);

	if (thread == NULL || map == NULL) {
		dump_printf("problem processing PERF_RECORD_MMAP, skipping event.\n");
		return 0;
	}

	thread__insert_map(thread, map);
	total_mmap++;

	return 0;
}

static int
process_comm_event(event_t *event, unsigned long offset, unsigned long head)
{
	struct thread *thread;

	thread = threads__findnew(event->comm.pid, &threads, &last_match);
	dump_printf("%p [%p]: PERF_RECORD_COMM: %s:%d\n",
		(void *)(offset + head),
		(void *)(long)(event->header.size),
		event->comm.comm, event->comm.pid);

	if (thread == NULL ||
	    thread__set_comm(thread, event->comm.comm)) {
		dump_printf("problem processing PERF_RECORD_COMM, skipping event.\n");
		return -1;
	}
	total_comm++;

	return 0;
}

static int
process_fork_event(event_t *event, unsigned long offset, unsigned long head)
{
	struct thread *thread;
	struct thread *parent;

	thread = threads__findnew(event->fork.pid, &threads, &last_match);
	parent = threads__findnew(event->fork.ppid, &threads, &last_match);
	dump_printf("%p [%p]: PERF_RECORD_FORK: %d:%d\n",
		(void *)(offset + head),
		(void *)(long)(event->header.size),
		event->fork.pid, event->fork.ppid);

	/*
	 * A thread clone will have the same PID for both
	 * parent and child.
	 */
	if (thread == parent)
		return 0;

	if (!thread || !parent || thread__fork(thread, parent)) {
		dump_printf("problem processing PERF_RECORD_FORK, skipping event.\n");
		return -1;
	}
	total_fork++;

	return 0;
}

static int
process_event(event_t *event, unsigned long offset, unsigned long head)
{
	switch (event->header.type) {
	case PERF_RECORD_SAMPLE:
		return process_sample_event(event, offset, head);

	case PERF_RECORD_MMAP:
		return process_mmap_event(event, offset, head);

	case PERF_RECORD_COMM:
		return process_comm_event(event, offset, head);

	case PERF_RECORD_FORK:
		return process_fork_event(event, offset, head);
	/*
	 * We dont process them right now but they are fine:
	 */

	case PERF_RECORD_THROTTLE:
	case PERF_RECORD_UNTHROTTLE:
		return 0;

	default:
		return -1;
	}

	return 0;
}

static int
parse_line(FILE *file, struct symbol *sym, u64 start, u64 len)
{
	char *line = NULL, *tmp, *tmp2;
	static const char *prev_line;
	static const char *prev_color;
	unsigned int offset;
	size_t line_len;
	s64 line_ip;
	int ret;
	char *c;

	if (getline(&line, &line_len, file) < 0)
		return -1;
	if (!line)
		return -1;

	c = strchr(line, '\n');
	if (c)
		*c = 0;

	line_ip = -1;
	offset = 0;
	ret = -2;

	/*
	 * Strip leading spaces:
	 */
	tmp = line;
	while (*tmp) {
		if (*tmp != ' ')
			break;
		tmp++;
	}

	if (*tmp) {
		/*
		 * Parse hexa addresses followed by ':'
		 */
		line_ip = strtoull(tmp, &tmp2, 16);
		if (*tmp2 != ':')
			line_ip = -1;
	}

	if (line_ip != -1) {
		const char *path = NULL;
		unsigned int hits = 0;
		double percent = 0.0;
		const char *color;
		struct sym_ext *sym_ext = sym->priv;

		offset = line_ip - start;
		if (offset < len)
			hits = sym->hist[offset];

		if (offset < len && sym_ext) {
			path = sym_ext[offset].path;
			percent = sym_ext[offset].percent;
		} else if (sym->hist_sum)
			percent = 100.0 * hits / sym->hist_sum;

		color = get_percent_color(percent);

		/*
		 * Also color the filename and line if needed, with
		 * the same color than the percentage. Don't print it
		 * twice for close colored ip with the same filename:line
		 */
		if (path) {
			if (!prev_line || strcmp(prev_line, path)
				       || color != prev_color) {
				color_fprintf(stdout, color, " %s", path);
				prev_line = path;
				prev_color = color;
			}
		}

		color_fprintf(stdout, color, " %7.2f", percent);
		printf(" :	");
		color_fprintf(stdout, PERF_COLOR_BLUE, "%s\n", line);
	} else {
		if (!*line)
			printf("         :\n");
		else
			printf("         :	%s\n", line);
	}

	return 0;
}

static struct rb_root root_sym_ext;

static void insert_source_line(struct sym_ext *sym_ext)
{
	struct sym_ext *iter;
	struct rb_node **p = &root_sym_ext.rb_node;
	struct rb_node *parent = NULL;

	while (*p != NULL) {
		parent = *p;
		iter = rb_entry(parent, struct sym_ext, node);

		if (sym_ext->percent > iter->percent)
			p = &(*p)->rb_left;
		else
			p = &(*p)->rb_right;
	}

	rb_link_node(&sym_ext->node, parent, p);
	rb_insert_color(&sym_ext->node, &root_sym_ext);
}

static void free_source_line(struct symbol *sym, int len)
{
	struct sym_ext *sym_ext = sym->priv;
	int i;

	if (!sym_ext)
		return;

	for (i = 0; i < len; i++)
		free(sym_ext[i].path);
	free(sym_ext);

	sym->priv = NULL;
	root_sym_ext = RB_ROOT;
}

/* Get the filename:line for the colored entries */
static void
get_source_line(struct symbol *sym, u64 start, int len, const char *filename)
{
	int i;
	char cmd[PATH_MAX * 2];
	struct sym_ext *sym_ext;

	if (!sym->hist_sum)
		return;

	sym->priv = calloc(len, sizeof(struct sym_ext));
	if (!sym->priv)
		return;

	sym_ext = sym->priv;

	for (i = 0; i < len; i++) {
		char *path = NULL;
		size_t line_len;
		u64 offset;
		FILE *fp;

		sym_ext[i].percent = 100.0 * sym->hist[i] / sym->hist_sum;
		if (sym_ext[i].percent <= 0.5)
			continue;

		offset = start + i;
		sprintf(cmd, "addr2line -e %s %016llx", filename, offset);
		fp = popen(cmd, "r");
		if (!fp)
			continue;

		if (getline(&path, &line_len, fp) < 0 || !line_len)
			goto next;

		sym_ext[i].path = malloc(sizeof(char) * line_len + 1);
		if (!sym_ext[i].path)
			goto next;

		strcpy(sym_ext[i].path, path);
		insert_source_line(&sym_ext[i]);

	next:
		pclose(fp);
	}
}

static void print_summary(const char *filename)
{
	struct sym_ext *sym_ext;
	struct rb_node *node;

	printf("\nSorted summary for file %s\n", filename);
	printf("----------------------------------------------\n\n");

	if (RB_EMPTY_ROOT(&root_sym_ext)) {
		printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
		return;
	}

	node = rb_first(&root_sym_ext);
	while (node) {
		double percent;
		const char *color;
		char *path;

		sym_ext = rb_entry(node, struct sym_ext, node);
		percent = sym_ext->percent;
		color = get_percent_color(percent);
		path = sym_ext->path;

		color_fprintf(stdout, color, " %7.2f %s", percent, path);
		node = rb_next(node);
	}
}

static void annotate_sym(struct dso *dso, struct symbol *sym)
{
	const char *filename = dso->name, *d_filename;
	u64 start, end, len;
	char command[PATH_MAX*2];
	FILE *file;

	if (!filename)
		return;
	if (sym->module)
		filename = sym->module->path;
	else if (dso == kernel_dso)
		filename = vmlinux_name;

	start = sym->obj_start;
	if (!start)
		start = sym->start;
	if (full_paths)
		d_filename = filename;
	else
		d_filename = basename(filename);

	end = start + sym->end - sym->start + 1;
	len = sym->end - sym->start;

	if (print_line) {
		get_source_line(sym, start, len, filename);
		print_summary(filename);
	}

	printf("\n\n------------------------------------------------\n");
	printf(" Percent |	Source code & Disassembly of %s\n", d_filename);
	printf("------------------------------------------------\n");

	if (verbose >= 2)
		printf("annotating [%p] %30s : [%p] %30s\n", dso, dso->name, sym, sym->name);

	sprintf(command, "objdump --start-address=0x%016Lx --stop-address=0x%016Lx -dS %s|grep -v %s",
			(u64)start, (u64)end, filename, filename);

	if (verbose >= 3)
		printf("doing: %s\n", command);

	file = popen(command, "r");
	if (!file)
		return;

	while (!feof(file)) {
		if (parse_line(file, sym, start, len) < 0)
			break;
	}

	pclose(file);
	if (print_line)
		free_source_line(sym, len);
}

static void find_annotations(void)
{
	struct rb_node *nd;
	struct dso *dso;
	int count = 0;

	list_for_each_entry(dso, &dsos, node) {

		for (nd = rb_first(&dso->syms); nd; nd = rb_next(nd)) {
			struct symbol *sym = rb_entry(nd, struct symbol, rb_node);

			if (sym->hist) {
				annotate_sym(dso, sym);
				count++;
			}
		}
	}

	if (!count)
		printf(" Error: symbol '%s' not present amongst the samples.\n", sym_hist_filter);
}

static int __cmd_annotate(void)
{
	int ret, rc = EXIT_FAILURE;
	unsigned long offset = 0;
	unsigned long head = 0;
	struct stat input_stat;
	event_t *event;
	uint32_t size;
	char *buf;

	register_idle_thread(&threads, &last_match);

	input = open(input_name, O_RDONLY);
	if (input < 0) {
		perror("failed to open file");
		exit(-1);
	}

	ret = fstat(input, &input_stat);
	if (ret < 0) {
		perror("failed to stat file");
		exit(-1);
	}

	if (!force && input_stat.st_uid && (input_stat.st_uid != geteuid())) {
		fprintf(stderr, "file: %s not owned by current user or root\n", input_name);
		exit(-1);
	}

	if (!input_stat.st_size) {
		fprintf(stderr, "zero-sized file, nothing to do!\n");
		exit(0);
	}

	if (load_kernel() < 0) {
		perror("failed to load kernel symbols");
		return EXIT_FAILURE;
	}

remap:
	buf = (char *)mmap(NULL, page_size * mmap_window, PROT_READ,
			   MAP_SHARED, input, offset);
	if (buf == MAP_FAILED) {
		perror("failed to mmap file");
		exit(-1);
	}

more:
	event = (event_t *)(buf + head);

	size = event->header.size;
	if (!size)
		size = 8;

	if (head + event->header.size >= page_size * mmap_window) {
		unsigned long shift = page_size * (head / page_size);
		int munmap_ret;

		munmap_ret = munmap(buf, page_size * mmap_window);
		assert(munmap_ret == 0);

		offset += shift;
		head -= shift;
		goto remap;
	}

	size = event->header.size;

	dump_printf("%p [%p]: event: %d\n",
			(void *)(offset + head),
			(void *)(long)event->header.size,
			event->header.type);

	if (!size || process_event(event, offset, head) < 0) {

		dump_printf("%p [%p]: skipping unknown header type: %d\n",
			(void *)(offset + head),
			(void *)(long)(event->header.size),
			event->header.type);

		total_unknown++;

		/*
		 * assume we lost track of the stream, check alignment, and
		 * increment a single u64 in the hope to catch on again 'soon'.
		 */

		if (unlikely(head & 7))
			head &= ~7ULL;

		size = 8;
	}

	head += size;

	if (offset + head < (unsigned long)input_stat.st_size)
		goto more;

	rc = EXIT_SUCCESS;
	close(input);

	dump_printf("      IP events: %10ld\n", total);
	dump_printf("    mmap events: %10ld\n", total_mmap);
	dump_printf("    comm events: %10ld\n", total_comm);
	dump_printf("    fork events: %10ld\n", total_fork);
	dump_printf(" unknown events: %10ld\n", total_unknown);

	if (dump_trace)
		return 0;

	if (verbose >= 3)
		threads__fprintf(stdout, &threads);

	if (verbose >= 2)
		dsos__fprintf(stdout);

	collapse__resort();
	output__resort(total);

	find_annotations();

	return rc;
}

static const char * const annotate_usage[] = {
	"perf annotate [<options>] <command>",
	NULL
};

static const struct option options[] = {
	OPT_STRING('i', "input", &input_name, "file",
		    "input file name"),
	OPT_STRING('s', "symbol", &sym_hist_filter, "symbol",
		    "symbol to annotate"),
	OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
	OPT_BOOLEAN('v', "verbose", &verbose,
		    "be more verbose (show symbol address, etc)"),
	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
		    "dump raw trace in ASCII"),
	OPT_STRING('k', "vmlinux", &vmlinux_name, "file", "vmlinux pathname"),
	OPT_BOOLEAN('m', "modules", &modules,
		    "load module symbols - WARNING: use only with -k and LIVE kernel"),
	OPT_BOOLEAN('l', "print-line", &print_line,
		    "print matching source lines (may be slow)"),
	OPT_BOOLEAN('P', "full-paths", &full_paths,
		    "Don't shorten the displayed pathnames"),
	OPT_END()
};

static void setup_sorting(void)
{
	char *tmp, *tok, *str = strdup(sort_order);

	for (tok = strtok_r(str, ", ", &tmp);
			tok; tok = strtok_r(NULL, ", ", &tmp)) {
		if (sort_dimension__add(tok) < 0) {
			error("Unknown --sort key: `%s'", tok);
			usage_with_options(annotate_usage, options);
		}
	}

	free(str);
}

int cmd_annotate(int argc, const char **argv, const char *prefix __used)
{
	symbol__init();

	page_size = getpagesize();

	argc = parse_options(argc, argv, options, annotate_usage, 0);

	setup_sorting();

	if (argc) {
		/*
		 * Special case: if there's an argument left then assume tha
		 * it's a symbol filter:
		 */
		if (argc > 1)
			usage_with_options(annotate_usage, options);

		sym_hist_filter = argv[0];
	}

	if (!sym_hist_filter)
		usage_with_options(annotate_usage, options);

	setup_pager();

	if (field_sep && *field_sep == '.') {
		fputs("'.' is the only non valid --field-separator argument\n",
				stderr);
		exit(129);
	}

	return __cmd_annotate();
}
Commit	Line	Data
8035e428 IM	1	/*
	2	* builtin-annotate.c
	3	*
	4	* Builtin annotate command: Analyze the perf.data input file,
	5	* look up and read DSOs and symbol information and display
	6	* a histogram of results, along various sorting keys.
	7	*/
	8	#include "builtin.h"
	9
	10	#include "util/util.h"
	11
	12	#include "util/color.h"
5da50258	13	#include <linux/list.h>
8035e428	14	#include "util/cache.h"
43cbcd8a	15	#include <linux/rbtree.h>
8035e428 IM	16	#include "util/symbol.h"
	17	#include "util/string.h"
	18
	19	#include "perf.h"
8f28827a	20	#include "util/debug.h"
8035e428 IM	21
	22	#include "util/parse-options.h"
	23	#include "util/parse-events.h"
6baa0a5a	24	#include "util/thread.h"
dd68ada2	25	#include "util/sort.h"
3d1d07ec	26	#include "util/hist.h"
8035e428	27
8035e428	28	static char const *input_name = "perf.data";
8035e428	29
fa6963b2	30	static int force;
8035e428 IM	31	static int input;
	32	static int show_mask = SHOW_KERNEL \| SHOW_USER \| SHOW_HV;
	33
42976487 MG	34	static int full_paths;
42976487 MG	35
301406b9 FW	36	static int print_line;
301406b9 FW	37
8035e428 IM	38	static unsigned long page_size;
	39	static unsigned long mmap_window = 32;
	40
6baa0a5a FW	41	static struct rb_root threads;
	42	static struct thread *last_match;
	43
301406b9 FW	44
301406b9 FW	45	struct sym_ext {
971738f3	46	struct rb_node node;
301406b9 FW	47	double percent;
	48	char *path;
	49	};
	50
8035e428	51
0b73da3f IM	52	/*
	53	* collect histogram counts
	54	*/
9cffa8d5	55	static void hist_hit(struct hist_entry *he, u64 ip)
8035e428	56	{
0b73da3f IM	57	unsigned int sym_size, offset;
0b73da3f IM	58	struct symbol *sym = he->sym;
8035e428	59
0b73da3f	60	he->count++;
8035e428	61
0b73da3f IM	62	if (!sym \|\| !sym->hist)
0b73da3f IM	63	return;
8035e428	64
0b73da3f IM	65	sym_size = sym->end - sym->start;
0b73da3f IM	66	offset = ip - sym->start;
8035e428	67
0b73da3f IM	68	if (offset >= sym_size)
0b73da3f IM	69	return;
8035e428	70
0b73da3f IM	71	sym->hist_sum++;
0b73da3f IM	72	sym->hist[offset]++;
8035e428	73
0b73da3f IM	74	if (verbose >= 3)
0b73da3f IM	75	printf("%p %s: count++ [ip: %p, %08Lx] => %Ld\n",
7d37a0cb	76	(void *)(unsigned long)he->sym->start,
0b73da3f	77	he->sym->name,
7d37a0cb	78	(void *)(unsigned long)ip, ip - he->sym->start,
0b73da3f	79	sym->hist[offset]);
8035e428 IM	80	}
8035e428 IM	81
8035e428 IM	82	static int
8035e428 IM	83	hist_entry__add(struct thread thread, struct map map, struct dso *dso,
9cffa8d5	84	struct symbol *sym, u64 ip, char level)
8035e428 IM	85	{
	86	struct rb_node **p = &hist.rb_node;
	87	struct rb_node *parent = NULL;
	88	struct hist_entry *he;
	89	struct hist_entry entry = {
	90	.thread = thread,
	91	.map = map,
	92	.dso = dso,
	93	.sym = sym,
	94	.ip = ip,
	95	.level = level,
	96	.count = 1,
	97	};
	98	int cmp;
	99
	100	while (*p != NULL) {
	101	parent = *p;
	102	he = rb_entry(parent, struct hist_entry, rb_node);
	103
	104	cmp = hist_entry__cmp(&entry, he);
	105
	106	if (!cmp) {
0b73da3f IM	107	hist_hit(he, ip);
0b73da3f IM	108
8035e428 IM	109	return 0;
	110	}
	111
	112	if (cmp < 0)
	113	p = &(*p)->rb_left;
	114	else
	115	p = &(*p)->rb_right;
	116	}
	117
	118	he = malloc(sizeof(*he));
	119	if (!he)
	120	return -ENOMEM;
	121	*he = entry;
	122	rb_link_node(&he->rb_node, parent, p);
	123	rb_insert_color(&he->rb_node, &hist);
	124
	125	return 0;
	126	}
	127
8035e428	128	static int
e6e18ec7	129	process_sample_event(event_t *event, unsigned long offset, unsigned long head)
8035e428 IM	130	{
	131	char level;
	132	int show = 0;
	133	struct dso *dso = NULL;
6baa0a5a	134	struct thread *thread;
9cffa8d5	135	u64 ip = event->ip.ip;
8035e428 IM	136	struct map *map = NULL;
8035e428 IM	137
6baa0a5a FW	138	thread = threads__findnew(event->ip.pid, &threads, &last_match);
6baa0a5a FW	139
2cec19d9	140	dump_printf("%p [%p]: PERF_EVENT (IP, %d): %d: %p\n",
8035e428 IM	141	(void *)(offset + head),
	142	(void *)(long)(event->header.size),
	143	event->header.misc,
	144	event->ip.pid,
	145	(void *)(long)ip);
	146
2cec19d9	147	dump_printf(" ... thread: %s:%d\n", thread->comm, thread->pid);
8035e428 IM	148
	149	if (thread == NULL) {
	150	fprintf(stderr, "problem processing %d event, skipping it.\n",
	151	event->header.type);
	152	return -1;
	153	}
	154
cdd6c482	155	if (event->header.misc & PERF_RECORD_MISC_KERNEL) {
8035e428 IM	156	show = SHOW_KERNEL;
	157	level = 'k';
	158
	159	dso = kernel_dso;
	160
2cec19d9	161	dump_printf(" ...... dso: %s\n", dso->name);
8035e428	162
cdd6c482	163	} else if (event->header.misc & PERF_RECORD_MISC_USER) {
8035e428 IM	164
	165	show = SHOW_USER;
	166	level = '.';
	167
	168	map = thread__find_map(thread, ip);
	169	if (map != NULL) {
	170	ip = map->map_ip(map, ip);
	171	dso = map->dso;
	172	} else {
	173	/*
	174	* If this is outside of all known maps,
	175	* and is a negative address, try to look it
	176	* up in the kernel dso, as it might be a
	177	* vsyscall (which executes in user-mode):
	178	*/
	179	if ((long long)ip < 0)
	180	dso = kernel_dso;
	181	}
2cec19d9	182	dump_printf(" ...... dso: %s\n", dso ? dso->name : "<not found>");
8035e428 IM	183
	184	} else {
	185	show = SHOW_HV;
	186	level = 'H';
2cec19d9	187	dump_printf(" ...... dso: [hypervisor]\n");
8035e428 IM	188	}
	189
	190	if (show & show_mask) {
	191	struct symbol *sym = NULL;
	192
	193	if (dso)
	194	sym = dso->find_symbol(dso, ip);
	195
	196	if (hist_entry__add(thread, map, dso, sym, ip, level)) {
	197	fprintf(stderr,
	198	"problem incrementing symbol count, skipping event\n");
	199	return -1;
	200	}
	201	}
	202	total++;
	203
	204	return 0;
	205	}
	206
	207	static int
	208	process_mmap_event(event_t *event, unsigned long offset, unsigned long head)
	209	{
6baa0a5a	210	struct thread *thread;
66e274f3	211	struct map *map = map__new(&event->mmap, NULL, 0);
8035e428	212
6baa0a5a FW	213	thread = threads__findnew(event->mmap.pid, &threads, &last_match);
6baa0a5a FW	214
cdd6c482	215	dump_printf("%p [%p]: PERF_RECORD_MMAP %d: [%p(%p) @ %p]: %s\n",
8035e428 IM	216	(void *)(offset + head),
	217	(void *)(long)(event->header.size),
	218	event->mmap.pid,
	219	(void *)(long)event->mmap.start,
	220	(void *)(long)event->mmap.len,
	221	(void *)(long)event->mmap.pgoff,
	222	event->mmap.filename);
	223
	224	if (thread == NULL \|\| map == NULL) {
cdd6c482	225	dump_printf("problem processing PERF_RECORD_MMAP, skipping event.\n");
8035e428 IM	226	return 0;
	227	}
	228
	229	thread__insert_map(thread, map);
	230	total_mmap++;
	231
	232	return 0;
	233	}
	234
	235	static int
	236	process_comm_event(event_t *event, unsigned long offset, unsigned long head)
	237	{
6baa0a5a	238	struct thread *thread;
8035e428	239
6baa0a5a	240	thread = threads__findnew(event->comm.pid, &threads, &last_match);
cdd6c482	241	dump_printf("%p [%p]: PERF_RECORD_COMM: %s:%d\n",
8035e428 IM	242	(void *)(offset + head),
	243	(void *)(long)(event->header.size),
	244	event->comm.comm, event->comm.pid);
	245
	246	if (thread == NULL \|\|
	247	thread__set_comm(thread, event->comm.comm)) {
cdd6c482	248	dump_printf("problem processing PERF_RECORD_COMM, skipping event.\n");
8035e428 IM	249	return -1;
	250	}
	251	total_comm++;
	252
	253	return 0;
	254	}
	255
	256	static int
	257	process_fork_event(event_t *event, unsigned long offset, unsigned long head)
	258	{
6baa0a5a FW	259	struct thread *thread;
6baa0a5a FW	260	struct thread *parent;
8035e428	261
6baa0a5a FW	262	thread = threads__findnew(event->fork.pid, &threads, &last_match);
6baa0a5a FW	263	parent = threads__findnew(event->fork.ppid, &threads, &last_match);
cdd6c482	264	dump_printf("%p [%p]: PERF_RECORD_FORK: %d:%d\n",
8035e428 IM	265	(void *)(offset + head),
	266	(void *)(long)(event->header.size),
	267	event->fork.pid, event->fork.ppid);
	268
15f3fa4e IM	269	/*
	270	* A thread clone will have the same PID for both
	271	* parent and child.
	272	*/
	273	if (thread == parent)
	274	return 0;
	275
8035e428	276	if (!thread \|\| !parent \|\| thread__fork(thread, parent)) {
cdd6c482	277	dump_printf("problem processing PERF_RECORD_FORK, skipping event.\n");
8035e428 IM	278	return -1;
	279	}
	280	total_fork++;
	281
	282	return 0;
	283	}
	284
8035e428 IM	285	static int
	286	process_event(event_t *event, unsigned long offset, unsigned long head)
	287	{
8035e428	288	switch (event->header.type) {
cdd6c482	289	case PERF_RECORD_SAMPLE:
e6e18ec7 PZ	290	return process_sample_event(event, offset, head);
e6e18ec7 PZ	291
cdd6c482	292	case PERF_RECORD_MMAP:
8035e428 IM	293	return process_mmap_event(event, offset, head);
8035e428 IM	294
cdd6c482	295	case PERF_RECORD_COMM:
8035e428 IM	296	return process_comm_event(event, offset, head);
8035e428 IM	297
cdd6c482	298	case PERF_RECORD_FORK:
8035e428	299	return process_fork_event(event, offset, head);
8035e428 IM	300	/*
	301	* We dont process them right now but they are fine:
	302	*/
	303
cdd6c482 IM	304	case PERF_RECORD_THROTTLE:
cdd6c482 IM	305	case PERF_RECORD_UNTHROTTLE:
8035e428 IM	306	return 0;
	307
	308	default:
	309	return -1;
	310	}
	311
	312	return 0;
	313	}
	314
0b73da3f	315	static int
9cffa8d5	316	parse_line(FILE file, struct symbol sym, u64 start, u64 len)
0b73da3f IM	317	{
0b73da3f IM	318	char line = NULL, tmp, *tmp2;
301406b9 FW	319	static const char *prev_line;
301406b9 FW	320	static const char *prev_color;
0b73da3f IM	321	unsigned int offset;
0b73da3f IM	322	size_t line_len;
f37a291c	323	s64 line_ip;
0b73da3f IM	324	int ret;
	325	char *c;
	326
	327	if (getline(&line, &line_len, file) < 0)
	328	return -1;
	329	if (!line)
	330	return -1;
	331
	332	c = strchr(line, '\n');
	333	if (c)
	334	*c = 0;
	335
	336	line_ip = -1;
	337	offset = 0;
	338	ret = -2;
	339
	340	/*
	341	* Strip leading spaces:
	342	*/
	343	tmp = line;
	344	while (*tmp) {
	345	if (*tmp != ' ')
	346	break;
	347	tmp++;
	348	}
	349
	350	if (*tmp) {
	351	/*
	352	* Parse hexa addresses followed by ':'
	353	*/
	354	line_ip = strtoull(tmp, &tmp2, 16);
	355	if (*tmp2 != ':')
	356	line_ip = -1;
	357	}
	358
	359	if (line_ip != -1) {
301406b9	360	const char *path = NULL;
0b73da3f IM	361	unsigned int hits = 0;
0b73da3f IM	362	double percent = 0.0;
83a0944f	363	const char *color;
301406b9	364	struct sym_ext *sym_ext = sym->priv;
0b73da3f IM	365
	366	offset = line_ip - start;
	367	if (offset < len)
	368	hits = sym->hist[offset];
	369
c17c2db1	370	if (offset < len && sym_ext) {
301406b9 FW	371	path = sym_ext[offset].path;
	372	percent = sym_ext[offset].percent;
	373	} else if (sym->hist_sum)
0b73da3f IM	374	percent = 100.0 * hits / sym->hist_sum;
0b73da3f IM	375
1e11fd82	376	color = get_percent_color(percent);
0b73da3f	377
301406b9 FW	378	/*
	379	* Also color the filename and line if needed, with
	380	* the same color than the percentage. Don't print it
	381	* twice for close colored ip with the same filename:line
	382	*/
	383	if (path) {
	384	if (!prev_line \|\| strcmp(prev_line, path)
	385	\|\| color != prev_color) {
	386	color_fprintf(stdout, color, " %s", path);
	387	prev_line = path;
	388	prev_color = color;
	389	}
	390	}
	391
0b73da3f IM	392	color_fprintf(stdout, color, " %7.2f", percent);
	393	printf(" : ");
	394	color_fprintf(stdout, PERF_COLOR_BLUE, "%s\n", line);
	395	} else {
	396	if (!*line)
	397	printf(" :\n");
	398	else
	399	printf(" : %s\n", line);
	400	}
	401
	402	return 0;
	403	}
	404
971738f3 FW	405	static struct rb_root root_sym_ext;
	406
	407	static void insert_source_line(struct sym_ext *sym_ext)
	408	{
	409	struct sym_ext *iter;
	410	struct rb_node **p = &root_sym_ext.rb_node;
	411	struct rb_node *parent = NULL;
	412
	413	while (*p != NULL) {
	414	parent = *p;
	415	iter = rb_entry(parent, struct sym_ext, node);
	416
	417	if (sym_ext->percent > iter->percent)
	418	p = &(*p)->rb_left;
	419	else
	420	p = &(*p)->rb_right;
	421	}
	422
	423	rb_link_node(&sym_ext->node, parent, p);
	424	rb_insert_color(&sym_ext->node, &root_sym_ext);
	425	}
	426
301406b9 FW	427	static void free_source_line(struct symbol *sym, int len)
	428	{
	429	struct sym_ext *sym_ext = sym->priv;
	430	int i;
	431
	432	if (!sym_ext)
	433	return;
	434
	435	for (i = 0; i < len; i++)
	436	free(sym_ext[i].path);
	437	free(sym_ext);
	438
	439	sym->priv = NULL;
971738f3	440	root_sym_ext = RB_ROOT;
301406b9 FW	441	}
	442
	443	/* Get the filename:line for the colored entries */
c17c2db1	444	static void
83a0944f	445	get_source_line(struct symbol sym, u64 start, int len, const char filename)
301406b9 FW	446	{
	447	int i;
	448	char cmd[PATH_MAX * 2];
	449	struct sym_ext *sym_ext;
	450
	451	if (!sym->hist_sum)
	452	return;
	453
	454	sym->priv = calloc(len, sizeof(struct sym_ext));
	455	if (!sym->priv)
	456	return;
	457
	458	sym_ext = sym->priv;
	459
	460	for (i = 0; i < len; i++) {
	461	char *path = NULL;
	462	size_t line_len;
9cffa8d5	463	u64 offset;
301406b9 FW	464	FILE *fp;
	465
	466	sym_ext[i].percent = 100.0 * sym->hist[i] / sym->hist_sum;
	467	if (sym_ext[i].percent <= 0.5)
	468	continue;
	469
	470	offset = start + i;
c17c2db1	471	sprintf(cmd, "addr2line -e %s %016llx", filename, offset);
301406b9 FW	472	fp = popen(cmd, "r");
	473	if (!fp)
	474	continue;
	475
	476	if (getline(&path, &line_len, fp) < 0 \|\| !line_len)
	477	goto next;
	478
c17c2db1	479	sym_ext[i].path = malloc(sizeof(char) * line_len + 1);
301406b9 FW	480	if (!sym_ext[i].path)
	481	goto next;
	482
	483	strcpy(sym_ext[i].path, path);
971738f3	484	insert_source_line(&sym_ext[i]);
301406b9 FW	485
	486	next:
	487	pclose(fp);
	488	}
	489	}
	490
83a0944f	491	static void print_summary(const char *filename)
971738f3 FW	492	{
	493	struct sym_ext *sym_ext;
	494	struct rb_node *node;
	495
	496	printf("\nSorted summary for file %s\n", filename);
	497	printf("----------------------------------------------\n\n");
	498
	499	if (RB_EMPTY_ROOT(&root_sym_ext)) {
	500	printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
	501	return;
	502	}
	503
	504	node = rb_first(&root_sym_ext);
	505	while (node) {
	506	double percent;
83a0944f	507	const char *color;
971738f3 FW	508	char *path;
	509
	510	sym_ext = rb_entry(node, struct sym_ext, node);
	511	percent = sym_ext->percent;
1e11fd82	512	color = get_percent_color(percent);
971738f3 FW	513	path = sym_ext->path;
	514
	515	color_fprintf(stdout, color, " %7.2f %s", percent, path);
	516	node = rb_next(node);
	517	}
	518	}
	519
0b73da3f IM	520	static void annotate_sym(struct dso dso, struct symbol sym)
0b73da3f IM	521	{
83a0944f	522	const char filename = dso->name, d_filename;
9cffa8d5	523	u64 start, end, len;
0b73da3f IM	524	char command[PATH_MAX*2];
	525	FILE *file;
	526
	527	if (!filename)
	528	return;
42976487 MG	529	if (sym->module)
	530	filename = sym->module->path;
	531	else if (dso == kernel_dso)
83a0944f	532	filename = vmlinux_name;
0b73da3f	533
0b73da3f IM	534	start = sym->obj_start;
	535	if (!start)
	536	start = sym->start;
42976487 MG	537	if (full_paths)
	538	d_filename = filename;
	539	else
	540	d_filename = basename(filename);
0b73da3f IM	541
	542	end = start + sym->end - sym->start + 1;
	543	len = sym->end - sym->start;
	544
971738f3	545	if (print_line) {
c17c2db1	546	get_source_line(sym, start, len, filename);
971738f3 FW	547	print_summary(filename);
	548	}
	549
	550	printf("\n\n------------------------------------------------\n");
42976487	551	printf(" Percent \| Source code & Disassembly of %s\n", d_filename);
971738f3 FW	552	printf("------------------------------------------------\n");
	553
	554	if (verbose >= 2)
	555	printf("annotating [%p] %30s : [%p] %30s\n", dso, dso->name, sym, sym->name);
301406b9	556
42976487 MG	557	sprintf(command, "objdump --start-address=0x%016Lx --stop-address=0x%016Lx -dS %s\|grep -v %s",
42976487 MG	558	(u64)start, (u64)end, filename, filename);
0b73da3f IM	559
	560	if (verbose >= 3)
	561	printf("doing: %s\n", command);
	562
	563	file = popen(command, "r");
	564	if (!file)
	565	return;
	566
	567	while (!feof(file)) {
	568	if (parse_line(file, sym, start, len) < 0)
	569	break;
	570	}
	571
	572	pclose(file);
971738f3 FW	573	if (print_line)
971738f3 FW	574	free_source_line(sym, len);
0b73da3f IM	575	}
	576
	577	static void find_annotations(void)
	578	{
	579	struct rb_node *nd;
	580	struct dso *dso;
	581	int count = 0;
	582
	583	list_for_each_entry(dso, &dsos, node) {
	584
	585	for (nd = rb_first(&dso->syms); nd; nd = rb_next(nd)) {
	586	struct symbol *sym = rb_entry(nd, struct symbol, rb_node);
	587
	588	if (sym->hist) {
	589	annotate_sym(dso, sym);
	590	count++;
	591	}
	592	}
	593	}
	594
	595	if (!count)
	596	printf(" Error: symbol '%s' not present amongst the samples.\n", sym_hist_filter);
	597	}
	598
8035e428 IM	599	static int __cmd_annotate(void)
	600	{
	601	int ret, rc = EXIT_FAILURE;
	602	unsigned long offset = 0;
	603	unsigned long head = 0;
83a0944f	604	struct stat input_stat;
8035e428 IM	605	event_t *event;
	606	uint32_t size;
	607	char *buf;
	608
5b447a6a	609	register_idle_thread(&threads, &last_match);
8035e428 IM	610
	611	input = open(input_name, O_RDONLY);
	612	if (input < 0) {
	613	perror("failed to open file");
	614	exit(-1);
	615	}
	616
83a0944f	617	ret = fstat(input, &input_stat);
8035e428 IM	618	if (ret < 0) {
	619	perror("failed to stat file");
	620	exit(-1);
	621	}
	622
119e7a22 PH	623	if (!force && input_stat.st_uid && (input_stat.st_uid != geteuid())) {
119e7a22 PH	624	fprintf(stderr, "file: %s not owned by current user or root\n", input_name);
fa6963b2 PZ	625	exit(-1);
	626	}
	627
83a0944f	628	if (!input_stat.st_size) {
8035e428 IM	629	fprintf(stderr, "zero-sized file, nothing to do!\n");
	630	exit(0);
	631	}
	632
	633	if (load_kernel() < 0) {
	634	perror("failed to load kernel symbols");
	635	return EXIT_FAILURE;
	636	}
	637
8035e428 IM	638	remap:
	639	buf = (char )mmap(NULL, page_size mmap_window, PROT_READ,
	640	MAP_SHARED, input, offset);
	641	if (buf == MAP_FAILED) {
	642	perror("failed to mmap file");
	643	exit(-1);
	644	}
	645
	646	more:
	647	event = (event_t *)(buf + head);
	648
	649	size = event->header.size;
	650	if (!size)
	651	size = 8;
	652
	653	if (head + event->header.size >= page_size * mmap_window) {
	654	unsigned long shift = page_size * (head / page_size);
83a0944f	655	int munmap_ret;
8035e428	656
83a0944f IM	657	munmap_ret = munmap(buf, page_size * mmap_window);
83a0944f IM	658	assert(munmap_ret == 0);
8035e428 IM	659
	660	offset += shift;
	661	head -= shift;
	662	goto remap;
	663	}
	664
	665	size = event->header.size;
	666
2cec19d9	667	dump_printf("%p [%p]: event: %d\n",
8035e428 IM	668	(void *)(offset + head),
	669	(void *)(long)event->header.size,
	670	event->header.type);
	671
	672	if (!size \|\| process_event(event, offset, head) < 0) {
	673
2cec19d9	674	dump_printf("%p [%p]: skipping unknown header type: %d\n",
8035e428 IM	675	(void *)(offset + head),
	676	(void *)(long)(event->header.size),
	677	event->header.type);
	678
	679	total_unknown++;
	680
	681	/*
	682	* assume we lost track of the stream, check alignment, and
	683	* increment a single u64 in the hope to catch on again 'soon'.
	684	*/
	685
	686	if (unlikely(head & 7))
	687	head &= ~7ULL;
	688
	689	size = 8;
	690	}
	691
	692	head += size;
	693
83a0944f	694	if (offset + head < (unsigned long)input_stat.st_size)
8035e428 IM	695	goto more;
	696
	697	rc = EXIT_SUCCESS;
	698	close(input);
	699
2cec19d9 FW	700	dump_printf(" IP events: %10ld\n", total);
	701	dump_printf(" mmap events: %10ld\n", total_mmap);
	702	dump_printf(" comm events: %10ld\n", total_comm);
	703	dump_printf(" fork events: %10ld\n", total_fork);
	704	dump_printf(" unknown events: %10ld\n", total_unknown);
8035e428 IM	705
	706	if (dump_trace)
	707	return 0;
	708
	709	if (verbose >= 3)
6baa0a5a	710	threads__fprintf(stdout, &threads);
8035e428 IM	711
	712	if (verbose >= 2)
	713	dsos__fprintf(stdout);
	714
	715	collapse__resort();
3d1d07ec	716	output__resort(total);
0b73da3f IM	717
0b73da3f IM	718	find_annotations();
8035e428 IM	719
	720	return rc;
	721	}
	722
	723	static const char * const annotate_usage[] = {
	724	"perf annotate [<options>] <command>",
	725	NULL
	726	};
	727
	728	static const struct option options[] = {
	729	OPT_STRING('i', "input", &input_name, "file",
	730	"input file name"),
23b87116	731	OPT_STRING('s', "symbol", &sym_hist_filter, "symbol",
0b73da3f	732	"symbol to annotate"),
fa6963b2	733	OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
8035e428 IM	734	OPT_BOOLEAN('v', "verbose", &verbose,
	735	"be more verbose (show symbol address, etc)"),
	736	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
	737	"dump raw trace in ASCII"),
83a0944f	738	OPT_STRING('k', "vmlinux", &vmlinux_name, "file", "vmlinux pathname"),
42976487 MG	739	OPT_BOOLEAN('m', "modules", &modules,
42976487 MG	740	"load module symbols - WARNING: use only with -k and LIVE kernel"),
301406b9 FW	741	OPT_BOOLEAN('l', "print-line", &print_line,
301406b9 FW	742	"print matching source lines (may be slow)"),
42976487 MG	743	OPT_BOOLEAN('P', "full-paths", &full_paths,
42976487 MG	744	"Don't shorten the displayed pathnames"),
8035e428 IM	745	OPT_END()
	746	};
	747
	748	static void setup_sorting(void)
	749	{
	750	char tmp, tok, *str = strdup(sort_order);
	751
	752	for (tok = strtok_r(str, ", ", &tmp);
	753	tok; tok = strtok_r(NULL, ", ", &tmp)) {
	754	if (sort_dimension__add(tok) < 0) {
	755	error("Unknown --sort key: `%s'", tok);
	756	usage_with_options(annotate_usage, options);
	757	}
	758	}
	759
	760	free(str);
	761	}
	762
f37a291c	763	int cmd_annotate(int argc, const char *argv, const char prefix __used)
8035e428 IM	764	{
	765	symbol__init();
	766
	767	page_size = getpagesize();
	768
	769	argc = parse_options(argc, argv, options, annotate_usage, 0);
	770
	771	setup_sorting();
	772
0b73da3f IM	773	if (argc) {
	774	/*
	775	* Special case: if there's an argument left then assume tha
	776	* it's a symbol filter:
	777	*/
	778	if (argc > 1)
	779	usage_with_options(annotate_usage, options);
	780
	781	sym_hist_filter = argv[0];
	782	}
	783
	784	if (!sym_hist_filter)
8035e428 IM	785	usage_with_options(annotate_usage, options);
	786
	787	setup_pager();
	788
dd68ada2 JK	789	if (field_sep && *field_sep == '.') {
	790	fputs("'.' is the only non valid --field-separator argument\n",
	791	stderr);
	792	exit(129);
	793	}
	794
8035e428 IM	795	return __cmd_annotate();
8035e428 IM	796	}