[deliverable/linux.git] / tools / perf / util / sort.c

#include "sort.h"
#include "hist.h"

regex_t		parent_regex;
const char	default_parent_pattern[] = "^sys_|^do_page_fault";
const char	*parent_pattern = default_parent_pattern;
const char	default_sort_order[] = "comm,dso,symbol";
const char	*sort_order = default_sort_order;
int		sort__need_collapse = 0;
int		sort__has_parent = 0;
int		sort__branch_mode = -1; /* -1 = means not set */

enum sort_type	sort__first_dimension;

LIST_HEAD(hist_entry__sort_list);

static int repsep_snprintf(char *bf, size_t size, const char *fmt, ...)
{
	int n;
	va_list ap;

	va_start(ap, fmt);
	n = vsnprintf(bf, size, fmt, ap);
	if (symbol_conf.field_sep && n > 0) {
		char *sep = bf;

		while (1) {
			sep = strchr(sep, *symbol_conf.field_sep);
			if (sep == NULL)
				break;
			*sep = '.';
		}
	}
	va_end(ap);

	if (n >= (int)size)
		return size - 1;
	return n;
}

static int64_t cmp_null(void *l, void *r)
{
	if (!l && !r)
		return 0;
	else if (!l)
		return -1;
	else
		return 1;
}

/* --sort pid */

static int64_t
sort__thread_cmp(struct hist_entry *left, struct hist_entry *right)
{
	return right->thread->pid - left->thread->pid;
}

static int hist_entry__thread_snprintf(struct hist_entry *self, char *bf,
				       size_t size, unsigned int width)
{
	return repsep_snprintf(bf, size, "%*s:%5d", width,
			      self->thread->comm ?: "", self->thread->pid);
}

struct sort_entry sort_thread = {
	.se_header	= "Command:  Pid",
	.se_cmp		= sort__thread_cmp,
	.se_snprintf	= hist_entry__thread_snprintf,
	.se_width_idx	= HISTC_THREAD,
};

/* --sort comm */

static int64_t
sort__comm_cmp(struct hist_entry *left, struct hist_entry *right)
{
	return right->thread->pid - left->thread->pid;
}

static int64_t
sort__comm_collapse(struct hist_entry *left, struct hist_entry *right)
{
	char *comm_l = left->thread->comm;
	char *comm_r = right->thread->comm;

	if (!comm_l || !comm_r)
		return cmp_null(comm_l, comm_r);

	return strcmp(comm_l, comm_r);
}

static int hist_entry__comm_snprintf(struct hist_entry *self, char *bf,
				     size_t size, unsigned int width)
{
	return repsep_snprintf(bf, size, "%*s", width, self->thread->comm);
}

static int64_t _sort__dso_cmp(struct map *map_l, struct map *map_r)
{
	struct dso *dso_l = map_l ? map_l->dso : NULL;
	struct dso *dso_r = map_r ? map_r->dso : NULL;
	const char *dso_name_l, *dso_name_r;

	if (!dso_l || !dso_r)
		return cmp_null(dso_l, dso_r);

	if (verbose) {
		dso_name_l = dso_l->long_name;
		dso_name_r = dso_r->long_name;
	} else {
		dso_name_l = dso_l->short_name;
		dso_name_r = dso_r->short_name;
	}

	return strcmp(dso_name_l, dso_name_r);
}

struct sort_entry sort_comm = {
	.se_header	= "Command",
	.se_cmp		= sort__comm_cmp,
	.se_collapse	= sort__comm_collapse,
	.se_snprintf	= hist_entry__comm_snprintf,
	.se_width_idx	= HISTC_COMM,
};

/* --sort dso */

static int64_t
sort__dso_cmp(struct hist_entry *left, struct hist_entry *right)
{
	return _sort__dso_cmp(left->ms.map, right->ms.map);
}


static int64_t _sort__sym_cmp(struct symbol *sym_l, struct symbol *sym_r,
			      u64 ip_l, u64 ip_r)
{
	if (!sym_l || !sym_r)
		return cmp_null(sym_l, sym_r);

	if (sym_l == sym_r)
		return 0;

	if (sym_l)
		ip_l = sym_l->start;
	if (sym_r)
		ip_r = sym_r->start;

	return (int64_t)(ip_r - ip_l);
}

static int _hist_entry__dso_snprintf(struct map *map, char *bf,
				     size_t size, unsigned int width)
{
	if (map && map->dso) {
		const char *dso_name = !verbose ? map->dso->short_name :
			map->dso->long_name;
		return repsep_snprintf(bf, size, "%-*s", width, dso_name);
	}

	return repsep_snprintf(bf, size, "%-*s", width, "[unknown]");
}

static int hist_entry__dso_snprintf(struct hist_entry *self, char *bf,
				    size_t size, unsigned int width)
{
	return _hist_entry__dso_snprintf(self->ms.map, bf, size, width);
}

static int _hist_entry__sym_snprintf(struct map *map, struct symbol *sym,
				     u64 ip, char level, char *bf, size_t size,
				     unsigned int width __maybe_unused)
{
	size_t ret = 0;

	if (verbose) {
		char o = map ? dso__symtab_origin(map->dso) : '!';
		ret += repsep_snprintf(bf, size, "%-#*llx %c ",
				       BITS_PER_LONG / 4, ip, o);
	}

	ret += repsep_snprintf(bf + ret, size - ret, "[%c] ", level);
	if (sym)
		ret += repsep_snprintf(bf + ret, size - ret, "%-*s",
				       width - ret,
				       sym->name);
	else {
		size_t len = BITS_PER_LONG / 4;
		ret += repsep_snprintf(bf + ret, size - ret, "%-#.*llx",
				       len, ip);
		ret += repsep_snprintf(bf + ret, size - ret, "%-*s",
				       width - ret, "");
	}

	return ret;
}


struct sort_entry sort_dso = {
	.se_header	= "Shared Object",
	.se_cmp		= sort__dso_cmp,
	.se_snprintf	= hist_entry__dso_snprintf,
	.se_width_idx	= HISTC_DSO,
};

static int hist_entry__sym_snprintf(struct hist_entry *self, char *bf,
				    size_t size,
				    unsigned int width __maybe_unused)
{
	return _hist_entry__sym_snprintf(self->ms.map, self->ms.sym, self->ip,
					 self->level, bf, size, width);
}

/* --sort symbol */
static int64_t
sort__sym_cmp(struct hist_entry *left, struct hist_entry *right)
{
	u64 ip_l, ip_r;

	if (!left->ms.sym && !right->ms.sym)
		return right->level - left->level;

	if (!left->ms.sym || !right->ms.sym)
		return cmp_null(left->ms.sym, right->ms.sym);

	if (left->ms.sym == right->ms.sym)
		return 0;

	ip_l = left->ms.sym->start;
	ip_r = right->ms.sym->start;

	return _sort__sym_cmp(left->ms.sym, right->ms.sym, ip_l, ip_r);
}

struct sort_entry sort_sym = {
	.se_header	= "Symbol",
	.se_cmp		= sort__sym_cmp,
	.se_snprintf	= hist_entry__sym_snprintf,
	.se_width_idx	= HISTC_SYMBOL,
};

/* --sort srcline */

static int64_t
sort__srcline_cmp(struct hist_entry *left, struct hist_entry *right)
{
	return (int64_t)(right->ip - left->ip);
}

static int hist_entry__srcline_snprintf(struct hist_entry *self, char *bf,
					size_t size,
					unsigned int width __maybe_unused)
{
	FILE *fp;
	char cmd[PATH_MAX + 2], *path = self->srcline, *nl;
	size_t line_len;

	if (path != NULL)
		goto out_path;

	snprintf(cmd, sizeof(cmd), "addr2line -e %s %016" PRIx64,
		 self->ms.map->dso->long_name, self->ip);
	fp = popen(cmd, "r");
	if (!fp)
		goto out_ip;

	if (getline(&path, &line_len, fp) < 0 || !line_len)
		goto out_ip;
	fclose(fp);
	self->srcline = strdup(path);
	if (self->srcline == NULL)
		goto out_ip;

	nl = strchr(self->srcline, '\n');
	if (nl != NULL)
		*nl = '\0';
	path = self->srcline;
out_path:
	return repsep_snprintf(bf, size, "%s", path);
out_ip:
	return repsep_snprintf(bf, size, "%-#*llx", BITS_PER_LONG / 4, self->ip);
}

struct sort_entry sort_srcline = {
	.se_header	= "Source:Line",
	.se_cmp		= sort__srcline_cmp,
	.se_snprintf	= hist_entry__srcline_snprintf,
	.se_width_idx	= HISTC_SRCLINE,
};

/* --sort parent */

static int64_t
sort__parent_cmp(struct hist_entry *left, struct hist_entry *right)
{
	struct symbol *sym_l = left->parent;
	struct symbol *sym_r = right->parent;

	if (!sym_l || !sym_r)
		return cmp_null(sym_l, sym_r);

	return strcmp(sym_l->name, sym_r->name);
}

static int hist_entry__parent_snprintf(struct hist_entry *self, char *bf,
				       size_t size, unsigned int width)
{
	return repsep_snprintf(bf, size, "%-*s", width,
			      self->parent ? self->parent->name : "[other]");
}

struct sort_entry sort_parent = {
	.se_header	= "Parent symbol",
	.se_cmp		= sort__parent_cmp,
	.se_snprintf	= hist_entry__parent_snprintf,
	.se_width_idx	= HISTC_PARENT,
};

/* --sort cpu */

static int64_t
sort__cpu_cmp(struct hist_entry *left, struct hist_entry *right)
{
	return right->cpu - left->cpu;
}

static int hist_entry__cpu_snprintf(struct hist_entry *self, char *bf,
				       size_t size, unsigned int width)
{
	return repsep_snprintf(bf, size, "%-*d", width, self->cpu);
}

struct sort_entry sort_cpu = {
	.se_header      = "CPU",
	.se_cmp	        = sort__cpu_cmp,
	.se_snprintf    = hist_entry__cpu_snprintf,
	.se_width_idx	= HISTC_CPU,
};

static int64_t
sort__dso_from_cmp(struct hist_entry *left, struct hist_entry *right)
{
	return _sort__dso_cmp(left->branch_info->from.map,
			      right->branch_info->from.map);
}

static int hist_entry__dso_from_snprintf(struct hist_entry *self, char *bf,
				    size_t size, unsigned int width)
{
	return _hist_entry__dso_snprintf(self->branch_info->from.map,
					 bf, size, width);
}

struct sort_entry sort_dso_from = {
	.se_header	= "Source Shared Object",
	.se_cmp		= sort__dso_from_cmp,
	.se_snprintf	= hist_entry__dso_from_snprintf,
	.se_width_idx	= HISTC_DSO_FROM,
};

static int64_t
sort__dso_to_cmp(struct hist_entry *left, struct hist_entry *right)
{
	return _sort__dso_cmp(left->branch_info->to.map,
			      right->branch_info->to.map);
}

static int hist_entry__dso_to_snprintf(struct hist_entry *self, char *bf,
				       size_t size, unsigned int width)
{
	return _hist_entry__dso_snprintf(self->branch_info->to.map,
					 bf, size, width);
}

static int64_t
sort__sym_from_cmp(struct hist_entry *left, struct hist_entry *right)
{
	struct addr_map_symbol *from_l = &left->branch_info->from;
	struct addr_map_symbol *from_r = &right->branch_info->from;

	if (!from_l->sym && !from_r->sym)
		return right->level - left->level;

	return _sort__sym_cmp(from_l->sym, from_r->sym, from_l->addr,
			     from_r->addr);
}

static int64_t
sort__sym_to_cmp(struct hist_entry *left, struct hist_entry *right)
{
	struct addr_map_symbol *to_l = &left->branch_info->to;
	struct addr_map_symbol *to_r = &right->branch_info->to;

	if (!to_l->sym && !to_r->sym)
		return right->level - left->level;

	return _sort__sym_cmp(to_l->sym, to_r->sym, to_l->addr, to_r->addr);
}

static int hist_entry__sym_from_snprintf(struct hist_entry *self, char *bf,
					size_t size,
					unsigned int width __maybe_unused)
{
	struct addr_map_symbol *from = &self->branch_info->from;
	return _hist_entry__sym_snprintf(from->map, from->sym, from->addr,
					 self->level, bf, size, width);

}

static int hist_entry__sym_to_snprintf(struct hist_entry *self, char *bf,
				       size_t size,
				       unsigned int width __maybe_unused)
{
	struct addr_map_symbol *to = &self->branch_info->to;
	return _hist_entry__sym_snprintf(to->map, to->sym, to->addr,
					 self->level, bf, size, width);

}

struct sort_entry sort_dso_to = {
	.se_header	= "Target Shared Object",
	.se_cmp		= sort__dso_to_cmp,
	.se_snprintf	= hist_entry__dso_to_snprintf,
	.se_width_idx	= HISTC_DSO_TO,
};

struct sort_entry sort_sym_from = {
	.se_header	= "Source Symbol",
	.se_cmp		= sort__sym_from_cmp,
	.se_snprintf	= hist_entry__sym_from_snprintf,
	.se_width_idx	= HISTC_SYMBOL_FROM,
};

struct sort_entry sort_sym_to = {
	.se_header	= "Target Symbol",
	.se_cmp		= sort__sym_to_cmp,
	.se_snprintf	= hist_entry__sym_to_snprintf,
	.se_width_idx	= HISTC_SYMBOL_TO,
};

static int64_t
sort__mispredict_cmp(struct hist_entry *left, struct hist_entry *right)
{
	const unsigned char mp = left->branch_info->flags.mispred !=
					right->branch_info->flags.mispred;
	const unsigned char p = left->branch_info->flags.predicted !=
					right->branch_info->flags.predicted;

	return mp || p;
}

static int hist_entry__mispredict_snprintf(struct hist_entry *self, char *bf,
				    size_t size, unsigned int width){
	static const char *out = "N/A";

	if (self->branch_info->flags.predicted)
		out = "N";
	else if (self->branch_info->flags.mispred)
		out = "Y";

	return repsep_snprintf(bf, size, "%-*s", width, out);
}

struct sort_entry sort_mispredict = {
	.se_header	= "Branch Mispredicted",
	.se_cmp		= sort__mispredict_cmp,
	.se_snprintf	= hist_entry__mispredict_snprintf,
	.se_width_idx	= HISTC_MISPREDICT,
};

struct sort_dimension {
	const char		*name;
	struct sort_entry	*entry;
	int			taken;
};

#define DIM(d, n, func) [d] = { .name = n, .entry = &(func) }

static struct sort_dimension sort_dimensions[] = {
	DIM(SORT_PID, "pid", sort_thread),
	DIM(SORT_COMM, "comm", sort_comm),
	DIM(SORT_DSO, "dso", sort_dso),
	DIM(SORT_DSO_FROM, "dso_from", sort_dso_from),
	DIM(SORT_DSO_TO, "dso_to", sort_dso_to),
	DIM(SORT_SYM, "symbol", sort_sym),
	DIM(SORT_SYM_TO, "symbol_from", sort_sym_from),
	DIM(SORT_SYM_FROM, "symbol_to", sort_sym_to),
	DIM(SORT_PARENT, "parent", sort_parent),
	DIM(SORT_CPU, "cpu", sort_cpu),
	DIM(SORT_MISPREDICT, "mispredict", sort_mispredict),
	DIM(SORT_SRCLINE, "srcline", sort_srcline),
};

int sort_dimension__add(const char *tok)
{
	unsigned int i;

	for (i = 0; i < ARRAY_SIZE(sort_dimensions); i++) {
		struct sort_dimension *sd = &sort_dimensions[i];

		if (strncasecmp(tok, sd->name, strlen(tok)))
			continue;
		if (sd->entry == &sort_parent) {
			int ret = regcomp(&parent_regex, parent_pattern, REG_EXTENDED);
			if (ret) {
				char err[BUFSIZ];

				regerror(ret, &parent_regex, err, sizeof(err));
				pr_err("Invalid regex: %s\n%s", parent_pattern, err);
				return -EINVAL;
			}
			sort__has_parent = 1;
		}

		if (sd->taken)
			return 0;

		if (sd->entry->se_collapse)
			sort__need_collapse = 1;

		if (list_empty(&hist_entry__sort_list)) {
			if (!strcmp(sd->name, "pid"))
				sort__first_dimension = SORT_PID;
			else if (!strcmp(sd->name, "comm"))
				sort__first_dimension = SORT_COMM;
			else if (!strcmp(sd->name, "dso"))
				sort__first_dimension = SORT_DSO;
			else if (!strcmp(sd->name, "symbol"))
				sort__first_dimension = SORT_SYM;
			else if (!strcmp(sd->name, "parent"))
				sort__first_dimension = SORT_PARENT;
			else if (!strcmp(sd->name, "cpu"))
				sort__first_dimension = SORT_CPU;
			else if (!strcmp(sd->name, "symbol_from"))
				sort__first_dimension = SORT_SYM_FROM;
			else if (!strcmp(sd->name, "symbol_to"))
				sort__first_dimension = SORT_SYM_TO;
			else if (!strcmp(sd->name, "dso_from"))
				sort__first_dimension = SORT_DSO_FROM;
			else if (!strcmp(sd->name, "dso_to"))
				sort__first_dimension = SORT_DSO_TO;
			else if (!strcmp(sd->name, "mispredict"))
				sort__first_dimension = SORT_MISPREDICT;
		}

		list_add_tail(&sd->entry->list, &hist_entry__sort_list);
		sd->taken = 1;

		return 0;
	}
	return -ESRCH;
}

void setup_sorting(const char * const usagestr[], const struct option *opts)
{
	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(usagestr, opts);
		}
	}

	free(str);
}

void sort_entry__setup_elide(struct sort_entry *self, struct strlist *list,
			     const char *list_name, FILE *fp)
{
	if (list && strlist__nr_entries(list) == 1) {
		if (fp != NULL)
			fprintf(fp, "# %s: %s\n", list_name,
				strlist__entry(list, 0)->s);
		self->elide = true;
	}
}
Commit	Line	Data
dd68ada2	1	#include "sort.h"
8a6c5b26	2	#include "hist.h"
dd68ada2 JK	3
dd68ada2 JK	4	regex_t parent_regex;
edb7c60e ACM	5	const char default_parent_pattern[] = "^sys_\|^do_page_fault";
	6	const char *parent_pattern = default_parent_pattern;
	7	const char default_sort_order[] = "comm,dso,symbol";
	8	const char *sort_order = default_sort_order;
af0a6fa4 FW	9	int sort__need_collapse = 0;
af0a6fa4 FW	10	int sort__has_parent = 0;
993ac88d	11	int sort__branch_mode = -1; /* -1 = means not set */
a4fb581b FW	12
a4fb581b FW	13	enum sort_type sort__first_dimension;
dd68ada2	14
dd68ada2 JK	15	LIST_HEAD(hist_entry__sort_list);
dd68ada2 JK	16
a4e3b956	17	static int repsep_snprintf(char bf, size_t size, const char fmt, ...)
dd68ada2 JK	18	{
	19	int n;
	20	va_list ap;
	21
	22	va_start(ap, fmt);
a4e3b956	23	n = vsnprintf(bf, size, fmt, ap);
0ca0c130	24	if (symbol_conf.field_sep && n > 0) {
a4e3b956 ACM	25	char *sep = bf;
	26
	27	while (1) {
0ca0c130	28	sep = strchr(sep, *symbol_conf.field_sep);
a4e3b956 ACM	29	if (sep == NULL)
	30	break;
	31	*sep = '.';
dd68ada2	32	}
dd68ada2 JK	33	}
dd68ada2 JK	34	va_end(ap);
b832796c AB	35
	36	if (n >= (int)size)
	37	return size - 1;
dd68ada2 JK	38	return n;
	39	}
	40
872a878f FW	41	static int64_t cmp_null(void l, void r)
	42	{
	43	if (!l && !r)
	44	return 0;
	45	else if (!l)
	46	return -1;
	47	else
	48	return 1;
	49	}
	50
	51	/* --sort pid */
	52
	53	static int64_t
	54	sort__thread_cmp(struct hist_entry left, struct hist_entry right)
	55	{
	56	return right->thread->pid - left->thread->pid;
	57	}
	58
a4e3b956 ACM	59	static int hist_entry__thread_snprintf(struct hist_entry self, char bf,
a4e3b956 ACM	60	size_t size, unsigned int width)
dd68ada2	61	{
a4e3b956	62	return repsep_snprintf(bf, size, "%*s:%5d", width,
dd68ada2 JK	63	self->thread->comm ?: "", self->thread->pid);
	64	}
	65
872a878f FW	66	struct sort_entry sort_thread = {
	67	.se_header = "Command: Pid",
	68	.se_cmp = sort__thread_cmp,
	69	.se_snprintf = hist_entry__thread_snprintf,
	70	.se_width_idx = HISTC_THREAD,
	71	};
	72
	73	/* --sort comm */
	74
	75	static int64_t
	76	sort__comm_cmp(struct hist_entry left, struct hist_entry right)
	77	{
	78	return right->thread->pid - left->thread->pid;
	79	}
	80
	81	static int64_t
	82	sort__comm_collapse(struct hist_entry left, struct hist_entry right)
	83	{
	84	char *comm_l = left->thread->comm;
	85	char *comm_r = right->thread->comm;
	86
	87	if (!comm_l \|\| !comm_r)
	88	return cmp_null(comm_l, comm_r);
	89
	90	return strcmp(comm_l, comm_r);
	91	}
	92
a4e3b956 ACM	93	static int hist_entry__comm_snprintf(struct hist_entry self, char bf,
a4e3b956 ACM	94	size_t size, unsigned int width)
dd68ada2	95	{
a4e3b956	96	return repsep_snprintf(bf, size, "%*s", width, self->thread->comm);
dd68ada2 JK	97	}
dd68ada2 JK	98
b5387528 RAV	99	static int64_t _sort__dso_cmp(struct map map_l, struct map map_r)
	100	{
	101	struct dso *dso_l = map_l ? map_l->dso : NULL;
	102	struct dso *dso_r = map_r ? map_r->dso : NULL;
	103	const char dso_name_l, dso_name_r;
	104
	105	if (!dso_l \|\| !dso_r)
	106	return cmp_null(dso_l, dso_r);
	107
	108	if (verbose) {
	109	dso_name_l = dso_l->long_name;
	110	dso_name_r = dso_r->long_name;
	111	} else {
	112	dso_name_l = dso_l->short_name;
	113	dso_name_r = dso_r->short_name;
	114	}
	115
	116	return strcmp(dso_name_l, dso_name_r);
	117	}
	118
872a878f FW	119	struct sort_entry sort_comm = {
	120	.se_header = "Command",
	121	.se_cmp = sort__comm_cmp,
	122	.se_collapse = sort__comm_collapse,
	123	.se_snprintf = hist_entry__comm_snprintf,
	124	.se_width_idx = HISTC_COMM,
	125	};
	126
dd68ada2 JK	127	/* --sort dso */
dd68ada2 JK	128
872a878f	129	static int64_t
dd68ada2 JK	130	sort__dso_cmp(struct hist_entry left, struct hist_entry right)
dd68ada2 JK	131	{
b5387528 RAV	132	return _sort__dso_cmp(left->ms.map, right->ms.map);
b5387528 RAV	133	}
dd68ada2	134
dd68ada2	135
b5387528 RAV	136	static int64_t _sort__sym_cmp(struct symbol sym_l, struct symbol sym_r,
	137	u64 ip_l, u64 ip_r)
	138	{
	139	if (!sym_l \|\| !sym_r)
	140	return cmp_null(sym_l, sym_r);
	141
	142	if (sym_l == sym_r)
	143	return 0;
	144
	145	if (sym_l)
	146	ip_l = sym_l->start;
	147	if (sym_r)
	148	ip_r = sym_r->start;
	149
	150	return (int64_t)(ip_r - ip_l);
	151	}
	152
	153	static int _hist_entry__dso_snprintf(struct map map, char bf,
	154	size_t size, unsigned int width)
	155	{
	156	if (map && map->dso) {
	157	const char *dso_name = !verbose ? map->dso->short_name :
	158	map->dso->long_name;
	159	return repsep_snprintf(bf, size, "%-*s", width, dso_name);
439d473b ACM	160	}
439d473b ACM	161
b5387528	162	return repsep_snprintf(bf, size, "%-*s", width, "[unknown]");
dd68ada2 JK	163	}
dd68ada2 JK	164
a4e3b956 ACM	165	static int hist_entry__dso_snprintf(struct hist_entry self, char bf,
a4e3b956 ACM	166	size_t size, unsigned int width)
dd68ada2	167	{
b5387528 RAV	168	return _hist_entry__dso_snprintf(self->ms.map, bf, size, width);
	169	}
	170
	171	static int _hist_entry__sym_snprintf(struct map map, struct symbol sym,
	172	u64 ip, char level, char *bf, size_t size,
1d037ca1	173	unsigned int width __maybe_unused)
b5387528 RAV	174	{
	175	size_t ret = 0;
	176
	177	if (verbose) {
	178	char o = map ? dso__symtab_origin(map->dso) : '!';
	179	ret += repsep_snprintf(bf, size, "%-#*llx %c ",
	180	BITS_PER_LONG / 4, ip, o);
439d473b	181	}
dd68ada2	182
b5387528 RAV	183	ret += repsep_snprintf(bf + ret, size - ret, "[%c] ", level);
	184	if (sym)
	185	ret += repsep_snprintf(bf + ret, size - ret, "%-*s",
	186	width - ret,
	187	sym->name);
	188	else {
	189	size_t len = BITS_PER_LONG / 4;
	190	ret += repsep_snprintf(bf + ret, size - ret, "%-#.*llx",
	191	len, ip);
	192	ret += repsep_snprintf(bf + ret, size - ret, "%-*s",
	193	width - ret, "");
	194	}
	195
	196	return ret;
dd68ada2 JK	197	}
dd68ada2 JK	198
b5387528	199
872a878f FW	200	struct sort_entry sort_dso = {
	201	.se_header = "Shared Object",
	202	.se_cmp = sort__dso_cmp,
	203	.se_snprintf = hist_entry__dso_snprintf,
	204	.se_width_idx = HISTC_DSO,
	205	};
	206
b5387528	207	static int hist_entry__sym_snprintf(struct hist_entry self, char bf,
1d037ca1 IT	208	size_t size,
1d037ca1 IT	209	unsigned int width __maybe_unused)
b5387528 RAV	210	{
	211	return _hist_entry__sym_snprintf(self->ms.map, self->ms.sym, self->ip,
	212	self->level, bf, size, width);
	213	}
dd68ada2	214
b5387528	215	/* --sort symbol */
872a878f	216	static int64_t
dd68ada2 JK	217	sort__sym_cmp(struct hist_entry left, struct hist_entry right)
	218	{
	219	u64 ip_l, ip_r;
	220
6bb8f311 AB	221	if (!left->ms.sym && !right->ms.sym)
	222	return right->level - left->level;
	223
	224	if (!left->ms.sym \|\| !right->ms.sym)
	225	return cmp_null(left->ms.sym, right->ms.sym);
	226
59fd5306	227	if (left->ms.sym == right->ms.sym)
dd68ada2 JK	228	return 0;
dd68ada2 JK	229
6bb8f311 AB	230	ip_l = left->ms.sym->start;
6bb8f311 AB	231	ip_r = right->ms.sym->start;
dd68ada2	232
b5387528	233	return _sort__sym_cmp(left->ms.sym, right->ms.sym, ip_l, ip_r);
dd68ada2 JK	234	}
dd68ada2 JK	235
872a878f FW	236	struct sort_entry sort_sym = {
	237	.se_header = "Symbol",
	238	.se_cmp = sort__sym_cmp,
	239	.se_snprintf = hist_entry__sym_snprintf,
	240	.se_width_idx = HISTC_SYMBOL,
	241	};
dd68ada2	242
409a8be6 ACM	243	/* --sort srcline */
	244
	245	static int64_t
	246	sort__srcline_cmp(struct hist_entry left, struct hist_entry right)
	247	{
	248	return (int64_t)(right->ip - left->ip);
	249	}
	250
	251	static int hist_entry__srcline_snprintf(struct hist_entry self, char bf,
1d037ca1 IT	252	size_t size,
1d037ca1 IT	253	unsigned int width __maybe_unused)
409a8be6 ACM	254	{
	255	FILE *fp;
	256	char cmd[PATH_MAX + 2], path = self->srcline, nl;
	257	size_t line_len;
	258
	259	if (path != NULL)
	260	goto out_path;
	261
	262	snprintf(cmd, sizeof(cmd), "addr2line -e %s %016" PRIx64,
	263	self->ms.map->dso->long_name, self->ip);
	264	fp = popen(cmd, "r");
	265	if (!fp)
	266	goto out_ip;
	267
	268	if (getline(&path, &line_len, fp) < 0 \|\| !line_len)
	269	goto out_ip;
	270	fclose(fp);
	271	self->srcline = strdup(path);
	272	if (self->srcline == NULL)
	273	goto out_ip;
	274
	275	nl = strchr(self->srcline, '\n');
	276	if (nl != NULL)
	277	*nl = '\0';
	278	path = self->srcline;
	279	out_path:
	280	return repsep_snprintf(bf, size, "%s", path);
	281	out_ip:
	282	return repsep_snprintf(bf, size, "%-#*llx", BITS_PER_LONG / 4, self->ip);
	283	}
	284
	285	struct sort_entry sort_srcline = {
	286	.se_header = "Source:Line",
	287	.se_cmp = sort__srcline_cmp,
	288	.se_snprintf = hist_entry__srcline_snprintf,
	289	.se_width_idx = HISTC_SRCLINE,
	290	};
	291
dd68ada2 JK	292	/* --sort parent */
dd68ada2 JK	293
872a878f	294	static int64_t
dd68ada2 JK	295	sort__parent_cmp(struct hist_entry left, struct hist_entry right)
	296	{
	297	struct symbol *sym_l = left->parent;
	298	struct symbol *sym_r = right->parent;
	299
	300	if (!sym_l \|\| !sym_r)
	301	return cmp_null(sym_l, sym_r);
	302
	303	return strcmp(sym_l->name, sym_r->name);
	304	}
	305
a4e3b956 ACM	306	static int hist_entry__parent_snprintf(struct hist_entry self, char bf,
a4e3b956 ACM	307	size_t size, unsigned int width)
dd68ada2	308	{
a4e3b956	309	return repsep_snprintf(bf, size, "%-*s", width,
dd68ada2 JK	310	self->parent ? self->parent->name : "[other]");
	311	}
	312
872a878f FW	313	struct sort_entry sort_parent = {
	314	.se_header = "Parent symbol",
	315	.se_cmp = sort__parent_cmp,
	316	.se_snprintf = hist_entry__parent_snprintf,
	317	.se_width_idx = HISTC_PARENT,
	318	};
	319
f60f3593 AS	320	/* --sort cpu */
f60f3593 AS	321
872a878f	322	static int64_t
f60f3593 AS	323	sort__cpu_cmp(struct hist_entry left, struct hist_entry right)
	324	{
	325	return right->cpu - left->cpu;
	326	}
	327
	328	static int hist_entry__cpu_snprintf(struct hist_entry self, char bf,
	329	size_t size, unsigned int width)
	330	{
	331	return repsep_snprintf(bf, size, "%-*d", width, self->cpu);
	332	}
	333
872a878f FW	334	struct sort_entry sort_cpu = {
	335	.se_header = "CPU",
	336	.se_cmp = sort__cpu_cmp,
	337	.se_snprintf = hist_entry__cpu_snprintf,
	338	.se_width_idx = HISTC_CPU,
	339	};
	340
b5387528 RAV	341	static int64_t
	342	sort__dso_from_cmp(struct hist_entry left, struct hist_entry right)
	343	{
	344	return _sort__dso_cmp(left->branch_info->from.map,
	345	right->branch_info->from.map);
	346	}
	347
	348	static int hist_entry__dso_from_snprintf(struct hist_entry self, char bf,
	349	size_t size, unsigned int width)
	350	{
	351	return _hist_entry__dso_snprintf(self->branch_info->from.map,
	352	bf, size, width);
	353	}
	354
	355	struct sort_entry sort_dso_from = {
	356	.se_header = "Source Shared Object",
	357	.se_cmp = sort__dso_from_cmp,
	358	.se_snprintf = hist_entry__dso_from_snprintf,
	359	.se_width_idx = HISTC_DSO_FROM,
	360	};
	361
	362	static int64_t
	363	sort__dso_to_cmp(struct hist_entry left, struct hist_entry right)
	364	{
	365	return _sort__dso_cmp(left->branch_info->to.map,
	366	right->branch_info->to.map);
	367	}
	368
	369	static int hist_entry__dso_to_snprintf(struct hist_entry self, char bf,
	370	size_t size, unsigned int width)
	371	{
	372	return _hist_entry__dso_snprintf(self->branch_info->to.map,
	373	bf, size, width);
	374	}
	375
	376	static int64_t
	377	sort__sym_from_cmp(struct hist_entry left, struct hist_entry right)
	378	{
	379	struct addr_map_symbol *from_l = &left->branch_info->from;
	380	struct addr_map_symbol *from_r = &right->branch_info->from;
	381
	382	if (!from_l->sym && !from_r->sym)
	383	return right->level - left->level;
	384
	385	return _sort__sym_cmp(from_l->sym, from_r->sym, from_l->addr,
	386	from_r->addr);
	387	}
	388
	389	static int64_t
	390	sort__sym_to_cmp(struct hist_entry left, struct hist_entry right)
	391	{
	392	struct addr_map_symbol *to_l = &left->branch_info->to;
	393	struct addr_map_symbol *to_r = &right->branch_info->to;
	394
	395	if (!to_l->sym && !to_r->sym)
	396	return right->level - left->level;
	397
	398	return _sort__sym_cmp(to_l->sym, to_r->sym, to_l->addr, to_r->addr);
	399	}
	400
	401	static int hist_entry__sym_from_snprintf(struct hist_entry self, char bf,
1d037ca1 IT	402	size_t size,
1d037ca1 IT	403	unsigned int width __maybe_unused)
b5387528 RAV	404	{
	405	struct addr_map_symbol *from = &self->branch_info->from;
	406	return _hist_entry__sym_snprintf(from->map, from->sym, from->addr,
	407	self->level, bf, size, width);
	408
	409	}
	410
	411	static int hist_entry__sym_to_snprintf(struct hist_entry self, char bf,
1d037ca1 IT	412	size_t size,
1d037ca1 IT	413	unsigned int width __maybe_unused)
b5387528 RAV	414	{
	415	struct addr_map_symbol *to = &self->branch_info->to;
	416	return _hist_entry__sym_snprintf(to->map, to->sym, to->addr,
	417	self->level, bf, size, width);
	418
	419	}
	420
	421	struct sort_entry sort_dso_to = {
	422	.se_header = "Target Shared Object",
	423	.se_cmp = sort__dso_to_cmp,
	424	.se_snprintf = hist_entry__dso_to_snprintf,
	425	.se_width_idx = HISTC_DSO_TO,
	426	};
	427
	428	struct sort_entry sort_sym_from = {
	429	.se_header = "Source Symbol",
	430	.se_cmp = sort__sym_from_cmp,
	431	.se_snprintf = hist_entry__sym_from_snprintf,
	432	.se_width_idx = HISTC_SYMBOL_FROM,
	433	};
	434
	435	struct sort_entry sort_sym_to = {
	436	.se_header = "Target Symbol",
	437	.se_cmp = sort__sym_to_cmp,
	438	.se_snprintf = hist_entry__sym_to_snprintf,
	439	.se_width_idx = HISTC_SYMBOL_TO,
	440	};
	441
	442	static int64_t
	443	sort__mispredict_cmp(struct hist_entry left, struct hist_entry right)
	444	{
	445	const unsigned char mp = left->branch_info->flags.mispred !=
	446	right->branch_info->flags.mispred;
	447	const unsigned char p = left->branch_info->flags.predicted !=
	448	right->branch_info->flags.predicted;
	449
	450	return mp \|\| p;
	451	}
	452
	453	static int hist_entry__mispredict_snprintf(struct hist_entry self, char bf,
	454	size_t size, unsigned int width){
	455	static const char *out = "N/A";
	456
	457	if (self->branch_info->flags.predicted)
	458	out = "N";
	459	else if (self->branch_info->flags.mispred)
	460	out = "Y";
	461
	462	return repsep_snprintf(bf, size, "%-*s", width, out);
	463	}
	464
	465	struct sort_entry sort_mispredict = {
	466	.se_header = "Branch Mispredicted",
	467	.se_cmp = sort__mispredict_cmp,
	468	.se_snprintf = hist_entry__mispredict_snprintf,
	469	.se_width_idx = HISTC_MISPREDICT,
	470	};
	471
872a878f FW	472	struct sort_dimension {
	473	const char *name;
	474	struct sort_entry *entry;
	475	int taken;
	476	};
	477
b5387528 RAV	478	#define DIM(d, n, func) [d] = { .name = n, .entry = &(func) }
b5387528 RAV	479
872a878f	480	static struct sort_dimension sort_dimensions[] = {
b5387528 RAV	481	DIM(SORT_PID, "pid", sort_thread),
	482	DIM(SORT_COMM, "comm", sort_comm),
	483	DIM(SORT_DSO, "dso", sort_dso),
	484	DIM(SORT_DSO_FROM, "dso_from", sort_dso_from),
	485	DIM(SORT_DSO_TO, "dso_to", sort_dso_to),
	486	DIM(SORT_SYM, "symbol", sort_sym),
	487	DIM(SORT_SYM_TO, "symbol_from", sort_sym_from),
	488	DIM(SORT_SYM_FROM, "symbol_to", sort_sym_to),
	489	DIM(SORT_PARENT, "parent", sort_parent),
	490	DIM(SORT_CPU, "cpu", sort_cpu),
	491	DIM(SORT_MISPREDICT, "mispredict", sort_mispredict),
409a8be6	492	DIM(SORT_SRCLINE, "srcline", sort_srcline),
872a878f FW	493	};
872a878f FW	494
dd68ada2 JK	495	int sort_dimension__add(const char *tok)
	496	{
	497	unsigned int i;
	498
	499	for (i = 0; i < ARRAY_SIZE(sort_dimensions); i++) {
	500	struct sort_dimension *sd = &sort_dimensions[i];
	501
dd68ada2 JK	502	if (strncasecmp(tok, sd->name, strlen(tok)))
dd68ada2 JK	503	continue;
dd68ada2 JK	504	if (sd->entry == &sort_parent) {
	505	int ret = regcomp(&parent_regex, parent_pattern, REG_EXTENDED);
	506	if (ret) {
	507	char err[BUFSIZ];
	508
	509	regerror(ret, &parent_regex, err, sizeof(err));
2aefa4f7 ACM	510	pr_err("Invalid regex: %s\n%s", parent_pattern, err);
2aefa4f7 ACM	511	return -EINVAL;
dd68ada2 JK	512	}
	513	sort__has_parent = 1;
	514	}
	515
fd8ea212 FW	516	if (sd->taken)
	517	return 0;
	518
	519	if (sd->entry->se_collapse)
	520	sort__need_collapse = 1;
	521
a4fb581b FW	522	if (list_empty(&hist_entry__sort_list)) {
	523	if (!strcmp(sd->name, "pid"))
	524	sort__first_dimension = SORT_PID;
	525	else if (!strcmp(sd->name, "comm"))
	526	sort__first_dimension = SORT_COMM;
	527	else if (!strcmp(sd->name, "dso"))
	528	sort__first_dimension = SORT_DSO;
	529	else if (!strcmp(sd->name, "symbol"))
	530	sort__first_dimension = SORT_SYM;
	531	else if (!strcmp(sd->name, "parent"))
	532	sort__first_dimension = SORT_PARENT;
f60f3593 AS	533	else if (!strcmp(sd->name, "cpu"))
f60f3593 AS	534	sort__first_dimension = SORT_CPU;
b5387528 RAV	535	else if (!strcmp(sd->name, "symbol_from"))
	536	sort__first_dimension = SORT_SYM_FROM;
	537	else if (!strcmp(sd->name, "symbol_to"))
	538	sort__first_dimension = SORT_SYM_TO;
	539	else if (!strcmp(sd->name, "dso_from"))
	540	sort__first_dimension = SORT_DSO_FROM;
	541	else if (!strcmp(sd->name, "dso_to"))
	542	sort__first_dimension = SORT_DSO_TO;
	543	else if (!strcmp(sd->name, "mispredict"))
	544	sort__first_dimension = SORT_MISPREDICT;
a4fb581b	545	}
af0a6fa4	546
dd68ada2 JK	547	list_add_tail(&sd->entry->list, &hist_entry__sort_list);
	548	sd->taken = 1;
	549
	550	return 0;
	551	}
dd68ada2 JK	552	return -ESRCH;
dd68ada2 JK	553	}
c8829c7a ACM	554
	555	void setup_sorting(const char * const usagestr[], const struct option *opts)
	556	{
	557	char tmp, tok, *str = strdup(sort_order);
	558
	559	for (tok = strtok_r(str, ", ", &tmp);
	560	tok; tok = strtok_r(NULL, ", ", &tmp)) {
	561	if (sort_dimension__add(tok) < 0) {
	562	error("Unknown --sort key: `%s'", tok);
	563	usage_with_options(usagestr, opts);
	564	}
	565	}
	566
	567	free(str);
	568	}
c351c281 ACM	569
	570	void sort_entry__setup_elide(struct sort_entry self, struct strlist list,
	571	const char list_name, FILE fp)
	572	{
	573	if (list && strlist__nr_entries(list) == 1) {
	574	if (fp != NULL)
	575	fprintf(fp, "# %s: %s\n", list_name,
	576	strlist__entry(list, 0)->s);
	577	self->elide = true;
	578	}
	579	}