Fix: src.ctf.fs: use BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE when applicable

[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 8819f018775dd443b442e553a426d4ea24ff1098..378fe7f4bc283a42e55fc5fe87d137c358f0051c 100644 (file)
--- a/src/plugins/ctf/fs-src/fs.h
+++ b/src/plugins/ctf/fs-src/fs.h
@@ -63,8 +63,6 @@ struct ctf_fs_metadata {
        /* Weak (owned by `decoder` above) */
        struct ctf_trace_class *tc;
 
-       /* Owned by this */
-
        /* Owned by this */
        char *text;
 
@@ -74,17 +72,11 @@ struct ctf_fs_metadata {
 struct ctf_fs_component {
        bt_logging_level log_level;
 
-       /* Weak, guaranteed to exist */
-       bt_self_component_source *self_comp_src;
-
-       /* Weak */
-       bt_self_component *self_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;
+       /* Owned by this */
+       struct ctf_fs_trace *trace;
 
        struct ctf_fs_metadata_config metadata_config;
 };
@@ -92,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 is
+        * set.
+        */
        bt_self_component *self_comp;
+       bt_self_component_class *self_comp_class;
 
        /* Owned by this */
        struct ctf_fs_metadata *metadata;
@@ -107,14 +104,14 @@ struct ctf_fs_trace {
        /* 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_index_entry {
+       /* Weak, belongs to ctf_fs_ds_file_info. */
+       const char *path;
+
        /* Position, in bytes, of the packet from the beginning of the file. */
        uint64_t offset;
 
@@ -205,24 +202,25 @@ struct ctf_fs_msg_iter_data {
 };
 
 BT_HIDDEN
-bt_self_component_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
 void ctf_fs_finalize(bt_self_component_source *component);
 
 BT_HIDDEN
-bt_query_status ctf_fs_query(
+bt_component_class_query_method_status ctf_fs_query(
                bt_self_component_class_source *comp_class,
-               const bt_query_executor *query_exec,
+               bt_private_query_executor *priv_query_exec,
                const char *object, const bt_value *params,
-               bt_logging_level log_level,
-               const bt_value **result);
+               void *method_data, const bt_value **result);
 
 BT_HIDDEN
-bt_self_message_iterator_status ctf_fs_iterator_init(
+bt_component_class_message_iterator_initialize_method_status ctf_fs_iterator_init(
                bt_self_message_iterator *self_msg_iter,
+               bt_self_message_iterator_configuration *config,
                bt_self_component_source *self_comp,
                bt_self_component_port_output *self_port);
 
@@ -230,13 +228,13 @@ BT_HIDDEN
 void ctf_fs_iterator_finalize(bt_self_message_iterator *it);
 
 BT_HIDDEN
-bt_self_message_iterator_status ctf_fs_iterator_next(
+bt_component_class_message_iterator_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_self_message_iterator_status ctf_fs_iterator_seek_beginning(
+bt_component_class_message_iterator_seek_beginning_method_status ctf_fs_iterator_seek_beginning(
                bt_self_message_iterator *message_iterator);
 
 /* Create and initialize a new, empty ctf_fs_component. */
@@ -246,15 +244,24 @@ struct ctf_fs_component *ctf_fs_component_create(bt_logging_level log_level,
                bt_self_component *self_comp);
 
 /*
- * Search recursively under all paths in `paths_value` (an array of strings),
- * for CTF traces. For each CTF trace found, create a ctf_fs_trace in
- * `ctf_fs` representing that trace.
+ * Create one `struct ctf_fs_trace` from one trace, or multiple traces sharing
+ * the same UUID.
+ *
+ * `paths_value` must be an array of strings,
+ *
+ * The created `struct ctf_fs_trace` is assigned to `ctf_fs->trace`.
+ *
+ * `self_comp` and `self_comp_class` are used for logging, only one of them
+ * should be set.
  */
 
 BT_HIDDEN
-int ctf_fs_component_create_ctf_fs_traces(bt_self_component_source *self_comp,
+int ctf_fs_component_create_ctf_fs_trace(
                struct ctf_fs_component *ctf_fs,
-               const bt_value *paths_value);
+               const bt_value *paths_value,
+               const bt_value *trace_name_value,
+               bt_self_component *self_comp,
+               bt_self_component_class *self_comp_class);
 
 /* Free `ctf_fs` and everything it owns. */
 
@@ -267,13 +274,22 @@ 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.
  *
  * Return true on success, false if any parameter didn't pass validation.
  */
 
 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);
 
 /*
  * Generate the port name to be used for a given data stream file group.