Building Knowhere

Name: building
Rating: 78
Author: zilliztech

Prerequisites

bash

# Ubuntu/Debian
sudo apt install build-essential libopenblas-openmp-dev libaio-dev python3-dev python3-pip
pip3 install conan==1.61.0 --user
export PATH=$PATH:$HOME/.local/bin

Build Commands

bash

mkdir build && cd build
conan remote add default-conan-local https://milvus01.jfrog.io/artifactory/api/conan/default-conan-local

Build Type	Command
CPU Release	`conan install .. --build=missing -o with_ut=True -s compiler.libcxx=libstdc++11 -s build_type=Release`
CPU Debug	`conan install .. --build=missing -o with_ut=True -s compiler.libcxx=libstdc++11 -s build_type=Debug`
GPU (CUVS)	`conan install .. --build=missing -o with_ut=True -o with_cuvs=True -s compiler.libcxx=libstdc++11 -s build_type=Release`
DISKANN	`conan install .. --build=missing -o with_ut=True -o with_diskann=True -s compiler.libcxx=libstdc++11 -s build_type=Release`
ASAN (CI default)	`conan install .. --build=missing -o with_ut=True -o with_diskann=True -o with_asan=True -s compiler.libcxx=libstdc++11 -s build_type=Release`
macOS	`conan install .. --build=missing -o with_ut=True -s compiler.libcxx=libc++ -s build_type=Release`

Then run: conan build ..

Build Options

Option	Description
`with_ut`	Enable unit tests
`with_diskann`	Enable DISKANN index support
`with_cuvs`	Enable GPU (CUVS) support
`with_asan`	Enable AddressSanitizer for memory error detection

Common Issues

•libstdc++ errors: Ensure -s compiler.libcxx=libstdc++11 matches your system
•Missing dependencies: Run conan install with --build=missing
•macOS: Use libc++ instead of libstdc++11
•ASAN failures: Check for memory leaks, use-after-free, buffer overflows

If this build relates to new features or interface changes, consider updating documentation. See documenting skill.