An OCaml binding for Yices 1
Yices is an efficient SMT solver developed at SRI International. OCamlyices lets you use this SMT solver inside your own OCaml program.
Based on CamlIDL, this library allows accessing both Yices APIs (full and light), with most (if not all) features: unsatisfiable cores, bit vectors, and more experimental features (interrupting, switching between APIs).
Warning! Only tested under Linux (32 and 64 bit platforms), but reported to work under MacOS X…
Yices 1.0.40 or more recent (but not 2) needs to be installed on your system. It can be done in two steps:
-
Download the latest tarball of Yices 1 from SRI website. Prefer the version with GMP statically linked, except on Linux x86_64 (see note below).
-
Install Yices on your system as follow:
wget -q -O- http://git.io/sWxMmg | sh -s <yices-XYZ.tar.gz>where
<yices-XYZ.tar.gz>should be replaced with the path to the downloaded tarball. The script (available in the repository) installs Yices in/usr/localand register the shared library.Optionally you can set installation directories :
wget -q -O- http://git.io/sWxMmg | sh -s <yices-XYZ.tar.gz> --prefix /opt --libdir /opt/lib64
N.B.: On Linux x86_64 (and possibly other 64-bit platform), “Yices with
GMP dynamically linked” is strongly preferred at the moment. Indeed,
libyices.a (provided in “Yices with GMP statically linked”) is not compiled
with the -fPIC flag and cannot be compiled in a shared library (used for
bytecode compilation). A possible but inadvisable workaround is to use the
custom compilation mode (see configure options below).
Once Yices is installed, use Opam (the official OCaml package manager):
opam update
opam install ocamlyices
Done.
With ocamlfind:
ocamlfind ocamlc/ocamlopt -package ocamlyices ...
Or without:
ocamlc -I +ocamlyices nums.cma ocamlyices.cma ...
ocamlopt -I +ocamlyices nums.cmxa ocamlyices.cmxa ...
nums is required in order to handle GMP big integers as big_int, but recent
versions of OCaml should infer it automatically.
The documentation of OCamlyices' API is available online and can be build
locally doc/ by the following command:
make doc
For the rest, see the Yices' official website.
Also, three examples are also available in examples/.
- Install rootless or non-root Docker and VSCode;
- Install Dev Containers extension;
- Download or clone the repository and open it in the editor;
- Reopen in dev container and wait for it to finish the build;
- Run
esycommand inside the container to install OCaml language server and build the project. Packages will be cached into local.esyfolder to persist between the container runs. (if no typing inference,Ctrl+Shift+P -> OCaml: restart language server)
- GCC
- OCaml
- Findlib (i.e. ocamlfind)
- CamlIDL
- GMP shared library (only for Yices without GMP statically linked)
- and optionally autoconf if you wish to tinker with the configuration file.
-
Download and extract the last release from Github or clone the last version from the repository (at your own risk).
-
Please make sure to uninstall any previous version beforehand.
-
Configure and build the OCamlyices library (bytecode and native version):
autoconf # Only if there is no configure ./configure makePart of the linking is done by an incremental, aka partial, linking, the rest is done by ocamlc or ocamlopt when you use the OCamlyices library.
-
Install the library using ocamlfind's (Findlib) default destination directory:
make installDepending on your OCaml installation you may need admin rights or to
sudothis last command.
--enable-custom
--disable-custom [DEFAULT]
Build the OCamlyices for custom bytecode compilation (see ocamlc manual for
more information), rather than using a shared library. As a result, every
program using such a version of OCamlyices will have to be compiled with the
option -custom. Also, in this mode, OCamlyices cannot be used from within
the standard interactive toplevel ocaml.
--enable-partial-linking [DEFAULT]
--disbable-partial-linking
Partial linking is used so as the ocamlyices.cma/.cmxa does not depend on
the CamlIDL library.
Yices uses a library for arbitrary precision arithmetic, called GMP. Like any
other dependency, this dependency may lead to version incompatibilities.
Yices' website proposes a special version cooked with “GMP statically linked”.
This version contains only a static library libyices.a, which includes GMP.
However, using a static library leads to larger binaries and in case of
multiprocess programs to larger memory footprint.
That is why personally I prefer to stick with Yices without GMP. At the moment
(1.0.34), libyices.so is dependent on libgmp.so.10 (that is, a GMP version
5.x). Most recent systems come with packages for the version 5.x of GMP, called
for instance libgmp10 and libgmp10-dev (with headers) on Debian and Ubuntu.
Since version 0.6, OCamlyices does not need to know which one is in use, but
you need to have it on your system. You can know if libyices.so has any
problem with ldd. Indeed ldd /pathto/libyices.so should notably print the
full path of the GMP dynamic library used by Yices.
If you have install it with Opam:
opam remove ocamlyices
Otherwise, use ocamlfind:
ocamlfind remove ocamlyices
Copyright (c) 2009-2013, Mickaël Delahaye, http://micdel.fr
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.