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