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/graph/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
;
42 struct ctf_fs_component
*ctf_fs
;
48 struct ctf_fs_metadata
{
49 struct bt_ctf_trace
*trace
;
56 struct ctf_fs_stream
{
57 struct ctf_fs_file
*file
;
58 struct bt_ctf_stream
*stream
;
59 struct bt_ctf_notif_iter
*notif_iter
;
60 /* A stream is assumed to be indexed. */
63 /* Max length of chunk to mmap() when updating the current mapping. */
65 /* Length of the current mapping. */
67 /* Length of the current mapping which *exists* in the backing file. */
68 size_t mmap_valid_len
;
69 /* Offset in the file where the current mapping starts. */
72 * Offset, in the current mapping, of the address to return on the next
79 struct ctf_fs_component_options
{
82 struct ctf_fs_port_data
{
86 struct ctf_fs_component
{
87 struct bt_private_component
*priv_comp
;
91 struct ctf_fs_component_options options
;
92 struct ctf_fs_metadata
*metadata
;
94 /* Array of struct ctf_fs_port_data *, owned by this */
99 enum bt_component_status
ctf_fs_init(struct bt_private_component
*source
,
100 struct bt_value
*params
, void *init_method_data
);
103 void ctf_fs_finalize(struct bt_private_component
*component
);
106 enum bt_notification_iterator_status
ctf_fs_iterator_init(
107 struct bt_private_notification_iterator
*it
,
108 struct bt_private_port
*port
);
110 void ctf_fs_iterator_finalize(struct bt_private_notification_iterator
*it
);
112 struct bt_notification_iterator_next_return
ctf_fs_iterator_next(
113 struct bt_private_notification_iterator
*iterator
);
116 struct bt_value
*ctf_fs_query(struct bt_component_class
*comp_class
,
117 const char *object
, struct bt_value
*params
);
119 #endif /* BABELTRACE_PLUGIN_CTF_FS_H */