Skip to content

BUILD.md

Latest commit

 

History

History
59 lines (44 loc) · 1.69 KB

BUILD.md

File metadata and controls

59 lines (44 loc) · 1.69 KB
Raw

Building CoBRA

Prerequisites

  • CMake 3.20+
  • C++23 compiler (GCC 13+, Clang 17+, Apple Clang 16+)
  • LLVM 19-22 (for the LLVM pass plugin; optional)

Quick Start

# Step 1: Build dependencies
cmake -S dependencies -B build-deps -DCMAKE_BUILD_TYPE=Release
cmake --build build-deps

# Step 2: Build CoBRA
cmake -S . -B build \
  -DCMAKE_PREFIX_PATH=$(pwd)/build-deps/install \
  -DCMAKE_BUILD_TYPE=Release
cmake --build build

# Run tests
ctest --test-dir build --output-on-failure

Superbuild Options

Pass these to the cmake -S dependencies step:

Option Default Description
USE_EXTERNAL_LLVM ON Use system LLVM (OFF = build from source)
USE_EXTERNAL_ABSEIL OFF Use system abseil (OFF = build from source)
USE_EXTERNAL_HIGHWAY OFF Use system highway (OFF = build from source)
COBRA_BUILD_TESTS OFF Build GoogleTest for tests
USE_EXTERNAL_GOOGLETEST OFF Use system GoogleTest (OFF = build from source)
COBRA_ENABLE_Z3 OFF Enable Z3 support (requires lib/verify implementation)
USE_EXTERNAL_Z3 OFF Use system Z3 (OFF = build from source)

Main Project Options

Pass these to the cmake -S . step:

Option Default Description
COBRA_BUILD_LLVM_PASS OFF Build the LLVM pass plugin (requires LLVM 19-22)
COBRA_BUILD_TESTS OFF Build tests (requires GoogleTest in prefix)

With LLVM Pass Plugin

Requires LLVM 19-22 installed or built from source via the superbuild.

cmake -S . -B build \
  -DCMAKE_PREFIX_PATH=$(pwd)/build-deps/install \
  -DCOBRA_BUILD_LLVM_PASS=ON \
  -DCMAKE_BUILD_TYPE=Release
cmake --build build