ydb/BUILD.md

Building YDB from sources

Build Requirements

We have tested YDB builds using Ubuntu 18.04, 20.04 and 22.04. Other Linux distributions are likely to work, but additional effort may be needed. Only x86_64 Linux is currently supported.

Below is a list of packages that need to be installed before building YDB. 'How to Build' section contains step by step instructions to obtain these packages.

• cmake 3.22+
• clang-14
• lld-14
• git 2.20+
• python3.8
• pip3
• antlr3
• libaio-dev
• libidn11-dev
• ninja 1.10+

We run multiple clang instances in parallel to speed up the process by default. Each instance of clang may use up to 1GB of RAM, and linking the binary may use up to 16GB of RAM, please make sure your build host has enough resources.

Runtime Requirements

The following packages are required to run ydbd server:

• libidn11
• libaio

How to Build

For Ubuntu 18.04, install Python 3.8, create and activate a new virtual environment, and install the latest PIP.

```bash apt-get install python3.8 python3.8-venv python3-venv python3.8 -m venv ~/ydbwork/ve source ~/ydbwork/ve/bin/activate pip install -U pip ```

For Ubuntu 18.04 and Ubuntu 20.04, add CMake and LLVM APT repositories.

```bash wget -O - https://apt.kitware.com/keys/kitware-archive-latest.asc | sudo apt-key add - echo "deb http://apt.kitware.com/ubuntu/ $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/kitware.list >/dev/null wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add - echo "deb http://apt.llvm.org/$(lsb_release -cs)/ llvm-toolchain-$(lsb_release -cs)-14 main" | sudo tee /etc/apt/sources.list.d/llvm.list >/dev/null sudo apt-get update ```

Install dependencies

sudo apt-get -y install git cmake python3-pip ninja-build antlr3 m4 clang-14 lld-14 libidn11-dev libaio1 libaio-dev llvm-14
sudo pip3 install conan==1.59 grpcio-tools==1.57.0

Create the work directory.

:warning: Please make sure you have at least 80Gb of free space. We also recommend placing this directory on SSD to reduce build times.

mkdir ~/ydbwork && cd ~/ydbwork
mkdir build

Clone the ydb repository.

git clone https://github.com/ydb-platform/ydb.git

Configure

Configure without Ccache

Run cmake to generate build configuration:

cd build
cmake -G Ninja -DCMAKE_BUILD_TYPE=Release \
  -DCMAKE_TOOLCHAIN_FILE=../ydb/clang.toolchain \
  ../ydb

(optional) Configure with Ccache

With enabled Ccache, you can finish the compilation of all targets on supported Linux distributions in a few minutes. Or just ydbd or ydb binary in a couple of seconds. To optionally enable Ccache and enhance the compilation speed, follow these steps:

1. Install Ccache into /usr/local/bin/ (We are using version 4.8.1, you can use any version greater than 4.7)

   (V=4.8.1; curl -L https://github.com/ccache/ccache/releases/download/v${V}/ccache-${V}-linux-x86_64.tar.xz | \
    sudo tar -xJ -C /usr/local/bin/ --strip-components=1 --no-same-owner ccache-${V}-linux-x86_64/ccache)
   
   

2. Configure Ccache to use remote storage using environment variables

   export CCACHE_REMOTE_STORAGE="http://cachesrv.ydb.tech:8080|read-only|layout=bazel"
   export CCACHE_SLOPPINESS=locale
   export CCACHE_BASEDIR=~/ydbwork/
      
   

   or using Ccache config file

   ```bash ccache -o remote_storage="http://cachesrv.ydb.tech:8080|read-only|layout=bazel" ccache -o sloppiness=locale ccache -o base_dir=~/ydbwork/ ```

3. Also, you should change Conan's home folder to the build folder for better cache hit

   export CONAN_USER_HOME=~/ydbwork/build
   

4. Generate build configuration using ccache

   cd build
   cmake -G Ninja -DCMAKE_BUILD_TYPE=Release \
   -DCCACHE_PATH=/usr/local/bin/ccache \
   -DCMAKE_TOOLCHAIN_FILE=../ydb/clang.toolchain \
   ../ydb
      
   

Build

To build all binary artifacts (server YDBD, client YDB, unittest binaries) run:

ninja

A YDB server binary can be found at:

ydb/apps/ydbd/ydbd

Build and Test YDB CLI

To build YDB CLI (ydb):

ninja ydb/apps/ydb/all

A YDB CLI binary can be found at:

ydb/apps/ydb/ydb

Unit tests

To build YDB CLI unit tests:

ninja ydb/public/lib/ydb_cli/all

To run tests execute:

cd ydb/public/lib/ydb_cli/
ctest

Functional tests

Before launch tests you need to build YDB CLI and YDB server binaries. Also you can load ydbd binary file and use it. To launch YDB CLI python tests run ydb_cli test suite via pytest according to this instruction.