llvm-cov: Added -u option for unconditional branch info.
[oota-llvm.git] / lib / IR / GCOV.cpp
index c7a1102d10add0e09de4e874b3587c9afdf5b805..929a5d45ca6c8ceebf6a6210cdf990048a4f2e66 100644 (file)
@@ -19,6 +19,7 @@
 #include "llvm/Support/Format.h"
 #include "llvm/Support/MemoryObject.h"
 #include "llvm/Support/system_error.h"
+#include <algorithm>
 using namespace llvm;
 
 //===----------------------------------------------------------------------===//
@@ -80,7 +81,7 @@ bool GCOVFile::readGCDA(GCOVBuffer &Buffer) {
     if (!Buffer.readInt(Length)) return false;
     if (!Buffer.readInt(Dummy)) return false; // checksum
     if (!Buffer.readInt(Dummy)) return false; // num
-    if (!Buffer.readInt(RunCount)) return false;;
+    if (!Buffer.readInt(RunCount)) return false;
     Buffer.advanceCursor(Length-3);
   }
   while (Buffer.readProgramTag()) {
@@ -278,10 +279,23 @@ bool GCOVFunction::readGCDA(GCOVBuffer &Buff, GCOV::GCOVVersion Version) {
       Block.addCount(EdgeNo, ArcCount);
       --Count;
     }
+    Block.sortDstEdges();
   }
   return true;
 }
 
+/// getEntryCount - Get the number of times the function was called by
+/// retrieving the entry block's count.
+uint64_t GCOVFunction::getEntryCount() const {
+  return Blocks.front()->getCount();
+}
+
+/// getExitCount - Get the number of times the function returned by retrieving
+/// the exit block's count.
+uint64_t GCOVFunction::getExitCount() const {
+  return Blocks.back()->getCount();
+}
+
 /// dump - Dump GCOVFunction content to dbgs() for debugging purposes.
 void GCOVFunction::dump() const {
   dbgs() <<  "===== " << Name << " @ " << Filename << ":" << LineNumber << "\n";
@@ -296,6 +310,7 @@ void GCOVFunction::collectLineCounts(FileInfo &FI) {
   for (SmallVectorImpl<GCOVBlock *>::iterator I = Blocks.begin(),
          E = Blocks.end(); I != E; ++I)
     (*I)->collectLineCounts(FI);
+  FI.addFunctionLine(Filename, LineNumber, this);
 }
 
 //===----------------------------------------------------------------------===//
@@ -318,6 +333,15 @@ void GCOVBlock::addCount(size_t DstEdgeNo, uint64_t N) {
     DstEdges[DstEdgeNo]->Dst->Counter += N;
 }
 
+/// sortDstEdges - Sort destination edges by block number, nop if already
+/// sorted. This is required for printing branch info in the correct order.
+void GCOVBlock::sortDstEdges() {
+  if (!DstEdgesAreSorted) {
+    SortDstEdgesFunctor SortEdges;
+    std::stable_sort(DstEdges.begin(), DstEdges.end(), SortEdges);
+  }
+}
+
 /// collectLineCounts - Collect line counts. This must be used after
 /// reading .gcno and .gcda files.
 void GCOVBlock::collectLineCounts(FileInfo &FI) {
@@ -357,6 +381,30 @@ void GCOVBlock::dump() const {
 //===----------------------------------------------------------------------===//
 // FileInfo implementation.
 
+// Safe integer division, returns 0 if numerator is 0.
+static uint32_t safeDiv(uint64_t Numerator, uint64_t Divisor) {
+  if (!Numerator)
+    return 0;
+  return Numerator/Divisor;
+}
+
+// This custom division function mimics gcov's branch ouputs:
+//   - Round to closest whole number
+//   - Only output 0% or 100% if it's exactly that value
+static uint32_t branchDiv(uint64_t Numerator, uint64_t Divisor) {
+  if (!Numerator)
+    return 0;
+  if (Numerator == Divisor)
+    return 100;
+
+  uint8_t Res = (Numerator*100+Divisor/2) / Divisor;
+  if (Res == 0)
+    return 1;
+  if (Res == 100)
+    return 99;
+  return Res;
+}
+
 /// print -  Print source files with collected line count information.
 void FileInfo::print(StringRef GCNOFile, StringRef GCDAFile) const {
   for (StringMap<LineData>::const_iterator I = LineInfo.begin(),
@@ -382,27 +430,129 @@ void FileInfo::print(StringRef GCNOFile, StringRef GCDAFile) const {
     OS << "        -:    0:Programs:" << ProgramCount << "\n";
 
     const LineData &Line = I->second;
-    for (uint32_t i = 0; !AllLines.empty(); ++i) {
-      LineData::const_iterator BlocksIt = Line.find(i);
+    for (uint32_t LineIndex = 0; !AllLines.empty(); ++LineIndex) {
+      if (Options.BranchProb) {
+        FunctionLines::const_iterator FuncsIt = Line.Functions.find(LineIndex);
+        if (FuncsIt != Line.Functions.end())
+          printFunctionSummary(OS, FuncsIt->second);
+      }
 
-      // Add up the block counts to form line counts.
-      if (BlocksIt != Line.end()) {
+      BlockLines::const_iterator BlocksIt = Line.Blocks.find(LineIndex);
+      if (BlocksIt == Line.Blocks.end()) {
+        // No basic blocks are on this line. Not an executable line of code.
+        OS << "        -:";
+        std::pair<StringRef, StringRef> P = AllLines.split('\n');
+        OS << format("%5u:", LineIndex+1) << P.first << "\n";
+        AllLines = P.second;
+      } else {
         const BlockVector &Blocks = BlocksIt->second;
+
+        // Add up the block counts to form line counts.
         uint64_t LineCount = 0;
         for (BlockVector::const_iterator I = Blocks.begin(), E = Blocks.end();
                I != E; ++I) {
-          LineCount += (*I)->getCount();
+          const GCOVBlock *Block = *I;
+          if (Options.AllBlocks) {
+            // Only take the highest block count for that line.
+            uint64_t BlockCount = Block->getCount();
+            LineCount = LineCount > BlockCount ? LineCount : BlockCount;
+          } else {
+            // Sum up all of the block counts.
+            LineCount += Block->getCount();
+          }
         }
         if (LineCount == 0)
           OS << "    #####:";
         else
           OS << format("%9" PRIu64 ":", LineCount);
-      } else {
-        OS << "        -:";
+
+        std::pair<StringRef, StringRef> P = AllLines.split('\n');
+        OS << format("%5u:", LineIndex+1) << P.first << "\n";
+        AllLines = P.second;
+
+        uint32_t BlockNo = 0;
+        uint32_t EdgeNo = 0;
+        for (BlockVector::const_iterator I = Blocks.begin(), E = Blocks.end();
+               I != E; ++I) {
+          const GCOVBlock *Block = *I;
+
+          // Only print block and branch information at the end of the block.
+          if (Block->getLastLine() != LineIndex+1)
+            continue;
+          if (Options.AllBlocks)
+            printBlockInfo(OS, *Block, LineIndex, BlockNo);
+          if (Options.BranchProb) {
+            size_t NumEdges = Block->getNumDstEdges();
+            if (NumEdges > 1)
+              printBranchInfo(OS, *Block, EdgeNo);
+            else if (Options.UncondBranch && NumEdges == 1)
+              printUncondBranchInfo(OS, EdgeNo, (*Block->dst_begin())->Count);
+          }
+        }
       }
-      std::pair<StringRef, StringRef> P = AllLines.split('\n');
-      OS << format("%5u:", i+1) << P.first << "\n";
-      AllLines = P.second;
     }
   }
 }
+
+/// printFunctionSummary - Print function and block summary.
+void FileInfo::printFunctionSummary(raw_fd_ostream &OS,
+                                    const FunctionVector &Funcs) const {
+  for (FunctionVector::const_iterator I = Funcs.begin(), E = Funcs.end();
+         I != E; ++I) {
+    const GCOVFunction *Func = *I;
+    uint64_t EntryCount = Func->getEntryCount();
+    uint32_t BlocksExecuted = 0;
+    for (GCOVFunction::BlockIterator I = Func->block_begin(),
+           E = Func->block_end(); I != E; ++I) {
+      const GCOVBlock *Block = *I;
+      if (Block->getNumDstEdges() && Block->getCount())
+          ++BlocksExecuted;
+    }
+
+    OS << "function " << Func->getName() << " called " << EntryCount
+       << " returned " << safeDiv(Func->getExitCount()*100, EntryCount)
+       << "% blocks executed "
+       << safeDiv(BlocksExecuted*100, Func->getNumBlocks()-1) << "%\n";
+  }
+}
+
+/// printBlockInfo - Output counts for each block.
+void FileInfo::printBlockInfo(raw_fd_ostream &OS, const GCOVBlock &Block,
+                              uint32_t LineIndex, uint32_t &BlockNo) const {
+  if (Block.getCount() == 0)
+    OS << "    $$$$$:";
+  else
+    OS << format("%9" PRIu64 ":", Block.getCount());
+  OS << format("%5u-block %2u\n", LineIndex+1, BlockNo++);
+}
+
+/// printBranchInfo - Print conditional branch probabilities.
+void FileInfo::printBranchInfo(raw_fd_ostream &OS, const GCOVBlock &Block,
+                               uint32_t &EdgeNo) const {
+  SmallVector<uint64_t, 16> BranchCounts;
+  uint64_t TotalCounts = 0;
+  for (GCOVBlock::EdgeIterator I = Block.dst_begin(), E = Block.dst_end();
+         I != E; ++I) {
+    const GCOVEdge *Edge = *I;
+    BranchCounts.push_back(Edge->Count);
+    TotalCounts += Edge->Count;
+  }
+
+  for (SmallVectorImpl<uint64_t>::const_iterator I = BranchCounts.begin(),
+         E = BranchCounts.end(); I != E; ++I) {
+    if (TotalCounts)
+      OS << format("branch %2u taken %u%%\n", EdgeNo++,
+                   branchDiv(*I, TotalCounts));
+    else
+      OS << format("branch %2u never executed\n", EdgeNo++);
+  }
+}
+
+/// printUncondBranchInfo - Print unconditional branch probabilities.
+void FileInfo::printUncondBranchInfo(raw_fd_ostream &OS, uint32_t &EdgeNo,
+                                     uint64_t Count) const {
+  if (Count)
+    OS << format("unconditional %2u taken 100%%\n", EdgeNo++);
+  else
+    OS << format("unconditional %2u never executed\n", EdgeNo++);
+}