mirror of
https://github.com/llvm/llvm-project.git
synced 2025-05-08 10:16:06 +00:00
2fd614efc1
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
90 lines
2.7 KiB
C++
90 lines
2.7 KiB
C++
//===- DebugSupport.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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file defines functions which generate more readable forms of data
|
|
// structures used in the dataflow analyses, for debugging purposes.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include <utility>
|
|
|
|
#include "clang/Analysis/FlowSensitive/DebugSupport.h"
|
|
#include "clang/Analysis/FlowSensitive/Solver.h"
|
|
#include "clang/Analysis/FlowSensitive/Value.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/Support/ErrorHandling.h"
|
|
|
|
namespace clang {
|
|
namespace dataflow {
|
|
|
|
llvm::StringRef debugString(Value::Kind Kind) {
|
|
switch (Kind) {
|
|
case Value::Kind::Integer:
|
|
return "Integer";
|
|
case Value::Kind::Reference:
|
|
return "Reference";
|
|
case Value::Kind::Pointer:
|
|
return "Pointer";
|
|
case Value::Kind::Struct:
|
|
return "Struct";
|
|
case Value::Kind::AtomicBool:
|
|
return "AtomicBool";
|
|
case Value::Kind::TopBool:
|
|
return "TopBool";
|
|
case Value::Kind::Conjunction:
|
|
return "Conjunction";
|
|
case Value::Kind::Disjunction:
|
|
return "Disjunction";
|
|
case Value::Kind::Negation:
|
|
return "Negation";
|
|
case Value::Kind::Implication:
|
|
return "Implication";
|
|
case Value::Kind::Biconditional:
|
|
return "Biconditional";
|
|
}
|
|
llvm_unreachable("Unhandled value kind");
|
|
}
|
|
|
|
llvm::raw_ostream &operator<<(llvm::raw_ostream &OS,
|
|
Solver::Result::Assignment Assignment) {
|
|
switch (Assignment) {
|
|
case Solver::Result::Assignment::AssignedFalse:
|
|
return OS << "False";
|
|
case Solver::Result::Assignment::AssignedTrue:
|
|
return OS << "True";
|
|
}
|
|
llvm_unreachable("Booleans can only be assigned true/false");
|
|
}
|
|
|
|
llvm::StringRef debugString(Solver::Result::Status Status) {
|
|
switch (Status) {
|
|
case Solver::Result::Status::Satisfiable:
|
|
return "Satisfiable";
|
|
case Solver::Result::Status::Unsatisfiable:
|
|
return "Unsatisfiable";
|
|
case Solver::Result::Status::TimedOut:
|
|
return "TimedOut";
|
|
}
|
|
llvm_unreachable("Unhandled SAT check result status");
|
|
}
|
|
|
|
llvm::raw_ostream &operator<<(llvm::raw_ostream &OS, const Solver::Result &R) {
|
|
OS << debugString(R.getStatus()) << "\n";
|
|
if (auto Solution = R.getSolution()) {
|
|
std::vector<std::pair<Atom, Solver::Result::Assignment>> Sorted = {
|
|
Solution->begin(), Solution->end()};
|
|
llvm::sort(Sorted);
|
|
for (const auto &Entry : Sorted)
|
|
OS << Entry.first << " = " << Entry.second << "\n";
|
|
}
|
|
return OS;
|
|
}
|
|
|
|
} // namespace dataflow
|
|
} // namespace clang
|