package smtml

Smt.ml

Smt.ml is a Multi Back-end Front-end for SMT Solvers in OCaml. The primary objective of Smt.ml is to facilitate the effortless transition between different SMT solvers during program analysis, as certain SMT solvers may prove more efficient at handling specific logics and formulas. Presently, Smt.ml offers support for Z3, Colibri2, Bitwuzla, and Alt-Ergo, and ongoing efforts are directed towards incorporating support for cvc5.

Installation

OPAM

Install opam and bootstrap the OCaml compiler:

opam init
opam switch create 5.1.1 5.1.1

Then install encoding:

opam install smtml

Build from source

Clone the repo and install the dependencies:

git clone https://github.com/formalsec/smtml.git
cd smtml
opam install . --deps-only --with-test

Build and test:

dune build @install
dune runtest

Install smtml on your path by running:

dune install

Code Coverage Reports

BISECT_FILE=`pwd`/bisect dune runtest --force --instrument-with bisect_ppx
bisect-ppx-report summary # Shell summary
bisect-ppx-report html    # Detailed Report in _coverage/index.html

Supported Solvers

Legend

• ☑️ Solver is currently supported

• 🔄 Ongoing work to support solver

• 📆 Planned to support in the future

About

Project Name

The name Smt.ml is a portmanteau of the terms SMT and OCaml. The .ml extension is a common file extension for OCaml source files. The library itself is named smtml and can be imported into OCaml programs using the following syntax:

open Smtml

Changelog

See CHANGES

Copyright

MIT License

Copyright (c) 2024 formalsec

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.