Add Engine interface for read_all_available and write_all_available

Author: jbaublitz

src/engine/engine.rs

@@ -19,7 +19,10 @@ use devicemapper::{Bytes, Sectors};
 
 use crate::{
     engine::{
-        structures::{AllLockReadGuard, AllLockWriteGuard, SomeLockReadGuard, SomeLockWriteGuard},
+        structures::{
+            AllLockReadAvailableGuard, AllLockReadGuard, AllLockWriteAvailableGuard,
+            AllLockWriteGuard, SomeLockReadGuard, SomeLockWriteGuard,
+        },
         types::{
             ActionAvailability, BlockDevTier, Clevis, CreateAction, DeleteAction, DevUuid,
             EncryptionInfo, FilesystemUuid, GrowAction, InputEncryptionInfo, IntegritySpec, Key,
@@ -506,9 +509,17 @@ pub trait Engine: Debug + Report + Send + Sync {
     /// Get all pools belonging to this engine.
     async fn pools(&self) -> AllLockReadGuard<PoolUuid, dyn Pool>;
 
+    /// Get all pools belonging to this engine that are currently available and will not block on
+    /// locking.
+    async fn available_pools(&self) -> Option<AllLockReadAvailableGuard<PoolUuid, dyn Pool>>;
+
     /// Get mutable references to all pools belonging to this engine.
     async fn pools_mut(&self) -> AllLockWriteGuard<PoolUuid, dyn Pool>;
 
+    /// Get mutable references to all pools belonging to this engine that are currently available
+    /// and will not block on locking.
+    async fn available_pools_mut(&self) -> Option<AllLockWriteAvailableGuard<PoolUuid, dyn Pool>>;
+
     /// Get the UUIDs of all pools that experienced an event.
     async fn get_events(&self) -> StratisResult<HashSet<PoolUuid>>;
 

src/engine/sim_engine/engine.rs

@@ -20,8 +20,9 @@ use crate::{
         shared::{create_pool_idempotent_or_err, validate_name, validate_paths},
         sim_engine::{keys::SimKeyActions, pool::SimPool},
         structures::{
-            AllLockReadGuard, AllLockWriteGuard, AllOrSomeLock, Lockable, SomeLockReadGuard,
-            SomeLockWriteGuard, Table,
+            AllLockReadAvailableGuard, AllLockReadGuard, AllLockWriteAvailableGuard,
+            AllLockWriteGuard, AllOrSomeLock, Lockable, SomeLockReadGuard, SomeLockWriteGuard,
+            Table,
         },
         types::{
             CreateAction, DeleteAction, DevUuid, EncryptionInfo, Features, FilesystemUuid,
@@ -301,10 +302,18 @@ impl Engine for SimEngine {
         self.pools.read_all().await.into_dyn()
     }
 
+    async fn available_pools(&self) -> Option<AllLockReadAvailableGuard<PoolUuid, dyn Pool>> {
+        self.pools.read_all_available().await.map(|l| l.into_dyn())
+    }
+
     async fn pools_mut(&self) -> AllLockWriteGuard<PoolUuid, dyn Pool> {
         self.pools.write_all().await.into_dyn()
     }
 
+    async fn available_pools_mut(&self) -> Option<AllLockWriteAvailableGuard<PoolUuid, dyn Pool>> {
+        self.pools.write_all_available().await.map(|l| l.into_dyn())
+    }
+
     async fn get_events(&self) -> StratisResult<HashSet<PoolUuid>> {
         Ok(HashSet::new())
     }

src/engine/strat_engine/engine.rs

@@ -34,8 +34,9 @@ use crate::{
             pool::{v1, v2, AnyPool},
         },
         structures::{
-            AllLockReadGuard, AllLockWriteGuard, AllOrSomeLock, Lockable, SomeLockReadGuard,
-            SomeLockWriteGuard, Table,
+            AllLockReadAvailableGuard, AllLockReadGuard, AllLockWriteAvailableGuard,
+            AllLockWriteGuard, AllOrSomeLock, Lockable, SomeLockReadGuard, SomeLockWriteGuard,
+            Table,
         },
         types::{
             CreateAction, DeleteAction, DevUuid, FilesystemUuid, InputEncryptionInfo,
@@ -202,10 +203,20 @@ impl StratEngine {
         self.pools.read_all().await
     }
 
+    pub async fn available_pools(&self) -> Option<AllLockReadAvailableGuard<PoolUuid, AnyPool>> {
+        self.pools.read_all_available().await
+    }
+
     pub async fn pools_mut(&self) -> AllLockWriteGuard<PoolUuid, AnyPool> {
         self.pools.write_all().await
     }
 
+    pub async fn available_pools_mut(
+        &self,
+    ) -> Option<AllLockWriteAvailableGuard<PoolUuid, AnyPool>> {
+        self.pools.write_all_available().await
+    }
+
     fn spawn_pool_check_handling(
         joins: &mut PoolJoinHandles,
         mut guard: SomeLockWriteGuard<PoolUuid, AnyPool>,
@@ -720,10 +731,18 @@ impl Engine for StratEngine {
         self.pools().await.into_dyn()
     }
 
+    async fn available_pools(&self) -> Option<AllLockReadAvailableGuard<PoolUuid, dyn Pool>> {
+        self.available_pools().await.map(|l| l.into_dyn())
+    }
+
     async fn pools_mut(&self) -> AllLockWriteGuard<PoolUuid, dyn Pool> {
         self.pools_mut().await.into_dyn()
     }
 
+    async fn available_pools_mut(&self) -> Option<AllLockWriteAvailableGuard<PoolUuid, dyn Pool>> {
+        self.available_pools_mut().await.map(|l| l.into_dyn())
+    }
+
     async fn get_events(&self) -> StratisResult<HashSet<PoolUuid>> {
         let device_list: HashMap<_, _> = get_dm()
             .list_devices()?

src/engine/structures/mod.rs

@@ -7,8 +7,9 @@ mod table;
 
 pub use self::{
     lock::{
-        AllLockReadGuard, AllLockWriteGuard, AllOrSomeLock, ExclusiveGuard, Lockable, SharedGuard,
-        SomeLockReadGuard, SomeLockWriteGuard,
+        AllLockReadAvailableGuard, AllLockReadGuard, AllLockWriteAvailableGuard, AllLockWriteGuard,
+        AllOrSomeLock, ExclusiveGuard, Lockable, SharedGuard, SomeLockReadGuard,
+        SomeLockWriteGuard,
     },
     table::Table,
 };