CoverageMapping.cpp revision 353358
1321369Sdim//===- CoverageMapping.cpp - Code coverage mapping support ----------------===// 2303231Sdim// 3353358Sdim// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4353358Sdim// See https://llvm.org/LICENSE.txt for license information. 5353358Sdim// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6303231Sdim// 7303231Sdim//===----------------------------------------------------------------------===// 8303231Sdim// 9303231Sdim// This file contains support for clang's and llvm's instrumentation based 10303231Sdim// code coverage. 11303231Sdim// 12303231Sdim//===----------------------------------------------------------------------===// 13303231Sdim 14303231Sdim#include "llvm/ProfileData/Coverage/CoverageMapping.h" 15321369Sdim#include "llvm/ADT/ArrayRef.h" 16303231Sdim#include "llvm/ADT/DenseMap.h" 17321369Sdim#include "llvm/ADT/None.h" 18303231Sdim#include "llvm/ADT/Optional.h" 19303231Sdim#include "llvm/ADT/SmallBitVector.h" 20321369Sdim#include "llvm/ADT/SmallVector.h" 21321369Sdim#include "llvm/ADT/StringRef.h" 22303231Sdim#include "llvm/ProfileData/Coverage/CoverageMappingReader.h" 23303231Sdim#include "llvm/ProfileData/InstrProfReader.h" 24303231Sdim#include "llvm/Support/Debug.h" 25303231Sdim#include "llvm/Support/Errc.h" 26321369Sdim#include "llvm/Support/Error.h" 27303231Sdim#include "llvm/Support/ErrorHandling.h" 28303231Sdim#include "llvm/Support/ManagedStatic.h" 29321369Sdim#include "llvm/Support/MemoryBuffer.h" 30303231Sdim#include "llvm/Support/raw_ostream.h" 31321369Sdim#include <algorithm> 32321369Sdim#include <cassert> 33321369Sdim#include <cstdint> 34321369Sdim#include <iterator> 35327952Sdim#include <map> 36321369Sdim#include <memory> 37321369Sdim#include <string> 38321369Sdim#include <system_error> 39321369Sdim#include <utility> 40321369Sdim#include <vector> 41303231Sdim 42303231Sdimusing namespace llvm; 43303231Sdimusing namespace coverage; 44303231Sdim 45303231Sdim#define DEBUG_TYPE "coverage-mapping" 46303231Sdim 47303231SdimCounter CounterExpressionBuilder::get(const CounterExpression &E) { 48303231Sdim auto It = ExpressionIndices.find(E); 49303231Sdim if (It != ExpressionIndices.end()) 50303231Sdim return Counter::getExpression(It->second); 51303231Sdim unsigned I = Expressions.size(); 52303231Sdim Expressions.push_back(E); 53303231Sdim ExpressionIndices[E] = I; 54303231Sdim return Counter::getExpression(I); 55303231Sdim} 56303231Sdim 57321369Sdimvoid CounterExpressionBuilder::extractTerms(Counter C, int Factor, 58321369Sdim SmallVectorImpl<Term> &Terms) { 59303231Sdim switch (C.getKind()) { 60303231Sdim case Counter::Zero: 61303231Sdim break; 62303231Sdim case Counter::CounterValueReference: 63321369Sdim Terms.emplace_back(C.getCounterID(), Factor); 64303231Sdim break; 65303231Sdim case Counter::Expression: 66303231Sdim const auto &E = Expressions[C.getExpressionID()]; 67321369Sdim extractTerms(E.LHS, Factor, Terms); 68321369Sdim extractTerms( 69321369Sdim E.RHS, E.Kind == CounterExpression::Subtract ? -Factor : Factor, Terms); 70303231Sdim break; 71303231Sdim } 72303231Sdim} 73303231Sdim 74303231SdimCounter CounterExpressionBuilder::simplify(Counter ExpressionTree) { 75303231Sdim // Gather constant terms. 76321369Sdim SmallVector<Term, 32> Terms; 77303231Sdim extractTerms(ExpressionTree, +1, Terms); 78303231Sdim 79303231Sdim // If there are no terms, this is just a zero. The algorithm below assumes at 80303231Sdim // least one term. 81303231Sdim if (Terms.size() == 0) 82303231Sdim return Counter::getZero(); 83303231Sdim 84303231Sdim // Group the terms by counter ID. 85344779Sdim llvm::sort(Terms, [](const Term &LHS, const Term &RHS) { 86321369Sdim return LHS.CounterID < RHS.CounterID; 87303231Sdim }); 88303231Sdim 89303231Sdim // Combine terms by counter ID to eliminate counters that sum to zero. 90303231Sdim auto Prev = Terms.begin(); 91303231Sdim for (auto I = Prev + 1, E = Terms.end(); I != E; ++I) { 92321369Sdim if (I->CounterID == Prev->CounterID) { 93321369Sdim Prev->Factor += I->Factor; 94303231Sdim continue; 95303231Sdim } 96303231Sdim ++Prev; 97303231Sdim *Prev = *I; 98303231Sdim } 99303231Sdim Terms.erase(++Prev, Terms.end()); 100303231Sdim 101303231Sdim Counter C; 102303231Sdim // Create additions. We do this before subtractions to avoid constructs like 103303231Sdim // ((0 - X) + Y), as opposed to (Y - X). 104321369Sdim for (auto T : Terms) { 105321369Sdim if (T.Factor <= 0) 106303231Sdim continue; 107321369Sdim for (int I = 0; I < T.Factor; ++I) 108303231Sdim if (C.isZero()) 109321369Sdim C = Counter::getCounter(T.CounterID); 110303231Sdim else 111303231Sdim C = get(CounterExpression(CounterExpression::Add, C, 112321369Sdim Counter::getCounter(T.CounterID))); 113303231Sdim } 114303231Sdim 115303231Sdim // Create subtractions. 116321369Sdim for (auto T : Terms) { 117321369Sdim if (T.Factor >= 0) 118303231Sdim continue; 119321369Sdim for (int I = 0; I < -T.Factor; ++I) 120303231Sdim C = get(CounterExpression(CounterExpression::Subtract, C, 121321369Sdim Counter::getCounter(T.CounterID))); 122303231Sdim } 123303231Sdim return C; 124303231Sdim} 125303231Sdim 126303231SdimCounter CounterExpressionBuilder::add(Counter LHS, Counter RHS) { 127303231Sdim return simplify(get(CounterExpression(CounterExpression::Add, LHS, RHS))); 128303231Sdim} 129303231Sdim 130303231SdimCounter CounterExpressionBuilder::subtract(Counter LHS, Counter RHS) { 131303231Sdim return simplify( 132303231Sdim get(CounterExpression(CounterExpression::Subtract, LHS, RHS))); 133303231Sdim} 134303231Sdim 135321369Sdimvoid CounterMappingContext::dump(const Counter &C, raw_ostream &OS) const { 136303231Sdim switch (C.getKind()) { 137303231Sdim case Counter::Zero: 138303231Sdim OS << '0'; 139303231Sdim return; 140303231Sdim case Counter::CounterValueReference: 141303231Sdim OS << '#' << C.getCounterID(); 142303231Sdim break; 143303231Sdim case Counter::Expression: { 144303231Sdim if (C.getExpressionID() >= Expressions.size()) 145303231Sdim return; 146303231Sdim const auto &E = Expressions[C.getExpressionID()]; 147303231Sdim OS << '('; 148303231Sdim dump(E.LHS, OS); 149303231Sdim OS << (E.Kind == CounterExpression::Subtract ? " - " : " + "); 150303231Sdim dump(E.RHS, OS); 151303231Sdim OS << ')'; 152303231Sdim break; 153303231Sdim } 154303231Sdim } 155303231Sdim if (CounterValues.empty()) 156303231Sdim return; 157303231Sdim Expected<int64_t> Value = evaluate(C); 158303231Sdim if (auto E = Value.takeError()) { 159321369Sdim consumeError(std::move(E)); 160303231Sdim return; 161303231Sdim } 162303231Sdim OS << '[' << *Value << ']'; 163303231Sdim} 164303231Sdim 165303231SdimExpected<int64_t> CounterMappingContext::evaluate(const Counter &C) const { 166303231Sdim switch (C.getKind()) { 167303231Sdim case Counter::Zero: 168303231Sdim return 0; 169303231Sdim case Counter::CounterValueReference: 170303231Sdim if (C.getCounterID() >= CounterValues.size()) 171303231Sdim return errorCodeToError(errc::argument_out_of_domain); 172303231Sdim return CounterValues[C.getCounterID()]; 173303231Sdim case Counter::Expression: { 174303231Sdim if (C.getExpressionID() >= Expressions.size()) 175303231Sdim return errorCodeToError(errc::argument_out_of_domain); 176303231Sdim const auto &E = Expressions[C.getExpressionID()]; 177303231Sdim Expected<int64_t> LHS = evaluate(E.LHS); 178303231Sdim if (!LHS) 179303231Sdim return LHS; 180303231Sdim Expected<int64_t> RHS = evaluate(E.RHS); 181303231Sdim if (!RHS) 182303231Sdim return RHS; 183303231Sdim return E.Kind == CounterExpression::Subtract ? *LHS - *RHS : *LHS + *RHS; 184303231Sdim } 185303231Sdim } 186303231Sdim llvm_unreachable("Unhandled CounterKind"); 187303231Sdim} 188303231Sdim 189303231Sdimvoid FunctionRecordIterator::skipOtherFiles() { 190303231Sdim while (Current != Records.end() && !Filename.empty() && 191303231Sdim Filename != Current->Filenames[0]) 192303231Sdim ++Current; 193303231Sdim if (Current == Records.end()) 194303231Sdim *this = FunctionRecordIterator(); 195303231Sdim} 196303231Sdim 197314564SdimError CoverageMapping::loadFunctionRecord( 198314564Sdim const CoverageMappingRecord &Record, 199314564Sdim IndexedInstrProfReader &ProfileReader) { 200314564Sdim StringRef OrigFuncName = Record.FunctionName; 201321369Sdim if (OrigFuncName.empty()) 202321369Sdim return make_error<CoverageMapError>(coveragemap_error::malformed); 203321369Sdim 204314564Sdim if (Record.Filenames.empty()) 205314564Sdim OrigFuncName = getFuncNameWithoutPrefix(OrigFuncName); 206314564Sdim else 207314564Sdim OrigFuncName = getFuncNameWithoutPrefix(OrigFuncName, Record.Filenames[0]); 208314564Sdim 209314564Sdim CounterMappingContext Ctx(Record.Expressions); 210314564Sdim 211314564Sdim std::vector<uint64_t> Counts; 212314564Sdim if (Error E = ProfileReader.getFunctionCounts(Record.FunctionName, 213314564Sdim Record.FunctionHash, Counts)) { 214314564Sdim instrprof_error IPE = InstrProfError::take(std::move(E)); 215314564Sdim if (IPE == instrprof_error::hash_mismatch) { 216327952Sdim FuncHashMismatches.emplace_back(Record.FunctionName, Record.FunctionHash); 217314564Sdim return Error::success(); 218314564Sdim } else if (IPE != instrprof_error::unknown_function) 219314564Sdim return make_error<InstrProfError>(IPE); 220314564Sdim Counts.assign(Record.MappingRegions.size(), 0); 221314564Sdim } 222314564Sdim Ctx.setCounts(Counts); 223314564Sdim 224314564Sdim assert(!Record.MappingRegions.empty() && "Function has no regions"); 225314564Sdim 226344779Sdim // This coverage record is a zero region for a function that's unused in 227344779Sdim // some TU, but used in a different TU. Ignore it. The coverage maps from the 228344779Sdim // the other TU will either be loaded (providing full region counts) or they 229344779Sdim // won't (in which case we don't unintuitively report functions as uncovered 230344779Sdim // when they have non-zero counts in the profile). 231344779Sdim if (Record.MappingRegions.size() == 1 && 232344779Sdim Record.MappingRegions[0].Count.isZero() && Counts[0] > 0) 233344779Sdim return Error::success(); 234344779Sdim 235314564Sdim FunctionRecord Function(OrigFuncName, Record.Filenames); 236314564Sdim for (const auto &Region : Record.MappingRegions) { 237314564Sdim Expected<int64_t> ExecutionCount = Ctx.evaluate(Region.Count); 238314564Sdim if (auto E = ExecutionCount.takeError()) { 239321369Sdim consumeError(std::move(E)); 240314564Sdim return Error::success(); 241314564Sdim } 242314564Sdim Function.pushRegion(Region, *ExecutionCount); 243314564Sdim } 244344779Sdim 245344779Sdim // Don't create records for (filenames, function) pairs we've already seen. 246344779Sdim auto FilenamesHash = hash_combine_range(Record.Filenames.begin(), 247344779Sdim Record.Filenames.end()); 248344779Sdim if (!RecordProvenance[FilenamesHash].insert(hash_value(OrigFuncName)).second) 249314564Sdim return Error::success(); 250314564Sdim 251314564Sdim Functions.push_back(std::move(Function)); 252314564Sdim return Error::success(); 253314564Sdim} 254314564Sdim 255314564SdimExpected<std::unique_ptr<CoverageMapping>> CoverageMapping::load( 256314564Sdim ArrayRef<std::unique_ptr<CoverageMappingReader>> CoverageReaders, 257314564Sdim IndexedInstrProfReader &ProfileReader) { 258314564Sdim auto Coverage = std::unique_ptr<CoverageMapping>(new CoverageMapping()); 259303231Sdim 260327952Sdim for (const auto &CoverageReader : CoverageReaders) { 261327952Sdim for (auto RecordOrErr : *CoverageReader) { 262327952Sdim if (Error E = RecordOrErr.takeError()) 263327952Sdim return std::move(E); 264327952Sdim const auto &Record = *RecordOrErr; 265314564Sdim if (Error E = Coverage->loadFunctionRecord(Record, ProfileReader)) 266314564Sdim return std::move(E); 267327952Sdim } 268327952Sdim } 269303231Sdim 270303231Sdim return std::move(Coverage); 271303231Sdim} 272303231Sdim 273303231SdimExpected<std::unique_ptr<CoverageMapping>> 274314564SdimCoverageMapping::load(ArrayRef<StringRef> ObjectFilenames, 275327952Sdim StringRef ProfileFilename, ArrayRef<StringRef> Arches) { 276303231Sdim auto ProfileReaderOrErr = IndexedInstrProfReader::create(ProfileFilename); 277303231Sdim if (Error E = ProfileReaderOrErr.takeError()) 278303231Sdim return std::move(E); 279303231Sdim auto ProfileReader = std::move(ProfileReaderOrErr.get()); 280314564Sdim 281314564Sdim SmallVector<std::unique_ptr<CoverageMappingReader>, 4> Readers; 282314564Sdim SmallVector<std::unique_ptr<MemoryBuffer>, 4> Buffers; 283327952Sdim for (const auto &File : llvm::enumerate(ObjectFilenames)) { 284327952Sdim auto CovMappingBufOrErr = MemoryBuffer::getFileOrSTDIN(File.value()); 285314564Sdim if (std::error_code EC = CovMappingBufOrErr.getError()) 286314564Sdim return errorCodeToError(EC); 287327952Sdim StringRef Arch = Arches.empty() ? StringRef() : Arches[File.index()]; 288353358Sdim MemoryBufferRef CovMappingBufRef = 289353358Sdim CovMappingBufOrErr.get()->getMemBufferRef(); 290353358Sdim auto CoverageReadersOrErr = 291353358Sdim BinaryCoverageReader::create(CovMappingBufRef, Arch, Buffers); 292353358Sdim if (Error E = CoverageReadersOrErr.takeError()) 293314564Sdim return std::move(E); 294353358Sdim for (auto &Reader : CoverageReadersOrErr.get()) 295353358Sdim Readers.push_back(std::move(Reader)); 296314564Sdim Buffers.push_back(std::move(CovMappingBufOrErr.get())); 297314564Sdim } 298314564Sdim return load(Readers, *ProfileReader); 299303231Sdim} 300303231Sdim 301303231Sdimnamespace { 302321369Sdim 303341825Sdim/// Distributes functions into instantiation sets. 304303231Sdim/// 305303231Sdim/// An instantiation set is a collection of functions that have the same source 306303231Sdim/// code, ie, template functions specializations. 307303231Sdimclass FunctionInstantiationSetCollector { 308327952Sdim using MapT = std::map<LineColPair, std::vector<const FunctionRecord *>>; 309303231Sdim MapT InstantiatedFunctions; 310303231Sdim 311303231Sdimpublic: 312303231Sdim void insert(const FunctionRecord &Function, unsigned FileID) { 313303231Sdim auto I = Function.CountedRegions.begin(), E = Function.CountedRegions.end(); 314303231Sdim while (I != E && I->FileID != FileID) 315303231Sdim ++I; 316303231Sdim assert(I != E && "function does not cover the given file"); 317303231Sdim auto &Functions = InstantiatedFunctions[I->startLoc()]; 318303231Sdim Functions.push_back(&Function); 319303231Sdim } 320303231Sdim 321303231Sdim MapT::iterator begin() { return InstantiatedFunctions.begin(); } 322303231Sdim MapT::iterator end() { return InstantiatedFunctions.end(); } 323303231Sdim}; 324303231Sdim 325303231Sdimclass SegmentBuilder { 326303231Sdim std::vector<CoverageSegment> &Segments; 327303231Sdim SmallVector<const CountedRegion *, 8> ActiveRegions; 328303231Sdim 329303231Sdim SegmentBuilder(std::vector<CoverageSegment> &Segments) : Segments(Segments) {} 330303231Sdim 331327952Sdim /// Emit a segment with the count from \p Region starting at \p StartLoc. 332327952Sdim // 333327952Sdim /// \p IsRegionEntry: The segment is at the start of a new non-gap region. 334327952Sdim /// \p EmitSkippedRegion: The segment must be emitted as a skipped region. 335327952Sdim void startSegment(const CountedRegion &Region, LineColPair StartLoc, 336327952Sdim bool IsRegionEntry, bool EmitSkippedRegion = false) { 337327952Sdim bool HasCount = !EmitSkippedRegion && 338327952Sdim (Region.Kind != CounterMappingRegion::SkippedRegion); 339303231Sdim 340327952Sdim // If the new segment wouldn't affect coverage rendering, skip it. 341327952Sdim if (!Segments.empty() && !IsRegionEntry && !EmitSkippedRegion) { 342327952Sdim const auto &Last = Segments.back(); 343327952Sdim if (Last.HasCount == HasCount && Last.Count == Region.ExecutionCount && 344327952Sdim !Last.IsRegionEntry) 345327952Sdim return; 346327952Sdim } 347303231Sdim 348327952Sdim if (HasCount) 349327952Sdim Segments.emplace_back(StartLoc.first, StartLoc.second, 350327952Sdim Region.ExecutionCount, IsRegionEntry, 351327952Sdim Region.Kind == CounterMappingRegion::GapRegion); 352327952Sdim else 353327952Sdim Segments.emplace_back(StartLoc.first, StartLoc.second, IsRegionEntry); 354327952Sdim 355341825Sdim LLVM_DEBUG({ 356327952Sdim const auto &Last = Segments.back(); 357327952Sdim dbgs() << "Segment at " << Last.Line << ":" << Last.Col 358327952Sdim << " (count = " << Last.Count << ")" 359327952Sdim << (Last.IsRegionEntry ? ", RegionEntry" : "") 360327952Sdim << (!Last.HasCount ? ", Skipped" : "") 361327952Sdim << (Last.IsGapRegion ? ", Gap" : "") << "\n"; 362327952Sdim }); 363303231Sdim } 364303231Sdim 365327952Sdim /// Emit segments for active regions which end before \p Loc. 366327952Sdim /// 367327952Sdim /// \p Loc: The start location of the next region. If None, all active 368327952Sdim /// regions are completed. 369327952Sdim /// \p FirstCompletedRegion: Index of the first completed region. 370327952Sdim void completeRegionsUntil(Optional<LineColPair> Loc, 371327952Sdim unsigned FirstCompletedRegion) { 372327952Sdim // Sort the completed regions by end location. This makes it simple to 373327952Sdim // emit closing segments in sorted order. 374327952Sdim auto CompletedRegionsIt = ActiveRegions.begin() + FirstCompletedRegion; 375327952Sdim std::stable_sort(CompletedRegionsIt, ActiveRegions.end(), 376327952Sdim [](const CountedRegion *L, const CountedRegion *R) { 377327952Sdim return L->endLoc() < R->endLoc(); 378327952Sdim }); 379327952Sdim 380327952Sdim // Emit segments for all completed regions. 381327952Sdim for (unsigned I = FirstCompletedRegion + 1, E = ActiveRegions.size(); I < E; 382327952Sdim ++I) { 383327952Sdim const auto *CompletedRegion = ActiveRegions[I]; 384327952Sdim assert((!Loc || CompletedRegion->endLoc() <= *Loc) && 385327952Sdim "Completed region ends after start of new region"); 386327952Sdim 387327952Sdim const auto *PrevCompletedRegion = ActiveRegions[I - 1]; 388327952Sdim auto CompletedSegmentLoc = PrevCompletedRegion->endLoc(); 389327952Sdim 390327952Sdim // Don't emit any more segments if they start where the new region begins. 391327952Sdim if (Loc && CompletedSegmentLoc == *Loc) 392327952Sdim break; 393327952Sdim 394327952Sdim // Don't emit a segment if the next completed region ends at the same 395327952Sdim // location as this one. 396327952Sdim if (CompletedSegmentLoc == CompletedRegion->endLoc()) 397327952Sdim continue; 398327952Sdim 399327952Sdim // Use the count from the last completed region which ends at this loc. 400327952Sdim for (unsigned J = I + 1; J < E; ++J) 401327952Sdim if (CompletedRegion->endLoc() == ActiveRegions[J]->endLoc()) 402327952Sdim CompletedRegion = ActiveRegions[J]; 403327952Sdim 404327952Sdim startSegment(*CompletedRegion, CompletedSegmentLoc, false); 405327952Sdim } 406327952Sdim 407327952Sdim auto Last = ActiveRegions.back(); 408327952Sdim if (FirstCompletedRegion && Last->endLoc() != *Loc) { 409327952Sdim // If there's a gap after the end of the last completed region and the 410327952Sdim // start of the new region, use the last active region to fill the gap. 411327952Sdim startSegment(*ActiveRegions[FirstCompletedRegion - 1], Last->endLoc(), 412327952Sdim false); 413327952Sdim } else if (!FirstCompletedRegion && (!Loc || *Loc != Last->endLoc())) { 414327952Sdim // Emit a skipped segment if there are no more active regions. This 415327952Sdim // ensures that gaps between functions are marked correctly. 416327952Sdim startSegment(*Last, Last->endLoc(), false, true); 417327952Sdim } 418327952Sdim 419327952Sdim // Pop the completed regions. 420327952Sdim ActiveRegions.erase(CompletedRegionsIt, ActiveRegions.end()); 421303231Sdim } 422303231Sdim 423303231Sdim void buildSegmentsImpl(ArrayRef<CountedRegion> Regions) { 424327952Sdim for (const auto &CR : enumerate(Regions)) { 425327952Sdim auto CurStartLoc = CR.value().startLoc(); 426327952Sdim 427327952Sdim // Active regions which end before the current region need to be popped. 428327952Sdim auto CompletedRegions = 429327952Sdim std::stable_partition(ActiveRegions.begin(), ActiveRegions.end(), 430327952Sdim [&](const CountedRegion *Region) { 431327952Sdim return !(Region->endLoc() <= CurStartLoc); 432327952Sdim }); 433327952Sdim if (CompletedRegions != ActiveRegions.end()) { 434327952Sdim unsigned FirstCompletedRegion = 435327952Sdim std::distance(ActiveRegions.begin(), CompletedRegions); 436327952Sdim completeRegionsUntil(CurStartLoc, FirstCompletedRegion); 437327952Sdim } 438327952Sdim 439327952Sdim bool GapRegion = CR.value().Kind == CounterMappingRegion::GapRegion; 440327952Sdim 441327952Sdim // Try to emit a segment for the current region. 442327952Sdim if (CurStartLoc == CR.value().endLoc()) { 443327952Sdim // Avoid making zero-length regions active. If it's the last region, 444327952Sdim // emit a skipped segment. Otherwise use its predecessor's count. 445327952Sdim const bool Skipped = (CR.index() + 1) == Regions.size(); 446327952Sdim startSegment(ActiveRegions.empty() ? CR.value() : *ActiveRegions.back(), 447327952Sdim CurStartLoc, !GapRegion, Skipped); 448327952Sdim continue; 449327952Sdim } 450327952Sdim if (CR.index() + 1 == Regions.size() || 451327952Sdim CurStartLoc != Regions[CR.index() + 1].startLoc()) { 452327952Sdim // Emit a segment if the next region doesn't start at the same location 453327952Sdim // as this one. 454327952Sdim startSegment(CR.value(), CurStartLoc, !GapRegion); 455327952Sdim } 456327952Sdim 457327952Sdim // This region is active (i.e not completed). 458327952Sdim ActiveRegions.push_back(&CR.value()); 459303231Sdim } 460327952Sdim 461327952Sdim // Complete any remaining active regions. 462327952Sdim if (!ActiveRegions.empty()) 463327952Sdim completeRegionsUntil(None, 0); 464303231Sdim } 465303231Sdim 466303231Sdim /// Sort a nested sequence of regions from a single file. 467303231Sdim static void sortNestedRegions(MutableArrayRef<CountedRegion> Regions) { 468344779Sdim llvm::sort(Regions, [](const CountedRegion &LHS, const CountedRegion &RHS) { 469303231Sdim if (LHS.startLoc() != RHS.startLoc()) 470303231Sdim return LHS.startLoc() < RHS.startLoc(); 471303231Sdim if (LHS.endLoc() != RHS.endLoc()) 472303231Sdim // When LHS completely contains RHS, we sort LHS first. 473303231Sdim return RHS.endLoc() < LHS.endLoc(); 474303231Sdim // If LHS and RHS cover the same area, we need to sort them according 475303231Sdim // to their kinds so that the most suitable region will become "active" 476303231Sdim // in combineRegions(). Because we accumulate counter values only from 477303231Sdim // regions of the same kind as the first region of the area, prefer 478303231Sdim // CodeRegion to ExpansionRegion and ExpansionRegion to SkippedRegion. 479321369Sdim static_assert(CounterMappingRegion::CodeRegion < 480321369Sdim CounterMappingRegion::ExpansionRegion && 481321369Sdim CounterMappingRegion::ExpansionRegion < 482321369Sdim CounterMappingRegion::SkippedRegion, 483303231Sdim "Unexpected order of region kind values"); 484303231Sdim return LHS.Kind < RHS.Kind; 485303231Sdim }); 486303231Sdim } 487303231Sdim 488303231Sdim /// Combine counts of regions which cover the same area. 489303231Sdim static ArrayRef<CountedRegion> 490303231Sdim combineRegions(MutableArrayRef<CountedRegion> Regions) { 491303231Sdim if (Regions.empty()) 492303231Sdim return Regions; 493303231Sdim auto Active = Regions.begin(); 494303231Sdim auto End = Regions.end(); 495303231Sdim for (auto I = Regions.begin() + 1; I != End; ++I) { 496303231Sdim if (Active->startLoc() != I->startLoc() || 497303231Sdim Active->endLoc() != I->endLoc()) { 498303231Sdim // Shift to the next region. 499303231Sdim ++Active; 500303231Sdim if (Active != I) 501303231Sdim *Active = *I; 502303231Sdim continue; 503303231Sdim } 504303231Sdim // Merge duplicate region. 505303231Sdim // If CodeRegions and ExpansionRegions cover the same area, it's probably 506303231Sdim // a macro which is fully expanded to another macro. In that case, we need 507303231Sdim // to accumulate counts only from CodeRegions, or else the area will be 508303231Sdim // counted twice. 509303231Sdim // On the other hand, a macro may have a nested macro in its body. If the 510303231Sdim // outer macro is used several times, the ExpansionRegion for the nested 511303231Sdim // macro will also be added several times. These ExpansionRegions cover 512303231Sdim // the same source locations and have to be combined to reach the correct 513303231Sdim // value for that area. 514303231Sdim // We add counts of the regions of the same kind as the active region 515303231Sdim // to handle the both situations. 516303231Sdim if (I->Kind == Active->Kind) 517303231Sdim Active->ExecutionCount += I->ExecutionCount; 518303231Sdim } 519303231Sdim return Regions.drop_back(std::distance(++Active, End)); 520303231Sdim } 521303231Sdim 522303231Sdimpublic: 523327952Sdim /// Build a sorted list of CoverageSegments from a list of Regions. 524303231Sdim static std::vector<CoverageSegment> 525303231Sdim buildSegments(MutableArrayRef<CountedRegion> Regions) { 526303231Sdim std::vector<CoverageSegment> Segments; 527303231Sdim SegmentBuilder Builder(Segments); 528303231Sdim 529303231Sdim sortNestedRegions(Regions); 530303231Sdim ArrayRef<CountedRegion> CombinedRegions = combineRegions(Regions); 531303231Sdim 532341825Sdim LLVM_DEBUG({ 533327952Sdim dbgs() << "Combined regions:\n"; 534327952Sdim for (const auto &CR : CombinedRegions) 535327952Sdim dbgs() << " " << CR.LineStart << ":" << CR.ColumnStart << " -> " 536327952Sdim << CR.LineEnd << ":" << CR.ColumnEnd 537327952Sdim << " (count=" << CR.ExecutionCount << ")\n"; 538327952Sdim }); 539327952Sdim 540303231Sdim Builder.buildSegmentsImpl(CombinedRegions); 541327952Sdim 542327952Sdim#ifndef NDEBUG 543327952Sdim for (unsigned I = 1, E = Segments.size(); I < E; ++I) { 544327952Sdim const auto &L = Segments[I - 1]; 545327952Sdim const auto &R = Segments[I]; 546327952Sdim if (!(L.Line < R.Line) && !(L.Line == R.Line && L.Col < R.Col)) { 547341825Sdim LLVM_DEBUG(dbgs() << " ! Segment " << L.Line << ":" << L.Col 548341825Sdim << " followed by " << R.Line << ":" << R.Col << "\n"); 549327952Sdim assert(false && "Coverage segments not unique or sorted"); 550327952Sdim } 551327952Sdim } 552327952Sdim#endif 553327952Sdim 554303231Sdim return Segments; 555303231Sdim } 556303231Sdim}; 557303231Sdim 558321369Sdim} // end anonymous namespace 559321369Sdim 560303231Sdimstd::vector<StringRef> CoverageMapping::getUniqueSourceFiles() const { 561303231Sdim std::vector<StringRef> Filenames; 562303231Sdim for (const auto &Function : getCoveredFunctions()) 563303231Sdim Filenames.insert(Filenames.end(), Function.Filenames.begin(), 564303231Sdim Function.Filenames.end()); 565344779Sdim llvm::sort(Filenames); 566303231Sdim auto Last = std::unique(Filenames.begin(), Filenames.end()); 567303231Sdim Filenames.erase(Last, Filenames.end()); 568303231Sdim return Filenames; 569303231Sdim} 570303231Sdim 571303231Sdimstatic SmallBitVector gatherFileIDs(StringRef SourceFile, 572303231Sdim const FunctionRecord &Function) { 573303231Sdim SmallBitVector FilenameEquivalence(Function.Filenames.size(), false); 574303231Sdim for (unsigned I = 0, E = Function.Filenames.size(); I < E; ++I) 575303231Sdim if (SourceFile == Function.Filenames[I]) 576303231Sdim FilenameEquivalence[I] = true; 577303231Sdim return FilenameEquivalence; 578303231Sdim} 579303231Sdim 580303231Sdim/// Return the ID of the file where the definition of the function is located. 581303231Sdimstatic Optional<unsigned> findMainViewFileID(const FunctionRecord &Function) { 582303231Sdim SmallBitVector IsNotExpandedFile(Function.Filenames.size(), true); 583303231Sdim for (const auto &CR : Function.CountedRegions) 584303231Sdim if (CR.Kind == CounterMappingRegion::ExpansionRegion) 585303231Sdim IsNotExpandedFile[CR.ExpandedFileID] = false; 586303231Sdim int I = IsNotExpandedFile.find_first(); 587303231Sdim if (I == -1) 588303231Sdim return None; 589303231Sdim return I; 590303231Sdim} 591303231Sdim 592303231Sdim/// Check if SourceFile is the file that contains the definition of 593303231Sdim/// the Function. Return the ID of the file in that case or None otherwise. 594303231Sdimstatic Optional<unsigned> findMainViewFileID(StringRef SourceFile, 595303231Sdim const FunctionRecord &Function) { 596303231Sdim Optional<unsigned> I = findMainViewFileID(Function); 597303231Sdim if (I && SourceFile == Function.Filenames[*I]) 598303231Sdim return I; 599303231Sdim return None; 600303231Sdim} 601303231Sdim 602303231Sdimstatic bool isExpansion(const CountedRegion &R, unsigned FileID) { 603303231Sdim return R.Kind == CounterMappingRegion::ExpansionRegion && R.FileID == FileID; 604303231Sdim} 605303231Sdim 606303231SdimCoverageData CoverageMapping::getCoverageForFile(StringRef Filename) const { 607303231Sdim CoverageData FileCoverage(Filename); 608321369Sdim std::vector<CountedRegion> Regions; 609303231Sdim 610303231Sdim for (const auto &Function : Functions) { 611303231Sdim auto MainFileID = findMainViewFileID(Filename, Function); 612303231Sdim auto FileIDs = gatherFileIDs(Filename, Function); 613303231Sdim for (const auto &CR : Function.CountedRegions) 614303231Sdim if (FileIDs.test(CR.FileID)) { 615303231Sdim Regions.push_back(CR); 616303231Sdim if (MainFileID && isExpansion(CR, *MainFileID)) 617303231Sdim FileCoverage.Expansions.emplace_back(CR, Function); 618303231Sdim } 619303231Sdim } 620303231Sdim 621341825Sdim LLVM_DEBUG(dbgs() << "Emitting segments for file: " << Filename << "\n"); 622303231Sdim FileCoverage.Segments = SegmentBuilder::buildSegments(Regions); 623303231Sdim 624303231Sdim return FileCoverage; 625303231Sdim} 626303231Sdim 627327952Sdimstd::vector<InstantiationGroup> 628327952SdimCoverageMapping::getInstantiationGroups(StringRef Filename) const { 629303231Sdim FunctionInstantiationSetCollector InstantiationSetCollector; 630303231Sdim for (const auto &Function : Functions) { 631303231Sdim auto MainFileID = findMainViewFileID(Filename, Function); 632303231Sdim if (!MainFileID) 633303231Sdim continue; 634303231Sdim InstantiationSetCollector.insert(Function, *MainFileID); 635303231Sdim } 636303231Sdim 637327952Sdim std::vector<InstantiationGroup> Result; 638327952Sdim for (auto &InstantiationSet : InstantiationSetCollector) { 639327952Sdim InstantiationGroup IG{InstantiationSet.first.first, 640327952Sdim InstantiationSet.first.second, 641327952Sdim std::move(InstantiationSet.second)}; 642327952Sdim Result.emplace_back(std::move(IG)); 643303231Sdim } 644303231Sdim return Result; 645303231Sdim} 646303231Sdim 647303231SdimCoverageData 648303231SdimCoverageMapping::getCoverageForFunction(const FunctionRecord &Function) const { 649303231Sdim auto MainFileID = findMainViewFileID(Function); 650303231Sdim if (!MainFileID) 651303231Sdim return CoverageData(); 652303231Sdim 653303231Sdim CoverageData FunctionCoverage(Function.Filenames[*MainFileID]); 654321369Sdim std::vector<CountedRegion> Regions; 655303231Sdim for (const auto &CR : Function.CountedRegions) 656303231Sdim if (CR.FileID == *MainFileID) { 657303231Sdim Regions.push_back(CR); 658303231Sdim if (isExpansion(CR, *MainFileID)) 659303231Sdim FunctionCoverage.Expansions.emplace_back(CR, Function); 660303231Sdim } 661303231Sdim 662341825Sdim LLVM_DEBUG(dbgs() << "Emitting segments for function: " << Function.Name 663341825Sdim << "\n"); 664303231Sdim FunctionCoverage.Segments = SegmentBuilder::buildSegments(Regions); 665303231Sdim 666303231Sdim return FunctionCoverage; 667303231Sdim} 668303231Sdim 669303231SdimCoverageData CoverageMapping::getCoverageForExpansion( 670303231Sdim const ExpansionRecord &Expansion) const { 671303231Sdim CoverageData ExpansionCoverage( 672303231Sdim Expansion.Function.Filenames[Expansion.FileID]); 673321369Sdim std::vector<CountedRegion> Regions; 674303231Sdim for (const auto &CR : Expansion.Function.CountedRegions) 675303231Sdim if (CR.FileID == Expansion.FileID) { 676303231Sdim Regions.push_back(CR); 677303231Sdim if (isExpansion(CR, Expansion.FileID)) 678303231Sdim ExpansionCoverage.Expansions.emplace_back(CR, Expansion.Function); 679303231Sdim } 680303231Sdim 681341825Sdim LLVM_DEBUG(dbgs() << "Emitting segments for expansion of file " 682341825Sdim << Expansion.FileID << "\n"); 683303231Sdim ExpansionCoverage.Segments = SegmentBuilder::buildSegments(Regions); 684303231Sdim 685303231Sdim return ExpansionCoverage; 686303231Sdim} 687303231Sdim 688327952SdimLineCoverageStats::LineCoverageStats( 689327952Sdim ArrayRef<const CoverageSegment *> LineSegments, 690327952Sdim const CoverageSegment *WrappedSegment, unsigned Line) 691327952Sdim : ExecutionCount(0), HasMultipleRegions(false), Mapped(false), Line(Line), 692327952Sdim LineSegments(LineSegments), WrappedSegment(WrappedSegment) { 693327952Sdim // Find the minimum number of regions which start in this line. 694327952Sdim unsigned MinRegionCount = 0; 695327952Sdim auto isStartOfRegion = [](const CoverageSegment *S) { 696327952Sdim return !S->IsGapRegion && S->HasCount && S->IsRegionEntry; 697327952Sdim }; 698327952Sdim for (unsigned I = 0; I < LineSegments.size() && MinRegionCount < 2; ++I) 699327952Sdim if (isStartOfRegion(LineSegments[I])) 700327952Sdim ++MinRegionCount; 701327952Sdim 702327952Sdim bool StartOfSkippedRegion = !LineSegments.empty() && 703327952Sdim !LineSegments.front()->HasCount && 704327952Sdim LineSegments.front()->IsRegionEntry; 705327952Sdim 706327952Sdim HasMultipleRegions = MinRegionCount > 1; 707327952Sdim Mapped = 708327952Sdim !StartOfSkippedRegion && 709327952Sdim ((WrappedSegment && WrappedSegment->HasCount) || (MinRegionCount > 0)); 710327952Sdim 711327952Sdim if (!Mapped) 712327952Sdim return; 713327952Sdim 714327952Sdim // Pick the max count from the non-gap, region entry segments and the 715327952Sdim // wrapped count. 716327952Sdim if (WrappedSegment) 717327952Sdim ExecutionCount = WrappedSegment->Count; 718327952Sdim if (!MinRegionCount) 719327952Sdim return; 720327952Sdim for (const auto *LS : LineSegments) 721327952Sdim if (isStartOfRegion(LS)) 722327952Sdim ExecutionCount = std::max(ExecutionCount, LS->Count); 723327952Sdim} 724327952Sdim 725327952SdimLineCoverageIterator &LineCoverageIterator::operator++() { 726327952Sdim if (Next == CD.end()) { 727327952Sdim Stats = LineCoverageStats(); 728327952Sdim Ended = true; 729327952Sdim return *this; 730327952Sdim } 731327952Sdim if (Segments.size()) 732327952Sdim WrappedSegment = Segments.back(); 733327952Sdim Segments.clear(); 734327952Sdim while (Next != CD.end() && Next->Line == Line) 735327952Sdim Segments.push_back(&*Next++); 736327952Sdim Stats = LineCoverageStats(Segments, WrappedSegment, Line); 737327952Sdim ++Line; 738327952Sdim return *this; 739327952Sdim} 740327952Sdim 741321369Sdimstatic std::string getCoverageMapErrString(coveragemap_error Err) { 742303231Sdim switch (Err) { 743303231Sdim case coveragemap_error::success: 744303231Sdim return "Success"; 745303231Sdim case coveragemap_error::eof: 746303231Sdim return "End of File"; 747303231Sdim case coveragemap_error::no_data_found: 748303231Sdim return "No coverage data found"; 749303231Sdim case coveragemap_error::unsupported_version: 750303231Sdim return "Unsupported coverage format version"; 751303231Sdim case coveragemap_error::truncated: 752303231Sdim return "Truncated coverage data"; 753303231Sdim case coveragemap_error::malformed: 754303231Sdim return "Malformed coverage data"; 755303231Sdim } 756303231Sdim llvm_unreachable("A value of coveragemap_error has no message."); 757303231Sdim} 758303231Sdim 759321369Sdimnamespace { 760321369Sdim 761303231Sdim// FIXME: This class is only here to support the transition to llvm::Error. It 762303231Sdim// will be removed once this transition is complete. Clients should prefer to 763303231Sdim// deal with the Error value directly, rather than converting to error_code. 764303231Sdimclass CoverageMappingErrorCategoryType : public std::error_category { 765314564Sdim const char *name() const noexcept override { return "llvm.coveragemap"; } 766303231Sdim std::string message(int IE) const override { 767303231Sdim return getCoverageMapErrString(static_cast<coveragemap_error>(IE)); 768303231Sdim } 769303231Sdim}; 770321369Sdim 771303231Sdim} // end anonymous namespace 772303231Sdim 773303231Sdimstd::string CoverageMapError::message() const { 774303231Sdim return getCoverageMapErrString(Err); 775303231Sdim} 776303231Sdim 777303231Sdimstatic ManagedStatic<CoverageMappingErrorCategoryType> ErrorCategory; 778303231Sdim 779303231Sdimconst std::error_category &llvm::coverage::coveragemap_category() { 780303231Sdim return *ErrorCategory; 781303231Sdim} 782303231Sdim 783303231Sdimchar CoverageMapError::ID = 0; 784