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