solver.h

Go to the documentation of this file.

// MIT License
//
// Copyright (c) 2019 Ruhr University Bochum, Chair for Embedded Security. All Rights reserved.
// Copyright (c) 2019 Marc Fyrbiak, Sebastian Wallat, Max Hoffmann ("ORIGINAL AUTHORS"). All rights reserved.
// Copyright (c) 2021 Max Planck Institute for Security and Privacy. All Rights reserved.
// Copyright (c) 2021 Jörn Langheinrich, Julian Speith, Nils Albartus, René Walendy, Simon Klix ("ORIGINAL AUTHORS"). All Rights reserved.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
 
#pragma once
 
#include "hal_core/netlist/boolean_function/types.h"
 
namespace hal
{
    namespace SMT
    {
        class Solver final
        {
        public:
            // Constructors, Destructors, Operators
 
            Solver(const std::vector<Constraint>& constraints = {});
 
            // Interface
 
            const std::vector<Constraint>& get_constraints() const;
 
            Solver& with_constraint(const Constraint& constraint);
 
            Solver& with_constraints(const std::vector<Constraint>& constraints);
 
            static bool has_local_solver_for(SolverType type, SolverCall call);
 
            Result<SolverResult> query(const QueryConfig& config = QueryConfig()) const;
 
            Result<SolverResult> query_local(const QueryConfig& config) const;
 
            static Result<SolverResult> query_local_with_smt2(const QueryConfig& config, const std::string& smt2);
 
            Result<SolverResult> query_remote(const QueryConfig& config) const;
 
            Result<std::string> to_smt2(const QueryConfig& config) const;
 
        private:
            // Member
 
            std::vector<Constraint> m_constraints;
 
            static std::map<std::pair<SolverType, SolverCall>, std::function<Result<std::tuple<bool, std::string>>(const std::string&, const QueryConfig&)>> spec2query;
            static std::map<SolverType, std::function<Result<std::string>()>> type2query_binary;
            static std::map<SolverType, bool> type2link_status;
 
            // Interface
 
            static Result<std::string> translate_to_smt2(const std::vector<Constraint>& constraints, const QueryConfig& config);
 
            static Result<SolverResult> translate_from_smt2(bool was_killed, std::string stdout, const QueryConfig& config);
        };
    }    // namespace SMT
}    // namespace hal