lib: introduce bt_message_iterator_class

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

diff --git a/src/plugins/ctf/fs-src/fs.h b/src/plugins/ctf/fs-src/fs.h
index e40f4ce78adfd6c138a2a4fe09b3d815163657fa..763136afef7be989fe7b2861f523c2179bbf7ba0 100644 (file)
--- a/src/plugins/ctf/fs-src/fs.h
+++ b/src/plugins/ctf/fs-src/fs.h
@@ -84,8 +84,13 @@ struct ctf_fs_component {
 struct ctf_fs_trace {
        bt_logging_level log_level;
 
-       /* Weak */
+       /*
+        * Weak. These are mostly used to generate log messages or to append
+        * error causes. They are mutually exclusive, only one of them must be
+        * set.
+        */
        bt_self_component *self_comp;
+       bt_self_component_class *self_comp_class;
 
        /* Owned by this */
        struct ctf_fs_metadata *metadata;
@@ -124,10 +129,15 @@ struct ctf_fs_ds_index_entry {
         * (in ns since EPOCH).
         */
        int64_t timestamp_begin_ns, timestamp_end_ns;
+
+       /*
+        * Packet sequence number, or UINT64_MAX if not present in the index.
+        */
+       uint64_t packet_seq_num;
 };
 
 struct ctf_fs_ds_index {
-       /* Array of pointer to struct ctf_fs_fd_index_entry. */
+       /* Array of pointer to struct ctf_fs_ds_index_entry. */
        GPtrArray *entries;
 };
 
@@ -156,12 +166,7 @@ struct ctf_fs_ds_file_group {
        struct ctf_fs_trace *ctf_fs_trace;
 
        /*
-        * Owned by this. May be NULL.
-        *
-        * A stream cannot be assumed to be indexed as the indexing might have
-        * been skipped. Moreover, the index's fields may not all be available
-        * depending on the producer (e.g. timestamp_begin/end are not
-        * mandatory).
+        * Owned by this.
         */
        struct ctf_fs_ds_index *index;
 };
@@ -181,24 +186,29 @@ struct ctf_fs_msg_iter_data {
        bt_self_component *self_comp;
 
        /* Weak */
-       bt_self_message_iterator *pc_msg_iter;
+       bt_self_message_iterator *self_msg_iter;
 
        /* 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;
+       struct ctf_msg_iter *msg_iter;
 
-       /* Which file the iterator is _currently_ operating on */
-       size_t ds_file_info_index;
+       /*
+        * Saved error.  If we hit an error in the _next method, but have some
+        * messages ready to return, we save the error here and return it on
+        * the next _next call.
+        */
+       bt_message_iterator_class_next_method_status next_saved_status;
+       const struct bt_error *next_saved_error;
 
-       /* Owned by this */
-       struct bt_msg_iter *msg_iter;
+       struct ctf_fs_ds_group_medops_data *msg_iter_medops_data;
 };
 
 BT_HIDDEN
-bt_component_class_init_method_status ctf_fs_init(
+bt_component_class_initialize_method_status ctf_fs_init(
                bt_self_component_source *source,
+               bt_self_component_source_configuration *config,
                const bt_value *params, void *init_method_data);
 
 BT_HIDDEN
@@ -212,22 +222,23 @@ bt_component_class_query_method_status ctf_fs_query(
                void *method_data, const bt_value **result);
 
 BT_HIDDEN
-bt_component_class_message_iterator_init_method_status ctf_fs_iterator_init(
+bt_message_iterator_class_initialize_method_status ctf_fs_iterator_init(
                bt_self_message_iterator *self_msg_iter,
-               bt_self_component_source *self_comp,
+               bt_self_message_iterator_configuration *config,
+               bt_self_component *self_comp,
                bt_self_component_port_output *self_port);
 
 BT_HIDDEN
 void ctf_fs_iterator_finalize(bt_self_message_iterator *it);
 
 BT_HIDDEN
-bt_component_class_message_iterator_next_method_status ctf_fs_iterator_next(
+bt_message_iterator_class_next_method_status ctf_fs_iterator_next(
                bt_self_message_iterator *iterator,
                bt_message_array_const msgs, uint64_t capacity,
                uint64_t *count);
 
 BT_HIDDEN
-bt_component_class_message_iterator_seek_beginning_method_status ctf_fs_iterator_seek_beginning(
+bt_message_iterator_class_seek_beginning_method_status ctf_fs_iterator_seek_beginning(
                bt_self_message_iterator *message_iterator);
 
 /* Create and initialize a new, empty ctf_fs_component. */
@@ -252,6 +263,7 @@ BT_HIDDEN
 int ctf_fs_component_create_ctf_fs_trace(
                struct ctf_fs_component *ctf_fs,
                const bt_value *paths_value,
+               const bt_value *trace_name_value,
                bt_self_component *self_comp,
                bt_self_component_class *self_comp_class);
 
@@ -266,6 +278,8 @@ void ctf_fs_destroy(struct ctf_fs_component *ctf_fs);
  *  - The mandatory `paths` parameter is returned in `*paths`.
  *  - The optional `clock-class-offset-s` and `clock-class-offset-ns`, if
  *    present, are recorded in the `ctf_fs` structure.
+ *  - The optional `trace-name` parameter is returned in `*trace_name` if
+ *    present, else `*trace_name` is set to NULL.
  *
  * `self_comp` and `self_comp_class` are used for logging, only one of them
  * should be set.
@@ -275,7 +289,9 @@ void ctf_fs_destroy(struct ctf_fs_component *ctf_fs);
 
 BT_HIDDEN
 bool read_src_fs_parameters(const bt_value *params,
-               const bt_value **paths, struct ctf_fs_component *ctf_fs,
+               const bt_value **paths,
+               const bt_value **trace_name,
+               struct ctf_fs_component *ctf_fs,
                bt_self_component *self_comp,
                bt_self_component_class *self_comp_class);