merge: Add generic trace reading library

This pull request adds a generic trace reading library to OpenDC. 
The library has been designed to support a wide range of trace formats 
and uses a streaming approach to improve performance of reading large traces.

* Add trace reading API
* Implement API for GWF format
* Implement API for SWF format
* Implement API for WTF format
* Implement API for Bitbrains format
* Implement API for Bitbrains Parquet format

**Breaking API Changes**

* `opendc-format` has been removed in favour of `opendc-trace-*`

2 files changed, 113 insertions, 0 deletions

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
new file mode 100644
index 00000000..9686891b
--- /dev/null
+++ b/opendc-trace/opendc-trace-swf/src/test/kotlin/org/opendc/trace/swf/SwfTraceFormatTest.kt
@@ -0,0 +1,107 @@
+/*
+ * 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.*
+import org.junit.jupiter.api.Assertions.*
+import org.opendc.trace.TABLE_TASKS
+import org.opendc.trace.TASK_ALLOC_NCPUS
+import org.opendc.trace.TASK_ID
+import java.net.URL
+
+/**
+ * Test suite for the [SwfTraceFormat] class.
+ */
+internal class SwfTraceFormatTest {
+    @Test
+    fun testTraceExists() {
+        val input = checkNotNull(SwfTraceFormatTest::class.java.getResource("/trace.swf"))
+        val format = SwfTraceFormat()
+        assertDoesNotThrow {
+            format.open(input)
+        }
+    }
+
+    @Test
+    fun testTraceDoesNotExists() {
+        val input = checkNotNull(SwfTraceFormatTest::class.java.getResource("/trace.swf"))
+        val format = SwfTraceFormat()
+        assertThrows<IllegalArgumentException> {
+            format.open(URL(input.toString() + "help"))
+        }
+    }
+
+    @Test
+    fun testTables() {
+        val input = checkNotNull(SwfTraceFormatTest::class.java.getResource("/trace.swf"))
+        val trace = SwfTraceFormat().open(input)
+
+        assertEquals(listOf(TABLE_TASKS), trace.tables)
+    }
+
+    @Test
+    fun testTableExists() {
+        val input = checkNotNull(SwfTraceFormatTest::class.java.getResource("/trace.swf"))
+        val table = SwfTraceFormat().open(input).getTable(TABLE_TASKS)
+
+        assertNotNull(table)
+        assertDoesNotThrow { table!!.newReader() }
+    }
+
+    @Test
+    fun testTableDoesNotExist() {
+        val input = checkNotNull(SwfTraceFormatTest::class.java.getResource("/trace.swf"))
+        val trace = SwfTraceFormat().open(input)
+
+        assertFalse(trace.containsTable("test"))
+        assertNull(trace.getTable("test"))
+    }
+
+    @Test
+    fun testReader() {
+        val input = checkNotNull(SwfTraceFormatTest::class.java.getResource("/trace.swf"))
+        val trace = SwfTraceFormat().open(input)
+        val reader = trace.getTable(TABLE_TASKS)!!.newReader()
+
+        assertAll(
+            { assertTrue(reader.nextRow()) },
+            { assertEquals(1, reader.getLong(TASK_ID)) },
+            { assertEquals(306, reader.getInt(TASK_ALLOC_NCPUS)) },
+            { assertTrue(reader.nextRow()) },
+            { assertEquals(2, reader.getLong(TASK_ID)) },
+            { assertEquals(17, reader.getInt(TASK_ALLOC_NCPUS)) },
+        )
+
+        reader.close()
+    }
+
+    @Test
+    fun testReaderPartition() {
+        val input = checkNotNull(SwfTraceFormatTest::class.java.getResource("/trace.swf"))
+        val trace = SwfTraceFormat().open(input)
+
+        assertThrows<IllegalArgumentException> {
+            trace.getTable(TABLE_TASKS)!!.newReader("test")
+        }
+    }
+}
diff --git a/opendc-trace/opendc-trace-swf/src/test/resources/trace.swf b/opendc-trace/opendc-trace-swf/src/test/resources/trace.swf
new file mode 100644
index 00000000..c3ecf890
--- /dev/null
+++ b/opendc-trace/opendc-trace-swf/src/test/resources/trace.swf
@@ -0,0 +1,6 @@
+; 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