diff --git a/.github/workflows/03-macos-linux-build.yml b/.github/workflows/03-macos-linux-build.yml index 4e4f1626f..1f6161242 100644 --- a/.github/workflows/03-macos-linux-build.yml +++ b/.github/workflows/03-macos-linux-build.yml @@ -60,14 +60,6 @@ jobs: sudo apt-get install -y clang libomp-dev shell: bash - - name: Install AIO - if: runner.os == 'Linux' && runner.arch == 'X64' - run: | - sudo apt-get update - sudo apt-get install -y --no-install-recommends \ - libaio-dev - shell: bash - - name: Print CPU info if: runner.os == 'Linux' run: lscpu @@ -183,3 +175,31 @@ jobs: ./c_api_index_example ./c_api_optimized_example shell: bash + + # ------------------------------------------------------------------ # + # DiskAnn libaio round: install libaio and re-run tests + # ------------------------------------------------------------------ # + - name: Install libaio runtime + if: matrix.platform == 'linux-x64' + run: | + sudo apt-get update -y + # libaio1t64 on Ubuntu 24.04+ (t64 transition), libaio1 on older + sudo apt-get install -y libaio1t64 || sudo apt-get install -y libaio1 + echo "=== libaio status (should be present) ===" + dpkg -l | grep -i libaio || true + ldconfig -p | grep libaio || true + shell: bash + + - name: Run DiskAnn C++ Tests (w/ libaio) + if: matrix.platform == 'linux-x64' + run: | + cd "$GITHUB_WORKSPACE/build" + ctest -R diskann --output-on-failure --parallel $NPROC + shell: bash + + - name: Run DiskAnn Python Tests (w/ libaio) + if: matrix.platform == 'linux-x64' + run: | + cd "$GITHUB_WORKSPACE" + python -m pytest python/tests/test_collection_diskann.py -v + shell: bash diff --git a/.github/workflows/08-cmake-subproject-integration.yml b/.github/workflows/08-cmake-subproject-integration.yml index 564a30484..3c5d50e17 100644 --- a/.github/workflows/08-cmake-subproject-integration.yml +++ b/.github/workflows/08-cmake-subproject-integration.yml @@ -34,13 +34,6 @@ jobs: cache: 'pip' cache-dependency-path: 'pyproject.toml' - - name: Install system dependencies - run: | - sudo apt-get update - sudo apt-get install -y --no-install-recommends \ - libaio-dev - shell: bash - - name: Set up environment variables run: | NPROC=$(nproc 2>/dev/null || echo 2) diff --git a/.github/workflows/clang_tidy.yml b/.github/workflows/clang_tidy.yml index 20a302d73..5ab872d58 100644 --- a/.github/workflows/clang_tidy.yml +++ b/.github/workflows/clang_tidy.yml @@ -47,7 +47,7 @@ jobs: if: steps.changed_files.outputs.any_changed == 'true' run: | sudo apt-get update - sudo apt-get install -y clang-tidy=1:18.0-59~exp2 cmake ninja-build libomp-dev libaio-dev + sudo apt-get install -y clang-tidy=1:18.0-59~exp2 cmake ninja-build libomp-dev - name: Setup ccache if: steps.changed_files.outputs.any_changed == 'true' diff --git a/.github/workflows/nightly_coverage.yml b/.github/workflows/nightly_coverage.yml index 81429b1eb..16c3e46de 100644 --- a/.github/workflows/nightly_coverage.yml +++ b/.github/workflows/nightly_coverage.yml @@ -49,7 +49,7 @@ jobs: run: | sudo apt-get update sudo apt-get install -y --no-install-recommends \ - lcov libaio-dev + lcov libaio-dev shell: bash - name: Install dependencies diff --git a/CMakeLists.txt b/CMakeLists.txt index d334b857f..1565ab79e 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -122,14 +122,17 @@ else() endif() message(STATUS "RABITQ_ARCH_FLAG: ${RABITQ_ARCH_FLAG}") -# DiskAnn support (Linux x86_64 only, requires libaio) -if(CMAKE_SYSTEM_NAME STREQUAL "Linux" AND CMAKE_SYSTEM_PROCESSOR MATCHES "x86_64|i686|i386" AND NOT ANDROID AND NOT IOS) +# DiskAnn support: +# - Linux (x86_64, i686, i386, aarch64, arm64) with libaio (loaded via dlopen) +# - macOS (x86_64, ARM64/Apple Silicon) with kqueue +if((CMAKE_SYSTEM_NAME STREQUAL "Linux" AND CMAKE_SYSTEM_PROCESSOR MATCHES "x86_64|i686|i386|aarch64|arm64" AND NOT ANDROID AND NOT IOS) + OR (CMAKE_SYSTEM_NAME STREQUAL "Darwin" AND NOT IOS)) set(DISKANN_SUPPORTED ON) add_definitions(-DDISKANN_SUPPORTED=1) else() set(DISKANN_SUPPORTED OFF) add_definitions(-DDISKANN_SUPPORTED=0) - message(STATUS "DiskAnn support disabled - only supported on Linux x86_64") + message(STATUS "DiskAnn support disabled - supported on Linux (x86_64/ARM64 with libaio) and macOS (with kqueue)") endif() message(STATUS "DISKANN_SUPPORTED: ${DISKANN_SUPPORTED}") @@ -180,24 +183,9 @@ if(BUILD_PYTHON_BINDINGS) install(TARGETS _zvec LIBRARY DESTINATION ${ZVEC_PY_INSTALL_DIR}/zvec COMPONENT python) - # DiskAnn ships as a runtime-loaded shared module - # (libzvec_diskann_plugin.so) that is brought online implicitly the - # first time a DiskAnn index is created — users never call any load - # function. The Python extension resolves the module next to _zvec.so - # (see the $ORIGIN rpath in src/binding/python/CMakeLists.txt); the - # module must therefore be installed alongside _zvec.so, i.e. inside the - # zvec package directory as well. - # - # Gate on DISKANN_SUPPORTED, not on the target's existence: on unsupported - # platforms (e.g. macOS / ARM64) the core_knn_diskann target is still - # defined, but built from an empty stub (src/core/algorithm/CMakeLists.txt) - # with zero exported symbols and a runtime load path compiled out - # (#if DISKANN_SUPPORTED). Shipping that stub is pure dead weight, so it is - # only packaged where DiskAnn is real — currently Linux x86_64 with libaio. - if(DISKANN_SUPPORTED) - install(TARGETS core_knn_diskann LIBRARY DESTINATION ${ZVEC_PY_INSTALL_DIR}/zvec - COMPONENT python) - endif() + # DiskAnn is now statically linked into _zvec.so via --whole-archive + # (see src/binding/python/CMakeLists.txt -> core_knn_diskann_static), + # so no separate runtime .so needs to be installed in the wheel. # Bundle cppjieba's dictionary files so the `jieba` FTS tokenizer works # out of the box. python/zvec/__init__.py resolves this directory via # importlib.resources and registers it with set_default_jieba_dict_dir(). diff --git a/examples/c++/CMakeLists.txt b/examples/c++/CMakeLists.txt index d58814d52..e3ccd1309 100644 --- a/examples/c++/CMakeLists.txt +++ b/examples/c++/CMakeLists.txt @@ -15,10 +15,13 @@ endif() get_filename_component(ZVEC_ROOT_DIR "${CMAKE_CURRENT_LIST_DIR}/../.." ABSOLUTE) set(ZVEC_INCLUDE_DIR ${ZVEC_ROOT_DIR}/src/include) +set(ZVEC_SRC_DIR ${ZVEC_ROOT_DIR}/src) set(ZVEC_LIB_DIR ${ZVEC_ROOT_DIR}/${HOST_BUILD_DIR}/lib) -# Add include and library search paths -include_directories(${ZVEC_INCLUDE_DIR}) +# Add include and library search paths. +# ZVEC_SRC_DIR is needed because public headers under src/include/ reference +# ailego/ and other internal headers that live directly under src/. +include_directories(${ZVEC_INCLUDE_DIR} ${ZVEC_SRC_DIR}) set(ZVEC_LIB_SEARCH_DIRS ${ZVEC_LIB_DIR}) # Support multi-config builds (MSVC puts libs in Debug/Release subdirectories) diff --git a/pyproject.toml b/pyproject.toml index 4f7add507..6296b3402 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -181,11 +181,6 @@ test-command = "cd {project} && pytest python/tests -v --tb=short" build-verbosity = 1 [tool.cibuildwheel.linux] -# libaio is required by the C++ backend; install it inside the manylinux -# container (manylinux_2_28 is AlmaLinux 8 based, so use dnf/libaio-devel). -# libaio-devel lives in BaseOS; disable EPEL so a flaky EPEL mirror cannot -# break metadata refresh. -before-all = "dnf install -y --disablerepo=epel libaio-devel" archs = ["auto"] environment = { CMAKE_GENERATOR = "Unix Makefiles", CMAKE_BUILD_PARALLEL_LEVEL = "16" } manylinux-x86_64-image = "manylinux_2_28" diff --git a/python/tests/detail/fixture_helper.py b/python/tests/detail/fixture_helper.py index 63aac799c..538c65df3 100644 --- a/python/tests/detail/fixture_helper.py +++ b/python/tests/detail/fixture_helper.py @@ -2,55 +2,31 @@ import logging import platform -DISKANN_SUPPORTED = platform.system() == "Linux" and platform.machine() in ( - "x86_64", - "AMD64", - "i686", - "i386", -) +DISKANN_SUPPORTED = ( + platform.system() == "Linux" + and platform.machine() in ("x86_64", "AMD64", "i686", "i386", "aarch64", "arm64") +) or platform.system() == "Darwin" from typing import Any, Generator from zvec.typing import DataType, StatusCode, MetricType, QuantizeType import zvec - -# Cache the DiskAnn plugin preload status so we pay the load cost once per -# test session. The plugin normally auto-loads on first DiskAnn use, but we -# preload it explicitly here so a missing libaio / misplaced plugin .so -# surfaces as a clear pytest skip instead of a confusing -# "Create vector column indexer failed" deep inside the collection code path. _DISKANN_PRELOAD_REASON: str | None = None _DISKANN_PRELOAD_DONE: bool = False def _ensure_diskann_runtime_or_reason() -> str | None: - """Preload the DiskAnn plugin and return None on success or a human-readable - skip reason on failure. Idempotent across calls.""" + """Check whether DiskAnn is available on this platform and return None + on success or a human-readable skip reason on failure. Idempotent across + calls.""" global _DISKANN_PRELOAD_DONE, _DISKANN_PRELOAD_REASON if _DISKANN_PRELOAD_DONE: return _DISKANN_PRELOAD_REASON _DISKANN_PRELOAD_DONE = True if not DISKANN_SUPPORTED: - _DISKANN_PRELOAD_REASON = "DiskAnn only supported on Linux x86_64" - return _DISKANN_PRELOAD_REASON - - if not zvec.is_libaio_available(): - _DISKANN_PRELOAD_REASON = ( - "libaio is not available on this host; DiskAnn cannot run. " - "Install libaio1 (or libaio1t64 on Ubuntu 24.04+) and retry." - ) + _DISKANN_PRELOAD_REASON = "DiskAnn is supported on Linux (x86_64/ARM64 with libaio) and macOS (kqueue)" return _DISKANN_PRELOAD_REASON - - status = zvec.load_diskann_plugin() - if status != zvec.DISKANN_PLUGIN_OK: - _DISKANN_PRELOAD_REASON = ( - f"Failed to load DiskAnn plugin (status={status}); " - "check that libzvec_diskann_plugin.so is installed alongside " - "_zvec.so in the Python site-packages directory." - ) - return _DISKANN_PRELOAD_REASON - _DISKANN_PRELOAD_REASON = None return None @@ -148,8 +124,7 @@ def full_schema_new(request) -> CollectionSchema: else: nullable, has_index, vector_index = True, False, HnswIndexParam() - # Skip DiskAnn tests on unsupported platforms or when the runtime cannot - # be brought up (missing libaio, plugin .so not installed, etc.). + # Skip DiskAnn tests on unsupported platforms. from zvec.model.param import DiskAnnIndexParam if isinstance(vector_index, DiskAnnIndexParam): diff --git a/python/tests/test_collection_diskann.py b/python/tests/test_collection_diskann.py index b0e12ce7e..458c93cad 100644 --- a/python/tests/test_collection_diskann.py +++ b/python/tests/test_collection_diskann.py @@ -13,17 +13,15 @@ # limitations under the License. """End-to-end collection tests for the DiskAnn index. -Mirrors ``test_collection_hnsw_rabitq.py`` but targets the DiskAnn plugin. +Mirrors ``test_collection_hnsw_rabitq.py`` but targets the DiskAnn index. Two platform-level prerequisites are enforced at module import time: -1. DiskAnn is currently built only for Linux x86_64 — other platforms are - skipped wholesale. -2. The DiskAnn backend lives in a *runtime-loaded* plugin - (``libzvec_diskann_plugin.so``). It must be loaded with ``RTLD_GLOBAL | - RTLD_NOW`` BEFORE ``import zvec`` so that the plugin's ``IndexFactory`` - singleton is unified with the one inside ``_zvec.so``. After ``import - zvec`` we must also call ``zvec.load_diskann_plugin()`` exactly once. +1. DiskAnn is built for Linux (x86_64/ARM64 with libaio) and macOS (with kqueue) — + other platforms are skipped wholesale. +2. libaio is loaded eagerly (via dlopen) inside DiskAnnBuilder::init() / + DiskAnnStreamer::init(). If libaio is missing, DiskAnn falls back to + synchronous pread() — the tests still run but with degraded performance. If either prerequisite fails the whole module is skipped so the rest of the test-suite is not affected. @@ -32,7 +30,6 @@ from __future__ import annotations import math -import os import platform import sys @@ -42,17 +39,16 @@ # Platform gating (must happen BEFORE we touch zvec). # --------------------------------------------------------------------------- # pytestmark = pytest.mark.skipif( - not (sys.platform == "linux" and platform.machine() in ("x86_64", "AMD64")), - reason="DiskAnn plugin is only supported on Linux x86_64", + not ( + ( + sys.platform == "linux" + and platform.machine() in ("x86_64", "AMD64", "aarch64", "arm64") + ) + or sys.platform == "darwin" + ), + reason="DiskAnn is supported on Linux (x86_64/ARM64 with libaio) and macOS (kqueue)", ) -# Promote all symbols in subsequently-loaded DSOs to the global namespace and -# resolve relocations eagerly. This is REQUIRED so the DiskAnn plugin can see -# the ``IndexFactory`` singleton that lives in ``_zvec.so`` and vice versa. -# See: DiskAnn RTLD_GLOBAL + RTLD_NOW Requirement. -if sys.platform == "linux": - sys.setdlopenflags(sys.getdlopenflags() | os.RTLD_GLOBAL | os.RTLD_NOW) - import zvec # noqa: E402 from zvec import ( # noqa: E402 diff --git a/python/zvec/__init__.py b/python/zvec/__init__.py index cfda0a4d5..d11cfea69 100644 --- a/python/zvec/__init__.py +++ b/python/zvec/__init__.py @@ -30,6 +30,7 @@ from zvec._zvec import ( get_default_jieba_dict_dir, + io_backend_type, set_default_jieba_dict_dir, ) @@ -43,21 +44,6 @@ # Public API — grouped by category # ============================== -# —— DiskAnn runtime plugin —— -# Re-export the plugin management entry points defined by the C++ extension. -# DiskAnn normally auto-loads on first use; these APIs let tests and -# diagnostic tools preload the plugin and get a clear error if libaio is -# missing or the plugin shared object cannot be located. -from zvec._zvec import ( - DISKANN_PLUGIN_DLOPEN_FAILED, - DISKANN_PLUGIN_LIBAIO_MISSING, - DISKANN_PLUGIN_OK, - DISKANN_PLUGIN_UNSUPPORTED_PLATFORM, - is_diskann_plugin_loaded, - is_libaio_available, - load_diskann_plugin, -) - from . import model as model # —— Extensions —— @@ -142,6 +128,7 @@ "open", "set_default_jieba_dict_dir", "get_default_jieba_dict_dir", + "io_backend_type", # Core classes "Collection", "Doc", @@ -203,14 +190,6 @@ "StatusCode", # Tools "require_module", - # DiskAnn plugin - "load_diskann_plugin", - "is_diskann_plugin_loaded", - "is_libaio_available", - "DISKANN_PLUGIN_OK", - "DISKANN_PLUGIN_UNSUPPORTED_PLATFORM", - "DISKANN_PLUGIN_LIBAIO_MISSING", - "DISKANN_PLUGIN_DLOPEN_FAILED", ] # ============================== diff --git a/src/ailego/io/io_backend.h b/src/ailego/io/io_backend.h new file mode 100644 index 000000000..647fb653c --- /dev/null +++ b/src/ailego/io/io_backend.h @@ -0,0 +1,114 @@ +// Copyright 2025-present the zvec project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Abstract I/O backend selector. +// +// Wraps the low-level loaders (LibAioLoader for libaio) and provides a uniform +// way to initialize, query, and report the active I/O backend. The actual I/O +// operations are still performed by the underlying loaders; this class is +// responsible only for backend initialization and reporting. +// +// When no async backend is available, the caller should fall back to +// synchronous pread(). +// +// Usage: +// auto& backend = ailego::IOBackend::Instance(); +// if (backend.available() != ailego::IOBackendType::kSyncPread) { ... } +// LOG_INFO("I/O backend: %s", backend.name()); + +#pragma once + +#include + +namespace zvec { +namespace ailego { + +// Supported I/O backend types. +enum class IOBackendType { + kSyncPread, // Synchronous pread() — no async I/O + kLibAio, // libaio loaded at runtime via dlopen() +}; + +// Returns a human-readable name for the given backend type. +inline const char *IOBackendTypeName(IOBackendType type) { + switch (type) { + case IOBackendType::kLibAio: + return "libaio"; + case IOBackendType::kSyncPread: + return "sync_pread"; + } + return "unknown"; +} + +// Singleton that loads and queries an I/O backend on demand. +// +// available() (no arg) tries the best backend with priority (libaio > pread) +// and returns the loaded backend type. +// available(IOBackendType) tries a specific backend. +// Use type() / name() to query the loaded backend without triggering a load. +class IOBackend { + public: + static IOBackend &Instance() { + static IOBackend instance; + return instance; + } + + // Try to load the best available backend (libaio > sync_pread). + // Returns the loaded backend type. + // Idempotent — if already loaded, returns immediately. + IOBackendType available() { + if (type_ != IOBackendType::kSyncPread) { + return type_; + } + return available(IOBackendType::kLibAio); + } + + // Try to load the requested backend. Returns the loaded backend type + // (may differ from requested if the load failed — falls back to kSyncPread). + // Idempotent — if the same backend is already loaded, returns immediately. + IOBackendType available(IOBackendType requested) { + if (type_ == requested && type_ != IOBackendType::kSyncPread) { + return type_; + } +#if defined(__linux) || defined(__linux__) + if (requested == IOBackendType::kLibAio) { + if (LibAioLoader::Instance().load() && + LibAioLoader::Instance().is_available()) { + type_ = IOBackendType::kLibAio; + return type_; + } + } +#endif + type_ = IOBackendType::kSyncPread; + return type_; + } + + // Returns the loaded backend type. + IOBackendType type() const { + return type_; + } + + // Human-readable name for the selected backend. + const char *name() const { + return IOBackendTypeName(type_); + } + + private: + IOBackend() = default; + + IOBackendType type_{IOBackendType::kSyncPread}; +}; + +} // namespace ailego +} // namespace zvec diff --git a/src/ailego/io/libaio_def.h b/src/ailego/io/libaio_def.h new file mode 100644 index 000000000..ce95bc982 --- /dev/null +++ b/src/ailego/io/libaio_def.h @@ -0,0 +1,190 @@ +// Copyright 2025-present the zvec project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Private replacement for . +// +// This header declares *only* the types, constants, and inline helpers that +// zvec needs from libaio. By doing so the project is completely decoupled +// from the system libaio-dev header: there is no `#include ` anywhere +// in the source tree, which means libaio-dev does not need to be installed at +// build time and the code is portable to cross-compilation environments that +// lack the header. +// +// The struct layouts (struct iocb, struct io_event, ...) are part of the Linux +// kernel ABI. They are copied verbatim from the upstream , including +// the PADDED macros that handle architecture-specific padding. The inline +// helper io_prep_pread() is likewise copied — it only manipulates struct fields +// and does not call into the library. + +#pragma once + +#include // struct timespec (used by io_getevents signature) +#include // memset() — used by io_prep_pread() inline helper + +#if defined(__linux) || defined(__linux__) + +struct sockaddr; +struct iovec; + +// --------------------------------------------------------------------------- +// Type and struct definitions copied from +// --------------------------------------------------------------------------- + +typedef struct io_context *io_context_t; + +typedef enum io_iocb_cmd { + IO_CMD_PREAD = 0, + IO_CMD_PWRITE = 1, + IO_CMD_FSYNC = 2, + IO_CMD_FDSYNC = 3, + IO_CMD_POLL = 5, + IO_CMD_NOOP = 6, + IO_CMD_PREADV = 7, + IO_CMD_PWRITEV = 8, +} io_iocb_cmd_t; + +// PADDED macros — copied verbatim from to guarantee ABI-compatible +// struct layout on every supported architecture. + +/* little endian, 32 bits */ +#if defined(__i386__) || (defined(__x86_64__) && defined(__ILP32__)) || \ + (defined(__arm__) && !defined(__ARMEB__)) || \ + (defined(__sh__) && defined(__LITTLE_ENDIAN__)) || defined(__bfin__) || \ + (defined(__MIPSEL__) && !defined(__mips64)) || defined(__cris__) || \ + defined(__loongarch32) || (defined(__riscv) && __riscv_xlen == 32) || \ + (defined(__GNUC__) && defined(__BYTE_ORDER__) && \ + __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ && __SIZEOF_LONG__ == 4) +#define AIO_PADDED(x, y) \ + x; \ + unsigned y +#define AIO_PADDEDptr(x, y) \ + x; \ + unsigned y +#define AIO_PADDEDul(x, y) \ + unsigned long x; \ + unsigned y + +/* little endian, 64 bits */ +#elif defined(__ia64__) || defined(__x86_64__) || defined(__alpha__) || \ + (defined(__mips64) && defined(__MIPSEL__)) || \ + (defined(__aarch64__) && defined(__AARCH64EL__)) || \ + defined(__loongarch64) || (defined(__riscv) && __riscv_xlen == 64) || \ + (defined(__GNUC__) && defined(__BYTE_ORDER__) && \ + __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ && __SIZEOF_LONG__ == 8) +#define AIO_PADDED(x, y) x, y +#define AIO_PADDEDptr(x, y) x +#define AIO_PADDEDul(x, y) unsigned long x + +/* big endian, 64 bits */ +#elif defined(__powerpc64__) || defined(__s390x__) || \ + (defined(__hppa__) && defined(__arch64__)) || \ + (defined(__sparc__) && defined(__arch64__)) || \ + (defined(__mips64) && defined(__MIPSEB__)) || \ + (defined(__aarch64__) && defined(__AARCH64EB__)) || \ + (defined(__GNUC__) && defined(__BYTE_ORDER__) && \ + __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__ && __SIZEOF_LONG__ == 8) +#define AIO_PADDED(x, y) \ + unsigned y; \ + x +#define AIO_PADDEDptr(x, y) x +#define AIO_PADDEDul(x, y) unsigned long x + +/* big endian, 32 bits */ +#elif defined(__PPC__) || defined(__s390__) || \ + (defined(__arm__) && defined(__ARMEB__)) || \ + (defined(__sh__) && defined(__BIG_ENDIAN__)) || defined(__sparc__) || \ + defined(__MIPSEB__) || defined(__m68k__) || defined(__hppa__) || \ + defined(__frv__) || defined(__avr32__) || \ + (defined(__GNUC__) && defined(__BYTE_ORDER__) && \ + __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__ && __SIZEOF_LONG__ == 4) +#define AIO_PADDED(x, y) \ + unsigned y; \ + x +#define AIO_PADDEDptr(x, y) \ + unsigned y; \ + x +#define AIO_PADDEDul(x, y) \ + unsigned y; \ + unsigned long x + +#else +#error endianness? +#endif + +struct io_iocb_poll { + AIO_PADDED(int events, __pad1); +}; + +struct io_iocb_sockaddr { + AIO_PADDEDptr(struct sockaddr *addr, __pad1); + AIO_PADDEDul(len, __pad2); +}; + +struct io_iocb_common { + AIO_PADDEDptr(void *buf, __pad1); + AIO_PADDEDul(nbytes, __pad2); + long long offset; + long long __pad3; + unsigned flags; + unsigned resfd; +}; + +struct io_iocb_vector { + AIO_PADDEDptr(const struct iovec *vec, __pad1); + AIO_PADDEDul(nr, __pad2); + long long offset; +}; + +struct iocb { + AIO_PADDEDptr(void *data, __pad1); + AIO_PADDED(unsigned key, aio_rw_flags); + short aio_lio_opcode; + short aio_reqprio; + int aio_fildes; + union { + struct io_iocb_common c; + struct io_iocb_vector v; + struct io_iocb_poll poll; + struct io_iocb_sockaddr saddr; + } u; +}; + +struct io_event { + AIO_PADDEDptr(void *data, __pad1); + AIO_PADDEDptr(struct iocb *obj, __pad2); + AIO_PADDEDul(res, __pad3); + AIO_PADDEDul(res2, __pad4); +}; + +#undef AIO_PADDED +#undef AIO_PADDEDptr +#undef AIO_PADDEDul + +// Inline helper — copied from . Only manipulates struct fields. +static inline void io_prep_pread(struct iocb *iocb, int fd, void *buf, + size_t count, long long offset) { + memset(iocb, 0, sizeof(*iocb)); + iocb->aio_fildes = fd; + iocb->aio_lio_opcode = IO_CMD_PREAD; + iocb->aio_reqprio = 0; + iocb->u.c.buf = buf; + iocb->u.c.nbytes = count; + iocb->u.c.offset = offset; +} + +// --------------------------------------------------------------------------- +// End: type and struct definitions from +// --------------------------------------------------------------------------- + +#endif // __linux__ diff --git a/src/ailego/io/libaio_loader.h b/src/ailego/io/libaio_loader.h new file mode 100644 index 000000000..7fbbbbfa1 --- /dev/null +++ b/src/ailego/io/libaio_loader.h @@ -0,0 +1,144 @@ +// Copyright 2025-present the zvec project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// dlopen-based wrapper for libaio. Instead of linking against -laio at build +// time, the DiskAnn plugin loads libaio at runtime via dlopen()/dlsym(). This +// removes libaio as a hard build- and load-time dependency: the plugin .so no +// longer carries a NEEDED entry for libaio.so.1, so it can be dlopen'ed on +// hosts that don't have libaio installed. Callers that actually exercise the +// async-I/O path will fall back to synchronous pread() when libaio is absent. +// +// All ABI-stable type and struct definitions (struct iocb, struct io_event, +// io_context_t, PADDED macros, io_prep_pread(), ...) now live in libaio_def.h — +// a private header that replaces so the project has zero build-time +// dependency on libaio-dev. + +#pragma once + +#if defined(__linux) || defined(__linux__) + +#include +#include +#include +#include +#include // ABI-stable struct definitions (replaces ) + +// Function-pointer typedefs for the four libaio syscalls used by DiskAnn. +typedef int (*aio_setup_fn)(int maxevents, io_context_t *ctxp); +typedef int (*aio_destroy_fn)(io_context_t ctx); +typedef int (*aio_submit_fn)(io_context_t ctx, long nr, struct iocb *ios[]); +typedef int (*aio_getevents_fn)(io_context_t ctx, long min_nr, long nr, + struct io_event *events, + struct timespec *timeout); + +// Runtime loader for libaio. Thread-safe singleton that dlopen()'s libaio +// once and caches the function pointers. If libaio is not present on the +// host, all pointers remain nullptr and callers should fall back to +// synchronous I/O (pread). +// +// Usage: +// if (LibAioLoader::Instance().load()) { +// LibAioLoader::Instance().io_setup(...); +// } +class LibAioLoader { + public: + static LibAioLoader &Instance() { + static LibAioLoader instance; + return instance; + } + + // Load (or confirm already loaded) libaio. Returns true on success. + // Thread-safe and idempotent. + bool load() { + if (available_.load(std::memory_order_acquire)) { + return true; + } + std::call_once(once_, [this] { this->try_load(); }); + return available_.load(std::memory_order_relaxed); + } + + bool is_available() const { + return available_.load(std::memory_order_acquire); + } + + // Function pointers — nullptr until load() succeeds. + aio_setup_fn io_setup; + aio_destroy_fn io_destroy; + aio_submit_fn io_submit; + aio_getevents_fn io_getevents; + + private: + LibAioLoader() + : io_setup(nullptr), + io_destroy(nullptr), + io_submit(nullptr), + io_getevents(nullptr) {} + + ~LibAioLoader() { + if (handle_ != nullptr) { + dlclose(handle_); + } + } + + LibAioLoader(const LibAioLoader &) = delete; + LibAioLoader &operator=(const LibAioLoader &) = delete; + + void try_load() { + // On Ubuntu 24.04 the libaio package was renamed with the t64 suffix + // (64-bit time_t transition), so probe both spellings. + static constexpr const char *kSonames[] = { + "libaio.so.1", + "libaio.so.1t64", + }; + + for (const char *soname : kSonames) { + void *h = dlopen(soname, RTLD_LAZY); + if (h == nullptr) { + continue; + } + + io_setup = reinterpret_cast(dlsym(h, "io_setup")); + io_destroy = reinterpret_cast(dlsym(h, "io_destroy")); + io_submit = reinterpret_cast(dlsym(h, "io_submit")); + + // io_getevents may be redirected to io_getevents_time64 on 32-bit + // platforms compiled with _TIME_BITS=64. + io_getevents = + reinterpret_cast(dlsym(h, "io_getevents")); + if (io_getevents == nullptr) { + io_getevents = + reinterpret_cast(dlsym(h, "io_getevents_time64")); + } + + if (io_setup && io_destroy && io_submit && io_getevents) { + handle_ = h; + available_.store(true, std::memory_order_release); + return; + } + + // Some symbols missing — try the next soname. + dlclose(h); + io_setup = nullptr; + io_destroy = nullptr; + io_submit = nullptr; + io_getevents = nullptr; + } + } + + std::once_flag once_; + std::atomic available_{false}; + void *handle_{nullptr}; +}; + +#endif // __linux__ diff --git a/src/binding/python/CMakeLists.txt b/src/binding/python/CMakeLists.txt index 0db6d75ff..7524502be 100644 --- a/src/binding/python/CMakeLists.txt +++ b/src/binding/python/CMakeLists.txt @@ -19,21 +19,6 @@ set(SRC_LISTS pybind11_add_module(_zvec ${SRC_LISTS}) -# pybind11_add_module() defaults to CXX_VISIBILITY_PRESET=hidden + -# VISIBILITY_INLINES_HIDDEN=ON, which hides the compiler-generated helper -# symbols attached to inline functions (guard variables for static locals, -# vtables, typeinfo ...). The DiskAnn runtime plugin has its own copy of -# Factory::Instance()'s guard variable; if _zvec.so's copy -# is hidden, the two guards are separate and the factory constructor runs -# twice during plugin load, wiping out the registrations that happened -# during _zvec.so import. We switch to default visibility here and rely on -# the version script (exports.map / exports.mac) to keep the dynamic -# symbol table small by exporting only zvec::* and PyInit_*. -set_target_properties(_zvec PROPERTIES - CXX_VISIBILITY_PRESET default - C_VISIBILITY_PRESET default - VISIBILITY_INLINES_HIDDEN OFF) - # Ensure any change to the linker version script (exports.map) triggers a # re-link of _zvec.so. target_link_options() alone is a command-line flag # and does not register the script file as a build dependency, so stale @@ -57,11 +42,11 @@ if (CMAKE_SYSTEM_NAME STREQUAL "Linux") $ $ $ + $ $ $ $ $ - $ -Wl,--no-whole-archive zvec ${CMAKE_DL_LIBS} @@ -69,21 +54,11 @@ if (CMAKE_SYSTEM_NAME STREQUAL "Linux") target_link_options(_zvec PRIVATE "LINKER:--version-script=${CMAKE_CURRENT_SOURCE_DIR}/exports.map" ) - # DiskAnn is x86-only (it depends on libaio, unavailable on ARM64), so the - # runtime plugin (libzvec_diskann_plugin.so) is only produced on non-ARM - # builds. It is shipped as a runtime-loaded shared module and brought up - # implicitly the first time a DiskAnn index is created — users never need to - # call any load function. If libaio is missing at runtime the auto-load - # fails cleanly and the error is surfaced only when DiskAnn is actually - # used; other index types (HNSW/IVF/Flat/Vamana) remain fully functional. - # The .so must therefore be discoverable next to the extension module, - # hence the $ORIGIN rpath below. - if (NOT CMAKE_SYSTEM_PROCESSOR MATCHES "aarch64|arm64|arm") - set_target_properties(_zvec PROPERTIES - BUILD_RPATH "$ORIGIN" - INSTALL_RPATH "$ORIGIN" - ) - endif() + # DiskAnn is now statically linked into _zvec.so via --whole-archive, so + # no separate runtime .so is shipped in the wheel. libaio is still loaded + # at runtime via dlopen() (see libaio_loader.h); if it is missing, DiskAnn + # fails cleanly with an actionable error while other index types + # (HNSW/IVF/Flat/Vamana) remain fully functional. elseif (APPLE) target_link_libraries(_zvec PRIVATE -Wl,-force_load,$ @@ -94,11 +69,11 @@ elseif (APPLE) -Wl,-force_load,$ -Wl,-force_load,$ -Wl,-force_load,$ + -Wl,-force_load,$ -Wl,-force_load,$ -Wl,-force_load,$ -Wl,-force_load,$ -Wl,-force_load,$ - -Wl,-force_load,$ zvec ) target_link_libraries(_zvec PRIVATE @@ -113,11 +88,11 @@ elseif (MSVC) core_knn_ivf_static core_knn_vamana_static core_knn_cluster_static + core_knn_diskann_static core_mix_reducer_static core_metric_static core_utility_static core_quantizer_static - core_plugin ) target_link_libraries(_zvec PRIVATE ${_zvec_whole_archive_libs} diff --git a/src/binding/python/binding.cc b/src/binding/python/binding.cc index ecb4d91bb..729a54d15 100644 --- a/src/binding/python/binding.cc +++ b/src/binding/python/binding.cc @@ -13,7 +13,6 @@ // limitations under the License. #include -#include #include "python_collection.h" #include "python_config.h" #include "python_doc.h" @@ -24,39 +23,6 @@ namespace zvec { -namespace { - -// Expose DiskAnn plugin management to Python. The DiskAnn runtime normally -// auto-loads on first use, but tests (and diagnostic tooling) need a way to -// force a load up-front and get actionable errors when libaio is missing or -// the plugin shared object cannot be located. -void InitializeDiskAnnPluginBindings(pybind11::module_ &m) { - m.def( - "load_diskann_plugin", - [](const std::string &path) { return ::zvec::LoadDiskAnnPlugin(path); }, - pybind11::arg("path") = std::string(), - "Load the DiskAnn runtime plugin. Returns 0 on success or a negative " - "DiskAnnPluginStatus code on failure (unsupported platform, libaio " - "missing, or dlopen failure)."); - m.def("is_diskann_plugin_loaded", &::zvec::IsDiskAnnPluginLoaded, - "Return True if the DiskAnn runtime plugin is currently loaded."); - m.def("is_libaio_available", &::zvec::IsLibAioAvailable, - "Return True if libaio is resolvable on this host (required by the " - "DiskAnn runtime)."); - - // Status constants so callers can compare against well-known codes without - // hard-coding integers. - m.attr("DISKANN_PLUGIN_OK") = static_cast(::zvec::kDiskAnnPluginOk); - m.attr("DISKANN_PLUGIN_UNSUPPORTED_PLATFORM") = - static_cast(::zvec::kDiskAnnPluginUnsupportedPlatform); - m.attr("DISKANN_PLUGIN_LIBAIO_MISSING") = - static_cast(::zvec::kDiskAnnPluginLibAioMissing); - m.attr("DISKANN_PLUGIN_DLOPEN_FAILED") = - static_cast(::zvec::kDiskAnnPluginDlopenFailed); -} - -} // namespace - PYBIND11_MODULE(_zvec, m) { m.doc() = "Zvec core module"; @@ -67,6 +33,5 @@ PYBIND11_MODULE(_zvec, m) { ZVecPyConfig::Initialize(m); ZVecPyDoc::Initialize(m); ZVecPyCollection::Initialize(m); - InitializeDiskAnnPluginBindings(m); } } // namespace zvec diff --git a/src/binding/python/exports.map b/src/binding/python/exports.map index 553da0055..66d92e04f 100644 --- a/src/binding/python/exports.map +++ b/src/binding/python/exports.map @@ -1,34 +1,6 @@ { global: - # Python module entry point(s). - PyInit_*; - - # Expose the full zvec C++ namespace so the DiskAnn runtime plugin - # (libzvec_diskann_plugin.so), which is dlopen()ed with - # RTLD_NOW | RTLD_GLOBAL after the interpreter has loaded _zvec.so, - # can resolve its undefined references against this module. Without - # this, the plugin fails to load with errors like - # undefined symbol: _ZN4zvec6ailego6Logger10LEVEL_INFOE - # because the default version script hides every internal symbol. - extern "C++" { - "zvec::*"; - zvec::*; - # Also export the compiler-generated helper symbols that live - # alongside symbols in the zvec namespace (guard variables for - # static locals, vtables, typeinfo, VTT, construction vtables, - # thunks). Without these, the DiskAnn plugin and _zvec.so each - # get their own copy of e.g. the guard for Factory::Instance's - # static local, which causes the factory constructor to run - # twice - wiping out registrations done during _zvec.so load. - "guard variable for zvec::*"; - "vtable for zvec::*"; - "VTT for zvec::*"; - "typeinfo for zvec::*"; - "typeinfo name for zvec::*"; - "construction vtable for zvec::*"; - "non-virtual thunk to zvec::*"; - "virtual thunk to zvec::*"; - }; + PyInit_*; # export only python related functions local: *; }; diff --git a/src/binding/python/model/common/python_config.cc b/src/binding/python/model/common/python_config.cc index dade4bbc3..866f14c9a 100644 --- a/src/binding/python/model/common/python_config.cc +++ b/src/binding/python/model/common/python_config.cc @@ -13,6 +13,7 @@ // limitations under the License. #include "python_config.h" +#include #include namespace zvec { @@ -217,6 +218,26 @@ void ZVecPyConfig::Initialize(pybind11::module_ &m) { "get_default_jieba_dict_dir", []() -> std::string { return GlobalConfig::Instance().jieba_dict_dir(); }, "Read the currently registered default jieba dict directory."); + + // Returns the current I/O backend type for DiskAnn async disk reads. + // When only sync_pread is available, prints the install hint to stdout. + m.def( + "io_backend_type", + []() -> std::string { + auto type = ailego::IOBackend::Instance().available(); + std::string name = ailego::IOBackendTypeName(type); + if (type == ailego::IOBackendType::kSyncPread) { + py::print( + "No async I/O backend available. Install libaio (e.g. " + "'apt-get install libaio1', or 'libaio1t64' on Ubuntu 24.04+) " + "and retry. DiskAnn will fall back to synchronous pread() — " + "performance will be degraded."); + } + return name; + }, + "Returns the current I/O backend type for DiskAnn async disk reads. " + "\"libaio\" if libaio is available, \"sync_pread\" otherwise. " + "When \"sync_pread\", prints the install hint to stdout."); } diff --git a/src/binding/python/model/python_collection.cc b/src/binding/python/model/python_collection.cc index b1311f119..66944a0df 100644 --- a/src/binding/python/model/python_collection.cc +++ b/src/binding/python/model/python_collection.cc @@ -310,7 +310,16 @@ void ZVecPyCollection::bind_dql_methods( "given vector column. One of 'mmap', 'buffer_pool', 'contiguous'. " "Raises KeyError if no HNSW index exists on the column, or " "ValueError if the column's index is not an HNSW index. Intended " - "for introspection and testing only; not part of the stable API."); + "for introspection and testing only; not part of the stable API.") + .def( + "_debug_io_backend_type", + [](const Collection &self) { + const auto result = self.DebugGetIoBackendType(); + return unwrap_expected(result); + }, + "Debug-only: returns the I/O backend type used by DiskAnn. " + "One of 'libaio', 'sync_pread'. Intended for introspection and " + "testing only; not part of the stable API."); } } // namespace zvec \ No newline at end of file diff --git a/src/core/CMakeLists.txt b/src/core/CMakeLists.txt index c52c3b8cc..866edd222 100644 --- a/src/core/CMakeLists.txt +++ b/src/core/CMakeLists.txt @@ -49,7 +49,6 @@ cc_directory(quantizer) cc_directory(utility) cc_directory(interface) cc_directory(mixed_reducer) -cc_directory(plugin) git_version(GIT_SRCS_VER ${CMAKE_CURRENT_SOURCE_DIR}) file(GLOB_RECURSE ALL_CORE_SRCS *.cc *.c *.h) @@ -63,17 +62,18 @@ endif() # Always exclude algorithm/diskann implementation files from zvec_core. # The DiskAnn algorithm is provided by the separate core_knn_diskann library -# (real on Linux x86_64, stub on other platforms). Including them here causes -# duplicate symbols and missing -laio when test binaries link both zvec_core -# (via zvec) and core_knn_diskann. - +# (STATIC+SHARED, real on Linux x86_64/ARM64 with libaio and macOS with kqueue, +# stub on other platforms). The static variant is whole-archived into _zvec.so +# for the Python wheel; the shared variant is used by C++ tools and tests. +# Including the sources here would cause duplicate symbols. list(FILTER ALL_CORE_SRCS EXCLUDE REGEX ".*/algorithm/diskann/.*") if(NOT DISKANN_SUPPORTED) list(FILTER ALL_CORE_SRCS EXCLUDE REGEX ".*/interface/indexes/diskann_index\\.cc") endif() set(ZVEC_CORE_LIBS zvec_ailego zvec_turbo sparsehash magic_enum rabitqlib) -# The plugin loader uses dlopen/dlsym, so link libdl on Linux. +# The DiskAnn runtime loader (LibAioLoader) uses dlopen/dlsym, so link libdl +# on Linux. On macOS, kqueue is part of the system and does not require dlopen. if(CMAKE_SYSTEM_NAME STREQUAL "Linux") list(APPEND ZVEC_CORE_LIBS ${CMAKE_DL_LIBS}) endif() diff --git a/src/core/algorithm/CMakeLists.txt b/src/core/algorithm/CMakeLists.txt index bed772984..23aea7773 100644 --- a/src/core/algorithm/CMakeLists.txt +++ b/src/core/algorithm/CMakeLists.txt @@ -17,13 +17,18 @@ else() # Empty stub library for unsupported platforms file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/diskann_stub.cc "// Stub implementation for unsupported platforms\n" - "// DiskAnn only supports Linux x86_64\n" + "// DiskAnn supports Linux (x86_64/ARM64 with libaio) and macOS (kqueue)\n" "namespace zvec { namespace core { /* empty namespace for compatibility */ } }\n" ) if(MSVC) # MSVC: STATIC-only stub to avoid creating an empty DLL with no exports - # (MSVC linker fails to produce an import library when there are zero exports) + # (MSVC linker fails to produce an import library when there are zero exports). + # cc_library with STATIC-only creates target "core_knn_diskann" but NOT the + # "core_knn_diskann_static" variant (that only happens with STATIC+SHARED). + # The Python binding references core_knn_diskann_static on all platforms, so + # create an ALIAS so the same target name works under MSVC as well. + # ($ supports ALIAS targets since CMake 3.18.) cc_library( NAME core_knn_diskann STATIC STRICT ALWAYS_LINK @@ -32,6 +37,7 @@ else() INCS . ${PROJECT_ROOT_DIR}/src ${PROJECT_ROOT_DIR}/src/core ${PROJECT_ROOT_DIR}/src/core/algorithm VERSION "${PROXIMA_ZVEC_VERSION}" ) + add_library(core_knn_diskann_static ALIAS core_knn_diskann) else() cc_library( NAME core_knn_diskann diff --git a/src/core/algorithm/diskann/CMakeLists.txt b/src/core/algorithm/diskann/CMakeLists.txt index 1b2252497..bb1746c63 100644 --- a/src/core/algorithm/diskann/CMakeLists.txt +++ b/src/core/algorithm/diskann/CMakeLists.txt @@ -1,57 +1,34 @@ include(${PROJECT_ROOT_DIR}/cmake/bazel.cmake) +include(${PROJECT_ROOT_DIR}/cmake/option.cmake) file(GLOB_RECURSE ALL_SRCS *.cc *.c) -# The DiskAnn plugin is loaded at runtime via zvec::LoadDiskAnnPlugin() with -# RTLD_GLOBAL, so its undefined references to internal zvec symbols -# (core_framework, core_knn_cluster, zvec_ailego, ...) are resolved at load -# time against the hosting binary (_zvec.so for the Python extension, the -# test executable for gtest, or libzvec_core for tools). +# DiskAnn is compiled as a STATIC+SHARED library (matching the pattern used by +# core_knn_hnsw, core_knn_cluster, etc.). The static variant +# (core_knn_diskann_static) is whole-archived into _zvec.so for the Python +# wheel, so no separate runtime .so is needed. The shared variant is used by +# C++ tools and tests that link against it directly. # -# As a consequence the plugin .so must NOT carry NEEDED entries for those -# libs: otherwise the dynamic loader would try to resolve them from disk -# before invoking dlopen's RTLD_GLOBAL symbol sharing, and the Python wheel -# (which only ships _zvec.so + the plugin) would fail to load. -# -# We therefore link the plugin only against its system-level dependency -# (libaio) and rely on the global include dirs plus -Wl,--unresolved-symbols -# =ignore-all to let the linker build a shared library with unresolved -# references to internal APIs. -set(CORE_KNN_DISKANN_LIBS "") +# libaio is loaded at runtime via dlopen()/dlsym() (see libaio_loader.h), so +# we do NOT link against -laio. The only system-level link dependency is +# ${CMAKE_DL_LIBS} for dlopen/dlsym/dlclose. +set(CORE_KNN_DISKANN_LIBS core_framework core_knn_cluster) + +if(CMAKE_SYSTEM_NAME STREQUAL "Linux" AND CMAKE_SYSTEM_PROCESSOR MATCHES "x86_64|i686|i386|aarch64|arm64") + list(APPEND CORE_KNN_DISKANN_LIBS ${CMAKE_DL_LIBS}) +endif() -if(CMAKE_SYSTEM_NAME STREQUAL "Linux" AND CMAKE_SYSTEM_PROCESSOR MATCHES "x86_64|i686|i386") - list(APPEND CORE_KNN_DISKANN_LIBS aio) +if(NOT APPLE) + set(CORE_KNN_DISKANN_LDFLAGS + "-Wl,--exclude-libs,libparquet.a:libarrow.a:libarrow_bundled_dependencies.a") endif() cc_library( NAME core_knn_diskann - SHARED STRICT + STATIC SHARED STRICT ALWAYS_LINK SRCS *.cc LIBS ${CORE_KNN_DISKANN_LIBS} INCS . ${PROJECT_ROOT_DIR}/src/core ${PROJECT_ROOT_DIR}/src/core/algorithm + LDFLAGS "${CORE_KNN_DISKANN_LDFLAGS}" VERSION "${PROXIMA_ZVEC_VERSION}" -) - -# Internal zvec libs are referenced only for header availability; the actual -# symbol resolution happens at dlopen time. Expose their public include dirs -# without adding them as link dependencies. -foreach(_dep zvec_ailego core_framework core_knn_cluster) - if(TARGET ${_dep}) - target_include_directories(core_knn_diskann PRIVATE - $) - add_dependencies(core_knn_diskann ${_dep}) - endif() -endforeach() - -# Allow the plugin to have unresolved symbols that will be satisfied at -# dlopen(RTLD_NOW | RTLD_GLOBAL) time by the hosting binary. -if(CMAKE_SYSTEM_NAME STREQUAL "Linux") - target_link_options(core_knn_diskann PRIVATE - "LINKER:--unresolved-symbols=ignore-all") -endif() - -# Rename the artifact to libzvec_diskann_plugin.so so it is clearly identified -# as an optional plugin that users load at runtime via zvec::LoadDiskAnnPlugin(). -set_target_properties(core_knn_diskann PROPERTIES - OUTPUT_NAME zvec_diskann_plugin ) \ No newline at end of file diff --git a/src/core/algorithm/diskann/diskann_builder.cc b/src/core/algorithm/diskann/diskann_builder.cc index e344844f0..0186dfdf3 100644 --- a/src/core/algorithm/diskann/diskann_builder.cc +++ b/src/core/algorithm/diskann/diskann_builder.cc @@ -17,6 +17,7 @@ #include #include #include +#include #include #include #include @@ -32,6 +33,23 @@ namespace core { int DiskAnnBuilder::init(const IndexMeta &meta, const ailego::Params ¶ms) { LOG_INFO("Begin DiskAnnBuilder::init"); +#if defined(__linux__) || defined(__linux) + // Eagerly probe the I/O backend at init time so the user gets immediate + // feedback about whether async I/O is available. IOBackend auto-probes on + // first Instance() access. + auto &backend = ailego::IOBackend::Instance(); + if (backend.available() == ailego::IOBackendType::kSyncPread) { + LOG_WARN( + "DiskAnn: no async I/O backend available. Install libaio (e.g. " + "'apt-get install libaio1', or 'libaio1t64' on Ubuntu 24.04+) and " + "retry. DiskAnn will fall back to synchronous pread() — performance " + "will be degraded."); + } else { + LOG_INFO("DiskAnn: I/O backend '%s' loaded — async I/O enabled.", + backend.name()); + } +#endif + params.get(PARAM_DISKANN_BUILDER_MAX_DEGREE, &max_degree_); params.get(PARAM_DISKANN_BUILDER_LIST_SIZE, &list_size_); params.get(PARAM_DISKANN_BUILDER_THREAD_COUNT, &build_thread_count_); diff --git a/src/core/algorithm/diskann/diskann_context.h b/src/core/algorithm/diskann/diskann_context.h index dd824ff23..e5729a19f 100644 --- a/src/core/algorithm/diskann/diskann_context.h +++ b/src/core/algorithm/diskann/diskann_context.h @@ -349,7 +349,13 @@ class DiskAnnContext : public IndexContext, uint32_t group_num_{0}; std::map group_topk_heaps_{}; - IOContext io_ctx_{0}; + IOContext io_ctx_{ +#if defined(__APPLE__) || defined(__MACH__) + -1 +#else + 0 +#endif + }; SearchStats query_stats_; float *pq_table_dist_buffer_{nullptr}; diff --git a/src/core/algorithm/diskann/diskann_entity.h b/src/core/algorithm/diskann/diskann_entity.h index af302290d..cdaeaed33 100644 --- a/src/core/algorithm/diskann/diskann_entity.h +++ b/src/core/algorithm/diskann/diskann_entity.h @@ -72,17 +72,6 @@ struct DiskAnnMetaHeader { clear(); } - DiskAnnMetaHeader(const DiskAnnMetaHeader &header) { - memcpy(this, &header, sizeof(header)); - } - - DiskAnnMetaHeader &operator=(const DiskAnnMetaHeader &header) { - if (this != &header) { - memcpy(this, &header, sizeof(header)); - } - return *this; - } - void reset() { doc_cnt = 0U; } @@ -104,15 +93,6 @@ struct DiskAnnPqMeta { clear(); } - DiskAnnPqMeta(const DiskAnnPqMeta &meta) { - memcpy(this, &meta, sizeof(meta)); - } - - DiskAnnPqMeta &operator=(const DiskAnnPqMeta &meta) { - memcpy(this, &meta, sizeof(meta)); - return *this; - } - void clear() { memset(this, 0, sizeof(DiskAnnPqMeta)); } diff --git a/src/core/algorithm/diskann/diskann_file_reader.cc b/src/core/algorithm/diskann/diskann_file_reader.cc index 4268d5156..c3cbf7e60 100644 --- a/src/core/algorithm/diskann/diskann_file_reader.cc +++ b/src/core/algorithm/diskann/diskann_file_reader.cc @@ -18,7 +18,12 @@ #include #include #include +#include #include +#if defined(__APPLE__) || defined(__MACH__) +#include +#include +#endif #define MAX_EVENTS 1024 @@ -28,13 +33,40 @@ namespace core { #if (defined(__linux) || defined(__linux__)) typedef struct io_event io_event_t; typedef struct iocb iocb_t; + +// Ensures the I/O backend selection is logged exactly once per process, +// regardless of which entry point (setup_io_ctx or register_thread) +// triggers it first. +static std::once_flag g_io_backend_log_once; #endif int setup_io_ctx(IOContext &ctx) { #if (defined(__linux) || defined(__linux__)) - int ret = io_setup(MAX_EVENTS, &ctx); - + auto &backend = ailego::IOBackend::Instance(); + std::call_once(g_io_backend_log_once, [&backend] { + if (backend.available() != ailego::IOBackendType::kSyncPread) { + LOG_INFO("DiskAnn I/O backend: %s (async I/O enabled)", backend.name()); + } else { + LOG_WARN( + "DiskAnn I/O backend: synchronous pread (no async I/O available)"); + } + }); + if (backend.available() == ailego::IOBackendType::kSyncPread) { + return 0; + } + int ret = LibAioLoader::Instance().io_setup(MAX_EVENTS, &ctx); return ret; +#elif defined(__APPLE__) || defined(__MACH__) + // Create a kqueue for this context. On macOS the kqueue is used to + // monitor file descriptor readiness for async-style I/O. + int kq = ::kqueue(); + if (kq == -1) { + LOG_ERROR("kqueue() failed in setup_io_ctx; errno=%d, %s", errno, + ::strerror(errno)); + return IndexError_Runtime; + } + ctx = kq; + return 0; #else return 0; #endif @@ -42,9 +74,18 @@ int setup_io_ctx(IOContext &ctx) { int destroy_io_ctx(IOContext &ctx) { #if (defined(__linux) || defined(__linux__)) - int ret = io_destroy(ctx); - + if (ailego::IOBackend::Instance().available() == + ailego::IOBackendType::kSyncPread) { + return 0; + } + int ret = LibAioLoader::Instance().io_destroy(ctx); return ret; +#elif defined(__APPLE__) || defined(__MACH__) + if (ctx >= 0) { + ::close(ctx); + ctx = -1; + } + return 0; #else return 0; #endif @@ -68,9 +109,117 @@ static int execute_io_pread(int fd, std::vector &read_reqs) { return 0; } +#if defined(__APPLE__) || defined(__MACH__) +// Execute batch I/O on macOS using kqueue to monitor file descriptor +// readiness and pread for actual data transfer. +// +// On macOS, regular file descriptors are almost always "readable", so +// kqueue's primary value here is providing the same async I/O interface +// as Linux's libaio. For each read request we: +// 1. Attempt a non-blocking pread (via O_NONBLOCK on the fd). +// 2. If EAGAIN, wait on kqueue for EVFILT_READ readiness, then retry. +// 3. Fall back to blocking pread if kqueue encounters an error. +// +// The kqueue fd is passed in as the IOContext. If no valid kqueue is +// available, we fall back to plain blocking pread. +static int execute_io_kqueue(int kq, int fd, + std::vector &read_reqs) { + // If no kqueue available, fall back to blocking pread. + if (kq < 0) { + return execute_io_pread(fd, read_reqs); + } + + // Register the file descriptor with the kqueue for read events. + // EV_CLEAR gives edge-triggered semantics so we only get notified + // when new data becomes available. + struct kevent ke; + EV_SET(&ke, fd, EVFILT_READ, EV_ADD | EV_CLEAR, 0, 0, nullptr); + + for (auto &req : read_reqs) { + while (true) { + ssize_t bytes_read = ::pread(fd, req.buf, req.len, req.offset); + + if (bytes_read > 0) { + // Successfully read data; verify full read. + if ((size_t)bytes_read != req.len) { + // Partial read — retry for the remaining bytes. + // Update offset and buffer to read the rest. + char *buf_ptr = static_cast(req.buf) + bytes_read; + uint64_t new_offset = req.offset + bytes_read; + size_t remaining = req.len - bytes_read; + while (remaining > 0) { + ssize_t n = ::pread(fd, buf_ptr, remaining, new_offset); + if (n < 0) { + if (errno == EINTR) continue; + LOG_ERROR("pread retry failed; errno=%d, %s", errno, + ::strerror(errno)); + return IndexError_Runtime; + } + if (n == 0) break; + buf_ptr += n; + new_offset += n; + remaining -= n; + } + if (remaining > 0) { + LOG_ERROR("pread short read after retry; remaining=%zu", remaining); + return IndexError_Runtime; + } + } + break; // Success, move to next request. + } + + if (bytes_read == 0) { + // EOF — should not happen for a valid index file. + LOG_ERROR("pread returned 0 (EOF); offset=%lu, len=%lu", + (unsigned long)req.offset, (unsigned long)req.len); + return IndexError_Runtime; + } + + // bytes_read == -1, error + if (errno == EINTR) { + continue; // Retry on signal. + } + if (errno == EAGAIN || errno == EWOULDBLOCK) { + // Data not ready — wait on kqueue for readability. + struct kevent events[1]; + struct timespec ts; + ts.tv_sec = 5; // 5 second timeout as a safety net. + ts.tv_nsec = 0; + int n_ev = ::kevent(kq, &ke, 1, events, 1, &ts); + if (n_ev < 0) { + if (errno == EINTR) continue; + // kqueue error — fall back to blocking pread for this request. + LOG_WARN("kevent failed; errno=%d, %s, falling back to pread", errno, + ::strerror(errno)); + return execute_io_pread(fd, read_reqs); + } + if (n_ev == 0) { + // Timeout — fall back to blocking pread. + LOG_WARN("kqueue timeout, falling back to pread"); + return execute_io_pread(fd, read_reqs); + } + // Event triggered — retry pread. + continue; + } + + // Other error — fall back to blocking pread. + LOG_ERROR("pread failed; errno=%d, %s, falling back to pread", errno, + ::strerror(errno)); + return execute_io_pread(fd, read_reqs); + } + } + + return 0; +} +#endif // __APPLE__ + int execute_io(IOContext ctx, int fd, std::vector &read_reqs, uint64_t n_retries = 0) { #if (defined(__linux) || defined(__linux__)) + if (ailego::IOBackend::Instance().available() == + ailego::IOBackendType::kSyncPread) { + return execute_io_pread(fd, read_reqs); + } uint64_t iters = DiskAnnUtil::div_round_up(read_reqs.size(), MAX_EVENTS); for (uint64_t iter = 0; iter < iters; iter++) { @@ -93,7 +242,8 @@ int execute_io(IOContext ctx, int fd, std::vector &read_reqs, size_t n_tries = 0; // Phase 1: io_submit with retry. while (true) { - int ret = io_submit(ctx, (int64_t)n_ops, cbs.data()); + int ret = + LibAioLoader::Instance().io_submit(ctx, (int64_t)n_ops, cbs.data()); if (ret == (int)n_ops) { break; } @@ -111,8 +261,8 @@ int execute_io(IOContext ctx, int fd, std::vector &read_reqs, // Phase 2: io_getevents with retry (never re-submits). n_tries = 0; while (true) { - int ret = io_getevents(ctx, (int64_t)n_ops, (int64_t)n_ops, evts.data(), - nullptr); + int ret = LibAioLoader::Instance().io_getevents( + ctx, (int64_t)n_ops, (int64_t)n_ops, evts.data(), nullptr); if (ret == (int)n_ops) { break; } @@ -144,7 +294,13 @@ int execute_io(IOContext ctx, int fd, std::vector &read_reqs, } return 0; +#elif defined(__APPLE__) || defined(__MACH__) + // On macOS, use kqueue-based I/O. The IOContext (ctx) is a kqueue fd. + (void)n_retries; + return execute_io_kqueue(ctx, fd, read_reqs); #else + (void)ctx; + (void)n_retries; return execute_io_pread(fd, read_reqs); #endif } @@ -182,29 +338,56 @@ void LinuxAlignedFileReader::register_thread() { std::unique_lock lk(ctx_mut); if (ctx_map.find(thread_id) != ctx_map.end()) { LOG_ERROR("multiple calls to register_thread from the same thread"); - return; } IOContext ctx = nullptr; - int ret = io_setup(MAX_EVENTS, &ctx); - if (ret != 0) { + auto &backend = ailego::IOBackend::Instance(); + std::call_once(g_io_backend_log_once, [&backend] { + if (backend.available() != ailego::IOBackendType::kSyncPread) { + LOG_INFO("DiskAnn I/O backend: %s (async I/O enabled)", backend.name()); + } else { + LOG_WARN( + "DiskAnn I/O backend: synchronous pread (no async I/O available)"); + } + }); + if (backend.available() == ailego::IOBackendType::kSyncPread) { lk.unlock(); + return; + } + int ret = LibAioLoader::Instance().io_setup(MAX_EVENTS, &ctx); + if (ret != 0) { if (ret == -EAGAIN) { LOG_ERROR( "io_setup failed with EAGAIN: Consider increasing " "/proc/sys/fs/aio-max-nr"); } else { LOG_ERROR("io_setup failed; returned: %d, %s", ret, ::strerror(-ret)); - ; } } else { LOG_INFO("allocating ctx: %lu", (uint64_t)ctx); - ctx_map[thread_id] = ctx; } + lk.unlock(); +#elif defined(__APPLE__) || defined(__MACH__) + auto thread_id = std::this_thread::get_id(); + std::unique_lock lk(ctx_mut); + if (ctx_map.find(thread_id) != ctx_map.end()) { + LOG_ERROR("multiple calls to register_thread from the same thread"); + return; + } + IOContext ctx = -1; + int kq = ::kqueue(); + if (kq == -1) { + LOG_ERROR("kqueue() failed in register_thread; errno=%d, %s", errno, + ::strerror(errno)); + } else { + LOG_INFO("allocating kqueue ctx: %d", kq); + ctx = kq; + ctx_map[thread_id] = ctx; + } lk.unlock(); #endif } @@ -226,17 +409,52 @@ void LinuxAlignedFileReader::deregister_thread() { } // io_destroy is a syscall; keep it outside the lock to avoid blocking others - io_destroy(ctx); + if (ailego::IOBackend::Instance().available() != + ailego::IOBackendType::kSyncPread) { + LibAioLoader::Instance().io_destroy(ctx); + } LOG_INFO("returned ctx from thread"); +#elif defined(__APPLE__) || defined(__MACH__) + auto thread_id = std::this_thread::get_id(); + IOContext ctx; + + { + std::lock_guard lk(ctx_mut); + auto it = ctx_map.find(thread_id); + if (it == ctx_map.end()) { + LOG_ERROR("deregister_thread: thread not registered"); + return; + } + ctx = it->second; + ctx_map.erase(it); + } + + if (ctx >= 0) { + ::close(ctx); + } + LOG_INFO("returned kqueue ctx from thread"); #endif } void LinuxAlignedFileReader::deregister_all_threads() { #if (defined(__linux) || defined(__linux__)) + std::unique_lock lk(ctx_mut); + bool aio_available = ailego::IOBackend::Instance().available() != + ailego::IOBackendType::kSyncPread; + for (auto x = ctx_map.begin(); x != ctx_map.end(); x++) { + IOContext ctx = x->second; + if (aio_available) { + LibAioLoader::Instance().io_destroy(ctx); + } + } + ctx_map.clear(); +#elif defined(__APPLE__) || defined(__MACH__) std::unique_lock lk(ctx_mut); for (auto x = ctx_map.begin(); x != ctx_map.end(); x++) { IOContext ctx = x->second; - io_destroy(ctx); + if (ctx >= 0) { + ::close(ctx); + } } ctx_map.clear(); #endif @@ -268,6 +486,32 @@ void LinuxAlignedFileReader::open(const std::string &fname) { ::strerror(errno)); } +#if defined(__APPLE__) || defined(__MACH__) + // macOS has no O_DIRECT. F_NOCACHE is its closest per-file equivalent: it + // asks the kernel to minimize caching for I/O through this descriptor. This + // is advisory rather than a guarantee that every read reaches the device. + // Disable read-ahead as well because DiskAnn performs random reads. + // + // Do not mmap the entire index and call msync(MS_INVALIDATE) here. That does + // not provide a reliable global cache eviction guarantee and makes open time + // and virtual-address usage scale with the size of the index. + if (this->file_desc != -1) { + if (::fcntl(this->file_desc, F_NOCACHE, 1) == -1) { + LOG_WARN("fcntl(F_NOCACHE) failed for %s (errno=%d: %s); reads will use " + "the page cache", + fname.c_str(), errno, ::strerror(errno)); + } else { + LOG_INFO("DiskAnn macOS: F_NOCACHE enabled for %s", + fname.c_str()); + } + + if (::fcntl(this->file_desc, F_RDAHEAD, 0) == -1) { + LOG_WARN("fcntl(F_RDAHEAD, 0) failed for %s (errno=%d: %s)", fname.c_str(), + errno, ::strerror(errno)); + } + } +#endif + LOG_INFO("Opened file : %s", fname.c_str()); } @@ -294,6 +538,5 @@ int LinuxAlignedFileReader::read(std::vector &read_reqs, return ret; } - } // namespace core } // namespace zvec diff --git a/src/core/algorithm/diskann/diskann_file_reader.h b/src/core/algorithm/diskann/diskann_file_reader.h index 432247e79..c2702c399 100644 --- a/src/core/algorithm/diskann/diskann_file_reader.h +++ b/src/core/algorithm/diskann/diskann_file_reader.h @@ -18,11 +18,20 @@ #include #if (defined(__linux) || defined(__linux__)) -#include +#include // dlopen-based libaio wrapper +#endif + +#if defined(__APPLE__) || defined(__MACH__) +#include +#include +#include #endif #include #include +#include +#include +#include #include #include #include "diskann_util.h" @@ -30,8 +39,13 @@ namespace zvec { namespace core { +// On Linux, IOContext is the libaio io_context_t. +// On macOS, IOContext is an int holding a kqueue file descriptor. +// On other platforms, IOContext is a uint32_t placeholder. #if (defined(__linux) || defined(__linux__)) typedef io_context_t IOContext; +#elif defined(__APPLE__) || defined(__MACH__) +typedef int IOContext; #else typedef uint32_t IOContext; #endif @@ -48,9 +62,12 @@ struct AlignedRead { AlignedRead(uint64_t offset, uint64_t len, void *buf) : offset(offset), len(len), buf(buf) { +#if defined(__linux__) || defined(__linux) + // O_DIRECT requires 512-byte alignment on Linux. ailego_assert(static_cast(offset) % 512 == 0); ailego_assert(static_cast(len) % 512 == 0); ailego_assert(reinterpret_cast(buf) % 512 == 0); +#endif } }; @@ -75,6 +92,10 @@ class AlignedFileReader { bool async = false) = 0; }; +// Reader implementation used on all supported platforms. +// On Linux (x86_64 and ARM64) it uses libaio for asynchronous batch I/O. +// On macOS (including ARM/Apple Silicon) it uses kqueue to monitor file +// descriptor readiness and pread for actual data transfer. class LinuxAlignedFileReader : public AlignedFileReader { private: int file_desc; diff --git a/src/core/algorithm/diskann/diskann_indexer.h b/src/core/algorithm/diskann/diskann_indexer.h index c372d288f..5eea9c7c3 100644 --- a/src/core/algorithm/diskann/diskann_indexer.h +++ b/src/core/algorithm/diskann/diskann_indexer.h @@ -91,7 +91,13 @@ class DiskAnnIndexer { PQTable::Pointer pq_table_; - IOContext init_ctx_{0}; + IOContext init_ctx_{ +#if defined(__APPLE__) || defined(__MACH__) + -1 +#else + 0 +#endif + }; std::vector neighbor_cache_buffer_; void *coord_cache_buf_{nullptr}; diff --git a/src/core/algorithm/diskann/diskann_searcher.cc b/src/core/algorithm/diskann/diskann_searcher.cc index 905fdf2bd..75c6d81d1 100644 --- a/src/core/algorithm/diskann/diskann_searcher.cc +++ b/src/core/algorithm/diskann/diskann_searcher.cc @@ -13,6 +13,7 @@ // limitations under the License. #include "diskann_searcher.h" +#include #include "diskann_context.h" #include "diskann_indexer.h" #include "diskann_params.h" @@ -25,6 +26,23 @@ DiskAnnSearcher::DiskAnnSearcher() {} DiskAnnSearcher::~DiskAnnSearcher() {} int DiskAnnSearcher::init(const ailego::Params &search_params) { +#if defined(__linux__) || defined(__linux) + // Eagerly probe the I/O backend at init time so the user gets immediate + // feedback about whether async I/O is available. IOBackend auto-probes on + // first Instance() access. + auto &backend = ailego::IOBackend::Instance(); + if (backend.available() == ailego::IOBackendType::kSyncPread) { + LOG_WARN( + "DiskAnn: no async I/O backend available. Install libaio (e.g. " + "'apt-get install libaio1', or 'libaio1t64' on Ubuntu 24.04+) and " + "retry. DiskAnn will fall back to synchronous pread() — performance " + "will be degraded."); + } else { + LOG_INFO("DiskAnn: I/O backend '%s' loaded — async I/O enabled.", + backend.name()); + } +#endif + search_params.get(PARAM_DISKANN_SEARCHER_LIST_SIZE, &list_size_); search_params.get(PARAM_DISKANN_SEARCHER_CACHE_NODE_NUM, &cache_nodes_num_); return 0; diff --git a/src/core/algorithm/diskann/diskann_searcher_entity.cc b/src/core/algorithm/diskann/diskann_searcher_entity.cc index c9e49deba..3e353a216 100644 --- a/src/core/algorithm/diskann/diskann_searcher_entity.cc +++ b/src/core/algorithm/diskann/diskann_searcher_entity.cc @@ -398,8 +398,8 @@ const void *DiskAnnSearcherEntity::get_vector(diskann_id_t id) const { const void *vec; if (ailego_unlikely(vector_segment_->read(total_offset, &vec, read_size) != read_size)) { - LOG_ERROR("Read vector from segment failed, id: %u, offset: %lu", id, - total_offset); + LOG_ERROR("Read vector from segment failed, id: %u, offset: %llu", id, + (unsigned long long)total_offset); return nullptr; } diff --git a/src/core/algorithm/diskann/diskann_streamer.cc b/src/core/algorithm/diskann/diskann_streamer.cc index 7a978b69e..6fbd22b1c 100644 --- a/src/core/algorithm/diskann/diskann_streamer.cc +++ b/src/core/algorithm/diskann/diskann_streamer.cc @@ -13,6 +13,7 @@ // limitations under the License. #include "diskann_streamer.h" +#include #include "diskann_context.h" #include "diskann_index_provider.h" #include "diskann_indexer.h" @@ -28,6 +29,24 @@ DiskAnnStreamer::~DiskAnnStreamer() {} int DiskAnnStreamer::init(const IndexMeta &meta, const ailego::Params &search_params) { meta_ = meta; + +#if defined(__linux__) || defined(__linux) + // Eagerly probe the I/O backend at init time so the user gets immediate + // feedback about whether async I/O is available. IOBackend auto-probes on + // first Instance() access. + auto &backend = ailego::IOBackend::Instance(); + if (backend.available() == ailego::IOBackendType::kSyncPread) { + LOG_WARN( + "DiskAnn: no async I/O backend available. Install libaio (e.g. " + "'apt-get install libaio1', or 'libaio1t64' on Ubuntu 24.04+) and " + "retry. DiskAnn will fall back to synchronous pread() — performance " + "will be degraded."); + } else { + LOG_INFO("DiskAnn: I/O backend '%s' loaded — async I/O enabled.", + backend.name()); + } +#endif + search_params.get(PARAM_DISKANN_SEARCHER_LIST_SIZE, &list_size_); search_params.get(PARAM_DISKANN_SEARCHER_CACHE_NODE_NUM, &cache_nodes_num_); return 0; diff --git a/src/core/algorithm/diskann/diskann_util.h b/src/core/algorithm/diskann/diskann_util.h index a02130bf0..3e2ecd652 100644 --- a/src/core/algorithm/diskann/diskann_util.h +++ b/src/core/algorithm/diskann/diskann_util.h @@ -35,7 +35,13 @@ class DiskAnnUtil { } static inline void alloc_aligned(void **ptr, size_t size, size_t align) { - *ptr = ::aligned_alloc(align, size); + // C11 aligned_alloc() requires size to be an integral multiple of + // alignment. This is true on Linux (glibc relaxes the requirement) + // but NOT on macOS, where aligned_alloc(32, 16) returns NULL. + // Use posix_memalign() which is portable and has no such restriction. + if (::posix_memalign(ptr, align, size) != 0) { + *ptr = nullptr; + } } static inline void free_aligned(void *ptr) { diff --git a/src/core/interface/CMakeLists.txt b/src/core/interface/CMakeLists.txt index d5475a4b5..ffb3cb043 100644 --- a/src/core/interface/CMakeLists.txt +++ b/src/core/interface/CMakeLists.txt @@ -1,10 +1,15 @@ include(${PROJECT_ROOT_DIR}/cmake/bazel.cmake) include(${PROJECT_ROOT_DIR}/cmake/option.cmake) +set(CORE_INTERFACE_LIBS zvec_ailego core_framework sparsehash magic_enum rabitqlib) +if(CMAKE_SYSTEM_NAME STREQUAL "Linux") + list(APPEND CORE_INTERFACE_LIBS ${CMAKE_DL_LIBS}) +endif() + cc_library( NAME core_interface STATIC STRICT ALWAYS_LINK SRCS *.cc indexes/*.cc INCS . ${PROJECT_ROOT_DIR}/src/ ${PROJECT_ROOT_DIR}/src/core - LIBS zvec_ailego core_framework core_plugin sparsehash magic_enum rabitqlib + LIBS ${CORE_INTERFACE_LIBS} VERSION "${PROXIMA_ZVEC_VERSION}" ) diff --git a/src/core/interface/indexes/diskann_index.cc b/src/core/interface/indexes/diskann_index.cc index bf1233a7a..2fcf68442 100644 --- a/src/core/interface/indexes/diskann_index.cc +++ b/src/core/interface/indexes/diskann_index.cc @@ -15,62 +15,14 @@ #include #include #include +#include #include -#include #include "algorithm/diskann/diskann_params.h" #include "holder_builder.h" namespace zvec::core_interface { -namespace { - -// Implicitly bring the DiskAnn runtime online on first use. This keeps the -// DiskAnn index an ordinary public API (users just instantiate a -// DiskAnnIndexParam) while still letting the rest of the library — HNSW, -// IVF, Flat, Vamana — run on hosts that happen to lack libaio. On such -// hosts only DiskAnn fails, with a clear, actionable error message, and -// every other index type stays fully functional. -int EnsureDiskAnnRuntimeReady() { - static std::once_flag once; - static int cached_result = 0; - std::call_once(once, []() { - const int status = ::zvec::LoadDiskAnnPlugin(); - if (status == kDiskAnnPluginOk) { - cached_result = 0; - return; - } - switch (status) { - case kDiskAnnPluginLibAioMissing: - LOG_ERROR( - "DiskAnn requires libaio at runtime, but it was not found on this " - "host. Install it (e.g. 'apt-get install libaio1' on " - "Debian/Ubuntu, " - "or 'libaio1t64' on Ubuntu 24.04+) and retry."); - break; - case kDiskAnnPluginUnsupportedPlatform: - LOG_ERROR("DiskAnn is only supported on Linux x86_64."); - break; - case kDiskAnnPluginDlopenFailed: - default: - LOG_ERROR("Failed to initialize the DiskAnn runtime (status=%d).", - status); - break; - } - cached_result = core::IndexError_Runtime; - }); - return cached_result; -} - -} // namespace - int DiskAnnIndex::CreateAndInitStreamer(const BaseIndexParam ¶m) { - // Fail fast and cleanly if the DiskAnn runtime cannot be brought up on - // this host (most commonly: libaio is missing). The rest of zvec keeps - // running; only DiskAnn is unusable. - if (int rc = EnsureDiskAnnRuntimeReady(); rc != 0) { - return rc; - } - if (is_sparse_) { LOG_ERROR("Failed to create streamer. Sparse is not Supported."); return core::IndexError_Unsupported; @@ -320,4 +272,16 @@ int DiskAnnIndex::Merge(const std::vector &indexes, return 0; } +ailego::IOBackendType DiskAnnIndex::io_backend_type() const { + auto &backend = ailego::IOBackend::Instance(); + ailego::IOBackendType type = backend.type(); + if (type == ailego::IOBackendType::kSyncPread) { + LOG_WARN( + "Only synchronous pread() is available. Install libaio " + "(e.g. 'apt-get install libaio1', or 'libaio1t64' on Ubuntu 24.04+) " + "for async I/O support — performance will be degraded without it."); + } + return type; +} + } // namespace zvec::core_interface \ No newline at end of file diff --git a/src/core/plugin/CMakeLists.txt b/src/core/plugin/CMakeLists.txt deleted file mode 100644 index 510677aed..000000000 --- a/src/core/plugin/CMakeLists.txt +++ /dev/null @@ -1,29 +0,0 @@ -## -## Copyright (C) The Software Authors. All rights reserved. -## -## \file CMakeLists.txt -## \brief Build script for the zvec internal plugin-loading glue library. -## Lives inside the main zvec_core artifact and provides the -## implicit DiskAnn runtime bring-up used by DiskAnnIndex on first -## use. These APIs are NOT part of the public user surface: users -## simply instantiate ``DiskAnnIndexParam`` / ``DiskAnnIndex`` and -## the runtime (``libzvec_diskann_plugin.so``) is loaded behind -## the scenes. -## - -include(${PROJECT_ROOT_DIR}/cmake/bazel.cmake) -include(${PROJECT_ROOT_DIR}/cmake/option.cmake) - -set(CORE_PLUGIN_LIBS zvec_ailego core_framework) -if(CMAKE_SYSTEM_NAME STREQUAL "Linux") - list(APPEND CORE_PLUGIN_LIBS ${CMAKE_DL_LIBS}) -endif() - -cc_library( - NAME core_plugin - STATIC STRICT ALWAYS_LINK - SRCS *.cc - LIBS ${CORE_PLUGIN_LIBS} - INCS . ${PROJECT_ROOT_DIR}/src/core - VERSION "${PROXIMA_ZVEC_VERSION}" -) diff --git a/src/core/plugin/diskann_plugin.cc b/src/core/plugin/diskann_plugin.cc deleted file mode 100644 index 9d4e9d0f5..000000000 --- a/src/core/plugin/diskann_plugin.cc +++ /dev/null @@ -1,322 +0,0 @@ -// Copyright 2025-present the zvec project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#include -#include -#include -#include -#include -#include - -#if defined(__linux__) || defined(__linux) || defined(__APPLE__) -#include -#include -#endif - -#if defined(__linux__) || defined(__linux) -#include -#endif - -namespace zvec { - -namespace { - -#if defined(__linux__) || defined(__linux) -constexpr const char *kPluginFileName = "libzvec_diskann_plugin.so"; -// Candidate soname list. On Ubuntu 24.04 the libaio package was renamed with -// the t64 suffix (64-bit time_t transition), so we probe both spellings. -constexpr const char *kLibAioSoNames[] = { - "libaio.so.1", - "libaio.so.1t64", -}; -constexpr bool kPlatformSupportsDiskAnnPlugin = true; -#elif defined(__APPLE__) -[[maybe_unused]] constexpr const char *kPluginFileName = - "libzvec_diskann_plugin.dylib"; -constexpr bool kPlatformSupportsDiskAnnPlugin = false; -#else -[[maybe_unused]] constexpr const char *kPluginFileName = - "zvec_diskann_plugin.dll"; -constexpr bool kPlatformSupportsDiskAnnPlugin = false; -#endif - -// Global plugin handle. Nullptr means "not loaded". -std::atomic g_plugin_handle{nullptr}; -std::mutex g_plugin_mutex; - -#if defined(__linux__) || defined(__linux) - -// Resolve the directory containing the currently running executable, so we -// can look for the plugin next to it regardless of the working directory. -std::string GetExecutableDir() { - char buf[PATH_MAX]; - ssize_t n = ::readlink("/proc/self/exe", buf, sizeof(buf) - 1); - if (n <= 0) { - return {}; - } - buf[n] = '\0'; - std::string path(buf); - auto slash = path.find_last_of('/'); - if (slash == std::string::npos) { - return {}; - } - return path.substr(0, slash); -} - -// Resolve the directory containing the shared object that hosts this -// function. For Python wheels this is the directory of -// ``_zvec.cpython-*.so``; for regular C++ binaries it is the directory of -// ``libzvec_core.so``. In either case the DiskAnn plugin is shipped -// alongside, so this is the most reliable lookup location. -// -// NOTE: we pass the address of an *exported* function (LoadDiskAnnPlugin) -// rather than one in this anonymous namespace, because dladdr() on a symbol -// with internal linkage can report the main executable instead of the -// hosting shared object when the translation unit is whole-archived into -// another .so. -std::string ResolveHostingSoDir() { - ::Dl_info info{}; - if (::dladdr(reinterpret_cast(&::zvec::LoadDiskAnnPlugin), &info) == - 0 || - info.dli_fname == nullptr) { - return {}; - } - std::string path(info.dli_fname); - auto slash = path.find_last_of('/'); - if (slash == std::string::npos) { - return {}; - } - return path.substr(0, slash); -} - -// Full path of the shared object that hosts LoadDiskAnnPlugin, or empty -// string on failure. -std::string ResolveHostingSoPath() { - ::Dl_info info{}; - if (::dladdr(reinterpret_cast(&::zvec::LoadDiskAnnPlugin), &info) == - 0 || - info.dli_fname == nullptr) { - return {}; - } - return std::string(info.dli_fname); -} - -// Promote the hosting shared object (e.g. the Python extension module -// ``_zvec.cpython-*.so``) to the global symbol scope. Python loads C -// extensions with RTLD_LOCAL by default, which means their C++ symbols are -// invisible to subsequently dlopen(RTLD_GLOBAL)ed libraries. Without this -// promotion, the DiskAnn plugin's undefined references to zvec:: symbols -// cannot be resolved against the already-loaded host module and dlopen -// fails with messages like: -// -// undefined symbol: _ZN4zvec6ailego6Logger10LEVEL_INFOE -// -// Using RTLD_NOLOAD re-opens the existing image without loading it again, -// while RTLD_GLOBAL merges its symbols into the global scope. This is a -// no-op for hosts that were already loaded with RTLD_GLOBAL. -void PromoteHostingSoToGlobal() { - const std::string host = ResolveHostingSoPath(); - if (host.empty()) { - return; - } - // When LoadDiskAnnPlugin is statically linked into the main executable, - // dladdr resolves to the executable itself. The main exe's symbols are - // already in the global scope by definition, so skip promotion. - const std::string exe_path = GetExecutableDir(); - if (!exe_path.empty()) { - char exe_buf[PATH_MAX]; - ssize_t n = ::readlink("/proc/self/exe", exe_buf, sizeof(exe_buf) - 1); - if (n > 0) { - exe_buf[n] = '\0'; - // Compare resolved real paths to handle relative vs absolute. - char host_real[PATH_MAX]; - char exe_real[PATH_MAX]; - if (::realpath(host.c_str(), host_real) != nullptr && - ::realpath(exe_buf, exe_real) != nullptr && - std::string(host_real) == std::string(exe_real)) { - // Host IS the main executable; symbols are already global. - return; - } - } - } - void *h = ::dlopen(host.c_str(), RTLD_NOW | RTLD_GLOBAL | RTLD_NOLOAD); - if (h == nullptr) { - const char *err = ::dlerror(); - LOG_WARN("Could not promote host '%s' to RTLD_GLOBAL: %s", host.c_str(), - err ? err : "unknown"); - return; - } - // We purposely keep the handle refcount incremented for the life of the - // process: there is no safe point at which to dlclose() it, and doing so - // would only decrement the count anyway (the image remains mapped because - // Python still holds its own reference). - (void)h; -} - -// Build the list of candidate paths for the plugin. -std::vector BuildCandidatePaths(const std::string &explicit_path) { - std::vector candidates; - if (!explicit_path.empty()) { - candidates.push_back(explicit_path); - return candidates; - } - - // Helper that pushes both ``/`` and ``/../lib/`` - // to handle the conventional CMake build layout where executables live in - // ``bin/`` while shared objects (including this plugin) live in ``lib/``. - auto push_dir_candidates = [&candidates](const std::string &dir) { - if (dir.empty()) { - return; - } - candidates.push_back(dir + "/" + kPluginFileName); - candidates.push_back(dir + "/../lib/" + kPluginFileName); - }; - - // 1. Directory of the library that hosts LoadDiskAnnPlugin (e.g. the - // Python extension module or libzvec_core). This works for Python, - // C++ embedding, and most packaging layouts. - const std::string own_dir = ResolveHostingSoDir(); - push_dir_candidates(own_dir); - // 2. Directory of the running executable. Useful for self-contained C++ - // tools that drop the plugin next to their binary, as well as for the - // standard CMake bin/lib split (handled by ``../lib/`` above). - const std::string exe_dir = GetExecutableDir(); - if (!exe_dir.empty() && exe_dir != own_dir) { - push_dir_candidates(exe_dir); - } - // 3. Fallback: rely on the dynamic linker's default search path - // (RPATH / LD_LIBRARY_PATH / /etc/ld.so.conf). - candidates.emplace_back(kPluginFileName); - return candidates; -} - -#endif // linux - -} // namespace - -bool IsLibAioAvailable() { -#if defined(__linux__) || defined(__linux) - const char *kRequiredSymbols[] = {"io_setup", "io_submit", "io_getevents", - "io_destroy"}; - for (const char *soname : kLibAioSoNames) { - // RTLD_LAZY keeps the cost low; we only need to know whether the library - // is resolvable and exposes the symbols DiskAnn actually calls. - void *handle = ::dlopen(soname, RTLD_LAZY); - if (handle == nullptr) { - continue; - } - bool ok = true; - for (const char *sym : kRequiredSymbols) { - if (::dlsym(handle, sym) == nullptr) { - ok = false; - break; - } - } - ::dlclose(handle); - if (ok) { - return true; - } - } - return false; -#else - return false; -#endif -} - -bool IsDiskAnnPluginLoaded() { - return g_plugin_handle.load(std::memory_order_acquire) != nullptr; -} - -int LoadDiskAnnPlugin(const std::string &path) { - if (!kPlatformSupportsDiskAnnPlugin) { - LOG_ERROR( - "DiskAnn plugin is not supported on this platform; it is only " - "available on Linux x86_64 with libaio."); - return kDiskAnnPluginUnsupportedPlatform; - } - -#if defined(__linux__) || defined(__linux) - // Fast path: already loaded. - if (g_plugin_handle.load(std::memory_order_acquire) != nullptr) { - return kDiskAnnPluginOk; - } - - std::lock_guard lock(g_plugin_mutex); - if (g_plugin_handle.load(std::memory_order_relaxed) != nullptr) { - return kDiskAnnPluginOk; - } - - if (!IsLibAioAvailable()) { - LOG_ERROR( - "libaio is not available on this host; the DiskAnn runtime cannot be " - "activated. Install libaio1 (e.g. 'apt-get install libaio1', or " - "'libaio1t64' on Ubuntu 24.04+) and retry. This does not affect " - "other index types (HNSW, IVF, Flat, Vamana)."); - return kDiskAnnPluginLibAioMissing; - } - - const std::vector candidates = BuildCandidatePaths(path); - // Ensure the hosting module's C++ symbols (zvec::*) are visible to the - // plugin at dlopen time. See PromoteHostingSoToGlobal() for the rationale. - PromoteHostingSoToGlobal(); - void *handle = nullptr; - std::string last_error; - for (const std::string &candidate : candidates) { - // RTLD_GLOBAL so the plugin's factory registrations (which live in the - // plugin's own static-init code) can reference symbols from the main - // library, and any callers that later dlsym against the process can see - // the plugin's symbols. - handle = ::dlopen(candidate.c_str(), RTLD_NOW | RTLD_GLOBAL); - if (handle != nullptr) { - LOG_INFO("Loaded DiskAnn plugin from: %s", candidate.c_str()); - break; - } - const char *err = ::dlerror(); - last_error = err ? err : "unknown dlopen error"; - LOG_DEBUG("dlopen(%s) failed: %s", candidate.c_str(), last_error.c_str()); - } - - if (handle == nullptr) { - LOG_ERROR("Failed to load DiskAnn plugin; last error: %s", - last_error.c_str()); - return kDiskAnnPluginDlopenFailed; - } - - g_plugin_handle.store(handle, std::memory_order_release); - return kDiskAnnPluginOk; -#else - (void)path; - return kDiskAnnPluginUnsupportedPlatform; -#endif -} - -bool UnloadDiskAnnPlugin() { -#if defined(__linux__) || defined(__linux) - std::lock_guard lock(g_plugin_mutex); - void *handle = g_plugin_handle.exchange(nullptr, std::memory_order_acq_rel); - if (handle == nullptr) { - return false; - } - if (::dlclose(handle) != 0) { - const char *err = ::dlerror(); - LOG_WARN("dlclose for DiskAnn plugin returned non-zero: %s", - err ? err : "unknown"); - } - return true; -#else - return false; -#endif -} - -} // namespace zvec diff --git a/src/db/collection.cc b/src/db/collection.cc index a2008f04a..98149ecb7 100644 --- a/src/db/collection.cc +++ b/src/db/collection.cc @@ -134,6 +134,8 @@ class CollectionImpl : public Collection { Result DebugGetHnswStorageMode( const std::string &column_name) const override; + Result DebugGetIoBackendType() const override; + private: void prepare_schema(); @@ -1893,6 +1895,11 @@ Result CollectionImpl::DebugGetHnswStorageMode( Status::NotFound("No HNSW index found for column '", column_name, "'")); } +Result CollectionImpl::DebugGetIoBackendType() const { + auto type = ailego::IOBackend::Instance().available(); + return std::string(ailego::IOBackendTypeName(type)); +} + Status CollectionImpl::recovery() { if (!FileHelper::DirectoryExists(path_.c_str())) { return Status::InvalidArgument("collection path{", path_, "} not exist."); diff --git a/src/db/index/common/schema.cc b/src/db/index/common/schema.cc index 06958ccc3..9ffe84451 100644 --- a/src/db/index/common/schema.cc +++ b/src/db/index/common/schema.cc @@ -20,7 +20,6 @@ #include #include #include -#include #include "ailego/internal/cpu_features.h" #include "db/common/constants.h" #include "db/common/typedef.h" @@ -198,30 +197,15 @@ Status FieldSchema::validate() const { } if (index_params_->type() == IndexType::DISKANN) { - // Probe the DiskAnn runtime eagerly at creation time so unsupported - // platforms (non Linux x86_64), missing libaio, or a missing plugin - // .so fail fast with a clear message instead of surfacing later during - // optimize(). This reuses the same gate DiskAnnIndex applies on first - // use (zvec::LoadDiskAnnPlugin, wrapped by EnsureDiskAnnRuntimeReady). - // All validate() call sites are creation-time only, so triggering the - // plugin load here is safe (and idempotent/cached). - const int rc = ::zvec::LoadDiskAnnPlugin(); - switch (rc) { - case kDiskAnnPluginOk: - break; - case kDiskAnnPluginUnsupportedPlatform: - return Status::NotSupported( - "DiskAnn is not supported on this platform (Linux x86_64 " - "only)"); - case kDiskAnnPluginLibAioMissing: - return Status::NotSupported( - "DiskAnn requires libaio at runtime, but it was not found on " - "this host. Install it (e.g. 'apt-get install libaio1', or " - "'libaio1t64' on Ubuntu 24.04+) and retry."); - default: - return Status::NotSupported( - "DiskAnn runtime could not be initialized on this host"); - } + // DiskAnn is supported on Linux (x86_64/ARM64 with libaio) and macOS + // (with kqueue). On Linux, libaio is loaded eagerly via dlopen; if + // missing, DiskAnn falls back to synchronous pread() with degraded + // performance. +#if !DISKANN_SUPPORTED + return Status::NotSupported( + "DiskAnn is not supported on this platform. It is available on " + "Linux (x86_64/ARM64 with libaio) and macOS (with kqueue)."); +#endif } diff --git a/src/include/zvec/ailego/pattern/factory.h b/src/include/zvec/ailego/pattern/factory.h index 9b292b90a..3ffbfcc1f 100644 --- a/src/include/zvec/ailego/pattern/factory.h +++ b/src/include/zvec/ailego/pattern/factory.h @@ -120,15 +120,18 @@ class Factory { //! a guard variable (`_ZGVZN...E7factory`) alongside the object, and both //! must be unified across DSOs for the singleton to be shared. //! - //! In the Python extension build the _zvec.so version script exports the - //! storage (`zvec::*` matches its demangled name) while the guard variable, - //! whose demangled form is `guard variable for zvec::...`, ends up hidden - //! (compilers emit the guard in a COMDAT group whose visibility is not - //! upgraded by our version script). When libzvec_diskann_plugin.so is - //! loaded, _zvec.so and the plugin then share the `factory` storage but - //! each have their own guard; the plugin's still-zero guard triggers a - //! second run of the Factory constructor on the shared storage, wiping - //! all registrations performed during _zvec.so import (e.g. FlatStreamer). + //! Historically (when DiskAnn was a runtime-loaded shared plugin) the + //! _zvec.so version script exported the storage (`zvec::*` matches its + //! demangled name) while the guard variable, whose demangled form is + //! `guard variable for zvec::...`, ended up hidden (compilers emit the + //! guard in a COMDAT group whose visibility is not upgraded by our version + //! script). When the plugin was loaded, _zvec.so and the plugin shared the + //! `factory` storage but each had its own guard; the plugin's still-zero + //! guard triggered a second run of the Factory constructor on the shared + //! storage, wiping out registrations performed during _zvec.so import. + //! DiskAnn is now statically linked into _zvec.so, so this DSO-splitting + //! issue no longer applies, but the atomic-pointer pattern is retained as + //! a defensive measure. //! //! A constant-initialized static std::atomic has NO guard variable //! (its zero init is compile-time), so we use a leaked heap singleton with diff --git a/src/include/zvec/core/interface/index.h b/src/include/zvec/core/interface/index.h index 6c01d7049..de8fc92c5 100644 --- a/src/include/zvec/core/interface/index.h +++ b/src/include/zvec/core/interface/index.h @@ -19,6 +19,7 @@ #include #include #include +#include #include #include #include @@ -375,6 +376,10 @@ class DiskAnnIndex : public Index { public: DiskAnnIndex() = default; + // Returns the I/O backend type currently loaded for DiskAnn async disk reads. + // If only sync_pread is available, logs a hint to install libaio. + ailego::IOBackendType io_backend_type() const; + protected: virtual int CreateAndInitStreamer(const BaseIndexParam ¶m) override; diff --git a/src/include/zvec/db/collection.h b/src/include/zvec/db/collection.h index 83a289c52..bc9f0d63b 100644 --- a/src/include/zvec/db/collection.h +++ b/src/include/zvec/db/collection.h @@ -117,6 +117,11 @@ class Collection { //! introspection and testing; not part of the stable public API. virtual Result DebugGetHnswStorageMode( const std::string &column_name) const = 0; + + //! Debug-only: retrieve the I/O backend type used by DiskAnn. Returns + //! "libaio" or "sync_pread". Intended for introspection and testing; not + //! part of the stable public API. + virtual Result DebugGetIoBackendType() const = 0; }; } // namespace zvec \ No newline at end of file diff --git a/src/include/zvec/plugin/diskann_plugin.h b/src/include/zvec/plugin/diskann_plugin.h deleted file mode 100644 index 988187068..000000000 --- a/src/include/zvec/plugin/diskann_plugin.h +++ /dev/null @@ -1,84 +0,0 @@ -// Copyright 2025-present the zvec project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#pragma once - -#include - -// NOTE: The APIs declared in this header are INTERNAL to zvec. They are -// invoked implicitly by ``DiskAnnIndex`` on first use so that DiskAnn works -// out of the box, without users ever calling a ``load_diskann_plugin()`` / -// ``is_libaio_available()`` entry point. External callers should not depend -// on these symbols; they may change or be removed in future releases. On -// hosts missing libaio the bring-up fails cleanly and only DiskAnn becomes -// unavailable — other index types (HNSW / IVF / Flat / Vamana) keep working. - -#if defined(_WIN32) || defined(__CYGWIN__) -#ifdef ZVEC_BUILD_SHARED -#define ZVEC_PLUGIN_EXPORT __declspec(dllexport) -#elif defined(ZVEC_USE_SHARED) -#define ZVEC_PLUGIN_EXPORT __declspec(dllimport) -#else -#define ZVEC_PLUGIN_EXPORT -#endif -#else -#if __GNUC__ >= 4 -#define ZVEC_PLUGIN_EXPORT __attribute__((visibility("default"))) -#else -#define ZVEC_PLUGIN_EXPORT -#endif -#endif - -namespace zvec { - -// Return codes for LoadDiskAnnPlugin(). -enum DiskAnnPluginStatus { - kDiskAnnPluginOk = 0, - kDiskAnnPluginUnsupportedPlatform = -1, - kDiskAnnPluginLibAioMissing = -2, - kDiskAnnPluginDlopenFailed = -3, -}; - -// Returns true if libaio is present on the host and the minimum set of symbols -// required by the DiskAnn runtime (io_setup / io_submit / io_getevents / -// io_destroy) can be resolved at runtime. -// -// Internal probe used by ``LoadDiskAnnPlugin`` before attempting dlopen. Not -// part of the user-facing API. -ZVEC_PLUGIN_EXPORT bool IsLibAioAvailable(); - -// Load the DiskAnn runtime shared library (libzvec_diskann_plugin.so) via -// dlopen(). Invoked implicitly by ``DiskAnnIndex::CreateAndInitStreamer`` on -// first use; callers should not invoke it directly. The call is idempotent -// and returns ``kDiskAnnPluginOk`` when the runtime is already active. -// -// Search order when ``path`` is empty: -// 1. next to the currently running executable (``/proc/self/exe`` on Linux); -// 2. next to the hosting shared object (e.g. ``_zvec.cpython-*.so``); -// 3. the platform default dynamic-linker search path (RPATH, -// ``LD_LIBRARY_PATH``, ``/etc/ld.so.conf``, …). -ZVEC_PLUGIN_EXPORT int LoadDiskAnnPlugin(const std::string &path = ""); - -// Returns true if the DiskAnn runtime is currently loaded in this process. -// Internal diagnostic; not a user-facing API. -ZVEC_PLUGIN_EXPORT bool IsDiskAnnPluginLoaded(); - -// Unload the DiskAnn runtime. Internal only — unloading a library that has -// registered itself into global factory singletons is inherently racy; -// callers must guarantee that no DiskAnn objects are still alive and no -// background threads are executing DiskAnn code before calling this. Returns -// true when a live handle was released. -ZVEC_PLUGIN_EXPORT bool UnloadDiskAnnPlugin(); - -} // namespace zvec diff --git a/tests/core/algorithm/diskann/CMakeLists.txt b/tests/core/algorithm/diskann/CMakeLists.txt index 2d919f270..e6ad1af12 100644 --- a/tests/core/algorithm/diskann/CMakeLists.txt +++ b/tests/core/algorithm/diskann/CMakeLists.txt @@ -7,7 +7,7 @@ foreach(CC_SRCS ${ALL_TEST_SRCS}) cc_gtest( NAME ${CC_TARGET} STRICT - LIBS zvec_ailego core_framework core_utility core_metric core_quantizer core_knn_cluster core_plugin core_knn_diskann + LIBS zvec_ailego core_framework core_utility core_metric core_quantizer core_knn_cluster core_knn_diskann SRCS ${CC_SRCS} INCS . ${PROJECT_ROOT_DIR}/src/core ${PROJECT_ROOT_DIR}/src/core/algorithm/diskann ) diff --git a/tests/core/algorithm/diskann/diskann_builder_test.cc b/tests/core/algorithm/diskann/diskann_builder_test.cc index 55b89d4f4..752759e9d 100644 --- a/tests/core/algorithm/diskann/diskann_builder_test.cc +++ b/tests/core/algorithm/diskann/diskann_builder_test.cc @@ -143,18 +143,6 @@ TEST_F(DiskAnnBuilderTest, SmallDatasetBuildTime) { << " ms — likely a lost-wakeup regression in progress loops."; } -// DiskAnn is now exposed implicitly: no caller ever invokes a -// ``LoadDiskAnnPlugin`` / ``IsLibAioAvailable`` API (those were removed from -// the public surface together with ``zvec.load_diskann_plugin()`` in Python). -// The only contract this test validates is the UX guarantee: once the DiskAnn -// module has been linked into the hosting binary (here, directly into the -// test via the ``core_knn_diskann`` target), its factory entries are -// registered automatically and the global ``IndexFactory`` can hand out a -// ``DiskAnnBuilder`` without any explicit setup step. On hosts missing -// libaio, DiskAnn would fail at the index-creation layer with a clear error -// while other index types (HNSW/IVF/Flat/Vamana) remain unaffected; that -// runtime branch lives in ``DiskAnnIndex::CreateAndInitStreamer`` and is -// covered by the higher-level interface tests. TEST_F(DiskAnnBuilderTest, TestImplicitFactoryRegistration) { IndexBuilder::Pointer builder = IndexFactory::CreateBuilder("DiskAnnBuilder"); ASSERT_NE(builder, nullptr) diff --git a/tests/core/interface/CMakeLists.txt b/tests/core/interface/CMakeLists.txt index 83bf8d95e..65c80ffbb 100644 --- a/tests/core/interface/CMakeLists.txt +++ b/tests/core/interface/CMakeLists.txt @@ -8,7 +8,7 @@ foreach(CC_SRCS ${ALL_TEST_SRCS}) NAME ${CC_TARGET} STRICT LIBS zvec_ailego core_framework core_metric core_interface core_knn_flat core_utility core_quantizer sparsehash core_knn_hnsw core_mix_reducer - core_knn_flat_sparse core_knn_hnsw_sparse core_knn_ivf core_knn_hnsw_rabitq core_knn_vamana + core_knn_flat_sparse core_knn_hnsw_sparse core_knn_ivf core_knn_hnsw_rabitq core_knn_vamana core_knn_diskann SRCS ${CC_SRCS} INCS . ${PROJECT_ROOT_DIR}/src/core ${PROJECT_ROOT_DIR}/src/core/algorithm ) diff --git a/tests/db/crash_recovery/write_recovery_test.cc b/tests/db/crash_recovery/write_recovery_test.cc index 4dce9985a..2e595eb87 100644 --- a/tests/db/crash_recovery/write_recovery_test.cc +++ b/tests/db/crash_recovery/write_recovery_test.cc @@ -188,7 +188,7 @@ TEST_F(CrashRecoveryTest, CrashRecoveryDuringInsertion) { collection.reset(); } - RunGeneratorAndCrash("0", "10000", "insert", "0", 3); + RunGeneratorAndCrash("0", "10000", "insert", "0", 5); auto result = Collection::Open(dir_path_, options_); ASSERT_TRUE(result.has_value()) << "Failed to reopen collection after crash. " @@ -196,7 +196,7 @@ TEST_F(CrashRecoveryTest, CrashRecoveryDuringInsertion) { auto collection = result.value(); uint64_t doc_count{collection->Stats().value().doc_count}; ASSERT_GT(doc_count, 800) - << "Document count is too low after 3s of insertion and recovery"; + << "Document count is too low after 5s of insertion and recovery"; for (uint64_t doc_id = 0; doc_id < doc_count; doc_id++) { const auto expected_doc = CreateTestDoc(doc_id, 0); diff --git a/tools/core/bench_original.cc b/tools/core/bench_original.cc index 65a36d7ba..c787b883b 100644 --- a/tools/core/bench_original.cc +++ b/tools/core/bench_original.cc @@ -885,7 +885,7 @@ int main(int argc, char *argv[]) { : "debug"; transform(log_level.begin(), log_level.end(), log_level.begin(), ::tolower); if (LOG_LEVEL.find(log_level) != LOG_LEVEL.end()) { - IndexLoggerBroker::SetLevel(LOG_LEVEL[log_level]); + zvec::ailego::LoggerBroker::SetLevel(LOG_LEVEL[log_level]); } // Calculate Bench diff --git a/tools/core/recall_original.cc b/tools/core/recall_original.cc index c8b2068ef..997ef5ad7 100644 --- a/tools/core/recall_original.cc +++ b/tools/core/recall_original.cc @@ -1882,7 +1882,7 @@ int main(int argc, char *argv[]) { : "debug"; transform(log_level.begin(), log_level.end(), log_level.begin(), ::tolower); if (LOG_LEVEL.find(log_level) != LOG_LEVEL.end()) { - IndexLoggerBroker::SetLevel(LOG_LEVEL[log_level]); + zvec::ailego::LoggerBroker::SetLevel(LOG_LEVEL[log_level]); } // Calculate Recall