Move to kernel style SPDX license identifiers

[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 e48c1469a613c4b5cc16e12c3d99c081f040f379..e7cffe512b06e657bc338ffbd889a271b0141591 100644 (file)
--- a/src/plugins/ctf/fs-src/fs.h
+++ b/src/plugins/ctf/fs-src/fs.h
@@ -1,33 +1,15 @@
-#ifndef BABELTRACE_PLUGIN_CTF_FS_H
-#define BABELTRACE_PLUGIN_CTF_FS_H
-
 /*
- * BabelTrace - CTF on File System Component
+ * SPDX-License-Identifier: MIT
  *
  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
  *
- * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
+ * BabelTrace - CTF on File System Component
  */
 
+#ifndef BABELTRACE_PLUGIN_CTF_FS_H
+#define BABELTRACE_PLUGIN_CTF_FS_H
+
 #include <stdbool.h>
 #include "common/macros.h"
 #include <babeltrace2/babeltrace.h>
@@ -84,8 +66,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 +111,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 +148,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,23 +168,27 @@ 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);
@@ -213,22 +204,22 @@ 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_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. */