summaryrefslogtreecommitdiff
path: root/simpleperf/scripts/test/report_sample_test.py
blob: 83f1d36be2b97f3daac73e99affe88a947de086c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
#!/usr/bin/env python3
#
# Copyright (C) 2021 The Android Open Source Project
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import os
import re
import tempfile
from typing import List, Optional, Set

from . test_utils import TestBase, TestHelper
from simpleperf_utils import remove


class TestReportSample(TestBase):
    def get_record_data_string(self, record_file: str, options: Optional[List[str]] = None):
        args = ['report_sample.py', '-i', TestHelper.testdata_path(record_file)]
        if options:
            args += options
        report = self.run_cmd(args, return_output=True)
        return report.replace('\r', '')

    def test_no_flags(self):
        got = self.get_record_data_string('perf_display_bitmaps.data')
        with open(TestHelper.testdata_path('perf_display_bitmaps.perf-script')) as f:
            want = f.read()
        self.assertEqual(got, want)

    def test_output_flag(self):
        # Test short form flag.
        remove('some.output')
        got = self.get_record_data_string('perf_display_bitmaps.data',
                                          ['-o', 'some.output'])
        self.assertEqual(got, '')
        self.check_exist(filename='some.output')

        # Test long form flag
        remove("some.output")
        got = self.get_record_data_string('perf_display_bitmaps.data',
                                          ['--output_file', 'some.output'])
        self.assertEqual(got, '')
        self.check_exist(filename="some.output")

        # Verify that the output file contains expected data
        with open(TestHelper.testdata_path('perf_display_bitmaps.perf-script')) as f:
            want = f.read()
        with open('some.output') as f:
            got = f.read()
        self.assertEqual(got, want)

        # Verify that an output spec of '-' is stdout
        remove("some.output")
        got = self.get_record_data_string('perf_display_bitmaps.data', ['-o', '-'])
        self.assertEqual(got, want)

    def test_comm_filter_to_renderthread(self):
        got = self.get_record_data_string('perf_display_bitmaps.data', ['--comm', 'RenderThread'])
        self.assertIn('RenderThread', got)
        self.assertNotIn('com.example.android.displayingbitmaps', got)

        with open(TestHelper.testdata_path('perf_display_bitmaps.RenderThread.perf-script')) as f:
            want = f.read()
        self.assertEqual(got, want)

    def test_comm_filter_to_ui_thread(self):
        got = self.get_record_data_string('perf_display_bitmaps.data', [
                                          '--comm', 'com.example.android.displayingbitmaps'])
        self.assertIn('com.example.android.displayingbitmaps', got)
        self.assertNotIn('RenderThread', got)
        with open(TestHelper.testdata_path('perf_display_bitmaps.UiThread.perf-script')) as f:
            want = f.read()
        self.assertEqual(got, want)

    def test_header(self):
        got = self.get_record_data_string('perf_display_bitmaps.data', ['--header'])
        with open(TestHelper.testdata_path('perf_display_bitmaps.header.perf-script')) as f:
            want = f.read()
        self.assertEqual(got, want)

    def test_trace_offcpu(self):
        got = self.get_record_data_string('perf_with_trace_offcpu_v2.data', [
                                          '--trace-offcpu', 'on-cpu'])
        self.assertIn('cpu-clock:u', got)
        self.assertNotIn('sched:sched_switch', got)

    def test_sample_filters(self):
        def get_threads_for_filter(filter: str) -> Set[int]:
            report = self.get_record_data_string('perf_display_bitmaps.data', filter.split())
            pattern = re.compile(r'\s+31850/(\d+)\s+')
            threads = set()
            for m in re.finditer(pattern, report):
                threads.add(int(m.group(1)))
            return threads

        self.assertNotIn(31850, get_threads_for_filter('--exclude-pid 31850'))
        self.assertIn(31850, get_threads_for_filter('--include-pid 31850'))
        self.assertIn(31850, get_threads_for_filter('--pid 31850'))
        self.assertNotIn(31881, get_threads_for_filter('--exclude-tid 31881'))
        self.assertIn(31881, get_threads_for_filter('--include-tid 31881'))
        self.assertIn(31881, get_threads_for_filter('--tid 31881'))
        self.assertNotIn(31881, get_threads_for_filter(
            '--exclude-process-name com.example.android.displayingbitmaps'))
        self.assertIn(31881, get_threads_for_filter(
            '--include-process-name com.example.android.displayingbitmaps'))
        self.assertNotIn(31850, get_threads_for_filter(
            '--exclude-thread-name com.example.android.displayingbitmaps'))
        self.assertIn(31850, get_threads_for_filter(
            '--include-thread-name com.example.android.displayingbitmaps'))

        with tempfile.NamedTemporaryFile('w', delete=False) as filter_file:
            filter_file.write('GLOBAL_BEGIN 684943449406175\nGLOBAL_END 684943449406176')
            filter_file.flush()
            threads = get_threads_for_filter('--filter-file ' + filter_file.name)
            self.assertIn(31881, threads)
            self.assertNotIn(31850, threads)
        os.unlink(filter_file.name)

    def test_show_art_frames(self):
        art_frame_str = 'art::interpreter::DoCall'
        report = self.get_record_data_string('perf_with_interpreter_frames.data')
        self.assertNotIn(art_frame_str, report)
        report = self.get_record_data_string(
            'perf_with_interpreter_frames.data', ['--show-art-frames'])
        self.assertIn(art_frame_str, report)