z3 README

The project's README from github.com/Z3Prover/z3. As one markdown file: README.md.

Z3

Z3 is a theorem prover from Microsoft Research. It is licensed under the MIT license. Windows binary distributions include C++ runtime redistributables

If you are not familiar with Z3, you can start here.

Pre-built binaries for stable and nightly releases are available here.

Z3 can be built using CMake, Visual Studio, a Makefile, vcpkg, or Bazel. It provides bindings for several programming languages.

See the release notes for notes on various stable releases of Z3.

Try the online Z3 Guide

Build status

Pull Request & Push Workflows

WASM Build Windows Build CI OCaml Binding
WASM Build Windows CI OCaml Binding CI

Scheduled Workflows

Android Build Pyodide Wheel (PyPI) Nightly Build Cross Build F* Master Build
Android Build Pyodide Wheel (PyPI) Nightly Build RISC V and PowerPC 64 F* Master Build
MSVC Static MSVC Clang-CL Build Z3 Cache Memory Safety Mark PRs Ready
MSVC Static Build MSVC Clang-CL Static Build Build and Cache Z3 Memory Safety Analysis Mark PRs Ready for Review

Manual & Release Workflows

Documentation Release Build WASM Release
Documentation Release Build WebAssembly Publish

Specialized Workflows

Nightly Validation Copilot Setup Agentics Maintenance
Nightly Build Validation Copilot Setup Steps Agentics Maintenance

Agentic Workflows

API Coherence Code Simplifier Release Notes Workflow Suggestion Academic Citation
API Coherence Checker Code Simplifier Release Notes Updater Workflow Suggestion Agent Academic Citation Tracker
Issue Backlog Memory Safety Report SMTLIB Benchmark Finder
Issue Backlog Processor Memory Safety Report SMTLIB Benchmark Finder

Building Z3 using CMake

CMake is the preferred and most fully featured build system for Z3. A basic release build is:

cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build --parallel

See README-CMake.md for build options, language bindings, installation, and instructions for consuming Z3 from another CMake project.

Building Z3 on Windows using Visual Studio Command Prompt

For 32-bit builds, start with:

python scripts/mk_make.py

or instead, for a 64-bit build:

python scripts/mk_make.py -x

then run:

cd build
nmake

Z3 uses C++20. The recommended version of Visual Studio is therefore VS2019 or later.

Security Features (MSVC): When building with Visual Studio/MSVC, a couple of security features are enabled by default for Z3:

Building Z3 using make and GCC/Clang

Execute:

python scripts/mk_make.py
cd build
make
sudo make install

Note by default g++ is used as C++ compiler if it is available. If you prefer to use Clang, change the mk_make.py invocation to:

CXX=clang++ CC=clang python scripts/mk_make.py

Note that Clang < 3.7 does not support OpenMP.

You can also build Z3 for Windows using Cygwin and the Mingw-w64 cross-compiler. In that case, make sure to use Cygwin's own Python and not some Windows installation of Python.

For a 64-bit build (from Cygwin64), configure Z3's sources with

CXX=x86_64-w64-mingw32-g++ CC=x86_64-w64-mingw32-gcc AR=x86_64-w64-mingw32-ar python scripts/mk_make.py

A 32-bit build should work similarly (but is untested); the same is true for 32/64 bit builds from within Cygwin32.

By default, it will install z3 executables at PREFIX/bin, libraries at PREFIX/lib, and include files at PREFIX/include, where the PREFIX installation prefix is inferred by the mk_make.py script. It is usually /usr for most Linux distros, and /usr/local for FreeBSD and macOS. Use the --prefix= command-line option to change the install prefix. For example:

python scripts/mk_make.py --prefix=/home/leo
cd build
make
make install

To uninstall Z3, use

sudo make uninstall

To clean Z3, you can delete the build directory and run the mk_make.py script again.

Building Z3 using vcpkg

vcpkg is a full platform package manager. To install Z3 with vcpkg, execute:

git clone https://github.com/microsoft/vcpkg.git
./bootstrap-vcpkg.bat # For powershell
./bootstrap-vcpkg.sh # For bash
./vcpkg install z3

Building Z3 using Bazel

Z3 can be built using Bazel. This is known to work on Ubuntu with Clang (but may work elsewhere with other compilers):

bazel build //...

Dependencies

Z3 itself has only few dependencies. It uses C++ runtime libraries, including pthreads for multi-threading. It is optionally possible to use GMP for multi-precision integers, but Z3 contains its own self-contained multi-precision functionality. Python is required to build Z3. Building Java, .NET, OCaml and Julia APIs requires installing relevant toolchains.

Z3 bindings

Z3 has bindings for various programming languages.

.NET

You can install a NuGet package for the latest release Z3 from nuget.org.

Use the --dotnet command line flag with mk_make.py to enable building these.

See examples/dotnet for examples.

C

These are always enabled.

See examples/c for examples.

C++

These are always enabled.

See examples/c++ for examples.

Java

Use the --java command line flag with mk_make.py to enable building these.

For IDE setup instructions (Eclipse, IntelliJ IDEA, Visual Studio Code) and troubleshooting, see the Java IDE Setup Guide.

See examples/java for examples.

Go

Use the --go command line flag with mk_make.py to enable building these. Note that Go bindings use CGO and require a Go toolchain (Go 1.20 or later) to build.

With CMake, use the -DZ3_BUILD_GO_BINDINGS=ON option.

See examples/go for examples and src/api/go/README.md for complete API documentation.

OCaml

Use the --ml command line flag with mk_make.py to enable building these.

See examples/ml for examples.

Python

You can install the Python wrapper for Z3 for the latest release from pypi using the command:

   pip install z3-solver

Use the --python command line flag with mk_make.py to enable building these.

Note that it is required on certain platforms that the Python package directory (site-packages on most distributions and dist-packages on Debian-based distributions) live under the install prefix. If you use a non-standard prefix you can use the --pypkgdir option to change the Python package directory used for installation. For example:

python scripts/mk_make.py --prefix=/home/leo --python --pypkgdir=/home/leo/lib/python-2.7/site-packages

If you do need to install to a non-standard prefix, a better approach is to use a Python virtual environment and install Z3 there. Python packages also work for Python3. Under Windows, recall to build inside the Visual C++ native command build environment. Note that the build/python/z3 directory should be accessible from where Python is used with Z3 and it requires libz3.dll to be in the path.

virtualenv venv
source venv/bin/activate
python scripts/mk_make.py --python
cd build
make
make install
# You will find Z3 and the Python bindings installed in the virtual environment
venv/bin/z3 -h
...
python -c 'import z3; print(z3.get_version_string())'
...

See examples/python for examples.

Julia

The Julia package Z3.jl wraps the C API of Z3. A previous version of it wrapped the C++ API: Information about updating and building the Julia bindings can be found in src/api/julia.

WebAssembly / TypeScript / JavaScript

A WebAssembly build with associated TypeScript typings is published on npm as z3-solver. Information about building these bindings can be found in src/api/js.

Smalltalk (Pharo / Smalltalk/X)

Project MachineArithmetic provides a Smalltalk interface to Z3's C API. For more information, see MachineArithmetic/README.md.

AIX

Build settings for AIX are described here.

System Overview

System Diagram

Interfaces

Power Tools

Policy for filing fuzz bugs

Z3 is a popular target for fuzzers. Many (best) papers have been published on finding bugs in z3 and SMT solvers and without doubt the bug file/fix ratio plays an important role establishing evidence in the publications for the value of fuzz tools. Unfortunately, addressing fuzz bugs doesn't necessarily advance uses of z3 where it matters most to users, and efforts to address them takes time away from such activities. With rapidly increasing quality of coding agents for diagnostics and fixes it is now a reasonable ask that fuzz bug reports make a solid effort on diagnostics and fix. To help focus efforts on what matters, fuzz bugs without further analysis than a repro may be closed without further consideration.

z3 (Z3Prover/z3)

Searching Database…

12.8K ·GitHub
What is this?Z3 is a theorem prover from Microsoft Research, used to check satisfiability of logical formulas (an SMT solver).
Is this a command-line tool or a library I call from code?Both: it's a C++ engine with native bindings for C, C++, .NET, Java, Python, Go, OCaml, Julia and WebAssembly/JS, and it also ships a CLI that reads SMTLIB2 input directly.
How do I get Z3 running or add it to my project?Grab pre-built binaries, build from source with CMake, Visual Studio, Make, vcpkg or Bazel, or install a language package directly, e.g. 'pip install z3-solver' for Python or the 'z3-solver' npm package for WASM/JS.
Do I need any special toolchain to build it?Building Z3 itself needs Python and a C++20-capable compiler; GMP is optional since Z3 has its own multi-precision arithmetic. The Java, .NET, OCaml, Julia and Go bindings each need their own language toolchain installed.
What happens if I report a crash found by a fuzzer?Fuzz bug reports that only include a repro, with no further diagnosis, may simply be closed, since Z3 is a very common fuzzing target.
Which languages have official Z3 bindings?C, C++, .NET, Java, Python, Go, OCaml, Julia, and WebAssembly/TypeScript/JavaScript, plus a community Smalltalk wrapper.
Can I use Z3 in a web browser?Yes, there's a WebAssembly build published on npm as z3-solver with accompanying TypeScript typings.
What is the Axiom Profiler mentioned in the README?It's a 'power tool' developed by ETH Zurich for analyzing Z3's proof and quantifier-instantiation behavior.
What format does Z3 expect for problems?SMTLIB2 is the default input format, alongside the native C/C++/Python/.NET/Java APIs.
Which topics is it in?theorem-proving, pypi, csharp, wasm, c++, java, go, rust, research, npm, api, library
Creator
Z3Prover
Size
197.1 MB
Stars
12.8K
Age
11y
Commits · 90 Days