Merge branch 'feat/2.x-perf-interference' into '2.x'

Implement a basic performance interference model

Closes #50

See merge request opendc/opendc-simulator!33

8 files changed, 204 insertions, 5 deletions

diff --git a/opendc/opendc-compute/src/main/kotlin/com/atlarge/opendc/compute/virt/driver/hypervisor/HypervisorVirtDriver.kt b/opendc/opendc-compute/src/main/kotlin/com/atlarge/opendc/compute/virt/driver/hypervisor/HypervisorVirtDriver.kt
index 3f358516..6fe11c28 100644
--- a/opendc/opendc-compute/src/main/kotlin/com/atlarge/opendc/compute/virt/driver/hypervisor/HypervisorVirtDriver.kt
+++ b/opendc/opendc-compute/src/main/kotlin/com/atlarge/opendc/compute/virt/driver/hypervisor/HypervisorVirtDriver.kt
@@ -26,9 +26,9 @@ package com.atlarge.opendc.compute.virt.driver.hypervisor
 
 import com.atlarge.odcsim.SimulationContext
 import com.atlarge.odcsim.simulationContext
-import com.atlarge.opendc.compute.core.Server
 import com.atlarge.opendc.compute.core.Flavor
 import com.atlarge.opendc.compute.core.ProcessingUnit
+import com.atlarge.opendc.compute.core.Server
 import com.atlarge.opendc.compute.core.ServerState
 import com.atlarge.opendc.compute.core.execution.ServerContext
 import com.atlarge.opendc.compute.core.execution.ServerManagementContext
@@ -37,6 +37,8 @@ import com.atlarge.opendc.compute.core.monitor.ServerMonitor
 import com.atlarge.opendc.compute.virt.driver.VirtDriver
 import com.atlarge.opendc.compute.virt.driver.VirtDriverMonitor
 import com.atlarge.opendc.compute.virt.monitor.HypervisorMonitor
+import com.atlarge.opendc.core.workload.IMAGE_PERF_INTERFERENCE_MODEL
+import com.atlarge.opendc.core.workload.PerformanceInterferenceModel
 import kotlinx.coroutines.CancellationException
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.channels.Channel
@@ -135,7 +137,13 @@ class HypervisorVirtDriver(
 
             val burst = LongArray(hostContext.cpus.size)
 
+            val imagesRunning = vms.map { it.server.image }.toSet()
+
             for (vm in vms) {
+                // Apply performance interference model
+                val performanceModel = vm.server.image.tags[IMAGE_PERF_INTERFERENCE_MODEL] as? PerformanceInterferenceModel?
+                val performanceScore = performanceModel?.apply(imagesRunning) ?: 1.0
+
                 for (i in 0 until min(vm.cpus.size, vm.requestedBurst.size)) {
                     val cpu = vm.cpus[i]
 
@@ -143,7 +151,7 @@ class HypervisorVirtDriver(
                     val actualUsage = min(vm.limit[i], cpu.frequency / vms.size)
                     val actualBurst = (duration * actualUsage * 1_000_000L).toLong()
 
-                    burst[i] += actualBurst
+                    burst[i] += (performanceScore * actualBurst).toLong()
                 }
             }
 
diff --git a/opendc/opendc-core/src/main/kotlin/com/atlarge/opendc/core/workload/PerformanceInterferenceModel.kt b/opendc/opendc-core/src/main/kotlin/com/atlarge/opendc/core/workload/PerformanceInterferenceModel.kt
new file mode 100644
index 00000000..5e0928b7
--- /dev/null
+++ b/opendc/opendc-core/src/main/kotlin/com/atlarge/opendc/core/workload/PerformanceInterferenceModel.kt
@@ -0,0 +1,57 @@
+package com.atlarge.opendc.core.workload
+
+import com.atlarge.opendc.core.resource.Resource
+import java.util.UUID
+
+/**
+ * Meta-data key for the [PerformanceInterferenceModel] of an image.
+ */
+const val IMAGE_PERF_INTERFERENCE_MODEL = "image:performance-interference"
+
+/**
+ * Performance Interference Model describing the variability incurred by different sets of workloads if colocated.
+ *
+ * @param items The [PerformanceInterferenceModelItem]s that make up this model.
+ */
+data class PerformanceInterferenceModel(
+    val items: Set<PerformanceInterferenceModelItem>
+) {
+    fun apply(colocatedWorkloads: Set<Resource>): Double {
+        val colocatedWorkloadIds = colocatedWorkloads.map { it.uid }
+        val intersectingItems = items.filter { item ->
+            colocatedWorkloadIds.intersect(item.workloadIds).size > 1
+        }
+
+        if (intersectingItems.isEmpty()) {
+            return 1.0
+        }
+        return intersectingItems.map { it.performanceScore }.min() ?: error("Minimum score must exist.")
+    }
+}
+
+/**
+ * Model describing how a specific set of workloads causes performance variability for each workload.
+ *
+ * @param workloadIds The IDs of the workloads that together cause performance variability for each workload in the set.
+ * @param performanceScore The performance score that should be applied to each workload's performance. 1 means no
+ * influence, <1 means that performance degrades, and >1 means that performance improves.
+ */
+data class PerformanceInterferenceModelItem(
+    val workloadIds: Set<UUID>,
+    val performanceScore: Double
+) {
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (javaClass != other?.javaClass) return false
+
+        other as PerformanceInterferenceModelItem
+
+        if (workloadIds != other.workloadIds) return false
+
+        return true
+    }
+
+    override fun hashCode(): Int {
+        return workloadIds.hashCode()
+    }
+}
diff --git a/opendc/opendc-experiments-sc20/src/main/kotlin/com/atlarge/opendc/experiments/sc20/TestExperiment.kt b/opendc/opendc-experiments-sc20/src/main/kotlin/com/atlarge/opendc/experiments/sc20/TestExperiment.kt
index daa40193..f4be75fa 100644
--- a/opendc/opendc-experiments-sc20/src/main/kotlin/com/atlarge/opendc/experiments/sc20/TestExperiment.kt
+++ b/opendc/opendc-experiments-sc20/src/main/kotlin/com/atlarge/opendc/experiments/sc20/TestExperiment.kt
@@ -34,6 +34,7 @@ import com.atlarge.opendc.compute.metal.service.ProvisioningService
 import com.atlarge.opendc.compute.virt.service.SimpleVirtProvisioningService
 import com.atlarge.opendc.compute.virt.service.allocation.AvailableMemoryAllocationPolicy
 import com.atlarge.opendc.format.environment.sc20.Sc20EnvironmentReader
+import com.atlarge.opendc.format.trace.sc20.Sc20PerformanceInterferenceReader
 import com.atlarge.opendc.format.trace.vm.VmTraceReader
 import kotlinx.coroutines.channels.Channel
 import kotlinx.coroutines.delay
@@ -67,6 +68,10 @@ fun main(args: Array<String>) {
         val environment = Sc20EnvironmentReader(object {}.javaClass.getResourceAsStream("/env/setup-small.json"))
             .use { it.construct(root) }
 
+        val performanceInterferenceModel = Sc20PerformanceInterferenceReader(
+            object {}.javaClass.getResourceAsStream("/env/performance-interference.json")
+        ).construct()
+
         println(simulationContext.clock.instant())
 
         val scheduler = SimpleVirtProvisioningService(
@@ -76,7 +81,7 @@ fun main(args: Array<String>) {
             Sc20HypervisorMonitor()
         )
 
-        val reader = VmTraceReader(File(args[0]))
+        val reader = VmTraceReader(File(args[0]), performanceInterferenceModel)
         delay(1376314846 * 1000L)
         while (reader.hasNext()) {
             val (time, workload) = reader.next()
diff --git a/opendc/opendc-experiments-sc20/src/main/resources/env/performance-interference.json b/opendc/opendc-experiments-sc20/src/main/resources/env/performance-interference.json
new file mode 100644
index 00000000..e2437693
--- /dev/null
+++ b/opendc/opendc-experiments-sc20/src/main/resources/env/performance-interference.json
@@ -0,0 +1,6 @@
+[
+    {
+        "vms": [545, 223],
+        "performanceScore": 0.6
+    }
+]
diff --git a/opendc/opendc-format/src/main/kotlin/com/atlarge/opendc/format/trace/PerformanceInterferenceModelReader.kt b/opendc/opendc-format/src/main/kotlin/com/atlarge/opendc/format/trace/PerformanceInterferenceModelReader.kt
new file mode 100644
index 00000000..f9ebba3d
--- /dev/null
+++ b/opendc/opendc-format/src/main/kotlin/com/atlarge/opendc/format/trace/PerformanceInterferenceModelReader.kt
@@ -0,0 +1,38 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2019 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 com.atlarge.opendc.format.trace
+
+import com.atlarge.opendc.core.workload.PerformanceInterferenceModel
+import java.io.Closeable
+
+/**
+ * An interface for reading descriptions of performance interference models into memory.
+ */
+interface PerformanceInterferenceModelReader : Closeable {
+    /**
+     * Construct a [PerformanceInterferenceModel].
+     */
+    fun construct(): PerformanceInterferenceModel
+}
diff --git a/opendc/opendc-format/src/main/kotlin/com/atlarge/opendc/format/trace/sc20/PerformanceInterferenceEntry.kt b/opendc/opendc-format/src/main/kotlin/com/atlarge/opendc/format/trace/sc20/PerformanceInterferenceEntry.kt
new file mode 100644
index 00000000..1eeecb25
--- /dev/null
+++ b/opendc/opendc-format/src/main/kotlin/com/atlarge/opendc/format/trace/sc20/PerformanceInterferenceEntry.kt
@@ -0,0 +1,6 @@
+package com.atlarge.opendc.format.trace.sc20
+
+internal data class PerformanceInterferenceEntry(
+    val vms: List<String>,
+    val performanceScore: Double
+)
diff --git a/opendc/opendc-format/src/main/kotlin/com/atlarge/opendc/format/trace/sc20/Sc20PerformanceInterferenceReader.kt b/opendc/opendc-format/src/main/kotlin/com/atlarge/opendc/format/trace/sc20/Sc20PerformanceInterferenceReader.kt
new file mode 100644
index 00000000..b2d60bb9
--- /dev/null
+++ b/opendc/opendc-format/src/main/kotlin/com/atlarge/opendc/format/trace/sc20/Sc20PerformanceInterferenceReader.kt
@@ -0,0 +1,61 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2019 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 com.atlarge.opendc.format.trace.sc20
+
+import com.atlarge.opendc.core.workload.PerformanceInterferenceModel
+import com.atlarge.opendc.core.workload.PerformanceInterferenceModelItem
+import com.atlarge.opendc.format.trace.PerformanceInterferenceModelReader
+import com.fasterxml.jackson.databind.ObjectMapper
+import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
+import com.fasterxml.jackson.module.kotlin.readValue
+import java.io.InputStream
+import java.util.UUID
+
+/**
+ * A parser for the JSON performance interference setup files used for the SC20 paper.
+ *
+ * @param input The input stream to read from.
+ * @param mapper The Jackson object mapper to use.
+ */
+class Sc20PerformanceInterferenceReader(input: InputStream, mapper: ObjectMapper = jacksonObjectMapper()) :
+    PerformanceInterferenceModelReader {
+    /**
+     * The environment that was read from the file.
+     */
+    private val performanceInterferenceModel: List<PerformanceInterferenceEntry> = mapper.readValue(input)
+
+    override fun construct(): PerformanceInterferenceModel {
+        return PerformanceInterferenceModel(
+            performanceInterferenceModel.map { item ->
+                PerformanceInterferenceModelItem(
+                    item.vms.map { name -> UUID(0L, name.toLong()) }.toSet(),
+                    item.performanceScore
+                )
+            }.toSet()
+        )
+    }
+
+    override fun close() {}
+}
diff --git a/opendc/opendc-format/src/main/kotlin/com/atlarge/opendc/format/trace/vm/VmTraceReader.kt b/opendc/opendc-format/src/main/kotlin/com/atlarge/opendc/format/trace/vm/VmTraceReader.kt
index 2e881a6c..2adf99b1 100644
--- a/opendc/opendc-format/src/main/kotlin/com/atlarge/opendc/format/trace/vm/VmTraceReader.kt
+++ b/opendc/opendc-format/src/main/kotlin/com/atlarge/opendc/format/trace/vm/VmTraceReader.kt
@@ -28,6 +28,8 @@ import com.atlarge.opendc.compute.core.image.FlopsHistoryFragment
 import com.atlarge.opendc.compute.core.image.VmImage
 import com.atlarge.opendc.compute.core.workload.VmWorkload
 import com.atlarge.opendc.core.User
+import com.atlarge.opendc.core.workload.IMAGE_PERF_INTERFERENCE_MODEL
+import com.atlarge.opendc.core.workload.PerformanceInterferenceModel
 import com.atlarge.opendc.format.trace.TraceEntry
 import com.atlarge.opendc.format.trace.TraceReader
 import java.io.BufferedReader
@@ -39,8 +41,12 @@ import java.util.UUID
  * A [TraceReader] for the VM workload trace format.
  *
  * @param traceDirectory The directory of the traces.
+ * @param performanceInterferenceModel The performance model covering the workload in the VM trace.
  */
-class VmTraceReader(traceDirectory: File) : TraceReader<VmWorkload> {
+class VmTraceReader(
+    traceDirectory: File,
+    performanceInterferenceModel: PerformanceInterferenceModel
+) : TraceReader<VmWorkload> {
     /**
      * The internal iterator to use for this reader.
      */
@@ -115,9 +121,21 @@ class VmTraceReader(traceDirectory: File) : TraceReader<VmWorkload> {
                 }
 
                 val uuid = UUID(0L, vmId)
+
+                val relevantPerformanceInterferenceModelItems = PerformanceInterferenceModel(
+                    performanceInterferenceModel.items.filter { it.workloadIds.contains(uuid) }.toSet()
+                )
+
                 val vmWorkload = VmWorkload(
                     uuid, "VM Workload $vmId", UnnamedUser,
-                    VmImage(uuid, vmId.toString(), emptyMap(), flopsHistory, cores, requiredMemory)
+                    VmImage(
+                        uuid,
+                        vmId.toString(),
+                        mapOf(IMAGE_PERF_INTERFERENCE_MODEL to relevantPerformanceInterferenceModelItems),
+                        flopsHistory,
+                        cores,
+                        requiredMemory
+                    )
                 )
                 entries[vmId] = TraceEntryImpl(
                     flopsHistory.firstOrNull()?.tick ?: -1,