feat(trace): Add support for extended Bitbrains trace format

This change adds support in the trace library for the extended Bitbrains
format. This format is slightly different than the CSV format used by
the original Bitbrains traces and contains more fields.

5 files changed, 2 insertions, 444 deletions

diff --git a/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/TraceConverter.kt b/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/TraceConverter.kt
index bae7cb22..02666cc7 100644
--- a/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/TraceConverter.kt
+++ b/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/TraceConverter.kt
@@ -37,8 +37,8 @@ import org.apache.parquet.hadoop.metadata.CompressionCodecName
 import org.opendc.compute.workload.trace.azure.AzureTraceFormat
 import org.opendc.compute.workload.trace.bp.BP_RESOURCES_SCHEMA
 import org.opendc.compute.workload.trace.bp.BP_RESOURCE_STATES_SCHEMA
-import org.opendc.compute.workload.trace.sv.SvTraceFormat
 import org.opendc.trace.*
+import org.opendc.trace.bitbrains.BitbrainsExTraceFormat
 import org.opendc.trace.bitbrains.BitbrainsTraceFormat
 import org.opendc.trace.util.parquet.LocalOutputFile
 import java.io.File
@@ -79,7 +79,7 @@ internal class TraceConverterCli : CliktCommand(name = "trace-converter") {
      */
     private val format by option("-f", "--format", help = "input format of trace")
         .choice(
-            "solvinity" to SvTraceFormat(),
+            "solvinity" to BitbrainsExTraceFormat(),
             "bitbrains" to BitbrainsTraceFormat(),
             "azure" to AzureTraceFormat()
         )
diff --git a/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/sv/SvResourceStateTable.kt b/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/sv/SvResourceStateTable.kt
deleted file mode 100644
index 3ff69d36..00000000
--- a/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/sv/SvResourceStateTable.kt
+++ /dev/null
@@ -1,138 +0,0 @@
-/*
- * 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.workload.trace.sv
-
-import org.opendc.trace.*
-import java.nio.file.Files
-import java.nio.file.Path
-import java.util.stream.Collectors
-import kotlin.io.path.bufferedReader
-import kotlin.io.path.extension
-import kotlin.io.path.nameWithoutExtension
-
-/**
- * The resource state [Table] in the extended Bitbrains format.
- */
-internal class SvResourceStateTable(path: Path) : Table {
-    /**
-     * The partitions that belong to the table.
-     */
-    private val partitions = Files.walk(path, 1)
-        .filter { !Files.isDirectory(it) && it.extension == "txt" }
-        .collect(Collectors.toMap({ it.nameWithoutExtension }, { it }))
-        .toSortedMap()
-
-    override val name: String = TABLE_RESOURCE_STATES
-
-    override val isSynthetic: Boolean = false
-
-    override val columns: List<TableColumn<*>> = listOf(
-        RESOURCE_STATE_ID,
-        RESOURCE_STATE_CLUSTER_ID,
-        RESOURCE_STATE_TIMESTAMP,
-        RESOURCE_STATE_NCPUS,
-        RESOURCE_STATE_CPU_CAPACITY,
-        RESOURCE_STATE_CPU_USAGE,
-        RESOURCE_STATE_CPU_USAGE_PCT,
-        RESOURCE_STATE_CPU_DEMAND,
-        RESOURCE_STATE_CPU_READY_PCT,
-        RESOURCE_STATE_MEM_CAPACITY,
-        RESOURCE_STATE_DISK_READ,
-        RESOURCE_STATE_DISK_WRITE,
-    )
-
-    override fun newReader(): TableReader {
-        val it = partitions.iterator()
-
-        return object : TableReader {
-            var delegate: TableReader? = nextDelegate()
-
-            override fun nextRow(): Boolean {
-                var delegate = delegate
-
-                while (delegate != null) {
-                    if (delegate.nextRow()) {
-                        break
-                    }
-
-                    delegate.close()
-                    delegate = nextDelegate()
-                }
-
-                this.delegate = delegate
-                return delegate != null
-            }
-
-            override fun hasColumn(column: TableColumn<*>): Boolean = delegate?.hasColumn(column) ?: false
-
-            override fun <T> get(column: TableColumn<T>): T {
-                val delegate = checkNotNull(delegate) { "Invalid reader state" }
-                return delegate.get(column)
-            }
-
-            override fun getBoolean(column: TableColumn<Boolean>): Boolean {
-                val delegate = checkNotNull(delegate) { "Invalid reader state" }
-                return delegate.getBoolean(column)
-            }
-
-            override fun getInt(column: TableColumn<Int>): Int {
-                val delegate = checkNotNull(delegate) { "Invalid reader state" }
-                return delegate.getInt(column)
-            }
-
-            override fun getLong(column: TableColumn<Long>): Long {
-                val delegate = checkNotNull(delegate) { "Invalid reader state" }
-                return delegate.getLong(column)
-            }
-
-            override fun getDouble(column: TableColumn<Double>): Double {
-                val delegate = checkNotNull(delegate) { "Invalid reader state" }
-                return delegate.getDouble(column)
-            }
-
-            override fun close() {
-                delegate?.close()
-            }
-
-            private fun nextDelegate(): TableReader? {
-                return if (it.hasNext()) {
-                    val (_, path) = it.next()
-                    val reader = path.bufferedReader()
-                    return SvResourceStateTableReader(reader)
-                } else {
-                    null
-                }
-            }
-
-            override fun toString(): String = "SvCompositeTableReader"
-        }
-    }
-
-    override fun newReader(partition: String): TableReader {
-        val path = requireNotNull(partitions[partition]) { "Invalid partition $partition" }
-        val reader = path.bufferedReader()
-        return SvResourceStateTableReader(reader)
-    }
-
-    override fun toString(): String = "SvResourceStateTable"
-}
diff --git a/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/sv/SvResourceStateTableReader.kt b/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/sv/SvResourceStateTableReader.kt
deleted file mode 100644
index 487be950..00000000
--- a/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/sv/SvResourceStateTableReader.kt
+++ /dev/null
@@ -1,212 +0,0 @@
-/*
- * 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.workload.trace.sv
-
-import org.opendc.trace.*
-import java.io.BufferedReader
-import java.time.Instant
-
-/**
- * A [TableReader] for the Bitbrains resource state table.
- */
-internal class SvResourceStateTableReader(private val reader: BufferedReader) : TableReader {
-    override fun nextRow(): Boolean {
-        reset()
-
-        var line: String
-        var num = 0
-
-        while (true) {
-            line = reader.readLine() ?: return false
-            num++
-
-            if (line[0] == '#' || line.isBlank()) {
-                // Ignore empty lines or comments
-                continue
-            }
-
-            break
-        }
-
-        line = line.trim()
-
-        val length = line.length
-        var col = 0
-        var start: Int
-        var end = 0
-
-        while (end < length) {
-            // Trim all whitespace before the field
-            start = end
-            while (start < length && line[start].isWhitespace()) {
-                start++
-            }
-
-            end = line.indexOf(' ', start)
-
-            if (end < 0) {
-                end = length
-            }
-
-            val field = line.subSequence(start, end) as String
-            when (col++) {
-                COL_TIMESTAMP -> timestamp = Instant.ofEpochSecond(field.toLong(10))
-                COL_CPU_USAGE -> cpuUsage = field.toDouble()
-                COL_CPU_DEMAND -> cpuDemand = field.toDouble()
-                COL_DISK_READ -> diskRead = field.toDouble()
-                COL_DISK_WRITE -> diskWrite = field.toDouble()
-                COL_CLUSTER_ID -> cluster = field.trim()
-                COL_NCPUS -> cpuCores = field.toInt(10)
-                COL_CPU_READY_PCT -> cpuReadyPct = field.toDouble()
-                COL_POWERED_ON -> poweredOn = field.toInt(10) == 1
-                COL_CPU_CAPACITY -> cpuCapacity = field.toDouble()
-                COL_ID -> id = field.trim()
-                COL_MEM_CAPACITY -> memCapacity = field.toDouble()
-            }
-        }
-
-        return true
-    }
-
-    override fun hasColumn(column: TableColumn<*>): Boolean {
-        return when (column) {
-            RESOURCE_STATE_ID -> true
-            RESOURCE_STATE_CLUSTER_ID -> true
-            RESOURCE_STATE_TIMESTAMP -> true
-            RESOURCE_STATE_NCPUS -> true
-            RESOURCE_STATE_CPU_CAPACITY -> true
-            RESOURCE_STATE_CPU_USAGE -> true
-            RESOURCE_STATE_CPU_USAGE_PCT -> true
-            RESOURCE_STATE_CPU_DEMAND -> true
-            RESOURCE_STATE_CPU_READY_PCT -> true
-            RESOURCE_STATE_MEM_CAPACITY -> true
-            RESOURCE_STATE_DISK_READ -> true
-            RESOURCE_STATE_DISK_WRITE -> true
-            else -> false
-        }
-    }
-
-    override fun <T> get(column: TableColumn<T>): T {
-        val res: Any? = when (column) {
-            RESOURCE_STATE_ID -> id
-            RESOURCE_STATE_CLUSTER_ID -> cluster
-            RESOURCE_STATE_TIMESTAMP -> timestamp
-            RESOURCE_STATE_NCPUS -> getInt(RESOURCE_STATE_NCPUS)
-            RESOURCE_STATE_CPU_CAPACITY -> getDouble(RESOURCE_STATE_CPU_CAPACITY)
-            RESOURCE_STATE_CPU_USAGE -> getDouble(RESOURCE_STATE_CPU_USAGE)
-            RESOURCE_STATE_CPU_USAGE_PCT -> getDouble(RESOURCE_STATE_CPU_USAGE_PCT)
-            RESOURCE_STATE_MEM_CAPACITY -> getDouble(RESOURCE_STATE_MEM_CAPACITY)
-            RESOURCE_STATE_DISK_READ -> getDouble(RESOURCE_STATE_DISK_READ)
-            RESOURCE_STATE_DISK_WRITE -> getDouble(RESOURCE_STATE_DISK_WRITE)
-            else -> throw IllegalArgumentException("Invalid column")
-        }
-
-        @Suppress("UNCHECKED_CAST")
-        return res as T
-    }
-
-    override fun getBoolean(column: TableColumn<Boolean>): Boolean {
-        return when (column) {
-            RESOURCE_STATE_POWERED_ON -> poweredOn
-            else -> throw IllegalArgumentException("Invalid column")
-        }
-    }
-
-    override fun getInt(column: TableColumn<Int>): Int {
-        return when (column) {
-            RESOURCE_STATE_NCPUS -> cpuCores
-            else -> throw IllegalArgumentException("Invalid column")
-        }
-    }
-
-    override fun getLong(column: TableColumn<Long>): Long {
-        throw IllegalArgumentException("Invalid column")
-    }
-
-    override fun getDouble(column: TableColumn<Double>): Double {
-        return when (column) {
-            RESOURCE_STATE_CPU_CAPACITY -> cpuCapacity
-            RESOURCE_STATE_CPU_USAGE -> cpuUsage
-            RESOURCE_STATE_CPU_USAGE_PCT -> cpuUsage / cpuCapacity
-            RESOURCE_STATE_CPU_DEMAND -> cpuDemand
-            RESOURCE_STATE_MEM_CAPACITY -> memCapacity
-            RESOURCE_STATE_DISK_READ -> diskRead
-            RESOURCE_STATE_DISK_WRITE -> diskWrite
-            else -> throw IllegalArgumentException("Invalid column")
-        }
-    }
-
-    override fun close() {
-        reader.close()
-    }
-
-    /**
-     * State fields of the reader.
-     */
-    private var id: String? = null
-    private var cluster: String? = null
-    private var timestamp: Instant? = null
-    private var cpuCores = -1
-    private var cpuCapacity = Double.NaN
-    private var cpuUsage = Double.NaN
-    private var cpuDemand = Double.NaN
-    private var cpuReadyPct = Double.NaN
-    private var memCapacity = Double.NaN
-    private var diskRead = Double.NaN
-    private var diskWrite = Double.NaN
-    private var poweredOn: Boolean = false
-
-    /**
-     * Reset the state of the reader.
-     */
-    private fun reset() {
-        id = null
-        timestamp = null
-        cluster = null
-        cpuCores = -1
-        cpuCapacity = Double.NaN
-        cpuUsage = Double.NaN
-        cpuDemand = Double.NaN
-        cpuReadyPct = Double.NaN
-        memCapacity = Double.NaN
-        diskRead = Double.NaN
-        diskWrite = Double.NaN
-        poweredOn = false
-    }
-
-    /**
-     * Default column indices for the extended Bitbrains format.
-     */
-    private val COL_TIMESTAMP = 0
-    private val COL_CPU_USAGE = 1
-    private val COL_CPU_DEMAND = 2
-    private val COL_DISK_READ = 4
-    private val COL_DISK_WRITE = 6
-    private val COL_CLUSTER_ID = 10
-    private val COL_NCPUS = 12
-    private val COL_CPU_READY_PCT = 13
-    private val COL_POWERED_ON = 14
-    private val COL_CPU_CAPACITY = 18
-    private val COL_ID = 19
-    private val COL_MEM_CAPACITY = 20
-}
diff --git a/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/sv/SvTrace.kt b/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/sv/SvTrace.kt
deleted file mode 100644
index 932c73ab..00000000
--- a/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/sv/SvTrace.kt
+++ /dev/null
@@ -1,45 +0,0 @@
-/*
- * 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.workload.trace.sv
-
-import org.opendc.trace.*
-import java.nio.file.Path
-
-/**
- * [Trace] implementation for the extended Bitbrains format.
- */
-public class SvTrace internal constructor(private val path: Path) : Trace {
-    override val tables: List<String> = listOf(TABLE_RESOURCE_STATES)
-
-    override fun containsTable(name: String): Boolean = TABLE_RESOURCE_STATES == name
-
-    override fun getTable(name: String): Table? {
-        if (!containsTable(name)) {
-            return null
-        }
-
-        return SvResourceStateTable(path)
-    }
-
-    override fun toString(): String = "SvTrace[$path]"
-}
diff --git a/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/sv/SvTraceFormat.kt b/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/sv/SvTraceFormat.kt
deleted file mode 100644
index ba673b5f..00000000
--- a/opendc-compute/opendc-compute-workload/src/main/kotlin/org/opendc/compute/workload/trace/sv/SvTraceFormat.kt
+++ /dev/null
@@ -1,47 +0,0 @@
-/*
- * 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.workload.trace.sv
-
-import org.opendc.trace.spi.TraceFormat
-import java.net.URL
-import java.nio.file.Paths
-import kotlin.io.path.exists
-
-/**
- * A format implementation for the extended Bitbrains trace format.
- */
-public class SvTraceFormat : TraceFormat {
-    /**
-     * The name of this trace format.
-     */
-    override val name: String = "sv"
-
-    /**
-     * Open the trace file.
-     */
-    override fun open(url: URL): SvTrace {
-        val path = Paths.get(url.toURI())
-        require(path.exists()) { "URL $url does not exist" }
-        return SvTrace(path)
-    }
-}