Skip to content

Commit 721dd3b

Browse files
committed
[analyzer] NFC: Don't regenerate duplicate HTML reports.
This is a performance optimization for HTML diagnostics output mode. Currently they're incredibly inefficient: * The HTMLRewriter is re-run from scratch on every file on every report. Each such re-run involves re-lexing the entire file and producing a syntax-highlighted webpage of the entire file, with text behind macros duplicated as pop-up macro expansion tooltips. Then, warning and note bubbles are injected into the page. Only the bubble part is different across reports; everything else can theoretically be cached. * Additionally, if duplicate reports are emitted (with the same issue hash), HTMLRewriter will be re-run even though the output file is going to be discarded due to filename collision. This is mostly an issue for path-insensitive bug reports because path-sensitive bug reports are already deduplicated by the BugReporter as part of searching for the shortest bug path. But on some translation units almost 80% of bug reports are dry-run here. We only get away with all this because there are usually very few reports emitted per file. But if loud checkers are enabled, such as `webkit.*`, this may explode in complexity and even cause the compiler to run over the 32-bit SourceLocation addressing limit. (We're re-lexing everything each time, remember?) This patch hotfixes the *second* problem. Adds a FIXME for the first problem, which will require more yak shaving to solve. rdar://120801986
1 parent 5f59b72 commit 721dd3b

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

clang/lib/StaticAnalyzer/Core/HTMLDiagnostics.cpp

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ class HTMLDiagnostics : public PathDiagnosticConsumer {
6868
bool noDir = false;
6969
const Preprocessor &PP;
7070
const bool SupportsCrossFileDiagnostics;
71+
llvm::StringSet<> EmittedHashes;
7172

7273
public:
7374
HTMLDiagnostics(PathDiagnosticConsumerOptions DiagOpts,
@@ -301,6 +302,17 @@ void HTMLDiagnostics::ReportDiag(const PathDiagnostic& D,
301302
}
302303
}
303304

305+
SmallString<32> IssueHash = getIssueHash(D, PP);
306+
auto [It, IsNew] = EmittedHashes.insert(IssueHash);
307+
if (!IsNew) {
308+
// We've already emitted a duplicate issue. It'll get overwritten anyway.
309+
return;
310+
}
311+
312+
// FIXME: This causes each file to be re-parsed and syntax-highlighted
313+
// and macro-expanded separately for each report. We could cache such rewrites
314+
// across all reports and only re-do the part that's actually different:
315+
// the warning/note bubbles.
304316
std::string report = GenerateHTML(D, R, SMgr, path, declName.c_str());
305317
if (report.empty()) {
306318
llvm::errs() << "warning: no diagnostics generated for main file.\n";
@@ -332,7 +344,7 @@ void HTMLDiagnostics::ReportDiag(const PathDiagnostic& D,
332344
<< declName.c_str() << "-" << offsetDecl << "-";
333345
}
334346

335-
FileName << StringRef(getIssueHash(D, PP)).substr(0, 6).str() << ".html";
347+
FileName << StringRef(IssueHash).substr(0, 6).str() << ".html";
336348

337349
SmallString<128> ResultPath;
338350
llvm::sys::path::append(ResultPath, Directory, FileName.str());

0 commit comments

Comments
 (0)