1 /*
2 * Copyright (C) 2020 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 "src/trace_processor/importers/proto/heap_graph_tracker.h"
18
19 #include "perfetto/base/logging.h"
20 #include "src/trace_processor/importers/common/process_tracker.h"
21 #include "src/trace_processor/importers/proto/profiler_util.h"
22 #include "test/gtest_and_gmock.h"
23
24 namespace perfetto {
25 namespace trace_processor {
26 namespace {
27
28 using ::testing::UnorderedElementsAre;
29
TEST(HeapGraphTrackerTest,PackageFromLocationApp)30 TEST(HeapGraphTrackerTest, PackageFromLocationApp) {
31 std::unique_ptr<TraceStorage> storage(new TraceStorage());
32
33 const char data_app_path[] =
34 "/data/app/org.perfetto.test-6XfQhnaSkFwGK0sYL9is0G==/base.apk";
35 EXPECT_EQ(PackageFromLocation(storage.get(), data_app_path),
36 "org.perfetto.test");
37
38 const char with_extra_dir[] =
39 "/data/app/~~ASDFGH1234QWerT==/"
40 "com.perfetto.test-MNBVCX7890SDTst6==/test.apk";
41 EXPECT_EQ(PackageFromLocation(storage.get(), with_extra_dir),
42 "com.perfetto.test");
43
44 const char odex[] =
45 "/data/app/com.google.android.apps.wellbeing-"
46 "qfQCaB4uJ7P0OPpZQqOu0Q==/oat/arm64/base.odex";
47 EXPECT_EQ(PackageFromLocation(storage.get(), odex),
48 "com.google.android.apps.wellbeing");
49
50 const char inmem_dex[] =
51 "[anon:dalvik-classes.dex extracted in memory from "
52 "/data/app/~~uUgHYtbjPNr2VFa3byIF4Q==/"
53 "com.perfetto.example-aC94wTfXRC60l2HJU5YvjQ==/base.apk]";
54 EXPECT_EQ(PackageFromLocation(storage.get(), inmem_dex),
55 "com.perfetto.example");
56 }
57
TEST(HeapGraphTrackerTest,PopulateNativeSize)58 TEST(HeapGraphTrackerTest, PopulateNativeSize) {
59 constexpr uint64_t kSeqId = 1;
60 constexpr UniquePid kPid = 1;
61 constexpr int64_t kTimestamp = 1;
62
63 TraceProcessorContext context;
64 context.storage.reset(new TraceStorage());
65 context.process_tracker.reset(new ProcessTracker(&context));
66 context.process_tracker->GetOrCreateProcess(kPid);
67
68 HeapGraphTracker tracker(&context);
69
70 StringPool::Id normal_kind = context.storage->InternString("KIND_NORMAL");
71
72 constexpr uint64_t kLocation = 0;
73 tracker.AddInternedLocationName(kSeqId, kLocation,
74 context.storage->InternString("location"));
75
76 enum Fields : uint64_t { kReferent = 1, kThunk, kThis0, kNext };
77
78 tracker.AddInternedFieldName(kSeqId, kReferent,
79 "java.lang.ref.Reference.referent");
80 tracker.AddInternedFieldName(kSeqId, kThunk, "sun.misc.Cleaner.thunk");
81 tracker.AddInternedFieldName(
82 kSeqId, kThis0,
83 "libcore.util.NativeAllocationRegistry$CleanerThunk.this$0");
84 tracker.AddInternedFieldName(kSeqId, kNext, "sun.misc.Cleaner.next");
85
86 enum Types : uint64_t {
87 kTypeBitmap = 1,
88 kTypeCleaner,
89 kTypeCleanerThunk,
90 kTypeNativeAllocationRegistry,
91 };
92
93 tracker.AddInternedType(
94 kSeqId, kTypeBitmap,
95 context.storage->InternString("android.graphics.Bitmap"), kLocation,
96 /*object_size=*/0,
97 /*reference_field_name_ids=*/{}, /*superclass_id=*/0,
98 /*classloader_id=*/0, /*no_reference_fields=*/false,
99 /*kind=*/normal_kind);
100
101 tracker.AddInternedType(
102 kSeqId, kTypeCleaner, context.storage->InternString("sun.misc.Cleaner"),
103 kLocation, /*object_size=*/0,
104 /*reference_field_name_ids=*/{kReferent, kThunk, kNext}, /*superclass_id=*/0,
105 /*classloader_id=*/0, /*no_reference_fields=*/false,
106 /*kind=*/normal_kind);
107
108 tracker.AddInternedType(
109 kSeqId, kTypeCleanerThunk,
110 context.storage->InternString(
111 "libcore.util.NativeAllocationRegistry$CleanerThunk"),
112 kLocation, /*object_size=*/0,
113 /*reference_field_name_ids=*/{kThis0}, /*superclass_id=*/0,
114 /*classloader_id=*/0, /*no_reference_fields=*/false,
115 /*kind=*/normal_kind);
116
117 tracker.AddInternedType(
118 kSeqId, kTypeNativeAllocationRegistry,
119 context.storage->InternString("libcore.util.NativeAllocationRegistry"),
120 kLocation, /*object_size=*/0,
121 /*reference_field_name_ids=*/{}, /*superclass_id=*/0,
122 /*classloader_id=*/0, /*no_reference_fields=*/false,
123 /*kind=*/normal_kind);
124
125 enum Objects : uint64_t {
126 kObjBitmap = 1,
127 kObjCleaner,
128 kObjThunk,
129 kObjNativeAllocationRegistry,
130 };
131
132 {
133 HeapGraphTracker::SourceObject obj;
134 obj.object_id = kObjBitmap;
135 obj.type_id = kTypeBitmap;
136
137 tracker.AddObject(kSeqId, kPid, kTimestamp, std::move(obj));
138 }
139
140 {
141 HeapGraphTracker::SourceObject obj;
142 obj.object_id = kObjCleaner;
143 obj.type_id = kTypeCleaner;
144 obj.referred_objects = {kObjBitmap, kObjThunk, 0};
145
146 tracker.AddObject(kSeqId, kPid, kTimestamp, std::move(obj));
147 }
148
149 {
150 HeapGraphTracker::SourceObject obj;
151 obj.object_id = kObjThunk;
152 obj.type_id = kTypeCleanerThunk;
153 obj.referred_objects = {kObjNativeAllocationRegistry};
154
155 tracker.AddObject(kSeqId, kPid, kTimestamp, std::move(obj));
156 }
157
158 {
159 HeapGraphTracker::SourceObject obj;
160 obj.object_id = kObjNativeAllocationRegistry;
161 obj.type_id = kTypeNativeAllocationRegistry;
162
163 // NativeAllocationRegistry.size least significant bit is used to encode the
164 // source of the allocation (1: malloc, 0: other).
165 obj.native_allocation_registry_size = 24242 | 1;
166
167 tracker.AddObject(kSeqId, kPid, kTimestamp, std::move(obj));
168 }
169
170 tracker.FinalizeProfile(kSeqId);
171
172 const auto& objs_table = context.storage->heap_graph_object_table();
173 const auto& class_table = context.storage->heap_graph_class_table();
174 size_t count_bitmaps = 0;
175 for (uint32_t obj_row = 0; obj_row < objs_table.row_count(); ++obj_row) {
176 base::Optional<uint32_t> class_row =
177 class_table.id().IndexOf(objs_table.type_id()[obj_row]);
178 ASSERT_TRUE(class_row.has_value());
179 if (context.storage->string_pool().Get(class_table.name()[*class_row]) ==
180 "android.graphics.Bitmap") {
181 EXPECT_EQ(objs_table.native_size()[obj_row], 24242);
182 count_bitmaps++;
183 } else {
184 EXPECT_EQ(objs_table.native_size()[obj_row], 0)
185 << context.storage->string_pool()
186 .Get(class_table.name()[*class_row])
187 .c_str()
188 << " has non zero native_size";
189 }
190 }
191 EXPECT_EQ(count_bitmaps, 1u);
192 }
193
TEST(HeapGraphTrackerTest,BuildFlamegraph)194 TEST(HeapGraphTrackerTest, BuildFlamegraph) {
195 // 4@A 5@B
196 // \ /
197 // 2@Y 3@Y
198 // \ /
199 // 1@X
200
201 constexpr uint64_t kSeqId = 1;
202 constexpr UniquePid kPid = 1;
203 constexpr int64_t kTimestamp = 1;
204
205 TraceProcessorContext context;
206 context.storage.reset(new TraceStorage());
207 context.process_tracker.reset(new ProcessTracker(&context));
208 context.process_tracker->GetOrCreateProcess(kPid);
209
210 HeapGraphTracker tracker(&context);
211
212 constexpr uint64_t kField = 1;
213 constexpr uint64_t kLocation = 0;
214
215 constexpr uint64_t kX = 1;
216 constexpr uint64_t kY = 2;
217 constexpr uint64_t kA = 3;
218 constexpr uint64_t kB = 4;
219 constexpr uint64_t kWeakRef = 5;
220
221 base::StringView field = base::StringView("foo");
222 StringPool::Id x = context.storage->InternString("X");
223 StringPool::Id y = context.storage->InternString("Y");
224 StringPool::Id a = context.storage->InternString("A");
225 StringPool::Id b = context.storage->InternString("B");
226 StringPool::Id weak_ref = context.storage->InternString("WeakReference");
227
228 StringPool::Id normal_kind = context.storage->InternString("KIND_NORMAL");
229 StringPool::Id weak_ref_kind =
230 context.storage->InternString("KIND_WEAK_REFERENCE");
231 tracker.AddInternedFieldName(kSeqId, kField, field);
232
233 tracker.AddInternedLocationName(kSeqId, kLocation,
234 context.storage->InternString("location"));
235 tracker.AddInternedType(kSeqId, kX, x, kLocation, /*object_size=*/0,
236 /*field_name_ids=*/{}, /*superclass_id=*/0,
237 /*classloader_id=*/0, /*no_fields=*/false,
238 /*kind=*/normal_kind);
239 tracker.AddInternedType(kSeqId, kY, y, kLocation, /*object_size=*/0,
240 /*field_name_ids=*/{}, /*superclass_id=*/0,
241 /*classloader_id=*/0, /*no_fields=*/false,
242 /*kind=*/normal_kind);
243 tracker.AddInternedType(kSeqId, kA, a, kLocation, /*object_size=*/0,
244 /*field_name_ids=*/{}, /*superclass_id=*/0,
245 /*classloader_id=*/0, /*no_fields=*/false,
246 /*kind=*/normal_kind);
247 tracker.AddInternedType(kSeqId, kB, b, kLocation, /*object_size=*/0,
248 /*field_name_ids=*/{}, /*superclass_id=*/0,
249 /*classloader_id=*/0, /*no_fields=*/false,
250 /*kind=*/normal_kind);
251 tracker.AddInternedType(kSeqId, kWeakRef, weak_ref, kLocation,
252 /*object_size=*/0,
253 /*field_name_ids=*/{}, /*superclass_id=*/0,
254 /*classloader_id=*/0, /*no_fields=*/false,
255 /*kind=*/weak_ref_kind);
256 {
257 HeapGraphTracker::SourceObject obj;
258 obj.object_id = 999;
259 obj.self_size = 999;
260 obj.type_id = kWeakRef;
261 obj.field_name_ids = {kField};
262 obj.referred_objects = {5};
263
264 tracker.AddObject(kSeqId, kPid, kTimestamp, std::move(obj));
265 }
266
267 {
268 HeapGraphTracker::SourceObject obj;
269 obj.object_id = 1;
270 obj.self_size = 1;
271 obj.type_id = kX;
272 obj.field_name_ids = {kField, kField};
273 obj.referred_objects = {2, 3};
274
275 tracker.AddObject(kSeqId, kPid, kTimestamp, std::move(obj));
276 }
277
278 {
279 HeapGraphTracker::SourceObject obj;
280 obj.object_id = 2;
281 obj.self_size = 2;
282 obj.type_id = kY;
283 tracker.AddObject(kSeqId, kPid, kTimestamp, std::move(obj));
284 }
285
286 {
287 HeapGraphTracker::SourceObject obj;
288 obj.object_id = 3;
289 obj.self_size = 3;
290 obj.type_id = kY;
291 obj.field_name_ids = {kField, kField};
292 obj.referred_objects = {4, 5};
293
294 tracker.AddObject(kSeqId, kPid, kTimestamp, std::move(obj));
295 }
296
297 {
298 HeapGraphTracker::SourceObject obj;
299 obj.object_id = 4;
300 obj.self_size = 4;
301 obj.type_id = kA;
302 tracker.AddObject(kSeqId, kPid, kTimestamp, std::move(obj));
303 }
304
305 {
306 HeapGraphTracker::SourceObject obj;
307 obj.object_id = 5;
308 obj.self_size = 5;
309 obj.type_id = kB;
310 tracker.AddObject(kSeqId, kPid, kTimestamp, std::move(obj));
311 }
312
313 HeapGraphTracker::SourceRoot root;
314 root.root_type = context.storage->InternString("ROOT");
315 root.object_ids.emplace_back(1);
316 root.object_ids.emplace_back(999);
317 tracker.AddRoot(kSeqId, kPid, kTimestamp, root);
318
319 tracker.FinalizeProfile(kSeqId);
320 std::unique_ptr<tables::ExperimentalFlamegraphNodesTable> flame =
321 tracker.BuildFlamegraph(kPid, kTimestamp);
322 ASSERT_NE(flame, nullptr);
323
324 auto cumulative_sizes = flame->cumulative_size().ToVectorForTesting();
325 EXPECT_THAT(cumulative_sizes, UnorderedElementsAre(15, 4, 14, 5, 999));
326
327 auto cumulative_counts = flame->cumulative_count().ToVectorForTesting();
328 EXPECT_THAT(cumulative_counts, UnorderedElementsAre(5, 4, 1, 1, 1));
329
330 auto sizes = flame->size().ToVectorForTesting();
331 EXPECT_THAT(sizes, UnorderedElementsAre(1, 5, 4, 5, 999));
332
333 auto counts = flame->count().ToVectorForTesting();
334 EXPECT_THAT(counts, UnorderedElementsAre(1, 2, 1, 1, 1));
335 }
336
337 static const char kArray[] = "X[]";
338 static const char kDoubleArray[] = "X[][]";
339 static const char kNoArray[] = "X";
340 static const char kLongNoArray[] = "ABCDE";
341 static const char kStaticClassNoArray[] = "java.lang.Class<abc>";
342 static const char kStaticClassArray[] = "java.lang.Class<abc[]>";
343
TEST(HeapGraphTrackerTest,NormalizeTypeName)344 TEST(HeapGraphTrackerTest, NormalizeTypeName) {
345 // sizeof(...) - 1 below to get rid of the null-byte.
346 EXPECT_EQ(NormalizeTypeName(base::StringView(kArray, sizeof(kArray) - 1))
347 .ToStdString(),
348 "X");
349 EXPECT_EQ(NormalizeTypeName(
350 base::StringView(kDoubleArray, sizeof(kDoubleArray) - 1))
351 .ToStdString(),
352 "X");
353 EXPECT_EQ(NormalizeTypeName(base::StringView(kNoArray, sizeof(kNoArray) - 1))
354 .ToStdString(),
355 "X");
356 EXPECT_EQ(NormalizeTypeName(
357 base::StringView(kLongNoArray, sizeof(kLongNoArray) - 1))
358 .ToStdString(),
359 "ABCDE");
360 EXPECT_EQ(NormalizeTypeName(base::StringView(kStaticClassNoArray,
361 sizeof(kStaticClassNoArray) - 1))
362 .ToStdString(),
363 "abc");
364 EXPECT_EQ(NormalizeTypeName(base::StringView(kStaticClassArray,
365 sizeof(kStaticClassArray) - 1))
366 .ToStdString(),
367 "abc");
368 }
369
TEST(HeapGraphTrackerTest,NumberOfArray)370 TEST(HeapGraphTrackerTest, NumberOfArray) {
371 // sizeof(...) - 1 below to get rid of the null-byte.
372 EXPECT_EQ(NumberOfArrays(base::StringView(kArray, sizeof(kArray) - 1)), 1u);
373 EXPECT_EQ(
374 NumberOfArrays(base::StringView(kDoubleArray, sizeof(kDoubleArray) - 1)),
375 2u);
376 EXPECT_EQ(NumberOfArrays(base::StringView(kNoArray, sizeof(kNoArray) - 1)),
377 0u);
378 EXPECT_EQ(
379 NumberOfArrays(base::StringView(kLongNoArray, sizeof(kLongNoArray) - 1)),
380 0u);
381 }
382
383 } // namespace
384 } // namespace trace_processor
385 } // namespace perfetto
386