X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=plugins%2Fctf%2Ffs-src%2Ffs.h;h=9e9ee84d86fa91fcaac3e267a29b632d2743e42a;hb=68b66a256a54d32992dfefeaad11eea88b7df234;hp=a4b04f372002800fe02fcf7c644816cd67a2dee4;hpb=55314f2a6c08045f6f7ca7700a4932628eff1b87;p=babeltrace.git diff --git a/plugins/ctf/fs-src/fs.h b/plugins/ctf/fs-src/fs.h index a4b04f37..9e9ee84d 100644 --- a/plugins/ctf/fs-src/fs.h +++ b/plugins/ctf/fs-src/fs.h @@ -29,10 +29,11 @@ */ #include -#include -#include -#include +#include +#include #include "data-stream-file.h" +#include "metadata.h" +#include "../common/metadata/decoder.h" BT_HIDDEN extern bool ctf_fs_debug; @@ -49,61 +50,25 @@ struct ctf_fs_file { struct ctf_fs_metadata { /* Owned by this */ - struct bt_ctf_trace *trace; + struct ctf_metadata_decoder *decoder; /* Owned by this */ - char *text; - - uint8_t uuid[16]; - bool is_uuid_set; - int bo; -}; - -struct ctf_fs_ds_file_info { - GString *path; - uint64_t begin_ns; -}; - -struct ctf_fs_ds_file { - /* Owned by this */ - struct ctf_fs_file *file; + bt_trace_class *trace_class; - /* Owned by this */ - struct bt_ctf_stream *stream; + /* Weak (owned by `decoder` above) */ + struct ctf_trace_class *tc; /* Owned by this */ - struct bt_clock_class_priority_map *cc_prio_map; /* Owned by this */ - 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; -}; + char *text; -struct ctf_fs_component_options { - int64_t clock_offset; - int64_t clock_offset_ns; + int bo; }; struct ctf_fs_component { /* Weak, guaranteed to exist */ - struct bt_private_component *priv_comp; + bt_self_component_source *self_comp; /* Array of struct ctf_fs_port_data *, owned by this */ GPtrArray *port_data; @@ -111,7 +76,7 @@ struct ctf_fs_component { /* Array of struct ctf_fs_trace *, owned by this */ GPtrArray *traces; - struct ctf_fs_component_options options; + struct ctf_fs_metadata_config metadata_config; }; struct ctf_fs_trace { @@ -119,7 +84,7 @@ struct ctf_fs_trace { struct ctf_fs_metadata *metadata; /* Owned by this */ - struct bt_clock_class_priority_map *cc_prio_map; + bt_trace *trace; /* Array of struct ctf_fs_ds_file_group *, owned by this */ GPtrArray *ds_file_groups; @@ -129,6 +94,34 @@ struct ctf_fs_trace { /* 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 { + /* 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 { @@ -139,23 +132,45 @@ struct ctf_fs_ds_file_group { * belong to this group (a single stream instance). * * You can call ctf_fs_ds_file_create() with one of those paths - * and the CTF IR stream below. + * and the trace IR stream below. */ GPtrArray *ds_file_infos; /* Owned by this */ - struct bt_ctf_stream *stream; + 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; + + /* + * 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 { /* 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_notif_iter_data { +struct ctf_fs_msg_iter_data { + /* Weak */ + bt_self_message_iterator *pc_msg_iter; + /* Weak, belongs to ctf_fs_trace */ struct ctf_fs_ds_file_group *ds_file_group; @@ -164,33 +179,87 @@ struct ctf_fs_notif_iter_data { /* 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 -void ctf_fs_finalize(struct bt_private_component *component); +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 -enum bt_notification_iterator_status ctf_fs_iterator_init( - struct bt_private_notification_iterator *it, - struct bt_private_port *port); +void ctf_fs_iterator_finalize(bt_self_message_iterator *it); BT_HIDDEN -struct bt_value *ctf_fs_query(struct bt_component_class *comp_class, - const char *object, struct bt_value *params); +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); BT_HIDDEN -int ctf_fs_find_traces(GList **trace_paths, const char *start_path); +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 -GList *ctf_fs_create_trace_names(GList *trace_paths, const char *base_path); +struct ctf_fs_component *ctf_fs_component_create(void); -void ctf_fs_iterator_finalize(struct bt_private_notification_iterator *it); +/* + * 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); -struct bt_notification_iterator_next_return ctf_fs_iterator_next( - struct bt_private_notification_iterator *iterator); +/* 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 */