[LLVM-COV] Add the coverage of lines in the summary report.

[MaggieYi]

Summary

The llvm-cov ‘report' command displays a summary of the coverage of a binary file.
The summary report currently only includes covered regions and covered functions as shown below:

Filename Regions Miss Cover Functions Executed
I:\test\test.cpp 12 2 83.33% 3 100.00%
TOTAL 12 2 83.33% 3 100.00%

This patch adds the coverage of lines in the summary report, for example:

Filename Regions Miss Cover Functions Miss Executed Lines Miss Cover
I:\test\test.cpp 12 2 83.33% 3 0 100.00% 26 2 92.31%
TOTAL 12 2 83.33% 3 0 100.00% 26 2 92.31%

[vsk]

Nice! This looks really close.

Apart from the nits I mentioned, please update the test in test/tools/llvm-cov/prevent_false_instantiations.h. It currently checks for:

NAN-NOT: 0{{[ \t]+}}nan%{{[ \t]+}}0{{[ \t]+}}nan%

But with the extra columns you added, it should be relaxed to:

NAN-NOT: {{[ \t]+}}nan%

test/tools/llvm-cov/report.cpp

4

Could you rename the three "Miss" columns to {"Missed Regions", "Missed Functions", "Missed Lines"}? I think that would make the report less confusing.

tools/llvm-cov/CoverageReport.cpp

91

The comment here doesn't exactly match the source. I'd prefer something more general, e.g: "Specify the default column widths."

[MaggieYi]

Thanks Vedant. I have updated the patch following your comments.

[MaggieYi]

The test in test/tools/llvm-cov/prevent_false_instantiations.h has been updated.

test/tools/llvm-cov/report.cpp

4

I have renamed the three ‘Miss’ heading to follow your advice. I have changed the default column widths to:

static size_t FileReportColumns[] = {25, 12, 18, 10, 12, 18, 10, 12, 18, 10};

These new ‘Miss’ columns widths are larger than the other columns. I think the report looks less nice, what do you think?

tools/llvm-cov/CoverageReport.cpp

91–93

Yes, I have done it.

[vsk]

LGTM.

test/tools/llvm-cov/report.cpp

4

IMO the report would look nicer with separators between the column names (e.g: "Filename | Regions | ... | Cover") . We can do that in a follow-up patch. I don't think re-using column names is the right answer.

test/tools/llvm-cov/report.cpp

 // RUN: llvm-cov report %S/Inputs/report.covmapping -instr-profile %S/Inputs/report.profdata -filename-equivalence 2>&1 | FileCheck %s
 // RUN: llvm-cov report %S/Inputs/report.covmapping -instr-profile %S/Inputs/report.profdata -filename-equivalence report.cpp 2>&1 | FileCheck -check-prefix=FILT-NEXT %s
 
-// CHECK:      Filename   Regions  Miss   Cover  Functions  Executed
+// CHECK:      Filename   Regions  Miss   Cover  Functions  Miss   Executed   Lines    Miss   Cover
 // CHECK-NEXT: ---
-// CHECK-NEXT: report.cpp       5     2  60.00%          4    75.00%
+// CHECK-NEXT: report.cpp       5     2  60.00%          4     1     75.00%       13      4   69.23%
 // CHECK-NEXT: ---
-// CHECK-NEXT: TOTAL            5     2  60.00%          4    75.00%
+// CHECK-NEXT: TOTAL            5     2  60.00%          4     1     75.00%       13      4   69.23%
 
 // FILT: File 'report.cpp':
 // FILT-NEXT: Name        Regions  Miss   Cover  Lines  Miss   Cover
 // FILT-NEXT: ---
 // FILT-NEXT: _Z3foob           2     1  50.00%      4     2  50.00%
 // FILT-NEXT: _Z3barv           1     0 100.00%      2     0 100.00%
 // FILT-NEXT: _Z4funcv          1     1   0.00%      2     2   0.00%
 // FILT-NEXT: main              1     0 100.00%      5     0 100.00%

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 size_t FileReportColumns[] = {25, 10, 8, 8, 10, 10};
+// Add the column widths for line coverage.
+static size_t FileReportColumns[] = {25, 10, 8, 8, 10, 8, 10, 10, 8, 8};
 static size_t FunctionReportColumns[] = {25, 10, 8, 8, 10, 8, 8};
 
 /// \brief  Adjust column widths to fit long file paths and function names.
 static void adjustColumnWidths(coverage::CoverageMapping *CM) {
   for (StringRef Filename : CM->getUniqueSourceFiles()) {
     FileReportColumns[0] = std::max(FileReportColumns[0], Filename.size());
     for (const auto &F : CM->getCoveredFunctions(Filename)) {
       FunctionReportColumns[0] =
           std::max(FunctionReportColumns[0], F.Name.size());
Options.colored_ostream(OS, File.RegionCoverage.isFullyCovered()
                                   : raw_ostream::RED)
       << format("%*u", FileReportColumns[2], (unsigned)File.RegionCoverage.NotCovered);
   Options.colored_ostream(OS,
                           determineCoveragePercentageColor(File.RegionCoverage))
       << format("%*.2f", FileReportColumns[3] - 1,
                 File.RegionCoverage.getPercentCovered()) << '%';
   OS << format("%*u", FileReportColumns[4],
                (unsigned)File.FunctionCoverage.NumFunctions);
+  OS << format("%*u", FileReportColumns[5],
+               (unsigned)(File.FunctionCoverage.NumFunctions -
+                          File.FunctionCoverage.Executed));
   Options.colored_ostream(
       OS, determineCoveragePercentageColor(File.FunctionCoverage))
-      << format("%*.2f", FileReportColumns[5] - 1,
+      << format("%*.2f", FileReportColumns[6] - 1,
                 File.FunctionCoverage.getPercentCovered()) << '%';
+  OS << format("%*u", FileReportColumns[7],
+               (unsigned)File.LineCoverage.NumLines);
+  Options.colored_ostream(OS, File.LineCoverage.isFullyCovered()
+                                  ? raw_ostream::GREEN
+                                  : raw_ostream::RED)
+      << format("%*u", FileReportColumns[8],
+                (unsigned)File.LineCoverage.NotCovered);
+  Options.colored_ostream(OS,
+                          determineCoveragePercentageColor(File.LineCoverage))
+      << format("%*.2f", FileReportColumns[9] - 1,
+                File.LineCoverage.getPercentCovered()) << '%';
   OS << "\n";
 }
 
 void CoverageReport::render(const FunctionCoverageSummary &Function,
                             raw_ostream &OS) {
   OS << column(Function.Name, FunctionReportColumns[0], Column::RightTrim)
      << format("%*u", FunctionReportColumns[1],
                (unsigned)Function.RegionCoverage.NumRegions);

 
 void CoverageReport::renderFileReports(raw_ostream &OS) {
   adjustColumnWidths(Coverage.get());
   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("Executed", FileReportColumns[5], Column::RightAlignment)
+     << column("Miss", FileReportColumns[5],
+               Column::RightAlignment)
+     << column("Executed", FileReportColumns[6], Column::RightAlignment)
+     << column("Lines", FileReportColumns[7], Column::RightAlignment)
+     << column("Miss", FileReportColumns[8], Column::RightAlignment)
+     << column("Cover", FileReportColumns[9], Column::RightAlignment)
      << "\n";
   renderDivider(FileReportColumns, OS);
   OS << "\n";
 
   FileCoverageSummary Totals("TOTAL");
   for (StringRef Filename : Coverage->getUniqueSourceFiles()) {
     FileCoverageSummary Summary(Filename);
     for (const auto &F : Coverage->getCoveredFunctions(Filename)) {