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

3 files changed, 0 insertions, 391 deletions

diff --git a/opendc-trace/opendc-trace-gwf/src/main/kotlin/org/opendc/trace/gwf/GwfTaskTableReader.kt b/opendc-trace/opendc-trace-gwf/src/main/kotlin/org/opendc/trace/gwf/GwfTaskTableReader.kt
deleted file mode 100644
index 8a2a99cb..00000000
--- a/opendc-trace/opendc-trace-gwf/src/main/kotlin/org/opendc/trace/gwf/GwfTaskTableReader.kt
+++ /dev/null
@@ -1,286 +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.gwf
-
-import com.fasterxml.jackson.core.JsonToken
-import com.fasterxml.jackson.dataformat.csv.CsvParser
-import com.fasterxml.jackson.dataformat.csv.CsvSchema
-import org.opendc.trace.TableColumnType
-import org.opendc.trace.TableReader
-import org.opendc.trace.conv.TASK_ALLOC_NCPUS
-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_SUBMIT_TIME
-import org.opendc.trace.conv.TASK_WORKFLOW_ID
-import org.opendc.trace.util.convertTo
-import java.time.Duration
-import java.time.Instant
-import java.util.UUID
-import java.util.regex.Pattern
-
-/**
- * A [TableReader] implementation for the GWF format.
- */
-internal class GwfTaskTableReader(private val parser: CsvParser) : TableReader {
-    /**
-     * A flag to indicate whether a single row has been read already.
-     */
-    private var isStarted = false
-
-    init {
-        parser.schema = schema
-    }
-
-    override fun nextRow(): Boolean {
-        if (!isStarted) {
-            isStarted = true
-        }
-
-        // Reset the row state
-        reset()
-
-        if (parser.isClosed || !nextStart()) {
-            return false
-        }
-
-        while (true) {
-            val token = parser.nextValue()
-
-            if (token == null || token == JsonToken.END_OBJECT) {
-                break
-            }
-
-            when (parser.currentName) {
-                "WorkflowID" -> workflowId = parser.text
-                "JobID" -> jobId = parser.text
-                "SubmitTime" -> submitTime = Instant.ofEpochSecond(parser.longValue)
-                "RunTime" -> runtime = Duration.ofSeconds(parser.longValue)
-                "NProcs" -> nProcs = parser.intValue
-                "ReqNProcs" -> reqNProcs = parser.intValue
-                "Dependencies" -> dependencies = parseParents(parser.valueAsString)
-            }
-        }
-
-        return true
-    }
-
-    override fun resolve(name: String): Int {
-        return when (name) {
-            TASK_ID -> colJobID
-            TASK_WORKFLOW_ID -> colWorkflowID
-            TASK_SUBMIT_TIME -> colSubmitTime
-            TASK_RUNTIME -> colRuntime
-            TASK_ALLOC_NCPUS -> colNproc
-            TASK_REQ_NCPUS -> colReqNproc
-            TASK_PARENTS -> colDeps
-            else -> -1
-        }
-    }
-
-    override fun isNull(index: Int): Boolean {
-        require(index in 0..colDeps) { "Invalid column" }
-        return false
-    }
-
-    override fun getBoolean(index: Int): Boolean {
-        throw IllegalArgumentException("Invalid column")
-    }
-
-    override fun getInt(index: Int): Int {
-        checkActive()
-        return when (index) {
-            colReqNproc -> reqNProcs
-            colNproc -> nProcs
-            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? {
-        checkActive()
-        return when (index) {
-            colJobID -> jobId
-            colWorkflowID -> workflowId
-            else -> throw IllegalArgumentException("Invalid column")
-        }
-    }
-
-    override fun getUUID(index: Int): UUID? {
-        throw IllegalArgumentException("Invalid column")
-    }
-
-    override fun getInstant(index: Int): Instant? {
-        checkActive()
-        return when (index) {
-            colSubmitTime -> submitTime
-            else -> throw IllegalArgumentException("Invalid column")
-        }
-    }
-
-    override fun getDuration(index: Int): Duration? {
-        checkActive()
-        return when (index) {
-            colRuntime -> runtime
-            else -> throw IllegalArgumentException("Invalid column")
-        }
-    }
-
-    override fun <T> getList(
-        index: Int,
-        elementType: Class<T>,
-    ): List<T>? {
-        throw IllegalArgumentException("Invalid column")
-    }
-
-    override fun <K, V> getMap(
-        index: Int,
-        keyType: Class<K>,
-        valueType: Class<V>,
-    ): Map<K, V>? {
-        throw IllegalArgumentException("Invalid column")
-    }
-
-    override fun <T> getSet(
-        index: Int,
-        elementType: Class<T>,
-    ): Set<T>? {
-        checkActive()
-        return when (index) {
-            colDeps -> typeDeps.convertTo(dependencies, elementType)
-            else -> throw IllegalArgumentException("Invalid column")
-        }
-    }
-
-    override fun close() {
-        parser.close()
-    }
-
-    /**
-     * Helper method to check if the reader is active.
-     */
-    private fun checkActive() {
-        check(isStarted && !parser.isClosed) { "No active row. Did you call nextRow()?" }
-    }
-
-    /**
-     * The pattern used to parse the parents.
-     */
-    private val pattern = Pattern.compile("\\s+")
-
-    /**
-     * Parse the parents into a set of longs.
-     */
-    private fun parseParents(value: String): Set<String> {
-        val result = mutableSetOf<String>()
-        val deps = value.split(pattern)
-
-        for (dep in deps) {
-            if (dep.isBlank()) {
-                continue
-            }
-
-            result.add(dep)
-        }
-
-        return result
-    }
-
-    /**
-     * Advance the parser until the next object start.
-     */
-    private fun nextStart(): Boolean {
-        var token = parser.nextValue()
-
-        while (token != null && token != JsonToken.START_OBJECT) {
-            token = parser.nextValue()
-        }
-
-        return token != null
-    }
-
-    /**
-     * Reader state fields.
-     */
-    private var workflowId: String? = null
-    private var jobId: String? = null
-    private var submitTime: Instant? = null
-    private var runtime: Duration? = null
-    private var nProcs = -1
-    private var reqNProcs = -1
-    private var dependencies = emptySet<String>()
-
-    /**
-     * Reset the state.
-     */
-    private fun reset() {
-        workflowId = null
-        jobId = null
-        submitTime = null
-        runtime = null
-        nProcs = -1
-        reqNProcs = -1
-        dependencies = emptySet()
-    }
-
-    private val colWorkflowID = 0
-    private val colJobID = 1
-    private val colSubmitTime = 2
-    private val colRuntime = 3
-    private val colNproc = 4
-    private val colReqNproc = 5
-    private val colDeps = 6
-
-    private val typeDeps = TableColumnType.Set(TableColumnType.String)
-
-    companion object {
-        /**
-         * The [CsvSchema] that is used to parse the trace.
-         */
-        private val schema =
-            CsvSchema.builder()
-                .addColumn("WorkflowID", CsvSchema.ColumnType.NUMBER)
-                .addColumn("JobID", CsvSchema.ColumnType.NUMBER)
-                .addColumn("SubmitTime", CsvSchema.ColumnType.NUMBER)
-                .addColumn("RunTime", CsvSchema.ColumnType.NUMBER)
-                .addColumn("NProcs", CsvSchema.ColumnType.NUMBER)
-                .addColumn("ReqNProcs", CsvSchema.ColumnType.NUMBER)
-                .addColumn("Dependencies", CsvSchema.ColumnType.STRING)
-                .setAllowComments(true)
-                .setUseHeader(true)
-                .setColumnSeparator(',')
-                .build()
-    }
-}
diff --git a/opendc-trace/opendc-trace-gwf/src/main/kotlin/org/opendc/trace/gwf/GwfTraceFormat.kt b/opendc-trace/opendc-trace-gwf/src/main/kotlin/org/opendc/trace/gwf/GwfTraceFormat.kt
deleted file mode 100644
index 097c5593..00000000
--- a/opendc-trace/opendc-trace-gwf/src/main/kotlin/org/opendc/trace/gwf/GwfTraceFormat.kt
+++ /dev/null
@@ -1,104 +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.gwf
-
-import com.fasterxml.jackson.dataformat.csv.CsvFactory
-import com.fasterxml.jackson.dataformat.csv.CsvParser
-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_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_SUBMIT_TIME
-import org.opendc.trace.conv.TASK_WORKFLOW_ID
-import org.opendc.trace.spi.TableDetails
-import org.opendc.trace.spi.TraceFormat
-import java.nio.file.Path
-
-/**
- * A [TraceFormat] implementation for the GWF trace format.
- */
-public class GwfTraceFormat : TraceFormat {
-    /**
-     * The name of this trace format.
-     */
-    override val name: String = "gwf"
-
-    /**
-     * The [CsvFactory] used to create the parser.
-     */
-    private val factory =
-        CsvFactory()
-            .enable(CsvParser.Feature.ALLOW_COMMENTS)
-            .enable(CsvParser.Feature.TRIM_SPACES)
-
-    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_WORKFLOW_ID, TableColumnType.String),
-                        TableColumn(TASK_ID, TableColumnType.String),
-                        TableColumn(TASK_SUBMIT_TIME, TableColumnType.Instant),
-                        TableColumn(TASK_RUNTIME, TableColumnType.Duration),
-                        TableColumn(TASK_REQ_NCPUS, TableColumnType.Int),
-                        TableColumn(TASK_ALLOC_NCPUS, TableColumnType.Int),
-                        TableColumn(TASK_PARENTS, TableColumnType.Set(TableColumnType.String)),
-                    ),
-                )
-            else -> throw IllegalArgumentException("Table $table not supported")
-        }
-    }
-
-    override fun newReader(
-        path: Path,
-        table: String,
-        projection: List<String>?,
-    ): TableReader {
-        return when (table) {
-            TABLE_TASKS -> GwfTaskTableReader(factory.createParser(path.toFile()))
-            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-gwf/src/main/resources/META-INF/services/org.opendc.trace.spi.TraceFormat b/opendc-trace/opendc-trace-gwf/src/main/resources/META-INF/services/org.opendc.trace.spi.TraceFormat
deleted file mode 100644
index 99a874c8..00000000
--- a/opendc-trace/opendc-trace-gwf/src/main/resources/META-INF/services/org.opendc.trace.spi.TraceFormat
+++ /dev/null
@@ -1 +0,0 @@
-org.opendc.trace.gwf.GwfTraceFormat