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