refactor: Replace use of CoroutineContext by Dispatcher

This change replaces the use of `CoroutineContext` for passing the
`SimulationDispatcher` across the different modules of OpenDC by the
lightweight `Dispatcher` interface of the OpenDC common module.

6 files changed, 32 insertions, 37 deletions

diff --git a/opendc-simulator/opendc-simulator-flow/src/jmh/kotlin/org/opendc/simulator/flow2/FlowBenchmarks.kt b/opendc-simulator/opendc-simulator-flow/src/jmh/kotlin/org/opendc/simulator/flow2/FlowBenchmarks.kt
index 5a67c7d2..59dd3bad 100644
--- a/opendc-simulator/opendc-simulator-flow/src/jmh/kotlin/org/opendc/simulator/flow2/FlowBenchmarks.kt
+++ b/opendc-simulator/opendc-simulator-flow/src/jmh/kotlin/org/opendc/simulator/flow2/FlowBenchmarks.kt
@@ -60,7 +60,7 @@ class FlowBenchmarks {
     @Benchmark
     fun benchmarkSink() {
         return runSimulation {
-            val engine = FlowEngine.create(coroutineContext, timeSource)
+            val engine = FlowEngine.create(dispatcher)
             val graph = engine.newGraph()
             val sink = SimpleFlowSink(graph, 4200.0f)
             val source = TraceFlowSource(graph, trace)
@@ -71,7 +71,7 @@ class FlowBenchmarks {
     @Benchmark
     fun benchmarkForward() {
         return runSimulation {
-            val engine = FlowEngine.create(coroutineContext, timeSource)
+            val engine = FlowEngine.create(dispatcher)
             val graph = engine.newGraph()
             val sink = SimpleFlowSink(graph, 4200.0f)
             val source = TraceFlowSource(graph, trace)
@@ -85,7 +85,7 @@ class FlowBenchmarks {
     @Benchmark
     fun benchmarkMuxMaxMinSingleSource() {
         return runSimulation {
-            val engine = FlowEngine.create(coroutineContext, timeSource)
+            val engine = FlowEngine.create(dispatcher)
             val graph = engine.newGraph()
             val switch = MaxMinFlowMultiplexer(graph)
 
@@ -103,7 +103,7 @@ class FlowBenchmarks {
     @Benchmark
     fun benchmarkMuxMaxMinTripleSource() {
         return runSimulation {
-            val engine = FlowEngine.create(coroutineContext, timeSource)
+            val engine = FlowEngine.create(dispatcher)
             val graph = engine.newGraph()
             val switch = MaxMinFlowMultiplexer(graph)
 
diff --git a/opendc-simulator/opendc-simulator-flow/src/main/java/org/opendc/simulator/flow2/FlowEngine.java b/opendc-simulator/opendc-simulator-flow/src/main/java/org/opendc/simulator/flow2/FlowEngine.java
index cfa5a48f..c0f52505 100644
--- a/opendc-simulator/opendc-simulator-flow/src/main/java/org/opendc/simulator/flow2/FlowEngine.java
+++ b/opendc-simulator/opendc-simulator-flow/src/main/java/org/opendc/simulator/flow2/FlowEngine.java
@@ -26,9 +26,8 @@ import java.time.Clock;
 import java.time.InstantSource;
 import java.util.ArrayList;
 import java.util.List;
-import kotlin.coroutines.ContinuationInterceptor;
 import kotlin.coroutines.CoroutineContext;
-import kotlinx.coroutines.Delay;
+import org.opendc.common.Dispatcher;
 
 /**
  * A {@link FlowEngine} simulates a generic flow network.
@@ -57,23 +56,19 @@ public final class FlowEngine implements Runnable {
      */
     private boolean active;
 
-    private final CoroutineContext coroutineContext;
+    private final Dispatcher dispatcher;
     private final InstantSource clock;
-    private final Delay delay;
 
     /**
      * Create a new {@link FlowEngine} instance using the specified {@link CoroutineContext} and {@link InstantSource}.
      */
-    public static FlowEngine create(CoroutineContext coroutineContext, InstantSource clock) {
-        return new FlowEngine(coroutineContext, clock);
+    public static FlowEngine create(Dispatcher dispatcher) {
+        return new FlowEngine(dispatcher);
     }
 
-    FlowEngine(CoroutineContext coroutineContext, InstantSource clock) {
-        this.coroutineContext = coroutineContext;
-        this.clock = clock;
-
-        CoroutineContext.Key<? extends ContinuationInterceptor> key = ContinuationInterceptor.Key;
-        this.delay = (Delay) coroutineContext.get(key);
+    FlowEngine(Dispatcher dispatcher) {
+        this.dispatcher = dispatcher;
+        this.clock = dispatcher.getTimeSource();
     }
 
     /**
@@ -205,7 +200,7 @@ public final class FlowEngine implements Runnable {
         // Only schedule a new scheduler invocation in case the target is earlier than all other pending
         // scheduler invocations
         if (scheduled.tryAdd(target)) {
-            delay.invokeOnTimeout(target - now, this, coroutineContext);
+            dispatcher.schedule(target - now, this);
         }
     }
 
diff --git a/opendc-simulator/opendc-simulator-flow/src/test/kotlin/org/opendc/simulator/flow2/FlowEngineTest.kt b/opendc-simulator/opendc-simulator-flow/src/test/kotlin/org/opendc/simulator/flow2/FlowEngineTest.kt
index b5054375..467bf334 100644
--- a/opendc-simulator/opendc-simulator-flow/src/test/kotlin/org/opendc/simulator/flow2/FlowEngineTest.kt
+++ b/opendc-simulator/opendc-simulator-flow/src/test/kotlin/org/opendc/simulator/flow2/FlowEngineTest.kt
@@ -38,7 +38,7 @@ import org.opendc.simulator.kotlin.runSimulation
 class FlowEngineTest {
     @Test
     fun testSmoke() = runSimulation {
-        val engine = FlowEngine.create(coroutineContext, timeSource)
+        val engine = FlowEngine.create(dispatcher)
         val graph = engine.newGraph()
 
         val multiplexer = MaxMinFlowMultiplexer(graph)
@@ -55,7 +55,7 @@ class FlowEngineTest {
 
     @Test
     fun testConnectInvalidInlet() = runSimulation {
-        val engine = FlowEngine.create(coroutineContext, timeSource)
+        val engine = FlowEngine.create(dispatcher)
         val graph = engine.newGraph()
 
         val inlet = mockk<Inlet>()
@@ -65,7 +65,7 @@ class FlowEngineTest {
 
     @Test
     fun testConnectInvalidOutlet() = runSimulation {
-        val engine = FlowEngine.create(coroutineContext, timeSource)
+        val engine = FlowEngine.create(dispatcher)
         val graph = engine.newGraph()
 
         val outlet = mockk<Outlet>()
@@ -75,7 +75,7 @@ class FlowEngineTest {
 
     @Test
     fun testConnectInletBelongsToDifferentGraph() = runSimulation {
-        val engine = FlowEngine.create(coroutineContext, timeSource)
+        val engine = FlowEngine.create(dispatcher)
         val graphA = engine.newGraph()
         val graphB = engine.newGraph()
 
@@ -87,7 +87,7 @@ class FlowEngineTest {
 
     @Test
     fun testConnectOutletBelongsToDifferentGraph() = runSimulation {
-        val engine = FlowEngine.create(coroutineContext, timeSource)
+        val engine = FlowEngine.create(dispatcher)
         val graphA = engine.newGraph()
         val graphB = engine.newGraph()
 
@@ -99,7 +99,7 @@ class FlowEngineTest {
 
     @Test
     fun testConnectInletAlreadyConnected() = runSimulation {
-        val engine = FlowEngine.create(coroutineContext, timeSource)
+        val engine = FlowEngine.create(dispatcher)
         val graph = engine.newGraph()
 
         val sink = SimpleFlowSink(graph, 2.0f)
@@ -112,7 +112,7 @@ class FlowEngineTest {
 
     @Test
     fun testConnectOutletAlreadyConnected() = runSimulation {
-        val engine = FlowEngine.create(coroutineContext, timeSource)
+        val engine = FlowEngine.create(dispatcher)
         val graph = engine.newGraph()
 
         val sinkA = SimpleFlowSink(graph, 2.0f)
@@ -125,7 +125,7 @@ class FlowEngineTest {
 
     @Test
     fun testDisconnectInletInvalid() = runSimulation {
-        val engine = FlowEngine.create(coroutineContext, timeSource)
+        val engine = FlowEngine.create(dispatcher)
         val graph = engine.newGraph()
 
         val inlet = mockk<Inlet>()
@@ -134,7 +134,7 @@ class FlowEngineTest {
 
     @Test
     fun testDisconnectOutletInvalid() = runSimulation {
-        val engine = FlowEngine.create(coroutineContext, timeSource)
+        val engine = FlowEngine.create(dispatcher)
         val graph = engine.newGraph()
 
         val outlet = mockk<Outlet>()
@@ -143,7 +143,7 @@ class FlowEngineTest {
 
     @Test
     fun testDisconnectInletInvalidGraph() = runSimulation {
-        val engine = FlowEngine.create(coroutineContext, timeSource)
+        val engine = FlowEngine.create(dispatcher)
         val graphA = engine.newGraph()
         val graphB = engine.newGraph()
 
@@ -154,7 +154,7 @@ class FlowEngineTest {
 
     @Test
     fun testDisconnectOutletInvalidGraph() = runSimulation {
-        val engine = FlowEngine.create(coroutineContext, timeSource)
+        val engine = FlowEngine.create(dispatcher)
         val graphA = engine.newGraph()
         val graphB = engine.newGraph()
 
@@ -165,7 +165,7 @@ class FlowEngineTest {
 
     @Test
     fun testInletEquality() = runSimulation {
-        val engine = FlowEngine.create(coroutineContext, timeSource)
+        val engine = FlowEngine.create(dispatcher)
         val graph = engine.newGraph()
 
         val sinkA = SimpleFlowSink(graph, 2.0f)
@@ -181,7 +181,7 @@ class FlowEngineTest {
 
     @Test
     fun testOutletEquality() = runSimulation {
-        val engine = FlowEngine.create(coroutineContext, timeSource)
+        val engine = FlowEngine.create(dispatcher)
         val graph = engine.newGraph()
 
         val sourceA = SimpleFlowSource(graph, 2000.0f, 0.8f)
diff --git a/opendc-simulator/opendc-simulator-flow/src/test/kotlin/org/opendc/simulator/flow2/mux/ForwardingFlowMultiplexerTest.kt b/opendc-simulator/opendc-simulator-flow/src/test/kotlin/org/opendc/simulator/flow2/mux/ForwardingFlowMultiplexerTest.kt
index d7a2190f..fef49786 100644
--- a/opendc-simulator/opendc-simulator-flow/src/test/kotlin/org/opendc/simulator/flow2/mux/ForwardingFlowMultiplexerTest.kt
+++ b/opendc-simulator/opendc-simulator-flow/src/test/kotlin/org/opendc/simulator/flow2/mux/ForwardingFlowMultiplexerTest.kt
@@ -39,7 +39,7 @@ class ForwardingFlowMultiplexerTest {
      */
     @Test
     fun testTrace() = runSimulation {
-        val engine = FlowEngine.create(coroutineContext, timeSource)
+        val engine = FlowEngine.create(dispatcher)
         val graph = engine.newGraph()
 
         val switch = ForwardingFlowMultiplexer(graph)
diff --git a/opendc-simulator/opendc-simulator-flow/src/test/kotlin/org/opendc/simulator/flow2/mux/MaxMinFlowMultiplexerTest.kt b/opendc-simulator/opendc-simulator-flow/src/test/kotlin/org/opendc/simulator/flow2/mux/MaxMinFlowMultiplexerTest.kt
index 635b1d98..ebae2d4e 100644
--- a/opendc-simulator/opendc-simulator-flow/src/test/kotlin/org/opendc/simulator/flow2/mux/MaxMinFlowMultiplexerTest.kt
+++ b/opendc-simulator/opendc-simulator-flow/src/test/kotlin/org/opendc/simulator/flow2/mux/MaxMinFlowMultiplexerTest.kt
@@ -35,7 +35,7 @@ import org.opendc.simulator.kotlin.runSimulation
 class MaxMinFlowMultiplexerTest {
     @Test
     fun testSmoke() = runSimulation {
-        val engine = FlowEngine.create(coroutineContext, timeSource)
+        val engine = FlowEngine.create(dispatcher)
         val graph = engine.newGraph()
         val switch = MaxMinFlowMultiplexer(graph)
 
diff --git a/opendc-simulator/opendc-simulator-flow/src/test/kotlin/org/opendc/simulator/flow2/sink/FlowSinkTest.kt b/opendc-simulator/opendc-simulator-flow/src/test/kotlin/org/opendc/simulator/flow2/sink/FlowSinkTest.kt
index d50a40b0..ea516c63 100644
--- a/opendc-simulator/opendc-simulator-flow/src/test/kotlin/org/opendc/simulator/flow2/sink/FlowSinkTest.kt
+++ b/opendc-simulator/opendc-simulator-flow/src/test/kotlin/org/opendc/simulator/flow2/sink/FlowSinkTest.kt
@@ -37,7 +37,7 @@ import java.util.concurrent.ThreadLocalRandom
 class FlowSinkTest {
     @Test
     fun testSmoke() = runSimulation {
-        val engine = FlowEngine.create(coroutineContext, timeSource)
+        val engine = FlowEngine.create(dispatcher)
         val graph = engine.newGraph()
 
         val sink = SimpleFlowSink(graph, 1.0f)
@@ -51,7 +51,7 @@ class FlowSinkTest {
 
     @Test
     fun testAdjustCapacity() = runSimulation {
-        val engine = FlowEngine.create(coroutineContext, timeSource)
+        val engine = FlowEngine.create(dispatcher)
         val graph = engine.newGraph()
 
         val sink = SimpleFlowSink(graph, 1.0f)
@@ -69,7 +69,7 @@ class FlowSinkTest {
 
     @Test
     fun testUtilization() = runSimulation {
-        val engine = FlowEngine.create(coroutineContext, timeSource)
+        val engine = FlowEngine.create(dispatcher)
         val graph = engine.newGraph()
 
         val sink = SimpleFlowSink(graph, 1.0f)
@@ -83,7 +83,7 @@ class FlowSinkTest {
 
     @Test
     fun testFragments() = runSimulation {
-        val engine = FlowEngine.create(coroutineContext, timeSource)
+        val engine = FlowEngine.create(dispatcher)
         val graph = engine.newGraph()
 
         val sink = SimpleFlowSink(graph, 1.0f)
@@ -114,7 +114,7 @@ class FlowSinkTest {
         )
 
         return runSimulation {
-            val engine = FlowEngine.create(coroutineContext, timeSource)
+            val engine = FlowEngine.create(dispatcher)
             val graph = engine.newGraph()
             val sink = SimpleFlowSink(graph, 4200.0f)
             val source = TraceFlowSource(graph, trace)