Revamped the trace system. All TraceFormat files are now in the api m… (#216)

* Revamped the trace system. All TraceFormat files are now in the api module. This fixes some problems with not being able to use types of traces

* applied spotless

6 files changed, 0 insertions, 477 deletions

diff --git a/opendc-trace/opendc-trace-swf/build.gradle.kts b/opendc-trace/opendc-trace-swf/build.gradle.kts
deleted file mode 100644
index 2798cdb1..00000000
--- a/opendc-trace/opendc-trace-swf/build.gradle.kts
+++ /dev/null
@@ -1,34 +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.
- */
-
-description = "Support for Standard Workload Format (SWF) traces in OpenDC"
-
-// Build configuration
-plugins {
-    `kotlin-library-conventions`
-}
-
-dependencies {
-    api(projects.opendcTrace.opendcTraceApi)
-
-    testImplementation(projects.opendcTrace.opendcTraceTestkit)
-}
diff --git a/opendc-trace/opendc-trace-swf/src/main/kotlin/org/opendc/trace/swf/SwfTaskTableReader.kt b/opendc-trace/opendc-trace-swf/src/main/kotlin/org/opendc/trace/swf/SwfTaskTableReader.kt
deleted file mode 100644
index 5a79fd6f..00000000
--- a/opendc-trace/opendc-trace-swf/src/main/kotlin/org/opendc/trace/swf/SwfTaskTableReader.kt
+++ /dev/null
@@ -1,236 +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.trace.swf
-
-import org.opendc.trace.TableReader
-import org.opendc.trace.conv.TASK_ALLOC_NCPUS
-import org.opendc.trace.conv.TASK_GROUP_ID
-import org.opendc.trace.conv.TASK_ID
-import org.opendc.trace.conv.TASK_PARENTS
-import org.opendc.trace.conv.TASK_REQ_NCPUS
-import org.opendc.trace.conv.TASK_RUNTIME
-import org.opendc.trace.conv.TASK_STATUS
-import org.opendc.trace.conv.TASK_SUBMIT_TIME
-import org.opendc.trace.conv.TASK_USER_ID
-import org.opendc.trace.conv.TASK_WAIT_TIME
-import java.io.BufferedReader
-import java.time.Duration
-import java.time.Instant
-import java.util.UUID
-
-/**
- * A [TableReader] implementation for the SWF format.
- */
-internal class SwfTaskTableReader(private val reader: BufferedReader) : TableReader {
-    /**
-     * A flag to indicate the state of the reader
-     */
-    private var state = State.Pending
-
-    /**
-     * The current row.
-     */
-    private var fields = emptyList<String>()
-
-    /**
-     * A [Regex] object to match whitespace.
-     */
-    private val whitespace = "\\s+".toRegex()
-
-    override fun nextRow(): Boolean {
-        var line: String?
-        var num = 0
-
-        val state = state
-        if (state == State.Closed) {
-            return false
-        } else if (state == State.Pending) {
-            this.state = State.Active
-        }
-
-        while (true) {
-            line = reader.readLine()
-
-            if (line == null) {
-                this.state = State.Closed
-                return false
-            }
-            num++
-
-            if (line.isBlank()) {
-                // Ignore empty lines
-                continue
-            } else if (line.startsWith(";")) {
-                // Ignore comments for now
-                continue
-            }
-
-            break
-        }
-
-        fields = line!!.trim().split(whitespace)
-
-        if (fields.size < 18) {
-            throw IllegalArgumentException("Invalid format at line $line")
-        }
-
-        return true
-    }
-
-    override fun resolve(name: String): Int {
-        return when (name) {
-            TASK_ID -> colJobID
-            TASK_SUBMIT_TIME -> colSubmitTime
-            TASK_WAIT_TIME -> colWaitTime
-            TASK_RUNTIME -> colRunTime
-            TASK_ALLOC_NCPUS -> colAllocNcpus
-            TASK_REQ_NCPUS -> colReqNcpus
-            TASK_STATUS -> colStatus
-            TASK_USER_ID -> colUserID
-            TASK_GROUP_ID -> colGroupID
-            TASK_PARENTS -> colParentJob
-            else -> -1
-        }
-    }
-
-    override fun isNull(index: Int): Boolean {
-        require(index in colJobID..colParentThinkTime) { "Invalid column index" }
-        return false
-    }
-
-    override fun getBoolean(index: Int): Boolean {
-        throw IllegalArgumentException("Invalid column")
-    }
-
-    override fun getInt(index: Int): Int {
-        check(state == State.Active) { "No active row" }
-        return when (index) {
-            colReqNcpus, colAllocNcpus, colStatus, colGroupID, colUserID -> fields[index].toInt(10)
-            else -> throw IllegalArgumentException("Invalid column")
-        }
-    }
-
-    override fun getLong(index: Int): Long {
-        throw IllegalArgumentException("Invalid column")
-    }
-
-    override fun getFloat(index: Int): Float {
-        throw IllegalArgumentException("Invalid column")
-    }
-
-    override fun getDouble(index: Int): Double {
-        throw IllegalArgumentException("Invalid column")
-    }
-
-    override fun getString(index: Int): String {
-        check(state == State.Active) { "No active row" }
-        return when (index) {
-            colJobID -> fields[index]
-            else -> throw IllegalArgumentException("Invalid column")
-        }
-    }
-
-    override fun getUUID(index: Int): UUID? {
-        throw IllegalArgumentException("Invalid column")
-    }
-
-    override fun getInstant(index: Int): Instant? {
-        check(state == State.Active) { "No active row" }
-        return when (index) {
-            colSubmitTime -> Instant.ofEpochSecond(fields[index].toLong(10))
-            else -> throw IllegalArgumentException("Invalid column")
-        }
-    }
-
-    override fun getDuration(index: Int): Duration? {
-        check(state == State.Active) { "No active row" }
-        return when (index) {
-            colWaitTime, colRunTime -> Duration.ofSeconds(fields[index].toLong(10))
-            else -> throw IllegalArgumentException("Invalid column")
-        }
-    }
-
-    override fun <T> getList(
-        index: Int,
-        elementType: Class<T>,
-    ): List<T>? {
-        throw IllegalArgumentException("Invalid column")
-    }
-
-    override fun <T> getSet(
-        index: Int,
-        elementType: Class<T>,
-    ): Set<T>? {
-        check(state == State.Active) { "No active row" }
-        @Suppress("UNCHECKED_CAST")
-        return when (index) {
-            colParentJob -> {
-                require(elementType.isAssignableFrom(String::class.java))
-                val parent = fields[index].toLong(10)
-                if (parent < 0) emptySet() else setOf(parent)
-            }
-            else -> throw IllegalArgumentException("Invalid column")
-        } as Set<T>?
-    }
-
-    override fun <K, V> getMap(
-        index: Int,
-        keyType: Class<K>,
-        valueType: Class<V>,
-    ): Map<K, V>? {
-        throw IllegalArgumentException("Invalid column")
-    }
-
-    override fun close() {
-        reader.close()
-        state = State.Closed
-    }
-
-    /**
-     * Default column indices for the SWF format.
-     */
-    private val colJobID = 0
-    private val colSubmitTime = 1
-    private val colWaitTime = 2
-    private val colRunTime = 3
-    private val colAllocNcpus = 4
-    private val colAvgCpuTime = 5
-    private val colUsedMem = 6
-    private val colReqNcpus = 7
-    private val colReqTime = 8
-    private val colReqMem = 9
-    private val colStatus = 10
-    private val colUserID = 11
-    private val colGroupID = 12
-    private val colExecNum = 13
-    private val colQueueNum = 14
-    private val colPartNum = 15
-    private val colParentJob = 16
-    private val colParentThinkTime = 17
-
-    private enum class State {
-        Pending,
-        Active,
-        Closed,
-    }
-}
diff --git a/opendc-trace/opendc-trace-swf/src/main/kotlin/org/opendc/trace/swf/SwfTraceFormat.kt b/opendc-trace/opendc-trace-swf/src/main/kotlin/org/opendc/trace/swf/SwfTraceFormat.kt
deleted file mode 100644
index d59b07b4..00000000
--- a/opendc-trace/opendc-trace-swf/src/main/kotlin/org/opendc/trace/swf/SwfTraceFormat.kt
+++ /dev/null
@@ -1,100 +0,0 @@
-/*
- * Copyright (c) 2020 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.trace.swf
-
-import org.opendc.trace.TableColumn
-import org.opendc.trace.TableColumnType
-import org.opendc.trace.TableReader
-import org.opendc.trace.TableWriter
-import org.opendc.trace.conv.TABLE_TASKS
-import org.opendc.trace.conv.TASK_ALLOC_NCPUS
-import org.opendc.trace.conv.TASK_GROUP_ID
-import org.opendc.trace.conv.TASK_ID
-import org.opendc.trace.conv.TASK_PARENTS
-import org.opendc.trace.conv.TASK_REQ_NCPUS
-import org.opendc.trace.conv.TASK_RUNTIME
-import org.opendc.trace.conv.TASK_STATUS
-import org.opendc.trace.conv.TASK_SUBMIT_TIME
-import org.opendc.trace.conv.TASK_USER_ID
-import org.opendc.trace.conv.TASK_WAIT_TIME
-import org.opendc.trace.spi.TableDetails
-import org.opendc.trace.spi.TraceFormat
-import java.nio.file.Path
-import kotlin.io.path.bufferedReader
-
-/**
- * Support for the Standard Workload Format (SWF) in OpenDC.
- *
- * The standard is defined by the PWA, see here: https://www.cse.huji.ac.il/labs/parallel/workload/swf.html
- */
-public class SwfTraceFormat : TraceFormat {
-    override val name: String = "swf"
-
-    override fun create(path: Path) {
-        throw UnsupportedOperationException("Writing not supported for this format")
-    }
-
-    override fun getTables(path: Path): List<String> = listOf(TABLE_TASKS)
-
-    override fun getDetails(
-        path: Path,
-        table: String,
-    ): TableDetails {
-        return when (table) {
-            TABLE_TASKS ->
-                TableDetails(
-                    listOf(
-                        TableColumn(TASK_ID, TableColumnType.String),
-                        TableColumn(TASK_SUBMIT_TIME, TableColumnType.Instant),
-                        TableColumn(TASK_WAIT_TIME, TableColumnType.Duration),
-                        TableColumn(TASK_RUNTIME, TableColumnType.Duration),
-                        TableColumn(TASK_REQ_NCPUS, TableColumnType.Int),
-                        TableColumn(TASK_ALLOC_NCPUS, TableColumnType.Int),
-                        TableColumn(TASK_PARENTS, TableColumnType.Set(TableColumnType.String)),
-                        TableColumn(TASK_STATUS, TableColumnType.Int),
-                        TableColumn(TASK_GROUP_ID, TableColumnType.Int),
-                        TableColumn(TASK_USER_ID, TableColumnType.Int),
-                    ),
-                )
-            else -> throw IllegalArgumentException("Table $table not supported")
-        }
-    }
-
-    override fun newReader(
-        path: Path,
-        table: String,
-        projection: List<String>?,
-    ): TableReader {
-        return when (table) {
-            TABLE_TASKS -> SwfTaskTableReader(path.bufferedReader())
-            else -> throw IllegalArgumentException("Table $table not supported")
-        }
-    }
-
-    override fun newWriter(
-        path: Path,
-        table: String,
-    ): TableWriter {
-        throw UnsupportedOperationException("Writing not supported for this format")
-    }
-}
diff --git a/opendc-trace/opendc-trace-swf/src/main/resources/META-INF/services/org.opendc.trace.spi.TraceFormat b/opendc-trace/opendc-trace-swf/src/main/resources/META-INF/services/org.opendc.trace.spi.TraceFormat
deleted file mode 100644
index 6c6b0eb2..00000000
--- a/opendc-trace/opendc-trace-swf/src/main/resources/META-INF/services/org.opendc.trace.spi.TraceFormat
+++ /dev/null
@@ -1 +0,0 @@
-org.opendc.trace.swf.SwfTraceFormat
diff --git a/opendc-trace/opendc-trace-swf/src/test/kotlin/org/opendc/trace/swf/SwfTraceFormatTest.kt b/opendc-trace/opendc-trace-swf/src/test/kotlin/org/opendc/trace/swf/SwfTraceFormatTest.kt
deleted file mode 100644
index 436f2572..00000000
--- a/opendc-trace/opendc-trace-swf/src/test/kotlin/org/opendc/trace/swf/SwfTraceFormatTest.kt
+++ /dev/null
@@ -1,100 +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.trace.swf
-
-import org.junit.jupiter.api.Assertions.assertAll
-import org.junit.jupiter.api.Assertions.assertDoesNotThrow
-import org.junit.jupiter.api.Assertions.assertEquals
-import org.junit.jupiter.api.Assertions.assertTrue
-import org.junit.jupiter.api.BeforeEach
-import org.junit.jupiter.api.DisplayName
-import org.junit.jupiter.api.Nested
-import org.junit.jupiter.api.Test
-import org.junit.jupiter.api.assertThrows
-import org.opendc.trace.TableColumn
-import org.opendc.trace.TableReader
-import org.opendc.trace.conv.TABLE_TASKS
-import org.opendc.trace.conv.TASK_ALLOC_NCPUS
-import org.opendc.trace.conv.TASK_ID
-import org.opendc.trace.testkit.TableReaderTestKit
-import java.nio.file.Paths
-
-/**
- * Test suite for the [SwfTraceFormat] class.
- */
-@DisplayName("SWF TraceFormat")
-internal class SwfTraceFormatTest {
-    private val format = SwfTraceFormat()
-
-    @Test
-    fun testTables() {
-        val path = Paths.get(checkNotNull(SwfTraceFormatTest::class.java.getResource("/trace.swf")).toURI())
-
-        assertEquals(listOf(TABLE_TASKS), format.getTables(path))
-    }
-
-    @Test
-    fun testTableExists() {
-        val path = Paths.get(checkNotNull(SwfTraceFormatTest::class.java.getResource("/trace.swf")).toURI())
-        assertDoesNotThrow { format.getDetails(path, TABLE_TASKS) }
-    }
-
-    @Test
-    fun testTableDoesNotExist() {
-        val path = Paths.get(checkNotNull(SwfTraceFormatTest::class.java.getResource("/trace.swf")).toURI())
-
-        assertThrows<IllegalArgumentException> { format.getDetails(path, "test") }
-    }
-
-    @Test
-    fun testReader() {
-        val path = Paths.get(checkNotNull(SwfTraceFormatTest::class.java.getResource("/trace.swf")).toURI())
-        val reader = format.newReader(path, TABLE_TASKS, null)
-
-        assertAll(
-            { assertTrue(reader.nextRow()) },
-            { assertEquals("1", reader.getString(TASK_ID)) },
-            { assertEquals(306, reader.getInt(TASK_ALLOC_NCPUS)) },
-            { assertTrue(reader.nextRow()) },
-            { assertEquals("2", reader.getString(TASK_ID)) },
-            { assertEquals(17, reader.getInt(TASK_ALLOC_NCPUS)) },
-        )
-
-        reader.close()
-    }
-
-    @DisplayName("TableReader for Tasks")
-    @Nested
-    inner class TasksTableReaderTest : TableReaderTestKit() {
-        override lateinit var reader: TableReader
-        override lateinit var columns: List<TableColumn>
-
-        @BeforeEach
-        fun setUp() {
-            val path = Paths.get(checkNotNull(SwfTraceFormatTest::class.java.getResource("/trace.swf")).toURI())
-
-            columns = format.getDetails(path, TABLE_TASKS).columns
-            reader = format.newReader(path, TABLE_TASKS, null)
-        }
-    }
-}
diff --git a/opendc-trace/opendc-trace-swf/src/test/resources/trace.swf b/opendc-trace/opendc-trace-swf/src/test/resources/trace.swf
deleted file mode 100644
index c3ecf890..00000000
--- a/opendc-trace/opendc-trace-swf/src/test/resources/trace.swf
+++ /dev/null
@@ -1,6 +0,0 @@
-; Excerpt from the PWA: CTC-SP2-1996-3.1-cln.swf
-    1        0 588530    937  306 142.00    -1   -1  35100    -1  1  97  -1 307  3 -1 -1 -1
-    2   164472 356587     75   17   2.00    -1   -1    300    -1  1  81  -1 195  3 -1 -1 -1
-    3   197154 459987  35268  306  32792    -1   -1  35100    -1  0  97  -1 307  3 -1 -1 -1
-    4   310448  50431  29493   64  28745    -1   -1  64800    -1  1  38  -1  38  1 -1 -1 -1
-    5   310541  50766  29063   64  28191    -1   -1  64800    -1  1  38  -1  69  1 -1 -1 -1