Commit | Line | Data |
---|---|---|
04c0ba87 JG |
1 | /* |
2 | * query.c | |
3 | * | |
4 | * Babeltrace CTF file system Reader Component queries | |
5 | * | |
6 | * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
7 | * | |
8 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
9 | * of this software and associated documentation files (the "Software"), to deal | |
10 | * in the Software without restriction, including without limitation the rights | |
11 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
12 | * copies of the Software, and to permit persons to whom the Software is | |
13 | * furnished to do so, subject to the following conditions: | |
14 | * | |
15 | * The above copyright notice and this permission notice shall be included in | |
16 | * all copies or substantial portions of the Software. | |
17 | * | |
18 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
19 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
20 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
21 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
22 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
23 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
24 | * SOFTWARE. | |
25 | */ | |
26 | ||
27 | #include "query.h" | |
28 | #include <stdbool.h> | |
29 | #include <assert.h> | |
30 | #include "metadata.h" | |
31 | #include "../common/metadata/decoder.h" | |
55314f2a | 32 | #include <babeltrace/common-internal.h> |
97ade20b | 33 | #include <babeltrace/babeltrace-internal.h> |
9d408fca | 34 | #include <babeltrace/babeltrace.h> |
97ade20b | 35 | #include "fs.h" |
55314f2a JG |
36 | |
37 | #define BT_LOG_TAG "PLUGIN-CTF-FS-QUERY-SRC" | |
38 | #include "logging.h" | |
04c0ba87 JG |
39 | |
40 | #define METADATA_TEXT_SIG "/* CTF 1.8" | |
41 | ||
97ade20b JG |
42 | struct range { |
43 | int64_t begin_ns; | |
44 | int64_t end_ns; | |
45 | bool set; | |
46 | }; | |
47 | ||
04c0ba87 | 48 | BT_HIDDEN |
90157d89 | 49 | struct bt_component_class_query_method_return metadata_info_query( |
c7eee084 | 50 | struct bt_component_class *comp_class, |
04c0ba87 JG |
51 | struct bt_value *params) |
52 | { | |
90157d89 | 53 | struct bt_component_class_query_method_return query_ret = { |
c7eee084 PP |
54 | .result = NULL, |
55 | .status = BT_QUERY_STATUS_OK, | |
56 | }; | |
57 | ||
04c0ba87 JG |
58 | struct bt_value *path_value = NULL; |
59 | char *metadata_text = NULL; | |
60 | FILE *metadata_fp = NULL; | |
61 | GString *g_metadata_text = NULL; | |
62 | int ret; | |
63 | int bo; | |
64 | const char *path; | |
65 | bool is_packetized; | |
66 | ||
c7eee084 PP |
67 | query_ret.result = bt_value_map_create(); |
68 | if (!query_ret.result) { | |
69 | query_ret.status = BT_QUERY_STATUS_NOMEM; | |
04c0ba87 JG |
70 | goto error; |
71 | } | |
72 | ||
73 | if (!bt_value_is_map(params)) { | |
f7d0e29c | 74 | BT_LOGE_STR("Query parameters is not a map value object."); |
c7eee084 | 75 | query_ret.status = BT_QUERY_STATUS_INVALID_PARAMS; |
04c0ba87 JG |
76 | goto error; |
77 | } | |
78 | ||
79 | path_value = bt_value_map_get(params, "path"); | |
80 | ret = bt_value_string_get(path_value, &path); | |
81 | if (ret) { | |
f7d0e29c | 82 | BT_LOGE_STR("Cannot get `path` string parameter."); |
c7eee084 | 83 | query_ret.status = BT_QUERY_STATUS_INVALID_PARAMS; |
04c0ba87 JG |
84 | goto error; |
85 | } | |
86 | ||
87 | assert(path); | |
88 | metadata_fp = ctf_fs_metadata_open_file(path); | |
89 | if (!metadata_fp) { | |
f7d0e29c | 90 | BT_LOGE("Cannot open trace metadata: path=\"%s\".", path); |
04c0ba87 JG |
91 | goto error; |
92 | } | |
93 | ||
94 | is_packetized = ctf_metadata_decoder_is_packetized(metadata_fp, | |
95 | &bo); | |
96 | ||
97 | if (is_packetized) { | |
98 | ret = ctf_metadata_decoder_packetized_file_stream_to_buf( | |
99 | metadata_fp, &metadata_text, bo); | |
100 | if (ret) { | |
f7d0e29c JG |
101 | BT_LOGE("Cannot decode packetized metadata file: path=\"%s\"", |
102 | path); | |
04c0ba87 JG |
103 | goto error; |
104 | } | |
105 | } else { | |
106 | long filesize; | |
107 | ||
677e1a21 MD |
108 | ret = fseek(metadata_fp, 0, SEEK_END); |
109 | if (ret) { | |
f7d0e29c JG |
110 | BT_LOGE_ERRNO("Failed to seek to the end of the metadata file", |
111 | ": path=\"%s\"", path); | |
677e1a21 MD |
112 | goto error; |
113 | } | |
04c0ba87 | 114 | filesize = ftell(metadata_fp); |
677e1a21 | 115 | if (filesize < 0) { |
f7d0e29c JG |
116 | BT_LOGE_ERRNO("Failed to get the current position in the metadata file", |
117 | ": path=\"%s\"", path); | |
677e1a21 MD |
118 | goto error; |
119 | } | |
04c0ba87 JG |
120 | rewind(metadata_fp); |
121 | metadata_text = malloc(filesize + 1); | |
122 | if (!metadata_text) { | |
f7d0e29c | 123 | BT_LOGE_STR("Cannot allocate buffer for metadata text."); |
04c0ba87 JG |
124 | goto error; |
125 | } | |
126 | ||
127 | if (fread(metadata_text, filesize, 1, metadata_fp) != 1) { | |
f7d0e29c JG |
128 | BT_LOGE_ERRNO("Cannot read metadata file", ": path=\"%s\"", |
129 | path); | |
04c0ba87 JG |
130 | goto error; |
131 | } | |
132 | ||
133 | metadata_text[filesize] = '\0'; | |
134 | } | |
135 | ||
136 | g_metadata_text = g_string_new(NULL); | |
137 | if (!g_metadata_text) { | |
138 | goto error; | |
139 | } | |
140 | ||
141 | if (strncmp(metadata_text, METADATA_TEXT_SIG, | |
142 | sizeof(METADATA_TEXT_SIG) - 1) != 0) { | |
143 | g_string_assign(g_metadata_text, METADATA_TEXT_SIG); | |
144 | g_string_append(g_metadata_text, " */\n\n"); | |
145 | } | |
146 | ||
147 | g_string_append(g_metadata_text, metadata_text); | |
148 | ||
c7eee084 | 149 | ret = bt_value_map_insert_string(query_ret.result, "text", |
04c0ba87 JG |
150 | g_metadata_text->str); |
151 | if (ret) { | |
f7d0e29c | 152 | BT_LOGE_STR("Cannot insert metadata text into query result."); |
04c0ba87 JG |
153 | goto error; |
154 | } | |
155 | ||
c7eee084 | 156 | ret = bt_value_map_insert_bool(query_ret.result, "is-packetized", |
04c0ba87 JG |
157 | is_packetized); |
158 | if (ret) { | |
f7d0e29c | 159 | BT_LOGE_STR("Cannot insert \"is-packetized\" attribute into query result."); |
04c0ba87 JG |
160 | goto error; |
161 | } | |
162 | ||
163 | goto end; | |
164 | ||
165 | error: | |
c7eee084 PP |
166 | BT_PUT(query_ret.result); |
167 | ||
168 | if (query_ret.status >= 0) { | |
169 | query_ret.status = BT_QUERY_STATUS_ERROR; | |
170 | } | |
04c0ba87 JG |
171 | |
172 | end: | |
173 | bt_put(path_value); | |
174 | free(metadata_text); | |
175 | ||
176 | if (g_metadata_text) { | |
177 | g_string_free(g_metadata_text, TRUE); | |
178 | } | |
179 | ||
180 | if (metadata_fp) { | |
181 | fclose(metadata_fp); | |
182 | } | |
c7eee084 PP |
183 | |
184 | return query_ret; | |
97ade20b | 185 | } |
9ec238a8 | 186 | |
97ade20b JG |
187 | static |
188 | int add_range(struct bt_value *info, struct range *range, | |
189 | const char *range_name) | |
190 | { | |
191 | int ret = 0; | |
192 | enum bt_value_status status; | |
193 | struct bt_value *range_map = NULL; | |
194 | ||
195 | if (!range->set) { | |
196 | /* Not an error. */ | |
197 | goto end; | |
198 | } | |
199 | ||
200 | range_map = bt_value_map_create(); | |
201 | if (!range_map) { | |
202 | ret = -1; | |
203 | goto end; | |
204 | } | |
205 | ||
206 | status = bt_value_map_insert_integer(range_map, "begin", | |
207 | range->begin_ns); | |
208 | if (status != BT_VALUE_STATUS_OK) { | |
209 | ret = -1; | |
210 | goto end; | |
211 | } | |
212 | ||
213 | status = bt_value_map_insert_integer(range_map, "end", | |
214 | range->end_ns); | |
215 | if (status != BT_VALUE_STATUS_OK) { | |
216 | ret = -1; | |
217 | goto end; | |
218 | } | |
219 | ||
220 | status = bt_value_map_insert(info, range_name, range_map); | |
221 | if (status != BT_VALUE_STATUS_OK) { | |
222 | ret = -1; | |
223 | goto end; | |
224 | } | |
225 | end: | |
226 | bt_put(range_map); | |
227 | return ret; | |
228 | } | |
229 | ||
230 | static | |
231 | int add_stream_ids(struct bt_value *info, struct bt_ctf_stream *stream) | |
232 | { | |
233 | int ret = 0; | |
234 | int64_t stream_class_id, stream_instance_id; | |
235 | enum bt_value_status status; | |
256eb8a0 | 236 | struct bt_ctf_stream_class *stream_class = NULL; |
97ade20b JG |
237 | |
238 | stream_instance_id = bt_ctf_stream_get_id(stream); | |
239 | if (stream_instance_id != -1) { | |
240 | status = bt_value_map_insert_integer(info, "id", | |
241 | stream_instance_id); | |
242 | if (status != BT_VALUE_STATUS_OK) { | |
243 | ret = -1; | |
244 | goto end; | |
245 | } | |
246 | } | |
247 | ||
248 | stream_class = bt_ctf_stream_get_class(stream); | |
249 | if (!stream_class) { | |
250 | ret = -1; | |
251 | goto end; | |
252 | } | |
253 | ||
254 | stream_class_id = bt_ctf_stream_class_get_id(stream_class); | |
255 | if (stream_class_id == -1) { | |
256 | ret = -1; | |
257 | goto end; | |
258 | } | |
259 | ||
260 | status = bt_value_map_insert_integer(info, "class-id", stream_class_id); | |
261 | if (status != BT_VALUE_STATUS_OK) { | |
262 | ret = -1; | |
263 | goto end; | |
264 | } | |
265 | end: | |
266 | bt_put(stream_class); | |
267 | return ret; | |
268 | } | |
269 | ||
270 | static | |
271 | int populate_stream_info(struct ctf_fs_ds_file_group *group, | |
272 | struct bt_value *group_info, | |
273 | struct range *stream_range) | |
274 | { | |
275 | int ret = 0; | |
276 | size_t file_idx; | |
277 | enum bt_value_status status; | |
278 | struct bt_value *file_paths; | |
279 | ||
280 | stream_range->begin_ns = INT64_MAX; | |
281 | stream_range->end_ns = 0; | |
282 | ||
283 | file_paths = bt_value_array_create(); | |
284 | if (!file_paths) { | |
285 | ret = -1; | |
286 | goto end; | |
287 | } | |
288 | ||
289 | for (file_idx = 0; file_idx < group->ds_file_infos->len; file_idx++) { | |
290 | int64_t file_begin_epoch, file_end_epoch; | |
291 | struct ctf_fs_ds_file_info *info = | |
292 | g_ptr_array_index(group->ds_file_infos, | |
293 | file_idx); | |
294 | ||
295 | if (!info->index || info->index->entries->len == 0) { | |
296 | BT_LOGW("Cannot determine range of unindexed stream file \'%s\'", | |
297 | info->path->str); | |
298 | ret = -1; | |
299 | goto end; | |
300 | } | |
301 | ||
302 | status = bt_value_array_append_string(file_paths, | |
303 | info->path->str); | |
304 | if (status != BT_VALUE_STATUS_OK) { | |
305 | ret = -1; | |
306 | goto end; | |
307 | } | |
308 | ||
309 | /* | |
310 | * file range is from timestamp_begin of the first entry to the | |
311 | * timestamp_end of the last entry. | |
312 | */ | |
313 | file_begin_epoch = ((struct ctf_fs_ds_index_entry *) &g_array_index(info->index->entries, | |
314 | struct ctf_fs_ds_index_entry, 0))->timestamp_begin_ns; | |
315 | file_end_epoch = ((struct ctf_fs_ds_index_entry *) &g_array_index(info->index->entries, | |
316 | struct ctf_fs_ds_index_entry, info->index->entries->len - 1))->timestamp_end_ns; | |
317 | ||
318 | stream_range->begin_ns = min(stream_range->begin_ns, file_begin_epoch); | |
319 | stream_range->end_ns = max(stream_range->end_ns, file_end_epoch); | |
320 | stream_range->set = true; | |
321 | } | |
322 | ||
323 | if (stream_range->set) { | |
324 | ret = add_range(group_info, stream_range, "range-ns"); | |
325 | if (ret) { | |
326 | goto end; | |
327 | } | |
328 | } | |
329 | ||
330 | status = bt_value_map_insert(group_info, "paths", file_paths); | |
331 | if (status != BT_VALUE_STATUS_OK) { | |
332 | ret = -1; | |
333 | goto end; | |
334 | } | |
335 | ||
336 | ret = add_stream_ids(group_info, group->stream); | |
337 | if (ret) { | |
338 | goto end; | |
339 | } | |
340 | end: | |
341 | bt_put(file_paths); | |
342 | return ret; | |
343 | } | |
344 | ||
345 | static | |
346 | int populate_trace_info(const char *trace_path, const char *trace_name, | |
347 | struct bt_value *trace_info) | |
348 | { | |
349 | int ret = 0; | |
350 | size_t group_idx; | |
351 | struct ctf_fs_trace *trace = NULL; | |
352 | enum bt_value_status status; | |
353 | struct bt_value *file_groups; | |
354 | struct range trace_range = { | |
355 | .begin_ns = INT64_MAX, | |
356 | .end_ns = 0, | |
357 | .set = false, | |
358 | }; | |
359 | struct range trace_intersection = { | |
360 | .begin_ns = 0, | |
361 | .end_ns = INT64_MAX, | |
362 | .set = false, | |
363 | }; | |
364 | ||
365 | file_groups = bt_value_array_create(); | |
366 | if (!file_groups) { | |
367 | goto end; | |
368 | } | |
369 | ||
370 | status = bt_value_map_insert_string(trace_info, "name", | |
371 | trace_name); | |
372 | if (status != BT_VALUE_STATUS_OK) { | |
373 | ret = -1; | |
374 | goto end; | |
375 | } | |
376 | status = bt_value_map_insert_string(trace_info, "path", | |
377 | trace_path); | |
378 | if (status != BT_VALUE_STATUS_OK) { | |
379 | ret = -1; | |
380 | goto end; | |
381 | } | |
382 | ||
383 | trace = ctf_fs_trace_create(trace_path, trace_name, NULL); | |
384 | if (!trace) { | |
385 | BT_LOGE("Failed to create fs trace at \'%s\'", trace_path); | |
386 | ret = -1; | |
387 | goto end; | |
388 | } | |
389 | ||
390 | assert(trace->ds_file_groups); | |
391 | /* Add trace range info only if it contains streams. */ | |
392 | if (trace->ds_file_groups->len == 0) { | |
393 | ret = -1; | |
394 | goto end; | |
395 | } | |
396 | ||
397 | /* Find range of all stream groups, and of the trace. */ | |
398 | for (group_idx = 0; group_idx < trace->ds_file_groups->len; | |
399 | group_idx++) { | |
400 | struct bt_value *group_info; | |
401 | struct range group_range = { .set = false }; | |
402 | struct ctf_fs_ds_file_group *group = g_ptr_array_index( | |
403 | trace->ds_file_groups, group_idx); | |
404 | ||
405 | group_info = bt_value_map_create(); | |
406 | if (!group_info) { | |
407 | ret = -1; | |
408 | goto end; | |
409 | } | |
410 | ||
411 | ret = populate_stream_info(group, group_info, &group_range); | |
412 | if (ret) { | |
413 | bt_put(group_info); | |
414 | goto end; | |
415 | } | |
416 | ||
417 | if (group_range.set) { | |
418 | trace_range.begin_ns = min(trace_range.begin_ns, | |
419 | group_range.begin_ns); | |
420 | trace_range.end_ns = max(trace_range.end_ns, | |
421 | group_range.end_ns); | |
422 | trace_range.set = true; | |
423 | ||
424 | trace_intersection.begin_ns = max(trace_intersection.begin_ns, | |
425 | group_range.begin_ns); | |
426 | trace_intersection.end_ns = min(trace_intersection.end_ns, | |
427 | group_range.end_ns); | |
428 | trace_intersection.set = true; | |
429 | status = bt_value_array_append(file_groups, group_info); | |
430 | bt_put(group_info); | |
431 | if (status != BT_VALUE_STATUS_OK) { | |
432 | goto end; | |
433 | } | |
434 | } | |
435 | } | |
436 | ||
437 | ret = add_range(trace_info, &trace_range, "range-ns"); | |
438 | if (ret) { | |
439 | goto end; | |
440 | } | |
441 | ret = add_range(trace_info, &trace_intersection, | |
442 | "intersection-range-ns"); | |
443 | if (ret) { | |
444 | goto end; | |
445 | } | |
446 | ||
447 | status = bt_value_map_insert(trace_info, "streams", file_groups); | |
448 | BT_PUT(file_groups); | |
449 | if (status != BT_VALUE_STATUS_OK) { | |
450 | ret = -1; | |
451 | goto end; | |
452 | } | |
453 | ||
454 | end: | |
455 | bt_put(file_groups); | |
456 | ctf_fs_trace_destroy(trace); | |
457 | return ret; | |
458 | } | |
459 | ||
460 | BT_HIDDEN | |
90157d89 | 461 | struct bt_component_class_query_method_return trace_info_query( |
c7eee084 | 462 | struct bt_component_class *comp_class, |
97ade20b JG |
463 | struct bt_value *params) |
464 | { | |
90157d89 | 465 | struct bt_component_class_query_method_return query_ret = { |
c7eee084 PP |
466 | .result = NULL, |
467 | .status = BT_QUERY_STATUS_OK, | |
468 | }; | |
469 | ||
97ade20b JG |
470 | struct bt_value *path_value = NULL; |
471 | int ret = 0; | |
472 | const char *path = NULL; | |
473 | GList *trace_paths = NULL; | |
474 | GList *trace_names = NULL; | |
475 | GList *tp_node = NULL; | |
476 | GList *tn_node = NULL; | |
477 | GString *normalized_path = NULL; | |
478 | ||
479 | if (!bt_value_is_map(params)) { | |
480 | BT_LOGE("Query parameters is not a map value object."); | |
c7eee084 | 481 | query_ret.status = BT_QUERY_STATUS_INVALID_PARAMS; |
97ade20b JG |
482 | goto error; |
483 | } | |
484 | ||
485 | path_value = bt_value_map_get(params, "path"); | |
486 | ret = bt_value_string_get(path_value, &path); | |
487 | if (ret) { | |
488 | BT_LOGE("Cannot get `path` string parameter."); | |
c7eee084 | 489 | query_ret.status = BT_QUERY_STATUS_INVALID_PARAMS; |
97ade20b JG |
490 | goto error; |
491 | } | |
492 | ||
493 | normalized_path = bt_common_normalize_path(path, NULL); | |
494 | if (!normalized_path) { | |
495 | BT_LOGE("Failed to normalize path: `%s`.", path); | |
496 | goto error; | |
497 | } | |
498 | assert(path); | |
499 | ||
500 | ret = ctf_fs_find_traces(&trace_paths, normalized_path->str); | |
501 | if (ret) { | |
502 | goto error; | |
503 | } | |
504 | ||
505 | trace_names = ctf_fs_create_trace_names(trace_paths, | |
506 | normalized_path->str); | |
507 | if (!trace_names) { | |
508 | BT_LOGE("Cannot create trace names from trace paths."); | |
509 | goto error; | |
510 | } | |
511 | ||
c7eee084 PP |
512 | query_ret.result = bt_value_array_create(); |
513 | if (!query_ret.result) { | |
514 | query_ret.status = BT_QUERY_STATUS_NOMEM; | |
97ade20b JG |
515 | goto error; |
516 | } | |
517 | ||
518 | /* Iterates over both trace paths and names simultaneously. */ | |
519 | for (tp_node = trace_paths, tn_node = trace_names; tp_node; | |
520 | tp_node = g_list_next(tp_node), | |
521 | tn_node = g_list_next(tn_node)) { | |
522 | GString *trace_path = tp_node->data; | |
523 | GString *trace_name = tn_node->data; | |
524 | enum bt_value_status status; | |
525 | struct bt_value *trace_info; | |
526 | ||
527 | trace_info = bt_value_map_create(); | |
528 | if (!trace_info) { | |
529 | BT_LOGE("Failed to create trace info map."); | |
530 | goto error; | |
531 | } | |
532 | ||
533 | ret = populate_trace_info(trace_path->str, trace_name->str, | |
534 | trace_info); | |
535 | if (ret) { | |
536 | bt_put(trace_info); | |
537 | goto error; | |
538 | } | |
539 | ||
c7eee084 | 540 | status = bt_value_array_append(query_ret.result, trace_info); |
97ade20b JG |
541 | bt_put(trace_info); |
542 | if (status != BT_VALUE_STATUS_OK) { | |
543 | goto error; | |
544 | } | |
545 | } | |
546 | ||
547 | goto end; | |
548 | ||
549 | error: | |
c7eee084 PP |
550 | BT_PUT(query_ret.result); |
551 | ||
552 | if (query_ret.status >= 0) { | |
553 | query_ret.status = BT_QUERY_STATUS_ERROR; | |
554 | } | |
555 | ||
97ade20b JG |
556 | end: |
557 | if (normalized_path) { | |
558 | g_string_free(normalized_path, TRUE); | |
559 | } | |
560 | if (trace_paths) { | |
561 | for (tp_node = trace_paths; tp_node; tp_node = g_list_next(tp_node)) { | |
562 | if (tp_node->data) { | |
563 | g_string_free(tp_node->data, TRUE); | |
564 | } | |
565 | } | |
566 | g_list_free(trace_paths); | |
567 | } | |
568 | if (trace_names) { | |
569 | for (tn_node = trace_names; tn_node; tn_node = g_list_next(tn_node)) { | |
570 | if (tn_node->data) { | |
571 | g_string_free(tn_node->data, TRUE); | |
572 | } | |
573 | } | |
574 | g_list_free(trace_names); | |
575 | } | |
576 | /* "path" becomes invalid with the release of path_value. */ | |
577 | bt_put(path_value); | |
c7eee084 | 578 | return query_ret; |
04c0ba87 | 579 | } |