[clang] [clang-tools-extra] [clang-tidy] For bugprone-unchecked-optional-access add simple BoolModel option (PR #240848)
Jan Voung via cfe-commits
cfe-commits at lists.llvm.org
Tue Nov 10 12:54:39 PST 2026
https://github.com/jvoung updated https://github.com/llvm/llvm-project/pull/240848
>From 678da41ccdc6293ff2a7fa4ac1c2ad613e280e19 Mon Sep 17 00:00:00 2001
From: Jan Voung <jvoung at gmail.com>
Date: Tue, 10 Nov 2026 14:31:25 +0000
Subject: [PATCH 1/4] [clang-tidy] For bugprone-unchecked-optional-access add
simple BoolModel option
Adds a checker option to select the Simple BoolModel (introduced in the
framework in https://github.com/llvm/llvm-project/pull/231061). This
gives users the choice of faster analysis (e.g., one way to address
https://github.com/llvm/llvm-project/issues/69369), but requires has
value checks to be more straightforward (no correlated branch conditions
for example).
---
.../bugprone/UncheckedOptionalAccessCheck.cpp | 45 ++++++++++++++++++-
.../bugprone/UncheckedOptionalAccessCheck.h | 15 +++----
clang-tools-extra/docs/ReleaseNotes.md | 12 +++--
.../bugprone/unchecked-optional-access.md | 14 ++++++
.../bugprone/unchecked-optional-access.cpp | 7 ++-
.../Analysis/FlowSensitive/DataflowAnalysis.h | 10 +++--
6 files changed, 84 insertions(+), 19 deletions(-)
diff --git a/clang-tools-extra/clang-tidy/bugprone/UncheckedOptionalAccessCheck.cpp b/clang-tools-extra/clang-tidy/bugprone/UncheckedOptionalAccessCheck.cpp
index 09c86e7da94f31..fcb6660d46a56a 100644
--- a/clang-tools-extra/clang-tidy/bugprone/UncheckedOptionalAccessCheck.cpp
+++ b/clang-tools-extra/clang-tidy/bugprone/UncheckedOptionalAccessCheck.cpp
@@ -7,15 +7,35 @@
//===----------------------------------------------------------------------===//
#include "UncheckedOptionalAccessCheck.h"
+#include "../ClangTidyCheck.h"
#include "clang/AST/ASTContext.h"
#include "clang/ASTMatchers/ASTMatchFinder.h"
#include "clang/ASTMatchers/ASTMatchers.h"
#include "clang/Analysis/FlowSensitive/DataflowAnalysis.h"
+#include "clang/Analysis/FlowSensitive/DataflowAnalysisContext.h"
#include "clang/Analysis/FlowSensitive/Models/UncheckedOptionalAccessModel.h"
#include "clang/Basic/SourceLocation.h"
#include "llvm/ADT/SmallVector.h"
+#include "llvm/ADT/StringRef.h"
#include "llvm/Support/Error.h"
+#include <optional>
+#include <utility>
+
+namespace clang::tidy {
+template <> struct OptionEnumMapping<dataflow::BoolModelKind> {
+ static llvm::ArrayRef<std::pair<dataflow::BoolModelKind, llvm::StringRef>>
+ getEnumMapping() {
+ static constexpr std::pair<dataflow::BoolModelKind, llvm::StringRef>
+ Mapping[] = {
+ {dataflow::BoolModelKind::SAT, "SAT"},
+ {dataflow::BoolModelKind::Simple, "Simple"},
+ };
+ return {Mapping};
+ }
+};
+} // namespace clang::tidy
+
namespace clang::tidy::bugprone {
using ast_matchers::MatchFinder;
using dataflow::UncheckedOptionalAccessDiagnoser;
@@ -24,6 +44,21 @@ using dataflow::UncheckedOptionalAccessModel;
static constexpr StringRef FuncID = "fun";
+UncheckedOptionalAccessCheck::UncheckedOptionalAccessCheck(
+ StringRef Name, ClangTidyContext *Context)
+ : ClangTidyCheck(Name, Context),
+ ModelOptions{Options.get("IgnoreSmartPointerDereference", false),
+ Options.get("IgnoreValueCalls", false)},
+ BoolModel(Options.get("BoolModel", dataflow::BoolModelKind::SAT)) {}
+
+void UncheckedOptionalAccessCheck::storeOptions(
+ ClangTidyOptions::OptionMap &Opts) {
+ Options.store(Opts, "IgnoreSmartPointerDereference",
+ ModelOptions.IgnoreSmartPointerDereference);
+ Options.store(Opts, "IgnoreValueCalls", ModelOptions.IgnoreValueCalls);
+ Options.store(Opts, "BoolModel", BoolModel);
+}
+
void UncheckedOptionalAccessCheck::registerMatchers(MatchFinder *Finder) {
using namespace ast_matchers;
@@ -57,13 +92,19 @@ void UncheckedOptionalAccessCheck::check(
if (llvm::Expected<SmallVector<UncheckedOptionalAccessDiagnostic>> Diags =
dataflow::diagnoseFunction<UncheckedOptionalAccessModel,
UncheckedOptionalAccessDiagnostic>(
- *FuncDecl, *Result.Context, Diagnoser))
+ *FuncDecl, *Result.Context, Diagnoser,
+ dataflow::kDefaultMaxSATIterations,
+ dataflow::kDefaultMaxBlockVisits,
+ {/*ContextSensitiveOpts=*/std::nullopt,
+ /*Logger=*/nullptr,
+ /*BoolModel=*/BoolModel})) {
for (const UncheckedOptionalAccessDiagnostic &Diag : *Diags) {
diag(Diag.Range.getBegin(), "unchecked access to optional value")
<< Diag.Range;
}
- else
+ } else {
llvm::consumeError(Diags.takeError());
+ }
}
} // namespace clang::tidy::bugprone
diff --git a/clang-tools-extra/clang-tidy/bugprone/UncheckedOptionalAccessCheck.h b/clang-tools-extra/clang-tidy/bugprone/UncheckedOptionalAccessCheck.h
index 62bf42da4f9f97..342c2c542207f8 100644
--- a/clang-tools-extra/clang-tidy/bugprone/UncheckedOptionalAccessCheck.h
+++ b/clang-tools-extra/clang-tidy/bugprone/UncheckedOptionalAccessCheck.h
@@ -11,6 +11,7 @@
#include "../ClangTidyCheck.h"
#include "clang/ASTMatchers/ASTMatchFinder.h"
+#include "clang/Analysis/FlowSensitive/DataflowAnalysisContext.h"
#include "clang/Analysis/FlowSensitive/Models/UncheckedOptionalAccessModel.h"
namespace clang::tidy::bugprone {
@@ -23,23 +24,19 @@ namespace clang::tidy::bugprone {
/// https://clang.llvm.org/extra/clang-tidy/checks/bugprone/unchecked-optional-access.html
class UncheckedOptionalAccessCheck : public ClangTidyCheck {
public:
- UncheckedOptionalAccessCheck(StringRef Name, ClangTidyContext *Context)
- : ClangTidyCheck(Name, Context),
- ModelOptions{Options.get("IgnoreSmartPointerDereference", false),
- Options.get("IgnoreValueCalls", false)} {}
+ UncheckedOptionalAccessCheck(StringRef Name, ClangTidyContext *Context);
void registerMatchers(ast_matchers::MatchFinder *Finder) override;
void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
return LangOpts.CPlusPlus;
}
- void storeOptions(ClangTidyOptions::OptionMap &Opts) override {
- Options.store(Opts, "IgnoreSmartPointerDereference",
- ModelOptions.IgnoreSmartPointerDereference);
- Options.store(Opts, "IgnoreValueCalls", ModelOptions.IgnoreValueCalls);
- }
+ void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
private:
dataflow::UncheckedOptionalAccessModelOptions ModelOptions;
+ // Note: The boolean model is an option for the framework, not the checker
+ // model, so we keep separate from ModelOptions.
+ dataflow::BoolModelKind BoolModel;
};
} // namespace clang::tidy::bugprone
diff --git a/clang-tools-extra/docs/ReleaseNotes.md b/clang-tools-extra/docs/ReleaseNotes.md
index 4cd6b4b8a82eee..5632cb0b8ec48c 100644
--- a/clang-tools-extra/docs/ReleaseNotes.md
+++ b/clang-tools-extra/docs/ReleaseNotes.md
@@ -239,9 +239,15 @@ infrastructure are described first, followed by tool-specific sections.
lambda closure types used as template arguments.
- Improved {doc}`bugprone-unchecked-optional-access
- <clang-tidy/checks/bugprone/unchecked-optional-access>` by fixing false
- positives on `bsl::optional` and `bdlb::NullableValue` constructed from a
- value or returned by `bsl::make_optional`.
+ <clang-tidy/checks/bugprone/unchecked-optional-access>` check:
+
+ - Fixed false positives on `bsl::optional` and `bdlb::NullableValue`
+ constructed from a value or returned by `bsl::make_optional`.
+
+ - Added the {option}`BoolModel` option to allow use of a "Simple" boolean
+ model that avoids relying on a SAT solver. Previously, only SAT was
+ available. This leads to faster analysis, but the trade-off is more false
+ positives (when has value checks involve correlated variables or ORs).
- Improved {doc}`cppcoreguidelines-missing-std-forward
<clang-tidy/checks/cppcoreguidelines/missing-std-forward>` check by diagnosing
diff --git a/clang-tools-extra/docs/clang-tidy/checks/bugprone/unchecked-optional-access.md b/clang-tools-extra/docs/clang-tidy/checks/bugprone/unchecked-optional-access.md
index 5f784f100f2440..fae7ae73831b4d 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/bugprone/unchecked-optional-access.md
+++ b/clang-tools-extra/docs/clang-tidy/checks/bugprone/unchecked-optional-access.md
@@ -157,6 +157,8 @@ void f(std::optional<int> opt) {
}
```
+(correlated-branches)=
+
### Ensure that a value exists, then access the value in a correlated branch
The check is aware of correlated branches in the code and can figure out
@@ -324,3 +326,15 @@ to `optional::value()`. Diagnostics for `operator*()` and
intentionally rely on `value()` for defined, guarded access while still
flagging UB-prone operator dereferences. Default is `false`.
```
+
+```{option} BoolModel
+Can be set to `SAT` (default) or `Simple`. The flow-sensitive analysis uses
+boolean formulas to model whether an `optional<T>` object has a value among
+other conditions. The analysis checks that, during accesses, the "has a value"
+state is provably true. The `SAT` model uses a SAT solver for this proof, so
+it can handle {ref}`branches with correlated conditions <correlated-branches>`
+and branches that contain ORs. The `Simple` model does a more limited tracking
+of boolean constants, and evaluates formulas without backtracking given
+assumptions at branch points, and does not introduce ORs for joins. As a result,
+the `Simple` model is faster but may have more false positives.
+```
diff --git a/clang-tools-extra/test/clang-tidy/checkers/bugprone/unchecked-optional-access.cpp b/clang-tools-extra/test/clang-tidy/checkers/bugprone/unchecked-optional-access.cpp
index 8bff66670f0da1..a0ea40f648880f 100644
--- a/clang-tools-extra/test/clang-tidy/checkers/bugprone/unchecked-optional-access.cpp
+++ b/clang-tools-extra/test/clang-tidy/checkers/bugprone/unchecked-optional-access.cpp
@@ -1,4 +1,9 @@
-// RUN: %check_clang_tidy %s bugprone-unchecked-optional-access %t -- -- -I %S/Inputs/unchecked-optional-access
+// RUN: %check_clang_tidy %s bugprone-unchecked-optional-access %t -- -- \
+// RUN: -I %S/Inputs/unchecked-optional-access
+// RUN: %check_clang_tidy %s bugprone-unchecked-optional-access %t -- \
+// RUN: -config="{CheckOptions: \
+// RUN: {bugprone-unchecked-optional-access.BoolModel: Simple}}" -- \
+// RUN: -I %S/Inputs/unchecked-optional-access
#include "absl/types/optional.h"
#include "bde/types/bdlb_nullablevalue.h"
diff --git a/clang/include/clang/Analysis/FlowSensitive/DataflowAnalysis.h b/clang/include/clang/Analysis/FlowSensitive/DataflowAnalysis.h
index e6efde091871fc..af499aa9e8e0a8 100644
--- a/clang/include/clang/Analysis/FlowSensitive/DataflowAnalysis.h
+++ b/clang/include/clang/Analysis/FlowSensitive/DataflowAnalysis.h
@@ -322,13 +322,14 @@ llvm::Expected<llvm::SmallVector<Diagnostic>>
diagnoseFunction(const FunctionDecl &FuncDecl, ASTContext &ASTCtx,
DiagnosisCallbacks<AnalysisT, Diagnostic> Diagnoser,
std::int64_t MaxSATIterations = kDefaultMaxSATIterations,
- std::int32_t MaxBlockVisits = kDefaultMaxBlockVisits) {
+ std::int32_t MaxBlockVisits = kDefaultMaxBlockVisits,
+ DataflowAnalysisContext::Options ContextOptions = {}) {
llvm::Expected<AdornedCFG> Context = AdornedCFG::build(FuncDecl);
if (!Context)
return Context.takeError();
auto Solver = std::make_unique<WatchedLiteralsSolver>(MaxSATIterations);
- DataflowAnalysisContext AnalysisContext(*Solver);
+ DataflowAnalysisContext AnalysisContext(*Solver, ContextOptions);
Environment Env(AnalysisContext, FuncDecl);
AnalysisT Analysis = createAnalysis<AnalysisT>(ASTCtx, Env);
llvm::SmallVector<Diagnostic> Diagnostics;
@@ -383,10 +384,11 @@ llvm::Expected<llvm::SmallVector<Diagnostic>>
diagnoseFunction(const FunctionDecl &FuncDecl, ASTContext &ASTCtx,
DiagnosisCallback<AnalysisT, Diagnostic> Diagnoser,
std::int64_t MaxSATIterations = kDefaultMaxSATIterations,
- std::int32_t MaxBlockVisits = kDefaultMaxBlockVisits) {
+ std::int32_t MaxBlockVisits = kDefaultMaxBlockVisits,
+ DataflowAnalysisContext::Options ContextOptions = {}) {
DiagnosisCallbacks<AnalysisT, Diagnostic> Callbacks = {nullptr, Diagnoser};
return diagnoseFunction(FuncDecl, ASTCtx, Callbacks, MaxSATIterations,
- MaxBlockVisits);
+ MaxBlockVisits, ContextOptions);
}
/// Abstract base class for dataflow "models": reusable analysis components that
>From a2a94104e6f43d6fcc7c86f9ba93af729ee29715 Mon Sep 17 00:00:00 2001
From: Jan Voung <jvoung at gmail.com>
Date: Tue, 10 Nov 2026 14:43:12 +0000
Subject: [PATCH 2/4] format code
---
.../clang-tidy/bugprone/UncheckedOptionalAccessCheck.cpp | 6 ++----
1 file changed, 2 insertions(+), 4 deletions(-)
diff --git a/clang-tools-extra/clang-tidy/bugprone/UncheckedOptionalAccessCheck.cpp b/clang-tools-extra/clang-tidy/bugprone/UncheckedOptionalAccessCheck.cpp
index fcb6660d46a56a..351fcbbde85c1d 100644
--- a/clang-tools-extra/clang-tidy/bugprone/UncheckedOptionalAccessCheck.cpp
+++ b/clang-tools-extra/clang-tidy/bugprone/UncheckedOptionalAccessCheck.cpp
@@ -27,10 +27,8 @@ template <> struct OptionEnumMapping<dataflow::BoolModelKind> {
static llvm::ArrayRef<std::pair<dataflow::BoolModelKind, llvm::StringRef>>
getEnumMapping() {
static constexpr std::pair<dataflow::BoolModelKind, llvm::StringRef>
- Mapping[] = {
- {dataflow::BoolModelKind::SAT, "SAT"},
- {dataflow::BoolModelKind::Simple, "Simple"},
- };
+ Mapping[] = {{dataflow::BoolModelKind::SAT, "SAT"},
+ {dataflow::BoolModelKind::Simple, "Simple"}};
return {Mapping};
}
};
>From 6bdfa9fb5ee3283cf74cc85918a47817778e6469 Mon Sep 17 00:00:00 2001
From: Jan Voung <jvoung at gmail.com>
Date: Tue, 10 Nov 2026 14:50:48 -0500
Subject: [PATCH 3/4] Apply batched suggestions from code review
Suggestions from EugeneZelenko
Co-authored-by: EugeneZelenko <eugene.zelenko at gmail.com>
---
clang-tools-extra/docs/ReleaseNotes.md | 2 +-
.../clang-tidy/checks/bugprone/unchecked-optional-access.md | 4 ++--
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/clang-tools-extra/docs/ReleaseNotes.md b/clang-tools-extra/docs/ReleaseNotes.md
index 5632cb0b8ec48c..b8a53065c360dd 100644
--- a/clang-tools-extra/docs/ReleaseNotes.md
+++ b/clang-tools-extra/docs/ReleaseNotes.md
@@ -244,7 +244,7 @@ infrastructure are described first, followed by tool-specific sections.
- Fixed false positives on `bsl::optional` and `bdlb::NullableValue`
constructed from a value or returned by `bsl::make_optional`.
- - Added the {option}`BoolModel` option to allow use of a "Simple" boolean
+ - Added the {option}`BoolModel` option to allow use of a "Simple" Boolean
model that avoids relying on a SAT solver. Previously, only SAT was
available. This leads to faster analysis, but the trade-off is more false
positives (when has value checks involve correlated variables or ORs).
diff --git a/clang-tools-extra/docs/clang-tidy/checks/bugprone/unchecked-optional-access.md b/clang-tools-extra/docs/clang-tidy/checks/bugprone/unchecked-optional-access.md
index fae7ae73831b4d..c84b5d7696b3ab 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/bugprone/unchecked-optional-access.md
+++ b/clang-tools-extra/docs/clang-tidy/checks/bugprone/unchecked-optional-access.md
@@ -329,12 +329,12 @@ flagging UB-prone operator dereferences. Default is `false`.
```{option} BoolModel
Can be set to `SAT` (default) or `Simple`. The flow-sensitive analysis uses
-boolean formulas to model whether an `optional<T>` object has a value among
+Boolean formulas to model whether an `optional<T>` object has a value among
other conditions. The analysis checks that, during accesses, the "has a value"
state is provably true. The `SAT` model uses a SAT solver for this proof, so
it can handle {ref}`branches with correlated conditions <correlated-branches>`
and branches that contain ORs. The `Simple` model does a more limited tracking
-of boolean constants, and evaluates formulas without backtracking given
+of Boolean constants, and evaluates formulas without backtracking given
assumptions at branch points, and does not introduce ORs for joins. As a result,
the `Simple` model is faster but may have more false positives.
```
>From 06fe5a7ed7eaf51dbd709a0a4ddbb315ed94a4e2 Mon Sep 17 00:00:00 2001
From: Jan Voung <jvoung at gmail.com>
Date: Tue, 10 Nov 2026 20:53:51 +0000
Subject: [PATCH 4/4] review: More clear name for checker option
---
.../clang-tidy/bugprone/UncheckedOptionalAccessCheck.cpp | 4 ++--
.../clang-tidy/bugprone/UncheckedOptionalAccessCheck.h | 2 +-
clang-tools-extra/docs/ReleaseNotes.md | 4 ++--
.../checkers/bugprone/unchecked-optional-access.cpp | 2 +-
4 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/clang-tools-extra/clang-tidy/bugprone/UncheckedOptionalAccessCheck.cpp b/clang-tools-extra/clang-tidy/bugprone/UncheckedOptionalAccessCheck.cpp
index 351fcbbde85c1d..a9b45ee25d6939 100644
--- a/clang-tools-extra/clang-tidy/bugprone/UncheckedOptionalAccessCheck.cpp
+++ b/clang-tools-extra/clang-tidy/bugprone/UncheckedOptionalAccessCheck.cpp
@@ -47,14 +47,14 @@ UncheckedOptionalAccessCheck::UncheckedOptionalAccessCheck(
: ClangTidyCheck(Name, Context),
ModelOptions{Options.get("IgnoreSmartPointerDereference", false),
Options.get("IgnoreValueCalls", false)},
- BoolModel(Options.get("BoolModel", dataflow::BoolModelKind::SAT)) {}
+ BoolModel(Options.get("BoolSolverModel", dataflow::BoolModelKind::SAT)) {}
void UncheckedOptionalAccessCheck::storeOptions(
ClangTidyOptions::OptionMap &Opts) {
Options.store(Opts, "IgnoreSmartPointerDereference",
ModelOptions.IgnoreSmartPointerDereference);
Options.store(Opts, "IgnoreValueCalls", ModelOptions.IgnoreValueCalls);
- Options.store(Opts, "BoolModel", BoolModel);
+ Options.store(Opts, "BoolSolverModel", BoolModel);
}
void UncheckedOptionalAccessCheck::registerMatchers(MatchFinder *Finder) {
diff --git a/clang-tools-extra/clang-tidy/bugprone/UncheckedOptionalAccessCheck.h b/clang-tools-extra/clang-tidy/bugprone/UncheckedOptionalAccessCheck.h
index 342c2c542207f8..08466ff9fc1c37 100644
--- a/clang-tools-extra/clang-tidy/bugprone/UncheckedOptionalAccessCheck.h
+++ b/clang-tools-extra/clang-tidy/bugprone/UncheckedOptionalAccessCheck.h
@@ -34,7 +34,7 @@ class UncheckedOptionalAccessCheck : public ClangTidyCheck {
private:
dataflow::UncheckedOptionalAccessModelOptions ModelOptions;
- // Note: The boolean model is an option for the framework, not the checker
+ // Note: The Boolean model is an option for the framework, not the checker
// model, so we keep separate from ModelOptions.
dataflow::BoolModelKind BoolModel;
};
diff --git a/clang-tools-extra/docs/ReleaseNotes.md b/clang-tools-extra/docs/ReleaseNotes.md
index b8a53065c360dd..e17fe043398bee 100644
--- a/clang-tools-extra/docs/ReleaseNotes.md
+++ b/clang-tools-extra/docs/ReleaseNotes.md
@@ -244,8 +244,8 @@ infrastructure are described first, followed by tool-specific sections.
- Fixed false positives on `bsl::optional` and `bdlb::NullableValue`
constructed from a value or returned by `bsl::make_optional`.
- - Added the {option}`BoolModel` option to allow use of a "Simple" Boolean
- model that avoids relying on a SAT solver. Previously, only SAT was
+ - Added the {option}`BoolSolverModel` option to allow use of a "Simple"
+ Boolean model that avoids relying on a SAT solver. Previously, only SAT was
available. This leads to faster analysis, but the trade-off is more false
positives (when has value checks involve correlated variables or ORs).
diff --git a/clang-tools-extra/test/clang-tidy/checkers/bugprone/unchecked-optional-access.cpp b/clang-tools-extra/test/clang-tidy/checkers/bugprone/unchecked-optional-access.cpp
index a0ea40f648880f..e3cbcf53144d98 100644
--- a/clang-tools-extra/test/clang-tidy/checkers/bugprone/unchecked-optional-access.cpp
+++ b/clang-tools-extra/test/clang-tidy/checkers/bugprone/unchecked-optional-access.cpp
@@ -2,7 +2,7 @@
// RUN: -I %S/Inputs/unchecked-optional-access
// RUN: %check_clang_tidy %s bugprone-unchecked-optional-access %t -- \
// RUN: -config="{CheckOptions: \
-// RUN: {bugprone-unchecked-optional-access.BoolModel: Simple}}" -- \
+// RUN: {bugprone-unchecked-optional-access.BoolSolverModel: Simple}}" -- \
// RUN: -I %S/Inputs/unchecked-optional-access
#include "absl/types/optional.h"
More information about the cfe-commits
mailing list