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