X-Git-Url: http://git.efficios.com/?p=ctf.git;a=blobdiff_plain;f=common-trace-format-specification.txt;h=d3b354a5a63647b1f5794f9c35ffbe0cee683def;hp=e0944b5d84b6491e33c6e9c0b6b889b0751b845b;hb=8f34dd4fad5677f71397e56954881bcb0ab4e9ec;hpb=0cedf6e545d9cb736218fed5832a2a9ae81b5ef1 diff --git a/common-trace-format-specification.txt b/common-trace-format-specification.txt index e0944b5..d3b354a 100644 --- a/common-trace-format-specification.txt +++ b/common-trace-format-specification.txt @@ -118,11 +118,10 @@ trace event types expressed in the Trace Stream Description Language 3. Event stream An event stream can be divided into contiguous event packets of variable -size. These subdivisions have a variable size. An event packet can -contain a certain amount of padding at the end. The stream header is -repeated at the beginning of each event packet. The rationale for the -event stream design choices is explained in Appendix B. Stream Header -Rationale. +size. An event packet can contain a certain amount of padding at the +end. The stream header is repeated at the beginning of each event +packet. The rationale for the event stream design choices is explained +in Appendix B. Stream Header Rationale. The event stream header will therefore be referred to as the "event packet header" throughout the rest of this document. @@ -172,7 +171,7 @@ TSDL meta-data attribute representation of a specific alignment: 4.1.3 Byte order -By default, the native endianness of the source architecture the trace is used. +By default, the native endianness of the source architecture is used. Byte order can be overridden for a basic type by specifying a "byte_order" attribute. Typical use-case is to specify the network byte order (big endian: "be") to save data captured from the network into the trace without conversion. @@ -691,11 +690,15 @@ Event packet context (all fields are optional, specified by TSDL meta-data): include all event timestamps assigned to events contained within the packet. - 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 prior to - the first event in the event packet. - * Note: producer-consumer buffer full condition should fill the current + events discarded that were supposed to be written in the stream after + the last event in the event packet. + * Note: producer-consumer buffer full condition can fill the current event packet with padding so we know exactly where events have been - discarded. + discarded. However, if the buffer full condition chooses not + to fill the current event packet with padding, all we know + about the timestamp range in which the events have been + discarded is that it is somewhere between the beginning and + the end of the packet. - Lossless compression scheme used for the event packet content. Applied directly to raw data. New types of compression can be added in following versions of the format.