1 //===- unittest/ProfileData/CoverageMappingTest.cpp -------------------------=//
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 
10 #include "llvm/ProfileData/CoverageMapping.h"
11 #include "llvm/ProfileData/CoverageMappingReader.h"
12 #include "llvm/ProfileData/CoverageMappingWriter.h"
13 #include "llvm/ProfileData/InstrProfReader.h"
14 #include "llvm/ProfileData/InstrProfWriter.h"
15 #include "llvm/Support/raw_ostream.h"
16 #include "gtest/gtest.h"
17 
18 #include <sstream>
19 
20 using namespace llvm;
21 using namespace coverage;
22 
23 static ::testing::AssertionResult NoError(std::error_code EC) {
24   if (!EC)
25     return ::testing::AssertionSuccess();
26   return ::testing::AssertionFailure() << "error " << EC.value()
27                                        << ": " << EC.message();
28 }
29 
30 namespace llvm {
31 namespace coverage {
32 void PrintTo(const Counter &C, ::std::ostream *os) {
33   if (C.isZero())
34     *os << "Zero";
35   else if (C.isExpression())
36     *os << "Expression " << C.getExpressionID();
37   else
38     *os << "Counter " << C.getCounterID();
39 }
40 
41 void PrintTo(const CoverageSegment &S, ::std::ostream *os) {
42   *os << "CoverageSegment(" << S.Line << ", " << S.Col << ", ";
43   if (S.HasCount)
44     *os << S.Count << ", ";
45   *os << (S.IsRegionEntry ? "true" : "false") << ")";
46 }
47 }
48 }
49 
50 namespace {
51 
52 struct OneFunctionCoverageReader : CoverageMappingReader {
53   StringRef Name;
54   uint64_t Hash;
55   std::vector<StringRef> Filenames;
56   ArrayRef<CounterMappingRegion> Regions;
57   bool Done;
58 
59   OneFunctionCoverageReader(StringRef Name, uint64_t Hash,
60                             ArrayRef<StringRef> Filenames,
61                             ArrayRef<CounterMappingRegion> Regions)
62       : Name(Name), Hash(Hash), Filenames(Filenames), Regions(Regions),
63         Done(false) {}
64 
65   std::error_code readNextRecord(CoverageMappingRecord &Record) override {
66     if (Done)
67       return instrprof_error::eof;
68     Done = true;
69 
70     Record.FunctionName = Name;
71     Record.FunctionHash = Hash;
72     Record.Filenames = Filenames;
73     Record.Expressions = {};
74     Record.MappingRegions = Regions;
75     return instrprof_error::success;
76   }
77 };
78 
79 struct CoverageMappingTest : ::testing::Test {
80   StringMap<unsigned> Files;
81   unsigned NextFile;
82   std::vector<CounterMappingRegion> InputCMRs;
83 
84   std::vector<StringRef> OutputFiles;
85   std::vector<CounterExpression> OutputExpressions;
86   std::vector<CounterMappingRegion> OutputCMRs;
87 
88   InstrProfWriter ProfileWriter;
89   std::unique_ptr<IndexedInstrProfReader> ProfileReader;
90 
91   std::unique_ptr<CoverageMapping> LoadedCoverage;
92 
93   void SetUp() override {
94     NextFile = 0;
95     ProfileWriter.setOutputSparse(false);
96   }
97 
98   unsigned getFile(StringRef Name) {
99     auto R = Files.find(Name);
100     if (R != Files.end())
101       return R->second;
102     Files[Name] = NextFile;
103     return NextFile++;
104   }
105 
106   void addCMR(Counter C, StringRef File, unsigned LS, unsigned CS, unsigned LE,
107               unsigned CE) {
108     InputCMRs.push_back(
109         CounterMappingRegion::makeRegion(C, getFile(File), LS, CS, LE, CE));
110   }
111 
112   void addExpansionCMR(StringRef File, StringRef ExpandedFile, unsigned LS,
113                        unsigned CS, unsigned LE, unsigned CE) {
114     InputCMRs.push_back(CounterMappingRegion::makeExpansion(
115         getFile(File), getFile(ExpandedFile), LS, CS, LE, CE));
116   }
117 
118   std::string writeCoverageRegions() {
119     SmallVector<unsigned, 8> FileIDs;
120     for (const auto &E : Files)
121       FileIDs.push_back(E.getValue());
122     std::string Coverage;
123     llvm::raw_string_ostream OS(Coverage);
124     CoverageMappingWriter(FileIDs, None, InputCMRs).write(OS);
125     return OS.str();
126   }
127 
128   void readCoverageRegions(std::string Coverage) {
129     SmallVector<StringRef, 8> Filenames;
130     for (const auto &E : Files)
131       Filenames.push_back(E.getKey());
132     RawCoverageMappingReader Reader(Coverage, Filenames, OutputFiles,
133                                     OutputExpressions, OutputCMRs);
134     ASSERT_TRUE(NoError(Reader.read()));
135   }
136 
137   void readProfCounts() {
138     auto Profile = ProfileWriter.writeBuffer();
139     auto ReaderOrErr = IndexedInstrProfReader::create(std::move(Profile));
140     ASSERT_TRUE(NoError(ReaderOrErr.getError()));
141     ProfileReader = std::move(ReaderOrErr.get());
142   }
143 
144   void loadCoverageMapping(StringRef FuncName, uint64_t Hash,
145                            bool EmitFilenames = true) {
146     std::string Regions = writeCoverageRegions();
147     readCoverageRegions(Regions);
148 
149     SmallVector<StringRef, 8> Filenames;
150     if (EmitFilenames)
151       for (const auto &E : Files)
152         Filenames.push_back(E.getKey());
153     OneFunctionCoverageReader CovReader(FuncName, Hash, Filenames, OutputCMRs);
154     auto CoverageOrErr = CoverageMapping::load(CovReader, *ProfileReader);
155     ASSERT_TRUE(NoError(CoverageOrErr.getError()));
156     LoadedCoverage = std::move(CoverageOrErr.get());
157   }
158 };
159 
160 struct MaybeSparseCoverageMappingTest
161     : public CoverageMappingTest,
162       public ::testing::WithParamInterface<bool> {
163   void SetUp() {
164     CoverageMappingTest::SetUp();
165     ProfileWriter.setOutputSparse(GetParam());
166   }
167 };
168 
169 TEST_P(MaybeSparseCoverageMappingTest, basic_write_read) {
170   addCMR(Counter::getCounter(0), "foo", 1, 1, 1, 1);
171   addCMR(Counter::getCounter(1), "foo", 2, 1, 2, 2);
172   addCMR(Counter::getZero(),     "foo", 3, 1, 3, 4);
173   addCMR(Counter::getCounter(2), "foo", 4, 1, 4, 8);
174   addCMR(Counter::getCounter(3), "bar", 1, 2, 3, 4);
175   std::string Coverage = writeCoverageRegions();
176   readCoverageRegions(Coverage);
177 
178   size_t N = makeArrayRef(InputCMRs).size();
179   ASSERT_EQ(N, OutputCMRs.size());
180   for (size_t I = 0; I < N; ++I) {
181     ASSERT_EQ(InputCMRs[I].Count,      OutputCMRs[I].Count);
182     ASSERT_EQ(InputCMRs[I].FileID,     OutputCMRs[I].FileID);
183     ASSERT_EQ(InputCMRs[I].startLoc(), OutputCMRs[I].startLoc());
184     ASSERT_EQ(InputCMRs[I].endLoc(),   OutputCMRs[I].endLoc());
185     ASSERT_EQ(InputCMRs[I].Kind,       OutputCMRs[I].Kind);
186   }
187 }
188 
189 TEST_P(MaybeSparseCoverageMappingTest, expansion_gets_first_counter) {
190   addCMR(Counter::getCounter(1), "foo", 10, 1, 10, 2);
191   // This starts earlier in "foo", so the expansion should get its counter.
192   addCMR(Counter::getCounter(2), "foo", 1, 1, 20, 1);
193   addExpansionCMR("bar", "foo", 3, 3, 3, 3);
194   std::string Coverage = writeCoverageRegions();
195   readCoverageRegions(Coverage);
196 
197   ASSERT_EQ(CounterMappingRegion::ExpansionRegion, OutputCMRs[2].Kind);
198   ASSERT_EQ(Counter::getCounter(2), OutputCMRs[2].Count);
199   ASSERT_EQ(3U, OutputCMRs[2].LineStart);
200 }
201 
202 TEST_P(MaybeSparseCoverageMappingTest, basic_coverage_iteration) {
203   InstrProfRecord Record("func", 0x1234, {30, 20, 10, 0});
204   ProfileWriter.addRecord(std::move(Record));
205   readProfCounts();
206 
207   addCMR(Counter::getCounter(0), "file1", 1, 1, 9, 9);
208   addCMR(Counter::getCounter(1), "file1", 1, 1, 4, 7);
209   addCMR(Counter::getCounter(2), "file1", 5, 8, 9, 1);
210   addCMR(Counter::getCounter(3), "file1", 10, 10, 11, 11);
211   loadCoverageMapping("func", 0x1234);
212 
213   CoverageData Data = LoadedCoverage->getCoverageForFile("file1");
214   std::vector<CoverageSegment> Segments(Data.begin(), Data.end());
215   ASSERT_EQ(7U, Segments.size());
216   ASSERT_EQ(CoverageSegment(1, 1, 20, true),  Segments[0]);
217   ASSERT_EQ(CoverageSegment(4, 7, 30, false), Segments[1]);
218   ASSERT_EQ(CoverageSegment(5, 8, 10, true),  Segments[2]);
219   ASSERT_EQ(CoverageSegment(9, 1, 30, false), Segments[3]);
220   ASSERT_EQ(CoverageSegment(9, 9, false),     Segments[4]);
221   ASSERT_EQ(CoverageSegment(10, 10, 0, true), Segments[5]);
222   ASSERT_EQ(CoverageSegment(11, 11, false),   Segments[6]);
223 }
224 
225 TEST_P(MaybeSparseCoverageMappingTest, uncovered_function) {
226   readProfCounts();
227 
228   addCMR(Counter::getZero(), "file1", 1, 2, 3, 4);
229   loadCoverageMapping("func", 0x1234);
230 
231   CoverageData Data = LoadedCoverage->getCoverageForFile("file1");
232   std::vector<CoverageSegment> Segments(Data.begin(), Data.end());
233   ASSERT_EQ(2U, Segments.size());
234   ASSERT_EQ(CoverageSegment(1, 2, 0, true), Segments[0]);
235   ASSERT_EQ(CoverageSegment(3, 4, false),   Segments[1]);
236 }
237 
238 TEST_P(MaybeSparseCoverageMappingTest, uncovered_function_with_mapping) {
239   readProfCounts();
240 
241   addCMR(Counter::getCounter(0), "file1", 1, 1, 9, 9);
242   addCMR(Counter::getCounter(1), "file1", 1, 1, 4, 7);
243   loadCoverageMapping("func", 0x1234);
244 
245   CoverageData Data = LoadedCoverage->getCoverageForFile("file1");
246   std::vector<CoverageSegment> Segments(Data.begin(), Data.end());
247   ASSERT_EQ(3U, Segments.size());
248   ASSERT_EQ(CoverageSegment(1, 1, 0, true),  Segments[0]);
249   ASSERT_EQ(CoverageSegment(4, 7, 0, false), Segments[1]);
250   ASSERT_EQ(CoverageSegment(9, 9, false),    Segments[2]);
251 }
252 
253 TEST_P(MaybeSparseCoverageMappingTest, combine_regions) {
254   InstrProfRecord Record("func", 0x1234, {10, 20, 30});
255   ProfileWriter.addRecord(std::move(Record));
256   readProfCounts();
257 
258   addCMR(Counter::getCounter(0), "file1", 1, 1, 9, 9);
259   addCMR(Counter::getCounter(1), "file1", 3, 3, 4, 4);
260   addCMR(Counter::getCounter(2), "file1", 3, 3, 4, 4);
261   loadCoverageMapping("func", 0x1234);
262 
263   CoverageData Data = LoadedCoverage->getCoverageForFile("file1");
264   std::vector<CoverageSegment> Segments(Data.begin(), Data.end());
265   ASSERT_EQ(4U, Segments.size());
266   ASSERT_EQ(CoverageSegment(1, 1, 10, true), Segments[0]);
267   ASSERT_EQ(CoverageSegment(3, 3, 50, true), Segments[1]);
268   ASSERT_EQ(CoverageSegment(4, 4, 10, false), Segments[2]);
269   ASSERT_EQ(CoverageSegment(9, 9, false), Segments[3]);
270 }
271 
272 TEST_P(MaybeSparseCoverageMappingTest, dont_combine_expansions) {
273   InstrProfRecord Record1("func", 0x1234, {10, 20});
274   InstrProfRecord Record2("func", 0x1234, {0, 0});
275   ProfileWriter.addRecord(std::move(Record1));
276   ProfileWriter.addRecord(std::move(Record2));
277   readProfCounts();
278 
279   addCMR(Counter::getCounter(0), "file1", 1, 1, 9, 9);
280   addCMR(Counter::getCounter(1), "file1", 3, 3, 4, 4);
281   addCMR(Counter::getCounter(1), "include1", 6, 6, 7, 7);
282   addExpansionCMR("file1", "include1", 3, 3, 4, 4);
283   loadCoverageMapping("func", 0x1234);
284 
285   CoverageData Data = LoadedCoverage->getCoverageForFile("file1");
286   std::vector<CoverageSegment> Segments(Data.begin(), Data.end());
287   ASSERT_EQ(4U, Segments.size());
288   ASSERT_EQ(CoverageSegment(1, 1, 10, true), Segments[0]);
289   ASSERT_EQ(CoverageSegment(3, 3, 20, true), Segments[1]);
290   ASSERT_EQ(CoverageSegment(4, 4, 10, false), Segments[2]);
291   ASSERT_EQ(CoverageSegment(9, 9, false), Segments[3]);
292 }
293 
294 TEST_P(MaybeSparseCoverageMappingTest, strip_filename_prefix) {
295   InstrProfRecord Record("file1:func", 0x1234, {0});
296   ProfileWriter.addRecord(std::move(Record));
297   readProfCounts();
298 
299   addCMR(Counter::getCounter(0), "file1", 1, 1, 9, 9);
300   loadCoverageMapping("file1:func", 0x1234);
301 
302   std::vector<std::string> Names;
303   for (const auto &Func : LoadedCoverage->getCoveredFunctions())
304     Names.push_back(Func.Name);
305   ASSERT_EQ(1U, Names.size());
306   ASSERT_EQ("func", Names[0]);
307 }
308 
309 TEST_P(MaybeSparseCoverageMappingTest, strip_unknown_filename_prefix) {
310   InstrProfRecord Record("<unknown>:func", 0x1234, {0});
311   ProfileWriter.addRecord(std::move(Record));
312   readProfCounts();
313 
314   addCMR(Counter::getCounter(0), "", 1, 1, 9, 9);
315   loadCoverageMapping("<unknown>:func", 0x1234, /*EmitFilenames=*/false);
316 
317   std::vector<std::string> Names;
318   for (const auto &Func : LoadedCoverage->getCoveredFunctions())
319     Names.push_back(Func.Name);
320   ASSERT_EQ(1U, Names.size());
321   ASSERT_EQ("func", Names[0]);
322 }
323 
324 INSTANTIATE_TEST_CASE_P(MaybeSparse, MaybeSparseCoverageMappingTest,
325                         ::testing::Bool());
326 
327 } // end anonymous namespace
328