llvm-cov: report the number of executed functions instead of the number of fully covered functions.

[arphaman]

Summary

I'm back after a short break.

This patch fixes the output produced by llvm-cov's report command by showing the number of functions executed in a file rather than the number of functions that were fully covered in that specific file.

[arphaman]

Sorry about the delay, had a wrist injury.
I've applied your suggestion and rebased the patch.
Alex

[arphaman]

Sorry, sent out the non-rebased version by accident, this is the rebased patch.

[arphaman]

Closed by commit rL218672 (authored by @arphaman).

llvm/trunk/include/llvm/ProfileData/CoverageMapping.h

 /// \brief Code coverage information for a single function.
 struct FunctionRecord {
   /// \brief Raw function name.
   std::string Name;
   /// \brief Associated files.
   std::vector<std::string> Filenames;
   /// \brief Regions in the function along with their counts.
   std::vector<CountedRegion> CountedRegions;
+  /// \brief The number of times this function was executed.
+  uint64_t ExecutionCount;
 
-  FunctionRecord(StringRef Name, ArrayRef<StringRef> Filenames)
-      : Name(Name), Filenames(Filenames.begin(), Filenames.end()) {}
+  FunctionRecord(StringRef Name, ArrayRef<StringRef> Filenames,
+                 uint64_t ExecutionCount)
+      : Name(Name), Filenames(Filenames.begin(), Filenames.end()),
+        ExecutionCount(ExecutionCount) {}
 };
 
 /// \brief Coverage information for a macro expansion or #included file.
 ///
 /// When covered code has pieces that can be expanded for more detail, such as a
 /// preprocessor macro use and its definition, these are represented as
 /// expansions whose coverage can be looked up independently.
 struct ExpansionRecord {

llvm/trunk/lib/ProfileData/CoverageMapping.cpp

if (std::error_code EC = ProfileReader.getFunctionCounts(
             Record.FunctionName, Record.FunctionHash, Counts)) {
       if (EC != instrprof_error::hash_mismatch &&
           EC != instrprof_error::unknown_function)
         return EC;
       Coverage->MismatchedFunctionCount++;
       continue;
     }
 
-    FunctionRecord Function(Record.FunctionName, Record.Filenames);
+    assert(Counts.size() != 0 && "Function's counts are empty");
+    FunctionRecord Function(Record.FunctionName, Record.Filenames,
+                            Counts.front());
     CounterMappingContext Ctx(Record.Expressions, Counts);
     for (const auto &Region : Record.MappingRegions) {
       ErrorOr<int64_t> ExecutionCount = Ctx.evaluate(Region.Count);
       if (!ExecutionCount)
         break;
       Function.CountedRegions.push_back(CountedRegion(Region, *ExecutionCount));
     }
     if (Function.CountedRegions.size() != Record.MappingRegions.size()) {

llvm/trunk/test/tools/llvm-cov/report.cpp

+// RUN: llvm-cov report %S/Inputs/report.covmapping -instr-profile %S/Inputs/report.profdata -no-colors 2>&1 | FileCheck %s
+
+// CHECK: Filename                    Regions    Miss   Cover Functions  Executed
+// CHECK: TOTAL                             5       2  60.00%         4    75.00%
+
+void foo(bool cond) {
+  if (cond) {
+  }
+}
+
+void bar() {
+}
+
+void func() {
+}
+
+int main() {
+  foo(false);
+  bar();
+  return 0;
+}
+
+// llvm-cov doesn't work on big endian yet
+// XFAIL: powerpc64-, s390x, mips-, mips64-, sparc

llvm/trunk/tools/llvm-cov/CoverageReport.cpp

static Column column(StringRef Str, unsigned Width) {
   return Column(Str, Width);
 }
 
 template <typename T>
 static Column column(StringRef Str, unsigned Width, const T &Value) {
   return Column(Str, Width).set(Value);
 }
 
-static const unsigned FileReportColumns[] = {25, 10, 8, 8, 10, 8};
+static const unsigned FileReportColumns[] = {25, 10, 8, 8, 10, 10};
 static const unsigned FunctionReportColumns[] = {25, 10, 8, 8, 10, 8, 8};
 
 /// \brief Prints a horizontal divider which spans across the given columns.
 template <typename T, size_t N>
 static void renderDivider(T (&Columns)[N], raw_ostream &OS) {
   unsigned Length = 0;
   for (unsigned I = 0; I < N; ++I)
     Length += Columns[I];
OS << column("Name", FunctionReportColumns[0])
        << column("Cover", FunctionReportColumns[6], Column::RightAlignment);
     OS << "\n";
     renderDivider(FunctionReportColumns, OS);
     OS << "\n";
     for (const auto &Function : File.FunctionSummaries)
       render(Function, OS);
     renderDivider(FunctionReportColumns, OS);
     OS << "\n";
-    render(FunctionCoverageSummary("TOTAL", File.RegionCoverage,
-                                   File.LineCoverage),
+    render(FunctionCoverageSummary("TOTAL", /*ExecutionCount=*/0,
+                                   File.RegionCoverage, File.LineCoverage),
            OS);
   }
 }
 
 void CoverageReport::renderFileReports(raw_ostream &OS) {
   OS << column("Filename", FileReportColumns[0])
      << column("Regions", FileReportColumns[1], Column::RightAlignment)
      << column("Miss", FileReportColumns[2], Column::RightAlignment)
      << column("Cover", FileReportColumns[3], Column::RightAlignment)
      << column("Functions", FileReportColumns[4], Column::RightAlignment)
-     << column("Cover", FileReportColumns[5], Column::RightAlignment) << "\n";
+     << column("Executed", FileReportColumns[5], Column::RightAlignment)
+     << "\n";
   renderDivider(FileReportColumns, OS);
   OS << "\n";
   for (const auto &File : Summary.getFileSummaries())
     render(File, OS);
   renderDivider(FileReportColumns, OS);
   OS << "\n";
   render(Summary.getCombinedFileSummaries(), OS);
 }

llvm/trunk/tools/llvm-cov/CoverageSummary.cpp

for (unsigned FileID = 0; FileID < Filenames.size(); ++FileID) {
     FileSummaries.push_back(
         FileCoverageSummary::get(Filenames[FileID], LocalSummaries));
   }
 }
 
 FileCoverageSummary CoverageSummary::getCombinedFileSummaries() {
   size_t NumRegions = 0, CoveredRegions = 0;
   size_t NumLines = 0, NonCodeLines = 0, CoveredLines = 0;
-  size_t NumFunctionsCovered = 0, NumFunctions = 0;
+  size_t NumFunctionsExecuted = 0, NumFunctions = 0;
   for (const auto &File : FileSummaries) {
     NumRegions += File.RegionCoverage.NumRegions;
     CoveredRegions += File.RegionCoverage.Covered;
 
     NumLines += File.LineCoverage.NumLines;
     NonCodeLines += File.LineCoverage.NonCodeLines;
     CoveredLines += File.LineCoverage.Covered;
 
-    NumFunctionsCovered += File.FunctionCoverage.FullyCovered;
+    NumFunctionsExecuted += File.FunctionCoverage.Executed;
     NumFunctions += File.FunctionCoverage.NumFunctions;
   }
   return FileCoverageSummary(
       "TOTAL", RegionCoverageInfo(CoveredRegions, NumRegions),
       LineCoverageInfo(CoveredLines, NonCodeLines, NumLines),
-      FunctionCoverageInfo(NumFunctionsCovered, NumFunctions),
+      FunctionCoverageInfo(NumFunctionsExecuted, NumFunctions),
       None);
 }

llvm/trunk/tools/llvm-cov/CoverageSummaryInfo.h

struct LineCoverageInfo {
 
   double getPercentCovered() const {
     return double(Covered) / double(NumLines - NonCodeLines) * 100.0;
   }
 };
 
 /// \brief Provides information about function coverage for a file.
 struct FunctionCoverageInfo {
-  /// \brief The number of functions that have full
-  /// region coverage.
-  size_t FullyCovered;
+  /// \brief The number of functions that were executed.
+  size_t Executed;
 
   /// \brief The total number of functions in this file.
   size_t NumFunctions;
 
-  FunctionCoverageInfo(size_t FullyCovered, size_t NumFunctions)
-      : FullyCovered(FullyCovered), NumFunctions(NumFunctions) {}
+  FunctionCoverageInfo(size_t Executed, size_t NumFunctions)
+      : Executed(Executed), NumFunctions(NumFunctions) {}
 
-  bool isFullyCovered() const { return FullyCovered == NumFunctions; }
+  bool isFullyCovered() const { return Executed == NumFunctions; }
 
   double getPercentCovered() const {
-    return double(FullyCovered) / double(NumFunctions) * 100.0;
+    return double(Executed) / double(NumFunctions) * 100.0;
   }
 };
 
 /// \brief A summary of function's code coverage.
 struct FunctionCoverageSummary {
   StringRef Name;
+  uint64_t ExecutionCount;
   RegionCoverageInfo RegionCoverage;
   LineCoverageInfo LineCoverage;
 
-  FunctionCoverageSummary(StringRef Name,
+  FunctionCoverageSummary(StringRef Name, uint64_t ExecutionCount,
                           const RegionCoverageInfo &RegionCoverage,
                           const LineCoverageInfo &LineCoverage)
-      : Name(Name), RegionCoverage(RegionCoverage), LineCoverage(LineCoverage) {
+      : Name(Name), ExecutionCount(ExecutionCount),
+        RegionCoverage(RegionCoverage), LineCoverage(LineCoverage) {
   }
 
   /// \brief Compute the code coverage summary for the given function coverage
   /// mapping record.
   static FunctionCoverageSummary
   get(const coverage::FunctionRecord &Function);
 };
 

llvm/trunk/tools/llvm-cov/CoverageSummaryInfo.cpp

for (auto &CR : Function.CountedRegions) {
       for (unsigned I = CR.LineStart; I <= CR.LineEnd; ++I)
         ExecutionCounts[I - LineStart] = ExecutionCount;
     }
     CoveredLines += LineCount - std::count(ExecutionCounts.begin(),
                                            ExecutionCounts.end(), 0);
     NumLines += LineCount;
   }
   return FunctionCoverageSummary(
-      Function.Name, RegionCoverageInfo(CoveredRegions, NumCodeRegions),
+      Function.Name, Function.ExecutionCount,
+      RegionCoverageInfo(CoveredRegions, NumCodeRegions),
       LineCoverageInfo(CoveredLines, 0, NumLines));
 }
 
 FileCoverageSummary
 FileCoverageSummary::get(StringRef Name,
                          ArrayRef<FunctionCoverageSummary> FunctionSummaries) {
   size_t NumRegions = 0, CoveredRegions = 0;
   size_t NumLines = 0, NonCodeLines = 0, CoveredLines = 0;
-  size_t NumFunctionsCovered = 0;
+  size_t NumFunctionsExecuted = 0;
   for (const auto &Func : FunctionSummaries) {
     CoveredRegions += Func.RegionCoverage.Covered;
     NumRegions += Func.RegionCoverage.NumRegions;
 
     CoveredLines += Func.LineCoverage.Covered;
     NonCodeLines += Func.LineCoverage.NonCodeLines;
     NumLines += Func.LineCoverage.NumLines;
 
-    if (Func.RegionCoverage.isFullyCovered())
-      ++NumFunctionsCovered;
+    if (Func.ExecutionCount != 0)
+      ++NumFunctionsExecuted;
   }
 
   return FileCoverageSummary(
       Name, RegionCoverageInfo(CoveredRegions, NumRegions),
       LineCoverageInfo(CoveredLines, NonCodeLines, NumLines),
-      FunctionCoverageInfo(NumFunctionsCovered, FunctionSummaries.size()),
+      FunctionCoverageInfo(NumFunctionsExecuted, FunctionSummaries.size()),
       FunctionSummaries);
 }