Sam McCall 2fd614efc1 [dataflow] Add dedicated representation of boolean formulas
This is the first step in untangling the two current jobs of BoolValue.

=== Desired end-state: ===

- BoolValue will model C++ booleans e.g. held in StorageLocations.
  this includes describing uncertainty (e.g. "top" is a Value concern)
- Formula describes analysis-level assertions in terms of SAT atoms.

These can still be linked together: a BoolValue may have a corresponding
SAT atom which is constrained by formulas.

=== Done in this patch: ===

BoolValue is left intact, Formula is just the input type to the
SAT solver, and we build formulas as needed to invoke the solver.

=== Incidental changes to debug string printing: ===

- variables renamed from B0 etc to V0 etc
  B0 collides with the names of basic blocks, which is confusing when
  debugging flow conditions.
- debug printing of formulas (Formula and Atom) uses operator<<
  rather than debugString(), so works with gtest.
  Therefore moved out of DebugSupport.h
- Did the same to Solver::Result, and some helper changes to SolverTest,
  so that we get useful messages on unit test failures
- formulas are now printed as infix expressions on one line, rather than
  wrapped/indented S-exprs. My experience is that this is easier to scan
  FCs for small examples, and large ones are unreadable either way.
- most of the several debugString() functions for constraints/results
  are unused, so removed them rather than updating tests.
  Inlined the one that was actually used into its callsite.

Differential Revision: https://reviews.llvm.org/D153366
2023-07-04 12:19:44 +02:00

82 lines
2.4 KiB
C++

//===- Formula.cpp ----------------------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "clang/Analysis/FlowSensitive/Formula.h"
#include "clang/Basic/LLVM.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/Allocator.h"
#include "llvm/Support/ErrorHandling.h"
#include <cassert>
namespace clang::dataflow {
Formula &Formula::create(llvm::BumpPtrAllocator &Alloc, Kind K,
ArrayRef<const Formula *> Operands, unsigned Value) {
assert(Operands.size() == numOperands(K));
if (Value != 0) // Currently, formulas have values or operands, not both.
assert(numOperands(K) == 0);
void *Mem = Alloc.Allocate(sizeof(Formula) +
Operands.size() * sizeof(Operands.front()),
alignof(Formula));
Formula *Result = new (Mem) Formula();
Result->FormulaKind = K;
Result->Value = Value;
// Operands are stored as `const Formula *`s after the formula itself.
// We don't need to construct an object as pointers are trivial types.
// Formula is alignas(const Formula *), so alignment is satisfied.
llvm::copy(Operands, reinterpret_cast<const Formula **>(Result + 1));
return *Result;
}
static llvm::StringLiteral sigil(Formula::Kind K) {
switch (K) {
case Formula::AtomRef:
return "";
case Formula::Not:
return "!";
case Formula::And:
return " & ";
case Formula::Or:
return " | ";
case Formula::Implies:
return " => ";
case Formula::Equal:
return " = ";
}
llvm_unreachable("unhandled formula kind");
}
void Formula::print(llvm::raw_ostream &OS, const AtomNames *Names) const {
if (Names && kind() == AtomRef)
if (auto It = Names->find(getAtom()); It != Names->end()) {
OS << It->second;
return;
}
switch (numOperands(kind())) {
case 0:
OS << getAtom();
break;
case 1:
OS << sigil(kind());
operands()[0]->print(OS, Names);
break;
case 2:
OS << '(';
operands()[0]->print(OS, Names);
OS << sigil(kind());
operands()[1]->print(OS, Names);
OS << ')';
break;
default:
llvm_unreachable("unhandled formula arity");
}
}
} // namespace clang::dataflow