projects / babeltrace.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Fix -Wmissing-prototypes/-Wmissing-declarations warnings
[babeltrace.git] / src / cli / babeltrace2.c
1 /*
2 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
3 *
4 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 * SOFTWARE.
23 */
24
25 #define BT_LOG_TAG "CLI"
26 #include "logging.h"
27
28 #include <babeltrace2/babeltrace.h>
29 #include "common/common.h"
30 #include <unistd.h>
31 #include <stdlib.h>
32 #include <string.h>
33 #include <stdio.h>
34 #include <glib.h>
35 #include <inttypes.h>
36 #include <unistd.h>
37 #include <signal.h>
38 #include "babeltrace2-cfg.h"
39 #include "babeltrace2-cfg-cli-args.h"
40 #include "babeltrace2-cfg-cli-args-default.h"
41 #include "babeltrace2-log-level.h"
42 #include "babeltrace2-plugins.h"
43 #include "babeltrace2-query.h"
44
45 #define ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH "BABELTRACE_CLI_WARN_COMMAND_NAME_DIRECTORY_CLASH"
46 #define NSEC_PER_SEC 1000000000LL
47
48 /* Application's interrupter (owned by this) */
49 static bt_interrupter *the_interrupter;
50
51 #ifdef __MINGW32__
52
53 #include <windows.h>
54
55 static
56 BOOL WINAPI signal_handler(DWORD signal) {
57 if (the_interrupter) {
58 bt_interrupter_set(the_interrupter);
59 }
60
61 return TRUE;
62 }
63
64 static
65 void set_signal_handler(void)
66 {
67 if (!SetConsoleCtrlHandler(signal_handler, TRUE)) {
68 BT_LOGE("Failed to set the Ctrl+C handler.");
69 }
70 }
71
72 #else /* __MINGW32__ */
73
74 static
75 void signal_handler(int signum)
76 {
77 if (signum != SIGINT) {
78 return;
79 }
80
81 if (the_interrupter) {
82 bt_interrupter_set(the_interrupter);
83 }
84 }
85
86 static
87 void set_signal_handler(void)
88 {
89 struct sigaction new_action, old_action;
90
91 new_action.sa_handler = signal_handler;
92 sigemptyset(&new_action.sa_mask);
93 new_action.sa_flags = 0;
94 sigaction(SIGINT, NULL, &old_action);
95
96 if (old_action.sa_handler != SIG_IGN) {
97 sigaction(SIGINT, &new_action, NULL);
98 }
99 }
100
101 #endif /* __MINGW32__ */
102
103 static
104 int query(struct bt_config *cfg, const bt_component_class *comp_cls,
105 const char *obj, const bt_value *params,
106 const bt_value **user_result, const char **fail_reason)
107 {
108 return cli_query(comp_cls, obj, params, cfg->log_level,
109 the_interrupter, user_result, fail_reason);
110 }
111
112 typedef const void *(*plugin_borrow_comp_cls_func_t)(
113 const bt_plugin *, const char *);
114
115 static
116 const void *find_component_class_from_plugin(const char *plugin_name,
117 const char *comp_class_name,
118 plugin_borrow_comp_cls_func_t plugin_borrow_comp_cls_func)
119 {
120 const void *comp_class = NULL;
121 const bt_plugin *plugin;
122
123 BT_LOGI("Finding component class: plugin-name=\"%s\", "
124 "comp-cls-name=\"%s\"", plugin_name, comp_class_name);
125
126 plugin = find_loaded_plugin(plugin_name);
127 if (!plugin) {
128 goto end;
129 }
130
131 comp_class = plugin_borrow_comp_cls_func(plugin, comp_class_name);
132 bt_object_get_ref(comp_class);
133 BT_PLUGIN_PUT_REF_AND_RESET(plugin);
134
135 end:
136 if (comp_class) {
137 BT_LOGI("Found component class: plugin-name=\"%s\", "
138 "comp-cls-name=\"%s\"", plugin_name, comp_class_name);
139 } else {
140 BT_LOGI("Cannot find source component class: "
141 "plugin-name=\"%s\", comp-cls-name=\"%s\"",
142 plugin_name, comp_class_name);
143 }
144
145 return comp_class;
146 }
147
148 static
149 const bt_component_class_source *find_source_component_class(
150 const char *plugin_name, const char *comp_class_name)
151 {
152 return (const void *) find_component_class_from_plugin(
153 plugin_name, comp_class_name,
154 (plugin_borrow_comp_cls_func_t)
155 bt_plugin_borrow_source_component_class_by_name_const);
156 }
157
158 static
159 const bt_component_class_filter *find_filter_component_class(
160 const char *plugin_name, const char *comp_class_name)
161 {
162 return (const void *) find_component_class_from_plugin(
163 plugin_name, comp_class_name,
164 (plugin_borrow_comp_cls_func_t)
165 bt_plugin_borrow_filter_component_class_by_name_const);
166 }
167
168 static
169 const bt_component_class_sink *find_sink_component_class(
170 const char *plugin_name, const char *comp_class_name)
171 {
172 return (const void *) find_component_class_from_plugin(plugin_name,
173 comp_class_name,
174 (plugin_borrow_comp_cls_func_t)
175 bt_plugin_borrow_sink_component_class_by_name_const);
176 }
177
178 static
179 const bt_component_class *find_component_class(const char *plugin_name,
180 const char *comp_class_name,
181 bt_component_class_type comp_class_type)
182 {
183 const bt_component_class *comp_cls = NULL;
184
185 switch (comp_class_type) {
186 case BT_COMPONENT_CLASS_TYPE_SOURCE:
187 comp_cls = bt_component_class_source_as_component_class_const(find_source_component_class(plugin_name, comp_class_name));
188 break;
189 case BT_COMPONENT_CLASS_TYPE_FILTER:
190 comp_cls = bt_component_class_filter_as_component_class_const(find_filter_component_class(plugin_name, comp_class_name));
191 break;
192 case BT_COMPONENT_CLASS_TYPE_SINK:
193 comp_cls = bt_component_class_sink_as_component_class_const(find_sink_component_class(plugin_name, comp_class_name));
194 break;
195 default:
196 abort();
197 }
198
199 return comp_cls;
200 }
201
202 static
203 void print_indent(FILE *fp, size_t indent)
204 {
205 size_t i;
206
207 for (i = 0; i < indent; i++) {
208 fprintf(fp, " ");
209 }
210 }
211
212 static
213 const char *component_type_str(bt_component_class_type type)
214 {
215 switch (type) {
216 case BT_COMPONENT_CLASS_TYPE_SOURCE:
217 return "source";
218 case BT_COMPONENT_CLASS_TYPE_SINK:
219 return "sink";
220 case BT_COMPONENT_CLASS_TYPE_FILTER:
221 return "filter";
222 default:
223 return "(unknown)";
224 }
225 }
226
227 static
228 void print_plugin_comp_cls_opt(FILE *fh, const char *plugin_name,
229 const char *comp_cls_name, bt_component_class_type type)
230 {
231 GString *shell_plugin_name = NULL;
232 GString *shell_comp_cls_name = NULL;
233
234 if (plugin_name) {
235 shell_plugin_name = bt_common_shell_quote(plugin_name, false);
236 if (!shell_plugin_name) {
237 goto end;
238 }
239 }
240
241 shell_comp_cls_name = bt_common_shell_quote(comp_cls_name, false);
242 if (!shell_comp_cls_name) {
243 goto end;
244 }
245
246 fprintf(fh, "'%s%s%s%s",
247 bt_common_color_bold(),
248 bt_common_color_fg_cyan(),
249 component_type_str(type),
250 bt_common_color_fg_default());
251
252 if (shell_plugin_name) {
253 fprintf(fh, ".%s%s%s",
254 bt_common_color_fg_blue(),
255 shell_plugin_name->str,
256 bt_common_color_fg_default());
257 }
258
259 fprintf(fh, ".%s%s%s'",
260 bt_common_color_fg_yellow(),
261 shell_comp_cls_name->str,
262 bt_common_color_reset());
263
264 end:
265 if (shell_plugin_name) {
266 g_string_free(shell_plugin_name, TRUE);
267 }
268
269 if (shell_comp_cls_name) {
270 g_string_free(shell_comp_cls_name, TRUE);
271 }
272 }
273
274 static
275 void print_value(FILE *, const bt_value *, size_t);
276
277 static
278 void print_value_rec(FILE *, const bt_value *, size_t);
279
280 static
281 void print_map_value(const char *key, const bt_value *object, FILE *fp,
282 size_t indent)
283 {
284 print_indent(fp, indent);
285 fprintf(fp, "%s: ", key);
286 BT_ASSERT(object);
287
288 if (bt_value_is_array(object) &&
289 bt_value_array_is_empty(object)) {
290 fprintf(fp, "[ ]\n");
291 goto end;
292 }
293
294 if (bt_value_is_map(object) &&
295 bt_value_map_is_empty(object)) {
296 fprintf(fp, "{ }\n");
297 goto end;
298 }
299
300 if (bt_value_is_array(object) ||
301 bt_value_is_map(object)) {
302 fprintf(fp, "\n");
303 }
304
305 print_value_rec(fp, object, indent + 2);
306
307 end:
308 return;
309 }
310
311 static
312 bt_bool collect_map_keys(const char *key, const bt_value *object, void *data)
313 {
314 GPtrArray *map_keys = data;
315
316 g_ptr_array_add(map_keys, (gpointer *) key);
317
318 return BT_TRUE;
319 }
320
321 static
322 gint g_ptr_array_sort_strings(gconstpointer a, gconstpointer b) {
323 const char *s1 = *((const char **) a);
324 const char *s2 = *((const char **) b);
325
326 return g_strcmp0(s1, s2);
327 }
328
329 static
330 void print_value_rec(FILE *fp, const bt_value *value, size_t indent)
331 {
332 bt_bool bool_val;
333 int64_t int_val;
334 uint64_t uint_val;
335 double dbl_val;
336 const char *str_val;
337 GPtrArray *map_keys = NULL;
338
339 if (!value) {
340 goto end;
341 }
342
343 switch (bt_value_get_type(value)) {
344 case BT_VALUE_TYPE_NULL:
345 fprintf(fp, "%snull%s\n", bt_common_color_bold(),
346 bt_common_color_reset());
347 break;
348 case BT_VALUE_TYPE_BOOL:
349 bool_val = bt_value_bool_get(value);
350 fprintf(fp, "%s%s%s%s\n", bt_common_color_bold(),
351 bt_common_color_fg_cyan(), bool_val ? "yes" : "no",
352 bt_common_color_reset());
353 break;
354 case BT_VALUE_TYPE_UNSIGNED_INTEGER:
355 uint_val = bt_value_integer_unsigned_get(value);
356 fprintf(fp, "%s%s%" PRIu64 "%s\n", bt_common_color_bold(),
357 bt_common_color_fg_red(), uint_val,
358 bt_common_color_reset());
359 break;
360 case BT_VALUE_TYPE_SIGNED_INTEGER:
361 int_val = bt_value_integer_signed_get(value);
362 fprintf(fp, "%s%s%" PRId64 "%s\n", bt_common_color_bold(),
363 bt_common_color_fg_red(), int_val,
364 bt_common_color_reset());
365 break;
366 case BT_VALUE_TYPE_REAL:
367 dbl_val = bt_value_real_get(value);
368 fprintf(fp, "%s%s%lf%s\n", bt_common_color_bold(),
369 bt_common_color_fg_red(), dbl_val,
370 bt_common_color_reset());
371 break;
372 case BT_VALUE_TYPE_STRING:
373 str_val = bt_value_string_get(value);
374 fprintf(fp, "%s%s%s%s\n", bt_common_color_bold(),
375 bt_common_color_fg_green(), str_val,
376 bt_common_color_reset());
377 break;
378 case BT_VALUE_TYPE_ARRAY:
379 {
380 uint64_t i, size;
381 size = bt_value_array_get_length(value);
382 if (size == 0) {
383 print_indent(fp, indent);
384 fprintf(fp, "[ ]\n");
385 break;
386 }
387
388 for (i = 0; i < size; i++) {
389 const bt_value *element =
390 bt_value_array_borrow_element_by_index_const(
391 value, i);
392
393 print_indent(fp, indent);
394 fprintf(fp, "- ");
395
396 if (bt_value_is_array(element) &&
397 bt_value_array_is_empty(element)) {
398 fprintf(fp, "[ ]\n");
399 continue;
400 }
401
402 if (bt_value_is_map(element) &&
403 bt_value_map_is_empty(element)) {
404 fprintf(fp, "{ }\n");
405 continue;
406 }
407
408 if (bt_value_is_array(element) ||
409 bt_value_is_map(element)) {
410 fprintf(fp, "\n");
411 }
412
413 print_value_rec(fp, element, indent + 2);
414 }
415 break;
416 }
417 case BT_VALUE_TYPE_MAP:
418 {
419 guint i;
420 bt_value_map_foreach_entry_const_status foreach_status;
421
422 if (bt_value_map_is_empty(value)) {
423 print_indent(fp, indent);
424 fprintf(fp, "{ }\n");
425 break;
426 }
427
428 map_keys = g_ptr_array_new();
429 if (!map_keys) {
430 BT_CLI_LOGE_APPEND_CAUSE("Failed to allocated on GPtrArray.");
431 goto end;
432 }
433
434 /*
435 * We want to print the map entries in a stable order. Collect
436 * all the map's keys in a GPtrArray, sort it, then print the
437 * entries in that order.
438 */
439 foreach_status = bt_value_map_foreach_entry_const(value,
440 collect_map_keys, map_keys);
441 if (foreach_status != BT_VALUE_MAP_FOREACH_ENTRY_CONST_STATUS_OK) {
442 BT_CLI_LOGE_APPEND_CAUSE("Failed to iterator on map value.");
443 goto end;
444 }
445
446 g_ptr_array_sort(map_keys, g_ptr_array_sort_strings);
447
448 for (i = 0; i < map_keys->len; i++) {
449 const char *map_key = g_ptr_array_index(map_keys, i);
450 const bt_value *map_value;
451
452 map_value = bt_value_map_borrow_entry_value_const(value, map_key);
453 BT_ASSERT(map_value);
454
455 print_map_value(map_key, map_value, fp, indent);
456 }
457
458 break;
459 }
460 default:
461 abort();
462 }
463
464 goto end;
465
466 end:
467 if (map_keys) {
468 g_ptr_array_free(map_keys, TRUE);
469 }
470 }
471
472 static
473 void print_value(FILE *fp, const bt_value *value, size_t indent)
474 {
475 if (!bt_value_is_array(value) && !bt_value_is_map(value)) {
476 print_indent(fp, indent);
477 }
478
479 print_value_rec(fp, value, indent);
480 }
481
482 static
483 void print_bt_config_component(struct bt_config_component *bt_config_component)
484 {
485 fprintf(stderr, " ");
486 print_plugin_comp_cls_opt(stderr, bt_config_component->plugin_name->str,
487 bt_config_component->comp_cls_name->str,
488 bt_config_component->type);
489 fprintf(stderr, ":\n");
490
491 if (bt_config_component->instance_name->len > 0) {
492 fprintf(stderr, " Name: %s\n",
493 bt_config_component->instance_name->str);
494 }
495
496 fprintf(stderr, " Parameters:\n");
497 print_value(stderr, bt_config_component->params, 8);
498 }
499
500 static
501 void print_bt_config_components(GPtrArray *array)
502 {
503 size_t i;
504
505 for (i = 0; i < array->len; i++) {
506 struct bt_config_component *cfg_component =
507 bt_config_get_component(array, i);
508 print_bt_config_component(cfg_component);
509 BT_OBJECT_PUT_REF_AND_RESET(cfg_component);
510 }
511 }
512
513 static
514 void print_plugin_paths(const bt_value *plugin_paths)
515 {
516 fprintf(stderr, " Plugin paths:\n");
517 print_value(stderr, plugin_paths, 4);
518 }
519
520 static
521 void print_cfg_run(struct bt_config *cfg)
522 {
523 size_t i;
524
525 print_plugin_paths(cfg->plugin_paths);
526 fprintf(stderr, " Source component instances:\n");
527 print_bt_config_components(cfg->cmd_data.run.sources);
528
529 if (cfg->cmd_data.run.filters->len > 0) {
530 fprintf(stderr, " Filter component instances:\n");
531 print_bt_config_components(cfg->cmd_data.run.filters);
532 }
533
534 fprintf(stderr, " Sink component instances:\n");
535 print_bt_config_components(cfg->cmd_data.run.sinks);
536 fprintf(stderr, " Connections:\n");
537
538 for (i = 0; i < cfg->cmd_data.run.connections->len; i++) {
539 struct bt_config_connection *cfg_connection =
540 g_ptr_array_index(cfg->cmd_data.run.connections,
541 i);
542
543 fprintf(stderr, " %s%s%s -> %s%s%s\n",
544 cfg_connection->upstream_comp_name->str,
545 cfg_connection->upstream_port_glob->len > 0 ? "." : "",
546 cfg_connection->upstream_port_glob->str,
547 cfg_connection->downstream_comp_name->str,
548 cfg_connection->downstream_port_glob->len > 0 ? "." : "",
549 cfg_connection->downstream_port_glob->str);
550 }
551 }
552
553 static
554 void print_cfg_list_plugins(struct bt_config *cfg)
555 {
556 print_plugin_paths(cfg->plugin_paths);
557 }
558
559 static
560 void print_cfg_help(struct bt_config *cfg)
561 {
562 print_plugin_paths(cfg->plugin_paths);
563 }
564
565 static
566 void print_cfg_print_ctf_metadata(struct bt_config *cfg)
567 {
568 print_plugin_paths(cfg->plugin_paths);
569 fprintf(stderr, " Path: %s\n",
570 cfg->cmd_data.print_ctf_metadata.path->str);
571 }
572
573 static
574 void print_cfg_print_lttng_live_sessions(struct bt_config *cfg)
575 {
576 print_plugin_paths(cfg->plugin_paths);
577 fprintf(stderr, " URL: %s\n",
578 cfg->cmd_data.print_lttng_live_sessions.url->str);
579 }
580
581 static
582 void print_cfg_query(struct bt_config *cfg)
583 {
584 print_plugin_paths(cfg->plugin_paths);
585 fprintf(stderr, " Object: `%s`\n", cfg->cmd_data.query.object->str);
586 fprintf(stderr, " Component class:\n");
587 print_bt_config_component(cfg->cmd_data.query.cfg_component);
588 }
589
590 static
591 void print_cfg(struct bt_config *cfg)
592 {
593 if (!BT_LOG_ON_INFO) {
594 return;
595 }
596
597 BT_LOGI_STR("CLI configuration:");
598
599 switch (cfg->command) {
600 case BT_CONFIG_COMMAND_RUN:
601 print_cfg_run(cfg);
602 break;
603 case BT_CONFIG_COMMAND_LIST_PLUGINS:
604 print_cfg_list_plugins(cfg);
605 break;
606 case BT_CONFIG_COMMAND_HELP:
607 print_cfg_help(cfg);
608 break;
609 case BT_CONFIG_COMMAND_QUERY:
610 print_cfg_query(cfg);
611 break;
612 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA:
613 print_cfg_print_ctf_metadata(cfg);
614 break;
615 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS:
616 print_cfg_print_lttng_live_sessions(cfg);
617 break;
618 default:
619 abort();
620 }
621 }
622
623 static
624 void print_plugin_info(const bt_plugin *plugin)
625 {
626 unsigned int major, minor, patch;
627 const char *extra;
628 bt_property_availability version_avail;
629 const char *plugin_name;
630 const char *path;
631 const char *author;
632 const char *license;
633 const char *plugin_description;
634
635 plugin_name = bt_plugin_get_name(plugin);
636 path = bt_plugin_get_path(plugin);
637 author = bt_plugin_get_author(plugin);
638 license = bt_plugin_get_license(plugin);
639 plugin_description = bt_plugin_get_description(plugin);
640 version_avail = bt_plugin_get_version(plugin, &major, &minor,
641 &patch, &extra);
642 printf("%s%s%s%s:\n", bt_common_color_bold(),
643 bt_common_color_fg_blue(), plugin_name,
644 bt_common_color_reset());
645 if (path) {
646 printf(" %sPath%s: %s\n", bt_common_color_bold(),
647 bt_common_color_reset(), path);
648 } else {
649 puts(" Built-in");
650 }
651
652 if (version_avail == BT_PROPERTY_AVAILABILITY_AVAILABLE) {
653 printf(" %sVersion%s: %u.%u.%u",
654 bt_common_color_bold(), bt_common_color_reset(),
655 major, minor, patch);
656
657 if (extra) {
658 printf("%s", extra);
659 }
660
661 printf("\n");
662 }
663
664 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
665 bt_common_color_reset(),
666 plugin_description ? plugin_description : "(None)");
667 printf(" %sAuthor%s: %s\n", bt_common_color_bold(),
668 bt_common_color_reset(), author ? author : "(Unknown)");
669 printf(" %sLicense%s: %s\n", bt_common_color_bold(),
670 bt_common_color_reset(),
671 license ? license : "(Unknown)");
672 }
673
674 static
675 int cmd_query(struct bt_config *cfg)
676 {
677 int ret = 0;
678 const bt_component_class *comp_cls = NULL;
679 const bt_value *results = NULL;
680 const char *fail_reason = NULL;
681
682 comp_cls = find_component_class(
683 cfg->cmd_data.query.cfg_component->plugin_name->str,
684 cfg->cmd_data.query.cfg_component->comp_cls_name->str,
685 cfg->cmd_data.query.cfg_component->type);
686 if (!comp_cls) {
687 BT_CLI_LOGE_APPEND_CAUSE(
688 "Cannot find component class: plugin-name=\"%s\", "
689 "comp-cls-name=\"%s\", comp-cls-type=%d",
690 cfg->cmd_data.query.cfg_component->plugin_name->str,
691 cfg->cmd_data.query.cfg_component->comp_cls_name->str,
692 cfg->cmd_data.query.cfg_component->type);
693 ret = -1;
694 goto end;
695 }
696
697 ret = query(cfg, comp_cls, cfg->cmd_data.query.object->str,
698 cfg->cmd_data.query.cfg_component->params,
699 &results, &fail_reason);
700 if (ret) {
701 goto failed;
702 }
703
704 print_value(stdout, results, 0);
705 goto end;
706
707 failed:
708 BT_CLI_LOGE_APPEND_CAUSE(
709 "Failed to query component class: %s: plugin-name=\"%s\", "
710 "comp-cls-name=\"%s\", comp-cls-type=%d "
711 "object=\"%s\"", fail_reason,
712 cfg->cmd_data.query.cfg_component->plugin_name->str,
713 cfg->cmd_data.query.cfg_component->comp_cls_name->str,
714 cfg->cmd_data.query.cfg_component->type,
715 cfg->cmd_data.query.object->str);
716 ret = -1;
717
718 end:
719 bt_component_class_put_ref(comp_cls);
720 bt_value_put_ref(results);
721 return ret;
722 }
723
724 static
725 void print_component_class_help(const char *plugin_name,
726 const bt_component_class *comp_cls)
727 {
728 const char *comp_class_name =
729 bt_component_class_get_name(comp_cls);
730 const char *comp_class_description =
731 bt_component_class_get_description(comp_cls);
732 const char *comp_class_help =
733 bt_component_class_get_help(comp_cls);
734 bt_component_class_type type =
735 bt_component_class_get_type(comp_cls);
736
737 print_plugin_comp_cls_opt(stdout, plugin_name, comp_class_name, type);
738 printf("\n");
739 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
740 bt_common_color_reset(),
741 comp_class_description ? comp_class_description : "(None)");
742
743 if (comp_class_help) {
744 printf("\n%s\n", comp_class_help);
745 }
746 }
747
748 static
749 int cmd_help(struct bt_config *cfg)
750 {
751 int ret = 0;
752 const bt_plugin *plugin = NULL;
753 const bt_component_class *needed_comp_cls = NULL;
754
755 plugin = find_loaded_plugin(cfg->cmd_data.help.cfg_component->plugin_name->str);
756 if (!plugin) {
757 BT_CLI_LOGE_APPEND_CAUSE(
758 "Cannot find plugin: plugin-name=\"%s\"",
759 cfg->cmd_data.help.cfg_component->plugin_name->str);
760 ret = -1;
761 goto end;
762 }
763
764 print_plugin_info(plugin);
765 printf(" %sSource component classes%s: %d\n",
766 bt_common_color_bold(),
767 bt_common_color_reset(),
768 (int) bt_plugin_get_source_component_class_count(plugin));
769 printf(" %sFilter component classes%s: %d\n",
770 bt_common_color_bold(),
771 bt_common_color_reset(),
772 (int) bt_plugin_get_filter_component_class_count(plugin));
773 printf(" %sSink component classes%s: %d\n",
774 bt_common_color_bold(),
775 bt_common_color_reset(),
776 (int) bt_plugin_get_sink_component_class_count(plugin));
777
778 if (strlen(cfg->cmd_data.help.cfg_component->comp_cls_name->str) == 0) {
779 /* Plugin help only */
780 goto end;
781 }
782
783 needed_comp_cls = find_component_class(
784 cfg->cmd_data.help.cfg_component->plugin_name->str,
785 cfg->cmd_data.help.cfg_component->comp_cls_name->str,
786 cfg->cmd_data.help.cfg_component->type);
787 if (!needed_comp_cls) {
788 BT_CLI_LOGE_APPEND_CAUSE(
789 "Cannot find component class: plugin-name=\"%s\", "
790 "comp-cls-name=\"%s\", comp-cls-type=%d",
791 cfg->cmd_data.help.cfg_component->plugin_name->str,
792 cfg->cmd_data.help.cfg_component->comp_cls_name->str,
793 cfg->cmd_data.help.cfg_component->type);
794 ret = -1;
795 goto end;
796 }
797
798 printf("\n");
799 print_component_class_help(
800 cfg->cmd_data.help.cfg_component->plugin_name->str,
801 needed_comp_cls);
802
803 end:
804 bt_component_class_put_ref(needed_comp_cls);
805 bt_plugin_put_ref(plugin);
806 return ret;
807 }
808
809 typedef void *(* plugin_borrow_comp_cls_by_index_func_t)(const bt_plugin *,
810 uint64_t);
811 typedef const bt_component_class *(* spec_comp_cls_borrow_comp_cls_func_t)(
812 void *);
813
814 static
815 void cmd_list_plugins_print_component_classes(const bt_plugin *plugin,
816 const char *cc_type_name, uint64_t count,
817 plugin_borrow_comp_cls_by_index_func_t borrow_comp_cls_by_index_func,
818 spec_comp_cls_borrow_comp_cls_func_t spec_comp_cls_borrow_comp_cls_func)
819 {
820 uint64_t i;
821
822 if (count == 0) {
823 printf(" %s%s component classes%s: (none)\n",
824 bt_common_color_bold(),
825 cc_type_name,
826 bt_common_color_reset());
827 goto end;
828 } else {
829 printf(" %s%s component classes%s:\n",
830 bt_common_color_bold(),
831 cc_type_name,
832 bt_common_color_reset());
833 }
834
835 for (i = 0; i < count; i++) {
836 const bt_component_class *comp_class =
837 spec_comp_cls_borrow_comp_cls_func(
838 borrow_comp_cls_by_index_func(plugin, i));
839 const char *comp_class_name =
840 bt_component_class_get_name(comp_class);
841 const char *comp_class_description =
842 bt_component_class_get_description(comp_class);
843 bt_component_class_type type =
844 bt_component_class_get_type(comp_class);
845
846 printf(" ");
847 print_plugin_comp_cls_opt(stdout,
848 bt_plugin_get_name(plugin), comp_class_name,
849 type);
850
851 if (comp_class_description) {
852 printf(": %s", comp_class_description);
853 }
854
855 printf("\n");
856 }
857
858 end:
859 return;
860 }
861
862 static
863 int cmd_list_plugins(struct bt_config *cfg)
864 {
865 int ret = 0;
866 int plugins_count, component_classes_count = 0, i;
867
868 printf("From the following plugin paths:\n\n");
869 print_value(stdout, cfg->plugin_paths, 2);
870 printf("\n");
871 plugins_count = get_loaded_plugins_count();
872 if (plugins_count == 0) {
873 printf("No plugins found.\n");
874 goto end;
875 }
876
877 for (i = 0; i < plugins_count; i++) {
878 const bt_plugin *plugin = borrow_loaded_plugin(i);
879
880 component_classes_count +=
881 bt_plugin_get_source_component_class_count(plugin) +
882 bt_plugin_get_filter_component_class_count(plugin) +
883 bt_plugin_get_sink_component_class_count(plugin);
884 }
885
886 printf("Found %s%d%s component classes in %s%d%s plugins.\n",
887 bt_common_color_bold(),
888 component_classes_count,
889 bt_common_color_reset(),
890 bt_common_color_bold(),
891 plugins_count,
892 bt_common_color_reset());
893
894 for (i = 0; i < plugins_count; i++) {
895 const bt_plugin *plugin = borrow_loaded_plugin(i);
896
897 printf("\n");
898 print_plugin_info(plugin);
899 cmd_list_plugins_print_component_classes(plugin, "Source",
900 bt_plugin_get_source_component_class_count(plugin),
901 (plugin_borrow_comp_cls_by_index_func_t)
902 bt_plugin_borrow_source_component_class_by_index_const,
903 (spec_comp_cls_borrow_comp_cls_func_t)
904 bt_component_class_source_as_component_class);
905 cmd_list_plugins_print_component_classes(plugin, "Filter",
906 bt_plugin_get_filter_component_class_count(plugin),
907 (plugin_borrow_comp_cls_by_index_func_t)
908 bt_plugin_borrow_filter_component_class_by_index_const,
909 (spec_comp_cls_borrow_comp_cls_func_t)
910 bt_component_class_filter_as_component_class);
911 cmd_list_plugins_print_component_classes(plugin, "Sink",
912 bt_plugin_get_sink_component_class_count(plugin),
913 (plugin_borrow_comp_cls_by_index_func_t)
914 bt_plugin_borrow_sink_component_class_by_index_const,
915 (spec_comp_cls_borrow_comp_cls_func_t)
916 bt_component_class_sink_as_component_class);
917 }
918
919 end:
920 return ret;
921 }
922
923 static
924 int cmd_print_lttng_live_sessions(struct bt_config *cfg)
925 {
926 int ret = 0;
927 const bt_component_class *comp_cls = NULL;
928 const bt_value *results = NULL;
929 bt_value *params = NULL;
930 const bt_value *map = NULL;
931 const bt_value *v = NULL;
932 static const char * const plugin_name = "ctf";
933 static const char * const comp_cls_name = "lttng-live";
934 static const bt_component_class_type comp_cls_type =
935 BT_COMPONENT_CLASS_TYPE_SOURCE;
936 uint64_t array_size, i;
937 const char *fail_reason = NULL;
938 FILE *out_stream = stdout;
939
940 BT_ASSERT(cfg->cmd_data.print_lttng_live_sessions.url);
941 comp_cls = find_component_class(plugin_name, comp_cls_name,
942 comp_cls_type);
943 if (!comp_cls) {
944 BT_CLI_LOGE_APPEND_CAUSE(
945 "Cannot find component class: plugin-name=\"%s\", "
946 "comp-cls-name=\"%s\", comp-cls-type=%d",
947 plugin_name, comp_cls_name,
948 BT_COMPONENT_CLASS_TYPE_SOURCE);
949 goto error;
950 }
951
952 params = bt_value_map_create();
953 if (!params) {
954 goto error;
955 }
956
957 ret = bt_value_map_insert_string_entry(params, "url",
958 cfg->cmd_data.print_lttng_live_sessions.url->str);
959 if (ret) {
960 goto error;
961 }
962
963 ret = query(cfg, comp_cls, "sessions", params,
964 &results, &fail_reason);
965 if (ret) {
966 goto failed;
967 }
968
969 BT_ASSERT(results);
970
971 if (!bt_value_is_array(results)) {
972 BT_CLI_LOGE_APPEND_CAUSE(
973 "Expecting an array for LTTng live `sessions` query.");
974 goto error;
975 }
976
977 if (cfg->cmd_data.print_lttng_live_sessions.output_path->len > 0) {
978 out_stream =
979 fopen(cfg->cmd_data.print_lttng_live_sessions.output_path->str,
980 "w");
981 if (!out_stream) {
982 ret = -1;
983 BT_LOGE_ERRNO("Cannot open file for writing",
984 ": path=\"%s\"",
985 cfg->cmd_data.print_lttng_live_sessions.output_path->str);
986 (void) BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
987 "Babeltrace CLI",
988 "Cannot open file for writing: path=\"%s\"",
989 cfg->cmd_data.print_lttng_live_sessions.output_path->str);
990 goto end;
991 }
992 }
993
994 array_size = bt_value_array_get_length(results);
995 for (i = 0; i < array_size; i++) {
996 const char *url_text;
997 int64_t timer_us, streams, clients;
998
999 map = bt_value_array_borrow_element_by_index_const(results, i);
1000 if (!bt_value_is_map(map)) {
1001 BT_CLI_LOGE_APPEND_CAUSE("Unexpected entry type.");
1002 goto error;
1003 }
1004
1005 v = bt_value_map_borrow_entry_value_const(map, "url");
1006 if (!v) {
1007 BT_CLI_LOGE_APPEND_CAUSE("Missing `url` entry.");
1008 goto error;
1009 }
1010 url_text = bt_value_string_get(v);
1011 fprintf(out_stream, "%s", url_text);
1012 v = bt_value_map_borrow_entry_value_const(map, "timer-us");
1013 if (!v) {
1014 BT_CLI_LOGE_APPEND_CAUSE("Missing `timer-us` entry.");
1015 goto error;
1016 }
1017 timer_us = bt_value_integer_unsigned_get(v);
1018 fprintf(out_stream, " (timer = %" PRIu64 ", ", timer_us);
1019 v = bt_value_map_borrow_entry_value_const(map, "stream-count");
1020 if (!v) {
1021 BT_CLI_LOGE_APPEND_CAUSE(
1022 "Missing `stream-count` entry.");
1023 goto error;
1024 }
1025 streams = bt_value_integer_unsigned_get(v);
1026 fprintf(out_stream, "%" PRIu64 " stream(s), ", streams);
1027 v = bt_value_map_borrow_entry_value_const(map, "client-count");
1028 if (!v) {
1029 BT_CLI_LOGE_APPEND_CAUSE(
1030 "Missing `client-count` entry.");
1031 goto error;
1032 }
1033 clients = bt_value_integer_unsigned_get(v);
1034 fprintf(out_stream, "%" PRIu64 " client(s) connected)\n", clients);
1035 }
1036
1037 goto end;
1038
1039 failed:
1040 BT_CLI_LOGE_APPEND_CAUSE("Failed to query `sessions` object: %s",
1041 fail_reason);
1042
1043 error:
1044 ret = -1;
1045
1046 end:
1047 bt_value_put_ref(results);
1048 bt_value_put_ref(params);
1049 bt_component_class_put_ref(comp_cls);
1050
1051 if (out_stream && out_stream != stdout) {
1052 int fclose_ret = fclose(out_stream);
1053
1054 if (fclose_ret) {
1055 BT_LOGE_ERRNO("Cannot close file stream",
1056 ": path=\"%s\"",
1057 cfg->cmd_data.print_lttng_live_sessions.output_path->str);
1058 }
1059 }
1060
1061 return ret;
1062 }
1063
1064 static
1065 int cmd_print_ctf_metadata(struct bt_config *cfg)
1066 {
1067 int ret = 0;
1068 const bt_component_class *comp_cls = NULL;
1069 const bt_value *results = NULL;
1070 bt_value *params = NULL;
1071 const bt_value *metadata_text_value = NULL;
1072 const char *metadata_text = NULL;
1073 static const char * const plugin_name = "ctf";
1074 static const char * const comp_cls_name = "fs";
1075 static const bt_component_class_type comp_cls_type =
1076 BT_COMPONENT_CLASS_TYPE_SOURCE;
1077 const char *fail_reason = NULL;
1078 FILE *out_stream = stdout;
1079
1080 BT_ASSERT(cfg->cmd_data.print_ctf_metadata.path);
1081 comp_cls = find_component_class(plugin_name, comp_cls_name,
1082 comp_cls_type);
1083 if (!comp_cls) {
1084 BT_CLI_LOGE_APPEND_CAUSE(
1085 "Cannot find component class: plugin-name=\"%s\", "
1086 "comp-cls-name=\"%s\", comp-cls-type=%d",
1087 plugin_name, comp_cls_name,
1088 BT_COMPONENT_CLASS_TYPE_SOURCE);
1089 ret = -1;
1090 goto end;
1091 }
1092
1093 params = bt_value_map_create();
1094 if (!params) {
1095 ret = -1;
1096 goto end;
1097 }
1098
1099 ret = bt_value_map_insert_string_entry(params, "path",
1100 cfg->cmd_data.print_ctf_metadata.path->str);
1101 if (ret) {
1102 ret = -1;
1103 goto end;
1104 }
1105
1106 ret = query(cfg, comp_cls, "metadata-info",
1107 params, &results, &fail_reason);
1108 if (ret) {
1109 goto failed;
1110 }
1111
1112 metadata_text_value = bt_value_map_borrow_entry_value_const(results,
1113 "text");
1114 if (!metadata_text_value) {
1115 BT_CLI_LOGE_APPEND_CAUSE(
1116 "Cannot find `text` string value in the resulting metadata info object.");
1117 ret = -1;
1118 goto end;
1119 }
1120
1121 metadata_text = bt_value_string_get(metadata_text_value);
1122
1123 if (cfg->cmd_data.print_ctf_metadata.output_path->len > 0) {
1124 out_stream =
1125 fopen(cfg->cmd_data.print_ctf_metadata.output_path->str,
1126 "w");
1127 if (!out_stream) {
1128 BT_LOGE_ERRNO("Cannot open file for writing",
1129 ": path=\"%s\"",
1130 cfg->cmd_data.print_ctf_metadata.output_path->str);
1131 (void) BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
1132 "Babeltrace CLI",
1133 "Cannot open file for writing: path=\"%s\"",
1134 cfg->cmd_data.print_ctf_metadata.output_path->str);
1135 ret = -1;
1136 goto end;
1137 }
1138 }
1139
1140 ret = fprintf(out_stream, "%s\n", metadata_text);
1141 if (ret < 0) {
1142 BT_CLI_LOGE_APPEND_CAUSE(
1143 "Cannot write whole metadata text to output stream: "
1144 "ret=%d", ret);
1145 goto end;
1146 }
1147
1148 ret = 0;
1149 goto end;
1150
1151 failed:
1152 ret = -1;
1153 BT_CLI_LOGE_APPEND_CAUSE(
1154 "Failed to query `metadata-info` object: %s", fail_reason);
1155
1156 end:
1157 bt_value_put_ref(results);
1158 bt_value_put_ref(params);
1159 bt_component_class_put_ref(comp_cls);
1160
1161 if (out_stream && out_stream != stdout) {
1162 int fclose_ret = fclose(out_stream);
1163
1164 if (fclose_ret) {
1165 BT_LOGE_ERRNO("Cannot close file stream",
1166 ": path=\"%s\"",
1167 cfg->cmd_data.print_ctf_metadata.output_path->str);
1168 }
1169 }
1170
1171 return ret;
1172 }
1173
1174 struct port_id {
1175 char *instance_name;
1176 char *port_name;
1177 };
1178
1179 struct trace_range {
1180 uint64_t intersection_range_begin_ns;
1181 uint64_t intersection_range_end_ns;
1182 };
1183
1184 static
1185 guint port_id_hash(gconstpointer v)
1186 {
1187 const struct port_id *id = v;
1188
1189 BT_ASSERT(id->instance_name);
1190 BT_ASSERT(id->port_name);
1191
1192 return g_str_hash(id->instance_name) ^ g_str_hash(id->port_name);
1193 }
1194
1195 static
1196 gboolean port_id_equal(gconstpointer v1, gconstpointer v2)
1197 {
1198 const struct port_id *id1 = v1;
1199 const struct port_id *id2 = v2;
1200
1201 return strcmp(id1->instance_name, id2->instance_name) == 0 &&
1202 strcmp(id1->port_name, id2->port_name) == 0;
1203 }
1204
1205 static
1206 void port_id_destroy(gpointer data)
1207 {
1208 struct port_id *id = data;
1209
1210 free(id->instance_name);
1211 free(id->port_name);
1212 free(id);
1213 }
1214
1215 static
1216 void trace_range_destroy(gpointer data)
1217 {
1218 free(data);
1219 }
1220
1221 struct cmd_run_ctx {
1222 /* Owned by this */
1223 GHashTable *src_components;
1224
1225 /* Owned by this */
1226 GHashTable *flt_components;
1227
1228 /* Owned by this */
1229 GHashTable *sink_components;
1230
1231 /* Owned by this */
1232 bt_graph *graph;
1233
1234 /* Weak */
1235 struct bt_config *cfg;
1236
1237 bool connect_ports;
1238
1239 bool stream_intersection_mode;
1240
1241 /*
1242 * Association of struct port_id -> struct trace_range.
1243 */
1244 GHashTable *intersections;
1245 };
1246
1247 /* Returns a timestamp of the form "(-)s.ns" */
1248 static
1249 char *s_from_ns(int64_t ns)
1250 {
1251 int ret;
1252 char *s_ret = NULL;
1253 bool is_negative;
1254 int64_t ts_sec_abs, ts_nsec_abs;
1255 int64_t ts_sec = ns / NSEC_PER_SEC;
1256 int64_t ts_nsec = ns % NSEC_PER_SEC;
1257
1258 if (ts_sec >= 0 && ts_nsec >= 0) {
1259 is_negative = false;
1260 ts_sec_abs = ts_sec;
1261 ts_nsec_abs = ts_nsec;
1262 } else if (ts_sec > 0 && ts_nsec < 0) {
1263 is_negative = false;
1264 ts_sec_abs = ts_sec - 1;
1265 ts_nsec_abs = NSEC_PER_SEC + ts_nsec;
1266 } else if (ts_sec == 0 && ts_nsec < 0) {
1267 is_negative = true;
1268 ts_sec_abs = ts_sec;
1269 ts_nsec_abs = -ts_nsec;
1270 } else if (ts_sec < 0 && ts_nsec > 0) {
1271 is_negative = true;
1272 ts_sec_abs = -(ts_sec + 1);
1273 ts_nsec_abs = NSEC_PER_SEC - ts_nsec;
1274 } else if (ts_sec < 0 && ts_nsec == 0) {
1275 is_negative = true;
1276 ts_sec_abs = -ts_sec;
1277 ts_nsec_abs = ts_nsec;
1278 } else { /* (ts_sec < 0 && ts_nsec < 0) */
1279 is_negative = true;
1280 ts_sec_abs = -ts_sec;
1281 ts_nsec_abs = -ts_nsec;
1282 }
1283
1284 ret = asprintf(&s_ret, "%s%" PRId64 ".%09" PRId64,
1285 is_negative ? "-" : "", ts_sec_abs, ts_nsec_abs);
1286 if (ret < 0) {
1287 s_ret = NULL;
1288 }
1289 return s_ret;
1290 }
1291
1292 static
1293 int cmd_run_ctx_connect_upstream_port_to_downstream_component(
1294 struct cmd_run_ctx *ctx,
1295 const bt_component *upstream_comp,
1296 const bt_port_output *out_upstream_port,
1297 struct bt_config_connection *cfg_conn)
1298 {
1299 typedef uint64_t (*input_port_count_func_t)(void *);
1300 typedef const bt_port_input *(*borrow_input_port_by_index_func_t)(
1301 const void *, uint64_t);
1302 const bt_port *upstream_port =
1303 bt_port_output_as_port_const(out_upstream_port);
1304
1305 int ret = 0;
1306 GQuark downstreamp_comp_name_quark;
1307 void *downstream_comp;
1308 uint64_t downstream_port_count;
1309 uint64_t i;
1310 input_port_count_func_t port_count_fn;
1311 borrow_input_port_by_index_func_t port_by_index_fn;
1312 bt_graph_connect_ports_status connect_ports_status =
1313 BT_GRAPH_CONNECT_PORTS_STATUS_OK;
1314 bool insert_trimmer = false;
1315 bt_value *trimmer_params = NULL;
1316 char *intersection_begin = NULL;
1317 char *intersection_end = NULL;
1318 const bt_component_filter *trimmer = NULL;
1319 const bt_component_class_filter *trimmer_class = NULL;
1320 const bt_port_input *trimmer_input = NULL;
1321 const bt_port_output *trimmer_output = NULL;
1322
1323 if (ctx->intersections &&
1324 bt_component_get_class_type(upstream_comp) ==
1325 BT_COMPONENT_CLASS_TYPE_SOURCE) {
1326 struct trace_range *range;
1327 struct port_id port_id = {
1328 .instance_name = (char *) bt_component_get_name(upstream_comp),
1329 .port_name = (char *) bt_port_get_name(upstream_port)
1330 };
1331
1332 if (!port_id.instance_name || !port_id.port_name) {
1333 goto error;
1334 }
1335
1336 range = (struct trace_range *) g_hash_table_lookup(
1337 ctx->intersections, &port_id);
1338 if (range) {
1339 bt_value_map_insert_entry_status insert_status;
1340
1341 intersection_begin = s_from_ns(
1342 range->intersection_range_begin_ns);
1343 intersection_end = s_from_ns(
1344 range->intersection_range_end_ns);
1345 if (!intersection_begin || !intersection_end) {
1346 BT_CLI_LOGE_APPEND_CAUSE(
1347 "Cannot create trimmer argument timestamp string.");
1348 goto error;
1349 }
1350
1351 insert_trimmer = true;
1352 trimmer_params = bt_value_map_create();
1353 if (!trimmer_params) {
1354 goto error;
1355 }
1356
1357 insert_status = bt_value_map_insert_string_entry(
1358 trimmer_params, "begin", intersection_begin);
1359 if (insert_status < 0) {
1360 goto error;
1361 }
1362 insert_status = bt_value_map_insert_string_entry(
1363 trimmer_params,
1364 "end", intersection_end);
1365 if (insert_status < 0) {
1366 goto error;
1367 }
1368 }
1369
1370 trimmer_class = find_filter_component_class("utils", "trimmer");
1371 if (!trimmer_class) {
1372 goto error;
1373 }
1374 }
1375
1376 BT_LOGI("Connecting upstream port to the next available downstream port: "
1377 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1378 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1379 upstream_port, bt_port_get_name(upstream_port),
1380 cfg_conn->downstream_comp_name->str,
1381 cfg_conn->arg->str);
1382 downstreamp_comp_name_quark = g_quark_from_string(
1383 cfg_conn->downstream_comp_name->str);
1384 BT_ASSERT(downstreamp_comp_name_quark > 0);
1385 downstream_comp = g_hash_table_lookup(ctx->flt_components,
1386 GUINT_TO_POINTER(downstreamp_comp_name_quark));
1387 port_count_fn = (input_port_count_func_t)
1388 bt_component_filter_get_input_port_count;
1389 port_by_index_fn = (borrow_input_port_by_index_func_t)
1390 bt_component_filter_borrow_input_port_by_index_const;
1391
1392 if (!downstream_comp) {
1393 downstream_comp = g_hash_table_lookup(ctx->sink_components,
1394 GUINT_TO_POINTER(downstreamp_comp_name_quark));
1395 port_count_fn = (input_port_count_func_t)
1396 bt_component_sink_get_input_port_count;
1397 port_by_index_fn = (borrow_input_port_by_index_func_t)
1398 bt_component_sink_borrow_input_port_by_index_const;
1399 }
1400
1401 if (!downstream_comp) {
1402 BT_CLI_LOGE_APPEND_CAUSE("Cannot find downstream component: "
1403 "comp-name=\"%s\", conn-arg=\"%s\"",
1404 cfg_conn->downstream_comp_name->str,
1405 cfg_conn->arg->str);
1406 goto error;
1407 }
1408
1409 downstream_port_count = port_count_fn(downstream_comp);
1410
1411 for (i = 0; i < downstream_port_count; i++) {
1412 const bt_port_input *in_downstream_port =
1413 port_by_index_fn(downstream_comp, i);
1414 const bt_port *downstream_port =
1415 bt_port_input_as_port_const(in_downstream_port);
1416 const char *upstream_port_name;
1417 const char *downstream_port_name;
1418
1419 BT_ASSERT(downstream_port);
1420
1421 /* Skip port if it's already connected. */
1422 if (bt_port_is_connected(downstream_port)) {
1423 BT_LOGI("Skipping downstream port: already connected: "
1424 "port-addr=%p, port-name=\"%s\"",
1425 downstream_port,
1426 bt_port_get_name(downstream_port));
1427 continue;
1428 }
1429
1430 downstream_port_name = bt_port_get_name(downstream_port);
1431 BT_ASSERT(downstream_port_name);
1432 upstream_port_name = bt_port_get_name(upstream_port);
1433 BT_ASSERT(upstream_port_name);
1434
1435 if (!bt_common_star_glob_match(
1436 cfg_conn->downstream_port_glob->str, SIZE_MAX,
1437 downstream_port_name, SIZE_MAX)) {
1438 continue;
1439 }
1440
1441 if (insert_trimmer) {
1442 /*
1443 * In order to insert the trimmer between the
1444 * two components that were being connected, we
1445 * create a connection configuration entry which
1446 * describes a connection from the trimmer's
1447 * output to the original input that was being
1448 * connected.
1449 *
1450 * Hence, the creation of the trimmer will cause
1451 * the graph "new port" listener to establish
1452 * all downstream connections as its output port
1453 * is connected. We will then establish the
1454 * connection between the original upstream
1455 * source and the trimmer.
1456 */
1457 char *trimmer_name = NULL;
1458 bt_graph_add_component_status add_comp_status;
1459
1460 ret = asprintf(&trimmer_name,
1461 "stream-intersection-trimmer-%s",
1462 upstream_port_name);
1463 if (ret < 0) {
1464 goto error;
1465 }
1466 ret = 0;
1467
1468 ctx->connect_ports = false;
1469 add_comp_status = bt_graph_add_filter_component(
1470 ctx->graph, trimmer_class, trimmer_name,
1471 trimmer_params, ctx->cfg->log_level,
1472 &trimmer);
1473 free(trimmer_name);
1474 if (add_comp_status !=
1475 BT_GRAPH_ADD_COMPONENT_STATUS_OK) {
1476 goto error;
1477 }
1478 BT_ASSERT(trimmer);
1479
1480 trimmer_input =
1481 bt_component_filter_borrow_input_port_by_index_const(
1482 trimmer, 0);
1483 if (!trimmer_input) {
1484 goto error;
1485 }
1486 trimmer_output =
1487 bt_component_filter_borrow_output_port_by_index_const(
1488 trimmer, 0);
1489 if (!trimmer_output) {
1490 goto error;
1491 }
1492
1493 /*
1494 * Replace the current downstream port by the trimmer's
1495 * upstream port.
1496 */
1497 in_downstream_port = trimmer_input;
1498 downstream_port =
1499 bt_port_input_as_port_const(in_downstream_port);
1500 downstream_port_name = bt_port_get_name(
1501 downstream_port);
1502 BT_ASSERT(downstream_port_name);
1503 }
1504
1505 /* We have a winner! */
1506 connect_ports_status = bt_graph_connect_ports(ctx->graph,
1507 out_upstream_port, in_downstream_port, NULL);
1508 downstream_port = NULL;
1509 switch (connect_ports_status) {
1510 case BT_GRAPH_CONNECT_PORTS_STATUS_OK:
1511 break;
1512 default:
1513 BT_CLI_LOGE_APPEND_CAUSE(
1514 "Cannot create connection: graph refuses to connect ports: "
1515 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1516 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1517 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1518 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1519 "conn-arg=\"%s\"",
1520 upstream_comp, bt_component_get_name(upstream_comp),
1521 upstream_port, bt_port_get_name(upstream_port),
1522 downstream_comp, cfg_conn->downstream_comp_name->str,
1523 downstream_port, downstream_port_name,
1524 cfg_conn->arg->str);
1525 goto error;
1526 }
1527
1528 BT_LOGI("Connected component ports: "
1529 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1530 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1531 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1532 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1533 "conn-arg=\"%s\"",
1534 upstream_comp, bt_component_get_name(upstream_comp),
1535 upstream_port, bt_port_get_name(upstream_port),
1536 downstream_comp, cfg_conn->downstream_comp_name->str,
1537 downstream_port, downstream_port_name,
1538 cfg_conn->arg->str);
1539
1540 if (insert_trimmer) {
1541 /*
1542 * The first connection, from the source to the trimmer,
1543 * has been done. We now connect the trimmer to the
1544 * original downstream port.
1545 */
1546 ret = cmd_run_ctx_connect_upstream_port_to_downstream_component(
1547 ctx,
1548 bt_component_filter_as_component_const(trimmer),
1549 trimmer_output, cfg_conn);
1550 if (ret) {
1551 goto error;
1552 }
1553 ctx->connect_ports = true;
1554 }
1555
1556 /*
1557 * We found a matching downstream port: the search is
1558 * over.
1559 */
1560 goto end;
1561 }
1562
1563 /* No downstream port found */
1564 BT_CLI_LOGE_APPEND_CAUSE(
1565 "Cannot create connection: cannot find a matching downstream port for upstream port: "
1566 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1567 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1568 upstream_port, bt_port_get_name(upstream_port),
1569 cfg_conn->downstream_comp_name->str,
1570 cfg_conn->arg->str);
1571
1572 error:
1573 ret = -1;
1574
1575 end:
1576 free(intersection_begin);
1577 free(intersection_end);
1578 BT_VALUE_PUT_REF_AND_RESET(trimmer_params);
1579 BT_COMPONENT_CLASS_FILTER_PUT_REF_AND_RESET(trimmer_class);
1580 BT_COMPONENT_FILTER_PUT_REF_AND_RESET(trimmer);
1581 return ret;
1582 }
1583
1584 static
1585 int cmd_run_ctx_connect_upstream_port(struct cmd_run_ctx *ctx,
1586 const bt_port_output *upstream_port)
1587 {
1588 int ret = 0;
1589 const char *upstream_port_name;
1590 const char *upstream_comp_name;
1591 const bt_component *upstream_comp = NULL;
1592 size_t i;
1593
1594 BT_ASSERT(ctx);
1595 BT_ASSERT(upstream_port);
1596 upstream_port_name = bt_port_get_name(
1597 bt_port_output_as_port_const(upstream_port));
1598 BT_ASSERT(upstream_port_name);
1599 upstream_comp = bt_port_borrow_component_const(
1600 bt_port_output_as_port_const(upstream_port));
1601 BT_ASSERT(upstream_comp);
1602 upstream_comp_name = bt_component_get_name(upstream_comp);
1603 BT_ASSERT(upstream_comp_name);
1604 BT_LOGI("Connecting upstream port: comp-addr=%p, comp-name=\"%s\", "
1605 "port-addr=%p, port-name=\"%s\"",
1606 upstream_comp, upstream_comp_name,
1607 upstream_port, upstream_port_name);
1608
1609 for (i = 0; i < ctx->cfg->cmd_data.run.connections->len; i++) {
1610 struct bt_config_connection *cfg_conn =
1611 g_ptr_array_index(
1612 ctx->cfg->cmd_data.run.connections, i);
1613
1614 if (strcmp(cfg_conn->upstream_comp_name->str,
1615 upstream_comp_name)) {
1616 continue;
1617 }
1618
1619 if (!bt_common_star_glob_match(
1620 cfg_conn->upstream_port_glob->str,
1621 SIZE_MAX, upstream_port_name, SIZE_MAX)) {
1622 continue;
1623 }
1624
1625 ret = cmd_run_ctx_connect_upstream_port_to_downstream_component(
1626 ctx, upstream_comp, upstream_port, cfg_conn);
1627 if (ret) {
1628 BT_CLI_LOGE_APPEND_CAUSE(
1629 "Cannot connect upstream port: "
1630 "port-addr=%p, port-name=\"%s\"",
1631 upstream_port,
1632 upstream_port_name);
1633 goto error;
1634 }
1635 goto end;
1636 }
1637
1638 BT_CLI_LOGE_APPEND_CAUSE(
1639 "Cannot connect upstream port: port does not match any connection argument: "
1640 "port-addr=%p, port-name=\"%s\"", upstream_port,
1641 upstream_port_name);
1642
1643 error:
1644 ret = -1;
1645
1646 end:
1647 return ret;
1648 }
1649
1650 static
1651 bt_graph_listener_func_status
1652 graph_output_port_added_listener(struct cmd_run_ctx *ctx,
1653 const bt_port_output *out_port)
1654 {
1655 const bt_component *comp;
1656 const bt_port *port = bt_port_output_as_port_const(out_port);
1657 bt_graph_listener_func_status ret =
1658 BT_GRAPH_LISTENER_FUNC_STATUS_OK;
1659
1660 comp = bt_port_borrow_component_const(port);
1661 BT_LOGI("Port added to a graph's component: comp-addr=%p, "
1662 "comp-name=\"%s\", port-addr=%p, port-name=\"%s\"",
1663 comp, comp ? bt_component_get_name(comp) : "",
1664 port, bt_port_get_name(port));
1665
1666 if (!ctx->connect_ports) {
1667 goto end;
1668 }
1669
1670 BT_ASSERT(comp);
1671
1672 if (bt_port_is_connected(port)) {
1673 BT_LOGW_STR("Port is already connected.");
1674 goto end;
1675 }
1676
1677 if (cmd_run_ctx_connect_upstream_port(ctx, out_port)) {
1678 BT_CLI_LOGE_APPEND_CAUSE("Cannot connect upstream port.");
1679 ret = BT_GRAPH_LISTENER_FUNC_STATUS_ERROR;
1680 goto end;
1681 }
1682
1683 end:
1684 return ret;
1685 }
1686
1687 static
1688 bt_graph_listener_func_status graph_source_output_port_added_listener(
1689 const bt_component_source *component,
1690 const bt_port_output *port, void *data)
1691 {
1692 return graph_output_port_added_listener(data, port);
1693 }
1694
1695 static
1696 bt_graph_listener_func_status graph_filter_output_port_added_listener(
1697 const bt_component_filter *component,
1698 const bt_port_output *port, void *data)
1699 {
1700 return graph_output_port_added_listener(data, port);
1701 }
1702
1703 static
1704 void cmd_run_ctx_destroy(struct cmd_run_ctx *ctx)
1705 {
1706 if (!ctx) {
1707 return;
1708 }
1709
1710 if (ctx->src_components) {
1711 g_hash_table_destroy(ctx->src_components);
1712 ctx->src_components = NULL;
1713 }
1714
1715 if (ctx->flt_components) {
1716 g_hash_table_destroy(ctx->flt_components);
1717 ctx->flt_components = NULL;
1718 }
1719
1720 if (ctx->sink_components) {
1721 g_hash_table_destroy(ctx->sink_components);
1722 ctx->sink_components = NULL;
1723 }
1724
1725 if (ctx->intersections) {
1726 g_hash_table_destroy(ctx->intersections);
1727 ctx->intersections = NULL;
1728 }
1729
1730 BT_GRAPH_PUT_REF_AND_RESET(ctx->graph);
1731 ctx->cfg = NULL;
1732 }
1733
1734 static
1735 int add_descriptor_to_component_descriptor_set(
1736 bt_component_descriptor_set *comp_descr_set,
1737 const char *plugin_name, const char *comp_cls_name,
1738 bt_component_class_type comp_cls_type,
1739 const bt_value *params)
1740 {
1741 const bt_component_class *comp_cls;
1742 int status = 0;
1743
1744 comp_cls = find_component_class(plugin_name, comp_cls_name,
1745 comp_cls_type);
1746 if (!comp_cls) {
1747 BT_CLI_LOGE_APPEND_CAUSE(
1748 "Cannot find component class: plugin-name=\"%s\", "
1749 "comp-cls-name=\"%s\", comp-cls-type=%d",
1750 plugin_name, comp_cls_name, comp_cls_type);
1751 status = -1;
1752 goto end;
1753 }
1754
1755 status = bt_component_descriptor_set_add_descriptor(
1756 comp_descr_set, comp_cls, params);
1757 if (status != BT_COMPONENT_DESCRIPTOR_SET_ADD_DESCRIPTOR_STATUS_OK) {
1758 BT_CLI_LOGE_APPEND_CAUSE(
1759 "Cannot append descriptor to component descriptor set: "
1760 "status=%s", bt_common_func_status_string(status));
1761 goto end;
1762 }
1763
1764 end:
1765 bt_component_class_put_ref(comp_cls);
1766 return status;
1767 }
1768
1769 static
1770 int append_descriptors_from_bt_config_component_array(
1771 bt_component_descriptor_set *comp_descr_set,
1772 GPtrArray *component_configs)
1773 {
1774 int ret = 0;
1775 uint64_t i;
1776
1777 for (i = 0; i < component_configs->len; i++) {
1778 struct bt_config_component *cfg_comp =
1779 component_configs->pdata[i];
1780
1781 ret = add_descriptor_to_component_descriptor_set(
1782 comp_descr_set,
1783 cfg_comp->plugin_name->str,
1784 cfg_comp->comp_cls_name->str,
1785 cfg_comp->type, cfg_comp->params);
1786 if (ret) {
1787 goto end;
1788 }
1789 }
1790
1791 end:
1792 return ret;
1793 }
1794
1795 static
1796 bt_get_greatest_operative_mip_version_status get_greatest_operative_mip_version(
1797 struct bt_config *cfg, uint64_t *mip_version)
1798 {
1799 bt_get_greatest_operative_mip_version_status status =
1800 BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_OK;
1801 bt_component_descriptor_set *comp_descr_set = NULL;
1802 int ret;
1803
1804 BT_ASSERT(cfg);
1805 BT_ASSERT(mip_version);
1806 comp_descr_set = bt_component_descriptor_set_create();
1807 if (!comp_descr_set) {
1808 BT_CLI_LOGE_APPEND_CAUSE(
1809 "Failed to create a component descriptor set object.");
1810 status = BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_MEMORY_ERROR;
1811 goto end;
1812 }
1813
1814 ret = append_descriptors_from_bt_config_component_array(
1815 comp_descr_set, cfg->cmd_data.run.sources);
1816 if (ret) {
1817 status = BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR;
1818 goto end;
1819 }
1820
1821 ret = append_descriptors_from_bt_config_component_array(
1822 comp_descr_set, cfg->cmd_data.run.filters);
1823 if (ret) {
1824 status = BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR;
1825 goto end;
1826 }
1827
1828 ret = append_descriptors_from_bt_config_component_array(
1829 comp_descr_set, cfg->cmd_data.run.sinks);
1830 if (ret) {
1831 status = BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR;
1832 goto end;
1833 }
1834
1835 if (cfg->cmd_data.run.stream_intersection_mode) {
1836 /*
1837 * Stream intersection mode adds `flt.utils.trimmer`
1838 * components; we need to include this type of component
1839 * in the component descriptor set to get the real
1840 * greatest operative MIP version.
1841 */
1842 ret = add_descriptor_to_component_descriptor_set(
1843 comp_descr_set, "utils", "trimmer",
1844 BT_COMPONENT_CLASS_TYPE_FILTER, NULL);
1845 if (ret) {
1846 status = BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR;
1847 goto end;
1848 }
1849 }
1850
1851 status = bt_get_greatest_operative_mip_version(comp_descr_set,
1852 bt_cli_log_level, mip_version);
1853
1854 end:
1855 bt_component_descriptor_set_put_ref(comp_descr_set);
1856 return status;
1857 }
1858
1859 static
1860 int cmd_run_ctx_init(struct cmd_run_ctx *ctx, struct bt_config *cfg)
1861 {
1862 int ret = 0;
1863 bt_graph_add_listener_status add_listener_status;
1864 bt_get_greatest_operative_mip_version_status mip_version_status;
1865 uint64_t mip_version = UINT64_C(-1);
1866
1867 ctx->cfg = cfg;
1868 ctx->connect_ports = false;
1869 ctx->src_components = g_hash_table_new_full(g_direct_hash,
1870 g_direct_equal, NULL, (GDestroyNotify) bt_object_put_ref);
1871 if (!ctx->src_components) {
1872 goto error;
1873 }
1874
1875 ctx->flt_components = g_hash_table_new_full(g_direct_hash,
1876 g_direct_equal, NULL, (GDestroyNotify) bt_object_put_ref);
1877 if (!ctx->flt_components) {
1878 goto error;
1879 }
1880
1881 ctx->sink_components = g_hash_table_new_full(g_direct_hash,
1882 g_direct_equal, NULL, (GDestroyNotify) bt_object_put_ref);
1883 if (!ctx->sink_components) {
1884 goto error;
1885 }
1886
1887 if (cfg->cmd_data.run.stream_intersection_mode) {
1888 ctx->stream_intersection_mode = true;
1889 ctx->intersections = g_hash_table_new_full(port_id_hash,
1890 port_id_equal, port_id_destroy, trace_range_destroy);
1891 if (!ctx->intersections) {
1892 goto error;
1893 }
1894 }
1895
1896 /*
1897 * Get the greatest operative MIP version to use to configure
1898 * the graph to create.
1899 */
1900 mip_version_status = get_greatest_operative_mip_version(
1901 cfg, &mip_version);
1902 if (mip_version_status == BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_NO_MATCH) {
1903 BT_CLI_LOGE_APPEND_CAUSE(
1904 "Failed to find an operative message interchange "
1905 "protocol version to use to create the `run` command's "
1906 "graph (components are not interoperable).");
1907 goto error;
1908 } else if (mip_version_status < 0) {
1909 BT_CLI_LOGE_APPEND_CAUSE(
1910 "Cannot find an operative message interchange "
1911 "protocol version to use to create the `run` command's "
1912 "graph: status=%s",
1913 bt_common_func_status_string(mip_version_status));
1914 goto error;
1915 }
1916
1917 BT_ASSERT(mip_version_status == BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_OK);
1918 BT_LOGI("Found operative message interchange protocol version to "
1919 "configure the `run` command's graph: mip-version=%" PRIu64,
1920 mip_version);
1921 ctx->graph = bt_graph_create(mip_version);
1922 if (!ctx->graph) {
1923 goto error;
1924 }
1925
1926 bt_graph_add_interrupter(ctx->graph, the_interrupter);
1927 add_listener_status = bt_graph_add_source_component_output_port_added_listener(
1928 ctx->graph, graph_source_output_port_added_listener, NULL, ctx,
1929 NULL);
1930 if (add_listener_status != BT_GRAPH_ADD_LISTENER_STATUS_OK) {
1931 BT_CLI_LOGE_APPEND_CAUSE(
1932 "Cannot add \"port added\" listener to graph.");
1933 goto error;
1934 }
1935
1936 add_listener_status = bt_graph_add_filter_component_output_port_added_listener(
1937 ctx->graph, graph_filter_output_port_added_listener, NULL, ctx,
1938 NULL);
1939 if (add_listener_status != BT_GRAPH_ADD_LISTENER_STATUS_OK) {
1940 BT_CLI_LOGE_APPEND_CAUSE(
1941 "Cannot add \"port added\" listener to graph.");
1942 goto error;
1943 }
1944
1945 goto end;
1946
1947 error:
1948 cmd_run_ctx_destroy(ctx);
1949 ret = -1;
1950
1951 end:
1952 return ret;
1953 }
1954
1955 /*
1956 * Compute the intersection of all streams in the array `streams`, write it
1957 * in `range`.
1958 */
1959
1960 static
1961 int compute_stream_intersection(const bt_value *streams,
1962 struct trace_range *range)
1963 {
1964 uint64_t i, stream_count;
1965 int ret;
1966
1967 BT_ASSERT(bt_value_get_type(streams) == BT_VALUE_TYPE_ARRAY);
1968
1969 stream_count = bt_value_array_get_length(streams);
1970
1971 BT_ASSERT(stream_count > 0);
1972
1973 range->intersection_range_begin_ns = 0;
1974 range->intersection_range_end_ns = UINT64_MAX;
1975
1976 for (i = 0; i < stream_count; i++) {
1977 int64_t begin_ns, end_ns;
1978 uint64_t begin_ns_u, end_ns_u;
1979 const bt_value *stream_value;
1980 const bt_value *range_ns_value;
1981 const bt_value *begin_value;
1982 const bt_value *end_value;
1983
1984 stream_value = bt_value_array_borrow_element_by_index_const(streams, i);
1985 if (bt_value_get_type(stream_value) != BT_VALUE_TYPE_MAP) {
1986 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
1987 "expected streams array element to be a map, got %s.",
1988 bt_common_value_type_string(bt_value_get_type(stream_value)));
1989 goto error;
1990 }
1991
1992 range_ns_value = bt_value_map_borrow_entry_value_const(
1993 stream_value, "range-ns");
1994 if (!range_ns_value) {
1995 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
1996 "missing expected `range-ns` key in stream map.");
1997 goto error;
1998 }
1999
2000 if (bt_value_get_type(range_ns_value) != BT_VALUE_TYPE_MAP) {
2001 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2002 "expected `range-ns` entry value of stream map to be a map, got %s.",
2003 bt_common_value_type_string(bt_value_get_type(range_ns_value)));
2004 goto error;
2005 }
2006
2007 begin_value = bt_value_map_borrow_entry_value_const(range_ns_value, "begin");
2008 if (!begin_value) {
2009 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2010 "missing expected `begin` key in range-ns map.");
2011 goto error;
2012 }
2013
2014 if (bt_value_get_type(begin_value) != BT_VALUE_TYPE_SIGNED_INTEGER) {
2015 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2016 "expected `begin` entry value of range-ns map to be a signed integer, got %s.",
2017 bt_common_value_type_string(bt_value_get_type(range_ns_value)));
2018 goto error;
2019 }
2020
2021 end_value = bt_value_map_borrow_entry_value_const(range_ns_value, "end");
2022 if (!end_value) {
2023 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2024 "missing expected `end` key in range-ns map.");
2025 goto error;
2026 }
2027
2028 if (bt_value_get_type(end_value) != BT_VALUE_TYPE_SIGNED_INTEGER) {
2029 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2030 "expected `end` entry value of range-ns map to be a signed integer, got %s.",
2031 bt_common_value_type_string(bt_value_get_type(range_ns_value)));
2032 goto error;
2033 }
2034
2035 begin_ns = bt_value_integer_signed_get(begin_value);
2036 end_ns = bt_value_integer_signed_get(end_value);
2037
2038 if (begin_ns < 0 || end_ns < 0 || end_ns < begin_ns) {
2039 BT_CLI_LOGE_APPEND_CAUSE(
2040 "Invalid stream range values: "
2041 "range-ns:begin=%" PRId64 ", "
2042 "range-ns:end=%" PRId64,
2043 begin_ns, end_ns);
2044 goto error;
2045 }
2046
2047 begin_ns_u = begin_ns;
2048 end_ns_u = end_ns;
2049
2050 range->intersection_range_begin_ns =
2051 MAX(range->intersection_range_begin_ns, begin_ns_u);
2052 range->intersection_range_end_ns =
2053 MIN(range->intersection_range_end_ns, end_ns_u);
2054 }
2055
2056 ret = 0;
2057 goto end;
2058 error:
2059 ret = -1;
2060
2061 end:
2062 return ret;
2063 }
2064
2065 static
2066 int set_stream_intersections(struct cmd_run_ctx *ctx,
2067 struct bt_config_component *cfg_comp,
2068 const bt_component_class_source *src_comp_cls)
2069 {
2070 int ret = 0;
2071 uint64_t trace_idx;
2072 uint64_t trace_count;
2073 const bt_value *query_result = NULL;
2074 const bt_value *trace_info = NULL;
2075 const bt_value *stream_infos = NULL;
2076 const bt_value *stream_info = NULL;
2077 struct port_id *port_id = NULL;
2078 struct trace_range *stream_intersection = NULL;
2079 const char *fail_reason = NULL;
2080 const bt_component_class *comp_cls =
2081 bt_component_class_source_as_component_class_const(src_comp_cls);
2082
2083 ret = query(ctx->cfg, comp_cls, "babeltrace.trace-infos",
2084 cfg_comp->params, &query_result,
2085 &fail_reason);
2086 if (ret) {
2087 BT_CLI_LOGE_APPEND_CAUSE("Failed to execute `babeltrace.trace-infos` query: %s: "
2088 "comp-class-name=\"%s\"", fail_reason,
2089 bt_component_class_get_name(comp_cls));
2090 ret = -1;
2091 goto end;
2092 }
2093
2094 BT_ASSERT(query_result);
2095
2096 if (!bt_value_is_array(query_result)) {
2097 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting result to be an array: "
2098 "component-class-name=%s, actual-type=%s",
2099 bt_component_class_get_name(comp_cls),
2100 bt_common_value_type_string(bt_value_get_type(query_result)));
2101 ret = -1;
2102 goto end;
2103 }
2104
2105 trace_count = bt_value_array_get_length(query_result);
2106 if (trace_count == 0) {
2107 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: result is empty: "
2108 "component-class-name=%s", bt_component_class_get_name(comp_cls));
2109 ret = -1;
2110 goto end;
2111 }
2112
2113 for (trace_idx = 0; trace_idx < trace_count; trace_idx++) {
2114 uint64_t stream_idx;
2115 int64_t stream_count;
2116 struct trace_range trace_intersection;
2117
2118 trace_info = bt_value_array_borrow_element_by_index_const(
2119 query_result, trace_idx);
2120 if (!bt_value_is_map(trace_info)) {
2121 ret = -1;
2122 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting element to be a map: "
2123 "component-class-name=%s, actual-type=%s",
2124 bt_component_class_get_name(comp_cls),
2125 bt_common_value_type_string(bt_value_get_type(trace_info)));
2126 goto end;
2127 }
2128
2129 stream_infos = bt_value_map_borrow_entry_value_const(
2130 trace_info, "stream-infos");
2131 if (!stream_infos) {
2132 ret = -1;
2133 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: missing `streams` key in trace info map: "
2134 "component-class-name=%s",
2135 bt_component_class_get_name(comp_cls));
2136 goto end;
2137 }
2138
2139 if (!bt_value_is_array(stream_infos)) {
2140 ret = -1;
2141 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting `streams` entry of trace info map to be an array: "
2142 "component-class-name=%s, actual-type=%s",
2143 bt_component_class_get_name(comp_cls),
2144 bt_common_value_type_string(bt_value_get_type(stream_infos)));
2145 goto end;
2146 }
2147
2148 stream_count = bt_value_array_get_length(stream_infos);
2149 if (stream_count == 0) {
2150 ret = -1;
2151 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: list of streams is empty: "
2152 "component-class-name=%s",
2153 bt_component_class_get_name(comp_cls));
2154 goto end;
2155 }
2156
2157 ret = compute_stream_intersection(stream_infos, &trace_intersection);
2158 if (ret != 0) {
2159 BT_CLI_LOGE_APPEND_CAUSE("Failed to compute trace streams intersection.");
2160 goto end;
2161 }
2162
2163 for (stream_idx = 0; stream_idx < stream_count; stream_idx++) {
2164 const bt_value *port_name;
2165
2166 port_id = g_new0(struct port_id, 1);
2167 if (!port_id) {
2168 ret = -1;
2169 BT_CLI_LOGE_APPEND_CAUSE(
2170 "Cannot allocate memory for port_id structure.");
2171 goto end;
2172 }
2173 port_id->instance_name = strdup(cfg_comp->instance_name->str);
2174 if (!port_id->instance_name) {
2175 ret = -1;
2176 BT_CLI_LOGE_APPEND_CAUSE(
2177 "Cannot allocate memory for port_id component instance name.");
2178 goto end;
2179 }
2180
2181 stream_intersection = g_new0(struct trace_range, 1);
2182 if (!stream_intersection) {
2183 ret = -1;
2184 BT_CLI_LOGE_APPEND_CAUSE(
2185 "Cannot allocate memory for trace_range structure.");
2186 goto end;
2187 }
2188
2189 *stream_intersection = trace_intersection;
2190
2191 stream_info = bt_value_array_borrow_element_by_index_const(
2192 stream_infos, stream_idx);
2193 if (!bt_value_is_map(stream_info)) {
2194 ret = -1;
2195 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: "
2196 "expecting element of stream list to be a map: "
2197 "component-class-name=%s, actual-type=%s",
2198 bt_component_class_get_name(comp_cls),
2199 bt_common_value_type_string(bt_value_get_type(stream_info)));
2200 goto end;
2201 }
2202
2203 port_name = bt_value_map_borrow_entry_value_const(stream_info, "port-name");
2204 if (!port_name) {
2205 ret = -1;
2206 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: "
2207 "missing `port-name` key in stream info map: "
2208 "component-class-name=%s",
2209 bt_component_class_get_name(comp_cls));
2210 goto end;
2211 }
2212
2213 if (!bt_value_is_string(port_name)) {
2214 ret = -1;
2215 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: "
2216 "expecting `port-name` entry of stream info map to be a string: "
2217 "component-class-name=%s, actual-type=%s",
2218 bt_component_class_get_name(comp_cls),
2219 bt_common_value_type_string(bt_value_get_type(port_name)));
2220 goto end;
2221 }
2222
2223 port_id->port_name = g_strdup(bt_value_string_get(port_name));
2224 if (!port_id->port_name) {
2225 ret = -1;
2226 BT_CLI_LOGE_APPEND_CAUSE(
2227 "Cannot allocate memory for port_id port_name.");
2228 goto end;
2229 }
2230
2231 BT_LOGD("Inserting stream intersection ");
2232
2233 g_hash_table_insert(ctx->intersections, port_id, stream_intersection);
2234
2235 port_id = NULL;
2236 stream_intersection = NULL;
2237 }
2238 }
2239
2240 ret = 0;
2241
2242 end:
2243 bt_value_put_ref(query_result);
2244 g_free(port_id);
2245 g_free(stream_intersection);
2246 return ret;
2247 }
2248
2249 static
2250 int cmd_run_ctx_create_components_from_config_components(
2251 struct cmd_run_ctx *ctx, GPtrArray *cfg_components)
2252 {
2253 size_t i;
2254 const void *comp_cls = NULL;
2255 const void *comp = NULL;
2256 int ret = 0;
2257
2258 for (i = 0; i < cfg_components->len; i++) {
2259 struct bt_config_component *cfg_comp =
2260 g_ptr_array_index(cfg_components, i);
2261 GQuark quark;
2262
2263 switch (cfg_comp->type) {
2264 case BT_COMPONENT_CLASS_TYPE_SOURCE:
2265 comp_cls = find_source_component_class(
2266 cfg_comp->plugin_name->str,
2267 cfg_comp->comp_cls_name->str);
2268 break;
2269 case BT_COMPONENT_CLASS_TYPE_FILTER:
2270 comp_cls = find_filter_component_class(
2271 cfg_comp->plugin_name->str,
2272 cfg_comp->comp_cls_name->str);
2273 break;
2274 case BT_COMPONENT_CLASS_TYPE_SINK:
2275 comp_cls = find_sink_component_class(
2276 cfg_comp->plugin_name->str,
2277 cfg_comp->comp_cls_name->str);
2278 break;
2279 default:
2280 abort();
2281 }
2282
2283 if (!comp_cls) {
2284 BT_CLI_LOGE_APPEND_CAUSE(
2285 "Cannot find component class: plugin-name=\"%s\", "
2286 "comp-cls-name=\"%s\", comp-cls-type=%d",
2287 cfg_comp->plugin_name->str,
2288 cfg_comp->comp_cls_name->str,
2289 cfg_comp->type);
2290 goto error;
2291 }
2292
2293 BT_ASSERT(cfg_comp->log_level >= BT_LOG_TRACE);
2294
2295 switch (cfg_comp->type) {
2296 case BT_COMPONENT_CLASS_TYPE_SOURCE:
2297 ret = bt_graph_add_source_component(ctx->graph,
2298 comp_cls, cfg_comp->instance_name->str,
2299 cfg_comp->params, cfg_comp->log_level,
2300 (void *) &comp);
2301 break;
2302 case BT_COMPONENT_CLASS_TYPE_FILTER:
2303 ret = bt_graph_add_filter_component(ctx->graph,
2304 comp_cls, cfg_comp->instance_name->str,
2305 cfg_comp->params, cfg_comp->log_level,
2306 (void *) &comp);
2307 break;
2308 case BT_COMPONENT_CLASS_TYPE_SINK:
2309 ret = bt_graph_add_sink_component(ctx->graph,
2310 comp_cls, cfg_comp->instance_name->str,
2311 cfg_comp->params, cfg_comp->log_level,
2312 (void *) &comp);
2313 break;
2314 default:
2315 abort();
2316 }
2317
2318 if (ret) {
2319 BT_CLI_LOGE_APPEND_CAUSE(
2320 "Cannot create component: plugin-name=\"%s\", "
2321 "comp-cls-name=\"%s\", comp-cls-type=%d, "
2322 "comp-name=\"%s\"",
2323 cfg_comp->plugin_name->str,
2324 cfg_comp->comp_cls_name->str,
2325 cfg_comp->type, cfg_comp->instance_name->str);
2326 goto error;
2327 }
2328
2329 if (ctx->stream_intersection_mode &&
2330 cfg_comp->type == BT_COMPONENT_CLASS_TYPE_SOURCE) {
2331 ret = set_stream_intersections(ctx, cfg_comp, comp_cls);
2332 if (ret) {
2333 BT_CLI_LOGE_APPEND_CAUSE(
2334 "Cannot determine stream intersection of trace.");
2335 goto error;
2336 }
2337 }
2338
2339 BT_LOGI("Created and inserted component: comp-addr=%p, comp-name=\"%s\"",
2340 comp, cfg_comp->instance_name->str);
2341 quark = g_quark_from_string(cfg_comp->instance_name->str);
2342 BT_ASSERT(quark > 0);
2343
2344 switch (cfg_comp->type) {
2345 case BT_COMPONENT_CLASS_TYPE_SOURCE:
2346 g_hash_table_insert(ctx->src_components,
2347 GUINT_TO_POINTER(quark), (void *) comp);
2348 break;
2349 case BT_COMPONENT_CLASS_TYPE_FILTER:
2350 g_hash_table_insert(ctx->flt_components,
2351 GUINT_TO_POINTER(quark), (void *) comp);
2352 break;
2353 case BT_COMPONENT_CLASS_TYPE_SINK:
2354 g_hash_table_insert(ctx->sink_components,
2355 GUINT_TO_POINTER(quark), (void *) comp);
2356 break;
2357 default:
2358 abort();
2359 }
2360
2361 comp = NULL;
2362 BT_OBJECT_PUT_REF_AND_RESET(comp_cls);
2363 }
2364
2365 goto end;
2366
2367 error:
2368 ret = -1;
2369
2370 end:
2371 bt_object_put_ref(comp);
2372 bt_object_put_ref(comp_cls);
2373 return ret;
2374 }
2375
2376 static
2377 int cmd_run_ctx_create_components(struct cmd_run_ctx *ctx)
2378 {
2379 int ret = 0;
2380
2381 /*
2382 * Make sure that, during this phase, our graph's "port added"
2383 * listener does not connect ports while we are creating the
2384 * components because we have a special, initial phase for
2385 * this.
2386 */
2387 ctx->connect_ports = false;
2388
2389 ret = cmd_run_ctx_create_components_from_config_components(
2390 ctx, ctx->cfg->cmd_data.run.sources);
2391 if (ret) {
2392 ret = -1;
2393 goto end;
2394 }
2395
2396 ret = cmd_run_ctx_create_components_from_config_components(
2397 ctx, ctx->cfg->cmd_data.run.filters);
2398 if (ret) {
2399 ret = -1;
2400 goto end;
2401 }
2402
2403 ret = cmd_run_ctx_create_components_from_config_components(
2404 ctx, ctx->cfg->cmd_data.run.sinks);
2405 if (ret) {
2406 ret = -1;
2407 goto end;
2408 }
2409
2410 end:
2411 return ret;
2412 }
2413
2414 typedef uint64_t (*output_port_count_func_t)(const void *);
2415 typedef const bt_port_output *(*borrow_output_port_by_index_func_t)(
2416 const void *, uint64_t);
2417
2418 static
2419 int cmd_run_ctx_connect_comp_ports(struct cmd_run_ctx *ctx,
2420 void *comp, output_port_count_func_t port_count_fn,
2421 borrow_output_port_by_index_func_t port_by_index_fn)
2422 {
2423 int ret = 0;
2424 uint64_t count;
2425 uint64_t i;
2426
2427 count = port_count_fn(comp);
2428
2429 for (i = 0; i < count; i++) {
2430 const bt_port_output *upstream_port = port_by_index_fn(comp, i);
2431
2432 BT_ASSERT(upstream_port);
2433 ret = cmd_run_ctx_connect_upstream_port(ctx, upstream_port);
2434 if (ret) {
2435 goto end;
2436 }
2437 }
2438
2439 end:
2440 return ret;
2441 }
2442
2443 static
2444 int cmd_run_ctx_connect_ports(struct cmd_run_ctx *ctx)
2445 {
2446 int ret = 0;
2447 GHashTableIter iter;
2448 gpointer g_name_quark, g_comp;
2449
2450 ctx->connect_ports = true;
2451 g_hash_table_iter_init(&iter, ctx->src_components);
2452
2453 while (g_hash_table_iter_next(&iter, &g_name_quark, &g_comp)) {
2454 ret = cmd_run_ctx_connect_comp_ports(ctx, g_comp,
2455 (output_port_count_func_t)
2456 bt_component_source_get_output_port_count,
2457 (borrow_output_port_by_index_func_t)
2458 bt_component_source_borrow_output_port_by_index_const);
2459 if (ret) {
2460 goto end;
2461 }
2462 }
2463
2464 g_hash_table_iter_init(&iter, ctx->flt_components);
2465
2466 while (g_hash_table_iter_next(&iter, &g_name_quark, &g_comp)) {
2467 ret = cmd_run_ctx_connect_comp_ports(ctx, g_comp,
2468 (output_port_count_func_t)
2469 bt_component_filter_get_output_port_count,
2470 (borrow_output_port_by_index_func_t)
2471 bt_component_filter_borrow_output_port_by_index_const);
2472 if (ret) {
2473 goto end;
2474 }
2475 }
2476
2477 end:
2478 return ret;
2479 }
2480
2481 static
2482 int cmd_run(struct bt_config *cfg)
2483 {
2484 int ret = 0;
2485 struct cmd_run_ctx ctx = { 0 };
2486
2487 /* Initialize the command's context and the graph object */
2488 if (cmd_run_ctx_init(&ctx, cfg)) {
2489 BT_CLI_LOGE_APPEND_CAUSE(
2490 "Cannot initialize the command's context.");
2491 goto error;
2492 }
2493
2494 if (bt_interrupter_is_set(the_interrupter)) {
2495 BT_CLI_LOGW_APPEND_CAUSE(
2496 "Interrupted by user before creating components.");
2497 goto error;
2498 }
2499
2500 BT_LOGI_STR("Creating components.");
2501
2502 /* Create the requested component instances */
2503 if (cmd_run_ctx_create_components(&ctx)) {
2504 BT_CLI_LOGE_APPEND_CAUSE("Cannot create components.");
2505 goto error;
2506 }
2507
2508 if (bt_interrupter_is_set(the_interrupter)) {
2509 BT_CLI_LOGW_APPEND_CAUSE(
2510 "Interrupted by user before connecting components.");
2511 goto error;
2512 }
2513
2514 BT_LOGI_STR("Connecting components.");
2515
2516 /* Connect the initially visible component ports */
2517 if (cmd_run_ctx_connect_ports(&ctx)) {
2518 BT_CLI_LOGE_APPEND_CAUSE(
2519 "Cannot connect initial component ports.");
2520 goto error;
2521 }
2522
2523 BT_LOGI_STR("Running the graph.");
2524
2525 /* Run the graph */
2526 while (true) {
2527 bt_graph_run_status run_status = bt_graph_run(ctx.graph);
2528
2529 /*
2530 * Reset console in case something messed with console
2531 * codes during the graph's execution.
2532 */
2533 printf("%s", bt_common_color_reset());
2534 fflush(stdout);
2535 fprintf(stderr, "%s", bt_common_color_reset());
2536 BT_LOGT("bt_graph_run() returned: status=%s",
2537 bt_common_func_status_string(run_status));
2538
2539 switch (run_status) {
2540 case BT_GRAPH_RUN_STATUS_OK:
2541 break;
2542 case BT_GRAPH_RUN_STATUS_AGAIN:
2543 if (bt_interrupter_is_set(the_interrupter)) {
2544 BT_CLI_LOGW_APPEND_CAUSE(
2545 "Graph was interrupted by user.");
2546 goto error;
2547 }
2548
2549 if (cfg->cmd_data.run.retry_duration_us > 0) {
2550 BT_LOGT("Got BT_GRAPH_RUN_STATUS_AGAIN: sleeping: "
2551 "time-us=%" PRIu64,
2552 cfg->cmd_data.run.retry_duration_us);
2553
2554 if (usleep(cfg->cmd_data.run.retry_duration_us)) {
2555 if (bt_interrupter_is_set(the_interrupter)) {
2556 BT_CLI_LOGW_APPEND_CAUSE(
2557 "Graph was interrupted by user.");
2558 goto error;
2559 }
2560 }
2561 }
2562 break;
2563 case BT_GRAPH_RUN_STATUS_END:
2564 goto end;
2565 default:
2566 if (bt_interrupter_is_set(the_interrupter)) {
2567 BT_CLI_LOGW_APPEND_CAUSE(
2568 "Graph was interrupted by user and failed: "
2569 "status=%s",
2570 bt_common_func_status_string(run_status));
2571 goto error;
2572 }
2573
2574 BT_CLI_LOGE_APPEND_CAUSE(
2575 "Graph failed to complete successfully");
2576 goto error;
2577 }
2578 }
2579
2580 goto end;
2581
2582 error:
2583 if (ret == 0) {
2584 ret = -1;
2585 }
2586
2587 end:
2588 cmd_run_ctx_destroy(&ctx);
2589 return ret;
2590 }
2591
2592 static
2593 void warn_command_name_and_directory_clash(struct bt_config *cfg)
2594 {
2595 const char *env_clash;
2596
2597 if (!cfg->command_name) {
2598 return;
2599 }
2600
2601 env_clash = getenv(ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH);
2602 if (env_clash && strcmp(env_clash, "0") == 0) {
2603 return;
2604 }
2605
2606 if (g_file_test(cfg->command_name,
2607 G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR)) {
2608 _bt_log_write_d(_BT_LOG_SRCLOC_FUNCTION, __FILE__, __LINE__,
2609 BT_LOG_WARNING, BT_LOG_TAG,
2610 "The `%s` command was executed. "
2611 "If you meant to convert a trace located in "
2612 "the local `%s` directory, please use:\n\n"
2613 " babeltrace2 convert %s [OPTIONS]",
2614 cfg->command_name, cfg->command_name,
2615 cfg->command_name);
2616 }
2617 }
2618
2619 static
2620 void init_log_level(void)
2621 {
2622 bt_cli_log_level = bt_log_get_level_from_env(ENV_BABELTRACE_CLI_LOG_LEVEL);
2623 }
2624
2625 static
2626 void print_error_causes(void)
2627 {
2628 const bt_error *error = bt_current_thread_take_error();
2629 int64_t i;
2630 GString *folded = NULL;
2631 unsigned int columns;
2632
2633 if (!error || bt_error_get_cause_count(error) == 0) {
2634 fprintf(stderr, "%s%sUnknown command-line error.%s\n",
2635 bt_common_color_bold(), bt_common_color_fg_red(),
2636 bt_common_color_reset());
2637 goto end;
2638 }
2639
2640 /* Try to get terminal width to fold the error cause messages */
2641 if (bt_common_get_term_size(&columns, NULL) < 0) {
2642 /* Width not found: default to 80 */
2643 columns = 80;
2644 }
2645
2646 /*
2647 * This helps visually separate the error causes from the last
2648 * logging statement.
2649 */
2650 fprintf(stderr, "\n");
2651
2652 /* Reverse order: deepest (root) cause printed at the end */
2653 for (i = bt_error_get_cause_count(error) - 1; i >= 0; i--) {
2654 const bt_error_cause *cause =
2655 bt_error_borrow_cause_by_index(error, (uint64_t) i);
2656 const char *prefix_fmt =
2657 i == bt_error_get_cause_count(error) - 1 ?
2658 "%s%sERROR%s: " : "%s%sCAUSED BY%s ";
2659
2660 /* Print prefix */
2661 fprintf(stderr, prefix_fmt,
2662 bt_common_color_bold(), bt_common_color_fg_red(),
2663 bt_common_color_reset());
2664
2665 /* Print actor name */
2666 fprintf(stderr, "[");
2667 switch (bt_error_cause_get_actor_type(cause)) {
2668 case BT_ERROR_CAUSE_ACTOR_TYPE_UNKNOWN:
2669 fprintf(stderr, "%s%s%s",
2670 bt_common_color_bold(),
2671 bt_error_cause_get_module_name(cause),
2672 bt_common_color_reset());
2673 break;
2674 case BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT:
2675 fprintf(stderr, "%s%s%s: ",
2676 bt_common_color_bold(),
2677 bt_error_cause_component_actor_get_component_name(cause),
2678 bt_common_color_reset());
2679 print_plugin_comp_cls_opt(stderr,
2680 bt_error_cause_component_actor_get_plugin_name(cause),
2681 bt_error_cause_component_actor_get_component_class_name(cause),
2682 bt_error_cause_component_actor_get_component_class_type(cause));
2683 break;
2684 case BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT_CLASS:
2685 print_plugin_comp_cls_opt(stderr,
2686 bt_error_cause_component_class_actor_get_plugin_name(cause),
2687 bt_error_cause_component_class_actor_get_component_class_name(cause),
2688 bt_error_cause_component_class_actor_get_component_class_type(cause));
2689 break;
2690 case BT_ERROR_CAUSE_ACTOR_TYPE_MESSAGE_ITERATOR:
2691 fprintf(stderr, "%s%s%s (%s%s%s): ",
2692 bt_common_color_bold(),
2693 bt_error_cause_message_iterator_actor_get_component_name(cause),
2694 bt_common_color_reset(),
2695 bt_common_color_bold(),
2696 bt_error_cause_message_iterator_actor_get_component_output_port_name(cause),
2697 bt_common_color_reset());
2698 print_plugin_comp_cls_opt(stderr,
2699 bt_error_cause_message_iterator_actor_get_plugin_name(cause),
2700 bt_error_cause_message_iterator_actor_get_component_class_name(cause),
2701 bt_error_cause_message_iterator_actor_get_component_class_type(cause));
2702 break;
2703 default:
2704 abort();
2705 }
2706
2707 /* Print file name and line number */
2708 fprintf(stderr, "] (%s%s%s%s:%s%" PRIu64 "%s)\n",
2709 bt_common_color_bold(),
2710 bt_common_color_fg_magenta(),
2711 bt_error_cause_get_file_name(cause),
2712 bt_common_color_reset(),
2713 bt_common_color_fg_green(),
2714 bt_error_cause_get_line_number(cause),
2715 bt_common_color_reset());
2716
2717 /* Print message */
2718 folded = bt_common_fold(bt_error_cause_get_message(cause),
2719 columns, 2);
2720 if (!folded) {
2721 BT_LOGE_STR("Could not fold string.");
2722 fprintf(stderr, "%s\n",
2723 bt_error_cause_get_message(cause));
2724 continue;
2725 }
2726
2727 fprintf(stderr, "%s\n", folded->str);
2728 g_string_free(folded, TRUE);
2729 folded = NULL;
2730 }
2731
2732 end:
2733 BT_ASSERT(!folded);
2734
2735 if (error) {
2736 bt_error_release(error);
2737 }
2738 }
2739
2740 int main(int argc, const char **argv)
2741 {
2742 int ret;
2743 int retcode;
2744 struct bt_config *cfg = NULL;
2745
2746 init_log_level();
2747 set_signal_handler();
2748 init_loaded_plugins();
2749
2750 BT_ASSERT(!the_interrupter);
2751 the_interrupter = bt_interrupter_create();
2752 if (!the_interrupter) {
2753 BT_CLI_LOGE_APPEND_CAUSE("Failed to create an interrupter object.");
2754 retcode = 1;
2755 goto end;
2756 }
2757
2758 cfg = bt_config_cli_args_create_with_default(argc, argv, &retcode,
2759 the_interrupter);
2760
2761 if (retcode < 0) {
2762 /* Quit without errors; typically usage/version */
2763 retcode = 0;
2764 BT_LOGI_STR("Quitting without errors.");
2765 goto end;
2766 }
2767
2768 if (retcode > 0) {
2769 BT_CLI_LOGE_APPEND_CAUSE(
2770 "Command-line error: retcode=%d", retcode);
2771 goto end;
2772 }
2773
2774 if (!cfg) {
2775 BT_CLI_LOGE_APPEND_CAUSE(
2776 "Failed to create a valid Babeltrace CLI configuration.");
2777 retcode = 1;
2778 goto end;
2779 }
2780
2781 print_cfg(cfg);
2782
2783 if (cfg->command_needs_plugins) {
2784 ret = require_loaded_plugins(cfg->plugin_paths);
2785 if (ret) {
2786 BT_CLI_LOGE_APPEND_CAUSE(
2787 "Failed to load plugins: ret=%d", ret);
2788 retcode = 1;
2789 goto end;
2790 }
2791 }
2792
2793 BT_LOGI("Executing command: cmd=%d, command-name=\"%s\"",
2794 cfg->command, cfg->command_name);
2795
2796 switch (cfg->command) {
2797 case BT_CONFIG_COMMAND_RUN:
2798 ret = cmd_run(cfg);
2799 break;
2800 case BT_CONFIG_COMMAND_LIST_PLUGINS:
2801 ret = cmd_list_plugins(cfg);
2802 break;
2803 case BT_CONFIG_COMMAND_HELP:
2804 ret = cmd_help(cfg);
2805 break;
2806 case BT_CONFIG_COMMAND_QUERY:
2807 ret = cmd_query(cfg);
2808 break;
2809 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA:
2810 ret = cmd_print_ctf_metadata(cfg);
2811 break;
2812 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS:
2813 ret = cmd_print_lttng_live_sessions(cfg);
2814 break;
2815 default:
2816 BT_LOGF("Invalid/unknown command: cmd=%d", cfg->command);
2817 abort();
2818 }
2819
2820 BT_LOGI("Command completed: cmd=%d, command-name=\"%s\", ret=%d",
2821 cfg->command, cfg->command_name, ret);
2822 warn_command_name_and_directory_clash(cfg);
2823 retcode = ret ? 1 : 0;
2824
2825 end:
2826 BT_OBJECT_PUT_REF_AND_RESET(cfg);
2827 fini_loaded_plugins();
2828 bt_interrupter_put_ref(the_interrupter);
2829
2830 if (retcode != 0) {
2831 print_error_causes();
2832 }
2833
2834 /*
2835 * Clear current thread's error in case there is one to avoid a
2836 * memory leak.
2837 */
2838 bt_current_thread_clear_error();
2839 return retcode;
2840 }
BabelTrace - Trace Format Babel Tower
This page took 0.159228 seconds and 4 git commands to generate.