1 //=-- CoverageMapping.cpp - Code coverage mapping support ---------*- C++ -*-=//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains support for clang's and llvm's instrumentation based
13 //===----------------------------------------------------------------------===//
15 #include "llvm/ProfileData/CoverageMapping.h"
16 #include "llvm/ADT/DenseMap.h"
17 #include "llvm/ADT/Optional.h"
18 #include "llvm/ADT/SmallBitVector.h"
19 #include "llvm/ProfileData/CoverageMappingReader.h"
20 #include "llvm/ProfileData/InstrProfReader.h"
21 #include "llvm/Support/Debug.h"
22 #include "llvm/Support/ErrorHandling.h"
25 using namespace coverage;
27 #define DEBUG_TYPE "coverage-mapping"
29 Counter CounterExpressionBuilder::get(const CounterExpression &E) {
30 auto It = ExpressionIndices.find(E);
31 if (It != ExpressionIndices.end())
32 return Counter::getExpression(It->second);
33 unsigned I = Expressions.size();
34 Expressions.push_back(E);
35 ExpressionIndices[E] = I;
36 return Counter::getExpression(I);
39 void CounterExpressionBuilder::extractTerms(
40 Counter C, int Sign, SmallVectorImpl<std::pair<unsigned, int>> &Terms) {
41 switch (C.getKind()) {
44 case Counter::CounterValueReference:
45 Terms.push_back(std::make_pair(C.getCounterID(), Sign));
47 case Counter::Expression:
48 const auto &E = Expressions[C.getExpressionID()];
49 extractTerms(E.LHS, Sign, Terms);
50 extractTerms(E.RHS, E.Kind == CounterExpression::Subtract ? -Sign : Sign,
56 Counter CounterExpressionBuilder::simplify(Counter ExpressionTree) {
57 // Gather constant terms.
58 llvm::SmallVector<std::pair<unsigned, int>, 32> Terms;
59 extractTerms(ExpressionTree, +1, Terms);
61 // If there are no terms, this is just a zero. The algorithm below assumes at
63 if (Terms.size() == 0)
64 return Counter::getZero();
66 // Group the terms by counter ID.
67 std::sort(Terms.begin(), Terms.end(),
68 [](const std::pair<unsigned, int> &LHS,
69 const std::pair<unsigned, int> &RHS) {
70 return LHS.first < RHS.first;
73 // Combine terms by counter ID to eliminate counters that sum to zero.
74 auto Prev = Terms.begin();
75 for (auto I = Prev + 1, E = Terms.end(); I != E; ++I) {
76 if (I->first == Prev->first) {
77 Prev->second += I->second;
83 Terms.erase(++Prev, Terms.end());
86 // Create additions. We do this before subtractions to avoid constructs like
87 // ((0 - X) + Y), as opposed to (Y - X).
88 for (auto Term : Terms) {
91 for (int I = 0; I < Term.second; ++I)
93 C = Counter::getCounter(Term.first);
95 C = get(CounterExpression(CounterExpression::Add, C,
96 Counter::getCounter(Term.first)));
99 // Create subtractions.
100 for (auto Term : Terms) {
101 if (Term.second >= 0)
103 for (int I = 0; I < -Term.second; ++I)
104 C = get(CounterExpression(CounterExpression::Subtract, C,
105 Counter::getCounter(Term.first)));
110 Counter CounterExpressionBuilder::add(Counter LHS, Counter RHS) {
111 return simplify(get(CounterExpression(CounterExpression::Add, LHS, RHS)));
114 Counter CounterExpressionBuilder::subtract(Counter LHS, Counter RHS) {
116 get(CounterExpression(CounterExpression::Subtract, LHS, RHS)));
119 void CounterMappingContext::dump(const Counter &C,
120 llvm::raw_ostream &OS) const {
121 switch (C.getKind()) {
125 case Counter::CounterValueReference:
126 OS << '#' << C.getCounterID();
128 case Counter::Expression: {
129 if (C.getExpressionID() >= Expressions.size())
131 const auto &E = Expressions[C.getExpressionID()];
134 OS << (E.Kind == CounterExpression::Subtract ? " - " : " + ");
140 if (CounterValues.empty())
142 ErrorOr<int64_t> Value = evaluate(C);
145 OS << '[' << *Value << ']';
148 ErrorOr<int64_t> CounterMappingContext::evaluate(const Counter &C) const {
149 switch (C.getKind()) {
152 case Counter::CounterValueReference:
153 if (C.getCounterID() >= CounterValues.size())
154 return std::make_error_code(std::errc::argument_out_of_domain);
155 return CounterValues[C.getCounterID()];
156 case Counter::Expression: {
157 if (C.getExpressionID() >= Expressions.size())
158 return std::make_error_code(std::errc::argument_out_of_domain);
159 const auto &E = Expressions[C.getExpressionID()];
160 ErrorOr<int64_t> LHS = evaluate(E.LHS);
163 ErrorOr<int64_t> RHS = evaluate(E.RHS);
166 return E.Kind == CounterExpression::Subtract ? *LHS - *RHS : *LHS + *RHS;
169 llvm_unreachable("Unhandled CounterKind");
172 void FunctionRecordIterator::skipOtherFiles() {
173 while (Current != Records.end() && !Filename.empty() &&
174 Filename != Current->Filenames[0])
176 if (Current == Records.end())
177 *this = FunctionRecordIterator();
180 ErrorOr<std::unique_ptr<CoverageMapping>>
181 CoverageMapping::load(ObjectFileCoverageMappingReader &CoverageReader,
182 IndexedInstrProfReader &ProfileReader) {
183 auto Coverage = std::unique_ptr<CoverageMapping>(new CoverageMapping());
185 std::vector<uint64_t> Counts;
186 for (const auto &Record : CoverageReader) {
188 if (std::error_code EC = ProfileReader.getFunctionCounts(
189 Record.FunctionName, Record.FunctionHash, Counts)) {
190 if (EC != instrprof_error::hash_mismatch &&
191 EC != instrprof_error::unknown_function)
193 Coverage->MismatchedFunctionCount++;
197 assert(Counts.size() != 0 && "Function's counts are empty");
198 FunctionRecord Function(Record.FunctionName, Record.Filenames,
200 CounterMappingContext Ctx(Record.Expressions, Counts);
201 for (const auto &Region : Record.MappingRegions) {
202 ErrorOr<int64_t> ExecutionCount = Ctx.evaluate(Region.Count);
205 Function.CountedRegions.push_back(CountedRegion(Region, *ExecutionCount));
207 if (Function.CountedRegions.size() != Record.MappingRegions.size()) {
208 Coverage->MismatchedFunctionCount++;
212 Coverage->Functions.push_back(std::move(Function));
215 return std::move(Coverage);
218 ErrorOr<std::unique_ptr<CoverageMapping>>
219 CoverageMapping::load(StringRef ObjectFilename, StringRef ProfileFilename) {
220 auto CounterMappingBuff = MemoryBuffer::getFileOrSTDIN(ObjectFilename);
221 if (auto EC = CounterMappingBuff.getError())
223 ObjectFileCoverageMappingReader CoverageReader(CounterMappingBuff.get());
224 if (auto EC = CoverageReader.readHeader())
226 auto ProfileReaderOrErr = IndexedInstrProfReader::create(ProfileFilename);
227 if (auto EC = ProfileReaderOrErr.getError())
229 auto ProfileReader = std::move(ProfileReaderOrErr.get());
230 return load(CoverageReader, *ProfileReader);
234 /// \brief Distributes functions into instantiation sets.
236 /// An instantiation set is a collection of functions that have the same source
237 /// code, ie, template functions specializations.
238 class FunctionInstantiationSetCollector {
239 typedef DenseMap<std::pair<unsigned, unsigned>,
240 std::vector<const FunctionRecord *>> MapT;
241 MapT InstantiatedFunctions;
244 void insert(const FunctionRecord &Function, unsigned FileID) {
245 auto I = Function.CountedRegions.begin(), E = Function.CountedRegions.end();
246 while (I != E && I->FileID != FileID)
248 assert(I != E && "function does not cover the given file");
249 auto &Functions = InstantiatedFunctions[I->startLoc()];
250 Functions.push_back(&Function);
253 MapT::iterator begin() { return InstantiatedFunctions.begin(); }
255 MapT::iterator end() { return InstantiatedFunctions.end(); }
258 class SegmentBuilder {
259 std::vector<CoverageSegment> Segments;
260 SmallVector<const CountedRegion *, 8> ActiveRegions;
262 /// Start a segment with no count specified.
263 void startSegment(unsigned Line, unsigned Col) {
264 DEBUG(dbgs() << "Top level segment at " << Line << ":" << Col << "\n");
265 Segments.emplace_back(Line, Col, /*IsRegionEntry=*/false);
268 /// Start a segment with the given Region's count.
269 void startSegment(unsigned Line, unsigned Col, bool IsRegionEntry,
270 const CountedRegion &Region) {
271 if (Segments.empty())
272 Segments.emplace_back(Line, Col, IsRegionEntry);
273 CoverageSegment S = Segments.back();
274 // Avoid creating empty regions.
275 if (S.Line != Line || S.Col != Col) {
276 Segments.emplace_back(Line, Col, IsRegionEntry);
279 DEBUG(dbgs() << "Segment at " << Line << ":" << Col);
280 // Set this region's count.
281 if (Region.Kind != coverage::CounterMappingRegion::SkippedRegion) {
282 DEBUG(dbgs() << " with count " << Region.ExecutionCount);
283 Segments.back().setCount(Region.ExecutionCount);
285 DEBUG(dbgs() << "\n");
288 /// Start a segment for the given region.
289 void startSegment(const CountedRegion &Region) {
290 startSegment(Region.LineStart, Region.ColumnStart, true, Region);
293 /// Pop the top region off of the active stack, starting a new segment with
294 /// the containing Region's count.
296 const CountedRegion *Active = ActiveRegions.back();
297 unsigned Line = Active->LineEnd, Col = Active->ColumnEnd;
298 ActiveRegions.pop_back();
299 if (ActiveRegions.empty())
300 startSegment(Line, Col);
302 startSegment(Line, Col, false, *ActiveRegions.back());
306 /// Build a list of CoverageSegments from a sorted list of Regions.
307 std::vector<CoverageSegment> buildSegments(ArrayRef<CountedRegion> Regions) {
308 const CountedRegion *PrevRegion = nullptr;
309 for (const auto &Region : Regions) {
310 // Pop any regions that end before this one starts.
311 while (!ActiveRegions.empty() &&
312 ActiveRegions.back()->endLoc() <= Region.startLoc())
314 if (PrevRegion && PrevRegion->startLoc() == Region.startLoc() &&
315 PrevRegion->endLoc() == Region.endLoc()) {
316 if (Region.Kind != coverage::CounterMappingRegion::SkippedRegion)
317 Segments.back().addCount(Region.ExecutionCount);
319 // Add this region to the stack.
320 ActiveRegions.push_back(&Region);
321 startSegment(Region);
323 PrevRegion = &Region;
325 // Pop any regions that are left in the stack.
326 while (!ActiveRegions.empty())
333 std::vector<StringRef> CoverageMapping::getUniqueSourceFiles() const {
334 std::vector<StringRef> Filenames;
335 for (const auto &Function : getCoveredFunctions())
336 Filenames.insert(Filenames.end(), Function.Filenames.begin(),
337 Function.Filenames.end());
338 std::sort(Filenames.begin(), Filenames.end());
339 auto Last = std::unique(Filenames.begin(), Filenames.end());
340 Filenames.erase(Last, Filenames.end());
344 static SmallBitVector gatherFileIDs(StringRef SourceFile,
345 const FunctionRecord &Function) {
346 SmallBitVector FilenameEquivalence(Function.Filenames.size(), false);
347 for (unsigned I = 0, E = Function.Filenames.size(); I < E; ++I)
348 if (SourceFile == Function.Filenames[I])
349 FilenameEquivalence[I] = true;
350 return FilenameEquivalence;
353 static Optional<unsigned> findMainViewFileID(StringRef SourceFile,
354 const FunctionRecord &Function) {
355 SmallBitVector IsNotExpandedFile(Function.Filenames.size(), true);
356 SmallBitVector FilenameEquivalence = gatherFileIDs(SourceFile, Function);
357 for (const auto &CR : Function.CountedRegions)
358 if (CR.Kind == CounterMappingRegion::ExpansionRegion &&
359 FilenameEquivalence[CR.FileID])
360 IsNotExpandedFile[CR.ExpandedFileID] = false;
361 IsNotExpandedFile &= FilenameEquivalence;
362 int I = IsNotExpandedFile.find_first();
363 return I != -1 ? I : None;
366 static Optional<unsigned> findMainViewFileID(const FunctionRecord &Function) {
367 SmallBitVector IsNotExpandedFile(Function.Filenames.size(), true);
368 for (const auto &CR : Function.CountedRegions)
369 if (CR.Kind == CounterMappingRegion::ExpansionRegion)
370 IsNotExpandedFile[CR.ExpandedFileID] = false;
371 int I = IsNotExpandedFile.find_first();
372 return I != -1 ? I : None;
375 /// Sort a nested sequence of regions from a single file.
376 template <class It> static void sortNestedRegions(It First, It Last) {
377 std::sort(First, Last,
378 [](const CountedRegion &LHS, const CountedRegion &RHS) {
379 if (LHS.startLoc() == RHS.startLoc())
380 // When LHS completely contains RHS, we sort LHS first.
381 return RHS.endLoc() < LHS.endLoc();
382 return LHS.startLoc() < RHS.startLoc();
386 static bool isExpansion(const CountedRegion &R, unsigned FileID) {
387 return R.Kind == CounterMappingRegion::ExpansionRegion && R.FileID == FileID;
390 CoverageData CoverageMapping::getCoverageForFile(StringRef Filename) {
391 CoverageData FileCoverage(Filename);
392 std::vector<coverage::CountedRegion> Regions;
394 for (const auto &Function : Functions) {
395 auto MainFileID = findMainViewFileID(Filename, Function);
398 auto FileIDs = gatherFileIDs(Filename, Function);
399 for (const auto &CR : Function.CountedRegions)
400 if (FileIDs.test(CR.FileID)) {
401 Regions.push_back(CR);
402 if (isExpansion(CR, *MainFileID))
403 FileCoverage.Expansions.emplace_back(CR, Function);
407 sortNestedRegions(Regions.begin(), Regions.end());
408 DEBUG(dbgs() << "Emitting segments for file: " << Filename << "\n");
409 FileCoverage.Segments = SegmentBuilder().buildSegments(Regions);
414 std::vector<const FunctionRecord *>
415 CoverageMapping::getInstantiations(StringRef Filename) {
416 FunctionInstantiationSetCollector InstantiationSetCollector;
417 for (const auto &Function : Functions) {
418 auto MainFileID = findMainViewFileID(Filename, Function);
421 InstantiationSetCollector.insert(Function, *MainFileID);
424 std::vector<const FunctionRecord *> Result;
425 for (const auto &InstantiationSet : InstantiationSetCollector) {
426 if (InstantiationSet.second.size() < 2)
428 Result.insert(Result.end(), InstantiationSet.second.begin(),
429 InstantiationSet.second.end());
435 CoverageMapping::getCoverageForFunction(const FunctionRecord &Function) {
436 auto MainFileID = findMainViewFileID(Function);
438 return CoverageData();
440 CoverageData FunctionCoverage(Function.Filenames[*MainFileID]);
441 std::vector<coverage::CountedRegion> Regions;
442 for (const auto &CR : Function.CountedRegions)
443 if (CR.FileID == *MainFileID) {
444 Regions.push_back(CR);
445 if (isExpansion(CR, *MainFileID))
446 FunctionCoverage.Expansions.emplace_back(CR, Function);
449 sortNestedRegions(Regions.begin(), Regions.end());
450 DEBUG(dbgs() << "Emitting segments for function: " << Function.Name << "\n");
451 FunctionCoverage.Segments = SegmentBuilder().buildSegments(Regions);
453 return FunctionCoverage;
457 CoverageMapping::getCoverageForExpansion(const ExpansionRecord &Expansion) {
458 CoverageData ExpansionCoverage(
459 Expansion.Function.Filenames[Expansion.FileID]);
460 std::vector<coverage::CountedRegion> Regions;
461 for (const auto &CR : Expansion.Function.CountedRegions)
462 if (CR.FileID == Expansion.FileID) {
463 Regions.push_back(CR);
464 if (isExpansion(CR, Expansion.FileID))
465 ExpansionCoverage.Expansions.emplace_back(CR, Expansion.Function);
468 sortNestedRegions(Regions.begin(), Regions.end());
469 DEBUG(dbgs() << "Emitting segments for expansion of file " << Expansion.FileID
471 ExpansionCoverage.Segments = SegmentBuilder().buildSegments(Regions);
473 return ExpansionCoverage;