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