Commit | Line | Data |
---|---|---|
7a278c8e | 1 | /* |
0235b0db | 2 | * SPDX-License-Identifier: MIT |
7a278c8e | 3 | * |
1a9f7075 | 4 | * Copyright 2015-2017 Philippe Proulx <pproulx@efficios.com> |
f3bc2010 | 5 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
7a278c8e | 6 | * |
0235b0db | 7 | * Babeltrace CTF file system Reader Component |
7a278c8e JG |
8 | */ |
9 | ||
c802cacb SM |
10 | #include <glib.h> |
11 | #include <inttypes.h> | |
c802cacb SM |
12 | |
13 | #include <babeltrace2/babeltrace.h> | |
14 | ||
c802cacb | 15 | #include "common/assert.h" |
578e048b | 16 | #include "common/common.h" |
6162e6b7 | 17 | #include "common/uuid.h" |
945312a2 | 18 | #include "cpp-common/bt2s/make-unique.hpp" |
c802cacb SM |
19 | |
20 | #include "plugins/common/param-validation/param-validation.h" | |
21 | ||
5656cea5 PP |
22 | #include "../common/src/metadata/tsdl/ctf-meta-configure-ir-trace.hpp" |
23 | #include "../common/src/msg-iter/msg-iter.hpp" | |
c802cacb SM |
24 | #include "data-stream-file.hpp" |
25 | #include "file.hpp" | |
26 | #include "fs.hpp" | |
27 | #include "metadata.hpp" | |
087cd0f5 | 28 | #include "query.hpp" |
e7a4393b | 29 | |
4164020e SM |
30 | struct tracer_info |
31 | { | |
32 | const char *name; | |
33 | int64_t major; | |
34 | int64_t minor; | |
35 | int64_t patch; | |
626cc488 FD |
36 | }; |
37 | ||
4164020e | 38 | static void ctf_fs_msg_iter_data_destroy(struct ctf_fs_msg_iter_data *msg_iter_data) |
94cf822e | 39 | { |
4164020e SM |
40 | if (!msg_iter_data) { |
41 | return; | |
42 | } | |
94cf822e | 43 | |
4164020e SM |
44 | if (msg_iter_data->msg_iter) { |
45 | ctf_msg_iter_destroy(msg_iter_data->msg_iter); | |
46 | } | |
6de92955 | 47 | |
afb0f12b | 48 | delete msg_iter_data; |
fc917f65 PP |
49 | } |
50 | ||
4164020e SM |
51 | static bt_message_iterator_class_next_method_status |
52 | ctf_fs_iterator_next_one(struct ctf_fs_msg_iter_data *msg_iter_data, const bt_message **out_msg) | |
ea0b4b9e | 53 | { |
4164020e SM |
54 | bt_message_iterator_class_next_method_status status; |
55 | enum ctf_msg_iter_status msg_iter_status; | |
4164020e SM |
56 | |
57 | msg_iter_status = ctf_msg_iter_get_next_message(msg_iter_data->msg_iter, out_msg); | |
58 | ||
59 | switch (msg_iter_status) { | |
60 | case CTF_MSG_ITER_STATUS_OK: | |
61 | /* Cool, message has been written to *out_msg. */ | |
62 | status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK; | |
63 | break; | |
64 | ||
65 | case CTF_MSG_ITER_STATUS_EOF: | |
66 | status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END; | |
67 | break; | |
68 | ||
69 | case CTF_MSG_ITER_STATUS_AGAIN: | |
70 | /* | |
71 | * Should not make it this far as this is | |
72 | * medium-specific; there is nothing for the user to do | |
73 | * and it should have been handled upstream. | |
74 | */ | |
75 | bt_common_abort(); | |
76 | ||
77 | case CTF_MSG_ITER_STATUS_ERROR: | |
0f5c5d5c SM |
78 | BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data->logger, |
79 | "Failed to get next message from CTF message iterator."); | |
4164020e SM |
80 | status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR; |
81 | break; | |
82 | ||
83 | case CTF_MSG_ITER_STATUS_MEMORY_ERROR: | |
0f5c5d5c SM |
84 | BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data->logger, |
85 | "Failed to get next message from CTF message iterator."); | |
4164020e SM |
86 | status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR; |
87 | break; | |
88 | ||
89 | default: | |
90 | bt_common_abort(); | |
91 | } | |
92 | ||
93 | return status; | |
d4393e08 PP |
94 | } |
95 | ||
4164020e SM |
96 | bt_message_iterator_class_next_method_status |
97 | ctf_fs_iterator_next(bt_self_message_iterator *iterator, bt_message_array_const msgs, | |
98 | uint64_t capacity, uint64_t *count) | |
d4393e08 | 99 | { |
1e690349 SM |
100 | try { |
101 | bt_message_iterator_class_next_method_status status; | |
102 | struct ctf_fs_msg_iter_data *msg_iter_data = | |
103 | (struct ctf_fs_msg_iter_data *) bt_self_message_iterator_get_data(iterator); | |
104 | uint64_t i = 0; | |
4164020e | 105 | |
1e690349 SM |
106 | if (G_UNLIKELY(msg_iter_data->next_saved_error)) { |
107 | /* | |
4164020e SM |
108 | * Last time we were called, we hit an error but had some |
109 | * messages to deliver, so we stashed the error here. Return | |
110 | * it now. | |
111 | */ | |
1e690349 SM |
112 | BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data->next_saved_error); |
113 | status = msg_iter_data->next_saved_status; | |
114 | goto end; | |
4164020e | 115 | } |
4164020e | 116 | |
1e690349 SM |
117 | do { |
118 | status = ctf_fs_iterator_next_one(msg_iter_data, &msgs[i]); | |
119 | if (status == BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK) { | |
120 | i++; | |
121 | } | |
122 | } while (i < capacity && status == BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK); | |
123 | ||
124 | if (i > 0) { | |
125 | /* | |
4164020e SM |
126 | * Even if ctf_fs_iterator_next_one() returned something |
127 | * else than BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we | |
128 | * accumulated message objects in the output | |
129 | * message array, so we need to return | |
130 | * BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are | |
e7401568 | 131 | * transferred to downstream. This other status occurs |
4164020e SM |
132 | * again the next time muxer_msg_iter_do_next() is |
133 | * called, possibly without any accumulated | |
134 | * message, in which case we'll return it. | |
135 | */ | |
1e690349 SM |
136 | if (status < 0) { |
137 | /* | |
4164020e SM |
138 | * Save this error for the next _next call. Assume that |
139 | * this component always appends error causes when | |
140 | * returning an error status code, which will cause the | |
141 | * current thread error to be non-NULL. | |
142 | */ | |
1e690349 SM |
143 | msg_iter_data->next_saved_error = bt_current_thread_take_error(); |
144 | BT_ASSERT(msg_iter_data->next_saved_error); | |
145 | msg_iter_data->next_saved_status = status; | |
146 | } | |
4164020e | 147 | |
1e690349 SM |
148 | *count = i; |
149 | status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK; | |
150 | } | |
d4393e08 | 151 | |
cbca1c06 | 152 | end: |
1e690349 SM |
153 | return status; |
154 | return status; | |
155 | } catch (const std::bad_alloc&) { | |
156 | return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR; | |
157 | } catch (const bt2::Error&) { | |
158 | return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR; | |
159 | } | |
ea0b4b9e | 160 | } |
bfd20a42 | 161 | |
a3f0c7db | 162 | bt_message_iterator_class_seek_beginning_method_status |
d24d5663 | 163 | ctf_fs_iterator_seek_beginning(bt_self_message_iterator *it) |
6a9bb5e9 | 164 | { |
1e690349 SM |
165 | try { |
166 | struct ctf_fs_msg_iter_data *msg_iter_data = | |
167 | (struct ctf_fs_msg_iter_data *) bt_self_message_iterator_get_data(it); | |
6a9bb5e9 | 168 | |
1e690349 | 169 | BT_ASSERT(msg_iter_data); |
6a9bb5e9 | 170 | |
1e690349 | 171 | ctf_msg_iter_reset(msg_iter_data->msg_iter); |
3cf88182 | 172 | ctf_fs_ds_group_medops_data_reset(msg_iter_data->msg_iter_medops_data.get()); |
f6e68e70 | 173 | |
1e690349 SM |
174 | return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_OK; |
175 | } catch (const std::bad_alloc&) { | |
176 | return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_MEMORY_ERROR; | |
177 | } catch (const bt2::Error&) { | |
178 | return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_ERROR; | |
179 | } | |
6a9bb5e9 PP |
180 | } |
181 | ||
d6e69534 | 182 | void ctf_fs_iterator_finalize(bt_self_message_iterator *it) |
760051fa | 183 | { |
4164020e SM |
184 | ctf_fs_msg_iter_data_destroy( |
185 | (struct ctf_fs_msg_iter_data *) bt_self_message_iterator_get_data(it)); | |
760051fa JG |
186 | } |
187 | ||
4164020e SM |
188 | static bt_message_iterator_class_initialize_method_status |
189 | ctf_msg_iter_medium_status_to_msg_iter_initialize_status(enum ctf_msg_iter_medium_status status) | |
1b7b1ef9 | 190 | { |
4164020e SM |
191 | switch (status) { |
192 | case CTF_MSG_ITER_MEDIUM_STATUS_EOF: | |
193 | case CTF_MSG_ITER_MEDIUM_STATUS_AGAIN: | |
194 | case CTF_MSG_ITER_MEDIUM_STATUS_ERROR: | |
195 | return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR; | |
196 | case CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR: | |
197 | return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; | |
198 | case CTF_MSG_ITER_MEDIUM_STATUS_OK: | |
199 | return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK; | |
200 | } | |
201 | ||
202 | bt_common_abort(); | |
1b7b1ef9 SM |
203 | } |
204 | ||
4164020e SM |
205 | bt_message_iterator_class_initialize_method_status |
206 | ctf_fs_iterator_init(bt_self_message_iterator *self_msg_iter, | |
207 | bt_self_message_iterator_configuration *config, | |
208 | bt_self_component_port_output *self_port) | |
4c1456f0 | 209 | { |
1e690349 SM |
210 | try { |
211 | struct ctf_fs_port_data *port_data; | |
212 | bt_message_iterator_class_initialize_method_status status; | |
213 | enum ctf_msg_iter_medium_status medium_status; | |
214 | ||
215 | port_data = (struct ctf_fs_port_data *) bt_self_component_port_get_data( | |
216 | bt_self_component_port_output_as_self_component_port(self_port)); | |
217 | BT_ASSERT(port_data); | |
218 | ||
219 | ctf_fs_msg_iter_data *msg_iter_data = new ctf_fs_msg_iter_data {self_msg_iter}; | |
220 | msg_iter_data->ds_file_group = port_data->ds_file_group; | |
221 | ||
222 | medium_status = ctf_fs_ds_group_medops_data_create(msg_iter_data->ds_file_group, | |
223 | self_msg_iter, msg_iter_data->logger, | |
3cf88182 | 224 | msg_iter_data->msg_iter_medops_data); |
1e690349 SM |
225 | BT_ASSERT(medium_status == CTF_MSG_ITER_MEDIUM_STATUS_OK || |
226 | medium_status == CTF_MSG_ITER_MEDIUM_STATUS_ERROR || | |
227 | medium_status == CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR); | |
228 | if (medium_status != CTF_MSG_ITER_MEDIUM_STATUS_OK) { | |
229 | BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data->logger, | |
230 | "Failed to create ctf_fs_ds_group_medops"); | |
231 | status = ctf_msg_iter_medium_status_to_msg_iter_initialize_status(medium_status); | |
232 | goto error; | |
233 | } | |
4164020e | 234 | |
657f1bd6 SM |
235 | msg_iter_data->msg_iter = |
236 | ctf_msg_iter_create( | |
237 | msg_iter_data->ds_file_group->ctf_fs_trace->metadata->tc, | |
238 | bt_common_get_page_size(static_cast<int>(msg_iter_data->logger.level())) * 8, | |
239 | ctf_fs_ds_group_medops, msg_iter_data->msg_iter_medops_data.get(), self_msg_iter, | |
240 | msg_iter_data->logger) | |
241 | .release(); | |
1e690349 SM |
242 | if (!msg_iter_data->msg_iter) { |
243 | BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data->logger, | |
244 | "Cannot create a CTF message iterator."); | |
245 | status = BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; | |
246 | goto error; | |
247 | } | |
4164020e | 248 | |
1e690349 | 249 | /* |
4164020e SM |
250 | * This iterator can seek forward if its stream class has a default |
251 | * clock class. | |
252 | */ | |
1e690349 SM |
253 | if (msg_iter_data->ds_file_group->sc->default_clock_class) { |
254 | bt_self_message_iterator_configuration_set_can_seek_forward(config, true); | |
255 | } | |
4164020e | 256 | |
1e690349 SM |
257 | bt_self_message_iterator_set_data(self_msg_iter, msg_iter_data); |
258 | msg_iter_data = NULL; | |
4164020e | 259 | |
1e690349 SM |
260 | status = BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK; |
261 | goto end; | |
5b29e799 | 262 | |
4f1f88a6 | 263 | error: |
1e690349 | 264 | bt_self_message_iterator_set_data(self_msg_iter, NULL); |
4f1f88a6 | 265 | |
760051fa | 266 | end: |
1e690349 SM |
267 | ctf_fs_msg_iter_data_destroy(msg_iter_data); |
268 | return status; | |
269 | } catch (const std::bad_alloc&) { | |
270 | return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; | |
271 | } catch (const bt2::Error&) { | |
272 | return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR; | |
273 | } | |
760051fa JG |
274 | } |
275 | ||
4164020e | 276 | static void ctf_fs_trace_destroy(struct ctf_fs_trace *ctf_fs_trace) |
a0cd55ad | 277 | { |
4164020e SM |
278 | if (!ctf_fs_trace) { |
279 | return; | |
280 | } | |
a0cd55ad | 281 | |
4164020e | 282 | BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace->trace); |
a0cd55ad | 283 | |
4164020e SM |
284 | if (ctf_fs_trace->path) { |
285 | g_string_free(ctf_fs_trace->path, TRUE); | |
286 | } | |
a0cd55ad | 287 | |
4164020e SM |
288 | if (ctf_fs_trace->metadata) { |
289 | ctf_fs_metadata_fini(ctf_fs_trace->metadata); | |
afb0f12b | 290 | delete ctf_fs_trace->metadata; |
4164020e | 291 | } |
a0cd55ad | 292 | |
afb0f12b | 293 | delete ctf_fs_trace; |
a0cd55ad SM |
294 | } |
295 | ||
7df773f2 SM |
296 | void ctf_fs_trace_deleter::operator()(ctf_fs_trace * const trace) noexcept |
297 | { | |
298 | ctf_fs_trace_destroy(trace); | |
299 | } | |
300 | ||
f340a3e8 | 301 | ctf_fs_component::UP ctf_fs_component_create(const bt2c::Logger& parentLogger) |
a4792757 | 302 | { |
57ec0a35 | 303 | return bt2s::make_unique<ctf_fs_component>(parentLogger); |
f280892e SM |
304 | } |
305 | ||
306 | void ctf_fs_finalize(bt_self_component_source *component) | |
307 | { | |
57ec0a35 SM |
308 | ctf_fs_component::UP {static_cast<ctf_fs_component *>( |
309 | bt_self_component_get_data(bt_self_component_source_as_self_component(component)))}; | |
5b29e799 JG |
310 | } |
311 | ||
49b956cc | 312 | bt2c::GCharUP ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group) |
547eacf1 | 313 | { |
4164020e SM |
314 | GString *name = g_string_new(NULL); |
315 | ||
316 | /* | |
317 | * The unique port name is generated by concatenating unique identifiers | |
318 | * for: | |
319 | * | |
320 | * - the trace | |
321 | * - the stream class | |
322 | * - the stream | |
323 | */ | |
324 | ||
325 | /* For the trace, use the uuid if present, else the path. */ | |
326 | if (ds_file_group->ctf_fs_trace->metadata->tc->is_uuid_set) { | |
327 | char uuid_str[BT_UUID_STR_LEN + 1]; | |
328 | ||
329 | bt_uuid_to_str(ds_file_group->ctf_fs_trace->metadata->tc->uuid, uuid_str); | |
330 | g_string_assign(name, uuid_str); | |
331 | } else { | |
332 | g_string_assign(name, ds_file_group->ctf_fs_trace->path->str); | |
333 | } | |
334 | ||
335 | /* | |
336 | * For the stream class, use the id if present. We can omit this field | |
337 | * otherwise, as there will only be a single stream class. | |
338 | */ | |
339 | if (ds_file_group->sc->id != UINT64_C(-1)) { | |
340 | g_string_append_printf(name, " | %" PRIu64, ds_file_group->sc->id); | |
341 | } | |
342 | ||
343 | /* For the stream, use the id if present, else, use the path. */ | |
344 | if (ds_file_group->stream_id != UINT64_C(-1)) { | |
345 | g_string_append_printf(name, " | %" PRIu64, ds_file_group->stream_id); | |
346 | } else { | |
f3d74124 SM |
347 | BT_ASSERT(ds_file_group->ds_file_infos.size() == 1); |
348 | const auto& ds_file_info = *ds_file_group->ds_file_infos[0]; | |
349 | g_string_append_printf(name, " | %s", ds_file_info.path.c_str()); | |
4164020e SM |
350 | } |
351 | ||
49b956cc | 352 | return bt2c::GCharUP {g_string_free(name, FALSE)}; |
547eacf1 PP |
353 | } |
354 | ||
ce11b8c4 | 355 | static int create_one_port_for_trace(struct ctf_fs_component *ctf_fs, |
4164020e SM |
356 | struct ctf_fs_ds_file_group *ds_file_group, |
357 | bt_self_component_source *self_comp_src) | |
5b29e799 | 358 | { |
4164020e | 359 | int ret = 0; |
945312a2 | 360 | ctf_fs_port_data::UP port_data; |
4164020e | 361 | |
49b956cc | 362 | bt2c::GCharUP port_name = ctf_fs_make_port_name(ds_file_group); |
4164020e SM |
363 | if (!port_name) { |
364 | goto error; | |
365 | } | |
366 | ||
49b956cc | 367 | BT_CPPLOGI_SPEC(ctf_fs->logger, "Creating one port named `{}`", port_name.get()); |
4164020e SM |
368 | |
369 | /* Create output port for this file */ | |
945312a2 | 370 | port_data = bt2s::make_unique<ctf_fs_port_data>(); |
4164020e SM |
371 | port_data->ctf_fs = ctf_fs; |
372 | port_data->ds_file_group = ds_file_group; | |
945312a2 SM |
373 | ret = bt_self_component_source_add_output_port(self_comp_src, port_name.get(), port_data.get(), |
374 | NULL); | |
4164020e SM |
375 | if (ret) { |
376 | goto error; | |
377 | } | |
378 | ||
945312a2 | 379 | ctf_fs->port_data.emplace_back(std::move(port_data)); |
4164020e | 380 | goto end; |
4f1f88a6 PP |
381 | |
382 | error: | |
4164020e | 383 | ret = -1; |
4f1f88a6 PP |
384 | |
385 | end: | |
4164020e | 386 | return ret; |
5b29e799 JG |
387 | } |
388 | ||
4164020e SM |
389 | static int create_ports_for_trace(struct ctf_fs_component *ctf_fs, |
390 | struct ctf_fs_trace *ctf_fs_trace, | |
391 | bt_self_component_source *self_comp_src) | |
94cf822e | 392 | { |
4164020e | 393 | int ret = 0; |
4164020e SM |
394 | |
395 | /* Create one output port for each stream file group */ | |
cdf7de78 SM |
396 | for (const auto& ds_file_group : ctf_fs_trace->ds_file_groups) { |
397 | ret = create_one_port_for_trace(ctf_fs, ds_file_group.get(), self_comp_src); | |
4164020e | 398 | if (ret) { |
0f5c5d5c | 399 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs->logger, "Cannot create output port."); |
4164020e SM |
400 | goto end; |
401 | } | |
402 | } | |
94cf822e PP |
403 | |
404 | end: | |
4164020e | 405 | return ret; |
94cf822e PP |
406 | } |
407 | ||
41a65f30 SM |
408 | /* |
409 | * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right | |
410 | * place to keep it sorted. | |
411 | */ | |
412 | ||
4164020e | 413 | static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group *ds_file_group, |
f3d74124 | 414 | ctf_fs_ds_file_info::UP ds_file_info) |
41a65f30 | 415 | { |
4164020e | 416 | /* Find the spot where to insert this ds_file_info. */ |
f3d74124 | 417 | auto it = ds_file_group->ds_file_infos.begin(); |
41a65f30 | 418 | |
f3d74124 SM |
419 | for (; it != ds_file_group->ds_file_infos.end(); ++it) { |
420 | const ctf_fs_ds_file_info& other_ds_file_info = **it; | |
421 | ||
422 | if (ds_file_info->begin_ns < other_ds_file_info.begin_ns) { | |
4164020e SM |
423 | break; |
424 | } | |
425 | } | |
41a65f30 | 426 | |
f3d74124 | 427 | ds_file_group->ds_file_infos.insert(it, std::move(ds_file_info)); |
41a65f30 SM |
428 | } |
429 | ||
4164020e SM |
430 | static bool ds_index_entries_equal(const struct ctf_fs_ds_index_entry *left, |
431 | const struct ctf_fs_ds_index_entry *right) | |
1505f33a | 432 | { |
ef7d7ac2 | 433 | if (left->packetSize != right->packetSize) { |
4164020e SM |
434 | return false; |
435 | } | |
1505f33a | 436 | |
4164020e SM |
437 | if (left->timestamp_begin != right->timestamp_begin) { |
438 | return false; | |
439 | } | |
1505f33a | 440 | |
4164020e SM |
441 | if (left->timestamp_end != right->timestamp_end) { |
442 | return false; | |
443 | } | |
1505f33a | 444 | |
4164020e SM |
445 | if (left->packet_seq_num != right->packet_seq_num) { |
446 | return false; | |
447 | } | |
1505f33a | 448 | |
4164020e | 449 | return true; |
1505f33a SM |
450 | } |
451 | ||
452 | /* | |
453 | * Insert `entry` into `index`, without duplication. | |
454 | * | |
455 | * The entry is inserted only if there isn't an identical entry already. | |
456 | * | |
457 | * In any case, the ownership of `entry` is transferred to this function. So if | |
458 | * the entry is not inserted, it is freed. | |
459 | */ | |
460 | ||
4164020e | 461 | static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index *index, |
2fb7af12 | 462 | ctf_fs_ds_index_entry::UP entry) |
7ed5243a | 463 | { |
4164020e | 464 | /* Find the spot where to insert this index entry. */ |
2fb7af12 SM |
465 | auto otherEntry = index->entries.begin(); |
466 | for (; otherEntry != index->entries.end(); ++otherEntry) { | |
467 | if (entry->timestamp_begin_ns <= (*otherEntry)->timestamp_begin_ns) { | |
4164020e SM |
468 | break; |
469 | } | |
470 | } | |
471 | ||
472 | /* | |
473 | * Insert the entry only if a duplicate doesn't already exist. | |
474 | * | |
475 | * There can be duplicate packets if reading multiple overlapping | |
476 | * snapshots of the same trace. We then want the index to contain | |
477 | * a reference to only one copy of that packet. | |
478 | */ | |
2fb7af12 SM |
479 | if (otherEntry == index->entries.end() || |
480 | !ds_index_entries_equal(entry.get(), otherEntry->get())) { | |
481 | index->entries.insert(otherEntry, std::move(entry)); | |
4164020e | 482 | } |
ce75de14 SM |
483 | } |
484 | ||
fe2f9cda | 485 | static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index *dest, ctf_fs_ds_index::UP src) |
ce75de14 | 486 | { |
2fb7af12 SM |
487 | for (auto& entry : src->entries) { |
488 | ds_index_insert_ds_index_entry_sorted(dest, std::move(entry)); | |
4164020e | 489 | } |
7ed5243a FD |
490 | } |
491 | ||
4164020e | 492 | static int add_ds_file_to_ds_file_group(struct ctf_fs_trace *ctf_fs_trace, const char *path) |
94cf822e | 493 | { |
4164020e SM |
494 | int64_t stream_instance_id = -1; |
495 | int64_t begin_ns = -1; | |
496 | struct ctf_fs_ds_file_group *ds_file_group = NULL; | |
fe2e19c4 | 497 | ctf_fs_ds_file_group::UP new_ds_file_group; |
4164020e | 498 | int ret; |
f3d74124 | 499 | ctf_fs_ds_file_info::UP ds_file_info; |
fe2f9cda | 500 | ctf_fs_ds_index::UP index; |
4164020e SM |
501 | struct ctf_msg_iter *msg_iter = NULL; |
502 | struct ctf_stream_class *sc = NULL; | |
503 | struct ctf_msg_iter_packet_properties props; | |
4164020e SM |
504 | |
505 | /* | |
506 | * Create a temporary ds_file to read some properties about the data | |
507 | * stream file. | |
508 | */ | |
884feb7c SM |
509 | const auto ds_file = |
510 | ctf_fs_ds_file_create(ctf_fs_trace, bt2::Stream::Shared {}, path, ctf_fs_trace->logger); | |
4164020e SM |
511 | if (!ds_file) { |
512 | goto error; | |
513 | } | |
514 | ||
515 | /* Create a temporary iterator to read the ds_file. */ | |
0f5c5d5c | 516 | msg_iter = ctf_msg_iter_create( |
657f1bd6 SM |
517 | ctf_fs_trace->metadata->tc, |
518 | bt_common_get_page_size(static_cast<int>(ctf_fs_trace->logger.level())) * 8, | |
519 | ctf_fs_ds_file_medops, ds_file.get(), nullptr, ctf_fs_trace->logger) | |
520 | .release(); | |
4164020e | 521 | if (!msg_iter) { |
0f5c5d5c | 522 | BT_CPPLOGE_STR_SPEC(ctf_fs_trace->logger, "Cannot create a CTF message iterator."); |
4164020e SM |
523 | goto error; |
524 | } | |
525 | ||
526 | ctf_msg_iter_set_dry_run(msg_iter, true); | |
527 | ||
528 | ret = ctf_msg_iter_get_packet_properties(msg_iter, &props); | |
529 | if (ret) { | |
0f5c5d5c SM |
530 | BT_CPPLOGE_APPEND_CAUSE_SPEC( |
531 | ctf_fs_trace->logger, | |
532 | "Cannot get stream file's first packet's header and context fields (`{}`).", path); | |
4164020e SM |
533 | goto error; |
534 | } | |
535 | ||
536 | sc = ctf_trace_class_borrow_stream_class_by_id(ds_file->metadata->tc, props.stream_class_id); | |
537 | BT_ASSERT(sc); | |
538 | stream_instance_id = props.data_stream_id; | |
539 | ||
540 | if (props.snapshots.beginning_clock != UINT64_C(-1)) { | |
541 | BT_ASSERT(sc->default_clock_class); | |
542 | ret = bt_util_clock_cycles_to_ns_from_origin( | |
543 | props.snapshots.beginning_clock, sc->default_clock_class->frequency, | |
544 | sc->default_clock_class->offset_seconds, sc->default_clock_class->offset_cycles, | |
545 | &begin_ns); | |
546 | if (ret) { | |
0f5c5d5c SM |
547 | BT_CPPLOGE_APPEND_CAUSE_SPEC( |
548 | ctf_fs_trace->logger, | |
549 | "Cannot convert clock cycles to nanoseconds from origin (`{}`).", path); | |
4164020e SM |
550 | goto error; |
551 | } | |
552 | } | |
553 | ||
f3d74124 | 554 | ds_file_info = ctf_fs_ds_file_info_create(path, begin_ns); |
4164020e SM |
555 | if (!ds_file_info) { |
556 | goto error; | |
557 | } | |
558 | ||
884feb7c | 559 | index = ctf_fs_ds_file_build_index(ds_file.get(), ds_file_info.get(), msg_iter); |
4164020e | 560 | if (!index) { |
0f5c5d5c | 561 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace->logger, "Failed to index CTF stream file \'{}\'", |
a39d9817 | 562 | ds_file->file->path); |
4164020e SM |
563 | goto error; |
564 | } | |
565 | ||
566 | if (begin_ns == -1) { | |
567 | /* | |
568 | * No beginning timestamp to sort the stream files | |
569 | * within a stream file group, so consider that this | |
570 | * file must be the only one within its group. | |
571 | */ | |
572 | stream_instance_id = -1; | |
573 | } | |
574 | ||
575 | if (stream_instance_id == -1) { | |
576 | /* | |
577 | * No stream instance ID or no beginning timestamp: | |
578 | * create a unique stream file group for this stream | |
579 | * file because, even if there's a stream instance ID, | |
580 | * there's no timestamp to order the file within its | |
581 | * group. | |
582 | */ | |
fe2f9cda SM |
583 | new_ds_file_group = |
584 | ctf_fs_ds_file_group_create(ctf_fs_trace, sc, UINT64_C(-1), std::move(index)); | |
4164020e | 585 | |
fe2e19c4 | 586 | if (!new_ds_file_group) { |
4164020e SM |
587 | goto error; |
588 | } | |
589 | ||
f3d74124 | 590 | ds_file_group_insert_ds_file_info_sorted(new_ds_file_group.get(), std::move(ds_file_info)); |
cdf7de78 | 591 | ctf_fs_trace->ds_file_groups.emplace_back(std::move(new_ds_file_group)); |
4164020e SM |
592 | goto end; |
593 | } | |
594 | ||
595 | BT_ASSERT(stream_instance_id != -1); | |
596 | BT_ASSERT(begin_ns != -1); | |
597 | ||
598 | /* Find an existing stream file group with this ID */ | |
cdf7de78 SM |
599 | for (const auto& candidate : ctf_fs_trace->ds_file_groups) { |
600 | if (candidate->sc == sc && candidate->stream_id == stream_instance_id) { | |
601 | ds_file_group = candidate.get(); | |
4164020e SM |
602 | break; |
603 | } | |
4164020e SM |
604 | } |
605 | ||
606 | if (!ds_file_group) { | |
fe2e19c4 | 607 | new_ds_file_group = |
fe2f9cda | 608 | ctf_fs_ds_file_group_create(ctf_fs_trace, sc, stream_instance_id, std::move(index)); |
fe2e19c4 | 609 | if (!new_ds_file_group) { |
4164020e SM |
610 | goto error; |
611 | } | |
612 | ||
fe2e19c4 | 613 | ds_file_group = new_ds_file_group.get(); |
cdf7de78 | 614 | ctf_fs_trace->ds_file_groups.emplace_back(std::move(new_ds_file_group)); |
4164020e | 615 | } else { |
fe2f9cda | 616 | merge_ctf_fs_ds_indexes(ds_file_group->index.get(), std::move(index)); |
4164020e SM |
617 | } |
618 | ||
f3d74124 | 619 | ds_file_group_insert_ds_file_info_sorted(ds_file_group, std::move(ds_file_info)); |
4164020e SM |
620 | |
621 | goto end; | |
94cf822e PP |
622 | |
623 | error: | |
4164020e | 624 | ret = -1; |
94cf822e PP |
625 | |
626 | end: | |
4164020e SM |
627 | if (msg_iter) { |
628 | ctf_msg_iter_destroy(msg_iter); | |
629 | } | |
6de92955 | 630 | |
4164020e | 631 | return ret; |
94cf822e PP |
632 | } |
633 | ||
4164020e | 634 | static int create_ds_file_groups(struct ctf_fs_trace *ctf_fs_trace) |
e7a4393b | 635 | { |
4164020e SM |
636 | int ret = 0; |
637 | const char *basename; | |
638 | GError *error = NULL; | |
639 | GDir *dir = NULL; | |
4164020e SM |
640 | |
641 | /* Check each file in the path directory, except specific ones */ | |
642 | dir = g_dir_open(ctf_fs_trace->path->str, 0, &error); | |
643 | if (!dir) { | |
0f5c5d5c SM |
644 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace->logger, |
645 | "Cannot open directory `{}`: {} (code {})", | |
646 | ctf_fs_trace->path->str, error->message, error->code); | |
4164020e SM |
647 | goto error; |
648 | } | |
649 | ||
650 | while ((basename = g_dir_read_name(dir))) { | |
4164020e SM |
651 | if (strcmp(basename, CTF_FS_METADATA_FILENAME) == 0) { |
652 | /* Ignore the metadata stream. */ | |
0f5c5d5c SM |
653 | BT_CPPLOGI_SPEC(ctf_fs_trace->logger, |
654 | "Ignoring metadata file `{}" G_DIR_SEPARATOR_S "{}`", | |
655 | ctf_fs_trace->path->str, basename); | |
4164020e SM |
656 | continue; |
657 | } | |
658 | ||
659 | if (basename[0] == '.') { | |
0f5c5d5c SM |
660 | BT_CPPLOGI_SPEC(ctf_fs_trace->logger, |
661 | "Ignoring hidden file `{}" G_DIR_SEPARATOR_S "{}`", | |
662 | ctf_fs_trace->path->str, basename); | |
4164020e SM |
663 | continue; |
664 | } | |
665 | ||
666 | /* Create the file. */ | |
2b6f09e0 | 667 | const auto file = ctf_fs_file_create(ctf_fs_trace->logger); |
4164020e | 668 | if (!file) { |
0f5c5d5c SM |
669 | BT_CPPLOGE_APPEND_CAUSE_SPEC( |
670 | ctf_fs_trace->logger, | |
671 | "Cannot create stream file object for file `{}" G_DIR_SEPARATOR_S "{}`", | |
4164020e SM |
672 | ctf_fs_trace->path->str, basename); |
673 | goto error; | |
674 | } | |
675 | ||
676 | /* Create full path string. */ | |
a39d9817 SM |
677 | file->path = fmt::format("{}" G_DIR_SEPARATOR_S "{}", ctf_fs_trace->path->str, basename); |
678 | ||
679 | if (!g_file_test(file->path.c_str(), G_FILE_TEST_IS_REGULAR)) { | |
680 | BT_CPPLOGI_SPEC(ctf_fs_trace->logger, "Ignoring non-regular file `{}`", file->path); | |
4164020e SM |
681 | continue; |
682 | } | |
683 | ||
2b6f09e0 | 684 | ret = ctf_fs_file_open(file.get(), "rb"); |
4164020e | 685 | if (ret) { |
0f5c5d5c | 686 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace->logger, "Cannot open stream file `{}`", |
a39d9817 | 687 | file->path); |
4164020e SM |
688 | goto error; |
689 | } | |
690 | ||
691 | if (file->size == 0) { | |
692 | /* Skip empty stream. */ | |
a39d9817 | 693 | BT_CPPLOGI_SPEC(ctf_fs_trace->logger, "Ignoring empty file `{}`", file->path); |
4164020e SM |
694 | continue; |
695 | } | |
696 | ||
a39d9817 | 697 | ret = add_ds_file_to_ds_file_group(ctf_fs_trace, file->path.c_str()); |
4164020e | 698 | if (ret) { |
0f5c5d5c SM |
699 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace->logger, |
700 | "Cannot add stream file `{}` to stream file group", | |
a39d9817 | 701 | file->path); |
4164020e SM |
702 | goto error; |
703 | } | |
4164020e SM |
704 | } |
705 | ||
706 | goto end; | |
4f1f88a6 | 707 | |
e7a4393b | 708 | error: |
4164020e | 709 | ret = -1; |
4f1f88a6 | 710 | |
e7a4393b | 711 | end: |
4164020e SM |
712 | if (dir) { |
713 | g_dir_close(dir); | |
714 | dir = NULL; | |
715 | } | |
4f1f88a6 | 716 | |
4164020e SM |
717 | if (error) { |
718 | g_error_free(error); | |
719 | } | |
5b29e799 | 720 | |
4164020e | 721 | return ret; |
5b29e799 JG |
722 | } |
723 | ||
0f5c5d5c | 724 | static int set_trace_name(bt_trace *trace, const char *name_suffix, const bt2c::Logger& logger) |
862ca4ed | 725 | { |
4164020e SM |
726 | int ret = 0; |
727 | const bt_value *val; | |
728 | GString *name; | |
729 | ||
730 | name = g_string_new(NULL); | |
731 | if (!name) { | |
0f5c5d5c | 732 | BT_CPPLOGE_STR_SPEC(logger, "Failed to allocate a GString."); |
4164020e SM |
733 | ret = -1; |
734 | goto end; | |
735 | } | |
736 | ||
737 | /* | |
738 | * Check if we have a trace environment string value named `hostname`. | |
739 | * If so, use it as the trace name's prefix. | |
740 | */ | |
741 | val = bt_trace_borrow_environment_entry_value_by_name_const(trace, "hostname"); | |
742 | if (val && bt_value_is_string(val)) { | |
743 | g_string_append(name, bt_value_string_get(val)); | |
744 | ||
745 | if (name_suffix) { | |
746 | g_string_append_c(name, G_DIR_SEPARATOR); | |
747 | } | |
748 | } | |
749 | ||
750 | if (name_suffix) { | |
751 | g_string_append(name, name_suffix); | |
752 | } | |
753 | ||
754 | ret = bt_trace_set_name(trace, name->str); | |
755 | if (ret) { | |
756 | goto end; | |
757 | } | |
758 | ||
759 | goto end; | |
862ca4ed PP |
760 | |
761 | end: | |
4164020e SM |
762 | if (name) { |
763 | g_string_free(name, TRUE); | |
764 | } | |
862ca4ed | 765 | |
4164020e | 766 | return ret; |
862ca4ed PP |
767 | } |
768 | ||
2ca337f1 SM |
769 | static ctf_fs_trace::UP ctf_fs_trace_create(const char *path, const char *name, |
770 | const ctf::src::ClkClsCfg& clkClsCfg, | |
771 | bt_self_component *selfComp, | |
772 | const bt2c::Logger& parentLogger) | |
1a9f7075 | 773 | { |
4164020e SM |
774 | int ret; |
775 | ||
2ca337f1 | 776 | ctf_fs_trace::UP ctf_fs_trace {new struct ctf_fs_trace(parentLogger)}; |
4164020e SM |
777 | ctf_fs_trace->path = g_string_new(path); |
778 | if (!ctf_fs_trace->path) { | |
779 | goto error; | |
780 | } | |
781 | ||
afb0f12b | 782 | ctf_fs_trace->metadata = new ctf_fs_metadata; |
4164020e | 783 | ctf_fs_metadata_init(ctf_fs_trace->metadata); |
4164020e | 784 | |
2ca337f1 | 785 | ret = ctf_fs_metadata_set_trace_class(selfComp, ctf_fs_trace.get(), clkClsCfg); |
4164020e SM |
786 | if (ret) { |
787 | goto error; | |
788 | } | |
789 | ||
790 | if (ctf_fs_trace->metadata->trace_class) { | |
791 | ctf_fs_trace->trace = bt_trace_create(ctf_fs_trace->metadata->trace_class); | |
792 | if (!ctf_fs_trace->trace) { | |
793 | goto error; | |
794 | } | |
795 | } | |
796 | ||
797 | if (ctf_fs_trace->trace) { | |
798 | ret = ctf_trace_class_configure_ir_trace(ctf_fs_trace->metadata->tc, ctf_fs_trace->trace); | |
799 | if (ret) { | |
800 | goto error; | |
801 | } | |
802 | ||
0f5c5d5c | 803 | ret = set_trace_name(ctf_fs_trace->trace, name, ctf_fs_trace->logger); |
4164020e SM |
804 | if (ret) { |
805 | goto error; | |
806 | } | |
807 | } | |
808 | ||
2ca337f1 | 809 | ret = create_ds_file_groups(ctf_fs_trace.get()); |
4164020e SM |
810 | if (ret) { |
811 | goto error; | |
812 | } | |
813 | ||
814 | goto end; | |
1a9f7075 PP |
815 | |
816 | error: | |
2ca337f1 | 817 | ctf_fs_trace.reset(); |
44c440bc | 818 | |
1a9f7075 | 819 | end: |
4164020e | 820 | return ctf_fs_trace; |
1a9f7075 PP |
821 | } |
822 | ||
4164020e | 823 | static int path_is_ctf_trace(const char *path) |
1a9f7075 | 824 | { |
4164020e SM |
825 | GString *metadata_path = g_string_new(NULL); |
826 | int ret = 0; | |
1a9f7075 | 827 | |
4164020e SM |
828 | if (!metadata_path) { |
829 | ret = -1; | |
830 | goto end; | |
831 | } | |
1a9f7075 | 832 | |
4164020e | 833 | g_string_printf(metadata_path, "%s" G_DIR_SEPARATOR_S "%s", path, CTF_FS_METADATA_FILENAME); |
1a9f7075 | 834 | |
4164020e SM |
835 | if (g_file_test(metadata_path->str, G_FILE_TEST_IS_REGULAR)) { |
836 | ret = 1; | |
837 | goto end; | |
838 | } | |
1a9f7075 PP |
839 | |
840 | end: | |
4164020e SM |
841 | g_string_free(metadata_path, TRUE); |
842 | return ret; | |
1a9f7075 PP |
843 | } |
844 | ||
a0cd55ad | 845 | /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */ |
f280892e | 846 | |
4164020e SM |
847 | static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component *ctf_fs, |
848 | const char *path_param, | |
a4c955d9 SM |
849 | const char *trace_name, |
850 | std::vector<ctf_fs_trace::UP>& traces, | |
0f5c5d5c | 851 | bt_self_component *selfComp) |
1a9f7075 | 852 | { |
2ca337f1 | 853 | ctf_fs_trace::UP ctf_fs_trace; |
4164020e SM |
854 | int ret; |
855 | GString *norm_path; | |
4164020e SM |
856 | |
857 | norm_path = bt_common_normalize_path(path_param, NULL); | |
858 | if (!norm_path) { | |
0f5c5d5c | 859 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs->logger, "Failed to normalize path: `{}`.", path_param); |
4164020e SM |
860 | goto error; |
861 | } | |
862 | ||
863 | ret = path_is_ctf_trace(norm_path->str); | |
864 | if (ret < 0) { | |
0f5c5d5c SM |
865 | BT_CPPLOGE_APPEND_CAUSE_SPEC( |
866 | ctf_fs->logger, "Failed to check if path is a CTF trace: path={}", norm_path->str); | |
4164020e SM |
867 | goto error; |
868 | } else if (ret == 0) { | |
0f5c5d5c SM |
869 | BT_CPPLOGE_APPEND_CAUSE_SPEC( |
870 | ctf_fs->logger, "Path is not a CTF trace (does not contain a metadata file): `{}`.", | |
871 | norm_path->str); | |
4164020e SM |
872 | goto error; |
873 | } | |
874 | ||
875 | // FIXME: Remove or ifdef for __MINGW32__ | |
876 | if (strcmp(norm_path->str, "/") == 0) { | |
0f5c5d5c | 877 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs->logger, "Opening a trace in `/` is not supported."); |
4164020e SM |
878 | ret = -1; |
879 | goto end; | |
880 | } | |
881 | ||
c942e7a2 SM |
882 | ctf_fs_trace = ctf_fs_trace_create(norm_path->str, trace_name, ctf_fs->clkClsCfg, selfComp, |
883 | ctf_fs->logger); | |
4164020e | 884 | if (!ctf_fs_trace) { |
0f5c5d5c SM |
885 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs->logger, "Cannot create trace for `{}`.", |
886 | norm_path->str); | |
4164020e SM |
887 | goto error; |
888 | } | |
889 | ||
a4c955d9 | 890 | traces.emplace_back(std::move(ctf_fs_trace)); |
4164020e SM |
891 | |
892 | ret = 0; | |
893 | goto end; | |
1a9f7075 PP |
894 | |
895 | error: | |
4164020e | 896 | ret = -1; |
1a9f7075 PP |
897 | |
898 | end: | |
4164020e SM |
899 | if (norm_path) { |
900 | g_string_free(norm_path, TRUE); | |
901 | } | |
4bd72b60 | 902 | |
4164020e | 903 | return ret; |
1a9f7075 PP |
904 | } |
905 | ||
41a65f30 SM |
906 | /* |
907 | * Count the number of stream and event classes defined by this trace's metadata. | |
908 | * | |
909 | * This is used to determine which metadata is the "latest", out of multiple | |
910 | * traces sharing the same UUID. It is assumed that amongst all these metadatas, | |
911 | * a bigger metadata is a superset of a smaller metadata. Therefore, it is | |
912 | * enough to just count the classes. | |
913 | */ | |
914 | ||
4164020e | 915 | static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace *trace) |
41a65f30 | 916 | { |
4164020e SM |
917 | unsigned int num = trace->metadata->tc->stream_classes->len; |
918 | guint i; | |
41a65f30 | 919 | |
4164020e SM |
920 | for (i = 0; i < trace->metadata->tc->stream_classes->len; i++) { |
921 | struct ctf_stream_class *sc = | |
922 | (struct ctf_stream_class *) trace->metadata->tc->stream_classes->pdata[i]; | |
923 | num += sc->event_classes->len; | |
924 | } | |
41a65f30 | 925 | |
4164020e | 926 | return num; |
41a65f30 SM |
927 | } |
928 | ||
929 | /* | |
930 | * Merge the src ds_file_group into dest. This consists of merging their | |
931 | * ds_file_infos, making sure to keep the result sorted. | |
932 | */ | |
933 | ||
4164020e | 934 | static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group *dest, |
cdf7de78 | 935 | ctf_fs_ds_file_group::UP src) |
41a65f30 | 936 | { |
f3d74124 SM |
937 | for (auto& ds_file_info : src->ds_file_infos) { |
938 | ds_file_group_insert_ds_file_info_sorted(dest, std::move(ds_file_info)); | |
4164020e | 939 | } |
41a65f30 | 940 | |
4164020e | 941 | /* Merge both indexes. */ |
fe2f9cda | 942 | merge_ctf_fs_ds_indexes(dest->index.get(), std::move(src->index)); |
7ed5243a | 943 | } |
a4c955d9 | 944 | |
41a65f30 SM |
945 | /* Merge src_trace's data stream file groups into dest_trace's. */ |
946 | ||
4164020e | 947 | static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace *dest_trace, |
a4c955d9 | 948 | ctf_fs_trace::UP src_trace) |
41a65f30 | 949 | { |
cdf7de78 SM |
950 | std::vector<ctf_fs_ds_file_group::UP>& dest = dest_trace->ds_file_groups; |
951 | std::vector<ctf_fs_ds_file_group::UP>& src = src_trace->ds_file_groups; | |
4164020e SM |
952 | int ret = 0; |
953 | ||
954 | /* | |
955 | * Save the initial length of dest: we only want to check against the | |
956 | * original elements in the inner loop. | |
957 | */ | |
cdf7de78 | 958 | size_t dest_len = dest.size(); |
4164020e | 959 | |
cdf7de78 | 960 | for (auto& src_group : src) { |
4164020e SM |
961 | struct ctf_fs_ds_file_group *dest_group = NULL; |
962 | ||
963 | /* A stream instance without ID can't match a stream in the other trace. */ | |
964 | if (src_group->stream_id != -1) { | |
4164020e | 965 | /* Let's search for a matching ds_file_group in the destination. */ |
cdf7de78 SM |
966 | for (size_t d_i = 0; d_i < dest_len; ++d_i) { |
967 | ctf_fs_ds_file_group *candidate_dest = dest[d_i].get(); | |
4164020e SM |
968 | |
969 | /* Can't match a stream instance without ID. */ | |
970 | if (candidate_dest->stream_id == -1) { | |
971 | continue; | |
972 | } | |
973 | ||
974 | /* | |
975 | * If the two groups have the same stream instance id | |
976 | * and belong to the same stream class (stream instance | |
977 | * ids are per-stream class), they represent the same | |
978 | * stream instance. | |
979 | */ | |
980 | if (candidate_dest->stream_id != src_group->stream_id || | |
981 | candidate_dest->sc->id != src_group->sc->id) { | |
982 | continue; | |
983 | } | |
984 | ||
985 | dest_group = candidate_dest; | |
986 | break; | |
987 | } | |
988 | } | |
989 | ||
990 | /* | |
991 | * Didn't find a friend in dest to merge our src_group into? | |
992 | * Create a new empty one. This can happen if a stream was | |
993 | * active in the source trace chunk but not in the destination | |
994 | * trace chunk. | |
995 | */ | |
996 | if (!dest_group) { | |
997 | struct ctf_stream_class *sc; | |
4164020e SM |
998 | |
999 | sc = ctf_trace_class_borrow_stream_class_by_id(dest_trace->metadata->tc, | |
1000 | src_group->sc->id); | |
1001 | BT_ASSERT(sc); | |
1002 | ||
2fb7af12 | 1003 | auto index = ctf_fs_ds_index_create(); |
4164020e SM |
1004 | if (!index) { |
1005 | ret = -1; | |
1006 | goto end; | |
1007 | } | |
1008 | ||
fe2e19c4 | 1009 | auto new_dest_group = |
fe2f9cda | 1010 | ctf_fs_ds_file_group_create(dest_trace, sc, src_group->stream_id, std::move(index)); |
fe2e19c4 | 1011 | |
fe2e19c4 | 1012 | if (!new_dest_group) { |
4164020e SM |
1013 | ret = -1; |
1014 | goto end; | |
1015 | } | |
1016 | ||
fe2e19c4 | 1017 | dest_group = new_dest_group.get(); |
cdf7de78 | 1018 | dest_trace->ds_file_groups.emplace_back(std::move(new_dest_group)); |
4164020e SM |
1019 | } |
1020 | ||
1021 | BT_ASSERT(dest_group); | |
cdf7de78 | 1022 | merge_ctf_fs_ds_file_groups(dest_group, std::move(src_group)); |
4164020e | 1023 | } |
54ef52bd FD |
1024 | |
1025 | end: | |
4164020e | 1026 | return ret; |
41a65f30 SM |
1027 | } |
1028 | ||
1029 | /* | |
1030 | * Collapse the given traces, which must all share the same UUID, in a single | |
1031 | * one. | |
1032 | * | |
1033 | * The trace with the most expansive metadata is chosen and all other traces | |
a4c955d9 SM |
1034 | * are merged into that one. On return, the elements of `traces` are nullptr |
1035 | * and the merged trace is placed in `out_trace`. | |
41a65f30 SM |
1036 | */ |
1037 | ||
a4c955d9 | 1038 | static int merge_ctf_fs_traces(std::vector<ctf_fs_trace::UP> traces, ctf_fs_trace::UP& out_trace) |
41a65f30 | 1039 | { |
4164020e SM |
1040 | unsigned int winner_count; |
1041 | struct ctf_fs_trace *winner; | |
1042 | guint i, winner_i; | |
1043 | int ret = 0; | |
1044 | ||
a4c955d9 | 1045 | BT_ASSERT(traces.size() >= 2); |
4164020e | 1046 | |
a4c955d9 SM |
1047 | winner_count = metadata_count_stream_and_event_classes(traces[0].get()); |
1048 | winner = traces[0].get(); | |
4164020e SM |
1049 | winner_i = 0; |
1050 | ||
1051 | /* Find the trace with the largest metadata. */ | |
a4c955d9 SM |
1052 | for (i = 1; i < traces.size(); i++) { |
1053 | ctf_fs_trace *candidate = traces[i].get(); | |
4164020e SM |
1054 | unsigned int candidate_count; |
1055 | ||
4164020e SM |
1056 | /* A bit of sanity check. */ |
1057 | BT_ASSERT(bt_uuid_compare(winner->metadata->tc->uuid, candidate->metadata->tc->uuid) == 0); | |
1058 | ||
1059 | candidate_count = metadata_count_stream_and_event_classes(candidate); | |
1060 | ||
1061 | if (candidate_count > winner_count) { | |
1062 | winner_count = candidate_count; | |
1063 | winner = candidate; | |
1064 | winner_i = i; | |
1065 | } | |
1066 | } | |
1067 | ||
1068 | /* Merge all the other traces in the winning trace. */ | |
a4c955d9 | 1069 | for (ctf_fs_trace::UP& trace : traces) { |
4164020e | 1070 | /* Don't merge the winner into itself. */ |
a4c955d9 | 1071 | if (trace.get() == winner) { |
4164020e SM |
1072 | continue; |
1073 | } | |
1074 | ||
1075 | /* Merge trace's data stream file groups into winner's. */ | |
a4c955d9 | 1076 | ret = merge_matching_ctf_fs_ds_file_groups(winner, std::move(trace)); |
4164020e SM |
1077 | if (ret) { |
1078 | goto end; | |
1079 | } | |
1080 | } | |
1081 | ||
1082 | /* | |
1083 | * Move the winner out of the array, into `*out_trace`. | |
1084 | */ | |
a4c955d9 | 1085 | out_trace = std::move(traces[winner_i]); |
54ef52bd FD |
1086 | |
1087 | end: | |
4164020e | 1088 | return ret; |
41a65f30 SM |
1089 | } |
1090 | ||
4164020e SM |
1091 | enum target_event |
1092 | { | |
1093 | FIRST_EVENT, | |
1094 | LAST_EVENT, | |
1719bf64 FD |
1095 | }; |
1096 | ||
4164020e SM |
1097 | static int decode_clock_snapshot_after_event(struct ctf_fs_trace *ctf_fs_trace, |
1098 | struct ctf_clock_class *default_cc, | |
1099 | struct ctf_fs_ds_index_entry *index_entry, | |
1100 | enum target_event target_event, uint64_t *cs, | |
1101 | int64_t *ts_ns) | |
1719bf64 | 1102 | { |
4164020e | 1103 | enum ctf_msg_iter_status iter_status = CTF_MSG_ITER_STATUS_OK; |
4164020e | 1104 | struct ctf_msg_iter *msg_iter = NULL; |
4164020e SM |
1105 | int ret = 0; |
1106 | ||
1107 | BT_ASSERT(ctf_fs_trace); | |
1108 | BT_ASSERT(index_entry); | |
1109 | BT_ASSERT(index_entry->path); | |
1110 | ||
21c7fd8b SM |
1111 | const auto ds_file = ctf_fs_ds_file_create(ctf_fs_trace, bt2::Stream::Shared {}, |
1112 | index_entry->path, ctf_fs_trace->logger); | |
4164020e | 1113 | if (!ds_file) { |
0f5c5d5c | 1114 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace->logger, "Failed to create a ctf_fs_ds_file"); |
4164020e SM |
1115 | ret = -1; |
1116 | goto end; | |
1117 | } | |
1118 | ||
1119 | BT_ASSERT(ctf_fs_trace->metadata); | |
1120 | BT_ASSERT(ctf_fs_trace->metadata->tc); | |
1121 | ||
0f5c5d5c | 1122 | msg_iter = ctf_msg_iter_create( |
657f1bd6 SM |
1123 | ctf_fs_trace->metadata->tc, |
1124 | bt_common_get_page_size(static_cast<int>(ctf_fs_trace->logger.level())) * 8, | |
1125 | ctf_fs_ds_file_medops, ds_file.get(), NULL, ctf_fs_trace->logger) | |
1126 | .release(); | |
4164020e SM |
1127 | if (!msg_iter) { |
1128 | /* ctf_msg_iter_create() logs errors. */ | |
1129 | ret = -1; | |
1130 | goto end; | |
1131 | } | |
1132 | ||
1133 | /* | |
1134 | * Turn on dry run mode to prevent the creation and usage of Babeltrace | |
1135 | * library objects (bt_field, bt_message_*, etc.). | |
1136 | */ | |
1137 | ctf_msg_iter_set_dry_run(msg_iter, true); | |
1138 | ||
1139 | /* Seek to the beginning of the target packet. */ | |
ef7d7ac2 | 1140 | iter_status = ctf_msg_iter_seek(msg_iter, index_entry->offset.bytes()); |
4164020e SM |
1141 | if (iter_status) { |
1142 | /* ctf_msg_iter_seek() logs errors. */ | |
1143 | ret = -1; | |
1144 | goto end; | |
1145 | } | |
1146 | ||
1147 | switch (target_event) { | |
1148 | case FIRST_EVENT: | |
1149 | /* | |
1150 | * Start to decode the packet until we reach the end of | |
1151 | * the first event. To extract the first event's clock | |
1152 | * snapshot. | |
1153 | */ | |
1154 | iter_status = ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter, cs); | |
1155 | break; | |
1156 | case LAST_EVENT: | |
1157 | /* Decode the packet to extract the last event's clock snapshot. */ | |
1158 | iter_status = ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter, cs); | |
1159 | break; | |
1160 | default: | |
1161 | bt_common_abort(); | |
1162 | } | |
1163 | if (iter_status) { | |
1164 | ret = -1; | |
1165 | goto end; | |
1166 | } | |
1167 | ||
1168 | /* Convert clock snapshot to timestamp. */ | |
1169 | ret = bt_util_clock_cycles_to_ns_from_origin( | |
1170 | *cs, default_cc->frequency, default_cc->offset_seconds, default_cc->offset_cycles, ts_ns); | |
1171 | if (ret) { | |
0f5c5d5c SM |
1172 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace->logger, |
1173 | "Failed to convert clock snapshot to timestamp"); | |
4164020e SM |
1174 | goto end; |
1175 | } | |
1719bf64 FD |
1176 | |
1177 | end: | |
4164020e SM |
1178 | if (msg_iter) { |
1179 | ctf_msg_iter_destroy(msg_iter); | |
1180 | } | |
1181 | ||
1182 | return ret; | |
1719bf64 FD |
1183 | } |
1184 | ||
4164020e SM |
1185 | static int decode_packet_first_event_timestamp(struct ctf_fs_trace *ctf_fs_trace, |
1186 | struct ctf_clock_class *default_cc, | |
1187 | struct ctf_fs_ds_index_entry *index_entry, | |
1188 | uint64_t *cs, int64_t *ts_ns) | |
c43092a5 | 1189 | { |
4164020e SM |
1190 | return decode_clock_snapshot_after_event(ctf_fs_trace, default_cc, index_entry, FIRST_EVENT, cs, |
1191 | ts_ns); | |
c43092a5 FD |
1192 | } |
1193 | ||
4164020e SM |
1194 | static int decode_packet_last_event_timestamp(struct ctf_fs_trace *ctf_fs_trace, |
1195 | struct ctf_clock_class *default_cc, | |
1196 | struct ctf_fs_ds_index_entry *index_entry, | |
1197 | uint64_t *cs, int64_t *ts_ns) | |
1719bf64 | 1198 | { |
4164020e SM |
1199 | return decode_clock_snapshot_after_event(ctf_fs_trace, default_cc, index_entry, LAST_EVENT, cs, |
1200 | ts_ns); | |
1719bf64 FD |
1201 | } |
1202 | ||
1203 | /* | |
1204 | * Fix up packet index entries for lttng's "event-after-packet" bug. | |
1205 | * Some buggy lttng tracer versions may emit events with a timestamp that is | |
1206 | * larger (after) than the timestamp_end of the their packets. | |
1207 | * | |
1208 | * To fix up this erroneous data we do the following: | |
1209 | * 1. If it's not the stream file's last packet: set the packet index entry's | |
1210 | * end time to the next packet's beginning time. | |
1211 | * 2. If it's the stream file's last packet, set the packet index entry's end | |
1212 | * time to the packet's last event's time, if any, or to the packet's | |
1213 | * beginning time otherwise. | |
1214 | * | |
1215 | * Known buggy tracer versions: | |
1216 | * - before lttng-ust 2.11.0 | |
1217 | * - before lttng-module 2.11.0 | |
1218 | * - before lttng-module 2.10.10 | |
1219 | * - before lttng-module 2.9.13 | |
1220 | */ | |
4164020e | 1221 | static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace *trace) |
1719bf64 | 1222 | { |
4164020e | 1223 | int ret = 0; |
4164020e | 1224 | |
cdf7de78 | 1225 | for (const auto& ds_file_group : trace->ds_file_groups) { |
4164020e | 1226 | struct ctf_clock_class *default_cc; |
4164020e | 1227 | |
4164020e | 1228 | BT_ASSERT(ds_file_group); |
fe2f9cda | 1229 | const auto index = ds_file_group->index.get(); |
4164020e SM |
1230 | |
1231 | BT_ASSERT(index); | |
2fb7af12 | 1232 | BT_ASSERT(!index->entries.empty()); |
4164020e SM |
1233 | |
1234 | /* | |
1235 | * Iterate over all entries but the last one. The last one is | |
1236 | * fixed differently after. | |
1237 | */ | |
2fb7af12 SM |
1238 | for (size_t entry_i = 0; entry_i < index->entries.size() - 1; ++entry_i) { |
1239 | ctf_fs_ds_index_entry *curr_entry = index->entries[entry_i].get(); | |
1240 | ctf_fs_ds_index_entry *next_entry = index->entries[entry_i + 1].get(); | |
4164020e SM |
1241 | |
1242 | /* | |
1243 | * 1. Set the current index entry `end` timestamp to | |
1244 | * the next index entry `begin` timestamp. | |
1245 | */ | |
1246 | curr_entry->timestamp_end = next_entry->timestamp_begin; | |
1247 | curr_entry->timestamp_end_ns = next_entry->timestamp_begin_ns; | |
1248 | } | |
1249 | ||
1250 | /* | |
1251 | * 2. Fix the last entry by decoding the last event of the last | |
1252 | * packet. | |
1253 | */ | |
2fb7af12 | 1254 | const auto last_entry = index->entries.back().get(); |
4164020e SM |
1255 | BT_ASSERT(last_entry); |
1256 | ||
1257 | BT_ASSERT(ds_file_group->sc->default_clock_class); | |
1258 | default_cc = ds_file_group->sc->default_clock_class; | |
1259 | ||
1260 | /* | |
1261 | * Decode packet to read the timestamp of the last event of the | |
1262 | * entry. | |
1263 | */ | |
1264 | ret = decode_packet_last_event_timestamp(trace, default_cc, last_entry, | |
1265 | &last_entry->timestamp_end, | |
1266 | &last_entry->timestamp_end_ns); | |
1267 | if (ret) { | |
0f5c5d5c SM |
1268 | BT_CPPLOGE_APPEND_CAUSE_SPEC( |
1269 | trace->logger, | |
4164020e SM |
1270 | "Failed to decode stream's last packet to get its last event's clock snapshot."); |
1271 | goto end; | |
1272 | } | |
1273 | } | |
1719bf64 FD |
1274 | |
1275 | end: | |
4164020e | 1276 | return ret; |
1719bf64 FD |
1277 | } |
1278 | ||
c43092a5 FD |
1279 | /* |
1280 | * Fix up packet index entries for barectf's "event-before-packet" bug. | |
1281 | * Some buggy barectf tracer versions may emit events with a timestamp that is | |
1282 | * less than the timestamp_begin of the their packets. | |
1283 | * | |
1284 | * To fix up this erroneous data we do the following: | |
1285 | * 1. Starting at the second index entry, set the timestamp_begin of the | |
1286 | * current entry to the timestamp of the first event of the packet. | |
1287 | * 2. Set the previous entry's timestamp_end to the timestamp_begin of the | |
1288 | * current packet. | |
1289 | * | |
1290 | * Known buggy tracer versions: | |
1291 | * - before barectf 2.3.1 | |
1292 | */ | |
4164020e | 1293 | static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace *trace) |
c43092a5 | 1294 | { |
4164020e | 1295 | int ret = 0; |
4164020e | 1296 | |
cdf7de78 | 1297 | for (const auto& ds_file_group : trace->ds_file_groups) { |
4164020e | 1298 | struct ctf_clock_class *default_cc; |
fe2f9cda | 1299 | const auto index = ds_file_group->index.get(); |
4164020e SM |
1300 | |
1301 | BT_ASSERT(index); | |
2fb7af12 | 1302 | BT_ASSERT(!index->entries.empty()); |
4164020e SM |
1303 | |
1304 | BT_ASSERT(ds_file_group->sc->default_clock_class); | |
1305 | default_cc = ds_file_group->sc->default_clock_class; | |
1306 | ||
1307 | /* | |
1308 | * 1. Iterate over the index, starting from the second entry | |
1309 | * (index = 1). | |
1310 | */ | |
2fb7af12 SM |
1311 | for (size_t entry_i = 1; entry_i < index->entries.size(); ++entry_i) { |
1312 | ctf_fs_ds_index_entry *prev_entry = index->entries[entry_i - 1].get(); | |
1313 | ctf_fs_ds_index_entry *curr_entry = index->entries[entry_i].get(); | |
4164020e SM |
1314 | /* |
1315 | * 2. Set the current entry `begin` timestamp to the | |
1316 | * timestamp of the first event of the current packet. | |
1317 | */ | |
1318 | ret = decode_packet_first_event_timestamp(trace, default_cc, curr_entry, | |
1319 | &curr_entry->timestamp_begin, | |
1320 | &curr_entry->timestamp_begin_ns); | |
1321 | if (ret) { | |
0f5c5d5c SM |
1322 | BT_CPPLOGE_APPEND_CAUSE_SPEC(trace->logger, |
1323 | "Failed to decode first event's clock snapshot"); | |
4164020e SM |
1324 | goto end; |
1325 | } | |
1326 | ||
1327 | /* | |
1328 | * 3. Set the previous entry `end` timestamp to the | |
1329 | * timestamp of the first event of the current packet. | |
1330 | */ | |
1331 | prev_entry->timestamp_end = curr_entry->timestamp_begin; | |
1332 | prev_entry->timestamp_end_ns = curr_entry->timestamp_begin_ns; | |
1333 | } | |
1334 | } | |
c43092a5 | 1335 | end: |
4164020e | 1336 | return ret; |
c43092a5 FD |
1337 | } |
1338 | ||
aada78b5 FD |
1339 | /* |
1340 | * When using the lttng-crash feature it's likely that the last packets of each | |
1341 | * stream have their timestamp_end set to zero. This is caused by the fact that | |
1342 | * the tracer crashed and was not able to properly close the packets. | |
1343 | * | |
1344 | * To fix up this erroneous data we do the following: | |
1345 | * For each index entry, if the entry's timestamp_end is 0 and the | |
1346 | * timestamp_begin is not 0: | |
1347 | * - If it's the stream file's last packet: set the packet index entry's end | |
1348 | * time to the packet's last event's time, if any, or to the packet's | |
1349 | * beginning time otherwise. | |
1350 | * - If it's not the stream file's last packet: set the packet index | |
1351 | * entry's end time to the next packet's beginning time. | |
1352 | * | |
1353 | * Affected versions: | |
1354 | * - All current and future lttng-ust and lttng-modules versions. | |
1355 | */ | |
4164020e | 1356 | static int fix_index_lttng_crash_quirk(struct ctf_fs_trace *trace) |
aada78b5 | 1357 | { |
4164020e | 1358 | int ret = 0; |
4164020e | 1359 | |
cdf7de78 | 1360 | for (const auto& ds_file_group : trace->ds_file_groups) { |
4164020e | 1361 | struct ctf_clock_class *default_cc; |
4164020e | 1362 | |
4164020e | 1363 | BT_ASSERT(ds_file_group); |
fe2f9cda | 1364 | const auto index = ds_file_group->index.get(); |
4164020e SM |
1365 | |
1366 | BT_ASSERT(ds_file_group->sc->default_clock_class); | |
1367 | default_cc = ds_file_group->sc->default_clock_class; | |
1368 | ||
1369 | BT_ASSERT(index); | |
2fb7af12 | 1370 | BT_ASSERT(!index->entries.empty()); |
4164020e | 1371 | |
2fb7af12 | 1372 | const auto last_entry = index->entries.back().get(); |
4164020e SM |
1373 | BT_ASSERT(last_entry); |
1374 | ||
1375 | /* 1. Fix the last entry first. */ | |
1376 | if (last_entry->timestamp_end == 0 && last_entry->timestamp_begin != 0) { | |
1377 | /* | |
1378 | * Decode packet to read the timestamp of the | |
1379 | * last event of the stream file. | |
1380 | */ | |
1381 | ret = decode_packet_last_event_timestamp(trace, default_cc, last_entry, | |
1382 | &last_entry->timestamp_end, | |
1383 | &last_entry->timestamp_end_ns); | |
1384 | if (ret) { | |
0f5c5d5c SM |
1385 | BT_CPPLOGE_APPEND_CAUSE_SPEC(trace->logger, |
1386 | "Failed to decode last event's clock snapshot"); | |
4164020e SM |
1387 | goto end; |
1388 | } | |
1389 | } | |
1390 | ||
1391 | /* Iterate over all entries but the last one. */ | |
2fb7af12 SM |
1392 | for (size_t entry_idx = 0; entry_idx < index->entries.size() - 1; ++entry_idx) { |
1393 | ctf_fs_ds_index_entry *curr_entry = index->entries[entry_idx].get(); | |
1394 | ctf_fs_ds_index_entry *next_entry = index->entries[entry_idx + 1].get(); | |
4164020e SM |
1395 | |
1396 | if (curr_entry->timestamp_end == 0 && curr_entry->timestamp_begin != 0) { | |
1397 | /* | |
1398 | * 2. Set the current index entry `end` timestamp to | |
1399 | * the next index entry `begin` timestamp. | |
1400 | */ | |
1401 | curr_entry->timestamp_end = next_entry->timestamp_begin; | |
1402 | curr_entry->timestamp_end_ns = next_entry->timestamp_begin_ns; | |
1403 | } | |
1404 | } | |
1405 | } | |
aada78b5 FD |
1406 | |
1407 | end: | |
4164020e | 1408 | return ret; |
aada78b5 FD |
1409 | } |
1410 | ||
626cc488 FD |
1411 | /* |
1412 | * Extract the tracer information necessary to compare versions. | |
1413 | * Returns 0 on success, and -1 if the extraction is not successful because the | |
1414 | * necessary fields are absents in the trace metadata. | |
1415 | */ | |
4164020e | 1416 | static int extract_tracer_info(struct ctf_fs_trace *trace, struct tracer_info *current_tracer_info) |
626cc488 | 1417 | { |
4164020e SM |
1418 | int ret = 0; |
1419 | struct ctf_trace_class_env_entry *entry; | |
1420 | ||
1421 | /* Clear the current_tracer_info struct */ | |
1422 | memset(current_tracer_info, 0, sizeof(*current_tracer_info)); | |
1423 | ||
1424 | /* | |
1425 | * To compare 2 tracer versions, at least the tracer name and it's | |
1426 | * major version are needed. If one of these is missing, consider it an | |
1427 | * extraction failure. | |
1428 | */ | |
1429 | entry = ctf_trace_class_borrow_env_entry_by_name(trace->metadata->tc, "tracer_name"); | |
1430 | if (!entry || entry->type != CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR) { | |
1431 | goto missing_bare_minimum; | |
1432 | } | |
1433 | ||
1434 | /* Set tracer name. */ | |
1435 | current_tracer_info->name = entry->value.str->str; | |
1436 | ||
1437 | entry = ctf_trace_class_borrow_env_entry_by_name(trace->metadata->tc, "tracer_major"); | |
1438 | if (!entry || entry->type != CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT) { | |
1439 | goto missing_bare_minimum; | |
1440 | } | |
1441 | ||
1442 | /* Set major version number. */ | |
1443 | current_tracer_info->major = entry->value.i; | |
1444 | ||
1445 | entry = ctf_trace_class_borrow_env_entry_by_name(trace->metadata->tc, "tracer_minor"); | |
1446 | if (!entry || entry->type != CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT) { | |
1447 | goto end; | |
1448 | } | |
1449 | ||
1450 | /* Set minor version number. */ | |
1451 | current_tracer_info->minor = entry->value.i; | |
1452 | ||
1453 | entry = ctf_trace_class_borrow_env_entry_by_name(trace->metadata->tc, "tracer_patch"); | |
1454 | if (!entry) { | |
1455 | /* | |
1456 | * If `tracer_patch` doesn't exist `tracer_patchlevel` might. | |
1457 | * For example, `lttng-modules` uses entry name | |
1458 | * `tracer_patchlevel`. | |
1459 | */ | |
1460 | entry = ctf_trace_class_borrow_env_entry_by_name(trace->metadata->tc, "tracer_patchlevel"); | |
1461 | } | |
1462 | ||
1463 | if (!entry || entry->type != CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT) { | |
1464 | goto end; | |
1465 | } | |
1466 | ||
1467 | /* Set patch version number. */ | |
1468 | current_tracer_info->patch = entry->value.i; | |
1469 | ||
1470 | goto end; | |
626cc488 FD |
1471 | |
1472 | missing_bare_minimum: | |
4164020e | 1473 | ret = -1; |
626cc488 | 1474 | end: |
4164020e | 1475 | return ret; |
626cc488 FD |
1476 | } |
1477 | ||
4164020e | 1478 | static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info *curr_tracer_info) |
1719bf64 | 1479 | { |
4164020e SM |
1480 | bool is_affected = false; |
1481 | ||
1482 | if (strcmp(curr_tracer_info->name, "lttng-ust") == 0) { | |
1483 | if (curr_tracer_info->major < 2) { | |
1484 | is_affected = true; | |
1485 | } else if (curr_tracer_info->major == 2) { | |
1486 | /* fixed in lttng-ust 2.11.0 */ | |
1487 | if (curr_tracer_info->minor < 11) { | |
1488 | is_affected = true; | |
1489 | } | |
1490 | } | |
1491 | } else if (strcmp(curr_tracer_info->name, "lttng-modules") == 0) { | |
1492 | if (curr_tracer_info->major < 2) { | |
1493 | is_affected = true; | |
1494 | } else if (curr_tracer_info->major == 2) { | |
1495 | /* fixed in lttng-modules 2.11.0 */ | |
1496 | if (curr_tracer_info->minor == 10) { | |
1497 | /* fixed in lttng-modules 2.10.10 */ | |
1498 | if (curr_tracer_info->patch < 10) { | |
1499 | is_affected = true; | |
1500 | } | |
1501 | } else if (curr_tracer_info->minor == 9) { | |
1502 | /* fixed in lttng-modules 2.9.13 */ | |
1503 | if (curr_tracer_info->patch < 13) { | |
1504 | is_affected = true; | |
1505 | } | |
1506 | } else if (curr_tracer_info->minor < 9) { | |
1507 | is_affected = true; | |
1508 | } | |
1509 | } | |
1510 | } | |
1511 | ||
1512 | return is_affected; | |
1719bf64 FD |
1513 | } |
1514 | ||
4164020e SM |
1515 | static bool |
1516 | is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info *curr_tracer_info) | |
c43092a5 | 1517 | { |
4164020e SM |
1518 | bool is_affected = false; |
1519 | ||
1520 | if (strcmp(curr_tracer_info->name, "barectf") == 0) { | |
1521 | if (curr_tracer_info->major < 2) { | |
1522 | is_affected = true; | |
1523 | } else if (curr_tracer_info->major == 2) { | |
1524 | if (curr_tracer_info->minor < 3) { | |
1525 | is_affected = true; | |
1526 | } else if (curr_tracer_info->minor == 3) { | |
1527 | /* fixed in barectf 2.3.1 */ | |
1528 | if (curr_tracer_info->patch < 1) { | |
1529 | is_affected = true; | |
1530 | } | |
1531 | } | |
1532 | } | |
1533 | } | |
1534 | ||
1535 | return is_affected; | |
c43092a5 FD |
1536 | } |
1537 | ||
4164020e | 1538 | static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info *curr_tracer_info) |
aada78b5 | 1539 | { |
4164020e | 1540 | bool is_affected = false; |
aada78b5 | 1541 | |
4164020e SM |
1542 | /* All LTTng tracer may be affected by this lttng crash quirk. */ |
1543 | if (strcmp(curr_tracer_info->name, "lttng-ust") == 0) { | |
1544 | is_affected = true; | |
1545 | } else if (strcmp(curr_tracer_info->name, "lttng-modules") == 0) { | |
1546 | is_affected = true; | |
1547 | } | |
aada78b5 | 1548 | |
4164020e | 1549 | return is_affected; |
aada78b5 FD |
1550 | } |
1551 | ||
1719bf64 FD |
1552 | /* |
1553 | * Looks for trace produced by known buggy tracers and fix up the index | |
1554 | * produced earlier. | |
1555 | */ | |
0f5c5d5c | 1556 | static int fix_packet_index_tracer_bugs(ctf_fs_trace *trace) |
1719bf64 | 1557 | { |
4164020e SM |
1558 | int ret = 0; |
1559 | struct tracer_info current_tracer_info; | |
4164020e | 1560 | |
0f5c5d5c | 1561 | ret = extract_tracer_info(trace, ¤t_tracer_info); |
4164020e SM |
1562 | if (ret) { |
1563 | /* | |
1564 | * A trace may not have all the necessary environment | |
1565 | * entries to do the tracer version comparison. | |
1566 | * At least, the tracer name and major version number | |
1567 | * are needed. Failing to extract these entries is not | |
1568 | * an error. | |
1569 | */ | |
1570 | ret = 0; | |
0f5c5d5c SM |
1571 | BT_CPPLOGI_STR_SPEC( |
1572 | trace->logger, | |
1573 | "Cannot extract tracer information necessary to compare with buggy versions."); | |
4164020e | 1574 | goto end; |
4164020e SM |
1575 | } |
1576 | ||
1577 | /* Check if the trace may be affected by old tracer bugs. */ | |
1578 | if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info)) { | |
0f5c5d5c SM |
1579 | BT_CPPLOGI_STR_SPEC( |
1580 | trace->logger, | |
1581 | "Trace may be affected by LTTng tracer packet timestamp bug. Fixing up."); | |
1582 | ret = fix_index_lttng_event_after_packet_bug(trace); | |
4164020e | 1583 | if (ret) { |
0f5c5d5c SM |
1584 | BT_CPPLOGE_APPEND_CAUSE_SPEC(trace->logger, |
1585 | "Failed to fix LTTng event-after-packet bug."); | |
4164020e SM |
1586 | goto end; |
1587 | } | |
0f5c5d5c | 1588 | trace->metadata->tc->quirks.lttng_event_after_packet = true; |
4164020e SM |
1589 | } |
1590 | ||
1591 | if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info)) { | |
0f5c5d5c SM |
1592 | BT_CPPLOGI_STR_SPEC( |
1593 | trace->logger, | |
1594 | "Trace may be affected by barectf tracer packet timestamp bug. Fixing up."); | |
1595 | ret = fix_index_barectf_event_before_packet_bug(trace); | |
4164020e | 1596 | if (ret) { |
0f5c5d5c SM |
1597 | BT_CPPLOGE_APPEND_CAUSE_SPEC(trace->logger, |
1598 | "Failed to fix barectf event-before-packet bug."); | |
4164020e SM |
1599 | goto end; |
1600 | } | |
0f5c5d5c | 1601 | trace->metadata->tc->quirks.barectf_event_before_packet = true; |
4164020e SM |
1602 | } |
1603 | ||
1604 | if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info)) { | |
0f5c5d5c | 1605 | ret = fix_index_lttng_crash_quirk(trace); |
4164020e | 1606 | if (ret) { |
0f5c5d5c SM |
1607 | BT_CPPLOGE_APPEND_CAUSE_SPEC(trace->logger, |
1608 | "Failed to fix lttng-crash timestamp quirks."); | |
4164020e SM |
1609 | goto end; |
1610 | } | |
0f5c5d5c | 1611 | trace->metadata->tc->quirks.lttng_crash = true; |
4164020e | 1612 | } |
a0cd55ad | 1613 | |
1719bf64 | 1614 | end: |
4164020e | 1615 | return ret; |
1719bf64 FD |
1616 | } |
1617 | ||
cdf7de78 SM |
1618 | static bool compare_ds_file_groups_by_first_path(const ctf_fs_ds_file_group::UP& ds_file_group_a, |
1619 | const ctf_fs_ds_file_group::UP& ds_file_group_b) | |
e9b3611f | 1620 | { |
f3d74124 SM |
1621 | BT_ASSERT(!ds_file_group_a->ds_file_infos.empty()); |
1622 | BT_ASSERT(!ds_file_group_b->ds_file_infos.empty()); | |
087cd0f5 | 1623 | |
f3d74124 SM |
1624 | const auto& first_ds_file_info_a = *ds_file_group_a->ds_file_infos[0]; |
1625 | const auto& first_ds_file_info_b = *ds_file_group_b->ds_file_infos[0]; | |
087cd0f5 | 1626 | |
f3d74124 | 1627 | return first_ds_file_info_a.path < first_ds_file_info_b.path; |
e9b3611f PP |
1628 | } |
1629 | ||
4164020e | 1630 | static gint compare_strings(gconstpointer p_a, gconstpointer p_b) |
7b69723d | 1631 | { |
4164020e SM |
1632 | const char *a = *((const char **) p_a); |
1633 | const char *b = *((const char **) p_b); | |
7b69723d | 1634 | |
4164020e | 1635 | return strcmp(a, b); |
7b69723d SM |
1636 | } |
1637 | ||
4164020e SM |
1638 | int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component *ctf_fs, |
1639 | const bt_value *paths_value, | |
1640 | const bt_value *trace_name_value, | |
0f5c5d5c | 1641 | bt_self_component *selfComp) |
f280892e | 1642 | { |
4164020e SM |
1643 | int ret = 0; |
1644 | uint64_t i; | |
4164020e | 1645 | GPtrArray *paths = NULL; |
a4c955d9 | 1646 | std::vector<ctf_fs_trace::UP> traces; |
4164020e SM |
1647 | const char *trace_name; |
1648 | ||
1649 | BT_ASSERT(bt_value_get_type(paths_value) == BT_VALUE_TYPE_ARRAY); | |
1650 | BT_ASSERT(!bt_value_array_is_empty(paths_value)); | |
1651 | ||
4164020e SM |
1652 | paths = g_ptr_array_new_with_free_func(g_free); |
1653 | if (!paths) { | |
0f5c5d5c | 1654 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs->logger, "Failed to allocate a GPtrArray."); |
4164020e SM |
1655 | goto error; |
1656 | } | |
1657 | ||
1658 | trace_name = trace_name_value ? bt_value_string_get(trace_name_value) : NULL; | |
1659 | ||
1660 | /* | |
1661 | * Create a sorted array of the paths, to make the execution of this | |
1662 | * component deterministic. | |
1663 | */ | |
1664 | for (i = 0; i < bt_value_array_get_length(paths_value); i++) { | |
1665 | const bt_value *path_value = bt_value_array_borrow_element_by_index_const(paths_value, i); | |
1666 | const char *input = bt_value_string_get(path_value); | |
1667 | gchar *input_copy; | |
1668 | ||
1669 | input_copy = g_strdup(input); | |
1670 | if (!input_copy) { | |
0f5c5d5c | 1671 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs->logger, "Failed to copy a string."); |
4164020e SM |
1672 | goto error; |
1673 | } | |
1674 | ||
1675 | g_ptr_array_add(paths, input_copy); | |
1676 | } | |
1677 | ||
1678 | g_ptr_array_sort(paths, compare_strings); | |
1679 | ||
1680 | /* Create a separate ctf_fs_trace object for each path. */ | |
1681 | for (i = 0; i < paths->len; i++) { | |
1682 | const char *path = (const char *) g_ptr_array_index(paths, i); | |
1683 | ||
1684 | ret = ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs, path, trace_name, traces, | |
0f5c5d5c | 1685 | selfComp); |
4164020e SM |
1686 | if (ret) { |
1687 | goto end; | |
1688 | } | |
1689 | } | |
1690 | ||
a4c955d9 SM |
1691 | if (traces.size() > 1) { |
1692 | ctf_fs_trace *first_trace = traces[0].get(); | |
4164020e | 1693 | const uint8_t *first_trace_uuid = first_trace->metadata->tc->uuid; |
4164020e SM |
1694 | |
1695 | /* | |
1696 | * We have more than one trace, they must all share the same | |
1697 | * UUID, verify that. | |
1698 | */ | |
a4c955d9 SM |
1699 | for (i = 0; i < traces.size(); i++) { |
1700 | ctf_fs_trace *this_trace = traces[i].get(); | |
4164020e SM |
1701 | const uint8_t *this_trace_uuid = this_trace->metadata->tc->uuid; |
1702 | ||
1703 | if (!this_trace->metadata->tc->is_uuid_set) { | |
0f5c5d5c SM |
1704 | BT_CPPLOGE_APPEND_CAUSE_SPEC( |
1705 | ctf_fs->logger, | |
1706 | "Multiple traces given, but a trace does not have a UUID: path={}", | |
4164020e SM |
1707 | this_trace->path->str); |
1708 | goto error; | |
1709 | } | |
1710 | ||
1711 | if (bt_uuid_compare(first_trace_uuid, this_trace_uuid) != 0) { | |
1712 | char first_trace_uuid_str[BT_UUID_STR_LEN + 1]; | |
1713 | char this_trace_uuid_str[BT_UUID_STR_LEN + 1]; | |
1714 | ||
1715 | bt_uuid_to_str(first_trace_uuid, first_trace_uuid_str); | |
1716 | bt_uuid_to_str(this_trace_uuid, this_trace_uuid_str); | |
1717 | ||
0f5c5d5c SM |
1718 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs->logger, |
1719 | "Multiple traces given, but UUIDs don't match: " | |
1720 | "first-trace-uuid={}, first-trace-path={}, " | |
1721 | "trace-uuid={}, trace-path={}", | |
1722 | first_trace_uuid_str, first_trace->path->str, | |
1723 | this_trace_uuid_str, this_trace->path->str); | |
4164020e SM |
1724 | goto error; |
1725 | } | |
1726 | } | |
1727 | ||
a4c955d9 | 1728 | ret = merge_ctf_fs_traces(std::move(traces), ctf_fs->trace); |
4164020e | 1729 | if (ret) { |
0f5c5d5c SM |
1730 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs->logger, |
1731 | "Failed to merge traces with the same UUID."); | |
4164020e SM |
1732 | goto error; |
1733 | } | |
4164020e SM |
1734 | } else { |
1735 | /* Just one trace, it may or may not have a UUID, both are fine. */ | |
a4c955d9 | 1736 | ctf_fs->trace = std::move(traces[0]); |
4164020e SM |
1737 | } |
1738 | ||
7df773f2 | 1739 | ret = fix_packet_index_tracer_bugs(ctf_fs->trace.get()); |
4164020e | 1740 | if (ret) { |
0f5c5d5c | 1741 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs->logger, "Failed to fix packet index tracer bugs."); |
4164020e SM |
1742 | } |
1743 | ||
1744 | /* | |
1745 | * Sort data stream file groups by first data stream file info | |
1746 | * path to get a deterministic order. This order influences the | |
1747 | * order of the output ports. It also influences the order of | |
1748 | * the automatic stream IDs if the trace's packet headers do not | |
1749 | * contain a `stream_instance_id` field, in which case the data | |
1750 | * stream file to stream ID association is always the same, | |
1751 | * whatever the build and the system. | |
1752 | * | |
1753 | * Having a deterministic order here can help debugging and | |
1754 | * testing. | |
1755 | */ | |
cdf7de78 SM |
1756 | std::sort(ctf_fs->trace->ds_file_groups.begin(), ctf_fs->trace->ds_file_groups.end(), |
1757 | compare_ds_file_groups_by_first_path); | |
4164020e | 1758 | goto end; |
a0cd55ad | 1759 | error: |
4164020e | 1760 | ret = -1; |
a0cd55ad | 1761 | |
f280892e | 1762 | end: |
4164020e SM |
1763 | if (paths) { |
1764 | g_ptr_array_free(paths, TRUE); | |
1765 | } | |
7b69723d | 1766 | |
4164020e | 1767 | return ret; |
f280892e SM |
1768 | } |
1769 | ||
4164020e | 1770 | static GString *get_stream_instance_unique_name(struct ctf_fs_ds_file_group *ds_file_group) |
a38d7650 | 1771 | { |
4164020e SM |
1772 | GString *name; |
1773 | struct ctf_fs_ds_file_info *ds_file_info; | |
1774 | ||
1775 | name = g_string_new(NULL); | |
1776 | if (!name) { | |
1777 | goto end; | |
1778 | } | |
1779 | ||
1780 | /* | |
1781 | * If there's more than one stream file in the stream file | |
1782 | * group, the first (earliest) stream file's path is used as | |
1783 | * the stream's unique name. | |
1784 | */ | |
f3d74124 SM |
1785 | BT_ASSERT(!ds_file_group->ds_file_infos.empty()); |
1786 | ds_file_info = ds_file_group->ds_file_infos[0].get(); | |
4d199954 | 1787 | g_string_assign(name, ds_file_info->path.c_str()); |
a38d7650 SM |
1788 | |
1789 | end: | |
4164020e | 1790 | return name; |
a38d7650 SM |
1791 | } |
1792 | ||
f280892e SM |
1793 | /* Create the IR stream objects for ctf_fs_trace. */ |
1794 | ||
4164020e | 1795 | static int create_streams_for_trace(struct ctf_fs_trace *ctf_fs_trace) |
f280892e | 1796 | { |
4164020e SM |
1797 | int ret; |
1798 | GString *name = NULL; | |
4164020e | 1799 | |
cdf7de78 SM |
1800 | for (const auto& ds_file_group : ctf_fs_trace->ds_file_groups) { |
1801 | name = get_stream_instance_unique_name(ds_file_group.get()); | |
4164020e SM |
1802 | |
1803 | if (!name) { | |
1804 | goto error; | |
1805 | } | |
1806 | ||
f0940b01 SM |
1807 | BT_ASSERT(ds_file_group->sc->ir_sc); |
1808 | BT_ASSERT(ctf_fs_trace->trace); | |
1809 | ||
be215bcd SM |
1810 | bt_stream *stream; |
1811 | ||
f0940b01 SM |
1812 | if (ds_file_group->stream_id == UINT64_C(-1)) { |
1813 | /* No stream ID: use 0 */ | |
be215bcd SM |
1814 | stream = bt_stream_create_with_id(ds_file_group->sc->ir_sc, ctf_fs_trace->trace, |
1815 | ctf_fs_trace->next_stream_id); | |
f0940b01 | 1816 | ctf_fs_trace->next_stream_id++; |
4164020e | 1817 | } else { |
f0940b01 | 1818 | /* Specific stream ID */ |
be215bcd SM |
1819 | stream = bt_stream_create_with_id(ds_file_group->sc->ir_sc, ctf_fs_trace->trace, |
1820 | (uint64_t) ds_file_group->stream_id); | |
4164020e SM |
1821 | } |
1822 | ||
be215bcd | 1823 | if (!stream) { |
0f5c5d5c SM |
1824 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace->logger, |
1825 | "Cannot create stream for DS file group: " | |
1826 | "addr={}, stream-name=\"{}\"", | |
1827 | fmt::ptr(ds_file_group), name->str); | |
4164020e SM |
1828 | goto error; |
1829 | } | |
1830 | ||
be215bcd SM |
1831 | ds_file_group->stream = bt2::Stream::Shared::createWithoutRef(stream); |
1832 | ||
1833 | ret = bt_stream_set_name(ds_file_group->stream->libObjPtr(), name->str); | |
4164020e | 1834 | if (ret) { |
0f5c5d5c SM |
1835 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace->logger, |
1836 | "Cannot set stream's name: " | |
1837 | "addr={}, stream-name=\"{}\"", | |
be215bcd | 1838 | fmt::ptr(ds_file_group->stream->libObjPtr()), name->str); |
4164020e SM |
1839 | goto error; |
1840 | } | |
1841 | ||
1842 | g_string_free(name, TRUE); | |
1843 | name = NULL; | |
1844 | } | |
1845 | ||
1846 | ret = 0; | |
1847 | goto end; | |
f280892e SM |
1848 | |
1849 | error: | |
4164020e | 1850 | ret = -1; |
f280892e SM |
1851 | |
1852 | end: | |
1853 | ||
4164020e SM |
1854 | if (name) { |
1855 | g_string_free(name, TRUE); | |
1856 | } | |
1857 | return ret; | |
f280892e SM |
1858 | } |
1859 | ||
88730e42 SM |
1860 | static const bt_param_validation_value_descr inputs_elem_descr = |
1861 | bt_param_validation_value_descr::makeString(); | |
087cd0f5 SM |
1862 | |
1863 | static bt_param_validation_map_value_entry_descr fs_params_entries_descr[] = { | |
88730e42 SM |
1864 | {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY, |
1865 | bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE, | |
1866 | inputs_elem_descr)}, | |
1867 | {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, | |
1868 | bt_param_validation_value_descr::makeString()}, | |
1869 | {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, | |
1870 | bt_param_validation_value_descr::makeSignedInteger()}, | |
1871 | {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, | |
1872 | bt_param_validation_value_descr::makeSignedInteger()}, | |
1873 | {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, | |
1874 | bt_param_validation_value_descr::makeBool()}, | |
4164020e SM |
1875 | BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END}; |
1876 | ||
1877 | bool read_src_fs_parameters(const bt_value *params, const bt_value **inputs, | |
0f5c5d5c | 1878 | const bt_value **trace_name, struct ctf_fs_component *ctf_fs) |
4164020e SM |
1879 | { |
1880 | bool ret; | |
1881 | const bt_value *value; | |
4164020e SM |
1882 | enum bt_param_validation_status validate_value_status; |
1883 | gchar *error = NULL; | |
1884 | ||
1885 | validate_value_status = bt_param_validation_validate(params, fs_params_entries_descr, &error); | |
1886 | if (validate_value_status != BT_PARAM_VALIDATION_STATUS_OK) { | |
0f5c5d5c | 1887 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs->logger, "{}", error); |
4164020e SM |
1888 | ret = false; |
1889 | goto end; | |
1890 | } | |
1891 | ||
1892 | /* inputs parameter */ | |
1893 | *inputs = bt_value_map_borrow_entry_value_const(params, "inputs"); | |
1894 | ||
1895 | /* clock-class-offset-s parameter */ | |
1896 | value = bt_value_map_borrow_entry_value_const(params, "clock-class-offset-s"); | |
1897 | if (value) { | |
c942e7a2 | 1898 | ctf_fs->clkClsCfg.offsetSec = bt_value_integer_signed_get(value); |
4164020e SM |
1899 | } |
1900 | ||
1901 | /* clock-class-offset-ns parameter */ | |
1902 | value = bt_value_map_borrow_entry_value_const(params, "clock-class-offset-ns"); | |
1903 | if (value) { | |
c942e7a2 | 1904 | ctf_fs->clkClsCfg.offsetNanoSec = bt_value_integer_signed_get(value); |
4164020e SM |
1905 | } |
1906 | ||
1907 | /* force-clock-class-origin-unix-epoch parameter */ | |
1908 | value = bt_value_map_borrow_entry_value_const(params, "force-clock-class-origin-unix-epoch"); | |
1909 | if (value) { | |
c942e7a2 | 1910 | ctf_fs->clkClsCfg.forceOriginIsUnixEpoch = bt_value_bool_get(value); |
4164020e SM |
1911 | } |
1912 | ||
1913 | /* trace-name parameter */ | |
1914 | *trace_name = bt_value_map_borrow_entry_value_const(params, "trace-name"); | |
1915 | ||
1916 | ret = true; | |
d907165c SM |
1917 | |
1918 | end: | |
4164020e SM |
1919 | g_free(error); |
1920 | return ret; | |
d907165c SM |
1921 | } |
1922 | ||
f340a3e8 SM |
1923 | static ctf_fs_component::UP ctf_fs_create(const bt_value *params, |
1924 | bt_self_component_source *self_comp_src) | |
56a1cced | 1925 | { |
4164020e SM |
1926 | const bt_value *inputs_value; |
1927 | const bt_value *trace_name_value; | |
1928 | bt_self_component *self_comp = bt_self_component_source_as_self_component(self_comp_src); | |
56a1cced | 1929 | |
f340a3e8 | 1930 | ctf_fs_component::UP ctf_fs = ctf_fs_component_create( |
0f5c5d5c | 1931 | bt2c::Logger {bt2::SelfSourceComponent {self_comp_src}, "PLUGIN/SRC.CTF.FS/COMP"}); |
4164020e | 1932 | if (!ctf_fs) { |
f340a3e8 | 1933 | return nullptr; |
4164020e | 1934 | } |
f280892e | 1935 | |
f340a3e8 SM |
1936 | if (!read_src_fs_parameters(params, &inputs_value, &trace_name_value, ctf_fs.get())) { |
1937 | return nullptr; | |
4164020e | 1938 | } |
56a1cced | 1939 | |
f340a3e8 SM |
1940 | if (ctf_fs_component_create_ctf_fs_trace(ctf_fs.get(), inputs_value, trace_name_value, |
1941 | self_comp)) { | |
1942 | return nullptr; | |
4164020e | 1943 | } |
4f1f88a6 | 1944 | |
7df773f2 | 1945 | if (create_streams_for_trace(ctf_fs->trace.get())) { |
f340a3e8 | 1946 | return nullptr; |
4164020e | 1947 | } |
f280892e | 1948 | |
7df773f2 | 1949 | if (create_ports_for_trace(ctf_fs.get(), ctf_fs->trace.get(), self_comp_src)) { |
f340a3e8 | 1950 | return nullptr; |
4164020e | 1951 | } |
4f1f88a6 | 1952 | |
4164020e | 1953 | return ctf_fs; |
56a1cced JG |
1954 | } |
1955 | ||
50b9f4b5 SM |
1956 | bt_component_class_initialize_method_status ctf_fs_init(bt_self_component_source *self_comp_src, |
1957 | bt_self_component_source_configuration *, | |
1958 | const bt_value *params, void *) | |
ea0b4b9e | 1959 | { |
1e690349 | 1960 | try { |
1e690349 SM |
1961 | bt_component_class_initialize_method_status ret = |
1962 | BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK; | |
1963 | ||
f340a3e8 | 1964 | ctf_fs_component::UP ctf_fs = ctf_fs_create(params, self_comp_src); |
1e690349 SM |
1965 | if (!ctf_fs) { |
1966 | ret = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR; | |
1967 | } | |
ea0b4b9e | 1968 | |
f340a3e8 SM |
1969 | bt_self_component_set_data(bt_self_component_source_as_self_component(self_comp_src), |
1970 | ctf_fs.release()); | |
1e690349 SM |
1971 | return ret; |
1972 | } catch (const std::bad_alloc&) { | |
1973 | return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; | |
1974 | } catch (const bt2::Error&) { | |
1975 | return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR; | |
4164020e | 1976 | } |
ea0b4b9e | 1977 | } |
33f93973 | 1978 | |
0f5c5d5c | 1979 | bt_component_class_query_method_status ctf_fs_query(bt_self_component_class_source *comp_class_src, |
4164020e SM |
1980 | bt_private_query_executor *priv_query_exec, |
1981 | const char *object, const bt_value *params, | |
1982 | __attribute__((unused)) void *method_data, | |
1983 | const bt_value **result) | |
33f93973 | 1984 | { |
1e690349 | 1985 | try { |
1e690349 SM |
1986 | bt2c::Logger logger {bt2::SelfComponentClass {comp_class_src}, |
1987 | bt2::PrivateQueryExecutor {priv_query_exec}, | |
1988 | "PLUGIN/SRC.CTF.FS/QUERY"}; | |
c02af779 SM |
1989 | bt2::ConstMapValue paramsObj(params); |
1990 | bt2::Value::Shared resultObj; | |
1e690349 SM |
1991 | |
1992 | if (strcmp(object, "metadata-info") == 0) { | |
c02af779 | 1993 | resultObj = metadata_info_query(paramsObj, logger); |
1e690349 | 1994 | } else if (strcmp(object, "babeltrace.trace-infos") == 0) { |
c02af779 | 1995 | resultObj = trace_infos_query(paramsObj, logger); |
1e690349 | 1996 | } else if (!strcmp(object, "babeltrace.support-info")) { |
c02af779 | 1997 | resultObj = support_info_query(paramsObj, logger); |
1e690349 SM |
1998 | } else { |
1999 | BT_CPPLOGE_SPEC(logger, "Unknown query object `{}`", object); | |
c02af779 | 2000 | return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT; |
1e690349 | 2001 | } |
c02af779 SM |
2002 | |
2003 | *result = resultObj.release().libObjPtr(); | |
2004 | ||
2005 | return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK; | |
1e690349 SM |
2006 | } catch (const std::bad_alloc&) { |
2007 | return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR; | |
2008 | } catch (const bt2::Error&) { | |
2009 | return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR; | |
2010 | } | |
33f93973 | 2011 | } |