Add a Cost Model [WIP]

opendc-compute/opendc-compute-carbon/src/main/kotlin/org/opendc/compute/carbon/CarbonTraceLoader.kt

@@ -36,7 +36,7 @@ import java.util.concurrent.ConcurrentHashMap
  * A helper class for loading compute workload traces into memory.
  *
  */
-public class CarbonTraceLoader {
+public class    CarbonTraceLoader {
     /**
      * The cache of workloads.
      */

opendc-compute/opendc-compute-costmodel/build.gradle.kts

@@ -0,0 +1,37 @@
+/*
+ * 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.
+ */
+
+description = "OpenDC Compute Service implementation"
+
+// Build configuration
+plugins {
+    `kotlin-library-conventions`
+}
+
+dependencies {
+    api(projects.opendcCompute.opendcComputeApi)
+    implementation(projects.opendcCommon)
+    implementation(project(mapOf("path" to ":opendc-trace:opendc-trace-api")))
+    implementation(project(mapOf("path" to ":opendc-simulator:opendc-simulator-compute")))
+
+    implementation(libs.kotlin.logging)
+}

opendc-compute/opendc-compute-costmodel/src/main/kotlin/org/opendc/compute/costmodel/EnergyCostTraceLoader.kt

@@ -0,0 +1,146 @@
+/*
+ * 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.compute.costmodel
+
+import org.opendc.simulator.compute.costmodel.EnergyCostFragment
+import org.opendc.trace.Trace
+import org.opendc.trace.conv.ENERGY_PRICE_COST
+import org.opendc.trace.conv.ENERGY_PRICE_TIMESTAMP
+import org.opendc.trace.conv.TABLE_COSTMODEL
+import java.io.File
+import java.lang.ref.SoftReference
+import java.time.Instant
+import java.util.concurrent.ConcurrentHashMap
+
+// TODO NICO code in here is crap, copy paste of carbon, needs rewrite to read energy cost trace instead.
+// Similarity to reading a carbon trace is high so I left the code in, but it needs to be at least renamed
+//  and possibly slightly rewritten to read an energy cost trace
+
+/**
+ * A helper class for loading compute workload traces into memory.
+ *
+ */
+public class EnergyCostTraceLoader {
+    /**
+     * The cache of workloads.
+     */
+    private val cache = ConcurrentHashMap<String, SoftReference<List<EnergyCostFragment>>>()
+
+    private val builder = EnergyCostFragmentNewBuilder()
+
+    /**
+     * Read the metadata into a workload.
+     */
+    @Suppress("UNREACHABLE_CODE", "UNUSED_PARAMETER")
+    private fun parseEnergy(trace: Trace): List<EnergyCostFragment> {
+        //TODO TEMPORARILY MAKING A SINGLE ENTITY LIST WITH A FRAGMENT THAT SPANS ALL TIME WITH RANDOM PRICE
+//        return listOf(EnergyCostFragment(0,
+//                            Long.MAX_VALUE,
+//                            0.018124))
+
+
+        // TODO we need to implement a reader for our trace format, once more carbon is an excellent starting point here
+        // opendc-trace/opendc-trace-api/src/main/kotlin/org/opendc/trace/formats/carbon
+        // I haven't gotten to it yet, its gna be a bunch  of copy paste boiler plate and should be straightforward
+        val reader = checkNotNull(trace.getTable(TABLE_COSTMODEL)).newReader()
+
+        val startTimeCol = reader.resolve(ENERGY_PRICE_TIMESTAMP)
+        val energyPriceCol = reader.resolve(ENERGY_PRICE_COST)
+
+        try {
+            while (reader.nextRow()) {
+                val startTime = reader.getInstant(startTimeCol)!!
+                val energyPriceCost = reader.getDouble(energyPriceCol)
+
+                builder.add(startTime, energyPriceCost)
+            }
+
+            // Make sure the virtual machines are ordered by start time
+            builder.fixReportTimes()
+
+            return builder.fragments
+        } catch (e: Exception) {
+            e.printStackTrace()
+            throw e
+        } finally {
+            reader.close()
+        }
+    }
+
+    /**
+     * Load the Carbon Trace at the given path.
+     */
+    public fun get(pathToFile: File): List<EnergyCostFragment> {
+        val trace = Trace.open(pathToFile, "costmodel")
+
+        return parseEnergy(trace)
+    }
+
+    /**
+     * Clear the workload cache.
+     */
+    public fun reset() {
+        cache.clear()
+    }
+
+    /**
+     * A builder for a VM trace.
+     */
+    private class EnergyCostFragmentNewBuilder {
+        /**
+         * The total load of the trace.
+         */
+        val fragments: MutableList<EnergyCostFragment> = mutableListOf()
+
+        /**
+         * Add a fragment to the trace.
+         *
+         * @param startTime Timestamp at which the fragment starts (in epoch millis).
+         * @param energyPriceCost the price per kwh
+         */
+        fun add(
+            startTime: Instant,
+            energyPriceCost: Double,
+        ) {
+            fragments.add(
+                EnergyCostFragment(
+                    startTime.toEpochMilli(),
+                    Long.MAX_VALUE,
+                    energyPriceCost,
+                ),
+            )
+        }
+
+        fun fixReportTimes() {
+            fragments.sortBy { it.startTime }
+
+            // For each report, set the end time to the start time of the next report
+            for (i in 0..fragments.size - 2) {
+                fragments[i].endTime = fragments[i + 1].startTime
+            }
+
+            // Set the start time of each report to the minimum value
+            fragments[0].startTime = Long.MIN_VALUE
+        }
+    }
+}

opendc-compute/opendc-compute-costmodel/src/main/kotlin/org/opendc/compute/costmodel/EnergyCostTraceReader.kt

@@ -0,0 +1,51 @@
+/*
+ * 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.
+ */
+
+@file:JvmName("ComputeWorkloadsNew")
+
+package org.opendc.compute.costmodel
+
+import org.opendc.simulator.compute.costmodel.EnergyCostFragment
+import java.io.File
+import javax.management.InvalidAttributeValueException
+
+/**
+ * Construct a workload from a trace.
+ */
+public fun getEnergyCostFragments(pathToFile: String?): List<EnergyCostFragment>? {
+    if (pathToFile == null) {
+        return null
+    }
+
+    return getEnergyCostFragments(File(pathToFile))
+}
+
+/**
+ * Construct a workload from a trace.
+ */
+public fun getEnergyCostFragments(file: File): List<EnergyCostFragment> {
+    if (!file.exists()) {
+        throw InvalidAttributeValueException("The energy price cost trace can not be found")
+    }
+
+    return EnergyCostTraceLoader().get(file)
+}

opendc-compute/opendc-compute-costmodel/src/test/resources/log4j2.xml

@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ 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.
+  -->
+
+<Configuration status="WARN" packages="org.apache.logging.log4j.core">
+    <Appenders>
+        <Console name="Console" target="SYSTEM_OUT">
+            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%highlight{%-5level}] %logger{36} - %msg%n" disableAnsi="false"/>
+        </Console>
+    </Appenders>
+    <Loggers>
+        <Logger name="org.opendc" level="trace" additivity="false">
+            <AppenderRef ref="Console"/>
+        </Logger>
+        <Root level="info">
+            <AppenderRef ref="Console"/>
+        </Root>
+    </Loggers>
+</Configuration>

opendc-compute/opendc-compute-simulator/build.gradle.kts

@@ -39,6 +39,7 @@ dependencies {
     api(libs.microprofile.config)
     implementation(project(mapOf("path" to ":opendc-compute:opendc-compute-topology")))
     implementation(project(mapOf("path" to ":opendc-compute:opendc-compute-carbon")))
+    implementation(project(mapOf("path" to ":opendc-compute:opendc-compute-costmodel")))
 
     implementation(project(mapOf("path" to ":opendc-trace:opendc-trace-api")))
     implementation(project(mapOf("path" to ":opendc-trace:opendc-trace-parquet")))

opendc-compute/opendc-compute-simulator/src/main/java/org/opendc/compute/simulator/service/ComputeService.java

@@ -49,6 +49,7 @@
 import org.opendc.compute.simulator.scheduler.SchedulingResultType;
 import org.opendc.compute.simulator.telemetry.ComputeMetricReader;
 import org.opendc.compute.simulator.telemetry.SchedulerStats;
+import org.opendc.simulator.compute.costmodel.CostModel;
 import org.opendc.simulator.compute.power.CarbonModel;
 import org.opendc.simulator.compute.power.CarbonReceiver;
 import org.opendc.simulator.compute.power.SimPowerSource;
@@ -105,6 +106,8 @@ public final class ComputeService implements AutoCloseable, CarbonReceiver {
      */
     private final Set<SimBattery> batteries = new HashSet<>();
 
+    private final Set<CostModel> costModels = new HashSet<>();
+
     /**
      * The tasks that should be launched by the service.
      */
@@ -322,6 +325,15 @@ public void addBattery(SimBattery simBattery) {
         batteries.add(simBattery);
     }
 
+    public void addCostModel(CostModel costModel) {
+        // Check if host is already known
+        if (costModels.contains(costModel)) {
+            return;
+        }
+
+        costModels.add(costModel);
+    }
+
     /**
      * Remove a {@link SimHost} from the scheduling pool of the compute service.
      */
@@ -360,6 +372,10 @@ public Set<SimBattery> getBatteries() {
         return Collections.unmodifiableSet(this.batteries);
     }
 
+    public Set<CostModel> getCostModels() {
+        return Collections.unmodifiableSet(this.costModels);
+    }
+
     public void setMetricReader(ComputeMetricReader metricReader) {
         this.metricReader = metricReader;
     }

opendc-compute/opendc-compute-simulator/src/main/kotlin/org/opendc/compute/simulator/provisioner/ComputeMonitorProvisioningStep.kt

@@ -44,6 +44,7 @@ public class ComputeMonitorProvisioningStep(
             OutputFiles.SERVICE to true,
             OutputFiles.POWER_SOURCE to true,
             OutputFiles.BATTERY to true,
+            OutputFiles.COSTMODEL to true,
         ),
     private val printFrequency: Int? = null,
 ) : ProvisioningStep {

opendc-compute/opendc-compute-simulator/src/main/kotlin/org/opendc/compute/simulator/provisioner/ComputeSteps.kt

@@ -67,6 +67,7 @@ public fun registerComputeMonitor(
             OutputFiles.SERVICE to true,
             OutputFiles.POWER_SOURCE to true,
             OutputFiles.BATTERY to true,
+            OutputFiles.COSTMODEL to true,
         ),
     printFrequency: Int? = null,
 ): ProvisioningStep {