simulator: Add uniform resource consumption model (v2)

This is the second pull request in the series of pull requests to add a uniform resource consumption model to OpenDC. This pull request focusses on adding dynamic capacity negotiation and propagation between resource consumer and resource provider:

* The generic resource constraint is removed from the interfaces of `opendc-simulator-resources`. Users of the API are expected to use the untyped variants where only the capacity needs to be specified. Users are expected to build higher-level abstractions on top of these interface to represent actual resources (e.g., CPU, disk or network).
* Added benchmarks for the most important implementations of `opendc-simulator-resources`. This allows us to quantify the effects of changes on the runtime.
* The `SimResourceSwitchMaxMin` has been split into a `SimResourceAggregatorMaxMin` and `SimResourceDistributorMaxMin` which respectively aggregate input resources and distribute output resources using max-min fair sharing.
* The `SimResourceConsumer` interface has a new method for receiving capacity change events: `onCapacityChanged(ctx, isThrottled)`

**Breaking API Changes**

*  All interfaces in `opendc-simulator-resources`.

2 files changed, 182 insertions, 0 deletions

diff --git a/simulator/opendc-simulator/opendc-simulator-resources/src/jmh/kotlin/org/opendc/simulator/resources/BenchmarkHelpers.kt b/simulator/opendc-simulator/opendc-simulator-resources/src/jmh/kotlin/org/opendc/simulator/resources/BenchmarkHelpers.kt
new file mode 100644
index 00000000..8d2587b1
--- /dev/null
+++ b/simulator/opendc-simulator/opendc-simulator-resources/src/jmh/kotlin/org/opendc/simulator/resources/BenchmarkHelpers.kt
@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2021 AtLarge Research
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package org.opendc.simulator.resources
+
+import org.opendc.simulator.resources.consumer.SimTraceConsumer
+
+/**
+ * Helper function to create simple consumer workload.
+ */
+fun createSimpleConsumer(): SimResourceConsumer {
+    return SimTraceConsumer(
+        sequenceOf(
+            SimTraceConsumer.Fragment(1000, 28.0),
+            SimTraceConsumer.Fragment(1000, 3500.0),
+            SimTraceConsumer.Fragment(1000, 0.0),
+            SimTraceConsumer.Fragment(1000, 183.0),
+            SimTraceConsumer.Fragment(1000, 400.0),
+            SimTraceConsumer.Fragment(1000, 100.0),
+            SimTraceConsumer.Fragment(1000, 3000.0),
+            SimTraceConsumer.Fragment(1000, 4500.0),
+        ),
+    )
+}
diff --git a/simulator/opendc-simulator/opendc-simulator-resources/src/jmh/kotlin/org/opendc/simulator/resources/SimResourceBenchmarks.kt b/simulator/opendc-simulator/opendc-simulator-resources/src/jmh/kotlin/org/opendc/simulator/resources/SimResourceBenchmarks.kt
new file mode 100644
index 00000000..f2eea97c
--- /dev/null
+++ b/simulator/opendc-simulator/opendc-simulator-resources/src/jmh/kotlin/org/opendc/simulator/resources/SimResourceBenchmarks.kt
@@ -0,0 +1,139 @@
+/*
+ * Copyright (c) 2021 AtLarge Research
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package org.opendc.simulator.resources
+
+import kotlinx.coroutines.ExperimentalCoroutinesApi
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.test.TestCoroutineScope
+import kotlinx.coroutines.test.runBlockingTest
+import org.opendc.simulator.utils.DelayControllerClockAdapter
+import org.opendc.utils.TimerScheduler
+import org.openjdk.jmh.annotations.*
+import java.time.Clock
+import java.util.concurrent.TimeUnit
+
+@State(Scope.Thread)
+@Fork(1)
+@Warmup(iterations = 2, time = 1, timeUnit = TimeUnit.SECONDS)
+@Measurement(iterations = 5, time = 3, timeUnit = TimeUnit.SECONDS)
+@OptIn(ExperimentalCoroutinesApi::class)
+class SimResourceBenchmarks {
+    private lateinit var scope: TestCoroutineScope
+    private lateinit var clock: Clock
+    private lateinit var scheduler: TimerScheduler<Any>
+
+    @Setup
+    fun setUp() {
+        scope = TestCoroutineScope()
+        clock = DelayControllerClockAdapter(scope)
+        scheduler = TimerScheduler(scope.coroutineContext, clock)
+    }
+
+    @State(Scope.Thread)
+    class Workload {
+        lateinit var consumers: Array<SimResourceConsumer>
+
+        @Setup
+        fun setUp() {
+            consumers = Array(3) { createSimpleConsumer() }
+        }
+    }
+
+    @Benchmark
+    fun benchmarkSource(state: Workload) {
+        return scope.runBlockingTest {
+            val provider = SimResourceSource(4200.0, clock, scheduler)
+            return@runBlockingTest provider.consume(state.consumers[0])
+        }
+    }
+
+    @Benchmark
+    fun benchmarkForwardOverhead(state: Workload) {
+        return scope.runBlockingTest {
+            val provider = SimResourceSource(4200.0, clock, scheduler)
+            val forwarder = SimResourceForwarder()
+            provider.startConsumer(forwarder)
+            return@runBlockingTest forwarder.consume(state.consumers[0])
+        }
+    }
+
+    @Benchmark
+    fun benchmarkSwitchMaxMinSingleConsumer(state: Workload) {
+        return scope.runBlockingTest {
+            val switch = SimResourceSwitchMaxMin(clock)
+
+            switch.addInput(SimResourceSource(3000.0, clock, scheduler))
+            switch.addInput(SimResourceSource(3000.0, clock, scheduler))
+
+            val provider = switch.addOutput(3500.0)
+            return@runBlockingTest provider.consume(state.consumers[0])
+        }
+    }
+
+    @Benchmark
+    fun benchmarkSwitchMaxMinTripleConsumer(state: Workload) {
+        return scope.runBlockingTest {
+            val switch = SimResourceSwitchMaxMin(clock)
+
+            switch.addInput(SimResourceSource(3000.0, clock, scheduler))
+            switch.addInput(SimResourceSource(3000.0, clock, scheduler))
+
+            repeat(3) { i ->
+                launch {
+                    val provider = switch.addOutput(3500.0)
+                    provider.consume(state.consumers[i])
+                }
+            }
+        }
+    }
+
+    @Benchmark
+    fun benchmarkSwitchExclusiveSingleConsumer(state: Workload) {
+        return scope.runBlockingTest {
+            val switch = SimResourceSwitchExclusive()
+
+            switch.addInput(SimResourceSource(3000.0, clock, scheduler))
+            switch.addInput(SimResourceSource(3000.0, clock, scheduler))
+
+            val provider = switch.addOutput(3500.0)
+            return@runBlockingTest provider.consume(state.consumers[0])
+        }
+    }
+
+    @Benchmark
+    fun benchmarkSwitchExclusiveTripleConsumer(state: Workload) {
+        return scope.runBlockingTest {
+            val switch = SimResourceSwitchExclusive()
+
+            switch.addInput(SimResourceSource(3000.0, clock, scheduler))
+            switch.addInput(SimResourceSource(3000.0, clock, scheduler))
+
+            repeat(2) { i ->
+                launch {
+                    val provider = switch.addOutput(3500.0)
+                    provider.consume(state.consumers[i])
+                }
+            }
+        }
+    }
+}