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 LineCoverageStats::LineCoverageStats( 87 ArrayRef<const coverage::CoverageSegment *> LineSegments, 88 const coverage::CoverageSegment *WrappedSegment) { 89 // Find the minimum number of regions which start in this line. 90 unsigned MinRegionCount = 0; 91 auto isStartOfRegion = [](const coverage::CoverageSegment *S) { 92 return S->HasCount && S->IsRegionEntry; 93 }; 94 for (unsigned I = 0; I < LineSegments.size() && MinRegionCount < 2; ++I) 95 if (isStartOfRegion(LineSegments[I])) 96 ++MinRegionCount; 97 98 bool StartOfSkippedRegion = !LineSegments.empty() && 99 !LineSegments.front()->HasCount && 100 LineSegments.front()->IsRegionEntry; 101 102 ExecutionCount = 0; 103 HasMultipleRegions = MinRegionCount > 1; 104 Mapped = 105 !StartOfSkippedRegion && 106 ((WrappedSegment && WrappedSegment->HasCount) || (MinRegionCount > 0)); 107 108 if (!Mapped) 109 return; 110 111 // Pick the max count among regions which start and end on this line, to 112 // avoid erroneously using the wrapped count, and to avoid picking region 113 // counts which come from deferred regions. 114 if (LineSegments.size() > 1) { 115 for (unsigned I = 0; I < LineSegments.size() - 1; ++I) 116 ExecutionCount = std::max(ExecutionCount, LineSegments[I]->Count); 117 return; 118 } 119 120 // Just pick the maximum count. 121 if (WrappedSegment && WrappedSegment->HasCount) 122 ExecutionCount = WrappedSegment->Count; 123 if (!LineSegments.empty()) 124 ExecutionCount = std::max(ExecutionCount, LineSegments[0]->Count); 125 } 126 127 unsigned SourceCoverageView::getFirstUncoveredLineNo() { 128 auto CheckIfUncovered = [](const coverage::CoverageSegment &S) { 129 return S.HasCount && S.Count == 0; 130 }; 131 // L is less than R if (1) it's an uncovered segment (has a 0 count), and (2) 132 // either R is not an uncovered segment, or L has a lower line number than R. 133 const auto MinSegIt = 134 std::min_element(CoverageInfo.begin(), CoverageInfo.end(), 135 [CheckIfUncovered](const coverage::CoverageSegment &L, 136 const coverage::CoverageSegment &R) { 137 return (CheckIfUncovered(L) && 138 (!CheckIfUncovered(R) || (L.Line < R.Line))); 139 }); 140 if (CheckIfUncovered(*MinSegIt)) 141 return (*MinSegIt).Line; 142 // There is no uncovered line, return zero. 143 return 0; 144 } 145 146 std::string SourceCoverageView::formatCount(uint64_t N) { 147 std::string Number = utostr(N); 148 int Len = Number.size(); 149 if (Len <= 3) 150 return Number; 151 int IntLen = Len % 3 == 0 ? 3 : Len % 3; 152 std::string Result(Number.data(), IntLen); 153 if (IntLen != 3) { 154 Result.push_back('.'); 155 Result += Number.substr(IntLen, 3 - IntLen); 156 } 157 Result.push_back(" kMGTPEZY"[(Len - 1) / 3]); 158 return Result; 159 } 160 161 bool SourceCoverageView::shouldRenderRegionMarkers( 162 CoverageSegmentArray Segments) const { 163 if (!getOptions().ShowRegionMarkers) 164 return false; 165 166 // Render the region markers if there's more than one count to show. 167 unsigned RegionCount = 0; 168 for (const auto *S : Segments) 169 if (S->IsRegionEntry) 170 if (++RegionCount > 1) 171 return true; 172 return false; 173 } 174 175 bool SourceCoverageView::hasSubViews() const { 176 return !ExpansionSubViews.empty() || !InstantiationSubViews.empty(); 177 } 178 179 std::unique_ptr<SourceCoverageView> 180 SourceCoverageView::create(StringRef SourceName, const MemoryBuffer &File, 181 const CoverageViewOptions &Options, 182 coverage::CoverageData &&CoverageInfo) { 183 switch (Options.Format) { 184 case CoverageViewOptions::OutputFormat::Text: 185 return llvm::make_unique<SourceCoverageViewText>( 186 SourceName, File, Options, std::move(CoverageInfo)); 187 case CoverageViewOptions::OutputFormat::HTML: 188 return llvm::make_unique<SourceCoverageViewHTML>( 189 SourceName, File, Options, std::move(CoverageInfo)); 190 } 191 llvm_unreachable("Unknown coverage output format!"); 192 } 193 194 std::string SourceCoverageView::getSourceName() const { 195 SmallString<128> SourceText(SourceName); 196 sys::path::remove_dots(SourceText, /*remove_dot_dots=*/true); 197 sys::path::native(SourceText); 198 return SourceText.str(); 199 } 200 201 void SourceCoverageView::addExpansion( 202 const coverage::CounterMappingRegion &Region, 203 std::unique_ptr<SourceCoverageView> View) { 204 ExpansionSubViews.emplace_back(Region, std::move(View)); 205 } 206 207 void SourceCoverageView::addInstantiation( 208 StringRef FunctionName, unsigned Line, 209 std::unique_ptr<SourceCoverageView> View) { 210 InstantiationSubViews.emplace_back(FunctionName, Line, std::move(View)); 211 } 212 213 void SourceCoverageView::print(raw_ostream &OS, bool WholeFile, 214 bool ShowSourceName, unsigned ViewDepth) { 215 if (WholeFile && getOptions().hasOutputDirectory()) 216 renderTitle(OS, "Coverage Report"); 217 218 renderViewHeader(OS); 219 220 if (ShowSourceName) 221 renderSourceName(OS, WholeFile); 222 223 renderTableHeader(OS, (ViewDepth > 0) ? 0 : getFirstUncoveredLineNo(), 224 ViewDepth); 225 226 // We need the expansions and instantiations sorted so we can go through them 227 // while we iterate lines. 228 std::sort(ExpansionSubViews.begin(), ExpansionSubViews.end()); 229 std::sort(InstantiationSubViews.begin(), InstantiationSubViews.end()); 230 auto NextESV = ExpansionSubViews.begin(); 231 auto EndESV = ExpansionSubViews.end(); 232 auto NextISV = InstantiationSubViews.begin(); 233 auto EndISV = InstantiationSubViews.end(); 234 235 // Get the coverage information for the file. 236 auto NextSegment = CoverageInfo.begin(); 237 auto EndSegment = CoverageInfo.end(); 238 239 unsigned FirstLine = NextSegment != EndSegment ? NextSegment->Line : 0; 240 const coverage::CoverageSegment *WrappedSegment = nullptr; 241 SmallVector<const coverage::CoverageSegment *, 8> LineSegments; 242 for (line_iterator LI(File, /*SkipBlanks=*/false); !LI.is_at_eof(); ++LI) { 243 // If we aren't rendering the whole file, we need to filter out the prologue 244 // and epilogue. 245 if (!WholeFile) { 246 if (NextSegment == EndSegment) 247 break; 248 else if (LI.line_number() < FirstLine) 249 continue; 250 } 251 252 // Collect the coverage information relevant to this line. 253 if (LineSegments.size()) 254 WrappedSegment = LineSegments.back(); 255 LineSegments.clear(); 256 while (NextSegment != EndSegment && NextSegment->Line == LI.line_number()) 257 LineSegments.push_back(&*NextSegment++); 258 259 renderLinePrefix(OS, ViewDepth); 260 if (getOptions().ShowLineNumbers) 261 renderLineNumberColumn(OS, LI.line_number()); 262 263 LineCoverageStats LineCount{LineSegments, WrappedSegment}; 264 if (getOptions().ShowLineStats) 265 renderLineCoverageColumn(OS, LineCount); 266 267 // If there are expansion subviews, we want to highlight the first one. 268 unsigned ExpansionColumn = 0; 269 if (NextESV != EndESV && NextESV->getLine() == LI.line_number() && 270 getOptions().Colors) 271 ExpansionColumn = NextESV->getStartCol(); 272 273 // Display the source code for the current line. 274 renderLine(OS, {*LI, LI.line_number()}, WrappedSegment, LineSegments, 275 ExpansionColumn, ViewDepth); 276 277 // Show the region markers. 278 if (shouldRenderRegionMarkers(LineSegments)) 279 renderRegionMarkers(OS, LineSegments, ViewDepth); 280 281 // Show the expansions and instantiations for this line. 282 bool RenderedSubView = false; 283 for (; NextESV != EndESV && NextESV->getLine() == LI.line_number(); 284 ++NextESV) { 285 renderViewDivider(OS, ViewDepth + 1); 286 287 // Re-render the current line and highlight the expansion range for 288 // this subview. 289 if (RenderedSubView) { 290 ExpansionColumn = NextESV->getStartCol(); 291 renderExpansionSite(OS, {*LI, LI.line_number()}, WrappedSegment, 292 LineSegments, ExpansionColumn, ViewDepth); 293 renderViewDivider(OS, ViewDepth + 1); 294 } 295 296 renderExpansionView(OS, *NextESV, ViewDepth + 1); 297 RenderedSubView = true; 298 } 299 for (; NextISV != EndISV && NextISV->Line == LI.line_number(); ++NextISV) { 300 renderViewDivider(OS, ViewDepth + 1); 301 renderInstantiationView(OS, *NextISV, ViewDepth + 1); 302 RenderedSubView = true; 303 } 304 if (RenderedSubView) 305 renderViewDivider(OS, ViewDepth + 1); 306 renderLineSuffix(OS, ViewDepth); 307 } 308 309 renderViewFooter(OS); 310 } 311