about summary refs log tree commit diff homepage
path: root/include/klee/Solver/SolverImpl.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/klee/Solver/SolverImpl.h')
-rw-r--r--include/klee/Solver/SolverImpl.h114
1 files changed, 114 insertions, 0 deletions
diff --git a/include/klee/Solver/SolverImpl.h b/include/klee/Solver/SolverImpl.h
new file mode 100644
index 00000000..90d5af24
--- /dev/null
+++ b/include/klee/Solver/SolverImpl.h
@@ -0,0 +1,114 @@
+//===-- SolverImpl.h --------------------------------------------*- C++ -*-===//
+//
+//                     The KLEE Symbolic Virtual Machine
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef KLEE_SOLVERIMPL_H
+#define KLEE_SOLVERIMPL_H
+
+#include "klee/Internal/System/Time.h"
+#include "Solver.h"
+
+#include <vector>
+
+namespace klee {
+  class Array;
+  class ExecutionState;
+  class Expr;
+  struct Query;
+
+  /// SolverImpl - Abstract base clase for solver implementations.
+  class SolverImpl {
+    // DO NOT IMPLEMENT.
+    SolverImpl(const SolverImpl&);
+    void operator=(const SolverImpl&);
+    
+  public:
+    SolverImpl() {}
+    virtual ~SolverImpl();
+
+    enum SolverRunStatus { SOLVER_RUN_STATUS_SUCCESS_SOLVABLE,
+                           SOLVER_RUN_STATUS_SUCCESS_UNSOLVABLE,
+                           SOLVER_RUN_STATUS_FAILURE,
+                           SOLVER_RUN_STATUS_TIMEOUT,
+                           SOLVER_RUN_STATUS_FORK_FAILED,
+                           SOLVER_RUN_STATUS_INTERRUPTED,
+                           SOLVER_RUN_STATUS_UNEXPECTED_EXIT_CODE,
+                           SOLVER_RUN_STATUS_WAITPID_FAILED };
+
+    /// computeValidity - Compute a full validity result for the
+    /// query.
+    ///
+    /// The query expression is guaranteed to be non-constant and have
+    /// bool type.
+    ///
+    /// SolverImpl provides a default implementation which uses
+    /// computeTruth. Clients should override this if a more efficient
+    /// implementation is available.
+    ///
+    /// \param [out] result - if
+    /// \f[ \forall X constraints(X) \to query(X) \f]
+    /// then Solver::True,
+    /// else if
+    /// \f[ \forall X constraints(X) \to \lnot query(X) \f]
+    /// then Solver::False,
+    /// else
+    /// Solver::Unknown
+    ///
+    /// \return True on success
+    virtual bool computeValidity(const Query& query, Solver::Validity &result);
+    
+    /// computeTruth - Determine whether the given query expression is provably true
+    /// given the constraints.
+    ///
+    /// The query expression is guaranteed to be non-constant and have
+    /// bool type.
+    ///
+    /// This method should evaluate the logical formula:
+    ///
+    /// \f[ \forall X constraints(X) \to query(X) \f]
+    ///
+    /// Where \f$X\f$ is some assignment, \f$constraints(X)\f$ are the constraints
+    /// in the query and \f$query(X)\f$ is the query expression.
+    ///
+    /// \param [out] isValid - On success, true iff the logical formula is true.
+    /// \return True on success
+    virtual bool computeTruth(const Query& query, bool &isValid) = 0;
+
+    /// computeValue - Compute a feasible value for the expression.
+    ///
+    /// The query expression is guaranteed to be non-constant.
+    ///
+    /// \return True on success
+    virtual bool computeValue(const Query& query, ref<Expr> &result) = 0;
+    
+    /// \sa Solver::getInitialValues()
+    virtual bool computeInitialValues(const Query& query,
+                                      const std::vector<const Array*> 
+                                        &objects,
+                                      std::vector< std::vector<unsigned char> > 
+                                        &values,
+                                      bool &hasSolution) = 0;
+    
+    /// getOperationStatusCode - get the status of the last solver operation
+    virtual SolverRunStatus getOperationStatusCode() = 0;
+
+    /// getOperationStatusString - get string representation of the operation
+    /// status code
+    static const char* getOperationStatusString(SolverRunStatus statusCode);
+
+    virtual char *getConstraintLog(const Query& query)  {
+        // dummy
+        return nullptr;
+    }
+
+    virtual void setCoreSolverTimeout(time::Span timeout) {};
+};
+
+}
+
+#endif /* KLEE_SOLVERIMPL_H */