Loading...
1// SPDX-License-Identifier: GPL-2.0
2#include "util/debug.h"
3#include "util/dso.h"
4#include "util/event.h"
5#include "util/map.h"
6#include "util/symbol.h"
7#include "util/sort.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>
16
17struct sample {
18 u32 cpu;
19 u32 pid;
20 u64 ip;
21 struct thread *thread;
22 struct map *map;
23 struct symbol *sym;
24};
25
26/* For the numbers, see hists_common.c */
27static struct sample fake_samples[] = {
28 /* perf [kernel] schedule() */
29 { .cpu = 0, .pid = FAKE_PID_PERF1, .ip = FAKE_IP_KERNEL_SCHEDULE, },
30 /* perf [perf] main() */
31 { .cpu = 1, .pid = FAKE_PID_PERF1, .ip = FAKE_IP_PERF_MAIN, },
32 /* perf [perf] cmd_record() */
33 { .cpu = 1, .pid = FAKE_PID_PERF1, .ip = FAKE_IP_PERF_CMD_RECORD, },
34 /* perf [libc] malloc() */
35 { .cpu = 1, .pid = FAKE_PID_PERF1, .ip = FAKE_IP_LIBC_MALLOC, },
36 /* perf [libc] free() */
37 { .cpu = 2, .pid = FAKE_PID_PERF1, .ip = FAKE_IP_LIBC_FREE, },
38 /* perf [perf] main() */
39 { .cpu = 2, .pid = FAKE_PID_PERF2, .ip = FAKE_IP_PERF_MAIN, },
40 /* perf [kernel] page_fault() */
41 { .cpu = 2, .pid = FAKE_PID_PERF2, .ip = FAKE_IP_KERNEL_PAGE_FAULT, },
42 /* bash [bash] main() */
43 { .cpu = 3, .pid = FAKE_PID_BASH, .ip = FAKE_IP_BASH_MAIN, },
44 /* bash [bash] xmalloc() */
45 { .cpu = 0, .pid = FAKE_PID_BASH, .ip = FAKE_IP_BASH_XMALLOC, },
46 /* bash [kernel] page_fault() */
47 { .cpu = 1, .pid = FAKE_PID_BASH, .ip = FAKE_IP_KERNEL_PAGE_FAULT, },
48};
49
50static int add_hist_entries(struct hists *hists, struct machine *machine)
51{
52 struct addr_location al;
53 struct evsel *evsel = hists_to_evsel(hists);
54 struct perf_sample sample = { .period = 100, };
55 size_t i;
56
57 for (i = 0; i < ARRAY_SIZE(fake_samples); i++) {
58 struct hist_entry_iter iter = {
59 .evsel = evsel,
60 .sample = &sample,
61 .ops = &hist_iter_normal,
62 .hide_unresolved = false,
63 };
64
65 sample.cpumode = PERF_RECORD_MISC_USER;
66 sample.cpu = fake_samples[i].cpu;
67 sample.pid = fake_samples[i].pid;
68 sample.tid = fake_samples[i].pid;
69 sample.ip = fake_samples[i].ip;
70
71 if (machine__resolve(machine, &al, &sample) < 0)
72 goto out;
73
74 if (hist_entry_iter__add(&iter, &al, sysctl_perf_event_max_stack,
75 NULL) < 0) {
76 addr_location__put(&al);
77 goto out;
78 }
79
80 fake_samples[i].thread = al.thread;
81 fake_samples[i].map = al.map;
82 fake_samples[i].sym = al.sym;
83 }
84
85 return TEST_OK;
86
87out:
88 pr_debug("Not enough memory for adding a hist entry\n");
89 return TEST_FAIL;
90}
91
92static void del_hist_entries(struct hists *hists)
93{
94 struct hist_entry *he;
95 struct rb_root_cached *root_in;
96 struct rb_root_cached *root_out;
97 struct rb_node *node;
98
99 if (hists__has(hists, need_collapse))
100 root_in = &hists->entries_collapsed;
101 else
102 root_in = hists->entries_in;
103
104 root_out = &hists->entries;
105
106 while (!RB_EMPTY_ROOT(&root_out->rb_root)) {
107 node = rb_first_cached(root_out);
108
109 he = rb_entry(node, struct hist_entry, rb_node);
110 rb_erase_cached(node, root_out);
111 rb_erase_cached(&he->rb_node_in, root_in);
112 hist_entry__delete(he);
113 }
114}
115
116typedef int (*test_fn_t)(struct evsel *, struct machine *);
117
118#define COMM(he) (thread__comm_str(he->thread))
119#define DSO(he) (he->ms.map->dso->short_name)
120#define SYM(he) (he->ms.sym->name)
121#define CPU(he) (he->cpu)
122#define PID(he) (he->thread->tid)
123
124/* default sort keys (no field) */
125static int test1(struct evsel *evsel, struct machine *machine)
126{
127 int err;
128 struct hists *hists = evsel__hists(evsel);
129 struct hist_entry *he;
130 struct rb_root_cached *root;
131 struct rb_node *node;
132
133 field_order = NULL;
134 sort_order = NULL; /* equivalent to sort_order = "comm,dso,sym" */
135
136 setup_sorting(NULL);
137
138 /*
139 * expected output:
140 *
141 * Overhead Command Shared Object Symbol
142 * ======== ======= ============= ==============
143 * 20.00% perf perf [.] main
144 * 10.00% bash [kernel] [k] page_fault
145 * 10.00% bash bash [.] main
146 * 10.00% bash bash [.] xmalloc
147 * 10.00% perf [kernel] [k] page_fault
148 * 10.00% perf [kernel] [k] schedule
149 * 10.00% perf libc [.] free
150 * 10.00% perf libc [.] malloc
151 * 10.00% perf perf [.] cmd_record
152 */
153 err = add_hist_entries(hists, machine);
154 if (err < 0)
155 goto out;
156
157 hists__collapse_resort(hists, NULL);
158 perf_evsel__output_resort(evsel, NULL);
159
160 if (verbose > 2) {
161 pr_info("[fields = %s, sort = %s]\n", field_order, sort_order);
162 print_hists_out(hists);
163 }
164
165 root = &hists->entries;
166 node = rb_first_cached(root);
167 he = rb_entry(node, struct hist_entry, rb_node);
168 TEST_ASSERT_VAL("Invalid hist entry",
169 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "perf") &&
170 !strcmp(SYM(he), "main") && he->stat.period == 200);
171
172 node = rb_next(node);
173 he = rb_entry(node, struct hist_entry, rb_node);
174 TEST_ASSERT_VAL("Invalid hist entry",
175 !strcmp(COMM(he), "bash") && !strcmp(DSO(he), "[kernel]") &&
176 !strcmp(SYM(he), "page_fault") && he->stat.period == 100);
177
178 node = rb_next(node);
179 he = rb_entry(node, struct hist_entry, rb_node);
180 TEST_ASSERT_VAL("Invalid hist entry",
181 !strcmp(COMM(he), "bash") && !strcmp(DSO(he), "bash") &&
182 !strcmp(SYM(he), "main") && he->stat.period == 100);
183
184 node = rb_next(node);
185 he = rb_entry(node, struct hist_entry, rb_node);
186 TEST_ASSERT_VAL("Invalid hist entry",
187 !strcmp(COMM(he), "bash") && !strcmp(DSO(he), "bash") &&
188 !strcmp(SYM(he), "xmalloc") && he->stat.period == 100);
189
190 node = rb_next(node);
191 he = rb_entry(node, struct hist_entry, rb_node);
192 TEST_ASSERT_VAL("Invalid hist entry",
193 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "[kernel]") &&
194 !strcmp(SYM(he), "page_fault") && he->stat.period == 100);
195
196 node = rb_next(node);
197 he = rb_entry(node, struct hist_entry, rb_node);
198 TEST_ASSERT_VAL("Invalid hist entry",
199 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "[kernel]") &&
200 !strcmp(SYM(he), "schedule") && he->stat.period == 100);
201
202 node = rb_next(node);
203 he = rb_entry(node, struct hist_entry, rb_node);
204 TEST_ASSERT_VAL("Invalid hist entry",
205 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "libc") &&
206 !strcmp(SYM(he), "free") && he->stat.period == 100);
207
208 node = rb_next(node);
209 he = rb_entry(node, struct hist_entry, rb_node);
210 TEST_ASSERT_VAL("Invalid hist entry",
211 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "libc") &&
212 !strcmp(SYM(he), "malloc") && he->stat.period == 100);
213
214 node = rb_next(node);
215 he = rb_entry(node, struct hist_entry, rb_node);
216 TEST_ASSERT_VAL("Invalid hist entry",
217 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "perf") &&
218 !strcmp(SYM(he), "cmd_record") && he->stat.period == 100);
219
220out:
221 del_hist_entries(hists);
222 reset_output_field();
223 return err;
224}
225
226/* mixed fields and sort keys */
227static int test2(struct evsel *evsel, struct machine *machine)
228{
229 int err;
230 struct hists *hists = evsel__hists(evsel);
231 struct hist_entry *he;
232 struct rb_root_cached *root;
233 struct rb_node *node;
234
235 field_order = "overhead,cpu";
236 sort_order = "pid";
237
238 setup_sorting(NULL);
239
240 /*
241 * expected output:
242 *
243 * Overhead CPU Command: Pid
244 * ======== === =============
245 * 30.00% 1 perf : 100
246 * 10.00% 0 perf : 100
247 * 10.00% 2 perf : 100
248 * 20.00% 2 perf : 200
249 * 10.00% 0 bash : 300
250 * 10.00% 1 bash : 300
251 * 10.00% 3 bash : 300
252 */
253 err = add_hist_entries(hists, machine);
254 if (err < 0)
255 goto out;
256
257 hists__collapse_resort(hists, NULL);
258 perf_evsel__output_resort(evsel, NULL);
259
260 if (verbose > 2) {
261 pr_info("[fields = %s, sort = %s]\n", field_order, sort_order);
262 print_hists_out(hists);
263 }
264
265 root = &hists->entries;
266 node = rb_first_cached(root);
267 he = rb_entry(node, struct hist_entry, rb_node);
268 TEST_ASSERT_VAL("Invalid hist entry",
269 CPU(he) == 1 && PID(he) == 100 && he->stat.period == 300);
270
271 node = rb_next(node);
272 he = rb_entry(node, struct hist_entry, rb_node);
273 TEST_ASSERT_VAL("Invalid hist entry",
274 CPU(he) == 0 && PID(he) == 100 && he->stat.period == 100);
275
276out:
277 del_hist_entries(hists);
278 reset_output_field();
279 return err;
280}
281
282/* fields only (no sort key) */
283static int test3(struct evsel *evsel, struct machine *machine)
284{
285 int err;
286 struct hists *hists = evsel__hists(evsel);
287 struct hist_entry *he;
288 struct rb_root_cached *root;
289 struct rb_node *node;
290
291 field_order = "comm,overhead,dso";
292 sort_order = NULL;
293
294 setup_sorting(NULL);
295
296 /*
297 * expected output:
298 *
299 * Command Overhead Shared Object
300 * ======= ======== =============
301 * bash 20.00% bash
302 * bash 10.00% [kernel]
303 * perf 30.00% perf
304 * perf 20.00% [kernel]
305 * perf 20.00% libc
306 */
307 err = add_hist_entries(hists, machine);
308 if (err < 0)
309 goto out;
310
311 hists__collapse_resort(hists, NULL);
312 perf_evsel__output_resort(evsel, NULL);
313
314 if (verbose > 2) {
315 pr_info("[fields = %s, sort = %s]\n", field_order, sort_order);
316 print_hists_out(hists);
317 }
318
319 root = &hists->entries;
320 node = rb_first_cached(root);
321 he = rb_entry(node, struct hist_entry, rb_node);
322 TEST_ASSERT_VAL("Invalid hist entry",
323 !strcmp(COMM(he), "bash") && !strcmp(DSO(he), "bash") &&
324 he->stat.period == 200);
325
326 node = rb_next(node);
327 he = rb_entry(node, struct hist_entry, rb_node);
328 TEST_ASSERT_VAL("Invalid hist entry",
329 !strcmp(COMM(he), "bash") && !strcmp(DSO(he), "[kernel]") &&
330 he->stat.period == 100);
331
332 node = rb_next(node);
333 he = rb_entry(node, struct hist_entry, rb_node);
334 TEST_ASSERT_VAL("Invalid hist entry",
335 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "perf") &&
336 he->stat.period == 300);
337
338 node = rb_next(node);
339 he = rb_entry(node, struct hist_entry, rb_node);
340 TEST_ASSERT_VAL("Invalid hist entry",
341 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "[kernel]") &&
342 he->stat.period == 200);
343
344 node = rb_next(node);
345 he = rb_entry(node, struct hist_entry, rb_node);
346 TEST_ASSERT_VAL("Invalid hist entry",
347 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "libc") &&
348 he->stat.period == 200);
349
350out:
351 del_hist_entries(hists);
352 reset_output_field();
353 return err;
354}
355
356/* handle duplicate 'dso' field */
357static int test4(struct evsel *evsel, struct machine *machine)
358{
359 int err;
360 struct hists *hists = evsel__hists(evsel);
361 struct hist_entry *he;
362 struct rb_root_cached *root;
363 struct rb_node *node;
364
365 field_order = "dso,sym,comm,overhead,dso";
366 sort_order = "sym";
367
368 setup_sorting(NULL);
369
370 /*
371 * expected output:
372 *
373 * Shared Object Symbol Command Overhead
374 * ============= ============== ======= ========
375 * perf [.] cmd_record perf 10.00%
376 * libc [.] free perf 10.00%
377 * bash [.] main bash 10.00%
378 * perf [.] main perf 20.00%
379 * libc [.] malloc perf 10.00%
380 * [kernel] [k] page_fault bash 10.00%
381 * [kernel] [k] page_fault perf 10.00%
382 * [kernel] [k] schedule perf 10.00%
383 * bash [.] xmalloc bash 10.00%
384 */
385 err = add_hist_entries(hists, machine);
386 if (err < 0)
387 goto out;
388
389 hists__collapse_resort(hists, NULL);
390 perf_evsel__output_resort(evsel, NULL);
391
392 if (verbose > 2) {
393 pr_info("[fields = %s, sort = %s]\n", field_order, sort_order);
394 print_hists_out(hists);
395 }
396
397 root = &hists->entries;
398 node = rb_first_cached(root);
399 he = rb_entry(node, struct hist_entry, rb_node);
400 TEST_ASSERT_VAL("Invalid hist entry",
401 !strcmp(DSO(he), "perf") && !strcmp(SYM(he), "cmd_record") &&
402 !strcmp(COMM(he), "perf") && he->stat.period == 100);
403
404 node = rb_next(node);
405 he = rb_entry(node, struct hist_entry, rb_node);
406 TEST_ASSERT_VAL("Invalid hist entry",
407 !strcmp(DSO(he), "libc") && !strcmp(SYM(he), "free") &&
408 !strcmp(COMM(he), "perf") && he->stat.period == 100);
409
410 node = rb_next(node);
411 he = rb_entry(node, struct hist_entry, rb_node);
412 TEST_ASSERT_VAL("Invalid hist entry",
413 !strcmp(DSO(he), "bash") && !strcmp(SYM(he), "main") &&
414 !strcmp(COMM(he), "bash") && he->stat.period == 100);
415
416 node = rb_next(node);
417 he = rb_entry(node, struct hist_entry, rb_node);
418 TEST_ASSERT_VAL("Invalid hist entry",
419 !strcmp(DSO(he), "perf") && !strcmp(SYM(he), "main") &&
420 !strcmp(COMM(he), "perf") && he->stat.period == 200);
421
422 node = rb_next(node);
423 he = rb_entry(node, struct hist_entry, rb_node);
424 TEST_ASSERT_VAL("Invalid hist entry",
425 !strcmp(DSO(he), "libc") && !strcmp(SYM(he), "malloc") &&
426 !strcmp(COMM(he), "perf") && he->stat.period == 100);
427
428 node = rb_next(node);
429 he = rb_entry(node, struct hist_entry, rb_node);
430 TEST_ASSERT_VAL("Invalid hist entry",
431 !strcmp(DSO(he), "[kernel]") && !strcmp(SYM(he), "page_fault") &&
432 !strcmp(COMM(he), "bash") && he->stat.period == 100);
433
434 node = rb_next(node);
435 he = rb_entry(node, struct hist_entry, rb_node);
436 TEST_ASSERT_VAL("Invalid hist entry",
437 !strcmp(DSO(he), "[kernel]") && !strcmp(SYM(he), "page_fault") &&
438 !strcmp(COMM(he), "perf") && he->stat.period == 100);
439
440 node = rb_next(node);
441 he = rb_entry(node, struct hist_entry, rb_node);
442 TEST_ASSERT_VAL("Invalid hist entry",
443 !strcmp(DSO(he), "[kernel]") && !strcmp(SYM(he), "schedule") &&
444 !strcmp(COMM(he), "perf") && he->stat.period == 100);
445
446 node = rb_next(node);
447 he = rb_entry(node, struct hist_entry, rb_node);
448 TEST_ASSERT_VAL("Invalid hist entry",
449 !strcmp(DSO(he), "bash") && !strcmp(SYM(he), "xmalloc") &&
450 !strcmp(COMM(he), "bash") && he->stat.period == 100);
451
452out:
453 del_hist_entries(hists);
454 reset_output_field();
455 return err;
456}
457
458/* full sort keys w/o overhead field */
459static int test5(struct evsel *evsel, struct machine *machine)
460{
461 int err;
462 struct hists *hists = evsel__hists(evsel);
463 struct hist_entry *he;
464 struct rb_root_cached *root;
465 struct rb_node *node;
466
467 field_order = "cpu,pid,comm,dso,sym";
468 sort_order = "dso,pid";
469
470 setup_sorting(NULL);
471
472 /*
473 * expected output:
474 *
475 * CPU Command: Pid Command Shared Object Symbol
476 * === ============= ======= ============= ==============
477 * 0 perf: 100 perf [kernel] [k] schedule
478 * 2 perf: 200 perf [kernel] [k] page_fault
479 * 1 bash: 300 bash [kernel] [k] page_fault
480 * 0 bash: 300 bash bash [.] xmalloc
481 * 3 bash: 300 bash bash [.] main
482 * 1 perf: 100 perf libc [.] malloc
483 * 2 perf: 100 perf libc [.] free
484 * 1 perf: 100 perf perf [.] cmd_record
485 * 1 perf: 100 perf perf [.] main
486 * 2 perf: 200 perf perf [.] main
487 */
488 err = add_hist_entries(hists, machine);
489 if (err < 0)
490 goto out;
491
492 hists__collapse_resort(hists, NULL);
493 perf_evsel__output_resort(evsel, NULL);
494
495 if (verbose > 2) {
496 pr_info("[fields = %s, sort = %s]\n", field_order, sort_order);
497 print_hists_out(hists);
498 }
499
500 root = &hists->entries;
501 node = rb_first_cached(root);
502 he = rb_entry(node, struct hist_entry, rb_node);
503
504 TEST_ASSERT_VAL("Invalid hist entry",
505 CPU(he) == 0 && PID(he) == 100 &&
506 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "[kernel]") &&
507 !strcmp(SYM(he), "schedule") && he->stat.period == 100);
508
509 node = rb_next(node);
510 he = rb_entry(node, struct hist_entry, rb_node);
511 TEST_ASSERT_VAL("Invalid hist entry",
512 CPU(he) == 2 && PID(he) == 200 &&
513 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "[kernel]") &&
514 !strcmp(SYM(he), "page_fault") && he->stat.period == 100);
515
516 node = rb_next(node);
517 he = rb_entry(node, struct hist_entry, rb_node);
518 TEST_ASSERT_VAL("Invalid hist entry",
519 CPU(he) == 1 && PID(he) == 300 &&
520 !strcmp(COMM(he), "bash") && !strcmp(DSO(he), "[kernel]") &&
521 !strcmp(SYM(he), "page_fault") && he->stat.period == 100);
522
523 node = rb_next(node);
524 he = rb_entry(node, struct hist_entry, rb_node);
525 TEST_ASSERT_VAL("Invalid hist entry",
526 CPU(he) == 0 && PID(he) == 300 &&
527 !strcmp(COMM(he), "bash") && !strcmp(DSO(he), "bash") &&
528 !strcmp(SYM(he), "xmalloc") && he->stat.period == 100);
529
530 node = rb_next(node);
531 he = rb_entry(node, struct hist_entry, rb_node);
532 TEST_ASSERT_VAL("Invalid hist entry",
533 CPU(he) == 3 && PID(he) == 300 &&
534 !strcmp(COMM(he), "bash") && !strcmp(DSO(he), "bash") &&
535 !strcmp(SYM(he), "main") && he->stat.period == 100);
536
537 node = rb_next(node);
538 he = rb_entry(node, struct hist_entry, rb_node);
539 TEST_ASSERT_VAL("Invalid hist entry",
540 CPU(he) == 1 && PID(he) == 100 &&
541 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "libc") &&
542 !strcmp(SYM(he), "malloc") && he->stat.period == 100);
543
544 node = rb_next(node);
545 he = rb_entry(node, struct hist_entry, rb_node);
546 TEST_ASSERT_VAL("Invalid hist entry",
547 CPU(he) == 2 && PID(he) == 100 &&
548 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "libc") &&
549 !strcmp(SYM(he), "free") && he->stat.period == 100);
550
551 node = rb_next(node);
552 he = rb_entry(node, struct hist_entry, rb_node);
553 TEST_ASSERT_VAL("Invalid hist entry",
554 CPU(he) == 1 && PID(he) == 100 &&
555 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "perf") &&
556 !strcmp(SYM(he), "cmd_record") && he->stat.period == 100);
557
558 node = rb_next(node);
559 he = rb_entry(node, struct hist_entry, rb_node);
560 TEST_ASSERT_VAL("Invalid hist entry",
561 CPU(he) == 1 && PID(he) == 100 &&
562 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "perf") &&
563 !strcmp(SYM(he), "main") && he->stat.period == 100);
564
565 node = rb_next(node);
566 he = rb_entry(node, struct hist_entry, rb_node);
567 TEST_ASSERT_VAL("Invalid hist entry",
568 CPU(he) == 2 && PID(he) == 200 &&
569 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "perf") &&
570 !strcmp(SYM(he), "main") && he->stat.period == 100);
571
572out:
573 del_hist_entries(hists);
574 reset_output_field();
575 return err;
576}
577
578int test__hists_output(struct test *test __maybe_unused, int subtest __maybe_unused)
579{
580 int err = TEST_FAIL;
581 struct machines machines;
582 struct machine *machine;
583 struct evsel *evsel;
584 struct evlist *evlist = evlist__new();
585 size_t i;
586 test_fn_t testcases[] = {
587 test1,
588 test2,
589 test3,
590 test4,
591 test5,
592 };
593
594 TEST_ASSERT_VAL("No memory", evlist);
595
596 err = parse_events(evlist, "cpu-clock", NULL);
597 if (err)
598 goto out;
599 err = TEST_FAIL;
600
601 machines__init(&machines);
602
603 /* setup threads/dso/map/symbols also */
604 machine = setup_fake_machine(&machines);
605 if (!machine)
606 goto out;
607
608 if (verbose > 1)
609 machine__fprintf(machine, stderr);
610
611 evsel = evlist__first(evlist);
612
613 for (i = 0; i < ARRAY_SIZE(testcases); i++) {
614 err = testcases[i](evsel, machine);
615 if (err < 0)
616 break;
617 }
618
619out:
620 /* tear down everything */
621 evlist__delete(evlist);
622 machines__exit(&machines);
623
624 return err;
625}
1// SPDX-License-Identifier: GPL-2.0
2#include "perf.h"
3#include "util/debug.h"
4#include "util/event.h"
5#include "util/symbol.h"
6#include "util/sort.h"
7#include "util/evsel.h"
8#include "util/evlist.h"
9#include "util/machine.h"
10#include "util/thread.h"
11#include "util/parse-events.h"
12#include "tests/tests.h"
13#include "tests/hists_common.h"
14#include <linux/kernel.h>
15
16struct sample {
17 u32 cpu;
18 u32 pid;
19 u64 ip;
20 struct thread *thread;
21 struct map *map;
22 struct symbol *sym;
23};
24
25/* For the numbers, see hists_common.c */
26static struct sample fake_samples[] = {
27 /* perf [kernel] schedule() */
28 { .cpu = 0, .pid = FAKE_PID_PERF1, .ip = FAKE_IP_KERNEL_SCHEDULE, },
29 /* perf [perf] main() */
30 { .cpu = 1, .pid = FAKE_PID_PERF1, .ip = FAKE_IP_PERF_MAIN, },
31 /* perf [perf] cmd_record() */
32 { .cpu = 1, .pid = FAKE_PID_PERF1, .ip = FAKE_IP_PERF_CMD_RECORD, },
33 /* perf [libc] malloc() */
34 { .cpu = 1, .pid = FAKE_PID_PERF1, .ip = FAKE_IP_LIBC_MALLOC, },
35 /* perf [libc] free() */
36 { .cpu = 2, .pid = FAKE_PID_PERF1, .ip = FAKE_IP_LIBC_FREE, },
37 /* perf [perf] main() */
38 { .cpu = 2, .pid = FAKE_PID_PERF2, .ip = FAKE_IP_PERF_MAIN, },
39 /* perf [kernel] page_fault() */
40 { .cpu = 2, .pid = FAKE_PID_PERF2, .ip = FAKE_IP_KERNEL_PAGE_FAULT, },
41 /* bash [bash] main() */
42 { .cpu = 3, .pid = FAKE_PID_BASH, .ip = FAKE_IP_BASH_MAIN, },
43 /* bash [bash] xmalloc() */
44 { .cpu = 0, .pid = FAKE_PID_BASH, .ip = FAKE_IP_BASH_XMALLOC, },
45 /* bash [kernel] page_fault() */
46 { .cpu = 1, .pid = FAKE_PID_BASH, .ip = FAKE_IP_KERNEL_PAGE_FAULT, },
47};
48
49static int add_hist_entries(struct hists *hists, struct machine *machine)
50{
51 struct addr_location al;
52 struct perf_evsel *evsel = hists_to_evsel(hists);
53 struct perf_sample sample = { .period = 100, };
54 size_t i;
55
56 for (i = 0; i < ARRAY_SIZE(fake_samples); i++) {
57 struct hist_entry_iter iter = {
58 .evsel = evsel,
59 .sample = &sample,
60 .ops = &hist_iter_normal,
61 .hide_unresolved = false,
62 };
63
64 sample.cpumode = PERF_RECORD_MISC_USER;
65 sample.cpu = fake_samples[i].cpu;
66 sample.pid = fake_samples[i].pid;
67 sample.tid = fake_samples[i].pid;
68 sample.ip = fake_samples[i].ip;
69
70 if (machine__resolve(machine, &al, &sample) < 0)
71 goto out;
72
73 if (hist_entry_iter__add(&iter, &al, sysctl_perf_event_max_stack,
74 NULL) < 0) {
75 addr_location__put(&al);
76 goto out;
77 }
78
79 fake_samples[i].thread = al.thread;
80 fake_samples[i].map = al.map;
81 fake_samples[i].sym = al.sym;
82 }
83
84 return TEST_OK;
85
86out:
87 pr_debug("Not enough memory for adding a hist entry\n");
88 return TEST_FAIL;
89}
90
91static void del_hist_entries(struct hists *hists)
92{
93 struct hist_entry *he;
94 struct rb_root *root_in;
95 struct rb_root *root_out;
96 struct rb_node *node;
97
98 if (hists__has(hists, need_collapse))
99 root_in = &hists->entries_collapsed;
100 else
101 root_in = hists->entries_in;
102
103 root_out = &hists->entries;
104
105 while (!RB_EMPTY_ROOT(root_out)) {
106 node = rb_first(root_out);
107
108 he = rb_entry(node, struct hist_entry, rb_node);
109 rb_erase(node, root_out);
110 rb_erase(&he->rb_node_in, root_in);
111 hist_entry__delete(he);
112 }
113}
114
115typedef int (*test_fn_t)(struct perf_evsel *, struct machine *);
116
117#define COMM(he) (thread__comm_str(he->thread))
118#define DSO(he) (he->ms.map->dso->short_name)
119#define SYM(he) (he->ms.sym->name)
120#define CPU(he) (he->cpu)
121#define PID(he) (he->thread->tid)
122
123/* default sort keys (no field) */
124static int test1(struct perf_evsel *evsel, struct machine *machine)
125{
126 int err;
127 struct hists *hists = evsel__hists(evsel);
128 struct hist_entry *he;
129 struct rb_root *root;
130 struct rb_node *node;
131
132 field_order = NULL;
133 sort_order = NULL; /* equivalent to sort_order = "comm,dso,sym" */
134
135 setup_sorting(NULL);
136
137 /*
138 * expected output:
139 *
140 * Overhead Command Shared Object Symbol
141 * ======== ======= ============= ==============
142 * 20.00% perf perf [.] main
143 * 10.00% bash [kernel] [k] page_fault
144 * 10.00% bash bash [.] main
145 * 10.00% bash bash [.] xmalloc
146 * 10.00% perf [kernel] [k] page_fault
147 * 10.00% perf [kernel] [k] schedule
148 * 10.00% perf libc [.] free
149 * 10.00% perf libc [.] malloc
150 * 10.00% perf perf [.] cmd_record
151 */
152 err = add_hist_entries(hists, machine);
153 if (err < 0)
154 goto out;
155
156 hists__collapse_resort(hists, NULL);
157 perf_evsel__output_resort(evsel, NULL);
158
159 if (verbose > 2) {
160 pr_info("[fields = %s, sort = %s]\n", field_order, sort_order);
161 print_hists_out(hists);
162 }
163
164 root = &hists->entries;
165 node = rb_first(root);
166 he = rb_entry(node, struct hist_entry, rb_node);
167 TEST_ASSERT_VAL("Invalid hist entry",
168 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "perf") &&
169 !strcmp(SYM(he), "main") && he->stat.period == 200);
170
171 node = rb_next(node);
172 he = rb_entry(node, struct hist_entry, rb_node);
173 TEST_ASSERT_VAL("Invalid hist entry",
174 !strcmp(COMM(he), "bash") && !strcmp(DSO(he), "[kernel]") &&
175 !strcmp(SYM(he), "page_fault") && he->stat.period == 100);
176
177 node = rb_next(node);
178 he = rb_entry(node, struct hist_entry, rb_node);
179 TEST_ASSERT_VAL("Invalid hist entry",
180 !strcmp(COMM(he), "bash") && !strcmp(DSO(he), "bash") &&
181 !strcmp(SYM(he), "main") && he->stat.period == 100);
182
183 node = rb_next(node);
184 he = rb_entry(node, struct hist_entry, rb_node);
185 TEST_ASSERT_VAL("Invalid hist entry",
186 !strcmp(COMM(he), "bash") && !strcmp(DSO(he), "bash") &&
187 !strcmp(SYM(he), "xmalloc") && he->stat.period == 100);
188
189 node = rb_next(node);
190 he = rb_entry(node, struct hist_entry, rb_node);
191 TEST_ASSERT_VAL("Invalid hist entry",
192 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "[kernel]") &&
193 !strcmp(SYM(he), "page_fault") && he->stat.period == 100);
194
195 node = rb_next(node);
196 he = rb_entry(node, struct hist_entry, rb_node);
197 TEST_ASSERT_VAL("Invalid hist entry",
198 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "[kernel]") &&
199 !strcmp(SYM(he), "schedule") && he->stat.period == 100);
200
201 node = rb_next(node);
202 he = rb_entry(node, struct hist_entry, rb_node);
203 TEST_ASSERT_VAL("Invalid hist entry",
204 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "libc") &&
205 !strcmp(SYM(he), "free") && he->stat.period == 100);
206
207 node = rb_next(node);
208 he = rb_entry(node, struct hist_entry, rb_node);
209 TEST_ASSERT_VAL("Invalid hist entry",
210 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "libc") &&
211 !strcmp(SYM(he), "malloc") && he->stat.period == 100);
212
213 node = rb_next(node);
214 he = rb_entry(node, struct hist_entry, rb_node);
215 TEST_ASSERT_VAL("Invalid hist entry",
216 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "perf") &&
217 !strcmp(SYM(he), "cmd_record") && he->stat.period == 100);
218
219out:
220 del_hist_entries(hists);
221 reset_output_field();
222 return err;
223}
224
225/* mixed fields and sort keys */
226static int test2(struct perf_evsel *evsel, struct machine *machine)
227{
228 int err;
229 struct hists *hists = evsel__hists(evsel);
230 struct hist_entry *he;
231 struct rb_root *root;
232 struct rb_node *node;
233
234 field_order = "overhead,cpu";
235 sort_order = "pid";
236
237 setup_sorting(NULL);
238
239 /*
240 * expected output:
241 *
242 * Overhead CPU Command: Pid
243 * ======== === =============
244 * 30.00% 1 perf : 100
245 * 10.00% 0 perf : 100
246 * 10.00% 2 perf : 100
247 * 20.00% 2 perf : 200
248 * 10.00% 0 bash : 300
249 * 10.00% 1 bash : 300
250 * 10.00% 3 bash : 300
251 */
252 err = add_hist_entries(hists, machine);
253 if (err < 0)
254 goto out;
255
256 hists__collapse_resort(hists, NULL);
257 perf_evsel__output_resort(evsel, NULL);
258
259 if (verbose > 2) {
260 pr_info("[fields = %s, sort = %s]\n", field_order, sort_order);
261 print_hists_out(hists);
262 }
263
264 root = &hists->entries;
265 node = rb_first(root);
266 he = rb_entry(node, struct hist_entry, rb_node);
267 TEST_ASSERT_VAL("Invalid hist entry",
268 CPU(he) == 1 && PID(he) == 100 && he->stat.period == 300);
269
270 node = rb_next(node);
271 he = rb_entry(node, struct hist_entry, rb_node);
272 TEST_ASSERT_VAL("Invalid hist entry",
273 CPU(he) == 0 && PID(he) == 100 && he->stat.period == 100);
274
275out:
276 del_hist_entries(hists);
277 reset_output_field();
278 return err;
279}
280
281/* fields only (no sort key) */
282static int test3(struct perf_evsel *evsel, struct machine *machine)
283{
284 int err;
285 struct hists *hists = evsel__hists(evsel);
286 struct hist_entry *he;
287 struct rb_root *root;
288 struct rb_node *node;
289
290 field_order = "comm,overhead,dso";
291 sort_order = NULL;
292
293 setup_sorting(NULL);
294
295 /*
296 * expected output:
297 *
298 * Command Overhead Shared Object
299 * ======= ======== =============
300 * bash 20.00% bash
301 * bash 10.00% [kernel]
302 * perf 30.00% perf
303 * perf 20.00% [kernel]
304 * perf 20.00% libc
305 */
306 err = add_hist_entries(hists, machine);
307 if (err < 0)
308 goto out;
309
310 hists__collapse_resort(hists, NULL);
311 perf_evsel__output_resort(evsel, NULL);
312
313 if (verbose > 2) {
314 pr_info("[fields = %s, sort = %s]\n", field_order, sort_order);
315 print_hists_out(hists);
316 }
317
318 root = &hists->entries;
319 node = rb_first(root);
320 he = rb_entry(node, struct hist_entry, rb_node);
321 TEST_ASSERT_VAL("Invalid hist entry",
322 !strcmp(COMM(he), "bash") && !strcmp(DSO(he), "bash") &&
323 he->stat.period == 200);
324
325 node = rb_next(node);
326 he = rb_entry(node, struct hist_entry, rb_node);
327 TEST_ASSERT_VAL("Invalid hist entry",
328 !strcmp(COMM(he), "bash") && !strcmp(DSO(he), "[kernel]") &&
329 he->stat.period == 100);
330
331 node = rb_next(node);
332 he = rb_entry(node, struct hist_entry, rb_node);
333 TEST_ASSERT_VAL("Invalid hist entry",
334 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "perf") &&
335 he->stat.period == 300);
336
337 node = rb_next(node);
338 he = rb_entry(node, struct hist_entry, rb_node);
339 TEST_ASSERT_VAL("Invalid hist entry",
340 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "[kernel]") &&
341 he->stat.period == 200);
342
343 node = rb_next(node);
344 he = rb_entry(node, struct hist_entry, rb_node);
345 TEST_ASSERT_VAL("Invalid hist entry",
346 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "libc") &&
347 he->stat.period == 200);
348
349out:
350 del_hist_entries(hists);
351 reset_output_field();
352 return err;
353}
354
355/* handle duplicate 'dso' field */
356static int test4(struct perf_evsel *evsel, struct machine *machine)
357{
358 int err;
359 struct hists *hists = evsel__hists(evsel);
360 struct hist_entry *he;
361 struct rb_root *root;
362 struct rb_node *node;
363
364 field_order = "dso,sym,comm,overhead,dso";
365 sort_order = "sym";
366
367 setup_sorting(NULL);
368
369 /*
370 * expected output:
371 *
372 * Shared Object Symbol Command Overhead
373 * ============= ============== ======= ========
374 * perf [.] cmd_record perf 10.00%
375 * libc [.] free perf 10.00%
376 * bash [.] main bash 10.00%
377 * perf [.] main perf 20.00%
378 * libc [.] malloc perf 10.00%
379 * [kernel] [k] page_fault bash 10.00%
380 * [kernel] [k] page_fault perf 10.00%
381 * [kernel] [k] schedule perf 10.00%
382 * bash [.] xmalloc bash 10.00%
383 */
384 err = add_hist_entries(hists, machine);
385 if (err < 0)
386 goto out;
387
388 hists__collapse_resort(hists, NULL);
389 perf_evsel__output_resort(evsel, NULL);
390
391 if (verbose > 2) {
392 pr_info("[fields = %s, sort = %s]\n", field_order, sort_order);
393 print_hists_out(hists);
394 }
395
396 root = &hists->entries;
397 node = rb_first(root);
398 he = rb_entry(node, struct hist_entry, rb_node);
399 TEST_ASSERT_VAL("Invalid hist entry",
400 !strcmp(DSO(he), "perf") && !strcmp(SYM(he), "cmd_record") &&
401 !strcmp(COMM(he), "perf") && he->stat.period == 100);
402
403 node = rb_next(node);
404 he = rb_entry(node, struct hist_entry, rb_node);
405 TEST_ASSERT_VAL("Invalid hist entry",
406 !strcmp(DSO(he), "libc") && !strcmp(SYM(he), "free") &&
407 !strcmp(COMM(he), "perf") && he->stat.period == 100);
408
409 node = rb_next(node);
410 he = rb_entry(node, struct hist_entry, rb_node);
411 TEST_ASSERT_VAL("Invalid hist entry",
412 !strcmp(DSO(he), "bash") && !strcmp(SYM(he), "main") &&
413 !strcmp(COMM(he), "bash") && he->stat.period == 100);
414
415 node = rb_next(node);
416 he = rb_entry(node, struct hist_entry, rb_node);
417 TEST_ASSERT_VAL("Invalid hist entry",
418 !strcmp(DSO(he), "perf") && !strcmp(SYM(he), "main") &&
419 !strcmp(COMM(he), "perf") && he->stat.period == 200);
420
421 node = rb_next(node);
422 he = rb_entry(node, struct hist_entry, rb_node);
423 TEST_ASSERT_VAL("Invalid hist entry",
424 !strcmp(DSO(he), "libc") && !strcmp(SYM(he), "malloc") &&
425 !strcmp(COMM(he), "perf") && he->stat.period == 100);
426
427 node = rb_next(node);
428 he = rb_entry(node, struct hist_entry, rb_node);
429 TEST_ASSERT_VAL("Invalid hist entry",
430 !strcmp(DSO(he), "[kernel]") && !strcmp(SYM(he), "page_fault") &&
431 !strcmp(COMM(he), "bash") && he->stat.period == 100);
432
433 node = rb_next(node);
434 he = rb_entry(node, struct hist_entry, rb_node);
435 TEST_ASSERT_VAL("Invalid hist entry",
436 !strcmp(DSO(he), "[kernel]") && !strcmp(SYM(he), "page_fault") &&
437 !strcmp(COMM(he), "perf") && he->stat.period == 100);
438
439 node = rb_next(node);
440 he = rb_entry(node, struct hist_entry, rb_node);
441 TEST_ASSERT_VAL("Invalid hist entry",
442 !strcmp(DSO(he), "[kernel]") && !strcmp(SYM(he), "schedule") &&
443 !strcmp(COMM(he), "perf") && he->stat.period == 100);
444
445 node = rb_next(node);
446 he = rb_entry(node, struct hist_entry, rb_node);
447 TEST_ASSERT_VAL("Invalid hist entry",
448 !strcmp(DSO(he), "bash") && !strcmp(SYM(he), "xmalloc") &&
449 !strcmp(COMM(he), "bash") && he->stat.period == 100);
450
451out:
452 del_hist_entries(hists);
453 reset_output_field();
454 return err;
455}
456
457/* full sort keys w/o overhead field */
458static int test5(struct perf_evsel *evsel, struct machine *machine)
459{
460 int err;
461 struct hists *hists = evsel__hists(evsel);
462 struct hist_entry *he;
463 struct rb_root *root;
464 struct rb_node *node;
465
466 field_order = "cpu,pid,comm,dso,sym";
467 sort_order = "dso,pid";
468
469 setup_sorting(NULL);
470
471 /*
472 * expected output:
473 *
474 * CPU Command: Pid Command Shared Object Symbol
475 * === ============= ======= ============= ==============
476 * 0 perf: 100 perf [kernel] [k] schedule
477 * 2 perf: 200 perf [kernel] [k] page_fault
478 * 1 bash: 300 bash [kernel] [k] page_fault
479 * 0 bash: 300 bash bash [.] xmalloc
480 * 3 bash: 300 bash bash [.] main
481 * 1 perf: 100 perf libc [.] malloc
482 * 2 perf: 100 perf libc [.] free
483 * 1 perf: 100 perf perf [.] cmd_record
484 * 1 perf: 100 perf perf [.] main
485 * 2 perf: 200 perf perf [.] main
486 */
487 err = add_hist_entries(hists, machine);
488 if (err < 0)
489 goto out;
490
491 hists__collapse_resort(hists, NULL);
492 perf_evsel__output_resort(evsel, NULL);
493
494 if (verbose > 2) {
495 pr_info("[fields = %s, sort = %s]\n", field_order, sort_order);
496 print_hists_out(hists);
497 }
498
499 root = &hists->entries;
500 node = rb_first(root);
501 he = rb_entry(node, struct hist_entry, rb_node);
502
503 TEST_ASSERT_VAL("Invalid hist entry",
504 CPU(he) == 0 && PID(he) == 100 &&
505 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "[kernel]") &&
506 !strcmp(SYM(he), "schedule") && he->stat.period == 100);
507
508 node = rb_next(node);
509 he = rb_entry(node, struct hist_entry, rb_node);
510 TEST_ASSERT_VAL("Invalid hist entry",
511 CPU(he) == 2 && PID(he) == 200 &&
512 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "[kernel]") &&
513 !strcmp(SYM(he), "page_fault") && he->stat.period == 100);
514
515 node = rb_next(node);
516 he = rb_entry(node, struct hist_entry, rb_node);
517 TEST_ASSERT_VAL("Invalid hist entry",
518 CPU(he) == 1 && PID(he) == 300 &&
519 !strcmp(COMM(he), "bash") && !strcmp(DSO(he), "[kernel]") &&
520 !strcmp(SYM(he), "page_fault") && he->stat.period == 100);
521
522 node = rb_next(node);
523 he = rb_entry(node, struct hist_entry, rb_node);
524 TEST_ASSERT_VAL("Invalid hist entry",
525 CPU(he) == 0 && PID(he) == 300 &&
526 !strcmp(COMM(he), "bash") && !strcmp(DSO(he), "bash") &&
527 !strcmp(SYM(he), "xmalloc") && he->stat.period == 100);
528
529 node = rb_next(node);
530 he = rb_entry(node, struct hist_entry, rb_node);
531 TEST_ASSERT_VAL("Invalid hist entry",
532 CPU(he) == 3 && PID(he) == 300 &&
533 !strcmp(COMM(he), "bash") && !strcmp(DSO(he), "bash") &&
534 !strcmp(SYM(he), "main") && he->stat.period == 100);
535
536 node = rb_next(node);
537 he = rb_entry(node, struct hist_entry, rb_node);
538 TEST_ASSERT_VAL("Invalid hist entry",
539 CPU(he) == 1 && PID(he) == 100 &&
540 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "libc") &&
541 !strcmp(SYM(he), "malloc") && he->stat.period == 100);
542
543 node = rb_next(node);
544 he = rb_entry(node, struct hist_entry, rb_node);
545 TEST_ASSERT_VAL("Invalid hist entry",
546 CPU(he) == 2 && PID(he) == 100 &&
547 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "libc") &&
548 !strcmp(SYM(he), "free") && he->stat.period == 100);
549
550 node = rb_next(node);
551 he = rb_entry(node, struct hist_entry, rb_node);
552 TEST_ASSERT_VAL("Invalid hist entry",
553 CPU(he) == 1 && PID(he) == 100 &&
554 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "perf") &&
555 !strcmp(SYM(he), "cmd_record") && he->stat.period == 100);
556
557 node = rb_next(node);
558 he = rb_entry(node, struct hist_entry, rb_node);
559 TEST_ASSERT_VAL("Invalid hist entry",
560 CPU(he) == 1 && PID(he) == 100 &&
561 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "perf") &&
562 !strcmp(SYM(he), "main") && he->stat.period == 100);
563
564 node = rb_next(node);
565 he = rb_entry(node, struct hist_entry, rb_node);
566 TEST_ASSERT_VAL("Invalid hist entry",
567 CPU(he) == 2 && PID(he) == 200 &&
568 !strcmp(COMM(he), "perf") && !strcmp(DSO(he), "perf") &&
569 !strcmp(SYM(he), "main") && he->stat.period == 100);
570
571out:
572 del_hist_entries(hists);
573 reset_output_field();
574 return err;
575}
576
577int test__hists_output(struct test *test __maybe_unused, int subtest __maybe_unused)
578{
579 int err = TEST_FAIL;
580 struct machines machines;
581 struct machine *machine;
582 struct perf_evsel *evsel;
583 struct perf_evlist *evlist = perf_evlist__new();
584 size_t i;
585 test_fn_t testcases[] = {
586 test1,
587 test2,
588 test3,
589 test4,
590 test5,
591 };
592
593 TEST_ASSERT_VAL("No memory", evlist);
594
595 err = parse_events(evlist, "cpu-clock", NULL);
596 if (err)
597 goto out;
598 err = TEST_FAIL;
599
600 machines__init(&machines);
601
602 /* setup threads/dso/map/symbols also */
603 machine = setup_fake_machine(&machines);
604 if (!machine)
605 goto out;
606
607 if (verbose > 1)
608 machine__fprintf(machine, stderr);
609
610 evsel = perf_evlist__first(evlist);
611
612 for (i = 0; i < ARRAY_SIZE(testcases); i++) {
613 err = testcases[i](evsel, machine);
614 if (err < 0)
615 break;
616 }
617
618out:
619 /* tear down everything */
620 perf_evlist__delete(evlist);
621 machines__exit(&machines);
622
623 return err;
624}