From patchwork Tue Apr 28 19:12:24 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mathieu Desnoyers X-Patchwork-Id: 3713053 From: mathieu.desnoyers at efficios.com (Mathieu Desnoyers) Date: Tue, 28 Apr 2020 15:12:24 -0400 Subject: [lttng-dev] [RFC PATCH CTF 1/4] Clarify that unlisted enumeration values are allowed Message-ID: <20200428191227.16560-1-mathieu.desnoyers@efficios.com> Signed-off-by: Mathieu Desnoyers --- common-trace-format-specification.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/common-trace-format-specification.md b/common-trace-format-specification.md index fd49e59..d6d196c 100644 --- a/common-trace-format-specification.md +++ b/common-trace-format-specification.md @@ -464,6 +464,9 @@ enum { } ~~~ +An enumeration field can have an integral value which its type does not +map to a string. + ### 4.2 Compound types Compound are aggregation of type declarations. Compound types include From patchwork Tue Apr 28 19:12:25 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mathieu Desnoyers X-Patchwork-Id: 3713052 From: mathieu.desnoyers at efficios.com (Mathieu Desnoyers) Date: Tue, 28 Apr 2020 15:12:25 -0400 Subject: [lttng-dev] [RFC PATCH CTF 2/4] Clarify monotonicity requirement on timestamp begin In-Reply-To: <20200428191227.16560-1-mathieu.desnoyers@efficios.com> References: <20200428191227.16560-1-mathieu.desnoyers@efficios.com> Message-ID: <20200428191227.16560-2-mathieu.desnoyers@efficios.com> Signed-off-by: Mathieu Desnoyers --- common-trace-format-specification.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/common-trace-format-specification.md b/common-trace-format-specification.md index d6d196c..55d0601 100644 --- a/common-trace-format-specification.md +++ b/common-trace-format-specification.md @@ -836,10 +836,12 @@ TSDL metadata): range between these timestamps should include all event timestamps assigned to events contained within the packet. The timestamp at the beginning of an event packet is guaranteed to be below or equal the - timestamp at the end of that event packet. The timestamp at the end - of an event packet is guaranteed to be below or equal the - timestamps at the end of any following packet within the same stream. - See [Clocks](#spec8) for more detail. + timestamp at the end of that event packet. The timestamp at the + beginning of an event packet is guaranteed to be above or equal the + timestamps at the beginning of any prior packet within the same + stream. The timestamp at the end of an event packet is guaranteed to + be below or equal the timestamps at the end of any following packet + within the same stream. See [Clocks](#spec8) for more detail. * **Events discarded count**. Snapshot of a per-stream free-running counter, counting the number of events discarded that were supposed to be written in the stream after the last event in From patchwork Tue Apr 28 19:12:26 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mathieu Desnoyers X-Patchwork-Id: 3713054 From: mathieu.desnoyers at efficios.com (Mathieu Desnoyers) Date: Tue, 28 Apr 2020 15:12:26 -0400 Subject: [lttng-dev] [RFC PATCH CTF 3/4] Clarify that timestamp begin/end need to be complete clock values In-Reply-To: <20200428191227.16560-1-mathieu.desnoyers@efficios.com> References: <20200428191227.16560-1-mathieu.desnoyers@efficios.com> Message-ID: <20200428191227.16560-3-mathieu.desnoyers@efficios.com> Signed-off-by: Mathieu Desnoyers --- common-trace-format-specification.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/common-trace-format-specification.md b/common-trace-format-specification.md index 55d0601..5732e92 100644 --- a/common-trace-format-specification.md +++ b/common-trace-format-specification.md @@ -837,11 +837,12 @@ TSDL metadata): assigned to events contained within the packet. The timestamp at the beginning of an event packet is guaranteed to be below or equal the timestamp at the end of that event packet. The timestamp at the - beginning of an event packet is guaranteed to be above or equal the - timestamps at the beginning of any prior packet within the same - stream. The timestamp at the end of an event packet is guaranteed to - be below or equal the timestamps at the end of any following packet - within the same stream. See [Clocks](#spec8) for more detail. + beginning of an event packet is guaranteed to be grater than or + equal to timestamps at the beginning of any prior packet within the + same stream. The timestamp at the end of an event packet is + guaranteed to be less than or equal to the timestamps at the end of + any following packet within the same stream. See [Clocks](#spec8) + for more detail. * **Events discarded count**. Snapshot of a per-stream free-running counter, counting the number of events discarded that were supposed to be written in the stream after the last event in @@ -1580,7 +1581,8 @@ stream { }; ~~~ -For a N-bit integer type referring to a clock, if the integer overflows +Within the stream event context, event context, and event payload, +fields of N-bit integer type referring to a clock, if the integer overflows compared to the N low order bits of the clock prior value found in the same stream, then it is assumed that one, and only one, overflow occurred. It is therefore important that events encoding time on a small @@ -1589,8 +1591,8 @@ N-bit overflow occurs. In a packet context, clock field names ending with `_begin` and `_end` have a special meaning: this refers to the timestamps at, respectively, -the beginning and the end of each packet. - +the beginning and the end of each packet. Those are required to be +complete representations of the clock value. ## A. Helper macros From patchwork Tue Apr 28 19:12:27 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mathieu Desnoyers X-Patchwork-Id: 3713055 From: mathieu.desnoyers at efficios.com (Mathieu Desnoyers) Date: Tue, 28 Apr 2020 15:12:27 -0400 Subject: [lttng-dev] [RFC PATCH CTF 4/4] Use the formulation "less than or equal to" rather than "below or equal" In-Reply-To: <20200428191227.16560-1-mathieu.desnoyers@efficios.com> References: <20200428191227.16560-1-mathieu.desnoyers@efficios.com> Message-ID: <20200428191227.16560-4-mathieu.desnoyers@efficios.com> Signed-off-by: Mathieu Desnoyers --- common-trace-format-specification.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/common-trace-format-specification.md b/common-trace-format-specification.md index 5732e92..8a3a745 100644 --- a/common-trace-format-specification.md +++ b/common-trace-format-specification.md @@ -835,9 +835,9 @@ TSDL metadata): while (or after) writing the last event in the packet. The inclusive range between these timestamps should include all event timestamps assigned to events contained within the packet. The timestamp at the - beginning of an event packet is guaranteed to be below or equal the - timestamp at the end of that event packet. The timestamp at the - beginning of an event packet is guaranteed to be grater than or + beginning of an event packet is guaranteed to be less than or equal + to the timestamp at the end of that event packet. The timestamp at + the beginning of an event packet is guaranteed to be grater than or equal to timestamps at the beginning of any prior packet within the same stream. The timestamp at the end of an event packet is guaranteed to be less than or equal to the timestamps at the end of