Acacia-Bonsai

This is a modern implementation of universal co-Buchi reactive synthesis algorithms using antichain data structures. The theory and practice is described in:

https://arxiv.org/abs/2204.06079

Docker images

Two images are published on the GitHub Container Registry. Boomslang bundles Spot's Python bindings, acacia_boomslang, and Jupyter:

docker pull ghcr.io/gaperez64/acacia-boomslang:latest
docker run --rm -p 8888:8888 ghcr.io/gaperez64/acacia-boomslang:latest

The CLI image contains the dependencies and sources. It compiles inside the container so -march=native can target the host:

docker pull ghcr.io/gaperez64/acacia-bonsai:latest
docker run --name acacia -it ghcr.io/gaperez64/acacia-bonsai:latest
./scripts/compile.sh
./scripts/acacia-bonsai.sh -f 'G F req -> G F grant' -i req -o grant
cat examples/realizable.tlsf | ./scripts/acacia-bonsai.sh --tlsf
cat examples/realizable.tlsf | \
  ./scripts/acacia-synthesis.sh --tlsf > controller.aag

The CLI example intentionally omits --rm: compilation happens inside the named container, so removing it on exit would discard the binaries. Re-enter it with docker start -ai acacia.

The wrappers name no configuration and follow the docker_default group. Pass a name as the first argument to choose a different shipped configuration, or run a wrapper without arguments to list the ones it accepts.

Dependencies

This program depends on:

• A modern C++ compiler (C++23 is used)
• The Meson Build System
• The Downset Manipulation Library
• The Spot Library: You will need to compile and install spot separately. The downset manipulation library requires compilation with g++ so to link against spot you need to compile it with g++ too (set CXX before configuring, compiling, and installing).
• The Z shell, for some scripts.

Initialize the vendored Posets and TLSF-tools dependencies after cloning:

git submodule update --init

This is deliberately non-recursive; Acacia disables TLSF-tools' optional OxiDD backend.

The corpus test driver (tests/check-real-correct.sh) can optionally run the solver under Valgrind (-V) or Callgrind (-c); no test does so by default, so Valgrind is only needed if you ask for it.

Installing dependencies on macOS

Note that on macOS the compilation has to happen via GCC. GCC can be installed using Homebrew: brew install gcc. Once installed, meson needs to be told to use GCC instead of built-in Clang. This can be done using the meson-native file, or by setting the CXX and CC environment variables. For instance, do export CXX=$(brew --prefix)/bin/g++-XX before starting with meson.

Spot has to be manually compiled using GCC and installed. After compiling it and installing it, you still need to ensure that meson can find Spot using pkgconfig. This can be done, for example, by setting the pkg_config_path in a meson-native file or by issuing export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig before starting with meson (this works if you installed spot in the default location).

Compiling, running, benchmarking

To compile and run, use Meson:

meson setup build
cd build
meson compile
src/acacia-bonsai -h
  [...]
src/acacia-bonsai -f '((G (F (req))) -> (G (F (grant))))' -i req -o grant
REALIZABLE

This produces a debug build. Build an optimized registered configuration with:

preset=$(python3 scripts/acacia-config.py list-group docker_default | head -1)
./self-benchmark.sh -c $preset -R

The -c option selects a configuration and the -R option disables the benchmarking step, so that only setup and compilation are done; the build lands in build_<preset>. If compilation memory is tight, add -L to use the low-memory compile profile.

The Meson option acacia_enable_tlsf_frontend is off by default, so a bare meson setup build does not require Flex and Bison. Every configuration preset enables the frontend, so any self-benchmark.sh -c NAME build includes it:

build_$preset/src/acacia-bonsai -T spec.tlsf

-T/--tlsf FILE parses TLSF natively and the wrapper accepts TLSF on standard input with --tlsf. No external TLSF converter is needed at runtime, and Moore-target controller conversion happens inside Acacia.

Correctness and performance gates, including the sequential measurement protocol, are documented in benchmarking/README.md. The comparison with ltlsynt is in benchmarking/LTLSYNT-GAP.md.

Compile-time configurations

Acacia-Bonsai's optimized variants are compile-time configurations. The registry holds the options in config/acacia-options.json and the presets that combine them in config/acacia-presets.json; scripts/acacia-config.py validates presets and translates them to Meson options, and meson.build writes the result into acacia_build_config.hh.

The options pick data structures and algorithms, for instance:

• acacia_vector_downset: the downset representation (vector_backed, rank_bucketed_vector_backed, kdtree_backed, bboxtree_backed, sharing trees, and others).
• acacia_vector_impl: the vector type stored in the downset, SIMD or plain (auto follows acacia_no_simd).
• acacia_forward_safety_solver: use the on-the-fly forward safety-game solver instead of the backward antichain fixed point.
• acacia_ios_precomputer: how input/output letters are precomputed (standard, mona, semantic_mona, ...).
• acacia_k_schedule: how the K loop raises its bound (linear, geometric, ...), with acacia_default_k, _kmin and _kinc setting its parameters.
• acacia_translation_pref: the Spot translator preference, small by default, also any, small+any and deterministic.
• acacia_decompose_spec: decompose the specification before solving.
• acacia_enable_equivariant_solver: compile the exact equivariant solver. It declines to the classic solver when no verified profitable symmetry is available, or when fewer than acacia_equivariant_min_blocks client-state blocks are found.

Some configurations take Spot's on-the-fly paths instead of the frozen automaton graph, gated by -Dacacia_spot_guarded_backend and -Dacacia_spot_lazy_provider and selected per polarity through --arms; the providers are described in benchmarking/OTF-AND-SPOT.md.

Inspect the registry with:

python3 scripts/acacia-config.py validate
python3 scripts/acacia-config.py list-presets              # names only
python3 scripts/acacia-config.py list-presets --long       # with role and description
python3 scripts/acacia-config.py show best_decomp_mona     # resolved options
python3 scripts/acacia-config.py show best_decomp_mona --describe
python3 scripts/acacia-config.py meson-args best_decomp_mona

The configurations we ship are whichever ones the docker_default group names:

python3 scripts/acacia-config.py list-group docker_default

The Docker images, the TLSF examples above and CI all read that group. A preset name is a historical label, not a claim about which configuration is currently best.

Each preset declares a role: shipping for docker_default members, reference for measurement controls, sweep for comparison arms, diagnostic for instrumented builds, legacy for historical configurations. best_decomp_mona is the plain vector-backed downset configuration, kept as the reference point for downset comparisons, and best_decomp_rank_bucketed_mona_noequivariant is the classic-solver-only ablation. A new preset inherits from the nearest existing configuration and overrides only the values being tested; new names are limited to 40 characters and cannot contain best, while existing names are grandfathered.

Documentation

This project comes with a doxygen configuration file. Execute the following command to generate documentation:

doxygen Doxyfile

Citing

If you use this tool for your academic work, please make sure to cite the paper we wrote about it.

@inproceedings{DBLP:conf/tacas/CadilhacP23,
  author       = {Micha{\"{e}}l Cadilhac and
                  Guillermo A. P{\'{e}}rez},
  editor       = {Sriram Sankaranarayanan and
                  Natasha Sharygina},
  title        = {Acacia-Bonsai: {A} Modern Implementation of Downset-Based {LTL} Realizability},
  booktitle    = {Tools and Algorithms for the Construction and Analysis of Systems
                  - 29th International Conference, {TACAS} 2023, Held as Part of the
                  European Joint Conferences on Theory and Practice of Software, {ETAPS}
                  2022, Paris, France, April 22-27, 2023, Proceedings, Part {II}},
  series       = {Lecture Notes in Computer Science},
  volume       = {13994},
  pages        = {192--207},
  publisher    = {Springer},
  year         = {2023},
  url          = {https://doi.org/10.1007/978-3-031-30820-8\_14},
  doi          = {10.1007/978-3-031-30820-8\_14},
  timestamp    = {Sat, 29 Apr 2023 19:25:03 +0200},
  biburl       = {https://dblp.org/rec/conf/tacas/CadilhacP23.bib},
  bibsource    = {dblp computer science bibliography, https://dblp.org}
}