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(CoverageMappingReader &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) {
187 CounterMappingContext Ctx(Record.Expressions);
190 if (std::error_code EC = ProfileReader.getFunctionCounts(
191 Record.FunctionName, Record.FunctionHash, Counts)) {
192 if (EC == instrprof_error::hash_mismatch) {
193 Coverage->MismatchedFunctionCount++;
195 } else if (EC != instrprof_error::unknown_function)
198 Ctx.setCounts(Counts);
200 assert(!Record.MappingRegions.empty() && "Function has no regions");
201 FunctionRecord Function(Record.FunctionName, Record.Filenames);
202 for (const auto &Region : Record.MappingRegions) {
203 ErrorOr<int64_t> ExecutionCount = Ctx.evaluate(Region.Count);
206 Function.pushRegion(Region, *ExecutionCount);
208 if (Function.CountedRegions.size() != Record.MappingRegions.size()) {
209 Coverage->MismatchedFunctionCount++;
213 Coverage->Functions.push_back(std::move(Function));
216 return std::move(Coverage);
219 ErrorOr<std::unique_ptr<CoverageMapping>>
220 CoverageMapping::load(StringRef ObjectFilename, StringRef ProfileFilename) {
221 auto CounterMappingBuff = MemoryBuffer::getFileOrSTDIN(ObjectFilename);
222 if (std::error_code EC = CounterMappingBuff.getError())
224 auto CoverageReaderOrErr =
225 BinaryCoverageReader::create(CounterMappingBuff.get());
226 if (std::error_code EC = CoverageReaderOrErr.getError())
228 auto CoverageReader = std::move(CoverageReaderOrErr.get());
229 auto ProfileReaderOrErr = IndexedInstrProfReader::create(ProfileFilename);
230 if (auto EC = ProfileReaderOrErr.getError())
232 auto ProfileReader = std::move(ProfileReaderOrErr.get());
233 return load(*CoverageReader, *ProfileReader);
237 /// \brief Distributes functions into instantiation sets.
239 /// An instantiation set is a collection of functions that have the same source
240 /// code, ie, template functions specializations.
241 class FunctionInstantiationSetCollector {
242 typedef DenseMap<std::pair<unsigned, unsigned>,
243 std::vector<const FunctionRecord *>> MapT;
244 MapT InstantiatedFunctions;
247 void insert(const FunctionRecord &Function, unsigned FileID) {
248 auto I = Function.CountedRegions.begin(), E = Function.CountedRegions.end();
249 while (I != E && I->FileID != FileID)
251 assert(I != E && "function does not cover the given file");
252 auto &Functions = InstantiatedFunctions[I->startLoc()];
253 Functions.push_back(&Function);
256 MapT::iterator begin() { return InstantiatedFunctions.begin(); }
258 MapT::iterator end() { return InstantiatedFunctions.end(); }
261 class SegmentBuilder {
262 std::vector<CoverageSegment> Segments;
263 SmallVector<const CountedRegion *, 8> ActiveRegions;
265 /// Start a segment with no count specified.
266 void startSegment(unsigned Line, unsigned Col) {
267 DEBUG(dbgs() << "Top level segment at " << Line << ":" << Col << "\n");
268 Segments.emplace_back(Line, Col, /*IsRegionEntry=*/false);
271 /// Start a segment with the given Region's count.
272 void startSegment(unsigned Line, unsigned Col, bool IsRegionEntry,
273 const CountedRegion &Region) {
274 if (Segments.empty())
275 Segments.emplace_back(Line, Col, IsRegionEntry);
276 CoverageSegment S = Segments.back();
277 // Avoid creating empty regions.
278 if (S.Line != Line || S.Col != Col) {
279 Segments.emplace_back(Line, Col, IsRegionEntry);
282 DEBUG(dbgs() << "Segment at " << Line << ":" << Col);
283 // Set this region's count.
284 if (Region.Kind != coverage::CounterMappingRegion::SkippedRegion) {
285 DEBUG(dbgs() << " with count " << Region.ExecutionCount);
286 Segments.back().setCount(Region.ExecutionCount);
288 DEBUG(dbgs() << "\n");
291 /// Start a segment for the given region.
292 void startSegment(const CountedRegion &Region) {
293 startSegment(Region.LineStart, Region.ColumnStart, true, Region);
296 /// Pop the top region off of the active stack, starting a new segment with
297 /// the containing Region's count.
299 const CountedRegion *Active = ActiveRegions.back();
300 unsigned Line = Active->LineEnd, Col = Active->ColumnEnd;
301 ActiveRegions.pop_back();
302 if (ActiveRegions.empty())
303 startSegment(Line, Col);
305 startSegment(Line, Col, false, *ActiveRegions.back());
309 /// Build a list of CoverageSegments from a sorted list of Regions.
310 std::vector<CoverageSegment> buildSegments(ArrayRef<CountedRegion> Regions) {
311 const CountedRegion *PrevRegion = nullptr;
312 for (const auto &Region : Regions) {
313 // Pop any regions that end before this one starts.
314 while (!ActiveRegions.empty() &&
315 ActiveRegions.back()->endLoc() <= Region.startLoc())
317 if (PrevRegion && PrevRegion->startLoc() == Region.startLoc() &&
318 PrevRegion->endLoc() == Region.endLoc()) {
319 if (Region.Kind == coverage::CounterMappingRegion::CodeRegion)
320 Segments.back().addCount(Region.ExecutionCount);
322 // Add this region to the stack.
323 ActiveRegions.push_back(&Region);
324 startSegment(Region);
326 PrevRegion = &Region;
328 // Pop any regions that are left in the stack.
329 while (!ActiveRegions.empty())
336 std::vector<StringRef> CoverageMapping::getUniqueSourceFiles() const {
337 std::vector<StringRef> Filenames;
338 for (const auto &Function : getCoveredFunctions())
339 Filenames.insert(Filenames.end(), Function.Filenames.begin(),
340 Function.Filenames.end());
341 std::sort(Filenames.begin(), Filenames.end());
342 auto Last = std::unique(Filenames.begin(), Filenames.end());
343 Filenames.erase(Last, Filenames.end());
347 static SmallBitVector gatherFileIDs(StringRef SourceFile,
348 const FunctionRecord &Function) {
349 SmallBitVector FilenameEquivalence(Function.Filenames.size(), false);
350 for (unsigned I = 0, E = Function.Filenames.size(); I < E; ++I)
351 if (SourceFile == Function.Filenames[I])
352 FilenameEquivalence[I] = true;
353 return FilenameEquivalence;
356 static Optional<unsigned> findMainViewFileID(StringRef SourceFile,
357 const FunctionRecord &Function) {
358 SmallBitVector IsNotExpandedFile(Function.Filenames.size(), true);
359 SmallBitVector FilenameEquivalence = gatherFileIDs(SourceFile, Function);
360 for (const auto &CR : Function.CountedRegions)
361 if (CR.Kind == CounterMappingRegion::ExpansionRegion &&
362 FilenameEquivalence[CR.FileID])
363 IsNotExpandedFile[CR.ExpandedFileID] = false;
364 IsNotExpandedFile &= FilenameEquivalence;
365 int I = IsNotExpandedFile.find_first();
371 static Optional<unsigned> findMainViewFileID(const FunctionRecord &Function) {
372 SmallBitVector IsNotExpandedFile(Function.Filenames.size(), true);
373 for (const auto &CR : Function.CountedRegions)
374 if (CR.Kind == CounterMappingRegion::ExpansionRegion)
375 IsNotExpandedFile[CR.ExpandedFileID] = false;
376 int I = IsNotExpandedFile.find_first();
382 /// Sort a nested sequence of regions from a single file.
383 template <class It> static void sortNestedRegions(It First, It Last) {
384 std::sort(First, Last,
385 [](const CountedRegion &LHS, const CountedRegion &RHS) {
386 if (LHS.startLoc() == RHS.startLoc())
387 // When LHS completely contains RHS, we sort LHS first.
388 return RHS.endLoc() < LHS.endLoc();
389 return LHS.startLoc() < RHS.startLoc();
393 static bool isExpansion(const CountedRegion &R, unsigned FileID) {
394 return R.Kind == CounterMappingRegion::ExpansionRegion && R.FileID == FileID;
397 CoverageData CoverageMapping::getCoverageForFile(StringRef Filename) {
398 CoverageData FileCoverage(Filename);
399 std::vector<coverage::CountedRegion> Regions;
401 for (const auto &Function : Functions) {
402 auto MainFileID = findMainViewFileID(Filename, Function);
405 auto FileIDs = gatherFileIDs(Filename, Function);
406 for (const auto &CR : Function.CountedRegions)
407 if (FileIDs.test(CR.FileID)) {
408 Regions.push_back(CR);
409 if (isExpansion(CR, *MainFileID))
410 FileCoverage.Expansions.emplace_back(CR, Function);
414 sortNestedRegions(Regions.begin(), Regions.end());
415 DEBUG(dbgs() << "Emitting segments for file: " << Filename << "\n");
416 FileCoverage.Segments = SegmentBuilder().buildSegments(Regions);
421 std::vector<const FunctionRecord *>
422 CoverageMapping::getInstantiations(StringRef Filename) {
423 FunctionInstantiationSetCollector InstantiationSetCollector;
424 for (const auto &Function : Functions) {
425 auto MainFileID = findMainViewFileID(Filename, Function);
428 InstantiationSetCollector.insert(Function, *MainFileID);
431 std::vector<const FunctionRecord *> Result;
432 for (const auto &InstantiationSet : InstantiationSetCollector) {
433 if (InstantiationSet.second.size() < 2)
435 Result.insert(Result.end(), InstantiationSet.second.begin(),
436 InstantiationSet.second.end());
442 CoverageMapping::getCoverageForFunction(const FunctionRecord &Function) {
443 auto MainFileID = findMainViewFileID(Function);
445 return CoverageData();
447 CoverageData FunctionCoverage(Function.Filenames[*MainFileID]);
448 std::vector<coverage::CountedRegion> Regions;
449 for (const auto &CR : Function.CountedRegions)
450 if (CR.FileID == *MainFileID) {
451 Regions.push_back(CR);
452 if (isExpansion(CR, *MainFileID))
453 FunctionCoverage.Expansions.emplace_back(CR, Function);
456 sortNestedRegions(Regions.begin(), Regions.end());
457 DEBUG(dbgs() << "Emitting segments for function: " << Function.Name << "\n");
458 FunctionCoverage.Segments = SegmentBuilder().buildSegments(Regions);
460 return FunctionCoverage;
464 CoverageMapping::getCoverageForExpansion(const ExpansionRecord &Expansion) {
465 CoverageData ExpansionCoverage(
466 Expansion.Function.Filenames[Expansion.FileID]);
467 std::vector<coverage::CountedRegion> Regions;
468 for (const auto &CR : Expansion.Function.CountedRegions)
469 if (CR.FileID == Expansion.FileID) {
470 Regions.push_back(CR);
471 if (isExpansion(CR, Expansion.FileID))
472 ExpansionCoverage.Expansions.emplace_back(CR, Expansion.Function);
475 sortNestedRegions(Regions.begin(), Regions.end());
476 DEBUG(dbgs() << "Emitting segments for expansion of file " << Expansion.FileID
478 ExpansionCoverage.Segments = SegmentBuilder().buildSegments(Regions);
480 return ExpansionCoverage;