1 //===- unittests/Support/MemProfTest.cpp ----------------------------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #include "llvm/ProfileData/MemProf.h" 10 #include "llvm/ADT/DenseMap.h" 11 #include "llvm/ADT/MapVector.h" 12 #include "llvm/ADT/STLForwardCompat.h" 13 #include "llvm/DebugInfo/DIContext.h" 14 #include "llvm/DebugInfo/Symbolize/SymbolizableModule.h" 15 #include "llvm/IR/Value.h" 16 #include "llvm/Object/ObjectFile.h" 17 #include "llvm/ProfileData/MemProfData.inc" 18 #include "llvm/ProfileData/MemProfReader.h" 19 #include "llvm/Support/raw_ostream.h" 20 #include "gmock/gmock.h" 21 #include "gtest/gtest.h" 22 23 #include <initializer_list> 24 25 namespace { 26 27 using ::llvm::DIGlobal; 28 using ::llvm::DIInliningInfo; 29 using ::llvm::DILineInfo; 30 using ::llvm::DILineInfoSpecifier; 31 using ::llvm::DILocal; 32 using ::llvm::StringRef; 33 using ::llvm::memprof::CallStackId; 34 using ::llvm::memprof::CallStackMap; 35 using ::llvm::memprof::Frame; 36 using ::llvm::memprof::FrameId; 37 using ::llvm::memprof::IndexedAllocationInfo; 38 using ::llvm::memprof::IndexedMemProfRecord; 39 using ::llvm::memprof::MemInfoBlock; 40 using ::llvm::memprof::MemProfReader; 41 using ::llvm::memprof::MemProfRecord; 42 using ::llvm::memprof::MemProfSchema; 43 using ::llvm::memprof::Meta; 44 using ::llvm::memprof::PortableMemInfoBlock; 45 using ::llvm::memprof::RawMemProfReader; 46 using ::llvm::memprof::SegmentEntry; 47 using ::llvm::object::SectionedAddress; 48 using ::llvm::symbolize::SymbolizableModule; 49 using ::testing::Return; 50 using ::testing::SizeIs; 51 52 class MockSymbolizer : public SymbolizableModule { 53 public: 54 MOCK_CONST_METHOD3(symbolizeInlinedCode, 55 DIInliningInfo(SectionedAddress, DILineInfoSpecifier, 56 bool)); 57 // Most of the methods in the interface are unused. We only mock the 58 // method that we expect to be called from the memprof reader. 59 virtual DILineInfo symbolizeCode(SectionedAddress, DILineInfoSpecifier, 60 bool) const { 61 llvm_unreachable("unused"); 62 } 63 virtual DIGlobal symbolizeData(SectionedAddress) const { 64 llvm_unreachable("unused"); 65 } 66 virtual std::vector<DILocal> symbolizeFrame(SectionedAddress) const { 67 llvm_unreachable("unused"); 68 } 69 virtual std::vector<SectionedAddress> findSymbol(StringRef Symbol, 70 uint64_t Offset) const { 71 llvm_unreachable("unused"); 72 } 73 virtual bool isWin32Module() const { llvm_unreachable("unused"); } 74 virtual uint64_t getModulePreferredBase() const { 75 llvm_unreachable("unused"); 76 } 77 }; 78 79 struct MockInfo { 80 std::string FunctionName; 81 uint32_t Line; 82 uint32_t StartLine; 83 uint32_t Column; 84 std::string FileName = "valid/path.cc"; 85 }; 86 DIInliningInfo makeInliningInfo(std::initializer_list<MockInfo> MockFrames) { 87 DIInliningInfo Result; 88 for (const auto &Item : MockFrames) { 89 DILineInfo Frame; 90 Frame.FunctionName = Item.FunctionName; 91 Frame.Line = Item.Line; 92 Frame.StartLine = Item.StartLine; 93 Frame.Column = Item.Column; 94 Frame.FileName = Item.FileName; 95 Result.addFrame(Frame); 96 } 97 return Result; 98 } 99 100 llvm::SmallVector<SegmentEntry, 4> makeSegments() { 101 llvm::SmallVector<SegmentEntry, 4> Result; 102 // Mimic an entry for a non position independent executable. 103 Result.emplace_back(0x0, 0x40000, 0x0); 104 return Result; 105 } 106 107 const DILineInfoSpecifier specifier() { 108 return DILineInfoSpecifier( 109 DILineInfoSpecifier::FileLineInfoKind::RawValue, 110 DILineInfoSpecifier::FunctionNameKind::LinkageName); 111 } 112 113 MATCHER_P4(FrameContains, FunctionName, LineOffset, Column, Inline, "") { 114 const Frame &F = arg; 115 116 const uint64_t ExpectedHash = IndexedMemProfRecord::getGUID(FunctionName); 117 if (F.Function != ExpectedHash) { 118 *result_listener << "Hash mismatch"; 119 return false; 120 } 121 if (F.SymbolName && *F.SymbolName != FunctionName) { 122 *result_listener << "SymbolName mismatch\nWant: " << FunctionName 123 << "\nGot: " << *F.SymbolName; 124 return false; 125 } 126 if (F.LineOffset == LineOffset && F.Column == Column && 127 F.IsInlineFrame == Inline) { 128 return true; 129 } 130 *result_listener << "LineOffset, Column or Inline mismatch"; 131 return false; 132 } 133 134 TEST(MemProf, FillsValue) { 135 std::unique_ptr<MockSymbolizer> Symbolizer(new MockSymbolizer()); 136 137 EXPECT_CALL(*Symbolizer, symbolizeInlinedCode(SectionedAddress{0x1000}, 138 specifier(), false)) 139 .Times(1) // Only once since we remember invalid PCs. 140 .WillRepeatedly(Return(makeInliningInfo({ 141 {"new", 70, 57, 3, "memprof/memprof_new_delete.cpp"}, 142 }))); 143 144 EXPECT_CALL(*Symbolizer, symbolizeInlinedCode(SectionedAddress{0x2000}, 145 specifier(), false)) 146 .Times(1) // Only once since we cache the result for future lookups. 147 .WillRepeatedly(Return(makeInliningInfo({ 148 {"foo", 10, 5, 30}, 149 {"bar", 201, 150, 20}, 150 }))); 151 152 EXPECT_CALL(*Symbolizer, symbolizeInlinedCode(SectionedAddress{0x3000}, 153 specifier(), false)) 154 .Times(1) 155 .WillRepeatedly(Return(makeInliningInfo({ 156 {"xyz.llvm.123", 10, 5, 30}, 157 {"abc", 10, 5, 30}, 158 }))); 159 160 CallStackMap CSM; 161 CSM[0x1] = {0x1000, 0x2000, 0x3000}; 162 163 llvm::MapVector<uint64_t, MemInfoBlock> Prof; 164 Prof[0x1].AllocCount = 1; 165 166 auto Seg = makeSegments(); 167 168 RawMemProfReader Reader(std::move(Symbolizer), Seg, Prof, CSM, 169 /*KeepName=*/true); 170 171 llvm::DenseMap<llvm::GlobalValue::GUID, MemProfRecord> Records; 172 for (const auto &Pair : Reader) { 173 Records.insert({Pair.first, Pair.second}); 174 } 175 176 // Mock program pseudocode and expected memprof record contents. 177 // 178 // AllocSite CallSite 179 // inline foo() { new(); } Y N 180 // bar() { foo(); } Y Y 181 // inline xyz() { bar(); } N Y 182 // abc() { xyz(); } N Y 183 184 // We expect 4 records. We attach alloc site data to foo and bar, i.e. 185 // all frames bottom up until we find a non-inline frame. We attach call site 186 // data to bar, xyz and abc. 187 ASSERT_THAT(Records, SizeIs(4)); 188 189 // Check the memprof record for foo. 190 const llvm::GlobalValue::GUID FooId = IndexedMemProfRecord::getGUID("foo"); 191 ASSERT_TRUE(Records.contains(FooId)); 192 const MemProfRecord &Foo = Records[FooId]; 193 ASSERT_THAT(Foo.AllocSites, SizeIs(1)); 194 EXPECT_EQ(Foo.AllocSites[0].Info.getAllocCount(), 1U); 195 EXPECT_THAT(Foo.AllocSites[0].CallStack[0], 196 FrameContains("foo", 5U, 30U, true)); 197 EXPECT_THAT(Foo.AllocSites[0].CallStack[1], 198 FrameContains("bar", 51U, 20U, false)); 199 EXPECT_THAT(Foo.AllocSites[0].CallStack[2], 200 FrameContains("xyz", 5U, 30U, true)); 201 EXPECT_THAT(Foo.AllocSites[0].CallStack[3], 202 FrameContains("abc", 5U, 30U, false)); 203 EXPECT_TRUE(Foo.CallSites.empty()); 204 205 // Check the memprof record for bar. 206 const llvm::GlobalValue::GUID BarId = IndexedMemProfRecord::getGUID("bar"); 207 ASSERT_TRUE(Records.contains(BarId)); 208 const MemProfRecord &Bar = Records[BarId]; 209 ASSERT_THAT(Bar.AllocSites, SizeIs(1)); 210 EXPECT_EQ(Bar.AllocSites[0].Info.getAllocCount(), 1U); 211 EXPECT_THAT(Bar.AllocSites[0].CallStack[0], 212 FrameContains("foo", 5U, 30U, true)); 213 EXPECT_THAT(Bar.AllocSites[0].CallStack[1], 214 FrameContains("bar", 51U, 20U, false)); 215 EXPECT_THAT(Bar.AllocSites[0].CallStack[2], 216 FrameContains("xyz", 5U, 30U, true)); 217 EXPECT_THAT(Bar.AllocSites[0].CallStack[3], 218 FrameContains("abc", 5U, 30U, false)); 219 220 ASSERT_THAT(Bar.CallSites, SizeIs(1)); 221 ASSERT_THAT(Bar.CallSites[0], SizeIs(2)); 222 EXPECT_THAT(Bar.CallSites[0][0], FrameContains("foo", 5U, 30U, true)); 223 EXPECT_THAT(Bar.CallSites[0][1], FrameContains("bar", 51U, 20U, false)); 224 225 // Check the memprof record for xyz. 226 const llvm::GlobalValue::GUID XyzId = IndexedMemProfRecord::getGUID("xyz"); 227 ASSERT_TRUE(Records.contains(XyzId)); 228 const MemProfRecord &Xyz = Records[XyzId]; 229 ASSERT_THAT(Xyz.CallSites, SizeIs(1)); 230 ASSERT_THAT(Xyz.CallSites[0], SizeIs(2)); 231 // Expect the entire frame even though in practice we only need the first 232 // entry here. 233 EXPECT_THAT(Xyz.CallSites[0][0], FrameContains("xyz", 5U, 30U, true)); 234 EXPECT_THAT(Xyz.CallSites[0][1], FrameContains("abc", 5U, 30U, false)); 235 236 // Check the memprof record for abc. 237 const llvm::GlobalValue::GUID AbcId = IndexedMemProfRecord::getGUID("abc"); 238 ASSERT_TRUE(Records.contains(AbcId)); 239 const MemProfRecord &Abc = Records[AbcId]; 240 EXPECT_TRUE(Abc.AllocSites.empty()); 241 ASSERT_THAT(Abc.CallSites, SizeIs(1)); 242 ASSERT_THAT(Abc.CallSites[0], SizeIs(2)); 243 EXPECT_THAT(Abc.CallSites[0][0], FrameContains("xyz", 5U, 30U, true)); 244 EXPECT_THAT(Abc.CallSites[0][1], FrameContains("abc", 5U, 30U, false)); 245 } 246 247 TEST(MemProf, PortableWrapper) { 248 MemInfoBlock Info(/*size=*/16, /*access_count=*/7, /*alloc_timestamp=*/1000, 249 /*dealloc_timestamp=*/2000, /*alloc_cpu=*/3, 250 /*dealloc_cpu=*/4, /*Histogram=*/0, /*HistogramSize=*/0); 251 252 const auto Schema = llvm::memprof::getFullSchema(); 253 PortableMemInfoBlock WriteBlock(Info, Schema); 254 255 std::string Buffer; 256 llvm::raw_string_ostream OS(Buffer); 257 WriteBlock.serialize(Schema, OS); 258 259 PortableMemInfoBlock ReadBlock( 260 Schema, reinterpret_cast<const unsigned char *>(Buffer.data())); 261 262 EXPECT_EQ(ReadBlock, WriteBlock); 263 // Here we compare directly with the actual counts instead of MemInfoBlock 264 // members. Since the MemInfoBlock struct is packed and the EXPECT_EQ macros 265 // take a reference to the params, this results in unaligned accesses. 266 EXPECT_EQ(1UL, ReadBlock.getAllocCount()); 267 EXPECT_EQ(7ULL, ReadBlock.getTotalAccessCount()); 268 EXPECT_EQ(3UL, ReadBlock.getAllocCpuId()); 269 } 270 271 TEST(MemProf, RecordSerializationRoundTripVerion2) { 272 const auto Schema = llvm::memprof::getFullSchema(); 273 274 MemInfoBlock Info(/*size=*/16, /*access_count=*/7, /*alloc_timestamp=*/1000, 275 /*dealloc_timestamp=*/2000, /*alloc_cpu=*/3, 276 /*dealloc_cpu=*/4, /*Histogram=*/0, /*HistogramSize=*/0); 277 278 llvm::SmallVector<llvm::memprof::CallStackId> CallStackIds = {0x123, 0x456}; 279 280 llvm::SmallVector<llvm::memprof::CallStackId> CallSiteIds = {0x333, 0x444}; 281 282 IndexedMemProfRecord Record; 283 for (const auto &CSId : CallStackIds) { 284 // Use the same info block for both allocation sites. 285 Record.AllocSites.emplace_back(CSId, Info); 286 } 287 Record.CallSiteIds.assign(CallSiteIds); 288 289 std::string Buffer; 290 llvm::raw_string_ostream OS(Buffer); 291 Record.serialize(Schema, OS, llvm::memprof::Version2); 292 293 const IndexedMemProfRecord GotRecord = IndexedMemProfRecord::deserialize( 294 Schema, reinterpret_cast<const unsigned char *>(Buffer.data()), 295 llvm::memprof::Version2); 296 297 EXPECT_EQ(Record, GotRecord); 298 } 299 300 TEST(MemProf, RecordSerializationRoundTripVersion2HotColdSchema) { 301 const auto Schema = llvm::memprof::getHotColdSchema(); 302 303 MemInfoBlock Info; 304 Info.AllocCount = 11; 305 Info.TotalSize = 22; 306 Info.TotalLifetime = 33; 307 Info.TotalLifetimeAccessDensity = 44; 308 309 llvm::SmallVector<llvm::memprof::CallStackId> CallStackIds = {0x123, 0x456}; 310 311 llvm::SmallVector<llvm::memprof::CallStackId> CallSiteIds = {0x333, 0x444}; 312 313 IndexedMemProfRecord Record; 314 for (const auto &CSId : CallStackIds) { 315 // Use the same info block for both allocation sites. 316 Record.AllocSites.emplace_back(CSId, Info, Schema); 317 } 318 Record.CallSiteIds.assign(CallSiteIds); 319 320 std::bitset<llvm::to_underlying(Meta::Size)> SchemaBitSet; 321 for (auto Id : Schema) 322 SchemaBitSet.set(llvm::to_underlying(Id)); 323 324 // Verify that SchemaBitSet has the fields we expect and nothing else, which 325 // we check with count(). 326 EXPECT_EQ(SchemaBitSet.count(), 4U); 327 EXPECT_TRUE(SchemaBitSet[llvm::to_underlying(Meta::AllocCount)]); 328 EXPECT_TRUE(SchemaBitSet[llvm::to_underlying(Meta::TotalSize)]); 329 EXPECT_TRUE(SchemaBitSet[llvm::to_underlying(Meta::TotalLifetime)]); 330 EXPECT_TRUE( 331 SchemaBitSet[llvm::to_underlying(Meta::TotalLifetimeAccessDensity)]); 332 333 // Verify that Schema has propagated all the way to the Info field in each 334 // IndexedAllocationInfo. 335 ASSERT_THAT(Record.AllocSites, ::SizeIs(2)); 336 EXPECT_EQ(Record.AllocSites[0].Info.getSchema(), SchemaBitSet); 337 EXPECT_EQ(Record.AllocSites[1].Info.getSchema(), SchemaBitSet); 338 339 std::string Buffer; 340 llvm::raw_string_ostream OS(Buffer); 341 Record.serialize(Schema, OS, llvm::memprof::Version2); 342 343 const IndexedMemProfRecord GotRecord = IndexedMemProfRecord::deserialize( 344 Schema, reinterpret_cast<const unsigned char *>(Buffer.data()), 345 llvm::memprof::Version2); 346 347 // Verify that Schema comes back correctly after deserialization. Technically, 348 // the comparison between Record and GotRecord below includes the comparison 349 // of their Schemas, but we'll verify the Schemas on our own. 350 ASSERT_THAT(GotRecord.AllocSites, ::SizeIs(2)); 351 EXPECT_EQ(GotRecord.AllocSites[0].Info.getSchema(), SchemaBitSet); 352 EXPECT_EQ(GotRecord.AllocSites[1].Info.getSchema(), SchemaBitSet); 353 354 EXPECT_EQ(Record, GotRecord); 355 } 356 357 TEST(MemProf, SymbolizationFilter) { 358 std::unique_ptr<MockSymbolizer> Symbolizer(new MockSymbolizer()); 359 360 EXPECT_CALL(*Symbolizer, symbolizeInlinedCode(SectionedAddress{0x1000}, 361 specifier(), false)) 362 .Times(1) // once since we don't lookup invalid PCs repeatedly. 363 .WillRepeatedly(Return(makeInliningInfo({ 364 {"malloc", 70, 57, 3, "memprof/memprof_malloc_linux.cpp"}, 365 }))); 366 367 EXPECT_CALL(*Symbolizer, symbolizeInlinedCode(SectionedAddress{0x2000}, 368 specifier(), false)) 369 .Times(1) // once since we don't lookup invalid PCs repeatedly. 370 .WillRepeatedly(Return(makeInliningInfo({ 371 {"new", 70, 57, 3, "memprof/memprof_new_delete.cpp"}, 372 }))); 373 374 EXPECT_CALL(*Symbolizer, symbolizeInlinedCode(SectionedAddress{0x3000}, 375 specifier(), false)) 376 .Times(1) // once since we don't lookup invalid PCs repeatedly. 377 .WillRepeatedly(Return(makeInliningInfo({ 378 {DILineInfo::BadString, 0, 0, 0}, 379 }))); 380 381 EXPECT_CALL(*Symbolizer, symbolizeInlinedCode(SectionedAddress{0x4000}, 382 specifier(), false)) 383 .Times(1) 384 .WillRepeatedly(Return(makeInliningInfo({ 385 {"foo", 10, 5, 30, "memprof/memprof_test_file.cpp"}, 386 }))); 387 388 EXPECT_CALL(*Symbolizer, symbolizeInlinedCode(SectionedAddress{0x5000}, 389 specifier(), false)) 390 .Times(1) 391 .WillRepeatedly(Return(makeInliningInfo({ 392 // Depending on how the runtime was compiled, only the filename 393 // may be present in the debug information. 394 {"malloc", 70, 57, 3, "memprof_malloc_linux.cpp"}, 395 }))); 396 397 CallStackMap CSM; 398 CSM[0x1] = {0x1000, 0x2000, 0x3000, 0x4000}; 399 // This entry should be dropped since all PCs are either not 400 // symbolizable or belong to the runtime. 401 CSM[0x2] = {0x1000, 0x2000, 0x5000}; 402 403 llvm::MapVector<uint64_t, MemInfoBlock> Prof; 404 Prof[0x1].AllocCount = 1; 405 Prof[0x2].AllocCount = 1; 406 407 auto Seg = makeSegments(); 408 409 RawMemProfReader Reader(std::move(Symbolizer), Seg, Prof, CSM); 410 411 llvm::SmallVector<MemProfRecord, 1> Records; 412 for (const auto &KeyRecordPair : Reader) { 413 Records.push_back(KeyRecordPair.second); 414 } 415 416 ASSERT_THAT(Records, SizeIs(1)); 417 ASSERT_THAT(Records[0].AllocSites, SizeIs(1)); 418 ASSERT_THAT(Records[0].AllocSites[0].CallStack, SizeIs(1)); 419 EXPECT_THAT(Records[0].AllocSites[0].CallStack[0], 420 FrameContains("foo", 5U, 30U, false)); 421 } 422 423 TEST(MemProf, BaseMemProfReader) { 424 llvm::memprof::IndexedMemProfData MemProfData; 425 Frame F1(/*Hash=*/IndexedMemProfRecord::getGUID("foo"), /*LineOffset=*/20, 426 /*Column=*/5, /*IsInlineFrame=*/true); 427 Frame F2(/*Hash=*/IndexedMemProfRecord::getGUID("bar"), /*LineOffset=*/10, 428 /*Column=*/2, /*IsInlineFrame=*/false); 429 MemProfData.Frames.insert({F1.hash(), F1}); 430 MemProfData.Frames.insert({F2.hash(), F2}); 431 432 llvm::SmallVector<FrameId> CallStack{F1.hash(), F2.hash()}; 433 CallStackId CSId = llvm::memprof::hashCallStack(CallStack); 434 MemProfData.CallStacks.try_emplace(CSId, CallStack); 435 436 IndexedMemProfRecord FakeRecord; 437 MemInfoBlock Block; 438 Block.AllocCount = 1U, Block.TotalAccessDensity = 4, 439 Block.TotalLifetime = 200001; 440 FakeRecord.AllocSites.emplace_back(/*CSId=*/CSId, /*MB=*/Block); 441 MemProfData.Records.insert({F1.hash(), FakeRecord}); 442 443 MemProfReader Reader(MemProfData); 444 445 llvm::SmallVector<MemProfRecord, 1> Records; 446 for (const auto &KeyRecordPair : Reader) { 447 Records.push_back(KeyRecordPair.second); 448 } 449 450 ASSERT_THAT(Records, SizeIs(1)); 451 ASSERT_THAT(Records[0].AllocSites, SizeIs(1)); 452 ASSERT_THAT(Records[0].AllocSites[0].CallStack, SizeIs(2)); 453 EXPECT_THAT(Records[0].AllocSites[0].CallStack[0], 454 FrameContains("foo", 20U, 5U, true)); 455 EXPECT_THAT(Records[0].AllocSites[0].CallStack[1], 456 FrameContains("bar", 10U, 2U, false)); 457 } 458 459 TEST(MemProf, BaseMemProfReaderWithCSIdMap) { 460 llvm::memprof::IndexedMemProfData MemProfData; 461 Frame F1(/*Hash=*/IndexedMemProfRecord::getGUID("foo"), /*LineOffset=*/20, 462 /*Column=*/5, /*IsInlineFrame=*/true); 463 Frame F2(/*Hash=*/IndexedMemProfRecord::getGUID("bar"), /*LineOffset=*/10, 464 /*Column=*/2, /*IsInlineFrame=*/false); 465 MemProfData.Frames.insert({F1.hash(), F1}); 466 MemProfData.Frames.insert({F2.hash(), F2}); 467 468 llvm::SmallVector<FrameId> CallStack = {F1.hash(), F2.hash()}; 469 CallStackId CSId = llvm::memprof::hashCallStack(CallStack); 470 MemProfData.CallStacks.insert({CSId, CallStack}); 471 472 IndexedMemProfRecord FakeRecord; 473 MemInfoBlock Block; 474 Block.AllocCount = 1U, Block.TotalAccessDensity = 4, 475 Block.TotalLifetime = 200001; 476 FakeRecord.AllocSites.emplace_back( 477 /*CSId=*/llvm::memprof::hashCallStack(CallStack), 478 /*MB=*/Block); 479 MemProfData.Records.insert({F1.hash(), FakeRecord}); 480 481 MemProfReader Reader(MemProfData); 482 483 llvm::SmallVector<MemProfRecord, 1> Records; 484 for (const auto &KeyRecordPair : Reader) { 485 Records.push_back(KeyRecordPair.second); 486 } 487 488 ASSERT_THAT(Records, SizeIs(1)); 489 ASSERT_THAT(Records[0].AllocSites, SizeIs(1)); 490 ASSERT_THAT(Records[0].AllocSites[0].CallStack, SizeIs(2)); 491 EXPECT_THAT(Records[0].AllocSites[0].CallStack[0], 492 FrameContains("foo", 20U, 5U, true)); 493 EXPECT_THAT(Records[0].AllocSites[0].CallStack[1], 494 FrameContains("bar", 10U, 2U, false)); 495 } 496 497 TEST(MemProf, IndexedMemProfRecordToMemProfRecord) { 498 // Verify that MemProfRecord can be constructed from IndexedMemProfRecord with 499 // CallStackIds only. 500 501 llvm::DenseMap<FrameId, Frame> FrameIdMap; 502 Frame F1(1, 0, 0, false); 503 Frame F2(2, 0, 0, false); 504 Frame F3(3, 0, 0, false); 505 Frame F4(4, 0, 0, false); 506 FrameIdMap.insert({F1.hash(), F1}); 507 FrameIdMap.insert({F2.hash(), F2}); 508 FrameIdMap.insert({F3.hash(), F3}); 509 FrameIdMap.insert({F4.hash(), F4}); 510 511 llvm::DenseMap<CallStackId, llvm::SmallVector<FrameId>> CallStackIdMap; 512 llvm::SmallVector<FrameId> CS1 = {F1.hash(), F2.hash()}; 513 llvm::SmallVector<FrameId> CS2 = {F1.hash(), F3.hash()}; 514 llvm::SmallVector<FrameId> CS3 = {F2.hash(), F3.hash()}; 515 llvm::SmallVector<FrameId> CS4 = {F2.hash(), F4.hash()}; 516 CallStackIdMap.insert({llvm::memprof::hashCallStack(CS1), CS1}); 517 CallStackIdMap.insert({llvm::memprof::hashCallStack(CS2), CS2}); 518 CallStackIdMap.insert({llvm::memprof::hashCallStack(CS3), CS3}); 519 CallStackIdMap.insert({llvm::memprof::hashCallStack(CS4), CS4}); 520 521 IndexedMemProfRecord IndexedRecord; 522 IndexedAllocationInfo AI; 523 AI.CSId = llvm::memprof::hashCallStack(CS1); 524 IndexedRecord.AllocSites.push_back(AI); 525 AI.CSId = llvm::memprof::hashCallStack(CS2); 526 IndexedRecord.AllocSites.push_back(AI); 527 IndexedRecord.CallSiteIds.push_back(llvm::memprof::hashCallStack(CS3)); 528 IndexedRecord.CallSiteIds.push_back(llvm::memprof::hashCallStack(CS4)); 529 530 llvm::memprof::FrameIdConverter<decltype(FrameIdMap)> FrameIdConv(FrameIdMap); 531 llvm::memprof::CallStackIdConverter<decltype(CallStackIdMap)> CSIdConv( 532 CallStackIdMap, FrameIdConv); 533 534 MemProfRecord Record = IndexedRecord.toMemProfRecord(CSIdConv); 535 536 // Make sure that all lookups are successful. 537 ASSERT_EQ(FrameIdConv.LastUnmappedId, std::nullopt); 538 ASSERT_EQ(CSIdConv.LastUnmappedId, std::nullopt); 539 540 // Verify the contents of Record. 541 ASSERT_THAT(Record.AllocSites, SizeIs(2)); 542 ASSERT_THAT(Record.AllocSites[0].CallStack, SizeIs(2)); 543 EXPECT_EQ(Record.AllocSites[0].CallStack[0].hash(), F1.hash()); 544 EXPECT_EQ(Record.AllocSites[0].CallStack[1].hash(), F2.hash()); 545 ASSERT_THAT(Record.AllocSites[1].CallStack, SizeIs(2)); 546 EXPECT_EQ(Record.AllocSites[1].CallStack[0].hash(), F1.hash()); 547 EXPECT_EQ(Record.AllocSites[1].CallStack[1].hash(), F3.hash()); 548 ASSERT_THAT(Record.CallSites, SizeIs(2)); 549 ASSERT_THAT(Record.CallSites[0], SizeIs(2)); 550 EXPECT_EQ(Record.CallSites[0][0].hash(), F2.hash()); 551 EXPECT_EQ(Record.CallSites[0][1].hash(), F3.hash()); 552 ASSERT_THAT(Record.CallSites[1], SizeIs(2)); 553 EXPECT_EQ(Record.CallSites[1][0].hash(), F2.hash()); 554 EXPECT_EQ(Record.CallSites[1][1].hash(), F4.hash()); 555 } 556 557 using FrameIdMapTy = 558 llvm::DenseMap<::llvm::memprof::FrameId, ::llvm::memprof::Frame>; 559 using CallStackIdMapTy = 560 llvm::DenseMap<::llvm::memprof::CallStackId, 561 ::llvm::SmallVector<::llvm::memprof::FrameId>>; 562 563 // Populate those fields returned by getHotColdSchema. 564 MemInfoBlock makePartialMIB() { 565 MemInfoBlock MIB; 566 MIB.AllocCount = 1; 567 MIB.TotalSize = 5; 568 MIB.TotalLifetime = 10; 569 MIB.TotalLifetimeAccessDensity = 23; 570 return MIB; 571 } 572 573 TEST(MemProf, MissingCallStackId) { 574 // Use a non-existent CallStackId to trigger a mapping error in 575 // toMemProfRecord. 576 llvm::memprof::IndexedAllocationInfo AI(0xdeadbeefU, makePartialMIB(), 577 llvm::memprof::getHotColdSchema()); 578 579 IndexedMemProfRecord IndexedMR; 580 IndexedMR.AllocSites.push_back(AI); 581 582 // Create empty maps. 583 const FrameIdMapTy IdToFrameMap; 584 const CallStackIdMapTy CSIdToCallStackMap; 585 llvm::memprof::FrameIdConverter<decltype(IdToFrameMap)> FrameIdConv( 586 IdToFrameMap); 587 llvm::memprof::CallStackIdConverter<decltype(CSIdToCallStackMap)> CSIdConv( 588 CSIdToCallStackMap, FrameIdConv); 589 590 // We are only interested in errors, not the return value. 591 (void)IndexedMR.toMemProfRecord(CSIdConv); 592 593 ASSERT_TRUE(CSIdConv.LastUnmappedId.has_value()); 594 EXPECT_EQ(*CSIdConv.LastUnmappedId, 0xdeadbeefU); 595 EXPECT_EQ(FrameIdConv.LastUnmappedId, std::nullopt); 596 } 597 598 TEST(MemProf, MissingFrameId) { 599 llvm::memprof::IndexedAllocationInfo AI(0x222, makePartialMIB(), 600 llvm::memprof::getHotColdSchema()); 601 602 IndexedMemProfRecord IndexedMR; 603 IndexedMR.AllocSites.push_back(AI); 604 605 // An empty map to trigger a mapping error. 606 const FrameIdMapTy IdToFrameMap; 607 CallStackIdMapTy CSIdToCallStackMap; 608 CSIdToCallStackMap.insert({0x222, {2, 3}}); 609 610 llvm::memprof::FrameIdConverter<decltype(IdToFrameMap)> FrameIdConv( 611 IdToFrameMap); 612 llvm::memprof::CallStackIdConverter<decltype(CSIdToCallStackMap)> CSIdConv( 613 CSIdToCallStackMap, FrameIdConv); 614 615 // We are only interested in errors, not the return value. 616 (void)IndexedMR.toMemProfRecord(CSIdConv); 617 618 EXPECT_EQ(CSIdConv.LastUnmappedId, std::nullopt); 619 ASSERT_TRUE(FrameIdConv.LastUnmappedId.has_value()); 620 EXPECT_EQ(*FrameIdConv.LastUnmappedId, 3U); 621 } 622 623 // Verify CallStackRadixTreeBuilder can handle empty inputs. 624 TEST(MemProf, RadixTreeBuilderEmpty) { 625 llvm::DenseMap<FrameId, llvm::memprof::LinearFrameId> MemProfFrameIndexes; 626 llvm::MapVector<CallStackId, llvm::SmallVector<FrameId>> MemProfCallStackData; 627 llvm::DenseMap<llvm::memprof::FrameId, llvm::memprof::FrameStat> 628 FrameHistogram = 629 llvm::memprof::computeFrameHistogram<FrameId>(MemProfCallStackData); 630 llvm::memprof::CallStackRadixTreeBuilder<FrameId> Builder; 631 Builder.build(std::move(MemProfCallStackData), MemProfFrameIndexes, 632 FrameHistogram); 633 ASSERT_THAT(Builder.getRadixArray(), testing::IsEmpty()); 634 const auto Mappings = Builder.takeCallStackPos(); 635 ASSERT_THAT(Mappings, testing::IsEmpty()); 636 } 637 638 // Verify CallStackRadixTreeBuilder can handle one trivial call stack. 639 TEST(MemProf, RadixTreeBuilderOne) { 640 llvm::DenseMap<FrameId, llvm::memprof::LinearFrameId> MemProfFrameIndexes = { 641 {11, 1}, {12, 2}, {13, 3}}; 642 llvm::SmallVector<llvm::memprof::FrameId> CS1 = {13, 12, 11}; 643 llvm::MapVector<CallStackId, llvm::SmallVector<FrameId>> MemProfCallStackData; 644 MemProfCallStackData.insert({llvm::memprof::hashCallStack(CS1), CS1}); 645 llvm::DenseMap<llvm::memprof::FrameId, llvm::memprof::FrameStat> 646 FrameHistogram = 647 llvm::memprof::computeFrameHistogram<FrameId>(MemProfCallStackData); 648 llvm::memprof::CallStackRadixTreeBuilder<FrameId> Builder; 649 Builder.build(std::move(MemProfCallStackData), MemProfFrameIndexes, 650 FrameHistogram); 651 EXPECT_THAT(Builder.getRadixArray(), testing::ElementsAreArray({ 652 3U, // Size of CS1, 653 3U, // MemProfFrameIndexes[13] 654 2U, // MemProfFrameIndexes[12] 655 1U // MemProfFrameIndexes[11] 656 })); 657 const auto Mappings = Builder.takeCallStackPos(); 658 ASSERT_THAT(Mappings, SizeIs(1)); 659 EXPECT_THAT(Mappings, testing::Contains(testing::Pair( 660 llvm::memprof::hashCallStack(CS1), 0U))); 661 } 662 663 // Verify CallStackRadixTreeBuilder can form a link between two call stacks. 664 TEST(MemProf, RadixTreeBuilderTwo) { 665 llvm::DenseMap<FrameId, llvm::memprof::LinearFrameId> MemProfFrameIndexes = { 666 {11, 1}, {12, 2}, {13, 3}}; 667 llvm::SmallVector<llvm::memprof::FrameId> CS1 = {12, 11}; 668 llvm::SmallVector<llvm::memprof::FrameId> CS2 = {13, 12, 11}; 669 llvm::MapVector<CallStackId, llvm::SmallVector<FrameId>> MemProfCallStackData; 670 MemProfCallStackData.insert({llvm::memprof::hashCallStack(CS1), CS1}); 671 MemProfCallStackData.insert({llvm::memprof::hashCallStack(CS2), CS2}); 672 llvm::DenseMap<llvm::memprof::FrameId, llvm::memprof::FrameStat> 673 FrameHistogram = 674 llvm::memprof::computeFrameHistogram<FrameId>(MemProfCallStackData); 675 llvm::memprof::CallStackRadixTreeBuilder<FrameId> Builder; 676 Builder.build(std::move(MemProfCallStackData), MemProfFrameIndexes, 677 FrameHistogram); 678 EXPECT_THAT(Builder.getRadixArray(), 679 testing::ElementsAreArray({ 680 2U, // Size of CS1 681 static_cast<uint32_t>(-3), // Jump 3 steps 682 3U, // Size of CS2 683 3U, // MemProfFrameIndexes[13] 684 2U, // MemProfFrameIndexes[12] 685 1U // MemProfFrameIndexes[11] 686 })); 687 const auto Mappings = Builder.takeCallStackPos(); 688 ASSERT_THAT(Mappings, SizeIs(2)); 689 EXPECT_THAT(Mappings, testing::Contains(testing::Pair( 690 llvm::memprof::hashCallStack(CS1), 0U))); 691 EXPECT_THAT(Mappings, testing::Contains(testing::Pair( 692 llvm::memprof::hashCallStack(CS2), 2U))); 693 } 694 695 // Verify CallStackRadixTreeBuilder can form a jump to a prefix that itself has 696 // another jump to another prefix. 697 TEST(MemProf, RadixTreeBuilderSuccessiveJumps) { 698 llvm::DenseMap<FrameId, llvm::memprof::LinearFrameId> MemProfFrameIndexes = { 699 {11, 1}, {12, 2}, {13, 3}, {14, 4}, {15, 5}, {16, 6}, {17, 7}, {18, 8}, 700 }; 701 llvm::SmallVector<llvm::memprof::FrameId> CS1 = {14, 13, 12, 11}; 702 llvm::SmallVector<llvm::memprof::FrameId> CS2 = {15, 13, 12, 11}; 703 llvm::SmallVector<llvm::memprof::FrameId> CS3 = {17, 16, 12, 11}; 704 llvm::SmallVector<llvm::memprof::FrameId> CS4 = {18, 16, 12, 11}; 705 llvm::MapVector<CallStackId, llvm::SmallVector<FrameId>> MemProfCallStackData; 706 MemProfCallStackData.insert({llvm::memprof::hashCallStack(CS1), CS1}); 707 MemProfCallStackData.insert({llvm::memprof::hashCallStack(CS2), CS2}); 708 MemProfCallStackData.insert({llvm::memprof::hashCallStack(CS3), CS3}); 709 MemProfCallStackData.insert({llvm::memprof::hashCallStack(CS4), CS4}); 710 llvm::DenseMap<llvm::memprof::FrameId, llvm::memprof::FrameStat> 711 FrameHistogram = 712 llvm::memprof::computeFrameHistogram<FrameId>(MemProfCallStackData); 713 llvm::memprof::CallStackRadixTreeBuilder<FrameId> Builder; 714 Builder.build(std::move(MemProfCallStackData), MemProfFrameIndexes, 715 FrameHistogram); 716 EXPECT_THAT(Builder.getRadixArray(), 717 testing::ElementsAreArray({ 718 4U, // Size of CS1 719 4U, // MemProfFrameIndexes[14] 720 static_cast<uint32_t>(-3), // Jump 3 steps 721 4U, // Size of CS2 722 5U, // MemProfFrameIndexes[15] 723 3U, // MemProfFrameIndexes[13] 724 static_cast<uint32_t>(-7), // Jump 7 steps 725 4U, // Size of CS3 726 7U, // MemProfFrameIndexes[17] 727 static_cast<uint32_t>(-3), // Jump 3 steps 728 4U, // Size of CS4 729 8U, // MemProfFrameIndexes[18] 730 6U, // MemProfFrameIndexes[16] 731 2U, // MemProfFrameIndexes[12] 732 1U // MemProfFrameIndexes[11] 733 })); 734 const auto Mappings = Builder.takeCallStackPos(); 735 ASSERT_THAT(Mappings, SizeIs(4)); 736 EXPECT_THAT(Mappings, testing::Contains(testing::Pair( 737 llvm::memprof::hashCallStack(CS1), 0U))); 738 EXPECT_THAT(Mappings, testing::Contains(testing::Pair( 739 llvm::memprof::hashCallStack(CS2), 3U))); 740 EXPECT_THAT(Mappings, testing::Contains(testing::Pair( 741 llvm::memprof::hashCallStack(CS3), 7U))); 742 EXPECT_THAT(Mappings, testing::Contains(testing::Pair( 743 llvm::memprof::hashCallStack(CS4), 10U))); 744 } 745 } // namespace 746