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