2 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
4 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
25 #define BT_LOG_TAG "CLI"
28 #include <babeltrace2/babeltrace.h>
29 #include "common/common.h"
39 #include "babeltrace2-cfg.h"
40 #include "babeltrace2-cfg-cli-args.h"
41 #include "babeltrace2-cfg-cli-args-default.h"
43 #define ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH "BABELTRACE_CLI_WARN_COMMAND_NAME_DIRECTORY_CLASH"
44 #define ENV_BABELTRACE_CLI_LOG_LEVEL "BABELTRACE_CLI_LOG_LEVEL"
45 #define NSEC_PER_SEC 1000000000LL
48 * Known environment variable names for the log levels of the project's
51 static const char* log_level_env_var_names
[] = {
52 "BABELTRACE_COMMON_LOG_LEVEL",
53 "BABELTRACE_COMPAT_LOG_LEVEL",
54 "BABELTRACE_CTFSER_LOG_LEVEL",
55 "BABELTRACE_FD_CACHE_LOG_LEVEL",
56 "BABELTRACE_FLT_LTTNG_UTILS_DEBUG_INFO_LOG_LEVEL",
57 "BABELTRACE_FLT_UTILS_COUNTER_LOG_LEVEL",
58 "BABELTRACE_FLT_UTILS_MUXER_LOG_LEVEL",
59 "BABELTRACE_FLT_UTILS_TRIMMER_LOG_LEVEL",
60 "BABELTRACE_PLUGIN_CTF_BFCR_LOG_LEVEL",
61 "BABELTRACE_PLUGIN_CTF_METADATA_LOG_LEVEL",
62 "BABELTRACE_PLUGIN_CTF_MSG_ITER_LOG_LEVEL",
63 "BABELTRACE_PLUGIN_CTF_UTILS_LOG_LEVEL",
64 "BABELTRACE_PYTHON_BT2_LOG_LEVEL",
65 "BABELTRACE_SINK_CTF_FS_LOG_LEVEL",
66 "BABELTRACE_SINK_TEXT_PRETTY_LOG_LEVEL",
67 "BABELTRACE_SINK_TEXT_DETAILS_LOG_LEVEL",
68 "BABELTRACE_SRC_CTF_FS_LOG_LEVEL",
69 "BABELTRACE_SRC_CTF_LTTNG_LIVE_LOG_LEVEL",
70 "BABELTRACE_SRC_TEXT_DMESG_LOG_LEVEL",
74 /* Application's processing graph (weak) */
75 static bt_graph
*the_graph
;
76 static bt_query_executor
*the_query_executor
;
77 static bool canceled
= false;
79 GPtrArray
*loaded_plugins
;
86 BOOL WINAPI
signal_handler(DWORD signal
) {
88 bt_graph_cancel(the_graph
);
97 void set_signal_handler(void)
99 if (!SetConsoleCtrlHandler(signal_handler
, TRUE
)) {
100 BT_LOGE("Failed to set the ctrl+c handler.");
104 #else /* __MINGW32__ */
107 void signal_handler(int signum
)
109 if (signum
!= SIGINT
) {
114 bt_graph_cancel(the_graph
);
117 if (the_query_executor
) {
118 bt_query_executor_cancel(the_query_executor
);
125 void set_signal_handler(void)
127 struct sigaction new_action
, old_action
;
129 new_action
.sa_handler
= signal_handler
;
130 sigemptyset(&new_action
.sa_mask
);
131 new_action
.sa_flags
= 0;
132 sigaction(SIGINT
, NULL
, &old_action
);
134 if (old_action
.sa_handler
!= SIG_IGN
) {
135 sigaction(SIGINT
, &new_action
, NULL
);
139 #endif /* __MINGW32__ */
142 void init_static_data(void)
144 loaded_plugins
= g_ptr_array_new_with_free_func(
145 (GDestroyNotify
) bt_object_put_ref
);
149 void fini_static_data(void)
151 g_ptr_array_free(loaded_plugins
, TRUE
);
155 int create_the_query_executor(void)
159 the_query_executor
= bt_query_executor_create();
160 if (!the_query_executor
) {
161 BT_LOGE_STR("Cannot create a query executor.");
169 void destroy_the_query_executor(void)
171 BT_QUERY_EXECUTOR_PUT_REF_AND_RESET(the_query_executor
);
175 int query(const bt_component_class
*comp_cls
, const char *obj
,
176 const bt_value
*params
, const bt_value
**user_result
,
177 const char **fail_reason
)
179 const bt_value
*result
= NULL
;
180 bt_query_executor_status status
;
181 *fail_reason
= "unknown error";
184 BT_ASSERT(fail_reason
);
185 BT_ASSERT(user_result
);
186 ret
= create_the_query_executor();
188 /* create_the_query_executor() logs errors */
193 BT_LOGI("Canceled by user before executing the query: "
194 "comp-cls-addr=%p, comp-cls-name=\"%s\", "
195 "query-obj=\"%s\"", comp_cls
,
196 bt_component_class_get_name(comp_cls
), obj
);
197 *fail_reason
= "canceled by user";
202 status
= bt_query_executor_query(the_query_executor
,
203 comp_cls
, obj
, params
, &result
);
205 case BT_QUERY_EXECUTOR_STATUS_OK
:
207 case BT_QUERY_EXECUTOR_STATUS_AGAIN
:
209 const uint64_t sleep_time_us
= 100000;
211 /* Wait 100 ms and retry */
212 BT_LOGV("Got BT_QUERY_EXECUTOR_STATUS_AGAIN: sleeping: "
213 "time-us=%" PRIu64
, sleep_time_us
);
215 if (usleep(sleep_time_us
)) {
216 if (bt_query_executor_is_canceled(the_query_executor
)) {
217 BT_LOGI("Query was canceled by user: "
218 "comp-cls-addr=%p, comp-cls-name=\"%s\", "
219 "query-obj=\"%s\"", comp_cls
,
220 bt_component_class_get_name(comp_cls
),
222 *fail_reason
= "canceled by user";
229 case BT_QUERY_EXECUTOR_STATUS_CANCELED
:
230 *fail_reason
= "canceled by user";
232 case BT_QUERY_EXECUTOR_STATUS_ERROR
:
234 case BT_QUERY_EXECUTOR_STATUS_INVALID_OBJECT
:
235 *fail_reason
= "invalid or unknown query object";
237 case BT_QUERY_EXECUTOR_STATUS_INVALID_PARAMS
:
238 *fail_reason
= "invalid query parameters";
240 case BT_QUERY_EXECUTOR_STATUS_UNSUPPORTED
:
241 *fail_reason
= "unsupported action";
243 case BT_QUERY_EXECUTOR_STATUS_NOMEM
:
244 *fail_reason
= "not enough memory";
247 BT_LOGF("Unknown query status: status=%d", status
);
253 *user_result
= result
;
261 destroy_the_query_executor();
262 bt_value_put_ref(result
);
267 const bt_plugin
*find_plugin(const char *name
)
270 const bt_plugin
*plugin
= NULL
;
273 BT_LOGD("Finding plugin: name=\"%s\"", name
);
275 for (i
= 0; i
< loaded_plugins
->len
; i
++) {
276 plugin
= g_ptr_array_index(loaded_plugins
, i
);
278 if (strcmp(name
, bt_plugin_get_name(plugin
)) == 0) {
285 if (BT_LOG_ON_DEBUG
) {
287 BT_LOGD("Found plugin: plugin-addr=%p", plugin
);
289 BT_LOGD("Cannot find plugin.");
293 bt_plugin_get_ref(plugin
);
297 typedef const void *(*plugin_borrow_comp_cls_func_t
)(
298 const bt_plugin
*, const char *);
301 const void *find_component_class_from_plugin(const char *plugin_name
,
302 const char *comp_class_name
,
303 plugin_borrow_comp_cls_func_t plugin_borrow_comp_cls_func
)
305 const void *comp_class
= NULL
;
306 const bt_plugin
*plugin
;
308 BT_LOGD("Finding component class: plugin-name=\"%s\", "
309 "comp-cls-name=\"%s\"", plugin_name
, comp_class_name
);
311 plugin
= find_plugin(plugin_name
);
316 comp_class
= plugin_borrow_comp_cls_func(plugin
, comp_class_name
);
317 bt_object_get_ref(comp_class
);
318 BT_PLUGIN_PUT_REF_AND_RESET(plugin
);
321 if (BT_LOG_ON_DEBUG
) {
323 BT_LOGD("Found component class: comp-cls-addr=%p",
326 BT_LOGD("Cannot find source component class.");
334 const bt_component_class_source
*find_source_component_class(
335 const char *plugin_name
, const char *comp_class_name
)
337 return (const void *) find_component_class_from_plugin(
338 plugin_name
, comp_class_name
,
339 (plugin_borrow_comp_cls_func_t
)
340 bt_plugin_borrow_source_component_class_by_name_const
);
344 const bt_component_class_filter
*find_filter_component_class(
345 const char *plugin_name
, const char *comp_class_name
)
347 return (const void *) find_component_class_from_plugin(
348 plugin_name
, comp_class_name
,
349 (plugin_borrow_comp_cls_func_t
)
350 bt_plugin_borrow_filter_component_class_by_name_const
);
354 const bt_component_class_sink
*find_sink_component_class(
355 const char *plugin_name
, const char *comp_class_name
)
357 return (const void *) find_component_class_from_plugin(plugin_name
,
359 (plugin_borrow_comp_cls_func_t
)
360 bt_plugin_borrow_sink_component_class_by_name_const
);
364 const bt_component_class
*find_component_class(const char *plugin_name
,
365 const char *comp_class_name
,
366 bt_component_class_type comp_class_type
)
368 const bt_component_class
*comp_cls
= NULL
;
370 switch (comp_class_type
) {
371 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
372 comp_cls
= bt_component_class_source_as_component_class_const(find_source_component_class(plugin_name
, comp_class_name
));
374 case BT_COMPONENT_CLASS_TYPE_FILTER
:
375 comp_cls
= bt_component_class_filter_as_component_class_const(find_filter_component_class(plugin_name
, comp_class_name
));
377 case BT_COMPONENT_CLASS_TYPE_SINK
:
378 comp_cls
= bt_component_class_sink_as_component_class_const(find_sink_component_class(plugin_name
, comp_class_name
));
388 void print_indent(FILE *fp
, size_t indent
)
392 for (i
= 0; i
< indent
; i
++) {
398 const char *component_type_str(bt_component_class_type type
)
401 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
403 case BT_COMPONENT_CLASS_TYPE_SINK
:
405 case BT_COMPONENT_CLASS_TYPE_FILTER
:
413 void print_plugin_comp_cls_opt(FILE *fh
, const char *plugin_name
,
414 const char *comp_cls_name
, bt_component_class_type type
)
416 GString
*shell_plugin_name
= NULL
;
417 GString
*shell_comp_cls_name
= NULL
;
419 shell_plugin_name
= bt_common_shell_quote(plugin_name
, false);
420 if (!shell_plugin_name
) {
424 shell_comp_cls_name
= bt_common_shell_quote(comp_cls_name
, false);
425 if (!shell_comp_cls_name
) {
429 fprintf(fh
, "'%s%s%s%s.%s%s%s.%s%s%s'",
430 bt_common_color_bold(),
431 bt_common_color_fg_cyan(),
432 component_type_str(type
),
433 bt_common_color_fg_default(),
434 bt_common_color_fg_blue(),
435 shell_plugin_name
->str
,
436 bt_common_color_fg_default(),
437 bt_common_color_fg_yellow(),
438 shell_comp_cls_name
->str
,
439 bt_common_color_reset());
442 if (shell_plugin_name
) {
443 g_string_free(shell_plugin_name
, TRUE
);
446 if (shell_comp_cls_name
) {
447 g_string_free(shell_comp_cls_name
, TRUE
);
452 void print_value(FILE *, const bt_value
*, size_t);
455 void print_value_rec(FILE *, const bt_value
*, size_t);
457 struct print_map_value_data
{
463 bt_bool
print_map_value(const char *key
, const bt_value
*object
,
466 struct print_map_value_data
*print_map_value_data
= data
;
468 print_indent(print_map_value_data
->fp
, print_map_value_data
->indent
);
469 fprintf(print_map_value_data
->fp
, "%s: ", key
);
472 if (bt_value_is_array(object
) &&
473 bt_value_array_is_empty(object
)) {
474 fprintf(print_map_value_data
->fp
, "[ ]\n");
478 if (bt_value_is_map(object
) &&
479 bt_value_map_is_empty(object
)) {
480 fprintf(print_map_value_data
->fp
, "{ }\n");
484 if (bt_value_is_array(object
) ||
485 bt_value_is_map(object
)) {
486 fprintf(print_map_value_data
->fp
, "\n");
489 print_value_rec(print_map_value_data
->fp
, object
,
490 print_map_value_data
->indent
+ 2);
495 void print_value_rec(FILE *fp
, const bt_value
*value
, size_t indent
)
509 switch (bt_value_get_type(value
)) {
510 case BT_VALUE_TYPE_NULL
:
511 fprintf(fp
, "%snull%s\n", bt_common_color_bold(),
512 bt_common_color_reset());
514 case BT_VALUE_TYPE_BOOL
:
515 bool_val
= bt_value_bool_get(value
);
516 fprintf(fp
, "%s%s%s%s\n", bt_common_color_bold(),
517 bt_common_color_fg_cyan(), bool_val
? "yes" : "no",
518 bt_common_color_reset());
520 case BT_VALUE_TYPE_UNSIGNED_INTEGER
:
521 uint_val
= bt_value_unsigned_integer_get(value
);
522 fprintf(fp
, "%s%s%" PRIu64
"%s\n", bt_common_color_bold(),
523 bt_common_color_fg_red(), uint_val
,
524 bt_common_color_reset());
526 case BT_VALUE_TYPE_SIGNED_INTEGER
:
527 int_val
= bt_value_signed_integer_get(value
);
528 fprintf(fp
, "%s%s%" PRId64
"%s\n", bt_common_color_bold(),
529 bt_common_color_fg_red(), int_val
,
530 bt_common_color_reset());
532 case BT_VALUE_TYPE_REAL
:
533 dbl_val
= bt_value_real_get(value
);
534 fprintf(fp
, "%s%s%lf%s\n", bt_common_color_bold(),
535 bt_common_color_fg_red(), dbl_val
,
536 bt_common_color_reset());
538 case BT_VALUE_TYPE_STRING
:
539 str_val
= bt_value_string_get(value
);
540 fprintf(fp
, "%s%s%s%s\n", bt_common_color_bold(),
541 bt_common_color_fg_green(), str_val
,
542 bt_common_color_reset());
544 case BT_VALUE_TYPE_ARRAY
:
545 size
= bt_value_array_get_size(value
);
551 print_indent(fp
, indent
);
552 fprintf(fp
, "[ ]\n");
556 for (i
= 0; i
< size
; i
++) {
557 const bt_value
*element
=
558 bt_value_array_borrow_element_by_index_const(
564 print_indent(fp
, indent
);
567 if (bt_value_is_array(element
) &&
568 bt_value_array_is_empty(element
)) {
569 fprintf(fp
, "[ ]\n");
573 if (bt_value_is_map(element
) &&
574 bt_value_map_is_empty(element
)) {
575 fprintf(fp
, "{ }\n");
579 if (bt_value_is_array(element
) ||
580 bt_value_is_map(element
)) {
584 print_value_rec(fp
, element
, indent
+ 2);
587 case BT_VALUE_TYPE_MAP
:
589 struct print_map_value_data data
= {
594 if (bt_value_map_is_empty(value
)) {
595 print_indent(fp
, indent
);
596 fprintf(fp
, "{ }\n");
600 bt_value_map_foreach_entry_const(value
, print_map_value
, &data
);
609 BT_LOGE("Error printing value of type %s.",
610 bt_common_value_type_string(bt_value_get_type(value
)));
614 void print_value(FILE *fp
, const bt_value
*value
, size_t indent
)
616 if (!bt_value_is_array(value
) && !bt_value_is_map(value
)) {
617 print_indent(fp
, indent
);
620 print_value_rec(fp
, value
, indent
);
624 void print_bt_config_component(struct bt_config_component
*bt_config_component
)
626 fprintf(stderr
, " ");
627 print_plugin_comp_cls_opt(stderr
, bt_config_component
->plugin_name
->str
,
628 bt_config_component
->comp_cls_name
->str
,
629 bt_config_component
->type
);
630 fprintf(stderr
, ":\n");
632 if (bt_config_component
->instance_name
->len
> 0) {
633 fprintf(stderr
, " Name: %s\n",
634 bt_config_component
->instance_name
->str
);
637 fprintf(stderr
, " Parameters:\n");
638 print_value(stderr
, bt_config_component
->params
, 8);
642 void print_bt_config_components(GPtrArray
*array
)
646 for (i
= 0; i
< array
->len
; i
++) {
647 struct bt_config_component
*cfg_component
=
648 bt_config_get_component(array
, i
);
649 print_bt_config_component(cfg_component
);
650 BT_OBJECT_PUT_REF_AND_RESET(cfg_component
);
655 void print_plugin_paths(const bt_value
*plugin_paths
)
657 fprintf(stderr
, " Plugin paths:\n");
658 print_value(stderr
, plugin_paths
, 4);
662 void print_cfg_run(struct bt_config
*cfg
)
666 print_plugin_paths(cfg
->plugin_paths
);
667 fprintf(stderr
, " Source component instances:\n");
668 print_bt_config_components(cfg
->cmd_data
.run
.sources
);
670 if (cfg
->cmd_data
.run
.filters
->len
> 0) {
671 fprintf(stderr
, " Filter component instances:\n");
672 print_bt_config_components(cfg
->cmd_data
.run
.filters
);
675 fprintf(stderr
, " Sink component instances:\n");
676 print_bt_config_components(cfg
->cmd_data
.run
.sinks
);
677 fprintf(stderr
, " Connections:\n");
679 for (i
= 0; i
< cfg
->cmd_data
.run
.connections
->len
; i
++) {
680 struct bt_config_connection
*cfg_connection
=
681 g_ptr_array_index(cfg
->cmd_data
.run
.connections
,
684 fprintf(stderr
, " %s%s%s -> %s%s%s\n",
685 cfg_connection
->upstream_comp_name
->str
,
686 cfg_connection
->upstream_port_glob
->len
> 0 ? "." : "",
687 cfg_connection
->upstream_port_glob
->str
,
688 cfg_connection
->downstream_comp_name
->str
,
689 cfg_connection
->downstream_port_glob
->len
> 0 ? "." : "",
690 cfg_connection
->downstream_port_glob
->str
);
695 void print_cfg_list_plugins(struct bt_config
*cfg
)
697 print_plugin_paths(cfg
->plugin_paths
);
701 void print_cfg_help(struct bt_config
*cfg
)
703 print_plugin_paths(cfg
->plugin_paths
);
707 void print_cfg_print_ctf_metadata(struct bt_config
*cfg
)
709 print_plugin_paths(cfg
->plugin_paths
);
710 fprintf(stderr
, " Path: %s\n",
711 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
715 void print_cfg_print_lttng_live_sessions(struct bt_config
*cfg
)
717 print_plugin_paths(cfg
->plugin_paths
);
718 fprintf(stderr
, " URL: %s\n",
719 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
723 void print_cfg_query(struct bt_config
*cfg
)
725 print_plugin_paths(cfg
->plugin_paths
);
726 fprintf(stderr
, " Object: `%s`\n", cfg
->cmd_data
.query
.object
->str
);
727 fprintf(stderr
, " Component class:\n");
728 print_bt_config_component(cfg
->cmd_data
.query
.cfg_component
);
732 void print_cfg(struct bt_config
*cfg
)
734 if (!BT_LOG_ON_INFO
) {
738 BT_LOGI_STR("Configuration:");
739 fprintf(stderr
, " Debug mode: %s\n", cfg
->debug
? "yes" : "no");
740 fprintf(stderr
, " Verbose mode: %s\n", cfg
->verbose
? "yes" : "no");
742 switch (cfg
->command
) {
743 case BT_CONFIG_COMMAND_RUN
:
746 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
747 print_cfg_list_plugins(cfg
);
749 case BT_CONFIG_COMMAND_HELP
:
752 case BT_CONFIG_COMMAND_QUERY
:
753 print_cfg_query(cfg
);
755 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
756 print_cfg_print_ctf_metadata(cfg
);
758 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
759 print_cfg_print_lttng_live_sessions(cfg
);
767 void add_to_loaded_plugins(const bt_plugin_set
*plugin_set
)
772 count
= bt_plugin_set_get_plugin_count(plugin_set
);
773 BT_ASSERT(count
>= 0);
775 for (i
= 0; i
< count
; i
++) {
776 const bt_plugin
*plugin
=
777 bt_plugin_set_borrow_plugin_by_index_const(plugin_set
, i
);
778 const bt_plugin
*loaded_plugin
=
779 find_plugin(bt_plugin_get_name(plugin
));
784 BT_LOGI("Not using plugin: another one already exists with the same name: "
785 "plugin-name=\"%s\", plugin-path=\"%s\", "
786 "existing-plugin-path=\"%s\"",
787 bt_plugin_get_name(plugin
),
788 bt_plugin_get_path(plugin
),
789 bt_plugin_get_path(loaded_plugin
));
790 bt_plugin_put_ref(loaded_plugin
);
792 /* Add to global array. */
793 BT_LOGD("Adding plugin to loaded plugins: plugin-path=\"%s\"",
794 bt_plugin_get_name(plugin
));
795 bt_plugin_get_ref(plugin
);
796 g_ptr_array_add(loaded_plugins
, (void *) plugin
);
802 int load_dynamic_plugins(const bt_value
*plugin_paths
)
804 int nr_paths
, i
, ret
= 0;
806 nr_paths
= bt_value_array_get_size(plugin_paths
);
808 BT_LOGE_STR("Cannot load dynamic plugins: no plugin path.");
813 BT_LOGI("Loading dynamic plugins.");
815 for (i
= 0; i
< nr_paths
; i
++) {
816 const bt_value
*plugin_path_value
= NULL
;
817 const char *plugin_path
;
818 const bt_plugin_set
*plugin_set
;
821 bt_value_array_borrow_element_by_index_const(
823 plugin_path
= bt_value_string_get(plugin_path_value
);
826 * Skip this if the directory does not exist because
827 * bt_plugin_find_all_from_dir() expects an existing
830 if (!g_file_test(plugin_path
, G_FILE_TEST_IS_DIR
)) {
831 BT_LOGV("Skipping nonexistent directory path: "
832 "path=\"%s\"", plugin_path
);
836 plugin_set
= bt_plugin_find_all_from_dir(plugin_path
, false);
838 BT_LOGD("Unable to load dynamic plugins: path=\"%s\"",
843 add_to_loaded_plugins(plugin_set
);
844 bt_plugin_set_put_ref(plugin_set
);
851 int load_static_plugins(void)
854 const bt_plugin_set
*plugin_set
;
856 BT_LOGI("Loading static plugins.");
857 plugin_set
= bt_plugin_find_all_from_static();
859 BT_LOGE("Unable to load static plugins.");
864 add_to_loaded_plugins(plugin_set
);
865 bt_plugin_set_put_ref(plugin_set
);
871 int load_all_plugins(const bt_value
*plugin_paths
)
875 if (load_dynamic_plugins(plugin_paths
)) {
880 if (load_static_plugins()) {
885 BT_LOGI("Loaded all plugins: count=%u", loaded_plugins
->len
);
892 void print_plugin_info(const bt_plugin
*plugin
)
894 unsigned int major
, minor
, patch
;
896 bt_property_availability version_avail
;
897 const char *plugin_name
;
901 const char *plugin_description
;
903 plugin_name
= bt_plugin_get_name(plugin
);
904 path
= bt_plugin_get_path(plugin
);
905 author
= bt_plugin_get_author(plugin
);
906 license
= bt_plugin_get_license(plugin
);
907 plugin_description
= bt_plugin_get_description(plugin
);
908 version_avail
= bt_plugin_get_version(plugin
, &major
, &minor
,
910 printf("%s%s%s%s:\n", bt_common_color_bold(),
911 bt_common_color_fg_blue(), plugin_name
,
912 bt_common_color_reset());
914 printf(" %sPath%s: %s\n", bt_common_color_bold(),
915 bt_common_color_reset(), path
);
920 if (version_avail
== BT_PROPERTY_AVAILABILITY_AVAILABLE
) {
921 printf(" %sVersion%s: %u.%u.%u",
922 bt_common_color_bold(), bt_common_color_reset(),
923 major
, minor
, patch
);
932 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
933 bt_common_color_reset(),
934 plugin_description
? plugin_description
: "(None)");
935 printf(" %sAuthor%s: %s\n", bt_common_color_bold(),
936 bt_common_color_reset(), author
? author
: "(Unknown)");
937 printf(" %sLicense%s: %s\n", bt_common_color_bold(),
938 bt_common_color_reset(),
939 license
? license
: "(Unknown)");
943 int cmd_query(struct bt_config
*cfg
)
946 const bt_component_class
*comp_cls
= NULL
;
947 const bt_value
*results
= NULL
;
948 const char *fail_reason
= NULL
;
950 comp_cls
= find_component_class(
951 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
952 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
953 cfg
->cmd_data
.query
.cfg_component
->type
);
955 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
956 "comp-cls-name=\"%s\", comp-cls-type=%d",
957 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
958 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
959 cfg
->cmd_data
.query
.cfg_component
->type
);
960 fprintf(stderr
, "%s%sCannot find component class %s",
961 bt_common_color_bold(),
962 bt_common_color_fg_red(),
963 bt_common_color_reset());
964 print_plugin_comp_cls_opt(stderr
,
965 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
966 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
967 cfg
->cmd_data
.query
.cfg_component
->type
);
968 fprintf(stderr
, "\n");
973 ret
= query(comp_cls
, cfg
->cmd_data
.query
.object
->str
,
974 cfg
->cmd_data
.query
.cfg_component
->params
,
975 &results
, &fail_reason
);
980 print_value(stdout
, results
, 0);
984 BT_LOGE("Failed to query component class: %s: plugin-name=\"%s\", "
985 "comp-cls-name=\"%s\", comp-cls-type=%d "
986 "object=\"%s\"", fail_reason
,
987 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
988 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
989 cfg
->cmd_data
.query
.cfg_component
->type
,
990 cfg
->cmd_data
.query
.object
->str
);
991 fprintf(stderr
, "%s%sFailed to query info to %s",
992 bt_common_color_bold(),
993 bt_common_color_fg_red(),
994 bt_common_color_reset());
995 print_plugin_comp_cls_opt(stderr
,
996 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
997 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
998 cfg
->cmd_data
.query
.cfg_component
->type
);
999 fprintf(stderr
, "%s%s with object `%s`: %s%s\n",
1000 bt_common_color_bold(),
1001 bt_common_color_fg_red(),
1002 cfg
->cmd_data
.query
.object
->str
,
1004 bt_common_color_reset());
1008 bt_component_class_put_ref(comp_cls
);
1009 bt_value_put_ref(results
);
1014 void print_component_class_help(const char *plugin_name
,
1015 const bt_component_class
*comp_cls
)
1017 const char *comp_class_name
=
1018 bt_component_class_get_name(comp_cls
);
1019 const char *comp_class_description
=
1020 bt_component_class_get_description(comp_cls
);
1021 const char *comp_class_help
=
1022 bt_component_class_get_help(comp_cls
);
1023 bt_component_class_type type
=
1024 bt_component_class_get_type(comp_cls
);
1026 print_plugin_comp_cls_opt(stdout
, plugin_name
, comp_class_name
, type
);
1028 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
1029 bt_common_color_reset(),
1030 comp_class_description
? comp_class_description
: "(None)");
1032 if (comp_class_help
) {
1033 printf("\n%s\n", comp_class_help
);
1038 int cmd_help(struct bt_config
*cfg
)
1041 const bt_plugin
*plugin
= NULL
;
1042 const bt_component_class
*needed_comp_cls
= NULL
;
1044 plugin
= find_plugin(cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
1046 BT_LOGE("Cannot find plugin: plugin-name=\"%s\"",
1047 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
1048 fprintf(stderr
, "%s%sCannot find plugin %s%s%s\n",
1049 bt_common_color_bold(), bt_common_color_fg_red(),
1050 bt_common_color_fg_blue(),
1051 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1052 bt_common_color_reset());
1057 print_plugin_info(plugin
);
1058 printf(" %sSource component classes%s: %d\n",
1059 bt_common_color_bold(),
1060 bt_common_color_reset(),
1061 (int) bt_plugin_get_source_component_class_count(plugin
));
1062 printf(" %sFilter component classes%s: %d\n",
1063 bt_common_color_bold(),
1064 bt_common_color_reset(),
1065 (int) bt_plugin_get_filter_component_class_count(plugin
));
1066 printf(" %sSink component classes%s: %d\n",
1067 bt_common_color_bold(),
1068 bt_common_color_reset(),
1069 (int) bt_plugin_get_sink_component_class_count(plugin
));
1071 if (strlen(cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
) == 0) {
1072 /* Plugin help only */
1076 needed_comp_cls
= find_component_class(
1077 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1078 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
1079 cfg
->cmd_data
.help
.cfg_component
->type
);
1080 if (!needed_comp_cls
) {
1081 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
1082 "comp-cls-name=\"%s\", comp-cls-type=%d",
1083 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1084 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
1085 cfg
->cmd_data
.help
.cfg_component
->type
);
1086 fprintf(stderr
, "\n%s%sCannot find component class %s",
1087 bt_common_color_bold(),
1088 bt_common_color_fg_red(),
1089 bt_common_color_reset());
1090 print_plugin_comp_cls_opt(stderr
,
1091 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1092 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
1093 cfg
->cmd_data
.help
.cfg_component
->type
);
1094 fprintf(stderr
, "\n");
1100 print_component_class_help(
1101 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1105 bt_component_class_put_ref(needed_comp_cls
);
1106 bt_plugin_put_ref(plugin
);
1110 typedef void *(* plugin_borrow_comp_cls_by_index_func_t
)(const bt_plugin
*,
1112 typedef const bt_component_class
*(* spec_comp_cls_borrow_comp_cls_func_t
)(
1115 void cmd_list_plugins_print_component_classes(const bt_plugin
*plugin
,
1116 const char *cc_type_name
, uint64_t count
,
1117 plugin_borrow_comp_cls_by_index_func_t borrow_comp_cls_by_index_func
,
1118 spec_comp_cls_borrow_comp_cls_func_t spec_comp_cls_borrow_comp_cls_func
)
1123 printf(" %s%s component classes%s: (none)\n",
1124 bt_common_color_bold(),
1126 bt_common_color_reset());
1129 printf(" %s%s component classes%s:\n",
1130 bt_common_color_bold(),
1132 bt_common_color_reset());
1135 for (i
= 0; i
< count
; i
++) {
1136 const bt_component_class
*comp_class
=
1137 spec_comp_cls_borrow_comp_cls_func(
1138 borrow_comp_cls_by_index_func(plugin
, i
));
1139 const char *comp_class_name
=
1140 bt_component_class_get_name(comp_class
);
1141 const char *comp_class_description
=
1142 bt_component_class_get_description(comp_class
);
1143 bt_component_class_type type
=
1144 bt_component_class_get_type(comp_class
);
1147 print_plugin_comp_cls_opt(stdout
,
1148 bt_plugin_get_name(plugin
), comp_class_name
,
1151 if (comp_class_description
) {
1152 printf(": %s", comp_class_description
);
1163 int cmd_list_plugins(struct bt_config
*cfg
)
1166 int plugins_count
, component_classes_count
= 0, i
;
1168 printf("From the following plugin paths:\n\n");
1169 print_value(stdout
, cfg
->plugin_paths
, 2);
1171 plugins_count
= loaded_plugins
->len
;
1172 if (plugins_count
== 0) {
1173 printf("No plugins found.\n");
1177 for (i
= 0; i
< plugins_count
; i
++) {
1178 const bt_plugin
*plugin
= g_ptr_array_index(loaded_plugins
, i
);
1180 component_classes_count
+=
1181 bt_plugin_get_source_component_class_count(plugin
) +
1182 bt_plugin_get_filter_component_class_count(plugin
) +
1183 bt_plugin_get_sink_component_class_count(plugin
);
1186 printf("Found %s%d%s component classes in %s%d%s plugins.\n",
1187 bt_common_color_bold(),
1188 component_classes_count
,
1189 bt_common_color_reset(),
1190 bt_common_color_bold(),
1192 bt_common_color_reset());
1194 for (i
= 0; i
< plugins_count
; i
++) {
1195 const bt_plugin
*plugin
= g_ptr_array_index(loaded_plugins
, i
);
1198 print_plugin_info(plugin
);
1199 cmd_list_plugins_print_component_classes(plugin
, "Source",
1200 bt_plugin_get_source_component_class_count(plugin
),
1201 (plugin_borrow_comp_cls_by_index_func_t
)
1202 bt_plugin_borrow_source_component_class_by_index_const
,
1203 (spec_comp_cls_borrow_comp_cls_func_t
)
1204 bt_component_class_source_as_component_class
);
1205 cmd_list_plugins_print_component_classes(plugin
, "Filter",
1206 bt_plugin_get_filter_component_class_count(plugin
),
1207 (plugin_borrow_comp_cls_by_index_func_t
)
1208 bt_plugin_borrow_filter_component_class_by_index_const
,
1209 (spec_comp_cls_borrow_comp_cls_func_t
)
1210 bt_component_class_filter_as_component_class
);
1211 cmd_list_plugins_print_component_classes(plugin
, "Sink",
1212 bt_plugin_get_sink_component_class_count(plugin
),
1213 (plugin_borrow_comp_cls_by_index_func_t
)
1214 bt_plugin_borrow_sink_component_class_by_index_const
,
1215 (spec_comp_cls_borrow_comp_cls_func_t
)
1216 bt_component_class_sink_as_component_class
);
1224 int cmd_print_lttng_live_sessions(struct bt_config
*cfg
)
1227 const bt_component_class
*comp_cls
= NULL
;
1228 const bt_value
*results
= NULL
;
1229 bt_value
*params
= NULL
;
1230 const bt_value
*map
= NULL
;
1231 const bt_value
*v
= NULL
;
1232 static const char * const plugin_name
= "ctf";
1233 static const char * const comp_cls_name
= "lttng-live";
1234 static const bt_component_class_type comp_cls_type
=
1235 BT_COMPONENT_CLASS_TYPE_SOURCE
;
1236 int64_t array_size
, i
;
1237 const char *fail_reason
= NULL
;
1238 FILE *out_stream
= stdout
;
1240 BT_ASSERT(cfg
->cmd_data
.print_lttng_live_sessions
.url
);
1241 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1244 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
1245 "comp-cls-name=\"%s\", comp-cls-type=%d",
1246 plugin_name
, comp_cls_name
,
1247 BT_COMPONENT_CLASS_TYPE_SOURCE
);
1248 fprintf(stderr
, "%s%sCannot find component class %s",
1249 bt_common_color_bold(),
1250 bt_common_color_fg_red(),
1251 bt_common_color_reset());
1252 print_plugin_comp_cls_opt(stderr
, plugin_name
,
1253 comp_cls_name
, comp_cls_type
);
1254 fprintf(stderr
, "\n");
1258 params
= bt_value_map_create();
1263 ret
= bt_value_map_insert_string_entry(params
, "url",
1264 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
1269 ret
= query(comp_cls
, "sessions", params
,
1270 &results
, &fail_reason
);
1277 if (!bt_value_is_array(results
)) {
1278 BT_LOGE_STR("Expecting an array for sessions query.");
1279 fprintf(stderr
, "%s%sUnexpected type returned by session query%s\n",
1280 bt_common_color_bold(),
1281 bt_common_color_fg_red(),
1282 bt_common_color_reset());
1286 if (cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->len
> 0) {
1288 fopen(cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
,
1292 BT_LOGE_ERRNO("Cannot open file for writing",
1294 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
1299 array_size
= bt_value_array_get_size(results
);
1300 for (i
= 0; i
< array_size
; i
++) {
1301 const char *url_text
;
1302 int64_t timer_us
, streams
, clients
;
1304 map
= bt_value_array_borrow_element_by_index_const(results
, i
);
1306 BT_LOGE_STR("Unexpected empty array entry.");
1309 if (!bt_value_is_map(map
)) {
1310 BT_LOGE_STR("Unexpected entry type.");
1314 v
= bt_value_map_borrow_entry_value_const(map
, "url");
1316 BT_LOGE_STR("Unexpected empty array \"url\" entry.");
1319 url_text
= bt_value_string_get(v
);
1320 fprintf(out_stream
, "%s", url_text
);
1321 v
= bt_value_map_borrow_entry_value_const(map
, "timer-us");
1323 BT_LOGE_STR("Unexpected empty array \"timer-us\" entry.");
1326 timer_us
= bt_value_signed_integer_get(v
);
1327 fprintf(out_stream
, " (timer = %" PRIu64
", ", timer_us
);
1328 v
= bt_value_map_borrow_entry_value_const(map
, "stream-count");
1330 BT_LOGE_STR("Unexpected empty array \"stream-count\" entry.");
1333 streams
= bt_value_signed_integer_get(v
);
1334 fprintf(out_stream
, "%" PRIu64
" stream(s), ", streams
);
1335 v
= bt_value_map_borrow_entry_value_const(map
, "client-count");
1337 BT_LOGE_STR("Unexpected empty array \"client-count\" entry.");
1340 clients
= bt_value_signed_integer_get(v
);
1341 fprintf(out_stream
, "%" PRIu64
" client(s) connected)\n", clients
);
1347 BT_LOGE("Failed to query for sessions: %s", fail_reason
);
1348 fprintf(stderr
, "%s%sFailed to request sessions: %s%s\n",
1349 bt_common_color_bold(),
1350 bt_common_color_fg_red(),
1352 bt_common_color_reset());
1358 bt_value_put_ref(results
);
1359 bt_value_put_ref(params
);
1360 bt_component_class_put_ref(comp_cls
);
1362 if (out_stream
&& out_stream
!= stdout
) {
1363 int fclose_ret
= fclose(out_stream
);
1366 BT_LOGE_ERRNO("Cannot close file stream",
1368 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
1376 int cmd_print_ctf_metadata(struct bt_config
*cfg
)
1379 const bt_component_class
*comp_cls
= NULL
;
1380 const bt_value
*results
= NULL
;
1381 bt_value
*params
= NULL
;
1382 const bt_value
*metadata_text_value
= NULL
;
1383 const char *metadata_text
= NULL
;
1384 static const char * const plugin_name
= "ctf";
1385 static const char * const comp_cls_name
= "fs";
1386 static const bt_component_class_type comp_cls_type
=
1387 BT_COMPONENT_CLASS_TYPE_SOURCE
;
1388 const char *fail_reason
= NULL
;
1389 FILE *out_stream
= stdout
;
1391 BT_ASSERT(cfg
->cmd_data
.print_ctf_metadata
.path
);
1392 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1395 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
1396 "comp-cls-name=\"%s\", comp-cls-type=%d",
1397 plugin_name
, comp_cls_name
,
1398 BT_COMPONENT_CLASS_TYPE_SOURCE
);
1399 fprintf(stderr
, "%s%sCannot find component class %s",
1400 bt_common_color_bold(),
1401 bt_common_color_fg_red(),
1402 bt_common_color_reset());
1403 print_plugin_comp_cls_opt(stderr
, plugin_name
,
1404 comp_cls_name
, comp_cls_type
);
1405 fprintf(stderr
, "\n");
1410 params
= bt_value_map_create();
1416 ret
= bt_value_map_insert_string_entry(params
, "path",
1417 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
1423 ret
= query(comp_cls
, "metadata-info",
1424 params
, &results
, &fail_reason
);
1429 metadata_text_value
= bt_value_map_borrow_entry_value_const(results
,
1431 if (!metadata_text_value
) {
1432 BT_LOGE_STR("Cannot find `text` string value in the resulting metadata info object.");
1437 metadata_text
= bt_value_string_get(metadata_text_value
);
1439 if (cfg
->cmd_data
.print_ctf_metadata
.output_path
->len
> 0) {
1441 fopen(cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
,
1445 BT_LOGE_ERRNO("Cannot open file for writing",
1447 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1452 ret
= fprintf(out_stream
, "%s\n", metadata_text
);
1454 BT_LOGE("Cannot write whole metadata text to output stream: "
1465 BT_LOGE("Failed to query for metadata info: %s", fail_reason
);
1466 fprintf(stderr
, "%s%sFailed to request metadata info: %s%s\n",
1467 bt_common_color_bold(),
1468 bt_common_color_fg_red(),
1470 bt_common_color_reset());
1473 bt_value_put_ref(results
);
1474 bt_value_put_ref(params
);
1475 bt_component_class_put_ref(comp_cls
);
1477 if (out_stream
&& out_stream
!= stdout
) {
1478 int fclose_ret
= fclose(out_stream
);
1481 BT_LOGE_ERRNO("Cannot close file stream",
1483 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1491 char *instance_name
;
1495 struct trace_range
{
1496 uint64_t intersection_range_begin_ns
;
1497 uint64_t intersection_range_end_ns
;
1501 guint
port_id_hash(gconstpointer v
)
1503 const struct port_id
*id
= v
;
1505 BT_ASSERT(id
->instance_name
);
1506 BT_ASSERT(id
->port_name
);
1508 return g_str_hash(id
->instance_name
) ^ g_str_hash(id
->port_name
);
1512 gboolean
port_id_equal(gconstpointer v1
, gconstpointer v2
)
1514 const struct port_id
*id1
= v1
;
1515 const struct port_id
*id2
= v2
;
1517 return !strcmp(id1
->instance_name
, id2
->instance_name
) &&
1518 !strcmp(id1
->port_name
, id2
->port_name
);
1522 void port_id_destroy(gpointer data
)
1524 struct port_id
*id
= data
;
1526 free(id
->instance_name
);
1527 free(id
->port_name
);
1532 void trace_range_destroy(gpointer data
)
1537 struct cmd_run_ctx
{
1539 GHashTable
*src_components
;
1542 GHashTable
*flt_components
;
1545 GHashTable
*sink_components
;
1551 struct bt_config
*cfg
;
1555 bool stream_intersection_mode
;
1558 * Association of struct port_id -> struct trace_range.
1560 GHashTable
*intersections
;
1563 /* Returns a timestamp of the form "(-)s.ns" */
1565 char *s_from_ns(int64_t ns
)
1570 int64_t ts_sec_abs
, ts_nsec_abs
;
1571 int64_t ts_sec
= ns
/ NSEC_PER_SEC
;
1572 int64_t ts_nsec
= ns
% NSEC_PER_SEC
;
1574 if (ts_sec
>= 0 && ts_nsec
>= 0) {
1575 is_negative
= false;
1576 ts_sec_abs
= ts_sec
;
1577 ts_nsec_abs
= ts_nsec
;
1578 } else if (ts_sec
> 0 && ts_nsec
< 0) {
1579 is_negative
= false;
1580 ts_sec_abs
= ts_sec
- 1;
1581 ts_nsec_abs
= NSEC_PER_SEC
+ ts_nsec
;
1582 } else if (ts_sec
== 0 && ts_nsec
< 0) {
1584 ts_sec_abs
= ts_sec
;
1585 ts_nsec_abs
= -ts_nsec
;
1586 } else if (ts_sec
< 0 && ts_nsec
> 0) {
1588 ts_sec_abs
= -(ts_sec
+ 1);
1589 ts_nsec_abs
= NSEC_PER_SEC
- ts_nsec
;
1590 } else if (ts_sec
< 0 && ts_nsec
== 0) {
1592 ts_sec_abs
= -ts_sec
;
1593 ts_nsec_abs
= ts_nsec
;
1594 } else { /* (ts_sec < 0 && ts_nsec < 0) */
1596 ts_sec_abs
= -ts_sec
;
1597 ts_nsec_abs
= -ts_nsec
;
1600 ret
= asprintf(&s_ret
, "%s%" PRId64
".%09" PRId64
,
1601 is_negative
? "-" : "", ts_sec_abs
, ts_nsec_abs
);
1609 int cmd_run_ctx_connect_upstream_port_to_downstream_component(
1610 struct cmd_run_ctx
*ctx
,
1611 const bt_component
*upstream_comp
,
1612 const bt_port_output
*out_upstream_port
,
1613 struct bt_config_connection
*cfg_conn
)
1615 typedef uint64_t (*input_port_count_func_t
)(void *);
1616 typedef const bt_port_input
*(*borrow_input_port_by_index_func_t
)(
1617 const void *, uint64_t);
1618 const bt_port
*upstream_port
=
1619 bt_port_output_as_port_const(out_upstream_port
);
1622 GQuark downstreamp_comp_name_quark
;
1623 void *downstream_comp
;
1624 uint64_t downstream_port_count
;
1626 input_port_count_func_t port_count_fn
;
1627 borrow_input_port_by_index_func_t port_by_index_fn
;
1628 bt_graph_status status
= BT_GRAPH_STATUS_ERROR
;
1629 bool insert_trimmer
= false;
1630 bt_value
*trimmer_params
= NULL
;
1631 char *intersection_begin
= NULL
;
1632 char *intersection_end
= NULL
;
1633 const bt_component_filter
*trimmer
= NULL
;
1634 const bt_component_class_filter
*trimmer_class
= NULL
;
1635 const bt_port_input
*trimmer_input
= NULL
;
1636 const bt_port_output
*trimmer_output
= NULL
;
1638 if (ctx
->intersections
&&
1639 bt_component_get_class_type(upstream_comp
) ==
1640 BT_COMPONENT_CLASS_TYPE_SOURCE
) {
1641 struct trace_range
*range
;
1642 struct port_id port_id
= {
1643 .instance_name
= (char *) bt_component_get_name(upstream_comp
),
1644 .port_name
= (char *) bt_port_get_name(upstream_port
)
1647 if (!port_id
.instance_name
|| !port_id
.port_name
) {
1651 range
= (struct trace_range
*) g_hash_table_lookup(
1652 ctx
->intersections
, &port_id
);
1654 bt_value_status status
;
1656 intersection_begin
= s_from_ns(
1657 range
->intersection_range_begin_ns
);
1658 intersection_end
= s_from_ns(
1659 range
->intersection_range_end_ns
);
1660 if (!intersection_begin
|| !intersection_end
) {
1661 BT_LOGE_STR("Cannot create trimmer argument timestamp string.");
1665 insert_trimmer
= true;
1666 trimmer_params
= bt_value_map_create();
1667 if (!trimmer_params
) {
1671 status
= bt_value_map_insert_string_entry(
1672 trimmer_params
, "begin", intersection_begin
);
1673 if (status
!= BT_VALUE_STATUS_OK
) {
1676 status
= bt_value_map_insert_string_entry(
1678 "end", intersection_end
);
1679 if (status
!= BT_VALUE_STATUS_OK
) {
1684 trimmer_class
= find_filter_component_class("utils", "trimmer");
1685 if (!trimmer_class
) {
1690 BT_LOGI("Connecting upstream port to the next available downstream port: "
1691 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1692 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1693 upstream_port
, bt_port_get_name(upstream_port
),
1694 cfg_conn
->downstream_comp_name
->str
,
1695 cfg_conn
->arg
->str
);
1696 downstreamp_comp_name_quark
= g_quark_from_string(
1697 cfg_conn
->downstream_comp_name
->str
);
1698 BT_ASSERT(downstreamp_comp_name_quark
> 0);
1699 downstream_comp
= g_hash_table_lookup(ctx
->flt_components
,
1700 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1701 port_count_fn
= (input_port_count_func_t
)
1702 bt_component_filter_get_input_port_count
;
1703 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1704 bt_component_filter_borrow_input_port_by_index_const
;
1706 if (!downstream_comp
) {
1707 downstream_comp
= g_hash_table_lookup(ctx
->sink_components
,
1708 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1709 port_count_fn
= (input_port_count_func_t
)
1710 bt_component_sink_get_input_port_count
;
1711 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1712 bt_component_sink_borrow_input_port_by_index_const
;
1715 if (!downstream_comp
) {
1716 BT_LOGE("Cannot find downstream component: comp-name=\"%s\", "
1717 "conn-arg=\"%s\"", cfg_conn
->downstream_comp_name
->str
,
1718 cfg_conn
->arg
->str
);
1719 fprintf(stderr
, "Cannot create connection: cannot find downstream component: %s\n",
1720 cfg_conn
->arg
->str
);
1724 downstream_port_count
= port_count_fn(downstream_comp
);
1726 for (i
= 0; i
< downstream_port_count
; i
++) {
1727 const bt_port_input
*in_downstream_port
=
1728 port_by_index_fn(downstream_comp
, i
);
1729 const bt_port
*downstream_port
=
1730 bt_port_input_as_port_const(in_downstream_port
);
1731 const char *upstream_port_name
;
1732 const char *downstream_port_name
;
1734 BT_ASSERT(downstream_port
);
1736 /* Skip port if it's already connected. */
1737 if (bt_port_is_connected(downstream_port
)) {
1738 BT_LOGD("Skipping downstream port: already connected: "
1739 "port-addr=%p, port-name=\"%s\"",
1741 bt_port_get_name(downstream_port
));
1745 downstream_port_name
= bt_port_get_name(downstream_port
);
1746 BT_ASSERT(downstream_port_name
);
1747 upstream_port_name
= bt_port_get_name(upstream_port
);
1748 BT_ASSERT(upstream_port_name
);
1750 if (!bt_common_star_glob_match(
1751 cfg_conn
->downstream_port_glob
->str
, SIZE_MAX
,
1752 downstream_port_name
, SIZE_MAX
)) {
1756 if (insert_trimmer
) {
1758 * In order to insert the trimmer between the
1759 * two components that were being connected, we
1760 * create a connection configuration entry which
1761 * describes a connection from the trimmer's
1762 * output to the original input that was being
1765 * Hence, the creation of the trimmer will cause
1766 * the graph "new port" listener to establish
1767 * all downstream connections as its output port
1768 * is connected. We will then establish the
1769 * connection between the original upstream
1770 * source and the trimmer.
1772 char *trimmer_name
= NULL
;
1773 bt_graph_status graph_status
;
1775 ret
= asprintf(&trimmer_name
,
1776 "stream-intersection-trimmer-%s",
1777 upstream_port_name
);
1783 ctx
->connect_ports
= false;
1784 graph_status
= bt_graph_add_filter_component(
1785 ctx
->graph
, trimmer_class
, trimmer_name
,
1786 trimmer_params
, &trimmer
);
1788 if (graph_status
!= BT_GRAPH_STATUS_OK
) {
1794 bt_component_filter_borrow_input_port_by_index_const(
1796 if (!trimmer_input
) {
1800 bt_component_filter_borrow_output_port_by_index_const(
1802 if (!trimmer_output
) {
1807 * Replace the current downstream port by the trimmer's
1810 in_downstream_port
= trimmer_input
;
1812 bt_port_input_as_port_const(in_downstream_port
);
1813 downstream_port_name
= bt_port_get_name(
1815 BT_ASSERT(downstream_port_name
);
1818 /* We have a winner! */
1819 status
= bt_graph_connect_ports(ctx
->graph
,
1820 out_upstream_port
, in_downstream_port
, NULL
);
1821 downstream_port
= NULL
;
1823 case BT_GRAPH_STATUS_OK
:
1825 case BT_GRAPH_STATUS_CANCELED
:
1826 BT_LOGI_STR("Graph was canceled by user.");
1827 status
= BT_GRAPH_STATUS_OK
;
1829 case BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION
:
1830 BT_LOGE("A component refused a connection to one of its ports: "
1831 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1832 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1833 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1834 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1836 upstream_comp
, bt_component_get_name(upstream_comp
),
1837 upstream_port
, bt_port_get_name(upstream_port
),
1838 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1839 downstream_port
, downstream_port_name
,
1840 cfg_conn
->arg
->str
);
1842 "A component refused a connection to one of its ports (`%s` to `%s`): %s\n",
1843 bt_port_get_name(upstream_port
),
1844 downstream_port_name
,
1845 cfg_conn
->arg
->str
);
1848 BT_LOGE("Cannot create connection: graph refuses to connect ports: "
1849 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1850 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1851 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1852 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1854 upstream_comp
, bt_component_get_name(upstream_comp
),
1855 upstream_port
, bt_port_get_name(upstream_port
),
1856 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1857 downstream_port
, downstream_port_name
,
1858 cfg_conn
->arg
->str
);
1860 "Cannot create connection: graph refuses to connect ports (`%s` to `%s`): %s\n",
1861 bt_port_get_name(upstream_port
),
1862 downstream_port_name
,
1863 cfg_conn
->arg
->str
);
1867 BT_LOGI("Connected component ports: "
1868 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1869 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1870 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1871 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1873 upstream_comp
, bt_component_get_name(upstream_comp
),
1874 upstream_port
, bt_port_get_name(upstream_port
),
1875 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1876 downstream_port
, downstream_port_name
,
1877 cfg_conn
->arg
->str
);
1879 if (insert_trimmer
) {
1881 * The first connection, from the source to the trimmer,
1882 * has been done. We now connect the trimmer to the
1883 * original downstream port.
1885 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1887 bt_component_filter_as_component_const(trimmer
),
1888 trimmer_output
, cfg_conn
);
1892 ctx
->connect_ports
= true;
1896 * We found a matching downstream port: the search is
1902 /* No downstream port found */
1903 BT_LOGE("Cannot create connection: cannot find a matching downstream port for upstream port: "
1904 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1905 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1906 upstream_port
, bt_port_get_name(upstream_port
),
1907 cfg_conn
->downstream_comp_name
->str
,
1908 cfg_conn
->arg
->str
);
1910 "Cannot create connection: cannot find a matching downstream port for upstream port `%s`: %s\n",
1911 bt_port_get_name(upstream_port
), cfg_conn
->arg
->str
);
1917 free(intersection_begin
);
1918 free(intersection_end
);
1919 BT_VALUE_PUT_REF_AND_RESET(trimmer_params
);
1920 BT_COMPONENT_CLASS_FILTER_PUT_REF_AND_RESET(trimmer_class
);
1921 BT_COMPONENT_FILTER_PUT_REF_AND_RESET(trimmer
);
1926 int cmd_run_ctx_connect_upstream_port(struct cmd_run_ctx
*ctx
,
1927 const bt_port_output
*upstream_port
)
1930 const char *upstream_port_name
;
1931 const char *upstream_comp_name
;
1932 const bt_component
*upstream_comp
= NULL
;
1936 BT_ASSERT(upstream_port
);
1937 upstream_port_name
= bt_port_get_name(
1938 bt_port_output_as_port_const(upstream_port
));
1939 BT_ASSERT(upstream_port_name
);
1940 upstream_comp
= bt_port_borrow_component_const(
1941 bt_port_output_as_port_const(upstream_port
));
1942 if (!upstream_comp
) {
1943 BT_LOGW("Upstream port to connect is not part of a component: "
1944 "port-addr=%p, port-name=\"%s\"",
1945 upstream_port
, upstream_port_name
);
1950 upstream_comp_name
= bt_component_get_name(upstream_comp
);
1951 BT_ASSERT(upstream_comp_name
);
1952 BT_LOGI("Connecting upstream port: comp-addr=%p, comp-name=\"%s\", "
1953 "port-addr=%p, port-name=\"%s\"",
1954 upstream_comp
, upstream_comp_name
,
1955 upstream_port
, upstream_port_name
);
1957 for (i
= 0; i
< ctx
->cfg
->cmd_data
.run
.connections
->len
; i
++) {
1958 struct bt_config_connection
*cfg_conn
=
1960 ctx
->cfg
->cmd_data
.run
.connections
, i
);
1962 if (strcmp(cfg_conn
->upstream_comp_name
->str
,
1963 upstream_comp_name
)) {
1967 if (!bt_common_star_glob_match(
1968 cfg_conn
->upstream_port_glob
->str
,
1969 SIZE_MAX
, upstream_port_name
, SIZE_MAX
)) {
1973 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1974 ctx
, upstream_comp
, upstream_port
, cfg_conn
);
1976 BT_LOGE("Cannot connect upstream port: "
1977 "port-addr=%p, port-name=\"%s\"",
1979 upstream_port_name
);
1981 "Cannot connect port `%s` of component `%s` to a downstream port: %s\n",
1984 cfg_conn
->arg
->str
);
1990 BT_LOGE("Cannot connect upstream port: port does not match any connection argument: "
1991 "port-addr=%p, port-name=\"%s\"", upstream_port
,
1992 upstream_port_name
);
1994 "Cannot create connection: upstream port `%s` does not match any connection\n",
1995 upstream_port_name
);
2005 bt_graph_listener_status
2006 graph_output_port_added_listener(struct cmd_run_ctx
*ctx
,
2007 const bt_port_output
*out_port
)
2009 const bt_component
*comp
;
2010 const bt_port
*port
= bt_port_output_as_port_const(out_port
);
2011 bt_graph_listener_status ret
= BT_GRAPH_LISTENER_STATUS_OK
;
2013 comp
= bt_port_borrow_component_const(port
);
2014 BT_LOGI("Port added to a graph's component: comp-addr=%p, "
2015 "comp-name=\"%s\", port-addr=%p, port-name=\"%s\"",
2016 comp
, comp
? bt_component_get_name(comp
) : "",
2017 port
, bt_port_get_name(port
));
2019 if (!ctx
->connect_ports
) {
2024 BT_LOGW_STR("Port has no component.");
2028 if (bt_port_is_connected(port
)) {
2029 BT_LOGW_STR("Port is already connected.");
2033 if (cmd_run_ctx_connect_upstream_port(ctx
, out_port
)) {
2034 BT_LOGF_STR("Cannot connect upstream port.");
2035 fprintf(stderr
, "Added port could not be connected: aborting\n");
2036 ret
= BT_GRAPH_LISTENER_STATUS_ERROR
;
2045 bt_graph_listener_status
graph_source_output_port_added_listener(
2046 const bt_component_source
*component
,
2047 const bt_port_output
*port
, void *data
)
2049 return graph_output_port_added_listener(data
, port
);
2053 bt_graph_listener_status
graph_filter_output_port_added_listener(
2054 const bt_component_filter
*component
,
2055 const bt_port_output
*port
, void *data
)
2057 return graph_output_port_added_listener(data
, port
);
2061 void cmd_run_ctx_destroy(struct cmd_run_ctx
*ctx
)
2067 if (ctx
->src_components
) {
2068 g_hash_table_destroy(ctx
->src_components
);
2069 ctx
->src_components
= NULL
;
2072 if (ctx
->flt_components
) {
2073 g_hash_table_destroy(ctx
->flt_components
);
2074 ctx
->flt_components
= NULL
;
2077 if (ctx
->sink_components
) {
2078 g_hash_table_destroy(ctx
->sink_components
);
2079 ctx
->sink_components
= NULL
;
2082 if (ctx
->intersections
) {
2083 g_hash_table_destroy(ctx
->intersections
);
2084 ctx
->intersections
= NULL
;
2087 BT_GRAPH_PUT_REF_AND_RESET(ctx
->graph
);
2093 int cmd_run_ctx_init(struct cmd_run_ctx
*ctx
, struct bt_config
*cfg
)
2096 bt_graph_status status
;
2099 ctx
->connect_ports
= false;
2100 ctx
->src_components
= g_hash_table_new_full(g_direct_hash
,
2101 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
2102 if (!ctx
->src_components
) {
2106 ctx
->flt_components
= g_hash_table_new_full(g_direct_hash
,
2107 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
2108 if (!ctx
->flt_components
) {
2112 ctx
->sink_components
= g_hash_table_new_full(g_direct_hash
,
2113 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
2114 if (!ctx
->sink_components
) {
2118 if (cfg
->cmd_data
.run
.stream_intersection_mode
) {
2119 ctx
->stream_intersection_mode
= true;
2120 ctx
->intersections
= g_hash_table_new_full(port_id_hash
,
2121 port_id_equal
, port_id_destroy
, trace_range_destroy
);
2122 if (!ctx
->intersections
) {
2127 ctx
->graph
= bt_graph_create();
2132 the_graph
= ctx
->graph
;
2133 status
= bt_graph_add_source_component_output_port_added_listener(
2134 ctx
->graph
, graph_source_output_port_added_listener
, NULL
, ctx
,
2136 if (status
!= BT_GRAPH_STATUS_OK
) {
2137 BT_LOGE_STR("Cannot add \"port added\" listener to graph.");
2141 status
= bt_graph_add_filter_component_output_port_added_listener(
2142 ctx
->graph
, graph_filter_output_port_added_listener
, NULL
, ctx
,
2144 if (status
!= BT_GRAPH_STATUS_OK
) {
2145 BT_LOGE_STR("Cannot add \"port added\" listener to graph.");
2152 cmd_run_ctx_destroy(ctx
);
2160 int set_stream_intersections(struct cmd_run_ctx
*ctx
,
2161 struct bt_config_component
*cfg_comp
,
2162 const bt_component_class_source
*src_comp_cls
)
2166 int64_t trace_count
;
2167 const char *path
= NULL
;
2168 const bt_value
*query_result
= NULL
;
2169 const bt_value
*trace_info
= NULL
;
2170 const bt_value
*intersection_range
= NULL
;
2171 const bt_value
*intersection_begin
= NULL
;
2172 const bt_value
*intersection_end
= NULL
;
2173 const bt_value
*stream_infos
= NULL
;
2174 const bt_value
*stream_info
= NULL
;
2175 struct port_id
*port_id
= NULL
;
2176 struct trace_range
*trace_range
= NULL
;
2177 const char *fail_reason
= NULL
;
2178 const bt_component_class
*comp_cls
=
2179 bt_component_class_source_as_component_class_const(src_comp_cls
);
2181 ret
= query(comp_cls
, "trace-info",
2182 cfg_comp
->params
, &query_result
,
2185 BT_LOGD("Component class does not support the `trace-info` query: %s: "
2186 "comp-class-name=\"%s\"", fail_reason
,
2187 bt_component_class_get_name(comp_cls
));
2192 BT_ASSERT(query_result
);
2194 if (!bt_value_is_array(query_result
)) {
2195 BT_LOGD("Unexpected format of \'trace-info\' query result: "
2196 "component-class-name=%s",
2197 bt_component_class_get_name(comp_cls
));
2202 trace_count
= bt_value_array_get_size(query_result
);
2203 if (trace_count
< 0) {
2208 for (trace_idx
= 0; trace_idx
< trace_count
; trace_idx
++) {
2210 uint64_t stream_idx
;
2211 int64_t stream_count
;
2213 trace_info
= bt_value_array_borrow_element_by_index_const(
2214 query_result
, trace_idx
);
2215 if (!trace_info
|| !bt_value_is_map(trace_info
)) {
2217 BT_LOGD_STR("Cannot retrieve trace from query result.");
2221 intersection_range
= bt_value_map_borrow_entry_value_const(
2222 trace_info
, "intersection-range-ns");
2223 if (!intersection_range
) {
2225 BT_LOGD_STR("Cannot retrieve \'intersetion-range-ns\' field from query result.");
2229 intersection_begin
= bt_value_map_borrow_entry_value_const(intersection_range
,
2231 if (!intersection_begin
) {
2233 BT_LOGD_STR("Cannot retrieve intersection-range-ns \'begin\' field from query result.");
2237 intersection_end
= bt_value_map_borrow_entry_value_const(intersection_range
,
2239 if (!intersection_end
) {
2241 BT_LOGD_STR("Cannot retrieve intersection-range-ns \'end\' field from query result.");
2245 begin
= bt_value_signed_integer_get(intersection_begin
);
2246 end
= bt_value_signed_integer_get(intersection_end
);
2248 if (begin
< 0 || end
< 0 || end
< begin
) {
2249 BT_LOGW("Invalid trace stream intersection values: "
2250 "intersection-range-ns:begin=%" PRId64
2251 ", intersection-range-ns:end=%" PRId64
,
2257 stream_infos
= bt_value_map_borrow_entry_value_const(trace_info
,
2259 if (!stream_infos
|| !bt_value_is_array(stream_infos
)) {
2261 BT_LOGD_STR("Cannot retrieve stream information from trace in query result.");
2265 stream_count
= bt_value_array_get_size(stream_infos
);
2266 if (stream_count
< 0) {
2271 for (stream_idx
= 0; stream_idx
< stream_count
; stream_idx
++) {
2272 const bt_value
*port_name
;
2274 port_id
= g_new0(struct port_id
, 1);
2277 BT_LOGE_STR("Cannot allocate memory for port_id structure.");
2280 port_id
->instance_name
= strdup(cfg_comp
->instance_name
->str
);
2281 if (!port_id
->instance_name
) {
2283 BT_LOGE_STR("Cannot allocate memory for port_id component instance name.");
2287 trace_range
= g_new0(struct trace_range
, 1);
2290 BT_LOGE_STR("Cannot allocate memory for trace_range structure.");
2293 trace_range
->intersection_range_begin_ns
= begin
;
2294 trace_range
->intersection_range_end_ns
= end
;
2296 stream_info
= bt_value_array_borrow_element_by_index_const(
2297 stream_infos
, stream_idx
);
2298 if (!stream_info
|| !bt_value_is_map(stream_info
)) {
2300 BT_LOGD_STR("Cannot retrieve stream informations from trace in query result.");
2304 port_name
= bt_value_map_borrow_entry_value_const(stream_info
, "port-name");
2305 if (!port_name
|| !bt_value_is_string(port_name
)) {
2307 BT_LOGD_STR("Cannot retrieve port name in query result.");
2311 port_id
->port_name
= g_strdup(bt_value_string_get(port_name
));
2312 if (!port_id
->port_name
) {
2314 BT_LOGE_STR("Cannot allocate memory for port_id port_name.");
2318 BT_LOGD("Inserting stream intersection ");
2320 g_hash_table_insert(ctx
->intersections
, port_id
, trace_range
);
2330 fprintf(stderr
, "%s%sCannot determine stream intersection of trace at path \'%s\'.%s\n",
2331 bt_common_color_bold(),
2332 bt_common_color_fg_yellow(),
2333 path
? path
: "(unknown)",
2334 bt_common_color_reset());
2336 bt_value_put_ref(query_result
);
2338 g_free(trace_range
);
2343 int cmd_run_ctx_create_components_from_config_components(
2344 struct cmd_run_ctx
*ctx
, GPtrArray
*cfg_components
)
2347 const void *comp_cls
= NULL
;
2348 const void *comp
= NULL
;
2351 for (i
= 0; i
< cfg_components
->len
; i
++) {
2352 struct bt_config_component
*cfg_comp
=
2353 g_ptr_array_index(cfg_components
, i
);
2356 switch (cfg_comp
->type
) {
2357 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2358 comp_cls
= find_source_component_class(
2359 cfg_comp
->plugin_name
->str
,
2360 cfg_comp
->comp_cls_name
->str
);
2362 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2363 comp_cls
= find_filter_component_class(
2364 cfg_comp
->plugin_name
->str
,
2365 cfg_comp
->comp_cls_name
->str
);
2367 case BT_COMPONENT_CLASS_TYPE_SINK
:
2368 comp_cls
= find_sink_component_class(
2369 cfg_comp
->plugin_name
->str
,
2370 cfg_comp
->comp_cls_name
->str
);
2377 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
2378 "comp-cls-name=\"%s\", comp-cls-type=%d",
2379 cfg_comp
->plugin_name
->str
,
2380 cfg_comp
->comp_cls_name
->str
,
2382 fprintf(stderr
, "%s%sCannot find component class %s",
2383 bt_common_color_bold(),
2384 bt_common_color_fg_red(),
2385 bt_common_color_reset());
2386 print_plugin_comp_cls_opt(stderr
,
2387 cfg_comp
->plugin_name
->str
,
2388 cfg_comp
->comp_cls_name
->str
,
2390 fprintf(stderr
, "\n");
2394 switch (cfg_comp
->type
) {
2395 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2396 ret
= bt_graph_add_source_component(ctx
->graph
,
2397 comp_cls
, cfg_comp
->instance_name
->str
,
2401 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2402 ret
= bt_graph_add_filter_component(ctx
->graph
,
2403 comp_cls
, cfg_comp
->instance_name
->str
,
2407 case BT_COMPONENT_CLASS_TYPE_SINK
:
2408 ret
= bt_graph_add_sink_component(ctx
->graph
,
2409 comp_cls
, cfg_comp
->instance_name
->str
,
2418 BT_LOGE("Cannot create component: plugin-name=\"%s\", "
2419 "comp-cls-name=\"%s\", comp-cls-type=%d, "
2421 cfg_comp
->plugin_name
->str
,
2422 cfg_comp
->comp_cls_name
->str
,
2423 cfg_comp
->type
, cfg_comp
->instance_name
->str
);
2424 fprintf(stderr
, "%s%sCannot create component `%s`%s\n",
2425 bt_common_color_bold(),
2426 bt_common_color_fg_red(),
2427 cfg_comp
->instance_name
->str
,
2428 bt_common_color_reset());
2432 if (ctx
->stream_intersection_mode
&&
2433 cfg_comp
->type
== BT_COMPONENT_CLASS_TYPE_SOURCE
) {
2434 ret
= set_stream_intersections(ctx
, cfg_comp
, comp_cls
);
2440 BT_LOGI("Created and inserted component: comp-addr=%p, comp-name=\"%s\"",
2441 comp
, cfg_comp
->instance_name
->str
);
2442 quark
= g_quark_from_string(cfg_comp
->instance_name
->str
);
2443 BT_ASSERT(quark
> 0);
2445 switch (cfg_comp
->type
) {
2446 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2447 g_hash_table_insert(ctx
->src_components
,
2448 GUINT_TO_POINTER(quark
), (void *) comp
);
2450 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2451 g_hash_table_insert(ctx
->flt_components
,
2452 GUINT_TO_POINTER(quark
), (void *) comp
);
2454 case BT_COMPONENT_CLASS_TYPE_SINK
:
2455 g_hash_table_insert(ctx
->sink_components
,
2456 GUINT_TO_POINTER(quark
), (void *) comp
);
2463 BT_OBJECT_PUT_REF_AND_RESET(comp_cls
);
2472 bt_object_put_ref(comp
);
2473 bt_object_put_ref(comp_cls
);
2478 int cmd_run_ctx_create_components(struct cmd_run_ctx
*ctx
)
2483 * Make sure that, during this phase, our graph's "port added"
2484 * listener does not connect ports while we are creating the
2485 * components because we have a special, initial phase for
2488 ctx
->connect_ports
= false;
2490 ret
= cmd_run_ctx_create_components_from_config_components(
2491 ctx
, ctx
->cfg
->cmd_data
.run
.sources
);
2497 ret
= cmd_run_ctx_create_components_from_config_components(
2498 ctx
, ctx
->cfg
->cmd_data
.run
.filters
);
2504 ret
= cmd_run_ctx_create_components_from_config_components(
2505 ctx
, ctx
->cfg
->cmd_data
.run
.sinks
);
2515 typedef uint64_t (*output_port_count_func_t
)(const void *);
2516 typedef const bt_port_output
*(*borrow_output_port_by_index_func_t
)(
2517 const void *, uint64_t);
2520 int cmd_run_ctx_connect_comp_ports(struct cmd_run_ctx
*ctx
,
2521 void *comp
, output_port_count_func_t port_count_fn
,
2522 borrow_output_port_by_index_func_t port_by_index_fn
)
2528 count
= port_count_fn(comp
);
2530 for (i
= 0; i
< count
; i
++) {
2531 const bt_port_output
*upstream_port
= port_by_index_fn(comp
, i
);
2533 BT_ASSERT(upstream_port
);
2534 ret
= cmd_run_ctx_connect_upstream_port(ctx
, upstream_port
);
2545 int cmd_run_ctx_connect_ports(struct cmd_run_ctx
*ctx
)
2548 GHashTableIter iter
;
2549 gpointer g_name_quark
, g_comp
;
2551 ctx
->connect_ports
= true;
2552 g_hash_table_iter_init(&iter
, ctx
->src_components
);
2554 while (g_hash_table_iter_next(&iter
, &g_name_quark
, &g_comp
)) {
2555 ret
= cmd_run_ctx_connect_comp_ports(ctx
, g_comp
,
2556 (output_port_count_func_t
)
2557 bt_component_source_get_output_port_count
,
2558 (borrow_output_port_by_index_func_t
)
2559 bt_component_source_borrow_output_port_by_index_const
);
2565 g_hash_table_iter_init(&iter
, ctx
->flt_components
);
2567 while (g_hash_table_iter_next(&iter
, &g_name_quark
, &g_comp
)) {
2568 ret
= cmd_run_ctx_connect_comp_ports(ctx
, g_comp
,
2569 (output_port_count_func_t
)
2570 bt_component_filter_get_output_port_count
,
2571 (borrow_output_port_by_index_func_t
)
2572 bt_component_filter_borrow_output_port_by_index_const
);
2583 const char *bt_graph_status_str(bt_graph_status status
)
2586 case BT_GRAPH_STATUS_OK
:
2587 return "BT_GRAPH_STATUS_OK";
2588 case BT_GRAPH_STATUS_END
:
2589 return "BT_GRAPH_STATUS_END";
2590 case BT_GRAPH_STATUS_AGAIN
:
2591 return "BT_GRAPH_STATUS_AGAIN";
2592 case BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION
:
2593 return "BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION";
2594 case BT_GRAPH_STATUS_CANCELED
:
2595 return "BT_GRAPH_STATUS_CANCELED";
2596 case BT_GRAPH_STATUS_ERROR
:
2597 return "BT_GRAPH_STATUS_ERROR";
2598 case BT_GRAPH_STATUS_NOMEM
:
2599 return "BT_GRAPH_STATUS_NOMEM";
2606 int cmd_run(struct bt_config
*cfg
)
2609 struct cmd_run_ctx ctx
= { 0 };
2611 /* Initialize the command's context and the graph object */
2612 if (cmd_run_ctx_init(&ctx
, cfg
)) {
2613 BT_LOGE_STR("Cannot initialize the command's context.");
2614 fprintf(stderr
, "Cannot initialize the command's context\n");
2619 BT_LOGI_STR("Canceled by user before creating components.");
2623 BT_LOGI_STR("Creating components.");
2625 /* Create the requested component instances */
2626 if (cmd_run_ctx_create_components(&ctx
)) {
2627 BT_LOGE_STR("Cannot create components.");
2628 fprintf(stderr
, "Cannot create components\n");
2633 BT_LOGI_STR("Canceled by user before connecting components.");
2637 BT_LOGI_STR("Connecting components.");
2639 /* Connect the initially visible component ports */
2640 if (cmd_run_ctx_connect_ports(&ctx
)) {
2641 BT_LOGE_STR("Cannot connect initial component ports.");
2642 fprintf(stderr
, "Cannot connect initial component ports\n");
2647 BT_LOGI_STR("Canceled by user before running the graph.");
2651 BT_LOGI_STR("Running the graph.");
2655 bt_graph_status graph_status
= bt_graph_run(ctx
.graph
);
2658 * Reset console in case something messed with console
2659 * codes during the graph's execution.
2661 printf("%s", bt_common_color_reset());
2663 fprintf(stderr
, "%s", bt_common_color_reset());
2664 BT_LOGV("bt_graph_run() returned: status=%s",
2665 bt_graph_status_str(graph_status
));
2667 switch (graph_status
) {
2668 case BT_GRAPH_STATUS_OK
:
2670 case BT_GRAPH_STATUS_CANCELED
:
2671 BT_LOGI_STR("Graph was canceled by user.");
2673 case BT_GRAPH_STATUS_AGAIN
:
2674 if (bt_graph_is_canceled(ctx
.graph
)) {
2675 BT_LOGI_STR("Graph was canceled by user.");
2679 if (cfg
->cmd_data
.run
.retry_duration_us
> 0) {
2680 BT_LOGV("Got BT_GRAPH_STATUS_AGAIN: sleeping: "
2682 cfg
->cmd_data
.run
.retry_duration_us
);
2684 if (usleep(cfg
->cmd_data
.run
.retry_duration_us
)) {
2685 if (bt_graph_is_canceled(ctx
.graph
)) {
2686 BT_LOGI_STR("Graph was canceled by user.");
2692 case BT_GRAPH_STATUS_END
:
2695 BT_LOGE_STR("Graph failed to complete successfully");
2696 fprintf(stderr
, "Graph failed to complete successfully\n");
2709 cmd_run_ctx_destroy(&ctx
);
2714 void warn_command_name_and_directory_clash(struct bt_config
*cfg
)
2716 const char *env_clash
;
2718 if (!cfg
->command_name
) {
2722 env_clash
= getenv(ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH
);
2723 if (env_clash
&& strcmp(env_clash
, "0") == 0) {
2727 if (g_file_test(cfg
->command_name
,
2728 G_FILE_TEST_EXISTS
| G_FILE_TEST_IS_DIR
)) {
2729 fprintf(stderr
, "\nNOTE: The `%s` command was executed. If you meant to convert a\n",
2731 fprintf(stderr
, "trace located in the local `%s` directory, please use:\n",
2733 fprintf(stderr
, "\n");
2734 fprintf(stderr
, " babeltrace2 convert %s [OPTIONS]\n",
2740 void init_log_level(void)
2742 bt_cli_log_level
= bt_log_get_level_from_env(ENV_BABELTRACE_CLI_LOG_LEVEL
);
2746 void set_auto_log_levels(struct bt_config
*cfg
)
2748 const char **env_var_name
;
2751 * Override the configuration's default log level if
2752 * BABELTRACE_VERBOSE or BABELTRACE_DEBUG environment variables
2753 * are found for backward compatibility with legacy Babetrace 1.
2755 if (getenv("BABELTRACE_DEBUG") &&
2756 strcmp(getenv("BABELTRACE_DEBUG"), "1") == 0) {
2757 cfg
->log_level
= 'V';
2758 } else if (getenv("BABELTRACE_VERBOSE") &&
2759 strcmp(getenv("BABELTRACE_VERBOSE"), "1") == 0) {
2760 cfg
->log_level
= 'I';
2764 * Set log levels according to --debug or --verbose. For
2765 * backward compatibility, --debug is more verbose than
2768 * --verbose: INFO log level
2769 * --debug: VERBOSE log level (includes DEBUG, which is
2770 * is less verbose than VERBOSE in the internal
2771 * logging framework)
2773 if (!getenv("BABELTRACE_LOGGING_GLOBAL_LEVEL")) {
2775 bt_logging_set_global_level(BT_LOGGING_LEVEL_INFO
);
2776 } else if (cfg
->debug
) {
2777 bt_logging_set_global_level(BT_LOGGING_LEVEL_VERBOSE
);
2780 * Set library's default log level if not
2781 * explicitly specified.
2783 switch (cfg
->log_level
) {
2785 bt_logging_set_global_level(BT_LOGGING_LEVEL_NONE
);
2788 bt_logging_set_global_level(BT_LOGGING_LEVEL_VERBOSE
);
2791 bt_logging_set_global_level(BT_LOGGING_LEVEL_DEBUG
);
2794 bt_logging_set_global_level(BT_LOGGING_LEVEL_INFO
);
2797 bt_logging_set_global_level(BT_LOGGING_LEVEL_WARN
);
2800 bt_logging_set_global_level(BT_LOGGING_LEVEL_ERROR
);
2803 bt_logging_set_global_level(BT_LOGGING_LEVEL_FATAL
);
2811 if (!getenv(ENV_BABELTRACE_CLI_LOG_LEVEL
)) {
2813 bt_cli_log_level
= BT_LOG_INFO
;
2814 } else if (cfg
->debug
) {
2815 bt_cli_log_level
= BT_LOG_VERBOSE
;
2818 * Set CLI's default log level if not explicitly
2821 switch (cfg
->log_level
) {
2823 bt_cli_log_level
= BT_LOG_NONE
;
2826 bt_cli_log_level
= BT_LOG_VERBOSE
;
2829 bt_cli_log_level
= BT_LOG_DEBUG
;
2832 bt_cli_log_level
= BT_LOG_INFO
;
2835 bt_cli_log_level
= BT_LOG_WARN
;
2838 bt_cli_log_level
= BT_LOG_ERROR
;
2841 bt_cli_log_level
= BT_LOG_FATAL
;
2849 env_var_name
= log_level_env_var_names
;
2851 while (*env_var_name
) {
2852 if (!getenv(*env_var_name
)) {
2854 g_setenv(*env_var_name
, "I", 1);
2855 } else if (cfg
->debug
) {
2856 g_setenv(*env_var_name
, "V", 1);
2858 char val
[2] = { 0 };
2861 * Set module's default log level if not
2862 * explicitly specified.
2864 val
[0] = cfg
->log_level
;
2865 g_setenv(*env_var_name
, val
, 1);
2873 int main(int argc
, const char **argv
)
2877 struct bt_config
*cfg
;
2880 set_signal_handler();
2882 cfg
= bt_config_cli_args_create_with_default(argc
, argv
, &retcode
);
2885 /* Quit without errors; typically usage/version */
2887 BT_LOGI_STR("Quitting without errors.");
2892 BT_LOGE("Command-line error: retcode=%d", retcode
);
2897 BT_LOGE_STR("Failed to create a valid Babeltrace configuration.");
2898 fprintf(stderr
, "Failed to create Babeltrace configuration\n");
2903 set_auto_log_levels(cfg
);
2906 if (cfg
->command_needs_plugins
) {
2907 ret
= load_all_plugins(cfg
->plugin_paths
);
2909 BT_LOGE("Failed to load plugins: ret=%d", ret
);
2915 BT_LOGI("Executing command: cmd=%d, command-name=\"%s\"",
2916 cfg
->command
, cfg
->command_name
);
2918 switch (cfg
->command
) {
2919 case BT_CONFIG_COMMAND_RUN
:
2922 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
2923 ret
= cmd_list_plugins(cfg
);
2925 case BT_CONFIG_COMMAND_HELP
:
2926 ret
= cmd_help(cfg
);
2928 case BT_CONFIG_COMMAND_QUERY
:
2929 ret
= cmd_query(cfg
);
2931 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
2932 ret
= cmd_print_ctf_metadata(cfg
);
2934 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
2935 ret
= cmd_print_lttng_live_sessions(cfg
);
2938 BT_LOGF("Invalid/unknown command: cmd=%d", cfg
->command
);
2942 BT_LOGI("Command completed: cmd=%d, command-name=\"%s\", ret=%d",
2943 cfg
->command
, cfg
->command_name
, ret
);
2944 warn_command_name_and_directory_clash(cfg
);
2945 retcode
= ret
? 1 : 0;
2948 BT_OBJECT_PUT_REF_AND_RESET(cfg
);