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; |
4420a5b6 | 494 | ctf_msg_iter_up msg_iter; |
4164020e SM |
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( |
4420a5b6 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); | |
4164020e | 513 | if (!msg_iter) { |
0f5c5d5c | 514 | BT_CPPLOGE_STR_SPEC(ctf_fs_trace->logger, "Cannot create a CTF message iterator."); |
4164020e SM |
515 | goto error; |
516 | } | |
517 | ||
4420a5b6 | 518 | ctf_msg_iter_set_dry_run(msg_iter.get(), true); |
4164020e | 519 | |
4420a5b6 | 520 | ret = ctf_msg_iter_get_packet_properties(msg_iter.get(), &props); |
4164020e | 521 | if (ret) { |
0f5c5d5c SM |
522 | BT_CPPLOGE_APPEND_CAUSE_SPEC( |
523 | ctf_fs_trace->logger, | |
524 | "Cannot get stream file's first packet's header and context fields (`{}`).", path); | |
4164020e SM |
525 | goto error; |
526 | } | |
527 | ||
528 | sc = ctf_trace_class_borrow_stream_class_by_id(ds_file->metadata->tc, props.stream_class_id); | |
529 | BT_ASSERT(sc); | |
530 | stream_instance_id = props.data_stream_id; | |
531 | ||
532 | if (props.snapshots.beginning_clock != UINT64_C(-1)) { | |
533 | BT_ASSERT(sc->default_clock_class); | |
534 | ret = bt_util_clock_cycles_to_ns_from_origin( | |
535 | props.snapshots.beginning_clock, sc->default_clock_class->frequency, | |
536 | sc->default_clock_class->offset_seconds, sc->default_clock_class->offset_cycles, | |
537 | &begin_ns); | |
538 | if (ret) { | |
0f5c5d5c SM |
539 | BT_CPPLOGE_APPEND_CAUSE_SPEC( |
540 | ctf_fs_trace->logger, | |
541 | "Cannot convert clock cycles to nanoseconds from origin (`{}`).", path); | |
4164020e SM |
542 | goto error; |
543 | } | |
544 | } | |
545 | ||
f3d74124 | 546 | ds_file_info = ctf_fs_ds_file_info_create(path, begin_ns); |
4164020e SM |
547 | if (!ds_file_info) { |
548 | goto error; | |
549 | } | |
550 | ||
4420a5b6 | 551 | index = ctf_fs_ds_file_build_index(ds_file.get(), ds_file_info.get(), msg_iter.get()); |
4164020e | 552 | if (!index) { |
0f5c5d5c | 553 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace->logger, "Failed to index CTF stream file \'{}\'", |
a39d9817 | 554 | ds_file->file->path); |
4164020e SM |
555 | goto error; |
556 | } | |
557 | ||
558 | if (begin_ns == -1) { | |
559 | /* | |
560 | * No beginning timestamp to sort the stream files | |
561 | * within a stream file group, so consider that this | |
562 | * file must be the only one within its group. | |
563 | */ | |
564 | stream_instance_id = -1; | |
565 | } | |
566 | ||
567 | if (stream_instance_id == -1) { | |
568 | /* | |
569 | * No stream instance ID or no beginning timestamp: | |
570 | * create a unique stream file group for this stream | |
571 | * file because, even if there's a stream instance ID, | |
572 | * there's no timestamp to order the file within its | |
573 | * group. | |
574 | */ | |
fe2f9cda SM |
575 | new_ds_file_group = |
576 | ctf_fs_ds_file_group_create(ctf_fs_trace, sc, UINT64_C(-1), std::move(index)); | |
4164020e | 577 | |
fe2e19c4 | 578 | if (!new_ds_file_group) { |
4164020e SM |
579 | goto error; |
580 | } | |
581 | ||
f3d74124 | 582 | ds_file_group_insert_ds_file_info_sorted(new_ds_file_group.get(), std::move(ds_file_info)); |
cdf7de78 | 583 | ctf_fs_trace->ds_file_groups.emplace_back(std::move(new_ds_file_group)); |
4164020e SM |
584 | goto end; |
585 | } | |
586 | ||
587 | BT_ASSERT(stream_instance_id != -1); | |
588 | BT_ASSERT(begin_ns != -1); | |
589 | ||
590 | /* Find an existing stream file group with this ID */ | |
cdf7de78 SM |
591 | for (const auto& candidate : ctf_fs_trace->ds_file_groups) { |
592 | if (candidate->sc == sc && candidate->stream_id == stream_instance_id) { | |
593 | ds_file_group = candidate.get(); | |
4164020e SM |
594 | break; |
595 | } | |
4164020e SM |
596 | } |
597 | ||
598 | if (!ds_file_group) { | |
fe2e19c4 | 599 | new_ds_file_group = |
fe2f9cda | 600 | ctf_fs_ds_file_group_create(ctf_fs_trace, sc, stream_instance_id, std::move(index)); |
fe2e19c4 | 601 | if (!new_ds_file_group) { |
4164020e SM |
602 | goto error; |
603 | } | |
604 | ||
fe2e19c4 | 605 | ds_file_group = new_ds_file_group.get(); |
cdf7de78 | 606 | ctf_fs_trace->ds_file_groups.emplace_back(std::move(new_ds_file_group)); |
4164020e | 607 | } else { |
fe2f9cda | 608 | merge_ctf_fs_ds_indexes(ds_file_group->index.get(), std::move(index)); |
4164020e SM |
609 | } |
610 | ||
f3d74124 | 611 | ds_file_group_insert_ds_file_info_sorted(ds_file_group, std::move(ds_file_info)); |
4164020e SM |
612 | |
613 | goto end; | |
94cf822e PP |
614 | |
615 | error: | |
4164020e | 616 | ret = -1; |
94cf822e PP |
617 | |
618 | end: | |
4164020e | 619 | return ret; |
94cf822e PP |
620 | } |
621 | ||
4164020e | 622 | static int create_ds_file_groups(struct ctf_fs_trace *ctf_fs_trace) |
e7a4393b | 623 | { |
4164020e SM |
624 | int ret = 0; |
625 | const char *basename; | |
626 | GError *error = NULL; | |
627 | GDir *dir = NULL; | |
4164020e SM |
628 | |
629 | /* Check each file in the path directory, except specific ones */ | |
630 | dir = g_dir_open(ctf_fs_trace->path->str, 0, &error); | |
631 | if (!dir) { | |
0f5c5d5c SM |
632 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace->logger, |
633 | "Cannot open directory `{}`: {} (code {})", | |
634 | ctf_fs_trace->path->str, error->message, error->code); | |
4164020e SM |
635 | goto error; |
636 | } | |
637 | ||
638 | while ((basename = g_dir_read_name(dir))) { | |
4164020e SM |
639 | if (strcmp(basename, CTF_FS_METADATA_FILENAME) == 0) { |
640 | /* Ignore the metadata stream. */ | |
0f5c5d5c SM |
641 | BT_CPPLOGI_SPEC(ctf_fs_trace->logger, |
642 | "Ignoring metadata file `{}" G_DIR_SEPARATOR_S "{}`", | |
643 | ctf_fs_trace->path->str, basename); | |
4164020e SM |
644 | continue; |
645 | } | |
646 | ||
647 | if (basename[0] == '.') { | |
0f5c5d5c SM |
648 | BT_CPPLOGI_SPEC(ctf_fs_trace->logger, |
649 | "Ignoring hidden file `{}" G_DIR_SEPARATOR_S "{}`", | |
650 | ctf_fs_trace->path->str, basename); | |
4164020e SM |
651 | continue; |
652 | } | |
653 | ||
654 | /* Create the file. */ | |
2b6f09e0 | 655 | const auto file = ctf_fs_file_create(ctf_fs_trace->logger); |
4164020e | 656 | if (!file) { |
0f5c5d5c SM |
657 | BT_CPPLOGE_APPEND_CAUSE_SPEC( |
658 | ctf_fs_trace->logger, | |
659 | "Cannot create stream file object for file `{}" G_DIR_SEPARATOR_S "{}`", | |
4164020e SM |
660 | ctf_fs_trace->path->str, basename); |
661 | goto error; | |
662 | } | |
663 | ||
664 | /* Create full path string. */ | |
a39d9817 SM |
665 | file->path = fmt::format("{}" G_DIR_SEPARATOR_S "{}", ctf_fs_trace->path->str, basename); |
666 | ||
667 | if (!g_file_test(file->path.c_str(), G_FILE_TEST_IS_REGULAR)) { | |
668 | BT_CPPLOGI_SPEC(ctf_fs_trace->logger, "Ignoring non-regular file `{}`", file->path); | |
4164020e SM |
669 | continue; |
670 | } | |
671 | ||
2b6f09e0 | 672 | ret = ctf_fs_file_open(file.get(), "rb"); |
4164020e | 673 | if (ret) { |
0f5c5d5c | 674 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace->logger, "Cannot open stream file `{}`", |
a39d9817 | 675 | file->path); |
4164020e SM |
676 | goto error; |
677 | } | |
678 | ||
679 | if (file->size == 0) { | |
680 | /* Skip empty stream. */ | |
a39d9817 | 681 | BT_CPPLOGI_SPEC(ctf_fs_trace->logger, "Ignoring empty file `{}`", file->path); |
4164020e SM |
682 | continue; |
683 | } | |
684 | ||
a39d9817 | 685 | ret = add_ds_file_to_ds_file_group(ctf_fs_trace, file->path.c_str()); |
4164020e | 686 | if (ret) { |
0f5c5d5c SM |
687 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace->logger, |
688 | "Cannot add stream file `{}` to stream file group", | |
a39d9817 | 689 | file->path); |
4164020e SM |
690 | goto error; |
691 | } | |
4164020e SM |
692 | } |
693 | ||
694 | goto end; | |
4f1f88a6 | 695 | |
e7a4393b | 696 | error: |
4164020e | 697 | ret = -1; |
4f1f88a6 | 698 | |
e7a4393b | 699 | end: |
4164020e SM |
700 | if (dir) { |
701 | g_dir_close(dir); | |
702 | dir = NULL; | |
703 | } | |
4f1f88a6 | 704 | |
4164020e SM |
705 | if (error) { |
706 | g_error_free(error); | |
707 | } | |
5b29e799 | 708 | |
4164020e | 709 | return ret; |
5b29e799 JG |
710 | } |
711 | ||
0f5c5d5c | 712 | static int set_trace_name(bt_trace *trace, const char *name_suffix, const bt2c::Logger& logger) |
862ca4ed | 713 | { |
4164020e SM |
714 | int ret = 0; |
715 | const bt_value *val; | |
716 | GString *name; | |
717 | ||
718 | name = g_string_new(NULL); | |
719 | if (!name) { | |
0f5c5d5c | 720 | BT_CPPLOGE_STR_SPEC(logger, "Failed to allocate a GString."); |
4164020e SM |
721 | ret = -1; |
722 | goto end; | |
723 | } | |
724 | ||
725 | /* | |
726 | * Check if we have a trace environment string value named `hostname`. | |
727 | * If so, use it as the trace name's prefix. | |
728 | */ | |
729 | val = bt_trace_borrow_environment_entry_value_by_name_const(trace, "hostname"); | |
730 | if (val && bt_value_is_string(val)) { | |
731 | g_string_append(name, bt_value_string_get(val)); | |
732 | ||
733 | if (name_suffix) { | |
734 | g_string_append_c(name, G_DIR_SEPARATOR); | |
735 | } | |
736 | } | |
737 | ||
738 | if (name_suffix) { | |
739 | g_string_append(name, name_suffix); | |
740 | } | |
741 | ||
742 | ret = bt_trace_set_name(trace, name->str); | |
743 | if (ret) { | |
744 | goto end; | |
745 | } | |
746 | ||
747 | goto end; | |
862ca4ed PP |
748 | |
749 | end: | |
4164020e SM |
750 | if (name) { |
751 | g_string_free(name, TRUE); | |
752 | } | |
862ca4ed | 753 | |
4164020e | 754 | return ret; |
862ca4ed PP |
755 | } |
756 | ||
2ca337f1 SM |
757 | static ctf_fs_trace::UP ctf_fs_trace_create(const char *path, const char *name, |
758 | const ctf::src::ClkClsCfg& clkClsCfg, | |
759 | bt_self_component *selfComp, | |
760 | const bt2c::Logger& parentLogger) | |
1a9f7075 | 761 | { |
4164020e SM |
762 | int ret; |
763 | ||
2ca337f1 | 764 | ctf_fs_trace::UP ctf_fs_trace {new struct ctf_fs_trace(parentLogger)}; |
4164020e SM |
765 | ctf_fs_trace->path = g_string_new(path); |
766 | if (!ctf_fs_trace->path) { | |
767 | goto error; | |
768 | } | |
769 | ||
afb0f12b | 770 | ctf_fs_trace->metadata = new ctf_fs_metadata; |
4164020e | 771 | ctf_fs_metadata_init(ctf_fs_trace->metadata); |
4164020e | 772 | |
2ca337f1 | 773 | ret = ctf_fs_metadata_set_trace_class(selfComp, ctf_fs_trace.get(), clkClsCfg); |
4164020e SM |
774 | if (ret) { |
775 | goto error; | |
776 | } | |
777 | ||
778 | if (ctf_fs_trace->metadata->trace_class) { | |
779 | ctf_fs_trace->trace = bt_trace_create(ctf_fs_trace->metadata->trace_class); | |
780 | if (!ctf_fs_trace->trace) { | |
781 | goto error; | |
782 | } | |
783 | } | |
784 | ||
785 | if (ctf_fs_trace->trace) { | |
786 | ret = ctf_trace_class_configure_ir_trace(ctf_fs_trace->metadata->tc, ctf_fs_trace->trace); | |
787 | if (ret) { | |
788 | goto error; | |
789 | } | |
790 | ||
0f5c5d5c | 791 | ret = set_trace_name(ctf_fs_trace->trace, name, ctf_fs_trace->logger); |
4164020e SM |
792 | if (ret) { |
793 | goto error; | |
794 | } | |
795 | } | |
796 | ||
2ca337f1 | 797 | ret = create_ds_file_groups(ctf_fs_trace.get()); |
4164020e SM |
798 | if (ret) { |
799 | goto error; | |
800 | } | |
801 | ||
802 | goto end; | |
1a9f7075 PP |
803 | |
804 | error: | |
2ca337f1 | 805 | ctf_fs_trace.reset(); |
44c440bc | 806 | |
1a9f7075 | 807 | end: |
4164020e | 808 | return ctf_fs_trace; |
1a9f7075 PP |
809 | } |
810 | ||
4164020e | 811 | static int path_is_ctf_trace(const char *path) |
1a9f7075 | 812 | { |
4164020e SM |
813 | GString *metadata_path = g_string_new(NULL); |
814 | int ret = 0; | |
1a9f7075 | 815 | |
4164020e SM |
816 | if (!metadata_path) { |
817 | ret = -1; | |
818 | goto end; | |
819 | } | |
1a9f7075 | 820 | |
4164020e | 821 | g_string_printf(metadata_path, "%s" G_DIR_SEPARATOR_S "%s", path, CTF_FS_METADATA_FILENAME); |
1a9f7075 | 822 | |
4164020e SM |
823 | if (g_file_test(metadata_path->str, G_FILE_TEST_IS_REGULAR)) { |
824 | ret = 1; | |
825 | goto end; | |
826 | } | |
1a9f7075 PP |
827 | |
828 | end: | |
4164020e SM |
829 | g_string_free(metadata_path, TRUE); |
830 | return ret; | |
1a9f7075 PP |
831 | } |
832 | ||
a0cd55ad | 833 | /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */ |
f280892e | 834 | |
4164020e SM |
835 | static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component *ctf_fs, |
836 | const char *path_param, | |
a4c955d9 SM |
837 | const char *trace_name, |
838 | std::vector<ctf_fs_trace::UP>& traces, | |
0f5c5d5c | 839 | bt_self_component *selfComp) |
1a9f7075 | 840 | { |
2ca337f1 | 841 | ctf_fs_trace::UP ctf_fs_trace; |
4164020e SM |
842 | int ret; |
843 | GString *norm_path; | |
4164020e SM |
844 | |
845 | norm_path = bt_common_normalize_path(path_param, NULL); | |
846 | if (!norm_path) { | |
0f5c5d5c | 847 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs->logger, "Failed to normalize path: `{}`.", path_param); |
4164020e SM |
848 | goto error; |
849 | } | |
850 | ||
851 | ret = path_is_ctf_trace(norm_path->str); | |
852 | if (ret < 0) { | |
0f5c5d5c SM |
853 | BT_CPPLOGE_APPEND_CAUSE_SPEC( |
854 | ctf_fs->logger, "Failed to check if path is a CTF trace: path={}", norm_path->str); | |
4164020e SM |
855 | goto error; |
856 | } else if (ret == 0) { | |
0f5c5d5c SM |
857 | BT_CPPLOGE_APPEND_CAUSE_SPEC( |
858 | ctf_fs->logger, "Path is not a CTF trace (does not contain a metadata file): `{}`.", | |
859 | norm_path->str); | |
4164020e SM |
860 | goto error; |
861 | } | |
862 | ||
863 | // FIXME: Remove or ifdef for __MINGW32__ | |
864 | if (strcmp(norm_path->str, "/") == 0) { | |
0f5c5d5c | 865 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs->logger, "Opening a trace in `/` is not supported."); |
4164020e SM |
866 | ret = -1; |
867 | goto end; | |
868 | } | |
869 | ||
c942e7a2 SM |
870 | ctf_fs_trace = ctf_fs_trace_create(norm_path->str, trace_name, ctf_fs->clkClsCfg, selfComp, |
871 | ctf_fs->logger); | |
4164020e | 872 | if (!ctf_fs_trace) { |
0f5c5d5c SM |
873 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs->logger, "Cannot create trace for `{}`.", |
874 | norm_path->str); | |
4164020e SM |
875 | goto error; |
876 | } | |
877 | ||
a4c955d9 | 878 | traces.emplace_back(std::move(ctf_fs_trace)); |
4164020e SM |
879 | |
880 | ret = 0; | |
881 | goto end; | |
1a9f7075 PP |
882 | |
883 | error: | |
4164020e | 884 | ret = -1; |
1a9f7075 PP |
885 | |
886 | end: | |
4164020e SM |
887 | if (norm_path) { |
888 | g_string_free(norm_path, TRUE); | |
889 | } | |
4bd72b60 | 890 | |
4164020e | 891 | return ret; |
1a9f7075 PP |
892 | } |
893 | ||
41a65f30 SM |
894 | /* |
895 | * Count the number of stream and event classes defined by this trace's metadata. | |
896 | * | |
897 | * This is used to determine which metadata is the "latest", out of multiple | |
898 | * traces sharing the same UUID. It is assumed that amongst all these metadatas, | |
899 | * a bigger metadata is a superset of a smaller metadata. Therefore, it is | |
900 | * enough to just count the classes. | |
901 | */ | |
902 | ||
4164020e | 903 | static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace *trace) |
41a65f30 | 904 | { |
4164020e SM |
905 | unsigned int num = trace->metadata->tc->stream_classes->len; |
906 | guint i; | |
41a65f30 | 907 | |
4164020e SM |
908 | for (i = 0; i < trace->metadata->tc->stream_classes->len; i++) { |
909 | struct ctf_stream_class *sc = | |
910 | (struct ctf_stream_class *) trace->metadata->tc->stream_classes->pdata[i]; | |
911 | num += sc->event_classes->len; | |
912 | } | |
41a65f30 | 913 | |
4164020e | 914 | return num; |
41a65f30 SM |
915 | } |
916 | ||
917 | /* | |
918 | * Merge the src ds_file_group into dest. This consists of merging their | |
919 | * ds_file_infos, making sure to keep the result sorted. | |
920 | */ | |
921 | ||
4164020e | 922 | static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group *dest, |
cdf7de78 | 923 | ctf_fs_ds_file_group::UP src) |
41a65f30 | 924 | { |
f3d74124 SM |
925 | for (auto& ds_file_info : src->ds_file_infos) { |
926 | ds_file_group_insert_ds_file_info_sorted(dest, std::move(ds_file_info)); | |
4164020e | 927 | } |
41a65f30 | 928 | |
4164020e | 929 | /* Merge both indexes. */ |
fe2f9cda | 930 | merge_ctf_fs_ds_indexes(dest->index.get(), std::move(src->index)); |
7ed5243a | 931 | } |
a4c955d9 | 932 | |
41a65f30 SM |
933 | /* Merge src_trace's data stream file groups into dest_trace's. */ |
934 | ||
4164020e | 935 | static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace *dest_trace, |
a4c955d9 | 936 | ctf_fs_trace::UP src_trace) |
41a65f30 | 937 | { |
cdf7de78 SM |
938 | std::vector<ctf_fs_ds_file_group::UP>& dest = dest_trace->ds_file_groups; |
939 | std::vector<ctf_fs_ds_file_group::UP>& src = src_trace->ds_file_groups; | |
4164020e SM |
940 | int ret = 0; |
941 | ||
942 | /* | |
943 | * Save the initial length of dest: we only want to check against the | |
944 | * original elements in the inner loop. | |
945 | */ | |
cdf7de78 | 946 | size_t dest_len = dest.size(); |
4164020e | 947 | |
cdf7de78 | 948 | for (auto& src_group : src) { |
4164020e SM |
949 | struct ctf_fs_ds_file_group *dest_group = NULL; |
950 | ||
951 | /* A stream instance without ID can't match a stream in the other trace. */ | |
952 | if (src_group->stream_id != -1) { | |
4164020e | 953 | /* Let's search for a matching ds_file_group in the destination. */ |
cdf7de78 SM |
954 | for (size_t d_i = 0; d_i < dest_len; ++d_i) { |
955 | ctf_fs_ds_file_group *candidate_dest = dest[d_i].get(); | |
4164020e SM |
956 | |
957 | /* Can't match a stream instance without ID. */ | |
958 | if (candidate_dest->stream_id == -1) { | |
959 | continue; | |
960 | } | |
961 | ||
962 | /* | |
963 | * If the two groups have the same stream instance id | |
964 | * and belong to the same stream class (stream instance | |
965 | * ids are per-stream class), they represent the same | |
966 | * stream instance. | |
967 | */ | |
968 | if (candidate_dest->stream_id != src_group->stream_id || | |
969 | candidate_dest->sc->id != src_group->sc->id) { | |
970 | continue; | |
971 | } | |
972 | ||
973 | dest_group = candidate_dest; | |
974 | break; | |
975 | } | |
976 | } | |
977 | ||
978 | /* | |
979 | * Didn't find a friend in dest to merge our src_group into? | |
980 | * Create a new empty one. This can happen if a stream was | |
981 | * active in the source trace chunk but not in the destination | |
982 | * trace chunk. | |
983 | */ | |
984 | if (!dest_group) { | |
985 | struct ctf_stream_class *sc; | |
4164020e SM |
986 | |
987 | sc = ctf_trace_class_borrow_stream_class_by_id(dest_trace->metadata->tc, | |
988 | src_group->sc->id); | |
989 | BT_ASSERT(sc); | |
990 | ||
2fb7af12 | 991 | auto index = ctf_fs_ds_index_create(); |
4164020e SM |
992 | if (!index) { |
993 | ret = -1; | |
994 | goto end; | |
995 | } | |
996 | ||
fe2e19c4 | 997 | auto new_dest_group = |
fe2f9cda | 998 | ctf_fs_ds_file_group_create(dest_trace, sc, src_group->stream_id, std::move(index)); |
fe2e19c4 | 999 | |
fe2e19c4 | 1000 | if (!new_dest_group) { |
4164020e SM |
1001 | ret = -1; |
1002 | goto end; | |
1003 | } | |
1004 | ||
fe2e19c4 | 1005 | dest_group = new_dest_group.get(); |
cdf7de78 | 1006 | dest_trace->ds_file_groups.emplace_back(std::move(new_dest_group)); |
4164020e SM |
1007 | } |
1008 | ||
1009 | BT_ASSERT(dest_group); | |
cdf7de78 | 1010 | merge_ctf_fs_ds_file_groups(dest_group, std::move(src_group)); |
4164020e | 1011 | } |
54ef52bd FD |
1012 | |
1013 | end: | |
4164020e | 1014 | return ret; |
41a65f30 SM |
1015 | } |
1016 | ||
1017 | /* | |
1018 | * Collapse the given traces, which must all share the same UUID, in a single | |
1019 | * one. | |
1020 | * | |
1021 | * The trace with the most expansive metadata is chosen and all other traces | |
a4c955d9 SM |
1022 | * are merged into that one. On return, the elements of `traces` are nullptr |
1023 | * and the merged trace is placed in `out_trace`. | |
41a65f30 SM |
1024 | */ |
1025 | ||
a4c955d9 | 1026 | static int merge_ctf_fs_traces(std::vector<ctf_fs_trace::UP> traces, ctf_fs_trace::UP& out_trace) |
41a65f30 | 1027 | { |
4164020e SM |
1028 | unsigned int winner_count; |
1029 | struct ctf_fs_trace *winner; | |
1030 | guint i, winner_i; | |
1031 | int ret = 0; | |
1032 | ||
a4c955d9 | 1033 | BT_ASSERT(traces.size() >= 2); |
4164020e | 1034 | |
a4c955d9 SM |
1035 | winner_count = metadata_count_stream_and_event_classes(traces[0].get()); |
1036 | winner = traces[0].get(); | |
4164020e SM |
1037 | winner_i = 0; |
1038 | ||
1039 | /* Find the trace with the largest metadata. */ | |
a4c955d9 SM |
1040 | for (i = 1; i < traces.size(); i++) { |
1041 | ctf_fs_trace *candidate = traces[i].get(); | |
4164020e SM |
1042 | unsigned int candidate_count; |
1043 | ||
4164020e SM |
1044 | /* A bit of sanity check. */ |
1045 | BT_ASSERT(bt_uuid_compare(winner->metadata->tc->uuid, candidate->metadata->tc->uuid) == 0); | |
1046 | ||
1047 | candidate_count = metadata_count_stream_and_event_classes(candidate); | |
1048 | ||
1049 | if (candidate_count > winner_count) { | |
1050 | winner_count = candidate_count; | |
1051 | winner = candidate; | |
1052 | winner_i = i; | |
1053 | } | |
1054 | } | |
1055 | ||
1056 | /* Merge all the other traces in the winning trace. */ | |
a4c955d9 | 1057 | for (ctf_fs_trace::UP& trace : traces) { |
4164020e | 1058 | /* Don't merge the winner into itself. */ |
a4c955d9 | 1059 | if (trace.get() == winner) { |
4164020e SM |
1060 | continue; |
1061 | } | |
1062 | ||
1063 | /* Merge trace's data stream file groups into winner's. */ | |
a4c955d9 | 1064 | ret = merge_matching_ctf_fs_ds_file_groups(winner, std::move(trace)); |
4164020e SM |
1065 | if (ret) { |
1066 | goto end; | |
1067 | } | |
1068 | } | |
1069 | ||
1070 | /* | |
1071 | * Move the winner out of the array, into `*out_trace`. | |
1072 | */ | |
a4c955d9 | 1073 | out_trace = std::move(traces[winner_i]); |
54ef52bd FD |
1074 | |
1075 | end: | |
4164020e | 1076 | return ret; |
41a65f30 SM |
1077 | } |
1078 | ||
4164020e SM |
1079 | enum target_event |
1080 | { | |
1081 | FIRST_EVENT, | |
1082 | LAST_EVENT, | |
1719bf64 FD |
1083 | }; |
1084 | ||
4164020e SM |
1085 | static int decode_clock_snapshot_after_event(struct ctf_fs_trace *ctf_fs_trace, |
1086 | struct ctf_clock_class *default_cc, | |
1087 | struct ctf_fs_ds_index_entry *index_entry, | |
1088 | enum target_event target_event, uint64_t *cs, | |
1089 | int64_t *ts_ns) | |
1719bf64 | 1090 | { |
4164020e | 1091 | enum ctf_msg_iter_status iter_status = CTF_MSG_ITER_STATUS_OK; |
4164020e | 1092 | struct ctf_msg_iter *msg_iter = NULL; |
4164020e SM |
1093 | int ret = 0; |
1094 | ||
1095 | BT_ASSERT(ctf_fs_trace); | |
1096 | BT_ASSERT(index_entry); | |
1097 | BT_ASSERT(index_entry->path); | |
1098 | ||
21c7fd8b SM |
1099 | const auto ds_file = ctf_fs_ds_file_create(ctf_fs_trace, bt2::Stream::Shared {}, |
1100 | index_entry->path, ctf_fs_trace->logger); | |
4164020e | 1101 | if (!ds_file) { |
0f5c5d5c | 1102 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace->logger, "Failed to create a ctf_fs_ds_file"); |
4164020e SM |
1103 | ret = -1; |
1104 | goto end; | |
1105 | } | |
1106 | ||
1107 | BT_ASSERT(ctf_fs_trace->metadata); | |
1108 | BT_ASSERT(ctf_fs_trace->metadata->tc); | |
1109 | ||
0f5c5d5c | 1110 | msg_iter = ctf_msg_iter_create( |
657f1bd6 SM |
1111 | ctf_fs_trace->metadata->tc, |
1112 | bt_common_get_page_size(static_cast<int>(ctf_fs_trace->logger.level())) * 8, | |
1113 | ctf_fs_ds_file_medops, ds_file.get(), NULL, ctf_fs_trace->logger) | |
1114 | .release(); | |
4164020e SM |
1115 | if (!msg_iter) { |
1116 | /* ctf_msg_iter_create() logs errors. */ | |
1117 | ret = -1; | |
1118 | goto end; | |
1119 | } | |
1120 | ||
1121 | /* | |
1122 | * Turn on dry run mode to prevent the creation and usage of Babeltrace | |
1123 | * library objects (bt_field, bt_message_*, etc.). | |
1124 | */ | |
1125 | ctf_msg_iter_set_dry_run(msg_iter, true); | |
1126 | ||
1127 | /* Seek to the beginning of the target packet. */ | |
ef7d7ac2 | 1128 | iter_status = ctf_msg_iter_seek(msg_iter, index_entry->offset.bytes()); |
4164020e SM |
1129 | if (iter_status) { |
1130 | /* ctf_msg_iter_seek() logs errors. */ | |
1131 | ret = -1; | |
1132 | goto end; | |
1133 | } | |
1134 | ||
1135 | switch (target_event) { | |
1136 | case FIRST_EVENT: | |
1137 | /* | |
1138 | * Start to decode the packet until we reach the end of | |
1139 | * the first event. To extract the first event's clock | |
1140 | * snapshot. | |
1141 | */ | |
1142 | iter_status = ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter, cs); | |
1143 | break; | |
1144 | case LAST_EVENT: | |
1145 | /* Decode the packet to extract the last event's clock snapshot. */ | |
1146 | iter_status = ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter, cs); | |
1147 | break; | |
1148 | default: | |
1149 | bt_common_abort(); | |
1150 | } | |
1151 | if (iter_status) { | |
1152 | ret = -1; | |
1153 | goto end; | |
1154 | } | |
1155 | ||
1156 | /* Convert clock snapshot to timestamp. */ | |
1157 | ret = bt_util_clock_cycles_to_ns_from_origin( | |
1158 | *cs, default_cc->frequency, default_cc->offset_seconds, default_cc->offset_cycles, ts_ns); | |
1159 | if (ret) { | |
0f5c5d5c SM |
1160 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace->logger, |
1161 | "Failed to convert clock snapshot to timestamp"); | |
4164020e SM |
1162 | goto end; |
1163 | } | |
1719bf64 FD |
1164 | |
1165 | end: | |
4164020e SM |
1166 | if (msg_iter) { |
1167 | ctf_msg_iter_destroy(msg_iter); | |
1168 | } | |
1169 | ||
1170 | return ret; | |
1719bf64 FD |
1171 | } |
1172 | ||
4164020e SM |
1173 | static int decode_packet_first_event_timestamp(struct ctf_fs_trace *ctf_fs_trace, |
1174 | struct ctf_clock_class *default_cc, | |
1175 | struct ctf_fs_ds_index_entry *index_entry, | |
1176 | uint64_t *cs, int64_t *ts_ns) | |
c43092a5 | 1177 | { |
4164020e SM |
1178 | return decode_clock_snapshot_after_event(ctf_fs_trace, default_cc, index_entry, FIRST_EVENT, cs, |
1179 | ts_ns); | |
c43092a5 FD |
1180 | } |
1181 | ||
4164020e SM |
1182 | static int decode_packet_last_event_timestamp(struct ctf_fs_trace *ctf_fs_trace, |
1183 | struct ctf_clock_class *default_cc, | |
1184 | struct ctf_fs_ds_index_entry *index_entry, | |
1185 | uint64_t *cs, int64_t *ts_ns) | |
1719bf64 | 1186 | { |
4164020e SM |
1187 | return decode_clock_snapshot_after_event(ctf_fs_trace, default_cc, index_entry, LAST_EVENT, cs, |
1188 | ts_ns); | |
1719bf64 FD |
1189 | } |
1190 | ||
1191 | /* | |
1192 | * Fix up packet index entries for lttng's "event-after-packet" bug. | |
1193 | * Some buggy lttng tracer versions may emit events with a timestamp that is | |
1194 | * larger (after) than the timestamp_end of the their packets. | |
1195 | * | |
1196 | * To fix up this erroneous data we do the following: | |
1197 | * 1. If it's not the stream file's last packet: set the packet index entry's | |
1198 | * end time to the next packet's beginning time. | |
1199 | * 2. If it's the stream file's last packet, set the packet index entry's end | |
1200 | * time to the packet's last event's time, if any, or to the packet's | |
1201 | * beginning time otherwise. | |
1202 | * | |
1203 | * Known buggy tracer versions: | |
1204 | * - before lttng-ust 2.11.0 | |
1205 | * - before lttng-module 2.11.0 | |
1206 | * - before lttng-module 2.10.10 | |
1207 | * - before lttng-module 2.9.13 | |
1208 | */ | |
4164020e | 1209 | static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace *trace) |
1719bf64 | 1210 | { |
4164020e | 1211 | int ret = 0; |
4164020e | 1212 | |
cdf7de78 | 1213 | for (const auto& ds_file_group : trace->ds_file_groups) { |
4164020e | 1214 | struct ctf_clock_class *default_cc; |
4164020e | 1215 | |
4164020e | 1216 | BT_ASSERT(ds_file_group); |
fe2f9cda | 1217 | const auto index = ds_file_group->index.get(); |
4164020e SM |
1218 | |
1219 | BT_ASSERT(index); | |
2fb7af12 | 1220 | BT_ASSERT(!index->entries.empty()); |
4164020e SM |
1221 | |
1222 | /* | |
1223 | * Iterate over all entries but the last one. The last one is | |
1224 | * fixed differently after. | |
1225 | */ | |
2fb7af12 SM |
1226 | for (size_t entry_i = 0; entry_i < index->entries.size() - 1; ++entry_i) { |
1227 | ctf_fs_ds_index_entry *curr_entry = index->entries[entry_i].get(); | |
1228 | ctf_fs_ds_index_entry *next_entry = index->entries[entry_i + 1].get(); | |
4164020e SM |
1229 | |
1230 | /* | |
1231 | * 1. Set the current index entry `end` timestamp to | |
1232 | * the next index entry `begin` timestamp. | |
1233 | */ | |
1234 | curr_entry->timestamp_end = next_entry->timestamp_begin; | |
1235 | curr_entry->timestamp_end_ns = next_entry->timestamp_begin_ns; | |
1236 | } | |
1237 | ||
1238 | /* | |
1239 | * 2. Fix the last entry by decoding the last event of the last | |
1240 | * packet. | |
1241 | */ | |
2fb7af12 | 1242 | const auto last_entry = index->entries.back().get(); |
4164020e SM |
1243 | BT_ASSERT(last_entry); |
1244 | ||
1245 | BT_ASSERT(ds_file_group->sc->default_clock_class); | |
1246 | default_cc = ds_file_group->sc->default_clock_class; | |
1247 | ||
1248 | /* | |
1249 | * Decode packet to read the timestamp of the last event of the | |
1250 | * entry. | |
1251 | */ | |
1252 | ret = decode_packet_last_event_timestamp(trace, default_cc, last_entry, | |
1253 | &last_entry->timestamp_end, | |
1254 | &last_entry->timestamp_end_ns); | |
1255 | if (ret) { | |
0f5c5d5c SM |
1256 | BT_CPPLOGE_APPEND_CAUSE_SPEC( |
1257 | trace->logger, | |
4164020e SM |
1258 | "Failed to decode stream's last packet to get its last event's clock snapshot."); |
1259 | goto end; | |
1260 | } | |
1261 | } | |
1719bf64 FD |
1262 | |
1263 | end: | |
4164020e | 1264 | return ret; |
1719bf64 FD |
1265 | } |
1266 | ||
c43092a5 FD |
1267 | /* |
1268 | * Fix up packet index entries for barectf's "event-before-packet" bug. | |
1269 | * Some buggy barectf tracer versions may emit events with a timestamp that is | |
1270 | * less than the timestamp_begin of the their packets. | |
1271 | * | |
1272 | * To fix up this erroneous data we do the following: | |
1273 | * 1. Starting at the second index entry, set the timestamp_begin of the | |
1274 | * current entry to the timestamp of the first event of the packet. | |
1275 | * 2. Set the previous entry's timestamp_end to the timestamp_begin of the | |
1276 | * current packet. | |
1277 | * | |
1278 | * Known buggy tracer versions: | |
1279 | * - before barectf 2.3.1 | |
1280 | */ | |
4164020e | 1281 | static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace *trace) |
c43092a5 | 1282 | { |
4164020e | 1283 | int ret = 0; |
4164020e | 1284 | |
cdf7de78 | 1285 | for (const auto& ds_file_group : trace->ds_file_groups) { |
4164020e | 1286 | struct ctf_clock_class *default_cc; |
fe2f9cda | 1287 | const auto index = ds_file_group->index.get(); |
4164020e SM |
1288 | |
1289 | BT_ASSERT(index); | |
2fb7af12 | 1290 | BT_ASSERT(!index->entries.empty()); |
4164020e SM |
1291 | |
1292 | BT_ASSERT(ds_file_group->sc->default_clock_class); | |
1293 | default_cc = ds_file_group->sc->default_clock_class; | |
1294 | ||
1295 | /* | |
1296 | * 1. Iterate over the index, starting from the second entry | |
1297 | * (index = 1). | |
1298 | */ | |
2fb7af12 SM |
1299 | for (size_t entry_i = 1; entry_i < index->entries.size(); ++entry_i) { |
1300 | ctf_fs_ds_index_entry *prev_entry = index->entries[entry_i - 1].get(); | |
1301 | ctf_fs_ds_index_entry *curr_entry = index->entries[entry_i].get(); | |
4164020e SM |
1302 | /* |
1303 | * 2. Set the current entry `begin` timestamp to the | |
1304 | * timestamp of the first event of the current packet. | |
1305 | */ | |
1306 | ret = decode_packet_first_event_timestamp(trace, default_cc, curr_entry, | |
1307 | &curr_entry->timestamp_begin, | |
1308 | &curr_entry->timestamp_begin_ns); | |
1309 | if (ret) { | |
0f5c5d5c SM |
1310 | BT_CPPLOGE_APPEND_CAUSE_SPEC(trace->logger, |
1311 | "Failed to decode first event's clock snapshot"); | |
4164020e SM |
1312 | goto end; |
1313 | } | |
1314 | ||
1315 | /* | |
1316 | * 3. Set the previous entry `end` timestamp to the | |
1317 | * timestamp of the first event of the current packet. | |
1318 | */ | |
1319 | prev_entry->timestamp_end = curr_entry->timestamp_begin; | |
1320 | prev_entry->timestamp_end_ns = curr_entry->timestamp_begin_ns; | |
1321 | } | |
1322 | } | |
c43092a5 | 1323 | end: |
4164020e | 1324 | return ret; |
c43092a5 FD |
1325 | } |
1326 | ||
aada78b5 FD |
1327 | /* |
1328 | * When using the lttng-crash feature it's likely that the last packets of each | |
1329 | * stream have their timestamp_end set to zero. This is caused by the fact that | |
1330 | * the tracer crashed and was not able to properly close the packets. | |
1331 | * | |
1332 | * To fix up this erroneous data we do the following: | |
1333 | * For each index entry, if the entry's timestamp_end is 0 and the | |
1334 | * timestamp_begin is not 0: | |
1335 | * - If it's the stream file's last packet: set the packet index entry's end | |
1336 | * time to the packet's last event's time, if any, or to the packet's | |
1337 | * beginning time otherwise. | |
1338 | * - If it's not the stream file's last packet: set the packet index | |
1339 | * entry's end time to the next packet's beginning time. | |
1340 | * | |
1341 | * Affected versions: | |
1342 | * - All current and future lttng-ust and lttng-modules versions. | |
1343 | */ | |
4164020e | 1344 | static int fix_index_lttng_crash_quirk(struct ctf_fs_trace *trace) |
aada78b5 | 1345 | { |
4164020e | 1346 | int ret = 0; |
4164020e | 1347 | |
cdf7de78 | 1348 | for (const auto& ds_file_group : trace->ds_file_groups) { |
4164020e | 1349 | struct ctf_clock_class *default_cc; |
4164020e | 1350 | |
4164020e | 1351 | BT_ASSERT(ds_file_group); |
fe2f9cda | 1352 | const auto index = ds_file_group->index.get(); |
4164020e SM |
1353 | |
1354 | BT_ASSERT(ds_file_group->sc->default_clock_class); | |
1355 | default_cc = ds_file_group->sc->default_clock_class; | |
1356 | ||
1357 | BT_ASSERT(index); | |
2fb7af12 | 1358 | BT_ASSERT(!index->entries.empty()); |
4164020e | 1359 | |
2fb7af12 | 1360 | const auto last_entry = index->entries.back().get(); |
4164020e SM |
1361 | BT_ASSERT(last_entry); |
1362 | ||
1363 | /* 1. Fix the last entry first. */ | |
1364 | if (last_entry->timestamp_end == 0 && last_entry->timestamp_begin != 0) { | |
1365 | /* | |
1366 | * Decode packet to read the timestamp of the | |
1367 | * last event of the stream file. | |
1368 | */ | |
1369 | ret = decode_packet_last_event_timestamp(trace, default_cc, last_entry, | |
1370 | &last_entry->timestamp_end, | |
1371 | &last_entry->timestamp_end_ns); | |
1372 | if (ret) { | |
0f5c5d5c SM |
1373 | BT_CPPLOGE_APPEND_CAUSE_SPEC(trace->logger, |
1374 | "Failed to decode last event's clock snapshot"); | |
4164020e SM |
1375 | goto end; |
1376 | } | |
1377 | } | |
1378 | ||
1379 | /* Iterate over all entries but the last one. */ | |
2fb7af12 SM |
1380 | for (size_t entry_idx = 0; entry_idx < index->entries.size() - 1; ++entry_idx) { |
1381 | ctf_fs_ds_index_entry *curr_entry = index->entries[entry_idx].get(); | |
1382 | ctf_fs_ds_index_entry *next_entry = index->entries[entry_idx + 1].get(); | |
4164020e SM |
1383 | |
1384 | if (curr_entry->timestamp_end == 0 && curr_entry->timestamp_begin != 0) { | |
1385 | /* | |
1386 | * 2. Set the current index entry `end` timestamp to | |
1387 | * the next index entry `begin` timestamp. | |
1388 | */ | |
1389 | curr_entry->timestamp_end = next_entry->timestamp_begin; | |
1390 | curr_entry->timestamp_end_ns = next_entry->timestamp_begin_ns; | |
1391 | } | |
1392 | } | |
1393 | } | |
aada78b5 FD |
1394 | |
1395 | end: | |
4164020e | 1396 | return ret; |
aada78b5 FD |
1397 | } |
1398 | ||
626cc488 FD |
1399 | /* |
1400 | * Extract the tracer information necessary to compare versions. | |
1401 | * Returns 0 on success, and -1 if the extraction is not successful because the | |
1402 | * necessary fields are absents in the trace metadata. | |
1403 | */ | |
4164020e | 1404 | static int extract_tracer_info(struct ctf_fs_trace *trace, struct tracer_info *current_tracer_info) |
626cc488 | 1405 | { |
4164020e SM |
1406 | int ret = 0; |
1407 | struct ctf_trace_class_env_entry *entry; | |
1408 | ||
1409 | /* Clear the current_tracer_info struct */ | |
1410 | memset(current_tracer_info, 0, sizeof(*current_tracer_info)); | |
1411 | ||
1412 | /* | |
1413 | * To compare 2 tracer versions, at least the tracer name and it's | |
1414 | * major version are needed. If one of these is missing, consider it an | |
1415 | * extraction failure. | |
1416 | */ | |
1417 | entry = ctf_trace_class_borrow_env_entry_by_name(trace->metadata->tc, "tracer_name"); | |
1418 | if (!entry || entry->type != CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR) { | |
1419 | goto missing_bare_minimum; | |
1420 | } | |
1421 | ||
1422 | /* Set tracer name. */ | |
1423 | current_tracer_info->name = entry->value.str->str; | |
1424 | ||
1425 | entry = ctf_trace_class_borrow_env_entry_by_name(trace->metadata->tc, "tracer_major"); | |
1426 | if (!entry || entry->type != CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT) { | |
1427 | goto missing_bare_minimum; | |
1428 | } | |
1429 | ||
1430 | /* Set major version number. */ | |
1431 | current_tracer_info->major = entry->value.i; | |
1432 | ||
1433 | entry = ctf_trace_class_borrow_env_entry_by_name(trace->metadata->tc, "tracer_minor"); | |
1434 | if (!entry || entry->type != CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT) { | |
1435 | goto end; | |
1436 | } | |
1437 | ||
1438 | /* Set minor version number. */ | |
1439 | current_tracer_info->minor = entry->value.i; | |
1440 | ||
1441 | entry = ctf_trace_class_borrow_env_entry_by_name(trace->metadata->tc, "tracer_patch"); | |
1442 | if (!entry) { | |
1443 | /* | |
1444 | * If `tracer_patch` doesn't exist `tracer_patchlevel` might. | |
1445 | * For example, `lttng-modules` uses entry name | |
1446 | * `tracer_patchlevel`. | |
1447 | */ | |
1448 | entry = ctf_trace_class_borrow_env_entry_by_name(trace->metadata->tc, "tracer_patchlevel"); | |
1449 | } | |
1450 | ||
1451 | if (!entry || entry->type != CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT) { | |
1452 | goto end; | |
1453 | } | |
1454 | ||
1455 | /* Set patch version number. */ | |
1456 | current_tracer_info->patch = entry->value.i; | |
1457 | ||
1458 | goto end; | |
626cc488 FD |
1459 | |
1460 | missing_bare_minimum: | |
4164020e | 1461 | ret = -1; |
626cc488 | 1462 | end: |
4164020e | 1463 | return ret; |
626cc488 FD |
1464 | } |
1465 | ||
4164020e | 1466 | static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info *curr_tracer_info) |
1719bf64 | 1467 | { |
4164020e SM |
1468 | bool is_affected = false; |
1469 | ||
1470 | if (strcmp(curr_tracer_info->name, "lttng-ust") == 0) { | |
1471 | if (curr_tracer_info->major < 2) { | |
1472 | is_affected = true; | |
1473 | } else if (curr_tracer_info->major == 2) { | |
1474 | /* fixed in lttng-ust 2.11.0 */ | |
1475 | if (curr_tracer_info->minor < 11) { | |
1476 | is_affected = true; | |
1477 | } | |
1478 | } | |
1479 | } else if (strcmp(curr_tracer_info->name, "lttng-modules") == 0) { | |
1480 | if (curr_tracer_info->major < 2) { | |
1481 | is_affected = true; | |
1482 | } else if (curr_tracer_info->major == 2) { | |
1483 | /* fixed in lttng-modules 2.11.0 */ | |
1484 | if (curr_tracer_info->minor == 10) { | |
1485 | /* fixed in lttng-modules 2.10.10 */ | |
1486 | if (curr_tracer_info->patch < 10) { | |
1487 | is_affected = true; | |
1488 | } | |
1489 | } else if (curr_tracer_info->minor == 9) { | |
1490 | /* fixed in lttng-modules 2.9.13 */ | |
1491 | if (curr_tracer_info->patch < 13) { | |
1492 | is_affected = true; | |
1493 | } | |
1494 | } else if (curr_tracer_info->minor < 9) { | |
1495 | is_affected = true; | |
1496 | } | |
1497 | } | |
1498 | } | |
1499 | ||
1500 | return is_affected; | |
1719bf64 FD |
1501 | } |
1502 | ||
4164020e SM |
1503 | static bool |
1504 | is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info *curr_tracer_info) | |
c43092a5 | 1505 | { |
4164020e SM |
1506 | bool is_affected = false; |
1507 | ||
1508 | if (strcmp(curr_tracer_info->name, "barectf") == 0) { | |
1509 | if (curr_tracer_info->major < 2) { | |
1510 | is_affected = true; | |
1511 | } else if (curr_tracer_info->major == 2) { | |
1512 | if (curr_tracer_info->minor < 3) { | |
1513 | is_affected = true; | |
1514 | } else if (curr_tracer_info->minor == 3) { | |
1515 | /* fixed in barectf 2.3.1 */ | |
1516 | if (curr_tracer_info->patch < 1) { | |
1517 | is_affected = true; | |
1518 | } | |
1519 | } | |
1520 | } | |
1521 | } | |
1522 | ||
1523 | return is_affected; | |
c43092a5 FD |
1524 | } |
1525 | ||
4164020e | 1526 | static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info *curr_tracer_info) |
aada78b5 | 1527 | { |
4164020e | 1528 | bool is_affected = false; |
aada78b5 | 1529 | |
4164020e SM |
1530 | /* All LTTng tracer may be affected by this lttng crash quirk. */ |
1531 | if (strcmp(curr_tracer_info->name, "lttng-ust") == 0) { | |
1532 | is_affected = true; | |
1533 | } else if (strcmp(curr_tracer_info->name, "lttng-modules") == 0) { | |
1534 | is_affected = true; | |
1535 | } | |
aada78b5 | 1536 | |
4164020e | 1537 | return is_affected; |
aada78b5 FD |
1538 | } |
1539 | ||
1719bf64 FD |
1540 | /* |
1541 | * Looks for trace produced by known buggy tracers and fix up the index | |
1542 | * produced earlier. | |
1543 | */ | |
0f5c5d5c | 1544 | static int fix_packet_index_tracer_bugs(ctf_fs_trace *trace) |
1719bf64 | 1545 | { |
4164020e SM |
1546 | int ret = 0; |
1547 | struct tracer_info current_tracer_info; | |
4164020e | 1548 | |
0f5c5d5c | 1549 | ret = extract_tracer_info(trace, ¤t_tracer_info); |
4164020e SM |
1550 | if (ret) { |
1551 | /* | |
1552 | * A trace may not have all the necessary environment | |
1553 | * entries to do the tracer version comparison. | |
1554 | * At least, the tracer name and major version number | |
1555 | * are needed. Failing to extract these entries is not | |
1556 | * an error. | |
1557 | */ | |
1558 | ret = 0; | |
0f5c5d5c SM |
1559 | BT_CPPLOGI_STR_SPEC( |
1560 | trace->logger, | |
1561 | "Cannot extract tracer information necessary to compare with buggy versions."); | |
4164020e | 1562 | goto end; |
4164020e SM |
1563 | } |
1564 | ||
1565 | /* Check if the trace may be affected by old tracer bugs. */ | |
1566 | if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info)) { | |
0f5c5d5c SM |
1567 | BT_CPPLOGI_STR_SPEC( |
1568 | trace->logger, | |
1569 | "Trace may be affected by LTTng tracer packet timestamp bug. Fixing up."); | |
1570 | ret = fix_index_lttng_event_after_packet_bug(trace); | |
4164020e | 1571 | if (ret) { |
0f5c5d5c SM |
1572 | BT_CPPLOGE_APPEND_CAUSE_SPEC(trace->logger, |
1573 | "Failed to fix LTTng event-after-packet bug."); | |
4164020e SM |
1574 | goto end; |
1575 | } | |
0f5c5d5c | 1576 | trace->metadata->tc->quirks.lttng_event_after_packet = true; |
4164020e SM |
1577 | } |
1578 | ||
1579 | if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info)) { | |
0f5c5d5c SM |
1580 | BT_CPPLOGI_STR_SPEC( |
1581 | trace->logger, | |
1582 | "Trace may be affected by barectf tracer packet timestamp bug. Fixing up."); | |
1583 | ret = fix_index_barectf_event_before_packet_bug(trace); | |
4164020e | 1584 | if (ret) { |
0f5c5d5c SM |
1585 | BT_CPPLOGE_APPEND_CAUSE_SPEC(trace->logger, |
1586 | "Failed to fix barectf event-before-packet bug."); | |
4164020e SM |
1587 | goto end; |
1588 | } | |
0f5c5d5c | 1589 | trace->metadata->tc->quirks.barectf_event_before_packet = true; |
4164020e SM |
1590 | } |
1591 | ||
1592 | if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info)) { | |
0f5c5d5c | 1593 | ret = fix_index_lttng_crash_quirk(trace); |
4164020e | 1594 | if (ret) { |
0f5c5d5c SM |
1595 | BT_CPPLOGE_APPEND_CAUSE_SPEC(trace->logger, |
1596 | "Failed to fix lttng-crash timestamp quirks."); | |
4164020e SM |
1597 | goto end; |
1598 | } | |
0f5c5d5c | 1599 | trace->metadata->tc->quirks.lttng_crash = true; |
4164020e | 1600 | } |
a0cd55ad | 1601 | |
1719bf64 | 1602 | end: |
4164020e | 1603 | return ret; |
1719bf64 FD |
1604 | } |
1605 | ||
cdf7de78 SM |
1606 | static bool compare_ds_file_groups_by_first_path(const ctf_fs_ds_file_group::UP& ds_file_group_a, |
1607 | const ctf_fs_ds_file_group::UP& ds_file_group_b) | |
e9b3611f | 1608 | { |
f3d74124 SM |
1609 | BT_ASSERT(!ds_file_group_a->ds_file_infos.empty()); |
1610 | BT_ASSERT(!ds_file_group_b->ds_file_infos.empty()); | |
087cd0f5 | 1611 | |
f3d74124 SM |
1612 | const auto& first_ds_file_info_a = *ds_file_group_a->ds_file_infos[0]; |
1613 | const auto& first_ds_file_info_b = *ds_file_group_b->ds_file_infos[0]; | |
087cd0f5 | 1614 | |
f3d74124 | 1615 | return first_ds_file_info_a.path < first_ds_file_info_b.path; |
e9b3611f PP |
1616 | } |
1617 | ||
4164020e | 1618 | static gint compare_strings(gconstpointer p_a, gconstpointer p_b) |
7b69723d | 1619 | { |
4164020e SM |
1620 | const char *a = *((const char **) p_a); |
1621 | const char *b = *((const char **) p_b); | |
7b69723d | 1622 | |
4164020e | 1623 | return strcmp(a, b); |
7b69723d SM |
1624 | } |
1625 | ||
4164020e SM |
1626 | int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component *ctf_fs, |
1627 | const bt_value *paths_value, | |
1628 | const bt_value *trace_name_value, | |
0f5c5d5c | 1629 | bt_self_component *selfComp) |
f280892e | 1630 | { |
4164020e SM |
1631 | int ret = 0; |
1632 | uint64_t i; | |
4164020e | 1633 | GPtrArray *paths = NULL; |
a4c955d9 | 1634 | std::vector<ctf_fs_trace::UP> traces; |
4164020e SM |
1635 | const char *trace_name; |
1636 | ||
1637 | BT_ASSERT(bt_value_get_type(paths_value) == BT_VALUE_TYPE_ARRAY); | |
1638 | BT_ASSERT(!bt_value_array_is_empty(paths_value)); | |
1639 | ||
4164020e SM |
1640 | paths = g_ptr_array_new_with_free_func(g_free); |
1641 | if (!paths) { | |
0f5c5d5c | 1642 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs->logger, "Failed to allocate a GPtrArray."); |
4164020e SM |
1643 | goto error; |
1644 | } | |
1645 | ||
1646 | trace_name = trace_name_value ? bt_value_string_get(trace_name_value) : NULL; | |
1647 | ||
1648 | /* | |
1649 | * Create a sorted array of the paths, to make the execution of this | |
1650 | * component deterministic. | |
1651 | */ | |
1652 | for (i = 0; i < bt_value_array_get_length(paths_value); i++) { | |
1653 | const bt_value *path_value = bt_value_array_borrow_element_by_index_const(paths_value, i); | |
1654 | const char *input = bt_value_string_get(path_value); | |
1655 | gchar *input_copy; | |
1656 | ||
1657 | input_copy = g_strdup(input); | |
1658 | if (!input_copy) { | |
0f5c5d5c | 1659 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs->logger, "Failed to copy a string."); |
4164020e SM |
1660 | goto error; |
1661 | } | |
1662 | ||
1663 | g_ptr_array_add(paths, input_copy); | |
1664 | } | |
1665 | ||
1666 | g_ptr_array_sort(paths, compare_strings); | |
1667 | ||
1668 | /* Create a separate ctf_fs_trace object for each path. */ | |
1669 | for (i = 0; i < paths->len; i++) { | |
1670 | const char *path = (const char *) g_ptr_array_index(paths, i); | |
1671 | ||
1672 | ret = ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs, path, trace_name, traces, | |
0f5c5d5c | 1673 | selfComp); |
4164020e SM |
1674 | if (ret) { |
1675 | goto end; | |
1676 | } | |
1677 | } | |
1678 | ||
a4c955d9 SM |
1679 | if (traces.size() > 1) { |
1680 | ctf_fs_trace *first_trace = traces[0].get(); | |
4164020e | 1681 | const uint8_t *first_trace_uuid = first_trace->metadata->tc->uuid; |
4164020e SM |
1682 | |
1683 | /* | |
1684 | * We have more than one trace, they must all share the same | |
1685 | * UUID, verify that. | |
1686 | */ | |
a4c955d9 SM |
1687 | for (i = 0; i < traces.size(); i++) { |
1688 | ctf_fs_trace *this_trace = traces[i].get(); | |
4164020e SM |
1689 | const uint8_t *this_trace_uuid = this_trace->metadata->tc->uuid; |
1690 | ||
1691 | if (!this_trace->metadata->tc->is_uuid_set) { | |
0f5c5d5c SM |
1692 | BT_CPPLOGE_APPEND_CAUSE_SPEC( |
1693 | ctf_fs->logger, | |
1694 | "Multiple traces given, but a trace does not have a UUID: path={}", | |
4164020e SM |
1695 | this_trace->path->str); |
1696 | goto error; | |
1697 | } | |
1698 | ||
1699 | if (bt_uuid_compare(first_trace_uuid, this_trace_uuid) != 0) { | |
1700 | char first_trace_uuid_str[BT_UUID_STR_LEN + 1]; | |
1701 | char this_trace_uuid_str[BT_UUID_STR_LEN + 1]; | |
1702 | ||
1703 | bt_uuid_to_str(first_trace_uuid, first_trace_uuid_str); | |
1704 | bt_uuid_to_str(this_trace_uuid, this_trace_uuid_str); | |
1705 | ||
0f5c5d5c SM |
1706 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs->logger, |
1707 | "Multiple traces given, but UUIDs don't match: " | |
1708 | "first-trace-uuid={}, first-trace-path={}, " | |
1709 | "trace-uuid={}, trace-path={}", | |
1710 | first_trace_uuid_str, first_trace->path->str, | |
1711 | this_trace_uuid_str, this_trace->path->str); | |
4164020e SM |
1712 | goto error; |
1713 | } | |
1714 | } | |
1715 | ||
a4c955d9 | 1716 | ret = merge_ctf_fs_traces(std::move(traces), ctf_fs->trace); |
4164020e | 1717 | if (ret) { |
0f5c5d5c SM |
1718 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs->logger, |
1719 | "Failed to merge traces with the same UUID."); | |
4164020e SM |
1720 | goto error; |
1721 | } | |
4164020e SM |
1722 | } else { |
1723 | /* Just one trace, it may or may not have a UUID, both are fine. */ | |
a4c955d9 | 1724 | ctf_fs->trace = std::move(traces[0]); |
4164020e SM |
1725 | } |
1726 | ||
7df773f2 | 1727 | ret = fix_packet_index_tracer_bugs(ctf_fs->trace.get()); |
4164020e | 1728 | if (ret) { |
0f5c5d5c | 1729 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs->logger, "Failed to fix packet index tracer bugs."); |
4164020e SM |
1730 | } |
1731 | ||
1732 | /* | |
1733 | * Sort data stream file groups by first data stream file info | |
1734 | * path to get a deterministic order. This order influences the | |
1735 | * order of the output ports. It also influences the order of | |
1736 | * the automatic stream IDs if the trace's packet headers do not | |
1737 | * contain a `stream_instance_id` field, in which case the data | |
1738 | * stream file to stream ID association is always the same, | |
1739 | * whatever the build and the system. | |
1740 | * | |
1741 | * Having a deterministic order here can help debugging and | |
1742 | * testing. | |
1743 | */ | |
cdf7de78 SM |
1744 | std::sort(ctf_fs->trace->ds_file_groups.begin(), ctf_fs->trace->ds_file_groups.end(), |
1745 | compare_ds_file_groups_by_first_path); | |
4164020e | 1746 | goto end; |
a0cd55ad | 1747 | error: |
4164020e | 1748 | ret = -1; |
a0cd55ad | 1749 | |
f280892e | 1750 | end: |
4164020e SM |
1751 | if (paths) { |
1752 | g_ptr_array_free(paths, TRUE); | |
1753 | } | |
7b69723d | 1754 | |
4164020e | 1755 | return ret; |
f280892e SM |
1756 | } |
1757 | ||
4164020e | 1758 | static GString *get_stream_instance_unique_name(struct ctf_fs_ds_file_group *ds_file_group) |
a38d7650 | 1759 | { |
4164020e SM |
1760 | GString *name; |
1761 | struct ctf_fs_ds_file_info *ds_file_info; | |
1762 | ||
1763 | name = g_string_new(NULL); | |
1764 | if (!name) { | |
1765 | goto end; | |
1766 | } | |
1767 | ||
1768 | /* | |
1769 | * If there's more than one stream file in the stream file | |
1770 | * group, the first (earliest) stream file's path is used as | |
1771 | * the stream's unique name. | |
1772 | */ | |
f3d74124 SM |
1773 | BT_ASSERT(!ds_file_group->ds_file_infos.empty()); |
1774 | ds_file_info = ds_file_group->ds_file_infos[0].get(); | |
4d199954 | 1775 | g_string_assign(name, ds_file_info->path.c_str()); |
a38d7650 SM |
1776 | |
1777 | end: | |
4164020e | 1778 | return name; |
a38d7650 SM |
1779 | } |
1780 | ||
f280892e SM |
1781 | /* Create the IR stream objects for ctf_fs_trace. */ |
1782 | ||
4164020e | 1783 | static int create_streams_for_trace(struct ctf_fs_trace *ctf_fs_trace) |
f280892e | 1784 | { |
4164020e SM |
1785 | int ret; |
1786 | GString *name = NULL; | |
4164020e | 1787 | |
cdf7de78 SM |
1788 | for (const auto& ds_file_group : ctf_fs_trace->ds_file_groups) { |
1789 | name = get_stream_instance_unique_name(ds_file_group.get()); | |
4164020e SM |
1790 | |
1791 | if (!name) { | |
1792 | goto error; | |
1793 | } | |
1794 | ||
f0940b01 SM |
1795 | BT_ASSERT(ds_file_group->sc->ir_sc); |
1796 | BT_ASSERT(ctf_fs_trace->trace); | |
1797 | ||
be215bcd SM |
1798 | bt_stream *stream; |
1799 | ||
f0940b01 SM |
1800 | if (ds_file_group->stream_id == UINT64_C(-1)) { |
1801 | /* No stream ID: use 0 */ | |
be215bcd SM |
1802 | stream = bt_stream_create_with_id(ds_file_group->sc->ir_sc, ctf_fs_trace->trace, |
1803 | ctf_fs_trace->next_stream_id); | |
f0940b01 | 1804 | ctf_fs_trace->next_stream_id++; |
4164020e | 1805 | } else { |
f0940b01 | 1806 | /* Specific stream ID */ |
be215bcd SM |
1807 | stream = bt_stream_create_with_id(ds_file_group->sc->ir_sc, ctf_fs_trace->trace, |
1808 | (uint64_t) ds_file_group->stream_id); | |
4164020e SM |
1809 | } |
1810 | ||
be215bcd | 1811 | if (!stream) { |
0f5c5d5c SM |
1812 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace->logger, |
1813 | "Cannot create stream for DS file group: " | |
1814 | "addr={}, stream-name=\"{}\"", | |
1815 | fmt::ptr(ds_file_group), name->str); | |
4164020e SM |
1816 | goto error; |
1817 | } | |
1818 | ||
be215bcd SM |
1819 | ds_file_group->stream = bt2::Stream::Shared::createWithoutRef(stream); |
1820 | ||
1821 | ret = bt_stream_set_name(ds_file_group->stream->libObjPtr(), name->str); | |
4164020e | 1822 | if (ret) { |
0f5c5d5c SM |
1823 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace->logger, |
1824 | "Cannot set stream's name: " | |
1825 | "addr={}, stream-name=\"{}\"", | |
be215bcd | 1826 | fmt::ptr(ds_file_group->stream->libObjPtr()), name->str); |
4164020e SM |
1827 | goto error; |
1828 | } | |
1829 | ||
1830 | g_string_free(name, TRUE); | |
1831 | name = NULL; | |
1832 | } | |
1833 | ||
1834 | ret = 0; | |
1835 | goto end; | |
f280892e SM |
1836 | |
1837 | error: | |
4164020e | 1838 | ret = -1; |
f280892e SM |
1839 | |
1840 | end: | |
1841 | ||
4164020e SM |
1842 | if (name) { |
1843 | g_string_free(name, TRUE); | |
1844 | } | |
1845 | return ret; | |
f280892e SM |
1846 | } |
1847 | ||
88730e42 SM |
1848 | static const bt_param_validation_value_descr inputs_elem_descr = |
1849 | bt_param_validation_value_descr::makeString(); | |
087cd0f5 SM |
1850 | |
1851 | static bt_param_validation_map_value_entry_descr fs_params_entries_descr[] = { | |
88730e42 SM |
1852 | {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY, |
1853 | bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE, | |
1854 | inputs_elem_descr)}, | |
1855 | {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, | |
1856 | bt_param_validation_value_descr::makeString()}, | |
1857 | {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, | |
1858 | bt_param_validation_value_descr::makeSignedInteger()}, | |
1859 | {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, | |
1860 | bt_param_validation_value_descr::makeSignedInteger()}, | |
1861 | {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, | |
1862 | bt_param_validation_value_descr::makeBool()}, | |
4164020e SM |
1863 | BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END}; |
1864 | ||
1865 | bool read_src_fs_parameters(const bt_value *params, const bt_value **inputs, | |
0f5c5d5c | 1866 | const bt_value **trace_name, struct ctf_fs_component *ctf_fs) |
4164020e SM |
1867 | { |
1868 | bool ret; | |
1869 | const bt_value *value; | |
4164020e SM |
1870 | enum bt_param_validation_status validate_value_status; |
1871 | gchar *error = NULL; | |
1872 | ||
1873 | validate_value_status = bt_param_validation_validate(params, fs_params_entries_descr, &error); | |
1874 | if (validate_value_status != BT_PARAM_VALIDATION_STATUS_OK) { | |
0f5c5d5c | 1875 | BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs->logger, "{}", error); |
4164020e SM |
1876 | ret = false; |
1877 | goto end; | |
1878 | } | |
1879 | ||
1880 | /* inputs parameter */ | |
1881 | *inputs = bt_value_map_borrow_entry_value_const(params, "inputs"); | |
1882 | ||
1883 | /* clock-class-offset-s parameter */ | |
1884 | value = bt_value_map_borrow_entry_value_const(params, "clock-class-offset-s"); | |
1885 | if (value) { | |
c942e7a2 | 1886 | ctf_fs->clkClsCfg.offsetSec = bt_value_integer_signed_get(value); |
4164020e SM |
1887 | } |
1888 | ||
1889 | /* clock-class-offset-ns parameter */ | |
1890 | value = bt_value_map_borrow_entry_value_const(params, "clock-class-offset-ns"); | |
1891 | if (value) { | |
c942e7a2 | 1892 | ctf_fs->clkClsCfg.offsetNanoSec = bt_value_integer_signed_get(value); |
4164020e SM |
1893 | } |
1894 | ||
1895 | /* force-clock-class-origin-unix-epoch parameter */ | |
1896 | value = bt_value_map_borrow_entry_value_const(params, "force-clock-class-origin-unix-epoch"); | |
1897 | if (value) { | |
c942e7a2 | 1898 | ctf_fs->clkClsCfg.forceOriginIsUnixEpoch = bt_value_bool_get(value); |
4164020e SM |
1899 | } |
1900 | ||
1901 | /* trace-name parameter */ | |
1902 | *trace_name = bt_value_map_borrow_entry_value_const(params, "trace-name"); | |
1903 | ||
1904 | ret = true; | |
d907165c SM |
1905 | |
1906 | end: | |
4164020e SM |
1907 | g_free(error); |
1908 | return ret; | |
d907165c SM |
1909 | } |
1910 | ||
f340a3e8 SM |
1911 | static ctf_fs_component::UP ctf_fs_create(const bt_value *params, |
1912 | bt_self_component_source *self_comp_src) | |
56a1cced | 1913 | { |
4164020e SM |
1914 | const bt_value *inputs_value; |
1915 | const bt_value *trace_name_value; | |
1916 | bt_self_component *self_comp = bt_self_component_source_as_self_component(self_comp_src); | |
56a1cced | 1917 | |
f340a3e8 | 1918 | ctf_fs_component::UP ctf_fs = ctf_fs_component_create( |
0f5c5d5c | 1919 | bt2c::Logger {bt2::SelfSourceComponent {self_comp_src}, "PLUGIN/SRC.CTF.FS/COMP"}); |
4164020e | 1920 | if (!ctf_fs) { |
f340a3e8 | 1921 | return nullptr; |
4164020e | 1922 | } |
f280892e | 1923 | |
f340a3e8 SM |
1924 | if (!read_src_fs_parameters(params, &inputs_value, &trace_name_value, ctf_fs.get())) { |
1925 | return nullptr; | |
4164020e | 1926 | } |
56a1cced | 1927 | |
f340a3e8 SM |
1928 | if (ctf_fs_component_create_ctf_fs_trace(ctf_fs.get(), inputs_value, trace_name_value, |
1929 | self_comp)) { | |
1930 | return nullptr; | |
4164020e | 1931 | } |
4f1f88a6 | 1932 | |
7df773f2 | 1933 | if (create_streams_for_trace(ctf_fs->trace.get())) { |
f340a3e8 | 1934 | return nullptr; |
4164020e | 1935 | } |
f280892e | 1936 | |
7df773f2 | 1937 | if (create_ports_for_trace(ctf_fs.get(), ctf_fs->trace.get(), self_comp_src)) { |
f340a3e8 | 1938 | return nullptr; |
4164020e | 1939 | } |
4f1f88a6 | 1940 | |
4164020e | 1941 | return ctf_fs; |
56a1cced JG |
1942 | } |
1943 | ||
50b9f4b5 SM |
1944 | bt_component_class_initialize_method_status ctf_fs_init(bt_self_component_source *self_comp_src, |
1945 | bt_self_component_source_configuration *, | |
1946 | const bt_value *params, void *) | |
ea0b4b9e | 1947 | { |
1e690349 | 1948 | try { |
1e690349 SM |
1949 | bt_component_class_initialize_method_status ret = |
1950 | BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK; | |
1951 | ||
f340a3e8 | 1952 | ctf_fs_component::UP ctf_fs = ctf_fs_create(params, self_comp_src); |
1e690349 SM |
1953 | if (!ctf_fs) { |
1954 | ret = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR; | |
1955 | } | |
ea0b4b9e | 1956 | |
f340a3e8 SM |
1957 | bt_self_component_set_data(bt_self_component_source_as_self_component(self_comp_src), |
1958 | ctf_fs.release()); | |
1e690349 SM |
1959 | return ret; |
1960 | } catch (const std::bad_alloc&) { | |
1961 | return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; | |
1962 | } catch (const bt2::Error&) { | |
1963 | return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR; | |
4164020e | 1964 | } |
ea0b4b9e | 1965 | } |
33f93973 | 1966 | |
0f5c5d5c | 1967 | bt_component_class_query_method_status ctf_fs_query(bt_self_component_class_source *comp_class_src, |
4164020e SM |
1968 | bt_private_query_executor *priv_query_exec, |
1969 | const char *object, const bt_value *params, | |
1970 | __attribute__((unused)) void *method_data, | |
1971 | const bt_value **result) | |
33f93973 | 1972 | { |
1e690349 | 1973 | try { |
1e690349 SM |
1974 | bt2c::Logger logger {bt2::SelfComponentClass {comp_class_src}, |
1975 | bt2::PrivateQueryExecutor {priv_query_exec}, | |
1976 | "PLUGIN/SRC.CTF.FS/QUERY"}; | |
c02af779 SM |
1977 | bt2::ConstMapValue paramsObj(params); |
1978 | bt2::Value::Shared resultObj; | |
1e690349 SM |
1979 | |
1980 | if (strcmp(object, "metadata-info") == 0) { | |
c02af779 | 1981 | resultObj = metadata_info_query(paramsObj, logger); |
1e690349 | 1982 | } else if (strcmp(object, "babeltrace.trace-infos") == 0) { |
c02af779 | 1983 | resultObj = trace_infos_query(paramsObj, logger); |
1e690349 | 1984 | } else if (!strcmp(object, "babeltrace.support-info")) { |
c02af779 | 1985 | resultObj = support_info_query(paramsObj, logger); |
1e690349 SM |
1986 | } else { |
1987 | BT_CPPLOGE_SPEC(logger, "Unknown query object `{}`", object); | |
c02af779 | 1988 | return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT; |
1e690349 | 1989 | } |
c02af779 SM |
1990 | |
1991 | *result = resultObj.release().libObjPtr(); | |
1992 | ||
1993 | return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK; | |
1e690349 SM |
1994 | } catch (const std::bad_alloc&) { |
1995 | return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR; | |
1996 | } catch (const bt2::Error&) { | |
1997 | return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR; | |
1998 | } | |
33f93973 | 1999 | } |