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/Errc.h"
23 #include "llvm/Support/ErrorHandling.h"
24 #include "llvm/Support/ManagedStatic.h"
25 #include "llvm/Support/Path.h"
26 #include "llvm/Support/raw_ostream.h"
29 using namespace coverage;
31 #define DEBUG_TYPE "coverage-mapping"
33 Counter CounterExpressionBuilder::get(const CounterExpression &E) {
34 auto It = ExpressionIndices.find(E);
35 if (It != ExpressionIndices.end())
36 return Counter::getExpression(It->second);
37 unsigned I = Expressions.size();
38 Expressions.push_back(E);
39 ExpressionIndices[E] = I;
40 return Counter::getExpression(I);
43 void CounterExpressionBuilder::extractTerms(
44 Counter C, int Sign, SmallVectorImpl<std::pair<unsigned, int>> &Terms) {
45 switch (C.getKind()) {
48 case Counter::CounterValueReference:
49 Terms.push_back(std::make_pair(C.getCounterID(), Sign));
51 case Counter::Expression:
52 const auto &E = Expressions[C.getExpressionID()];
53 extractTerms(E.LHS, Sign, Terms);
54 extractTerms(E.RHS, E.Kind == CounterExpression::Subtract ? -Sign : Sign,
60 Counter CounterExpressionBuilder::simplify(Counter ExpressionTree) {
61 // Gather constant terms.
62 llvm::SmallVector<std::pair<unsigned, int>, 32> Terms;
63 extractTerms(ExpressionTree, +1, Terms);
65 // If there are no terms, this is just a zero. The algorithm below assumes at
67 if (Terms.size() == 0)
68 return Counter::getZero();
70 // Group the terms by counter ID.
71 std::sort(Terms.begin(), Terms.end(),
72 [](const std::pair<unsigned, int> &LHS,
73 const std::pair<unsigned, int> &RHS) {
74 return LHS.first < RHS.first;
77 // Combine terms by counter ID to eliminate counters that sum to zero.
78 auto Prev = Terms.begin();
79 for (auto I = Prev + 1, E = Terms.end(); I != E; ++I) {
80 if (I->first == Prev->first) {
81 Prev->second += I->second;
87 Terms.erase(++Prev, Terms.end());
90 // Create additions. We do this before subtractions to avoid constructs like
91 // ((0 - X) + Y), as opposed to (Y - X).
92 for (auto Term : Terms) {
95 for (int I = 0; I < Term.second; ++I)
97 C = Counter::getCounter(Term.first);
99 C = get(CounterExpression(CounterExpression::Add, C,
100 Counter::getCounter(Term.first)));
103 // Create subtractions.
104 for (auto Term : Terms) {
105 if (Term.second >= 0)
107 for (int I = 0; I < -Term.second; ++I)
108 C = get(CounterExpression(CounterExpression::Subtract, C,
109 Counter::getCounter(Term.first)));
114 Counter CounterExpressionBuilder::add(Counter LHS, Counter RHS) {
115 return simplify(get(CounterExpression(CounterExpression::Add, LHS, RHS)));
118 Counter CounterExpressionBuilder::subtract(Counter LHS, Counter RHS) {
120 get(CounterExpression(CounterExpression::Subtract, LHS, RHS)));
123 void CounterMappingContext::dump(const Counter &C,
124 llvm::raw_ostream &OS) const {
125 switch (C.getKind()) {
129 case Counter::CounterValueReference:
130 OS << '#' << C.getCounterID();
132 case Counter::Expression: {
133 if (C.getExpressionID() >= Expressions.size())
135 const auto &E = Expressions[C.getExpressionID()];
138 OS << (E.Kind == CounterExpression::Subtract ? " - " : " + ");
144 if (CounterValues.empty())
146 ErrorOr<int64_t> Value = evaluate(C);
149 OS << '[' << *Value << ']';
152 ErrorOr<int64_t> CounterMappingContext::evaluate(const Counter &C) const {
153 switch (C.getKind()) {
156 case Counter::CounterValueReference:
157 if (C.getCounterID() >= CounterValues.size())
158 return make_error_code(errc::argument_out_of_domain);
159 return CounterValues[C.getCounterID()];
160 case Counter::Expression: {
161 if (C.getExpressionID() >= Expressions.size())
162 return make_error_code(errc::argument_out_of_domain);
163 const auto &E = Expressions[C.getExpressionID()];
164 ErrorOr<int64_t> LHS = evaluate(E.LHS);
167 ErrorOr<int64_t> RHS = evaluate(E.RHS);
170 return E.Kind == CounterExpression::Subtract ? *LHS - *RHS : *LHS + *RHS;
173 llvm_unreachable("Unhandled CounterKind");
176 void FunctionRecordIterator::skipOtherFiles() {
177 while (Current != Records.end() && !Filename.empty() &&
178 Filename != Current->Filenames[0])
180 if (Current == Records.end())
181 *this = FunctionRecordIterator();
184 /// Get the function name from the record, removing the filename prefix if
186 static StringRef getFuncNameWithoutPrefix(const CoverageMappingRecord &Record) {
187 StringRef FunctionName = Record.FunctionName;
188 if (Record.Filenames.empty())
190 StringRef Filename = sys::path::filename(Record.Filenames[0]);
191 if (FunctionName.startswith(Filename))
192 FunctionName = FunctionName.drop_front(Filename.size() + 1);
196 ErrorOr<std::unique_ptr<CoverageMapping>>
197 CoverageMapping::load(CoverageMappingReader &CoverageReader,
198 IndexedInstrProfReader &ProfileReader) {
199 auto Coverage = std::unique_ptr<CoverageMapping>(new CoverageMapping());
201 std::vector<uint64_t> Counts;
202 for (const auto &Record : CoverageReader) {
203 CounterMappingContext Ctx(Record.Expressions);
206 if (std::error_code EC = ProfileReader.getFunctionCounts(
207 Record.FunctionName, Record.FunctionHash, Counts)) {
208 if (EC == instrprof_error::hash_mismatch) {
209 Coverage->MismatchedFunctionCount++;
211 } else if (EC != instrprof_error::unknown_function)
213 Counts.assign(Record.MappingRegions.size(), 0);
215 Ctx.setCounts(Counts);
217 assert(!Record.MappingRegions.empty() && "Function has no regions");
219 FunctionRecord Function(getFuncNameWithoutPrefix(Record), Record.Filenames);
220 for (const auto &Region : Record.MappingRegions) {
221 ErrorOr<int64_t> ExecutionCount = Ctx.evaluate(Region.Count);
224 Function.pushRegion(Region, *ExecutionCount);
226 if (Function.CountedRegions.size() != Record.MappingRegions.size()) {
227 Coverage->MismatchedFunctionCount++;
231 Coverage->Functions.push_back(std::move(Function));
234 return std::move(Coverage);
237 ErrorOr<std::unique_ptr<CoverageMapping>>
238 CoverageMapping::load(StringRef ObjectFilename, StringRef ProfileFilename,
240 auto CounterMappingBuff = MemoryBuffer::getFileOrSTDIN(ObjectFilename);
241 if (std::error_code EC = CounterMappingBuff.getError())
243 auto CoverageReaderOrErr =
244 BinaryCoverageReader::create(CounterMappingBuff.get(), Arch);
245 if (std::error_code EC = CoverageReaderOrErr.getError())
247 auto CoverageReader = std::move(CoverageReaderOrErr.get());
248 auto ProfileReaderOrErr = IndexedInstrProfReader::create(ProfileFilename);
249 if (auto EC = ProfileReaderOrErr.getError())
251 auto ProfileReader = std::move(ProfileReaderOrErr.get());
252 return load(*CoverageReader, *ProfileReader);
256 /// \brief Distributes functions into instantiation sets.
258 /// An instantiation set is a collection of functions that have the same source
259 /// code, ie, template functions specializations.
260 class FunctionInstantiationSetCollector {
261 typedef DenseMap<std::pair<unsigned, unsigned>,
262 std::vector<const FunctionRecord *>> MapT;
263 MapT InstantiatedFunctions;
266 void insert(const FunctionRecord &Function, unsigned FileID) {
267 auto I = Function.CountedRegions.begin(), E = Function.CountedRegions.end();
268 while (I != E && I->FileID != FileID)
270 assert(I != E && "function does not cover the given file");
271 auto &Functions = InstantiatedFunctions[I->startLoc()];
272 Functions.push_back(&Function);
275 MapT::iterator begin() { return InstantiatedFunctions.begin(); }
277 MapT::iterator end() { return InstantiatedFunctions.end(); }
280 class SegmentBuilder {
281 std::vector<CoverageSegment> Segments;
282 SmallVector<const CountedRegion *, 8> ActiveRegions;
284 /// Start a segment with no count specified.
285 void startSegment(unsigned Line, unsigned Col) {
286 DEBUG(dbgs() << "Top level segment at " << Line << ":" << Col << "\n");
287 Segments.emplace_back(Line, Col, /*IsRegionEntry=*/false);
290 /// Start a segment with the given Region's count.
291 void startSegment(unsigned Line, unsigned Col, bool IsRegionEntry,
292 const CountedRegion &Region) {
293 if (Segments.empty())
294 Segments.emplace_back(Line, Col, IsRegionEntry);
295 CoverageSegment S = Segments.back();
296 // Avoid creating empty regions.
297 if (S.Line != Line || S.Col != Col) {
298 Segments.emplace_back(Line, Col, IsRegionEntry);
301 DEBUG(dbgs() << "Segment at " << Line << ":" << Col);
302 // Set this region's count.
303 if (Region.Kind != coverage::CounterMappingRegion::SkippedRegion) {
304 DEBUG(dbgs() << " with count " << Region.ExecutionCount);
305 Segments.back().setCount(Region.ExecutionCount);
307 DEBUG(dbgs() << "\n");
310 /// Start a segment for the given region.
311 void startSegment(const CountedRegion &Region) {
312 startSegment(Region.LineStart, Region.ColumnStart, true, Region);
315 /// Pop the top region off of the active stack, starting a new segment with
316 /// the containing Region's count.
318 const CountedRegion *Active = ActiveRegions.back();
319 unsigned Line = Active->LineEnd, Col = Active->ColumnEnd;
320 ActiveRegions.pop_back();
321 if (ActiveRegions.empty())
322 startSegment(Line, Col);
324 startSegment(Line, Col, false, *ActiveRegions.back());
328 /// Build a list of CoverageSegments from a sorted list of Regions.
329 std::vector<CoverageSegment> buildSegments(ArrayRef<CountedRegion> Regions) {
330 const CountedRegion *PrevRegion = nullptr;
331 for (const auto &Region : Regions) {
332 // Pop any regions that end before this one starts.
333 while (!ActiveRegions.empty() &&
334 ActiveRegions.back()->endLoc() <= Region.startLoc())
336 if (PrevRegion && PrevRegion->startLoc() == Region.startLoc() &&
337 PrevRegion->endLoc() == Region.endLoc()) {
338 if (Region.Kind == coverage::CounterMappingRegion::CodeRegion)
339 Segments.back().addCount(Region.ExecutionCount);
341 // Add this region to the stack.
342 ActiveRegions.push_back(&Region);
343 startSegment(Region);
345 PrevRegion = &Region;
347 // Pop any regions that are left in the stack.
348 while (!ActiveRegions.empty())
355 std::vector<StringRef> CoverageMapping::getUniqueSourceFiles() const {
356 std::vector<StringRef> Filenames;
357 for (const auto &Function : getCoveredFunctions())
358 Filenames.insert(Filenames.end(), Function.Filenames.begin(),
359 Function.Filenames.end());
360 std::sort(Filenames.begin(), Filenames.end());
361 auto Last = std::unique(Filenames.begin(), Filenames.end());
362 Filenames.erase(Last, Filenames.end());
366 static SmallBitVector gatherFileIDs(StringRef SourceFile,
367 const FunctionRecord &Function) {
368 SmallBitVector FilenameEquivalence(Function.Filenames.size(), false);
369 for (unsigned I = 0, E = Function.Filenames.size(); I < E; ++I)
370 if (SourceFile == Function.Filenames[I])
371 FilenameEquivalence[I] = true;
372 return FilenameEquivalence;
375 static Optional<unsigned> findMainViewFileID(StringRef SourceFile,
376 const FunctionRecord &Function) {
377 SmallBitVector IsNotExpandedFile(Function.Filenames.size(), true);
378 SmallBitVector FilenameEquivalence = gatherFileIDs(SourceFile, Function);
379 for (const auto &CR : Function.CountedRegions)
380 if (CR.Kind == CounterMappingRegion::ExpansionRegion &&
381 FilenameEquivalence[CR.FileID])
382 IsNotExpandedFile[CR.ExpandedFileID] = false;
383 IsNotExpandedFile &= FilenameEquivalence;
384 int I = IsNotExpandedFile.find_first();
390 static Optional<unsigned> findMainViewFileID(const FunctionRecord &Function) {
391 SmallBitVector IsNotExpandedFile(Function.Filenames.size(), true);
392 for (const auto &CR : Function.CountedRegions)
393 if (CR.Kind == CounterMappingRegion::ExpansionRegion)
394 IsNotExpandedFile[CR.ExpandedFileID] = false;
395 int I = IsNotExpandedFile.find_first();
401 /// Sort a nested sequence of regions from a single file.
402 template <class It> static void sortNestedRegions(It First, It Last) {
403 std::sort(First, Last,
404 [](const CountedRegion &LHS, const CountedRegion &RHS) {
405 if (LHS.startLoc() == RHS.startLoc())
406 // When LHS completely contains RHS, we sort LHS first.
407 return RHS.endLoc() < LHS.endLoc();
408 return LHS.startLoc() < RHS.startLoc();
412 static bool isExpansion(const CountedRegion &R, unsigned FileID) {
413 return R.Kind == CounterMappingRegion::ExpansionRegion && R.FileID == FileID;
416 CoverageData CoverageMapping::getCoverageForFile(StringRef Filename) {
417 CoverageData FileCoverage(Filename);
418 std::vector<coverage::CountedRegion> Regions;
420 for (const auto &Function : Functions) {
421 auto MainFileID = findMainViewFileID(Filename, Function);
424 auto FileIDs = gatherFileIDs(Filename, Function);
425 for (const auto &CR : Function.CountedRegions)
426 if (FileIDs.test(CR.FileID)) {
427 Regions.push_back(CR);
428 if (isExpansion(CR, *MainFileID))
429 FileCoverage.Expansions.emplace_back(CR, Function);
433 sortNestedRegions(Regions.begin(), Regions.end());
434 DEBUG(dbgs() << "Emitting segments for file: " << Filename << "\n");
435 FileCoverage.Segments = SegmentBuilder().buildSegments(Regions);
440 std::vector<const FunctionRecord *>
441 CoverageMapping::getInstantiations(StringRef Filename) {
442 FunctionInstantiationSetCollector InstantiationSetCollector;
443 for (const auto &Function : Functions) {
444 auto MainFileID = findMainViewFileID(Filename, Function);
447 InstantiationSetCollector.insert(Function, *MainFileID);
450 std::vector<const FunctionRecord *> Result;
451 for (const auto &InstantiationSet : InstantiationSetCollector) {
452 if (InstantiationSet.second.size() < 2)
454 Result.insert(Result.end(), InstantiationSet.second.begin(),
455 InstantiationSet.second.end());
461 CoverageMapping::getCoverageForFunction(const FunctionRecord &Function) {
462 auto MainFileID = findMainViewFileID(Function);
464 return CoverageData();
466 CoverageData FunctionCoverage(Function.Filenames[*MainFileID]);
467 std::vector<coverage::CountedRegion> Regions;
468 for (const auto &CR : Function.CountedRegions)
469 if (CR.FileID == *MainFileID) {
470 Regions.push_back(CR);
471 if (isExpansion(CR, *MainFileID))
472 FunctionCoverage.Expansions.emplace_back(CR, Function);
475 sortNestedRegions(Regions.begin(), Regions.end());
476 DEBUG(dbgs() << "Emitting segments for function: " << Function.Name << "\n");
477 FunctionCoverage.Segments = SegmentBuilder().buildSegments(Regions);
479 return FunctionCoverage;
483 CoverageMapping::getCoverageForExpansion(const ExpansionRecord &Expansion) {
484 CoverageData ExpansionCoverage(
485 Expansion.Function.Filenames[Expansion.FileID]);
486 std::vector<coverage::CountedRegion> Regions;
487 for (const auto &CR : Expansion.Function.CountedRegions)
488 if (CR.FileID == Expansion.FileID) {
489 Regions.push_back(CR);
490 if (isExpansion(CR, Expansion.FileID))
491 ExpansionCoverage.Expansions.emplace_back(CR, Expansion.Function);
494 sortNestedRegions(Regions.begin(), Regions.end());
495 DEBUG(dbgs() << "Emitting segments for expansion of file " << Expansion.FileID
497 ExpansionCoverage.Segments = SegmentBuilder().buildSegments(Regions);
499 return ExpansionCoverage;
503 class CoverageMappingErrorCategoryType : public std::error_category {
504 const char *name() const LLVM_NOEXCEPT override { return "llvm.coveragemap"; }
505 std::string message(int IE) const override {
506 auto E = static_cast<coveragemap_error>(IE);
508 case coveragemap_error::success:
510 case coveragemap_error::eof:
511 return "End of File";
512 case coveragemap_error::no_data_found:
513 return "No coverage data found";
514 case coveragemap_error::unsupported_version:
515 return "Unsupported coverage format version";
516 case coveragemap_error::truncated:
517 return "Truncated coverage data";
518 case coveragemap_error::malformed:
519 return "Malformed coverage data";
521 llvm_unreachable("A value of coveragemap_error has no message.");
526 static ManagedStatic<CoverageMappingErrorCategoryType> ErrorCategory;
528 const std::error_category &llvm::coveragemap_category() {
529 return *ErrorCategory;