Integrate threads partitioning with rustcoalescence

README.md

@@ -113,6 +113,7 @@ necsim-rust consists of the following crates:
         - core/: `necsim-partitioning-core` declares the core partitioning traits
         - monolithic/: `necsim-partitioning-monolithic` implements monolithic, i.e. non-parallel partitioning
         - mpi/: `necsim-partitioning-mpi` implements the MPI-based partitioning backend
+        - threads/: `necsim-partitioning-threads` implements the multithreading partitioning backend
 - rustcoalescence/: `rustcoalescence` provides the command-line interface.
     - scenarios/: `rustcoalescence-scenarios` contains the glue code to put together the cogs for the built-in scenarios. It is specifically built only for reducing code duplication in rustcoalescence, not for giving a minimal example of how to construct a simulation.
     - algorithms/:

docs/simulate.ron

@@ -676,6 +676,19 @@
              * optional, default = "100ms" */
             progress: (DurationString),
         )
+        /* the simulation is divided up across multiple threads
+         * multi-threaded, single-process
+         * requires the `threads-partitioning` feature */
+      | Threads(
+            /* number of threads to distribute the simulation across */
+            threads: (1 < u32),
+            /* minimum time interval between migration messages
+             * optional, default = "100ms" */
+            migration: (DurationString),
+            /* minimum time interval between progress messages
+             * optional, default = "100ms" */
+            progress: (DurationString),
+        )
     ),
 
     /* selection of the event persistence strategy

rustcoalescence/Cargo.toml

@@ -56,6 +56,12 @@ all-scenarios = [
 ]
 
 mpi-partitioning = ["dep:necsim-partitioning-mpi"]
+threads-partitioning = ["dep:necsim-partitioning-threads"]
+
+all-partitioning = [
+    "mpi-partitioning",
+    "threads-partitioning",
+]
 
 [dependencies]
 necsim-core = { path = "../necsim/core" }
@@ -70,6 +76,7 @@ rustcoalescence-scenarios = { path = "scenarios" }
 rustcoalescence-algorithms = { path = "algorithms" }
 
 necsim-partitioning-mpi = { path = "../necsim/partitioning/mpi", optional = true }
+necsim-partitioning-threads = { path = "../necsim/partitioning/threads", optional = true }
 
 rustcoalescence-algorithms-gillespie = { path = "algorithms/gillespie", optional = true }
 rustcoalescence-algorithms-independent = { path = "algorithms/independent", optional = true }

rustcoalescence/src/args/config/partitioning.rs

@@ -5,42 +5,43 @@ use necsim_partitioning_core::partition::PartitionSize;
 #[derive(Debug, Serialize, Deserialize)]
 pub enum Partitioning {
     Monolithic(necsim_partitioning_monolithic::MonolithicPartitioning),
-    #[cfg(feature = "necsim-partitioning-mpi")]
+    #[cfg(feature = "mpi-partitioning")]
     #[serde(alias = "MPI")]
     Mpi(necsim_partitioning_mpi::MpiPartitioning),
+    #[cfg(feature = "threads-partitioning")]
+    Threads(necsim_partitioning_threads::ThreadsPartitioning),
 }
 
 impl Partitioning {
-    // pub fn is_root(&self) -> bool {
-    //     use necsim_partitioning_core::Partitioning;
-
-    //     match self {
-    //         Self::Monolithic(partitioning) => partitioning.is_root(),
-    //         #[cfg(feature = "necsim-partitioning-mpi")]
-    //         Self::Mpi(partitioning) => partitioning.is_root(),
-    //     }
-    // }
-
     pub fn get_size(&self) -> PartitionSize {
         use necsim_partitioning_core::Partitioning;
 
         match self {
             Self::Monolithic(partitioning) => partitioning.get_size(),
-            #[cfg(feature = "necsim-partitioning-mpi")]
+            #[cfg(feature = "mpi-partitioning")]
             Self::Mpi(partitioning) => partitioning.get_size(),
+            #[cfg(feature = "threads-partitioning")]
+            Self::Threads(partitioning) => partitioning.get_size(),
         }
     }
 
     pub fn get_event_log_check(&self) -> (anyhow::Result<()>, anyhow::Result<()>) {
         match self {
             Self::Monolithic(_) => (Ok(()), Ok(())),
-            #[cfg(feature = "necsim-partitioning-mpi")]
+            #[cfg(feature = "mpi-partitioning")]
             Self::Mpi(_) => (
                 Err(anyhow::anyhow!(
                     necsim_partitioning_mpi::MpiLocalPartitionError::MissingEventLog
                 )),
                 Ok(()),
             ),
+            #[cfg(feature = "threads-partitioning")]
+            Self::Threads(_) => (
+                Err(anyhow::anyhow!(
+                    necsim_partitioning_mpi::MpiLocalPartitionError::MissingEventLog
+                )),
+                Ok(()),
+            ),
         }
     }
 }

rustcoalescence/src/cli/simulate/dispatch/valid/partitioning.rs

@@ -7,7 +7,7 @@ use necsim_impls_std::event_log::recorder::EventLogRecorder;
 use necsim_partitioning_core::{context::ReporterContext, LocalPartition, Partitioning as _};
 
 use necsim_partitioning_monolithic::MonolithicLocalPartition;
-#[cfg(feature = "necsim-partitioning-mpi")]
+#[cfg(feature = "mpi-partitioning")]
 use necsim_partitioning_mpi::MpiLocalPartition;
 use rustcoalescence_algorithms::{result::SimulationOutcome, Algorithm, AlgorithmDispatch};
 use rustcoalescence_scenarios::Scenario;
@@ -83,7 +83,7 @@ where
             },
             fold,
         ),
-        #[cfg(feature = "necsim-partitioning-mpi")]
+        #[cfg(feature = "mpi-partitioning")]
         Partitioning::Mpi(partitioning) => partitioning.with_local_partition(
             reporter_context,
             event_log,
@@ -116,6 +116,24 @@ where
             },
             fold,
         ),
+        #[cfg(feature = "threads-partitioning")]
+        Partitioning::Threads(partitioning) => partitioning.with_local_partition(
+            reporter_context,
+            event_log,
+            args,
+            |partition, (sample, rng, scenario, algorithm_args, pause_before, normalised_args)| {
+                wrap::<M, G, A::Algorithm<'_, _>, O, R, _>(
+                    partition,
+                    sample,
+                    rng,
+                    scenario,
+                    algorithm_args,
+                    pause_before,
+                    normalised_args,
+                )
+            },
+            fold,
+        ),
     }
     .and_then(|result| result.map_err(anyhow::Error::msg))
 }

rustcoalescence/src/cli/simulate/dispatch/valid/rng.rs

@@ -59,8 +59,12 @@ where
             Partitioning::Monolithic(partitioning) => {
                 A::get_logical_partition_size(&algorithm_args, partitioning)
             },
-            #[cfg(feature = "necsim-partitioning-mpi")]
-            Partitioning::MPI(partitioning) => {
+            #[cfg(feature = "mpi-partitioning")]
+            Partitioning::Mpi(partitioning) => {
+                A::get_logical_partition_size(&algorithm_args, partitioning)
+            },
+            #[cfg(feature = "threads-partitioning")]
+            Partitioning::Threads(partitioning) => {
                 A::get_logical_partition_size(&algorithm_args, partitioning)
             },
         },

rustcoalescence/src/cli/simulate/mod.rs

@@ -36,7 +36,7 @@ pub fn simulate_with_logger(simulate_args: CommandArgs) -> anyhow::Result<()> {
 
     let partitioning = parse::partitioning::parse_and_normalise(&ron_args, &mut normalised_args)?;
 
-    #[cfg(feature = "necsim-partitioning-mpi")]
+    #[cfg(feature = "mpi-partitioning")]
     if let crate::args::config::partitioning::Partitioning::Mpi(partitioning) = &partitioning {
         // Only log to stdout/stderr in the MPI root partition
         if !partitioning.peek_is_root() {