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