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