1 //===- SourceCoverageView.cpp - Code coverage view for source code --------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 /// 9 /// \file This class implements rendering for code coverage of source code. 10 /// 11 //===----------------------------------------------------------------------===// 12 13 #include "SourceCoverageView.h" 14 #include "SourceCoverageViewHTML.h" 15 #include "SourceCoverageViewText.h" 16 #include "llvm/ADT/SmallString.h" 17 #include "llvm/ADT/StringExtras.h" 18 #include "llvm/Support/FileSystem.h" 19 #include "llvm/Support/LineIterator.h" 20 #include "llvm/Support/Path.h" 21 22 using namespace llvm; 23 24 void CoveragePrinter::StreamDestructor::operator()(raw_ostream *OS) const { 25 if (OS == &outs()) 26 return; 27 delete OS; 28 } 29 30 std::string CoveragePrinter::getOutputPath(StringRef Path, StringRef Extension, 31 bool InToplevel, 32 bool Relative) const { 33 assert(!Extension.empty() && "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 std::string(FullPath.str()); 52 } 53 54 Expected<CoveragePrinter::OwnedStream> 55 CoveragePrinter::createOutputStream(StringRef Path, StringRef Extension, 56 bool InToplevel) const { 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 = 68 new raw_fd_ostream(FullPath, E, sys::fs::FA_Read | sys::fs::FA_Write); 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 std::make_unique<CoveragePrinterText>(Opts); 80 case CoverageViewOptions::OutputFormat::HTML: 81 return std::make_unique<CoveragePrinterHTML>(Opts); 82 case CoverageViewOptions::OutputFormat::Lcov: 83 // Unreachable because CodeCoverage.cpp should terminate with an error 84 // before we get here. 85 llvm_unreachable("Lcov format is not supported!"); 86 } 87 llvm_unreachable("Unknown coverage output format!"); 88 } 89 90 unsigned SourceCoverageView::getFirstUncoveredLineNo() { 91 const auto MinSegIt = find_if(CoverageInfo, [](const CoverageSegment &S) { 92 return S.HasCount && S.Count == 0; 93 }); 94 95 // There is no uncovered line, return zero. 96 if (MinSegIt == CoverageInfo.end()) 97 return 0; 98 99 return (*MinSegIt).Line; 100 } 101 102 std::string SourceCoverageView::formatCount(uint64_t N) { 103 std::string Number = utostr(N); 104 int Len = Number.size(); 105 if (Len <= 3) 106 return Number; 107 int IntLen = Len % 3 == 0 ? 3 : Len % 3; 108 std::string Result(Number.data(), IntLen); 109 if (IntLen != 3) { 110 Result.push_back('.'); 111 Result += Number.substr(IntLen, 3 - IntLen); 112 } 113 Result.push_back(" kMGTPEZY"[(Len - 1) / 3]); 114 return Result; 115 } 116 117 bool SourceCoverageView::shouldRenderRegionMarkers( 118 const LineCoverageStats &LCS) const { 119 if (!getOptions().ShowRegionMarkers) 120 return false; 121 122 CoverageSegmentArray Segments = LCS.getLineSegments(); 123 if (Segments.empty()) 124 return false; 125 for (unsigned I = 0, E = Segments.size() - 1; I < E; ++I) { 126 const auto *CurSeg = Segments[I]; 127 if (!CurSeg->IsRegionEntry || CurSeg->Count == LCS.getExecutionCount()) 128 continue; 129 return true; 130 } 131 return false; 132 } 133 134 bool SourceCoverageView::hasSubViews() const { 135 return !ExpansionSubViews.empty() || !InstantiationSubViews.empty() || 136 !BranchSubViews.empty(); 137 } 138 139 std::unique_ptr<SourceCoverageView> 140 SourceCoverageView::create(StringRef SourceName, const MemoryBuffer &File, 141 const CoverageViewOptions &Options, 142 CoverageData &&CoverageInfo) { 143 switch (Options.Format) { 144 case CoverageViewOptions::OutputFormat::Text: 145 return std::make_unique<SourceCoverageViewText>( 146 SourceName, File, Options, std::move(CoverageInfo)); 147 case CoverageViewOptions::OutputFormat::HTML: 148 return std::make_unique<SourceCoverageViewHTML>( 149 SourceName, File, Options, std::move(CoverageInfo)); 150 case CoverageViewOptions::OutputFormat::Lcov: 151 // Unreachable because CodeCoverage.cpp should terminate with an error 152 // before we get here. 153 llvm_unreachable("Lcov format is not supported!"); 154 } 155 llvm_unreachable("Unknown coverage output format!"); 156 } 157 158 std::string SourceCoverageView::getSourceName() const { 159 SmallString<128> SourceText(SourceName); 160 sys::path::remove_dots(SourceText, /*remove_dot_dots=*/true); 161 sys::path::native(SourceText); 162 return std::string(SourceText.str()); 163 } 164 165 void SourceCoverageView::addExpansion( 166 const CounterMappingRegion &Region, 167 std::unique_ptr<SourceCoverageView> View) { 168 ExpansionSubViews.emplace_back(Region, std::move(View)); 169 } 170 171 void SourceCoverageView::addBranch(unsigned Line, 172 ArrayRef<CountedRegion> Regions, 173 std::unique_ptr<SourceCoverageView> View) { 174 BranchSubViews.emplace_back(Line, Regions, std::move(View)); 175 } 176 177 void SourceCoverageView::addInstantiation( 178 StringRef FunctionName, unsigned Line, 179 std::unique_ptr<SourceCoverageView> View) { 180 InstantiationSubViews.emplace_back(FunctionName, Line, std::move(View)); 181 } 182 183 void SourceCoverageView::print(raw_ostream &OS, bool WholeFile, 184 bool ShowSourceName, bool ShowTitle, 185 unsigned ViewDepth) { 186 if (ShowTitle) 187 renderTitle(OS, "Coverage Report"); 188 189 renderViewHeader(OS); 190 191 if (ShowSourceName) 192 renderSourceName(OS, WholeFile); 193 194 renderTableHeader(OS, (ViewDepth > 0) ? 0 : getFirstUncoveredLineNo(), 195 ViewDepth); 196 197 // We need the expansions, instantiations, and branches sorted so we can go 198 // through them while we iterate lines. 199 llvm::stable_sort(ExpansionSubViews); 200 llvm::stable_sort(InstantiationSubViews); 201 llvm::stable_sort(BranchSubViews); 202 auto NextESV = ExpansionSubViews.begin(); 203 auto EndESV = ExpansionSubViews.end(); 204 auto NextISV = InstantiationSubViews.begin(); 205 auto EndISV = InstantiationSubViews.end(); 206 auto NextBRV = BranchSubViews.begin(); 207 auto EndBRV = BranchSubViews.end(); 208 209 // Get the coverage information for the file. 210 auto StartSegment = CoverageInfo.begin(); 211 auto EndSegment = CoverageInfo.end(); 212 LineCoverageIterator LCI{CoverageInfo, 1}; 213 LineCoverageIterator LCIEnd = LCI.getEnd(); 214 215 unsigned FirstLine = StartSegment != EndSegment ? StartSegment->Line : 0; 216 for (line_iterator LI(File, /*SkipBlanks=*/false); !LI.is_at_eof(); 217 ++LI, ++LCI) { 218 // If we aren't rendering the whole file, we need to filter out the prologue 219 // and epilogue. 220 if (!WholeFile) { 221 if (LCI == LCIEnd) 222 break; 223 else if (LI.line_number() < FirstLine) 224 continue; 225 } 226 227 renderLinePrefix(OS, ViewDepth); 228 if (getOptions().ShowLineNumbers) 229 renderLineNumberColumn(OS, LI.line_number()); 230 231 if (getOptions().ShowLineStats) 232 renderLineCoverageColumn(OS, *LCI); 233 234 // If there are expansion subviews, we want to highlight the first one. 235 unsigned ExpansionColumn = 0; 236 if (NextESV != EndESV && NextESV->getLine() == LI.line_number() && 237 getOptions().Colors) 238 ExpansionColumn = NextESV->getStartCol(); 239 240 // Display the source code for the current line. 241 renderLine(OS, {*LI, LI.line_number()}, *LCI, ExpansionColumn, ViewDepth); 242 243 // Show the region markers. 244 if (shouldRenderRegionMarkers(*LCI)) 245 renderRegionMarkers(OS, *LCI, ViewDepth); 246 247 // Show the expansions, instantiations, and branches for this line. 248 bool RenderedSubView = false; 249 for (; NextESV != EndESV && NextESV->getLine() == LI.line_number(); 250 ++NextESV) { 251 renderViewDivider(OS, ViewDepth + 1); 252 253 // Re-render the current line and highlight the expansion range for 254 // this subview. 255 if (RenderedSubView) { 256 ExpansionColumn = NextESV->getStartCol(); 257 renderExpansionSite(OS, {*LI, LI.line_number()}, *LCI, ExpansionColumn, 258 ViewDepth); 259 renderViewDivider(OS, ViewDepth + 1); 260 } 261 262 renderExpansionView(OS, *NextESV, ViewDepth + 1); 263 RenderedSubView = true; 264 } 265 for (; NextISV != EndISV && NextISV->Line == LI.line_number(); ++NextISV) { 266 renderViewDivider(OS, ViewDepth + 1); 267 renderInstantiationView(OS, *NextISV, ViewDepth + 1); 268 RenderedSubView = true; 269 } 270 for (; NextBRV != EndBRV && NextBRV->Line == LI.line_number(); ++NextBRV) { 271 renderViewDivider(OS, ViewDepth + 1); 272 renderBranchView(OS, *NextBRV, ViewDepth + 1); 273 RenderedSubView = true; 274 } 275 if (RenderedSubView) 276 renderViewDivider(OS, ViewDepth + 1); 277 renderLineSuffix(OS, ViewDepth); 278 } 279 280 renderViewFooter(OS); 281 } 282