X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=plugins%2Fctf%2Ffs-src%2Ffs.h;h=9e9ee84d86fa91fcaac3e267a29b632d2743e42a;hb=c8bc855f3c47d85dfe071d94e6f614d668cbb711;hp=e254aeb4416345b224dd0b31fec4e40df4b6610e;hpb=a74438a424a14a82d734e90ac063cc63ca692517;p=babeltrace.git

diff --git a/plugins/ctf/fs-src/fs.h b/plugins/ctf/fs-src/fs.h
index e254aeb4..9e9ee84d 100644
--- a/plugins/ctf/fs-src/fs.h
+++ b/plugins/ctf/fs-src/fs.h
@@ -29,8 +29,8 @@
  */
 
 #include <stdbool.h>
-#include <babeltrace/babeltrace-internal.h>
-#include <babeltrace/babeltrace.h>
+#include <babeltrace2/babeltrace-internal.h>
+#include <babeltrace2/babeltrace.h>
 #include "data-stream-file.h"
 #include "metadata.h"
 #include "../common/metadata/decoder.h"
@@ -99,6 +99,31 @@ struct ctf_fs_trace {
 	uint64_t next_stream_id;
 };
 
+struct ctf_fs_ds_index_entry {
+	/* Position, in bytes, of the packet from the beginning of the file. */
+	uint64_t offset;
+
+	/* Size of the packet, in bytes. */
+	uint64_t packet_size;
+
+	/*
+	 * Extracted from the packet context, relative to the respective fields'
+	 * mapped clock classes (in cycles).
+	 */
+	uint64_t timestamp_begin, timestamp_end;
+
+	/*
+	 * Converted from the packet context, relative to the trace's EPOCH
+	 * (in ns since EPOCH).
+	 */
+	int64_t timestamp_begin_ns, timestamp_end_ns;
+};
+
+struct ctf_fs_ds_index {
+	/* Array of pointer to struct ctf_fs_fd_index_entry. */
+	GPtrArray *entries;
+};
+
 struct ctf_fs_ds_file_group {
 	/*
 	 * Array of struct ctf_fs_ds_file_info, owned by this.
@@ -122,6 +147,16 @@ struct ctf_fs_ds_file_group {
 
 	/* Weak, belongs to component */
 	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).
+	 */
+	struct ctf_fs_ds_index *index;
 };
 
 struct ctf_fs_port_data {
@@ -164,20 +199,6 @@ bt_query_status ctf_fs_query(
 		const char *object, const bt_value *params,
 		const bt_value **result);
 
-BT_HIDDEN
-struct ctf_fs_trace *ctf_fs_trace_create(bt_self_component_source *self_comp,
-		const char *path, const char *name,
-		struct ctf_fs_metadata_config *config);
-
-BT_HIDDEN
-void ctf_fs_trace_destroy(struct ctf_fs_trace *trace);
-
-BT_HIDDEN
-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
 bt_self_message_iterator_status ctf_fs_iterator_init(
 		bt_self_message_iterator *self_msg_iter,
@@ -197,4 +218,48 @@ BT_HIDDEN
 bt_self_message_iterator_status ctf_fs_iterator_seek_beginning(
 		bt_self_message_iterator *message_iterator);
 
+/* Create and initialize a new, empty ctf_fs_component. */
+
+BT_HIDDEN
+struct ctf_fs_component *ctf_fs_component_create(void);
+
+/*
+ * 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.
+ */
+
+BT_HIDDEN
+int ctf_fs_component_create_ctf_fs_traces(bt_self_component_source *self_comp,
+		struct ctf_fs_component *ctf_fs,
+		const bt_value *paths_value);
+
+/* Free `ctf_fs` and everything it owns. */
+
+BT_HIDDEN
+void ctf_fs_destroy(struct ctf_fs_component *ctf_fs);
+
+/*
+ * Read and validate parameters taken by the src.ctf.fs plugin.
+ *
+ *  - 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.
+ *
+ * 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);
+
+/*
+ * Generate the port name to be used for a given data stream file group.
+ *
+ * The result must be freed using g_free by the caller.
+ */
+
+BT_HIDDEN
+gchar *ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group);
+
 #endif /* BABELTRACE_PLUGIN_CTF_FS_H */