simulator: Add benchmarks for opendc-simulator-compute

This change adds benchmarks to the opendc-simulator-compute module in
order to quantify effect of changes on the performance of this module.

3 files changed, 190 insertions, 1 deletions

diff --git a/simulator/opendc-simulator/opendc-simulator-compute/build.gradle.kts b/simulator/opendc-simulator/opendc-simulator-compute/build.gradle.kts
index 0005928f..149c0ed2 100644
--- a/simulator/opendc-simulator/opendc-simulator-compute/build.gradle.kts
+++ b/simulator/opendc-simulator/opendc-simulator-compute/build.gradle.kts
@@ -20,12 +20,13 @@
  * SOFTWARE.
  */
 
-description = "Library for simulation of cloud computing components"
+description = "Library for simulating computing workloads"
 
 plugins {
     `kotlin-library-conventions`
     `testing-conventions`
     `jacoco-conventions`
+    `benchmark-conventions`
 }
 
 dependencies {
diff --git a/simulator/opendc-simulator/opendc-simulator-compute/src/jmh/kotlin/org/opendc/simulator/compute/BenchmarkHelpers.kt b/simulator/opendc-simulator/opendc-simulator-compute/src/jmh/kotlin/org/opendc/simulator/compute/BenchmarkHelpers.kt
new file mode 100644
index 00000000..43bbfd0b
--- /dev/null
+++ b/simulator/opendc-simulator/opendc-simulator-compute/src/jmh/kotlin/org/opendc/simulator/compute/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.compute
+
+import org.opendc.simulator.compute.workload.SimTraceWorkload
+
+/**
+ * Helper function to create simple consumer workload.
+ */
+fun createSimpleConsumer(): SimTraceWorkload {
+    return SimTraceWorkload(
+        sequenceOf(
+            SimTraceWorkload.Fragment(1000, 28.0, 1),
+            SimTraceWorkload.Fragment(1000, 3500.0, 1),
+            SimTraceWorkload.Fragment(1000, 0.0, 1),
+            SimTraceWorkload.Fragment(1000, 183.0, 1),
+            SimTraceWorkload.Fragment(1000, 400.0, 1),
+            SimTraceWorkload.Fragment(1000, 100.0, 1),
+            SimTraceWorkload.Fragment(1000, 3000.0, 1),
+            SimTraceWorkload.Fragment(1000, 4500.0, 1),
+        ),
+    )
+}
diff --git a/simulator/opendc-simulator/opendc-simulator-compute/src/jmh/kotlin/org/opendc/simulator/compute/SimMachineBenchmarks.kt b/simulator/opendc-simulator/opendc-simulator-compute/src/jmh/kotlin/org/opendc/simulator/compute/SimMachineBenchmarks.kt
new file mode 100644
index 00000000..eb22c855
--- /dev/null
+++ b/simulator/opendc-simulator/opendc-simulator-compute/src/jmh/kotlin/org/opendc/simulator/compute/SimMachineBenchmarks.kt
@@ -0,0 +1,145 @@
+/*
+ * 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.compute
+
+import kotlinx.coroutines.ExperimentalCoroutinesApi
+import kotlinx.coroutines.coroutineScope
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.test.TestCoroutineScope
+import kotlinx.coroutines.test.runBlockingTest
+import org.opendc.simulator.compute.model.MemoryUnit
+import org.opendc.simulator.compute.model.ProcessingNode
+import org.opendc.simulator.compute.model.ProcessingUnit
+import org.opendc.simulator.compute.workload.SimWorkload
+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 SimMachineBenchmarks {
+    private lateinit var scope: TestCoroutineScope
+    private lateinit var clock: Clock
+    private lateinit var scheduler: TimerScheduler<Any>
+    private lateinit var machineModel: SimMachineModel
+
+    @Setup
+    fun setUp() {
+        scope = TestCoroutineScope()
+        clock = DelayControllerClockAdapter(scope)
+        scheduler = TimerScheduler(scope.coroutineContext, clock)
+
+        val cpuNode = ProcessingNode("Intel", "Xeon", "amd64", 2)
+
+        machineModel = SimMachineModel(
+            cpus = List(cpuNode.coreCount) { ProcessingUnit(cpuNode, it, 1000.0) },
+            memory = List(4) { MemoryUnit("Crucial", "MTA18ASF4G72AZ-3G2B1", 3200.0, 32_000) }
+        )
+    }
+
+    @State(Scope.Thread)
+    class Workload {
+        lateinit var workloads: Array<SimWorkload>
+
+        @Setup
+        fun setUp() {
+            workloads = Array(2) { createSimpleConsumer() }
+        }
+    }
+
+    @Benchmark
+    fun benchmarkBareMetal(state: Workload) {
+        return scope.runBlockingTest {
+            val machine = SimBareMetalMachine(scope.coroutineContext, clock, machineModel)
+            return@runBlockingTest machine.run(state.workloads[0])
+        }
+    }
+
+    @Benchmark
+    fun benchmarkSpaceSharedHypervisor(state: Workload) {
+        return scope.runBlockingTest {
+            val machine = SimBareMetalMachine(coroutineContext, clock, machineModel)
+            val hypervisor = SimSpaceSharedHypervisor()
+
+            launch { machine.run(hypervisor) }
+
+            val vm = hypervisor.createMachine(machineModel)
+
+            try {
+                return@runBlockingTest vm.run(state.workloads[0])
+            } finally {
+                vm.close()
+                machine.close()
+            }
+        }
+    }
+
+    @Benchmark
+    fun benchmarkFairShareHypervisorSingle(state: Workload) {
+        return scope.runBlockingTest {
+            val machine = SimBareMetalMachine(coroutineContext, clock, machineModel)
+            val hypervisor = SimFairShareHypervisor()
+
+            launch { machine.run(hypervisor) }
+
+            val vm = hypervisor.createMachine(machineModel)
+
+            try {
+                return@runBlockingTest vm.run(state.workloads[0])
+            } finally {
+                vm.close()
+                machine.close()
+            }
+        }
+    }
+
+    @Benchmark
+    fun benchmarkFairShareHypervisorDouble(state: Workload) {
+        return scope.runBlockingTest {
+            val machine = SimBareMetalMachine(coroutineContext, clock, machineModel)
+            val hypervisor = SimFairShareHypervisor()
+
+            launch { machine.run(hypervisor) }
+
+            coroutineScope {
+                repeat(2) { i ->
+                    val vm = hypervisor.createMachine(machineModel)
+
+                    launch {
+                        try {
+                            vm.run(state.workloads[i])
+                        } finally {
+                            machine.close()
+                        }
+                    }
+                }
+            }
+            machine.close()
+        }
+    }
+}