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 | |
0f5c5d5c SM |
17 | #include "cpp-common/bt2c/logging.hpp" |
18 | ||
087cd0f5 | 19 | #include "metadata.hpp" |
490db841 | 20 | |
78bb6992 | 21 | extern bool ctf_fs_debug; |
56a1cced | 22 | |
4164020e SM |
23 | struct ctf_fs_file |
24 | { | |
0f5c5d5c SM |
25 | explicit ctf_fs_file(const bt2c::Logger& parentLogger) : |
26 | logger {parentLogger, "PLUGIN/SRC.CTF.FS/FILE"} | |
27 | { | |
28 | } | |
98903a3e | 29 | |
0f5c5d5c | 30 | bt2c::Logger logger; |
4c65a157 | 31 | |
4164020e | 32 | /* Owned by this */ |
afb0f12b | 33 | GString *path = nullptr; |
1a9f7075 | 34 | |
4164020e | 35 | /* Owned by this */ |
afb0f12b | 36 | FILE *fp = nullptr; |
1a9f7075 | 37 | |
afb0f12b | 38 | off_t size = 0; |
56a1cced JG |
39 | }; |
40 | ||
4164020e SM |
41 | struct ctf_fs_metadata |
42 | { | |
43 | /* Owned by this */ | |
afb0f12b | 44 | struct ctf_metadata_decoder *decoder = nullptr; |
44c440bc | 45 | |
4164020e | 46 | /* Owned by this */ |
afb0f12b | 47 | bt_trace_class *trace_class = nullptr; |
1a9f7075 | 48 | |
4164020e | 49 | /* Weak (owned by `decoder` above) */ |
afb0f12b | 50 | struct ctf_trace_class *tc = nullptr; |
44c440bc | 51 | |
4164020e | 52 | /* Owned by this */ |
afb0f12b | 53 | char *text = nullptr; |
1a9f7075 | 54 | |
afb0f12b | 55 | int bo = 0; |
56a1cced JG |
56 | }; |
57 | ||
4164020e SM |
58 | struct ctf_fs_component |
59 | { | |
0f5c5d5c SM |
60 | explicit ctf_fs_component(const bt2c::Logger& parentLogger) : |
61 | logger {parentLogger, "PLUGIN/SRC.CTF.FS/COMP"} | |
62 | { | |
63 | } | |
64 | ||
65 | bt2c::Logger logger; | |
98903a3e | 66 | |
4164020e | 67 | /* Array of struct ctf_fs_port_data *, owned by this */ |
afb0f12b | 68 | GPtrArray *port_data = nullptr; |
1a9f7075 | 69 | |
4164020e | 70 | /* Owned by this */ |
afb0f12b | 71 | struct ctf_fs_trace *trace = nullptr; |
1a9f7075 | 72 | |
4164020e | 73 | struct ctf_fs_metadata_config metadata_config; |
1a9f7075 PP |
74 | }; |
75 | ||
4164020e SM |
76 | struct ctf_fs_trace |
77 | { | |
0f5c5d5c SM |
78 | explicit ctf_fs_trace(const bt2c::Logger& parentLogger) : |
79 | logger {parentLogger, "PLUGIN/SRC.CTF.FS/TRACE"} | |
80 | { | |
81 | } | |
98903a3e | 82 | |
0f5c5d5c | 83 | bt2c::Logger logger; |
4c65a157 | 84 | |
4164020e | 85 | /* Owned by this */ |
afb0f12b | 86 | struct ctf_fs_metadata *metadata = nullptr; |
1a9f7075 | 87 | |
4164020e | 88 | /* Owned by this */ |
afb0f12b | 89 | bt_trace *trace = nullptr; |
862ca4ed | 90 | |
4164020e | 91 | /* Array of struct ctf_fs_ds_file_group *, owned by this */ |
afb0f12b | 92 | GPtrArray *ds_file_groups = nullptr; |
94cf822e | 93 | |
4164020e | 94 | /* Owned by this */ |
afb0f12b | 95 | GString *path = nullptr; |
1a9f7075 | 96 | |
4164020e | 97 | /* Next automatic stream ID when not provided by packet header */ |
afb0f12b | 98 | uint64_t next_stream_id = 0; |
1a9f7075 PP |
99 | }; |
100 | ||
4164020e SM |
101 | struct ctf_fs_ds_index_entry |
102 | { | |
103 | /* Weak, belongs to ctf_fs_ds_file_info. */ | |
afb0f12b | 104 | const char *path = nullptr; |
4164020e SM |
105 | |
106 | /* Position, in bytes, of the packet from the beginning of the file. */ | |
afb0f12b | 107 | uint64_t offset = 0; |
4164020e SM |
108 | |
109 | /* Size of the packet, in bytes. */ | |
afb0f12b | 110 | uint64_t packet_size = 0; |
4164020e SM |
111 | |
112 | /* | |
113 | * Extracted from the packet context, relative to the respective fields' | |
114 | * mapped clock classes (in cycles). | |
115 | */ | |
afb0f12b | 116 | uint64_t timestamp_begin = 0, timestamp_end = 0; |
4164020e SM |
117 | |
118 | /* | |
119 | * Converted from the packet context, relative to the trace's EPOCH | |
120 | * (in ns since EPOCH). | |
121 | */ | |
afb0f12b | 122 | int64_t timestamp_begin_ns = 0, timestamp_end_ns = 0; |
4164020e SM |
123 | |
124 | /* | |
125 | * Packet sequence number, or UINT64_MAX if not present in the index. | |
126 | */ | |
afb0f12b | 127 | uint64_t packet_seq_num = 0; |
7ed5243a FD |
128 | }; |
129 | ||
4164020e SM |
130 | struct ctf_fs_ds_index |
131 | { | |
132 | /* Array of pointer to struct ctf_fs_ds_index_entry. */ | |
afb0f12b | 133 | GPtrArray *entries = nullptr; |
7ed5243a FD |
134 | }; |
135 | ||
4164020e SM |
136 | struct ctf_fs_ds_file_group |
137 | { | |
138 | /* | |
139 | * Array of struct ctf_fs_ds_file_info, owned by this. | |
140 | * | |
141 | * This is an _ordered_ array of data stream file infos which | |
142 | * belong to this group (a single stream instance). | |
143 | * | |
144 | * You can call ctf_fs_ds_file_create() with one of those paths | |
145 | * and the trace IR stream below. | |
146 | */ | |
afb0f12b | 147 | GPtrArray *ds_file_infos = nullptr; |
4164020e SM |
148 | |
149 | /* Owned by this */ | |
afb0f12b | 150 | struct ctf_stream_class *sc = nullptr; |
4164020e SM |
151 | |
152 | /* Owned by this */ | |
afb0f12b | 153 | bt_stream *stream = nullptr; |
4164020e SM |
154 | |
155 | /* Stream (instance) ID; -1ULL means none */ | |
afb0f12b | 156 | uint64_t stream_id = 0; |
4164020e SM |
157 | |
158 | /* Weak, belongs to component */ | |
afb0f12b | 159 | struct ctf_fs_trace *ctf_fs_trace = nullptr; |
4164020e SM |
160 | |
161 | /* | |
162 | * Owned by this. | |
163 | */ | |
afb0f12b | 164 | struct ctf_fs_ds_index *index = nullptr; |
ea0b4b9e JG |
165 | }; |
166 | ||
4164020e SM |
167 | struct ctf_fs_port_data |
168 | { | |
169 | /* Weak, belongs to ctf_fs_trace */ | |
afb0f12b | 170 | struct ctf_fs_ds_file_group *ds_file_group = nullptr; |
5c563278 | 171 | |
4164020e | 172 | /* Weak */ |
afb0f12b | 173 | struct ctf_fs_component *ctf_fs = nullptr; |
94cf822e PP |
174 | }; |
175 | ||
4164020e SM |
176 | struct ctf_fs_msg_iter_data |
177 | { | |
0f5c5d5c SM |
178 | explicit ctf_fs_msg_iter_data(bt_self_message_iterator *selfMsgIter) : |
179 | self_msg_iter {selfMsgIter}, logger {bt2::SelfMessageIterator {self_msg_iter}, | |
180 | "PLUGIN/SRC.CTF.FS/MSG-ITER"} | |
181 | { | |
182 | } | |
4c65a157 | 183 | |
4164020e | 184 | /* Weak */ |
afb0f12b | 185 | bt_self_message_iterator *self_msg_iter = nullptr; |
5c563278 | 186 | |
0f5c5d5c SM |
187 | bt2c::Logger logger; |
188 | ||
4164020e | 189 | /* Weak, belongs to ctf_fs_trace */ |
afb0f12b | 190 | struct ctf_fs_ds_file_group *ds_file_group = nullptr; |
94cf822e | 191 | |
4164020e | 192 | /* Owned by this */ |
afb0f12b | 193 | struct ctf_msg_iter *msg_iter = nullptr; |
cbca1c06 | 194 | |
4164020e SM |
195 | /* |
196 | * Saved error. If we hit an error in the _next method, but have some | |
197 | * messages ready to return, we save the error here and return it on | |
198 | * the next _next call. | |
199 | */ | |
afb0f12b SM |
200 | bt_message_iterator_class_next_method_status next_saved_status = |
201 | BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK; | |
202 | const struct bt_error *next_saved_error = nullptr; | |
f6e68e70 | 203 | |
afb0f12b | 204 | struct ctf_fs_ds_group_medops_data *msg_iter_medops_data = nullptr; |
94cf822e PP |
205 | }; |
206 | ||
4164020e SM |
207 | bt_component_class_initialize_method_status |
208 | ctf_fs_init(bt_self_component_source *source, bt_self_component_source_configuration *config, | |
209 | const bt_value *params, void *init_method_data); | |
490db841 | 210 | |
b19ff26f | 211 | void ctf_fs_finalize(bt_self_component_source *component); |
d3e4dcd8 | 212 | |
4164020e SM |
213 | bt_component_class_query_method_status ctf_fs_query(bt_self_component_class_source *comp_class, |
214 | bt_private_query_executor *priv_query_exec, | |
215 | const char *object, const bt_value *params, | |
216 | void *method_data, const bt_value **result); | |
55314f2a | 217 | |
4164020e SM |
218 | bt_message_iterator_class_initialize_method_status |
219 | ctf_fs_iterator_init(bt_self_message_iterator *self_msg_iter, | |
220 | bt_self_message_iterator_configuration *config, | |
221 | bt_self_component_port_output *self_port); | |
d94d92ac | 222 | |
d6e69534 | 223 | void ctf_fs_iterator_finalize(bt_self_message_iterator *it); |
d3eb6e8f | 224 | |
4164020e SM |
225 | bt_message_iterator_class_next_method_status |
226 | ctf_fs_iterator_next(bt_self_message_iterator *iterator, bt_message_array_const msgs, | |
227 | uint64_t capacity, uint64_t *count); | |
d3eb6e8f | 228 | |
4164020e SM |
229 | bt_message_iterator_class_seek_beginning_method_status |
230 | ctf_fs_iterator_seek_beginning(bt_self_message_iterator *message_iterator); | |
6a9bb5e9 | 231 | |
f280892e SM |
232 | /* Create and initialize a new, empty ctf_fs_component. */ |
233 | ||
0f5c5d5c | 234 | ctf_fs_component *ctf_fs_component_create(const bt2c::Logger& parentLogger); |
f280892e SM |
235 | |
236 | /* | |
a0cd55ad SM |
237 | * Create one `struct ctf_fs_trace` from one trace, or multiple traces sharing |
238 | * the same UUID. | |
239 | * | |
240 | * `paths_value` must be an array of strings, | |
241 | * | |
242 | * The created `struct ctf_fs_trace` is assigned to `ctf_fs->trace`. | |
d23b766e SM |
243 | * |
244 | * `self_comp` and `self_comp_class` are used for logging, only one of them | |
245 | * should be set. | |
f280892e SM |
246 | */ |
247 | ||
4164020e SM |
248 | int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component *ctf_fs, |
249 | const bt_value *paths_value, | |
250 | const bt_value *trace_name_value, | |
0f5c5d5c | 251 | bt_self_component *selfComp); |
f280892e SM |
252 | |
253 | /* Free `ctf_fs` and everything it owns. */ | |
254 | ||
f280892e SM |
255 | void ctf_fs_destroy(struct ctf_fs_component *ctf_fs); |
256 | ||
d907165c SM |
257 | /* |
258 | * Read and validate parameters taken by the src.ctf.fs plugin. | |
259 | * | |
260 | * - The mandatory `paths` parameter is returned in `*paths`. | |
261 | * - The optional `clock-class-offset-s` and `clock-class-offset-ns`, if | |
262 | * present, are recorded in the `ctf_fs` structure. | |
005d49d6 SM |
263 | * - The optional `trace-name` parameter is returned in `*trace_name` if |
264 | * present, else `*trace_name` is set to NULL. | |
d907165c | 265 | * |
d23b766e SM |
266 | * `self_comp` and `self_comp_class` are used for logging, only one of them |
267 | * should be set. | |
268 | * | |
d907165c SM |
269 | * Return true on success, false if any parameter didn't pass validation. |
270 | */ | |
f280892e | 271 | |
4164020e | 272 | bool read_src_fs_parameters(const bt_value *params, const bt_value **paths, |
0f5c5d5c | 273 | const bt_value **trace_name, struct ctf_fs_component *ctf_fs); |
f280892e | 274 | |
a38d7650 SM |
275 | /* |
276 | * Generate the port name to be used for a given data stream file group. | |
277 | * | |
278 | * The result must be freed using g_free by the caller. | |
279 | */ | |
280 | ||
a38d7650 SM |
281 | gchar *ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group); |
282 | ||
541b0a11 | 283 | #endif /* BABELTRACE_PLUGIN_CTF_FS_H */ |