X-Git-Url: http://git.efficios.com/?p=ctf.git;a=blobdiff_plain;f=common-trace-format-specification.md;h=b40082c72f8488c72577d9f1c8fa365e5e4e7020;hp=fd49e593742b443e59dad592d5d8f83e7f5e8b26;hb=HEAD;hpb=9ab09151d64ea4e124474648f6d715e55e3c34dc diff --git a/common-trace-format-specification.md b/common-trace-format-specification.md index fd49e59..d467f6a 100644 --- a/common-trace-format-specification.md +++ b/common-trace-format-specification.md @@ -1,4 +1,4 @@ -# Common Trace Format (CTF) Specification (v1.8.2) +# Common Trace Format (CTF) Specification (v1.8.3) **Author**: Mathieu Desnoyers, [EfficiOS Inc.](http://www.efficios.com/) @@ -464,6 +464,9 @@ enum { } ~~~ +An enumeration field can have an integral value for which the associated +enumeration type does not map to a string. + ### 4.2 Compound types Compound are aggregation of type declarations. Compound types include @@ -832,11 +835,14 @@ 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 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 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 greater 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 @@ -1539,11 +1545,11 @@ The `offset_s` and `offset` fields indicate the offset from POSIX.1 Epoch, 1970-01-01 00:00:00 +0000 (UTC), to the zero of value of the clock. The `offset_s` field is in seconds. The `offset` field is in (1/freq) units. If any of the `offset_s` or `offset` field is not -present, it is assigned the 0 value. The field `absolute` is `TRUE` if -the clock is a global reference across different clock UUID -(e.g. NTP time). Otherwise, `absolute` is `FALSE`, and the clock can -be considered as synchronized only with other clocks that have the same -UUID. +present, it is assigned the 0 value. Both `offset_s` and `offset` +fields are signed integers. The field `absolute` is `TRUE` if the clock +is a global reference across different clock UUID (e.g. NTP time). +Otherwise, `absolute` is `FALSE`, and the clock can be considered as +synchronized only with other clocks that have the same UUID. Secondly, a reference to this clock should be added within an integer type: @@ -1575,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 @@ -1584,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