1 #ifndef BABELTRACE_PLUGIN_CTF_FS_H
2 #define BABELTRACE_PLUGIN_CTF_FS_H
5 * BabelTrace - CTF on File System Component
7 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
10 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
12 * Permission is hereby granted, free of charge, to any person obtaining a copy
13 * of this software and associated documentation files (the "Software"), to deal
14 * in the Software without restriction, including without limitation the rights
15 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16 * copies of the Software, and to permit persons to whom the Software is
17 * furnished to do so, subject to the following conditions:
19 * The above copyright notice and this permission notice shall be included in
20 * all copies or substantial portions of the Software.
22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31 #include <babeltrace/babeltrace-internal.h>
32 #include <babeltrace/component/component.h>
33 #include "data-stream.h"
35 #define CTF_FS_COMPONENT_DESCRIPTION \
36 "Component used to read a CTF trace located on a file system."
39 extern bool ctf_fs_debug
;
41 struct bt_notification_heap
;
44 struct ctf_fs_component
*ctf_fs
;
50 struct ctf_fs_metadata
{
51 struct bt_ctf_trace
*trace
;
58 struct ctf_fs_stream
{
59 struct ctf_fs_file
*file
;
60 struct bt_ctf_stream
*stream
;
61 /* FIXME There should be many and ctf_fs_stream should not own them. */
62 struct bt_ctf_notif_iter
*notif_iter
;
63 /* A stream is assumed to be indexed. */
66 /* Max length of chunk to mmap() when updating the current mapping. */
68 /* Length of the current mapping. */
70 /* Length of the current mapping which *exists* in the backing file. */
71 size_t mmap_valid_len
;
72 /* Offset in the file where the current mapping starts. */
75 * Offset, in the current mapping, of the address to return on the next
82 struct ctf_fs_iterator
{
83 struct bt_notification_heap
*pending_notifications
;
84 struct bt_notification
*current_notification
;
86 * struct ctf_fs_data_stream* which have not yet been associated to a
87 * bt_ctf_stream. The association is performed on the first packet
88 * read by the stream (since, at that point, we have read a packet
91 GPtrArray
*pending_streams
;
92 /* bt_ctf_stream -> ctf_fs_stream */
93 GHashTable
*stream_ht
;
96 struct ctf_fs_component_options
{
100 struct ctf_fs_component
{
104 struct ctf_fs_component_options options
;
105 struct ctf_fs_metadata
*metadata
;
109 enum bt_component_status
ctf_fs_init(struct bt_component
*source
,
110 struct bt_value
*params
, void *init_method_data
);
113 void ctf_fs_destroy(struct bt_component
*component
);
116 enum bt_notification_iterator_status
ctf_fs_iterator_init(
117 struct bt_component
*source
,
118 struct bt_notification_iterator
*it
,
119 void *init_method_data
);
121 void ctf_fs_iterator_destroy(struct bt_notification_iterator
*it
);
123 enum bt_notification_iterator_status
ctf_fs_iterator_next(
124 struct bt_notification_iterator
*iterator
);
126 struct bt_notification
*ctf_fs_iterator_get(
127 struct bt_notification_iterator
*iterator
);
130 struct bt_value
*ctf_fs_query_info(struct bt_component_class
*comp_class
,
131 const char *action
, struct bt_value
*params
);
133 #endif /* BABELTRACE_PLUGIN_CTF_FS_H */