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_FLT_LTTNG_UTILS_DEBUG_INFO_LOG_LEVEL",
53 "BABELTRACE_PLUGIN_CTF_BFCR_LOG_LEVEL",
54 "BABELTRACE_PLUGIN_CTF_METADATA_LOG_LEVEL",
55 "BABELTRACE_PLUGIN_CTF_MSG_ITER_LOG_LEVEL",
56 "BABELTRACE_PLUGIN_CTF_UTILS_LOG_LEVEL",
57 "BABELTRACE_PYTHON_BT2_LOG_LEVEL",
58 "BABELTRACE_SINK_CTF_FS_LOG_LEVEL",
59 "BABELTRACE_SINK_TEXT_DETAILS_LOG_LEVEL",
60 "BABELTRACE_SRC_CTF_FS_LOG_LEVEL",
61 "BABELTRACE_SRC_CTF_LTTNG_LIVE_LOG_LEVEL",
65 /* Application's processing graph (weak) */
66 static bt_graph
*the_graph
;
67 static bt_query_executor
*the_query_executor
;
68 static bool canceled
= false;
70 GPtrArray
*loaded_plugins
;
77 BOOL WINAPI
signal_handler(DWORD signal
) {
79 bt_graph_cancel(the_graph
);
88 void set_signal_handler(void)
90 if (!SetConsoleCtrlHandler(signal_handler
, TRUE
)) {
91 BT_LOGE("Failed to set the Ctrl+C handler.");
95 #else /* __MINGW32__ */
98 void signal_handler(int signum
)
100 if (signum
!= SIGINT
) {
105 bt_graph_cancel(the_graph
);
108 if (the_query_executor
) {
109 bt_query_executor_cancel(the_query_executor
);
116 void set_signal_handler(void)
118 struct sigaction new_action
, old_action
;
120 new_action
.sa_handler
= signal_handler
;
121 sigemptyset(&new_action
.sa_mask
);
122 new_action
.sa_flags
= 0;
123 sigaction(SIGINT
, NULL
, &old_action
);
125 if (old_action
.sa_handler
!= SIG_IGN
) {
126 sigaction(SIGINT
, &new_action
, NULL
);
130 #endif /* __MINGW32__ */
133 void init_static_data(void)
135 loaded_plugins
= g_ptr_array_new_with_free_func(
136 (GDestroyNotify
) bt_object_put_ref
);
140 void fini_static_data(void)
142 g_ptr_array_free(loaded_plugins
, TRUE
);
146 int create_the_query_executor(void)
150 the_query_executor
= bt_query_executor_create();
151 if (!the_query_executor
) {
152 BT_LOGE_STR("Cannot create a query executor.");
160 void destroy_the_query_executor(void)
162 BT_QUERY_EXECUTOR_PUT_REF_AND_RESET(the_query_executor
);
166 int query(struct bt_config
*cfg
, const bt_component_class
*comp_cls
,
167 const char *obj
, const bt_value
*params
,
168 const bt_value
**user_result
, const char **fail_reason
)
170 const bt_value
*result
= NULL
;
171 bt_query_executor_status status
;
172 *fail_reason
= "unknown error";
175 BT_ASSERT(fail_reason
);
176 BT_ASSERT(user_result
);
177 ret
= create_the_query_executor();
179 /* create_the_query_executor() logs errors */
184 BT_LOGI("Canceled by user before executing the query: "
185 "comp-cls-addr=%p, comp-cls-name=\"%s\", "
186 "query-obj=\"%s\"", comp_cls
,
187 bt_component_class_get_name(comp_cls
), obj
);
188 *fail_reason
= "canceled by user";
193 status
= bt_query_executor_query(the_query_executor
,
194 comp_cls
, obj
, params
, cfg
->log_level
, &result
);
196 case BT_QUERY_EXECUTOR_STATUS_OK
:
198 case BT_QUERY_EXECUTOR_STATUS_AGAIN
:
200 const uint64_t sleep_time_us
= 100000;
202 /* Wait 100 ms and retry */
203 BT_LOGD("Got BT_QUERY_EXECUTOR_STATUS_AGAIN: sleeping: "
204 "time-us=%" PRIu64
, sleep_time_us
);
206 if (usleep(sleep_time_us
)) {
207 if (bt_query_executor_is_canceled(the_query_executor
)) {
208 BT_LOGI("Query was canceled by user: "
209 "comp-cls-addr=%p, comp-cls-name=\"%s\", "
210 "query-obj=\"%s\"", comp_cls
,
211 bt_component_class_get_name(comp_cls
),
213 *fail_reason
= "canceled by user";
220 case BT_QUERY_EXECUTOR_STATUS_CANCELED
:
221 *fail_reason
= "canceled by user";
223 case BT_QUERY_EXECUTOR_STATUS_ERROR
:
225 case BT_QUERY_EXECUTOR_STATUS_INVALID_OBJECT
:
226 *fail_reason
= "invalid or unknown query object";
228 case BT_QUERY_EXECUTOR_STATUS_INVALID_PARAMS
:
229 *fail_reason
= "invalid query parameters";
231 case BT_QUERY_EXECUTOR_STATUS_UNSUPPORTED
:
232 *fail_reason
= "unsupported action";
234 case BT_QUERY_EXECUTOR_STATUS_NOMEM
:
235 *fail_reason
= "not enough memory";
238 BT_LOGF("Unknown query status: status=%d", status
);
244 *user_result
= result
;
252 destroy_the_query_executor();
253 bt_value_put_ref(result
);
258 const bt_plugin
*find_plugin(const char *name
)
261 const bt_plugin
*plugin
= NULL
;
264 BT_LOGI("Finding plugin: name=\"%s\"", name
);
266 for (i
= 0; i
< loaded_plugins
->len
; i
++) {
267 plugin
= g_ptr_array_index(loaded_plugins
, i
);
269 if (strcmp(name
, bt_plugin_get_name(plugin
)) == 0) {
277 BT_LOGI("Found plugin: name=\"%s\", plugin-addr=%p",
280 BT_LOGI("Cannot find plugin: name=\"%s\"", name
);
283 bt_plugin_get_ref(plugin
);
287 typedef const void *(*plugin_borrow_comp_cls_func_t
)(
288 const bt_plugin
*, const char *);
291 const void *find_component_class_from_plugin(const char *plugin_name
,
292 const char *comp_class_name
,
293 plugin_borrow_comp_cls_func_t plugin_borrow_comp_cls_func
)
295 const void *comp_class
= NULL
;
296 const bt_plugin
*plugin
;
298 BT_LOGI("Finding component class: plugin-name=\"%s\", "
299 "comp-cls-name=\"%s\"", plugin_name
, comp_class_name
);
301 plugin
= find_plugin(plugin_name
);
306 comp_class
= plugin_borrow_comp_cls_func(plugin
, comp_class_name
);
307 bt_object_get_ref(comp_class
);
308 BT_PLUGIN_PUT_REF_AND_RESET(plugin
);
312 BT_LOGI("Found component class: plugin-name=\"%s\", "
313 "comp-cls-name=\"%s\"", plugin_name
, comp_class_name
);
315 BT_LOGI("Cannot find source component class: "
316 "plugin-name=\"%s\", comp-cls-name=\"%s\"",
317 plugin_name
, comp_class_name
);
324 const bt_component_class_source
*find_source_component_class(
325 const char *plugin_name
, const char *comp_class_name
)
327 return (const void *) find_component_class_from_plugin(
328 plugin_name
, comp_class_name
,
329 (plugin_borrow_comp_cls_func_t
)
330 bt_plugin_borrow_source_component_class_by_name_const
);
334 const bt_component_class_filter
*find_filter_component_class(
335 const char *plugin_name
, const char *comp_class_name
)
337 return (const void *) find_component_class_from_plugin(
338 plugin_name
, comp_class_name
,
339 (plugin_borrow_comp_cls_func_t
)
340 bt_plugin_borrow_filter_component_class_by_name_const
);
344 const bt_component_class_sink
*find_sink_component_class(
345 const char *plugin_name
, const char *comp_class_name
)
347 return (const void *) find_component_class_from_plugin(plugin_name
,
349 (plugin_borrow_comp_cls_func_t
)
350 bt_plugin_borrow_sink_component_class_by_name_const
);
354 const bt_component_class
*find_component_class(const char *plugin_name
,
355 const char *comp_class_name
,
356 bt_component_class_type comp_class_type
)
358 const bt_component_class
*comp_cls
= NULL
;
360 switch (comp_class_type
) {
361 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
362 comp_cls
= bt_component_class_source_as_component_class_const(find_source_component_class(plugin_name
, comp_class_name
));
364 case BT_COMPONENT_CLASS_TYPE_FILTER
:
365 comp_cls
= bt_component_class_filter_as_component_class_const(find_filter_component_class(plugin_name
, comp_class_name
));
367 case BT_COMPONENT_CLASS_TYPE_SINK
:
368 comp_cls
= bt_component_class_sink_as_component_class_const(find_sink_component_class(plugin_name
, comp_class_name
));
378 void print_indent(FILE *fp
, size_t indent
)
382 for (i
= 0; i
< indent
; i
++) {
388 const char *component_type_str(bt_component_class_type type
)
391 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
393 case BT_COMPONENT_CLASS_TYPE_SINK
:
395 case BT_COMPONENT_CLASS_TYPE_FILTER
:
403 void print_plugin_comp_cls_opt(FILE *fh
, const char *plugin_name
,
404 const char *comp_cls_name
, bt_component_class_type type
)
406 GString
*shell_plugin_name
= NULL
;
407 GString
*shell_comp_cls_name
= NULL
;
409 shell_plugin_name
= bt_common_shell_quote(plugin_name
, false);
410 if (!shell_plugin_name
) {
414 shell_comp_cls_name
= bt_common_shell_quote(comp_cls_name
, false);
415 if (!shell_comp_cls_name
) {
419 fprintf(fh
, "'%s%s%s%s.%s%s%s.%s%s%s'",
420 bt_common_color_bold(),
421 bt_common_color_fg_cyan(),
422 component_type_str(type
),
423 bt_common_color_fg_default(),
424 bt_common_color_fg_blue(),
425 shell_plugin_name
->str
,
426 bt_common_color_fg_default(),
427 bt_common_color_fg_yellow(),
428 shell_comp_cls_name
->str
,
429 bt_common_color_reset());
432 if (shell_plugin_name
) {
433 g_string_free(shell_plugin_name
, TRUE
);
436 if (shell_comp_cls_name
) {
437 g_string_free(shell_comp_cls_name
, TRUE
);
442 void print_value(FILE *, const bt_value
*, size_t);
445 void print_value_rec(FILE *, const bt_value
*, size_t);
447 struct print_map_value_data
{
453 bt_bool
print_map_value(const char *key
, const bt_value
*object
,
456 struct print_map_value_data
*print_map_value_data
= data
;
458 print_indent(print_map_value_data
->fp
, print_map_value_data
->indent
);
459 fprintf(print_map_value_data
->fp
, "%s: ", key
);
462 if (bt_value_is_array(object
) &&
463 bt_value_array_is_empty(object
)) {
464 fprintf(print_map_value_data
->fp
, "[ ]\n");
468 if (bt_value_is_map(object
) &&
469 bt_value_map_is_empty(object
)) {
470 fprintf(print_map_value_data
->fp
, "{ }\n");
474 if (bt_value_is_array(object
) ||
475 bt_value_is_map(object
)) {
476 fprintf(print_map_value_data
->fp
, "\n");
479 print_value_rec(print_map_value_data
->fp
, object
,
480 print_map_value_data
->indent
+ 2);
485 void print_value_rec(FILE *fp
, const bt_value
*value
, size_t indent
)
499 switch (bt_value_get_type(value
)) {
500 case BT_VALUE_TYPE_NULL
:
501 fprintf(fp
, "%snull%s\n", bt_common_color_bold(),
502 bt_common_color_reset());
504 case BT_VALUE_TYPE_BOOL
:
505 bool_val
= bt_value_bool_get(value
);
506 fprintf(fp
, "%s%s%s%s\n", bt_common_color_bold(),
507 bt_common_color_fg_cyan(), bool_val
? "yes" : "no",
508 bt_common_color_reset());
510 case BT_VALUE_TYPE_UNSIGNED_INTEGER
:
511 uint_val
= bt_value_unsigned_integer_get(value
);
512 fprintf(fp
, "%s%s%" PRIu64
"%s\n", bt_common_color_bold(),
513 bt_common_color_fg_red(), uint_val
,
514 bt_common_color_reset());
516 case BT_VALUE_TYPE_SIGNED_INTEGER
:
517 int_val
= bt_value_signed_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 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 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 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("CLI configuration:");
729 BT_LOGI(" Debug mode: %s\n", cfg
->debug
? "yes" : "no");
730 BT_LOGI(" 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 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 bt_plugin
*plugin
=
767 bt_plugin_set_borrow_plugin_by_index_const(plugin_set
, i
);
768 const 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 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_STR("Loading dynamic plugins.");
805 for (i
= 0; i
< nr_paths
; i
++) {
806 const bt_value
*plugin_path_value
= NULL
;
807 const char *plugin_path
;
808 const 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_find_all_from_dir() expects an existing
820 if (!g_file_test(plugin_path
, G_FILE_TEST_IS_DIR
)) {
821 BT_LOGI("Skipping nonexistent directory path: "
822 "path=\"%s\"", plugin_path
);
826 plugin_set
= bt_plugin_find_all_from_dir(plugin_path
, false);
828 BT_LOGI("Unable to load dynamic plugins from directory: "
829 "path=\"%s\"", plugin_path
);
833 add_to_loaded_plugins(plugin_set
);
834 bt_plugin_set_put_ref(plugin_set
);
841 int load_static_plugins(void)
844 const bt_plugin_set
*plugin_set
;
846 BT_LOGI("Loading static plugins.");
847 plugin_set
= bt_plugin_find_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 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 bt_plugin
*plugin
)
884 unsigned int major
, minor
, patch
;
886 bt_property_availability version_avail
;
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_avail
= 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_avail
== BT_PROPERTY_AVAILABILITY_AVAILABLE
) {
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 bt_component_class
*comp_cls
= NULL
;
937 const 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(cfg
, 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 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 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 bt_plugin
*plugin
= NULL
;
1032 const 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 bt_plugin
*,
1102 typedef const bt_component_class
*(* spec_comp_cls_borrow_comp_cls_func_t
)(
1105 void cmd_list_plugins_print_component_classes(const 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",
1114 bt_common_color_bold(),
1116 bt_common_color_reset());
1119 printf(" %s%s component classes%s:\n",
1120 bt_common_color_bold(),
1122 bt_common_color_reset());
1125 for (i
= 0; i
< count
; i
++) {
1126 const bt_component_class
*comp_class
=
1127 spec_comp_cls_borrow_comp_cls_func(
1128 borrow_comp_cls_by_index_func(plugin
, i
));
1129 const char *comp_class_name
=
1130 bt_component_class_get_name(comp_class
);
1131 const char *comp_class_description
=
1132 bt_component_class_get_description(comp_class
);
1133 bt_component_class_type type
=
1134 bt_component_class_get_type(comp_class
);
1137 print_plugin_comp_cls_opt(stdout
,
1138 bt_plugin_get_name(plugin
), comp_class_name
,
1141 if (comp_class_description
) {
1142 printf(": %s", comp_class_description
);
1153 int cmd_list_plugins(struct bt_config
*cfg
)
1156 int plugins_count
, component_classes_count
= 0, i
;
1158 printf("From the following plugin paths:\n\n");
1159 print_value(stdout
, cfg
->plugin_paths
, 2);
1161 plugins_count
= loaded_plugins
->len
;
1162 if (plugins_count
== 0) {
1163 printf("No plugins found.\n");
1167 for (i
= 0; i
< plugins_count
; i
++) {
1168 const bt_plugin
*plugin
= g_ptr_array_index(loaded_plugins
, i
);
1170 component_classes_count
+=
1171 bt_plugin_get_source_component_class_count(plugin
) +
1172 bt_plugin_get_filter_component_class_count(plugin
) +
1173 bt_plugin_get_sink_component_class_count(plugin
);
1176 printf("Found %s%d%s component classes in %s%d%s plugins.\n",
1177 bt_common_color_bold(),
1178 component_classes_count
,
1179 bt_common_color_reset(),
1180 bt_common_color_bold(),
1182 bt_common_color_reset());
1184 for (i
= 0; i
< plugins_count
; i
++) {
1185 const bt_plugin
*plugin
= g_ptr_array_index(loaded_plugins
, i
);
1188 print_plugin_info(plugin
);
1189 cmd_list_plugins_print_component_classes(plugin
, "Source",
1190 bt_plugin_get_source_component_class_count(plugin
),
1191 (plugin_borrow_comp_cls_by_index_func_t
)
1192 bt_plugin_borrow_source_component_class_by_index_const
,
1193 (spec_comp_cls_borrow_comp_cls_func_t
)
1194 bt_component_class_source_as_component_class
);
1195 cmd_list_plugins_print_component_classes(plugin
, "Filter",
1196 bt_plugin_get_filter_component_class_count(plugin
),
1197 (plugin_borrow_comp_cls_by_index_func_t
)
1198 bt_plugin_borrow_filter_component_class_by_index_const
,
1199 (spec_comp_cls_borrow_comp_cls_func_t
)
1200 bt_component_class_filter_as_component_class
);
1201 cmd_list_plugins_print_component_classes(plugin
, "Sink",
1202 bt_plugin_get_sink_component_class_count(plugin
),
1203 (plugin_borrow_comp_cls_by_index_func_t
)
1204 bt_plugin_borrow_sink_component_class_by_index_const
,
1205 (spec_comp_cls_borrow_comp_cls_func_t
)
1206 bt_component_class_sink_as_component_class
);
1214 int cmd_print_lttng_live_sessions(struct bt_config
*cfg
)
1217 const bt_component_class
*comp_cls
= NULL
;
1218 const bt_value
*results
= NULL
;
1219 bt_value
*params
= NULL
;
1220 const bt_value
*map
= NULL
;
1221 const bt_value
*v
= NULL
;
1222 static const char * const plugin_name
= "ctf";
1223 static const char * const comp_cls_name
= "lttng-live";
1224 static const bt_component_class_type comp_cls_type
=
1225 BT_COMPONENT_CLASS_TYPE_SOURCE
;
1226 int64_t array_size
, i
;
1227 const char *fail_reason
= NULL
;
1228 FILE *out_stream
= stdout
;
1230 BT_ASSERT(cfg
->cmd_data
.print_lttng_live_sessions
.url
);
1231 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1234 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
1235 "comp-cls-name=\"%s\", comp-cls-type=%d",
1236 plugin_name
, comp_cls_name
,
1237 BT_COMPONENT_CLASS_TYPE_SOURCE
);
1238 fprintf(stderr
, "%s%sCannot find component class %s",
1239 bt_common_color_bold(),
1240 bt_common_color_fg_red(),
1241 bt_common_color_reset());
1242 print_plugin_comp_cls_opt(stderr
, plugin_name
,
1243 comp_cls_name
, comp_cls_type
);
1244 fprintf(stderr
, "\n");
1248 params
= bt_value_map_create();
1253 ret
= bt_value_map_insert_string_entry(params
, "url",
1254 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
1259 ret
= query(cfg
, comp_cls
, "sessions", params
,
1260 &results
, &fail_reason
);
1267 if (!bt_value_is_array(results
)) {
1268 BT_LOGE_STR("Expecting an array for sessions query.");
1269 fprintf(stderr
, "%s%sUnexpected type returned by session query%s\n",
1270 bt_common_color_bold(),
1271 bt_common_color_fg_red(),
1272 bt_common_color_reset());
1276 if (cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->len
> 0) {
1278 fopen(cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
,
1282 BT_LOGE_ERRNO("Cannot open file for writing",
1284 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
1289 array_size
= bt_value_array_get_size(results
);
1290 for (i
= 0; i
< array_size
; i
++) {
1291 const char *url_text
;
1292 int64_t timer_us
, streams
, clients
;
1294 map
= bt_value_array_borrow_element_by_index_const(results
, i
);
1296 BT_LOGE_STR("Unexpected empty array entry.");
1299 if (!bt_value_is_map(map
)) {
1300 BT_LOGE_STR("Unexpected entry type.");
1304 v
= bt_value_map_borrow_entry_value_const(map
, "url");
1306 BT_LOGE_STR("Unexpected empty array \"url\" entry.");
1309 url_text
= bt_value_string_get(v
);
1310 fprintf(out_stream
, "%s", url_text
);
1311 v
= bt_value_map_borrow_entry_value_const(map
, "timer-us");
1313 BT_LOGE_STR("Unexpected empty array \"timer-us\" entry.");
1316 timer_us
= bt_value_signed_integer_get(v
);
1317 fprintf(out_stream
, " (timer = %" PRIu64
", ", timer_us
);
1318 v
= bt_value_map_borrow_entry_value_const(map
, "stream-count");
1320 BT_LOGE_STR("Unexpected empty array \"stream-count\" entry.");
1323 streams
= bt_value_signed_integer_get(v
);
1324 fprintf(out_stream
, "%" PRIu64
" stream(s), ", streams
);
1325 v
= bt_value_map_borrow_entry_value_const(map
, "client-count");
1327 BT_LOGE_STR("Unexpected empty array \"client-count\" entry.");
1330 clients
= bt_value_signed_integer_get(v
);
1331 fprintf(out_stream
, "%" PRIu64
" client(s) connected)\n", clients
);
1337 BT_LOGE("Failed to query for sessions: %s", fail_reason
);
1338 fprintf(stderr
, "%s%sFailed to request sessions: %s%s\n",
1339 bt_common_color_bold(),
1340 bt_common_color_fg_red(),
1342 bt_common_color_reset());
1348 bt_value_put_ref(results
);
1349 bt_value_put_ref(params
);
1350 bt_component_class_put_ref(comp_cls
);
1352 if (out_stream
&& out_stream
!= stdout
) {
1353 int fclose_ret
= fclose(out_stream
);
1356 BT_LOGE_ERRNO("Cannot close file stream",
1358 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
1366 int cmd_print_ctf_metadata(struct bt_config
*cfg
)
1369 const bt_component_class
*comp_cls
= NULL
;
1370 const bt_value
*results
= NULL
;
1371 bt_value
*params
= NULL
;
1372 const bt_value
*metadata_text_value
= NULL
;
1373 const char *metadata_text
= NULL
;
1374 static const char * const plugin_name
= "ctf";
1375 static const char * const comp_cls_name
= "fs";
1376 static const bt_component_class_type comp_cls_type
=
1377 BT_COMPONENT_CLASS_TYPE_SOURCE
;
1378 const char *fail_reason
= NULL
;
1379 FILE *out_stream
= stdout
;
1381 BT_ASSERT(cfg
->cmd_data
.print_ctf_metadata
.path
);
1382 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1385 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
1386 "comp-cls-name=\"%s\", comp-cls-type=%d",
1387 plugin_name
, comp_cls_name
,
1388 BT_COMPONENT_CLASS_TYPE_SOURCE
);
1389 fprintf(stderr
, "%s%sCannot find component class %s",
1390 bt_common_color_bold(),
1391 bt_common_color_fg_red(),
1392 bt_common_color_reset());
1393 print_plugin_comp_cls_opt(stderr
, plugin_name
,
1394 comp_cls_name
, comp_cls_type
);
1395 fprintf(stderr
, "\n");
1400 params
= bt_value_map_create();
1406 ret
= bt_value_map_insert_string_entry(params
, "path",
1407 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
1413 ret
= query(cfg
, comp_cls
, "metadata-info",
1414 params
, &results
, &fail_reason
);
1419 metadata_text_value
= bt_value_map_borrow_entry_value_const(results
,
1421 if (!metadata_text_value
) {
1422 BT_LOGE_STR("Cannot find `text` string value in the resulting metadata info object.");
1427 metadata_text
= bt_value_string_get(metadata_text_value
);
1429 if (cfg
->cmd_data
.print_ctf_metadata
.output_path
->len
> 0) {
1431 fopen(cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
,
1435 BT_LOGE_ERRNO("Cannot open file for writing",
1437 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1442 ret
= fprintf(out_stream
, "%s\n", metadata_text
);
1444 BT_LOGE("Cannot write whole metadata text to output stream: "
1455 BT_LOGE("Failed to query for metadata info: %s", fail_reason
);
1456 fprintf(stderr
, "%s%sFailed to request metadata info: %s%s\n",
1457 bt_common_color_bold(),
1458 bt_common_color_fg_red(),
1460 bt_common_color_reset());
1463 bt_value_put_ref(results
);
1464 bt_value_put_ref(params
);
1465 bt_component_class_put_ref(comp_cls
);
1467 if (out_stream
&& out_stream
!= stdout
) {
1468 int fclose_ret
= fclose(out_stream
);
1471 BT_LOGE_ERRNO("Cannot close file stream",
1473 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1481 char *instance_name
;
1485 struct trace_range
{
1486 uint64_t intersection_range_begin_ns
;
1487 uint64_t intersection_range_end_ns
;
1491 guint
port_id_hash(gconstpointer v
)
1493 const struct port_id
*id
= v
;
1495 BT_ASSERT(id
->instance_name
);
1496 BT_ASSERT(id
->port_name
);
1498 return g_str_hash(id
->instance_name
) ^ g_str_hash(id
->port_name
);
1502 gboolean
port_id_equal(gconstpointer v1
, gconstpointer v2
)
1504 const struct port_id
*id1
= v1
;
1505 const struct port_id
*id2
= v2
;
1507 return !strcmp(id1
->instance_name
, id2
->instance_name
) &&
1508 !strcmp(id1
->port_name
, id2
->port_name
);
1512 void port_id_destroy(gpointer data
)
1514 struct port_id
*id
= data
;
1516 free(id
->instance_name
);
1517 free(id
->port_name
);
1522 void trace_range_destroy(gpointer data
)
1527 struct cmd_run_ctx
{
1529 GHashTable
*src_components
;
1532 GHashTable
*flt_components
;
1535 GHashTable
*sink_components
;
1541 struct bt_config
*cfg
;
1545 bool stream_intersection_mode
;
1548 * Association of struct port_id -> struct trace_range.
1550 GHashTable
*intersections
;
1553 /* Returns a timestamp of the form "(-)s.ns" */
1555 char *s_from_ns(int64_t ns
)
1560 int64_t ts_sec_abs
, ts_nsec_abs
;
1561 int64_t ts_sec
= ns
/ NSEC_PER_SEC
;
1562 int64_t ts_nsec
= ns
% NSEC_PER_SEC
;
1564 if (ts_sec
>= 0 && ts_nsec
>= 0) {
1565 is_negative
= false;
1566 ts_sec_abs
= ts_sec
;
1567 ts_nsec_abs
= ts_nsec
;
1568 } else if (ts_sec
> 0 && ts_nsec
< 0) {
1569 is_negative
= false;
1570 ts_sec_abs
= ts_sec
- 1;
1571 ts_nsec_abs
= NSEC_PER_SEC
+ ts_nsec
;
1572 } else if (ts_sec
== 0 && ts_nsec
< 0) {
1574 ts_sec_abs
= ts_sec
;
1575 ts_nsec_abs
= -ts_nsec
;
1576 } else if (ts_sec
< 0 && ts_nsec
> 0) {
1578 ts_sec_abs
= -(ts_sec
+ 1);
1579 ts_nsec_abs
= NSEC_PER_SEC
- ts_nsec
;
1580 } else if (ts_sec
< 0 && ts_nsec
== 0) {
1582 ts_sec_abs
= -ts_sec
;
1583 ts_nsec_abs
= ts_nsec
;
1584 } else { /* (ts_sec < 0 && ts_nsec < 0) */
1586 ts_sec_abs
= -ts_sec
;
1587 ts_nsec_abs
= -ts_nsec
;
1590 ret
= asprintf(&s_ret
, "%s%" PRId64
".%09" PRId64
,
1591 is_negative
? "-" : "", ts_sec_abs
, ts_nsec_abs
);
1599 int cmd_run_ctx_connect_upstream_port_to_downstream_component(
1600 struct cmd_run_ctx
*ctx
,
1601 const bt_component
*upstream_comp
,
1602 const bt_port_output
*out_upstream_port
,
1603 struct bt_config_connection
*cfg_conn
)
1605 typedef uint64_t (*input_port_count_func_t
)(void *);
1606 typedef const bt_port_input
*(*borrow_input_port_by_index_func_t
)(
1607 const void *, uint64_t);
1608 const bt_port
*upstream_port
=
1609 bt_port_output_as_port_const(out_upstream_port
);
1612 GQuark downstreamp_comp_name_quark
;
1613 void *downstream_comp
;
1614 uint64_t downstream_port_count
;
1616 input_port_count_func_t port_count_fn
;
1617 borrow_input_port_by_index_func_t port_by_index_fn
;
1618 bt_graph_status status
= BT_GRAPH_STATUS_ERROR
;
1619 bool insert_trimmer
= false;
1620 bt_value
*trimmer_params
= NULL
;
1621 char *intersection_begin
= NULL
;
1622 char *intersection_end
= NULL
;
1623 const bt_component_filter
*trimmer
= NULL
;
1624 const bt_component_class_filter
*trimmer_class
= NULL
;
1625 const bt_port_input
*trimmer_input
= NULL
;
1626 const bt_port_output
*trimmer_output
= NULL
;
1628 if (ctx
->intersections
&&
1629 bt_component_get_class_type(upstream_comp
) ==
1630 BT_COMPONENT_CLASS_TYPE_SOURCE
) {
1631 struct trace_range
*range
;
1632 struct port_id port_id
= {
1633 .instance_name
= (char *) bt_component_get_name(upstream_comp
),
1634 .port_name
= (char *) bt_port_get_name(upstream_port
)
1637 if (!port_id
.instance_name
|| !port_id
.port_name
) {
1641 range
= (struct trace_range
*) g_hash_table_lookup(
1642 ctx
->intersections
, &port_id
);
1644 bt_value_status status
;
1646 intersection_begin
= s_from_ns(
1647 range
->intersection_range_begin_ns
);
1648 intersection_end
= s_from_ns(
1649 range
->intersection_range_end_ns
);
1650 if (!intersection_begin
|| !intersection_end
) {
1651 BT_LOGE_STR("Cannot create trimmer argument timestamp string.");
1655 insert_trimmer
= true;
1656 trimmer_params
= bt_value_map_create();
1657 if (!trimmer_params
) {
1661 status
= bt_value_map_insert_string_entry(
1662 trimmer_params
, "begin", intersection_begin
);
1663 if (status
!= BT_VALUE_STATUS_OK
) {
1666 status
= bt_value_map_insert_string_entry(
1668 "end", intersection_end
);
1669 if (status
!= BT_VALUE_STATUS_OK
) {
1674 trimmer_class
= find_filter_component_class("utils", "trimmer");
1675 if (!trimmer_class
) {
1680 BT_LOGI("Connecting upstream port to the next available downstream port: "
1681 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1682 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1683 upstream_port
, bt_port_get_name(upstream_port
),
1684 cfg_conn
->downstream_comp_name
->str
,
1685 cfg_conn
->arg
->str
);
1686 downstreamp_comp_name_quark
= g_quark_from_string(
1687 cfg_conn
->downstream_comp_name
->str
);
1688 BT_ASSERT(downstreamp_comp_name_quark
> 0);
1689 downstream_comp
= g_hash_table_lookup(ctx
->flt_components
,
1690 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1691 port_count_fn
= (input_port_count_func_t
)
1692 bt_component_filter_get_input_port_count
;
1693 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1694 bt_component_filter_borrow_input_port_by_index_const
;
1696 if (!downstream_comp
) {
1697 downstream_comp
= g_hash_table_lookup(ctx
->sink_components
,
1698 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1699 port_count_fn
= (input_port_count_func_t
)
1700 bt_component_sink_get_input_port_count
;
1701 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1702 bt_component_sink_borrow_input_port_by_index_const
;
1705 if (!downstream_comp
) {
1706 BT_LOGE("Cannot find downstream component: comp-name=\"%s\", "
1707 "conn-arg=\"%s\"", cfg_conn
->downstream_comp_name
->str
,
1708 cfg_conn
->arg
->str
);
1709 fprintf(stderr
, "Cannot create connection: cannot find downstream component: %s\n",
1710 cfg_conn
->arg
->str
);
1714 downstream_port_count
= port_count_fn(downstream_comp
);
1716 for (i
= 0; i
< downstream_port_count
; i
++) {
1717 const bt_port_input
*in_downstream_port
=
1718 port_by_index_fn(downstream_comp
, i
);
1719 const bt_port
*downstream_port
=
1720 bt_port_input_as_port_const(in_downstream_port
);
1721 const char *upstream_port_name
;
1722 const char *downstream_port_name
;
1724 BT_ASSERT(downstream_port
);
1726 /* Skip port if it's already connected. */
1727 if (bt_port_is_connected(downstream_port
)) {
1728 BT_LOGI("Skipping downstream port: already connected: "
1729 "port-addr=%p, port-name=\"%s\"",
1731 bt_port_get_name(downstream_port
));
1735 downstream_port_name
= bt_port_get_name(downstream_port
);
1736 BT_ASSERT(downstream_port_name
);
1737 upstream_port_name
= bt_port_get_name(upstream_port
);
1738 BT_ASSERT(upstream_port_name
);
1740 if (!bt_common_star_glob_match(
1741 cfg_conn
->downstream_port_glob
->str
, SIZE_MAX
,
1742 downstream_port_name
, SIZE_MAX
)) {
1746 if (insert_trimmer
) {
1748 * In order to insert the trimmer between the
1749 * two components that were being connected, we
1750 * create a connection configuration entry which
1751 * describes a connection from the trimmer's
1752 * output to the original input that was being
1755 * Hence, the creation of the trimmer will cause
1756 * the graph "new port" listener to establish
1757 * all downstream connections as its output port
1758 * is connected. We will then establish the
1759 * connection between the original upstream
1760 * source and the trimmer.
1762 char *trimmer_name
= NULL
;
1763 bt_graph_status graph_status
;
1765 ret
= asprintf(&trimmer_name
,
1766 "stream-intersection-trimmer-%s",
1767 upstream_port_name
);
1773 ctx
->connect_ports
= false;
1774 graph_status
= bt_graph_add_filter_component(
1775 ctx
->graph
, trimmer_class
, trimmer_name
,
1776 trimmer_params
, ctx
->cfg
->log_level
,
1779 if (graph_status
!= BT_GRAPH_STATUS_OK
) {
1785 bt_component_filter_borrow_input_port_by_index_const(
1787 if (!trimmer_input
) {
1791 bt_component_filter_borrow_output_port_by_index_const(
1793 if (!trimmer_output
) {
1798 * Replace the current downstream port by the trimmer's
1801 in_downstream_port
= trimmer_input
;
1803 bt_port_input_as_port_const(in_downstream_port
);
1804 downstream_port_name
= bt_port_get_name(
1806 BT_ASSERT(downstream_port_name
);
1809 /* We have a winner! */
1810 status
= bt_graph_connect_ports(ctx
->graph
,
1811 out_upstream_port
, in_downstream_port
, NULL
);
1812 downstream_port
= NULL
;
1814 case BT_GRAPH_STATUS_OK
:
1816 case BT_GRAPH_STATUS_CANCELED
:
1817 BT_LOGI_STR("Graph was canceled by user.");
1818 status
= BT_GRAPH_STATUS_OK
;
1820 case BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION
:
1821 BT_LOGE("A component refused a connection to one of its ports: "
1822 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1823 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1824 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1825 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1827 upstream_comp
, bt_component_get_name(upstream_comp
),
1828 upstream_port
, bt_port_get_name(upstream_port
),
1829 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1830 downstream_port
, downstream_port_name
,
1831 cfg_conn
->arg
->str
);
1833 "A component refused a connection to one of its ports (`%s` to `%s`): %s\n",
1834 bt_port_get_name(upstream_port
),
1835 downstream_port_name
,
1836 cfg_conn
->arg
->str
);
1839 BT_LOGE("Cannot create connection: graph refuses to connect ports: "
1840 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1841 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1842 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1843 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1845 upstream_comp
, bt_component_get_name(upstream_comp
),
1846 upstream_port
, bt_port_get_name(upstream_port
),
1847 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1848 downstream_port
, downstream_port_name
,
1849 cfg_conn
->arg
->str
);
1851 "Cannot create connection: graph refuses to connect ports (`%s` to `%s`): %s\n",
1852 bt_port_get_name(upstream_port
),
1853 downstream_port_name
,
1854 cfg_conn
->arg
->str
);
1858 BT_LOGI("Connected component ports: "
1859 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1860 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1861 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1862 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1864 upstream_comp
, bt_component_get_name(upstream_comp
),
1865 upstream_port
, bt_port_get_name(upstream_port
),
1866 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1867 downstream_port
, downstream_port_name
,
1868 cfg_conn
->arg
->str
);
1870 if (insert_trimmer
) {
1872 * The first connection, from the source to the trimmer,
1873 * has been done. We now connect the trimmer to the
1874 * original downstream port.
1876 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1878 bt_component_filter_as_component_const(trimmer
),
1879 trimmer_output
, cfg_conn
);
1883 ctx
->connect_ports
= true;
1887 * We found a matching downstream port: the search is
1893 /* No downstream port found */
1894 BT_LOGE("Cannot create connection: cannot find a matching downstream port for upstream port: "
1895 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1896 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1897 upstream_port
, bt_port_get_name(upstream_port
),
1898 cfg_conn
->downstream_comp_name
->str
,
1899 cfg_conn
->arg
->str
);
1901 "Cannot create connection: cannot find a matching downstream port for upstream port `%s`: %s\n",
1902 bt_port_get_name(upstream_port
), cfg_conn
->arg
->str
);
1908 free(intersection_begin
);
1909 free(intersection_end
);
1910 BT_VALUE_PUT_REF_AND_RESET(trimmer_params
);
1911 BT_COMPONENT_CLASS_FILTER_PUT_REF_AND_RESET(trimmer_class
);
1912 BT_COMPONENT_FILTER_PUT_REF_AND_RESET(trimmer
);
1917 int cmd_run_ctx_connect_upstream_port(struct cmd_run_ctx
*ctx
,
1918 const bt_port_output
*upstream_port
)
1921 const char *upstream_port_name
;
1922 const char *upstream_comp_name
;
1923 const bt_component
*upstream_comp
= NULL
;
1927 BT_ASSERT(upstream_port
);
1928 upstream_port_name
= bt_port_get_name(
1929 bt_port_output_as_port_const(upstream_port
));
1930 BT_ASSERT(upstream_port_name
);
1931 upstream_comp
= bt_port_borrow_component_const(
1932 bt_port_output_as_port_const(upstream_port
));
1933 if (!upstream_comp
) {
1934 BT_LOGW("Upstream port to connect is not part of a component: "
1935 "port-addr=%p, port-name=\"%s\"",
1936 upstream_port
, upstream_port_name
);
1941 upstream_comp_name
= bt_component_get_name(upstream_comp
);
1942 BT_ASSERT(upstream_comp_name
);
1943 BT_LOGI("Connecting upstream port: comp-addr=%p, comp-name=\"%s\", "
1944 "port-addr=%p, port-name=\"%s\"",
1945 upstream_comp
, upstream_comp_name
,
1946 upstream_port
, upstream_port_name
);
1948 for (i
= 0; i
< ctx
->cfg
->cmd_data
.run
.connections
->len
; i
++) {
1949 struct bt_config_connection
*cfg_conn
=
1951 ctx
->cfg
->cmd_data
.run
.connections
, i
);
1953 if (strcmp(cfg_conn
->upstream_comp_name
->str
,
1954 upstream_comp_name
)) {
1958 if (!bt_common_star_glob_match(
1959 cfg_conn
->upstream_port_glob
->str
,
1960 SIZE_MAX
, upstream_port_name
, SIZE_MAX
)) {
1964 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1965 ctx
, upstream_comp
, upstream_port
, cfg_conn
);
1967 BT_LOGE("Cannot connect upstream port: "
1968 "port-addr=%p, port-name=\"%s\"",
1970 upstream_port_name
);
1972 "Cannot connect port `%s` of component `%s` to a downstream port: %s\n",
1975 cfg_conn
->arg
->str
);
1981 BT_LOGE("Cannot connect upstream port: port does not match any connection argument: "
1982 "port-addr=%p, port-name=\"%s\"", upstream_port
,
1983 upstream_port_name
);
1985 "Cannot create connection: upstream port `%s` does not match any connection\n",
1986 upstream_port_name
);
1996 bt_graph_listener_status
1997 graph_output_port_added_listener(struct cmd_run_ctx
*ctx
,
1998 const bt_port_output
*out_port
)
2000 const bt_component
*comp
;
2001 const bt_port
*port
= bt_port_output_as_port_const(out_port
);
2002 bt_graph_listener_status ret
= BT_GRAPH_LISTENER_STATUS_OK
;
2004 comp
= bt_port_borrow_component_const(port
);
2005 BT_LOGI("Port added to a graph's component: comp-addr=%p, "
2006 "comp-name=\"%s\", port-addr=%p, port-name=\"%s\"",
2007 comp
, comp
? bt_component_get_name(comp
) : "",
2008 port
, bt_port_get_name(port
));
2010 if (!ctx
->connect_ports
) {
2015 BT_LOGW_STR("Port has no component.");
2019 if (bt_port_is_connected(port
)) {
2020 BT_LOGW_STR("Port is already connected.");
2024 if (cmd_run_ctx_connect_upstream_port(ctx
, out_port
)) {
2025 BT_LOGF_STR("Cannot connect upstream port.");
2026 fprintf(stderr
, "Added port could not be connected: aborting\n");
2027 ret
= BT_GRAPH_LISTENER_STATUS_ERROR
;
2036 bt_graph_listener_status
graph_source_output_port_added_listener(
2037 const bt_component_source
*component
,
2038 const bt_port_output
*port
, void *data
)
2040 return graph_output_port_added_listener(data
, port
);
2044 bt_graph_listener_status
graph_filter_output_port_added_listener(
2045 const bt_component_filter
*component
,
2046 const bt_port_output
*port
, void *data
)
2048 return graph_output_port_added_listener(data
, port
);
2052 void cmd_run_ctx_destroy(struct cmd_run_ctx
*ctx
)
2058 if (ctx
->src_components
) {
2059 g_hash_table_destroy(ctx
->src_components
);
2060 ctx
->src_components
= NULL
;
2063 if (ctx
->flt_components
) {
2064 g_hash_table_destroy(ctx
->flt_components
);
2065 ctx
->flt_components
= NULL
;
2068 if (ctx
->sink_components
) {
2069 g_hash_table_destroy(ctx
->sink_components
);
2070 ctx
->sink_components
= NULL
;
2073 if (ctx
->intersections
) {
2074 g_hash_table_destroy(ctx
->intersections
);
2075 ctx
->intersections
= NULL
;
2078 BT_GRAPH_PUT_REF_AND_RESET(ctx
->graph
);
2084 int cmd_run_ctx_init(struct cmd_run_ctx
*ctx
, struct bt_config
*cfg
)
2087 bt_graph_status status
;
2090 ctx
->connect_ports
= false;
2091 ctx
->src_components
= g_hash_table_new_full(g_direct_hash
,
2092 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
2093 if (!ctx
->src_components
) {
2097 ctx
->flt_components
= g_hash_table_new_full(g_direct_hash
,
2098 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
2099 if (!ctx
->flt_components
) {
2103 ctx
->sink_components
= g_hash_table_new_full(g_direct_hash
,
2104 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
2105 if (!ctx
->sink_components
) {
2109 if (cfg
->cmd_data
.run
.stream_intersection_mode
) {
2110 ctx
->stream_intersection_mode
= true;
2111 ctx
->intersections
= g_hash_table_new_full(port_id_hash
,
2112 port_id_equal
, port_id_destroy
, trace_range_destroy
);
2113 if (!ctx
->intersections
) {
2118 ctx
->graph
= bt_graph_create();
2123 the_graph
= ctx
->graph
;
2124 status
= bt_graph_add_source_component_output_port_added_listener(
2125 ctx
->graph
, graph_source_output_port_added_listener
, NULL
, ctx
,
2127 if (status
!= BT_GRAPH_STATUS_OK
) {
2128 BT_LOGE_STR("Cannot add \"port added\" listener to graph.");
2132 status
= bt_graph_add_filter_component_output_port_added_listener(
2133 ctx
->graph
, graph_filter_output_port_added_listener
, NULL
, ctx
,
2135 if (status
!= BT_GRAPH_STATUS_OK
) {
2136 BT_LOGE_STR("Cannot add \"port added\" listener to graph.");
2143 cmd_run_ctx_destroy(ctx
);
2151 int set_stream_intersections(struct cmd_run_ctx
*ctx
,
2152 struct bt_config_component
*cfg_comp
,
2153 const bt_component_class_source
*src_comp_cls
)
2157 int64_t trace_count
;
2158 const char *path
= NULL
;
2159 const bt_value
*query_result
= NULL
;
2160 const bt_value
*trace_info
= NULL
;
2161 const bt_value
*intersection_range
= NULL
;
2162 const bt_value
*intersection_begin
= NULL
;
2163 const bt_value
*intersection_end
= NULL
;
2164 const bt_value
*stream_infos
= NULL
;
2165 const bt_value
*stream_info
= NULL
;
2166 struct port_id
*port_id
= NULL
;
2167 struct trace_range
*trace_range
= NULL
;
2168 const char *fail_reason
= NULL
;
2169 const bt_component_class
*comp_cls
=
2170 bt_component_class_source_as_component_class_const(src_comp_cls
);
2172 ret
= query(ctx
->cfg
, comp_cls
, "trace-info",
2173 cfg_comp
->params
, &query_result
,
2176 BT_LOGD("Component class does not support the `trace-info` query: %s: "
2177 "comp-class-name=\"%s\"", fail_reason
,
2178 bt_component_class_get_name(comp_cls
));
2183 BT_ASSERT(query_result
);
2185 if (!bt_value_is_array(query_result
)) {
2186 BT_LOGD("Unexpected format of \'trace-info\' query result: "
2187 "component-class-name=%s",
2188 bt_component_class_get_name(comp_cls
));
2193 trace_count
= bt_value_array_get_size(query_result
);
2194 if (trace_count
< 0) {
2199 for (trace_idx
= 0; trace_idx
< trace_count
; trace_idx
++) {
2201 uint64_t stream_idx
;
2202 int64_t stream_count
;
2204 trace_info
= bt_value_array_borrow_element_by_index_const(
2205 query_result
, trace_idx
);
2206 if (!trace_info
|| !bt_value_is_map(trace_info
)) {
2208 BT_LOGD_STR("Cannot retrieve trace from query result.");
2212 intersection_range
= bt_value_map_borrow_entry_value_const(
2213 trace_info
, "intersection-range-ns");
2214 if (!intersection_range
) {
2216 BT_LOGD_STR("Cannot retrieve \'intersetion-range-ns\' field from query result.");
2220 intersection_begin
= bt_value_map_borrow_entry_value_const(intersection_range
,
2222 if (!intersection_begin
) {
2224 BT_LOGD_STR("Cannot retrieve intersection-range-ns \'begin\' field from query result.");
2228 intersection_end
= bt_value_map_borrow_entry_value_const(intersection_range
,
2230 if (!intersection_end
) {
2232 BT_LOGD_STR("Cannot retrieve intersection-range-ns \'end\' field from query result.");
2236 begin
= bt_value_signed_integer_get(intersection_begin
);
2237 end
= bt_value_signed_integer_get(intersection_end
);
2239 if (begin
< 0 || end
< 0 || end
< begin
) {
2240 BT_LOGW("Invalid trace stream intersection values: "
2241 "intersection-range-ns:begin=%" PRId64
2242 ", intersection-range-ns:end=%" PRId64
,
2248 stream_infos
= bt_value_map_borrow_entry_value_const(trace_info
,
2250 if (!stream_infos
|| !bt_value_is_array(stream_infos
)) {
2252 BT_LOGD_STR("Cannot retrieve stream information from trace in query result.");
2256 stream_count
= bt_value_array_get_size(stream_infos
);
2257 if (stream_count
< 0) {
2262 for (stream_idx
= 0; stream_idx
< stream_count
; stream_idx
++) {
2263 const bt_value
*port_name
;
2265 port_id
= g_new0(struct port_id
, 1);
2268 BT_LOGE_STR("Cannot allocate memory for port_id structure.");
2271 port_id
->instance_name
= strdup(cfg_comp
->instance_name
->str
);
2272 if (!port_id
->instance_name
) {
2274 BT_LOGE_STR("Cannot allocate memory for port_id component instance name.");
2278 trace_range
= g_new0(struct trace_range
, 1);
2281 BT_LOGE_STR("Cannot allocate memory for trace_range structure.");
2284 trace_range
->intersection_range_begin_ns
= begin
;
2285 trace_range
->intersection_range_end_ns
= end
;
2287 stream_info
= bt_value_array_borrow_element_by_index_const(
2288 stream_infos
, stream_idx
);
2289 if (!stream_info
|| !bt_value_is_map(stream_info
)) {
2291 BT_LOGE_STR("Cannot retrieve stream informations from trace in query result.");
2295 port_name
= bt_value_map_borrow_entry_value_const(stream_info
, "port-name");
2296 if (!port_name
|| !bt_value_is_string(port_name
)) {
2298 BT_LOGE_STR("Cannot retrieve port name in query result.");
2302 port_id
->port_name
= g_strdup(bt_value_string_get(port_name
));
2303 if (!port_id
->port_name
) {
2305 BT_LOGE_STR("Cannot allocate memory for port_id port_name.");
2309 BT_LOGD("Inserting stream intersection ");
2311 g_hash_table_insert(ctx
->intersections
, port_id
, trace_range
);
2321 fprintf(stderr
, "%s%sCannot determine stream intersection of trace at path \'%s\'.%s\n",
2322 bt_common_color_bold(),
2323 bt_common_color_fg_yellow(),
2324 path
? path
: "(unknown)",
2325 bt_common_color_reset());
2327 bt_value_put_ref(query_result
);
2329 g_free(trace_range
);
2334 int cmd_run_ctx_create_components_from_config_components(
2335 struct cmd_run_ctx
*ctx
, GPtrArray
*cfg_components
)
2338 const void *comp_cls
= NULL
;
2339 const void *comp
= NULL
;
2342 for (i
= 0; i
< cfg_components
->len
; i
++) {
2343 struct bt_config_component
*cfg_comp
=
2344 g_ptr_array_index(cfg_components
, i
);
2347 switch (cfg_comp
->type
) {
2348 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2349 comp_cls
= find_source_component_class(
2350 cfg_comp
->plugin_name
->str
,
2351 cfg_comp
->comp_cls_name
->str
);
2353 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2354 comp_cls
= find_filter_component_class(
2355 cfg_comp
->plugin_name
->str
,
2356 cfg_comp
->comp_cls_name
->str
);
2358 case BT_COMPONENT_CLASS_TYPE_SINK
:
2359 comp_cls
= find_sink_component_class(
2360 cfg_comp
->plugin_name
->str
,
2361 cfg_comp
->comp_cls_name
->str
);
2368 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
2369 "comp-cls-name=\"%s\", comp-cls-type=%d",
2370 cfg_comp
->plugin_name
->str
,
2371 cfg_comp
->comp_cls_name
->str
,
2373 fprintf(stderr
, "%s%sCannot find component class %s",
2374 bt_common_color_bold(),
2375 bt_common_color_fg_red(),
2376 bt_common_color_reset());
2377 print_plugin_comp_cls_opt(stderr
,
2378 cfg_comp
->plugin_name
->str
,
2379 cfg_comp
->comp_cls_name
->str
,
2381 fprintf(stderr
, "\n");
2385 BT_ASSERT(cfg_comp
->log_level
>= BT_LOG_VERBOSE
);
2387 switch (cfg_comp
->type
) {
2388 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2389 ret
= bt_graph_add_source_component(ctx
->graph
,
2390 comp_cls
, cfg_comp
->instance_name
->str
,
2391 cfg_comp
->params
, cfg_comp
->log_level
,
2394 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2395 ret
= bt_graph_add_filter_component(ctx
->graph
,
2396 comp_cls
, cfg_comp
->instance_name
->str
,
2397 cfg_comp
->params
, cfg_comp
->log_level
,
2400 case BT_COMPONENT_CLASS_TYPE_SINK
:
2401 ret
= bt_graph_add_sink_component(ctx
->graph
,
2402 comp_cls
, cfg_comp
->instance_name
->str
,
2403 cfg_comp
->params
, cfg_comp
->log_level
,
2411 BT_LOGE("Cannot create component: plugin-name=\"%s\", "
2412 "comp-cls-name=\"%s\", comp-cls-type=%d, "
2414 cfg_comp
->plugin_name
->str
,
2415 cfg_comp
->comp_cls_name
->str
,
2416 cfg_comp
->type
, cfg_comp
->instance_name
->str
);
2417 fprintf(stderr
, "%s%sCannot create component `%s`%s\n",
2418 bt_common_color_bold(),
2419 bt_common_color_fg_red(),
2420 cfg_comp
->instance_name
->str
,
2421 bt_common_color_reset());
2425 if (ctx
->stream_intersection_mode
&&
2426 cfg_comp
->type
== BT_COMPONENT_CLASS_TYPE_SOURCE
) {
2427 ret
= set_stream_intersections(ctx
, cfg_comp
, comp_cls
);
2433 BT_LOGI("Created and inserted component: comp-addr=%p, comp-name=\"%s\"",
2434 comp
, cfg_comp
->instance_name
->str
);
2435 quark
= g_quark_from_string(cfg_comp
->instance_name
->str
);
2436 BT_ASSERT(quark
> 0);
2438 switch (cfg_comp
->type
) {
2439 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2440 g_hash_table_insert(ctx
->src_components
,
2441 GUINT_TO_POINTER(quark
), (void *) comp
);
2443 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2444 g_hash_table_insert(ctx
->flt_components
,
2445 GUINT_TO_POINTER(quark
), (void *) comp
);
2447 case BT_COMPONENT_CLASS_TYPE_SINK
:
2448 g_hash_table_insert(ctx
->sink_components
,
2449 GUINT_TO_POINTER(quark
), (void *) comp
);
2456 BT_OBJECT_PUT_REF_AND_RESET(comp_cls
);
2465 bt_object_put_ref(comp
);
2466 bt_object_put_ref(comp_cls
);
2471 int cmd_run_ctx_create_components(struct cmd_run_ctx
*ctx
)
2476 * Make sure that, during this phase, our graph's "port added"
2477 * listener does not connect ports while we are creating the
2478 * components because we have a special, initial phase for
2481 ctx
->connect_ports
= false;
2483 ret
= cmd_run_ctx_create_components_from_config_components(
2484 ctx
, ctx
->cfg
->cmd_data
.run
.sources
);
2490 ret
= cmd_run_ctx_create_components_from_config_components(
2491 ctx
, ctx
->cfg
->cmd_data
.run
.filters
);
2497 ret
= cmd_run_ctx_create_components_from_config_components(
2498 ctx
, ctx
->cfg
->cmd_data
.run
.sinks
);
2508 typedef uint64_t (*output_port_count_func_t
)(const void *);
2509 typedef const bt_port_output
*(*borrow_output_port_by_index_func_t
)(
2510 const void *, uint64_t);
2513 int cmd_run_ctx_connect_comp_ports(struct cmd_run_ctx
*ctx
,
2514 void *comp
, output_port_count_func_t port_count_fn
,
2515 borrow_output_port_by_index_func_t port_by_index_fn
)
2521 count
= port_count_fn(comp
);
2523 for (i
= 0; i
< count
; i
++) {
2524 const bt_port_output
*upstream_port
= port_by_index_fn(comp
, i
);
2526 BT_ASSERT(upstream_port
);
2527 ret
= cmd_run_ctx_connect_upstream_port(ctx
, upstream_port
);
2538 int cmd_run_ctx_connect_ports(struct cmd_run_ctx
*ctx
)
2541 GHashTableIter iter
;
2542 gpointer g_name_quark
, g_comp
;
2544 ctx
->connect_ports
= true;
2545 g_hash_table_iter_init(&iter
, ctx
->src_components
);
2547 while (g_hash_table_iter_next(&iter
, &g_name_quark
, &g_comp
)) {
2548 ret
= cmd_run_ctx_connect_comp_ports(ctx
, g_comp
,
2549 (output_port_count_func_t
)
2550 bt_component_source_get_output_port_count
,
2551 (borrow_output_port_by_index_func_t
)
2552 bt_component_source_borrow_output_port_by_index_const
);
2558 g_hash_table_iter_init(&iter
, ctx
->flt_components
);
2560 while (g_hash_table_iter_next(&iter
, &g_name_quark
, &g_comp
)) {
2561 ret
= cmd_run_ctx_connect_comp_ports(ctx
, g_comp
,
2562 (output_port_count_func_t
)
2563 bt_component_filter_get_output_port_count
,
2564 (borrow_output_port_by_index_func_t
)
2565 bt_component_filter_borrow_output_port_by_index_const
);
2576 const char *bt_graph_status_str(bt_graph_status status
)
2579 case BT_GRAPH_STATUS_OK
:
2580 return "BT_GRAPH_STATUS_OK";
2581 case BT_GRAPH_STATUS_END
:
2582 return "BT_GRAPH_STATUS_END";
2583 case BT_GRAPH_STATUS_AGAIN
:
2584 return "BT_GRAPH_STATUS_AGAIN";
2585 case BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION
:
2586 return "BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION";
2587 case BT_GRAPH_STATUS_CANCELED
:
2588 return "BT_GRAPH_STATUS_CANCELED";
2589 case BT_GRAPH_STATUS_ERROR
:
2590 return "BT_GRAPH_STATUS_ERROR";
2591 case BT_GRAPH_STATUS_NOMEM
:
2592 return "BT_GRAPH_STATUS_NOMEM";
2599 int cmd_run(struct bt_config
*cfg
)
2602 struct cmd_run_ctx ctx
= { 0 };
2604 /* Initialize the command's context and the graph object */
2605 if (cmd_run_ctx_init(&ctx
, cfg
)) {
2606 BT_LOGE_STR("Cannot initialize the command's context.");
2607 fprintf(stderr
, "Cannot initialize the command's context\n");
2612 BT_LOGI_STR("Canceled by user before creating components.");
2616 BT_LOGI_STR("Creating components.");
2618 /* Create the requested component instances */
2619 if (cmd_run_ctx_create_components(&ctx
)) {
2620 BT_LOGE_STR("Cannot create components.");
2621 fprintf(stderr
, "Cannot create components\n");
2626 BT_LOGI_STR("Canceled by user before connecting components.");
2630 BT_LOGI_STR("Connecting components.");
2632 /* Connect the initially visible component ports */
2633 if (cmd_run_ctx_connect_ports(&ctx
)) {
2634 BT_LOGE_STR("Cannot connect initial component ports.");
2635 fprintf(stderr
, "Cannot connect initial component ports\n");
2640 BT_LOGI_STR("Canceled by user before running the graph.");
2644 BT_LOGI_STR("Running the graph.");
2648 bt_graph_status graph_status
= bt_graph_run(ctx
.graph
);
2651 * Reset console in case something messed with console
2652 * codes during the graph's execution.
2654 printf("%s", bt_common_color_reset());
2656 fprintf(stderr
, "%s", bt_common_color_reset());
2657 BT_LOGV("bt_graph_run() returned: status=%s",
2658 bt_graph_status_str(graph_status
));
2660 switch (graph_status
) {
2661 case BT_GRAPH_STATUS_OK
:
2663 case BT_GRAPH_STATUS_CANCELED
:
2664 BT_LOGI_STR("Graph was canceled by user.");
2666 case BT_GRAPH_STATUS_AGAIN
:
2667 if (bt_graph_is_canceled(ctx
.graph
)) {
2668 BT_LOGI_STR("Graph was canceled by user.");
2672 if (cfg
->cmd_data
.run
.retry_duration_us
> 0) {
2673 BT_LOGV("Got BT_GRAPH_STATUS_AGAIN: sleeping: "
2675 cfg
->cmd_data
.run
.retry_duration_us
);
2677 if (usleep(cfg
->cmd_data
.run
.retry_duration_us
)) {
2678 if (bt_graph_is_canceled(ctx
.graph
)) {
2679 BT_LOGI_STR("Graph was canceled by user.");
2685 case BT_GRAPH_STATUS_END
:
2688 BT_LOGE_STR("Graph failed to complete successfully");
2689 fprintf(stderr
, "Graph failed to complete successfully\n");
2702 cmd_run_ctx_destroy(&ctx
);
2707 void warn_command_name_and_directory_clash(struct bt_config
*cfg
)
2709 const char *env_clash
;
2711 if (!cfg
->command_name
) {
2715 env_clash
= getenv(ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH
);
2716 if (env_clash
&& strcmp(env_clash
, "0") == 0) {
2720 if (g_file_test(cfg
->command_name
,
2721 G_FILE_TEST_EXISTS
| G_FILE_TEST_IS_DIR
)) {
2722 fprintf(stderr
, "\nNOTE: The `%s` command was executed. If you meant to convert a\n",
2724 fprintf(stderr
, "trace located in the local `%s` directory, please use:\n",
2726 fprintf(stderr
, "\n");
2727 fprintf(stderr
, " babeltrace2 convert %s [OPTIONS]\n",
2733 void init_log_level(void)
2735 bt_cli_log_level
= bt_log_get_level_from_env(ENV_BABELTRACE_CLI_LOG_LEVEL
);
2739 void set_auto_log_levels(struct bt_config
*cfg
)
2741 const char **env_var_name
;
2744 * Override the configuration's default log level if
2745 * BABELTRACE_VERBOSE or BABELTRACE_DEBUG environment variables
2746 * are found for backward compatibility with legacy Babetrace 1.
2748 if (getenv("BABELTRACE_DEBUG") &&
2749 strcmp(getenv("BABELTRACE_DEBUG"), "1") == 0) {
2750 cfg
->log_level
= BT_LOG_VERBOSE
;
2751 } else if (getenv("BABELTRACE_VERBOSE") &&
2752 strcmp(getenv("BABELTRACE_VERBOSE"), "1") == 0) {
2753 cfg
->log_level
= BT_LOG_INFO
;
2757 * Set log levels according to --debug or --verbose. For
2758 * backward compatibility, --debug is more verbose than
2761 * --verbose: INFO log level
2762 * --debug: VERBOSE log level (includes DEBUG, which is
2763 * is less verbose than VERBOSE in the internal
2764 * logging framework)
2766 if (!getenv("BABELTRACE_LOGGING_GLOBAL_LEVEL")) {
2768 bt_logging_set_global_level(BT_LOG_INFO
);
2769 } else if (cfg
->debug
) {
2770 bt_logging_set_global_level(BT_LOG_VERBOSE
);
2773 * Set library's default log level if not
2774 * explicitly specified.
2776 bt_logging_set_global_level(cfg
->log_level
);
2780 if (!getenv(ENV_BABELTRACE_CLI_LOG_LEVEL
)) {
2782 bt_cli_log_level
= BT_LOG_INFO
;
2783 } else if (cfg
->debug
) {
2784 bt_cli_log_level
= BT_LOG_VERBOSE
;
2787 * Set CLI's default log level if not explicitly
2790 bt_cli_log_level
= cfg
->log_level
;
2794 env_var_name
= log_level_env_var_names
;
2796 while (*env_var_name
) {
2797 if (!getenv(*env_var_name
)) {
2799 g_setenv(*env_var_name
, "I", 1);
2800 } else if (cfg
->debug
) {
2801 g_setenv(*env_var_name
, "V", 1);
2803 char val
[2] = { 0 };
2806 * Set module's default log level if not
2807 * explicitly specified.
2809 val
[0] = bt_log_get_letter_from_level(
2811 g_setenv(*env_var_name
, val
, 1);
2819 int main(int argc
, const char **argv
)
2823 struct bt_config
*cfg
;
2826 set_signal_handler();
2828 cfg
= bt_config_cli_args_create_with_default(argc
, argv
, &retcode
);
2831 /* Quit without errors; typically usage/version */
2833 BT_LOGI_STR("Quitting without errors.");
2838 BT_LOGE("Command-line error: retcode=%d", retcode
);
2843 BT_LOGE_STR("Failed to create a valid Babeltrace configuration.");
2844 fprintf(stderr
, "Failed to create Babeltrace configuration\n");
2849 set_auto_log_levels(cfg
);
2852 if (cfg
->command_needs_plugins
) {
2853 ret
= load_all_plugins(cfg
->plugin_paths
);
2855 BT_LOGE("Failed to load plugins: ret=%d", ret
);
2861 BT_LOGI("Executing command: cmd=%d, command-name=\"%s\"",
2862 cfg
->command
, cfg
->command_name
);
2864 switch (cfg
->command
) {
2865 case BT_CONFIG_COMMAND_RUN
:
2868 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
2869 ret
= cmd_list_plugins(cfg
);
2871 case BT_CONFIG_COMMAND_HELP
:
2872 ret
= cmd_help(cfg
);
2874 case BT_CONFIG_COMMAND_QUERY
:
2875 ret
= cmd_query(cfg
);
2877 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
2878 ret
= cmd_print_ctf_metadata(cfg
);
2880 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
2881 ret
= cmd_print_lttng_live_sessions(cfg
);
2884 BT_LOGF("Invalid/unknown command: cmd=%d", cfg
->command
);
2888 BT_LOGI("Command completed: cmd=%d, command-name=\"%s\", ret=%d",
2889 cfg
->command
, cfg
->command_name
, ret
);
2890 warn_command_name_and_directory_clash(cfg
);
2891 retcode
= ret
? 1 : 0;
2894 BT_OBJECT_PUT_REF_AND_RESET(cfg
);