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
//! Index reader — the mmap-based query-time interface.
//!
//! Fast, zero-copy access to the index data.
use crate::bloom::BloomFilter;
use crate::error::{Error, Result};
use crate::format::{DELTA_FILE_ENTRY, DELTA_MAGIC, DELTA_TOMBSTONE, DELTA_TRIGRAM_ENTRY};
use crate::format::{FILE_ENTRY_SIZE, FileStatus, HEADER_SIZE, Header};
use crate::posting::PostingList;
use crate::string_pool::StringPoolReader;
use crate::trigram::Trigram;
use memmap2::Mmap;
use std::collections::{HashMap, HashSet};
use std::fs::File;
use std::path::{Path, PathBuf};
use std::time::UNIX_EPOCH;
#[cfg(unix)]
use std::os::unix::fs::MetadataExt;
/// Lightweight snapshot of shard-level metadata (no mmap needed).
#[derive(Debug, Clone, Copy)]
pub struct ShardMetadata {
/// Microsecond-precision Unix timestamp from the shard header.
pub shard_timestamp: u64,
/// Total number of files indexed in this shard.
pub file_count: u32,
/// Total number of unique trigrams in this shard.
pub trigram_count: u32,
}
/// One entry in the CDX block index: first trigram key + absolute block offset.
#[derive(Debug, Clone, Copy)]
pub struct CdxBlockEntry {
/// First trigram key in this block.
pub first_key: u32,
/// Absolute byte offset of the compressed block.
pub block_offset: u64,
}
/// Index reader — mmaps the shard file for zero-copy lookups.
pub struct Reader {
mmap: Mmap,
/// Parsed shard header containing section offsets and sizes.
pub header: Header,
string_pool: StringPoolReader<'static>,
inode: Option<u64>,
cdx_blocks: Vec<CdxBlockEntry>,
}
/// Descriptor pointing into the trigram table for a single trigram.
#[derive(Debug)]
pub struct TrigramInfo {
/// Absolute file offset where the posting list begins.
pub posting_offset: u64,
/// Number of bytes in the encoded posting list.
pub posting_length: u32,
/// How many files contain this trigram (document frequency).
pub doc_frequency: u32,
}
/// Metadata about a single file known to the index.
#[derive(Debug)]
pub struct FileInfo {
/// Internal 0-based file identifier.
pub file_id: u32,
/// Absolute path to the file on disk.
pub path: PathBuf,
/// Whether the file is fresh, stale, or deleted.
pub status: FileStatus,
/// Last modification time in nanoseconds since the Unix epoch.
pub mtime_ns: u64,
/// File size in bytes at index time.
pub size_bytes: u64,
/// XXH64 content hash computed at index time.
pub content_hash: u64,
}
#[allow(clippy::as_conversions)] // binary format: usize/u32/u64 casts for index decoding
#[allow(clippy::indexing_slicing)] // binary format: fixed-size buffer ops, length-checked
impl Reader {
/// Open and memory-map an index file for reading.
///
/// # Errors
///
/// Returns an error if the file cannot be opened, memory-mapped, or its
/// header is invalid.
pub fn open(path: &Path) -> Result<Self> {
let file = File::open(path)?;
// SAFETY: Mmap::map wraps the mmap(2) syscall. The file handle is kept alive
// by Mmap's internal Arc<File>, ensuring the underlying data remains valid
// for the lifetime of the mmap.
let mmap = unsafe { Mmap::map(&file)? };
if mmap.len() < HEADER_SIZE {
return Err(Error::IndexTooSmall);
}
let header = Header::parse(&mmap[0..HEADER_SIZE])?;
header.validate_bounds(mmap.len() as u64)?;
#[cfg(unix)]
let inode = Some(file.metadata()?.ino());
#[cfg(not(unix))]
let inode = None;
// SAFETY: We transmute the slice lifetime to 'static. This is sound because:
// INVARIANT: Reader owns the Mmap, which owns the underlying memory.
// INVARIANT: Mmap's data remains valid for the entire lifetime of Reader.
// INVARIANT: No mutable access to mmap occurs after construction.
// INVARIANT: StringPoolReader<'static> cannot outlive Reader (it's a field).
// This is the standard pattern for self-referential mmap structs in Rust.
let string_pool_data: &'static [u8] = unsafe {
let start = header.string_pool_offset as usize;
let end = (header.string_pool_offset + header.string_pool_size) as usize;
std::mem::transmute::<&[u8], &'static [u8]>(&mmap[start..end])
};
let string_pool = StringPoolReader::new(string_pool_data)?;
let cdx_blocks = if header.has_cdx() && header.cdx_block_index_size > 0 {
let idx_start = header.cdx_block_index_offset as usize;
let idx_end = idx_start + header.cdx_block_index_size as usize;
let idx_data = mmap
.get(idx_start..idx_end)
.ok_or(Error::SectionOutOfBounds {
section: "cdx_block_index",
offset: header.cdx_block_index_offset,
size: header.cdx_block_index_size,
file_len: mmap.len() as u64,
})?;
let mut blocks = Vec::new();
let mut pos = 0;
while pos + 12 <= idx_data.len() {
let first_key = u32::from_le_bytes(
idx_data[pos..pos + 4]
.try_into()
.map_err(|_| Error::Config("bad cdx key".into()))?,
);
if first_key == u32::MAX {
break;
}
let block_offset = u64::from_le_bytes(
idx_data[pos + 4..pos + 12]
.try_into()
.map_err(|_| Error::Config("bad cdx offset".into()))?,
);
blocks.push(CdxBlockEntry {
first_key,
block_offset,
});
pos += 12;
}
blocks
} else {
Vec::new()
};
Ok(Self {
mmap,
header,
string_pool,
inode,
cdx_blocks,
})
}
/// Get the last modification time among all source files in the tree.
///
/// # Errors
///
/// Returns an error if the directory walk fails or metadata cannot be read.
pub fn get_last_modified(root: &Path) -> Result<u64> {
let mut last_modified = 0u64;
let walker = ignore::WalkBuilder::new(root)
.hidden(false)
.git_ignore(true)
.require_git(false)
.add_custom_ignore_filename(".ixignore")
.filter_entry(move |entry| {
let path = entry.path();
let name = path.file_name().and_then(|n| n.to_str()).unwrap_or("");
if entry.file_type().is_some_and(|t| t.is_dir())
&& matches!(
name,
"lost+found"
| ".git"
| "node_modules"
| "target"
| "__pycache__"
| ".tox"
| ".venv"
| "venv"
| ".ix"
)
{
return false;
}
if entry.file_type().is_some_and(|t| t.is_file()) {
let ext = path.extension().and_then(|e| e.to_str()).unwrap_or("");
if matches!(
ext,
"so" | "o"
| "dylib"
| "a"
| "dll"
| "exe"
| "pyc"
| "jpg"
| "png"
| "gif"
| "mp4"
| "mp3"
| "pdf"
| "zip"
| "7z"
| "rar"
| "sqlite"
| "db"
| "bin"
) || name.ends_with(".tar.gz")
{
return false;
}
}
true
})
.build();
for result in walker {
match result {
Ok(entry) => {
if entry.file_type().is_some_and(|t| t.is_file()) {
let metadata =
entry.metadata().map_err(|e| Error::Config(e.to_string()))?;
let mtime = metadata
.modified()
.and_then(|t| {
t.duration_since(UNIX_EPOCH)
.map_err(|_| std::io::Error::other("time went backwards"))
})
.map_or(0, |d| d.as_micros() as u64);
if mtime > last_modified {
last_modified = mtime;
}
}
}
Err(e) => {
eprintln!("ix: warning: stale check skipping path: {e}");
}
}
}
Ok(last_modified)
}
/// Binary search the trigram table. Returns `None` if the trigram
/// is unknown.
///
/// When CDX compression is active, performs a two-level search:
/// first on the block index, then within the decompressed block.
pub fn get_trigram(&self, trigram: Trigram) -> Option<TrigramInfo> {
if self.header.has_cdx() && !self.cdx_blocks.is_empty() {
return self.get_trigram_cdx(trigram);
}
// Legacy fallback (no CDX)
let count = self.header.trigram_count as usize;
let table_start = self.header.trigram_table_offset as usize;
let entry_size = crate::format::TRIGRAM_ENTRY_SIZE;
let mut low = 0;
let mut high = count;
while low < high {
let mid = low + (high - low) / 2;
let entry_off = table_start + mid * entry_size;
let key_bytes = self.mmap.get(entry_off..entry_off + 4)?;
let key = u32::from_le_bytes(key_bytes.try_into().ok()?);
match key.cmp(&trigram) {
std::cmp::Ordering::Equal => {
let entry = self.mmap.get(entry_off..entry_off + entry_size)?;
let mut off_bytes = [0u8; 8];
off_bytes[..6].copy_from_slice(&entry[4..10]);
let posting_offset = u64::from_le_bytes(off_bytes);
let posting_length = entry
.get(10..14)
.and_then(|s| s.try_into().ok())
.map(u32::from_le_bytes)?;
let doc_frequency = entry
.get(14..18)
.and_then(|s| s.try_into().ok())
.map(u32::from_le_bytes)?;
return Some(TrigramInfo {
posting_offset,
posting_length,
doc_frequency,
});
}
std::cmp::Ordering::Less => low = mid + 1,
std::cmp::Ordering::Greater => high = mid,
}
}
None
}
fn get_trigram_cdx(&self, trigram: Trigram) -> Option<TrigramInfo> {
let mut block_idx = 0;
for (i, entry) in self.cdx_blocks.iter().enumerate() {
if entry.first_key > trigram {
break;
}
block_idx = i;
}
let block_entry = self.cdx_blocks.get(block_idx)?;
let block_end = self.cdx_blocks.get(block_idx + 1).map_or_else(
|| self.header.trigram_table_offset + self.header.trigram_table_size,
|next| next.block_offset,
);
let block_start = block_entry.block_offset as usize;
let block_end = block_end as usize;
let block_data = self.mmap.get(block_start..block_end)?;
let decompressed = match zstd::decode_all(block_data) {
Ok(d) => d,
Err(e) => {
tracing::warn!("ix: CDX block decompression failed: {e}");
return None;
}
};
let mut pos = 0;
let num_entries = match crate::varint::decode(&decompressed, &mut pos) {
Ok(v) => usize::try_from(v).unwrap_or(0),
Err(e) => {
tracing::warn!("ix: CDX num_entries varint decode failed: {e}");
return None;
}
};
let mut last_key = 0u32;
for _ in 0..num_entries {
let key_delta = match crate::varint::decode(&decompressed, &mut pos) {
Ok(v) => u32::try_from(v).unwrap_or(0),
Err(e) => {
tracing::warn!("ix: CDX key_delta varint decode failed: {e}");
return None;
}
};
let key = last_key + key_delta;
last_key = key;
let posting_offset = match crate::varint::decode(&decompressed, &mut pos) {
Ok(v) => v,
Err(e) => {
tracing::warn!("ix: CDX posting_offset varint decode failed: {e}");
return None;
}
};
let posting_length = match crate::varint::decode(&decompressed, &mut pos) {
Ok(v) => u32::try_from(v).unwrap_or(0),
Err(e) => {
tracing::warn!("ix: CDX posting_length varint decode failed: {e}");
return None;
}
};
let doc_frequency = match crate::varint::decode(&decompressed, &mut pos) {
Ok(v) => u32::try_from(v).unwrap_or(0),
Err(e) => {
tracing::warn!("ix: CDX doc_frequency varint decode failed: {e}");
return None;
}
};
if key == trigram {
return Some(TrigramInfo {
posting_offset,
posting_length,
doc_frequency,
});
}
if key > trigram {
break;
}
}
None
}
/// Decode the posting list for a given trigram info.
///
/// # Errors
///
/// Returns an error if the posting data is out of bounds or corrupted.
pub fn decode_postings(&self, info: &TrigramInfo) -> Result<PostingList> {
let start = info.posting_offset as usize;
let end = start + info.posting_length as usize;
if end > self.mmap.len() {
return Err(Error::PostingOutOfBounds);
}
PostingList::decode(&self.mmap[start..end])
}
/// Retrieve file metadata by its ID.
///
/// # Errors
///
/// Returns an error if the file ID is out of bounds or the file table entry
/// is malformed.
pub fn get_file(&self, file_id: u32) -> Result<FileInfo> {
if file_id >= self.header.file_count {
return Err(Error::FileIdOutOfBounds(file_id));
}
let entry_off = self.header.file_table_offset as usize + file_id as usize * FILE_ENTRY_SIZE;
let entry = self
.mmap
.get(entry_off..entry_off + FILE_ENTRY_SIZE)
.ok_or(Error::SectionOutOfBounds {
section: "file_entry",
offset: entry_off as u64,
size: FILE_ENTRY_SIZE as u64,
file_len: self.mmap.len() as u64,
})?;
let path_off = u32::from_le_bytes(
entry[4..8]
.try_into()
.map_err(|_| Error::Config("invalid path offset".into()))?,
);
let status = FileStatus::from_u8(entry[10]);
let mtime_ns = u64::from_le_bytes(
entry[12..20]
.try_into()
.map_err(|_| Error::Config("invalid mtime".into()))?,
);
let size_bytes = u64::from_le_bytes(
entry[20..28]
.try_into()
.map_err(|_| Error::Config("invalid size".into()))?,
);
let content_hash = u64::from_le_bytes(
entry[28..36]
.try_into()
.map_err(|_| Error::Config("invalid hash".into()))?,
);
let path = self.string_pool.resolve(path_off)?;
Ok(FileInfo {
file_id,
path: PathBuf::from(path),
status,
mtime_ns,
size_bytes,
content_hash,
})
}
/// Check if a bloom filter for a file may contain a trigram.
///
/// Returns `true` if the trigram may be present (conservative) or if
/// any error occurs reading the bloom data (safe default: assume present).
#[must_use]
pub fn bloom_may_contain(&self, file_id: u32, trigram: Trigram) -> bool {
if !self.header.has_bloom() {
return true;
}
let entry_off = self.header.file_table_offset as usize + file_id as usize * FILE_ENTRY_SIZE;
let Some(bloom_bytes) = self.mmap.get(entry_off + 40..entry_off + 44) else {
return true;
};
let bloom_rel_off = match bloom_bytes.try_into() {
Ok(b) => u32::from_le_bytes(b),
Err(_) => return true,
};
let bloom_abs_off = self.header.bloom_offset as usize + bloom_rel_off as usize;
let Some(size_bytes) = self.mmap.get(bloom_abs_off..bloom_abs_off + 2) else {
return true;
};
let size = match size_bytes.try_into() {
Ok(b) => u16::from_le_bytes(b),
Err(_) => return true,
} as usize;
let num_hashes = self.mmap.get(bloom_abs_off + 2).copied().unwrap_or(0);
let Some(bits) = self.mmap.get(bloom_abs_off + 4..bloom_abs_off + 4 + size) else {
return true;
};
BloomFilter::slice_contains(bits, num_hashes, trigram)
}
/// Retrieve high-level shard metadata without parsing the full header.
#[must_use]
pub const fn metadata(&self) -> ShardMetadata {
ShardMetadata {
shard_timestamp: self.header.created_at,
file_count: self.header.file_count,
trigram_count: self.header.trigram_count,
}
}
/// Detect whether the shard file on disk has been rebuilt under this live mmap.
///
/// Returns `true` if the inode or file size differs, or if the file no longer exists.
/// A stale reader should be dropped and reopened.
///
/// On Unix: uses inode comparison (inode changes on atomic rename).
/// On non-Unix: uses file size comparison only (Windows file locking prevents
/// rebuild under live mmap, so size-only detection is sufficient).
#[must_use]
pub fn is_stale(&self, path: &Path) -> bool {
let Ok(current) = std::fs::metadata(path) else {
return true;
};
if current.len() as usize != self.mmap.len() {
return true;
}
#[cfg(unix)]
{
if let Some(stored_inode) = self.inode
&& current.ino() != stored_inode
{
return true;
}
}
false
}
}
/// Metadata for a single file stored in the delta index.
#[derive(Debug, Clone)]
pub struct DeltaFileInfo {
/// Absolute path to the file on disk.
pub path: PathBuf,
/// Last modification time in nanoseconds since the Unix epoch.
pub mtime: u64,
/// File size in bytes at index time.
pub size: u64,
/// XXH64 content hash computed at index time.
pub hash: u64,
/// Raw bloom filter bytes (260 bytes).
pub bloom_bytes: Vec<u8>,
}
/// Delta index reader for incremental index updates.
#[derive(Default)]
pub struct DeltaReader {
/// Set of tombstoned file IDs.
pub tombstones: HashSet<u32>,
/// Delta trigram postings (trigram to entries).
pub postings: HashMap<u32, Vec<crate::posting::PostingEntry>>,
/// Mapping from file path to file ID (path → id).
pub path_to_id: HashMap<PathBuf, u32>,
/// Mapping from file ID to file metadata (id → info).
pub id_to_fileinfo: HashMap<u32, DeltaFileInfo>,
/// Total number of file entries in this delta.
pub total_file_entries: u32,
}
impl DeltaReader {
/// Open and parse a delta index file.
///
/// Returns `Default::default()` if the file does not exist or is invalid.
///
/// # Errors
///
/// Returns an error if the file exists but cannot be read.
pub fn open(path: &std::path::Path) -> crate::error::Result<Self> {
use std::io::Read;
let mut file = match std::fs::File::open(path) {
Ok(f) => f,
Err(e) if e.kind() == std::io::ErrorKind::NotFound => return Ok(Self::default()),
Err(e) => return Err(e.into()),
};
let mut reader = Self::default();
let mut magic = [0u8; 4];
if file.read_exact(&mut magic).is_err() || magic != DELTA_MAGIC {
return Ok(reader);
}
let mut type_buf = [0u8; 1];
while file.read_exact(&mut type_buf).is_ok() {
match type_buf[0] {
DELTA_TOMBSTONE => {
let mut id_buf = [0u8; 4];
file.read_exact(&mut id_buf)?;
reader.tombstones.insert(u32::from_le_bytes(id_buf));
}
DELTA_FILE_ENTRY => {
let mut id_buf = [0u8; 4];
file.read_exact(&mut id_buf)?;
let file_id = u32::from_le_bytes(id_buf);
let mut len_buf = [0u8; 2];
file.read_exact(&mut len_buf)?;
let path_len = u16::from_le_bytes(len_buf) as usize;
let mut path_buf = vec![0u8; path_len];
file.read_exact(&mut path_buf)?;
let path = PathBuf::from(String::from_utf8_lossy(&path_buf).into_owned());
let mut u64_buf = [0u8; 8];
file.read_exact(&mut u64_buf)?;
let mtime = u64::from_le_bytes(u64_buf);
file.read_exact(&mut u64_buf)?;
let size = u64::from_le_bytes(u64_buf);
file.read_exact(&mut u64_buf)?;
let hash = u64::from_le_bytes(u64_buf);
let mut bloom_buf = vec![0u8; 260];
file.read_exact(&mut bloom_buf)?;
reader.id_to_fileinfo.insert(
file_id,
DeltaFileInfo {
path: path.clone(),
mtime,
size,
hash,
bloom_bytes: bloom_buf,
},
);
reader.path_to_id.insert(path, file_id);
reader.total_file_entries += 1;
}
DELTA_TRIGRAM_ENTRY => {
let mut buf32 = [0u8; 4];
file.read_exact(&mut buf32)?;
let trigram = u32::from_le_bytes(buf32);
file.read_exact(&mut buf32)?;
file.read_exact(&mut buf32)?;
let file_id = u32::from_le_bytes(buf32);
file.read_exact(&mut buf32)?;
let offsets_len = u32::from_le_bytes(buf32) as usize;
let mut offsets = Vec::with_capacity(offsets_len);
for _ in 0..offsets_len {
file.read_exact(&mut buf32)?;
offsets.push(u32::from_le_bytes(buf32));
}
reader
.postings
.entry(trigram)
.or_default()
.push(crate::posting::PostingEntry { file_id, offsets });
}
_ => break,
}
}
Ok(reader)
}
}