= babeltrace2-source.ctf.fs(7)
:manpagetype: component class
-:revdate: 14 September 2019
+:revdate: 1 September 2023
== NAME
CTF data stream (LTTng's trace file rotation and tracing session
rotation can cause this).
+If two or more data stream files contain the same packets, a
+compcls:source.ctf.fs message iterator reads each of them only once so
+that it never emits duplicated messages. This feature makes it possible,
+for example, to open overlapping
+https://lttng.org/docs/#doc-taking-a-snapshot[LTTng snapshots] with a
+single compcls:source.ctf.fs component and silently discard the
+duplicated packets.
+
=== Trace quirks
--
+=== CTF compliance
+
+A compcls:source.ctf.fs component decodes traces as per
+https://diamon.org/ctf/v1.8.3/[CTF~1.8.3], except:
+
+* It only supports integer field classes (TSDL `integer` block) with
+ sizes from 1 to 64.
+
+* It only supports 32-bit and 64-bit floating point number classes (TSDL
+ `floating_point` block).
+
+* It doesn't support ยง~4.1.6 (``GNU/C bitfields'').
+
+* It doesn't support TSDL `callsite` blocks: the parser simply ignores
+ them.
+
+* It only supports a single clock class (TSDL `clock` block) reference
+ per stream class (TSDL `stream` block).
+
+* It doesn't support the checksum, compression, and encryption features
+ of metadata stream packets.
+
+
== INITIALIZATION PARAMETERS
param:clock-class-offset-ns='NS' vtype:[optional signed integer]::
You can combine this parameter with the param:clock-class-offset-ns
parameter.
-param:force-clock-class-origin-unix-epoch=`yes` vtype:[optional boolean]::
- Force the origin of all clock classes that the component creates to
- have a Unix epoch origin, whatever the detected tracer.
+param:force-clock-class-origin-unix-epoch='VAL' vtype:[optional boolean]::
+ If 'VAL' is true, then force the origin of all clock classes that
+ the component creates to have a Unix epoch origin, whatever the
+ detected tracer.
++
+Default: false.
param:inputs='DIRS' vtype:[array of strings]::
Open and read the physical CTF traces located in 'DIRS'.