Merge pull request #71 from atlarge-research/perf/workload

Convert to pull-based workload model

4 files changed, 350 insertions, 52 deletions

diff --git a/simulator/opendc-simulator/opendc-simulator-compute/src/test/kotlin/org/opendc/simulator/compute/SimHypervisorTest.kt b/simulator/opendc-simulator/opendc-simulator-compute/src/test/kotlin/org/opendc/simulator/compute/SimHypervisorTest.kt
index e7fdd4b2..b8eee4f0 100644
--- a/simulator/opendc-simulator/opendc-simulator-compute/src/test/kotlin/org/opendc/simulator/compute/SimHypervisorTest.kt
+++ b/simulator/opendc-simulator/opendc-simulator-compute/src/test/kotlin/org/opendc/simulator/compute/SimHypervisorTest.kt
@@ -26,7 +26,7 @@ import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.test.TestCoroutineScope
 import kotlinx.coroutines.yield
-import org.junit.jupiter.api.Assertions
+import org.junit.jupiter.api.Assertions.assertEquals
 import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.assertAll
@@ -51,7 +51,7 @@ internal class SimHypervisorTest {
         scope = TestCoroutineScope()
         clock = DelayControllerClockAdapter(scope)
 
-        val cpuNode = ProcessingNode("Intel", "Xeon", "amd64", 2)
+        val cpuNode = ProcessingNode("Intel", "Xeon", "amd64", 1)
         machineModel = SimMachineModel(
             cpus = List(cpuNode.coreCount) { ProcessingUnit(cpuNode, it, 3200.0) },
             memory = List(4) { MemoryUnit("Crucial", "MTA18ASF4G72AZ-3G2B1", 3200.0, 32_000) }
@@ -59,27 +59,27 @@ internal class SimHypervisorTest {
     }
 
     /**
-     * Test overcommissioning of a hypervisor.
+     * Test overcommitting of resources via the hypervisor with a single VM.
      */
     @Test
-    fun overcommission() {
+    fun testOvercommittedSingle() {
         val listener = object : SimHypervisor.Listener {
-            var totalRequestedBurst = 0L
-            var totalGrantedBurst = 0L
-            var totalOvercommissionedBurst = 0L
+            var totalRequestedWork = 0L
+            var totalGrantedWork = 0L
+            var totalOvercommittedWork = 0L
 
             override fun onSliceFinish(
                 hypervisor: SimHypervisor,
-                requestedBurst: Long,
-                grantedBurst: Long,
-                overcommissionedBurst: Long,
-                interferedBurst: Long,
+                requestedWork: Long,
+                grantedWork: Long,
+                overcommittedWork: Long,
+                interferedWork: Long,
                 cpuUsage: Double,
                 cpuDemand: Double
             ) {
-                totalRequestedBurst += requestedBurst
-                totalGrantedBurst += grantedBurst
-                totalOvercommissionedBurst += overcommissionedBurst
+                totalRequestedWork += requestedWork
+                totalGrantedWork += grantedWork
+                totalOvercommittedWork += overcommittedWork
             }
         }
 
@@ -88,24 +88,84 @@ internal class SimHypervisorTest {
             val workloadA =
                 SimTraceWorkload(
                     sequenceOf(
-                        SimTraceWorkload.Fragment(0, 28L * duration, duration * 1000, 28.0, 2),
-                        SimTraceWorkload.Fragment(0, 3500L * duration, duration * 1000, 3500.0, 2),
-                        SimTraceWorkload.Fragment(0, 0, duration * 1000, 0.0, 2),
-                        SimTraceWorkload.Fragment(0, 183L * duration, duration * 1000, 183.0, 2)
+                        SimTraceWorkload.Fragment(duration * 1000, 28.0, 1),
+                        SimTraceWorkload.Fragment(duration * 1000, 3500.0, 1),
+                        SimTraceWorkload.Fragment(duration * 1000, 0.0, 1),
+                        SimTraceWorkload.Fragment(duration * 1000, 183.0, 1)
+                    ),
+                )
+
+            val machine = SimBareMetalMachine(scope, clock, machineModel)
+            val hypervisor = SimFairShareHypervisor(listener)
+
+            launch {
+                machine.run(hypervisor)
+            }
+
+            yield()
+            launch { hypervisor.createMachine(machineModel).run(workloadA) }
+        }
+
+        scope.advanceUntilIdle()
+        scope.uncaughtExceptions.forEach { it.printStackTrace() }
+
+        assertAll(
+            { assertEquals(emptyList<Throwable>(), scope.uncaughtExceptions, "No errors") },
+            { assertEquals(1113300, listener.totalRequestedWork, "Requested Burst does not match") },
+            { assertEquals(1023300, listener.totalGrantedWork, "Granted Burst does not match") },
+            { assertEquals(90000, listener.totalOvercommittedWork, "Overcommissioned Burst does not match") },
+            { assertEquals(1200000, scope.currentTime) }
+        )
+    }
+
+    /**
+     * Test overcommitting of resources via the hypervisor with two VMs.
+     */
+    @Test
+    fun testOvercommittedDual() {
+        val listener = object : SimHypervisor.Listener {
+            var totalRequestedWork = 0L
+            var totalGrantedWork = 0L
+            var totalOvercommittedWork = 0L
+
+            override fun onSliceFinish(
+                hypervisor: SimHypervisor,
+                requestedWork: Long,
+                grantedWork: Long,
+                overcommittedWork: Long,
+                interferedWork: Long,
+                cpuUsage: Double,
+                cpuDemand: Double
+            ) {
+                totalRequestedWork += requestedWork
+                totalGrantedWork += grantedWork
+                totalOvercommittedWork += overcommittedWork
+            }
+        }
+
+        scope.launch {
+            val duration = 5 * 60L
+            val workloadA =
+                SimTraceWorkload(
+                    sequenceOf(
+                        SimTraceWorkload.Fragment(duration * 1000, 28.0, 1),
+                        SimTraceWorkload.Fragment(duration * 1000, 3500.0, 1),
+                        SimTraceWorkload.Fragment(duration * 1000, 0.0, 1),
+                        SimTraceWorkload.Fragment(duration * 1000, 183.0, 1)
                     ),
                 )
             val workloadB =
                 SimTraceWorkload(
                     sequenceOf(
-                        SimTraceWorkload.Fragment(0, 28L * duration, duration * 1000, 28.0, 2),
-                        SimTraceWorkload.Fragment(0, 3100L * duration, duration * 1000, 3100.0, 2),
-                        SimTraceWorkload.Fragment(0, 0, duration * 1000, 0.0, 2),
-                        SimTraceWorkload.Fragment(0, 73L * duration, duration * 1000, 73.0, 2)
+                        SimTraceWorkload.Fragment(duration * 1000, 28.0, 1),
+                        SimTraceWorkload.Fragment(duration * 1000, 3100.0, 1),
+                        SimTraceWorkload.Fragment(duration * 1000, 0.0, 1),
+                        SimTraceWorkload.Fragment(duration * 1000, 73.0, 1)
                     )
                 )
 
             val machine = SimBareMetalMachine(scope, clock, machineModel)
-            val hypervisor = SimFairSharedHypervisor(scope, clock, listener)
+            val hypervisor = SimFairShareHypervisor(listener)
 
             launch {
                 machine.run(hypervisor)
@@ -117,13 +177,14 @@ internal class SimHypervisorTest {
         }
 
         scope.advanceUntilIdle()
+        scope.uncaughtExceptions.forEach { it.printStackTrace() }
 
         assertAll(
-            { Assertions.assertEquals(emptyList<Throwable>(), scope.uncaughtExceptions, "No errors") },
-            { Assertions.assertEquals(2082000, listener.totalRequestedBurst, "Requested Burst does not match") },
-            { Assertions.assertEquals(2013600, listener.totalGrantedBurst, "Granted Burst does not match") },
-            { Assertions.assertEquals(60000, listener.totalOvercommissionedBurst, "Overcommissioned Burst does not match") },
-            { Assertions.assertEquals(1200001, scope.currentTime) }
+            { assertEquals(emptyList<Throwable>(), scope.uncaughtExceptions, "No errors") },
+            { assertEquals(2082000, listener.totalRequestedWork, "Requested Burst does not match") },
+            { assertEquals(1062000, listener.totalGrantedWork, "Granted Burst does not match") },
+            { assertEquals(1020000, listener.totalOvercommittedWork, "Overcommissioned Burst does not match") },
+            { assertEquals(1200000, scope.currentTime) }
         )
     }
 }
diff --git a/simulator/opendc-simulator/opendc-simulator-compute/src/test/kotlin/org/opendc/simulator/compute/SimMachineTest.kt b/simulator/opendc-simulator/opendc-simulator-compute/src/test/kotlin/org/opendc/simulator/compute/SimMachineTest.kt
index 332ca8e9..1036f1ac 100644
--- a/simulator/opendc-simulator/opendc-simulator-compute/src/test/kotlin/org/opendc/simulator/compute/SimMachineTest.kt
+++ b/simulator/opendc-simulator/opendc-simulator-compute/src/test/kotlin/org/opendc/simulator/compute/SimMachineTest.kt
@@ -23,15 +23,20 @@
 package org.opendc.simulator.compute
 
 import kotlinx.coroutines.*
+import kotlinx.coroutines.flow.toList
 import kotlinx.coroutines.test.TestCoroutineScope
 import kotlinx.coroutines.test.runBlockingTest
 import org.junit.jupiter.api.Assertions.assertEquals
 import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.assertDoesNotThrow
+import org.junit.jupiter.api.assertThrows
 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.SimFlopsWorkload
+import org.opendc.simulator.compute.workload.SimResourceCommand
+import org.opendc.simulator.compute.workload.SimWorkload
 import org.opendc.simulator.utils.DelayControllerClockAdapter
 
 /**
@@ -58,7 +63,7 @@ class SimMachineTest {
         val machine = SimBareMetalMachine(testScope, clock, machineModel)
 
         testScope.runBlockingTest {
-            machine.run(SimFlopsWorkload(2_000, 2, utilization = 1.0))
+            machine.run(SimFlopsWorkload(2_000, utilization = 1.0))
 
             // Two cores execute 1000 MFlOps per second (1000 ms)
             assertEquals(1000, testScope.currentTime)
@@ -72,12 +77,83 @@ class SimMachineTest {
         val machine = SimBareMetalMachine(testScope, clock, machineModel)
 
         testScope.runBlockingTest {
-            machine.run(SimFlopsWorkload(2_000, 2, utilization = 1.0))
-            assertEquals(1.0, machine.usage.value)
+            val res = mutableListOf<Double>()
+            val job = launch { machine.usage.toList(res) }
 
-            // Wait for the usage to reset
-            delay(1)
-            assertEquals(0.0, machine.usage.value)
+            machine.run(SimFlopsWorkload(2_000, utilization = 1.0))
+
+            job.cancel()
+            assertEquals(listOf(0.0, 0.5, 1.0, 0.5, 0.0), res) { "Machine is fully utilized" }
+        }
+    }
+
+    @Test
+    fun testInterrupt() {
+        val testScope = TestCoroutineScope()
+        val clock = DelayControllerClockAdapter(testScope)
+        val machine = SimBareMetalMachine(testScope, clock, machineModel)
+
+        val workload = object : SimWorkload {
+            override fun onStart(ctx: SimExecutionContext) {}
+
+            override fun onStart(ctx: SimExecutionContext, cpu: Int): SimResourceCommand {
+                ctx.interrupt(cpu)
+                return SimResourceCommand.Exit
+            }
+
+            override fun onNext(ctx: SimExecutionContext, cpu: Int, remainingWork: Double): SimResourceCommand {
+                throw IllegalStateException()
+            }
+        }
+
+        assertDoesNotThrow {
+            testScope.runBlockingTest { machine.run(workload) }
+        }
+    }
+
+    @Test
+    fun testExceptionPropagationOnStart() {
+        val testScope = TestCoroutineScope()
+        val clock = DelayControllerClockAdapter(testScope)
+        val machine = SimBareMetalMachine(testScope, clock, machineModel)
+
+        val workload = object : SimWorkload {
+            override fun onStart(ctx: SimExecutionContext) {}
+
+            override fun onStart(ctx: SimExecutionContext, cpu: Int): SimResourceCommand {
+                throw IllegalStateException()
+            }
+
+            override fun onNext(ctx: SimExecutionContext, cpu: Int, remainingWork: Double): SimResourceCommand {
+                throw IllegalStateException()
+            }
+        }
+
+        assertThrows<IllegalStateException> {
+            testScope.runBlockingTest { machine.run(workload) }
+        }
+    }
+
+    @Test
+    fun testExceptionPropagationOnNext() {
+        val testScope = TestCoroutineScope()
+        val clock = DelayControllerClockAdapter(testScope)
+        val machine = SimBareMetalMachine(testScope, clock, machineModel)
+
+        val workload = object : SimWorkload {
+            override fun onStart(ctx: SimExecutionContext) {}
+
+            override fun onStart(ctx: SimExecutionContext, cpu: Int): SimResourceCommand {
+                return SimResourceCommand.Consume(1.0, 1.0)
+            }
+
+            override fun onNext(ctx: SimExecutionContext, cpu: Int, remainingWork: Double): SimResourceCommand {
+                throw IllegalStateException()
+            }
+        }
+
+        assertThrows<IllegalStateException> {
+            testScope.runBlockingTest { machine.run(workload) }
         }
     }
 }
diff --git a/simulator/opendc-simulator/opendc-simulator-compute/src/test/kotlin/org/opendc/simulator/compute/SimSpaceSharedHypervisorTest.kt b/simulator/opendc-simulator/opendc-simulator-compute/src/test/kotlin/org/opendc/simulator/compute/SimSpaceSharedHypervisorTest.kt
new file mode 100644
index 00000000..1a9faf11
--- /dev/null
+++ b/simulator/opendc-simulator/opendc-simulator-compute/src/test/kotlin/org/opendc/simulator/compute/SimSpaceSharedHypervisorTest.kt
@@ -0,0 +1,175 @@
+/*
+ * 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.flow.toList
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.test.TestCoroutineScope
+import kotlinx.coroutines.yield
+import org.junit.jupiter.api.Assertions.*
+import org.junit.jupiter.api.BeforeEach
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.assertThrows
+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.SimRuntimeWorkload
+import org.opendc.simulator.compute.workload.SimTraceWorkload
+import org.opendc.simulator.utils.DelayControllerClockAdapter
+import java.time.Clock
+
+/**
+ * A test suite for the [SimSpaceSharedHypervisor].
+ */
+@OptIn(ExperimentalCoroutinesApi::class)
+internal class SimSpaceSharedHypervisorTest {
+    private lateinit var scope: TestCoroutineScope
+    private lateinit var clock: Clock
+    private lateinit var machineModel: SimMachineModel
+
+    @BeforeEach
+    fun setUp() {
+        scope = TestCoroutineScope()
+        clock = DelayControllerClockAdapter(scope)
+
+        val cpuNode = ProcessingNode("Intel", "Xeon", "amd64", 1)
+        machineModel = SimMachineModel(
+            cpus = List(cpuNode.coreCount) { ProcessingUnit(cpuNode, it, 3200.0) },
+            memory = List(4) { MemoryUnit("Crucial", "MTA18ASF4G72AZ-3G2B1", 3200.0, 32_000) }
+        )
+    }
+
+    /**
+     * Test a trace workload.
+     */
+    @Test
+    fun testTrace() {
+        val usagePm = mutableListOf<Double>()
+        val usageVm = mutableListOf<Double>()
+
+        scope.launch {
+            val duration = 5 * 60L
+            val workloadA =
+                SimTraceWorkload(
+                    sequenceOf(
+                        SimTraceWorkload.Fragment(duration * 1000, 28.0, 1),
+                        SimTraceWorkload.Fragment(duration * 1000, 3500.0, 1),
+                        SimTraceWorkload.Fragment(duration * 1000, 0.0, 1),
+                        SimTraceWorkload.Fragment(duration * 1000, 183.0, 1)
+                    ),
+                )
+
+            val machine = SimBareMetalMachine(scope, clock, machineModel)
+            val hypervisor = SimSpaceSharedHypervisor()
+
+            launch { machine.usage.toList(usagePm) }
+            launch { machine.run(hypervisor) }
+
+            yield()
+            launch {
+                val vm = hypervisor.createMachine(machineModel)
+                launch { vm.usage.toList(usageVm) }
+                vm.run(workloadA)
+            }
+        }
+
+        scope.advanceUntilIdle()
+
+        assertAll(
+            { assertEquals(listOf(0.0, 0.00875, 1.0, 0.0, 0.0571875, 0.0), usagePm) { "Correct PM usage" } },
+            { assertEquals(listOf(0.0, 0.00875, 1.0, 0.0, 0.0571875, 0.0), usageVm) { "Correct VM usage" } },
+            { assertEquals(5 * 60L * 4000, scope.currentTime) { "Took enough time" } }
+        )
+    }
+
+    /**
+     * Test runtime workload on hypervisor.
+     */
+    @Test
+    fun testRuntimeWorkload() {
+        val duration = 5 * 60L * 1000
+        val workload = SimRuntimeWorkload(duration)
+        val machine = SimBareMetalMachine(scope, clock, machineModel)
+        val hypervisor = SimSpaceSharedHypervisor()
+
+        scope.launch {
+            launch { machine.run(hypervisor) }
+
+            yield()
+            launch { hypervisor.createMachine(machineModel).run(workload) }
+        }
+
+        scope.advanceUntilIdle()
+
+        assertEquals(duration, scope.currentTime) { "Took enough time" }
+    }
+
+    /**
+     * Test concurrent workloads on the machine.
+     */
+    @Test
+    fun testConcurrentWorkloadFails() {
+        val machine = SimBareMetalMachine(scope, clock, machineModel)
+        val hypervisor = SimSpaceSharedHypervisor()
+
+        scope.launch {
+            launch { machine.run(hypervisor) }
+
+            yield()
+
+            hypervisor.createMachine(machineModel)
+
+            assertAll(
+                { assertFalse(hypervisor.canFit(machineModel)) },
+                { assertThrows<IllegalStateException> { hypervisor.createMachine(machineModel) } }
+            )
+        }
+
+        scope.advanceUntilIdle()
+    }
+
+    /**
+     * Test concurrent workloads on the machine.
+     */
+    @Test
+    fun testConcurrentWorkloadSucceeds() {
+        val machine = SimBareMetalMachine(scope, clock, machineModel)
+        val hypervisor = SimSpaceSharedHypervisor()
+
+        scope.launch {
+            launch { machine.run(hypervisor) }
+
+            yield()
+
+            hypervisor.createMachine(machineModel).close()
+
+            assertAll(
+                { assertTrue(hypervisor.canFit(machineModel)) },
+                { assertDoesNotThrow { hypervisor.createMachine(machineModel) } }
+            )
+        }
+
+        scope.advanceUntilIdle()
+    }
+}
diff --git a/simulator/opendc-simulator/opendc-simulator-compute/src/test/kotlin/org/opendc/simulator/compute/workload/SimFlopsWorkloadTest.kt b/simulator/opendc-simulator/opendc-simulator-compute/src/test/kotlin/org/opendc/simulator/compute/workload/SimFlopsWorkloadTest.kt
index 51bed76c..b3e57453 100644
--- a/simulator/opendc-simulator/opendc-simulator-compute/src/test/kotlin/org/opendc/simulator/compute/workload/SimFlopsWorkloadTest.kt
+++ b/simulator/opendc-simulator/opendc-simulator-compute/src/test/kotlin/org/opendc/simulator/compute/workload/SimFlopsWorkloadTest.kt
@@ -32,42 +32,28 @@ class SimFlopsWorkloadTest {
     @Test
     fun testFlopsNonNegative() {
         assertThrows<IllegalArgumentException>("FLOPs must be non-negative") {
-            SimFlopsWorkload(-1, 1)
-        }
-    }
-
-    @Test
-    fun testCoresNonZero() {
-        assertThrows<IllegalArgumentException>("Cores cannot be zero") {
-            SimFlopsWorkload(1, 0)
-        }
-    }
-
-    @Test
-    fun testCoresPositive() {
-        assertThrows<IllegalArgumentException>("Cores cannot be negative") {
-            SimFlopsWorkload(1, -1)
+            SimFlopsWorkload(-1)
         }
     }
 
     @Test
     fun testUtilizationNonZero() {
         assertThrows<IllegalArgumentException>("Utilization cannot be zero") {
-            SimFlopsWorkload(1, 1, 0.0)
+            SimFlopsWorkload(1, 0.0)
         }
     }
 
     @Test
     fun testUtilizationPositive() {
         assertThrows<IllegalArgumentException>("Utilization cannot be negative") {
-            SimFlopsWorkload(1, 1, -1.0)
+            SimFlopsWorkload(1, -1.0)
         }
     }
 
     @Test
     fun testUtilizationNotLargerThanOne() {
         assertThrows<IllegalArgumentException>("Utilization cannot be larger than one") {
-            SimFlopsWorkload(1, 1, 2.0)
+            SimFlopsWorkload(1, 2.0)
         }
     }
 }