diskann-disk 0.55.0

DiskANN3 is a composable library for bringing scalable, accurate and cost-effective vector indexing to multiple databases.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

/*
 * Copyright (c) Microsoft Corporation.
 * Licensed under the MIT license.
 */

use diskann::ANNResult;

#[cfg(all(not(miri), target_os = "linux"))]
use crate::search::provider::aligned_file_reader::reader::LinuxAlignedFileReader;
#[cfg(any(miri, target_os = "macos"))]
use crate::search::provider::aligned_file_reader::reader::StorageProviderAlignedFileReader;
#[cfg(all(not(miri), target_os = "windows"))]
use crate::search::provider::aligned_file_reader::reader::WindowsAlignedFileReader;
use crate::search::provider::aligned_file_reader::traits::AlignedReaderFactory;

#[cfg(any(miri, target_os = "macos"))]
use diskann_providers::storage::FileStorageProvider;

pub struct AlignedFileReaderFactory {
    pub file_path: String,
}

impl AlignedReaderFactory for AlignedFileReaderFactory {
    /*
        Fall back to the StorageProviderAlignedFileReader when running in miri or on macOS.

        For miri: Otherwise, miri fails with this error:
       --> C:\Users\<user>\.cargo\registry\src\msdata.pkgs.visualstudio.com-32ec7033fece98f6\io-uring-0.6.3\src\sys\mod.rs:97:15
        |
    97  |     to_result(syscall(SYSCALL_SETUP, entries as c_long, p as c_long) as _)
        |               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ can't execute syscall with ID 425
        |
        = help: this is likely not a bug in the program; it indicates that the program performed an operation that the interpreter does not support
        = note: BACKTRACE on thread `algorithm::sear`:
        = note: inside `io_uring::sys::io_uring_setup` at C:\Users\<user>\.cargo\registry\src\msdata.pkgs.visualstudio.com-32ec7033fece98f6\io-uring-0.6.3\src\sys\mod.rs:97:15: 97:69
        = note: inside `io_uring::IoUring::with_params` at C:\Users\<user>\.cargo\registry\src\msdata.pkgs.visualstudio.com-32ec7033fece98f6\io-uring-0.6.3\src\lib.rs:152:57: 152:93
        = note: inside `io_uring::Builder::build` at C:\Users\<user>\.cargo\registry\src\msdata.pkgs.visualstudio.com-32ec7033fece98f6\io-uring-0.6.3\src\lib.rs:412:20: 412:62
        = note: inside `io_uring::IoUring::new` at C:\Users\<user>\.cargo\registry\src\msdata.pkgs.visualstudio.com-32ec7033fece98f6\io-uring-0.6.3\src\lib.rs:82:9: 82:39
    note: inside `<model::aligned_file_reader::linux_aligned_file_reader::LinuxAlignedFileReader as model::aligned_file_reader::aligned_file_reader::AlignedFileReader>::read`
       --> diskann\src\model\aligned_file_reader\linux_aligned_file_reader.rs:221:24
        |
    221 |         let mut ring = IoUring::new(MAX_IO_CONCURRENCY as u32)?;

        For macOS: macOS does not support io_uring (Linux-only) or IOCompletionPort (Windows-only).
        StorageProviderAlignedFileReader provides a cross-platform fallback implementation.
         */
    #[cfg(any(miri, target_os = "macos"))]
    type AlignedReaderType = StorageProviderAlignedFileReader;

    #[cfg(all(not(miri), target_os = "linux"))]
    type AlignedReaderType = LinuxAlignedFileReader;

    #[cfg(all(not(miri), target_os = "windows"))]
    type AlignedReaderType = WindowsAlignedFileReader;

    fn build(&self) -> ANNResult<Self::AlignedReaderType> {
        #[cfg(any(miri, target_os = "macos"))]
        return StorageProviderAlignedFileReader::new(
            &FileStorageProvider,
            self.file_path.as_str(),
        );

        #[cfg(all(not(miri), target_os = "windows"))]
        return WindowsAlignedFileReader::new(self.file_path.as_str());

        #[cfg(all(not(miri), target_os = "linux"))]
        return LinuxAlignedFileReader::new(self.file_path.as_str());
    }
}

impl AlignedFileReaderFactory {
    pub fn new(file_path: String) -> Self {
        Self { file_path }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_aligned_file_reader_factory_new() {
        let path = "/tmp/test.bin".to_string();
        let factory = AlignedFileReaderFactory::new(path.clone());
        assert_eq!(factory.file_path, path);
    }
}