Make API CTF-agnostic
[babeltrace.git] / plugins / ctf / fs-src / fs.h
index acc14a1a674bb60c0c32cf4ee798097f6df4533a..c72be5e03dd3000b065ef1521384be843d7a5cfc 100644 (file)
 
 #include <stdbool.h>
 #include <babeltrace/babeltrace-internal.h>
-#include <babeltrace/graph/component.h>
-#include <babeltrace/graph/clock-class-priority-map.h>
-#include "data-stream.h"
+#include <babeltrace/babeltrace.h>
+#include "data-stream-file.h"
+#include "metadata.h"
+#include "../common/metadata/decoder.h"
 
 BT_HIDDEN
 extern bool ctf_fs_debug;
 
 struct ctf_fs_file {
-       struct ctf_fs_component *ctf_fs;
+       /* Owned by this */
        GString *path;
+
+       /* Owned by this */
        FILE *fp;
+
        off_t size;
 };
 
 struct ctf_fs_metadata {
-       struct bt_ctf_trace *trace;
+       /* Owned by this */
+       struct ctf_metadata_decoder *decoder;
+
+       /* Owned by this */
+       struct bt_trace *trace;
+
+       /* Weak (owned by `decoder` above) */
+       struct ctf_trace_class *tc;
+
+       /* Owned by this */
+
+       /* Owned by this */
+       char *text;
+
        uint8_t uuid[16];
        bool is_uuid_set;
        int bo;
-       char *text;
 };
 
-struct ctf_fs_stream {
-       struct ctf_fs_file *file;
-       struct bt_ctf_stream *stream;
-       struct bt_clock_class_priority_map *cc_prio_map;
-       struct bt_ctf_notif_iter *notif_iter;
-       /* A stream is assumed to be indexed. */
-       struct index index;
-       void *mmap_addr;
-       /* Max length of chunk to mmap() when updating the current mapping. */
-       size_t mmap_max_len;
-       /* Length of the current mapping. */
-       size_t mmap_len;
-       /* Length of the current mapping which *exists* in the backing file. */
-       size_t mmap_valid_len;
-       /* Offset in the file where the current mapping starts. */
-       off_t mmap_offset;
+struct ctf_fs_component {
+       /* Weak, guaranteed to exist */
+       struct bt_private_component *priv_comp;
+
+       /* 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_metadata_config metadata_config;
+};
+
+struct ctf_fs_trace {
+       /* Owned by this */
+       struct ctf_fs_metadata *metadata;
+
+       /* 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;
+
+       /* Next automatic stream ID when not provided by packet header */
+       uint64_t next_stream_id;
+};
+
+struct ctf_fs_ds_file_group {
        /*
-        * Offset, in the current mapping, of the address to return on the next
-        * request.
+        * 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.
         */
-       off_t request_offset;
-       bool end_reached;
-};
+       GPtrArray *ds_file_infos;
+
+       /* Owned by this */
+       struct bt_stream_class *stream_class;
 
-struct ctf_fs_component_options {
-       uint64_t clock_offset;
-       uint64_t clock_offset_ns;
+       /* Owned by this */
+       struct bt_stream *stream;
+
+       /* Stream (instance) ID; -1ULL means none */
+       uint64_t stream_id;
+
+       /* Weak, belongs to component */
+       struct ctf_fs_trace *ctf_fs_trace;
 };
 
 struct ctf_fs_port_data {
-       GString *path;
+       /* Weak, belongs to ctf_fs_trace */
+       struct ctf_fs_ds_file_group *ds_file_group;
+
+       /* Weak */
+       struct ctf_fs_component *ctf_fs;
 };
 
-struct ctf_fs_component {
-       struct bt_private_component *priv_comp;
-       GString *trace_path;
-       FILE *error_fp;
-       size_t page_size;
-       struct ctf_fs_component_options options;
-       struct ctf_fs_metadata *metadata;
-       struct bt_clock_class_priority_map *cc_prio_map;
+struct ctf_fs_notif_iter_data {
+       /* Weak */
+       struct bt_private_connection_private_notification_iterator *pc_notif_iter;
 
-       /* Array of struct ctf_fs_port_data *, owned by this */
-       GPtrArray *port_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;
+
+       /* Owned by this */
+       struct bt_notif_iter *notif_iter;
+
+       /* True to skip BT_NOTIFICATION_TYPE_STREAM_BEGIN notifications */
+       bool skip_stream_begin_notifs;
 };
 
 BT_HIDDEN
@@ -106,17 +159,35 @@ BT_HIDDEN
 void ctf_fs_finalize(struct bt_private_component *component);
 
 BT_HIDDEN
-enum bt_notification_iterator_status ctf_fs_iterator_init(
-               struct bt_private_notification_iterator *it,
-               struct bt_private_port *port);
+struct bt_component_class_query_method_return ctf_fs_query(
+               struct bt_component_class *comp_class,
+               struct bt_query_executor *query_exec,
+               const char *object, struct bt_value *params);
 
-void ctf_fs_iterator_finalize(struct bt_private_notification_iterator *it);
+BT_HIDDEN
+struct ctf_fs_trace *ctf_fs_trace_create(const char *path, const char *name,
+               struct ctf_fs_metadata_config *config, struct bt_graph *graph);
 
-struct bt_notification_iterator_next_return ctf_fs_iterator_next(
-               struct bt_private_notification_iterator *iterator);
+BT_HIDDEN
+void ctf_fs_trace_destroy(struct ctf_fs_trace *trace);
 
 BT_HIDDEN
-struct bt_value *ctf_fs_query(struct bt_component_class *comp_class,
-               const char *object, struct bt_value *params);
+int ctf_fs_find_traces(GList **trace_paths, const char *start_path);
+
+BT_HIDDEN
+GList *ctf_fs_create_trace_names(GList *trace_paths, const char *base_path);
+
+BT_HIDDEN
+enum bt_notification_iterator_status ctf_fs_iterator_init(
+               struct bt_private_connection_private_notification_iterator *it,
+               struct bt_private_port *port);
+BT_HIDDEN
+void ctf_fs_iterator_finalize(struct bt_private_connection_private_notification_iterator *it);
+
+BT_HIDDEN
+enum bt_notification_iterator_status ctf_fs_iterator_next(
+               struct bt_private_connection_private_notification_iterator *iterator,
+               bt_notification_array notifs, uint64_t capacity,
+               uint64_t *count);
 
 #endif /* BABELTRACE_PLUGIN_CTF_FS_H */
This page took 0.026351 seconds and 4 git commands to generate.