# TRACE File Format

The default TRACE file format is a simple text-based and human-readable format. It consists of several elements to specify the events, claims, signals and dependencies. This is a brief overview of the patterns that can be used to specify an execution trace (more detailed explanation and constraints follow below):
# Comments start with a # # # The following three patterns are used to specify general # properties of the execution trace: # 'TU' <time unit of time stamps in trace> 'O' <offset of time stamps in trace> 'T' <attributes>* # # Events are defined using the pattern: # 'E' <event id> <t> ';' <attributes>* # # The following two patterns are involved with # defining claims and resources: # 'R' <resource id> <capacity> <uses offset> ';' <attributes>* 'C' <claim id> <t0> <t1> <resource id> <offset>? <amount> ';' <attributes>* # # Dependencies between events and or start and end of claims # are defined with the following pattern: # 'D' <dep id> <type> <src id> <dst id> ';' <attributes>* # # Continuous signals are specified by piecewise second-order polynomials # using the following patterns: # 'S' <signal id> ';' <attributes>* 'F' <signal id> <t0> <t1> <c> <b> <a> # # Time-series are specified by the following patterns: # 'TS' <time-series-id> ';' <attributes>* 'TSS' <time-series-id> <series-id> ';' <attributes>* 'TSP' <time-series-id> <series-id> <time-value pair>* 'TSR' <time-series-id> <series-id> <time range> <value>*

## Specifying general trace properties

General trace properties are specified by the `TU`, `O` and `T` lines. The `TU` line specifies the time unit of all the time stamps that appear in the execution trace. It must be specified at most once per trace file. If it is not specified, then by default every time stamp is interpreted as a value in seconds. The time unit specification can take one of the following values:

NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS

The `O` line specifies the offset of the time stamps in the trace with respect to the Unix epoch, i.e., January 1970 00:00:00 UTC. The value should be an integer in milliseconds. It must be specified at most once per trace file. If it is not specified, then an offset of 0 is assumed.

The `T` line specifies general attributes of the execution trace. <attributes> define a (possibly empty) key-value mapping in which each key-value pair consists of a string for the key, a '=' character and a string for the value. Pairs are separated by ',' characters. Special characters thus are '=' and ','. If one of these is to be used in a key or value string, then it must be escaped by pre-fixing the character with a '\'. Key and value strings are trimmed, i.e., leading and trailing whitespace is removed. An example is the following:

T name = experiment 1, origin = prototype X, date = Jan 12\, 2020
This line specifies that the trace has three general attributes: name, origin and date. Note that the value of the date attribute contains a ',' which thus is escaped.

## Specifying events

Events are specified by the `E` lines. An event has an identifier (unique within the events), a time stamp and a number of attributes. An example is the following:
E 0 50.0 ; name=E1 E 1 42.4 ; name=E2, att = E2's name \= E2
Here two events are specified, and note the attributes of the second event in which the = is escaped and thus part of the attribute value.

## Specifying claims on resources

Claims on resources are specified by a combination of `R` and `C` lines. An `R` line specifies a resource, and a `C` line specifies a claim of a certain resource. A resource has:

- an identifier (natural number; unique within the resources of the trace),
- a capacity (positive real number),
- a boolean that indicates whether claims on the resource specify an offset, and
- a number of attributes.

A claim has:

- an identifier (natural number; unique within the claims of the trace),
- start and end time stamps (real numbers), a reference to a resource using the resource's identifier,
- an offset (real number) if and only if the resource has declared to use an offset,
- an amount (positive real number), and
- a number of attributes.

An example is the following:
R 0 100.0 false ; name = CPU, unit = % R 1 512 true ; name = RAM, unit = MB C 0 0.2 13.2 0 100.0 ; task=A C 1 0.4 0.6 1 128 256 ; task=B
This example specifies two resources. The CPU resource has a capacity of 100 and does not use an offset. The RAM resource has a capacity of 512 (MB as the attributes suggest) and does require claims to specify an offset. Also two claims are specified. The first claim, for task A, starts at 0.2 and ends at 13.2 time units. It claims 100.0 of the CPU resource (it specifies resource identifier 0, which is the identifier of the CPU resource). The second claim, for task B, is from 0.4 to 0.6 time units and takes 256 of the RAM resources, starting at an offset of 128. The offset in combination with the amount thus specifies that the middle half of the memory is claimed.

## Specifying dependencies

Dependencies are specified by the `D` lines. A dependency has an identifier (unique within the dependencies), a type (one of 0..8), a source (a claim or event identifier), a destination (a claim or event identifier) and a number of attributes. There are nine types of dependencies:

- 0 : claim start - claim start : both src and dst id refer to claims
- 1 : claim start - claim end : both src and dst id refer to claims
- 2 : claim end - claim start : both src and dst id refer to claims
- 3 : claim end - claim end : both src and dst id refer to claims
- 4 : event - event : both src and dst id refer to events
- 5 : claim start - event : src id refers to a claim and dst id refers to an event
- 6 : claim end - event : src id refers to a claim and dst id refers to an event
- 7 : event - claim start : src id refers to an event and dst id refers to a claim
- 8 : event - claim end : src id refers to an event and dst id refers to a claim

The following is an example that uses the claims and events from the examples above:
D 0 0 0 1 ; type=start-start D 1 4 0 1 ; type=application D 2 6 0 0 ; type=application
The first dependency has type 0 and specifies a dependency from the start of task A to the start of task B. The second dependency has type 4 and specifies a dependency from event E1 to event E2. The second dependency has type 6 and specifies a dependency from the end of task A to event E1. The attributes are used to indicate the type of the dependency.

## Specifying signals

Signals are specified by the `S` and `F` lines. There is exactly one `S` line for each signal, and at least one `F` line for each signal. The `S` line specifies a signal identifier (unique within the signals of the trace), and a number of attributes for the signal. The `F` lines then each encode a piecewise second-order polynomial fragment of the signal. An `F` line has an signal identifier that specifies the signal to which the fragment belongs. It then has five real numbers. The first two are the start and end time stamps of the time domain of the fragment. The last three are the coefficients for the second order polynomial (coefficient 0, 1 and 2 respectively). For instance:
S 0 ; name = x position F 0 0 2.2 3 1.2 -0.4 F 0 2.2 2.5 4 -0.3 5
This encodes a single signal with two fragments and gives a piecewise polynomial on the time domain [0, 2.5) with two fragments. The first fragment defines the polynomial on the time domain [0, 2.2) as:
c + b*(t-t0) + a*(t-t0)^2 = 3 + 1.2*t - 0.4*t^2
The second fragment defines the polynomial on the time domain [2.2, 2.5) as:
c + b*(t-t0) + a*(t-t0)^2 = 4 - 0.3*(t-2.2) + 5*(t - 2.2)^2
The time domains of the fragments of a signal as they appear in the file must be consecutive, i.e., no overlap between fragment domains and no gaps between fragment domains. This means that the boundary values must be equal.

## Specifying time-series

Time-series are specified by the `TS`, `TSS`, `TSP` and `TSR` lines. There is exactly one `TS` line for each time-series, and at least one `TSS` line for each time-series. The `TS` line specifies a time-series identifier (unique within the time-series of the trace), and a number of attributes for the time-series. The `TSS` lines specify series within a time-series. A `TSS` line has a time-series identifier that specifies the time-series it belongs to, a series identifier unique within the time-series, and a number of attributes for the time-series. The plot-type for the series can be set using the "type" attribute, which can be either "step", "linear" or "spline". Each series has one or more sets of data-points defined in `TSP` and `TSR` lines. A `TSP` line has a time-series and a series identifier that specify which time-series and series it belongs to. The data-points are specified in one or more time-value pairs separated by whitespace, the time and value in the pair are separated by a comma. A `TSR` line has a time-series and a series identifier that specifies which time-series and series it belongs to. The time-stamps of the data-points are specified by a time range given by a start value and a step size which are separated by a colon. The data values are specified after the time-stamps in a whitespace separated list. For instance:
TS 0 ; name=Velocity TSS 0 0 ; name=Velocity X, color=red, type=step TSP 0 0 0.0,0.4 0.2,0.5 0.4,0.6 TSP 0 0 1.4,0.6 1.6,0.8 1.8,1.0 2.0,1.2 TSS 0 1 ; name=Velocity Y, color=blue, type=linear TSP 0 1 0.0,0.0 1.0,0.0 TSR 0 1 1.1:0.1 0.2 0.4 0.6 0.6 0.5 0.4 0.3 0.2 0.1 0.0
This encodes a time-series named "Velocity" containing two series named "Velocity X" and "Velocity Y". The first series consists of seven data-points at time-stamps 0.0, 0.2, 0.4, 1.4, 1.6, 1.8 and 2.0 and values 0.4, 0.5, 0.6, 0.6, 0.8, 1.0 and 1.2. The second series consists of twelve data-points at time-stamps 0.0, 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9 and 2.0 and values 0.0, 0.0, 0.2, 0.4, 0.6, 0.6, 0.5, 0.4, 0.3, 0.2, 0.1 and 0.0.