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_dot=*/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 if (Opts.ShowDirectoryCoverage) 80 return std::make_unique<CoveragePrinterTextDirectory>(Opts); 81 return std::make_unique<CoveragePrinterText>(Opts); 82 case CoverageViewOptions::OutputFormat::HTML: 83 if (Opts.ShowDirectoryCoverage) 84 return std::make_unique<CoveragePrinterHTMLDirectory>(Opts); 85 return std::make_unique<CoveragePrinterHTML>(Opts); 86 case CoverageViewOptions::OutputFormat::Lcov: 87 // Unreachable because CodeCoverage.cpp should terminate with an error 88 // before we get here. 89 llvm_unreachable("Lcov format is not supported!"); 90 } 91 llvm_unreachable("Unknown coverage output format!"); 92 } 93 94 unsigned SourceCoverageView::getFirstUncoveredLineNo() { 95 const auto MinSegIt = find_if(CoverageInfo, [](const CoverageSegment &S) { 96 return S.HasCount && S.Count == 0; 97 }); 98 99 // There is no uncovered line, return zero. 100 if (MinSegIt == CoverageInfo.end()) 101 return 0; 102 103 return (*MinSegIt).Line; 104 } 105 106 std::string SourceCoverageView::formatCount(uint64_t N) { 107 std::string Number = utostr(N); 108 int Len = Number.size(); 109 if (Len <= 3) 110 return Number; 111 int IntLen = Len % 3 == 0 ? 3 : Len % 3; 112 std::string Result(Number.data(), IntLen); 113 if (IntLen != 3) { 114 Result.push_back('.'); 115 Result += Number.substr(IntLen, 3 - IntLen); 116 } 117 Result.push_back(" kMGTPEZY"[(Len - 1) / 3]); 118 return Result; 119 } 120 121 bool SourceCoverageView::shouldRenderRegionMarkers( 122 const LineCoverageStats &LCS) const { 123 if (!getOptions().ShowRegionMarkers) 124 return false; 125 126 CoverageSegmentArray Segments = LCS.getLineSegments(); 127 if (Segments.empty()) 128 return false; 129 for (unsigned I = 0, E = Segments.size() - 1; I < E; ++I) { 130 const auto *CurSeg = Segments[I]; 131 if (!CurSeg->IsRegionEntry || CurSeg->Count == LCS.getExecutionCount()) 132 continue; 133 return true; 134 } 135 return false; 136 } 137 138 bool SourceCoverageView::hasSubViews() const { 139 return !ExpansionSubViews.empty() || !InstantiationSubViews.empty() || 140 !BranchSubViews.empty(); 141 } 142 143 std::unique_ptr<SourceCoverageView> 144 SourceCoverageView::create(StringRef SourceName, const MemoryBuffer &File, 145 const CoverageViewOptions &Options, 146 CoverageData &&CoverageInfo) { 147 switch (Options.Format) { 148 case CoverageViewOptions::OutputFormat::Text: 149 return std::make_unique<SourceCoverageViewText>( 150 SourceName, File, Options, std::move(CoverageInfo)); 151 case CoverageViewOptions::OutputFormat::HTML: 152 return std::make_unique<SourceCoverageViewHTML>( 153 SourceName, File, Options, std::move(CoverageInfo)); 154 case CoverageViewOptions::OutputFormat::Lcov: 155 // Unreachable because CodeCoverage.cpp should terminate with an error 156 // before we get here. 157 llvm_unreachable("Lcov format is not supported!"); 158 } 159 llvm_unreachable("Unknown coverage output format!"); 160 } 161 162 std::string SourceCoverageView::getSourceName() const { 163 SmallString<128> SourceText(SourceName); 164 sys::path::remove_dots(SourceText, /*remove_dot_dot=*/true); 165 sys::path::native(SourceText); 166 return std::string(SourceText.str()); 167 } 168 169 void SourceCoverageView::addExpansion( 170 const CounterMappingRegion &Region, 171 std::unique_ptr<SourceCoverageView> View) { 172 ExpansionSubViews.emplace_back(Region, std::move(View)); 173 } 174 175 void SourceCoverageView::addBranch(unsigned Line, 176 ArrayRef<CountedRegion> Regions, 177 std::unique_ptr<SourceCoverageView> View) { 178 BranchSubViews.emplace_back(Line, Regions, std::move(View)); 179 } 180 181 void SourceCoverageView::addMCDCRecord( 182 unsigned Line, ArrayRef<MCDCRecord> Records, 183 std::unique_ptr<SourceCoverageView> View) { 184 MCDCSubViews.emplace_back(Line, Records, std::move(View)); 185 } 186 187 void SourceCoverageView::addInstantiation( 188 StringRef FunctionName, unsigned Line, 189 std::unique_ptr<SourceCoverageView> View) { 190 InstantiationSubViews.emplace_back(FunctionName, Line, std::move(View)); 191 } 192 193 void SourceCoverageView::print(raw_ostream &OS, bool WholeFile, 194 bool ShowSourceName, bool ShowTitle, 195 unsigned ViewDepth) { 196 if (ShowTitle) 197 renderTitle(OS, "Coverage Report"); 198 199 renderViewHeader(OS); 200 201 if (ShowSourceName) 202 renderSourceName(OS, WholeFile); 203 204 renderTableHeader(OS, (ViewDepth > 0) ? 0 : getFirstUncoveredLineNo(), 205 ViewDepth); 206 207 // We need the expansions, instantiations, and branches sorted so we can go 208 // through them while we iterate lines. 209 llvm::stable_sort(ExpansionSubViews); 210 llvm::stable_sort(InstantiationSubViews); 211 llvm::stable_sort(BranchSubViews); 212 llvm::stable_sort(MCDCSubViews); 213 auto NextESV = ExpansionSubViews.begin(); 214 auto EndESV = ExpansionSubViews.end(); 215 auto NextISV = InstantiationSubViews.begin(); 216 auto EndISV = InstantiationSubViews.end(); 217 auto NextBRV = BranchSubViews.begin(); 218 auto EndBRV = BranchSubViews.end(); 219 auto NextMSV = MCDCSubViews.begin(); 220 auto EndMSV = MCDCSubViews.end(); 221 222 // Get the coverage information for the file. 223 auto StartSegment = CoverageInfo.begin(); 224 auto EndSegment = CoverageInfo.end(); 225 LineCoverageIterator LCI{CoverageInfo, 1}; 226 LineCoverageIterator LCIEnd = LCI.getEnd(); 227 228 unsigned FirstLine = StartSegment != EndSegment ? StartSegment->Line : 0; 229 for (line_iterator LI(File, /*SkipBlanks=*/false); !LI.is_at_eof(); 230 ++LI, ++LCI) { 231 // If we aren't rendering the whole file, we need to filter out the prologue 232 // and epilogue. 233 if (!WholeFile) { 234 if (LCI == LCIEnd) 235 break; 236 else if (LI.line_number() < FirstLine) 237 continue; 238 } 239 240 renderLinePrefix(OS, ViewDepth); 241 if (getOptions().ShowLineNumbers) 242 renderLineNumberColumn(OS, LI.line_number()); 243 244 if (getOptions().ShowLineStats) 245 renderLineCoverageColumn(OS, *LCI); 246 247 // If there are expansion subviews, we want to highlight the first one. 248 unsigned ExpansionColumn = 0; 249 if (NextESV != EndESV && NextESV->getLine() == LI.line_number() && 250 getOptions().Colors) 251 ExpansionColumn = NextESV->getStartCol(); 252 253 // Display the source code for the current line. 254 renderLine(OS, {*LI, LI.line_number()}, *LCI, ExpansionColumn, ViewDepth); 255 256 // Show the region markers. 257 if (shouldRenderRegionMarkers(*LCI)) 258 renderRegionMarkers(OS, *LCI, ViewDepth); 259 260 // Show the expansions, instantiations, and branches for this line. 261 bool RenderedSubView = false; 262 for (; NextESV != EndESV && NextESV->getLine() == LI.line_number(); 263 ++NextESV) { 264 renderViewDivider(OS, ViewDepth + 1); 265 266 // Re-render the current line and highlight the expansion range for 267 // this subview. 268 if (RenderedSubView) { 269 ExpansionColumn = NextESV->getStartCol(); 270 renderExpansionSite(OS, {*LI, LI.line_number()}, *LCI, ExpansionColumn, 271 ViewDepth); 272 renderViewDivider(OS, ViewDepth + 1); 273 } 274 275 renderExpansionView(OS, *NextESV, ViewDepth + 1); 276 RenderedSubView = true; 277 } 278 for (; NextISV != EndISV && NextISV->Line == LI.line_number(); ++NextISV) { 279 renderViewDivider(OS, ViewDepth + 1); 280 renderInstantiationView(OS, *NextISV, ViewDepth + 1); 281 RenderedSubView = true; 282 } 283 for (; NextBRV != EndBRV && NextBRV->Line == LI.line_number(); ++NextBRV) { 284 renderViewDivider(OS, ViewDepth + 1); 285 renderBranchView(OS, *NextBRV, ViewDepth + 1); 286 RenderedSubView = true; 287 } 288 for (; NextMSV != EndMSV && NextMSV->Line == LI.line_number(); ++NextMSV) { 289 renderViewDivider(OS, ViewDepth + 1); 290 renderMCDCView(OS, *NextMSV, ViewDepth + 1); 291 RenderedSubView = true; 292 } 293 if (RenderedSubView) 294 renderViewDivider(OS, ViewDepth + 1); 295 renderLineSuffix(OS, ViewDepth); 296 } 297 298 renderViewFooter(OS); 299 } 300