[llvm-cov] Avoid 0% when reporting something that's 0/0

[arphaman]

Summary

Right now llvm-cov can show 0% (0/0) coverage for things like file function coverage, etc. in reports and HTML output. This can happen for files like headers that have macros but no functions. This patch makes llvm-cov report - (0/0) instead.

Example: “include/clang/AST/BuiltinTypes.def” has 0% (0/0) in http://lab.llvm.org:8080/coverage/coverage-reports/clang/index.html .

[vsk]

Thanks, LGTM.

I'd prefer it if you could check in a proftext file, and create the profdata file during the test. Also, please check that you compiled with -mllvm -enable-name-compression=false when producing the *.covmapping file -- some bots don't have zlib.

[arphaman]

In D26615#594825, @vsk wrote:

Thanks, LGTM.

I'd prefer it if you could check in a proftext file, and create the profdata file during the test.

Sure.

Also, please check that you compiled with -mllvm -enable-name-compression=false when producing the *.covmapping file -- some bots don't have zlib.

Thanks for letting me know, I'll do that.

test/tools/llvm-cov/Inputs/zeroFunctionFile.h

+// This header has no functions
+
+#define NOFUNCTIONS(x) (x) > 0 ? 0 : 1

test/tools/llvm-cov/zeroFunctionFile.c

+#include "test.h"
+
+int foo(int x) {
+  return NOFUNCTIONS(x);
+}
+int main() {
+  return foo(2);
+}
+
+// RUN: llvm-cov report %S/Inputs/zeroFunctionFile.covmapping -instr-profile %S/Inputs/zeroFunctionFile.profdata 2>&1 | FileCheck --check-prefix=REPORT --strict-whitespace %s
+// REPORT: 0                 0         -           0                 0         -               0               0         -           0                 0         -
+// REPORT-NO: 0%
+
+// RUN: llvm-cov show %S/Inputs/zeroFunctionFile.covmapping -format html -instr-profile %S/Inputs/zeroFunctionFile.profdata -o %t.dir
+// RUN: FileCheck %s -input-file=%t.dir/index.html -check-prefix=HTML
+// HTML: <td class='column-entry-green'><pre>- (0/0)
+// HTML-NO: 0.00% (0/0)

tools/llvm-cov/CoverageReport.cpp

void CoverageReport::render(const FileCoverageSummary &File,
   SmallString<256> FileName = File.Name;
   sys::path::remove_dots(FileName, /*remove_dot_dots=*/true);
   sys::path::native(FileName);
   OS << column(FileName, FileReportColumns[0], Column::NoTrim)
      << format("%*u", FileReportColumns[1],
                (unsigned)File.RegionCoverage.NumRegions);
   Options.colored_ostream(OS, FileCoverageColor) << format(
       "%*u", FileReportColumns[2], (unsigned)File.RegionCoverage.NotCovered);
+  if (File.RegionCoverage.NumRegions)
     Options.colored_ostream(OS, FileCoverageColor)
         << format("%*.2f", FileReportColumns[3] - 1,
                   File.RegionCoverage.getPercentCovered())
         << '%';
+  else
+    OS << column("-", FileReportColumns[3], Column::RightAlignment);
   OS << format("%*u", FileReportColumns[4],
                (unsigned)File.FunctionCoverage.NumFunctions);
   OS << format("%*u", FileReportColumns[5],
                (unsigned)(File.FunctionCoverage.NumFunctions -
                           File.FunctionCoverage.Executed));
+  if (File.FunctionCoverage.NumFunctions)
     Options.colored_ostream(OS, FuncCoverageColor)
         << format("%*.2f", FileReportColumns[6] - 1,
                   File.FunctionCoverage.getPercentCovered())
         << '%';
+  else
+    OS << column("-", FileReportColumns[6], Column::RightAlignment);
   OS << format("%*u", FileReportColumns[7],
                (unsigned)File.InstantiationCoverage.NumFunctions);
   OS << format("%*u", FileReportColumns[8],
                (unsigned)(File.InstantiationCoverage.NumFunctions -
                           File.InstantiationCoverage.Executed));
+  if (File.InstantiationCoverage.NumFunctions)
     Options.colored_ostream(OS, InstantiationCoverageColor)
         << format("%*.2f", FileReportColumns[9] - 1,
                   File.InstantiationCoverage.getPercentCovered())
         << '%';
+  else
+    OS << column("-", FileReportColumns[9], Column::RightAlignment);
   OS << format("%*u", FileReportColumns[10],
                (unsigned)File.LineCoverage.NumLines);
   Options.colored_ostream(OS, LineCoverageColor) << format(
       "%*u", FileReportColumns[11], (unsigned)File.LineCoverage.NotCovered);
+  if (File.LineCoverage.NumLines)
     Options.colored_ostream(OS, LineCoverageColor)
         << format("%*.2f", FileReportColumns[12] - 1,
                   File.LineCoverage.getPercentCovered())
         << '%';
+  else
+    OS << column("-", FileReportColumns[12], Column::RightAlignment);
   OS << "\n";
 }
 
 void CoverageReport::render(const FunctionCoverageSummary &Function,
                             raw_ostream &OS) const {
   auto FuncCoverageColor =
       determineCoveragePercentageColor(Function.RegionCoverage);
   auto LineCoverageColor =

tools/llvm-cov/SourceCoverageViewHTML.cpp

void CoveragePrinterHTML::emitFileSummary(raw_ostream &OS, StringRef SF,
   SmallVector<std::string, 8> Columns;
 
   // Format a coverage triple and add the result to the list of columns.
   auto AddCoverageTripleToColumn = [&Columns](unsigned Hit, unsigned Total,
                                               float Pctg) {
     std::string S;
     {
       raw_string_ostream RSO{S};
-      RSO << format("%*.2f", 7, Pctg) << "% (" << Hit << '/' << Total << ')';
+      if (Total)
+        RSO << format("%*.2f", 7, Pctg) << "% ";
+      else
+        RSO << "- ";
+      RSO << '(' << Hit << '/' << Total << ')';
     }
     const char *CellClass = "column-entry-yellow";
-    if (Pctg < 80.0)
-      CellClass = "column-entry-red";
-    else if (Hit == Total)
+    if (Hit == Total)
       CellClass = "column-entry-green";
+    else if (Pctg < 80.0)
+      CellClass = "column-entry-red";
     Columns.emplace_back(tag("td", tag("pre", S), CellClass));
   };
 
   // Simplify the display file path, and wrap it in a link if requested.
   std::string Filename;
   if (IsTotals) {
     Filename = "TOTALS";
   } else {