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 JG |
33 | #include <babeltrace/babeltrace-internal.h> |
34 | #include <babeltrace/ctf-ir/stream.h> | |
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 JG |
48 | BT_HIDDEN |
49 | struct bt_value *metadata_info_query(struct bt_component_class *comp_class, | |
50 | struct bt_value *params) | |
51 | { | |
97ade20b | 52 | struct bt_value *result = NULL; |
04c0ba87 JG |
53 | struct bt_value *path_value = NULL; |
54 | char *metadata_text = NULL; | |
55 | FILE *metadata_fp = NULL; | |
56 | GString *g_metadata_text = NULL; | |
57 | int ret; | |
58 | int bo; | |
59 | const char *path; | |
60 | bool is_packetized; | |
61 | ||
97ade20b JG |
62 | result = bt_value_map_create(); |
63 | if (!result) { | |
04c0ba87 JG |
64 | goto error; |
65 | } | |
66 | ||
67 | if (!bt_value_is_map(params)) { | |
68 | fprintf(stderr, | |
69 | "Query parameters is not a map value object\n"); | |
70 | goto error; | |
71 | } | |
72 | ||
73 | path_value = bt_value_map_get(params, "path"); | |
74 | ret = bt_value_string_get(path_value, &path); | |
75 | if (ret) { | |
76 | fprintf(stderr, | |
77 | "Cannot get `path` string parameter\n"); | |
78 | goto error; | |
79 | } | |
80 | ||
81 | assert(path); | |
82 | metadata_fp = ctf_fs_metadata_open_file(path); | |
83 | if (!metadata_fp) { | |
84 | fprintf(stderr, | |
85 | "Cannot open trace at path `%s`\n", path); | |
86 | goto error; | |
87 | } | |
88 | ||
89 | is_packetized = ctf_metadata_decoder_is_packetized(metadata_fp, | |
90 | &bo); | |
91 | ||
92 | if (is_packetized) { | |
93 | ret = ctf_metadata_decoder_packetized_file_stream_to_buf( | |
94 | metadata_fp, &metadata_text, bo); | |
95 | if (ret) { | |
96 | fprintf(stderr, | |
97 | "Cannot decode packetized metadata file\n"); | |
98 | goto error; | |
99 | } | |
100 | } else { | |
101 | long filesize; | |
102 | ||
faf8e665 MD |
103 | ret = fseek(metadata_fp, 0, SEEK_END); |
104 | if (ret) { | |
105 | fprintf(stderr, "Error in fseek: %s", strerror(errno)); | |
106 | goto error; | |
107 | } | |
04c0ba87 | 108 | filesize = ftell(metadata_fp); |
faf8e665 MD |
109 | if (filesize < 0) { |
110 | fprintf(stderr, "Error in ftell: %s", strerror(errno)); | |
111 | goto error; | |
112 | } | |
04c0ba87 JG |
113 | rewind(metadata_fp); |
114 | metadata_text = malloc(filesize + 1); | |
115 | if (!metadata_text) { | |
116 | fprintf(stderr, | |
117 | "Cannot allocate buffer for metadata text\n"); | |
118 | goto error; | |
119 | } | |
120 | ||
121 | if (fread(metadata_text, filesize, 1, metadata_fp) != 1) { | |
122 | fprintf(stderr, | |
123 | "Cannot read metadata file\n"); | |
124 | goto error; | |
125 | } | |
126 | ||
127 | metadata_text[filesize] = '\0'; | |
128 | } | |
129 | ||
130 | g_metadata_text = g_string_new(NULL); | |
131 | if (!g_metadata_text) { | |
132 | goto error; | |
133 | } | |
134 | ||
135 | if (strncmp(metadata_text, METADATA_TEXT_SIG, | |
136 | sizeof(METADATA_TEXT_SIG) - 1) != 0) { | |
137 | g_string_assign(g_metadata_text, METADATA_TEXT_SIG); | |
138 | g_string_append(g_metadata_text, " */\n\n"); | |
139 | } | |
140 | ||
141 | g_string_append(g_metadata_text, metadata_text); | |
142 | ||
97ade20b | 143 | ret = bt_value_map_insert_string(result, "text", |
04c0ba87 JG |
144 | g_metadata_text->str); |
145 | if (ret) { | |
97ade20b | 146 | fprintf(stderr, "Cannot insert metadata text into result\n"); |
04c0ba87 JG |
147 | goto error; |
148 | } | |
149 | ||
97ade20b | 150 | ret = bt_value_map_insert_bool(result, "is-packetized", |
04c0ba87 JG |
151 | is_packetized); |
152 | if (ret) { | |
97ade20b | 153 | fprintf(stderr, "Cannot insert is packetized into result\n"); |
04c0ba87 JG |
154 | goto error; |
155 | } | |
156 | ||
157 | goto end; | |
158 | ||
159 | error: | |
97ade20b | 160 | BT_PUT(result); |
04c0ba87 JG |
161 | |
162 | end: | |
163 | bt_put(path_value); | |
164 | free(metadata_text); | |
165 | ||
166 | if (g_metadata_text) { | |
167 | g_string_free(g_metadata_text, TRUE); | |
168 | } | |
169 | ||
170 | if (metadata_fp) { | |
171 | fclose(metadata_fp); | |
172 | } | |
97ade20b JG |
173 | return result; |
174 | } | |
175 | static | |
176 | int add_range(struct bt_value *info, struct range *range, | |
177 | const char *range_name) | |
178 | { | |
179 | int ret = 0; | |
180 | enum bt_value_status status; | |
181 | struct bt_value *range_map = NULL; | |
182 | ||
183 | if (!range->set) { | |
184 | /* Not an error. */ | |
185 | goto end; | |
186 | } | |
187 | ||
188 | range_map = bt_value_map_create(); | |
189 | if (!range_map) { | |
190 | ret = -1; | |
191 | goto end; | |
192 | } | |
193 | ||
194 | status = bt_value_map_insert_integer(range_map, "begin", | |
195 | range->begin_ns); | |
196 | if (status != BT_VALUE_STATUS_OK) { | |
197 | ret = -1; | |
198 | goto end; | |
199 | } | |
200 | ||
201 | status = bt_value_map_insert_integer(range_map, "end", | |
202 | range->end_ns); | |
203 | if (status != BT_VALUE_STATUS_OK) { | |
204 | ret = -1; | |
205 | goto end; | |
206 | } | |
207 | ||
208 | status = bt_value_map_insert(info, range_name, range_map); | |
209 | if (status != BT_VALUE_STATUS_OK) { | |
210 | ret = -1; | |
211 | goto end; | |
212 | } | |
213 | end: | |
214 | bt_put(range_map); | |
215 | return ret; | |
216 | } | |
217 | ||
218 | static | |
219 | int add_stream_ids(struct bt_value *info, struct bt_ctf_stream *stream) | |
220 | { | |
221 | int ret = 0; | |
222 | int64_t stream_class_id, stream_instance_id; | |
223 | enum bt_value_status status; | |
256eb8a0 | 224 | struct bt_ctf_stream_class *stream_class = NULL; |
97ade20b JG |
225 | |
226 | stream_instance_id = bt_ctf_stream_get_id(stream); | |
227 | if (stream_instance_id != -1) { | |
228 | status = bt_value_map_insert_integer(info, "id", | |
229 | stream_instance_id); | |
230 | if (status != BT_VALUE_STATUS_OK) { | |
231 | ret = -1; | |
232 | goto end; | |
233 | } | |
234 | } | |
235 | ||
236 | stream_class = bt_ctf_stream_get_class(stream); | |
237 | if (!stream_class) { | |
238 | ret = -1; | |
239 | goto end; | |
240 | } | |
241 | ||
242 | stream_class_id = bt_ctf_stream_class_get_id(stream_class); | |
243 | if (stream_class_id == -1) { | |
244 | ret = -1; | |
245 | goto end; | |
246 | } | |
247 | ||
248 | status = bt_value_map_insert_integer(info, "class-id", stream_class_id); | |
249 | if (status != BT_VALUE_STATUS_OK) { | |
250 | ret = -1; | |
251 | goto end; | |
252 | } | |
253 | end: | |
254 | bt_put(stream_class); | |
255 | return ret; | |
256 | } | |
257 | ||
258 | static | |
259 | int populate_stream_info(struct ctf_fs_ds_file_group *group, | |
260 | struct bt_value *group_info, | |
261 | struct range *stream_range) | |
262 | { | |
263 | int ret = 0; | |
264 | size_t file_idx; | |
265 | enum bt_value_status status; | |
266 | struct bt_value *file_paths; | |
267 | ||
268 | stream_range->begin_ns = INT64_MAX; | |
269 | stream_range->end_ns = 0; | |
270 | ||
271 | file_paths = bt_value_array_create(); | |
272 | if (!file_paths) { | |
273 | ret = -1; | |
274 | goto end; | |
275 | } | |
276 | ||
277 | for (file_idx = 0; file_idx < group->ds_file_infos->len; file_idx++) { | |
278 | int64_t file_begin_epoch, file_end_epoch; | |
279 | struct ctf_fs_ds_file_info *info = | |
280 | g_ptr_array_index(group->ds_file_infos, | |
281 | file_idx); | |
282 | ||
283 | if (!info->index || info->index->entries->len == 0) { | |
284 | BT_LOGW("Cannot determine range of unindexed stream file \'%s\'", | |
285 | info->path->str); | |
286 | ret = -1; | |
287 | goto end; | |
288 | } | |
289 | ||
290 | status = bt_value_array_append_string(file_paths, | |
291 | info->path->str); | |
292 | if (status != BT_VALUE_STATUS_OK) { | |
293 | ret = -1; | |
294 | goto end; | |
295 | } | |
296 | ||
297 | /* | |
298 | * file range is from timestamp_begin of the first entry to the | |
299 | * timestamp_end of the last entry. | |
300 | */ | |
301 | file_begin_epoch = ((struct ctf_fs_ds_index_entry *) &g_array_index(info->index->entries, | |
302 | struct ctf_fs_ds_index_entry, 0))->timestamp_begin_ns; | |
303 | file_end_epoch = ((struct ctf_fs_ds_index_entry *) &g_array_index(info->index->entries, | |
304 | struct ctf_fs_ds_index_entry, info->index->entries->len - 1))->timestamp_end_ns; | |
305 | ||
306 | stream_range->begin_ns = min(stream_range->begin_ns, file_begin_epoch); | |
307 | stream_range->end_ns = max(stream_range->end_ns, file_end_epoch); | |
308 | stream_range->set = true; | |
309 | } | |
310 | ||
311 | if (stream_range->set) { | |
312 | ret = add_range(group_info, stream_range, "range-ns"); | |
313 | if (ret) { | |
314 | goto end; | |
315 | } | |
316 | } | |
317 | ||
318 | status = bt_value_map_insert(group_info, "paths", file_paths); | |
319 | if (status != BT_VALUE_STATUS_OK) { | |
320 | ret = -1; | |
321 | goto end; | |
322 | } | |
323 | ||
324 | ret = add_stream_ids(group_info, group->stream); | |
325 | if (ret) { | |
326 | goto end; | |
327 | } | |
328 | end: | |
329 | bt_put(file_paths); | |
330 | return ret; | |
331 | } | |
332 | ||
333 | static | |
334 | int populate_trace_info(const char *trace_path, const char *trace_name, | |
335 | struct bt_value *trace_info) | |
336 | { | |
337 | int ret = 0; | |
338 | size_t group_idx; | |
339 | struct ctf_fs_trace *trace = NULL; | |
340 | enum bt_value_status status; | |
341 | struct bt_value *file_groups; | |
342 | struct range trace_range = { | |
343 | .begin_ns = INT64_MAX, | |
344 | .end_ns = 0, | |
345 | .set = false, | |
346 | }; | |
347 | struct range trace_intersection = { | |
348 | .begin_ns = 0, | |
349 | .end_ns = INT64_MAX, | |
350 | .set = false, | |
351 | }; | |
352 | ||
353 | file_groups = bt_value_array_create(); | |
354 | if (!file_groups) { | |
355 | goto end; | |
356 | } | |
357 | ||
358 | status = bt_value_map_insert_string(trace_info, "name", | |
359 | trace_name); | |
360 | if (status != BT_VALUE_STATUS_OK) { | |
361 | ret = -1; | |
362 | goto end; | |
363 | } | |
364 | status = bt_value_map_insert_string(trace_info, "path", | |
365 | trace_path); | |
366 | if (status != BT_VALUE_STATUS_OK) { | |
367 | ret = -1; | |
368 | goto end; | |
369 | } | |
370 | ||
371 | trace = ctf_fs_trace_create(trace_path, trace_name, NULL); | |
372 | if (!trace) { | |
373 | BT_LOGE("Failed to create fs trace at \'%s\'", trace_path); | |
374 | ret = -1; | |
375 | goto end; | |
376 | } | |
377 | ||
378 | assert(trace->ds_file_groups); | |
379 | /* Add trace range info only if it contains streams. */ | |
380 | if (trace->ds_file_groups->len == 0) { | |
381 | ret = -1; | |
382 | goto end; | |
383 | } | |
384 | ||
385 | /* Find range of all stream groups, and of the trace. */ | |
386 | for (group_idx = 0; group_idx < trace->ds_file_groups->len; | |
387 | group_idx++) { | |
388 | struct bt_value *group_info; | |
389 | struct range group_range = { .set = false }; | |
390 | struct ctf_fs_ds_file_group *group = g_ptr_array_index( | |
391 | trace->ds_file_groups, group_idx); | |
392 | ||
393 | group_info = bt_value_map_create(); | |
394 | if (!group_info) { | |
395 | ret = -1; | |
396 | goto end; | |
397 | } | |
398 | ||
399 | ret = populate_stream_info(group, group_info, &group_range); | |
400 | if (ret) { | |
401 | bt_put(group_info); | |
402 | goto end; | |
403 | } | |
404 | ||
405 | if (group_range.set) { | |
406 | trace_range.begin_ns = min(trace_range.begin_ns, | |
407 | group_range.begin_ns); | |
408 | trace_range.end_ns = max(trace_range.end_ns, | |
409 | group_range.end_ns); | |
410 | trace_range.set = true; | |
411 | ||
412 | trace_intersection.begin_ns = max(trace_intersection.begin_ns, | |
413 | group_range.begin_ns); | |
414 | trace_intersection.end_ns = min(trace_intersection.end_ns, | |
415 | group_range.end_ns); | |
416 | trace_intersection.set = true; | |
417 | status = bt_value_array_append(file_groups, group_info); | |
418 | bt_put(group_info); | |
419 | if (status != BT_VALUE_STATUS_OK) { | |
420 | goto end; | |
421 | } | |
422 | } | |
423 | } | |
424 | ||
425 | ret = add_range(trace_info, &trace_range, "range-ns"); | |
426 | if (ret) { | |
427 | goto end; | |
428 | } | |
429 | ret = add_range(trace_info, &trace_intersection, | |
430 | "intersection-range-ns"); | |
431 | if (ret) { | |
432 | goto end; | |
433 | } | |
434 | ||
435 | status = bt_value_map_insert(trace_info, "streams", file_groups); | |
436 | BT_PUT(file_groups); | |
437 | if (status != BT_VALUE_STATUS_OK) { | |
438 | ret = -1; | |
439 | goto end; | |
440 | } | |
441 | ||
442 | end: | |
443 | bt_put(file_groups); | |
444 | ctf_fs_trace_destroy(trace); | |
445 | return ret; | |
446 | } | |
447 | ||
448 | BT_HIDDEN | |
449 | struct bt_value *trace_info_query(struct bt_component_class *comp_class, | |
450 | struct bt_value *params) | |
451 | { | |
452 | struct bt_value *trace_infos = NULL; | |
453 | struct bt_value *path_value = NULL; | |
454 | int ret = 0; | |
455 | const char *path = NULL; | |
456 | GList *trace_paths = NULL; | |
457 | GList *trace_names = NULL; | |
458 | GList *tp_node = NULL; | |
459 | GList *tn_node = NULL; | |
460 | GString *normalized_path = NULL; | |
461 | ||
462 | if (!bt_value_is_map(params)) { | |
463 | BT_LOGE("Query parameters is not a map value object."); | |
464 | goto error; | |
465 | } | |
466 | ||
467 | path_value = bt_value_map_get(params, "path"); | |
468 | ret = bt_value_string_get(path_value, &path); | |
469 | if (ret) { | |
470 | BT_LOGE("Cannot get `path` string parameter."); | |
471 | goto error; | |
472 | } | |
473 | ||
474 | normalized_path = bt_common_normalize_path(path, NULL); | |
475 | if (!normalized_path) { | |
476 | BT_LOGE("Failed to normalize path: `%s`.", path); | |
477 | goto error; | |
478 | } | |
479 | assert(path); | |
480 | ||
481 | ret = ctf_fs_find_traces(&trace_paths, normalized_path->str); | |
482 | if (ret) { | |
483 | goto error; | |
484 | } | |
485 | ||
486 | trace_names = ctf_fs_create_trace_names(trace_paths, | |
487 | normalized_path->str); | |
488 | if (!trace_names) { | |
489 | BT_LOGE("Cannot create trace names from trace paths."); | |
490 | goto error; | |
491 | } | |
492 | ||
493 | trace_infos = bt_value_array_create(); | |
494 | if (!trace_infos) { | |
495 | goto error; | |
496 | } | |
497 | ||
498 | /* Iterates over both trace paths and names simultaneously. */ | |
499 | for (tp_node = trace_paths, tn_node = trace_names; tp_node; | |
500 | tp_node = g_list_next(tp_node), | |
501 | tn_node = g_list_next(tn_node)) { | |
502 | GString *trace_path = tp_node->data; | |
503 | GString *trace_name = tn_node->data; | |
504 | enum bt_value_status status; | |
505 | struct bt_value *trace_info; | |
506 | ||
507 | trace_info = bt_value_map_create(); | |
508 | if (!trace_info) { | |
509 | BT_LOGE("Failed to create trace info map."); | |
510 | goto error; | |
511 | } | |
512 | ||
513 | ret = populate_trace_info(trace_path->str, trace_name->str, | |
514 | trace_info); | |
515 | if (ret) { | |
516 | bt_put(trace_info); | |
517 | goto error; | |
518 | } | |
519 | ||
520 | status = bt_value_array_append(trace_infos, trace_info); | |
521 | bt_put(trace_info); | |
522 | if (status != BT_VALUE_STATUS_OK) { | |
523 | goto error; | |
524 | } | |
525 | } | |
526 | ||
527 | goto end; | |
528 | ||
529 | error: | |
530 | BT_PUT(trace_infos); | |
531 | end: | |
532 | if (normalized_path) { | |
533 | g_string_free(normalized_path, TRUE); | |
534 | } | |
535 | if (trace_paths) { | |
536 | for (tp_node = trace_paths; tp_node; tp_node = g_list_next(tp_node)) { | |
537 | if (tp_node->data) { | |
538 | g_string_free(tp_node->data, TRUE); | |
539 | } | |
540 | } | |
541 | g_list_free(trace_paths); | |
542 | } | |
543 | if (trace_names) { | |
544 | for (tn_node = trace_names; tn_node; tn_node = g_list_next(tn_node)) { | |
545 | if (tn_node->data) { | |
546 | g_string_free(tn_node->data, TRUE); | |
547 | } | |
548 | } | |
549 | g_list_free(trace_names); | |
550 | } | |
551 | /* "path" becomes invalid with the release of path_value. */ | |
552 | bt_put(path_value); | |
553 | return trace_infos; | |
04c0ba87 | 554 | } |