bytehaul 0.1.6

Async HTTP download library with resume, multi-connection, rate limiting, and checksum verification
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
use std::collections::BTreeMap;

use bytes::{Bytes, BytesMut};

/// A write-back cache that aggregates small data chunks by offset before flushing.
///
/// Data is stored per piece, and within each piece by contiguous byte ranges.
/// Adjacent or overlapping writes are merged to reduce the number of disk I/O operations.
#[derive(Default)]
pub struct WriteBackCache {
    /// Cached entries keyed by piece_id.
    pieces: BTreeMap<usize, PieceCacheEntry>,
    /// Total bytes currently held in the cache.
    total_bytes: usize,
}

/// Cached data for a single piece, stored as a set of contiguous byte ranges.
struct PieceCacheEntry {
    /// Sorted, non-overlapping ranges: (offset, data).
    ranges: Vec<(u64, BytesMut)>,
    /// Total resident bytes currently held for this piece.
    resident_bytes: usize,
}

/// A contiguous block of data ready to be flushed to disk.
pub struct FlushBlock {
    /// File offset where this block should be written.
    pub offset: u64,
    /// The data payload.
    pub data: Bytes,
}

impl WriteBackCache {
    pub fn new() -> Self {
        Self::default()
    }

    /// Total bytes currently buffered in the cache.
    pub fn total_bytes(&self) -> usize {
        self.total_bytes
    }

    /// Insert data for a specific piece at the given file offset.
    pub fn insert(&mut self, piece_id: usize, offset: u64, data: Bytes) {
        let len = data.len();
        if len == 0 {
            return;
        }
        let entry = self
            .pieces
            .entry(piece_id)
            .or_insert_with(|| PieceCacheEntry {
                ranges: Vec::new(),
                resident_bytes: 0,
            });
        self.total_bytes += entry.merge(offset, data);
    }

    /// Drain all cached data for the given piece, returning flush blocks sorted by offset.
    pub fn drain_piece(&mut self, piece_id: usize) -> Vec<FlushBlock> {
        match self.pieces.remove(&piece_id) {
            Some(entry) => {
                self.total_bytes = self.total_bytes.saturating_sub(entry.resident_bytes);
                let blocks: Vec<FlushBlock> = entry
                    .ranges
                    .into_iter()
                    .map(|(offset, data)| {
                        FlushBlock {
                            offset,
                            data: data.freeze(),
                        }
                    })
                    .collect();
                blocks
            }
            None => Vec::new(),
        }
    }

    /// Drain ALL cached data across all pieces, returning flush blocks sorted by offset.
    pub fn drain_all(&mut self) -> Vec<FlushBlock> {
        let mut blocks = Vec::new();
        let pieces = std::mem::take(&mut self.pieces);
        for (_piece_id, entry) in pieces {
            self.total_bytes = self.total_bytes.saturating_sub(entry.resident_bytes);
            for (offset, data) in entry.ranges {
                blocks.push(FlushBlock {
                    offset,
                    data: data.freeze(),
                });
            }
        }
        blocks
    }
}

impl PieceCacheEntry {
    /// Merge new data at `offset` into the existing ranges, coalescing adjacent/overlapping ranges.
    fn merge(&mut self, offset: u64, data: Bytes) -> usize {
        if let Some(delta) = self.try_append(offset, &data) {
            self.resident_bytes += delta;
            return delta;
        }

        let before = self.resident_bytes;
        let end = offset + data.len() as u64;

        // Find the insertion point
        let pos = self.ranges.partition_point(|(o, _)| *o < offset);

        // Check if we can extend the previous range
        if pos > 0 {
            let prev = &self.ranges[pos - 1];
            let prev_end = prev.0 + prev.1.len() as u64;
            if prev_end >= offset {
                // The new data overlaps or is contiguous with the previous range.
                // Extend the previous range.
                let idx = pos - 1;
                if end > prev_end {
                    let skip = (prev_end - offset) as usize;
                    if skip < data.len() {
                        self.ranges[idx].1.extend_from_slice(&data[skip..]);
                    }
                }
                // Now coalesce with subsequent ranges if they overlap
                self.coalesce_from(idx);
                self.recompute_resident_bytes();
                return self.resident_bytes - before;
            }
        }

        // Check if we overlap with the next range
        if pos < self.ranges.len() {
            let next = &self.ranges[pos];
            if end >= next.0 {
                // Overlaps with next range — insert and coalesce
                let mut buf = BytesMut::with_capacity(data.len());
                buf.extend_from_slice(&data);
                self.ranges.insert(pos, (offset, buf));
                self.coalesce_from(pos);
                self.recompute_resident_bytes();
                return self.resident_bytes - before;
            }
        }

        // No overlap — insert a new range
        let mut buf = BytesMut::with_capacity(data.len());
        buf.extend_from_slice(&data);
        self.ranges.insert(pos, (offset, buf));
        self.resident_bytes = before + data.len();
        data.len()
    }

    fn try_append(&mut self, offset: u64, data: &Bytes) -> Option<usize> {
        let (last_offset, last_data) = self.ranges.last_mut()?;
        let last_end = *last_offset + last_data.len() as u64;
        if offset < *last_offset || offset > last_end {
            return None;
        }

        let overlap = last_end.saturating_sub(offset) as usize;
        if overlap >= data.len() {
            return Some(0);
        }

        last_data.extend_from_slice(&data[overlap..]);
        Some(data.len() - overlap)
    }

    /// Starting from index `idx`, merge all subsequent ranges that are now contiguous/overlapping.
    fn coalesce_from(&mut self, idx: usize) {
        while idx + 1 < self.ranges.len() {
            let cur_end = self.ranges[idx].0 + self.ranges[idx].1.len() as u64;
            let next_start = self.ranges[idx + 1].0;
            if cur_end >= next_start {
                let next = self.ranges.remove(idx + 1);
                let next_end = next.0 + next.1.len() as u64;
                if next_end > cur_end {
                    let skip = (cur_end - next.0) as usize;
                    if skip < next.1.len() {
                        self.ranges[idx].1.extend_from_slice(&next.1[skip..]);
                    }
                }
            } else {
                break;
            }
        }
    }

    fn recompute_resident_bytes(&mut self) {
        self.resident_bytes = self.ranges.iter().map(|(_, data)| data.len()).sum();
    }
}

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

    #[test]
    fn test_basic_insert_and_drain() {
        let mut cache = WriteBackCache::new();
        cache.insert(0, 0, Bytes::from(vec![1u8; 100]));
        cache.insert(0, 100, Bytes::from(vec![2u8; 100]));
        assert_eq!(cache.total_bytes(), 200);

        let blocks = cache.drain_piece(0);
        // Should merge into one contiguous block
        assert_eq!(blocks.len(), 1);
        assert_eq!(blocks[0].offset, 0);
        assert_eq!(blocks[0].data.len(), 200);
        assert_eq!(cache.total_bytes(), 0);
    }

    #[test]
    fn test_non_contiguous_ranges() {
        let mut cache = WriteBackCache::new();
        cache.insert(0, 0, Bytes::from(vec![1u8; 100]));
        cache.insert(0, 200, Bytes::from(vec![2u8; 100]));
        assert_eq!(cache.total_bytes(), 200);

        let blocks = cache.drain_piece(0);
        assert_eq!(blocks.len(), 2);
        assert_eq!(blocks[0].offset, 0);
        assert_eq!(blocks[0].data.len(), 100);
        assert_eq!(blocks[1].offset, 200);
        assert_eq!(blocks[1].data.len(), 100);
    }

    #[test]
    fn test_overlapping_merge() {
        let mut cache = WriteBackCache::new();
        cache.insert(0, 0, Bytes::from(vec![1u8; 100]));
        cache.insert(0, 50, Bytes::from(vec![2u8; 100]));
        assert_eq!(cache.total_bytes(), 150);

        let blocks = cache.drain_piece(0);
        assert_eq!(blocks.len(), 1);
        assert_eq!(blocks[0].offset, 0);
        assert_eq!(blocks[0].data.len(), 150);
    }

    #[test]
    fn test_drain_all() {
        let mut cache = WriteBackCache::new();
        cache.insert(0, 0, Bytes::from(vec![1u8; 100]));
        cache.insert(1, 1000, Bytes::from(vec![2u8; 100]));

        let blocks = cache.drain_all();
        assert_eq!(blocks.len(), 2);
        assert_eq!(blocks[0].offset, 0);
        assert_eq!(blocks[1].offset, 1000);
        assert_eq!(cache.total_bytes(), 0);
    }

    #[test]
    fn test_append_fast_path_tracks_resident_bytes() {
        let mut cache = WriteBackCache::new();
        cache.insert(0, 0, Bytes::from(vec![1u8; 100]));
        cache.insert(0, 100, Bytes::from(vec![2u8; 50]));
        cache.insert(0, 125, Bytes::from(vec![3u8; 50]));

        assert_eq!(cache.total_bytes(), 175);
        let blocks = cache.drain_piece(0);
        assert_eq!(blocks.len(), 1);
        assert_eq!(blocks[0].data.len(), 175);
    }

    #[test]
    fn test_multiple_pieces() {
        let mut cache = WriteBackCache::new();
        cache.insert(0, 0, Bytes::from(vec![1u8; 100]));
        cache.insert(1, 1000, Bytes::from(vec![2u8; 200]));
        cache.insert(0, 100, Bytes::from(vec![3u8; 50]));

        assert_eq!(cache.total_bytes(), 350);

        let blocks = cache.drain_piece(0);
        assert_eq!(blocks.len(), 1);
        assert_eq!(blocks[0].data.len(), 150);

        let blocks = cache.drain_piece(1);
        assert_eq!(blocks.len(), 1);
        assert_eq!(blocks[0].data.len(), 200);
    }

    #[test]
    fn test_drain_piece_empty() {
        let mut cache = WriteBackCache::new();
        let blocks = cache.drain_piece(99);
        assert!(blocks.is_empty());
    }

    #[test]
    fn test_insert_empty_data() {
        let mut cache = WriteBackCache::new();
        cache.insert(0, 0, Bytes::new());
        assert_eq!(cache.total_bytes(), 0);
        let blocks = cache.drain_piece(0);
        assert!(blocks.is_empty());
    }

    #[test]
    fn test_overlap_with_next_range() {
        let mut cache = WriteBackCache::new();
        // Insert a range at offset 100
        cache.insert(0, 100, Bytes::from(vec![2u8; 50]));
        // Insert a range at offset 0 that overlaps with the one at 100
        cache.insert(0, 0, Bytes::from(vec![1u8; 120]));

        let blocks = cache.drain_piece(0);
        assert_eq!(blocks.len(), 1);
        assert_eq!(blocks[0].offset, 0);
        assert_eq!(blocks[0].data.len(), 150); // 0..120 merged with 100..150
    }

    #[test]
    fn test_coalesce_multiple_ranges() {
        let mut cache = WriteBackCache::new();
        // Create three separate ranges
        cache.insert(0, 0, Bytes::from(vec![1u8; 50]));
        cache.insert(0, 100, Bytes::from(vec![2u8; 50]));
        cache.insert(0, 200, Bytes::from(vec![3u8; 50]));
        // Now insert something that bridges all three
        cache.insert(0, 40, Bytes::from(vec![4u8; 170]));

        let blocks = cache.drain_piece(0);
        assert_eq!(blocks.len(), 1);
        assert_eq!(blocks[0].offset, 0);
        assert_eq!(blocks[0].data.len(), 250);
    }

    #[test]
    fn test_insert_contiguous_extends_previous() {
        let mut cache = WriteBackCache::new();
        cache.insert(0, 0, Bytes::from(vec![1u8; 100]));
        // Exactly contiguous
        cache.insert(0, 100, Bytes::from(vec![2u8; 100]));
        let blocks = cache.drain_piece(0);
        assert_eq!(blocks.len(), 1);
        assert_eq!(blocks[0].data.len(), 200);
    }

    #[test]
    fn test_fully_overlapping_insert() {
        let mut cache = WriteBackCache::new();
        cache.insert(0, 0, Bytes::from(vec![1u8; 200]));
        // Insert completely within existing range
        cache.insert(0, 50, Bytes::from(vec![2u8; 50]));
        let blocks = cache.drain_piece(0);
        assert_eq!(blocks.len(), 1);
        assert_eq!(blocks[0].offset, 0);
        assert_eq!(blocks[0].data.len(), 200);
    }

    #[test]
    fn test_drain_all_sorts_by_offset() {
        let mut cache = WriteBackCache::new();
        cache.insert(5, 5000, Bytes::from(vec![1u8; 10]));
        cache.insert(0, 0, Bytes::from(vec![2u8; 10]));
        cache.insert(3, 3000, Bytes::from(vec![3u8; 10]));

        let blocks = cache.drain_all();
        assert_eq!(blocks.len(), 3);
        assert_eq!(blocks[0].offset, 0);
        assert_eq!(blocks[1].offset, 3000);
        assert_eq!(blocks[2].offset, 5000);
        assert_eq!(cache.total_bytes(), 0);
    }

    #[test]
    fn test_coalesce_stops_at_gap() {
        let mut cache = WriteBackCache::new();
        // Three ranges with a gap between second and third
        cache.insert(0, 0, Bytes::from(vec![1u8; 50]));
        cache.insert(0, 50, Bytes::from(vec![2u8; 50]));
        cache.insert(0, 200, Bytes::from(vec![3u8; 50]));

        let blocks = cache.drain_piece(0);
        // First two should merge, third should be separate
        assert_eq!(blocks.len(), 2);
        assert_eq!(blocks[0].offset, 0);
        assert_eq!(blocks[0].data.len(), 100);
        assert_eq!(blocks[1].offset, 200);
        assert_eq!(blocks[1].data.len(), 50);
    }

    #[test]
    fn test_coalesce_breaks_when_next_range_is_still_gapped() {
        let mut cache = WriteBackCache::new();
        cache.insert(0, 0, Bytes::from(vec![1u8; 50]));
        cache.insert(0, 100, Bytes::from(vec![2u8; 50]));
        cache.insert(0, 200, Bytes::from(vec![3u8; 50]));

        // This extends the first range, but still leaves a gap before the second.
        cache.insert(0, 40, Bytes::from(vec![4u8; 40]));

        let blocks = cache.drain_piece(0);
        assert_eq!(blocks.len(), 3);
        assert_eq!(blocks[0].offset, 0);
        assert_eq!(blocks[0].data.len(), 80);
        assert_eq!(blocks[1].offset, 100);
        assert_eq!(blocks[2].offset, 200);
    }
}