LLVM  7.0.0svn
GCOV.cpp
Go to the documentation of this file.
1 //===- GCOV.cpp - LLVM coverage tool --------------------------------------===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // GCOV implements the interface to read and write coverage files that use
11 // 'gcov' format.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #include "llvm/ProfileData/GCOV.h"
16 #include "llvm/ADT/STLExtras.h"
17 #include "llvm/Config/llvm-config.h"
18 #include "llvm/Support/Debug.h"
20 #include "llvm/Support/Format.h"
21 #include "llvm/Support/Path.h"
23 #include <algorithm>
24 #include <system_error>
25 
26 using namespace llvm;
27 
28 //===----------------------------------------------------------------------===//
29 // GCOVFile implementation.
30 
31 /// readGCNO - Read GCNO buffer.
33  if (!Buffer.readGCNOFormat())
34  return false;
35  if (!Buffer.readGCOVVersion(Version))
36  return false;
37 
38  if (!Buffer.readInt(Checksum))
39  return false;
40  while (true) {
41  if (!Buffer.readFunctionTag())
42  break;
43  auto GFun = make_unique<GCOVFunction>(*this);
44  if (!GFun->readGCNO(Buffer, Version))
45  return false;
46  Functions.push_back(std::move(GFun));
47  }
48 
49  GCNOInitialized = true;
50  return true;
51 }
52 
53 /// readGCDA - Read GCDA buffer. It is required that readGCDA() can only be
54 /// called after readGCNO().
56  assert(GCNOInitialized && "readGCDA() can only be called after readGCNO()");
57  if (!Buffer.readGCDAFormat())
58  return false;
59  GCOV::GCOVVersion GCDAVersion;
60  if (!Buffer.readGCOVVersion(GCDAVersion))
61  return false;
62  if (Version != GCDAVersion) {
63  errs() << "GCOV versions do not match.\n";
64  return false;
65  }
66 
67  uint32_t GCDAChecksum;
68  if (!Buffer.readInt(GCDAChecksum))
69  return false;
70  if (Checksum != GCDAChecksum) {
71  errs() << "File checksums do not match: " << Checksum
72  << " != " << GCDAChecksum << ".\n";
73  return false;
74  }
75  for (size_t i = 0, e = Functions.size(); i < e; ++i) {
76  if (!Buffer.readFunctionTag()) {
77  errs() << "Unexpected number of functions.\n";
78  return false;
79  }
80  if (!Functions[i]->readGCDA(Buffer, Version))
81  return false;
82  }
83  if (Buffer.readObjectTag()) {
84  uint32_t Length;
86  if (!Buffer.readInt(Length))
87  return false;
88  if (!Buffer.readInt(Dummy))
89  return false; // checksum
90  if (!Buffer.readInt(Dummy))
91  return false; // num
92  if (!Buffer.readInt(RunCount))
93  return false;
94  Buffer.advanceCursor(Length - 3);
95  }
96  while (Buffer.readProgramTag()) {
97  uint32_t Length;
98  if (!Buffer.readInt(Length))
99  return false;
100  Buffer.advanceCursor(Length);
101  ++ProgramCount;
102  }
103 
104  return true;
105 }
106 
107 void GCOVFile::print(raw_ostream &OS) const {
108  for (const auto &FPtr : Functions)
109  FPtr->print(OS);
110 }
111 
112 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
113 /// dump - Dump GCOVFile content to dbgs() for debugging purposes.
115  print(dbgs());
116 }
117 #endif
118 
119 /// collectLineCounts - Collect line counts. This must be used after
120 /// reading .gcno and .gcda files.
122  for (const auto &FPtr : Functions)
123  FPtr->collectLineCounts(FI);
124  FI.setRunCount(RunCount);
125  FI.setProgramCount(ProgramCount);
126 }
127 
128 //===----------------------------------------------------------------------===//
129 // GCOVFunction implementation.
130 
131 /// readGCNO - Read a function from the GCNO buffer. Return false if an error
132 /// occurs.
134  uint32_t Dummy;
135  if (!Buff.readInt(Dummy))
136  return false; // Function header length
137  if (!Buff.readInt(Ident))
138  return false;
139  if (!Buff.readInt(Checksum))
140  return false;
141  if (Version != GCOV::V402) {
142  uint32_t CfgChecksum;
143  if (!Buff.readInt(CfgChecksum))
144  return false;
145  if (Parent.getChecksum() != CfgChecksum) {
146  errs() << "File checksums do not match: " << Parent.getChecksum()
147  << " != " << CfgChecksum << " in (" << Name << ").\n";
148  return false;
149  }
150  }
151  if (!Buff.readString(Name))
152  return false;
153  if (!Buff.readString(Filename))
154  return false;
155  if (!Buff.readInt(LineNumber))
156  return false;
157 
158  // read blocks.
159  if (!Buff.readBlockTag()) {
160  errs() << "Block tag not found.\n";
161  return false;
162  }
163  uint32_t BlockCount;
164  if (!Buff.readInt(BlockCount))
165  return false;
166  for (uint32_t i = 0, e = BlockCount; i != e; ++i) {
167  if (!Buff.readInt(Dummy))
168  return false; // Block flags;
169  Blocks.push_back(make_unique<GCOVBlock>(*this, i));
170  }
171 
172  // read edges.
173  while (Buff.readEdgeTag()) {
174  uint32_t EdgeCount;
175  if (!Buff.readInt(EdgeCount))
176  return false;
177  EdgeCount = (EdgeCount - 1) / 2;
178  uint32_t BlockNo;
179  if (!Buff.readInt(BlockNo))
180  return false;
181  if (BlockNo >= BlockCount) {
182  errs() << "Unexpected block number: " << BlockNo << " (in " << Name
183  << ").\n";
184  return false;
185  }
186  for (uint32_t i = 0, e = EdgeCount; i != e; ++i) {
187  uint32_t Dst;
188  if (!Buff.readInt(Dst))
189  return false;
190  Edges.push_back(make_unique<GCOVEdge>(*Blocks[BlockNo], *Blocks[Dst]));
191  GCOVEdge *Edge = Edges.back().get();
192  Blocks[BlockNo]->addDstEdge(Edge);
193  Blocks[Dst]->addSrcEdge(Edge);
194  if (!Buff.readInt(Dummy))
195  return false; // Edge flag
196  }
197  }
198 
199  // read line table.
200  while (Buff.readLineTag()) {
201  uint32_t LineTableLength;
202  // Read the length of this line table.
203  if (!Buff.readInt(LineTableLength))
204  return false;
205  uint32_t EndPos = Buff.getCursor() + LineTableLength * 4;
206  uint32_t BlockNo;
207  // Read the block number this table is associated with.
208  if (!Buff.readInt(BlockNo))
209  return false;
210  if (BlockNo >= BlockCount) {
211  errs() << "Unexpected block number: " << BlockNo << " (in " << Name
212  << ").\n";
213  return false;
214  }
215  GCOVBlock &Block = *Blocks[BlockNo];
216  // Read the word that pads the beginning of the line table. This may be a
217  // flag of some sort, but seems to always be zero.
218  if (!Buff.readInt(Dummy))
219  return false;
220 
221  // Line information starts here and continues up until the last word.
222  if (Buff.getCursor() != (EndPos - sizeof(uint32_t))) {
223  StringRef F;
224  // Read the source file name.
225  if (!Buff.readString(F))
226  return false;
227  if (Filename != F) {
228  errs() << "Multiple sources for a single basic block: " << Filename
229  << " != " << F << " (in " << Name << ").\n";
230  return false;
231  }
232  // Read lines up to, but not including, the null terminator.
233  while (Buff.getCursor() < (EndPos - 2 * sizeof(uint32_t))) {
234  uint32_t Line;
235  if (!Buff.readInt(Line))
236  return false;
237  // Line 0 means this instruction was injected by the compiler. Skip it.
238  if (!Line)
239  continue;
240  Block.addLine(Line);
241  }
242  // Read the null terminator.
243  if (!Buff.readInt(Dummy))
244  return false;
245  }
246  // The last word is either a flag or padding, it isn't clear which. Skip
247  // over it.
248  if (!Buff.readInt(Dummy))
249  return false;
250  }
251  return true;
252 }
253 
254 /// readGCDA - Read a function from the GCDA buffer. Return false if an error
255 /// occurs.
257  uint32_t HeaderLength;
258  if (!Buff.readInt(HeaderLength))
259  return false; // Function header length
260 
261  uint64_t EndPos = Buff.getCursor() + HeaderLength * sizeof(uint32_t);
262 
263  uint32_t GCDAIdent;
264  if (!Buff.readInt(GCDAIdent))
265  return false;
266  if (Ident != GCDAIdent) {
267  errs() << "Function identifiers do not match: " << Ident
268  << " != " << GCDAIdent << " (in " << Name << ").\n";
269  return false;
270  }
271 
272  uint32_t GCDAChecksum;
273  if (!Buff.readInt(GCDAChecksum))
274  return false;
275  if (Checksum != GCDAChecksum) {
276  errs() << "Function checksums do not match: " << Checksum
277  << " != " << GCDAChecksum << " (in " << Name << ").\n";
278  return false;
279  }
280 
281  uint32_t CfgChecksum;
282  if (Version != GCOV::V402) {
283  if (!Buff.readInt(CfgChecksum))
284  return false;
285  if (Parent.getChecksum() != CfgChecksum) {
286  errs() << "File checksums do not match: " << Parent.getChecksum()
287  << " != " << CfgChecksum << " (in " << Name << ").\n";
288  return false;
289  }
290  }
291 
292  if (Buff.getCursor() < EndPos) {
293  StringRef GCDAName;
294  if (!Buff.readString(GCDAName))
295  return false;
296  if (Name != GCDAName) {
297  errs() << "Function names do not match: " << Name << " != " << GCDAName
298  << ".\n";
299  return false;
300  }
301  }
302 
303  if (!Buff.readArcTag()) {
304  errs() << "Arc tag not found (in " << Name << ").\n";
305  return false;
306  }
307 
308  uint32_t Count;
309  if (!Buff.readInt(Count))
310  return false;
311  Count /= 2;
312 
313  // This for loop adds the counts for each block. A second nested loop is
314  // required to combine the edge counts that are contained in the GCDA file.
315  for (uint32_t BlockNo = 0; Count > 0; ++BlockNo) {
316  // The last block is always reserved for exit block
317  if (BlockNo >= Blocks.size()) {
318  errs() << "Unexpected number of edges (in " << Name << ").\n";
319  return false;
320  }
321  if (BlockNo == Blocks.size() - 1)
322  errs() << "(" << Name << ") has arcs from exit block.\n";
323  GCOVBlock &Block = *Blocks[BlockNo];
324  for (size_t EdgeNo = 0, End = Block.getNumDstEdges(); EdgeNo < End;
325  ++EdgeNo) {
326  if (Count == 0) {
327  errs() << "Unexpected number of edges (in " << Name << ").\n";
328  return false;
329  }
330  uint64_t ArcCount;
331  if (!Buff.readInt64(ArcCount))
332  return false;
333  Block.addCount(EdgeNo, ArcCount);
334  --Count;
335  }
336  Block.sortDstEdges();
337  }
338  return true;
339 }
340 
341 /// getEntryCount - Get the number of times the function was called by
342 /// retrieving the entry block's count.
343 uint64_t GCOVFunction::getEntryCount() const {
344  return Blocks.front()->getCount();
345 }
346 
347 /// getExitCount - Get the number of times the function returned by retrieving
348 /// the exit block's count.
349 uint64_t GCOVFunction::getExitCount() const {
350  return Blocks.back()->getCount();
351 }
352 
354  OS << "===== " << Name << " (" << Ident << ") @ " << Filename << ":"
355  << LineNumber << "\n";
356  for (const auto &Block : Blocks)
357  Block->print(OS);
358 }
359 
360 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
361 /// dump - Dump GCOVFunction content to dbgs() for debugging purposes.
363  print(dbgs());
364 }
365 #endif
366 
367 /// collectLineCounts - Collect line counts. This must be used after
368 /// reading .gcno and .gcda files.
370  // If the line number is zero, this is a function that doesn't actually appear
371  // in the source file, so there isn't anything we can do with it.
372  if (LineNumber == 0)
373  return;
374 
375  for (const auto &Block : Blocks)
376  Block->collectLineCounts(FI);
377  FI.addFunctionLine(Filename, LineNumber, this);
378 }
379 
380 //===----------------------------------------------------------------------===//
381 // GCOVBlock implementation.
382 
383 /// ~GCOVBlock - Delete GCOVBlock and its content.
385  SrcEdges.clear();
386  DstEdges.clear();
387  Lines.clear();
388 }
389 
390 /// addCount - Add to block counter while storing the edge count. If the
391 /// destination has no outgoing edges, also update that block's count too.
392 void GCOVBlock::addCount(size_t DstEdgeNo, uint64_t N) {
393  assert(DstEdgeNo < DstEdges.size()); // up to caller to ensure EdgeNo is valid
394  DstEdges[DstEdgeNo]->Count = N;
395  Counter += N;
396  if (!DstEdges[DstEdgeNo]->Dst.getNumDstEdges())
397  DstEdges[DstEdgeNo]->Dst.Counter += N;
398 }
399 
400 /// sortDstEdges - Sort destination edges by block number, nop if already
401 /// sorted. This is required for printing branch info in the correct order.
403  if (!DstEdgesAreSorted) {
404  SortDstEdgesFunctor SortEdges;
405  std::stable_sort(DstEdges.begin(), DstEdges.end(), SortEdges);
406  }
407 }
408 
409 /// collectLineCounts - Collect line counts. This must be used after
410 /// reading .gcno and .gcda files.
412  for (uint32_t N : Lines)
413  FI.addBlockLine(Parent.getFilename(), N, this);
414 }
415 
416 void GCOVBlock::print(raw_ostream &OS) const {
417  OS << "Block : " << Number << " Counter : " << Counter << "\n";
418  if (!SrcEdges.empty()) {
419  OS << "\tSource Edges : ";
420  for (const GCOVEdge *Edge : SrcEdges)
421  OS << Edge->Src.Number << " (" << Edge->Count << "), ";
422  OS << "\n";
423  }
424  if (!DstEdges.empty()) {
425  OS << "\tDestination Edges : ";
426  for (const GCOVEdge *Edge : DstEdges)
427  OS << Edge->Dst.Number << " (" << Edge->Count << "), ";
428  OS << "\n";
429  }
430  if (!Lines.empty()) {
431  OS << "\tLines : ";
432  for (uint32_t N : Lines)
433  OS << (N) << ",";
434  OS << "\n";
435  }
436 }
437 
438 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
439 /// dump - Dump GCOVBlock content to dbgs() for debugging purposes.
441  print(dbgs());
442 }
443 #endif
444 
445 //===----------------------------------------------------------------------===//
446 // FileInfo implementation.
447 
448 // Safe integer division, returns 0 if numerator is 0.
449 static uint32_t safeDiv(uint64_t Numerator, uint64_t Divisor) {
450  if (!Numerator)
451  return 0;
452  return Numerator / Divisor;
453 }
454 
455 // This custom division function mimics gcov's branch ouputs:
456 // - Round to closest whole number
457 // - Only output 0% or 100% if it's exactly that value
458 static uint32_t branchDiv(uint64_t Numerator, uint64_t Divisor) {
459  if (!Numerator)
460  return 0;
461  if (Numerator == Divisor)
462  return 100;
463 
464  uint8_t Res = (Numerator * 100 + Divisor / 2) / Divisor;
465  if (Res == 0)
466  return 1;
467  if (Res == 100)
468  return 99;
469  return Res;
470 }
471 
472 namespace {
473 struct formatBranchInfo {
474  formatBranchInfo(const GCOV::Options &Options, uint64_t Count, uint64_t Total)
475  : Options(Options), Count(Count), Total(Total) {}
476 
477  void print(raw_ostream &OS) const {
478  if (!Total)
479  OS << "never executed";
480  else if (Options.BranchCount)
481  OS << "taken " << Count;
482  else
483  OS << "taken " << branchDiv(Count, Total) << "%";
484  }
485 
486  const GCOV::Options &Options;
487  uint64_t Count;
488  uint64_t Total;
489 };
490 
491 static raw_ostream &operator<<(raw_ostream &OS, const formatBranchInfo &FBI) {
492  FBI.print(OS);
493  return OS;
494 }
495 
496 class LineConsumer {
497  std::unique_ptr<MemoryBuffer> Buffer;
498  StringRef Remaining;
499 
500 public:
501  LineConsumer(StringRef Filename) {
504  if (std::error_code EC = BufferOrErr.getError()) {
505  errs() << Filename << ": " << EC.message() << "\n";
506  Remaining = "";
507  } else {
508  Buffer = std::move(BufferOrErr.get());
509  Remaining = Buffer->getBuffer();
510  }
511  }
512  bool empty() { return Remaining.empty(); }
513  void printNext(raw_ostream &OS, uint32_t LineNum) {
514  StringRef Line;
515  if (empty())
516  Line = "/*EOF*/";
517  else
518  std::tie(Line, Remaining) = Remaining.split("\n");
519  OS << format("%5u:", LineNum) << Line << "\n";
520  }
521 };
522 } // end anonymous namespace
523 
524 /// Convert a path to a gcov filename. If PreservePaths is true, this
525 /// translates "/" to "#", ".." to "^", and drops ".", to match gcov.
526 static std::string mangleCoveragePath(StringRef Filename, bool PreservePaths) {
527  if (!PreservePaths)
528  return sys::path::filename(Filename).str();
529 
530  // This behaviour is defined by gcov in terms of text replacements, so it's
531  // not likely to do anything useful on filesystems with different textual
532  // conventions.
533  llvm::SmallString<256> Result("");
534  StringRef::iterator I, S, E;
535  for (I = S = Filename.begin(), E = Filename.end(); I != E; ++I) {
536  if (*I != '/')
537  continue;
538 
539  if (I - S == 1 && *S == '.') {
540  // ".", the current directory, is skipped.
541  } else if (I - S == 2 && *S == '.' && *(S + 1) == '.') {
542  // "..", the parent directory, is replaced with "^".
543  Result.append("^#");
544  } else {
545  if (S < I)
546  // Leave other components intact,
547  Result.append(S, I);
548  // And separate with "#".
549  Result.push_back('#');
550  }
551  S = I + 1;
552  }
553 
554  if (S < I)
555  Result.append(S, I);
556  return Result.str();
557 }
558 
559 std::string FileInfo::getCoveragePath(StringRef Filename,
560  StringRef MainFilename) {
561  if (Options.NoOutput)
562  // This is probably a bug in gcov, but when -n is specified, paths aren't
563  // mangled at all, and the -l and -p options are ignored. Here, we do the
564  // same.
565  return Filename;
566 
567  std::string CoveragePath;
568  if (Options.LongFileNames && !Filename.equals(MainFilename))
569  CoveragePath =
570  mangleCoveragePath(MainFilename, Options.PreservePaths) + "##";
571  CoveragePath += mangleCoveragePath(Filename, Options.PreservePaths) + ".gcov";
572  return CoveragePath;
573 }
574 
575 std::unique_ptr<raw_ostream>
576 FileInfo::openCoveragePath(StringRef CoveragePath) {
577  if (Options.NoOutput)
578  return llvm::make_unique<raw_null_ostream>();
579 
580  std::error_code EC;
581  auto OS = llvm::make_unique<raw_fd_ostream>(CoveragePath, EC,
583  if (EC) {
584  errs() << EC.message() << "\n";
585  return llvm::make_unique<raw_null_ostream>();
586  }
587  return std::move(OS);
588 }
589 
590 /// print - Print source files with collected line count information.
591 void FileInfo::print(raw_ostream &InfoOS, StringRef MainFilename,
592  StringRef GCNOFile, StringRef GCDAFile) {
593  SmallVector<StringRef, 4> Filenames;
594  for (const auto &LI : LineInfo)
595  Filenames.push_back(LI.first());
596  llvm::sort(Filenames.begin(), Filenames.end());
597 
598  for (StringRef Filename : Filenames) {
599  auto AllLines = LineConsumer(Filename);
600 
601  std::string CoveragePath = getCoveragePath(Filename, MainFilename);
602  std::unique_ptr<raw_ostream> CovStream = openCoveragePath(CoveragePath);
603  raw_ostream &CovOS = *CovStream;
604 
605  CovOS << " -: 0:Source:" << Filename << "\n";
606  CovOS << " -: 0:Graph:" << GCNOFile << "\n";
607  CovOS << " -: 0:Data:" << GCDAFile << "\n";
608  CovOS << " -: 0:Runs:" << RunCount << "\n";
609  CovOS << " -: 0:Programs:" << ProgramCount << "\n";
610 
611  const LineData &Line = LineInfo[Filename];
612  GCOVCoverage FileCoverage(Filename);
613  for (uint32_t LineIndex = 0; LineIndex < Line.LastLine || !AllLines.empty();
614  ++LineIndex) {
615  if (Options.BranchInfo) {
616  FunctionLines::const_iterator FuncsIt = Line.Functions.find(LineIndex);
617  if (FuncsIt != Line.Functions.end())
618  printFunctionSummary(CovOS, FuncsIt->second);
619  }
620 
621  BlockLines::const_iterator BlocksIt = Line.Blocks.find(LineIndex);
622  if (BlocksIt == Line.Blocks.end()) {
623  // No basic blocks are on this line. Not an executable line of code.
624  CovOS << " -:";
625  AllLines.printNext(CovOS, LineIndex + 1);
626  } else {
627  const BlockVector &Blocks = BlocksIt->second;
628 
629  // Add up the block counts to form line counts.
631  uint64_t LineCount = 0;
632  for (const GCOVBlock *Block : Blocks) {
633  if (Options.AllBlocks) {
634  // Only take the highest block count for that line.
635  uint64_t BlockCount = Block->getCount();
636  LineCount = LineCount > BlockCount ? LineCount : BlockCount;
637  } else {
638  // Sum up all of the block counts.
639  LineCount += Block->getCount();
640  }
641 
642  if (Options.FuncCoverage) {
643  // This is a slightly convoluted way to most accurately gather line
644  // statistics for functions. Basically what is happening is that we
645  // don't want to count a single line with multiple blocks more than
646  // once. However, we also don't simply want to give the total line
647  // count to every function that starts on the line. Thus, what is
648  // happening here are two things:
649  // 1) Ensure that the number of logical lines is only incremented
650  // once per function.
651  // 2) If there are multiple blocks on the same line, ensure that the
652  // number of lines executed is incremented as long as at least
653  // one of the blocks are executed.
654  const GCOVFunction *Function = &Block->getParent();
655  if (FuncCoverages.find(Function) == FuncCoverages.end()) {
656  std::pair<const GCOVFunction *, GCOVCoverage> KeyValue(
657  Function, GCOVCoverage(Function->getName()));
658  FuncCoverages.insert(KeyValue);
659  }
660  GCOVCoverage &FuncCoverage = FuncCoverages.find(Function)->second;
661 
662  if (LineExecs.find(Function) == LineExecs.end()) {
663  if (Block->getCount()) {
664  ++FuncCoverage.LinesExec;
665  LineExecs[Function] = true;
666  } else {
667  LineExecs[Function] = false;
668  }
669  ++FuncCoverage.LogicalLines;
670  } else if (!LineExecs[Function] && Block->getCount()) {
671  ++FuncCoverage.LinesExec;
672  LineExecs[Function] = true;
673  }
674  }
675  }
676 
677  if (LineCount == 0)
678  CovOS << " #####:";
679  else {
680  CovOS << format("%9" PRIu64 ":", LineCount);
681  ++FileCoverage.LinesExec;
682  }
683  ++FileCoverage.LogicalLines;
684 
685  AllLines.printNext(CovOS, LineIndex + 1);
686 
687  uint32_t BlockNo = 0;
688  uint32_t EdgeNo = 0;
689  for (const GCOVBlock *Block : Blocks) {
690  // Only print block and branch information at the end of the block.
691  if (Block->getLastLine() != LineIndex + 1)
692  continue;
693  if (Options.AllBlocks)
694  printBlockInfo(CovOS, *Block, LineIndex, BlockNo);
695  if (Options.BranchInfo) {
696  size_t NumEdges = Block->getNumDstEdges();
697  if (NumEdges > 1)
698  printBranchInfo(CovOS, *Block, FileCoverage, EdgeNo);
699  else if (Options.UncondBranch && NumEdges == 1)
700  printUncondBranchInfo(CovOS, EdgeNo,
701  (*Block->dst_begin())->Count);
702  }
703  }
704  }
705  }
706  FileCoverages.push_back(std::make_pair(CoveragePath, FileCoverage));
707  }
708 
709  // FIXME: There is no way to detect calls given current instrumentation.
710  if (Options.FuncCoverage)
711  printFuncCoverage(InfoOS);
712  printFileCoverage(InfoOS);
713 }
714 
715 /// printFunctionSummary - Print function and block summary.
716 void FileInfo::printFunctionSummary(raw_ostream &OS,
717  const FunctionVector &Funcs) const {
718  for (const GCOVFunction *Func : Funcs) {
719  uint64_t EntryCount = Func->getEntryCount();
720  uint32_t BlocksExec = 0;
721  for (const GCOVBlock &Block : Func->blocks())
722  if (Block.getNumDstEdges() && Block.getCount())
723  ++BlocksExec;
724 
725  OS << "function " << Func->getName() << " called " << EntryCount
726  << " returned " << safeDiv(Func->getExitCount() * 100, EntryCount)
727  << "% blocks executed "
728  << safeDiv(BlocksExec * 100, Func->getNumBlocks() - 1) << "%\n";
729  }
730 }
731 
732 /// printBlockInfo - Output counts for each block.
733 void FileInfo::printBlockInfo(raw_ostream &OS, const GCOVBlock &Block,
734  uint32_t LineIndex, uint32_t &BlockNo) const {
735  if (Block.getCount() == 0)
736  OS << " $$$$$:";
737  else
738  OS << format("%9" PRIu64 ":", Block.getCount());
739  OS << format("%5u-block %2u\n", LineIndex + 1, BlockNo++);
740 }
741 
742 /// printBranchInfo - Print conditional branch probabilities.
743 void FileInfo::printBranchInfo(raw_ostream &OS, const GCOVBlock &Block,
744  GCOVCoverage &Coverage, uint32_t &EdgeNo) {
745  SmallVector<uint64_t, 16> BranchCounts;
746  uint64_t TotalCounts = 0;
747  for (const GCOVEdge *Edge : Block.dsts()) {
748  BranchCounts.push_back(Edge->Count);
749  TotalCounts += Edge->Count;
750  if (Block.getCount())
751  ++Coverage.BranchesExec;
752  if (Edge->Count)
753  ++Coverage.BranchesTaken;
754  ++Coverage.Branches;
755 
756  if (Options.FuncCoverage) {
757  const GCOVFunction *Function = &Block.getParent();
758  GCOVCoverage &FuncCoverage = FuncCoverages.find(Function)->second;
759  if (Block.getCount())
760  ++FuncCoverage.BranchesExec;
761  if (Edge->Count)
762  ++FuncCoverage.BranchesTaken;
763  ++FuncCoverage.Branches;
764  }
765  }
766 
767  for (uint64_t N : BranchCounts)
768  OS << format("branch %2u ", EdgeNo++)
769  << formatBranchInfo(Options, N, TotalCounts) << "\n";
770 }
771 
772 /// printUncondBranchInfo - Print unconditional branch probabilities.
773 void FileInfo::printUncondBranchInfo(raw_ostream &OS, uint32_t &EdgeNo,
774  uint64_t Count) const {
775  OS << format("unconditional %2u ", EdgeNo++)
776  << formatBranchInfo(Options, Count, Count) << "\n";
777 }
778 
779 // printCoverage - Print generic coverage info used by both printFuncCoverage
780 // and printFileCoverage.
781 void FileInfo::printCoverage(raw_ostream &OS,
782  const GCOVCoverage &Coverage) const {
783  OS << format("Lines executed:%.2f%% of %u\n",
784  double(Coverage.LinesExec) * 100 / Coverage.LogicalLines,
785  Coverage.LogicalLines);
786  if (Options.BranchInfo) {
787  if (Coverage.Branches) {
788  OS << format("Branches executed:%.2f%% of %u\n",
789  double(Coverage.BranchesExec) * 100 / Coverage.Branches,
790  Coverage.Branches);
791  OS << format("Taken at least once:%.2f%% of %u\n",
792  double(Coverage.BranchesTaken) * 100 / Coverage.Branches,
793  Coverage.Branches);
794  } else {
795  OS << "No branches\n";
796  }
797  OS << "No calls\n"; // to be consistent with gcov
798  }
799 }
800 
801 // printFuncCoverage - Print per-function coverage info.
802 void FileInfo::printFuncCoverage(raw_ostream &OS) const {
803  for (const auto &FC : FuncCoverages) {
804  const GCOVCoverage &Coverage = FC.second;
805  OS << "Function '" << Coverage.Name << "'\n";
806  printCoverage(OS, Coverage);
807  OS << "\n";
808  }
809 }
810 
811 // printFileCoverage - Print per-file coverage info.
812 void FileInfo::printFileCoverage(raw_ostream &OS) const {
813  for (const auto &FC : FileCoverages) {
814  const std::string &Filename = FC.first;
815  const GCOVCoverage &Coverage = FC.second;
816  OS << "File '" << Coverage.Name << "'\n";
817  printCoverage(OS, Coverage);
818  if (!Options.NoOutput)
819  OS << Coverage.Name << ":creating '" << Filename << "'\n";
820  OS << "\n";
821  }
822 }
void push_back(const T &Elt)
Definition: SmallVector.h:213
Represents either an error or a value T.
Definition: ErrorOr.h:69
raw_ostream & errs()
This returns a reference to a raw_ostream for standard error.
bool readGCNO(GCOVBuffer &Buffer, GCOV::GCOVVersion Version)
readGCNO - Read a function from the GCNO buffer.
Definition: GCOV.cpp:133
bool readInt(uint32_t &Val)
Definition: GCOV.h:196
LLVM_NODISCARD std::string str() const
str - Get the contents as an std::string.
Definition: StringRef.h:228
bool readGCDAFormat()
readGCDAFormat - Check GCDA signature is valid at the beginning of buffer.
Definition: GCOV.h:80
GCOVEdge - Collects edge information.
Definition: GCOV.h:263
Compute iterated dominance frontiers using a linear time algorithm.
Definition: AllocatorList.h:24
#define LLVM_DUMP_METHOD
Mark debug helper function definitions like dump() that should not be stripped from debug builds...
Definition: Compiler.h:449
void addFunctionLine(StringRef Filename, uint32_t Line, const GCOVFunction *Function)
Definition: GCOV.h:419
void print(raw_ostream &OS, StringRef MainFilename, StringRef GCNOFile, StringRef GCDAFile)
print - Print source files with collected line count information.
Definition: GCOV.cpp:591
bool readLineTag()
readLineTag - If cursor points to a line tag then increment the cursor and return true otherwise retu...
Definition: GCOV.h:150
void setProgramCount(uint32_t Programs)
Definition: GCOV.h:427
bool readString(StringRef &Str)
Definition: GCOV.h:215
format_object< Ts... > format(const char *Fmt, const Ts &... Vals)
These are helper functions used to produce formatted output.
Definition: Format.h:124
void addLine(uint32_t N)
Definition: GCOV.h:330
A struct for passing gcov options between functions.
Definition: GCOV.h:45
uint64_t getCursor() const
Definition: GCOV.h:232
F(f)
void addBlockLine(StringRef Filename, uint32_t Line, const GCOVBlock *Block)
Definition: GCOV.h:413
static std::string mangleCoveragePath(StringRef Filename, bool PreservePaths)
Convert a path to a gcov filename.
Definition: GCOV.cpp:526
GCOVBuffer - A wrapper around MemoryBuffer to provide GCOV specific read operations.
Definition: GCOV.h:64
void print(raw_ostream &OS) const
Definition: GCOV.cpp:107
uint64_t getCount() const
Definition: GCOV.h:333
static uint32_t safeDiv(uint64_t Numerator, uint64_t Divisor)
Definition: GCOV.cpp:449
void collectLineCounts(FileInfo &FI)
collectLineCounts - Collect line counts.
Definition: GCOV.cpp:369
StringRef str() const
Explicit conversion to StringRef.
Definition: SmallString.h:267
bool readGCDA(GCOVBuffer &Buffer)
readGCDA - Read GCDA buffer.
Definition: GCOV.cpp:55
bool readArcTag()
readArcTag - If cursor points to an gcda arc tag then increment the cursor and return true otherwise ...
Definition: GCOV.h:162
void dump() const
dump - Dump GCOVBlock content to dbgs() for debugging purposes.
Definition: GCOV.cpp:440
StringRef getName() const
Definition: GCOV.h:281
LLVM_NODISCARD LLVM_ATTRIBUTE_ALWAYS_INLINE bool empty() const
empty - Check if the string is empty.
Definition: StringRef.h:133
GCOVBlock - Collects block information.
Definition: GCOV.h:309
bool BranchCount
Definition: GCOV.h:52
void sortDstEdges()
sortDstEdges - Sort destination edges by block number, nop if already sorted.
Definition: GCOV.cpp:402
bool readInt64(uint64_t &Val)
Definition: GCOV.h:207
void collectLineCounts(FileInfo &FI)
collectLineCounts - Collect line counts.
Definition: GCOV.cpp:121
void append(in_iter S, in_iter E)
Append from an iterator pair.
Definition: SmallString.h:75
* if(!EatIfPresent(lltok::kw_thread_local)) return false
ParseOptionalThreadLocal := /*empty.
iterator_range< EdgeIterator > dsts() const
Definition: GCOV.h:360
bool readBlockTag()
readBlockTag - If cursor points to a block tag then increment the cursor and return true otherwise re...
Definition: GCOV.h:126
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
LLVM_ATTRIBUTE_ALWAYS_INLINE iterator begin()
Definition: SmallVector.h:117
std::error_code getError() const
Definition: ErrorOr.h:172
uint64_t getExitCount() const
getExitCount - Get the number of times the function returned by retrieving the exit block&#39;s count...
Definition: GCOV.cpp:349
static const unsigned End
bool readGCNOFormat()
readGCNOFormat - Check GCNO signature is valid at the beginning of buffer.
Definition: GCOV.h:69
void advanceCursor(uint32_t n)
Definition: GCOV.h:233
bool readGCNO(GCOVBuffer &Buffer)
readGCNO - Read GCNO buffer.
Definition: GCOV.cpp:32
const GCOVFunction & getParent() const
Definition: GCOV.h:329
GCOVVersion
Definition: GCOV.h:42
bool readEdgeTag()
readEdgeTag - If cursor points to an edge tag then increment the cursor and return true otherwise ret...
Definition: GCOV.h:138
void sort(IteratorTy Start, IteratorTy End)
Definition: STLExtras.h:859
This is a &#39;vector&#39; (really, a variable-sized array), optimized for the case when the array is small...
Definition: SmallVector.h:861
LLVM_NODISCARD std::pair< StringRef, StringRef > split(char Separator) const
Split into two substrings around the first occurrence of a separator character.
Definition: StringRef.h:727
bool readGCDA(GCOVBuffer &Buffer, GCOV::GCOVVersion Version)
readGCDA - Read a function from the GCDA buffer.
Definition: GCOV.cpp:256
raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition: Debug.cpp:133
LLVM_NODISCARD LLVM_ATTRIBUTE_ALWAYS_INLINE bool equals(StringRef RHS) const
equals - Check for string equality, this is more efficient than compare() when the relative ordering ...
Definition: StringRef.h:169
iterator begin() const
Definition: StringRef.h:106
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 "-".
void collectLineCounts(FileInfo &FI)
collectLineCounts - Collect line counts.
Definition: GCOV.cpp:411
LLVM_ATTRIBUTE_ALWAYS_INLINE iterator end()
Definition: SmallVector.h:121
void dump() const
dump - Dump GCOVFile content to dbgs() for debugging purposes.
Definition: GCOV.cpp:114
size_t getNumDstEdges() const
Definition: GCOV.h:349
GCOVFunction - Collects function information.
Definition: GCOV.h:272
StringRef filename(StringRef path, Style style=Style::native)
Get filename.
Definition: Path.cpp:581
static uint32_t branchDiv(uint64_t Numerator, uint64_t Divisor)
Definition: GCOV.cpp:458
#define I(x, y, z)
Definition: MD5.cpp:58
#define N
bool readObjectTag()
readObjectTag - If cursor points to an object summary tag then increment the cursor and return true o...
Definition: GCOV.h:174
raw_ostream & operator<<(raw_ostream &OS, const APInt &I)
Definition: APInt.h:2023
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
~GCOVBlock()
~GCOVBlock - Delete GCOVBlock and its content.
Definition: GCOV.cpp:384
This class implements an extremely fast bulk output stream that can only output to a stream...
Definition: raw_ostream.h:46
bool readProgramTag()
readProgramTag - If cursor points to a program summary tag then increment the cursor and return true ...
Definition: GCOV.h:186
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:49
bool readFunctionTag()
readFunctionTag - If cursor points to a function tag then increment the cursor and return true otherw...
Definition: GCOV.h:114
void addCount(size_t DstEdgeNo, uint64_t N)
addCount - Add to block counter while storing the edge count.
Definition: GCOV.cpp:392
void setRunCount(uint32_t Runs)
Definition: GCOV.h:426
bool readGCOVVersion(GCOV::GCOVVersion &Version)
readGCOVVersion - Read GCOV version.
Definition: GCOV.h:91
iterator end() const
Definition: StringRef.h:108
void print(raw_ostream &OS) const
Definition: GCOV.cpp:416
void print(raw_ostream &OS) const
Definition: GCOV.cpp:353
void dump() const
dump - Dump GCOVFunction content to dbgs() for debugging purposes.
Definition: GCOV.cpp:362
reference get()
Definition: ErrorOr.h:169
uint64_t getEntryCount() const
getEntryCount - Get the number of times the function was called by retrieving the entry block&#39;s count...
Definition: GCOV.cpp:343