1 // SPDX-License-Identifier: GPL-2.0
2 #include "util/debug.h"
4 #include "util/event.h"
6 #include "util/symbol.h"
8 #include "util/evsel.h"
9 #include "util/evlist.h"
10 #include "util/machine.h"
11 #include "util/thread.h"
12 #include "util/parse-events.h"
13 #include "tests/tests.h"
14 #include "tests/hists_common.h"
15 #include <linux/kernel.h>
20 struct thread
*thread
;
25 /* For the numbers, see hists_common.c */
26 static struct sample fake_samples
[] = {
27 /* perf [kernel] schedule() */
28 { .pid
= FAKE_PID_PERF1
, .ip
= FAKE_IP_KERNEL_SCHEDULE
, },
29 /* perf [perf] main() */
30 { .pid
= FAKE_PID_PERF1
, .ip
= FAKE_IP_PERF_MAIN
, },
31 /* perf [perf] cmd_record() */
32 { .pid
= FAKE_PID_PERF1
, .ip
= FAKE_IP_PERF_CMD_RECORD
, },
33 /* perf [libc] malloc() */
34 { .pid
= FAKE_PID_PERF1
, .ip
= FAKE_IP_LIBC_MALLOC
, },
35 /* perf [libc] free() */
36 { .pid
= FAKE_PID_PERF1
, .ip
= FAKE_IP_LIBC_FREE
, },
37 /* perf [perf] main() */
38 { .pid
= FAKE_PID_PERF2
, .ip
= FAKE_IP_PERF_MAIN
, },
39 /* perf [kernel] page_fault() */
40 { .pid
= FAKE_PID_PERF2
, .ip
= FAKE_IP_KERNEL_PAGE_FAULT
, },
41 /* bash [bash] main() */
42 { .pid
= FAKE_PID_BASH
, .ip
= FAKE_IP_BASH_MAIN
, },
43 /* bash [bash] xmalloc() */
44 { .pid
= FAKE_PID_BASH
, .ip
= FAKE_IP_BASH_XMALLOC
, },
45 /* bash [kernel] page_fault() */
46 { .pid
= FAKE_PID_BASH
, .ip
= FAKE_IP_KERNEL_PAGE_FAULT
, },
50 * Will be casted to struct ip_callchain which has all 64 bit entries
53 static u64 fake_callchains
[][10] = {
54 /* schedule => run_command => main */
55 { 3, FAKE_IP_KERNEL_SCHEDULE
, FAKE_IP_PERF_RUN_COMMAND
, FAKE_IP_PERF_MAIN
, },
57 { 1, FAKE_IP_PERF_MAIN
, },
58 /* cmd_record => run_command => main */
59 { 3, FAKE_IP_PERF_CMD_RECORD
, FAKE_IP_PERF_RUN_COMMAND
, FAKE_IP_PERF_MAIN
, },
60 /* malloc => cmd_record => run_command => main */
61 { 4, FAKE_IP_LIBC_MALLOC
, FAKE_IP_PERF_CMD_RECORD
, FAKE_IP_PERF_RUN_COMMAND
,
63 /* free => cmd_record => run_command => main */
64 { 4, FAKE_IP_LIBC_FREE
, FAKE_IP_PERF_CMD_RECORD
, FAKE_IP_PERF_RUN_COMMAND
,
67 { 1, FAKE_IP_PERF_MAIN
, },
68 /* page_fault => sys_perf_event_open => run_command => main */
69 { 4, FAKE_IP_KERNEL_PAGE_FAULT
, FAKE_IP_KERNEL_SYS_PERF_EVENT_OPEN
,
70 FAKE_IP_PERF_RUN_COMMAND
, FAKE_IP_PERF_MAIN
, },
72 { 1, FAKE_IP_BASH_MAIN
, },
73 /* xmalloc => malloc => xmalloc => malloc => xmalloc => main */
74 { 6, FAKE_IP_BASH_XMALLOC
, FAKE_IP_LIBC_MALLOC
, FAKE_IP_BASH_XMALLOC
,
75 FAKE_IP_LIBC_MALLOC
, FAKE_IP_BASH_XMALLOC
, FAKE_IP_BASH_MAIN
, },
76 /* page_fault => malloc => main */
77 { 3, FAKE_IP_KERNEL_PAGE_FAULT
, FAKE_IP_LIBC_MALLOC
, FAKE_IP_BASH_MAIN
, },
80 static int add_hist_entries(struct hists
*hists
, struct machine
*machine
)
82 struct addr_location al
;
83 struct evsel
*evsel
= hists_to_evsel(hists
);
84 struct perf_sample sample
= { .period
= 1000, };
87 for (i
= 0; i
< ARRAY_SIZE(fake_samples
); i
++) {
88 struct hist_entry_iter iter
= {
91 .hide_unresolved
= false,
94 if (symbol_conf
.cumulate_callchain
)
95 iter
.ops
= &hist_iter_cumulative
;
97 iter
.ops
= &hist_iter_normal
;
99 sample
.cpumode
= PERF_RECORD_MISC_USER
;
100 sample
.pid
= fake_samples
[i
].pid
;
101 sample
.tid
= fake_samples
[i
].pid
;
102 sample
.ip
= fake_samples
[i
].ip
;
103 sample
.callchain
= (struct ip_callchain
*)fake_callchains
[i
];
105 if (machine__resolve(machine
, &al
, &sample
) < 0)
108 if (hist_entry_iter__add(&iter
, &al
, sysctl_perf_event_max_stack
,
110 addr_location__put(&al
);
114 fake_samples
[i
].thread
= al
.thread
;
115 fake_samples
[i
].map
= al
.map
;
116 fake_samples
[i
].sym
= al
.sym
;
122 pr_debug("Not enough memory for adding a hist entry\n");
126 static void del_hist_entries(struct hists
*hists
)
128 struct hist_entry
*he
;
129 struct rb_root_cached
*root_in
;
130 struct rb_root_cached
*root_out
;
131 struct rb_node
*node
;
133 if (hists__has(hists
, need_collapse
))
134 root_in
= &hists
->entries_collapsed
;
136 root_in
= hists
->entries_in
;
138 root_out
= &hists
->entries
;
140 while (!RB_EMPTY_ROOT(&root_out
->rb_root
)) {
141 node
= rb_first_cached(root_out
);
143 he
= rb_entry(node
, struct hist_entry
, rb_node
);
144 rb_erase_cached(node
, root_out
);
145 rb_erase_cached(&he
->rb_node_in
, root_in
);
146 hist_entry__delete(he
);
150 typedef int (*test_fn_t
)(struct evsel
*, struct machine
*);
152 #define COMM(he) (thread__comm_str(he->thread))
153 #define DSO(he) (he->ms.map->dso->short_name)
154 #define SYM(he) (he->ms.sym->name)
155 #define CPU(he) (he->cpu)
156 #define PID(he) (he->thread->tid)
157 #define DEPTH(he) (he->callchain->max_depth)
158 #define CDSO(cl) (cl->ms.map->dso->short_name)
159 #define CSYM(cl) (cl->ms.sym->name)
169 struct callchain_result
{
177 static int do_test(struct hists
*hists
, struct result
*expected
, size_t nr_expected
,
178 struct callchain_result
*expected_callchain
, size_t nr_callchain
)
182 struct hist_entry
*he
;
183 struct rb_root
*root
;
184 struct rb_node
*node
;
185 struct callchain_node
*cnode
;
186 struct callchain_list
*clist
;
189 * adding and deleting hist entries must be done outside of this
190 * function since TEST_ASSERT_VAL() returns in case of failure.
192 hists__collapse_resort(hists
, NULL
);
193 evsel__output_resort(hists_to_evsel(hists
), NULL
);
196 pr_info("use callchain: %d, cumulate callchain: %d\n",
197 symbol_conf
.use_callchain
,
198 symbol_conf
.cumulate_callchain
);
199 print_hists_out(hists
);
202 root
= &hists
->entries
.rb_root
;
203 for (node
= rb_first(root
), i
= 0;
204 node
&& (he
= rb_entry(node
, struct hist_entry
, rb_node
));
205 node
= rb_next(node
), i
++) {
206 scnprintf(buf
, sizeof(buf
), "Invalid hist entry #%zd", i
);
208 TEST_ASSERT_VAL("Incorrect number of hist entry",
210 TEST_ASSERT_VAL(buf
, he
->stat
.period
== expected
[i
].self
&&
211 !strcmp(COMM(he
), expected
[i
].comm
) &&
212 !strcmp(DSO(he
), expected
[i
].dso
) &&
213 !strcmp(SYM(he
), expected
[i
].sym
));
215 if (symbol_conf
.cumulate_callchain
)
216 TEST_ASSERT_VAL(buf
, he
->stat_acc
->period
== expected
[i
].children
);
218 if (!symbol_conf
.use_callchain
)
221 /* check callchain entries */
222 root
= &he
->callchain
->node
.rb_root
;
224 TEST_ASSERT_VAL("callchains expected", !RB_EMPTY_ROOT(root
));
225 cnode
= rb_entry(rb_first(root
), struct callchain_node
, rb_node
);
228 list_for_each_entry(clist
, &cnode
->val
, list
) {
229 scnprintf(buf
, sizeof(buf
), "Invalid callchain entry #%zd/%zd", i
, c
);
231 TEST_ASSERT_VAL("Incorrect number of callchain entry",
232 c
< expected_callchain
[i
].nr
);
234 !strcmp(CDSO(clist
), expected_callchain
[i
].node
[c
].dso
) &&
235 !strcmp(CSYM(clist
), expected_callchain
[i
].node
[c
].sym
));
238 /* TODO: handle multiple child nodes properly */
239 TEST_ASSERT_VAL("Incorrect number of callchain entry",
240 c
<= expected_callchain
[i
].nr
);
242 TEST_ASSERT_VAL("Incorrect number of hist entry",
244 TEST_ASSERT_VAL("Incorrect number of callchain entry",
245 !symbol_conf
.use_callchain
|| nr_expected
== nr_callchain
);
249 /* NO callchain + NO children */
250 static int test1(struct evsel
*evsel
, struct machine
*machine
)
253 struct hists
*hists
= evsel__hists(evsel
);
257 * Overhead Command Shared Object Symbol
258 * ======== ======= ============= ==============
259 * 20.00% perf perf [.] main
260 * 10.00% bash [kernel] [k] page_fault
261 * 10.00% bash bash [.] main
262 * 10.00% bash bash [.] xmalloc
263 * 10.00% perf [kernel] [k] page_fault
264 * 10.00% perf [kernel] [k] schedule
265 * 10.00% perf libc [.] free
266 * 10.00% perf libc [.] malloc
267 * 10.00% perf perf [.] cmd_record
269 struct result expected
[] = {
270 { 0, 2000, "perf", "perf", "main" },
271 { 0, 1000, "bash", "[kernel]", "page_fault" },
272 { 0, 1000, "bash", "bash", "main" },
273 { 0, 1000, "bash", "bash", "xmalloc" },
274 { 0, 1000, "perf", "[kernel]", "page_fault" },
275 { 0, 1000, "perf", "[kernel]", "schedule" },
276 { 0, 1000, "perf", "libc", "free" },
277 { 0, 1000, "perf", "libc", "malloc" },
278 { 0, 1000, "perf", "perf", "cmd_record" },
281 symbol_conf
.use_callchain
= false;
282 symbol_conf
.cumulate_callchain
= false;
283 evsel__reset_sample_bit(evsel
, CALLCHAIN
);
286 callchain_register_param(&callchain_param
);
288 err
= add_hist_entries(hists
, machine
);
292 err
= do_test(hists
, expected
, ARRAY_SIZE(expected
), NULL
, 0);
295 del_hist_entries(hists
);
296 reset_output_field();
300 /* callcain + NO children */
301 static int test2(struct evsel
*evsel
, struct machine
*machine
)
304 struct hists
*hists
= evsel__hists(evsel
);
308 * Overhead Command Shared Object Symbol
309 * ======== ======= ============= ==============
310 * 20.00% perf perf [.] main
314 * 10.00% bash [kernel] [k] page_fault
320 * 10.00% bash bash [.] main
324 * 10.00% bash bash [.] xmalloc
328 * xmalloc <--- NOTE: there's a cycle
333 * 10.00% perf [kernel] [k] page_fault
336 * sys_perf_event_open
340 * 10.00% perf [kernel] [k] schedule
346 * 10.00% perf libc [.] free
353 * 10.00% perf libc [.] malloc
360 * 10.00% perf perf [.] cmd_record
367 struct result expected
[] = {
368 { 0, 2000, "perf", "perf", "main" },
369 { 0, 1000, "bash", "[kernel]", "page_fault" },
370 { 0, 1000, "bash", "bash", "main" },
371 { 0, 1000, "bash", "bash", "xmalloc" },
372 { 0, 1000, "perf", "[kernel]", "page_fault" },
373 { 0, 1000, "perf", "[kernel]", "schedule" },
374 { 0, 1000, "perf", "libc", "free" },
375 { 0, 1000, "perf", "libc", "malloc" },
376 { 0, 1000, "perf", "perf", "cmd_record" },
378 struct callchain_result expected_callchain
[] = {
380 1, { { "perf", "main" }, },
383 3, { { "[kernel]", "page_fault" },
384 { "libc", "malloc" },
385 { "bash", "main" }, },
388 1, { { "bash", "main" }, },
391 6, { { "bash", "xmalloc" },
392 { "libc", "malloc" },
393 { "bash", "xmalloc" },
394 { "libc", "malloc" },
395 { "bash", "xmalloc" },
396 { "bash", "main" }, },
399 4, { { "[kernel]", "page_fault" },
400 { "[kernel]", "sys_perf_event_open" },
401 { "perf", "run_command" },
402 { "perf", "main" }, },
405 3, { { "[kernel]", "schedule" },
406 { "perf", "run_command" },
407 { "perf", "main" }, },
410 4, { { "libc", "free" },
411 { "perf", "cmd_record" },
412 { "perf", "run_command" },
413 { "perf", "main" }, },
416 4, { { "libc", "malloc" },
417 { "perf", "cmd_record" },
418 { "perf", "run_command" },
419 { "perf", "main" }, },
422 3, { { "perf", "cmd_record" },
423 { "perf", "run_command" },
424 { "perf", "main" }, },
428 symbol_conf
.use_callchain
= true;
429 symbol_conf
.cumulate_callchain
= false;
430 evsel__set_sample_bit(evsel
, CALLCHAIN
);
433 callchain_register_param(&callchain_param
);
435 err
= add_hist_entries(hists
, machine
);
439 err
= do_test(hists
, expected
, ARRAY_SIZE(expected
),
440 expected_callchain
, ARRAY_SIZE(expected_callchain
));
443 del_hist_entries(hists
);
444 reset_output_field();
448 /* NO callchain + children */
449 static int test3(struct evsel
*evsel
, struct machine
*machine
)
452 struct hists
*hists
= evsel__hists(evsel
);
456 * Children Self Command Shared Object Symbol
457 * ======== ======== ======= ============= =======================
458 * 70.00% 20.00% perf perf [.] main
459 * 50.00% 0.00% perf perf [.] run_command
460 * 30.00% 10.00% bash bash [.] main
461 * 30.00% 10.00% perf perf [.] cmd_record
462 * 20.00% 0.00% bash libc [.] malloc
463 * 10.00% 10.00% bash [kernel] [k] page_fault
464 * 10.00% 10.00% bash bash [.] xmalloc
465 * 10.00% 10.00% perf [kernel] [k] page_fault
466 * 10.00% 10.00% perf libc [.] malloc
467 * 10.00% 10.00% perf [kernel] [k] schedule
468 * 10.00% 10.00% perf libc [.] free
469 * 10.00% 0.00% perf [kernel] [k] sys_perf_event_open
471 struct result expected
[] = {
472 { 7000, 2000, "perf", "perf", "main" },
473 { 5000, 0, "perf", "perf", "run_command" },
474 { 3000, 1000, "bash", "bash", "main" },
475 { 3000, 1000, "perf", "perf", "cmd_record" },
476 { 2000, 0, "bash", "libc", "malloc" },
477 { 1000, 1000, "bash", "[kernel]", "page_fault" },
478 { 1000, 1000, "bash", "bash", "xmalloc" },
479 { 1000, 1000, "perf", "[kernel]", "page_fault" },
480 { 1000, 1000, "perf", "[kernel]", "schedule" },
481 { 1000, 1000, "perf", "libc", "free" },
482 { 1000, 1000, "perf", "libc", "malloc" },
483 { 1000, 0, "perf", "[kernel]", "sys_perf_event_open" },
486 symbol_conf
.use_callchain
= false;
487 symbol_conf
.cumulate_callchain
= true;
488 evsel__reset_sample_bit(evsel
, CALLCHAIN
);
491 callchain_register_param(&callchain_param
);
493 err
= add_hist_entries(hists
, machine
);
497 err
= do_test(hists
, expected
, ARRAY_SIZE(expected
), NULL
, 0);
500 del_hist_entries(hists
);
501 reset_output_field();
505 /* callchain + children */
506 static int test4(struct evsel
*evsel
, struct machine
*machine
)
509 struct hists
*hists
= evsel__hists(evsel
);
513 * Children Self Command Shared Object Symbol
514 * ======== ======== ======= ============= =======================
515 * 70.00% 20.00% perf perf [.] main
519 * 50.00% 0.00% perf perf [.] run_command
524 * 30.00% 10.00% bash bash [.] main
528 * 30.00% 10.00% perf perf [.] cmd_record
534 * 20.00% 0.00% bash libc [.] malloc
538 * |--50.00%-- xmalloc
542 * 10.00% 10.00% bash [kernel] [k] page_fault
548 * 10.00% 10.00% bash bash [.] xmalloc
552 * xmalloc <--- NOTE: there's a cycle
557 * 10.00% 0.00% perf [kernel] [k] sys_perf_event_open
559 * --- sys_perf_event_open
563 * 10.00% 10.00% perf [kernel] [k] page_fault
566 * sys_perf_event_open
570 * 10.00% 10.00% perf [kernel] [k] schedule
576 * 10.00% 10.00% perf libc [.] free
583 * 10.00% 10.00% perf libc [.] malloc
591 struct result expected
[] = {
592 { 7000, 2000, "perf", "perf", "main" },
593 { 5000, 0, "perf", "perf", "run_command" },
594 { 3000, 1000, "bash", "bash", "main" },
595 { 3000, 1000, "perf", "perf", "cmd_record" },
596 { 2000, 0, "bash", "libc", "malloc" },
597 { 1000, 1000, "bash", "[kernel]", "page_fault" },
598 { 1000, 1000, "bash", "bash", "xmalloc" },
599 { 1000, 0, "perf", "[kernel]", "sys_perf_event_open" },
600 { 1000, 1000, "perf", "[kernel]", "page_fault" },
601 { 1000, 1000, "perf", "[kernel]", "schedule" },
602 { 1000, 1000, "perf", "libc", "free" },
603 { 1000, 1000, "perf", "libc", "malloc" },
605 struct callchain_result expected_callchain
[] = {
607 1, { { "perf", "main" }, },
610 2, { { "perf", "run_command" },
611 { "perf", "main" }, },
614 1, { { "bash", "main" }, },
617 3, { { "perf", "cmd_record" },
618 { "perf", "run_command" },
619 { "perf", "main" }, },
622 4, { { "libc", "malloc" },
623 { "bash", "xmalloc" },
625 { "bash", "main" }, },
628 3, { { "[kernel]", "page_fault" },
629 { "libc", "malloc" },
630 { "bash", "main" }, },
633 6, { { "bash", "xmalloc" },
634 { "libc", "malloc" },
635 { "bash", "xmalloc" },
636 { "libc", "malloc" },
637 { "bash", "xmalloc" },
638 { "bash", "main" }, },
641 3, { { "[kernel]", "sys_perf_event_open" },
642 { "perf", "run_command" },
643 { "perf", "main" }, },
646 4, { { "[kernel]", "page_fault" },
647 { "[kernel]", "sys_perf_event_open" },
648 { "perf", "run_command" },
649 { "perf", "main" }, },
652 3, { { "[kernel]", "schedule" },
653 { "perf", "run_command" },
654 { "perf", "main" }, },
657 4, { { "libc", "free" },
658 { "perf", "cmd_record" },
659 { "perf", "run_command" },
660 { "perf", "main" }, },
663 4, { { "libc", "malloc" },
664 { "perf", "cmd_record" },
665 { "perf", "run_command" },
666 { "perf", "main" }, },
670 symbol_conf
.use_callchain
= true;
671 symbol_conf
.cumulate_callchain
= true;
672 evsel__set_sample_bit(evsel
, CALLCHAIN
);
676 callchain_param
= callchain_param_default
;
677 callchain_register_param(&callchain_param
);
679 err
= add_hist_entries(hists
, machine
);
683 err
= do_test(hists
, expected
, ARRAY_SIZE(expected
),
684 expected_callchain
, ARRAY_SIZE(expected_callchain
));
687 del_hist_entries(hists
);
688 reset_output_field();
692 int test__hists_cumulate(struct test
*test __maybe_unused
, int subtest __maybe_unused
)
695 struct machines machines
;
696 struct machine
*machine
;
698 struct evlist
*evlist
= evlist__new();
700 test_fn_t testcases
[] = {
707 TEST_ASSERT_VAL("No memory", evlist
);
709 err
= parse_events(evlist
, "cpu-clock", NULL
);
714 machines__init(&machines
);
716 /* setup threads/dso/map/symbols also */
717 machine
= setup_fake_machine(&machines
);
722 machine__fprintf(machine
, stderr
);
724 evsel
= evlist__first(evlist
);
726 for (i
= 0; i
< ARRAY_SIZE(testcases
); i
++) {
727 err
= testcases
[i
](evsel
, machine
);
733 /* tear down everything */
734 evlist__delete(evlist
);
735 machines__exit(&machines
);