rustkmer 0.5.2

High-performance k-mer counting tool in Rust
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
//! Streaming merge for large database operations
//!
//! This module implements external sort-based merge for databases
//! that are too large to fit in memory.

use crate::database::format::{DatabaseHeader, KmerEntry, DATABASE_MAGIC, DATABASE_VERSION};
use crate::error::ProcessingError;
use std::cmp::Ordering;
use std::collections::BinaryHeap;
use std::fs::File;
use std::io::{BufReader, BufWriter, Seek, SeekFrom, Write};
use std::path::{Path, PathBuf};
use std::time::Instant;

/// Streaming iterator for reading database entries in chunks
pub struct DatabaseStreamIterator {
    reader: BufReader<File>,
    remaining: u64,
    chunk_size: usize,
    current_pos: u64,
}

impl DatabaseStreamIterator {
    pub fn new(path: &Path, chunk_size: usize) -> Result<Self, ProcessingError> {
        let file = File::open(path).map_err(|e| {
            ProcessingError::io_error(format!(
                "Failed to open database '{}': {}",
                path.display(),
                e
            ))
        })?;

        let mut reader = BufReader::new(file);

        let header = DatabaseHeader::read_from(&mut reader).map_err(|e| {
            ProcessingError::io_error(format!("Failed to read database header: {}", e))
        })?;

        let actual_data_offset = if header.data_offset < 40 {
            42
        } else if header.data_offset > 1000 {
            42
        } else {
            header.data_offset
        };

        reader
            .seek(SeekFrom::Start(actual_data_offset))
            .map_err(|e| {
                ProcessingError::io_error(format!("Failed to seek to data section: {}", e))
            })?;

        Ok(Self {
            reader,
            remaining: header.total_kmers,
            chunk_size,
            current_pos: 0,
        })
    }

    pub fn header(&self) -> DatabaseHeader {
        DatabaseHeader {
            magic: *DATABASE_MAGIC,
            version: DATABASE_VERSION,
            kmer_size: 0,
            total_kmers: self.remaining,
            sorted: false,
            data_offset: 0,
            index_offset: 0,
            canonical: false,
            unique_kmers: self.remaining,
            file_size: 0,
        }
    }
}

impl Iterator for DatabaseStreamIterator {
    type Item = Result<Vec<KmerEntry>, ProcessingError>;

    fn next(&mut self) -> Option<Self::Item> {
        if self.remaining == 0 {
            return None;
        }

        let to_read = std::cmp::min(self.chunk_size, self.remaining as usize);
        let mut chunk = Vec::with_capacity(to_read);

        for _ in 0..to_read {
            match KmerEntry::read_from(&mut self.reader) {
                Ok(entry) => chunk.push(entry),
                Err(e) => {
                    return Some(Err(ProcessingError::io_error(format!(
                        "Failed to read k-mer entry: {}",
                        e
                    ))))
                }
            }
        }

        self.remaining -= to_read as u64;
        self.current_pos += to_read as u64;

        Some(Ok(chunk))
    }
}

/// Temporary file manager for external merge operations
pub struct TempFileManager {
    temp_dir: PathBuf,
    files: Vec<PathBuf>,
    prefix: String,
    auto_cleanup: bool,
}

impl TempFileManager {
    pub fn new(temp_dir: PathBuf, operation: &str) -> Self {
        let prefix = format!("rustkmer_{}_{}", operation, std::process::id());
        Self {
            temp_dir,
            files: Vec::new(),
            prefix,
            auto_cleanup: true,
        }
    }

    pub fn with_cleanup(mut self, auto_cleanup: bool) -> Self {
        self.auto_cleanup = auto_cleanup;
        self
    }

    pub fn create_temp_file(&mut self) -> Result<(PathBuf, BufWriter<File>), ProcessingError> {
        let timestamp = std::time::SystemTime::now()
            .duration_since(std::time::UNIX_EPOCH)
            .unwrap()
            .as_micros();

        let file_name = format!("{}_{}.chunk", self.prefix, timestamp);
        let file_path = self.temp_dir.join(&file_name);

        let file = File::create(&file_path).map_err(|e| {
            ProcessingError::io_error(format!(
                "Failed to create temp file '{}': {}",
                file_path.display(),
                e
            ))
        })?;

        let writer = BufWriter::new(file);
        self.files.push(file_path.clone());

        Ok((file_path, writer))
    }

    pub fn cleanup(&self) {
        for file_path in &self.files {
            let _ = std::fs::remove_file(file_path);
        }
    }

    pub fn take_files(&mut self) -> Vec<PathBuf> {
        std::mem::take(&mut self.files)
    }
}

impl Drop for TempFileManager {
    fn drop(&mut self) {
        if self.auto_cleanup {
            self.cleanup();
        }
    }
}

/// External merge using sorted run-based approach
pub struct ExternalMerger {
    chunk_size: usize,
    temp_dir: PathBuf,
    temp_files: Vec<PathBuf>,
    merge_stats: StreamingMergeStats,
}

#[derive(Debug, Clone, Default)]
pub struct StreamingMergeStats {
    pub total_kmers_read: u64,
    pub unique_kmers: u64,
    pub chunks_created: usize,
    pub read_time: std::time::Duration,
    pub sort_time: std::time::Duration,
    pub merge_time: std::time::Duration,
    pub write_time: std::time::Duration,
}

/// Represents a single item from a merge file
#[derive(Debug, Clone)]
pub struct MergeItem {
    kmer: u128,
    count: u32,
    file_index: usize,
}

impl PartialEq for MergeItem {
    fn eq(&self, other: &Self) -> bool {
        self.kmer == other.kmer
    }
}

impl Eq for MergeItem {}

impl PartialOrd for MergeItem {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        other.kmer.partial_cmp(&self.kmer)
    }
}

impl Ord for MergeItem {
    fn cmp(&self, other: &Self) -> Ordering {
        other.kmer.cmp(&self.kmer)
    }
}

impl ExternalMerger {
    pub fn new(chunk_size: usize, temp_dir: PathBuf) -> Self {
        Self {
            chunk_size,
            temp_dir,
            temp_files: Vec::new(),
            merge_stats: StreamingMergeStats::default(),
        }
    }

    /// Read and sort a single database into sorted chunks
    pub fn sort_database(&mut self, db_path: &Path) -> Result<(), ProcessingError> {
        let start_time = Instant::now();

        let mut temp_manager = TempFileManager::new(self.temp_dir.clone(), "sort");
        let stream_iter = DatabaseStreamIterator::new(db_path, self.chunk_size)?;

        let mut total_read = 0u64;

        for chunk_result in stream_iter {
            let mut chunk = chunk_result?;

            total_read += chunk.len() as u64;

            let sort_start = Instant::now();
            chunk.sort_by_key(|entry| entry.kmer);
            self.merge_stats.sort_time += sort_start.elapsed();

            let (_file_path, mut writer) = temp_manager.create_temp_file()?;

            let write_start = Instant::now();
            for entry in &chunk {
                entry.write_to(&mut writer).map_err(|e| {
                    ProcessingError::io_error(format!("Failed to write chunk: {}", e))
                })?;
            }
            writer
                .flush()
                .map_err(|e| ProcessingError::io_error(format!("Failed to flush chunk: {}", e)))?;
            self.merge_stats.write_time += write_start.elapsed();

            self.merge_stats.chunks_created += 1;
        }

        self.merge_stats.read_time += start_time.elapsed();
        self.merge_stats.total_kmers_read += total_read;

        let files = temp_manager.take_files();
        self.temp_files.extend(files);

        Ok(())
    }

    /// Merge all sorted chunks into a single sorted stream
    pub fn merge_sorted_chunks(&mut self) -> Result<StreamingMergeIterator, ProcessingError> {
        if self.temp_files.is_empty() {
            return Ok(StreamingMergeIterator::empty());
        }

        let start_time = Instant::now();

        let mut file_readers: Vec<BufReader<File>> = Vec::new();
        let mut heap: BinaryHeap<MergeItem> = BinaryHeap::new();

        for (file_index, file_path) in self.temp_files.iter().enumerate() {
            let file = File::open(file_path).map_err(|e| {
                ProcessingError::io_error(format!(
                    "Failed to open chunk file '{}': {}",
                    file_path.display(),
                    e
                ))
            })?;

            let mut reader = BufReader::new(file);
            let first_entry = KmerEntry::read_from(&mut reader);

            if let Ok(entry) = first_entry {
                heap.push(MergeItem {
                    kmer: entry.kmer,
                    count: entry.count,
                    file_index,
                });
            }

            file_readers.push(reader);
        }

        self.merge_stats.merge_time += start_time.elapsed();

        Ok(StreamingMergeIterator::new(
            heap,
            file_readers,
            self.temp_files.clone(),
        ))
    }

    pub fn stats(&self) -> &StreamingMergeStats {
        &self.merge_stats
    }
}

/// Streaming iterator that merges sorted chunks
pub struct StreamingMergeIterator {
    heap: BinaryHeap<MergeItem>,
    file_readers: Vec<BufReader<File>>,
    _temp_files: Vec<PathBuf>,
    current_kmer: Option<u128>,
    current_count: u32,
}

impl StreamingMergeIterator {
    pub fn new(
        heap: BinaryHeap<MergeItem>,
        file_readers: Vec<BufReader<File>>,
        temp_files: Vec<PathBuf>,
    ) -> Self {
        Self {
            heap,
            file_readers,
            _temp_files: temp_files,
            current_kmer: None,
            current_count: 0,
        }
    }

    pub fn empty() -> Self {
        Self {
            heap: BinaryHeap::new(),
            file_readers: Vec::new(),
            _temp_files: Vec::new(),
            current_kmer: None,
            current_count: 0,
        }
    }
}

impl Iterator for StreamingMergeIterator {
    type Item = Result<(u128, u32), ProcessingError>;

    fn next(&mut self) -> Option<Self::Item> {
        while let Some(mut merge_item) = self.heap.pop() {
            match &self.current_kmer {
                None => {
                    self.current_kmer = Some(merge_item.kmer);
                    self.current_count = merge_item.count;
                }
                Some(current) if *current == merge_item.kmer => {
                    self.current_count = match self.current_count.checked_add(merge_item.count) {
                        Some(sum) => sum,
                        None => u32::MAX,
                    };
                }
                Some(_) => {
                    let result = (self.current_kmer.unwrap(), self.current_count);
                    self.current_kmer = Some(merge_item.kmer);
                    self.current_count = merge_item.count;
                    return Some(Ok(result));
                }
            }

            let reader = &mut self.file_readers[merge_item.file_index];
            if let Ok(next_entry) = KmerEntry::read_from(reader) {
                merge_item.kmer = next_entry.kmer;
                merge_item.count = next_entry.count;
                self.heap.push(merge_item);
            }
        }

        if let Some(kmer) = self.current_kmer.take() {
            return Some(Ok((kmer, self.current_count)));
        }

        None
    }
}

impl Drop for StreamingMergeIterator {
    fn drop(&mut self) {
        // Close all file readers first
        self.file_readers.clear();

        // Clean up temporary files
        for temp_file in &self._temp_files {
            if let Err(e) = std::fs::remove_file(temp_file) {
                eprintln!(
                    "Warning: Failed to remove temporary file {}: {}",
                    temp_file.display(),
                    e
                );
            }
        }
    }
}

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

    #[test]
    fn test_database_stream_iterator() {
        let temp_dir = tempfile::tempdir().unwrap();
        let db_path = temp_dir.path().join("test.rkdb");

        let test_entries = vec![
            KmerEntry::new(0x1234, 10),
            KmerEntry::new(0x5678, 20),
            KmerEntry::new(0x9ABC, 30),
        ];

        let db = crate::database::format::RKDatabase::from_kmer_pairs(
            test_entries.iter().map(|e| (e.kmer, e.count)).collect(),
            31,
            false,
            false,
        )
        .unwrap();
        db.to_file_path(&db_path).unwrap();

        let mut iter = DatabaseStreamIterator::new(&db_path, 2).unwrap();
        let chunk1 = iter.next().unwrap().unwrap();
        assert_eq!(chunk1.len(), 2);
        let chunk2 = iter.next().unwrap().unwrap();
        assert_eq!(chunk2.len(), 1);
        assert!(iter.next().is_none());
    }

    #[test]
    fn test_temp_file_manager() {
        let temp_dir = tempfile::tempdir().unwrap();
        let mut manager = TempFileManager::new(temp_dir.path().to_path_buf(), "test");

        let (path, _writer) = manager.create_temp_file().unwrap();
        assert!(path.exists());
        assert_eq!(manager.files.len(), 1);

        let (_path2, _writer2) = manager.create_temp_file().unwrap();
        assert_eq!(manager.files.len(), 2);

        manager.cleanup();
        assert!(!path.exists());
    }

    #[test]
    fn test_external_merge() {
        let temp_dir = tempfile::tempdir().unwrap();
        let db1_path = temp_dir.path().join("db1.rkdb");

        let entries1 = vec![
            KmerEntry::new(0x0010, 10),
            KmerEntry::new(0x0020, 20),
            KmerEntry::new(0x0030, 30),
        ];

        let db1 = crate::database::format::RKDatabase::from_kmer_pairs(
            entries1.iter().map(|e| (e.kmer, e.count)).collect(),
            31,
            false,
            false,
        )
        .unwrap();
        db1.to_file_path(&db1_path).unwrap();

        let mut merger = ExternalMerger::new(2, temp_dir.path().to_path_buf());
        merger.sort_database(&db1_path).unwrap();

        let mut merge_iter = merger.merge_sorted_chunks().unwrap();

        let result1 = merge_iter.next().unwrap().unwrap();
        assert_eq!(result1, (0x0010, 10));

        let result2 = merge_iter.next().unwrap().unwrap();
        assert_eq!(result2, (0x0020, 20));

        let result3 = merge_iter.next().unwrap().unwrap();
        assert_eq!(result3, (0x0030, 30));

        assert!(merge_iter.next().is_none());
    }
}