Source code for claripy.backends

import ctypes
import weakref
import operator
import threading
import numbers

import logging

l = logging.getLogger("claripy.backend")


[docs] class Backend: """ Backends are Claripy's workhorses. Claripy exposes ASTs (claripy.ast.Base objects) to the world, but when actual computation has to be done, it pushes those ASTs into objects that can be handled by the backends themselves. This provides a unified interface to the outside world while allowing Claripy to support different types of computation. For example, BackendConcrete provides computation support for concrete bitvectors and booleans, BackendVSA introduces VSA constructs such as StridedIntervals (and details what happens when operations are performed on them), and BackendZ3 provides support for symbolic variables and constraint solving. There are a set of functions that a backend is expected to implement. For all of these functions, the "public" version is expected to be able to deal with claripy.ast.Base objects, while the "private" version should only deal with objects specific to the backend itself. This is distinguished with Python idioms: a public function will be named func() while a private function will be _func(). All functions should return objects that are usable by the backend in its private methods. If this can't be done (i.e., some functionality is being attempted that the backend can't handle), the backend should raise a BackendError. In this case, Claripy will move on to the next backend in its list. All backends must implement a convert() function. This function receives a claripy.ast.Base and should return an object that the backend can handle in its private methods. Backends should also implement a _convert() method, which will receive anything that is *not* a claripy.ast.Base object (i.e., an integer or an object from a different backend). If convert() or _convert() receives something that the backend can't translate to a format that is usable internally, the backend should raise BackendError, and thus won't be used for that object. Claripy contract with its backends is as follows: backends should be able to can handle, in their private functions, any object that they return from their private *or* public functions. Likewise, Claripy will never pass an object to any backend private function that did not originate as a return value from a private or public function of that backend. One exception to this is _convert(), as Claripy can try to stuff anything it feels like into _convert() to see if the backend can handle that type of object. """ __slots__ = ( "_op_raw", "_op_expr", "_cache_objects", "_solver_required", "_tls", "_true_cache", "_false_cache", )
[docs] def __init__(self, solver_required=None): self._op_raw = {} self._op_expr = {} self._cache_objects = True self._solver_required = solver_required is not None self._tls = threading.local() self._true_cache = weakref.WeakKeyDictionary() self._false_cache = weakref.WeakKeyDictionary()
@property def is_smt_backend(self): return False @property def _object_cache(self): try: return self._tls.object_cache except AttributeError: self._tls.object_cache = weakref.WeakKeyDictionary() return self._tls.object_cache def _make_raw_ops(self, op_list, op_dict=None, op_module=None): for o in op_list: if op_dict is not None: if o in op_dict: self._op_raw[o] = op_dict[o] else: l.warning("Operation %s not in op_dict.", o) else: if hasattr(op_module, o): self._op_raw[o] = getattr(op_module, o) else: l.debug("Operation %s not in op_module %s.", o, op_module) def _make_expr_ops(self, op_list, op_dict=None, op_class=None): """ Fill up `self._op_expr` dict. :param op_list: A list of operation names. :param op_dict: A dictionary of operation methods. :param op_class: Where the operation method comes from. :return: """ for o in op_list: if op_dict is not None: if o in op_dict: self._op_expr[o] = op_dict[o] else: l.warning("Operation %s not in op_dict.", o) else: if hasattr(op_class, o): self._op_expr[o] = getattr(op_class, o) else: l.warning("Operation %s not in op_class %s.", o, op_class) # # These functions handle converting expressions to formats that the backend # can understand. # def _convert(self, r): # pylint:disable=W0613,R0201 """ Converts `r` to something usable by this backend. """ return r
[docs] def downsize(self): """ Clears all caches associated with this backend. """ self._object_cache.clear() self._true_cache.clear() self._false_cache.clear()
[docs] def handles(self, expr): """ Checks whether this backend can handle the expression. :param expr: The expression. :return: True if the backend can handle this expression, False if not. """ try: self.convert(expr) return True except BackendError: return False
[docs] def convert(self, expr): # pylint:disable=R0201 """ Resolves a claripy.ast.Base into something usable by the backend. :param expr: The expression. :param save: Save the result in the expression's object cache :return: A backend object. """ ast_queue = [[expr]] arg_queue = [] op_queue = [] try: while ast_queue: args_list = ast_queue[-1] if args_list: ast = args_list.pop(0) if type(ast) in {bool, int, str, float} or not isinstance(ast, Base): converted = self._convert(ast) arg_queue.append(converted) continue if self in ast._errored: raise BackendError( "%s can't handle operation %s (%s) due to a failed " "conversion on a child node" % (self, ast.op, ast.__class__.__name__) ) if self._cache_objects: cached_obj = self._object_cache.get(ast._cache_key, None) if cached_obj is not None: arg_queue.append(cached_obj) continue op_queue.append(ast) if ast.op in self._op_expr: ast_queue.append(None) else: ast_queue.append(list(ast.args)) else: ast_queue.pop() if op_queue: ast = op_queue.pop() op = self._op_expr.get(ast.op, None) if op is not None: r = op(ast) else: args = arg_queue[-len(ast.args) :] del arg_queue[-len(ast.args) :] try: r = self._call(ast.op, args) except BackendUnsupportedError: r = self.default_op(ast) for a in ast.annotations: r = self.apply_annotation(r, a) if self._cache_objects: self._object_cache[ast._cache_key] = r arg_queue.append(r) except (RuntimeError, ctypes.ArgumentError) as e: raise ClaripyRecursionError("Recursion limit reached. Sorry about that.") from e except BackendError: for ast in op_queue: ast._errored.add(self) if isinstance(expr, Base): expr._errored.add(self) raise # Note: Uncomment the following assertions if you are touching the above implementation # assert len(op_queue) == 0, "op_queue is not empty" # assert len(ast_queue) == 0, "ast_queue is not empty" # assert len(arg_queue) == 1, ("arg_queue has unexpected length", len(arg_queue)) return arg_queue.pop()
[docs] def convert_list(self, args): return [a if isinstance(a, numbers.Number) else self.convert(a) for a in args]
# # These functions provide support for applying operations to expressions. #
[docs] def call(self, op, args): """ Calls operation `op` on args `args` with this backend. :return: A backend object representing the result. """ converted = self.convert_list(args) return self._call(op, converted)
def _call(self, op, args): """_call :param op: :param args: :return: """ if op in self._op_raw: # the raw ops don't get the model, cause, for example, Z3 stuff can't take it obj = self._op_raw[op](*args) elif not op.startswith("__"): l.debug("backend has no operation %s", op) raise BackendUnsupportedError else: obj = NotImplemented # first, try the operation with the first guy try: obj = getattr(operator, op)(*args) except (TypeError, ValueError): pass if obj is NotImplemented: l.debug("received NotImplemented in %s.call() for operation %s", self, op) raise BackendUnsupportedError return obj # # Abstraction and resolution. # def _abstract(self, e): # pylint:disable=W0613,R0201 """ Abstracts the BackendObject e to an AST. :param e: The backend object. :return: An AST. """ raise BackendError("backend %s doesn't implement abstract()" % self.__class__.__name__) # # These functions simplify expressions. #
[docs] def simplify(self, e): o = self._abstract(self._simplify(self.convert(e))) o._simplified = Base.FULL_SIMPLIFY return o
def _simplify(self, e): # pylint:disable=R0201,unused-argument raise BackendError("backend %s can't simplify" % self.__class__.__name__) # # Some other helpers #
[docs] def is_true(self, e, extra_constraints=(), solver=None, model_callback=None): # pylint:disable=unused-argument """ Should return True if `e` can be easily found to be True. :param e: The AST. :param extra_constraints: Extra constraints (as ASTs) to add to the solver for this solve. :param solver: A solver, for backends that require it. :param model_callback: a function that will be executed with recovered models (if any) :returns: A boolean. """ # if self._solver_required and solver is None: # raise BackendError("%s requires a solver for evaluation" % self.__class__.__name__) if not isinstance(e, Base): return self._is_true( self.convert(e), extra_constraints=extra_constraints, solver=solver, model_callback=model_callback ) try: return self._true_cache[e.cache_key] except KeyError: t = self._is_true( self.convert(e), extra_constraints=extra_constraints, solver=solver, model_callback=model_callback ) if len(extra_constraints) == 0: # Only update cache when we have no extra constraints self._true_cache[e.cache_key] = t if t is True: self._false_cache[e.cache_key] = False return t
[docs] def is_false(self, e, extra_constraints=(), solver=None, model_callback=None): # pylint:disable=unused-argument """ Should return True if e can be easily found to be False. :param e: The AST :param extra_constraints: Extra constraints (as ASTs) to add to the solver for this solve. :param solver: A solver, for backends that require it :param model_callback: a function that will be executed with recovered models (if any) :return: A boolean. """ # if self._solver_required and solver is None: # raise BackendError("%s requires a solver for evaluation" % self.__class__.__name__) if not isinstance(e, Base): return self._is_false( self.convert(e), extra_constraints=extra_constraints, solver=solver, model_callback=model_callback ) try: return self._false_cache[e.cache_key] except KeyError: f = self._is_false( self.convert(e), extra_constraints=extra_constraints, solver=solver, model_callback=model_callback ) if len(extra_constraints) == 0: # Only update cache when we have no extra constraints self._false_cache[e.cache_key] = f if f is True: self._true_cache[e.cache_key] = False return f
def _is_false( self, e, extra_constraints=(), solver=None, model_callback=None ): # pylint:disable=no-self-use,unused-argument """ The native version of is_false. :param e: The backend object. :param extra_constraints: Extra constraints (as ASTs) to add to the solver for this solve. :param solver: A solver, for backends that require it. :param model_callback: a function that will be executed with recovered models (if any) :return: A boolean. """ raise BackendError("backend doesn't support _is_false") def _is_true( self, e, extra_constraints=(), solver=None, model_callback=None ): # pylint:disable=no-self-use,unused-argument """ The native version of is_true. :param e: The backend object. :param extra_constraints: Extra constraints (as ASTs) to add to the solver for this solve. :param solver: A solver, for backends that require it. :param model_callback: a function that will be executed with recovered models (if any) :return: A boolean. """ raise BackendError("backend doesn't support _is_true")
[docs] def has_true(self, e, extra_constraints=(), solver=None, model_callback=None): # pylint:disable=unused-argument """ Should return True if `e` can possible be True. :param e: The AST. :param extra_constraints: Extra constraints (as ASTs) to add to the solver for this solve. :param solver: A solver, for backends that require it. :param model_callback: a function that will be executed with recovered models (if any) :return: A boolean """ # if self._solver_required and solver is None: # raise BackendError("%s requires a solver for evaluation" % self.__class__.__name__) return self._has_true( self.convert(e), extra_constraints=extra_constraints, solver=solver, model_callback=model_callback )
[docs] def has_false(self, e, extra_constraints=(), solver=None, model_callback=None): # pylint:disable=unused-argument """ Should return False if `e` can possibly be False. :param e: The AST. :param extra_constraints: Extra constraints (as ASTs) to add to the solver for this solve. :param solver: A solver, for backends that require it. :param model_callback: a function that will be executed with recovered models (if any) :return: A boolean. """ # if self._solver_required and solver is None: # raise BackendError("%s requires a solver for evaluation" % self.__class__.__name__) return self._has_false( self.convert(e), extra_constraints=extra_constraints, solver=solver, model_callback=model_callback )
def _has_false( self, e, extra_constraints=(), solver=None, model_callback=None ): # pylint:disable=no-self-use,unused-argument """ The native version of :func:`has_false`. :param e: The backend object. :param extra_constraints: Extra constraints (as ASTs) to add to the solver for this solve. :param solver: A solver, for backends that require it. :param model_callback: a function that will be executed with recovered models (if any) :return: A boolean. """ raise BackendError("backend doesn't support _has_false") def _has_true( self, e, extra_constraints=(), solver=None, model_callback=None ): # pylint:disable=no-self-use,unused-argument """ The native version of :func:`has_true`. :param e: The backend object. :param extra_constraints: Extra constraints (as ASTs) to add to the solver for this solve. :param solver: A solver, for backends that require it. :param model_callback: a function that will be executed with recovered models (if any) :return: A boolean. """ raise BackendError("backend doesn't support _has_true") # # These functions are straight-up solver functions #
[docs] def solver(self, timeout=None): # pylint:disable=no-self-use,unused-argument """ This function should return an instance of whatever object handles solving for this backend. For example, in Z3, this would be z3.Solver(). """ raise BackendError("backend doesn't support solving")
[docs] def add(self, s, c, track=False): """ This function adds constraints to the backend solver. :param c: A sequence of ASTs :param s: A backend solver object :param bool track: True to enable constraint tracking, which is used in unsat_core() """ return self._add(s, self.convert_list(c), track=track)
def _add(self, s, c, track=False): # pylint:disable=no-self-use,unused-argument """ This function adds constraints to the backend solver. :param c: sequence of converted backend objects :param s: backend solver object :param bool track: True to enable constraint tracking, which is used in unsat_core(). """ raise BackendError("backend doesn't support solving")
[docs] def unsat_core(self, s): """ This function returns the unsat core from the backend solver. :param s: A backend solver object. :return: The unsat core. """ return [self._abstract(core) for core in self._unsat_core(s)]
def _unsat_core(self, s): # pylint:disable=no-self-use,unused-argument """ This function returns the unsat core from the backend solver. :param s: A backend solver object. :return: The unsat core. """ raise BackendError("backend doesn't support unsat_core") # # These functions provide evaluation support. #
[docs] def eval(self, expr, n, extra_constraints=(), solver=None, model_callback=None): """ This function returns up to `n` possible solutions for expression `expr`. :param expr: expression (an AST) to evaluate :param n: number of results to return :param solver: a solver object, native to the backend, to assist in the evaluation (for example, a z3.Solver) :param extra_constraints: extra constraints (as ASTs) to add to the solver for this solve :param model_callback: a function that will be executed with recovered models (if any) :return: A sequence of up to n results (backend objects) """ if self._solver_required and solver is None: raise BackendError("%s requires a solver for evaluation" % self.__class__.__name__) return self._eval( self.convert(expr), n, extra_constraints=self.convert_list(extra_constraints), solver=solver, model_callback=model_callback, )
def _eval( self, expr, n, extra_constraints=(), solver=None, model_callback=None ): # pylint:disable=unused-argument,no-self-use """ This function returns up to `n` possible solutions for expression `expr`. :param expr: An expression (backend object) to evaluate. :param n: A number of results to return. :param extra_constraints: Extra constraints (as ASTs) to add to the solver for this solve. :param solver: A solver object, native to the backend, to assist in the evaluation (for example, a z3.Solver). :param model_callback: a function that will be executed with recovered models (if any) :return: A sequence of up to n results (backend objects). """ raise BackendError("backend doesn't support eval()")
[docs] def batch_eval(self, exprs, n, extra_constraints=(), solver=None, model_callback=None): """ Evaluate one or multiple expressions. :param exprs: A list of expressions to evaluate. :param n: Number of different solutions to return. :param extra_constraints: Extra constraints (as ASTs) to add to the solver for this solve. :param solver: A solver object, native to the backend, to assist in the evaluation. :param model_callback: a function that will be executed with recovered models (if any) :return: A list of up to n tuples, where each tuple is a solution for all expressions. """ if self._solver_required and solver is None: raise BackendError("%s requires a solver for batch evaluation" % self.__class__.__name__) converted_exprs = [self.convert(ex) for ex in exprs] return self._batch_eval( converted_exprs, n, extra_constraints=self.convert_list(extra_constraints), solver=solver, model_callback=model_callback, )
def _batch_eval( self, exprs, n, extra_constraints=(), solver=None, model_callback=None ): # pylint:disable=unused-argument,no-self-use """ Evaluate one or multiple expressions. :param exprs: A list of expressions to evaluate. :param n: Number of different solutions to return. :param extra_constraints: Extra constraints (as ASTs) to add to the solver for this solve. :param solver: A solver object, native to the backend, to assist in the evaluation. :param model_callback: a function that will be executed with recovered models (if any) :return: A list of up to n tuples, where each tuple is a solution for all expressions. """ raise BackendError("backend doesn't support batch_eval()")
[docs] def min(self, expr, extra_constraints=(), signed=False, solver=None, model_callback=None): """ Return the minimum value of `expr`. :param expr: expression (an AST) to evaluate :param solver: a solver object, native to the backend, to assist in the evaluation (for example, a z3.Solver) :param extra_constraints: extra constraints (as ASTs) to add to the solver for this solve :param signed: Whether to solve for the minimum signed integer instead of the unsigned min :param model_callback: a function that will be executed with recovered models (if any) :return: the minimum possible value of expr (backend object) """ if self._solver_required and solver is None: raise BackendError("%s requires a solver for evaluation" % self.__class__.__name__) return self._min( self.convert(expr), extra_constraints=self.convert_list(extra_constraints), signed=signed, solver=solver, model_callback=model_callback, )
def _min( self, expr, extra_constraints=(), signed=False, solver=None, model_callback=None ): # pylint:disable=unused-argument,no-self-use """ Return the minimum value of expr. :param expr: expression (backend object) to evaluate :param solver: a solver object, native to the backend, to assist in the evaluation (for example, a z3.Solver) :param extra_constraints: extra constraints (as ASTs) to add to the solver for this solve :param signed: Whether to solve for the minimum signed integer instead of the unsigned min :param model_callback: a function that will be executed with recovered models (if any) :return: the minimum possible value of expr (backend object) """ raise BackendError("backend doesn't support min()")
[docs] def max(self, expr, extra_constraints=(), signed=False, solver=None, model_callback=None): """ Return the maximum value of expr. :param expr: expression (an AST) to evaluate :param solver: a solver object, native to the backend, to assist in the evaluation (for example, a z3.Solver) :param extra_constraints: extra constraints (as ASTs) to add to the solver for this solve :param signed: Whether to solve for the maximum signed integer instead of the unsigned max :param model_callback: a function that will be executed with recovered models (if any) :return: the maximum possible value of expr (backend object) """ if self._solver_required and solver is None: raise BackendError("%s requires a solver for evaluation" % self.__class__.__name__) return self._max( self.convert(expr), extra_constraints=self.convert_list(extra_constraints), signed=signed, solver=solver, model_callback=model_callback, )
def _max( self, expr, extra_constraints=(), signed=False, solver=None, model_callback=None ): # pylint:disable=unused-argument,no-self-use """ Return the maximum value of expr. :param expr: expression (backend object) to evaluate :param solver: a solver object, native to the backend, to assist in the evaluation (for example, a z3.Solver) :param extra_constraints: extra constraints (as ASTs) to add to the solver for this solve :param signed: Whether to solve for the maximum signed integer instead of the unsigned max :param model_callback: a function that will be executed with recovered models (if any) :return: the maximum possible value of expr (backend object) """ raise BackendError("backend doesn't support max()")
[docs] def check_satisfiability(self, extra_constraints=(), solver=None, model_callback=None): """ This function does a constraint check and returns the solvers state :param solver: The backend solver object. :param extra_constraints: Extra constraints (as ASTs) to add to s for this solve :param model_callback: a function that will be executed with recovered models (if any) :return: 'SAT', 'UNSAT', or 'UNKNOWN' """ return self._check_satisfiability( extra_constraints=self.convert_list(extra_constraints), solver=solver, model_callback=model_callback )
def _check_satisfiability(self, extra_constraints=(), solver=None, model_callback=None): """ This function does a constraint check and returns the solvers state :param solver: The backend solver object. :param extra_constraints: Extra constraints (as ASTs) to add to s for this solve :param model_callback: a function that will be executed with recovered models (if any) :return: 'SAT', 'UNSAT', or 'UNKNOWN' """ return ( "SAT" if self.satisfiable(extra_constraints=extra_constraints, solver=solver, model_callback=model_callback) else "UNSAT" )
[docs] def satisfiable(self, extra_constraints=(), solver=None, model_callback=None): """ This function does a constraint check and checks if the solver is in a sat state. :param solver: The backend solver object. :param extra_constraints: Extra constraints (as ASTs) to add to s for this solve :param model_callback: a function that will be executed with recovered models (if any) :return: True if sat, otherwise false """ return self._satisfiable( extra_constraints=self.convert_list(extra_constraints), solver=solver, model_callback=model_callback )
def _satisfiable( self, extra_constraints=(), solver=None, model_callback=None ): # pylint:disable=no-self-use,unused-argument """ This function does a constraint check and returns a model for a solver. :param solver: The backend solver object :param extra_constraints: Extra constraints (backend objects) to add to s for this solve :param model_callback: a function that will be executed with recovered models (if any) :return: True if sat, otherwise false """ raise BackendError("backend doesn't support solving")
[docs] def solution(self, expr, v, extra_constraints=(), solver=None, model_callback=None): """ Return True if `v` is a solution of `expr` with the extra constraints, False otherwise. :param expr: An expression (an AST) to evaluate :param v: The proposed solution (an AST) :param solver: A solver object, native to the backend, to assist in the evaluation (for example, a z3.Solver). :param extra_constraints: Extra constraints (as ASTs) to add to the solver for this solve. :param model_callback: a function that will be executed with recovered models (if any) :return: True if `v` is a solution of `expr`, False otherwise """ if self._solver_required and solver is None: raise BackendError("%s requires a solver for evaluation" % self.__class__.__name__) return self._solution( self.convert(expr), self.convert(v), extra_constraints=self.convert_list(extra_constraints), solver=solver, model_callback=model_callback, )
def _solution( self, expr, v, extra_constraints=(), solver=None, model_callback=None ): # pylint:disable=unused-argument,no-self-use """ Return True if v is a solution of expr with the extra constraints, False otherwise. :param expr: expression (backend object) to evaluate :param v: the proposed solution (backend object) :param solver: a solver object, native to the backend, to assist in the evaluation (for example, a z3.Solver) :param extra_constraints: extra constraints (as ASTs) to add to the solver for this solve :return: True if v is a solution of expr, False otherwise """ raise BackendError("backend doesn't support solution()") # # Some other methods #
[docs] def name(self, a): """ This should return the name of an expression. :param a: the AST to evaluate """ return self._name(self.convert(a))
def _name(self, o): # pylint:disable=no-self-use,unused-argument """ This should return the name of an object. :param o: the (backend-native) object """ raise BackendError("backend doesn't support name()")
[docs] def identical(self, a, b): """ This should return whether `a` is identical to `b`. Of course, this isn't always clear. True should mean that it is definitely identical. False eans that, conservatively, it might not be. :param a: an AST :param b: another AST """ return self._identical(self.convert(a), self.convert(b))
def _identical(self, a, b): # pylint:disable=no-self-use,unused-argument """ This should return whether `a` is identical to `b`. This is the native version of ``identical()``. :param a: the (backend-native) object :param b: the (backend-native) object """ raise BackendError("backend doesn't support identical()")
[docs] def cardinality(self, a): """ This should return the maximum number of values that an expression can take on. This should be a strict *over* approximation. :param a: The AST to evaluate :return: An integer """ return self._cardinality(self.convert(a))
def _cardinality(self, b): # pylint:disable=no-self-use,unused-argument """ This should return the maximum number of values that an expression can take on. This should be a strict *over* approximation. :param a: The AST to evalute :return: An integer """ raise BackendError("backend doesn't support cardinality()")
[docs] def singlevalued(self, a): return self.cardinality(a) == 1
[docs] def multivalued(self, a): return self.cardinality(a) > 1
[docs] def apply_annotation(self, o, a): # pylint:disable=no-self-use,unused-argument """ This should apply the annotation on the backend object, and return a new backend object. :param o: A backend object. :param a: An Annotation object. :return: A backend object. """ return o
[docs] def default_op(self, expr): # pylint: disable=unused-argument raise BackendError(f"Backend {self} does not support operation {expr.op}")
from ..errors import BackendError, ClaripyRecursionError, BackendUnsupportedError from .backend_z3 import BackendZ3 from .backend_z3_parallel import BackendZ3Parallel from .backend_concrete import BackendConcrete from .backend_vsa import BackendVSA from ..ast.base import Base # If you need support for multiple solvers, please import claripy.backends.backend_smtlib_solvers by yourself # from .backend_smtlib_solvers import *