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 (auto EC = CounterMappingBuff.getError())
224 ObjectFileCoverageMappingReader CoverageReader(CounterMappingBuff.get());
225 if (auto EC = CoverageReader.readHeader())
227 auto ProfileReaderOrErr = IndexedInstrProfReader::create(ProfileFilename);
228 if (auto EC = ProfileReaderOrErr.getError())
230 auto ProfileReader = std::move(ProfileReaderOrErr.get());
231 return load(CoverageReader, *ProfileReader);
235 /// \brief Distributes functions into instantiation sets.
237 /// An instantiation set is a collection of functions that have the same source
238 /// code, ie, template functions specializations.
239 class FunctionInstantiationSetCollector {
240 typedef DenseMap<std::pair<unsigned, unsigned>,
241 std::vector<const FunctionRecord *>> MapT;
242 MapT InstantiatedFunctions;
245 void insert(const FunctionRecord &Function, unsigned FileID) {
246 auto I = Function.CountedRegions.begin(), E = Function.CountedRegions.end();
247 while (I != E && I->FileID != FileID)
249 assert(I != E && "function does not cover the given file");
250 auto &Functions = InstantiatedFunctions[I->startLoc()];
251 Functions.push_back(&Function);
254 MapT::iterator begin() { return InstantiatedFunctions.begin(); }
256 MapT::iterator end() { return InstantiatedFunctions.end(); }
259 class SegmentBuilder {
260 std::vector<CoverageSegment> Segments;
261 SmallVector<const CountedRegion *, 8> ActiveRegions;
263 /// Start a segment with no count specified.
264 void startSegment(unsigned Line, unsigned Col) {
265 DEBUG(dbgs() << "Top level segment at " << Line << ":" << Col << "\n");
266 Segments.emplace_back(Line, Col, /*IsRegionEntry=*/false);
269 /// Start a segment with the given Region's count.
270 void startSegment(unsigned Line, unsigned Col, bool IsRegionEntry,
271 const CountedRegion &Region) {
272 if (Segments.empty())
273 Segments.emplace_back(Line, Col, IsRegionEntry);
274 CoverageSegment S = Segments.back();
275 // Avoid creating empty regions.
276 if (S.Line != Line || S.Col != Col) {
277 Segments.emplace_back(Line, Col, IsRegionEntry);
280 DEBUG(dbgs() << "Segment at " << Line << ":" << Col);
281 // Set this region's count.
282 if (Region.Kind != coverage::CounterMappingRegion::SkippedRegion) {
283 DEBUG(dbgs() << " with count " << Region.ExecutionCount);
284 Segments.back().setCount(Region.ExecutionCount);
286 DEBUG(dbgs() << "\n");
289 /// Start a segment for the given region.
290 void startSegment(const CountedRegion &Region) {
291 startSegment(Region.LineStart, Region.ColumnStart, true, Region);
294 /// Pop the top region off of the active stack, starting a new segment with
295 /// the containing Region's count.
297 const CountedRegion *Active = ActiveRegions.back();
298 unsigned Line = Active->LineEnd, Col = Active->ColumnEnd;
299 ActiveRegions.pop_back();
300 if (ActiveRegions.empty())
301 startSegment(Line, Col);
303 startSegment(Line, Col, false, *ActiveRegions.back());
307 /// Build a list of CoverageSegments from a sorted list of Regions.
308 std::vector<CoverageSegment> buildSegments(ArrayRef<CountedRegion> Regions) {
309 const CountedRegion *PrevRegion = nullptr;
310 for (const auto &Region : Regions) {
311 // Pop any regions that end before this one starts.
312 while (!ActiveRegions.empty() &&
313 ActiveRegions.back()->endLoc() <= Region.startLoc())
315 if (PrevRegion && PrevRegion->startLoc() == Region.startLoc() &&
316 PrevRegion->endLoc() == Region.endLoc()) {
317 if (Region.Kind == coverage::CounterMappingRegion::CodeRegion)
318 Segments.back().addCount(Region.ExecutionCount);
320 // Add this region to the stack.
321 ActiveRegions.push_back(&Region);
322 startSegment(Region);
324 PrevRegion = &Region;
326 // Pop any regions that are left in the stack.
327 while (!ActiveRegions.empty())
334 std::vector<StringRef> CoverageMapping::getUniqueSourceFiles() const {
335 std::vector<StringRef> Filenames;
336 for (const auto &Function : getCoveredFunctions())
337 Filenames.insert(Filenames.end(), Function.Filenames.begin(),
338 Function.Filenames.end());
339 std::sort(Filenames.begin(), Filenames.end());
340 auto Last = std::unique(Filenames.begin(), Filenames.end());
341 Filenames.erase(Last, Filenames.end());
345 static SmallBitVector gatherFileIDs(StringRef SourceFile,
346 const FunctionRecord &Function) {
347 SmallBitVector FilenameEquivalence(Function.Filenames.size(), false);
348 for (unsigned I = 0, E = Function.Filenames.size(); I < E; ++I)
349 if (SourceFile == Function.Filenames[I])
350 FilenameEquivalence[I] = true;
351 return FilenameEquivalence;
354 static Optional<unsigned> findMainViewFileID(StringRef SourceFile,
355 const FunctionRecord &Function) {
356 SmallBitVector IsNotExpandedFile(Function.Filenames.size(), true);
357 SmallBitVector FilenameEquivalence = gatherFileIDs(SourceFile, Function);
358 for (const auto &CR : Function.CountedRegions)
359 if (CR.Kind == CounterMappingRegion::ExpansionRegion &&
360 FilenameEquivalence[CR.FileID])
361 IsNotExpandedFile[CR.ExpandedFileID] = false;
362 IsNotExpandedFile &= FilenameEquivalence;
363 int I = IsNotExpandedFile.find_first();
364 return I != -1 ? I : None;
367 static Optional<unsigned> findMainViewFileID(const FunctionRecord &Function) {
368 SmallBitVector IsNotExpandedFile(Function.Filenames.size(), true);
369 for (const auto &CR : Function.CountedRegions)
370 if (CR.Kind == CounterMappingRegion::ExpansionRegion)
371 IsNotExpandedFile[CR.ExpandedFileID] = false;
372 int I = IsNotExpandedFile.find_first();
373 return I != -1 ? I : None;
376 /// Sort a nested sequence of regions from a single file.
377 template <class It> static void sortNestedRegions(It First, It Last) {
378 std::sort(First, Last,
379 [](const CountedRegion &LHS, const CountedRegion &RHS) {
380 if (LHS.startLoc() == RHS.startLoc())
381 // When LHS completely contains RHS, we sort LHS first.
382 return RHS.endLoc() < LHS.endLoc();
383 return LHS.startLoc() < RHS.startLoc();
387 static bool isExpansion(const CountedRegion &R, unsigned FileID) {
388 return R.Kind == CounterMappingRegion::ExpansionRegion && R.FileID == FileID;
391 CoverageData CoverageMapping::getCoverageForFile(StringRef Filename) {
392 CoverageData FileCoverage(Filename);
393 std::vector<coverage::CountedRegion> Regions;
395 for (const auto &Function : Functions) {
396 auto MainFileID = findMainViewFileID(Filename, Function);
399 auto FileIDs = gatherFileIDs(Filename, Function);
400 for (const auto &CR : Function.CountedRegions)
401 if (FileIDs.test(CR.FileID)) {
402 Regions.push_back(CR);
403 if (isExpansion(CR, *MainFileID))
404 FileCoverage.Expansions.emplace_back(CR, Function);
408 sortNestedRegions(Regions.begin(), Regions.end());
409 DEBUG(dbgs() << "Emitting segments for file: " << Filename << "\n");
410 FileCoverage.Segments = SegmentBuilder().buildSegments(Regions);
415 std::vector<const FunctionRecord *>
416 CoverageMapping::getInstantiations(StringRef Filename) {
417 FunctionInstantiationSetCollector InstantiationSetCollector;
418 for (const auto &Function : Functions) {
419 auto MainFileID = findMainViewFileID(Filename, Function);
422 InstantiationSetCollector.insert(Function, *MainFileID);
425 std::vector<const FunctionRecord *> Result;
426 for (const auto &InstantiationSet : InstantiationSetCollector) {
427 if (InstantiationSet.second.size() < 2)
429 Result.insert(Result.end(), InstantiationSet.second.begin(),
430 InstantiationSet.second.end());
436 CoverageMapping::getCoverageForFunction(const FunctionRecord &Function) {
437 auto MainFileID = findMainViewFileID(Function);
439 return CoverageData();
441 CoverageData FunctionCoverage(Function.Filenames[*MainFileID]);
442 std::vector<coverage::CountedRegion> Regions;
443 for (const auto &CR : Function.CountedRegions)
444 if (CR.FileID == *MainFileID) {
445 Regions.push_back(CR);
446 if (isExpansion(CR, *MainFileID))
447 FunctionCoverage.Expansions.emplace_back(CR, Function);
450 sortNestedRegions(Regions.begin(), Regions.end());
451 DEBUG(dbgs() << "Emitting segments for function: " << Function.Name << "\n");
452 FunctionCoverage.Segments = SegmentBuilder().buildSegments(Regions);
454 return FunctionCoverage;
458 CoverageMapping::getCoverageForExpansion(const ExpansionRecord &Expansion) {
459 CoverageData ExpansionCoverage(
460 Expansion.Function.Filenames[Expansion.FileID]);
461 std::vector<coverage::CountedRegion> Regions;
462 for (const auto &CR : Expansion.Function.CountedRegions)
463 if (CR.FileID == Expansion.FileID) {
464 Regions.push_back(CR);
465 if (isExpansion(CR, Expansion.FileID))
466 ExpansionCoverage.Expansions.emplace_back(CR, Expansion.Function);
469 sortNestedRegions(Regions.begin(), Regions.end());
470 DEBUG(dbgs() << "Emitting segments for expansion of file " << Expansion.FileID
472 ExpansionCoverage.Segments = SegmentBuilder().buildSegments(Regions);
474 return ExpansionCoverage;