mirrors
/
codon
mirror of https://github.com/exaloop/codon.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
codon/docs/advanced/build.md

1.5 KiB
Raw Blame History

Unless you really need to build Codon for whatever reason, we strongly recommend using pre-built binaries if possible.

Dependencies

Codon uses an LLVM fork based on LLVM 15. To build it, you can do:

git clone --depth 1 -b codon https://github.com/exaloop/llvm-project
cmake -S llvm-project/llvm -B llvm-project/build -G Ninja \
    -DCMAKE_BUILD_TYPE=Release \
    -DLLVM_INCLUDE_TESTS=OFF \
    -DLLVM_ENABLE_RTTI=ON \
    -DLLVM_ENABLE_ZLIB=OFF \
    -DLLVM_ENABLE_TERMINFO=OFF \
    -DLLVM_TARGETS_TO_BUILD=all
cmake --build llvm-project/build
cmake --install llvm-project/build

Build

The following can generally be used to build Codon. The build process will automatically download and build several smaller dependencies.

cmake -S . -B build -G Ninja \
    -DCMAKE_BUILD_TYPE=Release \
    -DLLVM_DIR=$(llvm-config --cmakedir) \
    -DCMAKE_C_COMPILER=clang \
    -DCMAKE_CXX_COMPILER=clang++
cmake --build build --config Release

This will produce the codon executable in the build directory, as well as codon_test which runs the test suite. Additionally, a number of shared libraries are produced:

  • libcodonc: The compiler library used by the codon compiler.
  • libcodonrt: The runtime library used during execution.
  • libomp: OpenMP runtime used to execute parallel code.

Build options

The following additional flags can be passed to CMake:

  • CODON_JUPYTER = ON|OFF: Enable or disable Jupyter support (default: OFF)
  • CODON_GPU = ON|OFF: Enable or disable GPU support; requires CUDA (default: OFF)