tools/perf/util/sort.c

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