1 /*
2 * Copyright (C) 2016 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 #include <gtest/gtest.h>
18
19 #include <android-base/file.h>
20 #include <android-base/strings.h>
21 #include <regex>
22
23 #include "command.h"
24 #include "get_test_data.h"
25
26 using namespace simpleperf;
27
ReportSampleCmd()28 static std::unique_ptr<Command> ReportSampleCmd() {
29 return CreateCommandInstance("report-sample");
30 }
31
TEST(cmd_report_sample,text)32 TEST(cmd_report_sample, text) {
33 ASSERT_TRUE(ReportSampleCmd()->Run({"-i", GetTestData(PERF_DATA_WITH_SYMBOLS)}));
34 }
35
TEST(cmd_report_sample,output_option)36 TEST(cmd_report_sample, output_option) {
37 TemporaryFile tmpfile;
38 ASSERT_TRUE(
39 ReportSampleCmd()->Run({"-i", GetTestData(PERF_DATA_WITH_SYMBOLS), "-o", tmpfile.path}));
40 }
41
TEST(cmd_report_sample,show_callchain_option)42 TEST(cmd_report_sample, show_callchain_option) {
43 TemporaryFile tmpfile;
44 ASSERT_TRUE(ReportSampleCmd()->Run(
45 {"-i", GetTestData(CALLGRAPH_FP_PERF_DATA), "-o", tmpfile.path, "--show-callchain"}));
46 }
47
GetProtobufReport(const std::string & test_data_file,std::string * protobuf_report,const std::vector<std::string> & extra_args={})48 static void GetProtobufReport(const std::string& test_data_file, std::string* protobuf_report,
49 const std::vector<std::string>& extra_args = {}) {
50 TemporaryFile tmpfile;
51 TemporaryFile tmpfile2;
52 std::vector<std::string> args = {"-i", GetTestData(test_data_file), "-o", tmpfile.path,
53 "--protobuf"};
54 args.insert(args.end(), extra_args.begin(), extra_args.end());
55 ASSERT_TRUE(ReportSampleCmd()->Run(args));
56 ASSERT_TRUE(
57 ReportSampleCmd()->Run({"--dump-protobuf-report", tmpfile.path, "-o", tmpfile2.path}));
58 ASSERT_TRUE(android::base::ReadFileToString(tmpfile2.path, protobuf_report));
59 }
60
TEST(cmd_report_sample,protobuf_option)61 TEST(cmd_report_sample, protobuf_option) {
62 std::string data;
63 GetProtobufReport(PERF_DATA_WITH_SYMBOLS, &data);
64 ASSERT_NE(data.find("magic: SIMPLEPERF"), std::string::npos);
65 ASSERT_NE(data.find("version: 1"), std::string::npos);
66 ASSERT_NE(data.find("file:"), std::string::npos);
67 }
68
TEST(cmd_report_sample,no_skipped_file_id)69 TEST(cmd_report_sample, no_skipped_file_id) {
70 std::string data;
71 GetProtobufReport(PERF_DATA_WITH_WRONG_IP_IN_CALLCHAIN, &data);
72 // If wrong ips in callchain are omitted, "unknown" file path will not be generated.
73 ASSERT_EQ(data.find("unknown"), std::string::npos);
74 }
75
TEST(cmd_report_sample,sample_has_event_count)76 TEST(cmd_report_sample, sample_has_event_count) {
77 std::string data;
78 GetProtobufReport(PERF_DATA_WITH_SYMBOLS, &data);
79 ASSERT_NE(data.find("event_count:"), std::string::npos);
80 }
81
TEST(cmd_report_sample,has_thread_record)82 TEST(cmd_report_sample, has_thread_record) {
83 std::string data;
84 GetProtobufReport(PERF_DATA_WITH_SYMBOLS, &data);
85 ASSERT_NE(data.find("thread:"), std::string::npos);
86 ASSERT_NE(data.find("thread_name: t2"), std::string::npos);
87 }
88
TEST(cmd_report_sample,trace_offcpu)89 TEST(cmd_report_sample, trace_offcpu) {
90 std::string data;
91 GetProtobufReport("perf_with_trace_offcpu_v2.data", &data);
92 ASSERT_NE(data.find("event_type: sched:sched_switch"), std::string::npos);
93 ASSERT_NE(data.find("trace_offcpu: true"), std::string::npos);
94 std::vector<std::vector<std::string>> cases = {
95 {"context_switch:", "switch_on: true", "time: 676374949239318", "thread_id: 6525"},
96 {"context_switch:", "switch_on: false", "time: 676374953363850", "thread_id: 6525"},
97 };
98 for (auto& test_case : cases) {
99 auto pattern = std::regex(android::base::Join(test_case, R"((\s|\n|\r)+)"));
100 ASSERT_TRUE(std::regex_search(data, pattern));
101 }
102 }
103
TEST(cmd_report_sample,have_clear_callchain_end_in_protobuf_output)104 TEST(cmd_report_sample, have_clear_callchain_end_in_protobuf_output) {
105 std::string data;
106 GetProtobufReport("perf_with_trace_offcpu_v2.data", &data, {"--show-callchain"});
107 ASSERT_NE(data.find("__libc_init"), std::string::npos);
108 ASSERT_EQ(data.find("_start_main"), std::string::npos);
109 }
110
TEST(cmd_report_sample,app_device_info_in_meta_info)111 TEST(cmd_report_sample, app_device_info_in_meta_info) {
112 std::string data;
113 GetProtobufReport("perf_with_meta_info.data", &data);
114 ASSERT_NE(data.find("app_package_name: com.google.sample.tunnel"), std::string::npos);
115 ASSERT_NE(data.find("app_type: debuggable"), std::string::npos);
116 ASSERT_NE(data.find("android_sdk_version: 30"), std::string::npos);
117 ASSERT_NE(data.find("android_build_type: userdebug"), std::string::npos);
118 }
119
TEST(cmd_report_sample,remove_unknown_kernel_symbols)120 TEST(cmd_report_sample, remove_unknown_kernel_symbols) {
121 std::string data;
122 // Test --remove-unknown-kernel-symbols on perf.data with kernel_symbols_available=false.
123 GetProtobufReport(PERF_DATA_WITH_KERNEL_SYMBOLS_AVAILABLE_FALSE, &data, {"--show-callchain"});
124 ASSERT_NE(data.find("time: 1368182962424044"), std::string::npos);
125 ASSERT_NE(data.find("path: [kernel.kallsyms]"), std::string::npos);
126 ASSERT_NE(data.find("path: /system/lib64/libc.so"), std::string::npos);
127 GetProtobufReport(PERF_DATA_WITH_KERNEL_SYMBOLS_AVAILABLE_FALSE, &data,
128 {"--show-callchain", "--remove-unknown-kernel-symbols"});
129 // The sample dumped at time 1368182962424044 shouldn't be removed. Because it has user space
130 // callchains.
131 ASSERT_NE(data.find("time: 1368182962424044"), std::string::npos);
132 // Kernel callchains shouldn't be removed.
133 ASSERT_EQ(data.find("path: [kernel.kallsyms]"), std::string::npos);
134 // User space callchains still exist.
135 ASSERT_NE(data.find("path: /system/lib64/libc.so"), std::string::npos);
136
137 // Test --remove-unknown-kernel-symbols on perf.data with kernel_symbols_available=true.
138 GetProtobufReport(PERF_DATA_WITH_KERNEL_SYMBOLS_AVAILABLE_TRUE, &data, {"--show-callchain"});
139 ASSERT_NE(data.find("time: 1368297633794862"), std::string::npos);
140 ASSERT_NE(data.find("path: [kernel.kallsyms]"), std::string::npos);
141 ASSERT_NE(data.find("symbol: binder_ioctl_write_read"), std::string::npos);
142 ASSERT_NE(data.find("path: /system/lib64/libc.so"), std::string::npos);
143 GetProtobufReport(PERF_DATA_WITH_KERNEL_SYMBOLS_AVAILABLE_TRUE, &data,
144 {"--show-callchain", "--remove-unknown-kernel-symbols"});
145 ASSERT_NE(data.find("time: 1368297633794862"), std::string::npos);
146 ASSERT_NE(data.find("path: [kernel.kallsyms]"), std::string::npos);
147 ASSERT_NE(data.find("symbol: binder_ioctl_write_read"), std::string::npos);
148 ASSERT_NE(data.find("path: /system/lib64/libc.so"), std::string::npos);
149 }
150
TEST(cmd_report_sample,show_art_frames_option)151 TEST(cmd_report_sample, show_art_frames_option) {
152 std::string data;
153 GetProtobufReport(PERF_DATA_WITH_INTERPRETER_FRAMES, &data, {"--show-callchain"});
154 ASSERT_EQ(data.find("artMterpAsmInstructionStart"), std::string::npos);
155 GetProtobufReport(PERF_DATA_WITH_INTERPRETER_FRAMES, &data,
156 {"--show-callchain", "--show-art-frames"});
157 ASSERT_NE(data.find("artMterpAsmInstructionStart"), std::string::npos);
158 }
159
TEST(cmd_report_sample,show_execution_type_option)160 TEST(cmd_report_sample, show_execution_type_option) {
161 std::string data;
162 GetProtobufReport("perf_display_bitmaps.data", &data,
163 {"--show-callchain", "--show-execution-type"});
164 ASSERT_NE(data.find("execution_type: interpreted_jvm_method"), std::string::npos);
165 // We convert JIT frames to map to dex files. So there is no file named jit_app_cache in the
166 // report. But the execution type of a JIT frame isn't changed.
167 ASSERT_EQ(data.find("jit_app_cache"), std::string::npos);
168 ASSERT_NE(data.find("execution_type: jit_jvm_method"), std::string::npos);
169 // art_method is shown only when --show-art-frames is used.
170 ASSERT_EQ(data.find("execution_type: art_method"), std::string::npos);
171
172 GetProtobufReport("perf_display_bitmaps.data", &data,
173 {"--show-callchain", "--show-execution-type", "--show-art-frames"});
174 ASSERT_NE(data.find("execution_type: art_method"), std::string::npos);
175 }
176
TEST(cmd_report_sample,show_symbols_before_and_after_demangle)177 TEST(cmd_report_sample, show_symbols_before_and_after_demangle) {
178 std::string data;
179 GetProtobufReport(PERF_DATA_WITH_INTERPRETER_FRAMES, &data, {"--show-callchain"});
180 ASSERT_NE(data.find("symbol: android::hardware::IPCThreadState::talkWithDriver(bool)"),
181 std::string::npos);
182 ASSERT_NE(data.find("mangled_symbol: _ZN7android8hardware14IPCThreadState14talkWithDriverEb"),
183 std::string::npos);
184 }
185
TEST(cmd_report_sample,symdir_option)186 TEST(cmd_report_sample, symdir_option) {
187 std::string data;
188 GetProtobufReport(PERF_DATA_FOR_BUILD_ID_CHECK, &data);
189 ASSERT_EQ(data.find("symbol: main"), std::string::npos);
190 GetProtobufReport(PERF_DATA_FOR_BUILD_ID_CHECK, &data,
191 {"--symdir", GetTestDataDir() + CORRECT_SYMFS_FOR_BUILD_ID_CHECK});
192 ASSERT_NE(data.find("symbol: main"), std::string::npos);
193 }
194
TEST(cmd_report_sample,show_art_jni_methods)195 TEST(cmd_report_sample, show_art_jni_methods) {
196 std::string data;
197 GetProtobufReport("perf_display_bitmaps.data", &data, {"--show-callchain"});
198 ASSERT_NE(data.find("art::Method_invoke"), std::string::npos);
199 // Don't show art_jni_trampoline.
200 ASSERT_EQ(data.find("art_jni_trampoline"), std::string::npos);
201 }
202
TEST(cmd_report_sample,show_unwinding_result)203 TEST(cmd_report_sample, show_unwinding_result) {
204 std::string data;
205 GetProtobufReport("perf_with_failed_unwinding_debug_info.data", &data, {"--show-callchain"});
206 ASSERT_NE(data.find("error_code: ERROR_INVALID_MAP"), std::string::npos);
207 }
208
TEST(cmd_report_sample,proguard_mapping_file_option)209 TEST(cmd_report_sample, proguard_mapping_file_option) {
210 std::string data;
211 // Symbols aren't de-obfuscated without proguard mapping file.
212 GetProtobufReport("perf_need_proguard_mapping.data", &data, {"--show-callchain"});
213 ASSERT_EQ(data.find("androidx.fragment.app.FragmentActivity.startActivityForResult"),
214 std::string::npos);
215 ASSERT_EQ(data.find("com.example.android.displayingbitmaps.ui.ImageGridFragment.onItemClick"),
216 std::string::npos);
217 // Symbols are de-obfuscated with proguard mapping file.
218 GetProtobufReport(
219 "perf_need_proguard_mapping.data", &data,
220 {"--show-callchain", "--proguard-mapping-file", GetTestData("proguard_mapping.txt")});
221 ASSERT_NE(data.find("androidx.fragment.app.FragmentActivity.startActivityForResult"),
222 std::string::npos);
223 ASSERT_NE(data.find("com.example.android.displayingbitmaps.ui.ImageGridFragment.onItemClick"),
224 std::string::npos);
225 }
226
TEST(cmd_report_sample,exclude_include_pid_options)227 TEST(cmd_report_sample, exclude_include_pid_options) {
228 std::string data;
229 GetProtobufReport("perf_display_bitmaps.data", &data, {"--exclude-pid", "31850"});
230 ASSERT_EQ(data.find("thread_id: 31850"), std::string::npos);
231
232 GetProtobufReport("perf_display_bitmaps.data", &data, {"--include-pid", "31850"});
233 ASSERT_NE(data.find("thread_id: 31850"), std::string::npos);
234 }
235
TEST(cmd_report_sample,exclude_include_tid_options)236 TEST(cmd_report_sample, exclude_include_tid_options) {
237 std::string data;
238 GetProtobufReport("perf_display_bitmaps.data", &data, {"--exclude-tid", "31881"});
239 ASSERT_EQ(data.find("thread_id: 31881"), std::string::npos);
240
241 GetProtobufReport("perf_display_bitmaps.data", &data, {"--include-tid", "31881"});
242 ASSERT_NE(data.find("thread_id: 31881"), std::string::npos);
243 }
244
TEST(cmd_report_sample,exclude_include_process_name_options)245 TEST(cmd_report_sample, exclude_include_process_name_options) {
246 std::string data;
247 GetProtobufReport("perf_display_bitmaps.data", &data,
248 {"--exclude-process-name", "com.example.android.displayingbitmaps"});
249 ASSERT_EQ(data.find("thread_id: 31881"), std::string::npos);
250
251 GetProtobufReport("perf_display_bitmaps.data", &data,
252 {"--include-process-name", "com.example.android.displayingbitmaps"});
253 ASSERT_NE(data.find("thread_id: 31881"), std::string::npos);
254 }
255
TEST(cmd_report_sample,exclude_include_thread_name_options)256 TEST(cmd_report_sample, exclude_include_thread_name_options) {
257 std::string data;
258 GetProtobufReport("perf_display_bitmaps.data", &data,
259 {"--exclude-thread-name", "com.example.android.displayingbitmaps"});
260 ASSERT_EQ(data.find("thread_id: 31850"), std::string::npos);
261
262 GetProtobufReport("perf_display_bitmaps.data", &data,
263 {"--include-thread-name", "com.example.android.displayingbitmaps"});
264 ASSERT_NE(data.find("thread_id: 31850"), std::string::npos);
265 }
266
TEST(cmd_report_sample,filter_file_option)267 TEST(cmd_report_sample, filter_file_option) {
268 std::string filter_data =
269 "GLOBAL_BEGIN 684943449406175\n"
270 "GLOBAL_END 684943449406176";
271 TemporaryFile tmpfile;
272 ASSERT_TRUE(android::base::WriteStringToFd(filter_data, tmpfile.fd));
273 std::string data;
274 GetProtobufReport("perf_display_bitmaps.data", &data, {"--filter-file", tmpfile.path});
275 ASSERT_NE(data.find("thread_id: 31881"), std::string::npos);
276 ASSERT_EQ(data.find("thread_id: 31850"), std::string::npos);
277 }
278