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_PLUGIN_CTF_METADATA_LOG_LEVEL",
53 "BABELTRACE_PLUGIN_CTF_UTILS_LOG_LEVEL",
54 "BABELTRACE_PYTHON_BT2_LOG_LEVEL",
55 "BABELTRACE_SINK_CTF_FS_LOG_LEVEL",
56 "BABELTRACE_SINK_TEXT_DETAILS_LOG_LEVEL",
57 "BABELTRACE_SRC_CTF_FS_LOG_LEVEL",
58 "BABELTRACE_SRC_CTF_LTTNG_LIVE_LOG_LEVEL",
62 /* Application's processing graph (weak) */
63 static bt_graph
*the_graph
;
64 static bt_query_executor
*the_query_executor
;
65 static bool canceled
= false;
67 GPtrArray
*loaded_plugins
;
74 BOOL WINAPI
signal_handler(DWORD signal
) {
76 bt_graph_cancel(the_graph
);
85 void set_signal_handler(void)
87 if (!SetConsoleCtrlHandler(signal_handler
, TRUE
)) {
88 BT_LOGE("Failed to set the Ctrl+C handler.");
92 #else /* __MINGW32__ */
95 void signal_handler(int signum
)
97 if (signum
!= SIGINT
) {
102 bt_graph_cancel(the_graph
);
105 if (the_query_executor
) {
106 bt_query_executor_cancel(the_query_executor
);
113 void set_signal_handler(void)
115 struct sigaction new_action
, old_action
;
117 new_action
.sa_handler
= signal_handler
;
118 sigemptyset(&new_action
.sa_mask
);
119 new_action
.sa_flags
= 0;
120 sigaction(SIGINT
, NULL
, &old_action
);
122 if (old_action
.sa_handler
!= SIG_IGN
) {
123 sigaction(SIGINT
, &new_action
, NULL
);
127 #endif /* __MINGW32__ */
130 void init_static_data(void)
132 loaded_plugins
= g_ptr_array_new_with_free_func(
133 (GDestroyNotify
) bt_object_put_ref
);
137 void fini_static_data(void)
139 g_ptr_array_free(loaded_plugins
, TRUE
);
143 int create_the_query_executor(void)
147 the_query_executor
= bt_query_executor_create();
148 if (!the_query_executor
) {
149 BT_LOGE_STR("Cannot create a query executor.");
157 void destroy_the_query_executor(void)
159 BT_QUERY_EXECUTOR_PUT_REF_AND_RESET(the_query_executor
);
163 int query(struct bt_config
*cfg
, const bt_component_class
*comp_cls
,
164 const char *obj
, const bt_value
*params
,
165 const bt_value
**user_result
, const char **fail_reason
)
167 const bt_value
*result
= NULL
;
168 bt_query_executor_status status
;
169 *fail_reason
= "unknown error";
172 BT_ASSERT(fail_reason
);
173 BT_ASSERT(user_result
);
174 ret
= create_the_query_executor();
176 /* create_the_query_executor() logs errors */
181 BT_LOGI("Canceled by user before executing the query: "
182 "comp-cls-addr=%p, comp-cls-name=\"%s\", "
183 "query-obj=\"%s\"", comp_cls
,
184 bt_component_class_get_name(comp_cls
), obj
);
185 *fail_reason
= "canceled by user";
190 status
= bt_query_executor_query(the_query_executor
,
191 comp_cls
, obj
, params
, cfg
->log_level
, &result
);
193 case BT_QUERY_EXECUTOR_STATUS_OK
:
195 case BT_QUERY_EXECUTOR_STATUS_AGAIN
:
197 const uint64_t sleep_time_us
= 100000;
199 /* Wait 100 ms and retry */
200 BT_LOGD("Got BT_QUERY_EXECUTOR_STATUS_AGAIN: sleeping: "
201 "time-us=%" PRIu64
, sleep_time_us
);
203 if (usleep(sleep_time_us
)) {
204 if (bt_query_executor_is_canceled(the_query_executor
)) {
205 BT_LOGI("Query was canceled by user: "
206 "comp-cls-addr=%p, comp-cls-name=\"%s\", "
207 "query-obj=\"%s\"", comp_cls
,
208 bt_component_class_get_name(comp_cls
),
210 *fail_reason
= "canceled by user";
217 case BT_QUERY_EXECUTOR_STATUS_CANCELED
:
218 *fail_reason
= "canceled by user";
220 case BT_QUERY_EXECUTOR_STATUS_ERROR
:
222 case BT_QUERY_EXECUTOR_STATUS_INVALID_OBJECT
:
223 *fail_reason
= "invalid or unknown query object";
225 case BT_QUERY_EXECUTOR_STATUS_INVALID_PARAMS
:
226 *fail_reason
= "invalid query parameters";
228 case BT_QUERY_EXECUTOR_STATUS_UNSUPPORTED
:
229 *fail_reason
= "unsupported action";
231 case BT_QUERY_EXECUTOR_STATUS_NOMEM
:
232 *fail_reason
= "not enough memory";
235 BT_LOGF("Unknown query status: status=%d", status
);
241 *user_result
= result
;
249 destroy_the_query_executor();
250 bt_value_put_ref(result
);
255 const bt_plugin
*find_plugin(const char *name
)
258 const bt_plugin
*plugin
= NULL
;
261 BT_LOGI("Finding plugin: name=\"%s\"", name
);
263 for (i
= 0; i
< loaded_plugins
->len
; i
++) {
264 plugin
= g_ptr_array_index(loaded_plugins
, i
);
266 if (strcmp(name
, bt_plugin_get_name(plugin
)) == 0) {
274 BT_LOGI("Found plugin: name=\"%s\", plugin-addr=%p",
277 BT_LOGI("Cannot find plugin: name=\"%s\"", name
);
280 bt_plugin_get_ref(plugin
);
284 typedef const void *(*plugin_borrow_comp_cls_func_t
)(
285 const bt_plugin
*, const char *);
288 const void *find_component_class_from_plugin(const char *plugin_name
,
289 const char *comp_class_name
,
290 plugin_borrow_comp_cls_func_t plugin_borrow_comp_cls_func
)
292 const void *comp_class
= NULL
;
293 const bt_plugin
*plugin
;
295 BT_LOGI("Finding component class: plugin-name=\"%s\", "
296 "comp-cls-name=\"%s\"", plugin_name
, comp_class_name
);
298 plugin
= find_plugin(plugin_name
);
303 comp_class
= plugin_borrow_comp_cls_func(plugin
, comp_class_name
);
304 bt_object_get_ref(comp_class
);
305 BT_PLUGIN_PUT_REF_AND_RESET(plugin
);
309 BT_LOGI("Found component class: plugin-name=\"%s\", "
310 "comp-cls-name=\"%s\"", plugin_name
, comp_class_name
);
312 BT_LOGI("Cannot find source component class: "
313 "plugin-name=\"%s\", comp-cls-name=\"%s\"",
314 plugin_name
, comp_class_name
);
321 const bt_component_class_source
*find_source_component_class(
322 const char *plugin_name
, const char *comp_class_name
)
324 return (const void *) find_component_class_from_plugin(
325 plugin_name
, comp_class_name
,
326 (plugin_borrow_comp_cls_func_t
)
327 bt_plugin_borrow_source_component_class_by_name_const
);
331 const bt_component_class_filter
*find_filter_component_class(
332 const char *plugin_name
, const char *comp_class_name
)
334 return (const void *) find_component_class_from_plugin(
335 plugin_name
, comp_class_name
,
336 (plugin_borrow_comp_cls_func_t
)
337 bt_plugin_borrow_filter_component_class_by_name_const
);
341 const bt_component_class_sink
*find_sink_component_class(
342 const char *plugin_name
, const char *comp_class_name
)
344 return (const void *) find_component_class_from_plugin(plugin_name
,
346 (plugin_borrow_comp_cls_func_t
)
347 bt_plugin_borrow_sink_component_class_by_name_const
);
351 const bt_component_class
*find_component_class(const char *plugin_name
,
352 const char *comp_class_name
,
353 bt_component_class_type comp_class_type
)
355 const bt_component_class
*comp_cls
= NULL
;
357 switch (comp_class_type
) {
358 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
359 comp_cls
= bt_component_class_source_as_component_class_const(find_source_component_class(plugin_name
, comp_class_name
));
361 case BT_COMPONENT_CLASS_TYPE_FILTER
:
362 comp_cls
= bt_component_class_filter_as_component_class_const(find_filter_component_class(plugin_name
, comp_class_name
));
364 case BT_COMPONENT_CLASS_TYPE_SINK
:
365 comp_cls
= bt_component_class_sink_as_component_class_const(find_sink_component_class(plugin_name
, comp_class_name
));
375 void print_indent(FILE *fp
, size_t indent
)
379 for (i
= 0; i
< indent
; i
++) {
385 const char *component_type_str(bt_component_class_type type
)
388 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
390 case BT_COMPONENT_CLASS_TYPE_SINK
:
392 case BT_COMPONENT_CLASS_TYPE_FILTER
:
400 void print_plugin_comp_cls_opt(FILE *fh
, const char *plugin_name
,
401 const char *comp_cls_name
, bt_component_class_type type
)
403 GString
*shell_plugin_name
= NULL
;
404 GString
*shell_comp_cls_name
= NULL
;
406 shell_plugin_name
= bt_common_shell_quote(plugin_name
, false);
407 if (!shell_plugin_name
) {
411 shell_comp_cls_name
= bt_common_shell_quote(comp_cls_name
, false);
412 if (!shell_comp_cls_name
) {
416 fprintf(fh
, "'%s%s%s%s.%s%s%s.%s%s%s'",
417 bt_common_color_bold(),
418 bt_common_color_fg_cyan(),
419 component_type_str(type
),
420 bt_common_color_fg_default(),
421 bt_common_color_fg_blue(),
422 shell_plugin_name
->str
,
423 bt_common_color_fg_default(),
424 bt_common_color_fg_yellow(),
425 shell_comp_cls_name
->str
,
426 bt_common_color_reset());
429 if (shell_plugin_name
) {
430 g_string_free(shell_plugin_name
, TRUE
);
433 if (shell_comp_cls_name
) {
434 g_string_free(shell_comp_cls_name
, TRUE
);
439 void print_value(FILE *, const bt_value
*, size_t);
442 void print_value_rec(FILE *, const bt_value
*, size_t);
444 struct print_map_value_data
{
450 bt_bool
print_map_value(const char *key
, const bt_value
*object
,
453 struct print_map_value_data
*print_map_value_data
= data
;
455 print_indent(print_map_value_data
->fp
, print_map_value_data
->indent
);
456 fprintf(print_map_value_data
->fp
, "%s: ", key
);
459 if (bt_value_is_array(object
) &&
460 bt_value_array_is_empty(object
)) {
461 fprintf(print_map_value_data
->fp
, "[ ]\n");
465 if (bt_value_is_map(object
) &&
466 bt_value_map_is_empty(object
)) {
467 fprintf(print_map_value_data
->fp
, "{ }\n");
471 if (bt_value_is_array(object
) ||
472 bt_value_is_map(object
)) {
473 fprintf(print_map_value_data
->fp
, "\n");
476 print_value_rec(print_map_value_data
->fp
, object
,
477 print_map_value_data
->indent
+ 2);
482 void print_value_rec(FILE *fp
, const bt_value
*value
, size_t indent
)
496 switch (bt_value_get_type(value
)) {
497 case BT_VALUE_TYPE_NULL
:
498 fprintf(fp
, "%snull%s\n", bt_common_color_bold(),
499 bt_common_color_reset());
501 case BT_VALUE_TYPE_BOOL
:
502 bool_val
= bt_value_bool_get(value
);
503 fprintf(fp
, "%s%s%s%s\n", bt_common_color_bold(),
504 bt_common_color_fg_cyan(), bool_val
? "yes" : "no",
505 bt_common_color_reset());
507 case BT_VALUE_TYPE_UNSIGNED_INTEGER
:
508 uint_val
= bt_value_unsigned_integer_get(value
);
509 fprintf(fp
, "%s%s%" PRIu64
"%s\n", bt_common_color_bold(),
510 bt_common_color_fg_red(), uint_val
,
511 bt_common_color_reset());
513 case BT_VALUE_TYPE_SIGNED_INTEGER
:
514 int_val
= bt_value_signed_integer_get(value
);
515 fprintf(fp
, "%s%s%" PRId64
"%s\n", bt_common_color_bold(),
516 bt_common_color_fg_red(), int_val
,
517 bt_common_color_reset());
519 case BT_VALUE_TYPE_REAL
:
520 dbl_val
= bt_value_real_get(value
);
521 fprintf(fp
, "%s%s%lf%s\n", bt_common_color_bold(),
522 bt_common_color_fg_red(), dbl_val
,
523 bt_common_color_reset());
525 case BT_VALUE_TYPE_STRING
:
526 str_val
= bt_value_string_get(value
);
527 fprintf(fp
, "%s%s%s%s\n", bt_common_color_bold(),
528 bt_common_color_fg_green(), str_val
,
529 bt_common_color_reset());
531 case BT_VALUE_TYPE_ARRAY
:
532 size
= bt_value_array_get_size(value
);
538 print_indent(fp
, indent
);
539 fprintf(fp
, "[ ]\n");
543 for (i
= 0; i
< size
; i
++) {
544 const bt_value
*element
=
545 bt_value_array_borrow_element_by_index_const(
551 print_indent(fp
, indent
);
554 if (bt_value_is_array(element
) &&
555 bt_value_array_is_empty(element
)) {
556 fprintf(fp
, "[ ]\n");
560 if (bt_value_is_map(element
) &&
561 bt_value_map_is_empty(element
)) {
562 fprintf(fp
, "{ }\n");
566 if (bt_value_is_array(element
) ||
567 bt_value_is_map(element
)) {
571 print_value_rec(fp
, element
, indent
+ 2);
574 case BT_VALUE_TYPE_MAP
:
576 struct print_map_value_data data
= {
581 if (bt_value_map_is_empty(value
)) {
582 print_indent(fp
, indent
);
583 fprintf(fp
, "{ }\n");
587 bt_value_map_foreach_entry_const(value
, print_map_value
, &data
);
596 BT_LOGE("Error printing value of type %s.",
597 bt_common_value_type_string(bt_value_get_type(value
)));
601 void print_value(FILE *fp
, const bt_value
*value
, size_t indent
)
603 if (!bt_value_is_array(value
) && !bt_value_is_map(value
)) {
604 print_indent(fp
, indent
);
607 print_value_rec(fp
, value
, indent
);
611 void print_bt_config_component(struct bt_config_component
*bt_config_component
)
613 fprintf(stderr
, " ");
614 print_plugin_comp_cls_opt(stderr
, bt_config_component
->plugin_name
->str
,
615 bt_config_component
->comp_cls_name
->str
,
616 bt_config_component
->type
);
617 fprintf(stderr
, ":\n");
619 if (bt_config_component
->instance_name
->len
> 0) {
620 fprintf(stderr
, " Name: %s\n",
621 bt_config_component
->instance_name
->str
);
624 fprintf(stderr
, " Parameters:\n");
625 print_value(stderr
, bt_config_component
->params
, 8);
629 void print_bt_config_components(GPtrArray
*array
)
633 for (i
= 0; i
< array
->len
; i
++) {
634 struct bt_config_component
*cfg_component
=
635 bt_config_get_component(array
, i
);
636 print_bt_config_component(cfg_component
);
637 BT_OBJECT_PUT_REF_AND_RESET(cfg_component
);
642 void print_plugin_paths(const bt_value
*plugin_paths
)
644 fprintf(stderr
, " Plugin paths:\n");
645 print_value(stderr
, plugin_paths
, 4);
649 void print_cfg_run(struct bt_config
*cfg
)
653 print_plugin_paths(cfg
->plugin_paths
);
654 fprintf(stderr
, " Source component instances:\n");
655 print_bt_config_components(cfg
->cmd_data
.run
.sources
);
657 if (cfg
->cmd_data
.run
.filters
->len
> 0) {
658 fprintf(stderr
, " Filter component instances:\n");
659 print_bt_config_components(cfg
->cmd_data
.run
.filters
);
662 fprintf(stderr
, " Sink component instances:\n");
663 print_bt_config_components(cfg
->cmd_data
.run
.sinks
);
664 fprintf(stderr
, " Connections:\n");
666 for (i
= 0; i
< cfg
->cmd_data
.run
.connections
->len
; i
++) {
667 struct bt_config_connection
*cfg_connection
=
668 g_ptr_array_index(cfg
->cmd_data
.run
.connections
,
671 fprintf(stderr
, " %s%s%s -> %s%s%s\n",
672 cfg_connection
->upstream_comp_name
->str
,
673 cfg_connection
->upstream_port_glob
->len
> 0 ? "." : "",
674 cfg_connection
->upstream_port_glob
->str
,
675 cfg_connection
->downstream_comp_name
->str
,
676 cfg_connection
->downstream_port_glob
->len
> 0 ? "." : "",
677 cfg_connection
->downstream_port_glob
->str
);
682 void print_cfg_list_plugins(struct bt_config
*cfg
)
684 print_plugin_paths(cfg
->plugin_paths
);
688 void print_cfg_help(struct bt_config
*cfg
)
690 print_plugin_paths(cfg
->plugin_paths
);
694 void print_cfg_print_ctf_metadata(struct bt_config
*cfg
)
696 print_plugin_paths(cfg
->plugin_paths
);
697 fprintf(stderr
, " Path: %s\n",
698 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
702 void print_cfg_print_lttng_live_sessions(struct bt_config
*cfg
)
704 print_plugin_paths(cfg
->plugin_paths
);
705 fprintf(stderr
, " URL: %s\n",
706 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
710 void print_cfg_query(struct bt_config
*cfg
)
712 print_plugin_paths(cfg
->plugin_paths
);
713 fprintf(stderr
, " Object: `%s`\n", cfg
->cmd_data
.query
.object
->str
);
714 fprintf(stderr
, " Component class:\n");
715 print_bt_config_component(cfg
->cmd_data
.query
.cfg_component
);
719 void print_cfg(struct bt_config
*cfg
)
721 if (!BT_LOG_ON_INFO
) {
725 BT_LOGI_STR("CLI configuration:");
726 BT_LOGI(" Debug mode: %s\n", cfg
->debug
? "yes" : "no");
727 BT_LOGI(" Verbose mode: %s\n", cfg
->verbose
? "yes" : "no");
729 switch (cfg
->command
) {
730 case BT_CONFIG_COMMAND_RUN
:
733 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
734 print_cfg_list_plugins(cfg
);
736 case BT_CONFIG_COMMAND_HELP
:
739 case BT_CONFIG_COMMAND_QUERY
:
740 print_cfg_query(cfg
);
742 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
743 print_cfg_print_ctf_metadata(cfg
);
745 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
746 print_cfg_print_lttng_live_sessions(cfg
);
754 void add_to_loaded_plugins(const bt_plugin_set
*plugin_set
)
759 count
= bt_plugin_set_get_plugin_count(plugin_set
);
760 BT_ASSERT(count
>= 0);
762 for (i
= 0; i
< count
; i
++) {
763 const bt_plugin
*plugin
=
764 bt_plugin_set_borrow_plugin_by_index_const(plugin_set
, i
);
765 const bt_plugin
*loaded_plugin
=
766 find_plugin(bt_plugin_get_name(plugin
));
771 BT_LOGI("Not using plugin: another one already exists with the same name: "
772 "plugin-name=\"%s\", plugin-path=\"%s\", "
773 "existing-plugin-path=\"%s\"",
774 bt_plugin_get_name(plugin
),
775 bt_plugin_get_path(plugin
),
776 bt_plugin_get_path(loaded_plugin
));
777 bt_plugin_put_ref(loaded_plugin
);
779 /* Add to global array. */
780 BT_LOGD("Adding plugin to loaded plugins: plugin-path=\"%s\"",
781 bt_plugin_get_name(plugin
));
782 bt_plugin_get_ref(plugin
);
783 g_ptr_array_add(loaded_plugins
, (void *) plugin
);
789 int load_dynamic_plugins(const bt_value
*plugin_paths
)
791 int nr_paths
, i
, ret
= 0;
793 nr_paths
= bt_value_array_get_size(plugin_paths
);
795 BT_LOGE_STR("Cannot load dynamic plugins: no plugin path.");
800 BT_LOGI_STR("Loading dynamic plugins.");
802 for (i
= 0; i
< nr_paths
; i
++) {
803 const bt_value
*plugin_path_value
= NULL
;
804 const char *plugin_path
;
805 const bt_plugin_set
*plugin_set
;
808 bt_value_array_borrow_element_by_index_const(
810 plugin_path
= bt_value_string_get(plugin_path_value
);
813 * Skip this if the directory does not exist because
814 * bt_plugin_find_all_from_dir() expects an existing
817 if (!g_file_test(plugin_path
, G_FILE_TEST_IS_DIR
)) {
818 BT_LOGI("Skipping nonexistent directory path: "
819 "path=\"%s\"", plugin_path
);
823 plugin_set
= bt_plugin_find_all_from_dir(plugin_path
, false);
825 BT_LOGI("Unable to load dynamic plugins from directory: "
826 "path=\"%s\"", plugin_path
);
830 add_to_loaded_plugins(plugin_set
);
831 bt_plugin_set_put_ref(plugin_set
);
838 int load_static_plugins(void)
841 const bt_plugin_set
*plugin_set
;
843 BT_LOGI("Loading static plugins.");
844 plugin_set
= bt_plugin_find_all_from_static();
846 BT_LOGE("Unable to load static plugins.");
851 add_to_loaded_plugins(plugin_set
);
852 bt_plugin_set_put_ref(plugin_set
);
858 int load_all_plugins(const bt_value
*plugin_paths
)
862 if (load_dynamic_plugins(plugin_paths
)) {
867 if (load_static_plugins()) {
872 BT_LOGI("Loaded all plugins: count=%u", loaded_plugins
->len
);
879 void print_plugin_info(const bt_plugin
*plugin
)
881 unsigned int major
, minor
, patch
;
883 bt_property_availability version_avail
;
884 const char *plugin_name
;
888 const char *plugin_description
;
890 plugin_name
= bt_plugin_get_name(plugin
);
891 path
= bt_plugin_get_path(plugin
);
892 author
= bt_plugin_get_author(plugin
);
893 license
= bt_plugin_get_license(plugin
);
894 plugin_description
= bt_plugin_get_description(plugin
);
895 version_avail
= bt_plugin_get_version(plugin
, &major
, &minor
,
897 printf("%s%s%s%s:\n", bt_common_color_bold(),
898 bt_common_color_fg_blue(), plugin_name
,
899 bt_common_color_reset());
901 printf(" %sPath%s: %s\n", bt_common_color_bold(),
902 bt_common_color_reset(), path
);
907 if (version_avail
== BT_PROPERTY_AVAILABILITY_AVAILABLE
) {
908 printf(" %sVersion%s: %u.%u.%u",
909 bt_common_color_bold(), bt_common_color_reset(),
910 major
, minor
, patch
);
919 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
920 bt_common_color_reset(),
921 plugin_description
? plugin_description
: "(None)");
922 printf(" %sAuthor%s: %s\n", bt_common_color_bold(),
923 bt_common_color_reset(), author
? author
: "(Unknown)");
924 printf(" %sLicense%s: %s\n", bt_common_color_bold(),
925 bt_common_color_reset(),
926 license
? license
: "(Unknown)");
930 int cmd_query(struct bt_config
*cfg
)
933 const bt_component_class
*comp_cls
= NULL
;
934 const bt_value
*results
= NULL
;
935 const char *fail_reason
= NULL
;
937 comp_cls
= find_component_class(
938 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
939 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
940 cfg
->cmd_data
.query
.cfg_component
->type
);
942 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
943 "comp-cls-name=\"%s\", comp-cls-type=%d",
944 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
945 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
946 cfg
->cmd_data
.query
.cfg_component
->type
);
947 fprintf(stderr
, "%s%sCannot find component class %s",
948 bt_common_color_bold(),
949 bt_common_color_fg_red(),
950 bt_common_color_reset());
951 print_plugin_comp_cls_opt(stderr
,
952 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
953 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
954 cfg
->cmd_data
.query
.cfg_component
->type
);
955 fprintf(stderr
, "\n");
960 ret
= query(cfg
, comp_cls
, cfg
->cmd_data
.query
.object
->str
,
961 cfg
->cmd_data
.query
.cfg_component
->params
,
962 &results
, &fail_reason
);
967 print_value(stdout
, results
, 0);
971 BT_LOGE("Failed to query component class: %s: plugin-name=\"%s\", "
972 "comp-cls-name=\"%s\", comp-cls-type=%d "
973 "object=\"%s\"", fail_reason
,
974 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
975 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
976 cfg
->cmd_data
.query
.cfg_component
->type
,
977 cfg
->cmd_data
.query
.object
->str
);
978 fprintf(stderr
, "%s%sFailed to query info to %s",
979 bt_common_color_bold(),
980 bt_common_color_fg_red(),
981 bt_common_color_reset());
982 print_plugin_comp_cls_opt(stderr
,
983 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
984 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
985 cfg
->cmd_data
.query
.cfg_component
->type
);
986 fprintf(stderr
, "%s%s with object `%s`: %s%s\n",
987 bt_common_color_bold(),
988 bt_common_color_fg_red(),
989 cfg
->cmd_data
.query
.object
->str
,
991 bt_common_color_reset());
995 bt_component_class_put_ref(comp_cls
);
996 bt_value_put_ref(results
);
1001 void print_component_class_help(const char *plugin_name
,
1002 const bt_component_class
*comp_cls
)
1004 const char *comp_class_name
=
1005 bt_component_class_get_name(comp_cls
);
1006 const char *comp_class_description
=
1007 bt_component_class_get_description(comp_cls
);
1008 const char *comp_class_help
=
1009 bt_component_class_get_help(comp_cls
);
1010 bt_component_class_type type
=
1011 bt_component_class_get_type(comp_cls
);
1013 print_plugin_comp_cls_opt(stdout
, plugin_name
, comp_class_name
, type
);
1015 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
1016 bt_common_color_reset(),
1017 comp_class_description
? comp_class_description
: "(None)");
1019 if (comp_class_help
) {
1020 printf("\n%s\n", comp_class_help
);
1025 int cmd_help(struct bt_config
*cfg
)
1028 const bt_plugin
*plugin
= NULL
;
1029 const bt_component_class
*needed_comp_cls
= NULL
;
1031 plugin
= find_plugin(cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
1033 BT_LOGE("Cannot find plugin: plugin-name=\"%s\"",
1034 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
1035 fprintf(stderr
, "%s%sCannot find plugin %s%s%s\n",
1036 bt_common_color_bold(), bt_common_color_fg_red(),
1037 bt_common_color_fg_blue(),
1038 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1039 bt_common_color_reset());
1044 print_plugin_info(plugin
);
1045 printf(" %sSource component classes%s: %d\n",
1046 bt_common_color_bold(),
1047 bt_common_color_reset(),
1048 (int) bt_plugin_get_source_component_class_count(plugin
));
1049 printf(" %sFilter component classes%s: %d\n",
1050 bt_common_color_bold(),
1051 bt_common_color_reset(),
1052 (int) bt_plugin_get_filter_component_class_count(plugin
));
1053 printf(" %sSink component classes%s: %d\n",
1054 bt_common_color_bold(),
1055 bt_common_color_reset(),
1056 (int) bt_plugin_get_sink_component_class_count(plugin
));
1058 if (strlen(cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
) == 0) {
1059 /* Plugin help only */
1063 needed_comp_cls
= find_component_class(
1064 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1065 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
1066 cfg
->cmd_data
.help
.cfg_component
->type
);
1067 if (!needed_comp_cls
) {
1068 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
1069 "comp-cls-name=\"%s\", comp-cls-type=%d",
1070 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1071 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
1072 cfg
->cmd_data
.help
.cfg_component
->type
);
1073 fprintf(stderr
, "\n%s%sCannot find component class %s",
1074 bt_common_color_bold(),
1075 bt_common_color_fg_red(),
1076 bt_common_color_reset());
1077 print_plugin_comp_cls_opt(stderr
,
1078 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1079 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
1080 cfg
->cmd_data
.help
.cfg_component
->type
);
1081 fprintf(stderr
, "\n");
1087 print_component_class_help(
1088 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1092 bt_component_class_put_ref(needed_comp_cls
);
1093 bt_plugin_put_ref(plugin
);
1097 typedef void *(* plugin_borrow_comp_cls_by_index_func_t
)(const bt_plugin
*,
1099 typedef const bt_component_class
*(* spec_comp_cls_borrow_comp_cls_func_t
)(
1102 void cmd_list_plugins_print_component_classes(const bt_plugin
*plugin
,
1103 const char *cc_type_name
, uint64_t count
,
1104 plugin_borrow_comp_cls_by_index_func_t borrow_comp_cls_by_index_func
,
1105 spec_comp_cls_borrow_comp_cls_func_t spec_comp_cls_borrow_comp_cls_func
)
1110 printf(" %s%s component classes%s: (none)\n",
1111 bt_common_color_bold(),
1113 bt_common_color_reset());
1116 printf(" %s%s component classes%s:\n",
1117 bt_common_color_bold(),
1119 bt_common_color_reset());
1122 for (i
= 0; i
< count
; i
++) {
1123 const bt_component_class
*comp_class
=
1124 spec_comp_cls_borrow_comp_cls_func(
1125 borrow_comp_cls_by_index_func(plugin
, i
));
1126 const char *comp_class_name
=
1127 bt_component_class_get_name(comp_class
);
1128 const char *comp_class_description
=
1129 bt_component_class_get_description(comp_class
);
1130 bt_component_class_type type
=
1131 bt_component_class_get_type(comp_class
);
1134 print_plugin_comp_cls_opt(stdout
,
1135 bt_plugin_get_name(plugin
), comp_class_name
,
1138 if (comp_class_description
) {
1139 printf(": %s", comp_class_description
);
1150 int cmd_list_plugins(struct bt_config
*cfg
)
1153 int plugins_count
, component_classes_count
= 0, i
;
1155 printf("From the following plugin paths:\n\n");
1156 print_value(stdout
, cfg
->plugin_paths
, 2);
1158 plugins_count
= loaded_plugins
->len
;
1159 if (plugins_count
== 0) {
1160 printf("No plugins found.\n");
1164 for (i
= 0; i
< plugins_count
; i
++) {
1165 const bt_plugin
*plugin
= g_ptr_array_index(loaded_plugins
, i
);
1167 component_classes_count
+=
1168 bt_plugin_get_source_component_class_count(plugin
) +
1169 bt_plugin_get_filter_component_class_count(plugin
) +
1170 bt_plugin_get_sink_component_class_count(plugin
);
1173 printf("Found %s%d%s component classes in %s%d%s plugins.\n",
1174 bt_common_color_bold(),
1175 component_classes_count
,
1176 bt_common_color_reset(),
1177 bt_common_color_bold(),
1179 bt_common_color_reset());
1181 for (i
= 0; i
< plugins_count
; i
++) {
1182 const bt_plugin
*plugin
= g_ptr_array_index(loaded_plugins
, i
);
1185 print_plugin_info(plugin
);
1186 cmd_list_plugins_print_component_classes(plugin
, "Source",
1187 bt_plugin_get_source_component_class_count(plugin
),
1188 (plugin_borrow_comp_cls_by_index_func_t
)
1189 bt_plugin_borrow_source_component_class_by_index_const
,
1190 (spec_comp_cls_borrow_comp_cls_func_t
)
1191 bt_component_class_source_as_component_class
);
1192 cmd_list_plugins_print_component_classes(plugin
, "Filter",
1193 bt_plugin_get_filter_component_class_count(plugin
),
1194 (plugin_borrow_comp_cls_by_index_func_t
)
1195 bt_plugin_borrow_filter_component_class_by_index_const
,
1196 (spec_comp_cls_borrow_comp_cls_func_t
)
1197 bt_component_class_filter_as_component_class
);
1198 cmd_list_plugins_print_component_classes(plugin
, "Sink",
1199 bt_plugin_get_sink_component_class_count(plugin
),
1200 (plugin_borrow_comp_cls_by_index_func_t
)
1201 bt_plugin_borrow_sink_component_class_by_index_const
,
1202 (spec_comp_cls_borrow_comp_cls_func_t
)
1203 bt_component_class_sink_as_component_class
);
1211 int cmd_print_lttng_live_sessions(struct bt_config
*cfg
)
1214 const bt_component_class
*comp_cls
= NULL
;
1215 const bt_value
*results
= NULL
;
1216 bt_value
*params
= NULL
;
1217 const bt_value
*map
= NULL
;
1218 const bt_value
*v
= NULL
;
1219 static const char * const plugin_name
= "ctf";
1220 static const char * const comp_cls_name
= "lttng-live";
1221 static const bt_component_class_type comp_cls_type
=
1222 BT_COMPONENT_CLASS_TYPE_SOURCE
;
1223 int64_t array_size
, i
;
1224 const char *fail_reason
= NULL
;
1225 FILE *out_stream
= stdout
;
1227 BT_ASSERT(cfg
->cmd_data
.print_lttng_live_sessions
.url
);
1228 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1231 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
1232 "comp-cls-name=\"%s\", comp-cls-type=%d",
1233 plugin_name
, comp_cls_name
,
1234 BT_COMPONENT_CLASS_TYPE_SOURCE
);
1235 fprintf(stderr
, "%s%sCannot find component class %s",
1236 bt_common_color_bold(),
1237 bt_common_color_fg_red(),
1238 bt_common_color_reset());
1239 print_plugin_comp_cls_opt(stderr
, plugin_name
,
1240 comp_cls_name
, comp_cls_type
);
1241 fprintf(stderr
, "\n");
1245 params
= bt_value_map_create();
1250 ret
= bt_value_map_insert_string_entry(params
, "url",
1251 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
1256 ret
= query(cfg
, comp_cls
, "sessions", params
,
1257 &results
, &fail_reason
);
1264 if (!bt_value_is_array(results
)) {
1265 BT_LOGE_STR("Expecting an array for sessions query.");
1266 fprintf(stderr
, "%s%sUnexpected type returned by session query%s\n",
1267 bt_common_color_bold(),
1268 bt_common_color_fg_red(),
1269 bt_common_color_reset());
1273 if (cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->len
> 0) {
1275 fopen(cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
,
1279 BT_LOGE_ERRNO("Cannot open file for writing",
1281 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
1286 array_size
= bt_value_array_get_size(results
);
1287 for (i
= 0; i
< array_size
; i
++) {
1288 const char *url_text
;
1289 int64_t timer_us
, streams
, clients
;
1291 map
= bt_value_array_borrow_element_by_index_const(results
, i
);
1293 BT_LOGE_STR("Unexpected empty array entry.");
1296 if (!bt_value_is_map(map
)) {
1297 BT_LOGE_STR("Unexpected entry type.");
1301 v
= bt_value_map_borrow_entry_value_const(map
, "url");
1303 BT_LOGE_STR("Unexpected empty array \"url\" entry.");
1306 url_text
= bt_value_string_get(v
);
1307 fprintf(out_stream
, "%s", url_text
);
1308 v
= bt_value_map_borrow_entry_value_const(map
, "timer-us");
1310 BT_LOGE_STR("Unexpected empty array \"timer-us\" entry.");
1313 timer_us
= bt_value_signed_integer_get(v
);
1314 fprintf(out_stream
, " (timer = %" PRIu64
", ", timer_us
);
1315 v
= bt_value_map_borrow_entry_value_const(map
, "stream-count");
1317 BT_LOGE_STR("Unexpected empty array \"stream-count\" entry.");
1320 streams
= bt_value_signed_integer_get(v
);
1321 fprintf(out_stream
, "%" PRIu64
" stream(s), ", streams
);
1322 v
= bt_value_map_borrow_entry_value_const(map
, "client-count");
1324 BT_LOGE_STR("Unexpected empty array \"client-count\" entry.");
1327 clients
= bt_value_signed_integer_get(v
);
1328 fprintf(out_stream
, "%" PRIu64
" client(s) connected)\n", clients
);
1334 BT_LOGE("Failed to query for sessions: %s", fail_reason
);
1335 fprintf(stderr
, "%s%sFailed to request sessions: %s%s\n",
1336 bt_common_color_bold(),
1337 bt_common_color_fg_red(),
1339 bt_common_color_reset());
1345 bt_value_put_ref(results
);
1346 bt_value_put_ref(params
);
1347 bt_component_class_put_ref(comp_cls
);
1349 if (out_stream
&& out_stream
!= stdout
) {
1350 int fclose_ret
= fclose(out_stream
);
1353 BT_LOGE_ERRNO("Cannot close file stream",
1355 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
1363 int cmd_print_ctf_metadata(struct bt_config
*cfg
)
1366 const bt_component_class
*comp_cls
= NULL
;
1367 const bt_value
*results
= NULL
;
1368 bt_value
*params
= NULL
;
1369 const bt_value
*metadata_text_value
= NULL
;
1370 const char *metadata_text
= NULL
;
1371 static const char * const plugin_name
= "ctf";
1372 static const char * const comp_cls_name
= "fs";
1373 static const bt_component_class_type comp_cls_type
=
1374 BT_COMPONENT_CLASS_TYPE_SOURCE
;
1375 const char *fail_reason
= NULL
;
1376 FILE *out_stream
= stdout
;
1378 BT_ASSERT(cfg
->cmd_data
.print_ctf_metadata
.path
);
1379 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1382 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
1383 "comp-cls-name=\"%s\", comp-cls-type=%d",
1384 plugin_name
, comp_cls_name
,
1385 BT_COMPONENT_CLASS_TYPE_SOURCE
);
1386 fprintf(stderr
, "%s%sCannot find component class %s",
1387 bt_common_color_bold(),
1388 bt_common_color_fg_red(),
1389 bt_common_color_reset());
1390 print_plugin_comp_cls_opt(stderr
, plugin_name
,
1391 comp_cls_name
, comp_cls_type
);
1392 fprintf(stderr
, "\n");
1397 params
= bt_value_map_create();
1403 ret
= bt_value_map_insert_string_entry(params
, "path",
1404 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
1410 ret
= query(cfg
, comp_cls
, "metadata-info",
1411 params
, &results
, &fail_reason
);
1416 metadata_text_value
= bt_value_map_borrow_entry_value_const(results
,
1418 if (!metadata_text_value
) {
1419 BT_LOGE_STR("Cannot find `text` string value in the resulting metadata info object.");
1424 metadata_text
= bt_value_string_get(metadata_text_value
);
1426 if (cfg
->cmd_data
.print_ctf_metadata
.output_path
->len
> 0) {
1428 fopen(cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
,
1432 BT_LOGE_ERRNO("Cannot open file for writing",
1434 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1439 ret
= fprintf(out_stream
, "%s\n", metadata_text
);
1441 BT_LOGE("Cannot write whole metadata text to output stream: "
1452 BT_LOGE("Failed to query for metadata info: %s", fail_reason
);
1453 fprintf(stderr
, "%s%sFailed to request metadata info: %s%s\n",
1454 bt_common_color_bold(),
1455 bt_common_color_fg_red(),
1457 bt_common_color_reset());
1460 bt_value_put_ref(results
);
1461 bt_value_put_ref(params
);
1462 bt_component_class_put_ref(comp_cls
);
1464 if (out_stream
&& out_stream
!= stdout
) {
1465 int fclose_ret
= fclose(out_stream
);
1468 BT_LOGE_ERRNO("Cannot close file stream",
1470 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1478 char *instance_name
;
1482 struct trace_range
{
1483 uint64_t intersection_range_begin_ns
;
1484 uint64_t intersection_range_end_ns
;
1488 guint
port_id_hash(gconstpointer v
)
1490 const struct port_id
*id
= v
;
1492 BT_ASSERT(id
->instance_name
);
1493 BT_ASSERT(id
->port_name
);
1495 return g_str_hash(id
->instance_name
) ^ g_str_hash(id
->port_name
);
1499 gboolean
port_id_equal(gconstpointer v1
, gconstpointer v2
)
1501 const struct port_id
*id1
= v1
;
1502 const struct port_id
*id2
= v2
;
1504 return !strcmp(id1
->instance_name
, id2
->instance_name
) &&
1505 !strcmp(id1
->port_name
, id2
->port_name
);
1509 void port_id_destroy(gpointer data
)
1511 struct port_id
*id
= data
;
1513 free(id
->instance_name
);
1514 free(id
->port_name
);
1519 void trace_range_destroy(gpointer data
)
1524 struct cmd_run_ctx
{
1526 GHashTable
*src_components
;
1529 GHashTable
*flt_components
;
1532 GHashTable
*sink_components
;
1538 struct bt_config
*cfg
;
1542 bool stream_intersection_mode
;
1545 * Association of struct port_id -> struct trace_range.
1547 GHashTable
*intersections
;
1550 /* Returns a timestamp of the form "(-)s.ns" */
1552 char *s_from_ns(int64_t ns
)
1557 int64_t ts_sec_abs
, ts_nsec_abs
;
1558 int64_t ts_sec
= ns
/ NSEC_PER_SEC
;
1559 int64_t ts_nsec
= ns
% NSEC_PER_SEC
;
1561 if (ts_sec
>= 0 && ts_nsec
>= 0) {
1562 is_negative
= false;
1563 ts_sec_abs
= ts_sec
;
1564 ts_nsec_abs
= ts_nsec
;
1565 } else if (ts_sec
> 0 && ts_nsec
< 0) {
1566 is_negative
= false;
1567 ts_sec_abs
= ts_sec
- 1;
1568 ts_nsec_abs
= NSEC_PER_SEC
+ ts_nsec
;
1569 } else if (ts_sec
== 0 && ts_nsec
< 0) {
1571 ts_sec_abs
= ts_sec
;
1572 ts_nsec_abs
= -ts_nsec
;
1573 } else if (ts_sec
< 0 && ts_nsec
> 0) {
1575 ts_sec_abs
= -(ts_sec
+ 1);
1576 ts_nsec_abs
= NSEC_PER_SEC
- ts_nsec
;
1577 } else if (ts_sec
< 0 && ts_nsec
== 0) {
1579 ts_sec_abs
= -ts_sec
;
1580 ts_nsec_abs
= ts_nsec
;
1581 } else { /* (ts_sec < 0 && ts_nsec < 0) */
1583 ts_sec_abs
= -ts_sec
;
1584 ts_nsec_abs
= -ts_nsec
;
1587 ret
= asprintf(&s_ret
, "%s%" PRId64
".%09" PRId64
,
1588 is_negative
? "-" : "", ts_sec_abs
, ts_nsec_abs
);
1596 int cmd_run_ctx_connect_upstream_port_to_downstream_component(
1597 struct cmd_run_ctx
*ctx
,
1598 const bt_component
*upstream_comp
,
1599 const bt_port_output
*out_upstream_port
,
1600 struct bt_config_connection
*cfg_conn
)
1602 typedef uint64_t (*input_port_count_func_t
)(void *);
1603 typedef const bt_port_input
*(*borrow_input_port_by_index_func_t
)(
1604 const void *, uint64_t);
1605 const bt_port
*upstream_port
=
1606 bt_port_output_as_port_const(out_upstream_port
);
1609 GQuark downstreamp_comp_name_quark
;
1610 void *downstream_comp
;
1611 uint64_t downstream_port_count
;
1613 input_port_count_func_t port_count_fn
;
1614 borrow_input_port_by_index_func_t port_by_index_fn
;
1615 bt_graph_status status
= BT_GRAPH_STATUS_ERROR
;
1616 bool insert_trimmer
= false;
1617 bt_value
*trimmer_params
= NULL
;
1618 char *intersection_begin
= NULL
;
1619 char *intersection_end
= NULL
;
1620 const bt_component_filter
*trimmer
= NULL
;
1621 const bt_component_class_filter
*trimmer_class
= NULL
;
1622 const bt_port_input
*trimmer_input
= NULL
;
1623 const bt_port_output
*trimmer_output
= NULL
;
1625 if (ctx
->intersections
&&
1626 bt_component_get_class_type(upstream_comp
) ==
1627 BT_COMPONENT_CLASS_TYPE_SOURCE
) {
1628 struct trace_range
*range
;
1629 struct port_id port_id
= {
1630 .instance_name
= (char *) bt_component_get_name(upstream_comp
),
1631 .port_name
= (char *) bt_port_get_name(upstream_port
)
1634 if (!port_id
.instance_name
|| !port_id
.port_name
) {
1638 range
= (struct trace_range
*) g_hash_table_lookup(
1639 ctx
->intersections
, &port_id
);
1641 bt_value_status status
;
1643 intersection_begin
= s_from_ns(
1644 range
->intersection_range_begin_ns
);
1645 intersection_end
= s_from_ns(
1646 range
->intersection_range_end_ns
);
1647 if (!intersection_begin
|| !intersection_end
) {
1648 BT_LOGE_STR("Cannot create trimmer argument timestamp string.");
1652 insert_trimmer
= true;
1653 trimmer_params
= bt_value_map_create();
1654 if (!trimmer_params
) {
1658 status
= bt_value_map_insert_string_entry(
1659 trimmer_params
, "begin", intersection_begin
);
1660 if (status
!= BT_VALUE_STATUS_OK
) {
1663 status
= bt_value_map_insert_string_entry(
1665 "end", intersection_end
);
1666 if (status
!= BT_VALUE_STATUS_OK
) {
1671 trimmer_class
= find_filter_component_class("utils", "trimmer");
1672 if (!trimmer_class
) {
1677 BT_LOGI("Connecting upstream port to the next available downstream port: "
1678 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1679 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1680 upstream_port
, bt_port_get_name(upstream_port
),
1681 cfg_conn
->downstream_comp_name
->str
,
1682 cfg_conn
->arg
->str
);
1683 downstreamp_comp_name_quark
= g_quark_from_string(
1684 cfg_conn
->downstream_comp_name
->str
);
1685 BT_ASSERT(downstreamp_comp_name_quark
> 0);
1686 downstream_comp
= g_hash_table_lookup(ctx
->flt_components
,
1687 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1688 port_count_fn
= (input_port_count_func_t
)
1689 bt_component_filter_get_input_port_count
;
1690 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1691 bt_component_filter_borrow_input_port_by_index_const
;
1693 if (!downstream_comp
) {
1694 downstream_comp
= g_hash_table_lookup(ctx
->sink_components
,
1695 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1696 port_count_fn
= (input_port_count_func_t
)
1697 bt_component_sink_get_input_port_count
;
1698 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1699 bt_component_sink_borrow_input_port_by_index_const
;
1702 if (!downstream_comp
) {
1703 BT_LOGE("Cannot find downstream component: comp-name=\"%s\", "
1704 "conn-arg=\"%s\"", cfg_conn
->downstream_comp_name
->str
,
1705 cfg_conn
->arg
->str
);
1706 fprintf(stderr
, "Cannot create connection: cannot find downstream component: %s\n",
1707 cfg_conn
->arg
->str
);
1711 downstream_port_count
= port_count_fn(downstream_comp
);
1713 for (i
= 0; i
< downstream_port_count
; i
++) {
1714 const bt_port_input
*in_downstream_port
=
1715 port_by_index_fn(downstream_comp
, i
);
1716 const bt_port
*downstream_port
=
1717 bt_port_input_as_port_const(in_downstream_port
);
1718 const char *upstream_port_name
;
1719 const char *downstream_port_name
;
1721 BT_ASSERT(downstream_port
);
1723 /* Skip port if it's already connected. */
1724 if (bt_port_is_connected(downstream_port
)) {
1725 BT_LOGI("Skipping downstream port: already connected: "
1726 "port-addr=%p, port-name=\"%s\"",
1728 bt_port_get_name(downstream_port
));
1732 downstream_port_name
= bt_port_get_name(downstream_port
);
1733 BT_ASSERT(downstream_port_name
);
1734 upstream_port_name
= bt_port_get_name(upstream_port
);
1735 BT_ASSERT(upstream_port_name
);
1737 if (!bt_common_star_glob_match(
1738 cfg_conn
->downstream_port_glob
->str
, SIZE_MAX
,
1739 downstream_port_name
, SIZE_MAX
)) {
1743 if (insert_trimmer
) {
1745 * In order to insert the trimmer between the
1746 * two components that were being connected, we
1747 * create a connection configuration entry which
1748 * describes a connection from the trimmer's
1749 * output to the original input that was being
1752 * Hence, the creation of the trimmer will cause
1753 * the graph "new port" listener to establish
1754 * all downstream connections as its output port
1755 * is connected. We will then establish the
1756 * connection between the original upstream
1757 * source and the trimmer.
1759 char *trimmer_name
= NULL
;
1760 bt_graph_status graph_status
;
1762 ret
= asprintf(&trimmer_name
,
1763 "stream-intersection-trimmer-%s",
1764 upstream_port_name
);
1770 ctx
->connect_ports
= false;
1771 graph_status
= bt_graph_add_filter_component(
1772 ctx
->graph
, trimmer_class
, trimmer_name
,
1773 trimmer_params
, ctx
->cfg
->log_level
,
1776 if (graph_status
!= BT_GRAPH_STATUS_OK
) {
1782 bt_component_filter_borrow_input_port_by_index_const(
1784 if (!trimmer_input
) {
1788 bt_component_filter_borrow_output_port_by_index_const(
1790 if (!trimmer_output
) {
1795 * Replace the current downstream port by the trimmer's
1798 in_downstream_port
= trimmer_input
;
1800 bt_port_input_as_port_const(in_downstream_port
);
1801 downstream_port_name
= bt_port_get_name(
1803 BT_ASSERT(downstream_port_name
);
1806 /* We have a winner! */
1807 status
= bt_graph_connect_ports(ctx
->graph
,
1808 out_upstream_port
, in_downstream_port
, NULL
);
1809 downstream_port
= NULL
;
1811 case BT_GRAPH_STATUS_OK
:
1813 case BT_GRAPH_STATUS_CANCELED
:
1814 BT_LOGI_STR("Graph was canceled by user.");
1815 status
= BT_GRAPH_STATUS_OK
;
1817 case BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION
:
1818 BT_LOGE("A component refused a connection to one of its ports: "
1819 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1820 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1821 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1822 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1824 upstream_comp
, bt_component_get_name(upstream_comp
),
1825 upstream_port
, bt_port_get_name(upstream_port
),
1826 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1827 downstream_port
, downstream_port_name
,
1828 cfg_conn
->arg
->str
);
1830 "A component refused a connection to one of its ports (`%s` to `%s`): %s\n",
1831 bt_port_get_name(upstream_port
),
1832 downstream_port_name
,
1833 cfg_conn
->arg
->str
);
1836 BT_LOGE("Cannot create connection: graph refuses to connect ports: "
1837 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1838 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1839 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1840 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1842 upstream_comp
, bt_component_get_name(upstream_comp
),
1843 upstream_port
, bt_port_get_name(upstream_port
),
1844 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1845 downstream_port
, downstream_port_name
,
1846 cfg_conn
->arg
->str
);
1848 "Cannot create connection: graph refuses to connect ports (`%s` to `%s`): %s\n",
1849 bt_port_get_name(upstream_port
),
1850 downstream_port_name
,
1851 cfg_conn
->arg
->str
);
1855 BT_LOGI("Connected component ports: "
1856 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1857 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1858 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1859 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1861 upstream_comp
, bt_component_get_name(upstream_comp
),
1862 upstream_port
, bt_port_get_name(upstream_port
),
1863 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1864 downstream_port
, downstream_port_name
,
1865 cfg_conn
->arg
->str
);
1867 if (insert_trimmer
) {
1869 * The first connection, from the source to the trimmer,
1870 * has been done. We now connect the trimmer to the
1871 * original downstream port.
1873 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1875 bt_component_filter_as_component_const(trimmer
),
1876 trimmer_output
, cfg_conn
);
1880 ctx
->connect_ports
= true;
1884 * We found a matching downstream port: the search is
1890 /* No downstream port found */
1891 BT_LOGE("Cannot create connection: cannot find a matching downstream port for upstream port: "
1892 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1893 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1894 upstream_port
, bt_port_get_name(upstream_port
),
1895 cfg_conn
->downstream_comp_name
->str
,
1896 cfg_conn
->arg
->str
);
1898 "Cannot create connection: cannot find a matching downstream port for upstream port `%s`: %s\n",
1899 bt_port_get_name(upstream_port
), cfg_conn
->arg
->str
);
1905 free(intersection_begin
);
1906 free(intersection_end
);
1907 BT_VALUE_PUT_REF_AND_RESET(trimmer_params
);
1908 BT_COMPONENT_CLASS_FILTER_PUT_REF_AND_RESET(trimmer_class
);
1909 BT_COMPONENT_FILTER_PUT_REF_AND_RESET(trimmer
);
1914 int cmd_run_ctx_connect_upstream_port(struct cmd_run_ctx
*ctx
,
1915 const bt_port_output
*upstream_port
)
1918 const char *upstream_port_name
;
1919 const char *upstream_comp_name
;
1920 const bt_component
*upstream_comp
= NULL
;
1924 BT_ASSERT(upstream_port
);
1925 upstream_port_name
= bt_port_get_name(
1926 bt_port_output_as_port_const(upstream_port
));
1927 BT_ASSERT(upstream_port_name
);
1928 upstream_comp
= bt_port_borrow_component_const(
1929 bt_port_output_as_port_const(upstream_port
));
1930 if (!upstream_comp
) {
1931 BT_LOGW("Upstream port to connect is not part of a component: "
1932 "port-addr=%p, port-name=\"%s\"",
1933 upstream_port
, upstream_port_name
);
1938 upstream_comp_name
= bt_component_get_name(upstream_comp
);
1939 BT_ASSERT(upstream_comp_name
);
1940 BT_LOGI("Connecting upstream port: comp-addr=%p, comp-name=\"%s\", "
1941 "port-addr=%p, port-name=\"%s\"",
1942 upstream_comp
, upstream_comp_name
,
1943 upstream_port
, upstream_port_name
);
1945 for (i
= 0; i
< ctx
->cfg
->cmd_data
.run
.connections
->len
; i
++) {
1946 struct bt_config_connection
*cfg_conn
=
1948 ctx
->cfg
->cmd_data
.run
.connections
, i
);
1950 if (strcmp(cfg_conn
->upstream_comp_name
->str
,
1951 upstream_comp_name
)) {
1955 if (!bt_common_star_glob_match(
1956 cfg_conn
->upstream_port_glob
->str
,
1957 SIZE_MAX
, upstream_port_name
, SIZE_MAX
)) {
1961 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1962 ctx
, upstream_comp
, upstream_port
, cfg_conn
);
1964 BT_LOGE("Cannot connect upstream port: "
1965 "port-addr=%p, port-name=\"%s\"",
1967 upstream_port_name
);
1969 "Cannot connect port `%s` of component `%s` to a downstream port: %s\n",
1972 cfg_conn
->arg
->str
);
1978 BT_LOGE("Cannot connect upstream port: port does not match any connection argument: "
1979 "port-addr=%p, port-name=\"%s\"", upstream_port
,
1980 upstream_port_name
);
1982 "Cannot create connection: upstream port `%s` does not match any connection\n",
1983 upstream_port_name
);
1993 bt_graph_listener_status
1994 graph_output_port_added_listener(struct cmd_run_ctx
*ctx
,
1995 const bt_port_output
*out_port
)
1997 const bt_component
*comp
;
1998 const bt_port
*port
= bt_port_output_as_port_const(out_port
);
1999 bt_graph_listener_status ret
= BT_GRAPH_LISTENER_STATUS_OK
;
2001 comp
= bt_port_borrow_component_const(port
);
2002 BT_LOGI("Port added to a graph's component: comp-addr=%p, "
2003 "comp-name=\"%s\", port-addr=%p, port-name=\"%s\"",
2004 comp
, comp
? bt_component_get_name(comp
) : "",
2005 port
, bt_port_get_name(port
));
2007 if (!ctx
->connect_ports
) {
2012 BT_LOGW_STR("Port has no component.");
2016 if (bt_port_is_connected(port
)) {
2017 BT_LOGW_STR("Port is already connected.");
2021 if (cmd_run_ctx_connect_upstream_port(ctx
, out_port
)) {
2022 BT_LOGF_STR("Cannot connect upstream port.");
2023 fprintf(stderr
, "Added port could not be connected: aborting\n");
2024 ret
= BT_GRAPH_LISTENER_STATUS_ERROR
;
2033 bt_graph_listener_status
graph_source_output_port_added_listener(
2034 const bt_component_source
*component
,
2035 const bt_port_output
*port
, void *data
)
2037 return graph_output_port_added_listener(data
, port
);
2041 bt_graph_listener_status
graph_filter_output_port_added_listener(
2042 const bt_component_filter
*component
,
2043 const bt_port_output
*port
, void *data
)
2045 return graph_output_port_added_listener(data
, port
);
2049 void cmd_run_ctx_destroy(struct cmd_run_ctx
*ctx
)
2055 if (ctx
->src_components
) {
2056 g_hash_table_destroy(ctx
->src_components
);
2057 ctx
->src_components
= NULL
;
2060 if (ctx
->flt_components
) {
2061 g_hash_table_destroy(ctx
->flt_components
);
2062 ctx
->flt_components
= NULL
;
2065 if (ctx
->sink_components
) {
2066 g_hash_table_destroy(ctx
->sink_components
);
2067 ctx
->sink_components
= NULL
;
2070 if (ctx
->intersections
) {
2071 g_hash_table_destroy(ctx
->intersections
);
2072 ctx
->intersections
= NULL
;
2075 BT_GRAPH_PUT_REF_AND_RESET(ctx
->graph
);
2081 int cmd_run_ctx_init(struct cmd_run_ctx
*ctx
, struct bt_config
*cfg
)
2084 bt_graph_status status
;
2087 ctx
->connect_ports
= false;
2088 ctx
->src_components
= g_hash_table_new_full(g_direct_hash
,
2089 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
2090 if (!ctx
->src_components
) {
2094 ctx
->flt_components
= g_hash_table_new_full(g_direct_hash
,
2095 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
2096 if (!ctx
->flt_components
) {
2100 ctx
->sink_components
= g_hash_table_new_full(g_direct_hash
,
2101 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
2102 if (!ctx
->sink_components
) {
2106 if (cfg
->cmd_data
.run
.stream_intersection_mode
) {
2107 ctx
->stream_intersection_mode
= true;
2108 ctx
->intersections
= g_hash_table_new_full(port_id_hash
,
2109 port_id_equal
, port_id_destroy
, trace_range_destroy
);
2110 if (!ctx
->intersections
) {
2115 ctx
->graph
= bt_graph_create();
2120 the_graph
= ctx
->graph
;
2121 status
= bt_graph_add_source_component_output_port_added_listener(
2122 ctx
->graph
, graph_source_output_port_added_listener
, NULL
, ctx
,
2124 if (status
!= BT_GRAPH_STATUS_OK
) {
2125 BT_LOGE_STR("Cannot add \"port added\" listener to graph.");
2129 status
= bt_graph_add_filter_component_output_port_added_listener(
2130 ctx
->graph
, graph_filter_output_port_added_listener
, NULL
, ctx
,
2132 if (status
!= BT_GRAPH_STATUS_OK
) {
2133 BT_LOGE_STR("Cannot add \"port added\" listener to graph.");
2140 cmd_run_ctx_destroy(ctx
);
2148 int set_stream_intersections(struct cmd_run_ctx
*ctx
,
2149 struct bt_config_component
*cfg_comp
,
2150 const bt_component_class_source
*src_comp_cls
)
2154 int64_t trace_count
;
2155 const char *path
= NULL
;
2156 const bt_value
*query_result
= NULL
;
2157 const bt_value
*trace_info
= NULL
;
2158 const bt_value
*intersection_range
= NULL
;
2159 const bt_value
*intersection_begin
= NULL
;
2160 const bt_value
*intersection_end
= NULL
;
2161 const bt_value
*stream_infos
= NULL
;
2162 const bt_value
*stream_info
= NULL
;
2163 struct port_id
*port_id
= NULL
;
2164 struct trace_range
*trace_range
= NULL
;
2165 const char *fail_reason
= NULL
;
2166 const bt_component_class
*comp_cls
=
2167 bt_component_class_source_as_component_class_const(src_comp_cls
);
2169 ret
= query(ctx
->cfg
, comp_cls
, "trace-info",
2170 cfg_comp
->params
, &query_result
,
2173 BT_LOGD("Component class does not support the `trace-info` query: %s: "
2174 "comp-class-name=\"%s\"", fail_reason
,
2175 bt_component_class_get_name(comp_cls
));
2180 BT_ASSERT(query_result
);
2182 if (!bt_value_is_array(query_result
)) {
2183 BT_LOGD("Unexpected format of \'trace-info\' query result: "
2184 "component-class-name=%s",
2185 bt_component_class_get_name(comp_cls
));
2190 trace_count
= bt_value_array_get_size(query_result
);
2191 if (trace_count
< 0) {
2196 for (trace_idx
= 0; trace_idx
< trace_count
; trace_idx
++) {
2198 uint64_t stream_idx
;
2199 int64_t stream_count
;
2201 trace_info
= bt_value_array_borrow_element_by_index_const(
2202 query_result
, trace_idx
);
2203 if (!trace_info
|| !bt_value_is_map(trace_info
)) {
2205 BT_LOGD_STR("Cannot retrieve trace from query result.");
2209 intersection_range
= bt_value_map_borrow_entry_value_const(
2210 trace_info
, "intersection-range-ns");
2211 if (!intersection_range
) {
2213 BT_LOGD_STR("Cannot retrieve \'intersetion-range-ns\' field from query result.");
2217 intersection_begin
= bt_value_map_borrow_entry_value_const(intersection_range
,
2219 if (!intersection_begin
) {
2221 BT_LOGD_STR("Cannot retrieve intersection-range-ns \'begin\' field from query result.");
2225 intersection_end
= bt_value_map_borrow_entry_value_const(intersection_range
,
2227 if (!intersection_end
) {
2229 BT_LOGD_STR("Cannot retrieve intersection-range-ns \'end\' field from query result.");
2233 begin
= bt_value_signed_integer_get(intersection_begin
);
2234 end
= bt_value_signed_integer_get(intersection_end
);
2236 if (begin
< 0 || end
< 0 || end
< begin
) {
2237 BT_LOGW("Invalid trace stream intersection values: "
2238 "intersection-range-ns:begin=%" PRId64
2239 ", intersection-range-ns:end=%" PRId64
,
2245 stream_infos
= bt_value_map_borrow_entry_value_const(trace_info
,
2247 if (!stream_infos
|| !bt_value_is_array(stream_infos
)) {
2249 BT_LOGD_STR("Cannot retrieve stream information from trace in query result.");
2253 stream_count
= bt_value_array_get_size(stream_infos
);
2254 if (stream_count
< 0) {
2259 for (stream_idx
= 0; stream_idx
< stream_count
; stream_idx
++) {
2260 const bt_value
*port_name
;
2262 port_id
= g_new0(struct port_id
, 1);
2265 BT_LOGE_STR("Cannot allocate memory for port_id structure.");
2268 port_id
->instance_name
= strdup(cfg_comp
->instance_name
->str
);
2269 if (!port_id
->instance_name
) {
2271 BT_LOGE_STR("Cannot allocate memory for port_id component instance name.");
2275 trace_range
= g_new0(struct trace_range
, 1);
2278 BT_LOGE_STR("Cannot allocate memory for trace_range structure.");
2281 trace_range
->intersection_range_begin_ns
= begin
;
2282 trace_range
->intersection_range_end_ns
= end
;
2284 stream_info
= bt_value_array_borrow_element_by_index_const(
2285 stream_infos
, stream_idx
);
2286 if (!stream_info
|| !bt_value_is_map(stream_info
)) {
2288 BT_LOGE_STR("Cannot retrieve stream informations from trace in query result.");
2292 port_name
= bt_value_map_borrow_entry_value_const(stream_info
, "port-name");
2293 if (!port_name
|| !bt_value_is_string(port_name
)) {
2295 BT_LOGE_STR("Cannot retrieve port name in query result.");
2299 port_id
->port_name
= g_strdup(bt_value_string_get(port_name
));
2300 if (!port_id
->port_name
) {
2302 BT_LOGE_STR("Cannot allocate memory for port_id port_name.");
2306 BT_LOGD("Inserting stream intersection ");
2308 g_hash_table_insert(ctx
->intersections
, port_id
, trace_range
);
2318 fprintf(stderr
, "%s%sCannot determine stream intersection of trace at path \'%s\'.%s\n",
2319 bt_common_color_bold(),
2320 bt_common_color_fg_yellow(),
2321 path
? path
: "(unknown)",
2322 bt_common_color_reset());
2324 bt_value_put_ref(query_result
);
2326 g_free(trace_range
);
2331 int cmd_run_ctx_create_components_from_config_components(
2332 struct cmd_run_ctx
*ctx
, GPtrArray
*cfg_components
)
2335 const void *comp_cls
= NULL
;
2336 const void *comp
= NULL
;
2339 for (i
= 0; i
< cfg_components
->len
; i
++) {
2340 struct bt_config_component
*cfg_comp
=
2341 g_ptr_array_index(cfg_components
, i
);
2344 switch (cfg_comp
->type
) {
2345 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2346 comp_cls
= find_source_component_class(
2347 cfg_comp
->plugin_name
->str
,
2348 cfg_comp
->comp_cls_name
->str
);
2350 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2351 comp_cls
= find_filter_component_class(
2352 cfg_comp
->plugin_name
->str
,
2353 cfg_comp
->comp_cls_name
->str
);
2355 case BT_COMPONENT_CLASS_TYPE_SINK
:
2356 comp_cls
= find_sink_component_class(
2357 cfg_comp
->plugin_name
->str
,
2358 cfg_comp
->comp_cls_name
->str
);
2365 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
2366 "comp-cls-name=\"%s\", comp-cls-type=%d",
2367 cfg_comp
->plugin_name
->str
,
2368 cfg_comp
->comp_cls_name
->str
,
2370 fprintf(stderr
, "%s%sCannot find component class %s",
2371 bt_common_color_bold(),
2372 bt_common_color_fg_red(),
2373 bt_common_color_reset());
2374 print_plugin_comp_cls_opt(stderr
,
2375 cfg_comp
->plugin_name
->str
,
2376 cfg_comp
->comp_cls_name
->str
,
2378 fprintf(stderr
, "\n");
2382 BT_ASSERT(cfg_comp
->log_level
>= BT_LOG_VERBOSE
);
2384 switch (cfg_comp
->type
) {
2385 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2386 ret
= bt_graph_add_source_component(ctx
->graph
,
2387 comp_cls
, cfg_comp
->instance_name
->str
,
2388 cfg_comp
->params
, cfg_comp
->log_level
,
2391 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2392 ret
= bt_graph_add_filter_component(ctx
->graph
,
2393 comp_cls
, cfg_comp
->instance_name
->str
,
2394 cfg_comp
->params
, cfg_comp
->log_level
,
2397 case BT_COMPONENT_CLASS_TYPE_SINK
:
2398 ret
= bt_graph_add_sink_component(ctx
->graph
,
2399 comp_cls
, cfg_comp
->instance_name
->str
,
2400 cfg_comp
->params
, cfg_comp
->log_level
,
2408 BT_LOGE("Cannot create component: plugin-name=\"%s\", "
2409 "comp-cls-name=\"%s\", comp-cls-type=%d, "
2411 cfg_comp
->plugin_name
->str
,
2412 cfg_comp
->comp_cls_name
->str
,
2413 cfg_comp
->type
, cfg_comp
->instance_name
->str
);
2414 fprintf(stderr
, "%s%sCannot create component `%s`%s\n",
2415 bt_common_color_bold(),
2416 bt_common_color_fg_red(),
2417 cfg_comp
->instance_name
->str
,
2418 bt_common_color_reset());
2422 if (ctx
->stream_intersection_mode
&&
2423 cfg_comp
->type
== BT_COMPONENT_CLASS_TYPE_SOURCE
) {
2424 ret
= set_stream_intersections(ctx
, cfg_comp
, comp_cls
);
2430 BT_LOGI("Created and inserted component: comp-addr=%p, comp-name=\"%s\"",
2431 comp
, cfg_comp
->instance_name
->str
);
2432 quark
= g_quark_from_string(cfg_comp
->instance_name
->str
);
2433 BT_ASSERT(quark
> 0);
2435 switch (cfg_comp
->type
) {
2436 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2437 g_hash_table_insert(ctx
->src_components
,
2438 GUINT_TO_POINTER(quark
), (void *) comp
);
2440 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2441 g_hash_table_insert(ctx
->flt_components
,
2442 GUINT_TO_POINTER(quark
), (void *) comp
);
2444 case BT_COMPONENT_CLASS_TYPE_SINK
:
2445 g_hash_table_insert(ctx
->sink_components
,
2446 GUINT_TO_POINTER(quark
), (void *) comp
);
2453 BT_OBJECT_PUT_REF_AND_RESET(comp_cls
);
2462 bt_object_put_ref(comp
);
2463 bt_object_put_ref(comp_cls
);
2468 int cmd_run_ctx_create_components(struct cmd_run_ctx
*ctx
)
2473 * Make sure that, during this phase, our graph's "port added"
2474 * listener does not connect ports while we are creating the
2475 * components because we have a special, initial phase for
2478 ctx
->connect_ports
= false;
2480 ret
= cmd_run_ctx_create_components_from_config_components(
2481 ctx
, ctx
->cfg
->cmd_data
.run
.sources
);
2487 ret
= cmd_run_ctx_create_components_from_config_components(
2488 ctx
, ctx
->cfg
->cmd_data
.run
.filters
);
2494 ret
= cmd_run_ctx_create_components_from_config_components(
2495 ctx
, ctx
->cfg
->cmd_data
.run
.sinks
);
2505 typedef uint64_t (*output_port_count_func_t
)(const void *);
2506 typedef const bt_port_output
*(*borrow_output_port_by_index_func_t
)(
2507 const void *, uint64_t);
2510 int cmd_run_ctx_connect_comp_ports(struct cmd_run_ctx
*ctx
,
2511 void *comp
, output_port_count_func_t port_count_fn
,
2512 borrow_output_port_by_index_func_t port_by_index_fn
)
2518 count
= port_count_fn(comp
);
2520 for (i
= 0; i
< count
; i
++) {
2521 const bt_port_output
*upstream_port
= port_by_index_fn(comp
, i
);
2523 BT_ASSERT(upstream_port
);
2524 ret
= cmd_run_ctx_connect_upstream_port(ctx
, upstream_port
);
2535 int cmd_run_ctx_connect_ports(struct cmd_run_ctx
*ctx
)
2538 GHashTableIter iter
;
2539 gpointer g_name_quark
, g_comp
;
2541 ctx
->connect_ports
= true;
2542 g_hash_table_iter_init(&iter
, ctx
->src_components
);
2544 while (g_hash_table_iter_next(&iter
, &g_name_quark
, &g_comp
)) {
2545 ret
= cmd_run_ctx_connect_comp_ports(ctx
, g_comp
,
2546 (output_port_count_func_t
)
2547 bt_component_source_get_output_port_count
,
2548 (borrow_output_port_by_index_func_t
)
2549 bt_component_source_borrow_output_port_by_index_const
);
2555 g_hash_table_iter_init(&iter
, ctx
->flt_components
);
2557 while (g_hash_table_iter_next(&iter
, &g_name_quark
, &g_comp
)) {
2558 ret
= cmd_run_ctx_connect_comp_ports(ctx
, g_comp
,
2559 (output_port_count_func_t
)
2560 bt_component_filter_get_output_port_count
,
2561 (borrow_output_port_by_index_func_t
)
2562 bt_component_filter_borrow_output_port_by_index_const
);
2573 const char *bt_graph_status_str(bt_graph_status status
)
2576 case BT_GRAPH_STATUS_OK
:
2577 return "BT_GRAPH_STATUS_OK";
2578 case BT_GRAPH_STATUS_END
:
2579 return "BT_GRAPH_STATUS_END";
2580 case BT_GRAPH_STATUS_AGAIN
:
2581 return "BT_GRAPH_STATUS_AGAIN";
2582 case BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION
:
2583 return "BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION";
2584 case BT_GRAPH_STATUS_CANCELED
:
2585 return "BT_GRAPH_STATUS_CANCELED";
2586 case BT_GRAPH_STATUS_ERROR
:
2587 return "BT_GRAPH_STATUS_ERROR";
2588 case BT_GRAPH_STATUS_NOMEM
:
2589 return "BT_GRAPH_STATUS_NOMEM";
2596 int cmd_run(struct bt_config
*cfg
)
2599 struct cmd_run_ctx ctx
= { 0 };
2601 /* Initialize the command's context and the graph object */
2602 if (cmd_run_ctx_init(&ctx
, cfg
)) {
2603 BT_LOGE_STR("Cannot initialize the command's context.");
2604 fprintf(stderr
, "Cannot initialize the command's context\n");
2609 BT_LOGI_STR("Canceled by user before creating components.");
2613 BT_LOGI_STR("Creating components.");
2615 /* Create the requested component instances */
2616 if (cmd_run_ctx_create_components(&ctx
)) {
2617 BT_LOGE_STR("Cannot create components.");
2618 fprintf(stderr
, "Cannot create components\n");
2623 BT_LOGI_STR("Canceled by user before connecting components.");
2627 BT_LOGI_STR("Connecting components.");
2629 /* Connect the initially visible component ports */
2630 if (cmd_run_ctx_connect_ports(&ctx
)) {
2631 BT_LOGE_STR("Cannot connect initial component ports.");
2632 fprintf(stderr
, "Cannot connect initial component ports\n");
2637 BT_LOGI_STR("Canceled by user before running the graph.");
2641 BT_LOGI_STR("Running the graph.");
2645 bt_graph_status graph_status
= bt_graph_run(ctx
.graph
);
2648 * Reset console in case something messed with console
2649 * codes during the graph's execution.
2651 printf("%s", bt_common_color_reset());
2653 fprintf(stderr
, "%s", bt_common_color_reset());
2654 BT_LOGV("bt_graph_run() returned: status=%s",
2655 bt_graph_status_str(graph_status
));
2657 switch (graph_status
) {
2658 case BT_GRAPH_STATUS_OK
:
2660 case BT_GRAPH_STATUS_CANCELED
:
2661 BT_LOGI_STR("Graph was canceled by user.");
2663 case BT_GRAPH_STATUS_AGAIN
:
2664 if (bt_graph_is_canceled(ctx
.graph
)) {
2665 BT_LOGI_STR("Graph was canceled by user.");
2669 if (cfg
->cmd_data
.run
.retry_duration_us
> 0) {
2670 BT_LOGV("Got BT_GRAPH_STATUS_AGAIN: sleeping: "
2672 cfg
->cmd_data
.run
.retry_duration_us
);
2674 if (usleep(cfg
->cmd_data
.run
.retry_duration_us
)) {
2675 if (bt_graph_is_canceled(ctx
.graph
)) {
2676 BT_LOGI_STR("Graph was canceled by user.");
2682 case BT_GRAPH_STATUS_END
:
2685 BT_LOGE_STR("Graph failed to complete successfully");
2686 fprintf(stderr
, "Graph failed to complete successfully\n");
2699 cmd_run_ctx_destroy(&ctx
);
2704 void warn_command_name_and_directory_clash(struct bt_config
*cfg
)
2706 const char *env_clash
;
2708 if (!cfg
->command_name
) {
2712 env_clash
= getenv(ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH
);
2713 if (env_clash
&& strcmp(env_clash
, "0") == 0) {
2717 if (g_file_test(cfg
->command_name
,
2718 G_FILE_TEST_EXISTS
| G_FILE_TEST_IS_DIR
)) {
2719 fprintf(stderr
, "\nNOTE: The `%s` command was executed. If you meant to convert a\n",
2721 fprintf(stderr
, "trace located in the local `%s` directory, please use:\n",
2723 fprintf(stderr
, "\n");
2724 fprintf(stderr
, " babeltrace2 convert %s [OPTIONS]\n",
2730 void init_log_level(void)
2732 bt_cli_log_level
= bt_log_get_level_from_env(ENV_BABELTRACE_CLI_LOG_LEVEL
);
2736 void set_auto_log_levels(struct bt_config
*cfg
)
2738 const char **env_var_name
;
2741 * Override the configuration's default log level if
2742 * BABELTRACE_VERBOSE or BABELTRACE_DEBUG environment variables
2743 * are found for backward compatibility with legacy Babetrace 1.
2745 if (getenv("BABELTRACE_DEBUG") &&
2746 strcmp(getenv("BABELTRACE_DEBUG"), "1") == 0) {
2747 cfg
->log_level
= BT_LOG_VERBOSE
;
2748 } else if (getenv("BABELTRACE_VERBOSE") &&
2749 strcmp(getenv("BABELTRACE_VERBOSE"), "1") == 0) {
2750 cfg
->log_level
= BT_LOG_INFO
;
2754 * Set log levels according to --debug or --verbose. For
2755 * backward compatibility, --debug is more verbose than
2758 * --verbose: INFO log level
2759 * --debug: VERBOSE log level (includes DEBUG, which is
2760 * is less verbose than VERBOSE in the internal
2761 * logging framework)
2763 if (!getenv("BABELTRACE_LOGGING_GLOBAL_LEVEL")) {
2765 bt_logging_set_global_level(BT_LOG_INFO
);
2766 } else if (cfg
->debug
) {
2767 bt_logging_set_global_level(BT_LOG_VERBOSE
);
2770 * Set library's default log level if not
2771 * explicitly specified.
2773 bt_logging_set_global_level(cfg
->log_level
);
2777 if (!getenv(ENV_BABELTRACE_CLI_LOG_LEVEL
)) {
2779 bt_cli_log_level
= BT_LOG_INFO
;
2780 } else if (cfg
->debug
) {
2781 bt_cli_log_level
= BT_LOG_VERBOSE
;
2784 * Set CLI's default log level if not explicitly
2787 bt_cli_log_level
= cfg
->log_level
;
2791 env_var_name
= log_level_env_var_names
;
2793 while (*env_var_name
) {
2794 if (!getenv(*env_var_name
)) {
2796 g_setenv(*env_var_name
, "I", 1);
2797 } else if (cfg
->debug
) {
2798 g_setenv(*env_var_name
, "V", 1);
2800 char val
[2] = { 0 };
2803 * Set module's default log level if not
2804 * explicitly specified.
2806 val
[0] = bt_log_get_letter_from_level(
2808 g_setenv(*env_var_name
, val
, 1);
2816 int main(int argc
, const char **argv
)
2820 struct bt_config
*cfg
;
2823 set_signal_handler();
2825 cfg
= bt_config_cli_args_create_with_default(argc
, argv
, &retcode
);
2828 /* Quit without errors; typically usage/version */
2830 BT_LOGI_STR("Quitting without errors.");
2835 BT_LOGE("Command-line error: retcode=%d", retcode
);
2840 BT_LOGE_STR("Failed to create a valid Babeltrace configuration.");
2841 fprintf(stderr
, "Failed to create Babeltrace configuration\n");
2846 set_auto_log_levels(cfg
);
2849 if (cfg
->command_needs_plugins
) {
2850 ret
= load_all_plugins(cfg
->plugin_paths
);
2852 BT_LOGE("Failed to load plugins: ret=%d", ret
);
2858 BT_LOGI("Executing command: cmd=%d, command-name=\"%s\"",
2859 cfg
->command
, cfg
->command_name
);
2861 switch (cfg
->command
) {
2862 case BT_CONFIG_COMMAND_RUN
:
2865 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
2866 ret
= cmd_list_plugins(cfg
);
2868 case BT_CONFIG_COMMAND_HELP
:
2869 ret
= cmd_help(cfg
);
2871 case BT_CONFIG_COMMAND_QUERY
:
2872 ret
= cmd_query(cfg
);
2874 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
2875 ret
= cmd_print_ctf_metadata(cfg
);
2877 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
2878 ret
= cmd_print_lttng_live_sessions(cfg
);
2881 BT_LOGF("Invalid/unknown command: cmd=%d", cfg
->command
);
2885 BT_LOGI("Command completed: cmd=%d, command-name=\"%s\", ret=%d",
2886 cfg
->command
, cfg
->command_name
, ret
);
2887 warn_command_name_and_directory_clash(cfg
);
2888 retcode
= ret
? 1 : 0;
2891 BT_OBJECT_PUT_REF_AND_RESET(cfg
);