Struct garage_block::manager::BlockManager

source · [−]

pub struct BlockManager {
    pub replication: TableShardedReplication,
    pub data_dir: PathBuf,
    /* private fields */
}

Expand description

The block manager, handling block exchange between nodes, and block storage on local node

Fields

replication: TableShardedReplication

Replication strategy, allowing to find on which node blocks should be located

data_dir: PathBuf

Directory in which block are stored

Implementations

source

impl BlockManager

source

pub fn new(
 db: &Db,
 data_dir: PathBuf,
 compression_level: Option<i32>,
 background_tranquility: u32,
 replication: TableShardedReplication,
 system: Arc<System>
) -> Arc<Self>

source

pub async fn rpc_get_block(&self, hash: &Hash) -> Result<Vec<u8>, Error>

Ask nodes that might have a block for it

source

pub async fn rpc_put_block(
 &self,
 hash: Hash,
 data: Vec<u8>
) -> Result<(), Error>

Send block to nodes that should have it

source

pub async fn repair_data_store(
&self,
must_exit: &Receiver<bool>
) -> Result<(), Error>

Launch the repair procedure on the data store

This will list all blocks locally present, as well as those that are required because of refcount > 0, and will try to fix any mismatch between the two.

source

pub async fn scrub_data_store(
 &self,
 must_exit: &Receiver<bool>,
 tranquility: u32
) -> Result<(), Error>

Verify integrity of each block on disk. Use speed_limit to limit the load generated by this function.

source

pub fn resync_queue_len(&self) -> usize

Get lenght of resync queue

source

pub fn resync_errors_len(&self) -> usize

Get number of blocks that have an error

source

pub fn rc_len(&self) -> usize

Get number of items in the refcount table

source

pub fn block_incref(&self, hash: &Hash) -> Result<(), Error>

Increment the number of time a block is used, putting it to resynchronization if it is required, but not known

source

pub fn block_decref(&self, hash: &Hash) -> Result<(), Error>

Decrement the number of time a block is used

Trait Implementations

source

impl EndpointHandler<BlockRpc> for BlockManager

source

fn handle<'life0, 'life1, 'async_trait>(
 self: &'life0 Arc<Self>,
 message: &'life1 BlockRpc,
 _from: NodeID
) -> Pin<Box<dyn Future<Output = Result<BlockRpc, Error>> + Send + 'async_trait>> where
 'life0: 'async_trait,
 'life1: 'async_trait,
 Self: 'async_trait,

Auto Trait Implementations

impl !RefUnwindSafe for BlockManager

impl Send for BlockManager

impl Sync for BlockManager

impl Unpin for BlockManager

impl !UnwindSafe for BlockManager

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> FutureExt for T

source

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

source

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct garage_block::manager::BlockManager

Fields

Implementations

impl BlockManager

pub fn new( db: &Db, data_dir: PathBuf, compression_level: Option<i32>, background_tranquility: u32, replication: TableShardedReplication, system: Arc<System>) -> Arc<Self>

pub async fn rpc_get_block(&self, hash: &Hash) -> Result<Vec<u8>, Error>

pub async fn rpc_put_block( &self, hash: Hash, data: Vec<u8>) -> Result<(), Error>

pub async fn repair_data_store( &self, must_exit: &Receiver<bool>) -> Result<(), Error>

pub async fn scrub_data_store( &self, must_exit: &Receiver<bool>, tranquility: u32) -> Result<(), Error>

pub fn resync_queue_len(&self) -> usize

pub fn resync_errors_len(&self) -> usize

pub fn rc_len(&self) -> usize

pub fn block_incref(&self, hash: &Hash) -> Result<(), Error>

pub fn block_decref(&self, hash: &Hash) -> Result<(), Error>

Trait Implementations

impl EndpointHandler<BlockRpc> for BlockManager

fn handle<'life0, 'life1, 'async_trait>( self: &'life0 Arc<Self>, message: &'life1 BlockRpc, _from: NodeID) -> Pin<Box<dyn Future<Output = Result<BlockRpc, Error>> + Send + 'async_trait>> where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Auto Trait Implementations

impl !RefUnwindSafe for BlockManager

impl Send for BlockManager

impl Sync for BlockManager

impl Unpin for BlockManager

impl !UnwindSafe for BlockManager

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

fn with_current_context(self) -> WithContext<Self>

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> Same<T> for T

type Output = T

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn new(
db: &Db,
data_dir: PathBuf,
compression_level: Option<i32>,
background_tranquility: u32,
replication: TableShardedReplication,
system: Arc<System>
) -> Arc<Self>

pub async fn rpc_put_block(
&self,
hash: Hash,
data: Vec<u8>
) -> Result<(), Error>

pub async fn repair_data_store(
&self,
must_exit: &Receiver<bool>
) -> Result<(), Error>

pub async fn scrub_data_store(
&self,
must_exit: &Receiver<bool>,
tranquility: u32
) -> Result<(), Error>

fn handle<'life0, 'life1, 'async_trait>(
self: &'life0 Arc<Self>,
message: &'life1 BlockRpc,
_from: NodeID
) -> Pin<Box<dyn Future<Output = Result<BlockRpc, Error>> + Send + 'async_trait>> where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,