Merge pull request 'make lmdb's map_size configurable (fix #628)' (#630) from configurable-map-size into main

Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/630

3 files changed, 66 insertions, 8 deletions

diff --git a/src/model/garage.rs b/src/model/garage.rs
index 3daa1b33..a432aa7a 100644
--- a/src/model/garage.rs
+++ b/src/model/garage.rs
@@ -95,7 +95,7 @@ impl Garage {
 				info!("Opening Sled database at: {}", db_path.display());
 				let db = db::sled_adapter::sled::Config::default()
 					.path(&db_path)
-					.cache_capacity(config.sled_cache_capacity)
+					.cache_capacity(config.sled_cache_capacity as u64)
 					.flush_every_ms(Some(config.sled_flush_every_ms))
 					.open()
 					.ok_or_message("Unable to open sled DB")?;
@@ -125,7 +125,10 @@ impl Garage {
 				info!("Opening LMDB database at: {}", db_path.display());
 				std::fs::create_dir_all(&db_path)
 					.ok_or_message("Unable to create LMDB data directory")?;
-				let map_size = garage_db::lmdb_adapter::recommended_map_size();
+				let map_size = match config.lmdb_map_size {
+					v if v == usize::default() => garage_db::lmdb_adapter::recommended_map_size(),
+					v => v - (v % 4096),
+				};
 
 				use db::lmdb_adapter::heed;
 				let mut env_builder = heed::EnvOpenOptions::new();
@@ -142,6 +145,7 @@ impl Garage {
 							"OutOfMemory error while trying to open LMDB database. This can happen \
 							if your operating system is not allowing you to use sufficient virtual \
 							memory address space. Please check that no limit is set (ulimit -v). \
+							You may also try to set a smaller `lmdb_map_size` configuration parameter. \
 							On 32-bit machines, you should probably switch to another database engine.".into()))
 					}
 					x => x.ok_or_message("Unable to open LMDB DB")?,
diff --git a/src/util/Cargo.toml b/src/util/Cargo.toml
index 00dae4d1..2efb0270 100644
--- a/src/util/Cargo.toml
+++ b/src/util/Cargo.toml
@@ -20,6 +20,7 @@ arc-swap = "1.0"
 async-trait = "0.1"
 blake2 = "0.10"
 bytes = "1.0"
+bytesize = "1.2"
 digest = "0.10"
 err-derive = "0.3"
 hexdump = "0.1"
diff --git a/src/util/config.rs b/src/util/config.rs
index 1da95b2f..724f9404 100644
--- a/src/util/config.rs
+++ b/src/util/config.rs
@@ -1,4 +1,5 @@
 //! Contains type and functions related to Garage configuration file
+use std::convert::TryFrom;
 use std::io::Read;
 use std::net::SocketAddr;
 use std::path::PathBuf;
@@ -16,7 +17,10 @@ pub struct Config {
 	pub data_dir: PathBuf,
 
 	/// Size of data blocks to save to disk
-	#[serde(default = "default_block_size")]
+	#[serde(
+		deserialize_with = "deserialize_capacity",
+		default = "default_block_size"
+	)]
 	pub block_size: usize,
 
 	/// Replication mode. Supported values:
@@ -66,12 +70,19 @@ pub struct Config {
 	pub db_engine: String,
 
 	/// Sled cache size, in bytes
-	#[serde(default = "default_sled_cache_capacity")]
-	pub sled_cache_capacity: u64,
+	#[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,
+
 	// -- APIs
 	/// Configuration for S3 api
 	pub s3_api: S3ApiConfig,
@@ -186,7 +197,7 @@ fn default_db_engine() -> String {
 	"sled".into()
 }
 
-fn default_sled_cache_capacity() -> u64 {
+fn default_sled_cache_capacity() -> usize {
 	128 * 1024 * 1024
 }
 fn default_sled_flush_every_ms() -> u64 {
@@ -266,8 +277,6 @@ fn deserialize_compression<'de, D>(deserializer: D) -> Result<Option<i32>, D::Er
 where
 	D: de::Deserializer<'de>,
 {
-	use std::convert::TryFrom;
-
 	struct OptionVisitor;
 
 	impl<'de> serde::de::Visitor<'de> for OptionVisitor {
@@ -312,6 +321,50 @@ where
 	deserializer.deserialize_any(OptionVisitor)
 }
 
+fn deserialize_capacity<'de, D>(deserializer: D) -> Result<usize, D::Error>
+where
+	D: de::Deserializer<'de>,
+{
+	struct CapacityVisitor;
+
+	impl<'de> serde::de::Visitor<'de> for CapacityVisitor {
+		type Value = usize;
+		fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
+			formatter.write_str("int or '<capacity>'")
+		}
+
+		fn visit_str<E>(self, value: &str) -> Result<Self::Value, E>
+		where
+			E: de::Error,
+		{
+			value
+				.parse::<bytesize::ByteSize>()
+				.map(|x| x.as_u64())
+				.map_err(|e| E::custom(format!("invalid capacity value: {}", e)))
+				.and_then(|v| {
+					usize::try_from(v)
+						.map_err(|_| E::custom("capacity value out of bound".to_owned()))
+				})
+		}
+
+		fn visit_i64<E>(self, v: i64) -> Result<Self::Value, E>
+		where
+			E: de::Error,
+		{
+			usize::try_from(v).map_err(|_| E::custom("capacity value out of bound".to_owned()))
+		}
+
+		fn visit_u64<E>(self, v: u64) -> Result<Self::Value, E>
+		where
+			E: de::Error,
+		{
+			usize::try_from(v).map_err(|_| E::custom("capacity value out of bound".to_owned()))
+		}
+	}
+
+	deserializer.deserialize_any(CapacityVisitor)
+}
+
 #[cfg(test)]
 mod tests {
 	use crate::error::Error;