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
22using namespace llvm;
23
24void CoveragePrinter::StreamDestructor::operator()(raw_ostream *OS) const {
25 if (OS == &outs())
26 return;
27 delete OS;
28}
29
30std::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(RHS: Opts.ShowOutputDirectory);
39
40 if (!InToplevel)
41 sys::path::append(path&: FullPath, a: getCoverageDir());
42
43 SmallString<256> ParentPath = sys::path::parent_path(path: Path);
44 sys::path::remove_dots(path&: ParentPath, /*remove_dot_dot=*/true);
45 sys::path::append(path&: FullPath, a: sys::path::relative_path(path: ParentPath));
46
47 auto PathFilename = (sys::path::filename(path: Path) + "." + Extension).str();
48 sys::path::append(path&: FullPath, a: PathFilename);
49 sys::path::native(path&: FullPath);
50
51 return std::string(FullPath);
52}
53
54Expected<CoveragePrinter::OwnedStream>
55CoveragePrinter::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, Relative: false);
61
62 auto ParentDir = sys::path::parent_path(path: FullPath);
63 if (auto E = sys::fs::create_directories(path: ParentDir))
64 return errorCodeToError(EC: 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(EC: E);
72 return std::move(OS);
73}
74
75std::unique_ptr<CoveragePrinter>
76CoveragePrinter::create(const CoverageViewOptions &Opts) {
77 switch (Opts.Format) {
78 case CoverageViewOptions::OutputFormat::Text:
79 if (Opts.ShowDirectoryCoverage)
80 return std::make_unique<CoveragePrinterTextDirectory>(args: Opts);
81 return std::make_unique<CoveragePrinterText>(args: Opts);
82 case CoverageViewOptions::OutputFormat::HTML:
83 if (Opts.ShowDirectoryCoverage)
84 return std::make_unique<CoveragePrinterHTMLDirectory>(args: Opts);
85 return std::make_unique<CoveragePrinterHTML>(args: 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
94unsigned SourceCoverageView::getFirstUncoveredLineNo() {
95 const auto MinSegIt = find_if(Range&: CoverageInfo, P: [](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
106std::string SourceCoverageView::formatCount(uint64_t N) {
107 std::string Number = utostr(X: 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(c: '.');
115 Result += Number.substr(pos: IntLen, n: 3 - IntLen);
116 }
117 Result.push_back(c: " kMGTPEZY"[(Len - 1) / 3]);
118 return Result;
119}
120
121bool 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 if (!CurSeg->HasCount) // don't show tooltips for SkippedRegions
134 continue;
135 return true;
136 }
137 return false;
138}
139
140bool SourceCoverageView::hasSubViews() const {
141 return !ExpansionSubViews.empty() || !InstantiationSubViews.empty() ||
142 !BranchSubViews.empty() || !MCDCSubViews.empty();
143}
144
145std::unique_ptr<SourceCoverageView>
146SourceCoverageView::create(StringRef SourceName, const MemoryBuffer &File,
147 const CoverageViewOptions &Options,
148 CoverageData &&CoverageInfo) {
149 switch (Options.Format) {
150 case CoverageViewOptions::OutputFormat::Text:
151 return std::make_unique<SourceCoverageViewText>(
152 args&: SourceName, args: File, args: Options, args: std::move(CoverageInfo));
153 case CoverageViewOptions::OutputFormat::HTML:
154 return std::make_unique<SourceCoverageViewHTML>(
155 args&: SourceName, args: File, args: Options, args: std::move(CoverageInfo));
156 case CoverageViewOptions::OutputFormat::Lcov:
157 // Unreachable because CodeCoverage.cpp should terminate with an error
158 // before we get here.
159 llvm_unreachable("Lcov format is not supported!");
160 }
161 llvm_unreachable("Unknown coverage output format!");
162}
163
164std::string SourceCoverageView::getSourceName() const {
165 SmallString<128> SourceText(SourceName);
166 sys::path::remove_dots(path&: SourceText, /*remove_dot_dot=*/true);
167 sys::path::native(path&: SourceText);
168 return std::string(SourceText);
169}
170
171void SourceCoverageView::addExpansion(
172 const CounterMappingRegion &Region,
173 std::unique_ptr<SourceCoverageView> View) {
174 ExpansionSubViews.emplace_back(args: Region, args: std::move(View));
175}
176
177void SourceCoverageView::addBranch(unsigned Line,
178 SmallVector<CountedRegion, 0> Regions) {
179 BranchSubViews.emplace_back(Args&: Line, Args: std::move(Regions));
180}
181
182void SourceCoverageView::addMCDCRecord(unsigned Line,
183 SmallVector<MCDCRecord, 0> Records) {
184 MCDCSubViews.emplace_back(Args&: Line, Args: std::move(Records));
185}
186
187void SourceCoverageView::addInstantiation(
188 StringRef FunctionName, unsigned Line,
189 std::unique_ptr<SourceCoverageView> View) {
190 InstantiationSubViews.emplace_back(args&: FunctionName, args&: Line, args: std::move(View));
191}
192
193void SourceCoverageView::print(raw_ostream &OS, bool WholeFile,
194 bool ShowSourceName, bool ShowTitle,
195 unsigned ViewDepth) {
196 if (ShowTitle)
197 renderTitle(OS, CellText: "Coverage Report");
198
199 renderViewHeader(OS);
200
201 if (ShowSourceName)
202 renderSourceName(OS, WholeFile);
203
204 renderTableHeader(OS, IndentLevel: ViewDepth);
205
206 // We need the expansions, instantiations, and branches sorted so we can go
207 // through them while we iterate lines.
208 llvm::stable_sort(Range&: ExpansionSubViews);
209 llvm::stable_sort(Range&: InstantiationSubViews);
210 llvm::stable_sort(Range&: BranchSubViews);
211 llvm::stable_sort(Range&: MCDCSubViews);
212 auto NextESV = ExpansionSubViews.begin();
213 auto EndESV = ExpansionSubViews.end();
214 auto NextISV = InstantiationSubViews.begin();
215 auto EndISV = InstantiationSubViews.end();
216 auto NextBRV = BranchSubViews.begin();
217 auto EndBRV = BranchSubViews.end();
218 auto NextMSV = MCDCSubViews.begin();
219 auto EndMSV = MCDCSubViews.end();
220
221 // Get the coverage information for the file.
222 auto StartSegment = CoverageInfo.begin();
223 auto EndSegment = CoverageInfo.end();
224 LineCoverageIterator LCI{CoverageInfo, 1};
225 LineCoverageIterator LCIEnd = LCI.getEnd();
226
227 unsigned FirstLine = StartSegment != EndSegment ? StartSegment->Line : 0;
228 for (line_iterator LI(File, /*SkipBlanks=*/false); !LI.is_at_eof();
229 ++LI, ++LCI) {
230 // If we aren't rendering the whole file, we need to filter out the prologue
231 // and epilogue.
232 if (!WholeFile) {
233 if (LCI == LCIEnd)
234 break;
235 else if (LI.line_number() < FirstLine)
236 continue;
237 }
238
239 renderLinePrefix(OS, ViewDepth);
240 if (getOptions().ShowLineNumbers)
241 renderLineNumberColumn(OS, LineNo: LI.line_number());
242
243 if (getOptions().ShowLineStats)
244 renderLineCoverageColumn(OS, Line: *LCI);
245
246 // If there are expansion subviews, we want to highlight the first one.
247 unsigned ExpansionColumn = 0;
248 if (NextESV != EndESV && NextESV->getLine() == LI.line_number() &&
249 getOptions().Colors)
250 ExpansionColumn = NextESV->getStartCol();
251
252 // Display the source code for the current line.
253 renderLine(OS, L: {*LI, LI.line_number()}, LCS: *LCI, ExpansionCol: ExpansionColumn, ViewDepth);
254
255 // Show the region markers.
256 if (shouldRenderRegionMarkers(LCS: *LCI))
257 renderRegionMarkers(OS, Line: *LCI, ViewDepth);
258
259 // Show the expansions, instantiations, and branches for this line.
260 bool RenderedSubView = false;
261 for (; NextESV != EndESV && NextESV->getLine() == LI.line_number();
262 ++NextESV) {
263 renderViewDivider(OS, ViewDepth: ViewDepth + 1);
264
265 // Re-render the current line and highlight the expansion range for
266 // this subview.
267 if (RenderedSubView) {
268 ExpansionColumn = NextESV->getStartCol();
269 renderExpansionSite(OS, L: {*LI, LI.line_number()}, LCS: *LCI, ExpansionCol: ExpansionColumn,
270 ViewDepth);
271 renderViewDivider(OS, ViewDepth: ViewDepth + 1);
272 }
273
274 renderExpansionView(OS, ESV&: *NextESV, ViewDepth: ViewDepth + 1);
275 RenderedSubView = true;
276 }
277 for (; NextISV != EndISV && NextISV->Line == LI.line_number(); ++NextISV) {
278 renderViewDivider(OS, ViewDepth: ViewDepth + 1);
279 renderInstantiationView(OS, ISV&: *NextISV, ViewDepth: ViewDepth + 1);
280 RenderedSubView = true;
281 }
282 for (; NextBRV != EndBRV && NextBRV->Line == LI.line_number(); ++NextBRV) {
283 renderViewDivider(OS, ViewDepth: ViewDepth + 1);
284 renderBranchView(OS, BRV&: *NextBRV, ViewDepth: ViewDepth + 1);
285 RenderedSubView = true;
286 }
287 for (; NextMSV != EndMSV && NextMSV->Line == LI.line_number(); ++NextMSV) {
288 renderViewDivider(OS, ViewDepth: ViewDepth + 1);
289 renderMCDCView(OS, BRV&: *NextMSV, ViewDepth: ViewDepth + 1);
290 RenderedSubView = true;
291 }
292 if (RenderedSubView)
293 renderViewDivider(OS, ViewDepth: ViewDepth + 1);
294 renderLineSuffix(OS, ViewDepth);
295 }
296
297 renderViewFooter(OS);
298}
299