sanakirja/environment/muttxn.rs
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
use super::*;
use crate::L64;
use sanakirja_core::{btree, CowPage, MutPage};
use std::borrow::Borrow;
impl<E: Borrow<Env>, T> std::fmt::Debug for MutTxn<E, T> {
fn fmt(&self, fmt: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(fmt, "MutTxn {{ }}")
}
}
/// A mutable transaction.
pub struct MutTxn<E: Borrow<Env>, T> {
pub(crate) env: E,
/// The root page of this transaction, which is 1 + the root
/// written on page 0. The root written on page 0 changes at
/// commit time.
pub(crate) root: usize,
parent: Option<T>,
pub(crate) length: u64,
/// Offset to the root of the B tree of free pages.
pub(crate) free: u64,
/// Reference counts use a strange encoding, meant to avoid code
/// bloat: indeed, the list of free pages uses `Db<u64, ()>`, so
/// we're just reusing the same code here, encoding the reference
/// counts in the 12 least significant bits of the keys, and the
/// actual pages in the 52 most significant bits.
pub(crate) rc: Option<btree::Db<L64, ()>>,
/// Offsets of pages that were allocated by this transaction, and
/// have not been freed since. The boolean indicates whether this
/// was allocated with a dirty bit or not.
pub(crate) occupied_owned_pages: Vec<(MutPage, bool)>,
/// Offsets of pages that were allocated by this transaction, and
/// then freed.
pub(crate) free_owned_pages: Vec<u64>,
/// Offsets of old pages freed by this transaction. These were
/// *not* allocated by this transaction.
///
/// Since we can't reuse them in the same transaction, another
/// option would be to put them directly into the table of free
/// pages. However, since calls to `put` may allocate and free
/// pages, this could recurse infinitely, which is why we store
/// them outside of the file.
pub(crate) free_pages: Vec<u64>,
/// Offsets of pages that were free at the start of the
/// transaction, and are still free.
initial_free: Vec<u64>,
/// Offsets of pages that were free at the start of the
/// transaction, but have been allocated since then.
initial_allocated: Vec<u64>,
roots: Vec<u64>,
}
impl<E: Borrow<Env>, T> MutTxn<E, T> {
/// Borrow env
pub fn env_borrow(&self) -> &Env {
self.env.borrow()
}
}
/// When dropping a transaction, we need to unlock the read-write
/// locks internal to this process, and possibly the file locks.
impl<E: Borrow<Env>, T> Drop for MutTxn<E, T> {
fn drop(&mut self) {
if self.parent.is_none() {
let env = self.env.borrow();
unsafe {
env.mut_txn_unlock().unwrap_or(());
env.roots[self.root].rw.unlock_exclusive();
env.unlock(self.root).unwrap_or(())
}
}
}
}
/// Transactions that can be committed. This trait is an abstraction
/// over mutable transactions and their subtransactions.
pub trait Commit {
/// Commit the transaction.
fn commit(self) -> Result<(), Error>;
}
/// The following is very easy, we're just extending all values of the
/// current transaction with values of the subtransaction.
impl<'a, E: Borrow<Env>, T> Commit for MutTxn<E, &'a mut MutTxn<E, T>> {
fn commit(mut self) -> Result<(), Error> {
let parent = self.parent.as_mut().unwrap();
parent.length = self.length;
parent.free = self.free;
parent.rc = self.rc.take();
parent
.occupied_owned_pages
.extend(self.occupied_owned_pages.drain(..));
parent.free_owned_pages.extend(self.free_owned_pages.iter());
parent.free_pages.extend(self.free_pages.iter());
parent.initial_free = std::mem::replace(&mut self.initial_free, Vec::new());
parent.initial_allocated = std::mem::replace(&mut self.initial_allocated, Vec::new());
for (u, v) in self.roots.iter().enumerate() {
if *v != 0 {
parent.roots[u] = *v
}
}
for (n, &r) in self.roots.iter().enumerate() {
if r > 0 {
if parent.roots.get(n).is_none() {
parent.roots.resize(n + 1, 0u64)
}
parent.roots[n] = r
}
}
Ok(())
}
}
impl Env {
#[cfg(feature = "mmap")]
fn mut_txn_lock(&self) -> Result<(), Error> {
self.mut_txn_lock.lock();
if let Some(ref f) = self.file {
f.lock_exclusive()?;
}
Ok(())
}
#[cfg(not(feature = "mmap"))]
fn mut_txn_lock(&self) -> Result<(), Error> {
self.mut_txn_lock.lock();
Ok(())
}
#[cfg(feature = "mmap")]
fn mut_txn_unlock(&self) -> Result<(), Error> {
unsafe {
self.mut_txn_lock.unlock();
}
if let Some(ref f) = self.file {
f.unlock()?
}
Ok(())
}
#[cfg(not(feature = "mmap"))]
fn mut_txn_unlock(&self) -> Result<(), Error> {
unsafe {
self.mut_txn_lock.unlock();
}
Ok(())
}
/// Start a mutable transaction. Mutable transactions that go out
/// of scope are automatically aborted.
pub fn mut_txn_begin<E: Borrow<Self>>(env: E) -> Result<MutTxn<E, ()>, Error> {
unsafe {
let env_ = env.borrow();
// First, take an exclusive file lock on the whole file to
// make sure that no other process is starting a mutable
// transaction at the same time. The worst that can happen
// here is if the other process commits while we're still
// waiting for a lock on the current page, because if that
// happens, this new transaction will erase the
// transaction in the other process.
env_.mut_txn_lock()?;
// Then, we can lock the root page of this transaction.
let maps = env_.mmaps.lock()[0].ptr;
let root = (&*(maps as *const GlobalHeader)).root as usize;
debug!("BEGIN_TXN root = {:?}", root);
env_.roots[root].rw.lock_exclusive();
env_.lock_exclusive(root)?;
// Root of the last MutTxn.
let v0 = (root + env_.roots.len() - 1) % env_.roots.len();
env_.check_crc(v0)?;
// Copy the root page of the last transaction onto this
// one.
let page_ptr = maps.offset((v0 * PAGE_SIZE) as isize);
let next_page_ptr = maps.offset((root * PAGE_SIZE) as isize);
// Iff n_roots == 1 when creating the environment, the two pointers are equal.
if page_ptr != next_page_ptr {
std::ptr::copy_nonoverlapping(page_ptr.add(8), next_page_ptr.add(8), PAGE_SIZE - 8);
}
// Finally, read the header and start the transaction.
let header = GlobalHeader::from_le(&*(next_page_ptr as *const GlobalHeader));
debug!("n_roots = {:?}", header.n_roots);
debug!("initial free_page {:x}", header.free_db);
let mut txn = MutTxn {
env,
root,
parent: None,
rc: if header.rc_db == 0 {
None
} else {
Some(btree::Db::from_page(header.rc_db))
},
length: if header.length == 0 {
(PAGE_SIZE as u64) * (header.n_roots as u64)
} else {
header.length
},
free: header.free_db,
occupied_owned_pages: Vec::with_capacity(100),
free_owned_pages: Vec::new(),
free_pages: Vec::new(),
initial_free: Vec::new(),
initial_allocated: Vec::new(),
roots: Vec::new(),
};
if txn.free > 0 {
let free_db: btree::Db<L64, ()> = btree::Db::from_page(txn.free);
let mut init = Vec::new();
for p in btree::rev_iter(&txn, &free_db, None)? {
let (p, _) = p?;
init.push(p.as_u64());
}
txn.initial_free = init;
}
Ok(txn)
}
}
}
#[cfg(feature = "crc32")]
unsafe fn clear_dirty(p: &mut MutPage) {
p.clear_dirty(&HASHER)
}
#[cfg(not(feature = "crc32"))]
unsafe fn clear_dirty(p: &mut MutPage) {
p.clear_dirty()
}
impl<E: Borrow<Env>> Commit for MutTxn<E, ()> {
fn commit(mut self) -> Result<(), Error> {
debug!("COMMIT");
// If there's no tree of free pages, and no pages to free,
// don't bother with free pages at all (don't even allocate a
// tree).
let free_db =
if self.free == 0 && self.free_owned_pages.is_empty() && self.free_pages.is_empty() {
assert!(self.initial_free.is_empty());
assert!(self.initial_allocated.is_empty());
None
} else {
// Else, allocate or load the tree of free pages.
let mut free_db: btree::Db<L64, ()> = if self.free == 0 {
unsafe { btree::create_db(&mut self)? }
} else {
unsafe { btree::Db::from_page(self.free) }
};
debug!("free_db = {:x}", free_db.db);
if cfg!(debug_assertions) {
for p in self.initial_free.iter() {
debug!("initial_free {:x}", p);
}
for p in self.initial_allocated.iter() {
debug!("initial_alloc {:x}", p);
}
}
let mut changed = true;
// Fix point on the freed and allocated pages.
while changed {
changed = false;
// Delete the pages allocated during this transaction
// from the free db. If these pages have been freed
// again, they will be reinserted below.
while let Some(p) = self.initial_allocated.pop() {
btree::del(&mut self, &mut free_db, &L64(p.to_le()), None)?;
changed = true;
}
// Adding all the pages freed during the transaction to the
// tree of free pages. If this call to `btree::put` frees
// pages, add them again. This converges in at most log n
// iterations (where n is the total number of free pages).
while !self.free_pages.is_empty() || !self.free_owned_pages.is_empty() {
while let Some(p) = self.free_pages.pop() {
let p = p & !0xfff;
btree::put(&mut self, &mut free_db, &L64(p.to_le()), &())?;
changed = true;
}
while let Some(p) = self.free_owned_pages.pop() {
let p = p & !0xfff;
btree::put(&mut self, &mut free_db, &L64(p.to_le()), &())?;
changed = true;
}
}
}
Some(free_db)
};
// Clear the dirty bit of all pages we've touched. If they've
// been freed and have already been flushed by the kernel, we
// don't want to resurrect them to the main memory, so we
// check that.
let mut occ = std::mem::replace(&mut self.occupied_owned_pages, Vec::new());
for (p, uses_dirty) in occ.iter_mut() {
if *uses_dirty {
if let Some(ref free_db) = free_db {
if let Some((pp, ())) =
btree::get(&self, free_db, &L64(p.0.offset.to_le()), None)?
{
if u64::from_le(pp.0) == p.0.offset {
continue;
}
}
}
unsafe {
trace!(
"commit page {:x}: {:?}",
p.0.offset,
std::slice::from_raw_parts(p.0.data, 32)
);
}
unsafe {
clear_dirty(p);
}
}
}
let env = self.env.borrow();
let mut maps = env.mmaps.lock();
// Flush all the maps.
for m in maps.iter_mut() {
m.flush()?
}
// Get this transaction's root page.
let globptr =
unsafe { &mut *(maps[0].ptr.add(self.root * PAGE_SIZE) as *mut GlobalHeader) };
// Set the length and free database.
globptr.length = self.length.to_le();
if let Some(free_db) = free_db {
debug!("COMMIT: free_db = 0x{:x}", free_db.db);
let free: u64 = free_db.db.into();
globptr.free_db = free.to_le();
}
if let Some(ref rc_db) = self.rc {
debug!("COMMIT: rc_db = 0x{:x}", rc_db.db);
let rc: u64 = rc_db.db.into();
globptr.rc_db = rc.to_le();
}
// Set the "root databases" modified by this transaction.
let root_dbs = unsafe {
std::slice::from_raw_parts_mut(
maps[0].ptr.add(self.root * PAGE_SIZE + GLOBAL_HEADER_SIZE) as *mut u64,
N_ROOTS,
)
};
for (&r, rr) in self.roots.iter().zip(root_dbs.iter_mut()) {
if r > 0 {
*rr = r.to_le()
}
}
// Set the root page's CRC.
unsafe {
set_crc(maps[0].ptr.add(self.root * PAGE_SIZE));
}
// Move the current global root page by one page on page 0.
unsafe {
(&mut *(maps[0].ptr as *mut GlobalHeader)).root =
(self.root as u8 + 1) % (env.roots.len() as u8);
}
// Flush all the maps.
maps[0].flush_range(0, env.roots.len() * PAGE_SIZE)?;
// And finally, unlock the root page in the environment.
debug!("commit: unlock {:?}", self.root);
unsafe { env.roots[self.root].rw.unlock_exclusive() };
// Unlock the root page on the file lock (if relevant).
env.unlock(self.root)?;
// And unlock the global mutable transaction mutex.
env.mut_txn_unlock()?;
debug!("/COMMIT");
Ok(())
}
}
impl<E: Borrow<Env>, T> MutTxn<E, T> {
/// Setting the `num`th element of the initial page, treated as a
/// `[u64; 510]`, to `value`. This doesn't actually write anything
/// to that page, since that page is written during the commit.
///
/// In the current implementation, `value` is probably going to be
/// the offset in the file of the root page of a B tree.
pub fn set_root(&mut self, num: usize, value: u64) {
if self.roots.get(num).is_none() {
self.roots.resize(num + 1, 0u64);
}
self.roots[num] = value;
}
/// Setting the `num`th element of the initial page, treated as a
/// [u64; 510].
pub fn remove_root(&mut self, num: usize) {
if self.roots.get(num).is_none() {
self.roots.resize(num + 1, 0u64);
}
self.roots[num] = 0;
}
/// Add the page at offset `offset` to the list of free pages that
/// were allocated by this `MutTxn` (and hence can be reallocated
/// by the same transaction).
fn free_owned_page(&mut self, offset: u64) {
debug!("FREEING OWNED PAGE {:?} {:x}", offset, offset);
assert_ne!(offset, 0);
self.free_owned_pages.push(offset);
}
/// Add the page at offset `offset` to the list of free pages
/// allocated by a previous transaction, and hence may still be
/// accessible by other transactions.
fn free_page(&mut self, offset: u64) {
debug!("FREEING PAGE {:?} {:x}", offset, offset);
assert_ne!(offset, 0);
self.free_pages.push(offset)
}
/// Pop a free page from the B tree of free pages.
fn free_pages_pop(&mut self) -> Result<Option<u64>, Error> {
while let Some(p) = self.initial_free.pop() {
if self.free_for_all(p)? {
self.initial_allocated.push(p);
return Ok(Some(p));
}
}
Ok(None)
}
// Check whether this page is also free for the other
// versions.
fn free_for_all(&self, f: u64) -> Result<bool, Error> {
let env = self.env.borrow();
// We already know it's free for the youngest previous
// transaction and for the current one (because the tree of
// free pages was copied from there), so we only have
// `self.roots.len() - 2` root pages to check.
for i in 1..env.roots.len() - 1 {
debug!("free_for_all {:?}", i);
let db: btree::Db<L64, ()> = unsafe {
let p = &*(env.mmaps.lock()[0]
.ptr
.add(((self.root + i) % env.roots.len()) * PAGE_SIZE)
as *const GlobalHeader);
if f >= u64::from_le(p.length) {
// Page `f` was allocated strictyl after
// transaction `i`.
continue;
}
if p.free_db == 0 {
// This version doesn't have any free page.
return Ok(false);
}
btree::Db::from_page(u64::from_le(p.free_db))
};
if let Some((&f_, ())) = btree::get(self, &db, &L64(f.to_le()), None)? {
if f_.as_u64() != f {
return Ok(false);
}
}
}
Ok(true)
}
}
impl<E: Borrow<Env>, T> MutTxn<E, T> {
unsafe fn alloc_page_(&mut self, dirty: bool) -> Result<MutPage, Error> {
// If we have allocated and freed a page in this transaction,
// use it first.
if let Some(offset) = self.free_owned_pages.pop() {
assert_ne!(offset, 0);
debug!("free owned pop 0x{:x}", offset);
let data = unsafe { self.env.borrow().find_offset(offset)? };
let page = MutPage(CowPage { data, offset });
self.occupied_owned_pages
.push((MutPage(CowPage { data, offset }), dirty));
Ok(page)
} else {
// Else, if there are free pages, take one.
if let Some(offset) = self.free_pages_pop()? {
assert_ne!(offset, 0);
debug!("free pages pop 0x{:x}", offset);
let data = unsafe { self.env.borrow().find_offset(offset)? };
self.occupied_owned_pages
.push((MutPage(CowPage { data, offset }), dirty));
Ok(MutPage(CowPage { data, offset }))
} else {
// Else, allocate in the free space.
debug!("allocate in the free space 0x{:x}", self.length);
let offset = self.length;
self.length += PAGE_SIZE as u64;
let data = unsafe { self.env.borrow().find_offset(offset)? };
self.occupied_owned_pages
.push((MutPage(CowPage { data, offset }), dirty));
Ok(MutPage(CowPage { data, offset }))
}
}
}
}
impl<E: Borrow<Env>, T> sanakirja_core::AllocPage for MutTxn<E, T> {
/// Allocate a single page.
unsafe fn alloc_page(&mut self) -> Result<MutPage, Error> {
self.alloc_page_(true)
}
/// Allocate a single page.
unsafe fn alloc_page_no_dirty(&mut self) -> Result<MutPage, Error> {
self.alloc_page_(false)
}
/// Allocate many contiguous pages, return the first one
unsafe fn alloc_contiguous(&mut self, length: u64) -> Result<MutPage, Error> {
// Check that length is a multiple of the page size.
assert_eq!(length & (PAGE_SIZE as u64 - 1), 0);
self.free_owned_pages.sort_by(|a, b| b.cmp(a));
self.initial_free.sort_by(|a, b| b.cmp(a));
let mut i = self.free_owned_pages.len();
let mut ni = 0;
let mut j = self.initial_free.len();
let mut nj = 0;
let mut result = 0u64;
let mut current = 0u64;
let mut current_p = std::ptr::null_mut();
while current + PAGE_SIZE as u64 - result < length {
// page allocated, consumed in i, consumed in j
let (m, ic, jc) = if i > 0 && j > 0 {
let a = self.free_owned_pages[i - 1];
let b = self.initial_free[j - 1];
if a < b || !self.free_for_all(b)? {
i -= 1;
(a, 1, 0)
} else {
j -= 1;
(b, 0, 1)
}
} else if i > 0 {
i -= 1;
(self.free_owned_pages[i], 1, 0)
} else if j > 0 {
j -= 1;
let p = self.initial_free[j];
// Check whether p is available for all txns
if !self.free_for_all(p)? {
// Reset the current block, no free page was consumed.
ni = 0;
nj = 0;
current = result;
current_p = unsafe { self.env.borrow().find_offset(current)? };
continue;
}
(p, 0, 1)
} else if current == result {
// No current region, and we've reached the end of the file, just allocate there.
let offset = self.length;
let data = unsafe { self.env.borrow().find_offset(offset)? };
self.length += length;
return Ok(MutPage(CowPage { offset, data }));
} else if current + PAGE_SIZE as u64 == self.length {
// We've reached the end of the file, grow just one last time.
self.length += length - (current + PAGE_SIZE as u64 - result);
break;
} else {
unreachable!()
};
if current > 0 && m == current + PAGE_SIZE as u64 {
// We only have to check whether `current` is actually
// contiguous in terms of pointers.
let next_p = unsafe { self.env.borrow().find_offset(m)? };
if next_p as usize == current_p as usize + PAGE_SIZE {
ni += ic;
nj += jc;
} else {
// `m` is the first page in a new map, reset the block
result = m;
ni = ic;
nj = jc;
}
current = m;
current_p = next_p
} else {
// Initial region
result = m;
current = m;
current_p = unsafe { self.env.borrow().find_offset(m)? };
ni = ic;
nj = jc;
}
}
for offset in self
.free_owned_pages
.drain(i..i + ni)
.chain(self.initial_free.drain(j..j + nj))
{
let data = unsafe { self.env.borrow().find_offset(offset)? };
self.occupied_owned_pages
.push((MutPage(CowPage { data, offset }), false))
}
let data = unsafe { self.env.borrow().find_offset(result)? };
Ok(MutPage(CowPage {
data,
offset: result,
}))
}
/// Increment the reference count for page `off`.
fn incr_rc(&mut self, off: u64) -> Result<usize, Error> {
assert!(off > 0);
if let Some(mut rc_) = self.rc.take() {
let mut curs = btree::cursor::Cursor::new(self, &rc_)?;
curs.set(self, &L64(off.to_le()), None)?;
let rc = if let Some((rc, _)) = curs.current(self)? {
let rc = rc.as_u64();
if rc & !0xfff == off {
rc & 0xfff
} else {
1
}
} else {
1
};
if rc > 1 {
btree::del::del_at_cursor(self, &mut rc_, &mut curs, true)?;
}
debug!("incr rc 0x{:x} {:?}", off, rc + 1);
assert!(rc + 1 <= 0xfff);
btree::put(self, &mut rc_, &L64((off | (rc + 1)).to_le()), &())?;
self.rc = Some(rc_);
Ok(rc as usize + 1)
} else {
let mut rc = unsafe { btree::create_db(self)? };
btree::put(self, &mut rc, &L64((off | 2).to_le()), &())?;
self.rc = Some(rc);
Ok(2)
}
}
unsafe fn decr_rc(&mut self, off: u64) -> Result<usize, Error> {
let rc = self.decr_rc_(off)?;
if rc == 0 {
self.free_page(off);
}
Ok(rc)
}
unsafe fn decr_rc_owned(&mut self, off: u64) -> Result<usize, Error> {
let rc = self.decr_rc_(off)?;
if rc == 0 {
self.free_owned_page(off);
}
Ok(rc)
}
}
impl<E: Borrow<Env>, A> MutTxn<E, A> {
/// Decrement the reference count of page `off`, freeing that page
/// if the RC reaches 0 after decrementing it.
fn decr_rc_(&mut self, off: u64) -> Result<usize, Error> {
debug!("decr_rc 0x{:x} {:?}", off, self.rc);
// If there's no RC table, free the page. Also, in order to
// avoid infinite recursion (since `del` and `put` below might
// free pages), we `take` the reference counter table.
if let Some(mut rc_) = self.rc.take() {
let mut curs = btree::cursor::Cursor::new(self, &rc_)?;
curs.set(self, &L64(off.to_le()), None)?;
// The reference count is stored as the 12 LSBs of the
// keys. If the page isn't in the RC table, the count is
// 1.
let rc = if let Some((rc, ())) = curs.next(self)? {
let rc = rc.as_u64();
if rc & !0xfff == off {
rc
} else {
1
}
} else {
1
};
debug!("decr_rc, rc = 0x{:x}", rc);
if rc > 1 {
// If the reference count is strictly more than 2,
// replace the reference count with a decremented
// value.
btree::del(self, &mut rc_, &L64(rc.to_le()), None)?;
if rc & 0xfff > 2 {
btree::put(self, &mut rc_, &L64((rc - 1).to_le()), &())?;
self.rc = Some(rc_);
} else {
// Else, we don't free the page, but don't add the
// page back, since this is an implicit value of
// "1" for the reference count.
self.rc = Some(rc_)
}
return Ok((rc & 0xfff) as usize - 1);
} else {
self.rc = Some(rc_)
}
}
Ok(0)
}
/// The root page of this transaction (use with caution, this page
/// contains root databases).
pub unsafe fn root_page_mut(&mut self) -> &mut [u8; 4064] {
let env = self.env.borrow();
let maps = env.mmaps.lock();
let ptr = maps[0].ptr.add(self.root * PAGE_SIZE + GLOBAL_HEADER_SIZE);
&mut *(ptr as *mut [u8; 4064])
}
/// The root page of this transaction.
pub unsafe fn root_page(&self) -> &[u8; 4064] {
let env = self.env.borrow();
let maps = env.mmaps.lock();
let ptr = maps[0].ptr.add(self.root * PAGE_SIZE + GLOBAL_HEADER_SIZE);
&*(ptr as *const [u8; 4064])
}
}
impl<E: Borrow<Env>, A> sanakirja_core::LoadPage for MutTxn<E, A> {
type Error = Error;
unsafe fn load_page(&self, off: u64) -> Result<CowPage, Self::Error> {
let data = self.env.borrow().find_offset(off)?;
Ok(CowPage { data, offset: off })
}
fn rc(&self, page: u64) -> Result<u64, Self::Error> {
if let Some(ref rc) = self.rc {
if let Some((rc, _)) = btree::get(self, rc, &L64(page.to_le()), None)? {
let rc = rc.as_u64();
if rc & !0xfff == page {
let r = rc & 0xfff;
if r >= 2 {
return Ok(r);
}
}
}
}
Ok(0)
}
}
impl<E: Borrow<Env>, T> RootPage for MutTxn<E, T> {
unsafe fn root_page(&self) -> &[u8; 4064] {
let env = self.env.borrow();
let maps = env.mmaps.lock();
let ptr = maps[0].ptr.add(self.root * PAGE_SIZE + GLOBAL_HEADER_SIZE);
&*(ptr as *const [u8; 4064])
}
}
impl<E: Borrow<Env>, T> MutTxn<E, T> {
/// Low-level method to get the root page number `n`, if that page
/// isn't a B tree (use the [`RootDb`] trait else).
pub fn root(&self, n: usize) -> Option<u64> {
if let Some(db) = self.roots.get(n) {
if *db == 0 {
None
} else {
Some(*db)
}
} else {
unsafe {
let env = self.env.borrow();
let db = {
let maps = env.mmaps.lock();
u64::from_le(
*(maps[0]
.ptr
.add(self.root * PAGE_SIZE + GLOBAL_HEADER_SIZE + 8 * n)
as *mut u64),
)
};
if db != 0 {
Some(db)
} else {
None
}
}
}
}
}
impl<E: Borrow<Env>, T> RootDb for MutTxn<E, T> {
// Just call method `root` and convert the result to a `Db`.
fn root_db<K: Storable + ?Sized, V: Storable + ?Sized, P: btree::BTreePage<K, V>>(
&self,
n: usize,
) -> Option<btree::Db_<K, V, P>> {
if let Some(db) = self.root(n) {
Some(unsafe { btree::Db_::from_page(db) })
} else {
None
}
}
}