1 //===- SourceCoverageView.cpp - Code coverage view for source code --------===// 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 /// \file This class implements rendering for code coverage of source code. 11 /// 12 //===----------------------------------------------------------------------===// 13 14 #include "SourceCoverageView.h" 15 #include "SourceCoverageViewHTML.h" 16 #include "SourceCoverageViewText.h" 17 #include "llvm/ADT/SmallString.h" 18 #include "llvm/ADT/StringExtras.h" 19 #include "llvm/Support/FileSystem.h" 20 #include "llvm/Support/LineIterator.h" 21 #include "llvm/Support/Path.h" 22 23 using namespace llvm; 24 25 void CoveragePrinter::StreamDestructor::operator()(raw_ostream *OS) const { 26 if (OS == &outs()) 27 return; 28 delete OS; 29 } 30 31 std::string CoveragePrinter::getOutputPath(StringRef Path, StringRef Extension, 32 bool InToplevel, 33 bool Relative) const { 34 assert(Extension.size() && "The file extension may not be empty"); 35 36 SmallString<256> FullPath; 37 38 if (!Relative) 39 FullPath.append(Opts.ShowOutputDirectory); 40 41 if (!InToplevel) 42 sys::path::append(FullPath, getCoverageDir()); 43 44 SmallString<256> ParentPath = sys::path::parent_path(Path); 45 sys::path::remove_dots(ParentPath, /*remove_dot_dots=*/true); 46 sys::path::append(FullPath, sys::path::relative_path(ParentPath)); 47 48 auto PathFilename = (sys::path::filename(Path) + "." + Extension).str(); 49 sys::path::append(FullPath, PathFilename); 50 sys::path::native(FullPath); 51 52 return FullPath.str(); 53 } 54 55 Expected<CoveragePrinter::OwnedStream> 56 CoveragePrinter::createOutputStream(StringRef Path, StringRef Extension, 57 bool InToplevel) const { 58 if (!Opts.hasOutputDirectory()) 59 return OwnedStream(&outs()); 60 61 std::string FullPath = getOutputPath(Path, Extension, InToplevel, false); 62 63 auto ParentDir = sys::path::parent_path(FullPath); 64 if (auto E = sys::fs::create_directories(ParentDir)) 65 return errorCodeToError(E); 66 67 std::error_code E; 68 raw_ostream *RawStream = new raw_fd_ostream(FullPath, E, sys::fs::F_RW); 69 auto OS = CoveragePrinter::OwnedStream(RawStream); 70 if (E) 71 return errorCodeToError(E); 72 return std::move(OS); 73 } 74 75 std::unique_ptr<CoveragePrinter> 76 CoveragePrinter::create(const CoverageViewOptions &Opts) { 77 switch (Opts.Format) { 78 case CoverageViewOptions::OutputFormat::Text: 79 return llvm::make_unique<CoveragePrinterText>(Opts); 80 case CoverageViewOptions::OutputFormat::HTML: 81 return llvm::make_unique<CoveragePrinterHTML>(Opts); 82 } 83 llvm_unreachable("Unknown coverage output format!"); 84 } 85 86 unsigned SourceCoverageView::getFirstUncoveredLineNo() { 87 const auto MinSegIt = 88 find_if(CoverageInfo, [](const coverage::CoverageSegment &S) { 89 return S.HasCount && S.Count == 0; 90 }); 91 92 // There is no uncovered line, return zero. 93 if (MinSegIt == CoverageInfo.end()) 94 return 0; 95 96 return (*MinSegIt).Line; 97 } 98 99 std::string SourceCoverageView::formatCount(uint64_t N) { 100 std::string Number = utostr(N); 101 int Len = Number.size(); 102 if (Len <= 3) 103 return Number; 104 int IntLen = Len % 3 == 0 ? 3 : Len % 3; 105 std::string Result(Number.data(), IntLen); 106 if (IntLen != 3) { 107 Result.push_back('.'); 108 Result += Number.substr(IntLen, 3 - IntLen); 109 } 110 Result.push_back(" kMGTPEZY"[(Len - 1) / 3]); 111 return Result; 112 } 113 114 bool SourceCoverageView::shouldRenderRegionMarkers( 115 CoverageSegmentArray Segments) const { 116 if (!getOptions().ShowRegionMarkers) 117 return false; 118 119 // Render the region markers if there's more than one count to show. 120 unsigned RegionCount = 0; 121 for (const auto *S : Segments) 122 if (S->IsRegionEntry) 123 if (++RegionCount > 1) 124 return true; 125 return false; 126 } 127 128 bool SourceCoverageView::hasSubViews() const { 129 return !ExpansionSubViews.empty() || !InstantiationSubViews.empty(); 130 } 131 132 std::unique_ptr<SourceCoverageView> 133 SourceCoverageView::create(StringRef SourceName, const MemoryBuffer &File, 134 const CoverageViewOptions &Options, 135 coverage::CoverageData &&CoverageInfo) { 136 switch (Options.Format) { 137 case CoverageViewOptions::OutputFormat::Text: 138 return llvm::make_unique<SourceCoverageViewText>( 139 SourceName, File, Options, std::move(CoverageInfo)); 140 case CoverageViewOptions::OutputFormat::HTML: 141 return llvm::make_unique<SourceCoverageViewHTML>( 142 SourceName, File, Options, std::move(CoverageInfo)); 143 } 144 llvm_unreachable("Unknown coverage output format!"); 145 } 146 147 std::string SourceCoverageView::getSourceName() const { 148 SmallString<128> SourceText(SourceName); 149 sys::path::remove_dots(SourceText, /*remove_dot_dots=*/true); 150 sys::path::native(SourceText); 151 return SourceText.str(); 152 } 153 154 void SourceCoverageView::addExpansion( 155 const coverage::CounterMappingRegion &Region, 156 std::unique_ptr<SourceCoverageView> View) { 157 ExpansionSubViews.emplace_back(Region, std::move(View)); 158 } 159 160 void SourceCoverageView::addInstantiation( 161 StringRef FunctionName, unsigned Line, 162 std::unique_ptr<SourceCoverageView> View) { 163 InstantiationSubViews.emplace_back(FunctionName, Line, std::move(View)); 164 } 165 166 void SourceCoverageView::print(raw_ostream &OS, bool WholeFile, 167 bool ShowSourceName, unsigned ViewDepth) { 168 if (WholeFile && getOptions().hasOutputDirectory()) 169 renderTitle(OS, "Coverage Report"); 170 171 renderViewHeader(OS); 172 173 if (ShowSourceName) 174 renderSourceName(OS, WholeFile); 175 176 renderTableHeader(OS, (ViewDepth > 0) ? 0 : getFirstUncoveredLineNo(), 177 ViewDepth); 178 179 // We need the expansions and instantiations sorted so we can go through them 180 // while we iterate lines. 181 std::sort(ExpansionSubViews.begin(), ExpansionSubViews.end()); 182 std::sort(InstantiationSubViews.begin(), InstantiationSubViews.end()); 183 auto NextESV = ExpansionSubViews.begin(); 184 auto EndESV = ExpansionSubViews.end(); 185 auto NextISV = InstantiationSubViews.begin(); 186 auto EndISV = InstantiationSubViews.end(); 187 188 // Get the coverage information for the file. 189 auto NextSegment = CoverageInfo.begin(); 190 auto EndSegment = CoverageInfo.end(); 191 192 unsigned FirstLine = NextSegment != EndSegment ? NextSegment->Line : 0; 193 const coverage::CoverageSegment *WrappedSegment = nullptr; 194 SmallVector<const coverage::CoverageSegment *, 8> LineSegments; 195 for (line_iterator LI(File, /*SkipBlanks=*/false); !LI.is_at_eof(); ++LI) { 196 // If we aren't rendering the whole file, we need to filter out the prologue 197 // and epilogue. 198 if (!WholeFile) { 199 if (NextSegment == EndSegment) 200 break; 201 else if (LI.line_number() < FirstLine) 202 continue; 203 } 204 205 // Collect the coverage information relevant to this line. 206 if (LineSegments.size()) 207 WrappedSegment = LineSegments.back(); 208 LineSegments.clear(); 209 while (NextSegment != EndSegment && NextSegment->Line == LI.line_number()) 210 LineSegments.push_back(&*NextSegment++); 211 212 renderLinePrefix(OS, ViewDepth); 213 if (getOptions().ShowLineNumbers) 214 renderLineNumberColumn(OS, LI.line_number()); 215 216 LineCoverageStats LineCount{LineSegments, WrappedSegment}; 217 if (getOptions().ShowLineStats) 218 renderLineCoverageColumn(OS, LineCount); 219 220 // If there are expansion subviews, we want to highlight the first one. 221 unsigned ExpansionColumn = 0; 222 if (NextESV != EndESV && NextESV->getLine() == LI.line_number() && 223 getOptions().Colors) 224 ExpansionColumn = NextESV->getStartCol(); 225 226 // Display the source code for the current line. 227 renderLine(OS, {*LI, LI.line_number()}, WrappedSegment, LineSegments, 228 ExpansionColumn, ViewDepth); 229 230 // Show the region markers. 231 if (shouldRenderRegionMarkers(LineSegments)) 232 renderRegionMarkers(OS, LineSegments, ViewDepth); 233 234 // Show the expansions and instantiations for this line. 235 bool RenderedSubView = false; 236 for (; NextESV != EndESV && NextESV->getLine() == LI.line_number(); 237 ++NextESV) { 238 renderViewDivider(OS, ViewDepth + 1); 239 240 // Re-render the current line and highlight the expansion range for 241 // this subview. 242 if (RenderedSubView) { 243 ExpansionColumn = NextESV->getStartCol(); 244 renderExpansionSite(OS, {*LI, LI.line_number()}, WrappedSegment, 245 LineSegments, ExpansionColumn, ViewDepth); 246 renderViewDivider(OS, ViewDepth + 1); 247 } 248 249 renderExpansionView(OS, *NextESV, ViewDepth + 1); 250 RenderedSubView = true; 251 } 252 for (; NextISV != EndISV && NextISV->Line == LI.line_number(); ++NextISV) { 253 renderViewDivider(OS, ViewDepth + 1); 254 renderInstantiationView(OS, *NextISV, ViewDepth + 1); 255 RenderedSubView = true; 256 } 257 if (RenderedSubView) 258 renderViewDivider(OS, ViewDepth + 1); 259 renderLineSuffix(OS, ViewDepth); 260 } 261 262 renderViewFooter(OS); 263 } 264