[clang] [clang][dataflow] HTML logger: Mark iterations that have converged. (PR #68204)
via cfe-commits
cfe-commits at lists.llvm.org
Wed Oct 4 04:02:00 PDT 2023
https://github.com/martinboehme created https://github.com/llvm/llvm-project/pull/68204
I've eliminated the `logText("Block converged")` call entirely because
a) These logs are associated with an individual `CFGElement`, while convergence
should be associated with a block, and
b) The log message was being associated with the wrong block: `recordState()`
dumps all of the pending log messages, but `blockConverged()` is called after
the last `recordState()` call for a given block, so that the "Block
converged" log message was being associated with the first element of the
_next_ block to be processed.
>From 13c53463fe19b5cb89d21c73b2db6c1b61939ff0 Mon Sep 17 00:00:00 2001
From: Martin Braenne <mboehme at google.com>
Date: Wed, 4 Oct 2023 11:01:08 +0000
Subject: [PATCH] [clang][dataflow] HTML logger: Mark iterations that have
converged.
I've eliminated the `logText("Block converged")` call entirely because
a) These logs are associated with an individual `CFGElement`, while convergence
should be associated with a block, and
b) The log message was being associated with the wrong block: `recordState()`
dumps all of the pending log messages, but `blockConverged()` is called after
the last `recordState()` call for a given block, so that the "Block
converged" log message was being associated with the first element of the
_next_ block to be processed.
---
.../lib/Analysis/FlowSensitive/HTMLLogger.cpp | 20 +++++++++++--------
.../Analysis/FlowSensitive/HTMLLogger.html | 2 ++
2 files changed, 14 insertions(+), 8 deletions(-)
diff --git a/clang/lib/Analysis/FlowSensitive/HTMLLogger.cpp b/clang/lib/Analysis/FlowSensitive/HTMLLogger.cpp
index 47915958750d1f4..8aef1d6f46089d2 100644
--- a/clang/lib/Analysis/FlowSensitive/HTMLLogger.cpp
+++ b/clang/lib/Analysis/FlowSensitive/HTMLLogger.cpp
@@ -150,6 +150,7 @@ class HTMLLogger : public Logger {
const CFGBlock *Block;
unsigned Iter;
bool PostVisit;
+ bool Converged;
};
StreamFactory Streams;
@@ -159,8 +160,8 @@ class HTMLLogger : public Logger {
const ControlFlowContext *CFG;
// Timeline of iterations of CFG block visitation.
std::vector<Iteration> Iters;
- // Number of times each CFG block has been seen.
- llvm::DenseMap<const CFGBlock *, llvm::SmallVector<Iteration>> BlockIters;
+ // Indexes in `Iters` of the iterations for each block.
+ llvm::DenseMap<const CFGBlock *, llvm::SmallVector<size_t>> BlockIters;
// The messages logged in the current context but not yet written.
std::string ContextLogs;
// The number of elements we have visited within the current CFG block.
@@ -207,6 +208,7 @@ class HTMLLogger : public Logger {
JOS->attribute("block", blockID(E.Block->getBlockID()));
JOS->attribute("iter", E.Iter);
JOS->attribute("post_visit", E.PostVisit);
+ JOS->attribute("converged", E.Converged);
});
}
});
@@ -222,10 +224,10 @@ class HTMLLogger : public Logger {
}
void enterBlock(const CFGBlock &B, bool PostVisit) override {
- llvm::SmallVector<Iteration> &BIter = BlockIters[&B];
+ llvm::SmallVector<size_t> &BIter = BlockIters[&B];
unsigned IterNum = BIter.size() + 1;
- BIter.push_back({&B, IterNum, PostVisit});
- Iters.push_back({&B, IterNum, PostVisit});
+ BIter.push_back(Iters.size());
+ Iters.push_back({&B, IterNum, PostVisit, /*Converged=*/false});
ElementIndex = 0;
}
void enterElement(const CFGElement &E) override {
@@ -290,7 +292,7 @@ class HTMLLogger : public Logger {
}
});
}
- void blockConverged() override { logText("Block converged"); }
+ void blockConverged() override { Iters.back().Converged = true; }
void logText(llvm::StringRef S) override {
ContextLogs.append(S.begin(), S.end());
@@ -301,13 +303,15 @@ class HTMLLogger : public Logger {
// Write the CFG block details.
// Currently this is just the list of elements in execution order.
// FIXME: an AST dump would be a useful view, too.
- void writeBlock(const CFGBlock &B, llvm::ArrayRef<Iteration> ItersForB) {
+ void writeBlock(const CFGBlock &B, llvm::ArrayRef<size_t> ItersForB) {
JOS->attributeObject(blockID(B.getBlockID()), [&] {
JOS->attributeArray("iters", [&] {
- for (const auto &Iter : ItersForB) {
+ for (size_t IterIdx : ItersForB) {
+ const Iteration &Iter = Iters[IterIdx];
JOS->object([&] {
JOS->attribute("iter", Iter.Iter);
JOS->attribute("post_visit", Iter.PostVisit);
+ JOS->attribute("converged", Iter.Converged);
});
}
});
diff --git a/clang/lib/Analysis/FlowSensitive/HTMLLogger.html b/clang/lib/Analysis/FlowSensitive/HTMLLogger.html
index 6d866d57e144866..ec9d74c71d35d98 100644
--- a/clang/lib/Analysis/FlowSensitive/HTMLLogger.html
+++ b/clang/lib/Analysis/FlowSensitive/HTMLLogger.html
@@ -45,6 +45,7 @@
{{entry.block}}
<template data-if="entry.post_visit">(post-visit)</template>
<template data-if="!entry.post_visit">({{entry.iter}})</template>
+ <template data-if="entry.converged"> →|<!--Rightwards arrow, vertical line--></template>
</div>
</template>
</section>
@@ -62,6 +63,7 @@
<a class="chooser {{selection.bb}}:{{iter.iter}}" data-iter="{{selection.bb}}:{{iter.iter}}">
<template data-if="iter.post_visit">Post-visit</template>
<template data-if="!iter.post_visit">Iteration {{iter.iter}}</template>
+ <template data-if="iter.converged"> →|<!--Rightwards arrow, vertical line--></template>
</a>
</template>
</div>
More information about the cfe-commits
mailing list