1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
/*
* 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.spi
import org.opendc.trace.TableReader
import org.opendc.trace.TableWriter
import org.opendc.trace.formats.carbon.CarbonTraceFormat
import org.opendc.trace.formats.failure.FailureTraceFormat
import org.opendc.trace.formats.workload.WorkloadTraceFormat
import java.nio.file.Path
import java.util.ServiceLoader
/**
* A service-provider class for parsing trace formats.
*/
public interface TraceFormat {
/**
* The name of the trace format.
*/
public val name: String
/**
* Construct an empty trace at [path].
*
* @param path The path where to create the empty trace.
* @throws IllegalArgumentException If [path] is invalid.
* @throws UnsupportedOperationException If the table does not support trace creation.
*/
public fun create(path: Path)
/**
* Return the name of the tables available in the trace at the specified [path].
*
* @param path The path to the trace.
* @return The list of tables available in the trace.
*/
public fun getTables(path: Path): List<String>
/**
* Return the details of [table] in the trace at the specified [path].
*
* @param path The path to the trace.
* @param table The name of the table to obtain the details for.
* @throws IllegalArgumentException If [table] does not exist.
* @return The [TableDetails] for the specified [table].
*/
public fun getDetails(
path: Path,
table: String,
): TableDetails
/**
* Open a [TableReader] for the specified [table].
*
* @param path The path to the trace to open.
* @param table The name of the table to open a [TableReader] for.
* @param projection The name of the columns to project or `null` if no projection is performed.
* @throws IllegalArgumentException If [table] does not exist.
* @return A [TableReader] instance for the table.
*/
public fun newReader(
path: Path,
table: String,
projection: List<String>?,
): TableReader
/**
* Open a [TableWriter] for the specified [table].
*
* @param path The path to the trace to open.
* @param table The name of the table to open a [TableWriter] for.
* @throws IllegalArgumentException If [table] does not exist.
* @throws UnsupportedOperationException If the format does not support writing.
* @return A [TableWriter] instance for the table.
*/
public fun newWriter(
path: Path,
table: String,
): TableWriter
/**
* A helper object for resolving providers.
*/
public companion object {
/**
* Obtain a list of [TraceFormat] that are available in the current thread context.
*/
@JvmStatic
public fun getInstalledProviders(): Iterable<TraceFormat> {
return ServiceLoader.load(TraceFormat::class.java)
}
/**
* Obtain a [TraceFormat] implementation by [name].
*/
@JvmStatic
public fun byName(name: String): TraceFormat? {
return when (name) {
"carbon" -> CarbonTraceFormat()
"failure" -> FailureTraceFormat()
"workload" -> WorkloadTraceFormat()
else -> null
}
}
}
}
|
