* SOFTWARE.
*/
+#include <stdbool.h>
#include <babeltrace/babeltrace-internal.h>
-#include <babeltrace/graph/component.h>
-#include <babeltrace/graph/clock-class-priority-map.h>
-#include "data-stream.h"
+#include <babeltrace/babeltrace.h>
+#include "data-stream-file.h"
+#include "metadata.h"
+#include "../common/metadata/decoder.h"
BT_HIDDEN
extern bool ctf_fs_debug;
struct ctf_fs_file {
- struct ctf_fs_component *ctf_fs;
+ /* Owned by this */
GString *path;
+
+ /* Owned by this */
FILE *fp;
+
off_t size;
};
struct ctf_fs_metadata {
- struct bt_ctf_trace *trace;
- uint8_t uuid[16];
- bool is_uuid_set;
- int bo;
+ /* Owned by this */
+ struct ctf_metadata_decoder *decoder;
+
+ /* Owned by this */
+ bt_trace_class *trace_class;
+
+ /* Weak (owned by `decoder` above) */
+ struct ctf_trace_class *tc;
+
+ /* Owned by this */
+
+ /* Owned by this */
char *text;
+
+ int bo;
+};
+
+struct ctf_fs_component {
+ /* Weak, guaranteed to exist */
+ bt_self_component_source *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;
+
+ struct ctf_fs_metadata_config metadata_config;
+};
+
+struct ctf_fs_trace {
+ /* Owned by this */
+ struct ctf_fs_metadata *metadata;
+
+ /* Owned by this */
+ bt_trace *trace;
+
+ /* Array of struct ctf_fs_ds_file_group *, owned by this */
+ GPtrArray *ds_file_groups;
+
+ /* 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_stream {
- struct ctf_fs_file *file;
- struct bt_ctf_stream *stream;
- struct bt_clock_class_priority_map *cc_prio_map;
- 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;
+struct ctf_fs_ds_file_group {
/*
- * Offset, in the current mapping, of the address to return on the next
- * request.
+ * Array of struct ctf_fs_ds_file_info, owned by this.
+ *
+ * This is an _ordered_ array of data stream file infos which
+ * belong to this group (a single stream instance).
+ *
+ * You can call ctf_fs_ds_file_create() with one of those paths
+ * and the trace IR stream below.
*/
- off_t request_offset;
- bool end_reached;
-};
+ GPtrArray *ds_file_infos;
-struct ctf_fs_component_options {
- uint64_t clock_offset;
- uint64_t clock_offset_ns;
+ /* Owned by this */
+ struct ctf_stream_class *sc;
+
+ /* Owned by this */
+ bt_stream *stream;
+
+ /* Stream (instance) ID; -1ULL means none */
+ uint64_t stream_id;
+
+ /* Weak, belongs to component */
+ struct ctf_fs_trace *ctf_fs_trace;
};
struct ctf_fs_port_data {
- GString *path;
+ /* Weak, belongs to ctf_fs_trace */
+ struct ctf_fs_ds_file_group *ds_file_group;
+
+ /* Weak */
+ struct ctf_fs_component *ctf_fs;
};
-struct ctf_fs_component {
- struct bt_private_component *priv_comp;
- GString *trace_path;
- FILE *error_fp;
- size_t page_size;
- struct ctf_fs_component_options options;
- struct ctf_fs_metadata *metadata;
- struct bt_clock_class_priority_map *cc_prio_map;
+struct ctf_fs_msg_iter_data {
+ /* Weak */
+ bt_self_message_iterator *pc_msg_iter;
- /* Array of struct ctf_fs_port_data *, owned by this */
- GPtrArray *port_data;
+ /* 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;
+
+ /* Which file the iterator is _currently_ operating on */
+ size_t ds_file_info_index;
+
+ /* Owned by this */
+ struct bt_msg_iter *msg_iter;
};
BT_HIDDEN
-enum bt_component_status ctf_fs_init(struct bt_private_component *source,
- struct bt_value *params, void *init_method_data);
+bt_self_component_status ctf_fs_init(
+ bt_self_component_source *source,
+ 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_self_component_class_source *comp_class,
+ const bt_query_executor *query_exec,
+ const char *object, const bt_value *params,
+ const bt_value **result);
+
+BT_HIDDEN
+bt_self_message_iterator_status ctf_fs_iterator_init(
+ bt_self_message_iterator *self_msg_iter,
+ bt_self_component_source *self_comp,
+ bt_self_component_port_output *self_port);
BT_HIDDEN
-void ctf_fs_finalize(struct bt_private_component *component);
+void ctf_fs_iterator_finalize(bt_self_message_iterator *it);
BT_HIDDEN
-enum bt_notification_iterator_status ctf_fs_iterator_init(
- struct bt_private_notification_iterator *it,
- struct bt_private_port *port);
+bt_self_message_iterator_status ctf_fs_iterator_next(
+ bt_self_message_iterator *iterator,
+ bt_message_array_const msgs, uint64_t capacity,
+ uint64_t *count);
-void ctf_fs_iterator_finalize(struct bt_private_notification_iterator *it);
+BT_HIDDEN
+bt_self_message_iterator_status ctf_fs_iterator_seek_beginning(
+ bt_self_message_iterator *message_iterator);
-struct bt_notification_iterator_next_return ctf_fs_iterator_next(
- struct bt_private_notification_iterator *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
-struct bt_value *ctf_fs_query(struct bt_component_class *comp_class,
- const char *object, struct bt_value *params);
+bool read_src_fs_parameters(const bt_value *params,
+ const bt_value **paths, struct ctf_fs_component *ctf_fs);
#endif /* BABELTRACE_PLUGIN_CTF_FS_H */