X-Git-Url: http://git.efficios.com/?p=ctf.git;a=blobdiff_plain;f=common-trace-format-specification.md;h=9b230af06462cfe289450e8edec5dc17a0826408;hp=d98417601c11be852d72231d3e7a5f3dbe1e0860;hb=ed8509fc3bdc87500e78fd93c617aa0b867a4266;hpb=941a19cf5bf3edcb8ed6db218f3297644f5aa8a0 diff --git a/common-trace-format-specification.md b/common-trace-format-specification.md index d984176..9b230af 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 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 @@ -833,10 +836,13 @@ 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 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 @@ -886,13 +892,13 @@ trace { }; ~~~ -If the magic number is not present, tools such as `file` will have no -mean to discover the file type. +If the magic number (`magic` field) is not present, +tools such as `file` will have no mean to discover the file type. -If the uuid is not present, no validation that the metadata actually -corresponds to the stream is performed. +If the `uuid` field is not present, no validation that the metadata +actually corresponds to the stream is performed. -If the stream_id packet header field is missing, the trace can only +If the `stream_id` packet header field is missing, the trace can only contain a single stream. Its `id` field can be left out, and its events don't need to declare a `stream_id` field. @@ -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