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