Commit | Line | Data |
---|---|---|
490db841 | 1 | /* |
0235b0db | 2 | * SPDX-License-Identifier: MIT |
490db841 | 3 | * |
f3bc2010 | 4 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
56a1cced | 5 | * Copyright 2016 Philippe Proulx <pproulx@efficios.com> |
490db841 | 6 | * |
0235b0db | 7 | * BabelTrace - CTF on File System Component |
490db841 JG |
8 | */ |
9 | ||
0235b0db MJ |
10 | #ifndef BABELTRACE_PLUGIN_CTF_FS_H |
11 | #define BABELTRACE_PLUGIN_CTF_FS_H | |
12 | ||
c7e1be4b | 13 | #include <glib.h> |
c802cacb | 14 | |
c7e1be4b | 15 | #include <babeltrace2/babeltrace.h> |
c802cacb | 16 | |
49b956cc | 17 | #include "cpp-common/bt2c/glib-up.hpp" |
0f5c5d5c SM |
18 | #include "cpp-common/bt2c/logging.hpp" |
19 | ||
cdf7de78 | 20 | #include "data-stream-file.hpp" |
1fa280c9 | 21 | #include "plugins/ctf/common/src/metadata/tsdl/decoder.hpp" |
490db841 | 22 | |
78bb6992 | 23 | extern bool ctf_fs_debug; |
56a1cced | 24 | |
4164020e SM |
25 | struct ctf_fs_metadata |
26 | { | |
27 | /* Owned by this */ | |
1fa280c9 | 28 | ctf_metadata_decoder_up decoder; |
44c440bc | 29 | |
4164020e | 30 | /* Owned by this */ |
afb0f12b | 31 | bt_trace_class *trace_class = nullptr; |
1a9f7075 | 32 | |
4164020e | 33 | /* Weak (owned by `decoder` above) */ |
afb0f12b | 34 | struct ctf_trace_class *tc = nullptr; |
44c440bc | 35 | |
4164020e | 36 | /* Owned by this */ |
afb0f12b | 37 | char *text = nullptr; |
1a9f7075 | 38 | |
afb0f12b | 39 | int bo = 0; |
56a1cced JG |
40 | }; |
41 | ||
7df773f2 SM |
42 | struct ctf_fs_trace_deleter |
43 | { | |
44 | void operator()(ctf_fs_trace *) noexcept; | |
45 | }; | |
46 | ||
4164020e SM |
47 | struct ctf_fs_trace |
48 | { | |
7df773f2 SM |
49 | using UP = std::unique_ptr<ctf_fs_trace, ctf_fs_trace_deleter>; |
50 | ||
0f5c5d5c SM |
51 | explicit ctf_fs_trace(const bt2c::Logger& parentLogger) : |
52 | logger {parentLogger, "PLUGIN/SRC.CTF.FS/TRACE"} | |
53 | { | |
54 | } | |
98903a3e | 55 | |
0f5c5d5c | 56 | bt2c::Logger logger; |
4c65a157 | 57 | |
4164020e | 58 | /* Owned by this */ |
afb0f12b | 59 | struct ctf_fs_metadata *metadata = nullptr; |
1a9f7075 | 60 | |
4164020e | 61 | /* Owned by this */ |
afb0f12b | 62 | bt_trace *trace = nullptr; |
862ca4ed | 63 | |
cdf7de78 | 64 | std::vector<ctf_fs_ds_file_group::UP> ds_file_groups; |
94cf822e | 65 | |
4164020e | 66 | /* Owned by this */ |
afb0f12b | 67 | GString *path = nullptr; |
1a9f7075 | 68 | |
4164020e | 69 | /* Next automatic stream ID when not provided by packet header */ |
afb0f12b | 70 | uint64_t next_stream_id = 0; |
1a9f7075 PP |
71 | }; |
72 | ||
09721481 SM |
73 | struct ctf_fs_port_data |
74 | { | |
945312a2 SM |
75 | using UP = std::unique_ptr<ctf_fs_port_data>; |
76 | ||
09721481 SM |
77 | /* Weak, belongs to ctf_fs_trace */ |
78 | struct ctf_fs_ds_file_group *ds_file_group = nullptr; | |
79 | ||
80 | /* Weak */ | |
81 | struct ctf_fs_component *ctf_fs = nullptr; | |
82 | }; | |
83 | ||
84 | struct ctf_fs_component_deleter | |
85 | { | |
86 | void operator()(ctf_fs_component *); | |
87 | }; | |
88 | ||
89 | struct ctf_fs_component | |
90 | { | |
91 | using UP = std::unique_ptr<ctf_fs_component, ctf_fs_component_deleter>; | |
92 | ||
93 | explicit ctf_fs_component(const bt2c::Logger& parentLogger) noexcept : | |
94 | logger {parentLogger, "PLUGIN/SRC.CTF.FS/COMP"} | |
95 | { | |
96 | } | |
97 | ||
98 | bt2c::Logger logger; | |
99 | ||
945312a2 | 100 | std::vector<ctf_fs_port_data::UP> port_data; |
09721481 | 101 | |
7df773f2 | 102 | ctf_fs_trace::UP trace; |
09721481 SM |
103 | |
104 | ctf::src::ClkClsCfg clkClsCfg; | |
105 | }; | |
106 | ||
4164020e SM |
107 | struct ctf_fs_msg_iter_data |
108 | { | |
0f5c5d5c SM |
109 | explicit ctf_fs_msg_iter_data(bt_self_message_iterator *selfMsgIter) : |
110 | self_msg_iter {selfMsgIter}, logger {bt2::SelfMessageIterator {self_msg_iter}, | |
111 | "PLUGIN/SRC.CTF.FS/MSG-ITER"} | |
112 | { | |
113 | } | |
4c65a157 | 114 | |
4164020e | 115 | /* Weak */ |
afb0f12b | 116 | bt_self_message_iterator *self_msg_iter = nullptr; |
5c563278 | 117 | |
0f5c5d5c SM |
118 | bt2c::Logger logger; |
119 | ||
4164020e | 120 | /* Weak, belongs to ctf_fs_trace */ |
afb0f12b | 121 | struct ctf_fs_ds_file_group *ds_file_group = nullptr; |
94cf822e | 122 | |
4164020e | 123 | /* Owned by this */ |
afb0f12b | 124 | struct ctf_msg_iter *msg_iter = nullptr; |
cbca1c06 | 125 | |
4164020e SM |
126 | /* |
127 | * Saved error. If we hit an error in the _next method, but have some | |
128 | * messages ready to return, we save the error here and return it on | |
129 | * the next _next call. | |
130 | */ | |
afb0f12b SM |
131 | bt_message_iterator_class_next_method_status next_saved_status = |
132 | BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK; | |
133 | const struct bt_error *next_saved_error = nullptr; | |
f6e68e70 | 134 | |
afb0f12b | 135 | struct ctf_fs_ds_group_medops_data *msg_iter_medops_data = nullptr; |
94cf822e PP |
136 | }; |
137 | ||
4164020e SM |
138 | bt_component_class_initialize_method_status |
139 | ctf_fs_init(bt_self_component_source *source, bt_self_component_source_configuration *config, | |
140 | const bt_value *params, void *init_method_data); | |
490db841 | 141 | |
b19ff26f | 142 | void ctf_fs_finalize(bt_self_component_source *component); |
d3e4dcd8 | 143 | |
4164020e SM |
144 | bt_component_class_query_method_status ctf_fs_query(bt_self_component_class_source *comp_class, |
145 | bt_private_query_executor *priv_query_exec, | |
146 | const char *object, const bt_value *params, | |
147 | void *method_data, const bt_value **result); | |
55314f2a | 148 | |
4164020e SM |
149 | bt_message_iterator_class_initialize_method_status |
150 | ctf_fs_iterator_init(bt_self_message_iterator *self_msg_iter, | |
151 | bt_self_message_iterator_configuration *config, | |
152 | bt_self_component_port_output *self_port); | |
d94d92ac | 153 | |
d6e69534 | 154 | void ctf_fs_iterator_finalize(bt_self_message_iterator *it); |
d3eb6e8f | 155 | |
4164020e SM |
156 | bt_message_iterator_class_next_method_status |
157 | ctf_fs_iterator_next(bt_self_message_iterator *iterator, bt_message_array_const msgs, | |
158 | uint64_t capacity, uint64_t *count); | |
d3eb6e8f | 159 | |
4164020e SM |
160 | bt_message_iterator_class_seek_beginning_method_status |
161 | ctf_fs_iterator_seek_beginning(bt_self_message_iterator *message_iterator); | |
6a9bb5e9 | 162 | |
f280892e SM |
163 | /* Create and initialize a new, empty ctf_fs_component. */ |
164 | ||
f340a3e8 | 165 | ctf_fs_component::UP ctf_fs_component_create(const bt2c::Logger& parentLogger); |
f280892e SM |
166 | |
167 | /* | |
a0cd55ad SM |
168 | * Create one `struct ctf_fs_trace` from one trace, or multiple traces sharing |
169 | * the same UUID. | |
170 | * | |
171 | * `paths_value` must be an array of strings, | |
172 | * | |
173 | * The created `struct ctf_fs_trace` is assigned to `ctf_fs->trace`. | |
d23b766e SM |
174 | * |
175 | * `self_comp` and `self_comp_class` are used for logging, only one of them | |
176 | * should be set. | |
f280892e SM |
177 | */ |
178 | ||
4164020e SM |
179 | int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component *ctf_fs, |
180 | const bt_value *paths_value, | |
181 | const bt_value *trace_name_value, | |
0f5c5d5c | 182 | bt_self_component *selfComp); |
f280892e SM |
183 | |
184 | /* Free `ctf_fs` and everything it owns. */ | |
185 | ||
f280892e SM |
186 | void ctf_fs_destroy(struct ctf_fs_component *ctf_fs); |
187 | ||
d907165c SM |
188 | /* |
189 | * Read and validate parameters taken by the src.ctf.fs plugin. | |
190 | * | |
191 | * - The mandatory `paths` parameter is returned in `*paths`. | |
192 | * - The optional `clock-class-offset-s` and `clock-class-offset-ns`, if | |
193 | * present, are recorded in the `ctf_fs` structure. | |
005d49d6 SM |
194 | * - The optional `trace-name` parameter is returned in `*trace_name` if |
195 | * present, else `*trace_name` is set to NULL. | |
d907165c | 196 | * |
d23b766e SM |
197 | * `self_comp` and `self_comp_class` are used for logging, only one of them |
198 | * should be set. | |
199 | * | |
d907165c SM |
200 | * Return true on success, false if any parameter didn't pass validation. |
201 | */ | |
f280892e | 202 | |
4164020e | 203 | bool read_src_fs_parameters(const bt_value *params, const bt_value **paths, |
0f5c5d5c | 204 | const bt_value **trace_name, struct ctf_fs_component *ctf_fs); |
f280892e | 205 | |
a38d7650 SM |
206 | /* |
207 | * Generate the port name to be used for a given data stream file group. | |
a38d7650 SM |
208 | */ |
209 | ||
49b956cc | 210 | bt2c::GCharUP ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group); |
a38d7650 | 211 | |
541b0a11 | 212 | #endif /* BABELTRACE_PLUGIN_CTF_FS_H */ |