2 * Copyright (C) 2009-2011, Frederic Weisbecker <fweisbec@gmail.com>
4 * Handle the callchains from the stream in an ad-hoc radix tree and then
5 * sort them in an rbtree.
7 * Using a radix for code path provides a fast retrieval and factorizes
8 * memory use. Also that lets us use the paths in a hierarchical graph view.
24 #include "callchain.h"
26 __thread struct callchain_cursor callchain_cursor;
28 int parse_callchain_record_opt(const char *arg, struct callchain_param *param)
30 return parse_callchain_record(arg, param);
33 static int parse_callchain_mode(const char *value)
35 if (!strncmp(value, "graph", strlen(value))) {
36 callchain_param.mode = CHAIN_GRAPH_ABS;
39 if (!strncmp(value, "flat", strlen(value))) {
40 callchain_param.mode = CHAIN_FLAT;
43 if (!strncmp(value, "fractal", strlen(value))) {
44 callchain_param.mode = CHAIN_GRAPH_REL;
47 if (!strncmp(value, "folded", strlen(value))) {
48 callchain_param.mode = CHAIN_FOLDED;
54 static int parse_callchain_order(const char *value)
56 if (!strncmp(value, "caller", strlen(value))) {
57 callchain_param.order = ORDER_CALLER;
58 callchain_param.order_set = true;
61 if (!strncmp(value, "callee", strlen(value))) {
62 callchain_param.order = ORDER_CALLEE;
63 callchain_param.order_set = true;
69 static int parse_callchain_sort_key(const char *value)
71 if (!strncmp(value, "function", strlen(value))) {
72 callchain_param.key = CCKEY_FUNCTION;
75 if (!strncmp(value, "address", strlen(value))) {
76 callchain_param.key = CCKEY_ADDRESS;
79 if (!strncmp(value, "branch", strlen(value))) {
80 callchain_param.branch_callstack = 1;
86 static int parse_callchain_value(const char *value)
88 if (!strncmp(value, "percent", strlen(value))) {
89 callchain_param.value = CCVAL_PERCENT;
92 if (!strncmp(value, "period", strlen(value))) {
93 callchain_param.value = CCVAL_PERIOD;
96 if (!strncmp(value, "count", strlen(value))) {
97 callchain_param.value = CCVAL_COUNT;
104 __parse_callchain_report_opt(const char *arg, bool allow_record_opt)
108 bool minpcnt_set = false;
109 bool record_opt_set = false;
110 bool try_stack_size = false;
112 callchain_param.enabled = true;
113 symbol_conf.use_callchain = true;
118 while ((tok = strtok((char *)arg, ",")) != NULL) {
119 if (!strncmp(tok, "none", strlen(tok))) {
120 callchain_param.mode = CHAIN_NONE;
121 callchain_param.enabled = false;
122 symbol_conf.use_callchain = false;
126 if (!parse_callchain_mode(tok) ||
127 !parse_callchain_order(tok) ||
128 !parse_callchain_sort_key(tok) ||
129 !parse_callchain_value(tok)) {
130 /* parsing ok - move on to the next */
131 try_stack_size = false;
133 } else if (allow_record_opt && !record_opt_set) {
134 if (parse_callchain_record(tok, &callchain_param))
137 /* assume that number followed by 'dwarf' is stack size */
138 if (callchain_param.record_mode == CALLCHAIN_DWARF)
139 try_stack_size = true;
141 record_opt_set = true;
146 if (try_stack_size) {
147 unsigned long size = 0;
149 if (get_stack_size(tok, &size) < 0)
151 callchain_param.dump_size = size;
152 try_stack_size = false;
153 } else if (!minpcnt_set) {
154 /* try to get the min percent */
155 callchain_param.min_percent = strtod(tok, &endptr);
160 /* try print limit at last */
161 callchain_param.print_limit = strtoul(tok, &endptr, 0);
169 if (callchain_register_param(&callchain_param) < 0) {
170 pr_err("Can't register callchain params\n");
176 int parse_callchain_report_opt(const char *arg)
178 return __parse_callchain_report_opt(arg, false);
181 int parse_callchain_top_opt(const char *arg)
183 return __parse_callchain_report_opt(arg, true);
186 int perf_callchain_config(const char *var, const char *value)
190 if (prefixcmp(var, "call-graph."))
192 var += sizeof("call-graph.") - 1;
194 if (!strcmp(var, "record-mode"))
195 return parse_callchain_record_opt(value, &callchain_param);
196 if (!strcmp(var, "dump-size")) {
197 unsigned long size = 0;
200 ret = get_stack_size(value, &size);
201 callchain_param.dump_size = size;
205 if (!strcmp(var, "print-type"))
206 return parse_callchain_mode(value);
207 if (!strcmp(var, "order"))
208 return parse_callchain_order(value);
209 if (!strcmp(var, "sort-key"))
210 return parse_callchain_sort_key(value);
211 if (!strcmp(var, "threshold")) {
212 callchain_param.min_percent = strtod(value, &endptr);
216 if (!strcmp(var, "print-limit")) {
217 callchain_param.print_limit = strtod(value, &endptr);
226 rb_insert_callchain(struct rb_root *root, struct callchain_node *chain,
227 enum chain_mode mode)
229 struct rb_node **p = &root->rb_node;
230 struct rb_node *parent = NULL;
231 struct callchain_node *rnode;
232 u64 chain_cumul = callchain_cumul_hits(chain);
238 rnode = rb_entry(parent, struct callchain_node, rb_node);
239 rnode_cumul = callchain_cumul_hits(rnode);
244 if (rnode->hit < chain->hit)
249 case CHAIN_GRAPH_ABS: /* Falldown */
250 case CHAIN_GRAPH_REL:
251 if (rnode_cumul < chain_cumul)
262 rb_link_node(&chain->rb_node, parent, p);
263 rb_insert_color(&chain->rb_node, root);
267 __sort_chain_flat(struct rb_root *rb_root, struct callchain_node *node,
271 struct callchain_node *child;
273 n = rb_first(&node->rb_root_in);
275 child = rb_entry(n, struct callchain_node, rb_node_in);
278 __sort_chain_flat(rb_root, child, min_hit);
281 if (node->hit && node->hit >= min_hit)
282 rb_insert_callchain(rb_root, node, CHAIN_FLAT);
286 * Once we get every callchains from the stream, we can now
290 sort_chain_flat(struct rb_root *rb_root, struct callchain_root *root,
291 u64 min_hit, struct callchain_param *param __maybe_unused)
294 __sort_chain_flat(rb_root, &root->node, min_hit);
297 static void __sort_chain_graph_abs(struct callchain_node *node,
301 struct callchain_node *child;
303 node->rb_root = RB_ROOT;
304 n = rb_first(&node->rb_root_in);
307 child = rb_entry(n, struct callchain_node, rb_node_in);
310 __sort_chain_graph_abs(child, min_hit);
311 if (callchain_cumul_hits(child) >= min_hit)
312 rb_insert_callchain(&node->rb_root, child,
318 sort_chain_graph_abs(struct rb_root *rb_root, struct callchain_root *chain_root,
319 u64 min_hit, struct callchain_param *param __maybe_unused)
321 __sort_chain_graph_abs(&chain_root->node, min_hit);
322 rb_root->rb_node = chain_root->node.rb_root.rb_node;
325 static void __sort_chain_graph_rel(struct callchain_node *node,
329 struct callchain_node *child;
332 node->rb_root = RB_ROOT;
333 min_hit = ceil(node->children_hit * min_percent);
335 n = rb_first(&node->rb_root_in);
337 child = rb_entry(n, struct callchain_node, rb_node_in);
340 __sort_chain_graph_rel(child, min_percent);
341 if (callchain_cumul_hits(child) >= min_hit)
342 rb_insert_callchain(&node->rb_root, child,
348 sort_chain_graph_rel(struct rb_root *rb_root, struct callchain_root *chain_root,
349 u64 min_hit __maybe_unused, struct callchain_param *param)
351 __sort_chain_graph_rel(&chain_root->node, param->min_percent / 100.0);
352 rb_root->rb_node = chain_root->node.rb_root.rb_node;
355 int callchain_register_param(struct callchain_param *param)
357 switch (param->mode) {
358 case CHAIN_GRAPH_ABS:
359 param->sort = sort_chain_graph_abs;
361 case CHAIN_GRAPH_REL:
362 param->sort = sort_chain_graph_rel;
366 param->sort = sort_chain_flat;
376 * Create a child for a parent. If inherit_children, then the new child
377 * will become the new parent of it's parent children
379 static struct callchain_node *
380 create_child(struct callchain_node *parent, bool inherit_children)
382 struct callchain_node *new;
384 new = zalloc(sizeof(*new));
386 perror("not enough memory to create child for code path tree");
389 new->parent = parent;
390 INIT_LIST_HEAD(&new->val);
391 INIT_LIST_HEAD(&new->parent_val);
393 if (inherit_children) {
395 struct callchain_node *child;
397 new->rb_root_in = parent->rb_root_in;
398 parent->rb_root_in = RB_ROOT;
400 n = rb_first(&new->rb_root_in);
402 child = rb_entry(n, struct callchain_node, rb_node_in);
407 /* make it the first child */
408 rb_link_node(&new->rb_node_in, NULL, &parent->rb_root_in.rb_node);
409 rb_insert_color(&new->rb_node_in, &parent->rb_root_in);
417 * Fill the node with callchain values
420 fill_node(struct callchain_node *node, struct callchain_cursor *cursor)
422 struct callchain_cursor_node *cursor_node;
424 node->val_nr = cursor->nr - cursor->pos;
426 pr_warning("Warning: empty node in callchain tree\n");
428 cursor_node = callchain_cursor_current(cursor);
430 while (cursor_node) {
431 struct callchain_list *call;
433 call = zalloc(sizeof(*call));
435 perror("not enough memory for the code path tree");
438 call->ip = cursor_node->ip;
439 call->ms.sym = cursor_node->sym;
440 call->ms.map = map__get(cursor_node->map);
441 list_add_tail(&call->list, &node->val);
443 callchain_cursor_advance(cursor);
444 cursor_node = callchain_cursor_current(cursor);
449 static struct callchain_node *
450 add_child(struct callchain_node *parent,
451 struct callchain_cursor *cursor,
454 struct callchain_node *new;
456 new = create_child(parent, false);
460 if (fill_node(new, cursor) < 0) {
461 struct callchain_list *call, *tmp;
463 list_for_each_entry_safe(call, tmp, &new->val, list) {
464 list_del(&call->list);
465 map__zput(call->ms.map);
472 new->children_hit = 0;
474 new->children_count = 0;
486 static enum match_result match_chain(struct callchain_cursor_node *node,
487 struct callchain_list *cnode)
489 struct symbol *sym = node->sym;
492 if (cnode->ms.sym && sym &&
493 callchain_param.key == CCKEY_FUNCTION) {
494 left = cnode->ms.sym->start;
504 return left > right ? MATCH_GT : MATCH_LT;
508 * Split the parent in two parts (a new child is created) and
509 * give a part of its callchain to the created child.
510 * Then create another child to host the given callchain of new branch
513 split_add_child(struct callchain_node *parent,
514 struct callchain_cursor *cursor,
515 struct callchain_list *to_split,
516 u64 idx_parents, u64 idx_local, u64 period)
518 struct callchain_node *new;
519 struct list_head *old_tail;
520 unsigned int idx_total = idx_parents + idx_local;
523 new = create_child(parent, true);
527 /* split the callchain and move a part to the new child */
528 old_tail = parent->val.prev;
529 list_del_range(&to_split->list, old_tail);
530 new->val.next = &to_split->list;
531 new->val.prev = old_tail;
532 to_split->list.prev = &new->val;
533 old_tail->next = &new->val;
536 new->hit = parent->hit;
537 new->children_hit = parent->children_hit;
538 parent->children_hit = callchain_cumul_hits(new);
539 new->val_nr = parent->val_nr - idx_local;
540 parent->val_nr = idx_local;
541 new->count = parent->count;
542 new->children_count = parent->children_count;
543 parent->children_count = callchain_cumul_counts(new);
545 /* create a new child for the new branch if any */
546 if (idx_total < cursor->nr) {
547 struct callchain_node *first;
548 struct callchain_list *cnode;
549 struct callchain_cursor_node *node;
550 struct rb_node *p, **pp;
553 parent->children_hit += period;
555 parent->children_count += 1;
557 node = callchain_cursor_current(cursor);
558 new = add_child(parent, cursor, period);
563 * This is second child since we moved parent's children
564 * to new (first) child above.
566 p = parent->rb_root_in.rb_node;
567 first = rb_entry(p, struct callchain_node, rb_node_in);
568 cnode = list_first_entry(&first->val, struct callchain_list,
571 if (match_chain(node, cnode) == MATCH_LT)
576 rb_link_node(&new->rb_node_in, p, pp);
577 rb_insert_color(&new->rb_node_in, &parent->rb_root_in);
579 parent->hit = period;
585 static enum match_result
586 append_chain(struct callchain_node *root,
587 struct callchain_cursor *cursor,
591 append_chain_children(struct callchain_node *root,
592 struct callchain_cursor *cursor,
595 struct callchain_node *rnode;
596 struct callchain_cursor_node *node;
597 struct rb_node **p = &root->rb_root_in.rb_node;
598 struct rb_node *parent = NULL;
600 node = callchain_cursor_current(cursor);
604 /* lookup in childrens */
606 enum match_result ret;
609 rnode = rb_entry(parent, struct callchain_node, rb_node_in);
611 /* If at least first entry matches, rely to children */
612 ret = append_chain(rnode, cursor, period);
614 goto inc_children_hit;
615 if (ret == MATCH_ERROR)
619 p = &parent->rb_left;
621 p = &parent->rb_right;
623 /* nothing in children, add to the current node */
624 rnode = add_child(root, cursor, period);
628 rb_link_node(&rnode->rb_node_in, parent, p);
629 rb_insert_color(&rnode->rb_node_in, &root->rb_root_in);
632 root->children_hit += period;
633 root->children_count++;
637 static enum match_result
638 append_chain(struct callchain_node *root,
639 struct callchain_cursor *cursor,
642 struct callchain_list *cnode;
643 u64 start = cursor->pos;
646 enum match_result cmp = MATCH_ERROR;
649 * Lookup in the current node
650 * If we have a symbol, then compare the start to match
651 * anywhere inside a function, unless function
654 list_for_each_entry(cnode, &root->val, list) {
655 struct callchain_cursor_node *node;
657 node = callchain_cursor_current(cursor);
661 cmp = match_chain(node, cnode);
667 callchain_cursor_advance(cursor);
670 /* matches not, relay no the parent */
672 WARN_ONCE(cmp == MATCH_ERROR, "Chain comparison error\n");
676 matches = cursor->pos - start;
678 /* we match only a part of the node. Split it and add the new chain */
679 if (matches < root->val_nr) {
680 if (split_add_child(root, cursor, cnode, start, matches,
687 /* we match 100% of the path, increment the hit */
688 if (matches == root->val_nr && cursor->pos == cursor->nr) {
694 /* We match the node and still have a part remaining */
695 if (append_chain_children(root, cursor, period) < 0)
701 int callchain_append(struct callchain_root *root,
702 struct callchain_cursor *cursor,
708 callchain_cursor_commit(cursor);
710 if (append_chain_children(&root->node, cursor, period) < 0)
713 if (cursor->nr > root->max_depth)
714 root->max_depth = cursor->nr;
720 merge_chain_branch(struct callchain_cursor *cursor,
721 struct callchain_node *dst, struct callchain_node *src)
723 struct callchain_cursor_node **old_last = cursor->last;
724 struct callchain_node *child;
725 struct callchain_list *list, *next_list;
727 int old_pos = cursor->nr;
730 list_for_each_entry_safe(list, next_list, &src->val, list) {
731 callchain_cursor_append(cursor, list->ip,
732 list->ms.map, list->ms.sym);
733 list_del(&list->list);
734 map__zput(list->ms.map);
739 callchain_cursor_commit(cursor);
740 if (append_chain_children(dst, cursor, src->hit) < 0)
744 n = rb_first(&src->rb_root_in);
746 child = container_of(n, struct callchain_node, rb_node_in);
748 rb_erase(&child->rb_node_in, &src->rb_root_in);
750 err = merge_chain_branch(cursor, dst, child);
757 cursor->nr = old_pos;
758 cursor->last = old_last;
763 int callchain_merge(struct callchain_cursor *cursor,
764 struct callchain_root *dst, struct callchain_root *src)
766 return merge_chain_branch(cursor, &dst->node, &src->node);
769 int callchain_cursor_append(struct callchain_cursor *cursor,
770 u64 ip, struct map *map, struct symbol *sym)
772 struct callchain_cursor_node *node = *cursor->last;
775 node = calloc(1, sizeof(*node));
779 *cursor->last = node;
783 map__zput(node->map);
784 node->map = map__get(map);
789 cursor->last = &node->next;
794 int sample__resolve_callchain(struct perf_sample *sample,
795 struct callchain_cursor *cursor, struct symbol **parent,
796 struct perf_evsel *evsel, struct addr_location *al,
799 if (sample->callchain == NULL)
802 if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain ||
803 perf_hpp_list.parent) {
804 return thread__resolve_callchain(al->thread, cursor, evsel, sample,
805 parent, al, max_stack);
810 int hist_entry__append_callchain(struct hist_entry *he, struct perf_sample *sample)
812 if (!symbol_conf.use_callchain || sample->callchain == NULL)
814 return callchain_append(he->callchain, &callchain_cursor, sample->period);
817 int fill_callchain_info(struct addr_location *al, struct callchain_cursor_node *node,
818 bool hide_unresolved)
823 al->addr = node->map->map_ip(node->map, node->ip);
827 if (al->sym == NULL) {
834 if (al->map->groups == &al->machine->kmaps) {
835 if (machine__is_host(al->machine)) {
836 al->cpumode = PERF_RECORD_MISC_KERNEL;
839 al->cpumode = PERF_RECORD_MISC_GUEST_KERNEL;
843 if (machine__is_host(al->machine)) {
844 al->cpumode = PERF_RECORD_MISC_USER;
846 } else if (perf_guest) {
847 al->cpumode = PERF_RECORD_MISC_GUEST_USER;
850 al->cpumode = PERF_RECORD_MISC_HYPERVISOR;
859 char *callchain_list__sym_name(struct callchain_list *cl,
860 char *bf, size_t bfsize, bool show_dso)
865 if (callchain_param.key == CCKEY_ADDRESS &&
866 cl->ms.map && !cl->srcline)
867 cl->srcline = get_srcline(cl->ms.map->dso,
868 map__rip_2objdump(cl->ms.map,
872 printed = scnprintf(bf, bfsize, "%s %s",
873 cl->ms.sym->name, cl->srcline);
875 printed = scnprintf(bf, bfsize, "%s", cl->ms.sym->name);
877 printed = scnprintf(bf, bfsize, "%#" PRIx64, cl->ip);
880 scnprintf(bf + printed, bfsize - printed, " %s",
882 cl->ms.map->dso->short_name :
888 char *callchain_node__scnprintf_value(struct callchain_node *node,
889 char *bf, size_t bfsize, u64 total)
891 double percent = 0.0;
892 u64 period = callchain_cumul_hits(node);
893 unsigned count = callchain_cumul_counts(node);
895 if (callchain_param.mode == CHAIN_FOLDED) {
900 switch (callchain_param.value) {
902 scnprintf(bf, bfsize, "%"PRIu64, period);
905 scnprintf(bf, bfsize, "%u", count);
910 percent = period * 100.0 / total;
911 scnprintf(bf, bfsize, "%.2f%%", percent);
917 int callchain_node__fprintf_value(struct callchain_node *node,
920 double percent = 0.0;
921 u64 period = callchain_cumul_hits(node);
922 unsigned count = callchain_cumul_counts(node);
924 if (callchain_param.mode == CHAIN_FOLDED) {
929 switch (callchain_param.value) {
931 return fprintf(fp, "%"PRIu64, period);
933 return fprintf(fp, "%u", count);
937 percent = period * 100.0 / total;
938 return percent_color_fprintf(fp, "%.2f%%", percent);
943 static void free_callchain_node(struct callchain_node *node)
945 struct callchain_list *list, *tmp;
946 struct callchain_node *child;
949 list_for_each_entry_safe(list, tmp, &node->parent_val, list) {
950 list_del(&list->list);
951 map__zput(list->ms.map);
955 list_for_each_entry_safe(list, tmp, &node->val, list) {
956 list_del(&list->list);
957 map__zput(list->ms.map);
961 n = rb_first(&node->rb_root_in);
963 child = container_of(n, struct callchain_node, rb_node_in);
965 rb_erase(&child->rb_node_in, &node->rb_root_in);
967 free_callchain_node(child);
972 void free_callchain(struct callchain_root *root)
974 if (!symbol_conf.use_callchain)
977 free_callchain_node(&root->node);
980 static u64 decay_callchain_node(struct callchain_node *node)
982 struct callchain_node *child;
986 n = rb_first(&node->rb_root_in);
988 child = container_of(n, struct callchain_node, rb_node_in);
990 child_hits += decay_callchain_node(child);
994 node->hit = (node->hit * 7) / 8;
995 node->children_hit = child_hits;
1000 void decay_callchain(struct callchain_root *root)
1002 if (!symbol_conf.use_callchain)
1005 decay_callchain_node(&root->node);
1008 int callchain_node__make_parent_list(struct callchain_node *node)
1010 struct callchain_node *parent = node->parent;
1011 struct callchain_list *chain, *new;
1015 list_for_each_entry_reverse(chain, &parent->val, list) {
1016 new = malloc(sizeof(*new));
1020 new->has_children = false;
1021 map__get(new->ms.map);
1022 list_add_tail(&new->list, &head);
1024 parent = parent->parent;
1027 list_for_each_entry_safe_reverse(chain, new, &head, list)
1028 list_move_tail(&chain->list, &node->parent_val);
1030 if (!list_empty(&node->parent_val)) {
1031 chain = list_first_entry(&node->parent_val, struct callchain_list, list);
1032 chain->has_children = rb_prev(&node->rb_node) || rb_next(&node->rb_node);
1034 chain = list_first_entry(&node->val, struct callchain_list, list);
1035 chain->has_children = false;
1040 list_for_each_entry_safe(chain, new, &head, list) {
1041 list_del(&chain->list);
1042 map__zput(chain->ms.map);