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