Commit | Line | Data |
---|---|---|
04c0ba87 | 1 | /* |
0235b0db | 2 | * SPDX-License-Identifier: MIT |
04c0ba87 JG |
3 | * |
4 | * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
5 | * | |
0235b0db | 6 | * Babeltrace CTF file system Reader Component queries |
04c0ba87 JG |
7 | */ |
8 | ||
c802cacb SM |
9 | #include <glib.h> |
10 | #include <glib/gstdio.h> | |
c802cacb SM |
11 | #include <sys/types.h> |
12 | ||
13 | #include <babeltrace2/babeltrace.h> | |
14 | ||
71436ae4 | 15 | #define BT_LOG_OUTPUT_LEVEL ((enum bt_log_level) log_level) |
4164020e | 16 | #define BT_LOG_TAG "PLUGIN/SRC.CTF.FS/QUERY" |
c802cacb | 17 | #include "logging/comp-logging.h" |
98903a3e PP |
18 | #include "logging/log.h" |
19 | ||
578e048b | 20 | #include "common/assert.h" |
c802cacb SM |
21 | |
22 | #include "../common/metadata/decoder.hpp" | |
087cd0f5 | 23 | #include "fs.hpp" |
c802cacb SM |
24 | #include "metadata.hpp" |
25 | #include "query.hpp" | |
55314f2a | 26 | |
4164020e | 27 | #define METADATA_TEXT_SIG "/* CTF 1.8" |
04c0ba87 | 28 | |
4164020e SM |
29 | struct range |
30 | { | |
31 | int64_t begin_ns = 0; | |
32 | int64_t end_ns = 0; | |
33 | bool set = false; | |
97ade20b JG |
34 | }; |
35 | ||
4164020e SM |
36 | bt_component_class_query_method_status |
37 | metadata_info_query(bt_self_component_class_source *self_comp_class_src, const bt_value *params, | |
38 | bt_logging_level log_level, const bt_value **user_result) | |
04c0ba87 | 39 | { |
4164020e SM |
40 | bt_component_class_query_method_status status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK; |
41 | bt_self_component_class *self_comp_class = | |
42 | bt_self_component_class_source_as_self_component_class(self_comp_class_src); | |
43 | bt_value *result = NULL; | |
44 | const bt_value *path_value = NULL; | |
45 | FILE *metadata_fp = NULL; | |
46 | int ret; | |
47 | int bo; | |
48 | const char *path; | |
49 | bool is_packetized; | |
50 | struct ctf_metadata_decoder *decoder = NULL; | |
51 | ctf_metadata_decoder_config decoder_cfg {}; | |
52 | enum ctf_metadata_decoder_status decoder_status; | |
c719eabb FD |
53 | GString *g_metadata_text = NULL; |
54 | const char *plaintext; | |
4164020e SM |
55 | |
56 | result = bt_value_map_create(); | |
57 | if (!result) { | |
58 | status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR; | |
59 | goto error; | |
60 | } | |
61 | ||
62 | BT_ASSERT(params); | |
63 | ||
64 | if (!bt_value_is_map(params)) { | |
65 | BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, | |
66 | "Query parameters is not a map value object."); | |
67 | status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR; | |
68 | goto error; | |
69 | } | |
70 | ||
71 | path_value = bt_value_map_borrow_entry_value_const(params, "path"); | |
72 | if (!path_value) { | |
73 | BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, "Mandatory `path` parameter missing"); | |
74 | status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR; | |
75 | goto error; | |
76 | } | |
77 | ||
78 | if (!bt_value_is_string(path_value)) { | |
79 | BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, | |
80 | "`path` parameter is required to be a string value"); | |
81 | status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR; | |
82 | goto error; | |
83 | } | |
84 | ||
85 | path = bt_value_string_get(path_value); | |
86 | ||
87 | BT_ASSERT(path); | |
0ac40cd4 | 88 | metadata_fp = ctf_fs_metadata_open_file(path, log_level, self_comp_class); |
4164020e SM |
89 | if (!metadata_fp) { |
90 | BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, "Cannot open trace metadata: path=\"%s\".", | |
91 | path); | |
92 | goto error; | |
93 | } | |
94 | ||
95 | ret = ctf_metadata_decoder_is_packetized(metadata_fp, &is_packetized, &bo, log_level, NULL); | |
96 | if (ret) { | |
97 | BT_COMP_CLASS_LOGE_APPEND_CAUSE( | |
98 | self_comp_class, | |
99 | "Cannot check whether or not the metadata stream is packetized: path=\"%s\".", path); | |
100 | goto error; | |
101 | } | |
102 | ||
103 | decoder_cfg.log_level = log_level; | |
104 | decoder_cfg.self_comp_class = self_comp_class; | |
105 | decoder_cfg.keep_plain_text = true; | |
106 | decoder = ctf_metadata_decoder_create(&decoder_cfg); | |
107 | if (!decoder) { | |
108 | BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, | |
109 | "Cannot create metadata decoder: path=\"%s\".", path); | |
110 | goto error; | |
111 | } | |
112 | ||
113 | rewind(metadata_fp); | |
114 | decoder_status = ctf_metadata_decoder_append_content(decoder, metadata_fp); | |
115 | if (decoder_status) { | |
116 | BT_COMP_CLASS_LOGE_APPEND_CAUSE( | |
117 | self_comp_class, "Cannot update metadata decoder's content: path=\"%s\".", path); | |
118 | goto error; | |
119 | } | |
120 | ||
c719eabb FD |
121 | plaintext = ctf_metadata_decoder_get_text(decoder); |
122 | g_metadata_text = g_string_new(NULL); | |
123 | ||
124 | if (!g_metadata_text) { | |
125 | goto error; | |
126 | } | |
127 | ||
128 | if (strncmp(plaintext, METADATA_TEXT_SIG, sizeof(METADATA_TEXT_SIG) - 1) != 0) { | |
129 | g_string_assign(g_metadata_text, METADATA_TEXT_SIG); | |
130 | g_string_append(g_metadata_text, " */\n\n"); | |
131 | } | |
132 | ||
133 | g_string_append(g_metadata_text, plaintext); | |
134 | ||
135 | ret = bt_value_map_insert_string_entry(result, "text", g_metadata_text->str); | |
4164020e SM |
136 | if (ret) { |
137 | BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, | |
138 | "Cannot insert metadata text into query result."); | |
139 | goto error; | |
140 | } | |
141 | ||
142 | ret = bt_value_map_insert_bool_entry(result, "is-packetized", is_packetized); | |
143 | if (ret) { | |
144 | BT_COMP_CLASS_LOGE_APPEND_CAUSE( | |
145 | self_comp_class, "Cannot insert \"is-packetized\" attribute into query result."); | |
146 | goto error; | |
147 | } | |
148 | ||
149 | goto end; | |
04c0ba87 JG |
150 | |
151 | error: | |
4164020e SM |
152 | BT_VALUE_PUT_REF_AND_RESET(result); |
153 | result = NULL; | |
c7eee084 | 154 | |
4164020e SM |
155 | if (status >= 0) { |
156 | status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR; | |
157 | } | |
04c0ba87 JG |
158 | |
159 | end: | |
c719eabb FD |
160 | if (g_metadata_text) { |
161 | g_string_free(g_metadata_text, TRUE); | |
162 | } | |
4164020e SM |
163 | ctf_metadata_decoder_destroy(decoder); |
164 | ||
165 | if (metadata_fp) { | |
166 | ret = fclose(metadata_fp); | |
167 | if (ret) { | |
e7401568 | 168 | BT_LOGE_ERRNO("Cannot close metadata file stream", ": path=\"%s\"", path); |
4164020e SM |
169 | } |
170 | } | |
171 | ||
172 | *user_result = result; | |
173 | return status; | |
97ade20b | 174 | } |
9ec238a8 | 175 | |
4164020e | 176 | static int add_range(bt_value *info, struct range *range, const char *range_name) |
97ade20b | 177 | { |
4164020e SM |
178 | int ret = 0; |
179 | bt_value_map_insert_entry_status status; | |
180 | bt_value *range_map; | |
181 | ||
182 | if (!range->set) { | |
183 | /* Not an error. */ | |
184 | goto end; | |
185 | } | |
186 | ||
187 | status = bt_value_map_insert_empty_map_entry(info, range_name, &range_map); | |
188 | if (status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) { | |
189 | ret = -1; | |
190 | goto end; | |
191 | } | |
192 | ||
193 | status = bt_value_map_insert_signed_integer_entry(range_map, "begin", range->begin_ns); | |
194 | if (status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) { | |
195 | ret = -1; | |
196 | goto end; | |
197 | } | |
198 | ||
199 | status = bt_value_map_insert_signed_integer_entry(range_map, "end", range->end_ns); | |
200 | if (status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) { | |
201 | ret = -1; | |
202 | goto end; | |
203 | } | |
97ade20b | 204 | |
97ade20b | 205 | end: |
4164020e | 206 | return ret; |
97ade20b JG |
207 | } |
208 | ||
4164020e SM |
209 | static int populate_stream_info(struct ctf_fs_ds_file_group *group, bt_value *group_info, |
210 | struct range *stream_range) | |
97ade20b | 211 | { |
4164020e SM |
212 | int ret = 0; |
213 | bt_value_map_insert_entry_status insert_status; | |
214 | struct ctf_fs_ds_index_entry *first_ds_index_entry, *last_ds_index_entry; | |
215 | gchar *port_name = NULL; | |
216 | ||
217 | /* | |
218 | * Since each `struct ctf_fs_ds_file_group` has a sorted array of | |
219 | * `struct ctf_fs_ds_index_entry`, we can compute the stream range from | |
220 | * the timestamp_begin of the first index entry and the timestamp_end | |
221 | * of the last index entry. | |
222 | */ | |
223 | BT_ASSERT(group->index); | |
224 | BT_ASSERT(group->index->entries); | |
225 | BT_ASSERT(group->index->entries->len > 0); | |
226 | ||
227 | /* First entry. */ | |
228 | first_ds_index_entry = | |
229 | (struct ctf_fs_ds_index_entry *) g_ptr_array_index(group->index->entries, 0); | |
230 | ||
231 | /* Last entry. */ | |
232 | last_ds_index_entry = (struct ctf_fs_ds_index_entry *) g_ptr_array_index( | |
233 | group->index->entries, group->index->entries->len - 1); | |
234 | ||
235 | stream_range->begin_ns = first_ds_index_entry->timestamp_begin_ns; | |
236 | stream_range->end_ns = last_ds_index_entry->timestamp_end_ns; | |
237 | ||
238 | /* | |
239 | * If any of the begin and end timestamps is not set it means that | |
240 | * packets don't include `timestamp_begin` _and_ `timestamp_end` fields | |
241 | * in their packet context so we can't set the range. | |
242 | */ | |
243 | stream_range->set = | |
244 | stream_range->begin_ns != UINT64_C(-1) && stream_range->end_ns != UINT64_C(-1); | |
245 | ||
246 | ret = add_range(group_info, stream_range, "range-ns"); | |
247 | if (ret) { | |
248 | goto end; | |
249 | } | |
250 | ||
251 | port_name = ctf_fs_make_port_name(group); | |
252 | if (!port_name) { | |
253 | ret = -1; | |
254 | goto end; | |
255 | } | |
256 | ||
257 | insert_status = bt_value_map_insert_string_entry(group_info, "port-name", port_name); | |
258 | if (insert_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) { | |
259 | ret = -1; | |
260 | goto end; | |
261 | } | |
a38d7650 | 262 | |
97ade20b | 263 | end: |
4164020e SM |
264 | g_free(port_name); |
265 | return ret; | |
97ade20b JG |
266 | } |
267 | ||
4164020e SM |
268 | static int populate_trace_info(const struct ctf_fs_trace *trace, bt_value *trace_info, |
269 | bt_logging_level log_level, bt_self_component_class *self_comp_class) | |
97ade20b | 270 | { |
4164020e SM |
271 | int ret = 0; |
272 | size_t group_idx; | |
273 | bt_value_map_insert_entry_status insert_status; | |
274 | bt_value_array_append_element_status append_status; | |
275 | bt_value *file_groups = NULL; | |
276 | ||
277 | BT_ASSERT(trace->ds_file_groups); | |
278 | /* Add trace range info only if it contains streams. */ | |
279 | if (trace->ds_file_groups->len == 0) { | |
280 | ret = -1; | |
281 | BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, "Trace has no streams: trace-path=%s", | |
282 | trace->path->str); | |
283 | goto end; | |
284 | } | |
285 | ||
286 | insert_status = bt_value_map_insert_empty_array_entry(trace_info, "stream-infos", &file_groups); | |
287 | if (insert_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) { | |
288 | ret = -1; | |
289 | goto end; | |
290 | } | |
291 | ||
292 | /* Find range of all stream groups, and of the trace. */ | |
293 | for (group_idx = 0; group_idx < trace->ds_file_groups->len; group_idx++) { | |
294 | bt_value *group_info; | |
295 | range group_range; | |
296 | ctf_fs_ds_file_group *group = | |
297 | (ctf_fs_ds_file_group *) g_ptr_array_index(trace->ds_file_groups, group_idx); | |
298 | ||
299 | append_status = bt_value_array_append_empty_map_element(file_groups, &group_info); | |
300 | if (append_status != BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK) { | |
301 | ret = -1; | |
302 | goto end; | |
303 | } | |
304 | ||
305 | ret = populate_stream_info(group, group_info, &group_range); | |
306 | if (ret) { | |
307 | goto end; | |
308 | } | |
309 | } | |
97ade20b | 310 | |
97ade20b | 311 | end: |
4164020e | 312 | return ret; |
97ade20b JG |
313 | } |
314 | ||
4164020e SM |
315 | bt_component_class_query_method_status |
316 | trace_infos_query(bt_self_component_class_source *self_comp_class_src, const bt_value *params, | |
317 | bt_logging_level log_level, const bt_value **user_result) | |
97ade20b | 318 | { |
4164020e SM |
319 | struct ctf_fs_component *ctf_fs = NULL; |
320 | bt_component_class_query_method_status status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK; | |
321 | bt_self_component_class *self_comp_class = | |
322 | bt_self_component_class_source_as_self_component_class(self_comp_class_src); | |
323 | bt_value *result = NULL; | |
324 | const bt_value *inputs_value = NULL; | |
325 | const bt_value *trace_name_value; | |
326 | int ret = 0; | |
327 | bt_value *trace_info = NULL; | |
328 | bt_value_array_append_element_status append_status; | |
329 | ||
330 | BT_ASSERT(params); | |
331 | ||
332 | if (!bt_value_is_map(params)) { | |
333 | BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, | |
334 | "Query parameters is not a map value object."); | |
335 | status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR; | |
336 | goto error; | |
337 | } | |
338 | ||
50b9f4b5 | 339 | ctf_fs = ctf_fs_component_create(log_level); |
4164020e SM |
340 | if (!ctf_fs) { |
341 | goto error; | |
342 | } | |
343 | ||
344 | if (!read_src_fs_parameters(params, &inputs_value, &trace_name_value, ctf_fs, NULL, | |
345 | self_comp_class)) { | |
346 | status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR; | |
347 | goto error; | |
348 | } | |
349 | ||
350 | if (ctf_fs_component_create_ctf_fs_trace(ctf_fs, inputs_value, trace_name_value, NULL, | |
351 | self_comp_class)) { | |
352 | goto error; | |
353 | } | |
354 | ||
355 | result = bt_value_array_create(); | |
356 | if (!result) { | |
357 | status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR; | |
358 | goto error; | |
359 | } | |
360 | ||
361 | append_status = bt_value_array_append_empty_map_element(result, &trace_info); | |
362 | if (append_status != BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK) { | |
363 | BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, "Failed to create trace info map."); | |
364 | goto error; | |
365 | } | |
366 | ||
367 | ret = populate_trace_info(ctf_fs->trace, trace_info, log_level, self_comp_class); | |
368 | if (ret) { | |
369 | goto error; | |
370 | } | |
371 | ||
372 | goto end; | |
97ade20b JG |
373 | |
374 | error: | |
4164020e | 375 | BT_VALUE_PUT_REF_AND_RESET(result); |
c7eee084 | 376 | |
4164020e SM |
377 | if (status >= 0) { |
378 | status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR; | |
379 | } | |
c7eee084 | 380 | |
97ade20b | 381 | end: |
4164020e SM |
382 | if (ctf_fs) { |
383 | ctf_fs_destroy(ctf_fs); | |
384 | ctf_fs = NULL; | |
385 | } | |
d94d92ac | 386 | |
4164020e SM |
387 | *user_result = result; |
388 | return status; | |
04c0ba87 | 389 | } |
73760435 | 390 | |
4164020e SM |
391 | bt_component_class_query_method_status |
392 | support_info_query(bt_self_component_class_source *comp_class, const bt_value *params, | |
393 | bt_logging_level log_level, const bt_value **user_result) | |
73760435 | 394 | { |
4164020e SM |
395 | const bt_value *input_type_value; |
396 | const char *input_type; | |
397 | bt_component_class_query_method_status status; | |
398 | bt_value_map_insert_entry_status insert_entry_status; | |
399 | double weight = 0; | |
400 | gchar *metadata_path = NULL; | |
401 | bt_value *result = NULL; | |
402 | struct ctf_metadata_decoder *metadata_decoder = NULL; | |
403 | FILE *metadata_file = NULL; | |
404 | char uuid_str[BT_UUID_STR_LEN + 1]; | |
405 | bool has_uuid = false; | |
406 | const bt_value *input_value; | |
407 | const char *input; | |
408 | ||
409 | input_type_value = bt_value_map_borrow_entry_value_const(params, "type"); | |
410 | BT_ASSERT(input_type_value); | |
411 | BT_ASSERT(bt_value_get_type(input_type_value) == BT_VALUE_TYPE_STRING); | |
412 | input_type = bt_value_string_get(input_type_value); | |
413 | ||
414 | if (strcmp(input_type, "directory") != 0) { | |
415 | goto create_result; | |
416 | } | |
417 | ||
418 | input_value = bt_value_map_borrow_entry_value_const(params, "input"); | |
419 | BT_ASSERT(input_value); | |
420 | BT_ASSERT(bt_value_get_type(input_value) == BT_VALUE_TYPE_STRING); | |
421 | input = bt_value_string_get(input_value); | |
422 | ||
423 | metadata_path = g_build_filename(input, CTF_FS_METADATA_FILENAME, NULL); | |
424 | if (!metadata_path) { | |
425 | status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR; | |
426 | goto end; | |
427 | } | |
428 | ||
429 | metadata_file = g_fopen(metadata_path, "rb"); | |
430 | if (metadata_file) { | |
431 | ctf_metadata_decoder_config metadata_decoder_config {}; | |
432 | enum ctf_metadata_decoder_status decoder_status; | |
433 | bt_uuid_t uuid; | |
434 | ||
435 | metadata_decoder_config.log_level = log_level; | |
436 | metadata_decoder_config.self_comp_class = | |
437 | bt_self_component_class_source_as_self_component_class(comp_class); | |
438 | ||
439 | metadata_decoder = ctf_metadata_decoder_create(&metadata_decoder_config); | |
440 | if (!metadata_decoder) { | |
441 | status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR; | |
442 | goto end; | |
443 | } | |
444 | ||
445 | decoder_status = ctf_metadata_decoder_append_content(metadata_decoder, metadata_file); | |
446 | if (decoder_status != CTF_METADATA_DECODER_STATUS_OK) { | |
447 | BT_LOGW("cannot append metadata content: metadata-decoder-status=%d", decoder_status); | |
448 | status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR; | |
449 | goto end; | |
450 | } | |
451 | ||
452 | /* | |
453 | * We were able to parse the metadata file, so we are | |
454 | * confident it's a CTF trace. | |
455 | */ | |
456 | weight = 0.75; | |
457 | ||
458 | /* If the trace has a UUID, return the stringified UUID as the group. */ | |
459 | if (ctf_metadata_decoder_get_trace_class_uuid(metadata_decoder, uuid) == 0) { | |
460 | bt_uuid_to_str(uuid, uuid_str); | |
461 | has_uuid = true; | |
462 | } | |
463 | } | |
73760435 | 464 | |
493917ba | 465 | create_result: |
4164020e SM |
466 | result = bt_value_map_create(); |
467 | if (!result) { | |
468 | status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR; | |
469 | goto end; | |
470 | } | |
471 | ||
472 | insert_entry_status = bt_value_map_insert_real_entry(result, "weight", weight); | |
473 | if (insert_entry_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) { | |
474 | status = (bt_component_class_query_method_status) insert_entry_status; | |
475 | goto end; | |
476 | } | |
477 | ||
478 | /* We are not supposed to have weight == 0 and a UUID. */ | |
479 | BT_ASSERT(weight > 0 || !has_uuid); | |
480 | ||
481 | if (weight > 0 && has_uuid) { | |
482 | insert_entry_status = bt_value_map_insert_string_entry(result, "group", uuid_str); | |
483 | if (insert_entry_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) { | |
484 | status = (bt_component_class_query_method_status) insert_entry_status; | |
485 | goto end; | |
486 | } | |
487 | } | |
488 | ||
489 | *user_result = result; | |
490 | result = NULL; | |
491 | status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK; | |
73760435 SM |
492 | |
493 | end: | |
4164020e SM |
494 | g_free(metadata_path); |
495 | bt_value_put_ref(result); | |
496 | ctf_metadata_decoder_destroy(metadata_decoder); | |
73760435 | 497 | |
4164020e | 498 | return status; |
73760435 | 499 | } |