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