garage_table 2.4.1

Table sharding and replication engine (DynamoDB-like) for the Garage object store
Documentation
use std::sync::Arc;
use std::time::Duration;

use garage_rpc::layout::*;
use garage_rpc::replication_mode::ConsistencyMode;
use garage_util::data::*;
use garage_util::error::Error;

use crate::replication::sharded::manager::LayoutManager;
use crate::replication::*;

/// Sharded replication schema:
/// - based on the ring of nodes, a certain set of neighbors
///   store entries, given as a function of the position of the
///   entry's hash in the ring
/// - reads are done on all of the nodes that replicate the data
/// - writes as well
#[derive(Clone)]
pub struct TableShardedReplication {
	/// The membership manager of this node
	pub layout_manager: Arc<LayoutManager>,
	pub consistency_mode: ConsistencyMode,
}

impl TableReplication for TableShardedReplication {
	// Do anti-entropy every 10 minutes
	const ANTI_ENTROPY_INTERVAL: Duration = Duration::from_secs(10 * 60);

	type WriteSets = WriteLock<Vec<Vec<Uuid>>>;

	fn storage_nodes(&self, hash: &Hash) -> Result<Vec<Uuid>, Error> {
		let mut ret = vec![];
		for version in self.layout_manager.layout().versions()?.iter() {
			ret.extend(version.nodes_of(hash));
		}
		ret.sort();
		ret.dedup();
		Ok(ret)
	}

	fn read_nodes(&self, hash: &Hash) -> Result<Vec<Uuid>, Error> {
		Ok(self
			.layout_manager
			.layout()
			.read_version()?
			.nodes_of(hash)
			.collect())
	}

	fn read_quorum(&self) -> Result<usize, Error> {
		Ok(self
			.layout_manager
			.layout()
			.read_version()?
			.read_quorum(self.consistency_mode))
	}

	fn write_sets(&self, hash: &Hash) -> Result<Self::WriteSets, Error> {
		self.layout_manager
			.write_lock_with(|lvs| write_sets(lvs, hash))
	}

	fn write_quorum(&self) -> Result<usize, Error> {
		Ok(self
			.layout_manager
			.layout()
			.current()?
			.write_quorum(self.consistency_mode))
	}

	fn partition_of(&self, hash: &Hash) -> Result<Partition, Error> {
		Ok(self.layout_manager.layout().current()?.partition_of(hash))
	}

	fn sync_partitions(&self) -> Result<SyncPartitions, Error> {
		let layout = self.layout_manager.layout();
		let layout_versions = layout.versions()?;
		let layout_version = layout.ack_map_min();

		let mut partitions = layout
			.current()?
			.partitions()
			.map(|(partition, first_hash)| {
				SyncPartition {
					partition,
					first_hash,
					last_hash: [0u8; 32].into(), // filled in just after
					storage_sets: write_sets(layout_versions, &first_hash),
				}
			})
			.collect::<Vec<_>>();

		for i in 0..partitions.len() {
			partitions[i].last_hash = if i + 1 < partitions.len() {
				partitions[i + 1].first_hash
			} else {
				[0xFFu8; 32].into()
			};
		}

		Ok(SyncPartitions {
			layout_version,
			partitions,
		})
	}
}

fn write_sets(layout_versions: &[LayoutVersion], hash: &Hash) -> Vec<Vec<Uuid>> {
	layout_versions
		.iter()
		.map(|x| x.nodes_of(hash).collect())
		.collect()
}