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
use crate::{
nd, Arc, BTreeMap, CompactFile, Data, HashMap, HashSet, Mutex, Ordering, RwLock, SaveOp,
Storage,
};
use std::convert::TryFrom;
type HX = u32; // Typical 8M cache will have 1K x 8KB pages, so 10 bits is typical, 32 should be plenty.
type Heap = GHeap<u64, u64, HX>;
/// ```Arc<Mutex<PageInfo>>```
pub type PageInfoPtr = Arc<Mutex<PageInfo>>;
/// Information for a logical page, including historic data.
pub struct PageInfo {
/// Current data for the page( None implies it is stored in underlying file ).
pub current: Option<Data>,
/// Historic data for the page. Has data for page at specified time.
/// A copy is made prior to an update, so get looks forward from access time.
pub history: BTreeMap<u64, Data>,
/// How many times has the page been used.
pub usage: u64,
/// Heap index.
pub hx: HX,
}
impl PageInfo {
fn new() -> PageInfoPtr {
Arc::new(Mutex::new(PageInfo {
current: None,
history: BTreeMap::new(),
usage: 0,
hx: HX::MAX,
}))
}
/// Increase usage.
fn inc_usage(&mut self, lpnum: u64, ah: &mut Heap) {
self.usage += 1;
if self.hx == HX::MAX {
self.hx = ah.insert(lpnum, self.usage);
} else {
ah.modify(self.hx, self.usage);
}
}
/// Get the Data for the page, checking history if not a writer.
/// Reads Data from file if necessary.
/// Result is Data and flag indicating whether data was read from file.
fn get_data(&mut self, lpnum: u64, a: &AccessPagedData) -> (Data, bool) {
if !a.writer {
if let Some((_k, v)) = self.history.range(a.time..).next() {
return (v.clone(), false);
}
}
if let Some(p) = &self.current {
return (p.clone(), false);
}
// Get data from file.
let file = a.spd.file.read().unwrap();
let data = file.get_page(lpnum);
self.current = Some(data.clone());
(data, true)
}
/// Set the page data, updating the history using the specified time and old data.
/// Result is size of current data.
fn set_data(&mut self, time: u64, old: Data, data: Data, do_history: bool) -> usize {
if do_history {
self.history.insert(time, old);
}
let result = if let Some(x) = &self.current {
x.len()
} else {
0
};
self.current = Some(data);
result
}
/// Trim entry for time t that no longer need to be retained, returning whether entry was retained.
/// start is start of range for which no readers exist.
fn trim(&mut self, t: u64, start: u64) -> bool {
let first = self.history_start(t);
if first >= start {
// There is no reader that can read copy for time t, so copy can be removed.
self.history.remove(&t);
false
} else {
true
}
}
/// Returns the earliest time that would return the page for the specified time.
fn history_start(&self, t: u64) -> u64 {
if let Some((k, _)) = self.history.range(..t).next_back() {
*k + 1
} else {
0
}
}
}
/// Central store of data.
#[derive(Default)]
pub struct Stash {
/// Write time - number of writes.
pub time: u64,
/// Page number -> page info.
pub pages: HashMap<u64, PageInfoPtr>,
/// Time -> reader count. Number of readers for given time.
pub rdrs: BTreeMap<u64, usize>,
/// Time -> set of page numbers. Page copies held for given time.
pub vers: BTreeMap<u64, HashSet<u64>>,
/// Total size of current pages.
pub total: usize,
/// trim_cache reduces total to mem_limit (or below).
pub mem_limit: usize,
/// Tracks loaded page with smallest usage.
pub min: Heap,
/// Total number of page accesses.
pub read: u64,
/// Total number of misses ( data was not already loaded ).
pub miss: u64,
}
impl Stash {
/// Set the value of the specified page for the current time.
fn set(&mut self, lpnum: u64, old: Data, data: Data) -> usize {
let time = self.time;
let u = self.vers.entry(time).or_default();
let do_history = u.insert(lpnum);
let p = self.get_pinfo(lpnum);
let result = p.lock().unwrap().set_data(time, old, data, do_history);
result
}
/// Get the PageInfoPtr for the specified page and note the page as used.
fn get_pinfo(&mut self, lpnum: u64) -> PageInfoPtr {
let p = self
.pages
.entry(lpnum)
.or_insert_with(PageInfo::new)
.clone();
p.lock().unwrap().inc_usage(lpnum, &mut self.min);
self.read += 1;
p
}
/// Register that there is a client reading the database. The result is the current time.
fn begin_read(&mut self) -> u64 {
let time = self.time;
let n = self.rdrs.entry(time).or_insert(0);
*n += 1;
time
}
/// Register that the read at the specified time has ended. Stashed pages may be freed.
fn end_read(&mut self, time: u64) {
let n = self.rdrs.get_mut(&time).unwrap();
*n -= 1;
if *n == 0 {
self.rdrs.remove(&time);
self.trim(time);
}
}
/// Register that an update operation has completed. Time is incremented.
/// Stashed pages may be freed. Returns number of pages updated.
fn end_write(&mut self) -> usize {
let result = if let Some(u) = self.vers.get(&self.time) {
u.len()
} else {
0
};
let t = self.time;
self.time = t + 1;
self.trim(t);
result
}
/// Trim historic data that is no longer required.
fn trim(&mut self, time: u64) {
let (s, r) = (self.start(time), self.retain(time));
if s != r {
let mut empty = Vec::<u64>::new();
for (t, pl) in self.vers.range_mut(s..r) {
pl.retain(|pnum| {
let p = self.pages.get(pnum).unwrap();
p.lock().unwrap().trim(*t, s)
});
if pl.is_empty() {
empty.push(*t);
}
}
for t in empty {
self.vers.remove(&t);
}
}
}
/// Calculate the start of the range of times for which there are no readers.
fn start(&self, time: u64) -> u64 {
if let Some((t, _n)) = self.rdrs.range(..time).next_back() {
1 + *t
} else {
0
}
}
/// Calculate the end of the range of times for which there are no readers.
fn retain(&self, time: u64) -> u64 {
if let Some((t, _n)) = self.rdrs.range(time..).next() {
*t
} else {
self.time
}
}
/// Adjust total memory used by stash.
fn delta(&mut self, amount: usize, old: usize) {
if old == 0 {
self.miss += 1;
}
if amount > old {
self.total += amount - old;
self.trim_cache();
} else {
self.total -= old - amount;
}
}
/// Trim cached data to configured limit.
fn trim_cache(&mut self) {
while self.total > self.mem_limit && self.min.n > 0 {
let lpnum = self.min.pop();
let mut p = self.pages.get(&lpnum).unwrap().lock().unwrap();
p.hx = HX::MAX;
if let Some(data) = &p.current {
self.total -= data.len();
p.current = None;
}
}
}
/// Return the number of pages currently cached.
pub fn cached(&self) -> usize {
self.min.n
}
}
/// Allows logical database pages to be shared to allow concurrent readers.
pub struct SharedPagedData {
/// Underlying file.
pub file: RwLock<CompactFile>,
/// Starter page size.
pub sp_size: usize,
/// Extension page size.
pub ep_size: usize,
/// Stash of pages.
pub stash: Mutex<Stash>,
}
/// =1024. Size of an extension page.
const EP_SIZE: usize = 1024;
/// =16. Maximum number of extension pages.
const EP_MAX: usize = 16;
/// =136. Starter page size.
const SP_SIZE: usize = (EP_MAX + 1) * 8;
impl SharedPagedData {
/// Construct SharedPageData based on specified underlying storage.
pub fn new(file: Box<dyn Storage>) -> Arc<Self> {
let file = CompactFile::new(file, SP_SIZE, EP_SIZE);
// Note : if it's not a new file, sp_size and ep_size are read from file header.
let sp_size = file.sp_size;
let ep_size = file.ep_size;
// Set a default stash memory limit of 10 MB.
let stash = Stash {
mem_limit: 10 * 1024 * 1024,
..Default::default()
};
Arc::new(Self {
stash: Mutex::new(stash),
file: RwLock::new(file),
sp_size,
ep_size,
})
}
/// Calculate the maximum size of a logical page. This value is stored in the Database struct.
pub fn page_size_max(&self) -> usize {
let ep_max = (self.sp_size - 2) / 8;
(self.ep_size - 16) * ep_max + (self.sp_size - 2)
}
/// Trim cache.
pub fn trim_cache(&self) {
self.stash.lock().unwrap().trim_cache();
}
}
/// Access to shared paged data.
pub struct AccessPagedData {
writer: bool,
time: u64,
///
pub spd: Arc<SharedPagedData>,
}
impl AccessPagedData {
/// Construct access to a virtual read-only copy of the database logical pages.
pub fn new_reader(spd: Arc<SharedPagedData>) -> Self {
let time = spd.stash.lock().unwrap().begin_read();
AccessPagedData {
writer: false,
time,
spd,
}
}
/// Construct access to the database logical pages.
pub fn new_writer(spd: Arc<SharedPagedData>) -> Self {
AccessPagedData {
writer: true,
time: 0,
spd,
}
}
/// Get locked guard of stash.
pub fn stash(&self) -> std::sync::MutexGuard<'_, Stash> {
self.spd.stash.lock().unwrap()
}
/// Get the Data for the specified page.
pub fn get_data(&self, lpnum: u64) -> Data {
// Get page info.
let pinfo = self.stash().get_pinfo(lpnum);
// Read the page data.
let (data, loaded) = pinfo.lock().unwrap().get_data(lpnum, self);
// If data was read from underlying file, adjust the total data stashed, and trim the stash if appropriate.
if loaded {
self.stash().delta(data.len(), 0);
}
data
}
/// Set the data of the specified page.
pub fn set_page(&self, lpnum: u64, data: Data) {
debug_assert!(self.writer);
// Get copy of current data.
let old = self.get_data(lpnum);
let new_len = data.len();
// Update the stash ( ensures any readers will not attempt to read the file ).
let old_len = self.stash().set(lpnum, old, data.clone());
// Write data to underlying file.
if data.len() > 0 {
self.spd.file.write().unwrap().set_page(lpnum, data);
} else {
self.spd.file.write().unwrap().free_page(lpnum);
}
// Adjust the total data stashed, and trim the stash if appropriate.
self.stash().delta(new_len, old_len);
}
/// Free a logical page.
pub fn free_page(&self, lpnum: u64) {
self.set_page(lpnum, nd());
}
/// Is the underlying file new (so needs to be initialised ).
pub fn is_new(&self) -> bool {
self.writer && self.spd.file.read().unwrap().is_new()
}
/// Check whether compressing a page is worthwhile.
pub fn compress(&self, size: usize, saving: usize) -> bool {
debug_assert!(self.writer);
CompactFile::compress(self.spd.sp_size, self.spd.ep_size, size, saving)
}
/// Allocate a logical page.
pub fn alloc_page(&self) -> u64 {
debug_assert!(self.writer);
self.spd.file.write().unwrap().alloc_page()
}
/// Commit changes to underlying file ( or rollback logical page allocations ).
pub fn save(&self, op: SaveOp) -> usize {
debug_assert!(self.writer);
match op {
SaveOp::Save => {
self.spd.file.write().unwrap().save();
self.stash().end_write()
}
SaveOp::RollBack => {
// Note: rollback happens before any pages are updated.
// However logical page allocations need to be rolled back.
self.spd.file.write().unwrap().rollback();
0
}
}
}
}
impl Drop for AccessPagedData {
fn drop(&mut self) {
if !self.writer {
self.stash().end_read(self.time);
}
}
}
#[derive(Default)]
/// Heap Node.
pub struct HeapNode<K, T, U> {
/// Index of node from heap position.
pub x: U,
/// Heap position of this node.
pub pos: U,
/// Node id.
pub id: T,
/// Node key.
pub key: K,
}
/// Heap for tracking least used page.
pub struct GHeap<K, T, U> {
/// Number of heap nodes, not including free nodes.
pub n: usize,
/// 1 + Index of start of free list.
pub free: usize,
/// Vector of heap nodes.
pub v: Vec<HeapNode<K, T, U>>,
}
impl<K, T, U> Default for GHeap<K, T, U>
where
K: Default,
T: Default,
{
fn default() -> Self {
Self {
v: Vec::new(),
n: 0,
free: 0,
}
}
}
impl<K, T, U> GHeap<K, T, U>
where
K: Default + Ord + Copy,
T: Default + Copy,
U: Copy + Default + TryFrom<usize>,
usize: TryFrom<U>,
{
/// Insert id into heap with specified key (usage). Result is index of heap node.
pub fn insert(&mut self, id: T, key: K) -> U {
let pos = self.n;
self.n += 1;
let x = self.alloc(pos);
self.v[x].id = id;
self.v[x].key = key;
self.move_up(pos, x, key);
Self::z(x)
}
/// Modify key of specified heap node.
pub fn modify(&mut self, x: U, newkey: K) {
let x = Self::u(x);
let pos = Self::u(self.v[x].pos);
let oldkey = self.v[x].key;
self.v[x].key = newkey;
match newkey.cmp(&oldkey) {
Ordering::Greater => self.move_down(pos, x, newkey),
Ordering::Less => self.move_up(pos, x, newkey),
Ordering::Equal => (),
}
}
/// Remove heap node with smallest key, returning the associated id.
/// Note: index of heap node is no longer valid.
pub fn pop(&mut self) -> T {
assert!(self.n > 0);
self.n -= 1;
let xmin = Self::u(self.v[0].x); // Node with smallest key.
let xlast = Self::u(self.v[self.n].x); // Last node in heap.
self.v[xlast].pos = Self::z(0); // Make last node first.
self.v[0].x = Self::z(xlast);
self.move_down(0, xlast, self.v[xlast].key);
// De-allocate popped node
self.v[xmin].pos = Self::z(self.free);
self.free = xmin + 1;
self.v[xmin].id
}
fn move_up(&mut self, mut c: usize, cx: usize, ck: K) {
while c > 0 {
let p = (c - 1) / 2;
let px = Self::u(self.v[p].x);
if ck >= self.v[px].key {
return;
}
// Swap parent(p) and child(c).
self.v[p].x = Self::z(cx);
self.v[c].x = Self::z(px);
self.v[px].pos = Self::z(c);
self.v[cx].pos = Self::z(p);
c = p;
}
}
fn move_down(&mut self, mut p: usize, px: usize, pk: K) {
loop {
let mut c = p * 2 + 1;
if c >= self.n {
return;
}
let mut cx = Self::u(self.v[c].x);
let mut ck = self.v[cx].key;
let c2 = c + 1;
if c2 < self.n {
let cx2 = Self::u(self.v[c2].x);
let ck2 = self.v[cx2].key;
if ck2 < ck {
c = c2;
cx = cx2;
ck = ck2;
}
}
if ck >= pk {
return;
}
// Swap parent(p) and child(c).
self.v[p].x = Self::z(cx);
self.v[c].x = Self::z(px);
self.v[px].pos = Self::z(c);
self.v[cx].pos = Self::z(p);
p = c;
}
}
fn alloc(&mut self, pos: usize) -> usize {
let x = if self.free == 0 {
self.v.push(HeapNode::default());
self.v.len() - 1
} else {
let x = self.free - 1;
self.free = Self::u(self.v[x].pos);
x
};
self.v[pos].x = Self::z(pos);
self.v[x].pos = Self::z(x);
x
}
fn z(x: usize) -> U {
match U::try_from(x) {
Ok(y) => y,
Err(_) => panic!(),
}
}
fn u(x: U) -> usize {
match usize::try_from(x) {
Ok(y) => y,
Err(_) => panic!(),
}
}
}
#[test]
pub fn test() {
let mut h = Heap::default();
let _h5 = h.insert(5, 10);
let _h8 = h.insert(8, 1);
let _h13 = h.insert(13, 2);
h.modify(_h8, 15);
assert!(h.pop() == 13);
let _h22 = h.insert(22, 9);
assert!(h.pop() == 22);
assert!(h.pop() == 5);
assert!(h.pop() == 8);
}