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

#include <sys/mman.h>
#include "sort.h"
#include "hist.h"
#include "comm.h"
#include "symbol.h"
#include "evsel.h"
#include "evlist.h"
#include <traceevent/event-parse.h>
#include "mem-events.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      default_branch_sort_order[] = "comm,dso_from,symbol_from,symbol_to,cycles";
const char      default_mem_sort_order[] = "local_weight,mem,sym,dso,symbol_daddr,dso_daddr,snoop,tlb,locked";
const char      default_top_sort_order[] = "dso,symbol";
const char      default_diff_sort_order[] = "dso,symbol";
const char      default_tracepoint_sort_order[] = "trace";
const char      *sort_order;
const char      *field_order;
regex_t         ignore_callees_regex;
int             have_ignore_callees = 0;
int             sort__has_dso = 0;
int             sort__has_socket = 0;
int             sort__has_thread = 0;
int             sort__has_comm = 0;
enum sort_mode  sort__mode = SORT_MODE__NORMAL;

/*
 * Replaces all occurrences of a char used with the:
 *
 * -t, --field-separator
 *
 * option, that uses a special separator character and don't pad with spaces,
 * replacing all occurances of this separator in symbol names (and other
 * output) with a '.' character, that thus it's the only non valid separator.
*/
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(const void *l, const 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->tid - left->thread->tid;
}

static int hist_entry__thread_snprintf(struct hist_entry *he, char *bf,
                                       size_t size, unsigned int width)
{
        const char *comm = thread__comm_str(he->thread);

        width = max(7U, width) - 6;
        return repsep_snprintf(bf, size, "%5d:%-*.*s", he->thread->tid,
                               width, width, comm ?: "");
}

static int hist_entry__thread_filter(struct hist_entry *he, int type, const void *arg)
{
        const struct thread *th = arg;

        if (type != HIST_FILTER__THREAD)
                return -1;

        return th && he->thread != th;
}

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

/* --sort comm */

static int64_t
sort__comm_cmp(struct hist_entry *left, struct hist_entry *right)
{
        /* Compare the addr that should be unique among comm */
        return strcmp(comm__str(right->comm), comm__str(left->comm));
}

static int64_t
sort__comm_collapse(struct hist_entry *left, struct hist_entry *right)
{
        /* Compare the addr that should be unique among comm */
        return strcmp(comm__str(right->comm), comm__str(left->comm));
}

static int64_t
sort__comm_sort(struct hist_entry *left, struct hist_entry *right)
{
        return strcmp(comm__str(right->comm), comm__str(left->comm));
}

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

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

/* --sort dso */

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_r, dso_l);

        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);
}

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

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, width, dso_name);
        }

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

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

static int hist_entry__dso_filter(struct hist_entry *he, int type, const void *arg)
{
        const struct dso *dso = arg;

        if (type != HIST_FILTER__DSO)
                return -1;

        return dso && (!he->ms.map || he->ms.map->dso != dso);
}

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

/* --sort symbol */

static int64_t _sort__addr_cmp(u64 left_ip, u64 right_ip)
{
        return (int64_t)(right_ip - left_ip);
}

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

        if (sym_l == sym_r)
                return 0;

        if (sym_l->start != sym_r->start)
                return (int64_t)(sym_r->start - sym_l->start);

        return (int64_t)(sym_r->end - sym_l->end);
}

static int64_t
sort__sym_cmp(struct hist_entry *left, struct hist_entry *right)
{
        int64_t ret;

        if (!left->ms.sym && !right->ms.sym)
                return _sort__addr_cmp(left->ip, right->ip);

        /*
         * comparing symbol address alone is not enough since it's a
         * relative address within a dso.
         */
        if (!sort__has_dso) {
                ret = sort__dso_cmp(left, right);
                if (ret != 0)
                        return ret;
        }

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

static int64_t
sort__sym_sort(struct hist_entry *left, struct hist_entry *right)
{
        if (!left->ms.sym || !right->ms.sym)
                return cmp_null(left->ms.sym, right->ms.sym);

        return strcmp(right->ms.sym->name, left->ms.sym->name);
}

static int _hist_entry__sym_snprintf(struct map *map, struct symbol *sym,
                                     u64 ip, char level, char *bf, size_t size,
                                     unsigned int width)
{
        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 + 2, ip, o);
        }

        ret += repsep_snprintf(bf + ret, size - ret, "[%c] ", level);
        if (sym && map) {
                if (map->type == MAP__VARIABLE) {
                        ret += repsep_snprintf(bf + ret, size - ret, "%s", sym->name);
                        ret += repsep_snprintf(bf + ret, size - ret, "+0x%llx",
                                        ip - map->unmap_ip(map, sym->start));
                } else {
                        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);
        }

        return ret;
}

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

static int hist_entry__sym_filter(struct hist_entry *he, int type, const void *arg)
{
        const char *sym = arg;

        if (type != HIST_FILTER__SYMBOL)
                return -1;

        return sym && (!he->ms.sym || !strstr(he->ms.sym->name, sym));
}

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

/* --sort srcline */

static char *hist_entry__get_srcline(struct hist_entry *he)
{
        struct map *map = he->ms.map;

        if (!map)
                return SRCLINE_UNKNOWN;

        return get_srcline(map->dso, map__rip_2objdump(map, he->ip),
                           he->ms.sym, true);
}

static int64_t
sort__srcline_cmp(struct hist_entry *left, struct hist_entry *right)
{
        if (!left->srcline)
                left->srcline = hist_entry__get_srcline(left);
        if (!right->srcline)
                right->srcline = hist_entry__get_srcline(right);

        return strcmp(right->srcline, left->srcline);
}

static int hist_entry__srcline_snprintf(struct hist_entry *he, char *bf,
                                        size_t size, unsigned int width)
{
        if (!he->srcline)
                he->srcline = hist_entry__get_srcline(he);

        return repsep_snprintf(bf, size, "%-.*s", width, he->srcline);
}

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 srcfile */

static char no_srcfile[1];

static char *hist_entry__get_srcfile(struct hist_entry *e)
{
        char *sf, *p;
        struct map *map = e->ms.map;

        if (!map)
                return no_srcfile;

        sf = __get_srcline(map->dso, map__rip_2objdump(map, e->ip),
                         e->ms.sym, false, true);
        if (!strcmp(sf, SRCLINE_UNKNOWN))
                return no_srcfile;
        p = strchr(sf, ':');
        if (p && *sf) {
                *p = 0;
                return sf;
        }
        free(sf);
        return no_srcfile;
}

static int64_t
sort__srcfile_cmp(struct hist_entry *left, struct hist_entry *right)
{
        if (!left->srcfile)
                left->srcfile = hist_entry__get_srcfile(left);
        if (!right->srcfile)
                right->srcfile = hist_entry__get_srcfile(right);

        return strcmp(right->srcfile, left->srcfile);
}

static int hist_entry__srcfile_snprintf(struct hist_entry *he, char *bf,
                                        size_t size, unsigned int width)
{
        if (!he->srcfile)
                he->srcfile = hist_entry__get_srcfile(he);

        return repsep_snprintf(bf, size, "%-.*s", width, he->srcfile);
}

struct sort_entry sort_srcfile = {
        .se_header      = "Source File",
        .se_cmp         = sort__srcfile_cmp,
        .se_snprintf    = hist_entry__srcfile_snprintf,
        .se_width_idx   = HISTC_SRCFILE,
};

/* --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_r->name, sym_l->name);
}

static int hist_entry__parent_snprintf(struct hist_entry *he, char *bf,
                                       size_t size, unsigned int width)
{
        return repsep_snprintf(bf, size, "%-*.*s", width, width,
                              he->parent ? he->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 *he, char *bf,
                                    size_t size, unsigned int width)
{
        return repsep_snprintf(bf, size, "%*.*d", width, width, he->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,
};

/* --sort socket */

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

static int hist_entry__socket_snprintf(struct hist_entry *he, char *bf,
                                    size_t size, unsigned int width)
{
        return repsep_snprintf(bf, size, "%*.*d", width, width-3, he->socket);
}

static int hist_entry__socket_filter(struct hist_entry *he, int type, const void *arg)
{
        int sk = *(const int *)arg;

        if (type != HIST_FILTER__SOCKET)
                return -1;

        return sk >= 0 && he->socket != sk;
}

struct sort_entry sort_socket = {
        .se_header      = "Socket",
        .se_cmp         = sort__socket_cmp,
        .se_snprintf    = hist_entry__socket_snprintf,
        .se_filter      = hist_entry__socket_filter,
        .se_width_idx   = HISTC_SOCKET,
};

/* --sort trace */

static char *get_trace_output(struct hist_entry *he)
{
        struct trace_seq seq;
        struct perf_evsel *evsel;
        struct pevent_record rec = {
                .data = he->raw_data,
                .size = he->raw_size,
        };

        evsel = hists_to_evsel(he->hists);

        trace_seq_init(&seq);
        if (symbol_conf.raw_trace) {
                pevent_print_fields(&seq, he->raw_data, he->raw_size,
                                    evsel->tp_format);
        } else {
                pevent_event_info(&seq, evsel->tp_format, &rec);
        }
        return seq.buffer;
}

static int64_t
sort__trace_cmp(struct hist_entry *left, struct hist_entry *right)
{
        struct perf_evsel *evsel;

        evsel = hists_to_evsel(left->hists);
        if (evsel->attr.type != PERF_TYPE_TRACEPOINT)
                return 0;

        if (left->trace_output == NULL)
                left->trace_output = get_trace_output(left);
        if (right->trace_output == NULL)
                right->trace_output = get_trace_output(right);

        return strcmp(right->trace_output, left->trace_output);
}

static int hist_entry__trace_snprintf(struct hist_entry *he, char *bf,
                                    size_t size, unsigned int width)
{
        struct perf_evsel *evsel;

        evsel = hists_to_evsel(he->hists);
        if (evsel->attr.type != PERF_TYPE_TRACEPOINT)
                return scnprintf(bf, size, "%-.*s", width, "N/A");

        if (he->trace_output == NULL)
                he->trace_output = get_trace_output(he);
        return repsep_snprintf(bf, size, "%-.*s", width, he->trace_output);
}

struct sort_entry sort_trace = {
        .se_header      = "Trace output",
        .se_cmp         = sort__trace_cmp,
        .se_snprintf    = hist_entry__trace_snprintf,
        .se_width_idx   = HISTC_TRACE,
};

/* sort keys for branch stacks */

static int64_t
sort__dso_from_cmp(struct hist_entry *left, struct hist_entry *right)
{
        if (!left->branch_info || !right->branch_info)
                return cmp_null(left->branch_info, right->branch_info);

        return _sort__dso_cmp(left->branch_info->from.map,
                              right->branch_info->from.map);
}

static int hist_entry__dso_from_snprintf(struct hist_entry *he, char *bf,
                                    size_t size, unsigned int width)
{
        if (he->branch_info)
                return _hist_entry__dso_snprintf(he->branch_info->from.map,
                                                 bf, size, width);
        else
                return repsep_snprintf(bf, size, "%-*.*s", width, width, "N/A");
}

static int hist_entry__dso_from_filter(struct hist_entry *he, int type,
                                       const void *arg)
{
        const struct dso *dso = arg;

        if (type != HIST_FILTER__DSO)
                return -1;

        return dso && (!he->branch_info || !he->branch_info->from.map ||
                       he->branch_info->from.map->dso != dso);
}

static int64_t
sort__dso_to_cmp(struct hist_entry *left, struct hist_entry *right)
{
        if (!left->branch_info || !right->branch_info)
                return cmp_null(left->branch_info, right->branch_info);

        return _sort__dso_cmp(left->branch_info->to.map,
                              right->branch_info->to.map);
}

static int hist_entry__dso_to_snprintf(struct hist_entry *he, char *bf,
                                       size_t size, unsigned int width)
{
        if (he->branch_info)
                return _hist_entry__dso_snprintf(he->branch_info->to.map,
                                                 bf, size, width);
        else
                return repsep_snprintf(bf, size, "%-*.*s", width, width, "N/A");
}

static int hist_entry__dso_to_filter(struct hist_entry *he, int type,
                                     const void *arg)
{
        const struct dso *dso = arg;

        if (type != HIST_FILTER__DSO)
                return -1;

        return dso && (!he->branch_info || !he->branch_info->to.map ||
                       he->branch_info->to.map->dso != dso);
}

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 (!left->branch_info || !right->branch_info)
                return cmp_null(left->branch_info, right->branch_info);

        from_l = &left->branch_info->from;
        from_r = &right->branch_info->from;

        if (!from_l->sym && !from_r->sym)
                return _sort__addr_cmp(from_l->addr, from_r->addr);

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

static int64_t
sort__sym_to_cmp(struct hist_entry *left, struct hist_entry *right)
{
        struct addr_map_symbol *to_l, *to_r;

        if (!left->branch_info || !right->branch_info)
                return cmp_null(left->branch_info, right->branch_info);

        to_l = &left->branch_info->to;
        to_r = &right->branch_info->to;

        if (!to_l->sym && !to_r->sym)
                return _sort__addr_cmp(to_l->addr, to_r->addr);

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

static int hist_entry__sym_from_snprintf(struct hist_entry *he, char *bf,
                                         size_t size, unsigned int width)
{
        if (he->branch_info) {
                struct addr_map_symbol *from = &he->branch_info->from;

                return _hist_entry__sym_snprintf(from->map, from->sym, from->addr,
                                                 he->level, bf, size, width);
        }

        return repsep_snprintf(bf, size, "%-*.*s", width, width, "N/A");
}

static int hist_entry__sym_to_snprintf(struct hist_entry *he, char *bf,
                                       size_t size, unsigned int width)
{
        if (he->branch_info) {
                struct addr_map_symbol *to = &he->branch_info->to;

                return _hist_entry__sym_snprintf(to->map, to->sym, to->addr,
                                                 he->level, bf, size, width);
        }

        return repsep_snprintf(bf, size, "%-*.*s", width, width, "N/A");
}

static int hist_entry__sym_from_filter(struct hist_entry *he, int type,
                                       const void *arg)
{
        const char *sym = arg;

        if (type != HIST_FILTER__SYMBOL)
                return -1;

        return sym && !(he->branch_info && he->branch_info->from.sym &&
                        strstr(he->branch_info->from.sym->name, sym));
}

static int hist_entry__sym_to_filter(struct hist_entry *he, int type,
                                       const void *arg)
{
        const char *sym = arg;

        if (type != HIST_FILTER__SYMBOL)
                return -1;

        return sym && !(he->branch_info && he->branch_info->to.sym &&
                        strstr(he->branch_info->to.sym->name, sym));
}

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_filter      = hist_entry__dso_from_filter,
        .se_width_idx   = HISTC_DSO_FROM,
};

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_filter      = hist_entry__dso_to_filter,
        .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_filter      = hist_entry__sym_from_filter,
        .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_filter      = hist_entry__sym_to_filter,
        .se_width_idx   = HISTC_SYMBOL_TO,
};

static int64_t
sort__mispredict_cmp(struct hist_entry *left, struct hist_entry *right)
{
        unsigned char mp, p;

        if (!left->branch_info || !right->branch_info)
                return cmp_null(left->branch_info, right->branch_info);

        mp = left->branch_info->flags.mispred != right->branch_info->flags.mispred;
        p  = left->branch_info->flags.predicted != right->branch_info->flags.predicted;
        return mp || p;
}

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

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

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

static int64_t
sort__cycles_cmp(struct hist_entry *left, struct hist_entry *right)
{
        return left->branch_info->flags.cycles -
                right->branch_info->flags.cycles;
}

static int hist_entry__cycles_snprintf(struct hist_entry *he, char *bf,
                                    size_t size, unsigned int width)
{
        if (he->branch_info->flags.cycles == 0)
                return repsep_snprintf(bf, size, "%-*s", width, "-");
        return repsep_snprintf(bf, size, "%-*hd", width,
                               he->branch_info->flags.cycles);
}

struct sort_entry sort_cycles = {
        .se_header      = "Basic Block Cycles",
        .se_cmp         = sort__cycles_cmp,
        .se_snprintf    = hist_entry__cycles_snprintf,
        .se_width_idx   = HISTC_CYCLES,
};

/* --sort daddr_sym */
static int64_t
sort__daddr_cmp(struct hist_entry *left, struct hist_entry *right)
{
        uint64_t l = 0, r = 0;

        if (left->mem_info)
                l = left->mem_info->daddr.addr;
        if (right->mem_info)
                r = right->mem_info->daddr.addr;

        return (int64_t)(r - l);
}

static int hist_entry__daddr_snprintf(struct hist_entry *he, char *bf,
                                    size_t size, unsigned int width)
{
        uint64_t addr = 0;
        struct map *map = NULL;
        struct symbol *sym = NULL;

        if (he->mem_info) {
                addr = he->mem_info->daddr.addr;
                map = he->mem_info->daddr.map;
                sym = he->mem_info->daddr.sym;
        }
        return _hist_entry__sym_snprintf(map, sym, addr, he->level, bf, size,
                                         width);
}

static int64_t
sort__iaddr_cmp(struct hist_entry *left, struct hist_entry *right)
{
        uint64_t l = 0, r = 0;

        if (left->mem_info)
                l = left->mem_info->iaddr.addr;
        if (right->mem_info)
                r = right->mem_info->iaddr.addr;

        return (int64_t)(r - l);
}

static int hist_entry__iaddr_snprintf(struct hist_entry *he, char *bf,
                                    size_t size, unsigned int width)
{
        uint64_t addr = 0;
        struct map *map = NULL;
        struct symbol *sym = NULL;

        if (he->mem_info) {
                addr = he->mem_info->iaddr.addr;
                map  = he->mem_info->iaddr.map;
                sym  = he->mem_info->iaddr.sym;
        }
        return _hist_entry__sym_snprintf(map, sym, addr, he->level, bf, size,
                                         width);
}

static int64_t
sort__dso_daddr_cmp(struct hist_entry *left, struct hist_entry *right)
{
        struct map *map_l = NULL;
        struct map *map_r = NULL;

        if (left->mem_info)
                map_l = left->mem_info->daddr.map;
        if (right->mem_info)
                map_r = right->mem_info->daddr.map;

        return _sort__dso_cmp(map_l, map_r);
}

static int hist_entry__dso_daddr_snprintf(struct hist_entry *he, char *bf,
                                    size_t size, unsigned int width)
{
        struct map *map = NULL;

        if (he->mem_info)
                map = he->mem_info->daddr.map;

        return _hist_entry__dso_snprintf(map, bf, size, width);
}

static int64_t
sort__locked_cmp(struct hist_entry *left, struct hist_entry *right)
{
        union perf_mem_data_src data_src_l;
        union perf_mem_data_src data_src_r;

        if (left->mem_info)
                data_src_l = left->mem_info->data_src;
        else
                data_src_l.mem_lock = PERF_MEM_LOCK_NA;

        if (right->mem_info)
                data_src_r = right->mem_info->data_src;
        else
                data_src_r.mem_lock = PERF_MEM_LOCK_NA;

        return (int64_t)(data_src_r.mem_lock - data_src_l.mem_lock);
}

static int hist_entry__locked_snprintf(struct hist_entry *he, char *bf,
                                    size_t size, unsigned int width)
{
        char out[10];

        perf_mem__lck_scnprintf(out, sizeof(out), he->mem_info);
        return repsep_snprintf(bf, size, "%.*s", width, out);
}

static int64_t
sort__tlb_cmp(struct hist_entry *left, struct hist_entry *right)
{
        union perf_mem_data_src data_src_l;
        union perf_mem_data_src data_src_r;

        if (left->mem_info)
                data_src_l = left->mem_info->data_src;
        else
                data_src_l.mem_dtlb = PERF_MEM_TLB_NA;

        if (right->mem_info)
                data_src_r = right->mem_info->data_src;
        else
                data_src_r.mem_dtlb = PERF_MEM_TLB_NA;

        return (int64_t)(data_src_r.mem_dtlb - data_src_l.mem_dtlb);
}

static int hist_entry__tlb_snprintf(struct hist_entry *he, char *bf,
                                    size_t size, unsigned int width)
{
        char out[64];

        perf_mem__tlb_scnprintf(out, sizeof(out), he->mem_info);
        return repsep_snprintf(bf, size, "%-*s", width, out);
}

static int64_t
sort__lvl_cmp(struct hist_entry *left, struct hist_entry *right)
{
        union perf_mem_data_src data_src_l;
        union perf_mem_data_src data_src_r;

        if (left->mem_info)
                data_src_l = left->mem_info->data_src;
        else
                data_src_l.mem_lvl = PERF_MEM_LVL_NA;

        if (right->mem_info)
                data_src_r = right->mem_info->data_src;
        else
                data_src_r.mem_lvl = PERF_MEM_LVL_NA;

        return (int64_t)(data_src_r.mem_lvl - data_src_l.mem_lvl);
}

static int hist_entry__lvl_snprintf(struct hist_entry *he, char *bf,
                                    size_t size, unsigned int width)
{
        char out[64];

        perf_mem__lvl_scnprintf(out, sizeof(out), he->mem_info);
        return repsep_snprintf(bf, size, "%-*s", width, out);
}

static int64_t
sort__snoop_cmp(struct hist_entry *left, struct hist_entry *right)
{
        union perf_mem_data_src data_src_l;
        union perf_mem_data_src data_src_r;

        if (left->mem_info)
                data_src_l = left->mem_info->data_src;
        else
                data_src_l.mem_snoop = PERF_MEM_SNOOP_NA;

        if (right->mem_info)
                data_src_r = right->mem_info->data_src;
        else
                data_src_r.mem_snoop = PERF_MEM_SNOOP_NA;

        return (int64_t)(data_src_r.mem_snoop - data_src_l.mem_snoop);
}

static int hist_entry__snoop_snprintf(struct hist_entry *he, char *bf,
                                    size_t size, unsigned int width)
{
        char out[64];

        perf_mem__snp_scnprintf(out, sizeof(out), he->mem_info);
        return repsep_snprintf(bf, size, "%-*s", width, out);
}

static int64_t
sort__dcacheline_cmp(struct hist_entry *left, struct hist_entry *right)
{
        u64 l, r;
        struct map *l_map, *r_map;

        if (!left->mem_info)  return -1;
        if (!right->mem_info) return 1;

        /* group event types together */
        if (left->cpumode > right->cpumode) return -1;
        if (left->cpumode < right->cpumode) return 1;

        l_map = left->mem_info->daddr.map;
        r_map = right->mem_info->daddr.map;

        /* if both are NULL, jump to sort on al_addr instead */
        if (!l_map && !r_map)
                goto addr;

        if (!l_map) return -1;
        if (!r_map) return 1;

        if (l_map->maj > r_map->maj) return -1;
        if (l_map->maj < r_map->maj) return 1;

        if (l_map->min > r_map->min) return -1;
        if (l_map->min < r_map->min) return 1;

        if (l_map->ino > r_map->ino) return -1;
        if (l_map->ino < r_map->ino) return 1;

        if (l_map->ino_generation > r_map->ino_generation) return -1;
        if (l_map->ino_generation < r_map->ino_generation) return 1;

        /*
         * Addresses with no major/minor numbers are assumed to be
         * anonymous in userspace.  Sort those on pid then address.
         *
         * The kernel and non-zero major/minor mapped areas are
         * assumed to be unity mapped.  Sort those on address.
         */

        if ((left->cpumode != PERF_RECORD_MISC_KERNEL) &&
            (!(l_map->flags & MAP_SHARED)) &&
            !l_map->maj && !l_map->min && !l_map->ino &&
            !l_map->ino_generation) {
                /* userspace anonymous */

                if (left->thread->pid_ > right->thread->pid_) return -1;
                if (left->thread->pid_ < right->thread->pid_) return 1;
        }

addr:
        /* al_addr does all the right addr - start + offset calculations */
        l = cl_address(left->mem_info->daddr.al_addr);
        r = cl_address(right->mem_info->daddr.al_addr);

        if (l > r) return -1;
        if (l < r) return 1;

        return 0;
}

static int hist_entry__dcacheline_snprintf(struct hist_entry *he, char *bf,
                                          size_t size, unsigned int width)
{

        uint64_t addr = 0;
        struct map *map = NULL;
        struct symbol *sym = NULL;
        char level = he->level;

        if (he->mem_info) {
                addr = cl_address(he->mem_info->daddr.al_addr);
                map = he->mem_info->daddr.map;
                sym = he->mem_info->daddr.sym;

                /* print [s] for shared data mmaps */
                if ((he->cpumode != PERF_RECORD_MISC_KERNEL) &&
                     map && (map->type == MAP__VARIABLE) &&
                    (map->flags & MAP_SHARED) &&
                    (map->maj || map->min || map->ino ||
                     map->ino_generation))
                        level = 's';
                else if (!map)
                        level = 'X';
        }
        return _hist_entry__sym_snprintf(map, sym, addr, level, bf, size,
                                         width);
}

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,
};

static u64 he_weight(struct hist_entry *he)
{
        return he->stat.nr_events ? he->stat.weight / he->stat.nr_events : 0;
}

static int64_t
sort__local_weight_cmp(struct hist_entry *left, struct hist_entry *right)
{
        return he_weight(left) - he_weight(right);
}

static int hist_entry__local_weight_snprintf(struct hist_entry *he, char *bf,
                                    size_t size, unsigned int width)
{
        return repsep_snprintf(bf, size, "%-*llu", width, he_weight(he));
}

struct sort_entry sort_local_weight = {
        .se_header      = "Local Weight",
        .se_cmp         = sort__local_weight_cmp,
        .se_snprintf    = hist_entry__local_weight_snprintf,
        .se_width_idx   = HISTC_LOCAL_WEIGHT,
};

static int64_t
sort__global_weight_cmp(struct hist_entry *left, struct hist_entry *right)
{
        return left->stat.weight - right->stat.weight;
}

static int hist_entry__global_weight_snprintf(struct hist_entry *he, char *bf,
                                              size_t size, unsigned int width)
{
        return repsep_snprintf(bf, size, "%-*llu", width, he->stat.weight);
}

struct sort_entry sort_global_weight = {
        .se_header      = "Weight",
        .se_cmp         = sort__global_weight_cmp,
        .se_snprintf    = hist_entry__global_weight_snprintf,
        .se_width_idx   = HISTC_GLOBAL_WEIGHT,
};

struct sort_entry sort_mem_daddr_sym = {
        .se_header      = "Data Symbol",
        .se_cmp         = sort__daddr_cmp,
        .se_snprintf    = hist_entry__daddr_snprintf,
        .se_width_idx   = HISTC_MEM_DADDR_SYMBOL,
};

struct sort_entry sort_mem_iaddr_sym = {
        .se_header      = "Code Symbol",
        .se_cmp         = sort__iaddr_cmp,
        .se_snprintf    = hist_entry__iaddr_snprintf,
        .se_width_idx   = HISTC_MEM_IADDR_SYMBOL,
};

struct sort_entry sort_mem_daddr_dso = {
        .se_header      = "Data Object",
        .se_cmp         = sort__dso_daddr_cmp,
        .se_snprintf    = hist_entry__dso_daddr_snprintf,
        .se_width_idx   = HISTC_MEM_DADDR_SYMBOL,
};

struct sort_entry sort_mem_locked = {
        .se_header      = "Locked",
        .se_cmp         = sort__locked_cmp,
        .se_snprintf    = hist_entry__locked_snprintf,
        .se_width_idx   = HISTC_MEM_LOCKED,
};

struct sort_entry sort_mem_tlb = {
        .se_header      = "TLB access",
        .se_cmp         = sort__tlb_cmp,
        .se_snprintf    = hist_entry__tlb_snprintf,
        .se_width_idx   = HISTC_MEM_TLB,
};

struct sort_entry sort_mem_lvl = {
        .se_header      = "Memory access",
        .se_cmp         = sort__lvl_cmp,
        .se_snprintf    = hist_entry__lvl_snprintf,
        .se_width_idx   = HISTC_MEM_LVL,
};

struct sort_entry sort_mem_snoop = {
        .se_header      = "Snoop",
        .se_cmp         = sort__snoop_cmp,
        .se_snprintf    = hist_entry__snoop_snprintf,
        .se_width_idx   = HISTC_MEM_SNOOP,
};

struct sort_entry sort_mem_dcacheline = {
        .se_header      = "Data Cacheline",
        .se_cmp         = sort__dcacheline_cmp,
        .se_snprintf    = hist_entry__dcacheline_snprintf,
        .se_width_idx   = HISTC_MEM_DCACHELINE,
};

static int64_t
sort__abort_cmp(struct hist_entry *left, struct hist_entry *right)
{
        if (!left->branch_info || !right->branch_info)
                return cmp_null(left->branch_info, right->branch_info);

        return left->branch_info->flags.abort !=
                right->branch_info->flags.abort;
}

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

        if (he->branch_info) {
                if (he->branch_info->flags.abort)
                        out = "A";
                else
                        out = ".";
        }

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

struct sort_entry sort_abort = {
        .se_header      = "Transaction abort",
        .se_cmp         = sort__abort_cmp,
        .se_snprintf    = hist_entry__abort_snprintf,
        .se_width_idx   = HISTC_ABORT,
};

static int64_t
sort__in_tx_cmp(struct hist_entry *left, struct hist_entry *right)
{
        if (!left->branch_info || !right->branch_info)
                return cmp_null(left->branch_info, right->branch_info);

        return left->branch_info->flags.in_tx !=
                right->branch_info->flags.in_tx;
}

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

        if (he->branch_info) {
                if (he->branch_info->flags.in_tx)
                        out = "T";
                else
                        out = ".";
        }

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

struct sort_entry sort_in_tx = {
        .se_header      = "Branch in transaction",
        .se_cmp         = sort__in_tx_cmp,
        .se_snprintf    = hist_entry__in_tx_snprintf,
        .se_width_idx   = HISTC_IN_TX,
};

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

static inline char *add_str(char *p, const char *str)
{
        strcpy(p, str);
        return p + strlen(str);
}

static struct txbit {
        unsigned flag;
        const char *name;
        int skip_for_len;
} txbits[] = {
        { PERF_TXN_ELISION,        "EL ",        0 },
        { PERF_TXN_TRANSACTION,    "TX ",        1 },
        { PERF_TXN_SYNC,           "SYNC ",      1 },
        { PERF_TXN_ASYNC,          "ASYNC ",     0 },
        { PERF_TXN_RETRY,          "RETRY ",     0 },
        { PERF_TXN_CONFLICT,       "CON ",       0 },
        { PERF_TXN_CAPACITY_WRITE, "CAP-WRITE ", 1 },
        { PERF_TXN_CAPACITY_READ,  "CAP-READ ",  0 },
        { 0, NULL, 0 }
};

int hist_entry__transaction_len(void)
{
        int i;
        int len = 0;

        for (i = 0; txbits[i].name; i++) {
                if (!txbits[i].skip_for_len)
                        len += strlen(txbits[i].name);
        }
        len += 4; /* :XX<space> */
        return len;
}

static int hist_entry__transaction_snprintf(struct hist_entry *he, char *bf,
                                            size_t size, unsigned int width)
{
        u64 t = he->transaction;
        char buf[128];
        char *p = buf;
        int i;

        buf[0] = 0;
        for (i = 0; txbits[i].name; i++)
                if (txbits[i].flag & t)
                        p = add_str(p, txbits[i].name);
        if (t && !(t & (PERF_TXN_SYNC|PERF_TXN_ASYNC)))
                p = add_str(p, "NEITHER ");
        if (t & PERF_TXN_ABORT_MASK) {
                sprintf(p, ":%" PRIx64,
                        (t & PERF_TXN_ABORT_MASK) >>
                        PERF_TXN_ABORT_SHIFT);
                p += strlen(p);
        }

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

struct sort_entry sort_transaction = {
        .se_header      = "Transaction                ",
        .se_cmp         = sort__transaction_cmp,
        .se_snprintf    = hist_entry__transaction_snprintf,
        .se_width_idx   = HISTC_TRANSACTION,
};

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 common_sort_dimensions[] = {
        DIM(SORT_PID, "pid", sort_thread),
        DIM(SORT_COMM, "comm", sort_comm),
        DIM(SORT_DSO, "dso", sort_dso),
        DIM(SORT_SYM, "symbol", sort_sym),
        DIM(SORT_PARENT, "parent", sort_parent),
        DIM(SORT_CPU, "cpu", sort_cpu),
        DIM(SORT_SOCKET, "socket", sort_socket),
        DIM(SORT_SRCLINE, "srcline", sort_srcline),
        DIM(SORT_SRCFILE, "srcfile", sort_srcfile),
        DIM(SORT_LOCAL_WEIGHT, "local_weight", sort_local_weight),
        DIM(SORT_GLOBAL_WEIGHT, "weight", sort_global_weight),
        DIM(SORT_TRANSACTION, "transaction", sort_transaction),
        DIM(SORT_TRACE, "trace", sort_trace),
};

#undef DIM

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

static struct sort_dimension bstack_sort_dimensions[] = {
        DIM(SORT_DSO_FROM, "dso_from", sort_dso_from),
        DIM(SORT_DSO_TO, "dso_to", sort_dso_to),
        DIM(SORT_SYM_FROM, "symbol_from", sort_sym_from),
        DIM(SORT_SYM_TO, "symbol_to", sort_sym_to),
        DIM(SORT_MISPREDICT, "mispredict", sort_mispredict),
        DIM(SORT_IN_TX, "in_tx", sort_in_tx),
        DIM(SORT_ABORT, "abort", sort_abort),
        DIM(SORT_CYCLES, "cycles", sort_cycles),
};

#undef DIM

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

static struct sort_dimension memory_sort_dimensions[] = {
        DIM(SORT_MEM_DADDR_SYMBOL, "symbol_daddr", sort_mem_daddr_sym),
        DIM(SORT_MEM_IADDR_SYMBOL, "symbol_iaddr", sort_mem_iaddr_sym),
        DIM(SORT_MEM_DADDR_DSO, "dso_daddr", sort_mem_daddr_dso),
        DIM(SORT_MEM_LOCKED, "locked", sort_mem_locked),
        DIM(SORT_MEM_TLB, "tlb", sort_mem_tlb),
        DIM(SORT_MEM_LVL, "mem", sort_mem_lvl),
        DIM(SORT_MEM_SNOOP, "snoop", sort_mem_snoop),
        DIM(SORT_MEM_DCACHELINE, "dcacheline", sort_mem_dcacheline),
};

#undef DIM

struct hpp_dimension {
        const char              *name;
        struct perf_hpp_fmt     *fmt;
        int                     taken;
};

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

static struct hpp_dimension hpp_sort_dimensions[] = {
        DIM(PERF_HPP__OVERHEAD, "overhead"),
        DIM(PERF_HPP__OVERHEAD_SYS, "overhead_sys"),
        DIM(PERF_HPP__OVERHEAD_US, "overhead_us"),
        DIM(PERF_HPP__OVERHEAD_GUEST_SYS, "overhead_guest_sys"),
        DIM(PERF_HPP__OVERHEAD_GUEST_US, "overhead_guest_us"),
        DIM(PERF_HPP__OVERHEAD_ACC, "overhead_children"),
        DIM(PERF_HPP__SAMPLES, "sample"),
        DIM(PERF_HPP__PERIOD, "period"),
};

#undef DIM

struct hpp_sort_entry {
        struct perf_hpp_fmt hpp;
        struct sort_entry *se;
};

void perf_hpp__reset_sort_width(struct perf_hpp_fmt *fmt, struct hists *hists)
{
        struct hpp_sort_entry *hse;

        if (!perf_hpp__is_sort_entry(fmt))
                return;

        hse = container_of(fmt, struct hpp_sort_entry, hpp);
        hists__new_col_len(hists, hse->se->se_width_idx, strlen(fmt->name));
}

static int __sort__hpp_header(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
                              struct perf_evsel *evsel)
{
        struct hpp_sort_entry *hse;
        size_t len = fmt->user_len;

        hse = container_of(fmt, struct hpp_sort_entry, hpp);

        if (!len)
                len = hists__col_len(evsel__hists(evsel), hse->se->se_width_idx);

        return scnprintf(hpp->buf, hpp->size, "%-*.*s", len, len, fmt->name);
}

static int __sort__hpp_width(struct perf_hpp_fmt *fmt,
                             struct perf_hpp *hpp __maybe_unused,
                             struct perf_evsel *evsel)
{
        struct hpp_sort_entry *hse;
        size_t len = fmt->user_len;

        hse = container_of(fmt, struct hpp_sort_entry, hpp);

        if (!len)
                len = hists__col_len(evsel__hists(evsel), hse->se->se_width_idx);

        return len;
}

static int __sort__hpp_entry(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
                             struct hist_entry *he)
{
        struct hpp_sort_entry *hse;
        size_t len = fmt->user_len;

        hse = container_of(fmt, struct hpp_sort_entry, hpp);

        if (!len)
                len = hists__col_len(he->hists, hse->se->se_width_idx);

        return hse->se->se_snprintf(he, hpp->buf, hpp->size, len);
}

static int64_t __sort__hpp_cmp(struct perf_hpp_fmt *fmt,
                               struct hist_entry *a, struct hist_entry *b)
{
        struct hpp_sort_entry *hse;

        hse = container_of(fmt, struct hpp_sort_entry, hpp);
        return hse->se->se_cmp(a, b);
}

static int64_t __sort__hpp_collapse(struct perf_hpp_fmt *fmt,
                                    struct hist_entry *a, struct hist_entry *b)
{
        struct hpp_sort_entry *hse;
        int64_t (*collapse_fn)(struct hist_entry *, struct hist_entry *);

        hse = container_of(fmt, struct hpp_sort_entry, hpp);
        collapse_fn = hse->se->se_collapse ?: hse->se->se_cmp;
        return collapse_fn(a, b);
}

static int64_t __sort__hpp_sort(struct perf_hpp_fmt *fmt,
                                struct hist_entry *a, struct hist_entry *b)
{
        struct hpp_sort_entry *hse;
        int64_t (*sort_fn)(struct hist_entry *, struct hist_entry *);

        hse = container_of(fmt, struct hpp_sort_entry, hpp);
        sort_fn = hse->se->se_sort ?: hse->se->se_cmp;
        return sort_fn(a, b);
}

bool perf_hpp__is_sort_entry(struct perf_hpp_fmt *format)
{
        return format->header == __sort__hpp_header;
}

#define MK_SORT_ENTRY_CHK(key)                                  \
bool perf_hpp__is_ ## key ## _entry(struct perf_hpp_fmt *fmt)   \
{                                                               \
        struct hpp_sort_entry *hse;                             \
                                                                \
        if (!perf_hpp__is_sort_entry(fmt))                      \
                return false;                                   \
                                                                \
        hse = container_of(fmt, struct hpp_sort_entry, hpp);    \
        return hse->se == &sort_ ## key ;                       \
}

MK_SORT_ENTRY_CHK(trace)
MK_SORT_ENTRY_CHK(srcline)
MK_SORT_ENTRY_CHK(srcfile)
MK_SORT_ENTRY_CHK(thread)
MK_SORT_ENTRY_CHK(comm)
MK_SORT_ENTRY_CHK(dso)
MK_SORT_ENTRY_CHK(sym)


static bool __sort__hpp_equal(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b)
{
        struct hpp_sort_entry *hse_a;
        struct hpp_sort_entry *hse_b;

        if (!perf_hpp__is_sort_entry(a) || !perf_hpp__is_sort_entry(b))
                return false;

        hse_a = container_of(a, struct hpp_sort_entry, hpp);
        hse_b = container_of(b, struct hpp_sort_entry, hpp);

        return hse_a->se == hse_b->se;
}

static void hse_free(struct perf_hpp_fmt *fmt)
{
        struct hpp_sort_entry *hse;

        hse = container_of(fmt, struct hpp_sort_entry, hpp);
        free(hse);
}

static struct hpp_sort_entry *
__sort_dimension__alloc_hpp(struct sort_dimension *sd, int level)
{
        struct hpp_sort_entry *hse;

        hse = malloc(sizeof(*hse));
        if (hse == NULL) {
                pr_err("Memory allocation failed\n");
                return NULL;
        }

        hse->se = sd->entry;
        hse->hpp.name = sd->entry->se_header;
        hse->hpp.header = __sort__hpp_header;
        hse->hpp.width = __sort__hpp_width;
        hse->hpp.entry = __sort__hpp_entry;
        hse->hpp.color = NULL;

        hse->hpp.cmp = __sort__hpp_cmp;
        hse->hpp.collapse = __sort__hpp_collapse;
        hse->hpp.sort = __sort__hpp_sort;
        hse->hpp.equal = __sort__hpp_equal;
        hse->hpp.free = hse_free;

        INIT_LIST_HEAD(&hse->hpp.list);
        INIT_LIST_HEAD(&hse->hpp.sort_list);
        hse->hpp.elide = false;
        hse->hpp.len = 0;
        hse->hpp.user_len = 0;
        hse->hpp.level = level;

        return hse;
}

static void hpp_free(struct perf_hpp_fmt *fmt)
{
        free(fmt);
}

static struct perf_hpp_fmt *__hpp_dimension__alloc_hpp(struct hpp_dimension *hd,
                                                       int level)
{
        struct perf_hpp_fmt *fmt;

        fmt = memdup(hd->fmt, sizeof(*fmt));
        if (fmt) {
                INIT_LIST_HEAD(&fmt->list);
                INIT_LIST_HEAD(&fmt->sort_list);
                fmt->free = hpp_free;
                fmt->level = level;
        }

        return fmt;
}

int hist_entry__filter(struct hist_entry *he, int type, const void *arg)
{
        struct perf_hpp_fmt *fmt;
        struct hpp_sort_entry *hse;
        int ret = -1;
        int r;

        perf_hpp_list__for_each_format(he->hpp_list, fmt) {
                if (!perf_hpp__is_sort_entry(fmt))
                        continue;

                hse = container_of(fmt, struct hpp_sort_entry, hpp);
                if (hse->se->se_filter == NULL)
                        continue;

                /*
                 * hist entry is filtered if any of sort key in the hpp list
                 * is applied.  But it should skip non-matched filter types.
                 */
                r = hse->se->se_filter(he, type, arg);
                if (r >= 0) {
                        if (ret < 0)
                                ret = 0;
                        ret |= r;
                }
        }

        return ret;
}

static int __sort_dimension__add_hpp_sort(struct sort_dimension *sd,
                                          struct perf_hpp_list *list,
                                          int level)
{
        struct hpp_sort_entry *hse = __sort_dimension__alloc_hpp(sd, level);

        if (hse == NULL)
                return -1;

        perf_hpp_list__register_sort_field(list, &hse->hpp);
        return 0;
}

static int __sort_dimension__add_hpp_output(struct sort_dimension *sd,
                                            struct perf_hpp_list *list)
{
        struct hpp_sort_entry *hse = __sort_dimension__alloc_hpp(sd, 0);

        if (hse == NULL)
                return -1;

        perf_hpp_list__column_register(list, &hse->hpp);
        return 0;
}

struct hpp_dynamic_entry {
        struct perf_hpp_fmt hpp;
        struct perf_evsel *evsel;
        struct format_field *field;
        unsigned dynamic_len;
        bool raw_trace;
};

static int hde_width(struct hpp_dynamic_entry *hde)
{
        if (!hde->hpp.len) {
                int len = hde->dynamic_len;
                int namelen = strlen(hde->field->name);
                int fieldlen = hde->field->size;

                if (namelen > len)
                        len = namelen;

                if (!(hde->field->flags & FIELD_IS_STRING)) {
                        /* length for print hex numbers */
                        fieldlen = hde->field->size * 2 + 2;
                }
                if (fieldlen > len)
                        len = fieldlen;

                hde->hpp.len = len;
        }
        return hde->hpp.len;
}

static void update_dynamic_len(struct hpp_dynamic_entry *hde,
                               struct hist_entry *he)
{
        char *str, *pos;
        struct format_field *field = hde->field;
        size_t namelen;
        bool last = false;

        if (hde->raw_trace)
                return;

        /* parse pretty print result and update max length */
        if (!he->trace_output)
                he->trace_output = get_trace_output(he);

        namelen = strlen(field->name);
        str = he->trace_output;

        while (str) {
                pos = strchr(str, ' ');
                if (pos == NULL) {
                        last = true;
                        pos = str + strlen(str);
                }

                if (!strncmp(str, field->name, namelen)) {
                        size_t len;

                        str += namelen + 1;
                        len = pos - str;

                        if (len > hde->dynamic_len)
                                hde->dynamic_len = len;
                        break;
                }

                if (last)
                        str = NULL;
                else
                        str = pos + 1;
        }
}

static int __sort__hde_header(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
                              struct perf_evsel *evsel __maybe_unused)
{
        struct hpp_dynamic_entry *hde;
        size_t len = fmt->user_len;

        hde = container_of(fmt, struct hpp_dynamic_entry, hpp);

        if (!len)
                len = hde_width(hde);

        return scnprintf(hpp->buf, hpp->size, "%*.*s", len, len, hde->field->name);
}

static int __sort__hde_width(struct perf_hpp_fmt *fmt,
                             struct perf_hpp *hpp __maybe_unused,
                             struct perf_evsel *evsel __maybe_unused)
{
        struct hpp_dynamic_entry *hde;
        size_t len = fmt->user_len;

        hde = container_of(fmt, struct hpp_dynamic_entry, hpp);

        if (!len)
                len = hde_width(hde);

        return len;
}

bool perf_hpp__defined_dynamic_entry(struct perf_hpp_fmt *fmt, struct hists *hists)
{
        struct hpp_dynamic_entry *hde;

        hde = container_of(fmt, struct hpp_dynamic_entry, hpp);

        return hists_to_evsel(hists) == hde->evsel;
}

static int __sort__hde_entry(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
                             struct hist_entry *he)
{
        struct hpp_dynamic_entry *hde;
        size_t len = fmt->user_len;
        char *str, *pos;
        struct format_field *field;
        size_t namelen;
        bool last = false;
        int ret;

        hde = container_of(fmt, struct hpp_dynamic_entry, hpp);

        if (!len)
                len = hde_width(hde);

        if (hde->raw_trace)
                goto raw_field;

        if (!he->trace_output)
                he->trace_output = get_trace_output(he);

        field = hde->field;
        namelen = strlen(field->name);
        str = he->trace_output;

        while (str) {
                pos = strchr(str, ' ');
                if (pos == NULL) {
                        last = true;
                        pos = str + strlen(str);
                }

                if (!strncmp(str, field->name, namelen)) {
                        str += namelen + 1;
                        str = strndup(str, pos - str);

                        if (str == NULL)
                                return scnprintf(hpp->buf, hpp->size,
                                                 "%*.*s", len, len, "ERROR");
                        break;
                }

                if (last)
                        str = NULL;
                else
                        str = pos + 1;
        }

        if (str == NULL) {
                struct trace_seq seq;
raw_field:
                trace_seq_init(&seq);
                pevent_print_field(&seq, he->raw_data, hde->field);
                str = seq.buffer;
        }

        ret = scnprintf(hpp->buf, hpp->size, "%*.*s", len, len, str);
        free(str);
        return ret;
}

static int64_t __sort__hde_cmp(struct perf_hpp_fmt *fmt,
                               struct hist_entry *a, struct hist_entry *b)
{
        struct hpp_dynamic_entry *hde;
        struct format_field *field;
        unsigned offset, size;

        hde = container_of(fmt, struct hpp_dynamic_entry, hpp);

        if (b == NULL) {
                update_dynamic_len(hde, a);
                return 0;
        }

        field = hde->field;
        if (field->flags & FIELD_IS_DYNAMIC) {
                unsigned long long dyn;

                pevent_read_number_field(field, a->raw_data, &dyn);
                offset = dyn & 0xffff;
                size = (dyn >> 16) & 0xffff;

                /* record max width for output */
                if (size > hde->dynamic_len)
                        hde->dynamic_len = size;
        } else {
                offset = field->offset;
                size = field->size;
        }

        return memcmp(a->raw_data + offset, b->raw_data + offset, size);
}

bool perf_hpp__is_dynamic_entry(struct perf_hpp_fmt *fmt)
{
        return fmt->cmp == __sort__hde_cmp;
}

static bool __sort__hde_equal(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b)
{
        struct hpp_dynamic_entry *hde_a;
        struct hpp_dynamic_entry *hde_b;

        if (!perf_hpp__is_dynamic_entry(a) || !perf_hpp__is_dynamic_entry(b))
                return false;

        hde_a = container_of(a, struct hpp_dynamic_entry, hpp);
        hde_b = container_of(b, struct hpp_dynamic_entry, hpp);

        return hde_a->field == hde_b->field;
}

static void hde_free(struct perf_hpp_fmt *fmt)
{
        struct hpp_dynamic_entry *hde;

        hde = container_of(fmt, struct hpp_dynamic_entry, hpp);
        free(hde);
}

static struct hpp_dynamic_entry *
__alloc_dynamic_entry(struct perf_evsel *evsel, struct format_field *field,
                      int level)
{
        struct hpp_dynamic_entry *hde;

        hde = malloc(sizeof(*hde));
        if (hde == NULL) {
                pr_debug("Memory allocation failed\n");
                return NULL;
        }

        hde->evsel = evsel;
        hde->field = field;
        hde->dynamic_len = 0;

        hde->hpp.name = field->name;
        hde->hpp.header = __sort__hde_header;
        hde->hpp.width  = __sort__hde_width;
        hde->hpp.entry  = __sort__hde_entry;
        hde->hpp.color  = NULL;

        hde->hpp.cmp = __sort__hde_cmp;
        hde->hpp.collapse = __sort__hde_cmp;
        hde->hpp.sort = __sort__hde_cmp;
        hde->hpp.equal = __sort__hde_equal;
        hde->hpp.free = hde_free;

        INIT_LIST_HEAD(&hde->hpp.list);
        INIT_LIST_HEAD(&hde->hpp.sort_list);
        hde->hpp.elide = false;
        hde->hpp.len = 0;
        hde->hpp.user_len = 0;
        hde->hpp.level = level;

        return hde;
}

struct perf_hpp_fmt *perf_hpp_fmt__dup(struct perf_hpp_fmt *fmt)
{
        struct perf_hpp_fmt *new_fmt = NULL;

        if (perf_hpp__is_sort_entry(fmt)) {
                struct hpp_sort_entry *hse, *new_hse;

                hse = container_of(fmt, struct hpp_sort_entry, hpp);
                new_hse = memdup(hse, sizeof(*hse));
                if (new_hse)
                        new_fmt = &new_hse->hpp;
        } else if (perf_hpp__is_dynamic_entry(fmt)) {
                struct hpp_dynamic_entry *hde, *new_hde;

                hde = container_of(fmt, struct hpp_dynamic_entry, hpp);
                new_hde = memdup(hde, sizeof(*hde));
                if (new_hde)
                        new_fmt = &new_hde->hpp;
        } else {
                new_fmt = memdup(fmt, sizeof(*fmt));
        }

        INIT_LIST_HEAD(&new_fmt->list);
        INIT_LIST_HEAD(&new_fmt->sort_list);

        return new_fmt;
}

static int parse_field_name(char *str, char **event, char **field, char **opt)
{
        char *event_name, *field_name, *opt_name;

        event_name = str;
        field_name = strchr(str, '.');

        if (field_name) {
                *field_name++ = '\0';
        } else {
                event_name = NULL;
                field_name = str;
        }

        opt_name = strchr(field_name, '/');
        if (opt_name)
                *opt_name++ = '\0';

        *event = event_name;
        *field = field_name;
        *opt   = opt_name;

        return 0;
}

/* find match evsel using a given event name.  The event name can be:
 *   1. '%' + event index (e.g. '%1' for first event)
 *   2. full event name (e.g. sched:sched_switch)
 *   3. partial event name (should not contain ':')
 */
static struct perf_evsel *find_evsel(struct perf_evlist *evlist, char *event_name)
{
        struct perf_evsel *evsel = NULL;
        struct perf_evsel *pos;
        bool full_name;

        /* case 1 */
        if (event_name[0] == '%') {
                int nr = strtol(event_name+1, NULL, 0);

                if (nr > evlist->nr_entries)
                        return NULL;

                evsel = perf_evlist__first(evlist);
                while (--nr > 0)
                        evsel = perf_evsel__next(evsel);

                return evsel;
        }

        full_name = !!strchr(event_name, ':');
        evlist__for_each(evlist, pos) {
                /* case 2 */
                if (full_name && !strcmp(pos->name, event_name))
                        return pos;
                /* case 3 */
                if (!full_name && strstr(pos->name, event_name)) {
                        if (evsel) {
                                pr_debug("'%s' event is ambiguous: it can be %s or %s\n",
                                         event_name, evsel->name, pos->name);
                                return NULL;
                        }
                        evsel = pos;
                }
        }

        return evsel;
}

static int __dynamic_dimension__add(struct perf_evsel *evsel,
                                    struct format_field *field,
                                    bool raw_trace, int level)
{
        struct hpp_dynamic_entry *hde;

        hde = __alloc_dynamic_entry(evsel, field, level);
        if (hde == NULL)
                return -ENOMEM;

        hde->raw_trace = raw_trace;

        perf_hpp__register_sort_field(&hde->hpp);
        return 0;
}

static int add_evsel_fields(struct perf_evsel *evsel, bool raw_trace, int level)
{
        int ret;
        struct format_field *field;

        field = evsel->tp_format->format.fields;
        while (field) {
                ret = __dynamic_dimension__add(evsel, field, raw_trace, level);
                if (ret < 0)
                        return ret;

                field = field->next;
        }
        return 0;
}

static int add_all_dynamic_fields(struct perf_evlist *evlist, bool raw_trace,
                                  int level)
{
        int ret;
        struct perf_evsel *evsel;

        evlist__for_each(evlist, evsel) {
                if (evsel->attr.type != PERF_TYPE_TRACEPOINT)
                        continue;

                ret = add_evsel_fields(evsel, raw_trace, level);
                if (ret < 0)
                        return ret;
        }
        return 0;
}

static int add_all_matching_fields(struct perf_evlist *evlist,
                                   char *field_name, bool raw_trace, int level)
{
        int ret = -ESRCH;
        struct perf_evsel *evsel;
        struct format_field *field;

        evlist__for_each(evlist, evsel) {
                if (evsel->attr.type != PERF_TYPE_TRACEPOINT)
                        continue;

                field = pevent_find_any_field(evsel->tp_format, field_name);
                if (field == NULL)
                        continue;

                ret = __dynamic_dimension__add(evsel, field, raw_trace, level);
                if (ret < 0)
                        break;
        }
        return ret;
}

static int add_dynamic_entry(struct perf_evlist *evlist, const char *tok,
                             int level)
{
        char *str, *event_name, *field_name, *opt_name;
        struct perf_evsel *evsel;
        struct format_field *field;
        bool raw_trace = symbol_conf.raw_trace;
        int ret = 0;

        if (evlist == NULL)
                return -ENOENT;

        str = strdup(tok);
        if (str == NULL)
                return -ENOMEM;

        if (parse_field_name(str, &event_name, &field_name, &opt_name) < 0) {
                ret = -EINVAL;
                goto out;
        }

        if (opt_name) {
                if (strcmp(opt_name, "raw")) {
                        pr_debug("unsupported field option %s\n", opt_name);
                        ret = -EINVAL;
                        goto out;
                }
                raw_trace = true;
        }

        if (!strcmp(field_name, "trace_fields")) {
                ret = add_all_dynamic_fields(evlist, raw_trace, level);
                goto out;
        }

        if (event_name == NULL) {
                ret = add_all_matching_fields(evlist, field_name, raw_trace, level);
                goto out;
        }

        evsel = find_evsel(evlist, event_name);
        if (evsel == NULL) {
                pr_debug("Cannot find event: %s\n", event_name);
                ret = -ENOENT;
                goto out;
        }

        if (evsel->attr.type != PERF_TYPE_TRACEPOINT) {
                pr_debug("%s is not a tracepoint event\n", event_name);
                ret = -EINVAL;
                goto out;
        }

        if (!strcmp(field_name, "*")) {
                ret = add_evsel_fields(evsel, raw_trace, level);
        } else {
                field = pevent_find_any_field(evsel->tp_format, field_name);
                if (field == NULL) {
                        pr_debug("Cannot find event field for %s.%s\n",
                                 event_name, field_name);
                        return -ENOENT;
                }

                ret = __dynamic_dimension__add(evsel, field, raw_trace, level);
        }

out:
        free(str);
        return ret;
}

static int __sort_dimension__add(struct sort_dimension *sd,
                                 struct perf_hpp_list *list,
                                 int level)
{
        if (sd->taken)
                return 0;

        if (__sort_dimension__add_hpp_sort(sd, list, level) < 0)
                return -1;

        if (sd->entry->se_collapse)
                list->need_collapse = 1;

        sd->taken = 1;

        return 0;
}

static int __hpp_dimension__add(struct hpp_dimension *hd,
                                struct perf_hpp_list *list,
                                int level)
{
        struct perf_hpp_fmt *fmt;

        if (hd->taken)
                return 0;

        fmt = __hpp_dimension__alloc_hpp(hd, level);
        if (!fmt)
                return -1;

        hd->taken = 1;
        perf_hpp_list__register_sort_field(list, fmt);
        return 0;
}

static int __sort_dimension__add_output(struct perf_hpp_list *list,
                                        struct sort_dimension *sd)
{
        if (sd->taken)
                return 0;

        if (__sort_dimension__add_hpp_output(sd, list) < 0)
                return -1;

        sd->taken = 1;
        return 0;
}

static int __hpp_dimension__add_output(struct perf_hpp_list *list,
                                       struct hpp_dimension *hd)
{
        struct perf_hpp_fmt *fmt;

        if (hd->taken)
                return 0;

        fmt = __hpp_dimension__alloc_hpp(hd, 0);
        if (!fmt)
                return -1;

        hd->taken = 1;
        perf_hpp_list__column_register(list, fmt);
        return 0;
}

int hpp_dimension__add_output(unsigned col)
{
        BUG_ON(col >= PERF_HPP__MAX_INDEX);
        return __hpp_dimension__add_output(&perf_hpp_list, &hpp_sort_dimensions[col]);
}

static int sort_dimension__add(struct perf_hpp_list *list, const char *tok,
                               struct perf_evlist *evlist,
                               int level)
{
        unsigned int i;

        for (i = 0; i < ARRAY_SIZE(common_sort_dimensions); i++) {
                struct sort_dimension *sd = &common_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;
                        }
                        list->parent = 1;
                } else if (sd->entry == &sort_sym) {
                        list->sym = 1;
                        /*
                         * perf diff displays the performance difference amongst
                         * two or more perf.data files. Those files could come
                         * from different binaries. So we should not compare
                         * their ips, but the name of symbol.
                         */
                        if (sort__mode == SORT_MODE__DIFF)
                                sd->entry->se_collapse = sort__sym_sort;

                } else if (sd->entry == &sort_dso) {
                        sort__has_dso = 1;
                } else if (sd->entry == &sort_socket) {
                        sort__has_socket = 1;
                } else if (sd->entry == &sort_thread) {
                        sort__has_thread = 1;
                } else if (sd->entry == &sort_comm) {
                        sort__has_comm = 1;
                }

                return __sort_dimension__add(sd, list, level);
        }

        for (i = 0; i < ARRAY_SIZE(hpp_sort_dimensions); i++) {
                struct hpp_dimension *hd = &hpp_sort_dimensions[i];

                if (strncasecmp(tok, hd->name, strlen(tok)))
                        continue;

                return __hpp_dimension__add(hd, list, level);
        }

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

                if (strncasecmp(tok, sd->name, strlen(tok)))
                        continue;

                if (sort__mode != SORT_MODE__BRANCH)
                        return -EINVAL;

                if (sd->entry == &sort_sym_from || sd->entry == &sort_sym_to)
                        list->sym = 1;

                __sort_dimension__add(sd, list, level);
                return 0;
        }

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

                if (strncasecmp(tok, sd->name, strlen(tok)))
                        continue;

                if (sort__mode != SORT_MODE__MEMORY)
                        return -EINVAL;

                if (sd->entry == &sort_mem_daddr_sym)
                        list->sym = 1;

                __sort_dimension__add(sd, list, level);
                return 0;
        }

        if (!add_dynamic_entry(evlist, tok, level))
                return 0;

        return -ESRCH;
}

static int setup_sort_list(struct perf_hpp_list *list, char *str,
                           struct perf_evlist *evlist)
{
        char *tmp, *tok;
        int ret = 0;
        int level = 0;
        int next_level = 1;
        bool in_group = false;

        do {
                tok = str;
                tmp = strpbrk(str, "{}, ");
                if (tmp) {
                        if (in_group)
                                next_level = level;
                        else
                                next_level = level + 1;

                        if (*tmp == '{')
                                in_group = true;
                        else if (*tmp == '}')
                                in_group = false;

                        *tmp = '\0';
                        str = tmp + 1;
                }

                if (*tok) {
                        ret = sort_dimension__add(list, tok, evlist, level);
                        if (ret == -EINVAL) {
                                error("Invalid --sort key: `%s'", tok);
                                break;
                        } else if (ret == -ESRCH) {
                                error("Unknown --sort key: `%s'", tok);
                                break;
                        }
                }

                level = next_level;
        } while (tmp);

        return ret;
}

static const char *get_default_sort_order(struct perf_evlist *evlist)
{
        const char *default_sort_orders[] = {
                default_sort_order,
                default_branch_sort_order,
                default_mem_sort_order,
                default_top_sort_order,
                default_diff_sort_order,
                default_tracepoint_sort_order,
        };
        bool use_trace = true;
        struct perf_evsel *evsel;

        BUG_ON(sort__mode >= ARRAY_SIZE(default_sort_orders));

        if (evlist == NULL)
                goto out_no_evlist;

        evlist__for_each(evlist, evsel) {
                if (evsel->attr.type != PERF_TYPE_TRACEPOINT) {
                        use_trace = false;
                        break;
                }
        }

        if (use_trace) {
                sort__mode = SORT_MODE__TRACEPOINT;
                if (symbol_conf.raw_trace)
                        return "trace_fields";
        }
out_no_evlist:
        return default_sort_orders[sort__mode];
}

static int setup_sort_order(struct perf_evlist *evlist)
{
        char *new_sort_order;

        /*
         * Append '+'-prefixed sort order to the default sort
         * order string.
         */
        if (!sort_order || is_strict_order(sort_order))
                return 0;

        if (sort_order[1] == '\0') {
                error("Invalid --sort key: `+'");
                return -EINVAL;
        }

        /*
         * We allocate new sort_order string, but we never free it,
         * because it's checked over the rest of the code.
         */
        if (asprintf(&new_sort_order, "%s,%s",
                     get_default_sort_order(evlist), sort_order + 1) < 0) {
                error("Not enough memory to set up --sort");
                return -ENOMEM;
        }

        sort_order = new_sort_order;
        return 0;
}

/*
 * Adds 'pre,' prefix into 'str' is 'pre' is
 * not already part of 'str'.
 */
static char *prefix_if_not_in(const char *pre, char *str)
{
        char *n;

        if (!str || strstr(str, pre))
                return str;

        if (asprintf(&n, "%s,%s", pre, str) < 0)
                return NULL;

        free(str);
        return n;
}

static char *setup_overhead(char *keys)
{
        keys = prefix_if_not_in("overhead", keys);

        if (symbol_conf.cumulate_callchain)
                keys = prefix_if_not_in("overhead_children", keys);

        return keys;
}

static int __setup_sorting(struct perf_evlist *evlist)
{
        char *str;
        const char *sort_keys;
        int ret = 0;

        ret = setup_sort_order(evlist);
        if (ret)
                return ret;

        sort_keys = sort_order;
        if (sort_keys == NULL) {
                if (is_strict_order(field_order)) {
                        /*
                         * If user specified field order but no sort order,
                         * we'll honor it and not add default sort orders.
                         */
                        return 0;
                }

                sort_keys = get_default_sort_order(evlist);
        }

        str = strdup(sort_keys);
        if (str == NULL) {
                error("Not enough memory to setup sort keys");
                return -ENOMEM;
        }

        /*
         * Prepend overhead fields for backward compatibility.
         */
        if (!is_strict_order(field_order)) {
                str = setup_overhead(str);
                if (str == NULL) {
                        error("Not enough memory to setup overhead keys");
                        return -ENOMEM;
                }
        }

        ret = setup_sort_list(&perf_hpp_list, str, evlist);

        free(str);
        return ret;
}

void perf_hpp__set_elide(int idx, bool elide)
{
        struct perf_hpp_fmt *fmt;
        struct hpp_sort_entry *hse;

        perf_hpp_list__for_each_format(&perf_hpp_list, fmt) {
                if (!perf_hpp__is_sort_entry(fmt))
                        continue;

                hse = container_of(fmt, struct hpp_sort_entry, hpp);
                if (hse->se->se_width_idx == idx) {
                        fmt->elide = elide;
                        break;
                }
        }
}

static bool __get_elide(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);
                return true;
        }
        return false;
}

static bool get_elide(int idx, FILE *output)
{
        switch (idx) {
        case HISTC_SYMBOL:
                return __get_elide(symbol_conf.sym_list, "symbol", output);
        case HISTC_DSO:
                return __get_elide(symbol_conf.dso_list, "dso", output);
        case HISTC_COMM:
                return __get_elide(symbol_conf.comm_list, "comm", output);
        default:
                break;
        }

        if (sort__mode != SORT_MODE__BRANCH)
                return false;

        switch (idx) {
        case HISTC_SYMBOL_FROM:
                return __get_elide(symbol_conf.sym_from_list, "sym_from", output);
        case HISTC_SYMBOL_TO:
                return __get_elide(symbol_conf.sym_to_list, "sym_to", output);
        case HISTC_DSO_FROM:
                return __get_elide(symbol_conf.dso_from_list, "dso_from", output);
        case HISTC_DSO_TO:
                return __get_elide(symbol_conf.dso_to_list, "dso_to", output);
        default:
                break;
        }

        return false;
}

void sort__setup_elide(FILE *output)
{
        struct perf_hpp_fmt *fmt;
        struct hpp_sort_entry *hse;

        perf_hpp_list__for_each_format(&perf_hpp_list, fmt) {
                if (!perf_hpp__is_sort_entry(fmt))
                        continue;

                hse = container_of(fmt, struct hpp_sort_entry, hpp);
                fmt->elide = get_elide(hse->se->se_width_idx, output);
        }

        /*
         * It makes no sense to elide all of sort entries.
         * Just revert them to show up again.
         */
        perf_hpp_list__for_each_format(&perf_hpp_list, fmt) {
                if (!perf_hpp__is_sort_entry(fmt))
                        continue;

                if (!fmt->elide)
                        return;
        }

        perf_hpp_list__for_each_format(&perf_hpp_list, fmt) {
                if (!perf_hpp__is_sort_entry(fmt))
                        continue;

                fmt->elide = false;
        }
}

static int output_field_add(struct perf_hpp_list *list, char *tok)
{
        unsigned int i;

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

                if (strncasecmp(tok, sd->name, strlen(tok)))
                        continue;

                return __sort_dimension__add_output(list, sd);
        }

        for (i = 0; i < ARRAY_SIZE(hpp_sort_dimensions); i++) {
                struct hpp_dimension *hd = &hpp_sort_dimensions[i];

                if (strncasecmp(tok, hd->name, strlen(tok)))
                        continue;

                return __hpp_dimension__add_output(list, hd);
        }

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

                if (strncasecmp(tok, sd->name, strlen(tok)))
                        continue;

                return __sort_dimension__add_output(list, sd);
        }

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

                if (strncasecmp(tok, sd->name, strlen(tok)))
                        continue;

                return __sort_dimension__add_output(list, sd);
        }

        return -ESRCH;
}

static int setup_output_list(struct perf_hpp_list *list, char *str)
{
        char *tmp, *tok;
        int ret = 0;

        for (tok = strtok_r(str, ", ", &tmp);
                        tok; tok = strtok_r(NULL, ", ", &tmp)) {
                ret = output_field_add(list, tok);
                if (ret == -EINVAL) {
                        error("Invalid --fields key: `%s'", tok);
                        break;
                } else if (ret == -ESRCH) {
                        error("Unknown --fields key: `%s'", tok);
                        break;
                }
        }

        return ret;
}

static void reset_dimensions(void)
{
        unsigned int i;

        for (i = 0; i < ARRAY_SIZE(common_sort_dimensions); i++)
                common_sort_dimensions[i].taken = 0;

        for (i = 0; i < ARRAY_SIZE(hpp_sort_dimensions); i++)
                hpp_sort_dimensions[i].taken = 0;

        for (i = 0; i < ARRAY_SIZE(bstack_sort_dimensions); i++)
                bstack_sort_dimensions[i].taken = 0;

        for (i = 0; i < ARRAY_SIZE(memory_sort_dimensions); i++)
                memory_sort_dimensions[i].taken = 0;
}

bool is_strict_order(const char *order)
{
        return order && (*order != '+');
}

static int __setup_output_field(void)
{
        char *str, *strp;
        int ret = -EINVAL;

        if (field_order == NULL)
                return 0;

        strp = str = strdup(field_order);
        if (str == NULL) {
                error("Not enough memory to setup output fields");
                return -ENOMEM;
        }

        if (!is_strict_order(field_order))
                strp++;

        if (!strlen(strp)) {
                error("Invalid --fields key: `+'");
                goto out;
        }

        ret = setup_output_list(&perf_hpp_list, strp);

out:
        free(str);
        return ret;
}

int setup_sorting(struct perf_evlist *evlist)
{
        int err;

        err = __setup_sorting(evlist);
        if (err < 0)
                return err;

        if (parent_pattern != default_parent_pattern) {
                err = sort_dimension__add(&perf_hpp_list, "parent", evlist, -1);
                if (err < 0)
                        return err;
        }

        reset_dimensions();

        /*
         * perf diff doesn't use default hpp output fields.
         */
        if (sort__mode != SORT_MODE__DIFF)
                perf_hpp__init();

        err = __setup_output_field();
        if (err < 0)
                return err;

        /* copy sort keys to output fields */
        perf_hpp__setup_output_field(&perf_hpp_list);
        /* and then copy output fields to sort keys */
        perf_hpp__append_sort_keys(&perf_hpp_list);

        /* setup hists-specific output fields */
        if (perf_hpp__setup_hists_formats(&perf_hpp_list, evlist) < 0)
                return -1;

        return 0;
}

void reset_output_field(void)
{
        perf_hpp_list.need_collapse = 0;
        perf_hpp_list.parent = 0;
        perf_hpp_list.sym = 0;
        sort__has_dso = 0;

        field_order = NULL;
        sort_order = NULL;

        reset_dimensions();
        perf_hpp__reset_output_field(&perf_hpp_list);
}