Skip to content

prerequisites.md

Latest commit

 

History

History
111 lines (80 loc) · 2.91 KB

prerequisites.md

File metadata and controls

111 lines (80 loc) · 2.91 KB
Raw

Hayroll dependencies

Hayroll has several major dependencies. Please install them before starting to install Hayroll. You can either use our automated script prerequisites.bash, of follow the following steps manually. After that, the directory structure should look like this:

Hayroll/
└── dependencies/
    ├── c2rust/
    ├── Maki/
    ├── libmcs/
    ├── tree-sitter/
    └── tree-sitter-c_preproc/

C2Rust

Tested version: 0.20.0

C2Rust is a static-analysis-based C-to-Rust translation tool.

Please follow the steps on their README to install it. You may need to use the "Installing from Git" instructions rather than the "Installing from crates.io" instructions. Hayroll does not need to see C2Rust's installation folder, but the c2rust command must be on your PATH.

Maki (Hayroll-modified Version)

Tested version: tag 0.1.7

Maki is a C macro analysis tool. Hayroll uses a modified version.

Please follow the "Local Setup (Required by Hayroll)" section in Maki's README. Do not use the docker version. Clone Maki into dependencies/Maki inside the Hayroll directory.

Z3

Tested version: 4.13.4

Z3 is an automated theorem prover and a SAT solver.

Please follow the common CMake installation workflow, or read README-CMake.md which can be found at Z3's root folder. Do not forget to run sudo make install as the last step. Hayroll does not need to see Z3's folder, but looks for required libraries in system paths.

Tree-sitter

Tested version: 0.25.10

tree-sitter is a lightweight parser generator.

mkdir -p dependencies
git clone https://github.com/tree-sitter/tree-sitter.git dependencies/tree-sitter
make -C dependencies/tree-sitter

Hayroll Tree-sitter-c_preproc

Tested version: tag 0.1.7

tree-sitter-c_preproc is a parser for C macros.

git clone https://github.com/UW-HARVEST/tree-sitter-c_preproc.git dependencies/tree-sitter-c_preproc
make -C dependencies/tree-sitter-c_preproc

Libmcs

Tested version: 1.2.0

Libmcs is a math library. Hayroll's test suite uses it.

It is recommended to turn off complex number support when running ./configure, because C2Rust does not fully support complex number functionalities. ./configure opens an interactive menu that leads you through such options.

git clone https://gitlab.com/gtd-gmbh/libmcs.git dependencies/libmcs
cd dependencies/libmcs
./configure
make

Hayroll

git clone https://github.com/UW-HARVEST/Hayroll
cd Hayroll
./build.bash

After that, you can optionally run tests, which should take less than a minute to finish:

cd ./build && ctest