qem 0.6.2

High-performance cross-platform text engine for massive files.
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
use crate::source_identity::sampled_content_fingerprint;
use crate::storage::FileStorage;
use memchr::memchr2_iter;
use std::collections::{HashMap, VecDeque};
use std::fs::File;
use std::io::{self, Read, Seek, SeekFrom, Write};
use std::path::{Path, PathBuf};
use std::sync::{Arc, Mutex, RwLock};
use std::thread;
use std::time::UNIX_EPOCH;

const INDEX_MAGIC: &[u8; 8] = b"QEMIDX1\0";
// `.qem.lineidx` is an internal cache sidecar rather than a stable external
// format. Qem may bump this version across releases and rebuild the cache
// instead of preserving compatibility with older index files.
const INDEX_VERSION: u32 = 2;
const INDEX_PAGE_SIZE: usize = 4096;
const INDEX_HEADER_BYTES: usize = 72;
const INDEX_PAGE_HEADER_BYTES: usize = 16;
const INDEX_ENTRY_BYTES: usize = 24;
const INDEX_CACHE_PAGES: usize = 32;
const INDEX_BUILD_MIN_FILE_BYTES: usize = 64 * 1024 * 1024; // 64 MiB
const INDEX_SYNC_BUILD_MAX_SCAN_BYTES: usize = 64 * 1024 * 1024; // 64 MiB
const INDEX_CHECKPOINT_STRIDE_LINES: u64 = 8_192;
const INDEX_CHECKPOINT_STRIDE_BYTES: u64 = 1_048_576; // 1 MiB

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub(crate) struct LineCheckpoint {
    pub(crate) line0: usize,
    pub(crate) byte0: usize,
}

#[derive(Clone)]
pub(crate) struct DiskLineIndex {
    state: Arc<RwLock<DiskLineIndexState>>,
}

impl std::fmt::Debug for DiskLineIndex {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let state = self.state.read().ok();
        let label = match state.as_deref() {
            Some(DiskLineIndexState::Building) => "Building",
            Some(DiskLineIndexState::Ready(_)) => "Ready",
            Some(DiskLineIndexState::Failed) => "Failed",
            None => "Poisoned",
        };
        f.debug_struct("DiskLineIndex")
            .field("state", &label)
            .finish()
    }
}

#[derive(Debug)]
enum DiskLineIndexState {
    Building,
    Ready(Arc<ReadyDiskLineIndex>),
    Failed,
}

#[derive(Debug)]
struct ReadyDiskLineIndex {
    path: PathBuf,
    total_lines: u64,
    root_page: u64,
    page_count: u64,
    cache: Mutex<PageCache>,
}

#[derive(Debug, Default)]
struct PageCache {
    pages: HashMap<u64, Arc<Page>>,
    order: VecDeque<u64>,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
enum PageKind {
    Internal = 1,
    Leaf = 2,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
struct PageEntry {
    line0: u64,
    byte0: u64,
    child_page: u64,
}

#[derive(Debug)]
struct Page {
    kind: PageKind,
    entries: Vec<PageEntry>,
}

#[derive(Clone, Copy, Debug)]
struct IndexMetadata {
    source_len: u64,
    source_mtime_ns: u64,
    source_fingerprint: u64,
}

#[cfg(windows)]
#[repr(C)]
#[derive(Clone, Copy, Debug, Default)]
struct FileAllocatedRangeBuffer {
    file_offset: i64,
    length: i64,
}

impl DiskLineIndex {
    pub(crate) fn open_or_build(path: &Path, storage: &FileStorage) -> Option<Self> {
        if storage.len() < INDEX_BUILD_MIN_FILE_BYTES {
            return None;
        }

        let metadata = source_metadata(path, storage.bytes()).ok()?;
        let sidecar = sidecar_path(path);
        let state = if let Ok(ready) = ReadyDiskLineIndex::open_existing(&sidecar, metadata) {
            DiskLineIndexState::Ready(Arc::new(ready))
        } else {
            DiskLineIndexState::Building
        };
        let this = Self {
            state: Arc::new(RwLock::new(state)),
        };

        let already_ready = this
            .state
            .read()
            .ok()
            .map(|state| matches!(&*state, DiskLineIndexState::Ready(_)))
            .unwrap_or(false);
        if already_ready {
            return Some(this);
        }

        if should_build_index_synchronously(path, storage.len()) {
            let ready = build_or_open_index(path, storage, metadata).ok()?;
            if let Ok(mut guard) = this.state.write() {
                *guard = DiskLineIndexState::Ready(Arc::new(ready));
            }
            return Some(this);
        }

        let state = Arc::clone(&this.state);
        let storage = storage.clone();
        let path = path.to_path_buf();
        thread::spawn(move || {
            let result = build_or_open_index(&path, &storage, metadata);
            if let Ok(mut guard) = state.write() {
                *guard = match result {
                    Ok(ready) => DiskLineIndexState::Ready(Arc::new(ready)),
                    Err(_) => DiskLineIndexState::Failed,
                };
            }
        });

        Some(this)
    }

    pub(crate) fn checkpoint_for_line(&self, line0: usize) -> Option<LineCheckpoint> {
        let ready = self.ready()?;
        let checkpoint = ready.checkpoint_for_line(line0 as u64).ok()?;
        Some(LineCheckpoint {
            line0: checkpoint.line0 as usize,
            byte0: checkpoint.byte0 as usize,
        })
    }

    pub(crate) fn total_lines(&self) -> Option<usize> {
        let ready = self.ready()?;
        usize::try_from(ready.total_lines).ok()
    }

    pub(crate) fn is_building(&self) -> bool {
        self.state
            .read()
            .ok()
            .map(|state| matches!(&*state, DiskLineIndexState::Building))
            .unwrap_or(false)
    }

    fn ready(&self) -> Option<Arc<ReadyDiskLineIndex>> {
        let state = self.state.read().ok()?;
        match &*state {
            DiskLineIndexState::Ready(ready) => Some(Arc::clone(ready)),
            DiskLineIndexState::Building | DiskLineIndexState::Failed => None,
        }
    }

    #[cfg(test)]
    pub(crate) fn building_for_tests() -> Self {
        Self {
            state: Arc::new(RwLock::new(DiskLineIndexState::Building)),
        }
    }

    #[cfg(test)]
    pub(crate) fn finish_build_for_tests(&self, total_lines: usize) {
        let Ok(total_lines) = u64::try_from(total_lines) else {
            return;
        };
        let ready = ReadyDiskLineIndex {
            path: PathBuf::new(),
            total_lines,
            root_page: 0,
            page_count: 0,
            cache: Mutex::new(PageCache::default()),
        };
        if let Ok(mut guard) = self.state.write() {
            *guard = DiskLineIndexState::Ready(Arc::new(ready));
        }
    }
}

impl ReadyDiskLineIndex {
    fn open_existing(path: &Path, metadata: IndexMetadata) -> io::Result<Self> {
        let mut file = File::open(path)?;
        let header = read_header(&mut file)?;
        validate_header(header, metadata)?;

        let ready = Self {
            path: path.to_path_buf(),
            total_lines: header.total_lines,
            root_page: header.root_page,
            page_count: header.page_count,
            cache: Mutex::new(PageCache::default()),
        };
        ready.validate_root_page()?;
        Ok(ready)
    }

    fn checkpoint_for_line(&self, line0: u64) -> io::Result<PageEntry> {
        if self.page_count == 0 {
            return Ok(PageEntry {
                line0: 0,
                byte0: 0,
                child_page: 0,
            });
        }

        let mut current_page = self.root_page;
        loop {
            let page = self.read_page(current_page)?;
            let Some(entry) = lookup_entry(&page.entries, line0) else {
                return Ok(PageEntry {
                    line0: 0,
                    byte0: 0,
                    child_page: 0,
                });
            };
            if page.kind == PageKind::Leaf {
                return Ok(entry);
            }
            current_page = entry.child_page;
        }
    }

    fn read_page(&self, page_id: u64) -> io::Result<Arc<Page>> {
        if let Ok(mut cache) = self.cache.lock() {
            if let Some(page) = cache.get(page_id) {
                return Ok(page);
            }
        }

        let mut file = File::open(&self.path)?;
        let mut buf = vec![0u8; INDEX_PAGE_SIZE];
        let page_offset =
            INDEX_HEADER_BYTES as u64 + page_id.saturating_sub(1) * INDEX_PAGE_SIZE as u64;
        file.seek(SeekFrom::Start(page_offset))?;
        file.read_exact(&mut buf)?;
        let page = Arc::new(parse_page(&buf)?);

        if let Ok(mut cache) = self.cache.lock() {
            cache.insert(page_id, Arc::clone(&page));
        }

        Ok(page)
    }

    fn validate_root_page(&self) -> io::Result<()> {
        if self.page_count == 0 {
            return Ok(());
        }
        let _ = self.read_page(self.root_page)?;
        Ok(())
    }
}

impl PageCache {
    fn get(&mut self, page_id: u64) -> Option<Arc<Page>> {
        let page = self.pages.get(&page_id).cloned()?;
        self.touch(page_id);
        Some(page)
    }

    fn insert(&mut self, page_id: u64, page: Arc<Page>) {
        self.pages.insert(page_id, page);
        self.touch(page_id);
        while self.order.len() > INDEX_CACHE_PAGES {
            if let Some(evicted) = self.order.pop_back() {
                self.pages.remove(&evicted);
            }
        }
    }

    fn touch(&mut self, page_id: u64) {
        if let Some(idx) = self.order.iter().position(|id| *id == page_id) {
            self.order.remove(idx);
        }
        self.order.push_front(page_id);
    }
}

#[derive(Clone, Copy, Debug)]
struct FileHeader {
    root_page: u64,
    page_count: u64,
    total_lines: u64,
    total_bytes: u64,
    source_len: u64,
    source_mtime_ns: u64,
    source_fingerprint: u64,
}

fn validate_header(header: FileHeader, metadata: IndexMetadata) -> io::Result<()> {
    if header.source_len != metadata.source_len
        || header.source_mtime_ns != metadata.source_mtime_ns
        || header.source_fingerprint != metadata.source_fingerprint
    {
        return Err(io::Error::new(
            io::ErrorKind::InvalidData,
            "stale line index metadata",
        ));
    }

    if header.total_bytes != metadata.source_len || header.total_lines == 0 {
        return Err(io::Error::new(
            io::ErrorKind::InvalidData,
            "invalid qem line index header",
        ));
    }

    if header.page_count == 0 {
        if header.root_page != 0 {
            return Err(io::Error::new(
                io::ErrorKind::InvalidData,
                "invalid qem line index root page",
            ));
        }
    } else if header.root_page == 0 || header.root_page > header.page_count {
        return Err(io::Error::new(
            io::ErrorKind::InvalidData,
            "invalid qem line index root page",
        ));
    }

    Ok(())
}

fn build_or_open_index(
    source_path: &Path,
    storage: &FileStorage,
    metadata: IndexMetadata,
) -> io::Result<ReadyDiskLineIndex> {
    let sidecar = sidecar_path(source_path);
    if let Ok(ready) = ReadyDiskLineIndex::open_existing(&sidecar, metadata) {
        return Ok(ready);
    }

    build_index_file(source_path, &sidecar, storage, metadata)?;
    ReadyDiskLineIndex::open_existing(&sidecar, metadata)
}

fn build_index_file(
    source_path: &Path,
    path: &Path,
    storage: &FileStorage,
    metadata: IndexMetadata,
) -> io::Result<()> {
    FileStorage::replace_with(path, |file| {
        file.write_all(&[0u8; INDEX_HEADER_BYTES])?;

        let page_capacity =
            ((INDEX_PAGE_SIZE - INDEX_PAGE_HEADER_BYTES) / INDEX_ENTRY_BYTES).max(1);
        let bytes = storage.bytes();
        let ranges = scannable_ranges(source_path, bytes.len());
        let mut page_count = 0u64;
        let mut leaf_entries = Vec::with_capacity(page_capacity);
        let mut summaries = Vec::new();
        let mut total_lines = 1u64;
        let mut next_line_checkpoint = INDEX_CHECKPOINT_STRIDE_LINES;
        let mut next_byte_checkpoint = INDEX_CHECKPOINT_STRIDE_BYTES;

        leaf_entries.push(PageEntry {
            line0: 0,
            byte0: 0,
            child_page: 0,
        });

        for (start, end) in ranges {
            let start = start.min(bytes.len());
            let end = end.min(bytes.len()).max(start);
            for rel in memchr2_iter(b'\n', b'\r', &bytes[start..end]) {
                let pos = start + rel;
                if bytes[pos] == b'\r' && pos + 1 < bytes.len() && bytes[pos + 1] == b'\n' {
                    continue;
                }

                let line_start = (pos + 1) as u64;
                let line0 = total_lines;
                total_lines = total_lines.saturating_add(1);
                if line0 < next_line_checkpoint && line_start < next_byte_checkpoint {
                    continue;
                }

                leaf_entries.push(PageEntry {
                    line0,
                    byte0: line_start,
                    child_page: 0,
                });
                next_line_checkpoint = line0.saturating_add(INDEX_CHECKPOINT_STRIDE_LINES);
                next_byte_checkpoint = line_start.saturating_add(INDEX_CHECKPOINT_STRIDE_BYTES);

                if leaf_entries.len() >= page_capacity {
                    let page_id = write_page(file, PageKind::Leaf, &leaf_entries, &mut page_count)?;
                    let first = leaf_entries[0];
                    summaries.push(PageEntry {
                        line0: first.line0,
                        byte0: first.byte0,
                        child_page: page_id,
                    });
                    leaf_entries.clear();
                }
            }
        }

        if !leaf_entries.is_empty() {
            let page_id = write_page(file, PageKind::Leaf, &leaf_entries, &mut page_count)?;
            let first = leaf_entries[0];
            summaries.push(PageEntry {
                line0: first.line0,
                byte0: first.byte0,
                child_page: page_id,
            });
        }

        let root_page = build_internal_levels(file, page_capacity, &mut page_count, summaries)?;
        let header = FileHeader {
            root_page,
            page_count,
            total_lines,
            total_bytes: bytes.len() as u64,
            source_len: metadata.source_len,
            source_mtime_ns: metadata.source_mtime_ns,
            source_fingerprint: metadata.source_fingerprint,
        };
        file.seek(SeekFrom::Start(0))?;
        write_header(file, header)
    })
}

fn scannable_ranges(source_path: &Path, file_len: usize) -> Vec<(usize, usize)> {
    if file_len == 0 {
        return Vec::new();
    }

    #[cfg(windows)]
    {
        if let Ok(ranges) = windows_allocated_ranges(source_path, file_len) {
            return ranges;
        }
    }

    vec![(0, file_len)]
}

fn total_scannable_bytes(ranges: &[(usize, usize)]) -> usize {
    ranges
        .iter()
        .fold(0usize, |acc, (start, end)| acc.saturating_add(end.saturating_sub(*start)))
}

fn should_build_index_synchronously(source_path: &Path, file_len: usize) -> bool {
    if file_len == 0 {
        return true;
    }

    #[cfg(windows)]
    {
        if let Ok(ranges) = windows_allocated_ranges(source_path, file_len) {
            return total_scannable_bytes(&ranges) <= INDEX_SYNC_BUILD_MAX_SCAN_BYTES;
        }
    }

    false
}

fn merge_contiguous_ranges(mut ranges: Vec<(usize, usize)>, file_len: usize) -> Vec<(usize, usize)> {
    if ranges.is_empty() {
        return ranges;
    }

    ranges.sort_unstable_by_key(|range| range.0);
    let mut merged: Vec<(usize, usize)> = Vec::with_capacity(ranges.len());
    for (start, end) in ranges {
        let start = start.min(file_len);
        let end = end.min(file_len).max(start);
        if start >= end {
            continue;
        }

        if let Some(last) = merged.last_mut() {
            if start <= last.1 {
                last.1 = last.1.max(end);
                continue;
            }
        }
        merged.push((start, end));
    }
    merged
}

#[cfg(windows)]
fn windows_allocated_ranges(source_path: &Path, file_len: usize) -> io::Result<Vec<(usize, usize)>> {
    use std::ffi::c_void;
    use std::os::windows::io::AsRawHandle;
    use std::ptr;

    const ERROR_MORE_DATA: i32 = 234;
    const FSCTL_QUERY_ALLOCATED_RANGES: u32 = 0x0009_40CF;

    unsafe extern "system" {
        fn DeviceIoControl(
            device: *mut c_void,
            io_control_code: u32,
            in_buffer: *mut c_void,
            in_buffer_size: u32,
            out_buffer: *mut c_void,
            out_buffer_size: u32,
            bytes_returned: *mut u32,
            overlapped: *mut c_void,
        ) -> i32;
    }

    let file = File::open(source_path)?;
    let handle = file.as_raw_handle().cast::<c_void>();
    let query = FileAllocatedRangeBuffer {
        file_offset: 0,
        length: file_len.min(i64::MAX as usize) as i64,
    };
    let entry_size = std::mem::size_of::<FileAllocatedRangeBuffer>();
    let mut capacity = 64usize;

    loop {
        let mut output = vec![FileAllocatedRangeBuffer::default(); capacity];
        let mut returned = 0u32;
        let ok = unsafe {
            DeviceIoControl(
                handle,
                FSCTL_QUERY_ALLOCATED_RANGES,
                (&query as *const FileAllocatedRangeBuffer).cast_mut().cast::<c_void>(),
                entry_size as u32,
                output.as_mut_ptr().cast::<c_void>(),
                output
                    .len()
                    .saturating_mul(entry_size)
                    .min(u32::MAX as usize) as u32,
                &mut returned,
                ptr::null_mut(),
            )
        };
        if ok != 0 {
            let count = (returned as usize) / entry_size;
            output.truncate(count);
            let ranges = output
                .into_iter()
                .filter_map(|range| {
                    let start = usize::try_from(range.file_offset).ok()?;
                    let len = usize::try_from(range.length).ok()?;
                    let end = start.checked_add(len)?;
                    Some((start, end))
                })
                .collect();
            return Ok(merge_contiguous_ranges(ranges, file_len));
        }

        let err = io::Error::last_os_error();
        if err.raw_os_error() == Some(ERROR_MORE_DATA) && capacity < (1 << 20) {
            capacity = capacity.saturating_mul(2);
            continue;
        }
        return Err(err);
    }
}

fn build_internal_levels(
    file: &mut File,
    page_capacity: usize,
    page_count: &mut u64,
    mut summaries: Vec<PageEntry>,
) -> io::Result<u64> {
    if summaries.is_empty() {
        return Ok(0);
    }
    if summaries.len() == 1 {
        return Ok(summaries[0].child_page);
    }

    while summaries.len() > 1 {
        let mut next = Vec::new();
        for chunk in summaries.chunks(page_capacity.max(1)) {
            let page_id = write_page(file, PageKind::Internal, chunk, page_count)?;
            let first = chunk[0];
            next.push(PageEntry {
                line0: first.line0,
                byte0: first.byte0,
                child_page: page_id,
            });
        }
        summaries = next;
    }

    Ok(summaries[0].child_page)
}

fn write_page(
    file: &mut File,
    kind: PageKind,
    entries: &[PageEntry],
    page_count: &mut u64,
) -> io::Result<u64> {
    let page_id = page_count.saturating_add(1);
    let mut buf = vec![0u8; INDEX_PAGE_SIZE];
    buf[0] = kind as u8;
    buf[8..16].copy_from_slice(&(entries.len() as u64).to_le_bytes());
    let mut cursor = INDEX_PAGE_HEADER_BYTES;
    for entry in entries {
        buf[cursor..cursor + 8].copy_from_slice(&entry.line0.to_le_bytes());
        buf[cursor + 8..cursor + 16].copy_from_slice(&entry.byte0.to_le_bytes());
        buf[cursor + 16..cursor + 24].copy_from_slice(&entry.child_page.to_le_bytes());
        cursor += INDEX_ENTRY_BYTES;
    }
    file.seek(SeekFrom::End(0))?;
    file.write_all(&buf)?;
    *page_count = page_id;
    Ok(page_id)
}

fn write_header(file: &mut File, header: FileHeader) -> io::Result<()> {
    let mut buf = [0u8; INDEX_HEADER_BYTES];
    buf[0..8].copy_from_slice(INDEX_MAGIC);
    buf[8..12].copy_from_slice(&INDEX_VERSION.to_le_bytes());
    buf[12..16].copy_from_slice(&(INDEX_PAGE_SIZE as u32).to_le_bytes());
    buf[16..24].copy_from_slice(&header.root_page.to_le_bytes());
    buf[24..32].copy_from_slice(&header.page_count.to_le_bytes());
    buf[32..40].copy_from_slice(&header.total_lines.to_le_bytes());
    buf[40..48].copy_from_slice(&header.total_bytes.to_le_bytes());
    buf[48..56].copy_from_slice(&header.source_len.to_le_bytes());
    buf[56..64].copy_from_slice(&header.source_mtime_ns.to_le_bytes());
    buf[64..72].copy_from_slice(&header.source_fingerprint.to_le_bytes());
    file.write_all(&buf)
}

fn read_header(file: &mut File) -> io::Result<FileHeader> {
    let mut buf = [0u8; INDEX_HEADER_BYTES];
    file.seek(SeekFrom::Start(0))?;
    file.read_exact(&mut buf)?;
    if &buf[0..8] != INDEX_MAGIC {
        return Err(io::Error::new(
            io::ErrorKind::InvalidData,
            "invalid qem line index magic",
        ));
    }

    let version = u32::from_le_bytes(buf[8..12].try_into().unwrap_or([0; 4]));
    let page_size = u32::from_le_bytes(buf[12..16].try_into().unwrap_or([0; 4]));
    if version != INDEX_VERSION || page_size as usize != INDEX_PAGE_SIZE {
        return Err(io::Error::new(
            io::ErrorKind::InvalidData,
            "unsupported qem line index version",
        ));
    }

    Ok(FileHeader {
        root_page: u64::from_le_bytes(buf[16..24].try_into().unwrap_or([0; 8])),
        page_count: u64::from_le_bytes(buf[24..32].try_into().unwrap_or([0; 8])),
        total_lines: u64::from_le_bytes(buf[32..40].try_into().unwrap_or([0; 8])),
        total_bytes: u64::from_le_bytes(buf[40..48].try_into().unwrap_or([0; 8])),
        source_len: u64::from_le_bytes(buf[48..56].try_into().unwrap_or([0; 8])),
        source_mtime_ns: u64::from_le_bytes(buf[56..64].try_into().unwrap_or([0; 8])),
        source_fingerprint: u64::from_le_bytes(buf[64..72].try_into().unwrap_or([0; 8])),
    })
}

fn parse_page(buf: &[u8]) -> io::Result<Page> {
    let kind = match buf.first().copied() {
        Some(1) => PageKind::Internal,
        Some(2) => PageKind::Leaf,
        _ => {
            return Err(io::Error::new(
                io::ErrorKind::InvalidData,
                "invalid qem line index page kind",
            ));
        }
    };
    let count = u64::from_le_bytes(buf[8..16].try_into().unwrap_or([0; 8])) as usize;
    let mut entries = Vec::with_capacity(count);
    let mut cursor = INDEX_PAGE_HEADER_BYTES;
    for _ in 0..count {
        if cursor + INDEX_ENTRY_BYTES > buf.len() {
            return Err(io::Error::new(
                io::ErrorKind::UnexpectedEof,
                "truncated qem line index page",
            ));
        }
        entries.push(PageEntry {
            line0: u64::from_le_bytes(buf[cursor..cursor + 8].try_into().unwrap_or([0; 8])),
            byte0: u64::from_le_bytes(buf[cursor + 8..cursor + 16].try_into().unwrap_or([0; 8])),
            child_page: u64::from_le_bytes(
                buf[cursor + 16..cursor + 24].try_into().unwrap_or([0; 8]),
            ),
        });
        cursor += INDEX_ENTRY_BYTES;
    }
    Ok(Page { kind, entries })
}

fn lookup_entry(entries: &[PageEntry], target_line0: u64) -> Option<PageEntry> {
    if entries.is_empty() {
        return None;
    }
    let idx = entries.partition_point(|entry| entry.line0 <= target_line0);
    Some(entries[idx.saturating_sub(1)])
}

fn sidecar_path(source_path: &Path) -> PathBuf {
    let parent = source_path.parent().unwrap_or_else(|| Path::new("."));
    let file_name = source_path
        .file_name()
        .and_then(|name| name.to_str())
        .filter(|name| !name.is_empty())
        .unwrap_or("qem");
    parent.join(format!(".{file_name}.qem.lineidx"))
}

fn source_metadata(path: &Path, bytes: &[u8]) -> io::Result<IndexMetadata> {
    let metadata = std::fs::metadata(path)?;
    let source_len = metadata.len();
    let source_mtime_ns = metadata
        .modified()?
        .duration_since(UNIX_EPOCH)
        .unwrap_or_default()
        .as_nanos()
        .min(u64::MAX as u128) as u64;
    Ok(IndexMetadata {
        source_len,
        source_mtime_ns,
        source_fingerprint: sampled_content_fingerprint(bytes),
    })
}

#[cfg(test)]
mod tests {
    use super::{
        build_index_file, build_or_open_index, merge_contiguous_ranges, sidecar_path,
        source_metadata, FileHeader,
        ReadyDiskLineIndex,
    };
    use crate::storage::FileStorage;
    use std::fs;
    use std::io::{Seek, SeekFrom, Write};

    #[test]
    fn disk_line_index_builds_and_resolves_checkpoints() {
        let dir = std::env::temp_dir().join(format!("qem-index-{}", std::process::id()));
        let _ = fs::create_dir_all(&dir);
        let path = dir.join("sample.txt");
        let text = "aa\n".repeat(20_000);
        fs::write(&path, text).unwrap();

        let storage = FileStorage::open(&path).unwrap();
        let metadata = source_metadata(&path, storage.bytes()).unwrap();
        let sidecar = sidecar_path(&path);
        build_index_file(&path, &sidecar, &storage, metadata).unwrap();
        let ready = ReadyDiskLineIndex::open_existing(&sidecar, metadata).unwrap();

        assert_eq!(ready.total_lines, 20_001);
        assert!(ready.page_count >= 1);

        let checkpoint = ready.checkpoint_for_line(16_384).unwrap();
        assert!(checkpoint.line0 <= 16_384);
        assert!(checkpoint.byte0 <= storage.len() as u64);

        let _ = fs::remove_file(&sidecar);
        let _ = fs::remove_file(&path);
        let _ = fs::remove_dir_all(&dir);
    }

    #[test]
    fn index_header_round_trips() {
        let header = FileHeader {
            root_page: 7,
            page_count: 9,
            total_lines: 123,
            total_bytes: 456,
            source_len: 456,
            source_mtime_ns: 789,
            source_fingerprint: 987,
        };
        let dir = std::env::temp_dir().join(format!("qem-index-header-{}", std::process::id()));
        let _ = fs::create_dir_all(&dir);
        let path = dir.join("header.bin");
        let mut file = fs::File::create(&path).unwrap();
        super::write_header(&mut file, header).unwrap();
        drop(file);

        let mut file = fs::File::open(&path).unwrap();
        let parsed = super::read_header(&mut file).unwrap();
        assert_eq!(parsed.root_page, header.root_page);
        assert_eq!(parsed.page_count, header.page_count);
        assert_eq!(parsed.total_lines, header.total_lines);
        assert_eq!(parsed.total_bytes, header.total_bytes);
        assert_eq!(parsed.source_len, header.source_len);
        assert_eq!(parsed.source_mtime_ns, header.source_mtime_ns);
        assert_eq!(parsed.source_fingerprint, header.source_fingerprint);

        let _ = fs::remove_file(&path);
        let _ = fs::remove_dir_all(&dir);
    }

    #[test]
    fn line_index_rejects_stale_content_fingerprint_even_with_matching_file_metadata() {
        let dir = std::env::temp_dir().join(format!(
            "qem-index-stale-fingerprint-{}",
            std::process::id()
        ));
        let _ = fs::create_dir_all(&dir);
        let path = dir.join("sample.txt");
        let text = "aa\n".repeat(10_000);
        fs::write(&path, text).unwrap();

        let storage = FileStorage::open(&path).unwrap();
        let metadata = source_metadata(&path, storage.bytes()).unwrap();
        let sidecar = sidecar_path(&path);
        build_index_file(&path, &sidecar, &storage, metadata).unwrap();

        let stale = super::IndexMetadata {
            source_len: metadata.source_len,
            source_mtime_ns: metadata.source_mtime_ns,
            source_fingerprint: metadata.source_fingerprint ^ 1,
        };
        let err = ReadyDiskLineIndex::open_existing(&sidecar, stale).unwrap_err();
        assert_eq!(err.kind(), std::io::ErrorKind::InvalidData);

        let _ = fs::remove_file(&sidecar);
        let _ = fs::remove_file(&path);
        let _ = fs::remove_dir_all(&dir);
    }

    #[test]
    fn line_index_rebuilds_when_root_page_is_corrupt() {
        let dir =
            std::env::temp_dir().join(format!("qem-index-corrupt-root-{}", std::process::id()));
        let _ = fs::create_dir_all(&dir);
        let path = dir.join("sample.txt");
        let text = "aa\n".repeat(40_000);
        fs::write(&path, text).unwrap();

        let storage = FileStorage::open(&path).unwrap();
        let metadata = source_metadata(&path, storage.bytes()).unwrap();
        let sidecar = sidecar_path(&path);
        build_index_file(&path, &sidecar, &storage, metadata).unwrap();

        {
            let mut file = fs::OpenOptions::new().write(true).open(&sidecar).unwrap();
            file.seek(SeekFrom::Start(super::INDEX_HEADER_BYTES as u64))
                .unwrap();
            file.write_all(&[0xFF]).unwrap();
            file.flush().unwrap();
        }

        let err = ReadyDiskLineIndex::open_existing(&sidecar, metadata).unwrap_err();
        assert!(matches!(
            err.kind(),
            std::io::ErrorKind::InvalidData | std::io::ErrorKind::UnexpectedEof
        ));

        let rebuilt = build_or_open_index(&path, &storage, metadata).unwrap();
        assert_eq!(rebuilt.total_lines, 40_001);
        let checkpoint = rebuilt.checkpoint_for_line(16_384).unwrap();
        assert!(checkpoint.line0 <= 16_384);
        assert!(checkpoint.byte0 <= storage.len() as u64);

        let _ = fs::remove_file(&sidecar);
        let _ = fs::remove_file(&path);
        let _ = fs::remove_dir_all(&dir);
    }

    #[test]
    fn merge_contiguous_ranges_coalesces_touching_extents() {
        assert_eq!(
            merge_contiguous_ranges(vec![(32, 48), (0, 16), (16, 32), (64, 64), (80, 96)], 128),
            vec![(0, 48), (80, 96)]
        );
    }
}