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