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