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