"destroy" method -> "finalize" method

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

diff --git a/plugins/ctf/fs/fs.h b/plugins/ctf/fs/fs.h
index f4bd86c9d9b515065be5bf2d6a0e447a7e4801fa..769ab70563c79492e5aeb21797ba772b3fdf1e87 100644 (file)
--- a/plugins/ctf/fs/fs.h
+++ b/plugins/ctf/fs/fs.h
@@ -29,13 +29,14 @@
  */
 
 #include <babeltrace/babeltrace-internal.h>
-#include <babeltrace/plugin/component.h>
+#include <babeltrace/component/component.h>
+#include "data-stream.h"
 
-#define CTF_FS_COMPONENT_NAME "fs"
 #define CTF_FS_COMPONENT_DESCRIPTION \
        "Component used to read a CTF trace located on a file system."
 
-static bool ctf_fs_debug;
+BT_HIDDEN
+extern bool ctf_fs_debug;
 
 struct bt_notification_heap;
 
@@ -59,19 +60,37 @@ struct ctf_fs_stream {
        struct bt_ctf_stream *stream;
        /* FIXME There should be many and ctf_fs_stream should not own them. */
        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;
+       /*
+        * Offset, in the current mapping, of the address to return on the next
+        * request.
+        */
        off_t request_offset;
        bool end_reached;
 };
 
-struct ctf_fs_data_stream {
-       GPtrArray *streams;
-};
-
 struct ctf_fs_iterator {
        struct bt_notification_heap *pending_notifications;
+       struct bt_notification *current_notification;
+       /*
+        * struct ctf_fs_data_stream* which have not yet been associated to a
+        * bt_ctf_stream. The association is performed on the first packet
+        * read by the stream (since, at that point, we have read a packet
+        * header).
+        */
+       GPtrArray *pending_streams;
+       /* bt_ctf_stream -> ctf_fs_stream */
+       GHashTable *stream_ht;
 };
 
 struct ctf_fs_component_options {
@@ -82,14 +101,33 @@ struct ctf_fs_component {
        GString *trace_path;
        FILE *error_fp;
        size_t page_size;
-       struct bt_notification *current_notification;
-       struct ctf_fs_metadata metadata;
-       struct ctf_fs_data_stream data_stream;
        struct ctf_fs_component_options options;
+       struct ctf_fs_metadata *metadata;
 };
 
 BT_HIDDEN
-enum bt_component_status ctf_fs_init(struct bt_component *source,
-               struct bt_value *params);
+enum bt_component_status ctf_fs_init(struct bt_private_component *source,
+               struct bt_value *params, void *init_method_data);
+
+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_component *source,
+               struct bt_private_port *port,
+               struct bt_private_notification_iterator *it);
+
+void ctf_fs_iterator_finalize(struct bt_private_notification_iterator *it);
+
+enum bt_notification_iterator_status ctf_fs_iterator_next(
+               struct bt_private_notification_iterator *iterator);
+
+struct bt_notification *ctf_fs_iterator_get(
+               struct bt_private_notification_iterator *iterator);
+
+BT_HIDDEN
+struct bt_value *ctf_fs_query(struct bt_component_class *comp_class,
+               const char *object, struct bt_value *params);
 
 #endif /* BABELTRACE_PLUGIN_CTF_FS_H */