shardex 0.1.0

A high-performance memory-mapped vector search engine with ACID transactions and incremental updates
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
//! Memory-mapped vector storage using Arrow arrays for high-performance vector operations
//!
//! This module provides fixed-size memory-mapped storage for embedding vectors with direct
//! access capabilities. It leverages Apache Arrow's memory layout for optimal performance
//! and zero-copy operations while ensuring proper SIMD alignment.
//!
//! # Key Components
//!
//! - [`VectorStorage`]: Main vector storage container using Arrow FixedSizeListArray
//! - [`VectorStorageHeader`]: Memory-mapped header with metadata and configuration
//! - Zero-copy vector access with proper alignment for SIMD operations
//!
//! # Usage Examples
//!
//! ## Creating and Using Vector Storage
//!
//! ```rust
//! use shardex::vector_storage::VectorStorage;
//! use tempfile::TempDir;
//!
//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
//! let temp_dir = TempDir::new()?;
//! let storage_path = temp_dir.path().join("vectors.dat");
//!
//! // Create storage for 384-dimensional vectors with initial capacity of 1000
//! let mut storage = VectorStorage::create(&storage_path, 384, 1000)?;
//!
//! // Add some vectors
//! let vector1 = vec![1.0; 384];
//! let vector2 = vec![2.0; 384];
//! let idx1 = storage.add_vector(&vector1)?;
//! let idx2 = storage.add_vector(&vector2)?;
//!
//! // Access vectors (zero-copy)
//! let retrieved = storage.get_vector(idx1)?;
//! assert_eq!(retrieved[0], 1.0);
//!
//! // Update a vector in place
//! let new_vector = vec![3.0; 384];
//! storage.update_vector(idx1, &new_vector)?;
//!
//! // Remove a vector (tombstone marking)
//! storage.remove_vector(idx2)?;
//! # Ok(())
//! # }
//! ```
//!
//! ## Memory-Mapped Persistence
//!
//! ```rust
//! use shardex::vector_storage::VectorStorage;
//! use std::path::Path;
//!
//! # fn persistence_example(storage_path: &Path) -> Result<(), Box<dyn std::error::Error>> {
//! // Create and populate storage
//! {
//!     let mut storage = VectorStorage::create(storage_path, 128, 500)?;
//!     let vector = vec![0.5; 128];
//!     storage.add_vector(&vector)?;
//!     storage.sync()?;
//! }
//!
//! // Reopen existing storage
//! let storage = VectorStorage::open(storage_path)?;
//! assert_eq!(storage.vector_dimension(), 128);
//! assert_eq!(storage.current_count(), 1);
//! # Ok(())
//! # }
//! ```

use crate::constants::magic;
use crate::error::ShardexError;
use crate::memory::{FileHeader, MemoryMappedFile};
use bytemuck::{Pod, Zeroable};
use std::path::Path;

/// Memory-mapped vector storage header containing metadata and configuration
#[derive(Debug, Clone, Copy, PartialEq)]
#[repr(C)]
pub struct VectorStorageHeader {
    /// File format header with magic bytes and checksum
    pub file_header: FileHeader,
    /// Number of dimensions per vector
    pub vector_dimension: u32,
    /// Maximum number of vectors this storage can hold
    pub capacity: u32,
    /// Current number of vectors stored (including deleted ones)
    pub current_count: u32,
    /// Number of active (non-deleted) vectors
    pub active_count: u32,
    /// Offset to start of vector data in the file
    pub vector_data_offset: u64,
    /// Size of each vector in bytes (dimension * 4 bytes per f32)
    pub vector_size_bytes: u32,
    /// Alignment padding for SIMD operations (typically 64 bytes for AVX-512)
    pub simd_alignment: u32,
    /// Reserved bytes for future use
    pub reserved: [u8; 16],
}

/// High-performance memory-mapped vector storage
///
/// VectorStorage provides efficient storage and access for fixed-size vectors with
/// zero-copy operations, proper SIMD alignment, and memory-mapped persistence for
/// large-scale vector datasets.
pub struct VectorStorage {
    /// Memory-mapped file for persistent storage
    mmap_file: MemoryMappedFile,
    /// Storage metadata and configuration
    header: VectorStorageHeader,
    /// Vector dimension (cached from header for performance)
    vector_dimension: usize,
    /// Current capacity (cached from header for performance)
    capacity: usize,
    /// Flag indicating if storage is read-only
    read_only: bool,
}

// SAFETY: VectorStorageHeader contains only Pod types and has repr(C) layout
unsafe impl Pod for VectorStorageHeader {}
// SAFETY: VectorStorageHeader can be safely zero-initialized
unsafe impl Zeroable for VectorStorageHeader {}

/// Current version of the vector storage format
const VECTOR_STORAGE_VERSION: u32 = 1;
/// Default SIMD alignment (64 bytes for AVX-512)
const DEFAULT_SIMD_ALIGNMENT: usize = 64;

impl VectorStorageHeader {
    /// Size of the header structure in bytes
    pub const SIZE: usize = std::mem::size_of::<VectorStorageHeader>();

    /// Create a new vector storage header
    pub fn new(vector_dimension: usize, capacity: usize) -> Result<Self, ShardexError> {
        if vector_dimension == 0 {
            return Err(ShardexError::Config("Vector dimension cannot be zero".to_string()));
        }
        if capacity == 0 {
            return Err(ShardexError::Config("Capacity cannot be zero".to_string()));
        }
        if vector_dimension > u32::MAX as usize {
            return Err(ShardexError::Config(format!(
                "Vector dimension {} exceeds maximum {}",
                vector_dimension,
                u32::MAX
            )));
        }
        if capacity > u32::MAX as usize {
            return Err(ShardexError::Config(format!(
                "Capacity {} exceeds maximum {}",
                capacity,
                u32::MAX
            )));
        }

        let vector_size_bytes = (vector_dimension * std::mem::size_of::<f32>()) as u32;
        let vector_data_offset = Self::SIZE as u64;

        Ok(Self {
            file_header: FileHeader::new_without_checksum(
                magic::VECTOR_STORAGE,
                VECTOR_STORAGE_VERSION,
                FileHeader::SIZE as u64,
            ),
            vector_dimension: vector_dimension as u32,
            capacity: capacity as u32,
            current_count: 0,
            active_count: 0,
            vector_data_offset,
            vector_size_bytes,
            simd_alignment: DEFAULT_SIMD_ALIGNMENT as u32,
            reserved: [0; 16],
        })
    }

    /// Validate the header magic bytes and version
    pub fn validate(&self) -> Result<(), ShardexError> {
        self.file_header.validate_magic(magic::VECTOR_STORAGE)?;

        if self.file_header.version != VECTOR_STORAGE_VERSION {
            return Err(ShardexError::Corruption(format!(
                "Unsupported vector storage version: expected {}, found {}",
                VECTOR_STORAGE_VERSION, self.file_header.version
            )));
        }

        // Validate field consistency
        let expected_vector_size = (self.vector_dimension as usize * std::mem::size_of::<f32>()) as u32;
        if self.vector_size_bytes != expected_vector_size {
            return Err(ShardexError::Corruption(format!(
                "Vector size mismatch: expected {} bytes, found {}",
                expected_vector_size, self.vector_size_bytes
            )));
        }

        if self.current_count > self.capacity {
            return Err(ShardexError::Corruption(format!(
                "Current count {} exceeds capacity {}",
                self.current_count, self.capacity
            )));
        }

        if self.active_count > self.current_count {
            return Err(ShardexError::Corruption(format!(
                "Active count {} exceeds current count {}",
                self.active_count, self.current_count
            )));
        }

        Ok(())
    }

    /// Update the checksum based on vector data
    pub fn update_checksum(&mut self, vector_data: &[u8]) {
        self.file_header.update_checksum(vector_data);
    }
}

impl VectorStorage {
    /// Create a new vector storage file with the specified configuration
    ///
    /// # Arguments
    /// * `path` - Path where the storage file will be created
    /// * `vector_dimension` - Number of dimensions per vector
    /// * `capacity` - Initial capacity (number of vectors)
    pub fn create<P: AsRef<Path>>(path: P, vector_dimension: usize, capacity: usize) -> Result<Self, ShardexError> {
        let path = path.as_ref();

        // Calculate total file size needed
        let header_size = VectorStorageHeader::SIZE;
        let vector_data_size = capacity * vector_dimension * std::mem::size_of::<f32>();

        // Align vector data for SIMD operations
        let aligned_vector_data_size = Self::align_size(vector_data_size, DEFAULT_SIMD_ALIGNMENT);
        let total_size = header_size + aligned_vector_data_size;

        // Create memory-mapped file
        let mut mmap_file = MemoryMappedFile::create(path, total_size)?;

        // Create and write header
        let mut header = VectorStorageHeader::new(vector_dimension, capacity)?;

        // Initialize vector data area with zeros
        let vector_data_slice = vec![0u8; aligned_vector_data_size];
        header.update_checksum(&vector_data_slice);

        mmap_file.write_at(0, &header)?;
        mmap_file.write_slice_at(header_size, &vector_data_slice)?;
        mmap_file.sync()?;

        Ok(Self {
            mmap_file,
            header,
            vector_dimension,
            capacity,
            read_only: false,
        })
    }

    /// Open an existing vector storage file
    pub fn open<P: AsRef<Path>>(path: P) -> Result<Self, ShardexError> {
        Self::open_with_mode(path, false)
    }

    /// Open an existing vector storage file in read-only mode
    pub fn open_read_only<P: AsRef<Path>>(path: P) -> Result<Self, ShardexError> {
        Self::open_with_mode(path, true)
    }

    /// Internal method to open storage with specified mode
    fn open_with_mode<P: AsRef<Path>>(path: P, read_only: bool) -> Result<Self, ShardexError> {
        let path = path.as_ref();

        let mmap_file = if read_only {
            MemoryMappedFile::open_read_only(path)?
        } else {
            MemoryMappedFile::open_read_write(path)?
        };

        // Read and validate header
        let header: VectorStorageHeader = mmap_file.read_at(0)?;
        header.validate()?;

        // Validate checksum
        let vector_data_start = header.vector_data_offset as usize;
        let vector_data_size =
            (header.capacity as usize) * (header.vector_dimension as usize) * std::mem::size_of::<f32>();
        let aligned_size = Self::align_size(vector_data_size, header.simd_alignment as usize);

        if vector_data_start + aligned_size > mmap_file.len() {
            return Err(ShardexError::Corruption(
                "File too small for declared vector capacity".to_string(),
            ));
        }

        let vector_data = &mmap_file.as_slice()[vector_data_start..vector_data_start + aligned_size];
        header.file_header.validate_checksum(vector_data)?;

        let vector_dimension = header.vector_dimension as usize;
        let capacity = header.capacity as usize;

        Ok(Self {
            mmap_file,
            header,
            vector_dimension,
            capacity,
            read_only,
        })
    }

    /// Get the vector dimension
    pub fn vector_dimension(&self) -> usize {
        self.vector_dimension
    }

    /// Get the total capacity
    pub fn capacity(&self) -> usize {
        self.capacity
    }

    /// Get the current count of vectors (including deleted ones)
    pub fn current_count(&self) -> usize {
        self.header.current_count as usize
    }

    /// Get the count of active (non-deleted) vectors
    pub fn active_count(&self) -> usize {
        self.header.active_count as usize
    }

    /// Check if the storage is read-only
    pub fn is_read_only(&self) -> bool {
        self.read_only
    }

    /// Check if the storage is at capacity
    pub fn is_full(&self) -> bool {
        self.current_count() >= self.capacity()
    }

    /// Get remaining capacity
    pub fn remaining_capacity(&self) -> usize {
        self.capacity().saturating_sub(self.current_count())
    }

    /// Add a vector to the storage
    ///
    /// Returns the index where the vector was stored.
    pub fn add_vector(&mut self, vector: &[f32]) -> Result<usize, ShardexError> {
        if self.read_only {
            return Err(ShardexError::Config(
                "Cannot add vector to read-only storage".to_string(),
            ));
        }

        // Validate vector dimension
        if vector.len() != self.vector_dimension {
            return Err(ShardexError::InvalidDimension {
                expected: self.vector_dimension,
                actual: vector.len(),
            });
        }

        // Check capacity
        if self.is_full() {
            return Err(ShardexError::Config("Vector storage is at capacity".to_string()));
        }

        let index = self.current_count();
        self.write_vector_at_index(index, vector)?;

        // Update counts
        self.header.current_count += 1;
        self.header.active_count += 1;
        self.update_header()?;

        Ok(index)
    }

    /// Get a vector by index (zero-copy access)
    ///
    /// Returns a slice view into the mapped memory.
    pub fn get_vector(&self, index: usize) -> Result<&[f32], ShardexError> {
        if index >= self.current_count() {
            return Err(ShardexError::Config(format!(
                "Index {} out of bounds (current count: {})",
                index,
                self.current_count()
            )));
        }

        self.read_vector_at_index(index)
    }

    /// Update a vector at the specified index
    pub fn update_vector(&mut self, index: usize, vector: &[f32]) -> Result<(), ShardexError> {
        if self.read_only {
            return Err(ShardexError::Config(
                "Cannot update vector in read-only storage".to_string(),
            ));
        }

        if index >= self.current_count() {
            return Err(ShardexError::Config(format!(
                "Index {} out of bounds (current count: {})",
                index,
                self.current_count()
            )));
        }

        // Validate vector dimension
        if vector.len() != self.vector_dimension {
            return Err(ShardexError::InvalidDimension {
                expected: self.vector_dimension,
                actual: vector.len(),
            });
        }

        self.write_vector_at_index(index, vector)?;
        self.update_header()
    }

    /// Mark a vector as deleted (tombstone approach)
    ///
    /// The vector data remains in place but is marked as inactive.
    /// Use compact() to reclaim space from deleted vectors.
    pub fn remove_vector(&mut self, index: usize) -> Result<(), ShardexError> {
        if self.read_only {
            return Err(ShardexError::Config(
                "Cannot remove vector from read-only storage".to_string(),
            ));
        }

        if index >= self.current_count() {
            return Err(ShardexError::Config(format!(
                "Index {} out of bounds (current count: {})",
                index,
                self.current_count()
            )));
        }

        // For now, we use a simple tombstone approach by writing NaN values
        // In a full implementation, we might use a separate deleted bitmap
        let deleted_marker = vec![f32::NAN; self.vector_dimension];
        self.write_vector_at_index(index, &deleted_marker)?;

        // Update active count
        if self.header.active_count > 0 {
            self.header.active_count -= 1;
        }

        self.update_header()
    }

    /// Check if a vector at the given index is deleted
    pub fn is_deleted(&self, index: usize) -> Result<bool, ShardexError> {
        if index >= self.current_count() {
            return Ok(false); // Non-existent vectors are not deleted
        }

        let vector = self.get_vector(index)?;
        // Check if first element is NaN (our deletion marker)
        Ok(vector[0].is_nan())
    }

    /// Synchronize the storage to disk
    pub fn sync(&mut self) -> Result<(), ShardexError> {
        if self.read_only {
            return Ok(()); // Read-only storage doesn't need syncing
        }

        self.update_header()?;
        self.mmap_file.sync()
    }

    /// Internal method to write a vector at a specific index
    fn write_vector_at_index(&mut self, index: usize, vector: &[f32]) -> Result<(), ShardexError> {
        let vector_offset = self.calculate_vector_offset(index);
        self.mmap_file.write_slice_at(vector_offset, vector)?;
        Ok(())
    }

    /// Internal method to read a vector at a specific index
    fn read_vector_at_index(&self, index: usize) -> Result<&[f32], ShardexError> {
        let vector_offset = self.calculate_vector_offset(index);
        let vector_slice: &[f32] = self
            .mmap_file
            .read_slice_at(vector_offset, self.vector_dimension)?;
        Ok(vector_slice)
    }

    /// Calculate the byte offset for a vector at the given index
    fn calculate_vector_offset(&self, index: usize) -> usize {
        let header_size = VectorStorageHeader::SIZE;
        let vector_size_bytes = self.vector_dimension * std::mem::size_of::<f32>();
        header_size + (index * vector_size_bytes)
    }

    /// Validate the integrity of the vector storage
    ///
    /// Performs comprehensive validation including header consistency,
    /// vector data integrity, and cross-validation of metadata.
    pub fn validate_integrity(&self) -> Result<(), ShardexError> {
        // Validate header
        self.header.validate()?;

        // Validate file header checksum against data
        let vector_data_start = self.header.vector_data_offset as usize;
        let vector_data_size =
            (self.header.capacity as usize) * (self.header.vector_dimension as usize) * std::mem::size_of::<f32>();
        let aligned_size = Self::align_size(vector_data_size, self.header.simd_alignment as usize);

        if vector_data_start + aligned_size > self.mmap_file.len() {
            return Err(ShardexError::Corruption(
                "File size is inconsistent with header metadata".to_string(),
            ));
        }

        let vector_data = &self.mmap_file.as_slice()[vector_data_start..vector_data_start + aligned_size];
        self.header.file_header.validate_checksum(vector_data)?;

        // Validate vector data consistency
        self.validate_vector_consistency()?;

        Ok(())
    }

    /// Validate internal vector data consistency
    ///
    /// Checks that active/deleted counts match actual data,
    /// and that vector data is valid (no invalid float values unless deleted).
    fn validate_vector_consistency(&self) -> Result<(), ShardexError> {
        let mut actual_active_count = 0u32;
        let mut actual_deleted_count = 0u32;

        // Count actual active and deleted vectors
        for i in 0..self.current_count() {
            if self.is_deleted(i)? {
                actual_deleted_count += 1;
            } else {
                actual_active_count += 1;

                // Validate that active vectors have valid data
                let vector = self.get_vector(i)?;
                for (j, &value) in vector.iter().enumerate() {
                    if value.is_infinite() {
                        return Err(ShardexError::Corruption(format!(
                            "Vector {} contains infinite value at dimension {}",
                            i, j
                        )));
                    }
                    // Note: We allow NaN values only for deleted vectors
                    if value.is_nan() {
                        return Err(ShardexError::Corruption(format!(
                            "Active vector {} contains NaN value at dimension {} (should be deleted)",
                            i, j
                        )));
                    }
                }
            }
        }

        // Check active count consistency
        if actual_active_count != self.header.active_count {
            return Err(ShardexError::Corruption(format!(
                "Active count mismatch: header claims {}, actual count is {}",
                self.header.active_count, actual_active_count
            )));
        }

        // Check that total counts are consistent
        let total_accounted = actual_active_count + actual_deleted_count;
        if total_accounted != self.header.current_count {
            return Err(ShardexError::Corruption(format!(
                "Count mismatch: header claims {} total, but found {} active + {} deleted = {}",
                self.header.current_count, actual_active_count, actual_deleted_count, total_accounted
            )));
        }

        Ok(())
    }

    /// Get the underlying memory-mapped file for external integrity validation
    pub fn memory_mapped_file(&self) -> &MemoryMappedFile {
        &self.mmap_file
    }

    /// Update the header in the memory-mapped file
    fn update_header(&mut self) -> Result<(), ShardexError> {
        // Update checksum
        let vector_data_start = self.header.vector_data_offset as usize;
        let vector_data_size =
            (self.header.capacity as usize) * (self.header.vector_dimension as usize) * std::mem::size_of::<f32>();
        let aligned_size = Self::align_size(vector_data_size, self.header.simd_alignment as usize);
        let vector_data = &self.mmap_file.as_slice()[vector_data_start..vector_data_start + aligned_size];

        self.header.file_header.update_checksum(vector_data);

        // Write header to file
        self.mmap_file.write_at(0, &self.header)?;
        Ok(())
    }

    /// Align size to the specified alignment boundary
    fn align_size(size: usize, alignment: usize) -> usize {
        (size + alignment - 1) & !(alignment - 1)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use tempfile::{NamedTempFile, TempDir};

    #[test]
    fn test_vector_storage_header_creation() {
        let header = VectorStorageHeader::new(384, 1000).unwrap();

        assert_eq!(header.vector_dimension, 384);
        assert_eq!(header.capacity, 1000);
        assert_eq!(header.current_count, 0);
        assert_eq!(header.active_count, 0);
        assert_eq!(header.vector_size_bytes, 384 * 4);
        assert_eq!(header.simd_alignment, DEFAULT_SIMD_ALIGNMENT as u32);

        assert!(header.validate().is_ok());
    }

    #[test]
    fn test_vector_storage_header_validation_errors() {
        // Zero dimension should fail
        assert!(VectorStorageHeader::new(0, 1000).is_err());

        // Zero capacity should fail
        assert!(VectorStorageHeader::new(384, 0).is_err());

        // Dimension too large should fail
        assert!(VectorStorageHeader::new(u32::MAX as usize + 1, 1000).is_err());

        // Capacity too large should fail
        assert!(VectorStorageHeader::new(384, u32::MAX as usize + 1).is_err());
    }

    #[test]
    fn test_create_vector_storage() {
        let temp_dir = TempDir::new().unwrap();
        let storage_path = temp_dir.path().join("vectors.dat");

        let storage = VectorStorage::create(&storage_path, 128, 100).unwrap();

        assert_eq!(storage.vector_dimension(), 128);
        assert_eq!(storage.capacity(), 100);
        assert_eq!(storage.current_count(), 0);
        assert_eq!(storage.active_count(), 0);
        assert!(!storage.is_read_only());
        assert!(!storage.is_full());
        assert_eq!(storage.remaining_capacity(), 100);
    }

    #[test]
    fn test_add_and_get_vectors() {
        let temp_dir = TempDir::new().unwrap();
        let storage_path = temp_dir.path().join("vectors.dat");

        let mut storage = VectorStorage::create(&storage_path, 3, 10).unwrap();

        // Add some vectors
        let vector1 = vec![1.0, 2.0, 3.0];
        let vector2 = vec![4.0, 5.0, 6.0];

        let idx1 = storage.add_vector(&vector1).unwrap();
        let idx2 = storage.add_vector(&vector2).unwrap();

        assert_eq!(idx1, 0);
        assert_eq!(idx2, 1);
        assert_eq!(storage.current_count(), 2);
        assert_eq!(storage.active_count(), 2);

        // Retrieve vectors
        let retrieved1 = storage.get_vector(idx1).unwrap();
        let retrieved2 = storage.get_vector(idx2).unwrap();

        assert_eq!(retrieved1, &vector1[..]);
        assert_eq!(retrieved2, &vector2[..]);
    }

    #[test]
    fn test_vector_dimension_validation() {
        let temp_dir = TempDir::new().unwrap();
        let storage_path = temp_dir.path().join("vectors.dat");

        let mut storage = VectorStorage::create(&storage_path, 3, 10).unwrap();

        // Wrong dimension should fail
        let wrong_vector = vec![1.0, 2.0]; // 2D instead of 3D
        let result = storage.add_vector(&wrong_vector);

        match result {
            Err(ShardexError::InvalidDimension { expected, actual }) => {
                assert_eq!(expected, 3);
                assert_eq!(actual, 2);
            }
            _ => panic!("Expected InvalidDimension error"),
        }
    }

    #[test]
    fn test_capacity_limits() {
        let temp_dir = TempDir::new().unwrap();
        let storage_path = temp_dir.path().join("vectors.dat");

        let mut storage = VectorStorage::create(&storage_path, 2, 2).unwrap();

        // Add vectors up to capacity
        let vector = vec![1.0, 2.0];
        storage.add_vector(&vector).unwrap();
        storage.add_vector(&vector).unwrap();

        assert!(storage.is_full());
        assert_eq!(storage.remaining_capacity(), 0);

        // Adding beyond capacity should fail
        let result = storage.add_vector(&vector);
        assert!(matches!(result, Err(ShardexError::Config(_))));
    }

    #[test]
    fn test_update_vector() {
        let temp_dir = TempDir::new().unwrap();
        let storage_path = temp_dir.path().join("vectors.dat");

        let mut storage = VectorStorage::create(&storage_path, 3, 10).unwrap();

        // Add a vector
        let original = vec![1.0, 2.0, 3.0];
        let idx = storage.add_vector(&original).unwrap();

        // Update it
        let updated = vec![10.0, 20.0, 30.0];
        storage.update_vector(idx, &updated).unwrap();

        // Verify update
        let retrieved = storage.get_vector(idx).unwrap();
        assert_eq!(retrieved, &updated[..]);
    }

    #[test]
    fn test_remove_vector() {
        let temp_dir = TempDir::new().unwrap();
        let storage_path = temp_dir.path().join("vectors.dat");

        let mut storage = VectorStorage::create(&storage_path, 3, 10).unwrap();

        // Add vectors
        let vector1 = vec![1.0, 2.0, 3.0];
        let vector2 = vec![4.0, 5.0, 6.0];
        let idx1 = storage.add_vector(&vector1).unwrap();
        let idx2 = storage.add_vector(&vector2).unwrap();

        assert_eq!(storage.active_count(), 2);

        // Remove one vector
        storage.remove_vector(idx1).unwrap();

        assert_eq!(storage.current_count(), 2); // Still 2 total
        assert_eq!(storage.active_count(), 1); // But only 1 active
        assert!(storage.is_deleted(idx1).unwrap());
        assert!(!storage.is_deleted(idx2).unwrap());

        // Vector 2 should still be accessible
        let retrieved2 = storage.get_vector(idx2).unwrap();
        assert_eq!(retrieved2, &vector2[..]);
    }

    #[test]
    fn test_out_of_bounds_access() {
        let temp_dir = TempDir::new().unwrap();
        let storage_path = temp_dir.path().join("vectors.dat");

        let storage = VectorStorage::create(&storage_path, 3, 10).unwrap();

        // Try to access non-existent vector
        let result = storage.get_vector(0);
        assert!(matches!(result, Err(ShardexError::Config(_))));

        let result = storage.get_vector(5);
        assert!(matches!(result, Err(ShardexError::Config(_))));
    }

    #[test]
    fn test_persistence() {
        let temp_file = NamedTempFile::new().unwrap();
        let storage_path = temp_file.path();

        let vectors_to_add = vec![vec![1.0, 2.0, 3.0], vec![4.0, 5.0, 6.0], vec![7.0, 8.0, 9.0]];

        // Create and populate storage
        {
            let mut storage = VectorStorage::create(storage_path, 3, 10).unwrap();

            for vector in &vectors_to_add {
                storage.add_vector(vector).unwrap();
            }
            storage.sync().unwrap();
        }

        // Reopen and verify
        {
            let storage = VectorStorage::open(storage_path).unwrap();

            assert_eq!(storage.vector_dimension(), 3);
            assert_eq!(storage.capacity(), 10);
            assert_eq!(storage.current_count(), 3);
            assert_eq!(storage.active_count(), 3);

            for (i, expected_vector) in vectors_to_add.iter().enumerate() {
                let retrieved = storage.get_vector(i).unwrap();
                assert_eq!(retrieved, &expected_vector[..]);
            }
        }
    }

    #[test]
    fn test_read_only_mode() {
        let temp_file = NamedTempFile::new().unwrap();
        let storage_path = temp_file.path();

        // Create storage with some data
        {
            let mut storage = VectorStorage::create(storage_path, 2, 5).unwrap();
            let vector = vec![1.0, 2.0];
            storage.add_vector(&vector).unwrap();
            storage.sync().unwrap();
        }

        // Open in read-only mode
        {
            let mut storage = VectorStorage::open_read_only(storage_path).unwrap();

            assert!(storage.is_read_only());
            assert_eq!(storage.current_count(), 1);

            // Should be able to read
            let retrieved = storage.get_vector(0).unwrap();
            assert_eq!(retrieved, &[1.0, 2.0]);

            // Should not be able to modify
            let new_vector = vec![3.0, 4.0];
            assert!(storage.add_vector(&new_vector).is_err());
            assert!(storage.update_vector(0, &new_vector).is_err());
            assert!(storage.remove_vector(0).is_err());
        }
    }

    #[test]
    fn test_header_bytemuck_compatibility() {
        let header = VectorStorageHeader::new(128, 1000).unwrap();

        // Should be able to convert to bytes
        let bytes = bytemuck::bytes_of(&header);
        assert_eq!(bytes.len(), VectorStorageHeader::SIZE);

        // Should be able to convert back
        let header_restored = bytemuck::from_bytes::<VectorStorageHeader>(bytes);
        assert_eq!(header.vector_dimension, header_restored.vector_dimension);
        assert_eq!(header.capacity, header_restored.capacity);
        assert_eq!(header.current_count, header_restored.current_count);
    }

    #[test]
    fn test_alignment() {
        // Test alignment calculation
        assert_eq!(VectorStorage::align_size(100, 64), 128);
        assert_eq!(VectorStorage::align_size(64, 64), 64);
        assert_eq!(VectorStorage::align_size(65, 64), 128);
        assert_eq!(VectorStorage::align_size(1, 64), 64);
    }

    #[test]
    fn test_header_validation() {
        let mut header = VectorStorageHeader::new(384, 1000).unwrap();

        // Should validate correctly initially
        assert!(header.validate().is_ok());

        // Break magic bytes
        header.file_header.magic = *magic::TEST_CORRUPTION;
        assert!(header.validate().is_err());
        header.file_header.magic = *magic::VECTOR_STORAGE;

        // Break version
        header.file_header.version = 999;
        assert!(header.validate().is_err());
        header.file_header.version = VECTOR_STORAGE_VERSION;

        // Break vector size consistency
        header.vector_size_bytes = 100; // Should be 384 * 4 = 1536
        assert!(header.validate().is_err());
        header.vector_size_bytes = 384 * 4;

        // Break count consistency
        header.current_count = header.capacity + 1;
        assert!(header.validate().is_err());
        header.current_count = 0;

        header.active_count = header.current_count + 1;
        assert!(header.validate().is_err());
        header.active_count = 0;

        // Should validate correctly again
        assert!(header.validate().is_ok());
    }

    #[test]
    fn test_large_vectors() {
        let temp_dir = TempDir::new().unwrap();
        let storage_path = temp_dir.path().join("large_vectors.dat");

        // Create storage for large vectors (1536 dimensions like OpenAI embeddings)
        let dimension = 1536;
        let mut storage = VectorStorage::create(&storage_path, dimension, 10).unwrap();

        // Create a large vector
        let large_vector: Vec<f32> = (0..dimension)
            .map(|i| i as f32 / dimension as f32)
            .collect();

        let idx = storage.add_vector(&large_vector).unwrap();
        let retrieved = storage.get_vector(idx).unwrap();

        assert_eq!(retrieved.len(), dimension);
        assert_eq!(retrieved[0], 0.0);
        assert_eq!(retrieved[dimension - 1], (dimension - 1) as f32 / dimension as f32);

        // Verify all values
        for (i, &value) in retrieved.iter().enumerate() {
            assert_eq!(value, i as f32 / dimension as f32);
        }
    }

    #[test]
    fn test_zero_copy_access() {
        let temp_dir = TempDir::new().unwrap();
        let storage_path = temp_dir.path().join("zero_copy.dat");

        let mut storage = VectorStorage::create(&storage_path, 4, 100).unwrap();

        // Add vector
        let vector = vec![1.0, 2.0, 3.0, 4.0];
        let idx = storage.add_vector(&vector).unwrap();

        // Get vector reference (should be zero-copy)
        let vector_ref = storage.get_vector(idx).unwrap();

        // Verify it's pointing to the same memory location pattern
        // (We can't directly test memory addresses, but we can verify the slice works correctly)
        assert_eq!(vector_ref.len(), 4);
        assert_eq!(vector_ref[0], 1.0);
        assert_eq!(vector_ref[1], 2.0);
        assert_eq!(vector_ref[2], 3.0);
        assert_eq!(vector_ref[3], 4.0);

        // The slice should be directly backed by the memory-mapped file
        assert_eq!(std::mem::size_of_val(vector_ref), 4 * std::mem::size_of::<f32>());
    }

    #[test]
    fn test_simd_alignment() {
        let temp_dir = TempDir::new().unwrap();
        let storage_path = temp_dir.path().join("simd_test.dat");

        // Create storage that should have SIMD-aligned vector data
        let storage = VectorStorage::create(&storage_path, 8, 100).unwrap();

        // Verify the header has correct alignment
        assert_eq!(storage.header.simd_alignment, DEFAULT_SIMD_ALIGNMENT as u32);

        // The vector data should start at a SIMD-aligned offset
        let vector_data_start = storage.header.vector_data_offset as usize;
        assert!(vector_data_start >= VectorStorageHeader::SIZE);
    }
}