Merge pull request #1898 from CosmWasm/1702-cacheoptions-non-exhaustive

[2.0] Make CacheOptions non-exhaustive
CosmWasm · Oct 18, 2023 · 6e7b1e6 · 6e7b1e6
2 parents b1c031a + 498aa99
commit 6e7b1e6
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 31 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,10 +17,13 @@ and this project adheres to
   ([#1890])
 - cosmwasm-std: `Uint{64,128}::full_mul` now take `Into<Self>` as an argument.
   ([#1874])
+- cosmwasm-vm: Make `CacheOptions` non-exhaustive and add a constructor.
+  ([#1898])
 
 [#1874]: https://github.com/CosmWasm/cosmwasm/pull/1874
 [#1879]: https://github.com/CosmWasm/cosmwasm/pull/1879
 [#1890]: https://github.com/CosmWasm/cosmwasm/pull/1890
+[#1898]: https://github.com/CosmWasm/cosmwasm/pull/1898
 
 ## [1.5.0-rc.0]
 

diff --git a/packages/vm/benches/main.rs b/packages/vm/benches/main.rs
@@ -121,12 +121,12 @@ fn bench_instance(c: &mut Criterion) {
 fn bench_cache(c: &mut Criterion) {
     let mut group = c.benchmark_group("Cache");
 
-    let options = CacheOptions {
-        base_dir: TempDir::new().unwrap().into_path(),
-        available_capabilities: capabilities_from_csv("iterator,staking"),
-        memory_cache_size: MEMORY_CACHE_SIZE,
-        instance_memory_limit: DEFAULT_MEMORY_LIMIT,
-    };
+    let options = CacheOptions::new(
+        TempDir::new().unwrap().into_path(),
+        capabilities_from_csv("iterator,staking"),
+        MEMORY_CACHE_SIZE,
+        DEFAULT_MEMORY_LIMIT,
+    );
 
     group.bench_function("save wasm", |b| {
         let cache: Cache<MockApi, MockStorage, MockQuerier> =
@@ -150,7 +150,7 @@ fn bench_cache(c: &mut Criterion) {
     });
 
     group.bench_function("load wasm unchecked", |b| {
-        let options = CacheOptions { ..options.clone() };
+        let options = options.clone();
         let mut cache: Cache<MockApi, MockStorage, MockQuerier> =
             unsafe { Cache::new(options).unwrap() };
         cache.set_module_unchecked(true);
@@ -174,12 +174,12 @@ fn bench_cache(c: &mut Criterion) {
     });
 
     group.bench_function("instantiate from fs", |b| {
-        let non_memcache = CacheOptions {
-            base_dir: TempDir::new().unwrap().into_path(),
-            available_capabilities: capabilities_from_csv("iterator,staking"),
-            memory_cache_size: Size(0),
-            instance_memory_limit: DEFAULT_MEMORY_LIMIT,
-        };
+        let non_memcache = CacheOptions::new(
+            TempDir::new().unwrap().into_path(),
+            capabilities_from_csv("iterator,staking"),
+            Size(0),
+            DEFAULT_MEMORY_LIMIT,
+        );
         let cache: Cache<MockApi, MockStorage, MockQuerier> =
             unsafe { Cache::new(non_memcache).unwrap() };
         let checksum = cache.save_wasm(CONTRACT).unwrap();
@@ -196,12 +196,12 @@ fn bench_cache(c: &mut Criterion) {
     });
 
     group.bench_function("instantiate from fs unchecked", |b| {
-        let non_memcache = CacheOptions {
-            base_dir: TempDir::new().unwrap().into_path(),
-            available_capabilities: capabilities_from_csv("iterator,staking"),
-            memory_cache_size: Size(0),
-            instance_memory_limit: DEFAULT_MEMORY_LIMIT,
-        };
+        let non_memcache = CacheOptions::new(
+            TempDir::new().unwrap().into_path(),
+            capabilities_from_csv("iterator,staking"),
+            Size(0),
+            DEFAULT_MEMORY_LIMIT,
+        );
         let mut cache: Cache<MockApi, MockStorage, MockQuerier> =
             unsafe { Cache::new(non_memcache).unwrap() };
         cache.set_module_unchecked(true);
@@ -263,12 +263,12 @@ fn bench_cache(c: &mut Criterion) {
 
 pub fn bench_instance_threads(c: &mut Criterion) {
     c.bench_function("multi-threaded get_instance", |b| {
-        let options = CacheOptions {
-            base_dir: TempDir::new().unwrap().into_path(),
-            available_capabilities: capabilities_from_csv("iterator,staking"),
-            memory_cache_size: MEMORY_CACHE_SIZE,
-            instance_memory_limit: DEFAULT_MEMORY_LIMIT,
-        };
+        let options = CacheOptions::new(
+            TempDir::new().unwrap().into_path(),
+            capabilities_from_csv("iterator,staking"),
+            MEMORY_CACHE_SIZE,
+            DEFAULT_MEMORY_LIMIT,
+        );
 
         let cache: Cache<MockApi, MockStorage, MockQuerier> =
             unsafe { Cache::new(options).unwrap() };

diff --git a/packages/vm/examples/multi_threaded_cache.rs b/packages/vm/examples/multi_threaded_cache.rs
@@ -26,12 +26,12 @@ const INSTANTIATION_THREADS: usize = 2048;
 const THREADS: usize = SAVE_WASM_THREADS + INSTANTIATION_THREADS;
 
 pub fn main() {
-    let options = CacheOptions {
-        base_dir: TempDir::new().unwrap().into_path(),
-        available_capabilities: capabilities_from_csv("iterator,staking"),
-        memory_cache_size: MEMORY_CACHE_SIZE,
-        instance_memory_limit: DEFAULT_MEMORY_LIMIT,
-    };
+    let options = CacheOptions::new(
+        TempDir::new().unwrap().into_path(),
+        capabilities_from_csv("iterator,staking"),
+        MEMORY_CACHE_SIZE,
+        DEFAULT_MEMORY_LIMIT,
+    );
 
     let cache: Cache<MockApi, MockStorage, MockQuerier> = unsafe { Cache::new(options).unwrap() };
     let cache = Arc::new(cache);

diff --git a/packages/vm/src/cache.rs b/packages/vm/src/cache.rs
@@ -52,6 +52,7 @@ pub struct Metrics {
 }
 
 #[derive(Clone, Debug)]
+#[non_exhaustive]
 pub struct CacheOptions {
     /// The base directory of this cache.
     ///
@@ -65,6 +66,22 @@ pub struct CacheOptions {
     pub instance_memory_limit: Size,
 }
 
+impl CacheOptions {
+    pub fn new(
+        base_dir: impl Into<PathBuf>,
+        available_capabilities: impl Into<HashSet<String>>,
+        memory_cache_size: Size,
+        instance_memory_limit: Size,
+    ) -> Self {
+        Self {
+            base_dir: base_dir.into(),
+            available_capabilities: available_capabilities.into(),
+            memory_cache_size,
+            instance_memory_limit,
+        }
+    }
+}
+
 pub struct CacheInner {
     /// The directory in which the Wasm blobs are stored in the file system.
     wasm_path: PathBuf,