Struct tikv::storage::Latches

pub struct Latches {
    slots: Vec<CachePadded<Mutex<Latch>>>,
    size: usize,
}

Latches which are used for concurrency control in the scheduler.

Each latch is indexed by a slot ID, hence the term latch and slot are used interchangeably, but conceptually a latch is a queue, and a slot is an index to the queue.

Fields

slots: Vec<CachePadded<Mutex<Latch>>>

size: usize

Implementations

impl Latches

pub fn new(size: usize) -> Latches

Creates latches.

The size will be rounded up to the power of 2.

pub fn acquire(&self, lock: &mut Lock, who: u64) -> bool

Tries to acquire the latches specified by the lock for command with ID who.

This method will enqueue the command ID into the waiting queues of the latches. A latch is considered acquired if the command ID is the first one of elements in the queue which have the same hash value. Returns true if all the Latches are acquired, false otherwise.

pub fn release(&self, lock: &Lock, who: u64) -> Vec<u64>

Releases all latches owned by the lock of command with ID who, returns the wakeup list.

Preconditions: the caller must ensure the command is at the front of the latches.

fn lock_latch(&self, hash: u64) -> MutexGuard<'_, Latch>