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

   1 //===- CoverageReport.cpp - Code coverage report -------------------------===//
   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 // This class implements rendering of a code coverage report.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "CoverageReport.h"
  15 #include "RenderingSupport.h"
  16 #include "llvm/ADT/DenseMap.h"
  17 #include "llvm/Support/FileSystem.h"
  18 #include "llvm/Support/Format.h"
  19 #include "llvm/Support/Path.h"
  20 #include <numeric>
  21
  22 using namespace llvm;
  23
  24 namespace {
  25
  26 /// \brief Helper struct which prints trimmed and aligned columns.
  27 struct Column {
  28   enum TrimKind { NoTrim, WidthTrim, RightTrim };
  29
  30   enum AlignmentKind { LeftAlignment, RightAlignment };
  31
  32   StringRef Str;
  33   unsigned Width;
  34   TrimKind Trim;
  35   AlignmentKind Alignment;
  36
  37   Column(StringRef Str, unsigned Width)
  38       : Str(Str), Width(Width), Trim(WidthTrim), Alignment(LeftAlignment) {}
  39
  40   Column &set(TrimKind Value) {
  41     Trim = Value;
  42     return *this;
  43   }
  44
  45   Column &set(AlignmentKind Value) {
  46     Alignment = Value;
  47     return *this;
  48   }
  49
  50   void render(raw_ostream &OS) const {
  51     if (Str.size() <= Width) {
  52       if (Alignment == RightAlignment) {
  53         OS.indent(Width - Str.size());
  54         OS << Str;
  55         return;
  56       }
  57       OS << Str;
  58       OS.indent(Width - Str.size());
  59       return;
  60     }
  61
  62     switch (Trim) {
  63     case NoTrim:
  64       OS << Str;
  65       break;
  66     case WidthTrim:
  67       OS << Str.substr(0, Width);
  68       break;
  69     case RightTrim:
  70       OS << Str.substr(0, Width - 3) << "...";
  71       break;
  72     }
  73   }
  74 };
  75
  76 raw_ostream &operator<<(raw_ostream &OS, const Column &Value) {
  77   Value.render(OS);
  78   return OS;
  79 }
  80
  81 Column column(StringRef Str, unsigned Width) { return Column(Str, Width); }
  82
  83 template <typename T>
  84 Column column(StringRef Str, unsigned Width, const T &Value) {
  85   return Column(Str, Width).set(Value);
  86 }
  87
  88 // Specify the default column widths.
  89 size_t FileReportColumns[] = {25, 12, 18, 10, 12, 18, 10,
  90                               16, 16, 10, 12, 18, 10};
  91 size_t FunctionReportColumns[] = {25, 10, 8, 8, 10, 8, 8};
  92
  93 /// \brief Adjust column widths to fit long file paths and function names.
  94 void adjustColumnWidths(ArrayRef<StringRef> Files,
  95                         ArrayRef<StringRef> Functions) {
  96   for (StringRef Filename : Files)
  97     FileReportColumns[0] = std::max(FileReportColumns[0], Filename.size());
  98   for (StringRef Funcname : Functions)
  99     FunctionReportColumns[0] =
 100         std::max(FunctionReportColumns[0], Funcname.size());
 101 }
 102
 103 /// \brief Prints a horizontal divider long enough to cover the given column
 104 /// widths.
 105 void renderDivider(ArrayRef<size_t> ColumnWidths, raw_ostream &OS) {
 106   size_t Length = std::accumulate(ColumnWidths.begin(), ColumnWidths.end(), 0);
 107   for (size_t I = 0; I < Length; ++I)
 108     OS << '-';
 109 }
 110
 111 /// \brief Return the color which correponds to the coverage percentage of a
 112 /// certain metric.
 113 template <typename T>
 114 raw_ostream::Colors determineCoveragePercentageColor(const T &Info) {
 115   if (Info.isFullyCovered())
 116     return raw_ostream::GREEN;
 117   return Info.getPercentCovered() >= 80.0 ? raw_ostream::YELLOW
 118                                           : raw_ostream::RED;
 119 }
 120
 121 /// \brief Determine the length of the longest common prefix of the strings in
 122 /// \p Strings.
 123 unsigned getLongestCommonPrefixLen(ArrayRef<std::string> Strings) {
 124   unsigned LCP = Strings[0].size();
 125   for (unsigned I = 1, E = Strings.size(); LCP > 0 && I < E; ++I) {
 126     unsigned Cursor;
 127     StringRef S = Strings[I];
 128     for (Cursor = 0; Cursor < LCP && Cursor < S.size(); ++Cursor)
 129       if (Strings[0][Cursor] != S[Cursor])
 130         break;
 131     LCP = std::min(LCP, Cursor);
 132   }
 133   return LCP;
 134 }
 135
 136 } // end anonymous namespace
 137
 138 namespace llvm {
 139
 140 void CoverageReport::render(const FileCoverageSummary &File,
 141                             raw_ostream &OS) const {
 142   auto FileCoverageColor =
 143       determineCoveragePercentageColor(File.RegionCoverage);
 144   auto FuncCoverageColor =
 145       determineCoveragePercentageColor(File.FunctionCoverage);
 146   auto InstantiationCoverageColor =
 147       determineCoveragePercentageColor(File.InstantiationCoverage);
 148   auto LineCoverageColor = determineCoveragePercentageColor(File.LineCoverage);
 149   SmallString<256> FileName = File.Name;
 150   sys::path::remove_dots(FileName, /*remove_dot_dots=*/true);
 151   sys::path::native(FileName);
 152   OS << column(FileName, FileReportColumns[0], Column::NoTrim)
 153      << format("%*u", FileReportColumns[1],
 154                (unsigned)File.RegionCoverage.NumRegions);
 155   Options.colored_ostream(OS, FileCoverageColor) << format(
 156       "%*u", FileReportColumns[2], (unsigned)File.RegionCoverage.NotCovered);
 157   if (File.RegionCoverage.NumRegions)
 158     Options.colored_ostream(OS, FileCoverageColor)
 159         << format("%*.2f", FileReportColumns[3] - 1,
 160                   File.RegionCoverage.getPercentCovered())
 161         << '%';
 162   else
 163     OS << column("-", FileReportColumns[3], Column::RightAlignment);
 164   OS << format("%*u", FileReportColumns[4],
 165                (unsigned)File.FunctionCoverage.NumFunctions);
 166   OS << format("%*u", FileReportColumns[5],
 167                (unsigned)(File.FunctionCoverage.NumFunctions -
 168                           File.FunctionCoverage.Executed));
 169   if (File.FunctionCoverage.NumFunctions)
 170     Options.colored_ostream(OS, FuncCoverageColor)
 171         << format("%*.2f", FileReportColumns[6] - 1,
 172                   File.FunctionCoverage.getPercentCovered())
 173         << '%';
 174   else
 175     OS << column("-", FileReportColumns[6], Column::RightAlignment);
 176   OS << format("%*u", FileReportColumns[7],
 177                (unsigned)File.InstantiationCoverage.NumFunctions);
 178   OS << format("%*u", FileReportColumns[8],
 179                (unsigned)(File.InstantiationCoverage.NumFunctions -
 180                           File.InstantiationCoverage.Executed));
 181   if (File.InstantiationCoverage.NumFunctions)
 182     Options.colored_ostream(OS, InstantiationCoverageColor)
 183         << format("%*.2f", FileReportColumns[9] - 1,
 184                   File.InstantiationCoverage.getPercentCovered())
 185         << '%';
 186   else
 187     OS << column("-", FileReportColumns[9], Column::RightAlignment);
 188   OS << format("%*u", FileReportColumns[10],
 189                (unsigned)File.LineCoverage.NumLines);
 190   Options.colored_ostream(OS, LineCoverageColor) << format(
 191       "%*u", FileReportColumns[11], (unsigned)File.LineCoverage.NotCovered);
 192   if (File.LineCoverage.NumLines)
 193     Options.colored_ostream(OS, LineCoverageColor)
 194         << format("%*.2f", FileReportColumns[12] - 1,
 195                   File.LineCoverage.getPercentCovered())
 196         << '%';
 197   else
 198     OS << column("-", FileReportColumns[12], Column::RightAlignment);
 199   OS << "\n";
 200 }
 201
 202 void CoverageReport::render(const FunctionCoverageSummary &Function,
 203                             raw_ostream &OS) const {
 204   auto FuncCoverageColor =
 205       determineCoveragePercentageColor(Function.RegionCoverage);
 206   auto LineCoverageColor =
 207       determineCoveragePercentageColor(Function.LineCoverage);
 208   OS << column(Function.Name, FunctionReportColumns[0], Column::RightTrim)
 209      << format("%*u", FunctionReportColumns[1],
 210                (unsigned)Function.RegionCoverage.NumRegions);
 211   Options.colored_ostream(OS, FuncCoverageColor)
 212       << format("%*u", FunctionReportColumns[2],
 213                 (unsigned)Function.RegionCoverage.NotCovered);
 214   Options.colored_ostream(
 215       OS, determineCoveragePercentageColor(Function.RegionCoverage))
 216       << format("%*.2f", FunctionReportColumns[3] - 1,
 217                 Function.RegionCoverage.getPercentCovered())
 218       << '%';
 219   OS << format("%*u", FunctionReportColumns[4],
 220                (unsigned)Function.LineCoverage.NumLines);
 221   Options.colored_ostream(OS, LineCoverageColor)
 222       << format("%*u", FunctionReportColumns[5],
 223                 (unsigned)Function.LineCoverage.NotCovered);
 224   Options.colored_ostream(
 225       OS, determineCoveragePercentageColor(Function.LineCoverage))
 226       << format("%*.2f", FunctionReportColumns[6] - 1,
 227                 Function.LineCoverage.getPercentCovered())
 228       << '%';
 229   OS << "\n";
 230 }
 231
 232 void CoverageReport::renderFunctionReports(ArrayRef<std::string> Files,
 233                                            raw_ostream &OS) {
 234   bool isFirst = true;
 235   for (StringRef Filename : Files) {
 236     auto Functions = Coverage.getCoveredFunctions(Filename);
 237
 238     if (isFirst)
 239       isFirst = false;
 240     else
 241       OS << "\n";
 242
 243     std::vector<StringRef> Funcnames;
 244     for (const auto &F : Functions)
 245       Funcnames.emplace_back(F.Name);
 246     adjustColumnWidths({}, Funcnames);
 247
 248     OS << "File '" << Filename << "':\n";
 249     OS << column("Name", FunctionReportColumns[0])
 250        << column("Regions", FunctionReportColumns[1], Column::RightAlignment)
 251        << column("Miss", FunctionReportColumns[2], Column::RightAlignment)
 252        << column("Cover", FunctionReportColumns[3], Column::RightAlignment)
 253        << column("Lines", FunctionReportColumns[4], Column::RightAlignment)
 254        << column("Miss", FunctionReportColumns[5], Column::RightAlignment)
 255        << column("Cover", FunctionReportColumns[6], Column::RightAlignment);
 256     OS << "\n";
 257     renderDivider(FunctionReportColumns, OS);
 258     OS << "\n";
 259     FunctionCoverageSummary Totals("TOTAL");
 260     for (const auto &F : Functions) {
 261       FunctionCoverageSummary Function = FunctionCoverageSummary::get(F);
 262       ++Totals.ExecutionCount;
 263       Totals.RegionCoverage += Function.RegionCoverage;
 264       Totals.LineCoverage += Function.LineCoverage;
 265       render(Function, OS);
 266     }
 267     if (Totals.ExecutionCount) {
 268       renderDivider(FunctionReportColumns, OS);
 269       OS << "\n";
 270       render(Totals, OS);
 271     }
 272   }
 273 }
 274
 275 std::vector<FileCoverageSummary>
 276 CoverageReport::prepareFileReports(const coverage::CoverageMapping &Coverage,
 277                                    FileCoverageSummary &Totals,
 278                                    ArrayRef<std::string> Files) {
 279   std::vector<FileCoverageSummary> FileReports;
 280   unsigned LCP = 0;
 281   if (Files.size() > 1)
 282     LCP = getLongestCommonPrefixLen(Files);
 283
 284   for (StringRef Filename : Files) {
 285     FileCoverageSummary Summary(Filename.drop_front(LCP));
 286
 287     // Map source locations to aggregate function coverage summaries.
 288     DenseMap<std::pair<unsigned, unsigned>, FunctionCoverageSummary> Summaries;
 289
 290     for (const auto &F : Coverage.getCoveredFunctions(Filename)) {
 291       FunctionCoverageSummary Function = FunctionCoverageSummary::get(F);
 292       auto StartLoc = F.CountedRegions[0].startLoc();
 293
 294       auto UniquedSummary = Summaries.insert({StartLoc, Function});
 295       if (!UniquedSummary.second)
 296         UniquedSummary.first->second.update(Function);
 297
 298       Summary.addInstantiation(Function);
 299       Totals.addInstantiation(Function);
 300     }
 301
 302     for (const auto &UniquedSummary : Summaries) {
 303       const FunctionCoverageSummary &FCS = UniquedSummary.second;
 304       Summary.addFunction(FCS);
 305       Totals.addFunction(FCS);
 306     }
 307
 308     FileReports.push_back(Summary);
 309   }
 310
 311   return FileReports;
 312 }
 313
 314 void CoverageReport::renderFileReports(raw_ostream &OS) const {
 315   std::vector<std::string> UniqueSourceFiles;
 316   for (StringRef SF : Coverage.getUniqueSourceFiles())
 317     UniqueSourceFiles.emplace_back(SF.str());
 318   renderFileReports(OS, UniqueSourceFiles);
 319 }
 320
 321 void CoverageReport::renderFileReports(raw_ostream &OS,
 322                                        ArrayRef<std::string> Files) const {
 323   FileCoverageSummary Totals("TOTAL");
 324   auto FileReports = prepareFileReports(Coverage, Totals, Files);
 325
 326   std::vector<StringRef> Filenames;
 327   for (const FileCoverageSummary &FCS : FileReports)
 328     Filenames.emplace_back(FCS.Name);
 329   adjustColumnWidths(Filenames, {});
 330
 331   OS << column("Filename", FileReportColumns[0])
 332      << column("Regions", FileReportColumns[1], Column::RightAlignment)
 333      << column("Missed Regions", FileReportColumns[2], Column::RightAlignment)
 334      << column("Cover", FileReportColumns[3], Column::RightAlignment)
 335      << column("Functions", FileReportColumns[4], Column::RightAlignment)
 336      << column("Missed Functions", FileReportColumns[5], Column::RightAlignment)
 337      << column("Executed", FileReportColumns[6], Column::RightAlignment)
 338      << column("Instantiations", FileReportColumns[7], Column::RightAlignment)
 339      << column("Missed Insts.", FileReportColumns[8], Column::RightAlignment)
 340      << column("Executed", FileReportColumns[9], Column::RightAlignment)
 341      << column("Lines", FileReportColumns[10], Column::RightAlignment)
 342      << column("Missed Lines", FileReportColumns[11], Column::RightAlignment)
 343      << column("Cover", FileReportColumns[12], Column::RightAlignment) << "\n";
 344   renderDivider(FileReportColumns, OS);
 345   OS << "\n";
 346
 347   for (const FileCoverageSummary &FCS : FileReports)
 348     render(FCS, OS);
 349
 350   renderDivider(FileReportColumns, OS);
 351   OS << "\n";
 352   render(Totals, OS);
 353 }
 354
 355 } // end namespace llvm