SampleProfTest.cpp 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203
  1. //===- unittest/ProfileData/SampleProfTest.cpp ------------------*- C++ -*-===//
  2. //
  3. // The LLVM Compiler Infrastructure
  4. //
  5. // This file is distributed under the University of Illinois Open Source
  6. // License. See LICENSE.TXT for details.
  7. //
  8. //===----------------------------------------------------------------------===//
  9. #include "llvm/ADT/StringMap.h"
  10. #include "llvm/ADT/StringRef.h"
  11. #include "llvm/IR/LLVMContext.h"
  12. #include "llvm/IR/Metadata.h"
  13. #include "llvm/IR/Module.h"
  14. #include "llvm/ProfileData/ProfileCommon.h"
  15. #include "llvm/ProfileData/SampleProf.h"
  16. #include "llvm/ProfileData/SampleProfReader.h"
  17. #include "llvm/ProfileData/SampleProfWriter.h"
  18. #include "llvm/Support/Casting.h"
  19. #include "llvm/Support/ErrorOr.h"
  20. #include "llvm/Support/MemoryBuffer.h"
  21. #include "llvm/Support/raw_ostream.h"
  22. #include "gtest/gtest.h"
  23. #include <algorithm>
  24. #include <cstdint>
  25. #include <limits>
  26. #include <memory>
  27. #include <string>
  28. #include <system_error>
  29. #include <vector>
  30. using namespace llvm;
  31. using namespace sampleprof;
  32. static ::testing::AssertionResult NoError(std::error_code EC) {
  33. if (!EC)
  34. return ::testing::AssertionSuccess();
  35. return ::testing::AssertionFailure() << "error " << EC.value() << ": "
  36. << EC.message();
  37. }
  38. namespace {
  39. struct SampleProfTest : ::testing::Test {
  40. std::string Data;
  41. LLVMContext Context;
  42. std::unique_ptr<raw_ostream> OS;
  43. std::unique_ptr<SampleProfileWriter> Writer;
  44. std::unique_ptr<SampleProfileReader> Reader;
  45. SampleProfTest()
  46. : Data(), OS(new raw_string_ostream(Data)), Writer(), Reader() {}
  47. void createWriter(SampleProfileFormat Format) {
  48. auto WriterOrErr = SampleProfileWriter::create(OS, Format);
  49. ASSERT_TRUE(NoError(WriterOrErr.getError()));
  50. Writer = std::move(WriterOrErr.get());
  51. }
  52. void readProfile(std::unique_ptr<MemoryBuffer> &Profile) {
  53. auto ReaderOrErr = SampleProfileReader::create(Profile, Context);
  54. ASSERT_TRUE(NoError(ReaderOrErr.getError()));
  55. Reader = std::move(ReaderOrErr.get());
  56. }
  57. void testRoundTrip(SampleProfileFormat Format) {
  58. createWriter(Format);
  59. StringRef FooName("_Z3fooi");
  60. FunctionSamples FooSamples;
  61. FooSamples.setName(FooName);
  62. FooSamples.addTotalSamples(7711);
  63. FooSamples.addHeadSamples(610);
  64. FooSamples.addBodySamples(1, 0, 610);
  65. FooSamples.addBodySamples(2, 0, 600);
  66. FooSamples.addBodySamples(4, 0, 60000);
  67. FooSamples.addBodySamples(8, 0, 60351);
  68. FooSamples.addBodySamples(10, 0, 605);
  69. StringRef BarName("_Z3bari");
  70. FunctionSamples BarSamples;
  71. BarSamples.setName(BarName);
  72. BarSamples.addTotalSamples(20301);
  73. BarSamples.addHeadSamples(1437);
  74. BarSamples.addBodySamples(1, 0, 1437);
  75. StringMap<FunctionSamples> Profiles;
  76. Profiles[FooName] = std::move(FooSamples);
  77. Profiles[BarName] = std::move(BarSamples);
  78. std::error_code EC;
  79. EC = Writer->write(Profiles);
  80. ASSERT_TRUE(NoError(EC));
  81. Writer->getOutputStream().flush();
  82. auto Profile = MemoryBuffer::getMemBufferCopy(Data);
  83. readProfile(Profile);
  84. EC = Reader->read();
  85. ASSERT_TRUE(NoError(EC));
  86. StringMap<FunctionSamples> &ReadProfiles = Reader->getProfiles();
  87. ASSERT_EQ(2u, ReadProfiles.size());
  88. FunctionSamples &ReadFooSamples = ReadProfiles[FooName];
  89. ASSERT_EQ(7711u, ReadFooSamples.getTotalSamples());
  90. ASSERT_EQ(610u, ReadFooSamples.getHeadSamples());
  91. FunctionSamples &ReadBarSamples = ReadProfiles[BarName];
  92. ASSERT_EQ(20301u, ReadBarSamples.getTotalSamples());
  93. ASSERT_EQ(1437u, ReadBarSamples.getHeadSamples());
  94. auto VerifySummary = [](ProfileSummary &Summary) mutable {
  95. ASSERT_EQ(ProfileSummary::PSK_Sample, Summary.getKind());
  96. ASSERT_EQ(123603u, Summary.getTotalCount());
  97. ASSERT_EQ(6u, Summary.getNumCounts());
  98. ASSERT_EQ(2u, Summary.getNumFunctions());
  99. ASSERT_EQ(1437u, Summary.getMaxFunctionCount());
  100. ASSERT_EQ(60351u, Summary.getMaxCount());
  101. uint32_t Cutoff = 800000;
  102. auto Predicate = [&Cutoff](const ProfileSummaryEntry &PE) {
  103. return PE.Cutoff == Cutoff;
  104. };
  105. std::vector<ProfileSummaryEntry> &Details = Summary.getDetailedSummary();
  106. auto EightyPerc = std::find_if(Details.begin(), Details.end(), Predicate);
  107. Cutoff = 900000;
  108. auto NinetyPerc = std::find_if(Details.begin(), Details.end(), Predicate);
  109. Cutoff = 950000;
  110. auto NinetyFivePerc =
  111. std::find_if(Details.begin(), Details.end(), Predicate);
  112. Cutoff = 990000;
  113. auto NinetyNinePerc =
  114. std::find_if(Details.begin(), Details.end(), Predicate);
  115. ASSERT_EQ(60000u, EightyPerc->MinCount);
  116. ASSERT_EQ(60000u, NinetyPerc->MinCount);
  117. ASSERT_EQ(60000u, NinetyFivePerc->MinCount);
  118. ASSERT_EQ(610u, NinetyNinePerc->MinCount);
  119. };
  120. ProfileSummary &Summary = Reader->getSummary();
  121. VerifySummary(Summary);
  122. // Test that conversion of summary to and from Metadata works.
  123. Metadata *MD = Summary.getMD(Context);
  124. ASSERT_TRUE(MD);
  125. ProfileSummary *PS = ProfileSummary::getFromMD(MD);
  126. ASSERT_TRUE(PS);
  127. VerifySummary(*PS);
  128. delete PS;
  129. // Test that summary can be attached to and read back from module.
  130. Module M("my_module", Context);
  131. M.setProfileSummary(MD);
  132. MD = M.getProfileSummary();
  133. ASSERT_TRUE(MD);
  134. PS = ProfileSummary::getFromMD(MD);
  135. ASSERT_TRUE(PS);
  136. VerifySummary(*PS);
  137. delete PS;
  138. }
  139. };
  140. TEST_F(SampleProfTest, roundtrip_text_profile) {
  141. testRoundTrip(SampleProfileFormat::SPF_Text);
  142. }
  143. TEST_F(SampleProfTest, roundtrip_binary_profile) {
  144. testRoundTrip(SampleProfileFormat::SPF_Binary);
  145. }
  146. TEST_F(SampleProfTest, sample_overflow_saturation) {
  147. const uint64_t Max = std::numeric_limits<uint64_t>::max();
  148. sampleprof_error Result;
  149. StringRef FooName("_Z3fooi");
  150. FunctionSamples FooSamples;
  151. Result = FooSamples.addTotalSamples(1);
  152. ASSERT_EQ(Result, sampleprof_error::success);
  153. Result = FooSamples.addHeadSamples(1);
  154. ASSERT_EQ(Result, sampleprof_error::success);
  155. Result = FooSamples.addBodySamples(10, 0, 1);
  156. ASSERT_EQ(Result, sampleprof_error::success);
  157. Result = FooSamples.addTotalSamples(Max);
  158. ASSERT_EQ(Result, sampleprof_error::counter_overflow);
  159. ASSERT_EQ(FooSamples.getTotalSamples(), Max);
  160. Result = FooSamples.addHeadSamples(Max);
  161. ASSERT_EQ(Result, sampleprof_error::counter_overflow);
  162. ASSERT_EQ(FooSamples.getHeadSamples(), Max);
  163. Result = FooSamples.addBodySamples(10, 0, Max);
  164. ASSERT_EQ(Result, sampleprof_error::counter_overflow);
  165. ErrorOr<uint64_t> BodySamples = FooSamples.findSamplesAt(10, 0);
  166. ASSERT_FALSE(BodySamples.getError());
  167. ASSERT_EQ(BodySamples.get(), Max);
  168. }
  169. } // end anonymous namespace