solidity/libsmtutil/Z3Interface.h

/*
	This file is part of solidity.

	solidity is free software: you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation, either version 3 of the License, or
	(at your option) any later version.

	solidity is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with solidity.  If not, see <http://www.gnu.org/licenses/>.
*/
// SPDX-License-Identifier: GPL-3.0

#pragma once

#include <libsmtutil/SolverInterface.h>
#include <z3++.h>

namespace solidity::smtutil
{

class Z3Interface: public SolverInterface
{
public:
	/// Noncopyable.
	Z3Interface(Z3Interface const&) = delete;
	Z3Interface& operator=(Z3Interface const&) = delete;

	Z3Interface(std::optional<unsigned> _queryTimeout = {});

	static bool available();

	void reset() override;

	void push() override;
	void pop() override;

	void declareVariable(std::string const& _name, SortPointer const& _sort) override;

	void addAssertion(Expression const& _expr) override;
	std::pair<CheckResult, std::vector<std::string>> check(std::vector<Expression> const& _expressionsToEvaluate) override;

	z3::expr toZ3Expr(Expression const& _expr);
	smtutil::Expression fromZ3Expr(z3::expr const& _expr);

	std::map<std::string, z3::expr> constants() const { return m_constants; }
	std::map<std::string, z3::func_decl> functions() const { return m_functions; }

	z3::context* context() { return &m_context; }

	// Z3 "basic resources" limit.
	// This is used to make the runs more deterministic and platform/machine independent.
	static int const resourceLimit = 1000000;

private:
	void declareFunction(std::string const& _name, Sort const& _sort);

	z3::sort z3Sort(Sort const& _sort);
	z3::sort_vector z3Sort(std::vector<SortPointer> const& _sorts);
	smtutil::SortPointer fromZ3Sort(z3::sort const& _sort);
	std::vector<smtutil::SortPointer> fromZ3Sort(z3::sort_vector const& _sorts);

	z3::context m_context;
	z3::solver m_solver;

	std::map<std::string, z3::expr> m_constants;
	std::map<std::string, z3::func_decl> m_functions;
};

}