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