CoverageMapping.cpp revision 341825
1321369Sdim//===- CoverageMapping.cpp - Code coverage mapping support ----------------===// 2303231Sdim// 3303231Sdim// The LLVM Compiler Infrastructure 4303231Sdim// 5303231Sdim// This file is distributed under the University of Illinois Open Source 6303231Sdim// License. See LICENSE.TXT for details. 7303231Sdim// 8303231Sdim//===----------------------------------------------------------------------===// 9303231Sdim// 10303231Sdim// This file contains support for clang's and llvm's instrumentation based 11303231Sdim// code coverage. 12303231Sdim// 13303231Sdim//===----------------------------------------------------------------------===// 14303231Sdim 15303231Sdim#include "llvm/ProfileData/Coverage/CoverageMapping.h" 16321369Sdim#include "llvm/ADT/ArrayRef.h" 17303231Sdim#include "llvm/ADT/DenseMap.h" 18321369Sdim#include "llvm/ADT/None.h" 19303231Sdim#include "llvm/ADT/Optional.h" 20303231Sdim#include "llvm/ADT/SmallBitVector.h" 21321369Sdim#include "llvm/ADT/SmallVector.h" 22321369Sdim#include "llvm/ADT/StringRef.h" 23303231Sdim#include "llvm/ProfileData/Coverage/CoverageMappingReader.h" 24303231Sdim#include "llvm/ProfileData/InstrProfReader.h" 25303231Sdim#include "llvm/Support/Debug.h" 26303231Sdim#include "llvm/Support/Errc.h" 27321369Sdim#include "llvm/Support/Error.h" 28303231Sdim#include "llvm/Support/ErrorHandling.h" 29303231Sdim#include "llvm/Support/ManagedStatic.h" 30321369Sdim#include "llvm/Support/MemoryBuffer.h" 31303231Sdim#include "llvm/Support/raw_ostream.h" 32321369Sdim#include <algorithm> 33321369Sdim#include <cassert> 34321369Sdim#include <cstdint> 35321369Sdim#include <iterator> 36327952Sdim#include <map> 37321369Sdim#include <memory> 38321369Sdim#include <string> 39321369Sdim#include <system_error> 40321369Sdim#include <utility> 41321369Sdim#include <vector> 42303231Sdim 43303231Sdimusing namespace llvm; 44303231Sdimusing namespace coverage; 45303231Sdim 46303231Sdim#define DEBUG_TYPE "coverage-mapping" 47303231Sdim 48303231SdimCounter CounterExpressionBuilder::get(const CounterExpression &E) { 49303231Sdim auto It = ExpressionIndices.find(E); 50303231Sdim if (It != ExpressionIndices.end()) 51303231Sdim return Counter::getExpression(It->second); 52303231Sdim unsigned I = Expressions.size(); 53303231Sdim Expressions.push_back(E); 54303231Sdim ExpressionIndices[E] = I; 55303231Sdim return Counter::getExpression(I); 56303231Sdim} 57303231Sdim 58321369Sdimvoid CounterExpressionBuilder::extractTerms(Counter C, int Factor, 59321369Sdim SmallVectorImpl<Term> &Terms) { 60303231Sdim switch (C.getKind()) { 61303231Sdim case Counter::Zero: 62303231Sdim break; 63303231Sdim case Counter::CounterValueReference: 64321369Sdim Terms.emplace_back(C.getCounterID(), Factor); 65303231Sdim break; 66303231Sdim case Counter::Expression: 67303231Sdim const auto &E = Expressions[C.getExpressionID()]; 68321369Sdim extractTerms(E.LHS, Factor, Terms); 69321369Sdim extractTerms( 70321369Sdim E.RHS, E.Kind == CounterExpression::Subtract ? -Factor : Factor, Terms); 71303231Sdim break; 72303231Sdim } 73303231Sdim} 74303231Sdim 75303231SdimCounter CounterExpressionBuilder::simplify(Counter ExpressionTree) { 76303231Sdim // Gather constant terms. 77321369Sdim SmallVector<Term, 32> Terms; 78303231Sdim extractTerms(ExpressionTree, +1, Terms); 79303231Sdim 80303231Sdim // If there are no terms, this is just a zero. The algorithm below assumes at 81303231Sdim // least one term. 82303231Sdim if (Terms.size() == 0) 83303231Sdim return Counter::getZero(); 84303231Sdim 85303231Sdim // Group the terms by counter ID. 86341825Sdim llvm::sort(Terms.begin(), Terms.end(), [](const Term &LHS, const Term &RHS) { 87321369Sdim return LHS.CounterID < RHS.CounterID; 88303231Sdim }); 89303231Sdim 90303231Sdim // Combine terms by counter ID to eliminate counters that sum to zero. 91303231Sdim auto Prev = Terms.begin(); 92303231Sdim for (auto I = Prev + 1, E = Terms.end(); I != E; ++I) { 93321369Sdim if (I->CounterID == Prev->CounterID) { 94321369Sdim Prev->Factor += I->Factor; 95303231Sdim continue; 96303231Sdim } 97303231Sdim ++Prev; 98303231Sdim *Prev = *I; 99303231Sdim } 100303231Sdim Terms.erase(++Prev, Terms.end()); 101303231Sdim 102303231Sdim Counter C; 103303231Sdim // Create additions. We do this before subtractions to avoid constructs like 104303231Sdim // ((0 - X) + Y), as opposed to (Y - X). 105321369Sdim for (auto T : Terms) { 106321369Sdim if (T.Factor <= 0) 107303231Sdim continue; 108321369Sdim for (int I = 0; I < T.Factor; ++I) 109303231Sdim if (C.isZero()) 110321369Sdim C = Counter::getCounter(T.CounterID); 111303231Sdim else 112303231Sdim C = get(CounterExpression(CounterExpression::Add, C, 113321369Sdim Counter::getCounter(T.CounterID))); 114303231Sdim } 115303231Sdim 116303231Sdim // Create subtractions. 117321369Sdim for (auto T : Terms) { 118321369Sdim if (T.Factor >= 0) 119303231Sdim continue; 120321369Sdim for (int I = 0; I < -T.Factor; ++I) 121303231Sdim C = get(CounterExpression(CounterExpression::Subtract, C, 122321369Sdim Counter::getCounter(T.CounterID))); 123303231Sdim } 124303231Sdim return C; 125303231Sdim} 126303231Sdim 127303231SdimCounter CounterExpressionBuilder::add(Counter LHS, Counter RHS) { 128303231Sdim return simplify(get(CounterExpression(CounterExpression::Add, LHS, RHS))); 129303231Sdim} 130303231Sdim 131303231SdimCounter CounterExpressionBuilder::subtract(Counter LHS, Counter RHS) { 132303231Sdim return simplify( 133303231Sdim get(CounterExpression(CounterExpression::Subtract, LHS, RHS))); 134303231Sdim} 135303231Sdim 136321369Sdimvoid CounterMappingContext::dump(const Counter &C, raw_ostream &OS) const { 137303231Sdim switch (C.getKind()) { 138303231Sdim case Counter::Zero: 139303231Sdim OS << '0'; 140303231Sdim return; 141303231Sdim case Counter::CounterValueReference: 142303231Sdim OS << '#' << C.getCounterID(); 143303231Sdim break; 144303231Sdim case Counter::Expression: { 145303231Sdim if (C.getExpressionID() >= Expressions.size()) 146303231Sdim return; 147303231Sdim const auto &E = Expressions[C.getExpressionID()]; 148303231Sdim OS << '('; 149303231Sdim dump(E.LHS, OS); 150303231Sdim OS << (E.Kind == CounterExpression::Subtract ? " - " : " + "); 151303231Sdim dump(E.RHS, OS); 152303231Sdim OS << ')'; 153303231Sdim break; 154303231Sdim } 155303231Sdim } 156303231Sdim if (CounterValues.empty()) 157303231Sdim return; 158303231Sdim Expected<int64_t> Value = evaluate(C); 159303231Sdim if (auto E = Value.takeError()) { 160321369Sdim consumeError(std::move(E)); 161303231Sdim return; 162303231Sdim } 163303231Sdim OS << '[' << *Value << ']'; 164303231Sdim} 165303231Sdim 166303231SdimExpected<int64_t> CounterMappingContext::evaluate(const Counter &C) const { 167303231Sdim switch (C.getKind()) { 168303231Sdim case Counter::Zero: 169303231Sdim return 0; 170303231Sdim case Counter::CounterValueReference: 171303231Sdim if (C.getCounterID() >= CounterValues.size()) 172303231Sdim return errorCodeToError(errc::argument_out_of_domain); 173303231Sdim return CounterValues[C.getCounterID()]; 174303231Sdim case Counter::Expression: { 175303231Sdim if (C.getExpressionID() >= Expressions.size()) 176303231Sdim return errorCodeToError(errc::argument_out_of_domain); 177303231Sdim const auto &E = Expressions[C.getExpressionID()]; 178303231Sdim Expected<int64_t> LHS = evaluate(E.LHS); 179303231Sdim if (!LHS) 180303231Sdim return LHS; 181303231Sdim Expected<int64_t> RHS = evaluate(E.RHS); 182303231Sdim if (!RHS) 183303231Sdim return RHS; 184303231Sdim return E.Kind == CounterExpression::Subtract ? *LHS - *RHS : *LHS + *RHS; 185303231Sdim } 186303231Sdim } 187303231Sdim llvm_unreachable("Unhandled CounterKind"); 188303231Sdim} 189303231Sdim 190303231Sdimvoid FunctionRecordIterator::skipOtherFiles() { 191303231Sdim while (Current != Records.end() && !Filename.empty() && 192303231Sdim Filename != Current->Filenames[0]) 193303231Sdim ++Current; 194303231Sdim if (Current == Records.end()) 195303231Sdim *this = FunctionRecordIterator(); 196303231Sdim} 197303231Sdim 198314564SdimError CoverageMapping::loadFunctionRecord( 199314564Sdim const CoverageMappingRecord &Record, 200314564Sdim IndexedInstrProfReader &ProfileReader) { 201314564Sdim StringRef OrigFuncName = Record.FunctionName; 202321369Sdim if (OrigFuncName.empty()) 203321369Sdim return make_error<CoverageMapError>(coveragemap_error::malformed); 204321369Sdim 205314564Sdim if (Record.Filenames.empty()) 206314564Sdim OrigFuncName = getFuncNameWithoutPrefix(OrigFuncName); 207314564Sdim else 208314564Sdim OrigFuncName = getFuncNameWithoutPrefix(OrigFuncName, Record.Filenames[0]); 209314564Sdim 210341825Sdim // Don't load records for (filenames, function) pairs we've already seen. 211341825Sdim auto FilenamesHash = hash_combine_range(Record.Filenames.begin(), 212341825Sdim Record.Filenames.end()); 213341825Sdim if (!RecordProvenance[FilenamesHash].insert(hash_value(OrigFuncName)).second) 214314564Sdim return Error::success(); 215314564Sdim 216314564Sdim CounterMappingContext Ctx(Record.Expressions); 217314564Sdim 218314564Sdim std::vector<uint64_t> Counts; 219314564Sdim if (Error E = ProfileReader.getFunctionCounts(Record.FunctionName, 220314564Sdim Record.FunctionHash, Counts)) { 221314564Sdim instrprof_error IPE = InstrProfError::take(std::move(E)); 222314564Sdim if (IPE == instrprof_error::hash_mismatch) { 223327952Sdim FuncHashMismatches.emplace_back(Record.FunctionName, Record.FunctionHash); 224314564Sdim return Error::success(); 225314564Sdim } else if (IPE != instrprof_error::unknown_function) 226314564Sdim return make_error<InstrProfError>(IPE); 227314564Sdim Counts.assign(Record.MappingRegions.size(), 0); 228314564Sdim } 229314564Sdim Ctx.setCounts(Counts); 230314564Sdim 231314564Sdim assert(!Record.MappingRegions.empty() && "Function has no regions"); 232314564Sdim 233314564Sdim FunctionRecord Function(OrigFuncName, Record.Filenames); 234314564Sdim for (const auto &Region : Record.MappingRegions) { 235314564Sdim Expected<int64_t> ExecutionCount = Ctx.evaluate(Region.Count); 236314564Sdim if (auto E = ExecutionCount.takeError()) { 237321369Sdim consumeError(std::move(E)); 238314564Sdim return Error::success(); 239314564Sdim } 240314564Sdim Function.pushRegion(Region, *ExecutionCount); 241314564Sdim } 242314564Sdim if (Function.CountedRegions.size() != Record.MappingRegions.size()) { 243327952Sdim FuncCounterMismatches.emplace_back(Record.FunctionName, 244327952Sdim Function.CountedRegions.size()); 245314564Sdim return Error::success(); 246314564Sdim } 247314564Sdim 248314564Sdim Functions.push_back(std::move(Function)); 249314564Sdim return Error::success(); 250314564Sdim} 251314564Sdim 252314564SdimExpected<std::unique_ptr<CoverageMapping>> CoverageMapping::load( 253314564Sdim ArrayRef<std::unique_ptr<CoverageMappingReader>> CoverageReaders, 254314564Sdim IndexedInstrProfReader &ProfileReader) { 255314564Sdim auto Coverage = std::unique_ptr<CoverageMapping>(new CoverageMapping()); 256303231Sdim 257327952Sdim for (const auto &CoverageReader : CoverageReaders) { 258327952Sdim for (auto RecordOrErr : *CoverageReader) { 259327952Sdim if (Error E = RecordOrErr.takeError()) 260327952Sdim return std::move(E); 261327952Sdim const auto &Record = *RecordOrErr; 262314564Sdim if (Error E = Coverage->loadFunctionRecord(Record, ProfileReader)) 263314564Sdim return std::move(E); 264327952Sdim } 265327952Sdim } 266303231Sdim 267303231Sdim return std::move(Coverage); 268303231Sdim} 269303231Sdim 270303231SdimExpected<std::unique_ptr<CoverageMapping>> 271314564SdimCoverageMapping::load(ArrayRef<StringRef> ObjectFilenames, 272327952Sdim StringRef ProfileFilename, ArrayRef<StringRef> Arches) { 273303231Sdim auto ProfileReaderOrErr = IndexedInstrProfReader::create(ProfileFilename); 274303231Sdim if (Error E = ProfileReaderOrErr.takeError()) 275303231Sdim return std::move(E); 276303231Sdim auto ProfileReader = std::move(ProfileReaderOrErr.get()); 277314564Sdim 278314564Sdim SmallVector<std::unique_ptr<CoverageMappingReader>, 4> Readers; 279314564Sdim SmallVector<std::unique_ptr<MemoryBuffer>, 4> Buffers; 280327952Sdim for (const auto &File : llvm::enumerate(ObjectFilenames)) { 281327952Sdim auto CovMappingBufOrErr = MemoryBuffer::getFileOrSTDIN(File.value()); 282314564Sdim if (std::error_code EC = CovMappingBufOrErr.getError()) 283314564Sdim return errorCodeToError(EC); 284327952Sdim StringRef Arch = Arches.empty() ? StringRef() : Arches[File.index()]; 285314564Sdim auto CoverageReaderOrErr = 286314564Sdim BinaryCoverageReader::create(CovMappingBufOrErr.get(), Arch); 287314564Sdim if (Error E = CoverageReaderOrErr.takeError()) 288314564Sdim return std::move(E); 289314564Sdim Readers.push_back(std::move(CoverageReaderOrErr.get())); 290314564Sdim Buffers.push_back(std::move(CovMappingBufOrErr.get())); 291314564Sdim } 292314564Sdim return load(Readers, *ProfileReader); 293303231Sdim} 294303231Sdim 295303231Sdimnamespace { 296321369Sdim 297341825Sdim/// Distributes functions into instantiation sets. 298303231Sdim/// 299303231Sdim/// An instantiation set is a collection of functions that have the same source 300303231Sdim/// code, ie, template functions specializations. 301303231Sdimclass FunctionInstantiationSetCollector { 302327952Sdim using MapT = std::map<LineColPair, std::vector<const FunctionRecord *>>; 303303231Sdim MapT InstantiatedFunctions; 304303231Sdim 305303231Sdimpublic: 306303231Sdim void insert(const FunctionRecord &Function, unsigned FileID) { 307303231Sdim auto I = Function.CountedRegions.begin(), E = Function.CountedRegions.end(); 308303231Sdim while (I != E && I->FileID != FileID) 309303231Sdim ++I; 310303231Sdim assert(I != E && "function does not cover the given file"); 311303231Sdim auto &Functions = InstantiatedFunctions[I->startLoc()]; 312303231Sdim Functions.push_back(&Function); 313303231Sdim } 314303231Sdim 315303231Sdim MapT::iterator begin() { return InstantiatedFunctions.begin(); } 316303231Sdim MapT::iterator end() { return InstantiatedFunctions.end(); } 317303231Sdim}; 318303231Sdim 319303231Sdimclass SegmentBuilder { 320303231Sdim std::vector<CoverageSegment> &Segments; 321303231Sdim SmallVector<const CountedRegion *, 8> ActiveRegions; 322303231Sdim 323303231Sdim SegmentBuilder(std::vector<CoverageSegment> &Segments) : Segments(Segments) {} 324303231Sdim 325327952Sdim /// Emit a segment with the count from \p Region starting at \p StartLoc. 326327952Sdim // 327327952Sdim /// \p IsRegionEntry: The segment is at the start of a new non-gap region. 328327952Sdim /// \p EmitSkippedRegion: The segment must be emitted as a skipped region. 329327952Sdim void startSegment(const CountedRegion &Region, LineColPair StartLoc, 330327952Sdim bool IsRegionEntry, bool EmitSkippedRegion = false) { 331327952Sdim bool HasCount = !EmitSkippedRegion && 332327952Sdim (Region.Kind != CounterMappingRegion::SkippedRegion); 333303231Sdim 334327952Sdim // If the new segment wouldn't affect coverage rendering, skip it. 335327952Sdim if (!Segments.empty() && !IsRegionEntry && !EmitSkippedRegion) { 336327952Sdim const auto &Last = Segments.back(); 337327952Sdim if (Last.HasCount == HasCount && Last.Count == Region.ExecutionCount && 338327952Sdim !Last.IsRegionEntry) 339327952Sdim return; 340327952Sdim } 341303231Sdim 342327952Sdim if (HasCount) 343327952Sdim Segments.emplace_back(StartLoc.first, StartLoc.second, 344327952Sdim Region.ExecutionCount, IsRegionEntry, 345327952Sdim Region.Kind == CounterMappingRegion::GapRegion); 346327952Sdim else 347327952Sdim Segments.emplace_back(StartLoc.first, StartLoc.second, IsRegionEntry); 348327952Sdim 349341825Sdim LLVM_DEBUG({ 350327952Sdim const auto &Last = Segments.back(); 351327952Sdim dbgs() << "Segment at " << Last.Line << ":" << Last.Col 352327952Sdim << " (count = " << Last.Count << ")" 353327952Sdim << (Last.IsRegionEntry ? ", RegionEntry" : "") 354327952Sdim << (!Last.HasCount ? ", Skipped" : "") 355327952Sdim << (Last.IsGapRegion ? ", Gap" : "") << "\n"; 356327952Sdim }); 357303231Sdim } 358303231Sdim 359327952Sdim /// Emit segments for active regions which end before \p Loc. 360327952Sdim /// 361327952Sdim /// \p Loc: The start location of the next region. If None, all active 362327952Sdim /// regions are completed. 363327952Sdim /// \p FirstCompletedRegion: Index of the first completed region. 364327952Sdim void completeRegionsUntil(Optional<LineColPair> Loc, 365327952Sdim unsigned FirstCompletedRegion) { 366327952Sdim // Sort the completed regions by end location. This makes it simple to 367327952Sdim // emit closing segments in sorted order. 368327952Sdim auto CompletedRegionsIt = ActiveRegions.begin() + FirstCompletedRegion; 369327952Sdim std::stable_sort(CompletedRegionsIt, ActiveRegions.end(), 370327952Sdim [](const CountedRegion *L, const CountedRegion *R) { 371327952Sdim return L->endLoc() < R->endLoc(); 372327952Sdim }); 373327952Sdim 374327952Sdim // Emit segments for all completed regions. 375327952Sdim for (unsigned I = FirstCompletedRegion + 1, E = ActiveRegions.size(); I < E; 376327952Sdim ++I) { 377327952Sdim const auto *CompletedRegion = ActiveRegions[I]; 378327952Sdim assert((!Loc || CompletedRegion->endLoc() <= *Loc) && 379327952Sdim "Completed region ends after start of new region"); 380327952Sdim 381327952Sdim const auto *PrevCompletedRegion = ActiveRegions[I - 1]; 382327952Sdim auto CompletedSegmentLoc = PrevCompletedRegion->endLoc(); 383327952Sdim 384327952Sdim // Don't emit any more segments if they start where the new region begins. 385327952Sdim if (Loc && CompletedSegmentLoc == *Loc) 386327952Sdim break; 387327952Sdim 388327952Sdim // Don't emit a segment if the next completed region ends at the same 389327952Sdim // location as this one. 390327952Sdim if (CompletedSegmentLoc == CompletedRegion->endLoc()) 391327952Sdim continue; 392327952Sdim 393327952Sdim // Use the count from the last completed region which ends at this loc. 394327952Sdim for (unsigned J = I + 1; J < E; ++J) 395327952Sdim if (CompletedRegion->endLoc() == ActiveRegions[J]->endLoc()) 396327952Sdim CompletedRegion = ActiveRegions[J]; 397327952Sdim 398327952Sdim startSegment(*CompletedRegion, CompletedSegmentLoc, false); 399327952Sdim } 400327952Sdim 401327952Sdim auto Last = ActiveRegions.back(); 402327952Sdim if (FirstCompletedRegion && Last->endLoc() != *Loc) { 403327952Sdim // If there's a gap after the end of the last completed region and the 404327952Sdim // start of the new region, use the last active region to fill the gap. 405327952Sdim startSegment(*ActiveRegions[FirstCompletedRegion - 1], Last->endLoc(), 406327952Sdim false); 407327952Sdim } else if (!FirstCompletedRegion && (!Loc || *Loc != Last->endLoc())) { 408327952Sdim // Emit a skipped segment if there are no more active regions. This 409327952Sdim // ensures that gaps between functions are marked correctly. 410327952Sdim startSegment(*Last, Last->endLoc(), false, true); 411327952Sdim } 412327952Sdim 413327952Sdim // Pop the completed regions. 414327952Sdim ActiveRegions.erase(CompletedRegionsIt, ActiveRegions.end()); 415303231Sdim } 416303231Sdim 417303231Sdim void buildSegmentsImpl(ArrayRef<CountedRegion> Regions) { 418327952Sdim for (const auto &CR : enumerate(Regions)) { 419327952Sdim auto CurStartLoc = CR.value().startLoc(); 420327952Sdim 421327952Sdim // Active regions which end before the current region need to be popped. 422327952Sdim auto CompletedRegions = 423327952Sdim std::stable_partition(ActiveRegions.begin(), ActiveRegions.end(), 424327952Sdim [&](const CountedRegion *Region) { 425327952Sdim return !(Region->endLoc() <= CurStartLoc); 426327952Sdim }); 427327952Sdim if (CompletedRegions != ActiveRegions.end()) { 428327952Sdim unsigned FirstCompletedRegion = 429327952Sdim std::distance(ActiveRegions.begin(), CompletedRegions); 430327952Sdim completeRegionsUntil(CurStartLoc, FirstCompletedRegion); 431327952Sdim } 432327952Sdim 433327952Sdim bool GapRegion = CR.value().Kind == CounterMappingRegion::GapRegion; 434327952Sdim 435327952Sdim // Try to emit a segment for the current region. 436327952Sdim if (CurStartLoc == CR.value().endLoc()) { 437327952Sdim // Avoid making zero-length regions active. If it's the last region, 438327952Sdim // emit a skipped segment. Otherwise use its predecessor's count. 439327952Sdim const bool Skipped = (CR.index() + 1) == Regions.size(); 440327952Sdim startSegment(ActiveRegions.empty() ? CR.value() : *ActiveRegions.back(), 441327952Sdim CurStartLoc, !GapRegion, Skipped); 442327952Sdim continue; 443327952Sdim } 444327952Sdim if (CR.index() + 1 == Regions.size() || 445327952Sdim CurStartLoc != Regions[CR.index() + 1].startLoc()) { 446327952Sdim // Emit a segment if the next region doesn't start at the same location 447327952Sdim // as this one. 448327952Sdim startSegment(CR.value(), CurStartLoc, !GapRegion); 449327952Sdim } 450327952Sdim 451327952Sdim // This region is active (i.e not completed). 452327952Sdim ActiveRegions.push_back(&CR.value()); 453303231Sdim } 454327952Sdim 455327952Sdim // Complete any remaining active regions. 456327952Sdim if (!ActiveRegions.empty()) 457327952Sdim completeRegionsUntil(None, 0); 458303231Sdim } 459303231Sdim 460303231Sdim /// Sort a nested sequence of regions from a single file. 461303231Sdim static void sortNestedRegions(MutableArrayRef<CountedRegion> Regions) { 462341825Sdim llvm::sort(Regions.begin(), Regions.end(), [](const CountedRegion &LHS, 463341825Sdim const CountedRegion &RHS) { 464303231Sdim if (LHS.startLoc() != RHS.startLoc()) 465303231Sdim return LHS.startLoc() < RHS.startLoc(); 466303231Sdim if (LHS.endLoc() != RHS.endLoc()) 467303231Sdim // When LHS completely contains RHS, we sort LHS first. 468303231Sdim return RHS.endLoc() < LHS.endLoc(); 469303231Sdim // If LHS and RHS cover the same area, we need to sort them according 470303231Sdim // to their kinds so that the most suitable region will become "active" 471303231Sdim // in combineRegions(). Because we accumulate counter values only from 472303231Sdim // regions of the same kind as the first region of the area, prefer 473303231Sdim // CodeRegion to ExpansionRegion and ExpansionRegion to SkippedRegion. 474321369Sdim static_assert(CounterMappingRegion::CodeRegion < 475321369Sdim CounterMappingRegion::ExpansionRegion && 476321369Sdim CounterMappingRegion::ExpansionRegion < 477321369Sdim CounterMappingRegion::SkippedRegion, 478303231Sdim "Unexpected order of region kind values"); 479303231Sdim return LHS.Kind < RHS.Kind; 480303231Sdim }); 481303231Sdim } 482303231Sdim 483303231Sdim /// Combine counts of regions which cover the same area. 484303231Sdim static ArrayRef<CountedRegion> 485303231Sdim combineRegions(MutableArrayRef<CountedRegion> Regions) { 486303231Sdim if (Regions.empty()) 487303231Sdim return Regions; 488303231Sdim auto Active = Regions.begin(); 489303231Sdim auto End = Regions.end(); 490303231Sdim for (auto I = Regions.begin() + 1; I != End; ++I) { 491303231Sdim if (Active->startLoc() != I->startLoc() || 492303231Sdim Active->endLoc() != I->endLoc()) { 493303231Sdim // Shift to the next region. 494303231Sdim ++Active; 495303231Sdim if (Active != I) 496303231Sdim *Active = *I; 497303231Sdim continue; 498303231Sdim } 499303231Sdim // Merge duplicate region. 500303231Sdim // If CodeRegions and ExpansionRegions cover the same area, it's probably 501303231Sdim // a macro which is fully expanded to another macro. In that case, we need 502303231Sdim // to accumulate counts only from CodeRegions, or else the area will be 503303231Sdim // counted twice. 504303231Sdim // On the other hand, a macro may have a nested macro in its body. If the 505303231Sdim // outer macro is used several times, the ExpansionRegion for the nested 506303231Sdim // macro will also be added several times. These ExpansionRegions cover 507303231Sdim // the same source locations and have to be combined to reach the correct 508303231Sdim // value for that area. 509303231Sdim // We add counts of the regions of the same kind as the active region 510303231Sdim // to handle the both situations. 511303231Sdim if (I->Kind == Active->Kind) 512303231Sdim Active->ExecutionCount += I->ExecutionCount; 513303231Sdim } 514303231Sdim return Regions.drop_back(std::distance(++Active, End)); 515303231Sdim } 516303231Sdim 517303231Sdimpublic: 518327952Sdim /// Build a sorted list of CoverageSegments from a list of Regions. 519303231Sdim static std::vector<CoverageSegment> 520303231Sdim buildSegments(MutableArrayRef<CountedRegion> Regions) { 521303231Sdim std::vector<CoverageSegment> Segments; 522303231Sdim SegmentBuilder Builder(Segments); 523303231Sdim 524303231Sdim sortNestedRegions(Regions); 525303231Sdim ArrayRef<CountedRegion> CombinedRegions = combineRegions(Regions); 526303231Sdim 527341825Sdim LLVM_DEBUG({ 528327952Sdim dbgs() << "Combined regions:\n"; 529327952Sdim for (const auto &CR : CombinedRegions) 530327952Sdim dbgs() << " " << CR.LineStart << ":" << CR.ColumnStart << " -> " 531327952Sdim << CR.LineEnd << ":" << CR.ColumnEnd 532327952Sdim << " (count=" << CR.ExecutionCount << ")\n"; 533327952Sdim }); 534327952Sdim 535303231Sdim Builder.buildSegmentsImpl(CombinedRegions); 536327952Sdim 537327952Sdim#ifndef NDEBUG 538327952Sdim for (unsigned I = 1, E = Segments.size(); I < E; ++I) { 539327952Sdim const auto &L = Segments[I - 1]; 540327952Sdim const auto &R = Segments[I]; 541327952Sdim if (!(L.Line < R.Line) && !(L.Line == R.Line && L.Col < R.Col)) { 542341825Sdim LLVM_DEBUG(dbgs() << " ! Segment " << L.Line << ":" << L.Col 543341825Sdim << " followed by " << R.Line << ":" << R.Col << "\n"); 544327952Sdim assert(false && "Coverage segments not unique or sorted"); 545327952Sdim } 546327952Sdim } 547327952Sdim#endif 548327952Sdim 549303231Sdim return Segments; 550303231Sdim } 551303231Sdim}; 552303231Sdim 553321369Sdim} // end anonymous namespace 554321369Sdim 555303231Sdimstd::vector<StringRef> CoverageMapping::getUniqueSourceFiles() const { 556303231Sdim std::vector<StringRef> Filenames; 557303231Sdim for (const auto &Function : getCoveredFunctions()) 558303231Sdim Filenames.insert(Filenames.end(), Function.Filenames.begin(), 559303231Sdim Function.Filenames.end()); 560341825Sdim llvm::sort(Filenames.begin(), Filenames.end()); 561303231Sdim auto Last = std::unique(Filenames.begin(), Filenames.end()); 562303231Sdim Filenames.erase(Last, Filenames.end()); 563303231Sdim return Filenames; 564303231Sdim} 565303231Sdim 566303231Sdimstatic SmallBitVector gatherFileIDs(StringRef SourceFile, 567303231Sdim const FunctionRecord &Function) { 568303231Sdim SmallBitVector FilenameEquivalence(Function.Filenames.size(), false); 569303231Sdim for (unsigned I = 0, E = Function.Filenames.size(); I < E; ++I) 570303231Sdim if (SourceFile == Function.Filenames[I]) 571303231Sdim FilenameEquivalence[I] = true; 572303231Sdim return FilenameEquivalence; 573303231Sdim} 574303231Sdim 575303231Sdim/// Return the ID of the file where the definition of the function is located. 576303231Sdimstatic Optional<unsigned> findMainViewFileID(const FunctionRecord &Function) { 577303231Sdim SmallBitVector IsNotExpandedFile(Function.Filenames.size(), true); 578303231Sdim for (const auto &CR : Function.CountedRegions) 579303231Sdim if (CR.Kind == CounterMappingRegion::ExpansionRegion) 580303231Sdim IsNotExpandedFile[CR.ExpandedFileID] = false; 581303231Sdim int I = IsNotExpandedFile.find_first(); 582303231Sdim if (I == -1) 583303231Sdim return None; 584303231Sdim return I; 585303231Sdim} 586303231Sdim 587303231Sdim/// Check if SourceFile is the file that contains the definition of 588303231Sdim/// the Function. Return the ID of the file in that case or None otherwise. 589303231Sdimstatic Optional<unsigned> findMainViewFileID(StringRef SourceFile, 590303231Sdim const FunctionRecord &Function) { 591303231Sdim Optional<unsigned> I = findMainViewFileID(Function); 592303231Sdim if (I && SourceFile == Function.Filenames[*I]) 593303231Sdim return I; 594303231Sdim return None; 595303231Sdim} 596303231Sdim 597303231Sdimstatic bool isExpansion(const CountedRegion &R, unsigned FileID) { 598303231Sdim return R.Kind == CounterMappingRegion::ExpansionRegion && R.FileID == FileID; 599303231Sdim} 600303231Sdim 601303231SdimCoverageData CoverageMapping::getCoverageForFile(StringRef Filename) const { 602303231Sdim CoverageData FileCoverage(Filename); 603321369Sdim std::vector<CountedRegion> Regions; 604303231Sdim 605303231Sdim for (const auto &Function : Functions) { 606303231Sdim auto MainFileID = findMainViewFileID(Filename, Function); 607303231Sdim auto FileIDs = gatherFileIDs(Filename, Function); 608303231Sdim for (const auto &CR : Function.CountedRegions) 609303231Sdim if (FileIDs.test(CR.FileID)) { 610303231Sdim Regions.push_back(CR); 611303231Sdim if (MainFileID && isExpansion(CR, *MainFileID)) 612303231Sdim FileCoverage.Expansions.emplace_back(CR, Function); 613303231Sdim } 614303231Sdim } 615303231Sdim 616341825Sdim LLVM_DEBUG(dbgs() << "Emitting segments for file: " << Filename << "\n"); 617303231Sdim FileCoverage.Segments = SegmentBuilder::buildSegments(Regions); 618303231Sdim 619303231Sdim return FileCoverage; 620303231Sdim} 621303231Sdim 622327952Sdimstd::vector<InstantiationGroup> 623327952SdimCoverageMapping::getInstantiationGroups(StringRef Filename) const { 624303231Sdim FunctionInstantiationSetCollector InstantiationSetCollector; 625303231Sdim for (const auto &Function : Functions) { 626303231Sdim auto MainFileID = findMainViewFileID(Filename, Function); 627303231Sdim if (!MainFileID) 628303231Sdim continue; 629303231Sdim InstantiationSetCollector.insert(Function, *MainFileID); 630303231Sdim } 631303231Sdim 632327952Sdim std::vector<InstantiationGroup> Result; 633327952Sdim for (auto &InstantiationSet : InstantiationSetCollector) { 634327952Sdim InstantiationGroup IG{InstantiationSet.first.first, 635327952Sdim InstantiationSet.first.second, 636327952Sdim std::move(InstantiationSet.second)}; 637327952Sdim Result.emplace_back(std::move(IG)); 638303231Sdim } 639303231Sdim return Result; 640303231Sdim} 641303231Sdim 642303231SdimCoverageData 643303231SdimCoverageMapping::getCoverageForFunction(const FunctionRecord &Function) const { 644303231Sdim auto MainFileID = findMainViewFileID(Function); 645303231Sdim if (!MainFileID) 646303231Sdim return CoverageData(); 647303231Sdim 648303231Sdim CoverageData FunctionCoverage(Function.Filenames[*MainFileID]); 649321369Sdim std::vector<CountedRegion> Regions; 650303231Sdim for (const auto &CR : Function.CountedRegions) 651303231Sdim if (CR.FileID == *MainFileID) { 652303231Sdim Regions.push_back(CR); 653303231Sdim if (isExpansion(CR, *MainFileID)) 654303231Sdim FunctionCoverage.Expansions.emplace_back(CR, Function); 655303231Sdim } 656303231Sdim 657341825Sdim LLVM_DEBUG(dbgs() << "Emitting segments for function: " << Function.Name 658341825Sdim << "\n"); 659303231Sdim FunctionCoverage.Segments = SegmentBuilder::buildSegments(Regions); 660303231Sdim 661303231Sdim return FunctionCoverage; 662303231Sdim} 663303231Sdim 664303231SdimCoverageData CoverageMapping::getCoverageForExpansion( 665303231Sdim const ExpansionRecord &Expansion) const { 666303231Sdim CoverageData ExpansionCoverage( 667303231Sdim Expansion.Function.Filenames[Expansion.FileID]); 668321369Sdim std::vector<CountedRegion> Regions; 669303231Sdim for (const auto &CR : Expansion.Function.CountedRegions) 670303231Sdim if (CR.FileID == Expansion.FileID) { 671303231Sdim Regions.push_back(CR); 672303231Sdim if (isExpansion(CR, Expansion.FileID)) 673303231Sdim ExpansionCoverage.Expansions.emplace_back(CR, Expansion.Function); 674303231Sdim } 675303231Sdim 676341825Sdim LLVM_DEBUG(dbgs() << "Emitting segments for expansion of file " 677341825Sdim << Expansion.FileID << "\n"); 678303231Sdim ExpansionCoverage.Segments = SegmentBuilder::buildSegments(Regions); 679303231Sdim 680303231Sdim return ExpansionCoverage; 681303231Sdim} 682303231Sdim 683327952SdimLineCoverageStats::LineCoverageStats( 684327952Sdim ArrayRef<const CoverageSegment *> LineSegments, 685327952Sdim const CoverageSegment *WrappedSegment, unsigned Line) 686327952Sdim : ExecutionCount(0), HasMultipleRegions(false), Mapped(false), Line(Line), 687327952Sdim LineSegments(LineSegments), WrappedSegment(WrappedSegment) { 688327952Sdim // Find the minimum number of regions which start in this line. 689327952Sdim unsigned MinRegionCount = 0; 690327952Sdim auto isStartOfRegion = [](const CoverageSegment *S) { 691327952Sdim return !S->IsGapRegion && S->HasCount && S->IsRegionEntry; 692327952Sdim }; 693327952Sdim for (unsigned I = 0; I < LineSegments.size() && MinRegionCount < 2; ++I) 694327952Sdim if (isStartOfRegion(LineSegments[I])) 695327952Sdim ++MinRegionCount; 696327952Sdim 697327952Sdim bool StartOfSkippedRegion = !LineSegments.empty() && 698327952Sdim !LineSegments.front()->HasCount && 699327952Sdim LineSegments.front()->IsRegionEntry; 700327952Sdim 701327952Sdim HasMultipleRegions = MinRegionCount > 1; 702327952Sdim Mapped = 703327952Sdim !StartOfSkippedRegion && 704327952Sdim ((WrappedSegment && WrappedSegment->HasCount) || (MinRegionCount > 0)); 705327952Sdim 706327952Sdim if (!Mapped) 707327952Sdim return; 708327952Sdim 709327952Sdim // Pick the max count from the non-gap, region entry segments and the 710327952Sdim // wrapped count. 711327952Sdim if (WrappedSegment) 712327952Sdim ExecutionCount = WrappedSegment->Count; 713327952Sdim if (!MinRegionCount) 714327952Sdim return; 715327952Sdim for (const auto *LS : LineSegments) 716327952Sdim if (isStartOfRegion(LS)) 717327952Sdim ExecutionCount = std::max(ExecutionCount, LS->Count); 718327952Sdim} 719327952Sdim 720327952SdimLineCoverageIterator &LineCoverageIterator::operator++() { 721327952Sdim if (Next == CD.end()) { 722327952Sdim Stats = LineCoverageStats(); 723327952Sdim Ended = true; 724327952Sdim return *this; 725327952Sdim } 726327952Sdim if (Segments.size()) 727327952Sdim WrappedSegment = Segments.back(); 728327952Sdim Segments.clear(); 729327952Sdim while (Next != CD.end() && Next->Line == Line) 730327952Sdim Segments.push_back(&*Next++); 731327952Sdim Stats = LineCoverageStats(Segments, WrappedSegment, Line); 732327952Sdim ++Line; 733327952Sdim return *this; 734327952Sdim} 735327952Sdim 736321369Sdimstatic std::string getCoverageMapErrString(coveragemap_error Err) { 737303231Sdim switch (Err) { 738303231Sdim case coveragemap_error::success: 739303231Sdim return "Success"; 740303231Sdim case coveragemap_error::eof: 741303231Sdim return "End of File"; 742303231Sdim case coveragemap_error::no_data_found: 743303231Sdim return "No coverage data found"; 744303231Sdim case coveragemap_error::unsupported_version: 745303231Sdim return "Unsupported coverage format version"; 746303231Sdim case coveragemap_error::truncated: 747303231Sdim return "Truncated coverage data"; 748303231Sdim case coveragemap_error::malformed: 749303231Sdim return "Malformed coverage data"; 750303231Sdim } 751303231Sdim llvm_unreachable("A value of coveragemap_error has no message."); 752303231Sdim} 753303231Sdim 754321369Sdimnamespace { 755321369Sdim 756303231Sdim// FIXME: This class is only here to support the transition to llvm::Error. It 757303231Sdim// will be removed once this transition is complete. Clients should prefer to 758303231Sdim// deal with the Error value directly, rather than converting to error_code. 759303231Sdimclass CoverageMappingErrorCategoryType : public std::error_category { 760314564Sdim const char *name() const noexcept override { return "llvm.coveragemap"; } 761303231Sdim std::string message(int IE) const override { 762303231Sdim return getCoverageMapErrString(static_cast<coveragemap_error>(IE)); 763303231Sdim } 764303231Sdim}; 765321369Sdim 766303231Sdim} // end anonymous namespace 767303231Sdim 768303231Sdimstd::string CoverageMapError::message() const { 769303231Sdim return getCoverageMapErrString(Err); 770303231Sdim} 771303231Sdim 772303231Sdimstatic ManagedStatic<CoverageMappingErrorCategoryType> ErrorCategory; 773303231Sdim 774303231Sdimconst std::error_category &llvm::coverage::coveragemap_category() { 775303231Sdim return *ErrorCategory; 776303231Sdim} 777303231Sdim 778303231Sdimchar CoverageMapError::ID = 0; 779