4 * Babeltrace Trace Converter
6 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
8 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 #include <babeltrace/babeltrace.h>
30 #include <babeltrace/plugin/plugin.h>
31 #include <babeltrace/common-internal.h>
32 #include <babeltrace/graph/component.h>
33 #include <babeltrace/graph/component-source.h>
34 #include <babeltrace/graph/component-sink.h>
35 #include <babeltrace/graph/component-filter.h>
36 #include <babeltrace/graph/component-class.h>
37 #include <babeltrace/graph/port.h>
38 #include <babeltrace/graph/graph.h>
39 #include <babeltrace/graph/connection.h>
40 #include <babeltrace/graph/notification-iterator.h>
41 #include <babeltrace/ref.h>
42 #include <babeltrace/values.h>
43 #include <babeltrace/logging.h>
53 #include "babeltrace-cfg.h"
54 #include "babeltrace-cfg-cli-args.h"
55 #include "babeltrace-cfg-cli-args-default.h"
57 #define BT_LOG_TAG "CLI"
60 #define ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH "BABELTRACE_CLI_WARN_COMMAND_NAME_DIRECTORY_CLASH"
62 /* Application's processing graph (weak) */
63 static struct bt_graph
*the_graph
;
64 static bool canceled
= false;
66 GPtrArray
*loaded_plugins
;
69 int bt_cli_log_level
= BT_LOG_NONE
;
72 void sigint_handler(int signum
)
74 if (signum
!= SIGINT
) {
79 bt_graph_cancel(the_graph
);
86 void init_static_data(void)
88 loaded_plugins
= g_ptr_array_new_with_free_func(bt_put
);
92 void fini_static_data(void)
94 g_ptr_array_free(loaded_plugins
, TRUE
);
98 struct bt_plugin
*find_plugin(const char *name
)
101 struct bt_plugin
*plugin
= NULL
;
104 BT_LOGD("Finding plugin: name=\"%s\"", name
);
106 for (i
= 0; i
< loaded_plugins
->len
; i
++) {
107 plugin
= g_ptr_array_index(loaded_plugins
, i
);
109 if (strcmp(name
, bt_plugin_get_name(plugin
)) == 0) {
116 if (BT_LOG_ON_DEBUG
) {
118 BT_LOGD("Found plugin: plugin-addr=%p", plugin
);
120 BT_LOGD("Cannot find plugin.");
124 return bt_get(plugin
);
128 struct bt_component_class
*find_component_class(const char *plugin_name
,
129 const char *comp_class_name
,
130 enum bt_component_class_type comp_class_type
)
132 struct bt_component_class
*comp_class
= NULL
;
133 struct bt_plugin
*plugin
;
135 BT_LOGD("Finding component class: plugin-name=\"%s\", "
136 "comp-cls-name=\"%s\", comp-cls-type=%d",
137 plugin_name
, comp_class_name
, comp_class_type
);
139 plugin
= find_plugin(plugin_name
);
145 comp_class
= bt_plugin_get_component_class_by_name_and_type(plugin
,
146 comp_class_name
, comp_class_type
);
150 if (BT_LOG_ON_DEBUG
) {
152 BT_LOGD("Found component class: comp-cls-addr=%p",
155 BT_LOGD("Cannot find component class.");
163 void print_indent(FILE *fp
, size_t indent
)
167 for (i
= 0; i
< indent
; i
++) {
173 const char *component_type_str(enum bt_component_class_type type
)
176 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
178 case BT_COMPONENT_CLASS_TYPE_SINK
:
180 case BT_COMPONENT_CLASS_TYPE_FILTER
:
182 case BT_COMPONENT_CLASS_TYPE_UNKNOWN
:
189 void print_plugin_comp_cls_opt(FILE *fh
, const char *plugin_name
,
190 const char *comp_cls_name
, enum bt_component_class_type type
)
192 GString
*shell_plugin_name
= NULL
;
193 GString
*shell_comp_cls_name
= NULL
;
195 shell_plugin_name
= bt_common_shell_quote(plugin_name
, false);
196 if (!shell_plugin_name
) {
200 shell_comp_cls_name
= bt_common_shell_quote(comp_cls_name
, false);
201 if (!shell_comp_cls_name
) {
205 fprintf(fh
, "%s%s--%s%s %s'%s%s%s%s.%s%s%s'",
206 bt_common_color_bold(),
207 bt_common_color_fg_cyan(),
208 component_type_str(type
),
209 bt_common_color_reset(),
210 bt_common_color_fg_default(),
211 bt_common_color_bold(),
212 bt_common_color_fg_blue(),
213 shell_plugin_name
->str
,
214 bt_common_color_fg_default(),
215 bt_common_color_fg_yellow(),
216 shell_comp_cls_name
->str
,
217 bt_common_color_reset());
220 if (shell_plugin_name
) {
221 g_string_free(shell_plugin_name
, TRUE
);
224 if (shell_comp_cls_name
) {
225 g_string_free(shell_comp_cls_name
, TRUE
);
230 void print_value(FILE *, struct bt_value
*, size_t);
233 void print_value_rec(FILE *, struct bt_value
*, size_t);
235 struct print_map_value_data
{
241 bt_bool
print_map_value(const char *key
, struct bt_value
*object
, void *data
)
243 struct print_map_value_data
*print_map_value_data
= data
;
245 print_indent(print_map_value_data
->fp
, print_map_value_data
->indent
);
246 fprintf(print_map_value_data
->fp
, "%s: ", key
);
248 if (bt_value_is_array(object
) &&
249 bt_value_array_is_empty(object
)) {
250 fprintf(print_map_value_data
->fp
, "[ ]\n");
254 if (bt_value_is_map(object
) &&
255 bt_value_map_is_empty(object
)) {
256 fprintf(print_map_value_data
->fp
, "{ }\n");
260 if (bt_value_is_array(object
) ||
261 bt_value_is_map(object
)) {
262 fprintf(print_map_value_data
->fp
, "\n");
265 print_value_rec(print_map_value_data
->fp
, object
,
266 print_map_value_data
->indent
+ 2);
271 void print_value_rec(FILE *fp
, struct bt_value
*value
, size_t indent
)
284 switch (bt_value_get_type(value
)) {
285 case BT_VALUE_TYPE_NULL
:
286 fprintf(fp
, "%snull%s\n", bt_common_color_bold(),
287 bt_common_color_reset());
289 case BT_VALUE_TYPE_BOOL
:
290 bt_value_bool_get(value
, &bool_val
);
291 fprintf(fp
, "%s%s%s%s\n", bt_common_color_bold(),
292 bt_common_color_fg_cyan(), bool_val
? "yes" : "no",
293 bt_common_color_reset());
295 case BT_VALUE_TYPE_INTEGER
:
296 bt_value_integer_get(value
, &int_val
);
297 fprintf(fp
, "%s%s%" PRId64
"%s\n", bt_common_color_bold(),
298 bt_common_color_fg_red(), int_val
,
299 bt_common_color_reset());
301 case BT_VALUE_TYPE_FLOAT
:
302 bt_value_float_get(value
, &dbl_val
);
303 fprintf(fp
, "%s%s%lf%s\n", bt_common_color_bold(),
304 bt_common_color_fg_red(), dbl_val
,
305 bt_common_color_reset());
307 case BT_VALUE_TYPE_STRING
:
308 bt_value_string_get(value
, &str_val
);
309 fprintf(fp
, "%s%s%s%s\n", bt_common_color_bold(),
310 bt_common_color_fg_green(), str_val
,
311 bt_common_color_reset());
313 case BT_VALUE_TYPE_ARRAY
:
314 size
= bt_value_array_size(value
);
318 print_indent(fp
, indent
);
319 fprintf(fp
, "[ ]\n");
323 for (i
= 0; i
< size
; i
++) {
324 struct bt_value
*element
=
325 bt_value_array_get(value
, i
);
328 print_indent(fp
, indent
);
331 if (bt_value_is_array(element
) &&
332 bt_value_array_is_empty(element
)) {
333 fprintf(fp
, "[ ]\n");
337 if (bt_value_is_map(element
) &&
338 bt_value_map_is_empty(element
)) {
339 fprintf(fp
, "{ }\n");
343 if (bt_value_is_array(element
) ||
344 bt_value_is_map(element
)) {
348 print_value_rec(fp
, element
, indent
+ 2);
352 case BT_VALUE_TYPE_MAP
:
354 struct print_map_value_data data
= {
359 if (bt_value_map_is_empty(value
)) {
360 print_indent(fp
, indent
);
361 fprintf(fp
, "{ }\n");
365 bt_value_map_foreach(value
, print_map_value
, &data
);
374 void print_value(FILE *fp
, struct bt_value
*value
, size_t indent
)
376 if (!bt_value_is_array(value
) && !bt_value_is_map(value
)) {
377 print_indent(fp
, indent
);
380 print_value_rec(fp
, value
, indent
);
384 void print_bt_config_component(struct bt_config_component
*bt_config_component
)
386 fprintf(stderr
, " ");
387 print_plugin_comp_cls_opt(stderr
, bt_config_component
->plugin_name
->str
,
388 bt_config_component
->comp_cls_name
->str
,
389 bt_config_component
->type
);
390 fprintf(stderr
, ":\n");
392 if (bt_config_component
->instance_name
->len
> 0) {
393 fprintf(stderr
, " Name: %s\n",
394 bt_config_component
->instance_name
->str
);
397 fprintf(stderr
, " Parameters:\n");
398 print_value(stderr
, bt_config_component
->params
, 8);
402 void print_bt_config_components(GPtrArray
*array
)
406 for (i
= 0; i
< array
->len
; i
++) {
407 struct bt_config_component
*cfg_component
=
408 bt_config_get_component(array
, i
);
409 print_bt_config_component(cfg_component
);
410 BT_PUT(cfg_component
);
415 void print_plugin_paths(struct bt_value
*plugin_paths
)
417 fprintf(stderr
, " Plugin paths:\n");
418 print_value(stderr
, plugin_paths
, 4);
422 void print_cfg_run(struct bt_config
*cfg
)
426 print_plugin_paths(cfg
->plugin_paths
);
427 fprintf(stderr
, " Source component instances:\n");
428 print_bt_config_components(cfg
->cmd_data
.run
.sources
);
430 if (cfg
->cmd_data
.run
.filters
->len
> 0) {
431 fprintf(stderr
, " Filter component instances:\n");
432 print_bt_config_components(cfg
->cmd_data
.run
.filters
);
435 fprintf(stderr
, " Sink component instances:\n");
436 print_bt_config_components(cfg
->cmd_data
.run
.sinks
);
437 fprintf(stderr
, " Connections:\n");
439 for (i
= 0; i
< cfg
->cmd_data
.run
.connections
->len
; i
++) {
440 struct bt_config_connection
*cfg_connection
=
441 g_ptr_array_index(cfg
->cmd_data
.run
.connections
,
444 fprintf(stderr
, " %s%s%s -> %s%s%s\n",
445 cfg_connection
->upstream_comp_name
->str
,
446 cfg_connection
->upstream_port_glob
->len
> 0 ? "." : "",
447 cfg_connection
->upstream_port_glob
->str
,
448 cfg_connection
->downstream_comp_name
->str
,
449 cfg_connection
->downstream_port_glob
->len
> 0 ? "." : "",
450 cfg_connection
->downstream_port_glob
->str
);
455 void print_cfg_list_plugins(struct bt_config
*cfg
)
457 print_plugin_paths(cfg
->plugin_paths
);
461 void print_cfg_help(struct bt_config
*cfg
)
463 print_plugin_paths(cfg
->plugin_paths
);
467 void print_cfg_print_ctf_metadata(struct bt_config
*cfg
)
469 print_plugin_paths(cfg
->plugin_paths
);
470 fprintf(stderr
, " Path: %s\n",
471 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
475 void print_cfg_print_lttng_live_sessions(struct bt_config
*cfg
)
477 print_plugin_paths(cfg
->plugin_paths
);
478 fprintf(stderr
, " URL: %s\n",
479 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
483 void print_cfg_query(struct bt_config
*cfg
)
485 print_plugin_paths(cfg
->plugin_paths
);
486 fprintf(stderr
, " Object: `%s`\n", cfg
->cmd_data
.query
.object
->str
);
487 fprintf(stderr
, " Component class:\n");
488 print_bt_config_component(cfg
->cmd_data
.query
.cfg_component
);
492 void print_cfg(struct bt_config
*cfg
)
494 if (!BT_LOG_ON_INFO
) {
498 BT_LOGI_STR("Configuration:");
499 fprintf(stderr
, " Debug mode: %s\n", cfg
->debug
? "yes" : "no");
500 fprintf(stderr
, " Verbose mode: %s\n", cfg
->verbose
? "yes" : "no");
502 switch (cfg
->command
) {
503 case BT_CONFIG_COMMAND_RUN
:
506 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
507 print_cfg_list_plugins(cfg
);
509 case BT_CONFIG_COMMAND_HELP
:
512 case BT_CONFIG_COMMAND_QUERY
:
513 print_cfg_query(cfg
);
515 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
516 print_cfg_print_ctf_metadata(cfg
);
518 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
519 print_cfg_print_lttng_live_sessions(cfg
);
527 void add_to_loaded_plugins(struct bt_plugin_set
*plugin_set
)
532 count
= bt_plugin_set_get_plugin_count(plugin_set
);
535 for (i
= 0; i
< count
; i
++) {
536 struct bt_plugin
*plugin
=
537 bt_plugin_set_get_plugin(plugin_set
, i
);
538 struct bt_plugin
*loaded_plugin
=
539 find_plugin(bt_plugin_get_name(plugin
));
544 BT_LOGI("Not using plugin: another one already exists with the same name: "
545 "plugin-name=\"%s\", plugin-path=\"%s\", "
546 "existing-plugin-path=\"%s\"",
547 bt_plugin_get_name(plugin
),
548 bt_plugin_get_path(plugin
),
549 bt_plugin_get_path(loaded_plugin
));
550 bt_put(loaded_plugin
);
552 /* Add to global array. */
553 BT_LOGD("Adding plugin to loaded plugins: plugin-path=\"%s\"",
554 bt_plugin_get_name(plugin
));
555 g_ptr_array_add(loaded_plugins
, bt_get(plugin
));
563 int load_dynamic_plugins(struct bt_value
*plugin_paths
)
565 int nr_paths
, i
, ret
= 0;
567 nr_paths
= bt_value_array_size(plugin_paths
);
569 BT_LOGE_STR("Cannot load dynamic plugins: no plugin path.");
574 BT_LOGI("Loading dynamic plugins.");
576 for (i
= 0; i
< nr_paths
; i
++) {
577 struct bt_value
*plugin_path_value
= NULL
;
578 const char *plugin_path
;
579 struct bt_plugin_set
*plugin_set
;
581 plugin_path_value
= bt_value_array_get(plugin_paths
, i
);
582 bt_value_string_get(plugin_path_value
, &plugin_path
);
586 * Skip this if the directory does not exist because
587 * bt_plugin_create_all_from_dir() expects an existing
590 if (!g_file_test(plugin_path
, G_FILE_TEST_IS_DIR
)) {
591 BT_LOGV("Skipping nonexistent directory path: "
592 "path=\"%s\"", plugin_path
);
593 BT_PUT(plugin_path_value
);
597 plugin_set
= bt_plugin_create_all_from_dir(plugin_path
, false);
599 BT_LOGD("Unable to load dynamic plugins: path=\"%s\"",
601 BT_PUT(plugin_path_value
);
605 add_to_loaded_plugins(plugin_set
);
607 BT_PUT(plugin_path_value
);
614 int load_static_plugins(void)
617 struct bt_plugin_set
*plugin_set
;
619 BT_LOGI("Loading static plugins.");
620 plugin_set
= bt_plugin_create_all_from_static();
622 BT_LOGE("Unable to load static plugins.");
627 add_to_loaded_plugins(plugin_set
);
634 int load_all_plugins(struct bt_value
*plugin_paths
)
638 if (load_dynamic_plugins(plugin_paths
)) {
643 if (load_static_plugins()) {
648 BT_LOGI("Loaded all plugins: count=%u", loaded_plugins
->len
);
655 void print_plugin_info(struct bt_plugin
*plugin
)
657 unsigned int major
, minor
, patch
;
659 enum bt_plugin_status version_status
;
660 const char *plugin_name
;
664 const char *plugin_description
;
666 plugin_name
= bt_plugin_get_name(plugin
);
667 path
= bt_plugin_get_path(plugin
);
668 author
= bt_plugin_get_author(plugin
);
669 license
= bt_plugin_get_license(plugin
);
670 plugin_description
= bt_plugin_get_description(plugin
);
671 version_status
= bt_plugin_get_version(plugin
, &major
, &minor
,
673 printf("%s%s%s%s:\n", bt_common_color_bold(),
674 bt_common_color_fg_blue(), plugin_name
,
675 bt_common_color_reset());
676 printf(" %sPath%s: %s\n", bt_common_color_bold(),
677 bt_common_color_reset(), path
? path
: "(None)");
679 if (version_status
== BT_PLUGIN_STATUS_OK
) {
680 printf(" %sVersion%s: %u.%u.%u",
681 bt_common_color_bold(), bt_common_color_reset(),
682 major
, minor
, patch
);
691 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
692 bt_common_color_reset(),
693 plugin_description
? plugin_description
: "(None)");
694 printf(" %sAuthor%s: %s\n", bt_common_color_bold(),
695 bt_common_color_reset(), author
? author
: "(Unknown)");
696 printf(" %sLicense%s: %s\n", bt_common_color_bold(),
697 bt_common_color_reset(),
698 license
? license
: "(Unknown)");
702 int cmd_query(struct bt_config
*cfg
)
705 struct bt_component_class
*comp_cls
= NULL
;
706 struct bt_value
*results
= NULL
;
708 comp_cls
= find_component_class(cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
709 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
710 cfg
->cmd_data
.query
.cfg_component
->type
);
712 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
713 "comp-cls-name=\"%s\", comp-cls-type=%d",
714 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
715 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
716 cfg
->cmd_data
.query
.cfg_component
->type
);
717 fprintf(stderr
, "%s%sCannot find component class %s",
718 bt_common_color_bold(),
719 bt_common_color_fg_red(),
720 bt_common_color_reset());
721 print_plugin_comp_cls_opt(stderr
,
722 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
723 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
724 cfg
->cmd_data
.query
.cfg_component
->type
);
725 fprintf(stderr
, "\n");
730 results
= bt_component_class_query(comp_cls
,
731 cfg
->cmd_data
.query
.object
->str
,
732 cfg
->cmd_data
.query
.cfg_component
->params
);
734 BT_LOGE("Failed to query component class: plugin-name=\"%s\", "
735 "comp-cls-name=\"%s\", comp-cls-type=%d "
737 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
738 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
739 cfg
->cmd_data
.query
.cfg_component
->type
,
740 cfg
->cmd_data
.query
.object
->str
);
741 fprintf(stderr
, "%s%sFailed to query info to %s",
742 bt_common_color_bold(),
743 bt_common_color_fg_red(),
744 bt_common_color_reset());
745 print_plugin_comp_cls_opt(stderr
,
746 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
747 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
748 cfg
->cmd_data
.query
.cfg_component
->type
);
749 fprintf(stderr
, "%s%s with object `%s`%s\n",
750 bt_common_color_bold(),
751 bt_common_color_fg_red(),
752 cfg
->cmd_data
.query
.object
->str
,
753 bt_common_color_reset());
758 print_value(stdout
, results
, 0);
767 int cmd_help(struct bt_config
*cfg
)
770 struct bt_plugin
*plugin
= NULL
;
773 plugin
= find_plugin(cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
775 BT_LOGE("Cannot find plugin: plugin-name=\"%s\"",
776 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
777 fprintf(stderr
, "%s%sCannot find plugin %s%s%s\n",
778 bt_common_color_bold(), bt_common_color_fg_red(),
779 bt_common_color_fg_blue(),
780 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
781 bt_common_color_reset());
786 print_plugin_info(plugin
);
787 printf(" %sComponent classes%s: %d\n",
788 bt_common_color_bold(),
789 bt_common_color_reset(),
790 (int) bt_plugin_get_component_class_count(plugin
));
793 if (cfg
->cmd_data
.help
.cfg_component
->type
!=
794 BT_COMPONENT_CLASS_TYPE_UNKNOWN
) {
795 struct bt_component_class
*needed_comp_cls
=
796 find_component_class(
797 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
798 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
799 cfg
->cmd_data
.help
.cfg_component
->type
);
801 if (!needed_comp_cls
) {
802 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
803 "comp-cls-name=\"%s\", comp-cls-type=%d",
804 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
805 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
806 cfg
->cmd_data
.help
.cfg_component
->type
);
807 fprintf(stderr
, "\n%s%sCannot find component class %s",
808 bt_common_color_bold(),
809 bt_common_color_fg_red(),
810 bt_common_color_reset());
811 print_plugin_comp_cls_opt(stderr
,
812 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
813 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
814 cfg
->cmd_data
.help
.cfg_component
->type
);
815 fprintf(stderr
, "\n");
820 bt_put(needed_comp_cls
);
823 for (i
= 0; i
< bt_plugin_get_component_class_count(plugin
); i
++) {
824 struct bt_component_class
*comp_cls
=
825 bt_plugin_get_component_class_by_index(plugin
, i
);
826 const char *comp_class_name
=
827 bt_component_class_get_name(comp_cls
);
828 const char *comp_class_description
=
829 bt_component_class_get_description(comp_cls
);
830 const char *comp_class_help
=
831 bt_component_class_get_help(comp_cls
);
832 enum bt_component_class_type type
=
833 bt_component_class_get_type(comp_cls
);
837 if (cfg
->cmd_data
.help
.cfg_component
->type
!=
838 BT_COMPONENT_CLASS_TYPE_UNKNOWN
) {
839 if (strcmp(cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
840 comp_class_name
) != 0 &&
842 cfg
->cmd_data
.help
.cfg_component
->type
) {
849 print_plugin_comp_cls_opt(stdout
,
850 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
854 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
855 bt_common_color_reset(),
856 comp_class_description
? comp_class_description
: "(None)");
858 if (comp_class_help
) {
859 printf("\n%s\n", comp_class_help
);
871 int cmd_list_plugins(struct bt_config
*cfg
)
874 int plugins_count
, component_classes_count
= 0, i
;
876 printf("From the following plugin paths:\n\n");
877 print_value(stdout
, cfg
->plugin_paths
, 2);
879 plugins_count
= loaded_plugins
->len
;
880 if (plugins_count
== 0) {
881 printf("No plugins found.\n");
885 for (i
= 0; i
< plugins_count
; i
++) {
886 struct bt_plugin
*plugin
= g_ptr_array_index(loaded_plugins
, i
);
888 component_classes_count
+= bt_plugin_get_component_class_count(plugin
);
891 printf("Found %s%d%s component classes in %s%d%s plugins.\n",
892 bt_common_color_bold(),
893 component_classes_count
,
894 bt_common_color_reset(),
895 bt_common_color_bold(),
897 bt_common_color_reset());
899 for (i
= 0; i
< plugins_count
; i
++) {
901 struct bt_plugin
*plugin
= g_ptr_array_index(loaded_plugins
, i
);
903 component_classes_count
=
904 bt_plugin_get_component_class_count(plugin
);
906 print_plugin_info(plugin
);
908 if (component_classes_count
== 0) {
909 printf(" %sComponent classes%s: (none)\n",
910 bt_common_color_bold(),
911 bt_common_color_reset());
913 printf(" %sComponent classes%s:\n",
914 bt_common_color_bold(),
915 bt_common_color_reset());
918 for (j
= 0; j
< component_classes_count
; j
++) {
919 struct bt_component_class
*comp_class
=
920 bt_plugin_get_component_class_by_index(
922 const char *comp_class_name
=
923 bt_component_class_get_name(comp_class
);
924 const char *comp_class_description
=
925 bt_component_class_get_description(comp_class
);
926 enum bt_component_class_type type
=
927 bt_component_class_get_type(comp_class
);
930 print_plugin_comp_cls_opt(stdout
,
931 bt_plugin_get_name(plugin
), comp_class_name
,
934 if (comp_class_description
) {
935 printf(": %s", comp_class_description
);
948 int cmd_print_lttng_live_sessions(struct bt_config
*cfg
)
951 struct bt_component_class
*comp_cls
= NULL
;
952 struct bt_value
*results
= NULL
;
953 struct bt_value
*params
= NULL
;
954 struct bt_value
*map
= NULL
;
955 struct bt_value
*v
= NULL
;
956 static const char * const plugin_name
= "ctf";
957 static const char * const comp_cls_name
= "lttng-live";
958 static const enum bt_component_class_type comp_cls_type
=
959 BT_COMPONENT_CLASS_TYPE_SOURCE
;
960 int64_t array_size
, i
;
962 assert(cfg
->cmd_data
.print_lttng_live_sessions
.url
);
963 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
966 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
967 "comp-cls-name=\"%s\", comp-cls-type=%d",
968 plugin_name
, comp_cls_name
,
969 BT_COMPONENT_CLASS_TYPE_SOURCE
);
970 fprintf(stderr
, "%s%sCannot find component class %s",
971 bt_common_color_bold(),
972 bt_common_color_fg_red(),
973 bt_common_color_reset());
974 print_plugin_comp_cls_opt(stderr
, plugin_name
,
975 comp_cls_name
, comp_cls_type
);
976 fprintf(stderr
, "\n");
980 params
= bt_value_map_create();
985 ret
= bt_value_map_insert_string(params
, "url",
986 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
991 results
= bt_component_class_query(comp_cls
, "sessions",
994 BT_LOGE_STR("Failed to query for sessions.");
995 fprintf(stderr
, "%s%sFailed to request sessions%s\n",
996 bt_common_color_bold(),
997 bt_common_color_fg_red(),
998 bt_common_color_reset());
1002 if (!bt_value_is_array(results
)) {
1003 BT_LOGE_STR("Expecting an array for sessions query.");
1004 fprintf(stderr
, "%s%sUnexpected type returned by session query%s\n",
1005 bt_common_color_bold(),
1006 bt_common_color_fg_red(),
1007 bt_common_color_reset());
1011 array_size
= bt_value_array_size(results
);
1012 for (i
= 0; i
< array_size
; i
++) {
1013 const char *url_text
;
1014 int64_t timer_us
, streams
, clients
;
1016 map
= bt_value_array_get(results
, i
);
1018 BT_LOGE_STR("Unexpected empty array entry.");
1021 if (!bt_value_is_map(map
)) {
1022 BT_LOGE_STR("Unexpected entry type.");
1026 v
= bt_value_map_get(map
, "url");
1028 BT_LOGE_STR("Unexpected empty array \"url\" entry.");
1031 ret
= bt_value_string_get(v
, &url_text
);
1033 printf("%s", url_text
);
1036 v
= bt_value_map_get(map
, "timer-us");
1038 BT_LOGE_STR("Unexpected empty array \"timer-us\" entry.");
1041 ret
= bt_value_integer_get(v
, &timer_us
);
1043 printf(" (timer = %" PRIu64
", ", timer_us
);
1046 v
= bt_value_map_get(map
, "stream-count");
1048 BT_LOGE_STR("Unexpected empty array \"stream-count\" entry.");
1051 ret
= bt_value_integer_get(v
, &streams
);
1053 printf("%" PRIu64
" stream(s), ", streams
);
1056 v
= bt_value_map_get(map
, "client-count");
1058 BT_LOGE_STR("Unexpected empty array \"client-count\" entry.");
1061 ret
= bt_value_integer_get(v
, &clients
);
1063 printf("%" PRIu64
" client(s) connected)\n", clients
);
1082 int cmd_print_ctf_metadata(struct bt_config
*cfg
)
1085 struct bt_component_class
*comp_cls
= NULL
;
1086 struct bt_value
*results
= NULL
;
1087 struct bt_value
*params
= NULL
;
1088 struct bt_value
*metadata_text_value
= NULL
;
1089 const char *metadata_text
= NULL
;
1090 static const char * const plugin_name
= "ctf";
1091 static const char * const comp_cls_name
= "fs";
1092 static const enum bt_component_class_type comp_cls_type
=
1093 BT_COMPONENT_CLASS_TYPE_SOURCE
;
1095 assert(cfg
->cmd_data
.print_ctf_metadata
.path
);
1096 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1099 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
1100 "comp-cls-name=\"%s\", comp-cls-type=%d",
1101 plugin_name
, comp_cls_name
,
1102 BT_COMPONENT_CLASS_TYPE_SOURCE
);
1103 fprintf(stderr
, "%s%sCannot find component class %s",
1104 bt_common_color_bold(),
1105 bt_common_color_fg_red(),
1106 bt_common_color_reset());
1107 print_plugin_comp_cls_opt(stderr
, plugin_name
,
1108 comp_cls_name
, comp_cls_type
);
1109 fprintf(stderr
, "\n");
1114 params
= bt_value_map_create();
1120 ret
= bt_value_map_insert_string(params
, "path",
1121 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
1127 results
= bt_component_class_query(comp_cls
, "metadata-info",
1131 BT_LOGE_STR("Failed to query for metadata info.");
1132 fprintf(stderr
, "%s%sFailed to request metadata info%s\n",
1133 bt_common_color_bold(),
1134 bt_common_color_fg_red(),
1135 bt_common_color_reset());
1139 metadata_text_value
= bt_value_map_get(results
, "text");
1140 if (!metadata_text_value
) {
1141 BT_LOGE_STR("Cannot find `text` string value in the resulting metadata info object.");
1146 ret
= bt_value_string_get(metadata_text_value
, &metadata_text
);
1148 printf("%s\n", metadata_text
);
1153 bt_put(metadata_text_value
);
1158 struct cmd_run_ctx
{
1160 GHashTable
*components
;
1163 struct bt_graph
*graph
;
1166 struct bt_config
*cfg
;
1172 int cmd_run_ctx_connect_upstream_port_to_downstream_component(
1173 struct cmd_run_ctx
*ctx
, struct bt_component
*upstream_comp
,
1174 struct bt_port
*upstream_port
,
1175 struct bt_config_connection
*cfg_conn
)
1178 GQuark downstreamp_comp_name_quark
;
1179 struct bt_component
*downstream_comp
;
1180 int64_t downstream_port_count
;
1182 int64_t (*port_count_fn
)(struct bt_component
*);
1183 struct bt_port
*(*port_by_index_fn
)(struct bt_component
*, uint64_t);
1186 BT_LOGI("Connecting upstream port to the next available downstream port: "
1187 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1188 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1189 upstream_port
, bt_port_get_name(upstream_port
),
1190 cfg_conn
->downstream_comp_name
->str
,
1191 cfg_conn
->arg
->str
);
1192 downstreamp_comp_name_quark
= g_quark_from_string(
1193 cfg_conn
->downstream_comp_name
->str
);
1194 assert(downstreamp_comp_name_quark
> 0);
1195 downstream_comp
= g_hash_table_lookup(ctx
->components
,
1196 (gpointer
) (long) downstreamp_comp_name_quark
);
1197 if (!downstream_comp
) {
1198 BT_LOGE("Cannot find downstream component: comp-name=\"%s\", "
1199 "conn-arg=\"%s\"", cfg_conn
->downstream_comp_name
->str
,
1200 cfg_conn
->arg
->str
);
1201 fprintf(stderr
, "Cannot create connection: cannot find downstream component: %s\n",
1202 cfg_conn
->arg
->str
);
1206 if (bt_component_is_filter(downstream_comp
)) {
1207 port_count_fn
= bt_component_filter_get_input_port_count
;
1208 port_by_index_fn
= bt_component_filter_get_input_port_by_index
;
1209 } else if (bt_component_is_sink(downstream_comp
)) {
1210 port_count_fn
= bt_component_sink_get_input_port_count
;
1211 port_by_index_fn
= bt_component_sink_get_input_port_by_index
;
1214 * Should never happen because the connections are
1215 * validated before we get here.
1217 BT_LOGF("Invalid connection: downstream component is a source: "
1218 "conn-arg=\"%s\"", cfg_conn
->arg
->str
);
1222 downstream_port_count
= port_count_fn(downstream_comp
);
1223 assert(downstream_port_count
>= 0);
1225 for (i
= 0; i
< downstream_port_count
; i
++) {
1226 struct bt_port
*downstream_port
=
1227 port_by_index_fn(downstream_comp
, i
);
1228 const char *downstream_port_name
;
1230 assert(downstream_port
);
1232 /* Skip port if it's already connected */
1233 if (bt_port_is_connected(downstream_port
)) {
1234 bt_put(downstream_port
);
1235 BT_LOGD("Skipping downstream port: already connected: "
1236 "port-addr=%p, port-name=\"%s\"",
1238 bt_port_get_name(downstream_port
));
1242 downstream_port_name
= bt_port_get_name(downstream_port
);
1243 assert(downstream_port_name
);
1245 if (bt_common_star_glob_match(
1246 cfg_conn
->downstream_port_glob
->str
, -1ULL,
1247 downstream_port_name
, -1ULL)) {
1248 /* We have a winner! */
1249 conn
= bt_graph_connect_ports(ctx
->graph
,
1250 upstream_port
, downstream_port
);
1251 bt_put(downstream_port
);
1253 BT_LOGE("Cannot create connection: graph refuses to connect ports: "
1254 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1255 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1256 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1257 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1259 upstream_comp
, bt_component_get_name(upstream_comp
),
1260 upstream_port
, bt_port_get_name(upstream_port
),
1261 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1262 downstream_port
, downstream_port_name
,
1263 cfg_conn
->arg
->str
);
1265 "Cannot create connection: graph refuses to connect ports (`%s` to `%s`): %s\n",
1266 bt_port_get_name(upstream_port
),
1267 downstream_port_name
,
1268 cfg_conn
->arg
->str
);
1272 BT_LOGI("Connected component ports: "
1273 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1274 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1275 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1276 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1278 upstream_comp
, bt_component_get_name(upstream_comp
),
1279 upstream_port
, bt_port_get_name(upstream_port
),
1280 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1281 downstream_port
, downstream_port_name
,
1282 cfg_conn
->arg
->str
);
1287 bt_put(downstream_port
);
1291 BT_LOGE("Cannot create connection: cannot find a matching downstream port for upstream port: "
1292 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1293 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1294 upstream_port
, bt_port_get_name(upstream_port
),
1295 cfg_conn
->downstream_comp_name
->str
,
1296 cfg_conn
->arg
->str
);
1298 "Cannot create connection: cannot find a matching downstream port for upstream port `%s`: %s\n",
1299 bt_port_get_name(upstream_port
), cfg_conn
->arg
->str
);
1314 int cmd_run_ctx_connect_upstream_port(struct cmd_run_ctx
*ctx
,
1315 struct bt_port
*upstream_port
)
1318 const char *upstream_port_name
;
1319 const char *upstream_comp_name
;
1320 struct bt_component
*upstream_comp
= NULL
;
1324 assert(upstream_port
);
1325 upstream_port_name
= bt_port_get_name(upstream_port
);
1326 assert(upstream_port_name
);
1327 upstream_comp
= bt_port_get_component(upstream_port
);
1328 if (!upstream_comp
) {
1329 BT_LOGW("Upstream port to connect is not part of a component: "
1330 "port-addr=%p, port-name=\"%s\"",
1331 upstream_port
, upstream_port_name
);
1336 upstream_comp_name
= bt_component_get_name(upstream_comp
);
1337 assert(upstream_comp_name
);
1338 BT_LOGI("Connecting upstream port: comp-addr=%p, comp-name=\"%s\", "
1339 "port-addr=%p, port-name=\"%s\"",
1340 upstream_comp
, upstream_comp_name
,
1341 upstream_port
, upstream_port_name
);
1343 for (i
= 0; i
< ctx
->cfg
->cmd_data
.run
.connections
->len
; i
++) {
1344 struct bt_config_connection
*cfg_conn
=
1346 ctx
->cfg
->cmd_data
.run
.connections
, i
);
1348 if (strcmp(cfg_conn
->upstream_comp_name
->str
,
1349 upstream_comp_name
) == 0) {
1350 if (bt_common_star_glob_match(
1351 cfg_conn
->upstream_port_glob
->str
,
1352 -1ULL, upstream_port_name
, -1ULL)) {
1353 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1354 ctx
, upstream_comp
, upstream_port
,
1357 BT_LOGE("Cannot connect upstream port: "
1358 "port-addr=%p, port-name=\"%s\"",
1360 upstream_port_name
);
1362 "Cannot connect port `%s` of component `%s` to a downstream port: %s\n",
1365 cfg_conn
->arg
->str
);
1374 BT_LOGE("Cannot connect upstream port: port does not match any connection argument: "
1375 "port-addr=%p, port-name=\"%s\"", upstream_port
,
1376 upstream_port_name
);
1378 "Cannot create connection: upstream port `%s` does not match any connection\n",
1379 upstream_port_name
);
1385 bt_put(upstream_comp
);
1390 void graph_port_added_listener(struct bt_port
*port
, void *data
)
1392 struct bt_component
*comp
= NULL
;
1393 struct cmd_run_ctx
*ctx
= data
;
1395 comp
= bt_port_get_component(port
);
1396 BT_LOGI("Port added to a graph's component: comp-addr=%p, "
1397 "comp-name=\"%s\", port-addr=%p, port-name=\"%s\"",
1398 comp
, comp
? bt_component_get_name(comp
) : "",
1399 port
, bt_port_get_name(port
));
1401 BT_LOGW_STR("Port has no component.");
1405 if (bt_port_is_connected(port
)) {
1406 BT_LOGW_STR("Port is already connected.");
1410 if (!bt_port_is_output(port
)) {
1411 BT_LOGI_STR("Skipping input port.");
1415 if (cmd_run_ctx_connect_upstream_port(ctx
, port
)) {
1416 BT_LOGF_STR("Cannot connect upstream port.");
1417 fprintf(stderr
, "Added port could not be connected: aborting\n");
1427 void graph_port_removed_listener(struct bt_component
*component
,
1428 struct bt_port
*port
, void *data
)
1430 BT_LOGI("Port removed from a graph's component: comp-addr=%p, "
1431 "comp-name=\"%s\", port-addr=%p, port-name=\"%s\"",
1432 component
, bt_component_get_name(component
),
1433 port
, bt_port_get_name(port
));
1437 void graph_ports_connected_listener(struct bt_port
*upstream_port
,
1438 struct bt_port
*downstream_port
, void *data
)
1440 struct bt_component
*upstream_comp
= bt_port_get_component(upstream_port
);
1441 struct bt_component
*downstream_comp
= bt_port_get_component(downstream_port
);
1443 assert(upstream_comp
);
1444 assert(downstream_comp
);
1445 BT_LOGI("Graph's component ports connected: "
1446 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1447 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1448 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1449 "downstream-port-addr=%p, downstream-port-name=\"%s\"",
1450 upstream_comp
, bt_component_get_name(upstream_comp
),
1451 upstream_port
, bt_port_get_name(upstream_port
),
1452 downstream_comp
, bt_component_get_name(downstream_comp
),
1453 downstream_port
, bt_port_get_name(downstream_port
));
1454 bt_put(upstream_comp
);
1455 bt_put(downstream_comp
);
1459 void graph_ports_disconnected_listener(
1460 struct bt_component
*upstream_component
,
1461 struct bt_component
*downstream_component
,
1462 struct bt_port
*upstream_port
, struct bt_port
*downstream_port
,
1465 BT_LOGI("Graph's component ports disconnected: "
1466 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1467 "downstream-port-addr=%p, downstream-port-name=\"%s\"",
1468 upstream_port
, bt_port_get_name(upstream_port
),
1469 downstream_port
, bt_port_get_name(downstream_port
));
1473 void cmd_run_ctx_destroy(struct cmd_run_ctx
*ctx
)
1479 if (ctx
->components
) {
1480 g_hash_table_destroy(ctx
->components
);
1481 ctx
->components
= NULL
;
1490 int cmd_run_ctx_init(struct cmd_run_ctx
*ctx
, struct bt_config
*cfg
)
1495 ctx
->connect_ports
= false;
1496 ctx
->components
= g_hash_table_new_full(g_direct_hash
, g_direct_equal
,
1498 if (!ctx
->components
) {
1502 ctx
->graph
= bt_graph_create();
1507 the_graph
= ctx
->graph
;
1508 ret
= bt_graph_add_port_added_listener(ctx
->graph
,
1509 graph_port_added_listener
, ctx
);
1511 BT_LOGE_STR("Cannot add \"port added\" listener to graph.");
1515 ret
= bt_graph_add_port_removed_listener(ctx
->graph
,
1516 graph_port_removed_listener
, ctx
);
1518 BT_LOGE_STR("Cannot add \"port removed\" listener to graph.");
1522 ret
= bt_graph_add_ports_connected_listener(ctx
->graph
,
1523 graph_ports_connected_listener
, ctx
);
1525 BT_LOGE_STR("Cannot add \"ports connected\" listener to graph.");
1529 ret
= bt_graph_add_ports_disconnected_listener(ctx
->graph
,
1530 graph_ports_disconnected_listener
, ctx
);
1532 BT_LOGE_STR("Cannot add \"ports disconnected\" listener to graph.");
1539 cmd_run_ctx_destroy(ctx
);
1547 int cmd_run_ctx_create_components_from_config_components(
1548 struct cmd_run_ctx
*ctx
, GPtrArray
*cfg_components
)
1551 struct bt_component_class
*comp_cls
= NULL
;
1552 struct bt_component
*comp
= NULL
;
1555 for (i
= 0; i
< cfg_components
->len
; i
++) {
1556 struct bt_config_component
*cfg_comp
=
1557 g_ptr_array_index(cfg_components
, i
);
1560 comp_cls
= find_component_class(cfg_comp
->plugin_name
->str
,
1561 cfg_comp
->comp_cls_name
->str
, cfg_comp
->type
);
1563 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
1564 "comp-cls-name=\"%s\", comp-cls-type=%d",
1565 cfg_comp
->plugin_name
->str
,
1566 cfg_comp
->comp_cls_name
->str
,
1568 fprintf(stderr
, "%s%sCannot find component class %s",
1569 bt_common_color_bold(),
1570 bt_common_color_fg_red(),
1571 bt_common_color_reset());
1572 print_plugin_comp_cls_opt(stderr
,
1573 cfg_comp
->plugin_name
->str
,
1574 cfg_comp
->comp_cls_name
->str
,
1576 fprintf(stderr
, "\n");
1580 comp
= bt_component_create(comp_cls
,
1581 cfg_comp
->instance_name
->str
, cfg_comp
->params
);
1583 BT_LOGE("Cannot create component: plugin-name=\"%s\", "
1584 "comp-cls-name=\"%s\", comp-cls-type=%d, "
1586 cfg_comp
->plugin_name
->str
,
1587 cfg_comp
->comp_cls_name
->str
,
1588 cfg_comp
->type
, cfg_comp
->instance_name
->str
);
1589 fprintf(stderr
, "%s%sCannot create component `%s`%s\n",
1590 bt_common_color_bold(),
1591 bt_common_color_fg_red(),
1592 cfg_comp
->instance_name
->str
,
1593 bt_common_color_reset());
1597 BT_LOGI("Created and inserted component: comp-addr=%p, comp-name=\"%s\"",
1598 comp
, cfg_comp
->instance_name
->str
);
1599 quark
= g_quark_from_string(cfg_comp
->instance_name
->str
);
1601 g_hash_table_insert(ctx
->components
,
1602 (gpointer
) (long) quark
, comp
);
1619 int cmd_run_ctx_create_components(struct cmd_run_ctx
*ctx
)
1624 * Make sure that, during this phase, our graph's "port added"
1625 * listener does not connect ports while we are creating the
1626 * components because we have a special, initial phase for
1629 ctx
->connect_ports
= false;
1631 ret
= cmd_run_ctx_create_components_from_config_components(
1632 ctx
, ctx
->cfg
->cmd_data
.run
.sources
);
1638 ret
= cmd_run_ctx_create_components_from_config_components(
1639 ctx
, ctx
->cfg
->cmd_data
.run
.filters
);
1645 ret
= cmd_run_ctx_create_components_from_config_components(
1646 ctx
, ctx
->cfg
->cmd_data
.run
.sinks
);
1657 int cmd_run_ctx_connect_comp_ports(struct cmd_run_ctx
*ctx
,
1658 struct bt_component
*comp
,
1659 int64_t (*port_count_fn
)(struct bt_component
*),
1660 struct bt_port
*(*port_by_index_fn
)(struct bt_component
*, uint64_t))
1666 count
= port_count_fn(comp
);
1669 for (i
= 0; i
< count
; i
++) {
1670 struct bt_port
*upstream_port
= port_by_index_fn(comp
, i
);
1672 assert(upstream_port
);
1673 ret
= cmd_run_ctx_connect_upstream_port(ctx
, upstream_port
);
1674 bt_put(upstream_port
);
1685 int cmd_run_ctx_connect_ports(struct cmd_run_ctx
*ctx
)
1688 GHashTableIter iter
;
1689 gpointer g_name_quark
, g_comp
;
1691 ctx
->connect_ports
= true;
1692 g_hash_table_iter_init(&iter
, ctx
->components
);
1694 while (g_hash_table_iter_next(&iter
, &g_name_quark
, &g_comp
)) {
1695 if (bt_component_is_source(g_comp
)) {
1696 ret
= cmd_run_ctx_connect_comp_ports(ctx
,
1697 g_comp
, bt_component_source_get_output_port_count
,
1698 bt_component_source_get_output_port_by_index
);
1699 } else if (bt_component_is_filter(g_comp
)) {
1700 ret
= cmd_run_ctx_connect_comp_ports(ctx
,
1701 g_comp
, bt_component_filter_get_output_port_count
,
1702 bt_component_filter_get_output_port_by_index
);
1715 const char *bt_graph_status_str(enum bt_graph_status status
)
1718 case BT_GRAPH_STATUS_CANCELED
:
1719 return "BT_GRAPH_STATUS_CANCELED";
1720 case BT_GRAPH_STATUS_AGAIN
:
1721 return "BT_GRAPH_STATUS_AGAIN";
1722 case BT_GRAPH_STATUS_END
:
1723 return "BT_GRAPH_STATUS_END";
1724 case BT_GRAPH_STATUS_OK
:
1725 return "BT_GRAPH_STATUS_OK";
1726 case BT_GRAPH_STATUS_ALREADY_IN_A_GRAPH
:
1727 return "BT_GRAPH_STATUS_ALREADY_IN_A_GRAPH";
1728 case BT_GRAPH_STATUS_INVALID
:
1729 return "BT_GRAPH_STATUS_INVALID";
1730 case BT_GRAPH_STATUS_NO_SINK
:
1731 return "BT_GRAPH_STATUS_NO_SINK";
1732 case BT_GRAPH_STATUS_ERROR
:
1733 return "BT_GRAPH_STATUS_ERROR";
1740 int cmd_run(struct bt_config
*cfg
)
1743 struct cmd_run_ctx ctx
= { 0 };
1745 /* Initialize the command's context and the graph object */
1746 if (cmd_run_ctx_init(&ctx
, cfg
)) {
1747 BT_LOGE_STR("Cannot initialize the command's context.");
1748 fprintf(stderr
, "Cannot initialize the command's context\n");
1753 BT_LOGI_STR("Canceled by user before creating components.");
1757 BT_LOGI_STR("Creating components.");
1759 /* Create the requested component instances */
1760 if (cmd_run_ctx_create_components(&ctx
)) {
1761 BT_LOGE_STR("Cannot create components.");
1762 fprintf(stderr
, "Cannot create components\n");
1767 BT_LOGI_STR("Canceled by user before connecting components.");
1771 BT_LOGI_STR("Connecting components.");
1773 /* Connect the initially visible component ports */
1774 if (cmd_run_ctx_connect_ports(&ctx
)) {
1775 BT_LOGE_STR("Cannot connect initial component ports.");
1776 fprintf(stderr
, "Cannot connect initial component ports\n");
1781 BT_LOGI_STR("Canceled by user before running the graph.");
1785 BT_LOGI_STR("Running the graph.");
1789 enum bt_graph_status graph_status
= bt_graph_run(ctx
.graph
);
1792 * Reset console in case something messed with console
1793 * codes during the graph's execution.
1795 printf("%s", bt_common_color_reset());
1797 fprintf(stderr
, "%s", bt_common_color_reset());
1798 BT_LOGV("bt_graph_run() returned: status=%s",
1799 bt_graph_status_str(graph_status
));
1801 switch (graph_status
) {
1802 case BT_GRAPH_STATUS_OK
:
1804 case BT_GRAPH_STATUS_CANCELED
:
1805 BT_LOGI_STR("Graph was canceled by user.");
1807 case BT_GRAPH_STATUS_AGAIN
:
1808 if (bt_graph_is_canceled(ctx
.graph
)) {
1809 BT_LOGI_STR("Graph was canceled by user.");
1813 if (cfg
->cmd_data
.run
.retry_duration_us
> 0) {
1814 BT_LOGV("Got BT_GRAPH_STATUS_AGAIN: sleeping: "
1816 cfg
->cmd_data
.run
.retry_duration_us
);
1818 if (usleep(cfg
->cmd_data
.run
.retry_duration_us
)) {
1819 if (bt_graph_is_canceled(ctx
.graph
)) {
1820 BT_LOGI_STR("Graph was canceled by user.");
1826 case BT_COMPONENT_STATUS_END
:
1829 BT_LOGE_STR("Graph failed to complete successfully");
1830 fprintf(stderr
, "Graph failed to complete successfully\n");
1843 cmd_run_ctx_destroy(&ctx
);
1848 void warn_command_name_and_directory_clash(struct bt_config
*cfg
)
1850 const char *env_clash
;
1852 if (!cfg
->command_name
) {
1856 env_clash
= getenv(ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH
);
1857 if (env_clash
&& strcmp(env_clash
, "0") == 0) {
1861 if (g_file_test(cfg
->command_name
,
1862 G_FILE_TEST_EXISTS
| G_FILE_TEST_IS_DIR
)) {
1863 fprintf(stderr
, "\nNOTE: The `%s` command was executed. If you meant to convert a\n",
1865 fprintf(stderr
, "trace located in the local `%s` directory, please use:\n",
1867 fprintf(stderr
, "\n");
1868 fprintf(stderr
, " babeltrace convert %s [OPTIONS]\n",
1874 void init_log_level(void)
1876 bt_cli_log_level
= bt_log_get_level_from_env("BABELTRACE_CLI_LOG_LEVEL");
1879 void set_sigint_handler(void)
1881 struct sigaction new_action
, old_action
;
1883 new_action
.sa_handler
= sigint_handler
;
1884 sigemptyset(&new_action
.sa_mask
);
1885 new_action
.sa_flags
= 0;
1886 sigaction(SIGINT
, NULL
, &old_action
);
1888 if (old_action
.sa_handler
!= SIG_IGN
) {
1889 sigaction(SIGINT
, &new_action
, NULL
);
1893 int main(int argc
, const char **argv
)
1897 struct bt_config
*cfg
;
1900 set_sigint_handler();
1902 cfg
= bt_config_cli_args_create_with_default(argc
, argv
, &retcode
);
1905 /* Quit without errors; typically usage/version */
1907 BT_LOGI_STR("Quitting without errors.");
1912 BT_LOGE("Command-line error: retcode=%d", retcode
);
1917 BT_LOGE_STR("Failed to create a valid Babeltrace configuration.");
1918 fprintf(stderr
, "Failed to create Babeltrace configuration\n");
1924 bt_cli_log_level
= BT_LOGGING_LEVEL_VERBOSE
;
1925 bt_logging_set_global_level(BT_LOGGING_LEVEL_VERBOSE
);
1926 // TODO: for backward compat., set the log level
1927 // environment variables of the known plugins
1929 } else if (cfg
->debug
) {
1930 bt_cli_log_level
= BT_LOGGING_LEVEL_DEBUG
;
1931 bt_logging_set_global_level(BT_LOGGING_LEVEL_DEBUG
);
1932 // TODO: for backward compat., set the log level
1933 // environment variables of the known plugins
1937 babeltrace_debug
= cfg
->debug
;
1938 babeltrace_verbose
= cfg
->verbose
;
1941 if (cfg
->command_needs_plugins
) {
1942 ret
= load_all_plugins(cfg
->plugin_paths
);
1944 BT_LOGE("Failed to load plugins: ret=%d", ret
);
1950 BT_LOGI("Executing command: cmd=%d, command-name=\"%s\"",
1951 cfg
->command
, cfg
->command_name
);
1953 switch (cfg
->command
) {
1954 case BT_CONFIG_COMMAND_RUN
:
1957 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
1958 ret
= cmd_list_plugins(cfg
);
1960 case BT_CONFIG_COMMAND_HELP
:
1961 ret
= cmd_help(cfg
);
1963 case BT_CONFIG_COMMAND_QUERY
:
1964 ret
= cmd_query(cfg
);
1966 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
1967 ret
= cmd_print_ctf_metadata(cfg
);
1969 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
1970 ret
= cmd_print_lttng_live_sessions(cfg
);
1973 BT_LOGF("Invalid/unknown command: cmd=%d", cfg
->command
);
1977 BT_LOGI("Command completed: cmd=%d, command-name=\"%s\", ret=%d",
1978 cfg
->command
, cfg
->command_name
, ret
);
1979 warn_command_name_and_directory_clash(cfg
);
1980 retcode
= ret
? 1 : 0;