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 <babeltrace/babeltrace.h>
29 #include <babeltrace/common-internal.h>
39 #include "babeltrace-cfg.h"
40 #include "babeltrace-cfg-cli-args.h"
41 #include "babeltrace-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_PLUGIN_CTF_BTR_LOG_LEVEL",
55 "BABELTRACE_SINK_CTF_FS_LOG_LEVEL",
56 "BABELTRACE_SRC_CTF_FS_LOG_LEVEL",
57 "BABELTRACE_SRC_CTF_LTTNG_LIVE_LOG_LEVEL",
58 "BABELTRACE_PLUGIN_CTF_METADATA_LOG_LEVEL",
59 "BABELTRACE_PLUGIN_CTF_NOTIF_ITER_LOG_LEVEL",
60 "BABELTRACE_PLUGIN_CTFCOPYTRACE_LIB_LOG_LEVEL",
61 "BABELTRACE_FLT_LTTNG_UTILS_DEBUG_INFO_LOG_LEVEL",
62 "BABELTRACE_SRC_TEXT_DMESG_LOG_LEVEL",
63 "BABELTRACE_SINK_TEXT_PRETTY_LOG_LEVEL",
64 "BABELTRACE_FLT_UTILS_MUXER_LOG_LEVEL",
65 "BABELTRACE_FLT_UTILS_TRIMMER_LOG_LEVEL",
66 "BABELTRACE_PYTHON_BT2_LOG_LEVEL",
67 "BABELTRACE_PYTHON_PLUGIN_PROVIDER_LOG_LEVEL",
71 /* Application's processing graph (weak) */
72 static struct bt_graph
*the_graph
;
73 static struct bt_query_executor
*the_query_executor
;
74 static bool canceled
= false;
76 GPtrArray
*loaded_plugins
;
83 BOOL WINAPI
signal_handler(DWORD signal
) {
85 bt_graph_cancel(the_graph
);
94 void set_signal_handler(void)
96 if (!SetConsoleCtrlHandler(signal_handler
, TRUE
)) {
97 BT_LOGE("Failed to set the ctrl+c handler.");
101 #else /* __MINGW32__ */
104 void signal_handler(int signum
)
106 if (signum
!= SIGINT
) {
111 bt_graph_cancel(the_graph
);
114 if (the_query_executor
) {
115 bt_query_executor_cancel(the_query_executor
);
122 void set_signal_handler(void)
124 struct sigaction new_action
, old_action
;
126 new_action
.sa_handler
= signal_handler
;
127 sigemptyset(&new_action
.sa_mask
);
128 new_action
.sa_flags
= 0;
129 sigaction(SIGINT
, NULL
, &old_action
);
131 if (old_action
.sa_handler
!= SIG_IGN
) {
132 sigaction(SIGINT
, &new_action
, NULL
);
136 #endif /* __MINGW32__ */
139 void init_static_data(void)
141 loaded_plugins
= g_ptr_array_new_with_free_func(
142 (GDestroyNotify
) bt_object_put_ref
);
146 void fini_static_data(void)
148 g_ptr_array_free(loaded_plugins
, TRUE
);
152 int create_the_query_executor(void)
156 the_query_executor
= bt_query_executor_create();
157 if (!the_query_executor
) {
158 BT_LOGE_STR("Cannot create a query executor.");
166 void destroy_the_query_executor(void)
168 BT_QUERY_EXECUTOR_PUT_REF_AND_RESET(the_query_executor
);
172 int query(const struct bt_component_class
*comp_cls
, const char *obj
,
173 const struct bt_value
*params
, const struct bt_value
**user_result
,
174 const char **fail_reason
)
176 const struct bt_value
*result
= NULL
;
177 enum bt_query_executor_status status
;
178 *fail_reason
= "unknown error";
181 BT_ASSERT(fail_reason
);
182 BT_ASSERT(user_result
);
183 ret
= create_the_query_executor();
185 /* create_the_query_executor() logs errors */
190 BT_LOGI("Canceled by user before executing the query: "
191 "comp-cls-addr=%p, comp-cls-name=\"%s\", "
192 "query-obj=\"%s\"", comp_cls
,
193 bt_component_class_get_name(comp_cls
), obj
);
194 *fail_reason
= "canceled by user";
199 status
= bt_query_executor_query(the_query_executor
,
200 comp_cls
, obj
, params
, &result
);
202 case BT_QUERY_EXECUTOR_STATUS_OK
:
204 case BT_QUERY_EXECUTOR_STATUS_AGAIN
:
206 const uint64_t sleep_time_us
= 100000;
208 /* Wait 100 ms and retry */
209 BT_LOGV("Got BT_QUERY_EXECUTOR_STATUS_AGAIN: sleeping: "
210 "time-us=%" PRIu64
, sleep_time_us
);
212 if (usleep(sleep_time_us
)) {
213 if (bt_query_executor_is_canceled(the_query_executor
)) {
214 BT_LOGI("Query was canceled by user: "
215 "comp-cls-addr=%p, comp-cls-name=\"%s\", "
216 "query-obj=\"%s\"", comp_cls
,
217 bt_component_class_get_name(comp_cls
),
219 *fail_reason
= "canceled by user";
226 case BT_QUERY_EXECUTOR_STATUS_CANCELED
:
227 *fail_reason
= "canceled by user";
229 case BT_QUERY_EXECUTOR_STATUS_ERROR
:
231 case BT_QUERY_EXECUTOR_STATUS_INVALID_OBJECT
:
232 *fail_reason
= "invalid or unknown query object";
234 case BT_QUERY_EXECUTOR_STATUS_INVALID_PARAMS
:
235 *fail_reason
= "invalid query parameters";
237 case BT_QUERY_EXECUTOR_STATUS_UNSUPPORTED
:
238 *fail_reason
= "unsupported action";
240 case BT_QUERY_EXECUTOR_STATUS_NOMEM
:
241 *fail_reason
= "not enough memory";
244 BT_LOGF("Unknown query status: status=%d", status
);
250 *user_result
= result
;
258 destroy_the_query_executor();
259 bt_value_put_ref(result
);
264 const struct bt_plugin
*find_plugin(const char *name
)
267 const struct bt_plugin
*plugin
= NULL
;
270 BT_LOGD("Finding plugin: name=\"%s\"", name
);
272 for (i
= 0; i
< loaded_plugins
->len
; i
++) {
273 plugin
= g_ptr_array_index(loaded_plugins
, i
);
275 if (strcmp(name
, bt_plugin_get_name(plugin
)) == 0) {
282 if (BT_LOG_ON_DEBUG
) {
284 BT_LOGD("Found plugin: plugin-addr=%p", plugin
);
286 BT_LOGD("Cannot find plugin.");
290 bt_plugin_get_ref(plugin
);
294 typedef const void *(*plugin_borrow_comp_cls_func_t
)(
295 const struct bt_plugin
*, const char *);
298 const void *find_component_class_from_plugin(const char *plugin_name
,
299 const char *comp_class_name
,
300 plugin_borrow_comp_cls_func_t plugin_borrow_comp_cls_func
)
302 const void *comp_class
= NULL
;
303 const struct bt_plugin
*plugin
;
305 BT_LOGD("Finding component class: plugin-name=\"%s\", "
306 "comp-cls-name=\"%s\"", plugin_name
, comp_class_name
);
308 plugin
= find_plugin(plugin_name
);
313 comp_class
= plugin_borrow_comp_cls_func(plugin
, comp_class_name
);
314 bt_object_get_ref(comp_class
);
315 BT_PLUGIN_PUT_REF_AND_RESET(plugin
);
318 if (BT_LOG_ON_DEBUG
) {
320 BT_LOGD("Found component class: comp-cls-addr=%p",
323 BT_LOGD("Cannot find source component class.");
331 const struct bt_component_class_source
*find_source_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_source_component_class_by_name_const
);
341 const struct bt_component_class_filter
*find_filter_component_class(
342 const char *plugin_name
, const char *comp_class_name
)
344 return (const void *) find_component_class_from_plugin(
345 plugin_name
, comp_class_name
,
346 (plugin_borrow_comp_cls_func_t
)
347 bt_plugin_borrow_filter_component_class_by_name_const
);
351 const struct bt_component_class_sink
*find_sink_component_class(
352 const char *plugin_name
, const char *comp_class_name
)
354 return (const void *) find_component_class_from_plugin(plugin_name
,
356 (plugin_borrow_comp_cls_func_t
)
357 bt_plugin_borrow_sink_component_class_by_name_const
);
361 const struct bt_component_class
*find_component_class(const char *plugin_name
,
362 const char *comp_class_name
,
363 enum bt_component_class_type comp_class_type
)
365 const struct bt_component_class
*comp_cls
= NULL
;
367 switch (comp_class_type
) {
368 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
369 comp_cls
= bt_component_class_source_as_component_class_const(find_source_component_class(plugin_name
, comp_class_name
));
371 case BT_COMPONENT_CLASS_TYPE_FILTER
:
372 comp_cls
= bt_component_class_filter_as_component_class_const(find_filter_component_class(plugin_name
, comp_class_name
));
374 case BT_COMPONENT_CLASS_TYPE_SINK
:
375 comp_cls
= bt_component_class_sink_as_component_class_const(find_sink_component_class(plugin_name
, comp_class_name
));
385 void print_indent(FILE *fp
, size_t indent
)
389 for (i
= 0; i
< indent
; i
++) {
395 const char *component_type_str(enum bt_component_class_type type
)
398 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
400 case BT_COMPONENT_CLASS_TYPE_SINK
:
402 case BT_COMPONENT_CLASS_TYPE_FILTER
:
410 void print_plugin_comp_cls_opt(FILE *fh
, const char *plugin_name
,
411 const char *comp_cls_name
, enum bt_component_class_type type
)
413 GString
*shell_plugin_name
= NULL
;
414 GString
*shell_comp_cls_name
= NULL
;
416 shell_plugin_name
= bt_common_shell_quote(plugin_name
, false);
417 if (!shell_plugin_name
) {
421 shell_comp_cls_name
= bt_common_shell_quote(comp_cls_name
, false);
422 if (!shell_comp_cls_name
) {
426 fprintf(fh
, "'%s%s%s%s.%s%s%s.%s%s%s'",
427 bt_common_color_bold(),
428 bt_common_color_fg_cyan(),
429 component_type_str(type
),
430 bt_common_color_fg_default(),
431 bt_common_color_fg_blue(),
432 shell_plugin_name
->str
,
433 bt_common_color_fg_default(),
434 bt_common_color_fg_yellow(),
435 shell_comp_cls_name
->str
,
436 bt_common_color_reset());
439 if (shell_plugin_name
) {
440 g_string_free(shell_plugin_name
, TRUE
);
443 if (shell_comp_cls_name
) {
444 g_string_free(shell_comp_cls_name
, TRUE
);
449 void print_value(FILE *, const struct bt_value
*, size_t);
452 void print_value_rec(FILE *, const struct bt_value
*, size_t);
454 struct print_map_value_data
{
460 bt_bool
print_map_value(const char *key
, const struct bt_value
*object
,
463 struct print_map_value_data
*print_map_value_data
= data
;
465 print_indent(print_map_value_data
->fp
, print_map_value_data
->indent
);
466 fprintf(print_map_value_data
->fp
, "%s: ", key
);
469 if (bt_value_is_array(object
) &&
470 bt_value_array_is_empty(object
)) {
471 fprintf(print_map_value_data
->fp
, "[ ]\n");
475 if (bt_value_is_map(object
) &&
476 bt_value_map_is_empty(object
)) {
477 fprintf(print_map_value_data
->fp
, "{ }\n");
481 if (bt_value_is_array(object
) ||
482 bt_value_is_map(object
)) {
483 fprintf(print_map_value_data
->fp
, "\n");
486 print_value_rec(print_map_value_data
->fp
, object
,
487 print_map_value_data
->indent
+ 2);
492 void print_value_rec(FILE *fp
, const struct bt_value
*value
, size_t indent
)
505 switch (bt_value_get_type(value
)) {
506 case BT_VALUE_TYPE_NULL
:
507 fprintf(fp
, "%snull%s\n", bt_common_color_bold(),
508 bt_common_color_reset());
510 case BT_VALUE_TYPE_BOOL
:
511 bool_val
= bt_value_bool_get(value
);
512 fprintf(fp
, "%s%s%s%s\n", bt_common_color_bold(),
513 bt_common_color_fg_cyan(), bool_val
? "yes" : "no",
514 bt_common_color_reset());
516 case BT_VALUE_TYPE_INTEGER
:
517 int_val
= bt_value_integer_get(value
);
518 fprintf(fp
, "%s%s%" PRId64
"%s\n", bt_common_color_bold(),
519 bt_common_color_fg_red(), int_val
,
520 bt_common_color_reset());
522 case BT_VALUE_TYPE_REAL
:
523 dbl_val
= bt_value_real_get(value
);
524 fprintf(fp
, "%s%s%lf%s\n", bt_common_color_bold(),
525 bt_common_color_fg_red(), dbl_val
,
526 bt_common_color_reset());
528 case BT_VALUE_TYPE_STRING
:
529 str_val
= bt_value_string_get(value
);
530 fprintf(fp
, "%s%s%s%s\n", bt_common_color_bold(),
531 bt_common_color_fg_green(), str_val
,
532 bt_common_color_reset());
534 case BT_VALUE_TYPE_ARRAY
:
535 size
= bt_value_array_get_size(value
);
541 print_indent(fp
, indent
);
542 fprintf(fp
, "[ ]\n");
546 for (i
= 0; i
< size
; i
++) {
547 const struct bt_value
*element
=
548 bt_value_array_borrow_element_by_index_const(
554 print_indent(fp
, indent
);
557 if (bt_value_is_array(element
) &&
558 bt_value_array_is_empty(element
)) {
559 fprintf(fp
, "[ ]\n");
563 if (bt_value_is_map(element
) &&
564 bt_value_map_is_empty(element
)) {
565 fprintf(fp
, "{ }\n");
569 if (bt_value_is_array(element
) ||
570 bt_value_is_map(element
)) {
574 print_value_rec(fp
, element
, indent
+ 2);
577 case BT_VALUE_TYPE_MAP
:
579 struct print_map_value_data data
= {
584 if (bt_value_map_is_empty(value
)) {
585 print_indent(fp
, indent
);
586 fprintf(fp
, "{ }\n");
590 bt_value_map_foreach_entry_const(value
, print_map_value
, &data
);
599 BT_LOGE("Error printing value of type %s.",
600 bt_common_value_type_string(bt_value_get_type(value
)));
604 void print_value(FILE *fp
, const struct bt_value
*value
, size_t indent
)
606 if (!bt_value_is_array(value
) && !bt_value_is_map(value
)) {
607 print_indent(fp
, indent
);
610 print_value_rec(fp
, value
, indent
);
614 void print_bt_config_component(struct bt_config_component
*bt_config_component
)
616 fprintf(stderr
, " ");
617 print_plugin_comp_cls_opt(stderr
, bt_config_component
->plugin_name
->str
,
618 bt_config_component
->comp_cls_name
->str
,
619 bt_config_component
->type
);
620 fprintf(stderr
, ":\n");
622 if (bt_config_component
->instance_name
->len
> 0) {
623 fprintf(stderr
, " Name: %s\n",
624 bt_config_component
->instance_name
->str
);
627 fprintf(stderr
, " Parameters:\n");
628 print_value(stderr
, bt_config_component
->params
, 8);
632 void print_bt_config_components(GPtrArray
*array
)
636 for (i
= 0; i
< array
->len
; i
++) {
637 struct bt_config_component
*cfg_component
=
638 bt_config_get_component(array
, i
);
639 print_bt_config_component(cfg_component
);
640 BT_OBJECT_PUT_REF_AND_RESET(cfg_component
);
645 void print_plugin_paths(const struct bt_value
*plugin_paths
)
647 fprintf(stderr
, " Plugin paths:\n");
648 print_value(stderr
, plugin_paths
, 4);
652 void print_cfg_run(struct bt_config
*cfg
)
656 print_plugin_paths(cfg
->plugin_paths
);
657 fprintf(stderr
, " Source component instances:\n");
658 print_bt_config_components(cfg
->cmd_data
.run
.sources
);
660 if (cfg
->cmd_data
.run
.filters
->len
> 0) {
661 fprintf(stderr
, " Filter component instances:\n");
662 print_bt_config_components(cfg
->cmd_data
.run
.filters
);
665 fprintf(stderr
, " Sink component instances:\n");
666 print_bt_config_components(cfg
->cmd_data
.run
.sinks
);
667 fprintf(stderr
, " Connections:\n");
669 for (i
= 0; i
< cfg
->cmd_data
.run
.connections
->len
; i
++) {
670 struct bt_config_connection
*cfg_connection
=
671 g_ptr_array_index(cfg
->cmd_data
.run
.connections
,
674 fprintf(stderr
, " %s%s%s -> %s%s%s\n",
675 cfg_connection
->upstream_comp_name
->str
,
676 cfg_connection
->upstream_port_glob
->len
> 0 ? "." : "",
677 cfg_connection
->upstream_port_glob
->str
,
678 cfg_connection
->downstream_comp_name
->str
,
679 cfg_connection
->downstream_port_glob
->len
> 0 ? "." : "",
680 cfg_connection
->downstream_port_glob
->str
);
685 void print_cfg_list_plugins(struct bt_config
*cfg
)
687 print_plugin_paths(cfg
->plugin_paths
);
691 void print_cfg_help(struct bt_config
*cfg
)
693 print_plugin_paths(cfg
->plugin_paths
);
697 void print_cfg_print_ctf_metadata(struct bt_config
*cfg
)
699 print_plugin_paths(cfg
->plugin_paths
);
700 fprintf(stderr
, " Path: %s\n",
701 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
705 void print_cfg_print_lttng_live_sessions(struct bt_config
*cfg
)
707 print_plugin_paths(cfg
->plugin_paths
);
708 fprintf(stderr
, " URL: %s\n",
709 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
713 void print_cfg_query(struct bt_config
*cfg
)
715 print_plugin_paths(cfg
->plugin_paths
);
716 fprintf(stderr
, " Object: `%s`\n", cfg
->cmd_data
.query
.object
->str
);
717 fprintf(stderr
, " Component class:\n");
718 print_bt_config_component(cfg
->cmd_data
.query
.cfg_component
);
722 void print_cfg(struct bt_config
*cfg
)
724 if (!BT_LOG_ON_INFO
) {
728 BT_LOGI_STR("Configuration:");
729 fprintf(stderr
, " Debug mode: %s\n", cfg
->debug
? "yes" : "no");
730 fprintf(stderr
, " Verbose mode: %s\n", cfg
->verbose
? "yes" : "no");
732 switch (cfg
->command
) {
733 case BT_CONFIG_COMMAND_RUN
:
736 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
737 print_cfg_list_plugins(cfg
);
739 case BT_CONFIG_COMMAND_HELP
:
742 case BT_CONFIG_COMMAND_QUERY
:
743 print_cfg_query(cfg
);
745 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
746 print_cfg_print_ctf_metadata(cfg
);
748 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
749 print_cfg_print_lttng_live_sessions(cfg
);
757 void add_to_loaded_plugins(const struct bt_plugin_set
*plugin_set
)
762 count
= bt_plugin_set_get_plugin_count(plugin_set
);
763 BT_ASSERT(count
>= 0);
765 for (i
= 0; i
< count
; i
++) {
766 const struct bt_plugin
*plugin
=
767 bt_plugin_set_borrow_plugin_by_index_const(plugin_set
, i
);
768 const struct bt_plugin
*loaded_plugin
=
769 find_plugin(bt_plugin_get_name(plugin
));
774 BT_LOGI("Not using plugin: another one already exists with the same name: "
775 "plugin-name=\"%s\", plugin-path=\"%s\", "
776 "existing-plugin-path=\"%s\"",
777 bt_plugin_get_name(plugin
),
778 bt_plugin_get_path(plugin
),
779 bt_plugin_get_path(loaded_plugin
));
780 bt_plugin_put_ref(loaded_plugin
);
782 /* Add to global array. */
783 BT_LOGD("Adding plugin to loaded plugins: plugin-path=\"%s\"",
784 bt_plugin_get_name(plugin
));
785 bt_plugin_get_ref(plugin
);
786 g_ptr_array_add(loaded_plugins
, (void *) plugin
);
792 int load_dynamic_plugins(const struct bt_value
*plugin_paths
)
794 int nr_paths
, i
, ret
= 0;
796 nr_paths
= bt_value_array_get_size(plugin_paths
);
798 BT_LOGE_STR("Cannot load dynamic plugins: no plugin path.");
803 BT_LOGI("Loading dynamic plugins.");
805 for (i
= 0; i
< nr_paths
; i
++) {
806 const struct bt_value
*plugin_path_value
= NULL
;
807 const char *plugin_path
;
808 const struct bt_plugin_set
*plugin_set
;
811 bt_value_array_borrow_element_by_index_const(
813 plugin_path
= bt_value_string_get(plugin_path_value
);
816 * Skip this if the directory does not exist because
817 * bt_plugin_create_all_from_dir() expects an existing
820 if (!g_file_test(plugin_path
, G_FILE_TEST_IS_DIR
)) {
821 BT_LOGV("Skipping nonexistent directory path: "
822 "path=\"%s\"", plugin_path
);
826 plugin_set
= bt_plugin_create_all_from_dir(plugin_path
, false);
828 BT_LOGD("Unable to load dynamic plugins: path=\"%s\"",
833 add_to_loaded_plugins(plugin_set
);
834 bt_plugin_set_put_ref(plugin_set
);
841 int load_static_plugins(void)
844 const struct bt_plugin_set
*plugin_set
;
846 BT_LOGI("Loading static plugins.");
847 plugin_set
= bt_plugin_create_all_from_static();
849 BT_LOGE("Unable to load static plugins.");
854 add_to_loaded_plugins(plugin_set
);
855 bt_plugin_set_put_ref(plugin_set
);
861 int load_all_plugins(const struct bt_value
*plugin_paths
)
865 if (load_dynamic_plugins(plugin_paths
)) {
870 if (load_static_plugins()) {
875 BT_LOGI("Loaded all plugins: count=%u", loaded_plugins
->len
);
882 void print_plugin_info(const struct bt_plugin
*plugin
)
884 unsigned int major
, minor
, patch
;
886 enum bt_plugin_status version_status
;
887 const char *plugin_name
;
891 const char *plugin_description
;
893 plugin_name
= bt_plugin_get_name(plugin
);
894 path
= bt_plugin_get_path(plugin
);
895 author
= bt_plugin_get_author(plugin
);
896 license
= bt_plugin_get_license(plugin
);
897 plugin_description
= bt_plugin_get_description(plugin
);
898 version_status
= bt_plugin_get_version(plugin
, &major
, &minor
,
900 printf("%s%s%s%s:\n", bt_common_color_bold(),
901 bt_common_color_fg_blue(), plugin_name
,
902 bt_common_color_reset());
904 printf(" %sPath%s: %s\n", bt_common_color_bold(),
905 bt_common_color_reset(), path
);
910 if (version_status
== BT_PLUGIN_STATUS_OK
) {
911 printf(" %sVersion%s: %u.%u.%u",
912 bt_common_color_bold(), bt_common_color_reset(),
913 major
, minor
, patch
);
922 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
923 bt_common_color_reset(),
924 plugin_description
? plugin_description
: "(None)");
925 printf(" %sAuthor%s: %s\n", bt_common_color_bold(),
926 bt_common_color_reset(), author
? author
: "(Unknown)");
927 printf(" %sLicense%s: %s\n", bt_common_color_bold(),
928 bt_common_color_reset(),
929 license
? license
: "(Unknown)");
933 int cmd_query(struct bt_config
*cfg
)
936 const struct bt_component_class
*comp_cls
= NULL
;
937 const struct bt_value
*results
= NULL
;
938 const char *fail_reason
= NULL
;
940 comp_cls
= find_component_class(
941 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
942 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
943 cfg
->cmd_data
.query
.cfg_component
->type
);
945 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
946 "comp-cls-name=\"%s\", comp-cls-type=%d",
947 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
948 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
949 cfg
->cmd_data
.query
.cfg_component
->type
);
950 fprintf(stderr
, "%s%sCannot find component class %s",
951 bt_common_color_bold(),
952 bt_common_color_fg_red(),
953 bt_common_color_reset());
954 print_plugin_comp_cls_opt(stderr
,
955 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
956 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
957 cfg
->cmd_data
.query
.cfg_component
->type
);
958 fprintf(stderr
, "\n");
963 ret
= query(comp_cls
, cfg
->cmd_data
.query
.object
->str
,
964 cfg
->cmd_data
.query
.cfg_component
->params
,
965 &results
, &fail_reason
);
970 print_value(stdout
, results
, 0);
974 BT_LOGE("Failed to query component class: %s: plugin-name=\"%s\", "
975 "comp-cls-name=\"%s\", comp-cls-type=%d "
976 "object=\"%s\"", fail_reason
,
977 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
978 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
979 cfg
->cmd_data
.query
.cfg_component
->type
,
980 cfg
->cmd_data
.query
.object
->str
);
981 fprintf(stderr
, "%s%sFailed to query info to %s",
982 bt_common_color_bold(),
983 bt_common_color_fg_red(),
984 bt_common_color_reset());
985 print_plugin_comp_cls_opt(stderr
,
986 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
987 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
988 cfg
->cmd_data
.query
.cfg_component
->type
);
989 fprintf(stderr
, "%s%s with object `%s`: %s%s\n",
990 bt_common_color_bold(),
991 bt_common_color_fg_red(),
992 cfg
->cmd_data
.query
.object
->str
,
994 bt_common_color_reset());
998 bt_component_class_put_ref(comp_cls
);
999 bt_value_put_ref(results
);
1004 void print_component_class_help(const char *plugin_name
,
1005 const struct bt_component_class
*comp_cls
)
1007 const char *comp_class_name
=
1008 bt_component_class_get_name(comp_cls
);
1009 const char *comp_class_description
=
1010 bt_component_class_get_description(comp_cls
);
1011 const char *comp_class_help
=
1012 bt_component_class_get_help(comp_cls
);
1013 enum bt_component_class_type type
=
1014 bt_component_class_get_type(comp_cls
);
1016 print_plugin_comp_cls_opt(stdout
, plugin_name
, comp_class_name
, type
);
1018 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
1019 bt_common_color_reset(),
1020 comp_class_description
? comp_class_description
: "(None)");
1022 if (comp_class_help
) {
1023 printf("\n%s\n", comp_class_help
);
1028 int cmd_help(struct bt_config
*cfg
)
1031 const struct bt_plugin
*plugin
= NULL
;
1032 const struct bt_component_class
*needed_comp_cls
= NULL
;
1034 plugin
= find_plugin(cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
1036 BT_LOGE("Cannot find plugin: plugin-name=\"%s\"",
1037 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
1038 fprintf(stderr
, "%s%sCannot find plugin %s%s%s\n",
1039 bt_common_color_bold(), bt_common_color_fg_red(),
1040 bt_common_color_fg_blue(),
1041 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1042 bt_common_color_reset());
1047 print_plugin_info(plugin
);
1048 printf(" %sSource component classes%s: %d\n",
1049 bt_common_color_bold(),
1050 bt_common_color_reset(),
1051 (int) bt_plugin_get_source_component_class_count(plugin
));
1052 printf(" %sFilter component classes%s: %d\n",
1053 bt_common_color_bold(),
1054 bt_common_color_reset(),
1055 (int) bt_plugin_get_filter_component_class_count(plugin
));
1056 printf(" %sSink component classes%s: %d\n",
1057 bt_common_color_bold(),
1058 bt_common_color_reset(),
1059 (int) bt_plugin_get_sink_component_class_count(plugin
));
1061 if (strlen(cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
) == 0) {
1062 /* Plugin help only */
1066 needed_comp_cls
= find_component_class(
1067 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1068 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
1069 cfg
->cmd_data
.help
.cfg_component
->type
);
1070 if (!needed_comp_cls
) {
1071 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
1072 "comp-cls-name=\"%s\", comp-cls-type=%d",
1073 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1074 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
1075 cfg
->cmd_data
.help
.cfg_component
->type
);
1076 fprintf(stderr
, "\n%s%sCannot find component class %s",
1077 bt_common_color_bold(),
1078 bt_common_color_fg_red(),
1079 bt_common_color_reset());
1080 print_plugin_comp_cls_opt(stderr
,
1081 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1082 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
1083 cfg
->cmd_data
.help
.cfg_component
->type
);
1084 fprintf(stderr
, "\n");
1090 print_component_class_help(
1091 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1095 bt_component_class_put_ref(needed_comp_cls
);
1096 bt_plugin_put_ref(plugin
);
1100 typedef void *(* plugin_borrow_comp_cls_by_index_func_t
)(const struct bt_plugin
*,
1102 typedef const struct bt_component_class
*(* spec_comp_cls_borrow_comp_cls_func_t
)(
1105 void cmd_list_plugins_print_component_classes(const struct bt_plugin
*plugin
,
1106 const char *cc_type_name
, uint64_t count
,
1107 plugin_borrow_comp_cls_by_index_func_t borrow_comp_cls_by_index_func
,
1108 spec_comp_cls_borrow_comp_cls_func_t spec_comp_cls_borrow_comp_cls_func
)
1113 printf(" %s%s component classes%s: (none)\n", cc_type_name
,
1114 bt_common_color_bold(),
1115 bt_common_color_reset());
1118 printf(" %s%s component classes%s:\n", cc_type_name
,
1119 bt_common_color_bold(),
1120 bt_common_color_reset());
1123 for (i
= 0; i
< count
; i
++) {
1124 const struct bt_component_class
*comp_class
=
1125 spec_comp_cls_borrow_comp_cls_func(
1126 borrow_comp_cls_by_index_func(plugin
, i
));
1127 const char *comp_class_name
=
1128 bt_component_class_get_name(comp_class
);
1129 const char *comp_class_description
=
1130 bt_component_class_get_description(comp_class
);
1131 enum bt_component_class_type type
=
1132 bt_component_class_get_type(comp_class
);
1135 print_plugin_comp_cls_opt(stdout
,
1136 bt_plugin_get_name(plugin
), comp_class_name
,
1139 if (comp_class_description
) {
1140 printf(": %s", comp_class_description
);
1151 int cmd_list_plugins(struct bt_config
*cfg
)
1154 int plugins_count
, component_classes_count
= 0, i
;
1156 printf("From the following plugin paths:\n\n");
1157 print_value(stdout
, cfg
->plugin_paths
, 2);
1159 plugins_count
= loaded_plugins
->len
;
1160 if (plugins_count
== 0) {
1161 printf("No plugins found.\n");
1165 for (i
= 0; i
< plugins_count
; i
++) {
1166 const struct bt_plugin
*plugin
= g_ptr_array_index(loaded_plugins
, i
);
1168 component_classes_count
+=
1169 bt_plugin_get_source_component_class_count(plugin
) +
1170 bt_plugin_get_filter_component_class_count(plugin
) +
1171 bt_plugin_get_sink_component_class_count(plugin
);
1174 printf("Found %s%d%s component classes in %s%d%s plugins.\n",
1175 bt_common_color_bold(),
1176 component_classes_count
,
1177 bt_common_color_reset(),
1178 bt_common_color_bold(),
1180 bt_common_color_reset());
1182 for (i
= 0; i
< plugins_count
; i
++) {
1183 const struct bt_plugin
*plugin
= g_ptr_array_index(loaded_plugins
, i
);
1186 print_plugin_info(plugin
);
1187 cmd_list_plugins_print_component_classes(plugin
, "Source",
1188 bt_plugin_get_source_component_class_count(plugin
),
1189 (plugin_borrow_comp_cls_by_index_func_t
)
1190 bt_plugin_borrow_source_component_class_by_name_const
,
1191 (spec_comp_cls_borrow_comp_cls_func_t
)
1192 bt_component_class_source_as_component_class
);
1193 cmd_list_plugins_print_component_classes(plugin
, "Filter",
1194 bt_plugin_get_filter_component_class_count(plugin
),
1195 (plugin_borrow_comp_cls_by_index_func_t
)
1196 bt_plugin_borrow_filter_component_class_by_name_const
,
1197 (spec_comp_cls_borrow_comp_cls_func_t
)
1198 bt_component_class_filter_as_component_class
);
1199 cmd_list_plugins_print_component_classes(plugin
, "Sink",
1200 bt_plugin_get_sink_component_class_count(plugin
),
1201 (plugin_borrow_comp_cls_by_index_func_t
)
1202 bt_plugin_borrow_sink_component_class_by_name_const
,
1203 (spec_comp_cls_borrow_comp_cls_func_t
)
1204 bt_component_class_sink_as_component_class
);
1212 int cmd_print_lttng_live_sessions(struct bt_config
*cfg
)
1215 const struct bt_component_class
*comp_cls
= NULL
;
1216 const struct bt_value
*results
= NULL
;
1217 struct bt_value
*params
= NULL
;
1218 const struct bt_value
*map
= NULL
;
1219 const struct bt_value
*v
= NULL
;
1220 static const char * const plugin_name
= "ctf";
1221 static const char * const comp_cls_name
= "lttng-live";
1222 static const enum bt_component_class_type comp_cls_type
=
1223 BT_COMPONENT_CLASS_TYPE_SOURCE
;
1224 int64_t array_size
, i
;
1225 const char *fail_reason
= NULL
;
1226 FILE *out_stream
= stdout
;
1228 BT_ASSERT(cfg
->cmd_data
.print_lttng_live_sessions
.url
);
1229 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1232 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
1233 "comp-cls-name=\"%s\", comp-cls-type=%d",
1234 plugin_name
, comp_cls_name
,
1235 BT_COMPONENT_CLASS_TYPE_SOURCE
);
1236 fprintf(stderr
, "%s%sCannot find component class %s",
1237 bt_common_color_bold(),
1238 bt_common_color_fg_red(),
1239 bt_common_color_reset());
1240 print_plugin_comp_cls_opt(stderr
, plugin_name
,
1241 comp_cls_name
, comp_cls_type
);
1242 fprintf(stderr
, "\n");
1246 params
= bt_value_map_create();
1251 ret
= bt_value_map_insert_string_entry(params
, "url",
1252 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
1257 ret
= query(comp_cls
, "sessions", params
,
1258 &results
, &fail_reason
);
1265 if (!bt_value_is_array(results
)) {
1266 BT_LOGE_STR("Expecting an array for sessions query.");
1267 fprintf(stderr
, "%s%sUnexpected type returned by session query%s\n",
1268 bt_common_color_bold(),
1269 bt_common_color_fg_red(),
1270 bt_common_color_reset());
1274 if (cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->len
> 0) {
1276 fopen(cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
,
1280 BT_LOGE_ERRNO("Cannot open file for writing",
1282 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
1287 array_size
= bt_value_array_get_size(results
);
1288 for (i
= 0; i
< array_size
; i
++) {
1289 const char *url_text
;
1290 int64_t timer_us
, streams
, clients
;
1292 map
= bt_value_array_borrow_element_by_index_const(results
, i
);
1294 BT_LOGE_STR("Unexpected empty array entry.");
1297 if (!bt_value_is_map(map
)) {
1298 BT_LOGE_STR("Unexpected entry type.");
1302 v
= bt_value_map_borrow_entry_value_const(map
, "url");
1304 BT_LOGE_STR("Unexpected empty array \"url\" entry.");
1307 url_text
= bt_value_string_get(v
);
1308 fprintf(out_stream
, "%s", url_text
);
1309 v
= bt_value_map_borrow_entry_value_const(map
, "timer-us");
1311 BT_LOGE_STR("Unexpected empty array \"timer-us\" entry.");
1314 timer_us
= bt_value_integer_get(v
);
1315 fprintf(out_stream
, " (timer = %" PRIu64
", ", timer_us
);
1316 v
= bt_value_map_borrow_entry_value_const(map
, "stream-count");
1318 BT_LOGE_STR("Unexpected empty array \"stream-count\" entry.");
1321 streams
= bt_value_integer_get(v
);
1322 fprintf(out_stream
, "%" PRIu64
" stream(s), ", streams
);
1323 v
= bt_value_map_borrow_entry_value_const(map
, "client-count");
1325 BT_LOGE_STR("Unexpected empty array \"client-count\" entry.");
1328 clients
= bt_value_integer_get(v
);
1329 fprintf(out_stream
, "%" PRIu64
" client(s) connected)\n", clients
);
1335 BT_LOGE("Failed to query for sessions: %s", fail_reason
);
1336 fprintf(stderr
, "%s%sFailed to request sessions: %s%s\n",
1337 bt_common_color_bold(),
1338 bt_common_color_fg_red(),
1340 bt_common_color_reset());
1346 bt_value_put_ref(results
);
1347 bt_value_put_ref(params
);
1348 bt_component_class_put_ref(comp_cls
);
1350 if (out_stream
&& out_stream
!= stdout
) {
1351 int fclose_ret
= fclose(out_stream
);
1354 BT_LOGE_ERRNO("Cannot close file stream",
1356 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
1364 int cmd_print_ctf_metadata(struct bt_config
*cfg
)
1367 const struct bt_component_class
*comp_cls
= NULL
;
1368 const struct bt_value
*results
= NULL
;
1369 struct bt_value
*params
= NULL
;
1370 const struct bt_value
*metadata_text_value
= NULL
;
1371 const char *metadata_text
= NULL
;
1372 static const char * const plugin_name
= "ctf";
1373 static const char * const comp_cls_name
= "fs";
1374 static const enum bt_component_class_type comp_cls_type
=
1375 BT_COMPONENT_CLASS_TYPE_SOURCE
;
1376 const char *fail_reason
= NULL
;
1377 FILE *out_stream
= stdout
;
1379 BT_ASSERT(cfg
->cmd_data
.print_ctf_metadata
.path
);
1380 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1383 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
1384 "comp-cls-name=\"%s\", comp-cls-type=%d",
1385 plugin_name
, comp_cls_name
,
1386 BT_COMPONENT_CLASS_TYPE_SOURCE
);
1387 fprintf(stderr
, "%s%sCannot find component class %s",
1388 bt_common_color_bold(),
1389 bt_common_color_fg_red(),
1390 bt_common_color_reset());
1391 print_plugin_comp_cls_opt(stderr
, plugin_name
,
1392 comp_cls_name
, comp_cls_type
);
1393 fprintf(stderr
, "\n");
1398 params
= bt_value_map_create();
1404 ret
= bt_value_map_insert_string_entry(params
, "path",
1405 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
1411 ret
= query(comp_cls
, "metadata-info",
1412 params
, &results
, &fail_reason
);
1417 metadata_text_value
= bt_value_map_borrow_entry_value_const(results
,
1419 if (!metadata_text_value
) {
1420 BT_LOGE_STR("Cannot find `text` string value in the resulting metadata info object.");
1425 metadata_text
= bt_value_string_get(metadata_text_value
);
1427 if (cfg
->cmd_data
.print_ctf_metadata
.output_path
->len
> 0) {
1429 fopen(cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
,
1433 BT_LOGE_ERRNO("Cannot open file for writing",
1435 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1440 ret
= fprintf(out_stream
, "%s\n", metadata_text
);
1442 BT_LOGE("Cannot write whole metadata text to output stream: "
1450 BT_LOGE("Failed to query for metadata info: %s", fail_reason
);
1451 fprintf(stderr
, "%s%sFailed to request metadata info: %s%s\n",
1452 bt_common_color_bold(),
1453 bt_common_color_fg_red(),
1455 bt_common_color_reset());
1458 bt_value_put_ref(results
);
1459 bt_value_put_ref(params
);
1460 bt_component_class_put_ref(comp_cls
);
1462 if (out_stream
&& out_stream
!= stdout
) {
1463 int fclose_ret
= fclose(out_stream
);
1466 BT_LOGE_ERRNO("Cannot close file stream",
1468 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1476 char *instance_name
;
1480 struct trace_range
{
1481 uint64_t intersection_range_begin_ns
;
1482 uint64_t intersection_range_end_ns
;
1486 guint
port_id_hash(gconstpointer v
)
1488 const struct port_id
*id
= v
;
1490 BT_ASSERT(id
->instance_name
);
1491 BT_ASSERT(id
->port_name
);
1493 return g_str_hash(id
->instance_name
) ^ g_str_hash(id
->port_name
);
1497 gboolean
port_id_equal(gconstpointer v1
, gconstpointer v2
)
1499 const struct port_id
*id1
= v1
;
1500 const struct port_id
*id2
= v2
;
1502 return !strcmp(id1
->instance_name
, id2
->instance_name
) &&
1503 !strcmp(id1
->port_name
, id2
->port_name
);
1507 void port_id_destroy(gpointer data
)
1509 struct port_id
*id
= data
;
1511 free(id
->instance_name
);
1512 free(id
->port_name
);
1517 void trace_range_destroy(gpointer data
)
1522 struct cmd_run_ctx
{
1524 GHashTable
*src_components
;
1527 GHashTable
*flt_components
;
1530 GHashTable
*sink_components
;
1533 struct bt_graph
*graph
;
1536 struct bt_config
*cfg
;
1540 bool stream_intersection_mode
;
1543 * Association of struct port_id -> struct trace_range.
1545 GHashTable
*intersections
;
1548 /* Returns a timestamp of the form "(-)s.ns" */
1550 char *s_from_ns(int64_t ns
)
1555 int64_t ts_sec_abs
, ts_nsec_abs
;
1556 int64_t ts_sec
= ns
/ NSEC_PER_SEC
;
1557 int64_t ts_nsec
= ns
% NSEC_PER_SEC
;
1559 if (ts_sec
>= 0 && ts_nsec
>= 0) {
1560 is_negative
= false;
1561 ts_sec_abs
= ts_sec
;
1562 ts_nsec_abs
= ts_nsec
;
1563 } else if (ts_sec
> 0 && ts_nsec
< 0) {
1564 is_negative
= false;
1565 ts_sec_abs
= ts_sec
- 1;
1566 ts_nsec_abs
= NSEC_PER_SEC
+ ts_nsec
;
1567 } else if (ts_sec
== 0 && ts_nsec
< 0) {
1569 ts_sec_abs
= ts_sec
;
1570 ts_nsec_abs
= -ts_nsec
;
1571 } else if (ts_sec
< 0 && ts_nsec
> 0) {
1573 ts_sec_abs
= -(ts_sec
+ 1);
1574 ts_nsec_abs
= NSEC_PER_SEC
- ts_nsec
;
1575 } else if (ts_sec
< 0 && ts_nsec
== 0) {
1577 ts_sec_abs
= -ts_sec
;
1578 ts_nsec_abs
= ts_nsec
;
1579 } else { /* (ts_sec < 0 && ts_nsec < 0) */
1581 ts_sec_abs
= -ts_sec
;
1582 ts_nsec_abs
= -ts_nsec
;
1585 ret
= asprintf(&s_ret
, "%s%" PRId64
".%09" PRId64
,
1586 is_negative
? "-" : "", ts_sec_abs
, ts_nsec_abs
);
1594 int cmd_run_ctx_connect_upstream_port_to_downstream_component(
1595 struct cmd_run_ctx
*ctx
,
1596 const struct bt_component
*upstream_comp
,
1597 const struct bt_port_output
*out_upstream_port
,
1598 struct bt_config_connection
*cfg_conn
)
1600 typedef uint64_t (*input_port_count_func_t
)(void *);
1601 typedef const struct bt_port_input
*(*borrow_input_port_by_index_func_t
)(
1602 const void *, uint64_t);
1603 const struct bt_port
*upstream_port
=
1604 bt_port_output_as_port_const(out_upstream_port
);
1607 GQuark downstreamp_comp_name_quark
;
1608 void *downstream_comp
;
1609 uint64_t downstream_port_count
;
1611 input_port_count_func_t port_count_fn
;
1612 borrow_input_port_by_index_func_t port_by_index_fn
;
1613 enum bt_graph_status status
= BT_GRAPH_STATUS_ERROR
;
1614 bool insert_trimmer
= false;
1615 struct bt_value
*trimmer_params
= NULL
;
1616 char *intersection_begin
= NULL
;
1617 char *intersection_end
= NULL
;
1618 const struct bt_component_filter
*trimmer
= NULL
;
1619 const struct bt_component_class_filter
*trimmer_class
= NULL
;
1620 const struct bt_port_input
*trimmer_input
= NULL
;
1621 const struct bt_port_output
*trimmer_output
= NULL
;
1623 if (ctx
->intersections
&&
1624 bt_component_get_class_type(upstream_comp
) ==
1625 BT_COMPONENT_CLASS_TYPE_SOURCE
) {
1626 struct trace_range
*range
;
1627 struct port_id port_id
= {
1628 .instance_name
= (char *) bt_component_get_name(upstream_comp
),
1629 .port_name
= (char *) bt_port_get_name(upstream_port
)
1632 if (!port_id
.instance_name
|| !port_id
.port_name
) {
1636 range
= (struct trace_range
*) g_hash_table_lookup(
1637 ctx
->intersections
, &port_id
);
1639 enum bt_value_status status
;
1641 intersection_begin
= s_from_ns(
1642 range
->intersection_range_begin_ns
);
1643 intersection_end
= s_from_ns(
1644 range
->intersection_range_end_ns
);
1645 if (!intersection_begin
|| !intersection_end
) {
1646 BT_LOGE_STR("Cannot create trimmer argument timestamp string.");
1650 insert_trimmer
= true;
1651 trimmer_params
= bt_value_map_create();
1652 if (!trimmer_params
) {
1656 status
= bt_value_map_insert_string_entry(
1657 trimmer_params
, "begin", intersection_begin
);
1658 if (status
!= BT_VALUE_STATUS_OK
) {
1661 status
= bt_value_map_insert_string_entry(
1663 "end", intersection_end
);
1664 if (status
!= BT_VALUE_STATUS_OK
) {
1669 trimmer_class
= find_filter_component_class("utils", "trimmer");
1670 if (!trimmer_class
) {
1675 BT_LOGI("Connecting upstream port to the next available downstream port: "
1676 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1677 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1678 upstream_port
, bt_port_get_name(upstream_port
),
1679 cfg_conn
->downstream_comp_name
->str
,
1680 cfg_conn
->arg
->str
);
1681 downstreamp_comp_name_quark
= g_quark_from_string(
1682 cfg_conn
->downstream_comp_name
->str
);
1683 BT_ASSERT(downstreamp_comp_name_quark
> 0);
1684 downstream_comp
= g_hash_table_lookup(ctx
->flt_components
,
1685 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1686 port_count_fn
= (input_port_count_func_t
)
1687 bt_component_filter_get_input_port_count
;
1688 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1689 bt_component_filter_borrow_input_port_by_index_const
;
1691 if (!downstream_comp
) {
1692 downstream_comp
= g_hash_table_lookup(ctx
->sink_components
,
1693 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1694 port_count_fn
= (input_port_count_func_t
)
1695 bt_component_sink_get_input_port_count
;
1696 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1697 bt_component_sink_borrow_input_port_by_index_const
;
1700 if (!downstream_comp
) {
1701 BT_LOGE("Cannot find downstream component: comp-name=\"%s\", "
1702 "conn-arg=\"%s\"", cfg_conn
->downstream_comp_name
->str
,
1703 cfg_conn
->arg
->str
);
1704 fprintf(stderr
, "Cannot create connection: cannot find downstream component: %s\n",
1705 cfg_conn
->arg
->str
);
1709 downstream_port_count
= port_count_fn(downstream_comp
);
1710 BT_ASSERT(downstream_port_count
>= 0);
1712 for (i
= 0; i
< downstream_port_count
; i
++) {
1713 const struct bt_port_input
*in_downstream_port
=
1714 port_by_index_fn(downstream_comp
, i
);
1715 const struct bt_port
*downstream_port
=
1716 bt_port_input_as_port_const(in_downstream_port
);
1717 const char *upstream_port_name
;
1718 const char *downstream_port_name
;
1720 BT_ASSERT(downstream_port
);
1722 /* Skip port if it's already connected. */
1723 if (bt_port_is_connected(downstream_port
)) {
1724 BT_LOGD("Skipping downstream port: already connected: "
1725 "port-addr=%p, port-name=\"%s\"",
1727 bt_port_get_name(downstream_port
));
1731 downstream_port_name
= bt_port_get_name(downstream_port
);
1732 BT_ASSERT(downstream_port_name
);
1733 upstream_port_name
= bt_port_get_name(upstream_port
);
1734 BT_ASSERT(upstream_port_name
);
1736 if (!bt_common_star_glob_match(
1737 cfg_conn
->downstream_port_glob
->str
, SIZE_MAX
,
1738 downstream_port_name
, SIZE_MAX
)) {
1742 if (insert_trimmer
) {
1744 * In order to insert the trimmer between the
1745 * two components that were being connected, we
1746 * create a connection configuration entry which
1747 * describes a connection from the trimmer's
1748 * output to the original input that was being
1751 * Hence, the creation of the trimmer will cause
1752 * the graph "new port" listener to establish
1753 * all downstream connections as its output port
1754 * is connected. We will then establish the
1755 * connection between the original upstream
1756 * source and the trimmer.
1758 char *trimmer_name
= NULL
;
1759 enum bt_graph_status graph_status
;
1761 ret
= asprintf(&trimmer_name
,
1762 "stream-intersection-trimmer-%s",
1763 upstream_port_name
);
1769 ctx
->connect_ports
= false;
1770 graph_status
= bt_graph_add_filter_component(
1771 ctx
->graph
, trimmer_class
, trimmer_name
,
1772 trimmer_params
, &trimmer
);
1774 if (graph_status
!= BT_GRAPH_STATUS_OK
) {
1780 bt_component_filter_borrow_input_port_by_index_const(
1782 if (!trimmer_input
) {
1786 bt_component_filter_borrow_output_port_by_index_const(
1788 if (!trimmer_output
) {
1793 * Replace the current downstream port by the trimmer's
1796 in_downstream_port
= trimmer_input
;
1798 bt_port_input_as_port_const(in_downstream_port
);
1799 downstream_port_name
= bt_port_get_name(
1801 BT_ASSERT(downstream_port_name
);
1804 /* We have a winner! */
1805 status
= bt_graph_connect_ports(ctx
->graph
,
1806 out_upstream_port
, in_downstream_port
, NULL
);
1807 downstream_port
= NULL
;
1809 case BT_GRAPH_STATUS_OK
:
1811 case BT_GRAPH_STATUS_CANCELED
:
1812 BT_LOGI_STR("Graph was canceled by user.");
1813 status
= BT_GRAPH_STATUS_OK
;
1815 case BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION
:
1816 BT_LOGE("A component refused a connection to one of its ports: "
1817 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1818 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1819 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1820 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1822 upstream_comp
, bt_component_get_name(upstream_comp
),
1823 upstream_port
, bt_port_get_name(upstream_port
),
1824 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1825 downstream_port
, downstream_port_name
,
1826 cfg_conn
->arg
->str
);
1828 "A component refused a connection to one of its ports (`%s` to `%s`): %s\n",
1829 bt_port_get_name(upstream_port
),
1830 downstream_port_name
,
1831 cfg_conn
->arg
->str
);
1834 BT_LOGE("Cannot create connection: graph refuses to connect ports: "
1835 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1836 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1837 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1838 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1840 upstream_comp
, bt_component_get_name(upstream_comp
),
1841 upstream_port
, bt_port_get_name(upstream_port
),
1842 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1843 downstream_port
, downstream_port_name
,
1844 cfg_conn
->arg
->str
);
1846 "Cannot create connection: graph refuses to connect ports (`%s` to `%s`): %s\n",
1847 bt_port_get_name(upstream_port
),
1848 downstream_port_name
,
1849 cfg_conn
->arg
->str
);
1853 BT_LOGI("Connected component ports: "
1854 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1855 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1856 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1857 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1859 upstream_comp
, bt_component_get_name(upstream_comp
),
1860 upstream_port
, bt_port_get_name(upstream_port
),
1861 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1862 downstream_port
, downstream_port_name
,
1863 cfg_conn
->arg
->str
);
1865 if (insert_trimmer
) {
1867 * The first connection, from the source to the trimmer,
1868 * has been done. We now connect the trimmer to the
1869 * original downstream port.
1871 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1873 bt_component_filter_as_component_const(trimmer
),
1874 trimmer_output
, cfg_conn
);
1878 ctx
->connect_ports
= true;
1882 * We found a matching downstream port: the search is
1888 /* No downstream port found */
1889 BT_LOGE("Cannot create connection: cannot find a matching downstream port for upstream port: "
1890 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1891 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1892 upstream_port
, bt_port_get_name(upstream_port
),
1893 cfg_conn
->downstream_comp_name
->str
,
1894 cfg_conn
->arg
->str
);
1896 "Cannot create connection: cannot find a matching downstream port for upstream port `%s`: %s\n",
1897 bt_port_get_name(upstream_port
), cfg_conn
->arg
->str
);
1903 free(intersection_begin
);
1904 free(intersection_end
);
1905 BT_VALUE_PUT_REF_AND_RESET(trimmer_params
);
1906 BT_COMPONENT_CLASS_FILTER_PUT_REF_AND_RESET(trimmer_class
);
1907 BT_COMPONENT_FILTER_PUT_REF_AND_RESET(trimmer
);
1912 int cmd_run_ctx_connect_upstream_port(struct cmd_run_ctx
*ctx
,
1913 const struct bt_port_output
*upstream_port
)
1916 const char *upstream_port_name
;
1917 const char *upstream_comp_name
;
1918 const struct bt_component
*upstream_comp
= NULL
;
1922 BT_ASSERT(upstream_port
);
1923 upstream_port_name
= bt_port_get_name(
1924 bt_port_output_as_port_const(upstream_port
));
1925 BT_ASSERT(upstream_port_name
);
1926 upstream_comp
= bt_port_borrow_component_const(
1927 bt_port_output_as_port_const(upstream_port
));
1928 if (!upstream_comp
) {
1929 BT_LOGW("Upstream port to connect is not part of a component: "
1930 "port-addr=%p, port-name=\"%s\"",
1931 upstream_port
, upstream_port_name
);
1936 upstream_comp_name
= bt_component_get_name(upstream_comp
);
1937 BT_ASSERT(upstream_comp_name
);
1938 BT_LOGI("Connecting upstream port: comp-addr=%p, comp-name=\"%s\", "
1939 "port-addr=%p, port-name=\"%s\"",
1940 upstream_comp
, upstream_comp_name
,
1941 upstream_port
, upstream_port_name
);
1943 for (i
= 0; i
< ctx
->cfg
->cmd_data
.run
.connections
->len
; i
++) {
1944 struct bt_config_connection
*cfg_conn
=
1946 ctx
->cfg
->cmd_data
.run
.connections
, i
);
1948 if (strcmp(cfg_conn
->upstream_comp_name
->str
,
1949 upstream_comp_name
)) {
1953 if (!bt_common_star_glob_match(
1954 cfg_conn
->upstream_port_glob
->str
,
1955 SIZE_MAX
, upstream_port_name
, SIZE_MAX
)) {
1959 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1960 ctx
, upstream_comp
, upstream_port
, cfg_conn
);
1962 BT_LOGE("Cannot connect upstream port: "
1963 "port-addr=%p, port-name=\"%s\"",
1965 upstream_port_name
);
1967 "Cannot connect port `%s` of component `%s` to a downstream port: %s\n",
1970 cfg_conn
->arg
->str
);
1976 BT_LOGE("Cannot connect upstream port: port does not match any connection argument: "
1977 "port-addr=%p, port-name=\"%s\"", upstream_port
,
1978 upstream_port_name
);
1980 "Cannot create connection: upstream port `%s` does not match any connection\n",
1981 upstream_port_name
);
1991 void graph_output_port_added_listener(struct cmd_run_ctx
*ctx
,
1992 const struct bt_port_output
*out_port
)
1994 const struct bt_component
*comp
;
1995 const struct bt_port
*port
= bt_port_output_as_port_const(out_port
);
1997 comp
= bt_port_borrow_component_const(port
);
1998 BT_LOGI("Port added to a graph's component: comp-addr=%p, "
1999 "comp-name=\"%s\", port-addr=%p, port-name=\"%s\"",
2000 comp
, comp
? bt_component_get_name(comp
) : "",
2001 port
, bt_port_get_name(port
));
2003 if (!ctx
->connect_ports
) {
2008 BT_LOGW_STR("Port has no component.");
2012 if (bt_port_is_connected(port
)) {
2013 BT_LOGW_STR("Port is already connected.");
2017 if (cmd_run_ctx_connect_upstream_port(ctx
, out_port
)) {
2018 BT_LOGF_STR("Cannot connect upstream port.");
2019 fprintf(stderr
, "Added port could not be connected: aborting\n");
2028 void graph_source_output_port_added_listener(
2029 const struct bt_component_source
*component
,
2030 const struct bt_port_output
*port
, void *data
)
2032 graph_output_port_added_listener(data
, port
);
2036 void graph_filter_output_port_added_listener(
2037 const struct bt_component_filter
*component
,
2038 const struct bt_port_output
*port
, void *data
)
2040 graph_output_port_added_listener(data
, port
);
2044 void cmd_run_ctx_destroy(struct cmd_run_ctx
*ctx
)
2050 if (ctx
->src_components
) {
2051 g_hash_table_destroy(ctx
->src_components
);
2052 ctx
->src_components
= NULL
;
2055 if (ctx
->flt_components
) {
2056 g_hash_table_destroy(ctx
->flt_components
);
2057 ctx
->flt_components
= NULL
;
2060 if (ctx
->sink_components
) {
2061 g_hash_table_destroy(ctx
->sink_components
);
2062 ctx
->sink_components
= NULL
;
2065 if (ctx
->intersections
) {
2066 g_hash_table_destroy(ctx
->intersections
);
2067 ctx
->intersections
= NULL
;
2070 BT_GRAPH_PUT_REF_AND_RESET(ctx
->graph
);
2076 int cmd_run_ctx_init(struct cmd_run_ctx
*ctx
, struct bt_config
*cfg
)
2079 enum bt_graph_status status
;
2082 ctx
->connect_ports
= false;
2083 ctx
->src_components
= g_hash_table_new_full(g_direct_hash
,
2084 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
2085 if (!ctx
->src_components
) {
2089 ctx
->flt_components
= g_hash_table_new_full(g_direct_hash
,
2090 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
2091 if (!ctx
->flt_components
) {
2095 ctx
->sink_components
= g_hash_table_new_full(g_direct_hash
,
2096 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
2097 if (!ctx
->sink_components
) {
2101 if (cfg
->cmd_data
.run
.stream_intersection_mode
) {
2102 ctx
->stream_intersection_mode
= true;
2103 ctx
->intersections
= g_hash_table_new_full(port_id_hash
,
2104 port_id_equal
, port_id_destroy
, trace_range_destroy
);
2105 if (!ctx
->intersections
) {
2110 ctx
->graph
= bt_graph_create();
2115 the_graph
= ctx
->graph
;
2116 status
= bt_graph_add_source_component_output_port_added_listener(
2117 ctx
->graph
, graph_source_output_port_added_listener
, NULL
, ctx
,
2119 if (status
!= BT_GRAPH_STATUS_OK
) {
2120 BT_LOGE_STR("Cannot add \"port added\" listener to graph.");
2124 status
= bt_graph_add_filter_component_output_port_added_listener(
2125 ctx
->graph
, graph_filter_output_port_added_listener
, NULL
, ctx
,
2127 if (status
!= BT_GRAPH_STATUS_OK
) {
2128 BT_LOGE_STR("Cannot add \"port added\" listener to graph.");
2135 cmd_run_ctx_destroy(ctx
);
2143 int set_stream_intersections(struct cmd_run_ctx
*ctx
,
2144 struct bt_config_component
*cfg_comp
,
2145 const struct bt_component_class_source
*src_comp_cls
)
2149 int64_t trace_count
;
2150 enum bt_value_status value_status
;
2151 const char *path
= NULL
;
2152 const struct bt_value
*component_path_value
= NULL
;
2153 struct bt_value
*query_params
= NULL
;
2154 const struct bt_value
*query_result
= NULL
;
2155 const struct bt_value
*trace_info
= NULL
;
2156 const struct bt_value
*intersection_range
= NULL
;
2157 const struct bt_value
*intersection_begin
= NULL
;
2158 const struct bt_value
*intersection_end
= NULL
;
2159 const struct bt_value
*stream_path_value
= NULL
;
2160 const struct bt_value
*stream_paths
= NULL
;
2161 const struct bt_value
*stream_infos
= NULL
;
2162 const struct 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 struct bt_component_class
*comp_cls
=
2167 bt_component_class_source_as_component_class_const(src_comp_cls
);
2169 component_path_value
= bt_value_map_borrow_entry_value(cfg_comp
->params
,
2171 if (component_path_value
&& !bt_value_is_string(component_path_value
)) {
2172 BT_LOGD("Cannot get path parameter: component-name=%s",
2173 cfg_comp
->instance_name
->str
);
2178 path
= bt_value_string_get(component_path_value
);
2179 query_params
= bt_value_map_create();
2180 if (!query_params
) {
2181 BT_LOGE_STR("Cannot create query parameters.");
2186 value_status
= bt_value_map_insert_string_entry(query_params
, "path",
2188 if (value_status
!= BT_VALUE_STATUS_OK
) {
2189 BT_LOGE_STR("Cannot insert path parameter in query parameter map.");
2194 ret
= query(comp_cls
, "trace-info",
2195 query_params
, &query_result
,
2198 BT_LOGD("Component class does not support the `trace-info` query: %s: "
2199 "comp-class-name=\"%s\"", fail_reason
,
2200 bt_component_class_get_name(comp_cls
));
2205 BT_ASSERT(query_result
);
2207 if (!bt_value_is_array(query_result
)) {
2208 BT_LOGD("Unexpected format of \'trace-info\' query result: "
2209 "component-class-name=%s",
2210 bt_component_class_get_name(comp_cls
));
2215 trace_count
= bt_value_array_get_size(query_result
);
2216 if (trace_count
< 0) {
2221 for (trace_idx
= 0; trace_idx
< trace_count
; trace_idx
++) {
2223 uint64_t stream_idx
;
2224 int64_t stream_count
;
2226 trace_info
= bt_value_array_borrow_element_by_index_const(
2227 query_result
, trace_idx
);
2228 if (!trace_info
|| !bt_value_is_map(trace_info
)) {
2230 BT_LOGD_STR("Cannot retrieve trace from query result.");
2234 intersection_range
= bt_value_map_borrow_entry_value_const(
2235 trace_info
, "intersection-range-ns");
2236 if (!intersection_range
) {
2238 BT_LOGD_STR("Cannot retrieve \'intersetion-range-ns\' field from query result.");
2242 intersection_begin
= bt_value_map_borrow_entry_value_const(intersection_range
,
2244 if (!intersection_begin
) {
2246 BT_LOGD_STR("Cannot retrieve intersection-range-ns \'begin\' field from query result.");
2250 intersection_end
= bt_value_map_borrow_entry_value_const(intersection_range
,
2252 if (!intersection_end
) {
2254 BT_LOGD_STR("Cannot retrieve intersection-range-ns \'end\' field from query result.");
2258 begin
= bt_value_integer_get(intersection_begin
);
2259 end
= bt_value_integer_get(intersection_end
);
2261 if (begin
< 0 || end
< 0 || end
< begin
) {
2262 BT_LOGW("Invalid trace stream intersection values: "
2263 "intersection-range-ns:begin=%" PRId64
2264 ", intersection-range-ns:end=%" PRId64
,
2270 stream_infos
= bt_value_map_borrow_entry_value_const(trace_info
,
2272 if (!stream_infos
|| !bt_value_is_array(stream_infos
)) {
2274 BT_LOGD_STR("Cannot retrieve stream information from trace in query result.");
2278 stream_count
= bt_value_array_get_size(stream_infos
);
2279 if (stream_count
< 0) {
2287 * The first path of a stream's "paths" is currently used to
2288 * associate streams/ports to a given trace intersection.
2290 * This is a fragile hack as it relies on the port names
2291 * being set to the various streams path.
2293 * A stream name should be introduced as part of the trace-info
2296 for (stream_idx
= 0; stream_idx
< stream_count
; stream_idx
++) {
2297 const char *stream_path
;
2299 port_id
= g_new0(struct port_id
, 1);
2302 BT_LOGE_STR("Cannot allocate memory for port_id structure.");
2305 port_id
->instance_name
= strdup(cfg_comp
->instance_name
->str
);
2306 if (!port_id
->instance_name
) {
2308 BT_LOGE_STR("Cannot allocate memory for port_id component instance name.");
2312 trace_range
= g_new0(struct trace_range
, 1);
2315 BT_LOGE_STR("Cannot allocate memory for trace_range structure.");
2318 trace_range
->intersection_range_begin_ns
= begin
;
2319 trace_range
->intersection_range_end_ns
= end
;
2321 stream_info
= bt_value_array_borrow_element_by_index_const(
2322 stream_infos
, stream_idx
);
2323 if (!stream_info
|| !bt_value_is_map(stream_info
)) {
2325 BT_LOGD_STR("Cannot retrieve stream informations from trace in query result.");
2329 stream_paths
= bt_value_map_borrow_entry_value_const(stream_info
,
2331 if (!stream_paths
|| !bt_value_is_array(stream_paths
)) {
2333 BT_LOGD_STR("Cannot retrieve stream paths from trace in query result.");
2338 bt_value_array_borrow_element_by_index_const(
2340 if (!stream_path_value
||
2341 !bt_value_is_string(stream_path_value
)) {
2343 BT_LOGD_STR("Cannot retrieve stream path value from trace in query result.");
2347 stream_path
= bt_value_string_get(stream_path_value
);
2348 port_id
->port_name
= strdup(stream_path
);
2349 if (!port_id
->port_name
) {
2351 BT_LOGE_STR("Cannot allocate memory for port_id port_name.");
2355 BT_LOGD("Inserting stream intersection ");
2357 g_hash_table_insert(ctx
->intersections
, port_id
, trace_range
);
2367 fprintf(stderr
, "%s%sCannot determine stream intersection of trace at path \'%s\'.%s\n",
2368 bt_common_color_bold(),
2369 bt_common_color_fg_yellow(),
2370 path
? path
: "(unknown)",
2371 bt_common_color_reset());
2373 bt_value_put_ref(query_params
);
2374 bt_value_put_ref(query_result
);
2376 g_free(trace_range
);
2381 int cmd_run_ctx_create_components_from_config_components(
2382 struct cmd_run_ctx
*ctx
, GPtrArray
*cfg_components
)
2385 const void *comp_cls
= NULL
;
2386 const void *comp
= NULL
;
2389 for (i
= 0; i
< cfg_components
->len
; i
++) {
2390 struct bt_config_component
*cfg_comp
=
2391 g_ptr_array_index(cfg_components
, i
);
2394 switch (cfg_comp
->type
) {
2395 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2396 comp_cls
= find_source_component_class(
2397 cfg_comp
->plugin_name
->str
,
2398 cfg_comp
->comp_cls_name
->str
);
2400 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2401 comp_cls
= find_filter_component_class(
2402 cfg_comp
->plugin_name
->str
,
2403 cfg_comp
->comp_cls_name
->str
);
2405 case BT_COMPONENT_CLASS_TYPE_SINK
:
2406 comp_cls
= find_sink_component_class(
2407 cfg_comp
->plugin_name
->str
,
2408 cfg_comp
->comp_cls_name
->str
);
2415 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
2416 "comp-cls-name=\"%s\", comp-cls-type=%d",
2417 cfg_comp
->plugin_name
->str
,
2418 cfg_comp
->comp_cls_name
->str
,
2420 fprintf(stderr
, "%s%sCannot find component class %s",
2421 bt_common_color_bold(),
2422 bt_common_color_fg_red(),
2423 bt_common_color_reset());
2424 print_plugin_comp_cls_opt(stderr
,
2425 cfg_comp
->plugin_name
->str
,
2426 cfg_comp
->comp_cls_name
->str
,
2428 fprintf(stderr
, "\n");
2432 switch (cfg_comp
->type
) {
2433 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2434 ret
= bt_graph_add_source_component(ctx
->graph
,
2435 comp_cls
, cfg_comp
->instance_name
->str
,
2439 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2440 ret
= bt_graph_add_filter_component(ctx
->graph
,
2441 comp_cls
, cfg_comp
->instance_name
->str
,
2445 case BT_COMPONENT_CLASS_TYPE_SINK
:
2446 ret
= bt_graph_add_sink_component(ctx
->graph
,
2447 comp_cls
, cfg_comp
->instance_name
->str
,
2456 BT_LOGE("Cannot create component: plugin-name=\"%s\", "
2457 "comp-cls-name=\"%s\", comp-cls-type=%d, "
2459 cfg_comp
->plugin_name
->str
,
2460 cfg_comp
->comp_cls_name
->str
,
2461 cfg_comp
->type
, cfg_comp
->instance_name
->str
);
2462 fprintf(stderr
, "%s%sCannot create component `%s`%s\n",
2463 bt_common_color_bold(),
2464 bt_common_color_fg_red(),
2465 cfg_comp
->instance_name
->str
,
2466 bt_common_color_reset());
2470 if (ctx
->stream_intersection_mode
&&
2471 cfg_comp
->type
== BT_COMPONENT_CLASS_TYPE_SOURCE
) {
2472 ret
= set_stream_intersections(ctx
, cfg_comp
, comp_cls
);
2478 BT_LOGI("Created and inserted component: comp-addr=%p, comp-name=\"%s\"",
2479 comp
, cfg_comp
->instance_name
->str
);
2480 quark
= g_quark_from_string(cfg_comp
->instance_name
->str
);
2481 BT_ASSERT(quark
> 0);
2483 switch (cfg_comp
->type
) {
2484 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2485 g_hash_table_insert(ctx
->src_components
,
2486 GUINT_TO_POINTER(quark
), (void *) comp
);
2488 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2489 g_hash_table_insert(ctx
->flt_components
,
2490 GUINT_TO_POINTER(quark
), (void *) comp
);
2492 case BT_COMPONENT_CLASS_TYPE_SINK
:
2493 g_hash_table_insert(ctx
->sink_components
,
2494 GUINT_TO_POINTER(quark
), (void *) comp
);
2501 BT_OBJECT_PUT_REF_AND_RESET(comp_cls
);
2510 bt_object_put_ref(comp
);
2511 bt_object_put_ref(comp_cls
);
2516 int cmd_run_ctx_create_components(struct cmd_run_ctx
*ctx
)
2521 * Make sure that, during this phase, our graph's "port added"
2522 * listener does not connect ports while we are creating the
2523 * components because we have a special, initial phase for
2526 ctx
->connect_ports
= false;
2528 ret
= cmd_run_ctx_create_components_from_config_components(
2529 ctx
, ctx
->cfg
->cmd_data
.run
.sources
);
2535 ret
= cmd_run_ctx_create_components_from_config_components(
2536 ctx
, ctx
->cfg
->cmd_data
.run
.filters
);
2542 ret
= cmd_run_ctx_create_components_from_config_components(
2543 ctx
, ctx
->cfg
->cmd_data
.run
.sinks
);
2553 typedef uint64_t (*output_port_count_func_t
)(const void *);
2554 typedef const struct bt_port_output
*(*borrow_output_port_by_index_func_t
)(
2555 const void *, uint64_t);
2558 int cmd_run_ctx_connect_comp_ports(struct cmd_run_ctx
*ctx
,
2559 void *comp
, output_port_count_func_t port_count_fn
,
2560 borrow_output_port_by_index_func_t port_by_index_fn
)
2566 count
= port_count_fn(comp
);
2567 BT_ASSERT(count
>= 0);
2569 for (i
= 0; i
< count
; i
++) {
2570 const struct bt_port_output
*upstream_port
= port_by_index_fn(comp
, i
);
2572 BT_ASSERT(upstream_port
);
2573 ret
= cmd_run_ctx_connect_upstream_port(ctx
, upstream_port
);
2584 int cmd_run_ctx_connect_ports(struct cmd_run_ctx
*ctx
)
2587 GHashTableIter iter
;
2588 gpointer g_name_quark
, g_comp
;
2590 ctx
->connect_ports
= true;
2591 g_hash_table_iter_init(&iter
, ctx
->src_components
);
2593 while (g_hash_table_iter_next(&iter
, &g_name_quark
, &g_comp
)) {
2594 ret
= cmd_run_ctx_connect_comp_ports(ctx
, g_comp
,
2595 (output_port_count_func_t
)
2596 bt_component_source_get_output_port_count
,
2597 (borrow_output_port_by_index_func_t
)
2598 bt_component_source_borrow_output_port_by_index_const
);
2604 g_hash_table_iter_init(&iter
, ctx
->flt_components
);
2606 while (g_hash_table_iter_next(&iter
, &g_name_quark
, &g_comp
)) {
2607 ret
= cmd_run_ctx_connect_comp_ports(ctx
, g_comp
,
2608 (output_port_count_func_t
)
2609 bt_component_filter_get_output_port_count
,
2610 (borrow_output_port_by_index_func_t
)
2611 bt_component_filter_borrow_output_port_by_index_const
);
2622 const char *bt_graph_status_str(enum bt_graph_status status
)
2625 case BT_GRAPH_STATUS_OK
:
2626 return "BT_GRAPH_STATUS_OK";
2627 case BT_GRAPH_STATUS_END
:
2628 return "BT_GRAPH_STATUS_END";
2629 case BT_GRAPH_STATUS_AGAIN
:
2630 return "BT_GRAPH_STATUS_AGAIN";
2631 case BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION
:
2632 return "BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION";
2633 case BT_GRAPH_STATUS_CANCELED
:
2634 return "BT_GRAPH_STATUS_CANCELED";
2635 case BT_GRAPH_STATUS_ERROR
:
2636 return "BT_GRAPH_STATUS_ERROR";
2637 case BT_GRAPH_STATUS_NO_SINK
:
2638 return "BT_GRAPH_STATUS_NO_SINK";
2639 case BT_GRAPH_STATUS_NOMEM
:
2640 return "BT_GRAPH_STATUS_NOMEM";
2647 int cmd_run(struct bt_config
*cfg
)
2650 struct cmd_run_ctx ctx
= { 0 };
2652 /* Initialize the command's context and the graph object */
2653 if (cmd_run_ctx_init(&ctx
, cfg
)) {
2654 BT_LOGE_STR("Cannot initialize the command's context.");
2655 fprintf(stderr
, "Cannot initialize the command's context\n");
2660 BT_LOGI_STR("Canceled by user before creating components.");
2664 BT_LOGI_STR("Creating components.");
2666 /* Create the requested component instances */
2667 if (cmd_run_ctx_create_components(&ctx
)) {
2668 BT_LOGE_STR("Cannot create components.");
2669 fprintf(stderr
, "Cannot create components\n");
2674 BT_LOGI_STR("Canceled by user before connecting components.");
2678 BT_LOGI_STR("Connecting components.");
2680 /* Connect the initially visible component ports */
2681 if (cmd_run_ctx_connect_ports(&ctx
)) {
2682 BT_LOGE_STR("Cannot connect initial component ports.");
2683 fprintf(stderr
, "Cannot connect initial component ports\n");
2688 BT_LOGI_STR("Canceled by user before running the graph.");
2692 BT_LOGI_STR("Running the graph.");
2696 enum bt_graph_status graph_status
= bt_graph_run(ctx
.graph
);
2699 * Reset console in case something messed with console
2700 * codes during the graph's execution.
2702 printf("%s", bt_common_color_reset());
2704 fprintf(stderr
, "%s", bt_common_color_reset());
2705 BT_LOGV("bt_graph_run() returned: status=%s",
2706 bt_graph_status_str(graph_status
));
2708 switch (graph_status
) {
2709 case BT_GRAPH_STATUS_OK
:
2711 case BT_GRAPH_STATUS_CANCELED
:
2712 BT_LOGI_STR("Graph was canceled by user.");
2714 case BT_GRAPH_STATUS_AGAIN
:
2715 if (bt_graph_is_canceled(ctx
.graph
)) {
2716 BT_LOGI_STR("Graph was canceled by user.");
2720 if (cfg
->cmd_data
.run
.retry_duration_us
> 0) {
2721 BT_LOGV("Got BT_GRAPH_STATUS_AGAIN: sleeping: "
2723 cfg
->cmd_data
.run
.retry_duration_us
);
2725 if (usleep(cfg
->cmd_data
.run
.retry_duration_us
)) {
2726 if (bt_graph_is_canceled(ctx
.graph
)) {
2727 BT_LOGI_STR("Graph was canceled by user.");
2733 case BT_GRAPH_STATUS_END
:
2736 BT_LOGE_STR("Graph failed to complete successfully");
2737 fprintf(stderr
, "Graph failed to complete successfully\n");
2750 cmd_run_ctx_destroy(&ctx
);
2755 void warn_command_name_and_directory_clash(struct bt_config
*cfg
)
2757 const char *env_clash
;
2759 if (!cfg
->command_name
) {
2763 env_clash
= getenv(ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH
);
2764 if (env_clash
&& strcmp(env_clash
, "0") == 0) {
2768 if (g_file_test(cfg
->command_name
,
2769 G_FILE_TEST_EXISTS
| G_FILE_TEST_IS_DIR
)) {
2770 fprintf(stderr
, "\nNOTE: The `%s` command was executed. If you meant to convert a\n",
2772 fprintf(stderr
, "trace located in the local `%s` directory, please use:\n",
2774 fprintf(stderr
, "\n");
2775 fprintf(stderr
, " babeltrace convert %s [OPTIONS]\n",
2781 void init_log_level(void)
2783 bt_cli_log_level
= bt_log_get_level_from_env(ENV_BABELTRACE_CLI_LOG_LEVEL
);
2787 void set_auto_log_levels(struct bt_config
*cfg
)
2789 const char **env_var_name
;
2792 * Override the configuration's default log level if
2793 * BABELTRACE_VERBOSE or BABELTRACE_DEBUG environment variables
2794 * are found for backward compatibility with legacy Babetrace 1.
2796 if (getenv("BABELTRACE_DEBUG") &&
2797 strcmp(getenv("BABELTRACE_DEBUG"), "1") == 0) {
2798 cfg
->log_level
= 'V';
2799 } else if (getenv("BABELTRACE_VERBOSE") &&
2800 strcmp(getenv("BABELTRACE_VERBOSE"), "1") == 0) {
2801 cfg
->log_level
= 'I';
2805 * Set log levels according to --debug or --verbose. For
2806 * backward compatibility, --debug is more verbose than
2809 * --verbose: INFO log level
2810 * --debug: VERBOSE log level (includes DEBUG, which is
2811 * is less verbose than VERBOSE in the internal
2812 * logging framework)
2814 if (!getenv("BABELTRACE_LOGGING_GLOBAL_LEVEL")) {
2816 bt_logging_set_global_level(BT_LOGGING_LEVEL_INFO
);
2817 } else if (cfg
->debug
) {
2818 bt_logging_set_global_level(BT_LOGGING_LEVEL_VERBOSE
);
2821 * Set library's default log level if not
2822 * explicitly specified.
2824 switch (cfg
->log_level
) {
2826 bt_logging_set_global_level(BT_LOGGING_LEVEL_NONE
);
2829 bt_logging_set_global_level(BT_LOGGING_LEVEL_VERBOSE
);
2832 bt_logging_set_global_level(BT_LOGGING_LEVEL_DEBUG
);
2835 bt_logging_set_global_level(BT_LOGGING_LEVEL_INFO
);
2838 bt_logging_set_global_level(BT_LOGGING_LEVEL_WARN
);
2841 bt_logging_set_global_level(BT_LOGGING_LEVEL_ERROR
);
2844 bt_logging_set_global_level(BT_LOGGING_LEVEL_FATAL
);
2852 if (!getenv(ENV_BABELTRACE_CLI_LOG_LEVEL
)) {
2854 bt_cli_log_level
= BT_LOG_INFO
;
2855 } else if (cfg
->debug
) {
2856 bt_cli_log_level
= BT_LOG_VERBOSE
;
2859 * Set CLI's default log level if not explicitly
2862 switch (cfg
->log_level
) {
2864 bt_cli_log_level
= BT_LOG_NONE
;
2867 bt_cli_log_level
= BT_LOG_VERBOSE
;
2870 bt_cli_log_level
= BT_LOG_DEBUG
;
2873 bt_cli_log_level
= BT_LOG_INFO
;
2876 bt_cli_log_level
= BT_LOG_WARN
;
2879 bt_cli_log_level
= BT_LOG_ERROR
;
2882 bt_cli_log_level
= BT_LOG_FATAL
;
2890 env_var_name
= log_level_env_var_names
;
2892 while (*env_var_name
) {
2893 if (!getenv(*env_var_name
)) {
2895 g_setenv(*env_var_name
, "I", 1);
2896 } else if (cfg
->debug
) {
2897 g_setenv(*env_var_name
, "V", 1);
2899 char val
[2] = { 0 };
2902 * Set module's default log level if not
2903 * explicitly specified.
2905 val
[0] = cfg
->log_level
;
2906 g_setenv(*env_var_name
, val
, 1);
2914 int main(int argc
, const char **argv
)
2918 struct bt_config
*cfg
;
2921 set_signal_handler();
2923 cfg
= bt_config_cli_args_create_with_default(argc
, argv
, &retcode
);
2926 /* Quit without errors; typically usage/version */
2928 BT_LOGI_STR("Quitting without errors.");
2933 BT_LOGE("Command-line error: retcode=%d", retcode
);
2938 BT_LOGE_STR("Failed to create a valid Babeltrace configuration.");
2939 fprintf(stderr
, "Failed to create Babeltrace configuration\n");
2944 set_auto_log_levels(cfg
);
2947 if (cfg
->command_needs_plugins
) {
2948 ret
= load_all_plugins(cfg
->plugin_paths
);
2950 BT_LOGE("Failed to load plugins: ret=%d", ret
);
2956 BT_LOGI("Executing command: cmd=%d, command-name=\"%s\"",
2957 cfg
->command
, cfg
->command_name
);
2959 switch (cfg
->command
) {
2960 case BT_CONFIG_COMMAND_RUN
:
2963 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
2964 ret
= cmd_list_plugins(cfg
);
2966 case BT_CONFIG_COMMAND_HELP
:
2967 ret
= cmd_help(cfg
);
2969 case BT_CONFIG_COMMAND_QUERY
:
2970 ret
= cmd_query(cfg
);
2972 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
2973 ret
= cmd_print_ctf_metadata(cfg
);
2975 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
2976 ret
= cmd_print_lttng_live_sessions(cfg
);
2979 BT_LOGF("Invalid/unknown command: cmd=%d", cfg
->command
);
2983 BT_LOGI("Command completed: cmd=%d, command-name=\"%s\", ret=%d",
2984 cfg
->command
, cfg
->command_name
, ret
);
2985 warn_command_name_and_directory_clash(cfg
);
2986 retcode
= ret
? 1 : 0;
2989 BT_OBJECT_PUT_REF_AND_RESET(cfg
);