umadb-core 0.1.21

Core event store implementation for UmaDB
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
use crate::common::PageID;
use memmap2::{Mmap, MmapOptions};
use std::collections::HashMap;
use std::fs::{File, OpenOptions};
use std::io;
use std::io::{BufWriter, Seek, SeekFrom, Write};
use std::os::fd::{AsRawFd, RawFd};
use std::path::Path;
use std::sync::{Arc, Mutex, RwLock};
use umadb_dcb::{DCBError, DCBResult};
// use memmap2::{Advice, Mmap, MmapOptions};

// Pager for file I/O
pub struct Pager {
    pub reader: Arc<File>,
    // pub writer: Arc<File>,
    pub writer: Mutex<BufWriter<File>>,
    pub writer_raw_fd: RawFd,
    pub page_size: usize,
    pub is_file_new: bool,
    // Number of logical database pages contained in a single mmap window.
    mmap_pages_per_map: usize,
    // Cache of memory maps, keyed by map identifier (floor(page_id / mmap_pages_per_map)).
    mmaps: RwLock<HashMap<u64, Arc<Mmap>>>,
}

// Implementation for Pager
impl Pager {
    pub fn new(path: &Path, page_size: usize) -> io::Result<Self> {
        let is_file_new = !path.exists();

        let reader_file = if is_file_new {
            OpenOptions::new()
                .read(true)
                .write(true)
                .create(true)
                .truncate(false)
                .open(path)?
        } else {
            OpenOptions::new().read(true).write(true).open(path)?
        };

        let writer_file = if is_file_new {
            OpenOptions::new()
                .read(true)
                .write(true)
                .create(true)
                .truncate(false)
                .open(path)?
        } else {
            OpenOptions::new().read(true).write(true).open(path)?
        };
        let writer_raw_fd = writer_file.as_raw_fd();

        // Compute pages per mmap so that:
        // - Each mmap offset is aligned to OS page size (and implicitly DB page size), and
        // - Each mapping window is at least 10 MiB.
        let os_ps = Self::os_page_size();
        let g = Self::gcd(os_ps, page_size);
        // Alignment factor: number of DB pages per window must be a multiple of this to keep
        // mmap offsets aligned to OS page boundaries.
        let align_pages = usize::max(1, os_ps / g);
        // Minimum window size in bytes: 10 MiB
        let min_window_bytes: usize = 10 * 1024 * 1024;
        // Minimum number of DB pages to reach at least the min window size
        let min_pages = min_window_bytes.div_ceil(page_size);
        // Choose smallest multiple of align_pages that is >= min_pages
        let k = if min_pages == 0 {
            1
        } else {
            min_pages.div_ceil(align_pages)
        };
        let mmap_pages_per_map = align_pages * usize::max(1, k);

        Ok(Self {
            reader: Arc::new(reader_file),
            writer: Mutex::new(BufWriter::with_capacity(100 * page_size, writer_file)),
            writer_raw_fd,
            page_size,
            is_file_new,
            mmap_pages_per_map,
            mmaps: RwLock::new(HashMap::new()),
        })
    }

    fn gcd(mut a: usize, mut b: usize) -> usize {
        while b != 0 {
            let t = b;
            b = a % t;
            a = t;
        }
        a
    }

    #[cfg(unix)]
    fn os_page_size() -> usize {
        // Safe: sysconf is thread-safe and returns a constant for page size
        unsafe {
            let sz = libc::sysconf(libc::_SC_PAGESIZE);
            if sz <= 0 {
                4096usize // sensible default
            } else {
                sz as usize
            }
        }
    }

    pub fn read_page(&self, page_id: PageID) -> io::Result<Vec<u8>> {
        use std::os::unix::fs::FileExt;
        let file = self.reader.clone();
        let offset = page_id.0 * (self.page_size as u64);
        let mut page = vec![0u8; self.page_size];
        let bytes_read = file.read_at(&mut page, offset)?;
        if bytes_read < self.page_size {
            return Err(io::Error::new(
                io::ErrorKind::UnexpectedEof,
                format!("Page {page_id:?} not found"),
            ));
        }
        Ok(page)
    }

    // pub fn read_page_mmap(&self, page_id: PageID) -> io::Result<Vec<u8>> {
    //     // Precompute addressing values
    //     let page_size_u64 = self.page_size as u64;
    //     let offset = page_id.0 * page_size_u64;
    //     let pages_per_map = self.mmap_pages_per_map as u64;
    //     let map_id = page_id.0 / pages_per_map;
    //     let map_offset = map_id * pages_per_map * page_size_u64;
    //     let within = (offset - map_offset) as usize;
    //
    //     // Fast path: if mapping exists, do not obtain file lock; take Arc clone and release map lock
    //     if let Some(mmap_arc) = {
    //         let maps = self.mmaps.lock().unwrap();
    //         maps.get(&map_id).cloned()
    //     } {
    //         let start = within;
    //         let stop = start + self.page_size;
    //         if stop > mmap_arc.len() {
    //             return Err(io::Error::new(
    //                 io::ErrorKind::UnexpectedEof,
    //                 format!("Page {page_id:?} not found"),
    //             ));
    //         }
    //         return Ok(mmap_arc[start..stop].to_vec());
    //     }
    //
    //     // Slow path: need to create the mapping with double-checked locking
    //     let file = self.reader.lock().unwrap();
    //     let file_len = file.metadata()?.len();
    //
    //     // Re-check if mapping appeared while we acquired the file lock
    //     if let Some(mmap_arc) = {
    //         let maps = self.mmaps.lock().unwrap();
    //         maps.get(&map_id).cloned()
    //     } {
    //         let start = within;
    //         let stop = start + self.page_size;
    //         if stop > mmap_arc.len() {
    //             return Err(io::Error::new(
    //                 io::ErrorKind::UnexpectedEof,
    //                 format!("Page {page_id:?} not found"),
    //             ));
    //         }
    //         return Ok(mmap_arc[start..stop].to_vec());
    //     }
    //
    //     // Calculate standard mapping window length (does not depend on current file length)
    //     let max_len = pages_per_map * page_size_u64;
    //
    //     // Before mapping, ensure the requested page is within the current file length.
    //     let page_end = offset + page_size_u64;
    //     if page_end > file_len {
    //         return Err(io::Error::new(
    //             io::ErrorKind::UnexpectedEof,
    //             format!("Page {page_id:?} not found"),
    //         ));
    //     }
    //
    //     // Ensure the underlying file is large enough to permit a full standard-length mapping.
    //     let required_len = map_offset + max_len;
    //     if file_len < required_len {
    //         file.set_len(required_len)?;
    //     }
    //
    //     // Create the mmap and insert it, but guard with a double-check
    //     let mmap_new = unsafe {
    //         MmapOptions::new()
    //             .offset(map_offset)
    //             .len(max_len as usize)
    //             .map(&*file)?
    //     };
    //     let mmap_arc = {
    //         let mut maps = self.mmaps.lock().unwrap();
    //         // Another thread could have inserted meanwhile
    //         if let Some(existing) = maps.get(&map_id) {
    //             existing.clone()
    //         } else {
    //             let arc = Arc::new(mmap_new);
    //             maps.insert(map_id, arc.clone());
    //             // println!(
    //             //     "Created new mmap: map_id={} offset={} len={}",
    //             //     map_id, map_offset, max_len
    //             // );
    //             arc
    //         }
    //     };
    //
    //     // Now copy the requested page
    //     let start = within;
    //     let stop = start + self.page_size;
    //     if stop > mmap_arc.len() {
    //         return Err(io::Error::new(
    //             io::ErrorKind::UnexpectedEof,
    //             format!("Page {page_id:?} not found"),
    //         ));
    //     }
    //     Ok(mmap_arc[start..stop].to_vec())
    // }

    pub fn read_page_mmap_slice(&self, page_id: PageID) -> io::Result<MappedPage> {
        // Precompute addressing values
        let page_size_u64 = self.page_size as u64;
        let offset = page_id.0 * page_size_u64;
        let pages_per_map = self.mmap_pages_per_map as u64;
        let map_id = page_id.0 / pages_per_map;
        let map_offset = map_id * pages_per_map * page_size_u64;
        let within = (offset - map_offset) as usize;

        // Fast path: if mapping exists, do not obtain file lock; take Arc clone and release map lock
        if let Some(mmap_arc) = {
            let maps = self.mmaps.read().unwrap();
            maps.get(&map_id).cloned()
        } {
            let start = within;
            let stop = start + self.page_size;
            if stop > mmap_arc.len() {
                return Err(io::Error::new(
                    io::ErrorKind::UnexpectedEof,
                    format!("Page {page_id:?} not found"),
                ));
            }
            return Ok(MappedPage {
                mmap: mmap_arc,
                start,
                len: self.page_size,
            });
        }

        // Slow path: need to create the mapping with double-checked locking
        let file = self.reader.clone();
        let file_len = file.metadata()?.len();

        // Re-check if mapping appeared while we acquired the file lock
        if let Some(mmap_arc) = {
            let maps = self.mmaps.read().unwrap();
            maps.get(&map_id).cloned()
        } {
            let start = within;
            let stop = start + self.page_size;
            if stop > mmap_arc.len() {
                return Err(io::Error::new(
                    io::ErrorKind::UnexpectedEof,
                    format!("Page {page_id:?} not found"),
                ));
            }
            return Ok(MappedPage {
                mmap: mmap_arc,
                start,
                len: self.page_size,
            });
        }

        // Calculate standard mapping window length (does not depend on current file length)
        let max_len = pages_per_map * page_size_u64;

        // Before mapping, ensure the requested page is within the current file length.
        let page_end = offset + page_size_u64;
        if page_end > file_len {
            return Err(io::Error::new(
                io::ErrorKind::UnexpectedEof,
                format!("Page {page_id:?} not found"),
            ));
        }

        // Ensure the underlying file is large enough to permit a full standard-length mapping.
        let required_len = map_offset + max_len;
        if file_len < required_len {
            file.set_len(required_len)?;
        }

        // Create the mmap and insert it, but guard with a double-check
        let mmap_new = unsafe {
            MmapOptions::new()
                .offset(map_offset)
                .len(max_len as usize)
                .map(&*file)?
        };
        // mmap_new.advise(Advice::Random)?;
        // mmap_new.advise(Advice::WillNeed)?;
        let mmap_arc = {
            let mut maps = self.mmaps.write().unwrap();
            // Another thread could have inserted meanwhile
            if let Some(existing) = maps.get(&map_id) {
                existing.clone()
            } else {
                let arc = Arc::new(mmap_new);
                maps.insert(map_id, arc.clone());
                // println!(
                //     "Created new mmap: map_id={} offset={} len={}",
                //     map_id, map_offset, max_len
                // );
                arc
            }
        };

        // Now form the mapped page view
        let start = within;
        let stop = start + self.page_size;
        if stop > mmap_arc.len() {
            return Err(io::Error::new(
                io::ErrorKind::UnexpectedEof,
                format!("Page {page_id:?} not found"),
            ));
        }
        Ok(MappedPage {
            mmap: mmap_arc,
            start,
            len: self.page_size,
        })
    }

    pub fn write_page(&self, page_id: PageID, page: &[u8]) -> DCBResult<()> {
        let mut file = self.writer.lock().unwrap();
        if page.len() != self.page_size {
            return Err(DCBError::InternalError(format!(
                "Page size mismatch: page_id={:?} size={} > PAGE_SIZE={}",
                page_id,
                page.len(),
                self.page_size
            )));
        }

        // Seek to the correct position
        file.seek(SeekFrom::Start(page_id.0 * (self.page_size as u64)))?;

        // Write the page data
        file.write_all(page)?;

        Ok(())
    }

    pub fn flush(&self) -> io::Result<()> {
        let mut file = self.writer.lock().unwrap();
        file.flush()?;
        // fsync equivalent in Rust
        #[cfg(unix)]
        unsafe {
            let result = libc::fsync(self.writer_raw_fd);
            if result != 0 {
                return Err(io::Error::last_os_error());
            }
        }
        Ok(())
    }

    #[cfg(test)]
    pub fn debug_mmap_count(&self) -> usize {
        self.mmaps.read().unwrap().len()
    }

    #[cfg(test)]
    pub fn debug_pages_per_mmap(&self) -> usize {
        self.mmap_pages_per_map
    }
}

// A zero-copy view over a page backed by a memory map. Holds an Arc to keep the mapping alive.
#[derive(Debug)]
pub struct MappedPage {
    mmap: Arc<Mmap>,
    start: usize,
    len: usize,
}

impl MappedPage {
    pub fn as_slice(&self) -> &[u8] {
        &self.mmap[self.start..self.start + self.len]
    }
}

#[cfg(test)]
mod tests {
    use super::Pager;
    use crate::common::PageID;
    use std::path::PathBuf;
    use tempfile::tempdir;
    use umadb_dcb::DCBError;

    fn temp_file_path(name: &str) -> PathBuf {
        let dir = tempdir().expect("tempdir");
        dir.keep().join(name)
    }

    #[test]
    fn test_write_page_size_mismatch_error() {
        let page_size = 1024usize;
        let path = temp_file_path("pager_mmap_test.db");
        let pager = Pager::new(&path, page_size).expect("pager new");

        let data1 = vec![1u8; 100];

        let err = pager.write_page(PageID(0), &data1);
        assert!(matches!(err, Err(DCBError::InternalError(_))));
    }

    #[test]
    fn mmap_read_matches_normal_read() {
        let page_size = 1024usize;
        let path = temp_file_path("pager_mmap_test.db");
        let pager = Pager::new(&path, page_size).expect("pager new");

        let data1 = vec![1u8; page_size];
        let data2 = (0..page_size).map(|i| (i % 256) as u8).collect::<Vec<_>>();

        pager.write_page(PageID(0), &data1).expect("write page 0");
        pager.write_page(PageID(1), &data2).expect("write page 1");
        pager.flush().expect("flush");

        let r0 = pager.read_page(PageID(0)).expect("read0");
        let r0m = pager.read_page_mmap_slice(PageID(0)).expect("read0m");
        assert_eq!(
            r0,
            r0m.as_slice(),
            "mmap read should match std read for page 0"
        );

        let r1 = pager.read_page(PageID(1)).expect("read1");
        let r1m = pager.read_page_mmap_slice(PageID(1)).expect("read1m");
        assert_eq!(
            r1,
            r1m.as_slice(),
            "mmap read should match std read for page 1"
        );
        assert_eq!(&r1[..], &data2[..]);
    }

    #[test]
    fn mmap_read_out_of_bounds() {
        let page_size = 512usize;
        let path = temp_file_path("pager_mmap_oob.db");
        let pager = Pager::new(&path, page_size).expect("pager new");

        let buf = vec![0u8; page_size];
        pager.write_page(PageID(0), &buf).expect("write p0");
        pager.flush().expect("flush");

        let err = pager.read_page_mmap_slice(PageID(1)).unwrap_err();
        assert_eq!(err.kind(), std::io::ErrorKind::UnexpectedEof);
    }

    #[test]
    fn mmap_reuse_within_same_map() {
        // Try a few page sizes to ensure we get at least 2 pages per mmap window
        let candidates = [512usize, 1024, 2048, 4096, 8192];
        let mut pager_opt = None;
        for ps in candidates {
            let path = temp_file_path("pager_mmap_reuse.db");
            let pager = Pager::new(&path, ps).expect("pager new");
            if pager.debug_pages_per_mmap() >= 2 {
                pager_opt = Some((pager, ps));
                break;
            }
        }
        let (pager, page_size) = pager_opt.expect("could not find suitable page size for test");

        // Write two pages
        pager
            .write_page(PageID(0), &vec![1u8; page_size])
            .expect("write p0");
        pager
            .write_page(PageID(1), &vec![2u8; page_size])
            .expect("write p1");
        pager.flush().expect("flush");

        // Read both pages via mmap
        let _ = pager.read_page_mmap_slice(PageID(0)).expect("read0m");
        assert_eq!(pager.debug_mmap_count(), 1, "first mmap created");
        let _ = pager.read_page_mmap_slice(PageID(1)).expect("read1m");
        assert_eq!(
            pager.debug_mmap_count(),
            1,
            "should reuse same mmap for pages in same window"
        );
    }

    #[test]
    fn mmap_creates_new_on_boundary() {
        // Ensure pages_per_mmap is available and >= 2 by selecting suitable page size
        let candidates = [512usize, 1024, 2048, 4096, 8192];
        let mut pager_opt = None;
        for ps in candidates {
            let path = temp_file_path("pager_mmap_boundary.db");
            let pager = Pager::new(&path, ps).expect("pager new");
            if pager.debug_pages_per_mmap() >= 1 {
                pager_opt = Some((pager, ps));
                break;
            }
        }
        let (pager, page_size) = pager_opt.expect("failed to create pager");
        let ppm = pager.debug_pages_per_mmap();

        // Write enough pages to cover two windows
        for p in 0..(ppm as u64 + 1) {
            let fill = if (p % 2) == 0 { 0xAA } else { 0x55 };
            pager
                .write_page(PageID(p), &vec![fill; page_size])
                .expect("write page");
        }
        pager.flush().expect("flush");

        // First read creates first mmap
        let _ = pager
            .read_page_mmap_slice(PageID(0))
            .expect("read first window");
        assert_eq!(pager.debug_mmap_count(), 1);
        // Reading the first page in the next window should create a second mmap
        let _ = pager
            .read_page_mmap_slice(PageID(ppm as u64))
            .expect("read second window");
        assert_eq!(pager.debug_mmap_count(), 2);
    }
}