1 //===- CoverageMapping.cpp - Code coverage mapping support ----------------===//
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/Coverage/CoverageMapping.h"
16 #include "llvm/ADT/ArrayRef.h"
17 #include "llvm/ADT/DenseMap.h"
18 #include "llvm/ADT/None.h"
19 #include "llvm/ADT/Optional.h"
20 #include "llvm/ADT/SmallBitVector.h"
21 #include "llvm/ADT/SmallVector.h"
22 #include "llvm/ADT/StringRef.h"
23 #include "llvm/ProfileData/Coverage/CoverageMappingReader.h"
24 #include "llvm/ProfileData/InstrProfReader.h"
25 #include "llvm/Support/Debug.h"
26 #include "llvm/Support/Errc.h"
27 #include "llvm/Support/Error.h"
28 #include "llvm/Support/ErrorHandling.h"
29 #include "llvm/Support/ManagedStatic.h"
30 #include "llvm/Support/MemoryBuffer.h"
31 #include "llvm/Support/raw_ostream.h"
39 #include <system_error>
44 using namespace coverage;
46 #define DEBUG_TYPE "coverage-mapping"
48 Counter CounterExpressionBuilder::get(const CounterExpression &E) {
49 auto It = ExpressionIndices.find(E);
50 if (It != ExpressionIndices.end())
51 return Counter::getExpression(It->second);
52 unsigned I = Expressions.size();
53 Expressions.push_back(E);
54 ExpressionIndices[E] = I;
55 return Counter::getExpression(I);
58 void CounterExpressionBuilder::extractTerms(Counter C, int Factor,
59 SmallVectorImpl<Term> &Terms) {
60 switch (C.getKind()) {
63 case Counter::CounterValueReference:
64 Terms.emplace_back(C.getCounterID(), Factor);
66 case Counter::Expression:
67 const auto &E = Expressions[C.getExpressionID()];
68 extractTerms(E.LHS, Factor, Terms);
70 E.RHS, E.Kind == CounterExpression::Subtract ? -Factor : Factor, Terms);
75 Counter CounterExpressionBuilder::simplify(Counter ExpressionTree) {
76 // Gather constant terms.
77 SmallVector<Term, 32> Terms;
78 extractTerms(ExpressionTree, +1, Terms);
80 // If there are no terms, this is just a zero. The algorithm below assumes at
82 if (Terms.size() == 0)
83 return Counter::getZero();
85 // Group the terms by counter ID.
86 std::sort(Terms.begin(), Terms.end(), [](const Term &LHS, const Term &RHS) {
87 return LHS.CounterID < RHS.CounterID;
90 // Combine terms by counter ID to eliminate counters that sum to zero.
91 auto Prev = Terms.begin();
92 for (auto I = Prev + 1, E = Terms.end(); I != E; ++I) {
93 if (I->CounterID == Prev->CounterID) {
94 Prev->Factor += I->Factor;
100 Terms.erase(++Prev, Terms.end());
103 // Create additions. We do this before subtractions to avoid constructs like
104 // ((0 - X) + Y), as opposed to (Y - X).
105 for (auto T : Terms) {
108 for (int I = 0; I < T.Factor; ++I)
110 C = Counter::getCounter(T.CounterID);
112 C = get(CounterExpression(CounterExpression::Add, C,
113 Counter::getCounter(T.CounterID)));
116 // Create subtractions.
117 for (auto T : Terms) {
120 for (int I = 0; I < -T.Factor; ++I)
121 C = get(CounterExpression(CounterExpression::Subtract, C,
122 Counter::getCounter(T.CounterID)));
127 Counter CounterExpressionBuilder::add(Counter LHS, Counter RHS) {
128 return simplify(get(CounterExpression(CounterExpression::Add, LHS, RHS)));
131 Counter CounterExpressionBuilder::subtract(Counter LHS, Counter RHS) {
133 get(CounterExpression(CounterExpression::Subtract, LHS, RHS)));
136 void CounterMappingContext::dump(const Counter &C, raw_ostream &OS) const {
137 switch (C.getKind()) {
141 case Counter::CounterValueReference:
142 OS << '#' << C.getCounterID();
144 case Counter::Expression: {
145 if (C.getExpressionID() >= Expressions.size())
147 const auto &E = Expressions[C.getExpressionID()];
150 OS << (E.Kind == CounterExpression::Subtract ? " - " : " + ");
156 if (CounterValues.empty())
158 Expected<int64_t> Value = evaluate(C);
159 if (auto E = Value.takeError()) {
160 consumeError(std::move(E));
163 OS << '[' << *Value << ']';
166 Expected<int64_t> CounterMappingContext::evaluate(const Counter &C) const {
167 switch (C.getKind()) {
170 case Counter::CounterValueReference:
171 if (C.getCounterID() >= CounterValues.size())
172 return errorCodeToError(errc::argument_out_of_domain);
173 return CounterValues[C.getCounterID()];
174 case Counter::Expression: {
175 if (C.getExpressionID() >= Expressions.size())
176 return errorCodeToError(errc::argument_out_of_domain);
177 const auto &E = Expressions[C.getExpressionID()];
178 Expected<int64_t> LHS = evaluate(E.LHS);
181 Expected<int64_t> RHS = evaluate(E.RHS);
184 return E.Kind == CounterExpression::Subtract ? *LHS - *RHS : *LHS + *RHS;
187 llvm_unreachable("Unhandled CounterKind");
190 void FunctionRecordIterator::skipOtherFiles() {
191 while (Current != Records.end() && !Filename.empty() &&
192 Filename != Current->Filenames[0])
194 if (Current == Records.end())
195 *this = FunctionRecordIterator();
198 Error CoverageMapping::loadFunctionRecord(
199 const CoverageMappingRecord &Record,
200 IndexedInstrProfReader &ProfileReader) {
201 StringRef OrigFuncName = Record.FunctionName;
202 if (OrigFuncName.empty())
203 return make_error<CoverageMapError>(coveragemap_error::malformed);
205 if (Record.Filenames.empty())
206 OrigFuncName = getFuncNameWithoutPrefix(OrigFuncName);
208 OrigFuncName = getFuncNameWithoutPrefix(OrigFuncName, Record.Filenames[0]);
210 // Don't load records for functions we've already seen.
211 if (!FunctionNames.insert(OrigFuncName).second)
212 return Error::success();
214 CounterMappingContext Ctx(Record.Expressions);
216 std::vector<uint64_t> Counts;
217 if (Error E = ProfileReader.getFunctionCounts(Record.FunctionName,
218 Record.FunctionHash, Counts)) {
219 instrprof_error IPE = InstrProfError::take(std::move(E));
220 if (IPE == instrprof_error::hash_mismatch) {
221 FuncHashMismatches.emplace_back(Record.FunctionName, Record.FunctionHash);
222 return Error::success();
223 } else if (IPE != instrprof_error::unknown_function)
224 return make_error<InstrProfError>(IPE);
225 Counts.assign(Record.MappingRegions.size(), 0);
227 Ctx.setCounts(Counts);
229 assert(!Record.MappingRegions.empty() && "Function has no regions");
231 FunctionRecord Function(OrigFuncName, Record.Filenames);
232 for (const auto &Region : Record.MappingRegions) {
233 Expected<int64_t> ExecutionCount = Ctx.evaluate(Region.Count);
234 if (auto E = ExecutionCount.takeError()) {
235 consumeError(std::move(E));
236 return Error::success();
238 Function.pushRegion(Region, *ExecutionCount);
240 if (Function.CountedRegions.size() != Record.MappingRegions.size()) {
241 FuncCounterMismatches.emplace_back(Record.FunctionName,
242 Function.CountedRegions.size());
243 return Error::success();
246 Functions.push_back(std::move(Function));
247 return Error::success();
250 Expected<std::unique_ptr<CoverageMapping>> CoverageMapping::load(
251 ArrayRef<std::unique_ptr<CoverageMappingReader>> CoverageReaders,
252 IndexedInstrProfReader &ProfileReader) {
253 auto Coverage = std::unique_ptr<CoverageMapping>(new CoverageMapping());
255 for (const auto &CoverageReader : CoverageReaders) {
256 for (auto RecordOrErr : *CoverageReader) {
257 if (Error E = RecordOrErr.takeError())
259 const auto &Record = *RecordOrErr;
260 if (Error E = Coverage->loadFunctionRecord(Record, ProfileReader))
265 return std::move(Coverage);
268 Expected<std::unique_ptr<CoverageMapping>>
269 CoverageMapping::load(ArrayRef<StringRef> ObjectFilenames,
270 StringRef ProfileFilename, ArrayRef<StringRef> Arches) {
271 auto ProfileReaderOrErr = IndexedInstrProfReader::create(ProfileFilename);
272 if (Error E = ProfileReaderOrErr.takeError())
274 auto ProfileReader = std::move(ProfileReaderOrErr.get());
276 SmallVector<std::unique_ptr<CoverageMappingReader>, 4> Readers;
277 SmallVector<std::unique_ptr<MemoryBuffer>, 4> Buffers;
278 for (const auto &File : llvm::enumerate(ObjectFilenames)) {
279 auto CovMappingBufOrErr = MemoryBuffer::getFileOrSTDIN(File.value());
280 if (std::error_code EC = CovMappingBufOrErr.getError())
281 return errorCodeToError(EC);
282 StringRef Arch = Arches.empty() ? StringRef() : Arches[File.index()];
283 auto CoverageReaderOrErr =
284 BinaryCoverageReader::create(CovMappingBufOrErr.get(), Arch);
285 if (Error E = CoverageReaderOrErr.takeError())
287 Readers.push_back(std::move(CoverageReaderOrErr.get()));
288 Buffers.push_back(std::move(CovMappingBufOrErr.get()));
290 return load(Readers, *ProfileReader);
295 /// \brief Distributes functions into instantiation sets.
297 /// An instantiation set is a collection of functions that have the same source
298 /// code, ie, template functions specializations.
299 class FunctionInstantiationSetCollector {
300 using MapT = std::map<LineColPair, std::vector<const FunctionRecord *>>;
301 MapT InstantiatedFunctions;
304 void insert(const FunctionRecord &Function, unsigned FileID) {
305 auto I = Function.CountedRegions.begin(), E = Function.CountedRegions.end();
306 while (I != E && I->FileID != FileID)
308 assert(I != E && "function does not cover the given file");
309 auto &Functions = InstantiatedFunctions[I->startLoc()];
310 Functions.push_back(&Function);
313 MapT::iterator begin() { return InstantiatedFunctions.begin(); }
314 MapT::iterator end() { return InstantiatedFunctions.end(); }
317 class SegmentBuilder {
318 std::vector<CoverageSegment> &Segments;
319 SmallVector<const CountedRegion *, 8> ActiveRegions;
321 SegmentBuilder(std::vector<CoverageSegment> &Segments) : Segments(Segments) {}
323 /// Emit a segment with the count from \p Region starting at \p StartLoc.
325 /// \p IsRegionEntry: The segment is at the start of a new non-gap region.
326 /// \p EmitSkippedRegion: The segment must be emitted as a skipped region.
327 void startSegment(const CountedRegion &Region, LineColPair StartLoc,
328 bool IsRegionEntry, bool EmitSkippedRegion = false) {
329 bool HasCount = !EmitSkippedRegion &&
330 (Region.Kind != CounterMappingRegion::SkippedRegion);
332 // If the new segment wouldn't affect coverage rendering, skip it.
333 if (!Segments.empty() && !IsRegionEntry && !EmitSkippedRegion) {
334 const auto &Last = Segments.back();
335 if (Last.HasCount == HasCount && Last.Count == Region.ExecutionCount &&
341 Segments.emplace_back(StartLoc.first, StartLoc.second,
342 Region.ExecutionCount, IsRegionEntry,
343 Region.Kind == CounterMappingRegion::GapRegion);
345 Segments.emplace_back(StartLoc.first, StartLoc.second, IsRegionEntry);
348 const auto &Last = Segments.back();
349 dbgs() << "Segment at " << Last.Line << ":" << Last.Col
350 << " (count = " << Last.Count << ")"
351 << (Last.IsRegionEntry ? ", RegionEntry" : "")
352 << (!Last.HasCount ? ", Skipped" : "")
353 << (Last.IsGapRegion ? ", Gap" : "") << "\n";
357 /// Emit segments for active regions which end before \p Loc.
359 /// \p Loc: The start location of the next region. If None, all active
360 /// regions are completed.
361 /// \p FirstCompletedRegion: Index of the first completed region.
362 void completeRegionsUntil(Optional<LineColPair> Loc,
363 unsigned FirstCompletedRegion) {
364 // Sort the completed regions by end location. This makes it simple to
365 // emit closing segments in sorted order.
366 auto CompletedRegionsIt = ActiveRegions.begin() + FirstCompletedRegion;
367 std::stable_sort(CompletedRegionsIt, ActiveRegions.end(),
368 [](const CountedRegion *L, const CountedRegion *R) {
369 return L->endLoc() < R->endLoc();
372 // Emit segments for all completed regions.
373 for (unsigned I = FirstCompletedRegion + 1, E = ActiveRegions.size(); I < E;
375 const auto *CompletedRegion = ActiveRegions[I];
376 assert((!Loc || CompletedRegion->endLoc() <= *Loc) &&
377 "Completed region ends after start of new region");
379 const auto *PrevCompletedRegion = ActiveRegions[I - 1];
380 auto CompletedSegmentLoc = PrevCompletedRegion->endLoc();
382 // Don't emit any more segments if they start where the new region begins.
383 if (Loc && CompletedSegmentLoc == *Loc)
386 // Don't emit a segment if the next completed region ends at the same
387 // location as this one.
388 if (CompletedSegmentLoc == CompletedRegion->endLoc())
391 // Use the count from the last completed region which ends at this loc.
392 for (unsigned J = I + 1; J < E; ++J)
393 if (CompletedRegion->endLoc() == ActiveRegions[J]->endLoc())
394 CompletedRegion = ActiveRegions[J];
396 startSegment(*CompletedRegion, CompletedSegmentLoc, false);
399 auto Last = ActiveRegions.back();
400 if (FirstCompletedRegion && Last->endLoc() != *Loc) {
401 // If there's a gap after the end of the last completed region and the
402 // start of the new region, use the last active region to fill the gap.
403 startSegment(*ActiveRegions[FirstCompletedRegion - 1], Last->endLoc(),
405 } else if (!FirstCompletedRegion && (!Loc || *Loc != Last->endLoc())) {
406 // Emit a skipped segment if there are no more active regions. This
407 // ensures that gaps between functions are marked correctly.
408 startSegment(*Last, Last->endLoc(), false, true);
411 // Pop the completed regions.
412 ActiveRegions.erase(CompletedRegionsIt, ActiveRegions.end());
415 void buildSegmentsImpl(ArrayRef<CountedRegion> Regions) {
416 for (const auto &CR : enumerate(Regions)) {
417 auto CurStartLoc = CR.value().startLoc();
419 // Active regions which end before the current region need to be popped.
420 auto CompletedRegions =
421 std::stable_partition(ActiveRegions.begin(), ActiveRegions.end(),
422 [&](const CountedRegion *Region) {
423 return !(Region->endLoc() <= CurStartLoc);
425 if (CompletedRegions != ActiveRegions.end()) {
426 unsigned FirstCompletedRegion =
427 std::distance(ActiveRegions.begin(), CompletedRegions);
428 completeRegionsUntil(CurStartLoc, FirstCompletedRegion);
431 bool GapRegion = CR.value().Kind == CounterMappingRegion::GapRegion;
433 // Try to emit a segment for the current region.
434 if (CurStartLoc == CR.value().endLoc()) {
435 // Avoid making zero-length regions active. If it's the last region,
436 // emit a skipped segment. Otherwise use its predecessor's count.
437 const bool Skipped = (CR.index() + 1) == Regions.size();
438 startSegment(ActiveRegions.empty() ? CR.value() : *ActiveRegions.back(),
439 CurStartLoc, !GapRegion, Skipped);
442 if (CR.index() + 1 == Regions.size() ||
443 CurStartLoc != Regions[CR.index() + 1].startLoc()) {
444 // Emit a segment if the next region doesn't start at the same location
446 startSegment(CR.value(), CurStartLoc, !GapRegion);
449 // This region is active (i.e not completed).
450 ActiveRegions.push_back(&CR.value());
453 // Complete any remaining active regions.
454 if (!ActiveRegions.empty())
455 completeRegionsUntil(None, 0);
458 /// Sort a nested sequence of regions from a single file.
459 static void sortNestedRegions(MutableArrayRef<CountedRegion> Regions) {
460 std::sort(Regions.begin(), Regions.end(), [](const CountedRegion &LHS,
461 const CountedRegion &RHS) {
462 if (LHS.startLoc() != RHS.startLoc())
463 return LHS.startLoc() < RHS.startLoc();
464 if (LHS.endLoc() != RHS.endLoc())
465 // When LHS completely contains RHS, we sort LHS first.
466 return RHS.endLoc() < LHS.endLoc();
467 // If LHS and RHS cover the same area, we need to sort them according
468 // to their kinds so that the most suitable region will become "active"
469 // in combineRegions(). Because we accumulate counter values only from
470 // regions of the same kind as the first region of the area, prefer
471 // CodeRegion to ExpansionRegion and ExpansionRegion to SkippedRegion.
472 static_assert(CounterMappingRegion::CodeRegion <
473 CounterMappingRegion::ExpansionRegion &&
474 CounterMappingRegion::ExpansionRegion <
475 CounterMappingRegion::SkippedRegion,
476 "Unexpected order of region kind values");
477 return LHS.Kind < RHS.Kind;
481 /// Combine counts of regions which cover the same area.
482 static ArrayRef<CountedRegion>
483 combineRegions(MutableArrayRef<CountedRegion> Regions) {
486 auto Active = Regions.begin();
487 auto End = Regions.end();
488 for (auto I = Regions.begin() + 1; I != End; ++I) {
489 if (Active->startLoc() != I->startLoc() ||
490 Active->endLoc() != I->endLoc()) {
491 // Shift to the next region.
497 // Merge duplicate region.
498 // If CodeRegions and ExpansionRegions cover the same area, it's probably
499 // a macro which is fully expanded to another macro. In that case, we need
500 // to accumulate counts only from CodeRegions, or else the area will be
502 // On the other hand, a macro may have a nested macro in its body. If the
503 // outer macro is used several times, the ExpansionRegion for the nested
504 // macro will also be added several times. These ExpansionRegions cover
505 // the same source locations and have to be combined to reach the correct
506 // value for that area.
507 // We add counts of the regions of the same kind as the active region
508 // to handle the both situations.
509 if (I->Kind == Active->Kind)
510 Active->ExecutionCount += I->ExecutionCount;
512 return Regions.drop_back(std::distance(++Active, End));
516 /// Build a sorted list of CoverageSegments from a list of Regions.
517 static std::vector<CoverageSegment>
518 buildSegments(MutableArrayRef<CountedRegion> Regions) {
519 std::vector<CoverageSegment> Segments;
520 SegmentBuilder Builder(Segments);
522 sortNestedRegions(Regions);
523 ArrayRef<CountedRegion> CombinedRegions = combineRegions(Regions);
526 dbgs() << "Combined regions:\n";
527 for (const auto &CR : CombinedRegions)
528 dbgs() << " " << CR.LineStart << ":" << CR.ColumnStart << " -> "
529 << CR.LineEnd << ":" << CR.ColumnEnd
530 << " (count=" << CR.ExecutionCount << ")\n";
533 Builder.buildSegmentsImpl(CombinedRegions);
536 for (unsigned I = 1, E = Segments.size(); I < E; ++I) {
537 const auto &L = Segments[I - 1];
538 const auto &R = Segments[I];
539 if (!(L.Line < R.Line) && !(L.Line == R.Line && L.Col < R.Col)) {
540 DEBUG(dbgs() << " ! Segment " << L.Line << ":" << L.Col
541 << " followed by " << R.Line << ":" << R.Col << "\n");
542 assert(false && "Coverage segments not unique or sorted");
551 } // end anonymous namespace
553 std::vector<StringRef> CoverageMapping::getUniqueSourceFiles() const {
554 std::vector<StringRef> Filenames;
555 for (const auto &Function : getCoveredFunctions())
556 Filenames.insert(Filenames.end(), Function.Filenames.begin(),
557 Function.Filenames.end());
558 std::sort(Filenames.begin(), Filenames.end());
559 auto Last = std::unique(Filenames.begin(), Filenames.end());
560 Filenames.erase(Last, Filenames.end());
564 static SmallBitVector gatherFileIDs(StringRef SourceFile,
565 const FunctionRecord &Function) {
566 SmallBitVector FilenameEquivalence(Function.Filenames.size(), false);
567 for (unsigned I = 0, E = Function.Filenames.size(); I < E; ++I)
568 if (SourceFile == Function.Filenames[I])
569 FilenameEquivalence[I] = true;
570 return FilenameEquivalence;
573 /// Return the ID of the file where the definition of the function is located.
574 static Optional<unsigned> findMainViewFileID(const FunctionRecord &Function) {
575 SmallBitVector IsNotExpandedFile(Function.Filenames.size(), true);
576 for (const auto &CR : Function.CountedRegions)
577 if (CR.Kind == CounterMappingRegion::ExpansionRegion)
578 IsNotExpandedFile[CR.ExpandedFileID] = false;
579 int I = IsNotExpandedFile.find_first();
585 /// Check if SourceFile is the file that contains the definition of
586 /// the Function. Return the ID of the file in that case or None otherwise.
587 static Optional<unsigned> findMainViewFileID(StringRef SourceFile,
588 const FunctionRecord &Function) {
589 Optional<unsigned> I = findMainViewFileID(Function);
590 if (I && SourceFile == Function.Filenames[*I])
595 static bool isExpansion(const CountedRegion &R, unsigned FileID) {
596 return R.Kind == CounterMappingRegion::ExpansionRegion && R.FileID == FileID;
599 CoverageData CoverageMapping::getCoverageForFile(StringRef Filename) const {
600 CoverageData FileCoverage(Filename);
601 std::vector<CountedRegion> Regions;
603 for (const auto &Function : Functions) {
604 auto MainFileID = findMainViewFileID(Filename, Function);
605 auto FileIDs = gatherFileIDs(Filename, Function);
606 for (const auto &CR : Function.CountedRegions)
607 if (FileIDs.test(CR.FileID)) {
608 Regions.push_back(CR);
609 if (MainFileID && isExpansion(CR, *MainFileID))
610 FileCoverage.Expansions.emplace_back(CR, Function);
614 DEBUG(dbgs() << "Emitting segments for file: " << Filename << "\n");
615 FileCoverage.Segments = SegmentBuilder::buildSegments(Regions);
620 std::vector<InstantiationGroup>
621 CoverageMapping::getInstantiationGroups(StringRef Filename) const {
622 FunctionInstantiationSetCollector InstantiationSetCollector;
623 for (const auto &Function : Functions) {
624 auto MainFileID = findMainViewFileID(Filename, Function);
627 InstantiationSetCollector.insert(Function, *MainFileID);
630 std::vector<InstantiationGroup> Result;
631 for (auto &InstantiationSet : InstantiationSetCollector) {
632 InstantiationGroup IG{InstantiationSet.first.first,
633 InstantiationSet.first.second,
634 std::move(InstantiationSet.second)};
635 Result.emplace_back(std::move(IG));
641 CoverageMapping::getCoverageForFunction(const FunctionRecord &Function) const {
642 auto MainFileID = findMainViewFileID(Function);
644 return CoverageData();
646 CoverageData FunctionCoverage(Function.Filenames[*MainFileID]);
647 std::vector<CountedRegion> Regions;
648 for (const auto &CR : Function.CountedRegions)
649 if (CR.FileID == *MainFileID) {
650 Regions.push_back(CR);
651 if (isExpansion(CR, *MainFileID))
652 FunctionCoverage.Expansions.emplace_back(CR, Function);
655 DEBUG(dbgs() << "Emitting segments for function: " << Function.Name << "\n");
656 FunctionCoverage.Segments = SegmentBuilder::buildSegments(Regions);
658 return FunctionCoverage;
661 CoverageData CoverageMapping::getCoverageForExpansion(
662 const ExpansionRecord &Expansion) const {
663 CoverageData ExpansionCoverage(
664 Expansion.Function.Filenames[Expansion.FileID]);
665 std::vector<CountedRegion> Regions;
666 for (const auto &CR : Expansion.Function.CountedRegions)
667 if (CR.FileID == Expansion.FileID) {
668 Regions.push_back(CR);
669 if (isExpansion(CR, Expansion.FileID))
670 ExpansionCoverage.Expansions.emplace_back(CR, Expansion.Function);
673 DEBUG(dbgs() << "Emitting segments for expansion of file " << Expansion.FileID
675 ExpansionCoverage.Segments = SegmentBuilder::buildSegments(Regions);
677 return ExpansionCoverage;
680 LineCoverageStats::LineCoverageStats(
681 ArrayRef<const CoverageSegment *> LineSegments,
682 const CoverageSegment *WrappedSegment, unsigned Line)
683 : ExecutionCount(0), HasMultipleRegions(false), Mapped(false), Line(Line),
684 LineSegments(LineSegments), WrappedSegment(WrappedSegment) {
685 // Find the minimum number of regions which start in this line.
686 unsigned MinRegionCount = 0;
687 auto isStartOfRegion = [](const CoverageSegment *S) {
688 return !S->IsGapRegion && S->HasCount && S->IsRegionEntry;
690 for (unsigned I = 0; I < LineSegments.size() && MinRegionCount < 2; ++I)
691 if (isStartOfRegion(LineSegments[I]))
694 bool StartOfSkippedRegion = !LineSegments.empty() &&
695 !LineSegments.front()->HasCount &&
696 LineSegments.front()->IsRegionEntry;
698 HasMultipleRegions = MinRegionCount > 1;
700 !StartOfSkippedRegion &&
701 ((WrappedSegment && WrappedSegment->HasCount) || (MinRegionCount > 0));
706 // Pick the max count from the non-gap, region entry segments and the
709 ExecutionCount = WrappedSegment->Count;
712 for (const auto *LS : LineSegments)
713 if (isStartOfRegion(LS))
714 ExecutionCount = std::max(ExecutionCount, LS->Count);
717 LineCoverageIterator &LineCoverageIterator::operator++() {
718 if (Next == CD.end()) {
719 Stats = LineCoverageStats();
724 WrappedSegment = Segments.back();
726 while (Next != CD.end() && Next->Line == Line)
727 Segments.push_back(&*Next++);
728 Stats = LineCoverageStats(Segments, WrappedSegment, Line);
733 static std::string getCoverageMapErrString(coveragemap_error Err) {
735 case coveragemap_error::success:
737 case coveragemap_error::eof:
738 return "End of File";
739 case coveragemap_error::no_data_found:
740 return "No coverage data found";
741 case coveragemap_error::unsupported_version:
742 return "Unsupported coverage format version";
743 case coveragemap_error::truncated:
744 return "Truncated coverage data";
745 case coveragemap_error::malformed:
746 return "Malformed coverage data";
748 llvm_unreachable("A value of coveragemap_error has no message.");
753 // FIXME: This class is only here to support the transition to llvm::Error. It
754 // will be removed once this transition is complete. Clients should prefer to
755 // deal with the Error value directly, rather than converting to error_code.
756 class CoverageMappingErrorCategoryType : public std::error_category {
757 const char *name() const noexcept override { return "llvm.coveragemap"; }
758 std::string message(int IE) const override {
759 return getCoverageMapErrString(static_cast<coveragemap_error>(IE));
763 } // end anonymous namespace
765 std::string CoverageMapError::message() const {
766 return getCoverageMapErrString(Err);
769 static ManagedStatic<CoverageMappingErrorCategoryType> ErrorCategory;
771 const std::error_category &llvm::coverage::coveragemap_category() {
772 return *ErrorCategory;
775 char CoverageMapError::ID = 0;