LLVM  9.0.0svn
CoverageMapping.cpp
Go to the documentation of this file.
1 //===- CoverageMapping.cpp - Code coverage mapping support ----------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file contains support for clang's and llvm's instrumentation based
10 // code coverage.
11 //
12 //===----------------------------------------------------------------------===//
13 
15 #include "llvm/ADT/ArrayRef.h"
16 #include "llvm/ADT/DenseMap.h"
17 #include "llvm/ADT/None.h"
18 #include "llvm/ADT/Optional.h"
20 #include "llvm/ADT/SmallVector.h"
21 #include "llvm/ADT/StringRef.h"
24 #include "llvm/Support/Debug.h"
25 #include "llvm/Support/Errc.h"
26 #include "llvm/Support/Error.h"
31 #include <algorithm>
32 #include <cassert>
33 #include <cstdint>
34 #include <iterator>
35 #include <map>
36 #include <memory>
37 #include <string>
38 #include <system_error>
39 #include <utility>
40 #include <vector>
41 
42 using namespace llvm;
43 using namespace coverage;
44 
45 #define DEBUG_TYPE "coverage-mapping"
46 
47 Counter CounterExpressionBuilder::get(const CounterExpression &E) {
48  auto It = ExpressionIndices.find(E);
49  if (It != ExpressionIndices.end())
50  return Counter::getExpression(It->second);
51  unsigned I = Expressions.size();
52  Expressions.push_back(E);
53  ExpressionIndices[E] = I;
54  return Counter::getExpression(I);
55 }
56 
57 void CounterExpressionBuilder::extractTerms(Counter C, int Factor,
58  SmallVectorImpl<Term> &Terms) {
59  switch (C.getKind()) {
60  case Counter::Zero:
61  break;
63  Terms.emplace_back(C.getCounterID(), Factor);
64  break;
66  const auto &E = Expressions[C.getExpressionID()];
67  extractTerms(E.LHS, Factor, Terms);
68  extractTerms(
69  E.RHS, E.Kind == CounterExpression::Subtract ? -Factor : Factor, Terms);
70  break;
71  }
72 }
73 
74 Counter CounterExpressionBuilder::simplify(Counter ExpressionTree) {
75  // Gather constant terms.
77  extractTerms(ExpressionTree, +1, Terms);
78 
79  // If there are no terms, this is just a zero. The algorithm below assumes at
80  // least one term.
81  if (Terms.size() == 0)
82  return Counter::getZero();
83 
84  // Group the terms by counter ID.
85  llvm::sort(Terms, [](const Term &LHS, const Term &RHS) {
86  return LHS.CounterID < RHS.CounterID;
87  });
88 
89  // Combine terms by counter ID to eliminate counters that sum to zero.
90  auto Prev = Terms.begin();
91  for (auto I = Prev + 1, E = Terms.end(); I != E; ++I) {
92  if (I->CounterID == Prev->CounterID) {
93  Prev->Factor += I->Factor;
94  continue;
95  }
96  ++Prev;
97  *Prev = *I;
98  }
99  Terms.erase(++Prev, Terms.end());
100 
101  Counter C;
102  // Create additions. We do this before subtractions to avoid constructs like
103  // ((0 - X) + Y), as opposed to (Y - X).
104  for (auto T : Terms) {
105  if (T.Factor <= 0)
106  continue;
107  for (int I = 0; I < T.Factor; ++I)
108  if (C.isZero())
109  C = Counter::getCounter(T.CounterID);
110  else
112  Counter::getCounter(T.CounterID)));
113  }
114 
115  // Create subtractions.
116  for (auto T : Terms) {
117  if (T.Factor >= 0)
118  continue;
119  for (int I = 0; I < -T.Factor; ++I)
121  Counter::getCounter(T.CounterID)));
122  }
123  return C;
124 }
125 
127  return simplify(get(CounterExpression(CounterExpression::Add, LHS, RHS)));
128 }
129 
131  return simplify(
133 }
134 
136  switch (C.getKind()) {
137  case Counter::Zero:
138  OS << '0';
139  return;
141  OS << '#' << C.getCounterID();
142  break;
143  case Counter::Expression: {
144  if (C.getExpressionID() >= Expressions.size())
145  return;
146  const auto &E = Expressions[C.getExpressionID()];
147  OS << '(';
148  dump(E.LHS, OS);
149  OS << (E.Kind == CounterExpression::Subtract ? " - " : " + ");
150  dump(E.RHS, OS);
151  OS << ')';
152  break;
153  }
154  }
155  if (CounterValues.empty())
156  return;
157  Expected<int64_t> Value = evaluate(C);
158  if (auto E = Value.takeError()) {
159  consumeError(std::move(E));
160  return;
161  }
162  OS << '[' << *Value << ']';
163 }
164 
166  switch (C.getKind()) {
167  case Counter::Zero:
168  return 0;
170  if (C.getCounterID() >= CounterValues.size())
172  return CounterValues[C.getCounterID()];
173  case Counter::Expression: {
174  if (C.getExpressionID() >= Expressions.size())
176  const auto &E = Expressions[C.getExpressionID()];
177  Expected<int64_t> LHS = evaluate(E.LHS);
178  if (!LHS)
179  return LHS;
180  Expected<int64_t> RHS = evaluate(E.RHS);
181  if (!RHS)
182  return RHS;
183  return E.Kind == CounterExpression::Subtract ? *LHS - *RHS : *LHS + *RHS;
184  }
185  }
186  llvm_unreachable("Unhandled CounterKind");
187 }
188 
189 void FunctionRecordIterator::skipOtherFiles() {
190  while (Current != Records.end() && !Filename.empty() &&
191  Filename != Current->Filenames[0])
192  ++Current;
193  if (Current == Records.end())
194  *this = FunctionRecordIterator();
195 }
196 
197 Error CoverageMapping::loadFunctionRecord(
199  IndexedInstrProfReader &ProfileReader) {
200  StringRef OrigFuncName = Record.FunctionName;
201  if (OrigFuncName.empty())
202  return make_error<CoverageMapError>(coveragemap_error::malformed);
203 
204  if (Record.Filenames.empty())
205  OrigFuncName = getFuncNameWithoutPrefix(OrigFuncName);
206  else
207  OrigFuncName = getFuncNameWithoutPrefix(OrigFuncName, Record.Filenames[0]);
208 
210 
211  std::vector<uint64_t> Counts;
212  if (Error E = ProfileReader.getFunctionCounts(Record.FunctionName,
213  Record.FunctionHash, Counts)) {
214  instrprof_error IPE = InstrProfError::take(std::move(E));
215  if (IPE == instrprof_error::hash_mismatch) {
216  FuncHashMismatches.emplace_back(Record.FunctionName, Record.FunctionHash);
217  return Error::success();
218  } else if (IPE != instrprof_error::unknown_function)
219  return make_error<InstrProfError>(IPE);
220  Counts.assign(Record.MappingRegions.size(), 0);
221  }
222  Ctx.setCounts(Counts);
223 
224  assert(!Record.MappingRegions.empty() && "Function has no regions");
225 
226  // This coverage record is a zero region for a function that's unused in
227  // some TU, but used in a different TU. Ignore it. The coverage maps from the
228  // the other TU will either be loaded (providing full region counts) or they
229  // won't (in which case we don't unintuitively report functions as uncovered
230  // when they have non-zero counts in the profile).
231  if (Record.MappingRegions.size() == 1 &&
232  Record.MappingRegions[0].Count.isZero() && Counts[0] > 0)
233  return Error::success();
234 
235  FunctionRecord Function(OrigFuncName, Record.Filenames);
236  for (const auto &Region : Record.MappingRegions) {
237  Expected<int64_t> ExecutionCount = Ctx.evaluate(Region.Count);
238  if (auto E = ExecutionCount.takeError()) {
239  consumeError(std::move(E));
240  return Error::success();
241  }
242  Function.pushRegion(Region, *ExecutionCount);
243  }
244 
245  // Don't create records for (filenames, function) pairs we've already seen.
246  auto FilenamesHash = hash_combine_range(Record.Filenames.begin(),
247  Record.Filenames.end());
248  if (!RecordProvenance[FilenamesHash].insert(hash_value(OrigFuncName)).second)
249  return Error::success();
250 
251  Functions.push_back(std::move(Function));
252  return Error::success();
253 }
254 
256  ArrayRef<std::unique_ptr<CoverageMappingReader>> CoverageReaders,
257  IndexedInstrProfReader &ProfileReader) {
258  auto Coverage = std::unique_ptr<CoverageMapping>(new CoverageMapping());
259 
260  for (const auto &CoverageReader : CoverageReaders) {
261  for (auto RecordOrErr : *CoverageReader) {
262  if (Error E = RecordOrErr.takeError())
263  return std::move(E);
264  const auto &Record = *RecordOrErr;
265  if (Error E = Coverage->loadFunctionRecord(Record, ProfileReader))
266  return std::move(E);
267  }
268  }
269 
270  return std::move(Coverage);
271 }
272 
275  StringRef ProfileFilename, ArrayRef<StringRef> Arches) {
276  auto ProfileReaderOrErr = IndexedInstrProfReader::create(ProfileFilename);
277  if (Error E = ProfileReaderOrErr.takeError())
278  return std::move(E);
279  auto ProfileReader = std::move(ProfileReaderOrErr.get());
280 
283  for (const auto &File : llvm::enumerate(ObjectFilenames)) {
284  auto CovMappingBufOrErr = MemoryBuffer::getFileOrSTDIN(File.value());
285  if (std::error_code EC = CovMappingBufOrErr.getError())
286  return errorCodeToError(EC);
287  StringRef Arch = Arches.empty() ? StringRef() : Arches[File.index()];
288  auto CoverageReaderOrErr =
289  BinaryCoverageReader::create(CovMappingBufOrErr.get(), Arch);
290  if (Error E = CoverageReaderOrErr.takeError())
291  return std::move(E);
292  Readers.push_back(std::move(CoverageReaderOrErr.get()));
293  Buffers.push_back(std::move(CovMappingBufOrErr.get()));
294  }
295  return load(Readers, *ProfileReader);
296 }
297 
298 namespace {
299 
300 /// Distributes functions into instantiation sets.
301 ///
302 /// An instantiation set is a collection of functions that have the same source
303 /// code, ie, template functions specializations.
304 class FunctionInstantiationSetCollector {
305  using MapT = std::map<LineColPair, std::vector<const FunctionRecord *>>;
306  MapT InstantiatedFunctions;
307 
308 public:
309  void insert(const FunctionRecord &Function, unsigned FileID) {
310  auto I = Function.CountedRegions.begin(), E = Function.CountedRegions.end();
311  while (I != E && I->FileID != FileID)
312  ++I;
313  assert(I != E && "function does not cover the given file");
314  auto &Functions = InstantiatedFunctions[I->startLoc()];
315  Functions.push_back(&Function);
316  }
317 
318  MapT::iterator begin() { return InstantiatedFunctions.begin(); }
319  MapT::iterator end() { return InstantiatedFunctions.end(); }
320 };
321 
322 class SegmentBuilder {
323  std::vector<CoverageSegment> &Segments;
325 
326  SegmentBuilder(std::vector<CoverageSegment> &Segments) : Segments(Segments) {}
327 
328  /// Emit a segment with the count from \p Region starting at \p StartLoc.
329  //
330  /// \p IsRegionEntry: The segment is at the start of a new non-gap region.
331  /// \p EmitSkippedRegion: The segment must be emitted as a skipped region.
332  void startSegment(const CountedRegion &Region, LineColPair StartLoc,
333  bool IsRegionEntry, bool EmitSkippedRegion = false) {
334  bool HasCount = !EmitSkippedRegion &&
336 
337  // If the new segment wouldn't affect coverage rendering, skip it.
338  if (!Segments.empty() && !IsRegionEntry && !EmitSkippedRegion) {
339  const auto &Last = Segments.back();
340  if (Last.HasCount == HasCount && Last.Count == Region.ExecutionCount &&
341  !Last.IsRegionEntry)
342  return;
343  }
344 
345  if (HasCount)
346  Segments.emplace_back(StartLoc.first, StartLoc.second,
347  Region.ExecutionCount, IsRegionEntry,
349  else
350  Segments.emplace_back(StartLoc.first, StartLoc.second, IsRegionEntry);
351 
352  LLVM_DEBUG({
353  const auto &Last = Segments.back();
354  dbgs() << "Segment at " << Last.Line << ":" << Last.Col
355  << " (count = " << Last.Count << ")"
356  << (Last.IsRegionEntry ? ", RegionEntry" : "")
357  << (!Last.HasCount ? ", Skipped" : "")
358  << (Last.IsGapRegion ? ", Gap" : "") << "\n";
359  });
360  }
361 
362  /// Emit segments for active regions which end before \p Loc.
363  ///
364  /// \p Loc: The start location of the next region. If None, all active
365  /// regions are completed.
366  /// \p FirstCompletedRegion: Index of the first completed region.
367  void completeRegionsUntil(Optional<LineColPair> Loc,
368  unsigned FirstCompletedRegion) {
369  // Sort the completed regions by end location. This makes it simple to
370  // emit closing segments in sorted order.
371  auto CompletedRegionsIt = ActiveRegions.begin() + FirstCompletedRegion;
372  std::stable_sort(CompletedRegionsIt, ActiveRegions.end(),
373  [](const CountedRegion *L, const CountedRegion *R) {
374  return L->endLoc() < R->endLoc();
375  });
376 
377  // Emit segments for all completed regions.
378  for (unsigned I = FirstCompletedRegion + 1, E = ActiveRegions.size(); I < E;
379  ++I) {
380  const auto *CompletedRegion = ActiveRegions[I];
381  assert((!Loc || CompletedRegion->endLoc() <= *Loc) &&
382  "Completed region ends after start of new region");
383 
384  const auto *PrevCompletedRegion = ActiveRegions[I - 1];
385  auto CompletedSegmentLoc = PrevCompletedRegion->endLoc();
386 
387  // Don't emit any more segments if they start where the new region begins.
388  if (Loc && CompletedSegmentLoc == *Loc)
389  break;
390 
391  // Don't emit a segment if the next completed region ends at the same
392  // location as this one.
393  if (CompletedSegmentLoc == CompletedRegion->endLoc())
394  continue;
395 
396  // Use the count from the last completed region which ends at this loc.
397  for (unsigned J = I + 1; J < E; ++J)
398  if (CompletedRegion->endLoc() == ActiveRegions[J]->endLoc())
399  CompletedRegion = ActiveRegions[J];
400 
401  startSegment(*CompletedRegion, CompletedSegmentLoc, false);
402  }
403 
404  auto Last = ActiveRegions.back();
405  if (FirstCompletedRegion && Last->endLoc() != *Loc) {
406  // If there's a gap after the end of the last completed region and the
407  // start of the new region, use the last active region to fill the gap.
408  startSegment(*ActiveRegions[FirstCompletedRegion - 1], Last->endLoc(),
409  false);
410  } else if (!FirstCompletedRegion && (!Loc || *Loc != Last->endLoc())) {
411  // Emit a skipped segment if there are no more active regions. This
412  // ensures that gaps between functions are marked correctly.
413  startSegment(*Last, Last->endLoc(), false, true);
414  }
415 
416  // Pop the completed regions.
417  ActiveRegions.erase(CompletedRegionsIt, ActiveRegions.end());
418  }
419 
420  void buildSegmentsImpl(ArrayRef<CountedRegion> Regions) {
421  for (const auto &CR : enumerate(Regions)) {
422  auto CurStartLoc = CR.value().startLoc();
423 
424  // Active regions which end before the current region need to be popped.
425  auto CompletedRegions =
426  std::stable_partition(ActiveRegions.begin(), ActiveRegions.end(),
427  [&](const CountedRegion *Region) {
428  return !(Region->endLoc() <= CurStartLoc);
429  });
430  if (CompletedRegions != ActiveRegions.end()) {
431  unsigned FirstCompletedRegion =
432  std::distance(ActiveRegions.begin(), CompletedRegions);
433  completeRegionsUntil(CurStartLoc, FirstCompletedRegion);
434  }
435 
436  bool GapRegion = CR.value().Kind == CounterMappingRegion::GapRegion;
437 
438  // Try to emit a segment for the current region.
439  if (CurStartLoc == CR.value().endLoc()) {
440  // Avoid making zero-length regions active. If it's the last region,
441  // emit a skipped segment. Otherwise use its predecessor's count.
442  const bool Skipped = (CR.index() + 1) == Regions.size();
443  startSegment(ActiveRegions.empty() ? CR.value() : *ActiveRegions.back(),
444  CurStartLoc, !GapRegion, Skipped);
445  continue;
446  }
447  if (CR.index() + 1 == Regions.size() ||
448  CurStartLoc != Regions[CR.index() + 1].startLoc()) {
449  // Emit a segment if the next region doesn't start at the same location
450  // as this one.
451  startSegment(CR.value(), CurStartLoc, !GapRegion);
452  }
453 
454  // This region is active (i.e not completed).
455  ActiveRegions.push_back(&CR.value());
456  }
457 
458  // Complete any remaining active regions.
459  if (!ActiveRegions.empty())
460  completeRegionsUntil(None, 0);
461  }
462 
463  /// Sort a nested sequence of regions from a single file.
464  static void sortNestedRegions(MutableArrayRef<CountedRegion> Regions) {
465  llvm::sort(Regions, [](const CountedRegion &LHS, const CountedRegion &RHS) {
466  if (LHS.startLoc() != RHS.startLoc())
467  return LHS.startLoc() < RHS.startLoc();
468  if (LHS.endLoc() != RHS.endLoc())
469  // When LHS completely contains RHS, we sort LHS first.
470  return RHS.endLoc() < LHS.endLoc();
471  // If LHS and RHS cover the same area, we need to sort them according
472  // to their kinds so that the most suitable region will become "active"
473  // in combineRegions(). Because we accumulate counter values only from
474  // regions of the same kind as the first region of the area, prefer
475  // CodeRegion to ExpansionRegion and ExpansionRegion to SkippedRegion.
476  static_assert(CounterMappingRegion::CodeRegion <
480  "Unexpected order of region kind values");
481  return LHS.Kind < RHS.Kind;
482  });
483  }
484 
485  /// Combine counts of regions which cover the same area.
487  combineRegions(MutableArrayRef<CountedRegion> Regions) {
488  if (Regions.empty())
489  return Regions;
490  auto Active = Regions.begin();
491  auto End = Regions.end();
492  for (auto I = Regions.begin() + 1; I != End; ++I) {
493  if (Active->startLoc() != I->startLoc() ||
494  Active->endLoc() != I->endLoc()) {
495  // Shift to the next region.
496  ++Active;
497  if (Active != I)
498  *Active = *I;
499  continue;
500  }
501  // Merge duplicate region.
502  // If CodeRegions and ExpansionRegions cover the same area, it's probably
503  // a macro which is fully expanded to another macro. In that case, we need
504  // to accumulate counts only from CodeRegions, or else the area will be
505  // counted twice.
506  // On the other hand, a macro may have a nested macro in its body. If the
507  // outer macro is used several times, the ExpansionRegion for the nested
508  // macro will also be added several times. These ExpansionRegions cover
509  // the same source locations and have to be combined to reach the correct
510  // value for that area.
511  // We add counts of the regions of the same kind as the active region
512  // to handle the both situations.
513  if (I->Kind == Active->Kind)
514  Active->ExecutionCount += I->ExecutionCount;
515  }
516  return Regions.drop_back(std::distance(++Active, End));
517  }
518 
519 public:
520  /// Build a sorted list of CoverageSegments from a list of Regions.
521  static std::vector<CoverageSegment>
522  buildSegments(MutableArrayRef<CountedRegion> Regions) {
523  std::vector<CoverageSegment> Segments;
524  SegmentBuilder Builder(Segments);
525 
526  sortNestedRegions(Regions);
527  ArrayRef<CountedRegion> CombinedRegions = combineRegions(Regions);
528 
529  LLVM_DEBUG({
530  dbgs() << "Combined regions:\n";
531  for (const auto &CR : CombinedRegions)
532  dbgs() << " " << CR.LineStart << ":" << CR.ColumnStart << " -> "
533  << CR.LineEnd << ":" << CR.ColumnEnd
534  << " (count=" << CR.ExecutionCount << ")\n";
535  });
536 
537  Builder.buildSegmentsImpl(CombinedRegions);
538 
539 #ifndef NDEBUG
540  for (unsigned I = 1, E = Segments.size(); I < E; ++I) {
541  const auto &L = Segments[I - 1];
542  const auto &R = Segments[I];
543  if (!(L.Line < R.Line) && !(L.Line == R.Line && L.Col < R.Col)) {
544  LLVM_DEBUG(dbgs() << " ! Segment " << L.Line << ":" << L.Col
545  << " followed by " << R.Line << ":" << R.Col << "\n");
546  assert(false && "Coverage segments not unique or sorted");
547  }
548  }
549 #endif
550 
551  return Segments;
552  }
553 };
554 
555 } // end anonymous namespace
556 
557 std::vector<StringRef> CoverageMapping::getUniqueSourceFiles() const {
558  std::vector<StringRef> Filenames;
559  for (const auto &Function : getCoveredFunctions())
560  Filenames.insert(Filenames.end(), Function.Filenames.begin(),
561  Function.Filenames.end());
562  llvm::sort(Filenames);
563  auto Last = std::unique(Filenames.begin(), Filenames.end());
564  Filenames.erase(Last, Filenames.end());
565  return Filenames;
566 }
567 
569  const FunctionRecord &Function) {
570  SmallBitVector FilenameEquivalence(Function.Filenames.size(), false);
571  for (unsigned I = 0, E = Function.Filenames.size(); I < E; ++I)
572  if (SourceFile == Function.Filenames[I])
573  FilenameEquivalence[I] = true;
574  return FilenameEquivalence;
575 }
576 
577 /// Return the ID of the file where the definition of the function is located.
579  SmallBitVector IsNotExpandedFile(Function.Filenames.size(), true);
580  for (const auto &CR : Function.CountedRegions)
582  IsNotExpandedFile[CR.ExpandedFileID] = false;
583  int I = IsNotExpandedFile.find_first();
584  if (I == -1)
585  return None;
586  return I;
587 }
588 
589 /// Check if SourceFile is the file that contains the definition of
590 /// the Function. Return the ID of the file in that case or None otherwise.
592  const FunctionRecord &Function) {
594  if (I && SourceFile == Function.Filenames[*I])
595  return I;
596  return None;
597 }
598 
599 static bool isExpansion(const CountedRegion &R, unsigned FileID) {
600  return R.Kind == CounterMappingRegion::ExpansionRegion && R.FileID == FileID;
601 }
602 
604  CoverageData FileCoverage(Filename);
605  std::vector<CountedRegion> Regions;
606 
607  for (const auto &Function : Functions) {
608  auto MainFileID = findMainViewFileID(Filename, Function);
609  auto FileIDs = gatherFileIDs(Filename, Function);
610  for (const auto &CR : Function.CountedRegions)
611  if (FileIDs.test(CR.FileID)) {
612  Regions.push_back(CR);
613  if (MainFileID && isExpansion(CR, *MainFileID))
614  FileCoverage.Expansions.emplace_back(CR, Function);
615  }
616  }
617 
618  LLVM_DEBUG(dbgs() << "Emitting segments for file: " << Filename << "\n");
619  FileCoverage.Segments = SegmentBuilder::buildSegments(Regions);
620 
621  return FileCoverage;
622 }
623 
624 std::vector<InstantiationGroup>
626  FunctionInstantiationSetCollector InstantiationSetCollector;
627  for (const auto &Function : Functions) {
628  auto MainFileID = findMainViewFileID(Filename, Function);
629  if (!MainFileID)
630  continue;
631  InstantiationSetCollector.insert(Function, *MainFileID);
632  }
633 
634  std::vector<InstantiationGroup> Result;
635  for (auto &InstantiationSet : InstantiationSetCollector) {
636  InstantiationGroup IG{InstantiationSet.first.first,
637  InstantiationSet.first.second,
638  std::move(InstantiationSet.second)};
639  Result.emplace_back(std::move(IG));
640  }
641  return Result;
642 }
643 
646  auto MainFileID = findMainViewFileID(Function);
647  if (!MainFileID)
648  return CoverageData();
649 
650  CoverageData FunctionCoverage(Function.Filenames[*MainFileID]);
651  std::vector<CountedRegion> Regions;
652  for (const auto &CR : Function.CountedRegions)
653  if (CR.FileID == *MainFileID) {
654  Regions.push_back(CR);
655  if (isExpansion(CR, *MainFileID))
656  FunctionCoverage.Expansions.emplace_back(CR, Function);
657  }
658 
659  LLVM_DEBUG(dbgs() << "Emitting segments for function: " << Function.Name
660  << "\n");
661  FunctionCoverage.Segments = SegmentBuilder::buildSegments(Regions);
662 
663  return FunctionCoverage;
664 }
665 
667  const ExpansionRecord &Expansion) const {
668  CoverageData ExpansionCoverage(
669  Expansion.Function.Filenames[Expansion.FileID]);
670  std::vector<CountedRegion> Regions;
671  for (const auto &CR : Expansion.Function.CountedRegions)
672  if (CR.FileID == Expansion.FileID) {
673  Regions.push_back(CR);
674  if (isExpansion(CR, Expansion.FileID))
675  ExpansionCoverage.Expansions.emplace_back(CR, Expansion.Function);
676  }
677 
678  LLVM_DEBUG(dbgs() << "Emitting segments for expansion of file "
679  << Expansion.FileID << "\n");
680  ExpansionCoverage.Segments = SegmentBuilder::buildSegments(Regions);
681 
682  return ExpansionCoverage;
683 }
684 
685 LineCoverageStats::LineCoverageStats(
687  const CoverageSegment *WrappedSegment, unsigned Line)
688  : ExecutionCount(0), HasMultipleRegions(false), Mapped(false), Line(Line),
689  LineSegments(LineSegments), WrappedSegment(WrappedSegment) {
690  // Find the minimum number of regions which start in this line.
691  unsigned MinRegionCount = 0;
692  auto isStartOfRegion = [](const CoverageSegment *S) {
693  return !S->IsGapRegion && S->HasCount && S->IsRegionEntry;
694  };
695  for (unsigned I = 0; I < LineSegments.size() && MinRegionCount < 2; ++I)
696  if (isStartOfRegion(LineSegments[I]))
697  ++MinRegionCount;
698 
699  bool StartOfSkippedRegion = !LineSegments.empty() &&
700  !LineSegments.front()->HasCount &&
701  LineSegments.front()->IsRegionEntry;
702 
703  HasMultipleRegions = MinRegionCount > 1;
704  Mapped =
705  !StartOfSkippedRegion &&
706  ((WrappedSegment && WrappedSegment->HasCount) || (MinRegionCount > 0));
707 
708  if (!Mapped)
709  return;
710 
711  // Pick the max count from the non-gap, region entry segments and the
712  // wrapped count.
713  if (WrappedSegment)
714  ExecutionCount = WrappedSegment->Count;
715  if (!MinRegionCount)
716  return;
717  for (const auto *LS : LineSegments)
718  if (isStartOfRegion(LS))
719  ExecutionCount = std::max(ExecutionCount, LS->Count);
720 }
721 
723  if (Next == CD.end()) {
725  Ended = true;
726  return *this;
727  }
728  if (Segments.size())
729  WrappedSegment = Segments.back();
730  Segments.clear();
731  while (Next != CD.end() && Next->Line == Line)
732  Segments.push_back(&*Next++);
733  Stats = LineCoverageStats(Segments, WrappedSegment, Line);
734  ++Line;
735  return *this;
736 }
737 
739  switch (Err) {
741  return "Success";
743  return "End of File";
745  return "No coverage data found";
747  return "Unsupported coverage format version";
749  return "Truncated coverage data";
751  return "Malformed coverage data";
752  }
753  llvm_unreachable("A value of coveragemap_error has no message.");
754 }
755 
756 namespace {
757 
758 // FIXME: This class is only here to support the transition to llvm::Error. It
759 // will be removed once this transition is complete. Clients should prefer to
760 // deal with the Error value directly, rather than converting to error_code.
761 class CoverageMappingErrorCategoryType : public std::error_category {
762  const char *name() const noexcept override { return "llvm.coveragemap"; }
763  std::string message(int IE) const override {
764  return getCoverageMapErrString(static_cast<coveragemap_error>(IE));
765  }
766 };
767 
768 } // end anonymous namespace
769 
770 std::string CoverageMapError::message() const {
771  return getCoverageMapErrString(Err);
772 }
773 
775 
777  return *ErrorCategory;
778 }
779 
780 char CoverageMapError::ID = 0;
const T & front() const
front - Get the first element.
Definition: ArrayRef.h:151
const NoneType None
Definition: None.h:23
uint64_t CallInst * C
const_iterator end(StringRef path)
Get end iterator over path.
Definition: Path.cpp:233
reference emplace_back(ArgTypes &&... Args)
Definition: SmallVector.h:645
GCNRegPressure max(const GCNRegPressure &P1, const GCNRegPressure &P2)
const_iterator begin(StringRef path, Style style=Style::native)
Get begin iterator over path.
Definition: Path.cpp:224
This is a &#39;bitvector&#39; (really, a variable-sized bit array), optimized for the case when the array is ...
This class represents lattice values for constants.
Definition: AllocatorList.h:23
static Counter getZero()
Return the counter that represents the number zero.
iterator end()
Definition: Function.h:663
void setCounts(ArrayRef< uint64_t > Counts)
static instrprof_error take(Error E)
Consume an Error and return the raw enum value contained within it.
Definition: InstrProf.h:323
static SmallBitVector gatherFileIDs(StringRef SourceFile, const FunctionRecord &Function)
void pushRegion(CounterMappingRegion Region, uint64_t Count)
A Counter expression is a value that represents an arithmetic operation with two counters.
Error takeError()
Take ownership of the stored error.
Definition: Error.h:552
ArrayRef< CounterMappingRegion > MappingRegions
CoverageData getCoverageForFile(StringRef Filename) const
Get the coverage for a particular file.
Iterator over Functions, optionally filtered to a single file.
A GapRegion is like a CodeRegion, but its count is only set as the line execution count when its the ...
ArrayRef< CounterExpression > Expressions
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
Definition: APFloat.h:41
An iterator over the LineCoverageStats objects for lines described by a CoverageData instance...
friend const_iterator begin(StringRef path, Style style)
Get begin iterator over path.
Definition: Path.cpp:224
Tagged union holding either a T or a Error.
Definition: CachePruning.h:22
block placement Basic Block Placement Stats
LLVM_NODISCARD bool empty() const
empty - Check if the string is empty.
Definition: StringRef.h:126
StringRef getFuncNameWithoutPrefix(StringRef PGOFuncName, StringRef FileName="<unknown>")
Given a PGO function name, remove the filename prefix and return the original (static) function name...
Definition: InstrProf.cpp:276
std::pair< unsigned, unsigned > LineColPair
void dump(const Counter &C, raw_ostream &OS) const
Coverage information to be processed or displayed.
static Expected< std::unique_ptr< CoverageMapping > > load(ArrayRef< std::unique_ptr< CoverageMappingReader >> CoverageReaders, IndexedInstrProfReader &ProfileReader)
Load the coverage mapping using the given readers.
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory)...
Definition: APInt.h:32
hash_code hash_value(const APFloat &Arg)
See friend declarations above.
Definition: APFloat.cpp:4433
Counter add(Counter LHS, Counter RHS)
Return a counter that represents the expression that adds LHS and RHS.
iterator begin()
Definition: Function.h:661
const std::error_category & coveragemap_category()
The execution count information starting at a point in a file.
friend const_iterator end(StringRef path)
Get end iterator over path.
Definition: Path.cpp:233
void dump(const SparseBitVector< ElementSize > &LHS, raw_ostream &out)
MutableArrayRef - Represent a mutable reference to an array (0 or more elements consecutively in memo...
Definition: ArrayRef.h:290
Coverage mapping information for a single function.
Instrumentation for Order File
size_t size() const
size - Get the array size.
Definition: ArrayRef.h:148
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
Error errorCodeToError(std::error_code EC)
Helper for converting an std::error_code to a Error.
Definition: Error.cpp:87
An instantiation group contains a FunctionRecord list, such that each record corresponds to a distinc...
A CodeRegion associates some code with a counter.
A Counter mapping context is used to connect the counters, expressions and the obtained counter value...
bool IsRegionEntry
Whether this enters a new region or returns to a previous count.
static ManagedStatic< _object_error_category > error_category
Definition: Error.cpp:74
static ManagedStatic< CoverageMappingErrorCategoryType > ErrorCategory
Associates a source range with an execution count.
iterator erase(const_iterator CI)
Definition: SmallVector.h:438
void consumeError(Error Err)
Consume a Error without doing anything.
Definition: Error.h:981
size_t size() const
Definition: SmallVector.h:52
MutableArrayRef< T > drop_back(size_t N=1) const
Definition: ArrayRef.h:366
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
Counter subtract(Counter LHS, Counter RHS)
Return a counter that represents the expression that subtracts RHS from LHS.
CoverageData getCoverageForFunction(const FunctionRecord &Function) const
Get the coverage for a particular function.
void sort(IteratorTy Start, IteratorTy End)
Definition: STLExtras.h:1115
Code coverage information for a single function.
static ErrorSuccess success()
Create a success value.
Definition: Error.h:326
static std::string getCoverageMapErrString(coveragemap_error Err)
Coverage statistics for a single line.
This is a &#39;vector&#39; (really, a variable-sized array), optimized for the case when the array is small...
Definition: SmallVector.h:841
static bool isExpansion(const CountedRegion &R, unsigned FileID)
uint64_t Count
The execution count, or zero if no count was recorded.
bool HasCount
When false, the segment was uninstrumented or skipped.
static Expected< std::unique_ptr< BinaryCoverageReader > > create(std::unique_ptr< MemoryBuffer > &ObjectBuffer, StringRef Arch)
An ExpansionRegion represents a file expansion region that associates a source range with the expansi...
A SkippedRegion represents a source range with code that was skipped by a preprocessor or similar mea...
raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition: Debug.cpp:132
hash_code hash_combine_range(InputIteratorT first, InputIteratorT last)
Compute a hash_code for a sequence of values.
Definition: Hashing.h:478
iterator begin() const
Definition: ArrayRef.h:330
The mapping of profile information to coverage data.
static ErrorOr< std::unique_ptr< MemoryBuffer > > getFileOrSTDIN(const Twine &Filename, int64_t FileSize=-1, bool RequiresNullTerminator=true)
Open the specified file as a MemoryBuffer, or open stdin if the Filename is "-".
std::vector< InstantiationGroup > getInstantiationGroups(StringRef Filename) const
Get the list of function instantiation groups in a particular file.
std::string message() const override
Return the error message as a string.
unsigned getExpressionID() const
CounterKind getKind() const
LLVM_NODISCARD bool empty() const
Definition: SmallVector.h:55
instrprof_error
Definition: InstrProf.h:279
#define I(x, y, z)
Definition: MD5.cpp:58
static Optional< unsigned > findMainViewFileID(const FunctionRecord &Function)
Return the ID of the file where the definition of the function is located.
Expected< int64_t > evaluate(const Counter &C) const
Return the number of times that a region of code associated with this counter was executed...
std::vector< CountedRegion > CountedRegions
Regions in the function along with their counts.
std::string Name
Raw function name.
unsigned FileID
The abstract file this expansion covers.
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
bool IsGapRegion
Whether this enters a gap region.
void stable_sort(R &&Range)
Definition: STLExtras.h:1309
unsigned getCounterID() const
LLVM Value Representation.
Definition: Value.h:72
static const char * name
std::vector< std::string > Filenames
Associated files.
Lightweight error class with error context and mandatory checking.
Definition: Error.h:157
iterator end() const
Definition: ArrayRef.h:331
This class implements an extremely fast bulk output stream that can only output to a stream...
Definition: raw_ostream.h:45
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:48
Reader for the indexed binary instrprof format.
ManagedStatic - This transparently changes the behavior of global statics to be lazily constructed on...
Definition: ManagedStatic.h:83
static Counter getExpression(unsigned ExpressionId)
Return the counter that corresponds to a specific addition counter expression.
CoverageData getCoverageForExpansion(const ExpansionRecord &Expansion) const
Get the coverage for an expansion within a coverage set.
#define LLVM_DEBUG(X)
Definition: Debug.h:122
static Expected< std::unique_ptr< IndexedInstrProfReader > > create(const Twine &Path, const Twine &RemappingPath="")
Factory method to create an indexed reader.
A Counter is an abstract value that describes how to compute the execution count for a region of code...
static Counter getCounter(unsigned CounterId)
Return the counter that corresponds to a specific profile counter.
const FunctionRecord & Function
Coverage for the expansion.
bool empty() const
empty - Check if the array is empty.
Definition: ArrayRef.h:143
std::vector< StringRef > getUniqueSourceFiles() const
Returns a lexicographically sorted, unique list of files that are covered.
detail::enumerator< R > enumerate(R &&TheRange)
Given an input range, returns a new range whose values are are pair (A,B) such that A is the 0-based ...
Definition: STLExtras.h:1571
Error getFunctionCounts(StringRef FuncName, uint64_t FuncHash, std::vector< uint64_t > &Counts)
Fill Counts with the profile data for the given function name.
Coverage information for a macro expansion or #included file.