[rm-sled] Remove the Sled database engine

14 files changed, 18 insertions, 355 deletions

diff --git a/src/block/resync.rs b/src/block/resync.rs
index 15f210e4..2516ba08 100644
--- a/src/block/resync.rs
+++ b/src/block/resync.rs
@@ -180,7 +180,7 @@ impl BlockResyncManager {
 	// deleted once the garbage collection delay has passed.
 	//
 	// Here are some explanations on how the resync queue works.
-	// There are two Sled trees that are used to have information
+	// There are two db trees that are used to have information
 	// about the status of blocks that need to be resynchronized:
 	//
 	// - resync.queue: a tree that is ordered first by a timestamp
@@ -541,9 +541,9 @@ impl Worker for ResyncWorker {
 				Ok(WorkerState::Idle)
 			}
 			Err(e) => {
-				// The errors that we have here are only Sled errors
+				// The errors that we have here are only db errors
 				// We don't really know how to handle them so just ¯\_(ツ)_/¯
-				// (there is kind of an assumption that Sled won't error on us,
+				// (there is kind of an assumption that the db won't error on us,
 				// if it does there is not much we can do -- TODO should we just panic?)
 				// Here we just give the error to the worker manager,
 				// it will print it to the logs and increment a counter
diff --git a/src/db/Cargo.toml b/src/db/Cargo.toml
index fddc5cca..a8f6d586 100644
--- a/src/db/Cargo.toml
+++ b/src/db/Cargo.toml
@@ -18,13 +18,12 @@ tracing.workspace = true
 
 heed = { workspace = true, optional = true }
 rusqlite = { workspace = true, optional = true }
-sled = { workspace = true, optional = true }
 
 [dev-dependencies]
 mktemp.workspace = true
 
 [features]
-default = [ "sled", "lmdb", "sqlite" ]
+default = [ "lmdb", "sqlite" ]
 bundled-libs = [ "rusqlite?/bundled" ]
 lmdb = [ "heed" ]
 sqlite = [ "rusqlite" ]
diff --git a/src/db/lib.rs b/src/db/lib.rs
index 0fb457ce..8975f295 100644
--- a/src/db/lib.rs
+++ b/src/db/lib.rs
@@ -3,8 +3,6 @@ extern crate tracing;
 
 #[cfg(feature = "lmdb")]
 pub mod lmdb_adapter;
-#[cfg(feature = "sled")]
-pub mod sled_adapter;
 #[cfg(feature = "sqlite")]
 pub mod sqlite_adapter;
 
diff --git a/src/db/open.rs b/src/db/open.rs
index ae135c4e..03476a42 100644
--- a/src/db/open.rs
+++ b/src/db/open.rs
@@ -11,7 +11,6 @@ use crate::{Db, Error, Result};
 pub enum Engine {
 	Lmdb,
 	Sqlite,
-	Sled,
 }
 
 impl Engine {
@@ -20,7 +19,6 @@ impl Engine {
 		match self {
 			Self::Lmdb => "lmdb",
 			Self::Sqlite => "sqlite",
-			Self::Sled => "sled",
 		}
 	}
 }
@@ -38,10 +36,10 @@ impl std::str::FromStr for Engine {
 		match text {
 			"lmdb" | "heed" => Ok(Self::Lmdb),
 			"sqlite" | "sqlite3" | "rusqlite" => Ok(Self::Sqlite),
-			"sled" => Ok(Self::Sled),
+			"sled" => Err(Error("Sled is no longer supported as a database engine. Converting your old metadata db can be done using an older Garage binary (e.g. v0.9.3).".into())),
 			kind => Err(Error(
 				format!(
-					"Invalid DB engine: {} (options are: lmdb, sled, sqlite)",
+					"Invalid DB engine: {} (options are: lmdb, sqlite)",
 					kind
 				)
 				.into(),
@@ -53,8 +51,6 @@ impl std::str::FromStr for Engine {
 pub struct OpenOpt {
 	pub fsync: bool,
 	pub lmdb_map_size: Option<usize>,
-	pub sled_cache_capacity: usize,
-	pub sled_flush_every_ms: u64,
 }
 
 impl Default for OpenOpt {
@@ -62,31 +58,12 @@ impl Default for OpenOpt {
 		Self {
 			fsync: false,
 			lmdb_map_size: None,
-			sled_cache_capacity: 1024 * 1024 * 1024,
-			sled_flush_every_ms: 2000,
 		}
 	}
 }
 
 pub fn open_db(path: &PathBuf, engine: Engine, opt: &OpenOpt) -> Result<Db> {
 	match engine {
-		// ---- Sled DB ----
-		#[cfg(feature = "sled")]
-		Engine::Sled => {
-			if opt.fsync {
-				return Err(Error(
-					"`metadata_fsync = true` is not supported with the Sled database engine".into(),
-				));
-			}
-			info!("Opening Sled database at: {}", path.display());
-			let db = crate::sled_adapter::sled::Config::default()
-				.path(&path)
-				.cache_capacity(opt.sled_cache_capacity as u64)
-				.flush_every_ms(Some(opt.sled_flush_every_ms))
-				.open()?;
-			Ok(crate::sled_adapter::SledDb::init(db))
-		}
-
 		// ---- Sqlite DB ----
 		#[cfg(feature = "sqlite")]
 		Engine::Sqlite => {
diff --git a/src/db/sled_adapter.rs b/src/db/sled_adapter.rs
deleted file mode 100644
index 84f2001b..00000000
--- a/src/db/sled_adapter.rs
+++ /dev/null
@@ -1,274 +0,0 @@
-use core::ops::Bound;
-
-use std::cell::Cell;
-use std::collections::HashMap;
-use std::sync::{Arc, RwLock};
-
-use sled::transaction::{
-	ConflictableTransactionError, TransactionError, Transactional, TransactionalTree,
-	UnabortableTransactionError,
-};
-
-use crate::{
-	Db, Error, IDb, ITx, ITxFn, OnCommit, Result, TxError, TxFnResult, TxOpError, TxOpResult,
-	TxResult, TxValueIter, Value, ValueIter,
-};
-
-pub use sled;
-
-// -- err
-
-impl From<sled::Error> for Error {
-	fn from(e: sled::Error) -> Error {
-		Error(format!("Sled: {}", e).into())
-	}
-}
-
-impl From<sled::Error> for TxOpError {
-	fn from(e: sled::Error) -> TxOpError {
-		TxOpError(e.into())
-	}
-}
-
-// -- db
-
-pub struct SledDb {
-	db: sled::Db,
-	trees: RwLock<(Vec<sled::Tree>, HashMap<String, usize>)>,
-}
-
-impl SledDb {
-	#[deprecated(
-		since = "0.9.0",
-		note = "The Sled database is now deprecated and will be removed in Garage v1.0. Please migrate to LMDB or Sqlite as soon as possible."
-	)]
-	pub fn init(db: sled::Db) -> Db {
-		tracing::warn!("--------------------    IMPORTANT WARNING !!!    ----------------------");
-		tracing::warn!("The Sled database is now deprecated and will be removed in Garage v1.0.");
-		tracing::warn!("Please migrate to LMDB or Sqlite as soon as possible.");
-		tracing::warn!("-----------------------------------------------------------------------");
-		let s = Self {
-			db,
-			trees: RwLock::new((Vec::new(), HashMap::new())),
-		};
-		Db(Arc::new(s))
-	}
-
-	fn get_tree(&self, i: usize) -> Result<sled::Tree> {
-		self.trees
-			.read()
-			.unwrap()
-			.0
-			.get(i)
-			.cloned()
-			.ok_or_else(|| Error("invalid tree id".into()))
-	}
-}
-
-impl IDb for SledDb {
-	fn engine(&self) -> String {
-		"Sled".into()
-	}
-
-	fn open_tree(&self, name: &str) -> Result<usize> {
-		let mut trees = self.trees.write().unwrap();
-		if let Some(i) = trees.1.get(name) {
-			Ok(*i)
-		} else {
-			let tree = self.db.open_tree(name)?;
-			let i = trees.0.len();
-			trees.0.push(tree);
-			trees.1.insert(name.to_string(), i);
-			Ok(i)
-		}
-	}
-
-	fn list_trees(&self) -> Result<Vec<String>> {
-		let mut trees = vec![];
-		for name in self.db.tree_names() {
-			let name = std::str::from_utf8(&name)
-				.map_err(|e| Error(format!("{}", e).into()))?
-				.to_string();
-			if name != "__sled__default" {
-				trees.push(name);
-			}
-		}
-		Ok(trees)
-	}
-
-	// ----
-
-	fn get(&self, tree: usize, key: &[u8]) -> Result<Option<Value>> {
-		let tree = self.get_tree(tree)?;
-		let val = tree.get(key)?;
-		Ok(val.map(|x| x.to_vec()))
-	}
-
-	fn len(&self, tree: usize) -> Result<usize> {
-		let tree = self.get_tree(tree)?;
-		Ok(tree.len())
-	}
-
-	fn insert(&self, tree: usize, key: &[u8], value: &[u8]) -> Result<Option<Value>> {
-		let tree = self.get_tree(tree)?;
-		let old_val = tree.insert(key, value)?;
-		Ok(old_val.map(|x| x.to_vec()))
-	}
-
-	fn remove(&self, tree: usize, key: &[u8]) -> Result<Option<Value>> {
-		let tree = self.get_tree(tree)?;
-		let old_val = tree.remove(key)?;
-		Ok(old_val.map(|x| x.to_vec()))
-	}
-
-	fn clear(&self, tree: usize) -> Result<()> {
-		let tree = self.get_tree(tree)?;
-		tree.clear()?;
-		Ok(())
-	}
-
-	fn iter(&self, tree: usize) -> Result<ValueIter<'_>> {
-		let tree = self.get_tree(tree)?;
-		Ok(Box::new(tree.iter().map(|v| {
-			v.map(|(x, y)| (x.to_vec(), y.to_vec())).map_err(Into::into)
-		})))
-	}
-
-	fn iter_rev(&self, tree: usize) -> Result<ValueIter<'_>> {
-		let tree = self.get_tree(tree)?;
-		Ok(Box::new(tree.iter().rev().map(|v| {
-			v.map(|(x, y)| (x.to_vec(), y.to_vec())).map_err(Into::into)
-		})))
-	}
-
-	fn range<'r>(
-		&self,
-		tree: usize,
-		low: Bound<&'r [u8]>,
-		high: Bound<&'r [u8]>,
-	) -> Result<ValueIter<'_>> {
-		let tree = self.get_tree(tree)?;
-		Ok(Box::new(tree.range::<&'r [u8], _>((low, high)).map(|v| {
-			v.map(|(x, y)| (x.to_vec(), y.to_vec())).map_err(Into::into)
-		})))
-	}
-	fn range_rev<'r>(
-		&self,
-		tree: usize,
-		low: Bound<&'r [u8]>,
-		high: Bound<&'r [u8]>,
-	) -> Result<ValueIter<'_>> {
-		let tree = self.get_tree(tree)?;
-		Ok(Box::new(tree.range::<&'r [u8], _>((low, high)).rev().map(
-			|v| v.map(|(x, y)| (x.to_vec(), y.to_vec())).map_err(Into::into),
-		)))
-	}
-
-	// ----
-
-	fn transaction(&self, f: &dyn ITxFn) -> TxResult<OnCommit, ()> {
-		let trees = self.trees.read().unwrap();
-		let res = trees.0.transaction(|txtrees| {
-			let mut tx = SledTx {
-				trees: txtrees,
-				err: Cell::new(None),
-			};
-			match f.try_on(&mut tx) {
-				TxFnResult::Ok(on_commit) => {
-					assert!(tx.err.into_inner().is_none());
-					Ok(on_commit)
-				}
-				TxFnResult::Abort => {
-					assert!(tx.err.into_inner().is_none());
-					Err(ConflictableTransactionError::Abort(()))
-				}
-				TxFnResult::DbErr => {
-					let e = tx.err.into_inner().expect("No DB error");
-					Err(e.into())
-				}
-			}
-		});
-		match res {
-			Ok(on_commit) => Ok(on_commit),
-			Err(TransactionError::Abort(())) => Err(TxError::Abort(())),
-			Err(TransactionError::Storage(s)) => Err(TxError::Db(s.into())),
-		}
-	}
-}
-
-// ----
-
-struct SledTx<'a> {
-	trees: &'a [TransactionalTree],
-	err: Cell<Option<UnabortableTransactionError>>,
-}
-
-impl<'a> SledTx<'a> {
-	fn get_tree(&self, i: usize) -> TxOpResult<&TransactionalTree> {
-		self.trees.get(i).ok_or_else(|| {
-			TxOpError(Error(
-				"invalid tree id (it might have been openned after the transaction started)".into(),
-			))
-		})
-	}
-
-	fn save_error<R>(
-		&self,
-		v: std::result::Result<R, UnabortableTransactionError>,
-	) -> TxOpResult<R> {
-		match v {
-			Ok(x) => Ok(x),
-			Err(e) => {
-				let txt = format!("{}", e);
-				self.err.set(Some(e));
-				Err(TxOpError(Error(txt.into())))
-			}
-		}
-	}
-}
-
-impl<'a> ITx for SledTx<'a> {
-	fn get(&self, tree: usize, key: &[u8]) -> TxOpResult<Option<Value>> {
-		let tree = self.get_tree(tree)?;
-		let tmp = self.save_error(tree.get(key))?;
-		Ok(tmp.map(|x| x.to_vec()))
-	}
-	fn len(&self, _tree: usize) -> TxOpResult<usize> {
-		unimplemented!(".len() in transaction not supported with Sled backend")
-	}
-
-	fn insert(&mut self, tree: usize, key: &[u8], value: &[u8]) -> TxOpResult<Option<Value>> {
-		let tree = self.get_tree(tree)?;
-		let old_val = self.save_error(tree.insert(key, value))?;
-		Ok(old_val.map(|x| x.to_vec()))
-	}
-	fn remove(&mut self, tree: usize, key: &[u8]) -> TxOpResult<Option<Value>> {
-		let tree = self.get_tree(tree)?;
-		let old_val = self.save_error(tree.remove(key))?;
-		Ok(old_val.map(|x| x.to_vec()))
-	}
-
-	fn iter(&self, _tree: usize) -> TxOpResult<TxValueIter<'_>> {
-		unimplemented!("Iterators in transactions not supported with Sled backend");
-	}
-	fn iter_rev(&self, _tree: usize) -> TxOpResult<TxValueIter<'_>> {
-		unimplemented!("Iterators in transactions not supported with Sled backend");
-	}
-
-	fn range<'r>(
-		&self,
-		_tree: usize,
-		_low: Bound<&'r [u8]>,
-		_high: Bound<&'r [u8]>,
-	) -> TxOpResult<TxValueIter<'_>> {
-		unimplemented!("Iterators in transactions not supported with Sled backend");
-	}
-	fn range_rev<'r>(
-		&self,
-		_tree: usize,
-		_low: Bound<&'r [u8]>,
-		_high: Bound<&'r [u8]>,
-	) -> TxOpResult<TxValueIter<'_>> {
-		unimplemented!("Iterators in transactions not supported with Sled backend");
-	}
-}
diff --git a/src/db/test.rs b/src/db/test.rs
index cd99eafa..d4c875f0 100644
--- a/src/db/test.rs
+++ b/src/db/test.rs
@@ -91,17 +91,6 @@ fn test_lmdb_db() {
 }
 
 #[test]
-#[cfg(feature = "sled")]
-fn test_sled_db() {
-	use crate::sled_adapter::SledDb;
-
-	let path = mktemp::Temp::new_dir().unwrap();
-	let db = SledDb::init(sled::open(path.to_path_buf()).unwrap());
-	test_suite(db);
-	drop(path);
-}
-
-#[test]
 #[cfg(feature = "sqlite")]
 fn test_sqlite_db() {
 	use crate::sqlite_adapter::SqliteDb;
diff --git a/src/garage/Cargo.toml b/src/garage/Cargo.toml
index 00ecb35e..53449a1c 100644
--- a/src/garage/Cargo.toml
+++ b/src/garage/Cargo.toml
@@ -80,12 +80,11 @@ k2v-client.workspace = true
 
 
 [features]
-default = [ "bundled-libs", "metrics", "sled", "lmdb", "sqlite", "k2v" ]
+default = [ "bundled-libs", "metrics", "lmdb", "sqlite", "k2v" ]
 
 k2v = [ "garage_util/k2v", "garage_api/k2v" ]
 
-# Database engines, Sled is still our default even though we don't like it
-sled = [ "garage_model/sled" ]
+# Database engines
 lmdb = [ "garage_model/lmdb" ]
 sqlite = [ "garage_model/sqlite" ]
 
diff --git a/src/garage/cli/convert_db.rs b/src/garage/cli/convert_db.rs
index 2aadb1d6..5346d55a 100644
--- a/src/garage/cli/convert_db.rs
+++ b/src/garage/cli/convert_db.rs
@@ -11,7 +11,7 @@ pub struct ConvertDbOpt {
 	/// https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/#db-engine-since-v0-8-0)
 	#[structopt(short = "i")]
 	input_path: PathBuf,
-	/// Input database engine (sled, lmdb or sqlite; limited by db engines
+	/// Input database engine (lmdb or sqlite; limited by db engines
 	/// enabled in this build)
 	#[structopt(short = "a")]
 	input_engine: Engine,
diff --git a/src/garage/main.rs b/src/garage/main.rs
index e489fff0..5e9c061f 100644
--- a/src/garage/main.rs
+++ b/src/garage/main.rs
@@ -18,8 +18,8 @@ compile_error!("Either bundled-libs or system-libs Cargo feature must be enabled
 #[cfg(all(feature = "bundled-libs", feature = "system-libs"))]
 compile_error!("Only one of bundled-libs and system-libs Cargo features must be enabled");
 
-#[cfg(not(any(feature = "lmdb", feature = "sled", feature = "sqlite")))]
-compile_error!("Must activate the Cargo feature for at least one DB engine: lmdb, sled or sqlite.");
+#[cfg(not(any(feature = "lmdb", feature = "sqlite")))]
+compile_error!("Must activate the Cargo feature for at least one DB engine: lmdb or sqlite.");
 
 use std::net::SocketAddr;
 use std::path::PathBuf;
@@ -72,8 +72,6 @@ async fn main() {
 	let features = &[
 		#[cfg(feature = "k2v")]
 		"k2v",
-		#[cfg(feature = "sled")]
-		"sled",
 		#[cfg(feature = "lmdb")]
 		"lmdb",
 		#[cfg(feature = "sqlite")]
diff --git a/src/model/Cargo.toml b/src/model/Cargo.toml
index 776671d0..a6bcfbe7 100644
--- a/src/model/Cargo.toml
+++ b/src/model/Cargo.toml
@@ -42,8 +42,7 @@ tokio.workspace = true
 opentelemetry.workspace = true
 
 [features]
-default = [ "sled", "lmdb", "sqlite" ]
+default = [ "lmdb", "sqlite" ]
 k2v = [ "garage_util/k2v" ]
 lmdb = [ "garage_db/lmdb" ]
-sled = [ "garage_db/sled" ]
 sqlite = [ "garage_db/sqlite" ]
diff --git a/src/model/garage.rs b/src/model/garage.rs
index 7ec8b22e..8987c594 100644
--- a/src/model/garage.rs
+++ b/src/model/garage.rs
@@ -118,9 +118,6 @@ impl Garage {
 			.ok_or_message("Invalid `db_engine` value in configuration file")?;
 		let mut db_path = config.metadata_dir.clone();
 		match db_engine {
-			db::Engine::Sled => {
-				db_path.push("db");
-			}
 			db::Engine::Sqlite => {
 				db_path.push("db.sqlite");
 			}
@@ -134,8 +131,6 @@ impl Garage {
 				v if v == usize::default() => None,
 				v => Some(v),
 			},
-			sled_cache_capacity: config.sled_cache_capacity,
-			sled_flush_every_ms: config.sled_flush_every_ms,
 		};
 		let db = db::open_db(&db_path, db_engine, &db_opt)
 			.ok_or_message("Unable to open metadata db")?;
diff --git a/src/table/gc.rs b/src/table/gc.rs
index ef788749..65ad0c42 100644
--- a/src/table/gc.rs
+++ b/src/table/gc.rs
@@ -334,9 +334,9 @@ impl<F: TableSchema, R: TableReplication> Worker for GcWorker<F, R> {
 	}
 }
 
-/// An entry stored in the gc_todo Sled tree associated with the table
+/// An entry stored in the gc_todo db tree associated with the table
 /// Contains helper function for parsing, saving, and removing
-/// such entry in Sled
+/// such entry in the db
 ///
 /// Format of an entry:
 /// - key =    8 bytes: timestamp of tombstone
@@ -353,7 +353,7 @@ pub(crate) struct GcTodoEntry {
 }
 
 impl GcTodoEntry {
-	/// Creates a new GcTodoEntry (not saved in Sled) from its components:
+	/// Creates a new GcTodoEntry (not saved in the db) from its components:
 	/// the key of an entry in the table, and the hash of the associated
 	/// serialized value
 	pub(crate) fn new(key: Vec<u8>, value_hash: Hash) -> Self {
diff --git a/src/table/merkle.rs b/src/table/merkle.rs
index 01271c58..be0ae243 100644
--- a/src/table/merkle.rs
+++ b/src/table/merkle.rs
@@ -31,14 +31,14 @@ pub struct MerkleUpdater<F: TableSchema, R: TableReplication> {
 	// - value = the hash of the full serialized item, if present,
 	//			 or an empty vec if item is absent (deleted)
 	// Fields in data:
-	//		pub(crate) merkle_todo: sled::Tree,
+	//		pub(crate) merkle_todo: db::Tree,
 	//		pub(crate) merkle_todo_notify: Notify,
 
 	// Content of the merkle tree: items where
 	// - key = .bytes() for MerkleNodeKey
 	// - value = serialization of a MerkleNode, assumed to be MerkleNode::empty if not found
 	// Field in data:
-	//		pub(crate) merkle_tree: sled::Tree,
+	//		pub(crate) merkle_tree: db::Tree,
 	empty_node_hash: Hash,
 }
 
diff --git a/src/util/config.rs b/src/util/config.rs
index b7f27676..e243c813 100644
--- a/src/util/config.rs
+++ b/src/util/config.rs
@@ -87,20 +87,10 @@ pub struct Config {
 	pub kubernetes_discovery: Option<KubernetesDiscoveryConfig>,
 
 	// -- DB
-	/// Database engine to use for metadata (options: sled, sqlite, lmdb)
+	/// Database engine to use for metadata (options: sqlite, lmdb)
 	#[serde(default = "default_db_engine")]
 	pub db_engine: String,
 
-	/// Sled cache size, in bytes
-	#[serde(
-		deserialize_with = "deserialize_capacity",
-		default = "default_sled_cache_capacity"
-	)]
-	pub sled_cache_capacity: usize,
-	/// Sled flush interval in milliseconds
-	#[serde(default = "default_sled_flush_every_ms")]
-	pub sled_flush_every_ms: u64,
-
 	/// LMDB map size
 	#[serde(deserialize_with = "deserialize_capacity", default)]
 	pub lmdb_map_size: usize,
@@ -246,13 +236,6 @@ fn default_db_engine() -> String {
 	"lmdb".into()
 }
 
-fn default_sled_cache_capacity() -> usize {
-	128 * 1024 * 1024
-}
-fn default_sled_flush_every_ms() -> u64 {
-	2000
-}
-
 fn default_block_size() -> usize {
 	1048576
 }