Building on Linux

Step-by-step guide for Ubuntu 22.04. This guide uses the Linux native AIO fast path and writes build outputs to build/. If you want the portable build recipe shared with macOS, use -DTURBOLYNX_PORTABLE_DISK_IO=ON -B build-portable instead.

1. Install Build Tools

sudo apt-get update
sudo apt-get install -y \
    build-essential gcc-11 g++-11 \
    cmake ninja-build git \
    autoconf automake libtool pkg-config \
    ca-certificates

Set GCC 11 as default compiler:

sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-11 60 \
                         --slave   /usr/bin/g++ g++ /usr/bin/g++-11

Verify:

gcc --version    # gcc (Ubuntu 11.x.x) 11.x.x
cmake --version  # cmake 3.22+
ninja --version  # 1.10+

2. Clone and Configure

git clone https://github.com/turbolynx-dslab/TurboLynx
cd TurboLynx
cmake -GNinja \
      -DCMAKE_BUILD_TYPE=Release \
      -DENABLE_TCMALLOC=OFF \
      -DBUILD_UNITTESTS=OFF \
      -DTBB_TEST=OFF \
      -B build

3. Build

cmake --build build

Expected final output:

[N/N] Linking CXX shared library src/libturbolynx.so
[N/N] Linking CXX executable tools/turbolynx

4. Verify

./build/tools/turbolynx --help

Troubleshooting

FetchContent download fails

Check internet connectivity and that ca-certificates is installed. If behind a proxy, set the https_proxy environment variable before running cmake.

autoconf: not found during configure

sudo apt-get install autoconf automake libtool

Build with unit tests

cmake -GNinja -DCMAKE_BUILD_TYPE=Debug -DENABLE_TCMALLOC=OFF -DBUILD_UNITTESTS=ON -DTBB_TEST=OFF -B build-debug
cmake --build build-debug
./build-debug/test/unittest "[catalog]"
./build-debug/test/unittest "[storage]"
./build-debug/test/unittest "[common]"