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