Kater: Automating Weak Memory Model Metatheory and Consistency Checking

Kater is a tool that can prove metatheoretic properties of weak memory models. It can also be used to generate consistency checking code for stateless model checking tools like GenMC.

This repository mirrors an internal repository and is only updated periodically. For changes between different versions please refer to the CHANGELOG.

Author: Michalis Kokologiannakis.

NOTE: Kater's code is currently unstable and undergoing modifications. Please report any encountered issues to michalis AT mpi-sws DOT org.

Getting Kater
Usage
Troubleshooting
License
Contact

Getting Kater

Using Docker

To pull a container containing GenMC from Docker Hub please issue the following command:

	docker pull genmc/kater

Building from source

Dependencies

To use Kater you need a C++20 compiler, cmake, flex (>= 2.6.4) and bison (>= 3.7.5) . On a Debian-based installation, the necessary dependencies are met by installing the following packages:

cmake make g++ flex bison

Installing

For a release build issue:

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

This will leave the kater executable in the Release directory. You can either run it from there (as in the examples below), or issue cmake --install.

Usage

To see a list of available options run:
```
  ./Release/kater --help
```
To run a particular test run:
```
  ./Release/kater [options] <file>
```

License

Kater is distributed under the GPL, version 3 or (at your option) later. Please see the COPYING file for details on GPLv3.

Contact

For feedback, questions, and bug reports please send an e-mail to michalis AT mpi-sws DOT org.

MPI-SWS/kater