Skip to content

[clang][dataflow] Convert SpecialBoolAnalysis to synthetic fields. #74706

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 11, 2023
Merged

[clang][dataflow] Convert SpecialBoolAnalysis to synthetic fields. #74706

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 20 additions & 58 deletions clang/unittests/Analysis/FlowSensitive/TypeErasedDataflowAnalysisTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -514,8 +514,17 @@ TEST_F(NoreturnDestructorTest, ConditionalOperatorNestedBranchReturns) {
class SpecialBoolAnalysis final
: public DataflowAnalysis<SpecialBoolAnalysis, NoopLattice> {
public:
explicit SpecialBoolAnalysis(ASTContext &Context)
: DataflowAnalysis<SpecialBoolAnalysis, NoopLattice>(Context) {}
explicit SpecialBoolAnalysis(ASTContext &Context, Environment &Env)
: DataflowAnalysis<SpecialBoolAnalysis, NoopLattice>(Context) {
Env.getDataflowAnalysisContext().setSyntheticFieldCallback(
[](QualType Ty) -> llvm::StringMap<QualType> {
RecordDecl *RD = Ty->getAsRecordDecl();
if (RD == nullptr || RD->getIdentifier() == nullptr ||
RD->getName() != "SpecialBool")
return {};
return {{"is_set", RD->getASTContext().BoolTy}};
});
}

static NoopLattice initialElement() { return {}; }

Expand All @@ -530,67 +539,18 @@ class SpecialBoolAnalysis final
if (const auto *E = selectFirst<CXXConstructExpr>(
"call", match(cxxConstructExpr(HasSpecialBoolType).bind("call"), *S,
getASTContext()))) {
cast<RecordValue>(Env.getValue(*E))
->setProperty("is_set", Env.getBoolLiteralValue(false));
Env.setValue(Env.getResultObjectLocation(*E).getSyntheticField("is_set"),
Env.getBoolLiteralValue(false));
} else if (const auto *E = selectFirst<CXXMemberCallExpr>(
"call", match(cxxMemberCallExpr(callee(cxxMethodDecl(ofClass(
SpecialBoolRecordDecl))))
.bind("call"),
*S, getASTContext()))) {
auto &ObjectLoc =
*cast<RecordStorageLocation>(getImplicitObjectLocation(*E, Env));

refreshRecordValue(ObjectLoc, Env)
.setProperty("is_set", Env.getBoolLiteralValue(true));
if (RecordStorageLocation *ObjectLoc = getImplicitObjectLocation(*E, Env))
Env.setValue(ObjectLoc->getSyntheticField("is_set"),
Env.getBoolLiteralValue(true));
}
}

ComparisonResult compare(QualType Type, const Value &Val1,
const Environment &Env1, const Value &Val2,
const Environment &Env2) override {
const auto *Decl = Type->getAsCXXRecordDecl();
if (Decl == nullptr || Decl->getIdentifier() == nullptr ||
Decl->getName() != "SpecialBool")
return ComparisonResult::Unknown;

auto *IsSet1 = cast_or_null<BoolValue>(Val1.getProperty("is_set"));
auto *IsSet2 = cast_or_null<BoolValue>(Val2.getProperty("is_set"));
if (IsSet1 == nullptr)
return IsSet2 == nullptr ? ComparisonResult::Same
: ComparisonResult::Different;

if (IsSet2 == nullptr)
return ComparisonResult::Different;

return Env1.proves(IsSet1->formula()) == Env2.proves(IsSet2->formula())
? ComparisonResult::Same
: ComparisonResult::Different;
}

// Always returns `true` to accept the `MergedVal`.
bool merge(QualType Type, const Value &Val1, const Environment &Env1,
const Value &Val2, const Environment &Env2, Value &MergedVal,
Environment &MergedEnv) override {
const auto *Decl = Type->getAsCXXRecordDecl();
if (Decl == nullptr || Decl->getIdentifier() == nullptr ||
Decl->getName() != "SpecialBool")
return true;

auto *IsSet1 = cast_or_null<BoolValue>(Val1.getProperty("is_set"));
if (IsSet1 == nullptr)
return true;

auto *IsSet2 = cast_or_null<BoolValue>(Val2.getProperty("is_set"));
if (IsSet2 == nullptr)
return true;

auto &IsSet = MergedEnv.makeAtomicBoolValue();
MergedVal.setProperty("is_set", IsSet);
if (Env1.proves(IsSet1->formula()) && Env2.proves(IsSet2->formula()))
MergedEnv.assume(IsSet.formula());

return true;
}
};

class JoinFlowConditionsTest : public Test {
Expand All @@ -602,7 +562,7 @@ class JoinFlowConditionsTest : public Test {
AnalysisInputs<SpecialBoolAnalysis>(
Code, ast_matchers::hasName("target"),
[](ASTContext &Context, Environment &Env) {
return SpecialBoolAnalysis(Context);
return SpecialBoolAnalysis(Context, Env);
})
.withASTBuildArgs({"-fsyntax-only", "-std=c++17"}),
/*VerifyResults=*/[&Match](const llvm::StringMap<
Expand Down Expand Up @@ -650,7 +610,9 @@ TEST_F(JoinFlowConditionsTest, JoinDistinctButProvablyEquivalentValues) {
ASSERT_THAT(FooDecl, NotNull());

auto GetFoo = [FooDecl](const Environment &Env) -> const Formula & {
return cast<BoolValue>(Env.getValue(*FooDecl)->getProperty("is_set"))
auto *Loc =
cast<RecordStorageLocation>(Env.getStorageLocation(*FooDecl));
return cast<BoolValue>(Env.getValue(Loc->getSyntheticField("is_set")))
->formula();
};

Expand Down