ctf.fs source: add trace file rotation (stream instance ID) support

[babeltrace.git] / plugins / ctf / fs-src / fs.h

diff --git a/plugins/ctf/fs-src/fs.h b/plugins/ctf/fs-src/fs.h
index acc14a1a674bb60c0c32cf4ee798097f6df4533a..02a5edfb53612731e6bdcd5bd448acba59ae0ccb 100644 (file)
--- a/plugins/ctf/fs-src/fs.h
+++ b/plugins/ctf/fs-src/fs.h
@@ -32,31 +32,54 @@
 #include <babeltrace/babeltrace-internal.h>
 #include <babeltrace/graph/component.h>
 #include <babeltrace/graph/clock-class-priority-map.h>
-#include "data-stream.h"
+#include "data-stream-file.h"
 
 BT_HIDDEN
 extern bool ctf_fs_debug;
 
 struct ctf_fs_file {
+       /* Weak, belongs to component */
        struct ctf_fs_component *ctf_fs;
+
+       /* Owned by this */
        GString *path;
+
+       /* Owned by this */
        FILE *fp;
+
        off_t size;
 };
 
 struct ctf_fs_metadata {
+       /* Owned by this */
        struct bt_ctf_trace *trace;
+
+       /* Owned by this */
+       char *text;
+
        uint8_t uuid[16];
        bool is_uuid_set;
        int bo;
-       char *text;
 };
 
-struct ctf_fs_stream {
+struct ctf_fs_ds_file_info {
+       GString *path;
+       uint64_t begin_ns;
+};
+
+struct ctf_fs_ds_file {
+       /* Owned by this */
        struct ctf_fs_file *file;
+
+       /* Owned by this */
        struct bt_ctf_stream *stream;
+
+       /* Owned by this */
        struct bt_clock_class_priority_map *cc_prio_map;
+
+       /* Owned by this */
        struct bt_ctf_notif_iter *notif_iter;
+
        /* A stream is assumed to be indexed. */
        struct index index;
        void *mmap_addr;
@@ -81,21 +104,74 @@ struct ctf_fs_component_options {
        uint64_t clock_offset_ns;
 };
 
-struct ctf_fs_port_data {
-       GString *path;
-};
-
 struct ctf_fs_component {
+       /* Weak, guaranteed to exist */
        struct bt_private_component *priv_comp;
-       GString *trace_path;
+
+       /* Array of struct ctf_fs_port_data *, owned by this */
+       GPtrArray *port_data;
+
+       /* Array of struct ctf_fs_trace *, owned by this */
+       GPtrArray *traces;
+
+       struct ctf_fs_component_options options;
        FILE *error_fp;
        size_t page_size;
-       struct ctf_fs_component_options options;
+};
+
+struct ctf_fs_trace {
+       /* Weak, belongs to component */
+       struct ctf_fs_component *ctf_fs;
+
+       /* Owned by this */
        struct ctf_fs_metadata *metadata;
+
+       /* Owned by this */
        struct bt_clock_class_priority_map *cc_prio_map;
 
-       /* Array of struct ctf_fs_port_data *, owned by this */
-       GPtrArray *port_data;
+       /* Array of struct ctf_fs_ds_file_group *, owned by this */
+       GPtrArray *ds_file_groups;
+
+       /* Owned by this */
+       GString *path;
+
+       /* Owned by this */
+       GString *name;
+};
+
+struct ctf_fs_ds_file_group {
+       /*
+        * Array of struct ctf_fs_ds_file_info, owned by this.
+        *
+        * This is an _ordered_ array of data stream file infos which
+        * belong to this group (a single stream instance).
+        *
+        * You can call ctf_fs_ds_file_create() with one of those paths
+        * and the CTF IR stream below.
+        */
+       GPtrArray *ds_file_infos;
+
+       /* Owned by this */
+       struct bt_ctf_stream *stream;
+
+       /* Weak, belongs to component */
+       struct ctf_fs_trace *ctf_fs_trace;
+};
+
+struct ctf_fs_port_data {
+       /* Weak, belongs to ctf_fs_trace */
+       struct ctf_fs_ds_file_group *ds_file_group;
+};
+
+struct ctf_fs_notif_iter_data {
+       /* Weak, belongs to ctf_fs_trace */
+       struct ctf_fs_ds_file_group *ds_file_group;
+
+       /* Owned by this */
+       struct ctf_fs_ds_file *ds_file;
+
+       /* Which file the iterator is _currently_ operating on */
+       size_t ds_file_info_index;
 };
 
 BT_HIDDEN