2 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
4 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25 #define BT_LOG_TAG "CLI"
28 #include <babeltrace2/babeltrace.h>
29 #include "common/common.h"
39 #include "babeltrace2-cfg.h"
40 #include "babeltrace2-cfg-cli-args.h"
41 #include "babeltrace2-cfg-cli-args-default.h"
43 #define ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH "BABELTRACE_CLI_WARN_COMMAND_NAME_DIRECTORY_CLASH"
44 #define ENV_BABELTRACE_CLI_LOG_LEVEL "BABELTRACE_CLI_LOG_LEVEL"
45 #define NSEC_PER_SEC 1000000000LL
48 * Known environment variable names for the log levels of the project's
51 static const char* log_level_env_var_names
[] = {
52 "BABELTRACE_PLUGIN_CTF_METADATA_LOG_LEVEL",
53 "BABELTRACE_PYTHON_BT2_LOG_LEVEL",
57 /* Application's processing graph (weak) */
58 static bt_graph
*the_graph
;
59 static bt_query_executor
*the_query_executor
;
60 static bool canceled
= false;
62 GPtrArray
*loaded_plugins
;
69 BOOL WINAPI
signal_handler(DWORD signal
) {
71 bt_graph_cancel(the_graph
);
80 void set_signal_handler(void)
82 if (!SetConsoleCtrlHandler(signal_handler
, TRUE
)) {
83 BT_LOGE("Failed to set the Ctrl+C handler.");
87 #else /* __MINGW32__ */
90 void signal_handler(int signum
)
92 if (signum
!= SIGINT
) {
97 bt_graph_cancel(the_graph
);
100 if (the_query_executor
) {
101 bt_query_executor_cancel(the_query_executor
);
108 void set_signal_handler(void)
110 struct sigaction new_action
, old_action
;
112 new_action
.sa_handler
= signal_handler
;
113 sigemptyset(&new_action
.sa_mask
);
114 new_action
.sa_flags
= 0;
115 sigaction(SIGINT
, NULL
, &old_action
);
117 if (old_action
.sa_handler
!= SIG_IGN
) {
118 sigaction(SIGINT
, &new_action
, NULL
);
122 #endif /* __MINGW32__ */
125 void init_static_data(void)
127 loaded_plugins
= g_ptr_array_new_with_free_func(
128 (GDestroyNotify
) bt_object_put_ref
);
132 void fini_static_data(void)
134 g_ptr_array_free(loaded_plugins
, TRUE
);
138 int create_the_query_executor(void)
142 the_query_executor
= bt_query_executor_create();
143 if (!the_query_executor
) {
144 BT_LOGE_STR("Cannot create a query executor.");
152 void destroy_the_query_executor(void)
154 BT_QUERY_EXECUTOR_PUT_REF_AND_RESET(the_query_executor
);
158 int query(struct bt_config
*cfg
, const bt_component_class
*comp_cls
,
159 const char *obj
, const bt_value
*params
,
160 const bt_value
**user_result
, const char **fail_reason
)
162 const bt_value
*result
= NULL
;
163 bt_query_executor_status status
;
164 *fail_reason
= "unknown error";
167 BT_ASSERT(fail_reason
);
168 BT_ASSERT(user_result
);
169 ret
= create_the_query_executor();
171 /* create_the_query_executor() logs errors */
176 BT_LOGI("Canceled by user before executing the query: "
177 "comp-cls-addr=%p, comp-cls-name=\"%s\", "
178 "query-obj=\"%s\"", comp_cls
,
179 bt_component_class_get_name(comp_cls
), obj
);
180 *fail_reason
= "canceled by user";
185 status
= bt_query_executor_query(the_query_executor
,
186 comp_cls
, obj
, params
, cfg
->log_level
, &result
);
188 case BT_QUERY_EXECUTOR_STATUS_OK
:
190 case BT_QUERY_EXECUTOR_STATUS_AGAIN
:
192 const uint64_t sleep_time_us
= 100000;
194 /* Wait 100 ms and retry */
195 BT_LOGD("Got BT_QUERY_EXECUTOR_STATUS_AGAIN: sleeping: "
196 "time-us=%" PRIu64
, sleep_time_us
);
198 if (usleep(sleep_time_us
)) {
199 if (bt_query_executor_is_canceled(the_query_executor
)) {
200 BT_LOGI("Query was canceled by user: "
201 "comp-cls-addr=%p, comp-cls-name=\"%s\", "
202 "query-obj=\"%s\"", comp_cls
,
203 bt_component_class_get_name(comp_cls
),
205 *fail_reason
= "canceled by user";
212 case BT_QUERY_EXECUTOR_STATUS_CANCELED
:
213 *fail_reason
= "canceled by user";
215 case BT_QUERY_EXECUTOR_STATUS_ERROR
:
217 case BT_QUERY_EXECUTOR_STATUS_INVALID_OBJECT
:
218 *fail_reason
= "invalid or unknown query object";
220 case BT_QUERY_EXECUTOR_STATUS_INVALID_PARAMS
:
221 *fail_reason
= "invalid query parameters";
223 case BT_QUERY_EXECUTOR_STATUS_UNSUPPORTED
:
224 *fail_reason
= "unsupported action";
226 case BT_QUERY_EXECUTOR_STATUS_NOMEM
:
227 *fail_reason
= "not enough memory";
230 BT_LOGF("Unknown query status: status=%d", status
);
236 *user_result
= result
;
244 destroy_the_query_executor();
245 bt_value_put_ref(result
);
250 const bt_plugin
*find_plugin(const char *name
)
253 const bt_plugin
*plugin
= NULL
;
256 BT_LOGI("Finding plugin: name=\"%s\"", name
);
258 for (i
= 0; i
< loaded_plugins
->len
; i
++) {
259 plugin
= g_ptr_array_index(loaded_plugins
, i
);
261 if (strcmp(name
, bt_plugin_get_name(plugin
)) == 0) {
269 BT_LOGI("Found plugin: name=\"%s\", plugin-addr=%p",
272 BT_LOGI("Cannot find plugin: name=\"%s\"", name
);
275 bt_plugin_get_ref(plugin
);
279 typedef const void *(*plugin_borrow_comp_cls_func_t
)(
280 const bt_plugin
*, const char *);
283 const void *find_component_class_from_plugin(const char *plugin_name
,
284 const char *comp_class_name
,
285 plugin_borrow_comp_cls_func_t plugin_borrow_comp_cls_func
)
287 const void *comp_class
= NULL
;
288 const bt_plugin
*plugin
;
290 BT_LOGI("Finding component class: plugin-name=\"%s\", "
291 "comp-cls-name=\"%s\"", plugin_name
, comp_class_name
);
293 plugin
= find_plugin(plugin_name
);
298 comp_class
= plugin_borrow_comp_cls_func(plugin
, comp_class_name
);
299 bt_object_get_ref(comp_class
);
300 BT_PLUGIN_PUT_REF_AND_RESET(plugin
);
304 BT_LOGI("Found component class: plugin-name=\"%s\", "
305 "comp-cls-name=\"%s\"", plugin_name
, comp_class_name
);
307 BT_LOGI("Cannot find source component class: "
308 "plugin-name=\"%s\", comp-cls-name=\"%s\"",
309 plugin_name
, comp_class_name
);
316 const bt_component_class_source
*find_source_component_class(
317 const char *plugin_name
, const char *comp_class_name
)
319 return (const void *) find_component_class_from_plugin(
320 plugin_name
, comp_class_name
,
321 (plugin_borrow_comp_cls_func_t
)
322 bt_plugin_borrow_source_component_class_by_name_const
);
326 const bt_component_class_filter
*find_filter_component_class(
327 const char *plugin_name
, const char *comp_class_name
)
329 return (const void *) find_component_class_from_plugin(
330 plugin_name
, comp_class_name
,
331 (plugin_borrow_comp_cls_func_t
)
332 bt_plugin_borrow_filter_component_class_by_name_const
);
336 const bt_component_class_sink
*find_sink_component_class(
337 const char *plugin_name
, const char *comp_class_name
)
339 return (const void *) find_component_class_from_plugin(plugin_name
,
341 (plugin_borrow_comp_cls_func_t
)
342 bt_plugin_borrow_sink_component_class_by_name_const
);
346 const bt_component_class
*find_component_class(const char *plugin_name
,
347 const char *comp_class_name
,
348 bt_component_class_type comp_class_type
)
350 const bt_component_class
*comp_cls
= NULL
;
352 switch (comp_class_type
) {
353 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
354 comp_cls
= bt_component_class_source_as_component_class_const(find_source_component_class(plugin_name
, comp_class_name
));
356 case BT_COMPONENT_CLASS_TYPE_FILTER
:
357 comp_cls
= bt_component_class_filter_as_component_class_const(find_filter_component_class(plugin_name
, comp_class_name
));
359 case BT_COMPONENT_CLASS_TYPE_SINK
:
360 comp_cls
= bt_component_class_sink_as_component_class_const(find_sink_component_class(plugin_name
, comp_class_name
));
370 void print_indent(FILE *fp
, size_t indent
)
374 for (i
= 0; i
< indent
; i
++) {
380 const char *component_type_str(bt_component_class_type type
)
383 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
385 case BT_COMPONENT_CLASS_TYPE_SINK
:
387 case BT_COMPONENT_CLASS_TYPE_FILTER
:
395 void print_plugin_comp_cls_opt(FILE *fh
, const char *plugin_name
,
396 const char *comp_cls_name
, bt_component_class_type type
)
398 GString
*shell_plugin_name
= NULL
;
399 GString
*shell_comp_cls_name
= NULL
;
401 shell_plugin_name
= bt_common_shell_quote(plugin_name
, false);
402 if (!shell_plugin_name
) {
406 shell_comp_cls_name
= bt_common_shell_quote(comp_cls_name
, false);
407 if (!shell_comp_cls_name
) {
411 fprintf(fh
, "'%s%s%s%s.%s%s%s.%s%s%s'",
412 bt_common_color_bold(),
413 bt_common_color_fg_cyan(),
414 component_type_str(type
),
415 bt_common_color_fg_default(),
416 bt_common_color_fg_blue(),
417 shell_plugin_name
->str
,
418 bt_common_color_fg_default(),
419 bt_common_color_fg_yellow(),
420 shell_comp_cls_name
->str
,
421 bt_common_color_reset());
424 if (shell_plugin_name
) {
425 g_string_free(shell_plugin_name
, TRUE
);
428 if (shell_comp_cls_name
) {
429 g_string_free(shell_comp_cls_name
, TRUE
);
434 void print_value(FILE *, const bt_value
*, size_t);
437 void print_value_rec(FILE *, const bt_value
*, size_t);
439 struct print_map_value_data
{
445 bt_bool
print_map_value(const char *key
, const bt_value
*object
,
448 struct print_map_value_data
*print_map_value_data
= data
;
450 print_indent(print_map_value_data
->fp
, print_map_value_data
->indent
);
451 fprintf(print_map_value_data
->fp
, "%s: ", key
);
454 if (bt_value_is_array(object
) &&
455 bt_value_array_is_empty(object
)) {
456 fprintf(print_map_value_data
->fp
, "[ ]\n");
460 if (bt_value_is_map(object
) &&
461 bt_value_map_is_empty(object
)) {
462 fprintf(print_map_value_data
->fp
, "{ }\n");
466 if (bt_value_is_array(object
) ||
467 bt_value_is_map(object
)) {
468 fprintf(print_map_value_data
->fp
, "\n");
471 print_value_rec(print_map_value_data
->fp
, object
,
472 print_map_value_data
->indent
+ 2);
477 void print_value_rec(FILE *fp
, const bt_value
*value
, size_t indent
)
491 switch (bt_value_get_type(value
)) {
492 case BT_VALUE_TYPE_NULL
:
493 fprintf(fp
, "%snull%s\n", bt_common_color_bold(),
494 bt_common_color_reset());
496 case BT_VALUE_TYPE_BOOL
:
497 bool_val
= bt_value_bool_get(value
);
498 fprintf(fp
, "%s%s%s%s\n", bt_common_color_bold(),
499 bt_common_color_fg_cyan(), bool_val
? "yes" : "no",
500 bt_common_color_reset());
502 case BT_VALUE_TYPE_UNSIGNED_INTEGER
:
503 uint_val
= bt_value_unsigned_integer_get(value
);
504 fprintf(fp
, "%s%s%" PRIu64
"%s\n", bt_common_color_bold(),
505 bt_common_color_fg_red(), uint_val
,
506 bt_common_color_reset());
508 case BT_VALUE_TYPE_SIGNED_INTEGER
:
509 int_val
= bt_value_signed_integer_get(value
);
510 fprintf(fp
, "%s%s%" PRId64
"%s\n", bt_common_color_bold(),
511 bt_common_color_fg_red(), int_val
,
512 bt_common_color_reset());
514 case BT_VALUE_TYPE_REAL
:
515 dbl_val
= bt_value_real_get(value
);
516 fprintf(fp
, "%s%s%lf%s\n", bt_common_color_bold(),
517 bt_common_color_fg_red(), dbl_val
,
518 bt_common_color_reset());
520 case BT_VALUE_TYPE_STRING
:
521 str_val
= bt_value_string_get(value
);
522 fprintf(fp
, "%s%s%s%s\n", bt_common_color_bold(),
523 bt_common_color_fg_green(), str_val
,
524 bt_common_color_reset());
526 case BT_VALUE_TYPE_ARRAY
:
527 size
= bt_value_array_get_size(value
);
533 print_indent(fp
, indent
);
534 fprintf(fp
, "[ ]\n");
538 for (i
= 0; i
< size
; i
++) {
539 const bt_value
*element
=
540 bt_value_array_borrow_element_by_index_const(
546 print_indent(fp
, indent
);
549 if (bt_value_is_array(element
) &&
550 bt_value_array_is_empty(element
)) {
551 fprintf(fp
, "[ ]\n");
555 if (bt_value_is_map(element
) &&
556 bt_value_map_is_empty(element
)) {
557 fprintf(fp
, "{ }\n");
561 if (bt_value_is_array(element
) ||
562 bt_value_is_map(element
)) {
566 print_value_rec(fp
, element
, indent
+ 2);
569 case BT_VALUE_TYPE_MAP
:
571 struct print_map_value_data data
= {
576 if (bt_value_map_is_empty(value
)) {
577 print_indent(fp
, indent
);
578 fprintf(fp
, "{ }\n");
582 bt_value_map_foreach_entry_const(value
, print_map_value
, &data
);
591 BT_LOGE("Error printing value of type %s.",
592 bt_common_value_type_string(bt_value_get_type(value
)));
596 void print_value(FILE *fp
, const bt_value
*value
, size_t indent
)
598 if (!bt_value_is_array(value
) && !bt_value_is_map(value
)) {
599 print_indent(fp
, indent
);
602 print_value_rec(fp
, value
, indent
);
606 void print_bt_config_component(struct bt_config_component
*bt_config_component
)
608 fprintf(stderr
, " ");
609 print_plugin_comp_cls_opt(stderr
, bt_config_component
->plugin_name
->str
,
610 bt_config_component
->comp_cls_name
->str
,
611 bt_config_component
->type
);
612 fprintf(stderr
, ":\n");
614 if (bt_config_component
->instance_name
->len
> 0) {
615 fprintf(stderr
, " Name: %s\n",
616 bt_config_component
->instance_name
->str
);
619 fprintf(stderr
, " Parameters:\n");
620 print_value(stderr
, bt_config_component
->params
, 8);
624 void print_bt_config_components(GPtrArray
*array
)
628 for (i
= 0; i
< array
->len
; i
++) {
629 struct bt_config_component
*cfg_component
=
630 bt_config_get_component(array
, i
);
631 print_bt_config_component(cfg_component
);
632 BT_OBJECT_PUT_REF_AND_RESET(cfg_component
);
637 void print_plugin_paths(const bt_value
*plugin_paths
)
639 fprintf(stderr
, " Plugin paths:\n");
640 print_value(stderr
, plugin_paths
, 4);
644 void print_cfg_run(struct bt_config
*cfg
)
648 print_plugin_paths(cfg
->plugin_paths
);
649 fprintf(stderr
, " Source component instances:\n");
650 print_bt_config_components(cfg
->cmd_data
.run
.sources
);
652 if (cfg
->cmd_data
.run
.filters
->len
> 0) {
653 fprintf(stderr
, " Filter component instances:\n");
654 print_bt_config_components(cfg
->cmd_data
.run
.filters
);
657 fprintf(stderr
, " Sink component instances:\n");
658 print_bt_config_components(cfg
->cmd_data
.run
.sinks
);
659 fprintf(stderr
, " Connections:\n");
661 for (i
= 0; i
< cfg
->cmd_data
.run
.connections
->len
; i
++) {
662 struct bt_config_connection
*cfg_connection
=
663 g_ptr_array_index(cfg
->cmd_data
.run
.connections
,
666 fprintf(stderr
, " %s%s%s -> %s%s%s\n",
667 cfg_connection
->upstream_comp_name
->str
,
668 cfg_connection
->upstream_port_glob
->len
> 0 ? "." : "",
669 cfg_connection
->upstream_port_glob
->str
,
670 cfg_connection
->downstream_comp_name
->str
,
671 cfg_connection
->downstream_port_glob
->len
> 0 ? "." : "",
672 cfg_connection
->downstream_port_glob
->str
);
677 void print_cfg_list_plugins(struct bt_config
*cfg
)
679 print_plugin_paths(cfg
->plugin_paths
);
683 void print_cfg_help(struct bt_config
*cfg
)
685 print_plugin_paths(cfg
->plugin_paths
);
689 void print_cfg_print_ctf_metadata(struct bt_config
*cfg
)
691 print_plugin_paths(cfg
->plugin_paths
);
692 fprintf(stderr
, " Path: %s\n",
693 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
697 void print_cfg_print_lttng_live_sessions(struct bt_config
*cfg
)
699 print_plugin_paths(cfg
->plugin_paths
);
700 fprintf(stderr
, " URL: %s\n",
701 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
705 void print_cfg_query(struct bt_config
*cfg
)
707 print_plugin_paths(cfg
->plugin_paths
);
708 fprintf(stderr
, " Object: `%s`\n", cfg
->cmd_data
.query
.object
->str
);
709 fprintf(stderr
, " Component class:\n");
710 print_bt_config_component(cfg
->cmd_data
.query
.cfg_component
);
714 void print_cfg(struct bt_config
*cfg
)
716 if (!BT_LOG_ON_INFO
) {
720 BT_LOGI_STR("CLI configuration:");
721 BT_LOGI(" Debug mode: %s\n", cfg
->debug
? "yes" : "no");
722 BT_LOGI(" Verbose mode: %s\n", cfg
->verbose
? "yes" : "no");
724 switch (cfg
->command
) {
725 case BT_CONFIG_COMMAND_RUN
:
728 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
729 print_cfg_list_plugins(cfg
);
731 case BT_CONFIG_COMMAND_HELP
:
734 case BT_CONFIG_COMMAND_QUERY
:
735 print_cfg_query(cfg
);
737 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
738 print_cfg_print_ctf_metadata(cfg
);
740 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
741 print_cfg_print_lttng_live_sessions(cfg
);
749 void add_to_loaded_plugins(const bt_plugin_set
*plugin_set
)
754 count
= bt_plugin_set_get_plugin_count(plugin_set
);
755 BT_ASSERT(count
>= 0);
757 for (i
= 0; i
< count
; i
++) {
758 const bt_plugin
*plugin
=
759 bt_plugin_set_borrow_plugin_by_index_const(plugin_set
, i
);
760 const bt_plugin
*loaded_plugin
=
761 find_plugin(bt_plugin_get_name(plugin
));
766 BT_LOGI("Not using plugin: another one already exists with the same name: "
767 "plugin-name=\"%s\", plugin-path=\"%s\", "
768 "existing-plugin-path=\"%s\"",
769 bt_plugin_get_name(plugin
),
770 bt_plugin_get_path(plugin
),
771 bt_plugin_get_path(loaded_plugin
));
772 bt_plugin_put_ref(loaded_plugin
);
774 /* Add to global array. */
775 BT_LOGD("Adding plugin to loaded plugins: plugin-path=\"%s\"",
776 bt_plugin_get_name(plugin
));
777 bt_plugin_get_ref(plugin
);
778 g_ptr_array_add(loaded_plugins
, (void *) plugin
);
784 int load_dynamic_plugins(const bt_value
*plugin_paths
)
786 int nr_paths
, i
, ret
= 0;
788 nr_paths
= bt_value_array_get_size(plugin_paths
);
790 BT_LOGE_STR("Cannot load dynamic plugins: no plugin path.");
795 BT_LOGI_STR("Loading dynamic plugins.");
797 for (i
= 0; i
< nr_paths
; i
++) {
798 const bt_value
*plugin_path_value
= NULL
;
799 const char *plugin_path
;
800 const bt_plugin_set
*plugin_set
;
803 bt_value_array_borrow_element_by_index_const(
805 plugin_path
= bt_value_string_get(plugin_path_value
);
808 * Skip this if the directory does not exist because
809 * bt_plugin_find_all_from_dir() expects an existing
812 if (!g_file_test(plugin_path
, G_FILE_TEST_IS_DIR
)) {
813 BT_LOGI("Skipping nonexistent directory path: "
814 "path=\"%s\"", plugin_path
);
818 plugin_set
= bt_plugin_find_all_from_dir(plugin_path
, false);
820 BT_LOGI("Unable to load dynamic plugins from directory: "
821 "path=\"%s\"", plugin_path
);
825 add_to_loaded_plugins(plugin_set
);
826 bt_plugin_set_put_ref(plugin_set
);
833 int load_static_plugins(void)
836 const bt_plugin_set
*plugin_set
;
838 BT_LOGI("Loading static plugins.");
839 plugin_set
= bt_plugin_find_all_from_static();
841 BT_LOGE("Unable to load static plugins.");
846 add_to_loaded_plugins(plugin_set
);
847 bt_plugin_set_put_ref(plugin_set
);
853 int load_all_plugins(const bt_value
*plugin_paths
)
857 if (load_dynamic_plugins(plugin_paths
)) {
862 if (load_static_plugins()) {
867 BT_LOGI("Loaded all plugins: count=%u", loaded_plugins
->len
);
874 void print_plugin_info(const bt_plugin
*plugin
)
876 unsigned int major
, minor
, patch
;
878 bt_property_availability version_avail
;
879 const char *plugin_name
;
883 const char *plugin_description
;
885 plugin_name
= bt_plugin_get_name(plugin
);
886 path
= bt_plugin_get_path(plugin
);
887 author
= bt_plugin_get_author(plugin
);
888 license
= bt_plugin_get_license(plugin
);
889 plugin_description
= bt_plugin_get_description(plugin
);
890 version_avail
= bt_plugin_get_version(plugin
, &major
, &minor
,
892 printf("%s%s%s%s:\n", bt_common_color_bold(),
893 bt_common_color_fg_blue(), plugin_name
,
894 bt_common_color_reset());
896 printf(" %sPath%s: %s\n", bt_common_color_bold(),
897 bt_common_color_reset(), path
);
902 if (version_avail
== BT_PROPERTY_AVAILABILITY_AVAILABLE
) {
903 printf(" %sVersion%s: %u.%u.%u",
904 bt_common_color_bold(), bt_common_color_reset(),
905 major
, minor
, patch
);
914 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
915 bt_common_color_reset(),
916 plugin_description
? plugin_description
: "(None)");
917 printf(" %sAuthor%s: %s\n", bt_common_color_bold(),
918 bt_common_color_reset(), author
? author
: "(Unknown)");
919 printf(" %sLicense%s: %s\n", bt_common_color_bold(),
920 bt_common_color_reset(),
921 license
? license
: "(Unknown)");
925 int cmd_query(struct bt_config
*cfg
)
928 const bt_component_class
*comp_cls
= NULL
;
929 const bt_value
*results
= NULL
;
930 const char *fail_reason
= NULL
;
932 comp_cls
= find_component_class(
933 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
934 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
935 cfg
->cmd_data
.query
.cfg_component
->type
);
937 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
938 "comp-cls-name=\"%s\", comp-cls-type=%d",
939 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
940 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
941 cfg
->cmd_data
.query
.cfg_component
->type
);
942 fprintf(stderr
, "%s%sCannot find component class %s",
943 bt_common_color_bold(),
944 bt_common_color_fg_red(),
945 bt_common_color_reset());
946 print_plugin_comp_cls_opt(stderr
,
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
, "\n");
955 ret
= query(cfg
, comp_cls
, cfg
->cmd_data
.query
.object
->str
,
956 cfg
->cmd_data
.query
.cfg_component
->params
,
957 &results
, &fail_reason
);
962 print_value(stdout
, results
, 0);
966 BT_LOGE("Failed to query component class: %s: plugin-name=\"%s\", "
967 "comp-cls-name=\"%s\", comp-cls-type=%d "
968 "object=\"%s\"", fail_reason
,
969 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
970 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
971 cfg
->cmd_data
.query
.cfg_component
->type
,
972 cfg
->cmd_data
.query
.object
->str
);
973 fprintf(stderr
, "%s%sFailed to query info to %s",
974 bt_common_color_bold(),
975 bt_common_color_fg_red(),
976 bt_common_color_reset());
977 print_plugin_comp_cls_opt(stderr
,
978 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
979 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
980 cfg
->cmd_data
.query
.cfg_component
->type
);
981 fprintf(stderr
, "%s%s with object `%s`: %s%s\n",
982 bt_common_color_bold(),
983 bt_common_color_fg_red(),
984 cfg
->cmd_data
.query
.object
->str
,
986 bt_common_color_reset());
990 bt_component_class_put_ref(comp_cls
);
991 bt_value_put_ref(results
);
996 void print_component_class_help(const char *plugin_name
,
997 const bt_component_class
*comp_cls
)
999 const char *comp_class_name
=
1000 bt_component_class_get_name(comp_cls
);
1001 const char *comp_class_description
=
1002 bt_component_class_get_description(comp_cls
);
1003 const char *comp_class_help
=
1004 bt_component_class_get_help(comp_cls
);
1005 bt_component_class_type type
=
1006 bt_component_class_get_type(comp_cls
);
1008 print_plugin_comp_cls_opt(stdout
, plugin_name
, comp_class_name
, type
);
1010 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
1011 bt_common_color_reset(),
1012 comp_class_description
? comp_class_description
: "(None)");
1014 if (comp_class_help
) {
1015 printf("\n%s\n", comp_class_help
);
1020 int cmd_help(struct bt_config
*cfg
)
1023 const bt_plugin
*plugin
= NULL
;
1024 const bt_component_class
*needed_comp_cls
= NULL
;
1026 plugin
= find_plugin(cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
1028 BT_LOGE("Cannot find plugin: plugin-name=\"%s\"",
1029 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
1030 fprintf(stderr
, "%s%sCannot find plugin %s%s%s\n",
1031 bt_common_color_bold(), bt_common_color_fg_red(),
1032 bt_common_color_fg_blue(),
1033 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1034 bt_common_color_reset());
1039 print_plugin_info(plugin
);
1040 printf(" %sSource component classes%s: %d\n",
1041 bt_common_color_bold(),
1042 bt_common_color_reset(),
1043 (int) bt_plugin_get_source_component_class_count(plugin
));
1044 printf(" %sFilter component classes%s: %d\n",
1045 bt_common_color_bold(),
1046 bt_common_color_reset(),
1047 (int) bt_plugin_get_filter_component_class_count(plugin
));
1048 printf(" %sSink component classes%s: %d\n",
1049 bt_common_color_bold(),
1050 bt_common_color_reset(),
1051 (int) bt_plugin_get_sink_component_class_count(plugin
));
1053 if (strlen(cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
) == 0) {
1054 /* Plugin help only */
1058 needed_comp_cls
= find_component_class(
1059 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1060 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
1061 cfg
->cmd_data
.help
.cfg_component
->type
);
1062 if (!needed_comp_cls
) {
1063 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
1064 "comp-cls-name=\"%s\", comp-cls-type=%d",
1065 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1066 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
1067 cfg
->cmd_data
.help
.cfg_component
->type
);
1068 fprintf(stderr
, "\n%s%sCannot find component class %s",
1069 bt_common_color_bold(),
1070 bt_common_color_fg_red(),
1071 bt_common_color_reset());
1072 print_plugin_comp_cls_opt(stderr
,
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");
1082 print_component_class_help(
1083 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1087 bt_component_class_put_ref(needed_comp_cls
);
1088 bt_plugin_put_ref(plugin
);
1092 typedef void *(* plugin_borrow_comp_cls_by_index_func_t
)(const bt_plugin
*,
1094 typedef const bt_component_class
*(* spec_comp_cls_borrow_comp_cls_func_t
)(
1097 void cmd_list_plugins_print_component_classes(const bt_plugin
*plugin
,
1098 const char *cc_type_name
, uint64_t count
,
1099 plugin_borrow_comp_cls_by_index_func_t borrow_comp_cls_by_index_func
,
1100 spec_comp_cls_borrow_comp_cls_func_t spec_comp_cls_borrow_comp_cls_func
)
1105 printf(" %s%s component classes%s: (none)\n",
1106 bt_common_color_bold(),
1108 bt_common_color_reset());
1111 printf(" %s%s component classes%s:\n",
1112 bt_common_color_bold(),
1114 bt_common_color_reset());
1117 for (i
= 0; i
< count
; i
++) {
1118 const bt_component_class
*comp_class
=
1119 spec_comp_cls_borrow_comp_cls_func(
1120 borrow_comp_cls_by_index_func(plugin
, i
));
1121 const char *comp_class_name
=
1122 bt_component_class_get_name(comp_class
);
1123 const char *comp_class_description
=
1124 bt_component_class_get_description(comp_class
);
1125 bt_component_class_type type
=
1126 bt_component_class_get_type(comp_class
);
1129 print_plugin_comp_cls_opt(stdout
,
1130 bt_plugin_get_name(plugin
), comp_class_name
,
1133 if (comp_class_description
) {
1134 printf(": %s", comp_class_description
);
1145 int cmd_list_plugins(struct bt_config
*cfg
)
1148 int plugins_count
, component_classes_count
= 0, i
;
1150 printf("From the following plugin paths:\n\n");
1151 print_value(stdout
, cfg
->plugin_paths
, 2);
1153 plugins_count
= loaded_plugins
->len
;
1154 if (plugins_count
== 0) {
1155 printf("No plugins found.\n");
1159 for (i
= 0; i
< plugins_count
; i
++) {
1160 const bt_plugin
*plugin
= g_ptr_array_index(loaded_plugins
, i
);
1162 component_classes_count
+=
1163 bt_plugin_get_source_component_class_count(plugin
) +
1164 bt_plugin_get_filter_component_class_count(plugin
) +
1165 bt_plugin_get_sink_component_class_count(plugin
);
1168 printf("Found %s%d%s component classes in %s%d%s plugins.\n",
1169 bt_common_color_bold(),
1170 component_classes_count
,
1171 bt_common_color_reset(),
1172 bt_common_color_bold(),
1174 bt_common_color_reset());
1176 for (i
= 0; i
< plugins_count
; i
++) {
1177 const bt_plugin
*plugin
= g_ptr_array_index(loaded_plugins
, i
);
1180 print_plugin_info(plugin
);
1181 cmd_list_plugins_print_component_classes(plugin
, "Source",
1182 bt_plugin_get_source_component_class_count(plugin
),
1183 (plugin_borrow_comp_cls_by_index_func_t
)
1184 bt_plugin_borrow_source_component_class_by_index_const
,
1185 (spec_comp_cls_borrow_comp_cls_func_t
)
1186 bt_component_class_source_as_component_class
);
1187 cmd_list_plugins_print_component_classes(plugin
, "Filter",
1188 bt_plugin_get_filter_component_class_count(plugin
),
1189 (plugin_borrow_comp_cls_by_index_func_t
)
1190 bt_plugin_borrow_filter_component_class_by_index_const
,
1191 (spec_comp_cls_borrow_comp_cls_func_t
)
1192 bt_component_class_filter_as_component_class
);
1193 cmd_list_plugins_print_component_classes(plugin
, "Sink",
1194 bt_plugin_get_sink_component_class_count(plugin
),
1195 (plugin_borrow_comp_cls_by_index_func_t
)
1196 bt_plugin_borrow_sink_component_class_by_index_const
,
1197 (spec_comp_cls_borrow_comp_cls_func_t
)
1198 bt_component_class_sink_as_component_class
);
1206 int cmd_print_lttng_live_sessions(struct bt_config
*cfg
)
1209 const bt_component_class
*comp_cls
= NULL
;
1210 const bt_value
*results
= NULL
;
1211 bt_value
*params
= NULL
;
1212 const bt_value
*map
= NULL
;
1213 const bt_value
*v
= NULL
;
1214 static const char * const plugin_name
= "ctf";
1215 static const char * const comp_cls_name
= "lttng-live";
1216 static const bt_component_class_type comp_cls_type
=
1217 BT_COMPONENT_CLASS_TYPE_SOURCE
;
1218 int64_t array_size
, i
;
1219 const char *fail_reason
= NULL
;
1220 FILE *out_stream
= stdout
;
1222 BT_ASSERT(cfg
->cmd_data
.print_lttng_live_sessions
.url
);
1223 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1226 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
1227 "comp-cls-name=\"%s\", comp-cls-type=%d",
1228 plugin_name
, comp_cls_name
,
1229 BT_COMPONENT_CLASS_TYPE_SOURCE
);
1230 fprintf(stderr
, "%s%sCannot find component class %s",
1231 bt_common_color_bold(),
1232 bt_common_color_fg_red(),
1233 bt_common_color_reset());
1234 print_plugin_comp_cls_opt(stderr
, plugin_name
,
1235 comp_cls_name
, comp_cls_type
);
1236 fprintf(stderr
, "\n");
1240 params
= bt_value_map_create();
1245 ret
= bt_value_map_insert_string_entry(params
, "url",
1246 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
1251 ret
= query(cfg
, comp_cls
, "sessions", params
,
1252 &results
, &fail_reason
);
1259 if (!bt_value_is_array(results
)) {
1260 BT_LOGE_STR("Expecting an array for sessions query.");
1261 fprintf(stderr
, "%s%sUnexpected type returned by session query%s\n",
1262 bt_common_color_bold(),
1263 bt_common_color_fg_red(),
1264 bt_common_color_reset());
1268 if (cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->len
> 0) {
1270 fopen(cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
,
1274 BT_LOGE_ERRNO("Cannot open file for writing",
1276 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
1281 array_size
= bt_value_array_get_size(results
);
1282 for (i
= 0; i
< array_size
; i
++) {
1283 const char *url_text
;
1284 int64_t timer_us
, streams
, clients
;
1286 map
= bt_value_array_borrow_element_by_index_const(results
, i
);
1288 BT_LOGE_STR("Unexpected empty array entry.");
1291 if (!bt_value_is_map(map
)) {
1292 BT_LOGE_STR("Unexpected entry type.");
1296 v
= bt_value_map_borrow_entry_value_const(map
, "url");
1298 BT_LOGE_STR("Unexpected empty array \"url\" entry.");
1301 url_text
= bt_value_string_get(v
);
1302 fprintf(out_stream
, "%s", url_text
);
1303 v
= bt_value_map_borrow_entry_value_const(map
, "timer-us");
1305 BT_LOGE_STR("Unexpected empty array \"timer-us\" entry.");
1308 timer_us
= bt_value_signed_integer_get(v
);
1309 fprintf(out_stream
, " (timer = %" PRIu64
", ", timer_us
);
1310 v
= bt_value_map_borrow_entry_value_const(map
, "stream-count");
1312 BT_LOGE_STR("Unexpected empty array \"stream-count\" entry.");
1315 streams
= bt_value_signed_integer_get(v
);
1316 fprintf(out_stream
, "%" PRIu64
" stream(s), ", streams
);
1317 v
= bt_value_map_borrow_entry_value_const(map
, "client-count");
1319 BT_LOGE_STR("Unexpected empty array \"client-count\" entry.");
1322 clients
= bt_value_signed_integer_get(v
);
1323 fprintf(out_stream
, "%" PRIu64
" client(s) connected)\n", clients
);
1329 BT_LOGE("Failed to query for sessions: %s", fail_reason
);
1330 fprintf(stderr
, "%s%sFailed to request sessions: %s%s\n",
1331 bt_common_color_bold(),
1332 bt_common_color_fg_red(),
1334 bt_common_color_reset());
1340 bt_value_put_ref(results
);
1341 bt_value_put_ref(params
);
1342 bt_component_class_put_ref(comp_cls
);
1344 if (out_stream
&& out_stream
!= stdout
) {
1345 int fclose_ret
= fclose(out_stream
);
1348 BT_LOGE_ERRNO("Cannot close file stream",
1350 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
1358 int cmd_print_ctf_metadata(struct bt_config
*cfg
)
1361 const bt_component_class
*comp_cls
= NULL
;
1362 const bt_value
*results
= NULL
;
1363 bt_value
*params
= NULL
;
1364 const bt_value
*metadata_text_value
= NULL
;
1365 const char *metadata_text
= NULL
;
1366 static const char * const plugin_name
= "ctf";
1367 static const char * const comp_cls_name
= "fs";
1368 static const bt_component_class_type comp_cls_type
=
1369 BT_COMPONENT_CLASS_TYPE_SOURCE
;
1370 const char *fail_reason
= NULL
;
1371 FILE *out_stream
= stdout
;
1373 BT_ASSERT(cfg
->cmd_data
.print_ctf_metadata
.path
);
1374 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1377 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
1378 "comp-cls-name=\"%s\", comp-cls-type=%d",
1379 plugin_name
, comp_cls_name
,
1380 BT_COMPONENT_CLASS_TYPE_SOURCE
);
1381 fprintf(stderr
, "%s%sCannot find component class %s",
1382 bt_common_color_bold(),
1383 bt_common_color_fg_red(),
1384 bt_common_color_reset());
1385 print_plugin_comp_cls_opt(stderr
, plugin_name
,
1386 comp_cls_name
, comp_cls_type
);
1387 fprintf(stderr
, "\n");
1392 params
= bt_value_map_create();
1398 ret
= bt_value_map_insert_string_entry(params
, "path",
1399 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
1405 ret
= query(cfg
, comp_cls
, "metadata-info",
1406 params
, &results
, &fail_reason
);
1411 metadata_text_value
= bt_value_map_borrow_entry_value_const(results
,
1413 if (!metadata_text_value
) {
1414 BT_LOGE_STR("Cannot find `text` string value in the resulting metadata info object.");
1419 metadata_text
= bt_value_string_get(metadata_text_value
);
1421 if (cfg
->cmd_data
.print_ctf_metadata
.output_path
->len
> 0) {
1423 fopen(cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
,
1427 BT_LOGE_ERRNO("Cannot open file for writing",
1429 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1434 ret
= fprintf(out_stream
, "%s\n", metadata_text
);
1436 BT_LOGE("Cannot write whole metadata text to output stream: "
1447 BT_LOGE("Failed to query for metadata info: %s", fail_reason
);
1448 fprintf(stderr
, "%s%sFailed to request metadata info: %s%s\n",
1449 bt_common_color_bold(),
1450 bt_common_color_fg_red(),
1452 bt_common_color_reset());
1455 bt_value_put_ref(results
);
1456 bt_value_put_ref(params
);
1457 bt_component_class_put_ref(comp_cls
);
1459 if (out_stream
&& out_stream
!= stdout
) {
1460 int fclose_ret
= fclose(out_stream
);
1463 BT_LOGE_ERRNO("Cannot close file stream",
1465 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1473 char *instance_name
;
1477 struct trace_range
{
1478 uint64_t intersection_range_begin_ns
;
1479 uint64_t intersection_range_end_ns
;
1483 guint
port_id_hash(gconstpointer v
)
1485 const struct port_id
*id
= v
;
1487 BT_ASSERT(id
->instance_name
);
1488 BT_ASSERT(id
->port_name
);
1490 return g_str_hash(id
->instance_name
) ^ g_str_hash(id
->port_name
);
1494 gboolean
port_id_equal(gconstpointer v1
, gconstpointer v2
)
1496 const struct port_id
*id1
= v1
;
1497 const struct port_id
*id2
= v2
;
1499 return !strcmp(id1
->instance_name
, id2
->instance_name
) &&
1500 !strcmp(id1
->port_name
, id2
->port_name
);
1504 void port_id_destroy(gpointer data
)
1506 struct port_id
*id
= data
;
1508 free(id
->instance_name
);
1509 free(id
->port_name
);
1514 void trace_range_destroy(gpointer data
)
1519 struct cmd_run_ctx
{
1521 GHashTable
*src_components
;
1524 GHashTable
*flt_components
;
1527 GHashTable
*sink_components
;
1533 struct bt_config
*cfg
;
1537 bool stream_intersection_mode
;
1540 * Association of struct port_id -> struct trace_range.
1542 GHashTable
*intersections
;
1545 /* Returns a timestamp of the form "(-)s.ns" */
1547 char *s_from_ns(int64_t ns
)
1552 int64_t ts_sec_abs
, ts_nsec_abs
;
1553 int64_t ts_sec
= ns
/ NSEC_PER_SEC
;
1554 int64_t ts_nsec
= ns
% NSEC_PER_SEC
;
1556 if (ts_sec
>= 0 && ts_nsec
>= 0) {
1557 is_negative
= false;
1558 ts_sec_abs
= ts_sec
;
1559 ts_nsec_abs
= ts_nsec
;
1560 } else if (ts_sec
> 0 && ts_nsec
< 0) {
1561 is_negative
= false;
1562 ts_sec_abs
= ts_sec
- 1;
1563 ts_nsec_abs
= NSEC_PER_SEC
+ ts_nsec
;
1564 } else if (ts_sec
== 0 && ts_nsec
< 0) {
1566 ts_sec_abs
= ts_sec
;
1567 ts_nsec_abs
= -ts_nsec
;
1568 } else if (ts_sec
< 0 && ts_nsec
> 0) {
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 { /* (ts_sec < 0 && ts_nsec < 0) */
1578 ts_sec_abs
= -ts_sec
;
1579 ts_nsec_abs
= -ts_nsec
;
1582 ret
= asprintf(&s_ret
, "%s%" PRId64
".%09" PRId64
,
1583 is_negative
? "-" : "", ts_sec_abs
, ts_nsec_abs
);
1591 int cmd_run_ctx_connect_upstream_port_to_downstream_component(
1592 struct cmd_run_ctx
*ctx
,
1593 const bt_component
*upstream_comp
,
1594 const bt_port_output
*out_upstream_port
,
1595 struct bt_config_connection
*cfg_conn
)
1597 typedef uint64_t (*input_port_count_func_t
)(void *);
1598 typedef const bt_port_input
*(*borrow_input_port_by_index_func_t
)(
1599 const void *, uint64_t);
1600 const bt_port
*upstream_port
=
1601 bt_port_output_as_port_const(out_upstream_port
);
1604 GQuark downstreamp_comp_name_quark
;
1605 void *downstream_comp
;
1606 uint64_t downstream_port_count
;
1608 input_port_count_func_t port_count_fn
;
1609 borrow_input_port_by_index_func_t port_by_index_fn
;
1610 bt_graph_status status
= BT_GRAPH_STATUS_ERROR
;
1611 bool insert_trimmer
= false;
1612 bt_value
*trimmer_params
= NULL
;
1613 char *intersection_begin
= NULL
;
1614 char *intersection_end
= NULL
;
1615 const bt_component_filter
*trimmer
= NULL
;
1616 const bt_component_class_filter
*trimmer_class
= NULL
;
1617 const bt_port_input
*trimmer_input
= NULL
;
1618 const bt_port_output
*trimmer_output
= NULL
;
1620 if (ctx
->intersections
&&
1621 bt_component_get_class_type(upstream_comp
) ==
1622 BT_COMPONENT_CLASS_TYPE_SOURCE
) {
1623 struct trace_range
*range
;
1624 struct port_id port_id
= {
1625 .instance_name
= (char *) bt_component_get_name(upstream_comp
),
1626 .port_name
= (char *) bt_port_get_name(upstream_port
)
1629 if (!port_id
.instance_name
|| !port_id
.port_name
) {
1633 range
= (struct trace_range
*) g_hash_table_lookup(
1634 ctx
->intersections
, &port_id
);
1636 bt_value_status status
;
1638 intersection_begin
= s_from_ns(
1639 range
->intersection_range_begin_ns
);
1640 intersection_end
= s_from_ns(
1641 range
->intersection_range_end_ns
);
1642 if (!intersection_begin
|| !intersection_end
) {
1643 BT_LOGE_STR("Cannot create trimmer argument timestamp string.");
1647 insert_trimmer
= true;
1648 trimmer_params
= bt_value_map_create();
1649 if (!trimmer_params
) {
1653 status
= bt_value_map_insert_string_entry(
1654 trimmer_params
, "begin", intersection_begin
);
1655 if (status
!= BT_VALUE_STATUS_OK
) {
1658 status
= bt_value_map_insert_string_entry(
1660 "end", intersection_end
);
1661 if (status
!= BT_VALUE_STATUS_OK
) {
1666 trimmer_class
= find_filter_component_class("utils", "trimmer");
1667 if (!trimmer_class
) {
1672 BT_LOGI("Connecting upstream port to the next available downstream port: "
1673 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1674 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1675 upstream_port
, bt_port_get_name(upstream_port
),
1676 cfg_conn
->downstream_comp_name
->str
,
1677 cfg_conn
->arg
->str
);
1678 downstreamp_comp_name_quark
= g_quark_from_string(
1679 cfg_conn
->downstream_comp_name
->str
);
1680 BT_ASSERT(downstreamp_comp_name_quark
> 0);
1681 downstream_comp
= g_hash_table_lookup(ctx
->flt_components
,
1682 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1683 port_count_fn
= (input_port_count_func_t
)
1684 bt_component_filter_get_input_port_count
;
1685 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1686 bt_component_filter_borrow_input_port_by_index_const
;
1688 if (!downstream_comp
) {
1689 downstream_comp
= g_hash_table_lookup(ctx
->sink_components
,
1690 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1691 port_count_fn
= (input_port_count_func_t
)
1692 bt_component_sink_get_input_port_count
;
1693 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1694 bt_component_sink_borrow_input_port_by_index_const
;
1697 if (!downstream_comp
) {
1698 BT_LOGE("Cannot find downstream component: comp-name=\"%s\", "
1699 "conn-arg=\"%s\"", cfg_conn
->downstream_comp_name
->str
,
1700 cfg_conn
->arg
->str
);
1701 fprintf(stderr
, "Cannot create connection: cannot find downstream component: %s\n",
1702 cfg_conn
->arg
->str
);
1706 downstream_port_count
= port_count_fn(downstream_comp
);
1708 for (i
= 0; i
< downstream_port_count
; i
++) {
1709 const bt_port_input
*in_downstream_port
=
1710 port_by_index_fn(downstream_comp
, i
);
1711 const bt_port
*downstream_port
=
1712 bt_port_input_as_port_const(in_downstream_port
);
1713 const char *upstream_port_name
;
1714 const char *downstream_port_name
;
1716 BT_ASSERT(downstream_port
);
1718 /* Skip port if it's already connected. */
1719 if (bt_port_is_connected(downstream_port
)) {
1720 BT_LOGI("Skipping downstream port: already connected: "
1721 "port-addr=%p, port-name=\"%s\"",
1723 bt_port_get_name(downstream_port
));
1727 downstream_port_name
= bt_port_get_name(downstream_port
);
1728 BT_ASSERT(downstream_port_name
);
1729 upstream_port_name
= bt_port_get_name(upstream_port
);
1730 BT_ASSERT(upstream_port_name
);
1732 if (!bt_common_star_glob_match(
1733 cfg_conn
->downstream_port_glob
->str
, SIZE_MAX
,
1734 downstream_port_name
, SIZE_MAX
)) {
1738 if (insert_trimmer
) {
1740 * In order to insert the trimmer between the
1741 * two components that were being connected, we
1742 * create a connection configuration entry which
1743 * describes a connection from the trimmer's
1744 * output to the original input that was being
1747 * Hence, the creation of the trimmer will cause
1748 * the graph "new port" listener to establish
1749 * all downstream connections as its output port
1750 * is connected. We will then establish the
1751 * connection between the original upstream
1752 * source and the trimmer.
1754 char *trimmer_name
= NULL
;
1755 bt_graph_status graph_status
;
1757 ret
= asprintf(&trimmer_name
,
1758 "stream-intersection-trimmer-%s",
1759 upstream_port_name
);
1765 ctx
->connect_ports
= false;
1766 graph_status
= bt_graph_add_filter_component(
1767 ctx
->graph
, trimmer_class
, trimmer_name
,
1768 trimmer_params
, ctx
->cfg
->log_level
,
1771 if (graph_status
!= BT_GRAPH_STATUS_OK
) {
1777 bt_component_filter_borrow_input_port_by_index_const(
1779 if (!trimmer_input
) {
1783 bt_component_filter_borrow_output_port_by_index_const(
1785 if (!trimmer_output
) {
1790 * Replace the current downstream port by the trimmer's
1793 in_downstream_port
= trimmer_input
;
1795 bt_port_input_as_port_const(in_downstream_port
);
1796 downstream_port_name
= bt_port_get_name(
1798 BT_ASSERT(downstream_port_name
);
1801 /* We have a winner! */
1802 status
= bt_graph_connect_ports(ctx
->graph
,
1803 out_upstream_port
, in_downstream_port
, NULL
);
1804 downstream_port
= NULL
;
1806 case BT_GRAPH_STATUS_OK
:
1808 case BT_GRAPH_STATUS_CANCELED
:
1809 BT_LOGI_STR("Graph was canceled by user.");
1810 status
= BT_GRAPH_STATUS_OK
;
1812 case BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION
:
1813 BT_LOGE("A component refused a connection to one of its ports: "
1814 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1815 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1816 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1817 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1819 upstream_comp
, bt_component_get_name(upstream_comp
),
1820 upstream_port
, bt_port_get_name(upstream_port
),
1821 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1822 downstream_port
, downstream_port_name
,
1823 cfg_conn
->arg
->str
);
1825 "A component refused a connection to one of its ports (`%s` to `%s`): %s\n",
1826 bt_port_get_name(upstream_port
),
1827 downstream_port_name
,
1828 cfg_conn
->arg
->str
);
1831 BT_LOGE("Cannot create connection: graph refuses to connect ports: "
1832 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1833 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1834 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1835 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1837 upstream_comp
, bt_component_get_name(upstream_comp
),
1838 upstream_port
, bt_port_get_name(upstream_port
),
1839 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1840 downstream_port
, downstream_port_name
,
1841 cfg_conn
->arg
->str
);
1843 "Cannot create connection: graph refuses to connect ports (`%s` to `%s`): %s\n",
1844 bt_port_get_name(upstream_port
),
1845 downstream_port_name
,
1846 cfg_conn
->arg
->str
);
1850 BT_LOGI("Connected component ports: "
1851 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1852 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1853 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1854 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1856 upstream_comp
, bt_component_get_name(upstream_comp
),
1857 upstream_port
, bt_port_get_name(upstream_port
),
1858 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1859 downstream_port
, downstream_port_name
,
1860 cfg_conn
->arg
->str
);
1862 if (insert_trimmer
) {
1864 * The first connection, from the source to the trimmer,
1865 * has been done. We now connect the trimmer to the
1866 * original downstream port.
1868 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1870 bt_component_filter_as_component_const(trimmer
),
1871 trimmer_output
, cfg_conn
);
1875 ctx
->connect_ports
= true;
1879 * We found a matching downstream port: the search is
1885 /* No downstream port found */
1886 BT_LOGE("Cannot create connection: cannot find a matching downstream port for upstream port: "
1887 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1888 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1889 upstream_port
, bt_port_get_name(upstream_port
),
1890 cfg_conn
->downstream_comp_name
->str
,
1891 cfg_conn
->arg
->str
);
1893 "Cannot create connection: cannot find a matching downstream port for upstream port `%s`: %s\n",
1894 bt_port_get_name(upstream_port
), cfg_conn
->arg
->str
);
1900 free(intersection_begin
);
1901 free(intersection_end
);
1902 BT_VALUE_PUT_REF_AND_RESET(trimmer_params
);
1903 BT_COMPONENT_CLASS_FILTER_PUT_REF_AND_RESET(trimmer_class
);
1904 BT_COMPONENT_FILTER_PUT_REF_AND_RESET(trimmer
);
1909 int cmd_run_ctx_connect_upstream_port(struct cmd_run_ctx
*ctx
,
1910 const bt_port_output
*upstream_port
)
1913 const char *upstream_port_name
;
1914 const char *upstream_comp_name
;
1915 const bt_component
*upstream_comp
= NULL
;
1919 BT_ASSERT(upstream_port
);
1920 upstream_port_name
= bt_port_get_name(
1921 bt_port_output_as_port_const(upstream_port
));
1922 BT_ASSERT(upstream_port_name
);
1923 upstream_comp
= bt_port_borrow_component_const(
1924 bt_port_output_as_port_const(upstream_port
));
1925 if (!upstream_comp
) {
1926 BT_LOGW("Upstream port to connect is not part of a component: "
1927 "port-addr=%p, port-name=\"%s\"",
1928 upstream_port
, upstream_port_name
);
1933 upstream_comp_name
= bt_component_get_name(upstream_comp
);
1934 BT_ASSERT(upstream_comp_name
);
1935 BT_LOGI("Connecting upstream port: comp-addr=%p, comp-name=\"%s\", "
1936 "port-addr=%p, port-name=\"%s\"",
1937 upstream_comp
, upstream_comp_name
,
1938 upstream_port
, upstream_port_name
);
1940 for (i
= 0; i
< ctx
->cfg
->cmd_data
.run
.connections
->len
; i
++) {
1941 struct bt_config_connection
*cfg_conn
=
1943 ctx
->cfg
->cmd_data
.run
.connections
, i
);
1945 if (strcmp(cfg_conn
->upstream_comp_name
->str
,
1946 upstream_comp_name
)) {
1950 if (!bt_common_star_glob_match(
1951 cfg_conn
->upstream_port_glob
->str
,
1952 SIZE_MAX
, upstream_port_name
, SIZE_MAX
)) {
1956 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1957 ctx
, upstream_comp
, upstream_port
, cfg_conn
);
1959 BT_LOGE("Cannot connect upstream port: "
1960 "port-addr=%p, port-name=\"%s\"",
1962 upstream_port_name
);
1964 "Cannot connect port `%s` of component `%s` to a downstream port: %s\n",
1967 cfg_conn
->arg
->str
);
1973 BT_LOGE("Cannot connect upstream port: port does not match any connection argument: "
1974 "port-addr=%p, port-name=\"%s\"", upstream_port
,
1975 upstream_port_name
);
1977 "Cannot create connection: upstream port `%s` does not match any connection\n",
1978 upstream_port_name
);
1988 bt_graph_listener_status
1989 graph_output_port_added_listener(struct cmd_run_ctx
*ctx
,
1990 const bt_port_output
*out_port
)
1992 const bt_component
*comp
;
1993 const bt_port
*port
= bt_port_output_as_port_const(out_port
);
1994 bt_graph_listener_status ret
= BT_GRAPH_LISTENER_STATUS_OK
;
1996 comp
= bt_port_borrow_component_const(port
);
1997 BT_LOGI("Port added to a graph's component: comp-addr=%p, "
1998 "comp-name=\"%s\", port-addr=%p, port-name=\"%s\"",
1999 comp
, comp
? bt_component_get_name(comp
) : "",
2000 port
, bt_port_get_name(port
));
2002 if (!ctx
->connect_ports
) {
2007 BT_LOGW_STR("Port has no component.");
2011 if (bt_port_is_connected(port
)) {
2012 BT_LOGW_STR("Port is already connected.");
2016 if (cmd_run_ctx_connect_upstream_port(ctx
, out_port
)) {
2017 BT_LOGF_STR("Cannot connect upstream port.");
2018 fprintf(stderr
, "Added port could not be connected: aborting\n");
2019 ret
= BT_GRAPH_LISTENER_STATUS_ERROR
;
2028 bt_graph_listener_status
graph_source_output_port_added_listener(
2029 const bt_component_source
*component
,
2030 const bt_port_output
*port
, void *data
)
2032 return graph_output_port_added_listener(data
, port
);
2036 bt_graph_listener_status
graph_filter_output_port_added_listener(
2037 const bt_component_filter
*component
,
2038 const bt_port_output
*port
, void *data
)
2040 return 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 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 bt_component_class_source
*src_comp_cls
)
2149 int64_t trace_count
;
2150 const char *path
= NULL
;
2151 const bt_value
*query_result
= NULL
;
2152 const bt_value
*trace_info
= NULL
;
2153 const bt_value
*intersection_range
= NULL
;
2154 const bt_value
*intersection_begin
= NULL
;
2155 const bt_value
*intersection_end
= NULL
;
2156 const bt_value
*stream_infos
= NULL
;
2157 const bt_value
*stream_info
= NULL
;
2158 struct port_id
*port_id
= NULL
;
2159 struct trace_range
*trace_range
= NULL
;
2160 const char *fail_reason
= NULL
;
2161 const bt_component_class
*comp_cls
=
2162 bt_component_class_source_as_component_class_const(src_comp_cls
);
2164 ret
= query(ctx
->cfg
, comp_cls
, "trace-info",
2165 cfg_comp
->params
, &query_result
,
2168 BT_LOGD("Component class does not support the `trace-info` query: %s: "
2169 "comp-class-name=\"%s\"", fail_reason
,
2170 bt_component_class_get_name(comp_cls
));
2175 BT_ASSERT(query_result
);
2177 if (!bt_value_is_array(query_result
)) {
2178 BT_LOGD("Unexpected format of \'trace-info\' query result: "
2179 "component-class-name=%s",
2180 bt_component_class_get_name(comp_cls
));
2185 trace_count
= bt_value_array_get_size(query_result
);
2186 if (trace_count
< 0) {
2191 for (trace_idx
= 0; trace_idx
< trace_count
; trace_idx
++) {
2193 uint64_t stream_idx
;
2194 int64_t stream_count
;
2196 trace_info
= bt_value_array_borrow_element_by_index_const(
2197 query_result
, trace_idx
);
2198 if (!trace_info
|| !bt_value_is_map(trace_info
)) {
2200 BT_LOGD_STR("Cannot retrieve trace from query result.");
2204 intersection_range
= bt_value_map_borrow_entry_value_const(
2205 trace_info
, "intersection-range-ns");
2206 if (!intersection_range
) {
2208 BT_LOGD_STR("Cannot retrieve \'intersetion-range-ns\' field from query result.");
2212 intersection_begin
= bt_value_map_borrow_entry_value_const(intersection_range
,
2214 if (!intersection_begin
) {
2216 BT_LOGD_STR("Cannot retrieve intersection-range-ns \'begin\' field from query result.");
2220 intersection_end
= bt_value_map_borrow_entry_value_const(intersection_range
,
2222 if (!intersection_end
) {
2224 BT_LOGD_STR("Cannot retrieve intersection-range-ns \'end\' field from query result.");
2228 begin
= bt_value_signed_integer_get(intersection_begin
);
2229 end
= bt_value_signed_integer_get(intersection_end
);
2231 if (begin
< 0 || end
< 0 || end
< begin
) {
2232 BT_LOGW("Invalid trace stream intersection values: "
2233 "intersection-range-ns:begin=%" PRId64
2234 ", intersection-range-ns:end=%" PRId64
,
2240 stream_infos
= bt_value_map_borrow_entry_value_const(trace_info
,
2242 if (!stream_infos
|| !bt_value_is_array(stream_infos
)) {
2244 BT_LOGD_STR("Cannot retrieve stream information from trace in query result.");
2248 stream_count
= bt_value_array_get_size(stream_infos
);
2249 if (stream_count
< 0) {
2254 for (stream_idx
= 0; stream_idx
< stream_count
; stream_idx
++) {
2255 const bt_value
*port_name
;
2257 port_id
= g_new0(struct port_id
, 1);
2260 BT_LOGE_STR("Cannot allocate memory for port_id structure.");
2263 port_id
->instance_name
= strdup(cfg_comp
->instance_name
->str
);
2264 if (!port_id
->instance_name
) {
2266 BT_LOGE_STR("Cannot allocate memory for port_id component instance name.");
2270 trace_range
= g_new0(struct trace_range
, 1);
2273 BT_LOGE_STR("Cannot allocate memory for trace_range structure.");
2276 trace_range
->intersection_range_begin_ns
= begin
;
2277 trace_range
->intersection_range_end_ns
= end
;
2279 stream_info
= bt_value_array_borrow_element_by_index_const(
2280 stream_infos
, stream_idx
);
2281 if (!stream_info
|| !bt_value_is_map(stream_info
)) {
2283 BT_LOGE_STR("Cannot retrieve stream informations from trace in query result.");
2287 port_name
= bt_value_map_borrow_entry_value_const(stream_info
, "port-name");
2288 if (!port_name
|| !bt_value_is_string(port_name
)) {
2290 BT_LOGE_STR("Cannot retrieve port name in query result.");
2294 port_id
->port_name
= g_strdup(bt_value_string_get(port_name
));
2295 if (!port_id
->port_name
) {
2297 BT_LOGE_STR("Cannot allocate memory for port_id port_name.");
2301 BT_LOGD("Inserting stream intersection ");
2303 g_hash_table_insert(ctx
->intersections
, port_id
, trace_range
);
2313 fprintf(stderr
, "%s%sCannot determine stream intersection of trace at path \'%s\'.%s\n",
2314 bt_common_color_bold(),
2315 bt_common_color_fg_yellow(),
2316 path
? path
: "(unknown)",
2317 bt_common_color_reset());
2319 bt_value_put_ref(query_result
);
2321 g_free(trace_range
);
2326 int cmd_run_ctx_create_components_from_config_components(
2327 struct cmd_run_ctx
*ctx
, GPtrArray
*cfg_components
)
2330 const void *comp_cls
= NULL
;
2331 const void *comp
= NULL
;
2334 for (i
= 0; i
< cfg_components
->len
; i
++) {
2335 struct bt_config_component
*cfg_comp
=
2336 g_ptr_array_index(cfg_components
, i
);
2339 switch (cfg_comp
->type
) {
2340 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2341 comp_cls
= find_source_component_class(
2342 cfg_comp
->plugin_name
->str
,
2343 cfg_comp
->comp_cls_name
->str
);
2345 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2346 comp_cls
= find_filter_component_class(
2347 cfg_comp
->plugin_name
->str
,
2348 cfg_comp
->comp_cls_name
->str
);
2350 case BT_COMPONENT_CLASS_TYPE_SINK
:
2351 comp_cls
= find_sink_component_class(
2352 cfg_comp
->plugin_name
->str
,
2353 cfg_comp
->comp_cls_name
->str
);
2360 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
2361 "comp-cls-name=\"%s\", comp-cls-type=%d",
2362 cfg_comp
->plugin_name
->str
,
2363 cfg_comp
->comp_cls_name
->str
,
2365 fprintf(stderr
, "%s%sCannot find component class %s",
2366 bt_common_color_bold(),
2367 bt_common_color_fg_red(),
2368 bt_common_color_reset());
2369 print_plugin_comp_cls_opt(stderr
,
2370 cfg_comp
->plugin_name
->str
,
2371 cfg_comp
->comp_cls_name
->str
,
2373 fprintf(stderr
, "\n");
2377 BT_ASSERT(cfg_comp
->log_level
>= BT_LOG_VERBOSE
);
2379 switch (cfg_comp
->type
) {
2380 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2381 ret
= bt_graph_add_source_component(ctx
->graph
,
2382 comp_cls
, cfg_comp
->instance_name
->str
,
2383 cfg_comp
->params
, cfg_comp
->log_level
,
2386 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2387 ret
= bt_graph_add_filter_component(ctx
->graph
,
2388 comp_cls
, cfg_comp
->instance_name
->str
,
2389 cfg_comp
->params
, cfg_comp
->log_level
,
2392 case BT_COMPONENT_CLASS_TYPE_SINK
:
2393 ret
= bt_graph_add_sink_component(ctx
->graph
,
2394 comp_cls
, cfg_comp
->instance_name
->str
,
2395 cfg_comp
->params
, cfg_comp
->log_level
,
2403 BT_LOGE("Cannot create component: plugin-name=\"%s\", "
2404 "comp-cls-name=\"%s\", comp-cls-type=%d, "
2406 cfg_comp
->plugin_name
->str
,
2407 cfg_comp
->comp_cls_name
->str
,
2408 cfg_comp
->type
, cfg_comp
->instance_name
->str
);
2409 fprintf(stderr
, "%s%sCannot create component `%s`%s\n",
2410 bt_common_color_bold(),
2411 bt_common_color_fg_red(),
2412 cfg_comp
->instance_name
->str
,
2413 bt_common_color_reset());
2417 if (ctx
->stream_intersection_mode
&&
2418 cfg_comp
->type
== BT_COMPONENT_CLASS_TYPE_SOURCE
) {
2419 ret
= set_stream_intersections(ctx
, cfg_comp
, comp_cls
);
2425 BT_LOGI("Created and inserted component: comp-addr=%p, comp-name=\"%s\"",
2426 comp
, cfg_comp
->instance_name
->str
);
2427 quark
= g_quark_from_string(cfg_comp
->instance_name
->str
);
2428 BT_ASSERT(quark
> 0);
2430 switch (cfg_comp
->type
) {
2431 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2432 g_hash_table_insert(ctx
->src_components
,
2433 GUINT_TO_POINTER(quark
), (void *) comp
);
2435 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2436 g_hash_table_insert(ctx
->flt_components
,
2437 GUINT_TO_POINTER(quark
), (void *) comp
);
2439 case BT_COMPONENT_CLASS_TYPE_SINK
:
2440 g_hash_table_insert(ctx
->sink_components
,
2441 GUINT_TO_POINTER(quark
), (void *) comp
);
2448 BT_OBJECT_PUT_REF_AND_RESET(comp_cls
);
2457 bt_object_put_ref(comp
);
2458 bt_object_put_ref(comp_cls
);
2463 int cmd_run_ctx_create_components(struct cmd_run_ctx
*ctx
)
2468 * Make sure that, during this phase, our graph's "port added"
2469 * listener does not connect ports while we are creating the
2470 * components because we have a special, initial phase for
2473 ctx
->connect_ports
= false;
2475 ret
= cmd_run_ctx_create_components_from_config_components(
2476 ctx
, ctx
->cfg
->cmd_data
.run
.sources
);
2482 ret
= cmd_run_ctx_create_components_from_config_components(
2483 ctx
, ctx
->cfg
->cmd_data
.run
.filters
);
2489 ret
= cmd_run_ctx_create_components_from_config_components(
2490 ctx
, ctx
->cfg
->cmd_data
.run
.sinks
);
2500 typedef uint64_t (*output_port_count_func_t
)(const void *);
2501 typedef const bt_port_output
*(*borrow_output_port_by_index_func_t
)(
2502 const void *, uint64_t);
2505 int cmd_run_ctx_connect_comp_ports(struct cmd_run_ctx
*ctx
,
2506 void *comp
, output_port_count_func_t port_count_fn
,
2507 borrow_output_port_by_index_func_t port_by_index_fn
)
2513 count
= port_count_fn(comp
);
2515 for (i
= 0; i
< count
; i
++) {
2516 const bt_port_output
*upstream_port
= port_by_index_fn(comp
, i
);
2518 BT_ASSERT(upstream_port
);
2519 ret
= cmd_run_ctx_connect_upstream_port(ctx
, upstream_port
);
2530 int cmd_run_ctx_connect_ports(struct cmd_run_ctx
*ctx
)
2533 GHashTableIter iter
;
2534 gpointer g_name_quark
, g_comp
;
2536 ctx
->connect_ports
= true;
2537 g_hash_table_iter_init(&iter
, ctx
->src_components
);
2539 while (g_hash_table_iter_next(&iter
, &g_name_quark
, &g_comp
)) {
2540 ret
= cmd_run_ctx_connect_comp_ports(ctx
, g_comp
,
2541 (output_port_count_func_t
)
2542 bt_component_source_get_output_port_count
,
2543 (borrow_output_port_by_index_func_t
)
2544 bt_component_source_borrow_output_port_by_index_const
);
2550 g_hash_table_iter_init(&iter
, ctx
->flt_components
);
2552 while (g_hash_table_iter_next(&iter
, &g_name_quark
, &g_comp
)) {
2553 ret
= cmd_run_ctx_connect_comp_ports(ctx
, g_comp
,
2554 (output_port_count_func_t
)
2555 bt_component_filter_get_output_port_count
,
2556 (borrow_output_port_by_index_func_t
)
2557 bt_component_filter_borrow_output_port_by_index_const
);
2568 const char *bt_graph_status_str(bt_graph_status status
)
2571 case BT_GRAPH_STATUS_OK
:
2572 return "BT_GRAPH_STATUS_OK";
2573 case BT_GRAPH_STATUS_END
:
2574 return "BT_GRAPH_STATUS_END";
2575 case BT_GRAPH_STATUS_AGAIN
:
2576 return "BT_GRAPH_STATUS_AGAIN";
2577 case BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION
:
2578 return "BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION";
2579 case BT_GRAPH_STATUS_CANCELED
:
2580 return "BT_GRAPH_STATUS_CANCELED";
2581 case BT_GRAPH_STATUS_ERROR
:
2582 return "BT_GRAPH_STATUS_ERROR";
2583 case BT_GRAPH_STATUS_NOMEM
:
2584 return "BT_GRAPH_STATUS_NOMEM";
2591 int cmd_run(struct bt_config
*cfg
)
2594 struct cmd_run_ctx ctx
= { 0 };
2596 /* Initialize the command's context and the graph object */
2597 if (cmd_run_ctx_init(&ctx
, cfg
)) {
2598 BT_LOGE_STR("Cannot initialize the command's context.");
2599 fprintf(stderr
, "Cannot initialize the command's context\n");
2604 BT_LOGI_STR("Canceled by user before creating components.");
2608 BT_LOGI_STR("Creating components.");
2610 /* Create the requested component instances */
2611 if (cmd_run_ctx_create_components(&ctx
)) {
2612 BT_LOGE_STR("Cannot create components.");
2613 fprintf(stderr
, "Cannot create components\n");
2618 BT_LOGI_STR("Canceled by user before connecting components.");
2622 BT_LOGI_STR("Connecting components.");
2624 /* Connect the initially visible component ports */
2625 if (cmd_run_ctx_connect_ports(&ctx
)) {
2626 BT_LOGE_STR("Cannot connect initial component ports.");
2627 fprintf(stderr
, "Cannot connect initial component ports\n");
2632 BT_LOGI_STR("Canceled by user before running the graph.");
2636 BT_LOGI_STR("Running the graph.");
2640 bt_graph_status graph_status
= bt_graph_run(ctx
.graph
);
2643 * Reset console in case something messed with console
2644 * codes during the graph's execution.
2646 printf("%s", bt_common_color_reset());
2648 fprintf(stderr
, "%s", bt_common_color_reset());
2649 BT_LOGV("bt_graph_run() returned: status=%s",
2650 bt_graph_status_str(graph_status
));
2652 switch (graph_status
) {
2653 case BT_GRAPH_STATUS_OK
:
2655 case BT_GRAPH_STATUS_CANCELED
:
2656 BT_LOGI_STR("Graph was canceled by user.");
2658 case BT_GRAPH_STATUS_AGAIN
:
2659 if (bt_graph_is_canceled(ctx
.graph
)) {
2660 BT_LOGI_STR("Graph was canceled by user.");
2664 if (cfg
->cmd_data
.run
.retry_duration_us
> 0) {
2665 BT_LOGV("Got BT_GRAPH_STATUS_AGAIN: sleeping: "
2667 cfg
->cmd_data
.run
.retry_duration_us
);
2669 if (usleep(cfg
->cmd_data
.run
.retry_duration_us
)) {
2670 if (bt_graph_is_canceled(ctx
.graph
)) {
2671 BT_LOGI_STR("Graph was canceled by user.");
2677 case BT_GRAPH_STATUS_END
:
2680 BT_LOGE_STR("Graph failed to complete successfully");
2681 fprintf(stderr
, "Graph failed to complete successfully\n");
2694 cmd_run_ctx_destroy(&ctx
);
2699 void warn_command_name_and_directory_clash(struct bt_config
*cfg
)
2701 const char *env_clash
;
2703 if (!cfg
->command_name
) {
2707 env_clash
= getenv(ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH
);
2708 if (env_clash
&& strcmp(env_clash
, "0") == 0) {
2712 if (g_file_test(cfg
->command_name
,
2713 G_FILE_TEST_EXISTS
| G_FILE_TEST_IS_DIR
)) {
2714 fprintf(stderr
, "\nNOTE: The `%s` command was executed. If you meant to convert a\n",
2716 fprintf(stderr
, "trace located in the local `%s` directory, please use:\n",
2718 fprintf(stderr
, "\n");
2719 fprintf(stderr
, " babeltrace2 convert %s [OPTIONS]\n",
2725 void init_log_level(void)
2727 bt_cli_log_level
= bt_log_get_level_from_env(ENV_BABELTRACE_CLI_LOG_LEVEL
);
2731 void set_auto_log_levels(struct bt_config
*cfg
)
2733 const char **env_var_name
;
2736 * Override the configuration's default log level if
2737 * BABELTRACE_VERBOSE or BABELTRACE_DEBUG environment variables
2738 * are found for backward compatibility with legacy Babetrace 1.
2740 if (getenv("BABELTRACE_DEBUG") &&
2741 strcmp(getenv("BABELTRACE_DEBUG"), "1") == 0) {
2742 cfg
->log_level
= BT_LOG_VERBOSE
;
2743 } else if (getenv("BABELTRACE_VERBOSE") &&
2744 strcmp(getenv("BABELTRACE_VERBOSE"), "1") == 0) {
2745 cfg
->log_level
= BT_LOG_INFO
;
2749 * Set log levels according to --debug or --verbose. For
2750 * backward compatibility, --debug is more verbose than
2753 * --verbose: INFO log level
2754 * --debug: VERBOSE log level (includes DEBUG, which is
2755 * is less verbose than VERBOSE in the internal
2756 * logging framework)
2758 if (!getenv("LIBBABELTRACE2_INIT_LOG_LEVEL")) {
2760 bt_logging_set_global_level(BT_LOG_INFO
);
2761 } else if (cfg
->debug
) {
2762 bt_logging_set_global_level(BT_LOG_VERBOSE
);
2765 * Set library's default log level if not
2766 * explicitly specified.
2768 bt_logging_set_global_level(cfg
->log_level
);
2772 if (!getenv(ENV_BABELTRACE_CLI_LOG_LEVEL
)) {
2774 bt_cli_log_level
= BT_LOG_INFO
;
2775 } else if (cfg
->debug
) {
2776 bt_cli_log_level
= BT_LOG_VERBOSE
;
2779 * Set CLI's default log level if not explicitly
2782 bt_cli_log_level
= cfg
->log_level
;
2786 env_var_name
= log_level_env_var_names
;
2788 while (*env_var_name
) {
2789 if (!getenv(*env_var_name
)) {
2791 g_setenv(*env_var_name
, "I", 1);
2792 } else if (cfg
->debug
) {
2793 g_setenv(*env_var_name
, "V", 1);
2795 char val
[2] = { 0 };
2798 * Set module's default log level if not
2799 * explicitly specified.
2801 val
[0] = bt_log_get_letter_from_level(
2803 g_setenv(*env_var_name
, val
, 1);
2811 int main(int argc
, const char **argv
)
2815 struct bt_config
*cfg
;
2818 set_signal_handler();
2820 cfg
= bt_config_cli_args_create_with_default(argc
, argv
, &retcode
);
2823 /* Quit without errors; typically usage/version */
2825 BT_LOGI_STR("Quitting without errors.");
2830 BT_LOGE("Command-line error: retcode=%d", retcode
);
2835 BT_LOGE_STR("Failed to create a valid Babeltrace configuration.");
2836 fprintf(stderr
, "Failed to create Babeltrace configuration\n");
2841 set_auto_log_levels(cfg
);
2844 if (cfg
->command_needs_plugins
) {
2845 ret
= load_all_plugins(cfg
->plugin_paths
);
2847 BT_LOGE("Failed to load plugins: ret=%d", ret
);
2853 BT_LOGI("Executing command: cmd=%d, command-name=\"%s\"",
2854 cfg
->command
, cfg
->command_name
);
2856 switch (cfg
->command
) {
2857 case BT_CONFIG_COMMAND_RUN
:
2860 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
2861 ret
= cmd_list_plugins(cfg
);
2863 case BT_CONFIG_COMMAND_HELP
:
2864 ret
= cmd_help(cfg
);
2866 case BT_CONFIG_COMMAND_QUERY
:
2867 ret
= cmd_query(cfg
);
2869 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
2870 ret
= cmd_print_ctf_metadata(cfg
);
2872 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
2873 ret
= cmd_print_lttng_live_sessions(cfg
);
2876 BT_LOGF("Invalid/unknown command: cmd=%d", cfg
->command
);
2880 BT_LOGI("Command completed: cmd=%d, command-name=\"%s\", ret=%d",
2881 cfg
->command
, cfg
->command_name
, ret
);
2882 warn_command_name_and_directory_clash(cfg
);
2883 retcode
= ret
? 1 : 0;
2886 BT_OBJECT_PUT_REF_AND_RESET(cfg
);