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