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_query_status query_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 query_status
= bt_query_executor_query(
186 the_query_executor
, comp_cls
, obj
, params
,
187 cfg
->log_level
, &result
);
188 switch (query_status
) {
189 case BT_QUERY_EXECUTOR_QUERY_STATUS_OK
:
191 case BT_QUERY_EXECUTOR_QUERY_STATUS_AGAIN
:
193 const uint64_t sleep_time_us
= 100000;
195 /* Wait 100 ms and retry */
196 BT_LOGD("Got BT_QUERY_EXECUTOR_QUERY_STATUS_AGAIN: sleeping: "
197 "time-us=%" PRIu64
, sleep_time_us
);
199 if (usleep(sleep_time_us
)) {
200 if (bt_query_executor_is_canceled(the_query_executor
)) {
201 BT_LOGI("Query was canceled by user: "
202 "comp-cls-addr=%p, comp-cls-name=\"%s\", "
203 "query-obj=\"%s\"", comp_cls
,
204 bt_component_class_get_name(comp_cls
),
206 *fail_reason
= "canceled by user";
213 case BT_QUERY_EXECUTOR_QUERY_STATUS_CANCELED
:
214 *fail_reason
= "canceled by user";
216 case BT_QUERY_EXECUTOR_QUERY_STATUS_ERROR
:
218 case BT_QUERY_EXECUTOR_QUERY_STATUS_INVALID_OBJECT
:
219 *fail_reason
= "invalid or unknown query object";
221 case BT_QUERY_EXECUTOR_QUERY_STATUS_INVALID_PARAMS
:
222 *fail_reason
= "invalid query parameters";
224 case BT_QUERY_EXECUTOR_QUERY_STATUS_UNSUPPORTED
:
225 *fail_reason
= "unsupported action";
227 case BT_QUERY_EXECUTOR_QUERY_STATUS_MEMORY_ERROR
:
228 *fail_reason
= "not enough memory";
231 BT_LOGF("Unknown query status: status=%s",
232 bt_common_func_status_string(
239 *user_result
= result
;
247 destroy_the_query_executor();
248 bt_value_put_ref(result
);
253 const bt_plugin
*find_plugin(const char *name
)
256 const bt_plugin
*plugin
= NULL
;
259 BT_LOGI("Finding plugin: name=\"%s\"", name
);
261 for (i
= 0; i
< loaded_plugins
->len
; i
++) {
262 plugin
= g_ptr_array_index(loaded_plugins
, i
);
264 if (strcmp(name
, bt_plugin_get_name(plugin
)) == 0) {
272 BT_LOGI("Found plugin: name=\"%s\", plugin-addr=%p",
275 BT_LOGI("Cannot find plugin: name=\"%s\"", name
);
278 bt_plugin_get_ref(plugin
);
282 typedef const void *(*plugin_borrow_comp_cls_func_t
)(
283 const bt_plugin
*, const char *);
286 const void *find_component_class_from_plugin(const char *plugin_name
,
287 const char *comp_class_name
,
288 plugin_borrow_comp_cls_func_t plugin_borrow_comp_cls_func
)
290 const void *comp_class
= NULL
;
291 const bt_plugin
*plugin
;
293 BT_LOGI("Finding component class: plugin-name=\"%s\", "
294 "comp-cls-name=\"%s\"", plugin_name
, comp_class_name
);
296 plugin
= find_plugin(plugin_name
);
301 comp_class
= plugin_borrow_comp_cls_func(plugin
, comp_class_name
);
302 bt_object_get_ref(comp_class
);
303 BT_PLUGIN_PUT_REF_AND_RESET(plugin
);
307 BT_LOGI("Found component class: plugin-name=\"%s\", "
308 "comp-cls-name=\"%s\"", plugin_name
, comp_class_name
);
310 BT_LOGI("Cannot find source component class: "
311 "plugin-name=\"%s\", comp-cls-name=\"%s\"",
312 plugin_name
, comp_class_name
);
319 const bt_component_class_source
*find_source_component_class(
320 const char *plugin_name
, const char *comp_class_name
)
322 return (const void *) find_component_class_from_plugin(
323 plugin_name
, comp_class_name
,
324 (plugin_borrow_comp_cls_func_t
)
325 bt_plugin_borrow_source_component_class_by_name_const
);
329 const bt_component_class_filter
*find_filter_component_class(
330 const char *plugin_name
, const char *comp_class_name
)
332 return (const void *) find_component_class_from_plugin(
333 plugin_name
, comp_class_name
,
334 (plugin_borrow_comp_cls_func_t
)
335 bt_plugin_borrow_filter_component_class_by_name_const
);
339 const bt_component_class_sink
*find_sink_component_class(
340 const char *plugin_name
, const char *comp_class_name
)
342 return (const void *) find_component_class_from_plugin(plugin_name
,
344 (plugin_borrow_comp_cls_func_t
)
345 bt_plugin_borrow_sink_component_class_by_name_const
);
349 const bt_component_class
*find_component_class(const char *plugin_name
,
350 const char *comp_class_name
,
351 bt_component_class_type comp_class_type
)
353 const bt_component_class
*comp_cls
= NULL
;
355 switch (comp_class_type
) {
356 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
357 comp_cls
= bt_component_class_source_as_component_class_const(find_source_component_class(plugin_name
, comp_class_name
));
359 case BT_COMPONENT_CLASS_TYPE_FILTER
:
360 comp_cls
= bt_component_class_filter_as_component_class_const(find_filter_component_class(plugin_name
, comp_class_name
));
362 case BT_COMPONENT_CLASS_TYPE_SINK
:
363 comp_cls
= bt_component_class_sink_as_component_class_const(find_sink_component_class(plugin_name
, comp_class_name
));
373 void print_indent(FILE *fp
, size_t indent
)
377 for (i
= 0; i
< indent
; i
++) {
383 const char *component_type_str(bt_component_class_type type
)
386 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
388 case BT_COMPONENT_CLASS_TYPE_SINK
:
390 case BT_COMPONENT_CLASS_TYPE_FILTER
:
398 void print_plugin_comp_cls_opt(FILE *fh
, const char *plugin_name
,
399 const char *comp_cls_name
, bt_component_class_type type
)
401 GString
*shell_plugin_name
= NULL
;
402 GString
*shell_comp_cls_name
= NULL
;
404 shell_plugin_name
= bt_common_shell_quote(plugin_name
, false);
405 if (!shell_plugin_name
) {
409 shell_comp_cls_name
= bt_common_shell_quote(comp_cls_name
, false);
410 if (!shell_comp_cls_name
) {
414 fprintf(fh
, "'%s%s%s%s.%s%s%s.%s%s%s'",
415 bt_common_color_bold(),
416 bt_common_color_fg_cyan(),
417 component_type_str(type
),
418 bt_common_color_fg_default(),
419 bt_common_color_fg_blue(),
420 shell_plugin_name
->str
,
421 bt_common_color_fg_default(),
422 bt_common_color_fg_yellow(),
423 shell_comp_cls_name
->str
,
424 bt_common_color_reset());
427 if (shell_plugin_name
) {
428 g_string_free(shell_plugin_name
, TRUE
);
431 if (shell_comp_cls_name
) {
432 g_string_free(shell_comp_cls_name
, TRUE
);
437 void print_value(FILE *, const bt_value
*, size_t);
440 void print_value_rec(FILE *, const bt_value
*, size_t);
442 struct print_map_value_data
{
448 bt_bool
print_map_value(const char *key
, const bt_value
*object
,
451 struct print_map_value_data
*print_map_value_data
= data
;
453 print_indent(print_map_value_data
->fp
, print_map_value_data
->indent
);
454 fprintf(print_map_value_data
->fp
, "%s: ", key
);
457 if (bt_value_is_array(object
) &&
458 bt_value_array_is_empty(object
)) {
459 fprintf(print_map_value_data
->fp
, "[ ]\n");
463 if (bt_value_is_map(object
) &&
464 bt_value_map_is_empty(object
)) {
465 fprintf(print_map_value_data
->fp
, "{ }\n");
469 if (bt_value_is_array(object
) ||
470 bt_value_is_map(object
)) {
471 fprintf(print_map_value_data
->fp
, "\n");
474 print_value_rec(print_map_value_data
->fp
, object
,
475 print_map_value_data
->indent
+ 2);
480 void print_value_rec(FILE *fp
, const bt_value
*value
, size_t indent
)
494 switch (bt_value_get_type(value
)) {
495 case BT_VALUE_TYPE_NULL
:
496 fprintf(fp
, "%snull%s\n", bt_common_color_bold(),
497 bt_common_color_reset());
499 case BT_VALUE_TYPE_BOOL
:
500 bool_val
= bt_value_bool_get(value
);
501 fprintf(fp
, "%s%s%s%s\n", bt_common_color_bold(),
502 bt_common_color_fg_cyan(), bool_val
? "yes" : "no",
503 bt_common_color_reset());
505 case BT_VALUE_TYPE_UNSIGNED_INTEGER
:
506 uint_val
= bt_value_unsigned_integer_get(value
);
507 fprintf(fp
, "%s%s%" PRIu64
"%s\n", bt_common_color_bold(),
508 bt_common_color_fg_red(), uint_val
,
509 bt_common_color_reset());
511 case BT_VALUE_TYPE_SIGNED_INTEGER
:
512 int_val
= bt_value_signed_integer_get(value
);
513 fprintf(fp
, "%s%s%" PRId64
"%s\n", bt_common_color_bold(),
514 bt_common_color_fg_red(), int_val
,
515 bt_common_color_reset());
517 case BT_VALUE_TYPE_REAL
:
518 dbl_val
= bt_value_real_get(value
);
519 fprintf(fp
, "%s%s%lf%s\n", bt_common_color_bold(),
520 bt_common_color_fg_red(), dbl_val
,
521 bt_common_color_reset());
523 case BT_VALUE_TYPE_STRING
:
524 str_val
= bt_value_string_get(value
);
525 fprintf(fp
, "%s%s%s%s\n", bt_common_color_bold(),
526 bt_common_color_fg_green(), str_val
,
527 bt_common_color_reset());
529 case BT_VALUE_TYPE_ARRAY
:
530 size
= bt_value_array_get_size(value
);
536 print_indent(fp
, indent
);
537 fprintf(fp
, "[ ]\n");
541 for (i
= 0; i
< size
; i
++) {
542 const bt_value
*element
=
543 bt_value_array_borrow_element_by_index_const(
549 print_indent(fp
, indent
);
552 if (bt_value_is_array(element
) &&
553 bt_value_array_is_empty(element
)) {
554 fprintf(fp
, "[ ]\n");
558 if (bt_value_is_map(element
) &&
559 bt_value_map_is_empty(element
)) {
560 fprintf(fp
, "{ }\n");
564 if (bt_value_is_array(element
) ||
565 bt_value_is_map(element
)) {
569 print_value_rec(fp
, element
, indent
+ 2);
572 case BT_VALUE_TYPE_MAP
:
574 struct print_map_value_data data
= {
579 if (bt_value_map_is_empty(value
)) {
580 print_indent(fp
, indent
);
581 fprintf(fp
, "{ }\n");
585 bt_value_map_foreach_entry_const(value
, print_map_value
, &data
);
594 BT_LOGE("Error printing value of type %s.",
595 bt_common_value_type_string(bt_value_get_type(value
)));
599 void print_value(FILE *fp
, const bt_value
*value
, size_t indent
)
601 if (!bt_value_is_array(value
) && !bt_value_is_map(value
)) {
602 print_indent(fp
, indent
);
605 print_value_rec(fp
, value
, indent
);
609 void print_bt_config_component(struct bt_config_component
*bt_config_component
)
611 fprintf(stderr
, " ");
612 print_plugin_comp_cls_opt(stderr
, bt_config_component
->plugin_name
->str
,
613 bt_config_component
->comp_cls_name
->str
,
614 bt_config_component
->type
);
615 fprintf(stderr
, ":\n");
617 if (bt_config_component
->instance_name
->len
> 0) {
618 fprintf(stderr
, " Name: %s\n",
619 bt_config_component
->instance_name
->str
);
622 fprintf(stderr
, " Parameters:\n");
623 print_value(stderr
, bt_config_component
->params
, 8);
627 void print_bt_config_components(GPtrArray
*array
)
631 for (i
= 0; i
< array
->len
; i
++) {
632 struct bt_config_component
*cfg_component
=
633 bt_config_get_component(array
, i
);
634 print_bt_config_component(cfg_component
);
635 BT_OBJECT_PUT_REF_AND_RESET(cfg_component
);
640 void print_plugin_paths(const bt_value
*plugin_paths
)
642 fprintf(stderr
, " Plugin paths:\n");
643 print_value(stderr
, plugin_paths
, 4);
647 void print_cfg_run(struct bt_config
*cfg
)
651 print_plugin_paths(cfg
->plugin_paths
);
652 fprintf(stderr
, " Source component instances:\n");
653 print_bt_config_components(cfg
->cmd_data
.run
.sources
);
655 if (cfg
->cmd_data
.run
.filters
->len
> 0) {
656 fprintf(stderr
, " Filter component instances:\n");
657 print_bt_config_components(cfg
->cmd_data
.run
.filters
);
660 fprintf(stderr
, " Sink component instances:\n");
661 print_bt_config_components(cfg
->cmd_data
.run
.sinks
);
662 fprintf(stderr
, " Connections:\n");
664 for (i
= 0; i
< cfg
->cmd_data
.run
.connections
->len
; i
++) {
665 struct bt_config_connection
*cfg_connection
=
666 g_ptr_array_index(cfg
->cmd_data
.run
.connections
,
669 fprintf(stderr
, " %s%s%s -> %s%s%s\n",
670 cfg_connection
->upstream_comp_name
->str
,
671 cfg_connection
->upstream_port_glob
->len
> 0 ? "." : "",
672 cfg_connection
->upstream_port_glob
->str
,
673 cfg_connection
->downstream_comp_name
->str
,
674 cfg_connection
->downstream_port_glob
->len
> 0 ? "." : "",
675 cfg_connection
->downstream_port_glob
->str
);
680 void print_cfg_list_plugins(struct bt_config
*cfg
)
682 print_plugin_paths(cfg
->plugin_paths
);
686 void print_cfg_help(struct bt_config
*cfg
)
688 print_plugin_paths(cfg
->plugin_paths
);
692 void print_cfg_print_ctf_metadata(struct bt_config
*cfg
)
694 print_plugin_paths(cfg
->plugin_paths
);
695 fprintf(stderr
, " Path: %s\n",
696 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
700 void print_cfg_print_lttng_live_sessions(struct bt_config
*cfg
)
702 print_plugin_paths(cfg
->plugin_paths
);
703 fprintf(stderr
, " URL: %s\n",
704 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
708 void print_cfg_query(struct bt_config
*cfg
)
710 print_plugin_paths(cfg
->plugin_paths
);
711 fprintf(stderr
, " Object: `%s`\n", cfg
->cmd_data
.query
.object
->str
);
712 fprintf(stderr
, " Component class:\n");
713 print_bt_config_component(cfg
->cmd_data
.query
.cfg_component
);
717 void print_cfg(struct bt_config
*cfg
)
719 if (!BT_LOG_ON_INFO
) {
723 BT_LOGI_STR("CLI configuration:");
724 BT_LOGI(" Debug mode: %s\n", cfg
->debug
? "yes" : "no");
725 BT_LOGI(" Verbose mode: %s\n", cfg
->verbose
? "yes" : "no");
727 switch (cfg
->command
) {
728 case BT_CONFIG_COMMAND_RUN
:
731 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
732 print_cfg_list_plugins(cfg
);
734 case BT_CONFIG_COMMAND_HELP
:
737 case BT_CONFIG_COMMAND_QUERY
:
738 print_cfg_query(cfg
);
740 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
741 print_cfg_print_ctf_metadata(cfg
);
743 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
744 print_cfg_print_lttng_live_sessions(cfg
);
752 void add_to_loaded_plugins(const bt_plugin_set
*plugin_set
)
757 count
= bt_plugin_set_get_plugin_count(plugin_set
);
758 BT_ASSERT(count
>= 0);
760 for (i
= 0; i
< count
; i
++) {
761 const bt_plugin
*plugin
=
762 bt_plugin_set_borrow_plugin_by_index_const(plugin_set
, i
);
763 const bt_plugin
*loaded_plugin
=
764 find_plugin(bt_plugin_get_name(plugin
));
769 BT_LOGI("Not using plugin: another one already exists with the same name: "
770 "plugin-name=\"%s\", plugin-path=\"%s\", "
771 "existing-plugin-path=\"%s\"",
772 bt_plugin_get_name(plugin
),
773 bt_plugin_get_path(plugin
),
774 bt_plugin_get_path(loaded_plugin
));
775 bt_plugin_put_ref(loaded_plugin
);
777 /* Add to global array. */
778 BT_LOGD("Adding plugin to loaded plugins: plugin-path=\"%s\"",
779 bt_plugin_get_name(plugin
));
780 bt_plugin_get_ref(plugin
);
781 g_ptr_array_add(loaded_plugins
, (void *) plugin
);
787 int load_dynamic_plugins(const bt_value
*plugin_paths
)
789 int nr_paths
, i
, ret
= 0;
791 nr_paths
= bt_value_array_get_size(plugin_paths
);
793 BT_LOGE_STR("Cannot load dynamic plugins: no plugin path.");
798 BT_LOGI_STR("Loading dynamic plugins.");
800 for (i
= 0; i
< nr_paths
; i
++) {
801 const bt_value
*plugin_path_value
= NULL
;
802 const char *plugin_path
;
803 const bt_plugin_set
*plugin_set
= NULL
;
804 bt_plugin_find_all_from_dir_status status
;
807 bt_value_array_borrow_element_by_index_const(
809 plugin_path
= bt_value_string_get(plugin_path_value
);
812 * Skip this if the directory does not exist because
813 * bt_plugin_find_all_from_dir() expects an existing
816 if (!g_file_test(plugin_path
, G_FILE_TEST_IS_DIR
)) {
817 BT_LOGI("Skipping nonexistent directory path: "
818 "path=\"%s\"", plugin_path
);
822 status
= bt_plugin_find_all_from_dir(plugin_path
, BT_FALSE
,
823 BT_FALSE
, &plugin_set
);
825 BT_LOGE("Unable to load dynamic plugins from directory: "
826 "path=\"%s\"", plugin_path
);
829 BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_NOT_FOUND
) {
830 BT_LOGI("No plugins found in directory: path=\"%s\"",
835 BT_ASSERT(status
== BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_OK
);
836 BT_ASSERT(plugin_set
);
837 add_to_loaded_plugins(plugin_set
);
838 bt_plugin_set_put_ref(plugin_set
);
845 int load_static_plugins(void)
848 const bt_plugin_set
*plugin_set
;
849 bt_plugin_find_all_from_static_status status
;
851 BT_LOGI("Loading static plugins.");
852 status
= bt_plugin_find_all_from_static(BT_FALSE
, &plugin_set
);
854 BT_LOGE("Unable to load static plugins.");
858 BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_NOT_FOUND
) {
859 BT_LOGI("No static plugins found.");
863 BT_ASSERT(status
== BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_OK
);
864 BT_ASSERT(plugin_set
);
865 add_to_loaded_plugins(plugin_set
);
866 bt_plugin_set_put_ref(plugin_set
);
873 int load_all_plugins(const bt_value
*plugin_paths
)
877 if (load_dynamic_plugins(plugin_paths
)) {
882 if (load_static_plugins()) {
887 BT_LOGI("Loaded all plugins: count=%u", loaded_plugins
->len
);
894 void print_plugin_info(const bt_plugin
*plugin
)
896 unsigned int major
, minor
, patch
;
898 bt_property_availability version_avail
;
899 const char *plugin_name
;
903 const char *plugin_description
;
905 plugin_name
= bt_plugin_get_name(plugin
);
906 path
= bt_plugin_get_path(plugin
);
907 author
= bt_plugin_get_author(plugin
);
908 license
= bt_plugin_get_license(plugin
);
909 plugin_description
= bt_plugin_get_description(plugin
);
910 version_avail
= bt_plugin_get_version(plugin
, &major
, &minor
,
912 printf("%s%s%s%s:\n", bt_common_color_bold(),
913 bt_common_color_fg_blue(), plugin_name
,
914 bt_common_color_reset());
916 printf(" %sPath%s: %s\n", bt_common_color_bold(),
917 bt_common_color_reset(), path
);
922 if (version_avail
== BT_PROPERTY_AVAILABILITY_AVAILABLE
) {
923 printf(" %sVersion%s: %u.%u.%u",
924 bt_common_color_bold(), bt_common_color_reset(),
925 major
, minor
, patch
);
934 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
935 bt_common_color_reset(),
936 plugin_description
? plugin_description
: "(None)");
937 printf(" %sAuthor%s: %s\n", bt_common_color_bold(),
938 bt_common_color_reset(), author
? author
: "(Unknown)");
939 printf(" %sLicense%s: %s\n", bt_common_color_bold(),
940 bt_common_color_reset(),
941 license
? license
: "(Unknown)");
945 int cmd_query(struct bt_config
*cfg
)
948 const bt_component_class
*comp_cls
= NULL
;
949 const bt_value
*results
= NULL
;
950 const char *fail_reason
= NULL
;
952 comp_cls
= find_component_class(
953 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
954 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
955 cfg
->cmd_data
.query
.cfg_component
->type
);
957 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
958 "comp-cls-name=\"%s\", comp-cls-type=%d",
959 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
960 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
961 cfg
->cmd_data
.query
.cfg_component
->type
);
962 fprintf(stderr
, "%s%sCannot find component class %s",
963 bt_common_color_bold(),
964 bt_common_color_fg_red(),
965 bt_common_color_reset());
966 print_plugin_comp_cls_opt(stderr
,
967 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
968 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
969 cfg
->cmd_data
.query
.cfg_component
->type
);
970 fprintf(stderr
, "\n");
975 ret
= query(cfg
, comp_cls
, cfg
->cmd_data
.query
.object
->str
,
976 cfg
->cmd_data
.query
.cfg_component
->params
,
977 &results
, &fail_reason
);
982 print_value(stdout
, results
, 0);
986 BT_LOGE("Failed to query component class: %s: plugin-name=\"%s\", "
987 "comp-cls-name=\"%s\", comp-cls-type=%d "
988 "object=\"%s\"", fail_reason
,
989 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
990 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
991 cfg
->cmd_data
.query
.cfg_component
->type
,
992 cfg
->cmd_data
.query
.object
->str
);
993 fprintf(stderr
, "%s%sFailed to query info to %s",
994 bt_common_color_bold(),
995 bt_common_color_fg_red(),
996 bt_common_color_reset());
997 print_plugin_comp_cls_opt(stderr
,
998 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
999 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
1000 cfg
->cmd_data
.query
.cfg_component
->type
);
1001 fprintf(stderr
, "%s%s with object `%s`: %s%s\n",
1002 bt_common_color_bold(),
1003 bt_common_color_fg_red(),
1004 cfg
->cmd_data
.query
.object
->str
,
1006 bt_common_color_reset());
1010 bt_component_class_put_ref(comp_cls
);
1011 bt_value_put_ref(results
);
1016 void print_component_class_help(const char *plugin_name
,
1017 const bt_component_class
*comp_cls
)
1019 const char *comp_class_name
=
1020 bt_component_class_get_name(comp_cls
);
1021 const char *comp_class_description
=
1022 bt_component_class_get_description(comp_cls
);
1023 const char *comp_class_help
=
1024 bt_component_class_get_help(comp_cls
);
1025 bt_component_class_type type
=
1026 bt_component_class_get_type(comp_cls
);
1028 print_plugin_comp_cls_opt(stdout
, plugin_name
, comp_class_name
, type
);
1030 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
1031 bt_common_color_reset(),
1032 comp_class_description
? comp_class_description
: "(None)");
1034 if (comp_class_help
) {
1035 printf("\n%s\n", comp_class_help
);
1040 int cmd_help(struct bt_config
*cfg
)
1043 const bt_plugin
*plugin
= NULL
;
1044 const bt_component_class
*needed_comp_cls
= NULL
;
1046 plugin
= find_plugin(cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
1048 BT_LOGE("Cannot find plugin: plugin-name=\"%s\"",
1049 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
1050 fprintf(stderr
, "%s%sCannot find plugin %s%s%s\n",
1051 bt_common_color_bold(), bt_common_color_fg_red(),
1052 bt_common_color_fg_blue(),
1053 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1054 bt_common_color_reset());
1059 print_plugin_info(plugin
);
1060 printf(" %sSource component classes%s: %d\n",
1061 bt_common_color_bold(),
1062 bt_common_color_reset(),
1063 (int) bt_plugin_get_source_component_class_count(plugin
));
1064 printf(" %sFilter component classes%s: %d\n",
1065 bt_common_color_bold(),
1066 bt_common_color_reset(),
1067 (int) bt_plugin_get_filter_component_class_count(plugin
));
1068 printf(" %sSink component classes%s: %d\n",
1069 bt_common_color_bold(),
1070 bt_common_color_reset(),
1071 (int) bt_plugin_get_sink_component_class_count(plugin
));
1073 if (strlen(cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
) == 0) {
1074 /* Plugin help only */
1078 needed_comp_cls
= find_component_class(
1079 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1080 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
1081 cfg
->cmd_data
.help
.cfg_component
->type
);
1082 if (!needed_comp_cls
) {
1083 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
1084 "comp-cls-name=\"%s\", comp-cls-type=%d",
1085 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1086 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
1087 cfg
->cmd_data
.help
.cfg_component
->type
);
1088 fprintf(stderr
, "\n%s%sCannot find component class %s",
1089 bt_common_color_bold(),
1090 bt_common_color_fg_red(),
1091 bt_common_color_reset());
1092 print_plugin_comp_cls_opt(stderr
,
1093 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1094 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
1095 cfg
->cmd_data
.help
.cfg_component
->type
);
1096 fprintf(stderr
, "\n");
1102 print_component_class_help(
1103 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1107 bt_component_class_put_ref(needed_comp_cls
);
1108 bt_plugin_put_ref(plugin
);
1112 typedef void *(* plugin_borrow_comp_cls_by_index_func_t
)(const bt_plugin
*,
1114 typedef const bt_component_class
*(* spec_comp_cls_borrow_comp_cls_func_t
)(
1117 void cmd_list_plugins_print_component_classes(const bt_plugin
*plugin
,
1118 const char *cc_type_name
, uint64_t count
,
1119 plugin_borrow_comp_cls_by_index_func_t borrow_comp_cls_by_index_func
,
1120 spec_comp_cls_borrow_comp_cls_func_t spec_comp_cls_borrow_comp_cls_func
)
1125 printf(" %s%s component classes%s: (none)\n",
1126 bt_common_color_bold(),
1128 bt_common_color_reset());
1131 printf(" %s%s component classes%s:\n",
1132 bt_common_color_bold(),
1134 bt_common_color_reset());
1137 for (i
= 0; i
< count
; i
++) {
1138 const bt_component_class
*comp_class
=
1139 spec_comp_cls_borrow_comp_cls_func(
1140 borrow_comp_cls_by_index_func(plugin
, i
));
1141 const char *comp_class_name
=
1142 bt_component_class_get_name(comp_class
);
1143 const char *comp_class_description
=
1144 bt_component_class_get_description(comp_class
);
1145 bt_component_class_type type
=
1146 bt_component_class_get_type(comp_class
);
1149 print_plugin_comp_cls_opt(stdout
,
1150 bt_plugin_get_name(plugin
), comp_class_name
,
1153 if (comp_class_description
) {
1154 printf(": %s", comp_class_description
);
1165 int cmd_list_plugins(struct bt_config
*cfg
)
1168 int plugins_count
, component_classes_count
= 0, i
;
1170 printf("From the following plugin paths:\n\n");
1171 print_value(stdout
, cfg
->plugin_paths
, 2);
1173 plugins_count
= loaded_plugins
->len
;
1174 if (plugins_count
== 0) {
1175 printf("No plugins found.\n");
1179 for (i
= 0; i
< plugins_count
; i
++) {
1180 const bt_plugin
*plugin
= g_ptr_array_index(loaded_plugins
, i
);
1182 component_classes_count
+=
1183 bt_plugin_get_source_component_class_count(plugin
) +
1184 bt_plugin_get_filter_component_class_count(plugin
) +
1185 bt_plugin_get_sink_component_class_count(plugin
);
1188 printf("Found %s%d%s component classes in %s%d%s plugins.\n",
1189 bt_common_color_bold(),
1190 component_classes_count
,
1191 bt_common_color_reset(),
1192 bt_common_color_bold(),
1194 bt_common_color_reset());
1196 for (i
= 0; i
< plugins_count
; i
++) {
1197 const bt_plugin
*plugin
= g_ptr_array_index(loaded_plugins
, i
);
1200 print_plugin_info(plugin
);
1201 cmd_list_plugins_print_component_classes(plugin
, "Source",
1202 bt_plugin_get_source_component_class_count(plugin
),
1203 (plugin_borrow_comp_cls_by_index_func_t
)
1204 bt_plugin_borrow_source_component_class_by_index_const
,
1205 (spec_comp_cls_borrow_comp_cls_func_t
)
1206 bt_component_class_source_as_component_class
);
1207 cmd_list_plugins_print_component_classes(plugin
, "Filter",
1208 bt_plugin_get_filter_component_class_count(plugin
),
1209 (plugin_borrow_comp_cls_by_index_func_t
)
1210 bt_plugin_borrow_filter_component_class_by_index_const
,
1211 (spec_comp_cls_borrow_comp_cls_func_t
)
1212 bt_component_class_filter_as_component_class
);
1213 cmd_list_plugins_print_component_classes(plugin
, "Sink",
1214 bt_plugin_get_sink_component_class_count(plugin
),
1215 (plugin_borrow_comp_cls_by_index_func_t
)
1216 bt_plugin_borrow_sink_component_class_by_index_const
,
1217 (spec_comp_cls_borrow_comp_cls_func_t
)
1218 bt_component_class_sink_as_component_class
);
1226 int cmd_print_lttng_live_sessions(struct bt_config
*cfg
)
1229 const bt_component_class
*comp_cls
= NULL
;
1230 const bt_value
*results
= NULL
;
1231 bt_value
*params
= NULL
;
1232 const bt_value
*map
= NULL
;
1233 const bt_value
*v
= NULL
;
1234 static const char * const plugin_name
= "ctf";
1235 static const char * const comp_cls_name
= "lttng-live";
1236 static const bt_component_class_type comp_cls_type
=
1237 BT_COMPONENT_CLASS_TYPE_SOURCE
;
1238 int64_t array_size
, i
;
1239 const char *fail_reason
= NULL
;
1240 FILE *out_stream
= stdout
;
1242 BT_ASSERT(cfg
->cmd_data
.print_lttng_live_sessions
.url
);
1243 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1246 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
1247 "comp-cls-name=\"%s\", comp-cls-type=%d",
1248 plugin_name
, comp_cls_name
,
1249 BT_COMPONENT_CLASS_TYPE_SOURCE
);
1250 fprintf(stderr
, "%s%sCannot find component class %s",
1251 bt_common_color_bold(),
1252 bt_common_color_fg_red(),
1253 bt_common_color_reset());
1254 print_plugin_comp_cls_opt(stderr
, plugin_name
,
1255 comp_cls_name
, comp_cls_type
);
1256 fprintf(stderr
, "\n");
1260 params
= bt_value_map_create();
1265 ret
= bt_value_map_insert_string_entry(params
, "url",
1266 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
1271 ret
= query(cfg
, comp_cls
, "sessions", params
,
1272 &results
, &fail_reason
);
1279 if (!bt_value_is_array(results
)) {
1280 BT_LOGE_STR("Expecting an array for sessions query.");
1281 fprintf(stderr
, "%s%sUnexpected type returned by session query%s\n",
1282 bt_common_color_bold(),
1283 bt_common_color_fg_red(),
1284 bt_common_color_reset());
1288 if (cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->len
> 0) {
1290 fopen(cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
,
1294 BT_LOGE_ERRNO("Cannot open file for writing",
1296 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
1301 array_size
= bt_value_array_get_size(results
);
1302 for (i
= 0; i
< array_size
; i
++) {
1303 const char *url_text
;
1304 int64_t timer_us
, streams
, clients
;
1306 map
= bt_value_array_borrow_element_by_index_const(results
, i
);
1308 BT_LOGE_STR("Unexpected empty array entry.");
1311 if (!bt_value_is_map(map
)) {
1312 BT_LOGE_STR("Unexpected entry type.");
1316 v
= bt_value_map_borrow_entry_value_const(map
, "url");
1318 BT_LOGE_STR("Unexpected empty array \"url\" entry.");
1321 url_text
= bt_value_string_get(v
);
1322 fprintf(out_stream
, "%s", url_text
);
1323 v
= bt_value_map_borrow_entry_value_const(map
, "timer-us");
1325 BT_LOGE_STR("Unexpected empty array \"timer-us\" entry.");
1328 timer_us
= bt_value_signed_integer_get(v
);
1329 fprintf(out_stream
, " (timer = %" PRIu64
", ", timer_us
);
1330 v
= bt_value_map_borrow_entry_value_const(map
, "stream-count");
1332 BT_LOGE_STR("Unexpected empty array \"stream-count\" entry.");
1335 streams
= bt_value_signed_integer_get(v
);
1336 fprintf(out_stream
, "%" PRIu64
" stream(s), ", streams
);
1337 v
= bt_value_map_borrow_entry_value_const(map
, "client-count");
1339 BT_LOGE_STR("Unexpected empty array \"client-count\" entry.");
1342 clients
= bt_value_signed_integer_get(v
);
1343 fprintf(out_stream
, "%" PRIu64
" client(s) connected)\n", clients
);
1349 BT_LOGE("Failed to query for sessions: %s", fail_reason
);
1350 fprintf(stderr
, "%s%sFailed to request sessions: %s%s\n",
1351 bt_common_color_bold(),
1352 bt_common_color_fg_red(),
1354 bt_common_color_reset());
1360 bt_value_put_ref(results
);
1361 bt_value_put_ref(params
);
1362 bt_component_class_put_ref(comp_cls
);
1364 if (out_stream
&& out_stream
!= stdout
) {
1365 int fclose_ret
= fclose(out_stream
);
1368 BT_LOGE_ERRNO("Cannot close file stream",
1370 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
1378 int cmd_print_ctf_metadata(struct bt_config
*cfg
)
1381 const bt_component_class
*comp_cls
= NULL
;
1382 const bt_value
*results
= NULL
;
1383 bt_value
*params
= NULL
;
1384 const bt_value
*metadata_text_value
= NULL
;
1385 const char *metadata_text
= NULL
;
1386 static const char * const plugin_name
= "ctf";
1387 static const char * const comp_cls_name
= "fs";
1388 static const bt_component_class_type comp_cls_type
=
1389 BT_COMPONENT_CLASS_TYPE_SOURCE
;
1390 const char *fail_reason
= NULL
;
1391 FILE *out_stream
= stdout
;
1393 BT_ASSERT(cfg
->cmd_data
.print_ctf_metadata
.path
);
1394 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1397 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
1398 "comp-cls-name=\"%s\", comp-cls-type=%d",
1399 plugin_name
, comp_cls_name
,
1400 BT_COMPONENT_CLASS_TYPE_SOURCE
);
1401 fprintf(stderr
, "%s%sCannot find component class %s",
1402 bt_common_color_bold(),
1403 bt_common_color_fg_red(),
1404 bt_common_color_reset());
1405 print_plugin_comp_cls_opt(stderr
, plugin_name
,
1406 comp_cls_name
, comp_cls_type
);
1407 fprintf(stderr
, "\n");
1412 params
= bt_value_map_create();
1418 ret
= bt_value_map_insert_string_entry(params
, "path",
1419 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
1425 ret
= query(cfg
, comp_cls
, "metadata-info",
1426 params
, &results
, &fail_reason
);
1431 metadata_text_value
= bt_value_map_borrow_entry_value_const(results
,
1433 if (!metadata_text_value
) {
1434 BT_LOGE_STR("Cannot find `text` string value in the resulting metadata info object.");
1439 metadata_text
= bt_value_string_get(metadata_text_value
);
1441 if (cfg
->cmd_data
.print_ctf_metadata
.output_path
->len
> 0) {
1443 fopen(cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
,
1447 BT_LOGE_ERRNO("Cannot open file for writing",
1449 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1454 ret
= fprintf(out_stream
, "%s\n", metadata_text
);
1456 BT_LOGE("Cannot write whole metadata text to output stream: "
1467 BT_LOGE("Failed to query for metadata info: %s", fail_reason
);
1468 fprintf(stderr
, "%s%sFailed to request metadata info: %s%s\n",
1469 bt_common_color_bold(),
1470 bt_common_color_fg_red(),
1472 bt_common_color_reset());
1475 bt_value_put_ref(results
);
1476 bt_value_put_ref(params
);
1477 bt_component_class_put_ref(comp_cls
);
1479 if (out_stream
&& out_stream
!= stdout
) {
1480 int fclose_ret
= fclose(out_stream
);
1483 BT_LOGE_ERRNO("Cannot close file stream",
1485 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1493 char *instance_name
;
1497 struct trace_range
{
1498 uint64_t intersection_range_begin_ns
;
1499 uint64_t intersection_range_end_ns
;
1503 guint
port_id_hash(gconstpointer v
)
1505 const struct port_id
*id
= v
;
1507 BT_ASSERT(id
->instance_name
);
1508 BT_ASSERT(id
->port_name
);
1510 return g_str_hash(id
->instance_name
) ^ g_str_hash(id
->port_name
);
1514 gboolean
port_id_equal(gconstpointer v1
, gconstpointer v2
)
1516 const struct port_id
*id1
= v1
;
1517 const struct port_id
*id2
= v2
;
1519 return !strcmp(id1
->instance_name
, id2
->instance_name
) &&
1520 !strcmp(id1
->port_name
, id2
->port_name
);
1524 void port_id_destroy(gpointer data
)
1526 struct port_id
*id
= data
;
1528 free(id
->instance_name
);
1529 free(id
->port_name
);
1534 void trace_range_destroy(gpointer data
)
1539 struct cmd_run_ctx
{
1541 GHashTable
*src_components
;
1544 GHashTable
*flt_components
;
1547 GHashTable
*sink_components
;
1553 struct bt_config
*cfg
;
1557 bool stream_intersection_mode
;
1560 * Association of struct port_id -> struct trace_range.
1562 GHashTable
*intersections
;
1565 /* Returns a timestamp of the form "(-)s.ns" */
1567 char *s_from_ns(int64_t ns
)
1572 int64_t ts_sec_abs
, ts_nsec_abs
;
1573 int64_t ts_sec
= ns
/ NSEC_PER_SEC
;
1574 int64_t ts_nsec
= ns
% NSEC_PER_SEC
;
1576 if (ts_sec
>= 0 && ts_nsec
>= 0) {
1577 is_negative
= false;
1578 ts_sec_abs
= ts_sec
;
1579 ts_nsec_abs
= ts_nsec
;
1580 } else if (ts_sec
> 0 && ts_nsec
< 0) {
1581 is_negative
= false;
1582 ts_sec_abs
= ts_sec
- 1;
1583 ts_nsec_abs
= NSEC_PER_SEC
+ ts_nsec
;
1584 } else if (ts_sec
== 0 && ts_nsec
< 0) {
1586 ts_sec_abs
= ts_sec
;
1587 ts_nsec_abs
= -ts_nsec
;
1588 } else if (ts_sec
< 0 && ts_nsec
> 0) {
1590 ts_sec_abs
= -(ts_sec
+ 1);
1591 ts_nsec_abs
= NSEC_PER_SEC
- ts_nsec
;
1592 } else if (ts_sec
< 0 && ts_nsec
== 0) {
1594 ts_sec_abs
= -ts_sec
;
1595 ts_nsec_abs
= ts_nsec
;
1596 } else { /* (ts_sec < 0 && ts_nsec < 0) */
1598 ts_sec_abs
= -ts_sec
;
1599 ts_nsec_abs
= -ts_nsec
;
1602 ret
= asprintf(&s_ret
, "%s%" PRId64
".%09" PRId64
,
1603 is_negative
? "-" : "", ts_sec_abs
, ts_nsec_abs
);
1611 int cmd_run_ctx_connect_upstream_port_to_downstream_component(
1612 struct cmd_run_ctx
*ctx
,
1613 const bt_component
*upstream_comp
,
1614 const bt_port_output
*out_upstream_port
,
1615 struct bt_config_connection
*cfg_conn
)
1617 typedef uint64_t (*input_port_count_func_t
)(void *);
1618 typedef const bt_port_input
*(*borrow_input_port_by_index_func_t
)(
1619 const void *, uint64_t);
1620 const bt_port
*upstream_port
=
1621 bt_port_output_as_port_const(out_upstream_port
);
1624 GQuark downstreamp_comp_name_quark
;
1625 void *downstream_comp
;
1626 uint64_t downstream_port_count
;
1628 input_port_count_func_t port_count_fn
;
1629 borrow_input_port_by_index_func_t port_by_index_fn
;
1630 bt_graph_connect_ports_status connect_ports_status
=
1631 BT_GRAPH_CONNECT_PORTS_STATUS_OK
;
1632 bool insert_trimmer
= false;
1633 bt_value
*trimmer_params
= NULL
;
1634 char *intersection_begin
= NULL
;
1635 char *intersection_end
= NULL
;
1636 const bt_component_filter
*trimmer
= NULL
;
1637 const bt_component_class_filter
*trimmer_class
= NULL
;
1638 const bt_port_input
*trimmer_input
= NULL
;
1639 const bt_port_output
*trimmer_output
= NULL
;
1641 if (ctx
->intersections
&&
1642 bt_component_get_class_type(upstream_comp
) ==
1643 BT_COMPONENT_CLASS_TYPE_SOURCE
) {
1644 struct trace_range
*range
;
1645 struct port_id port_id
= {
1646 .instance_name
= (char *) bt_component_get_name(upstream_comp
),
1647 .port_name
= (char *) bt_port_get_name(upstream_port
)
1650 if (!port_id
.instance_name
|| !port_id
.port_name
) {
1654 range
= (struct trace_range
*) g_hash_table_lookup(
1655 ctx
->intersections
, &port_id
);
1657 bt_value_map_insert_entry_status insert_status
;
1659 intersection_begin
= s_from_ns(
1660 range
->intersection_range_begin_ns
);
1661 intersection_end
= s_from_ns(
1662 range
->intersection_range_end_ns
);
1663 if (!intersection_begin
|| !intersection_end
) {
1664 BT_LOGE_STR("Cannot create trimmer argument timestamp string.");
1668 insert_trimmer
= true;
1669 trimmer_params
= bt_value_map_create();
1670 if (!trimmer_params
) {
1674 insert_status
= bt_value_map_insert_string_entry(
1675 trimmer_params
, "begin", intersection_begin
);
1676 if (insert_status
< 0) {
1679 insert_status
= bt_value_map_insert_string_entry(
1681 "end", intersection_end
);
1682 if (insert_status
< 0) {
1687 trimmer_class
= find_filter_component_class("utils", "trimmer");
1688 if (!trimmer_class
) {
1693 BT_LOGI("Connecting upstream port to the next available downstream port: "
1694 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1695 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1696 upstream_port
, bt_port_get_name(upstream_port
),
1697 cfg_conn
->downstream_comp_name
->str
,
1698 cfg_conn
->arg
->str
);
1699 downstreamp_comp_name_quark
= g_quark_from_string(
1700 cfg_conn
->downstream_comp_name
->str
);
1701 BT_ASSERT(downstreamp_comp_name_quark
> 0);
1702 downstream_comp
= g_hash_table_lookup(ctx
->flt_components
,
1703 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1704 port_count_fn
= (input_port_count_func_t
)
1705 bt_component_filter_get_input_port_count
;
1706 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1707 bt_component_filter_borrow_input_port_by_index_const
;
1709 if (!downstream_comp
) {
1710 downstream_comp
= g_hash_table_lookup(ctx
->sink_components
,
1711 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1712 port_count_fn
= (input_port_count_func_t
)
1713 bt_component_sink_get_input_port_count
;
1714 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1715 bt_component_sink_borrow_input_port_by_index_const
;
1718 if (!downstream_comp
) {
1719 BT_LOGE("Cannot find downstream component: comp-name=\"%s\", "
1720 "conn-arg=\"%s\"", cfg_conn
->downstream_comp_name
->str
,
1721 cfg_conn
->arg
->str
);
1722 fprintf(stderr
, "Cannot create connection: cannot find downstream component: %s\n",
1723 cfg_conn
->arg
->str
);
1727 downstream_port_count
= port_count_fn(downstream_comp
);
1729 for (i
= 0; i
< downstream_port_count
; i
++) {
1730 const bt_port_input
*in_downstream_port
=
1731 port_by_index_fn(downstream_comp
, i
);
1732 const bt_port
*downstream_port
=
1733 bt_port_input_as_port_const(in_downstream_port
);
1734 const char *upstream_port_name
;
1735 const char *downstream_port_name
;
1737 BT_ASSERT(downstream_port
);
1739 /* Skip port if it's already connected. */
1740 if (bt_port_is_connected(downstream_port
)) {
1741 BT_LOGI("Skipping downstream port: already connected: "
1742 "port-addr=%p, port-name=\"%s\"",
1744 bt_port_get_name(downstream_port
));
1748 downstream_port_name
= bt_port_get_name(downstream_port
);
1749 BT_ASSERT(downstream_port_name
);
1750 upstream_port_name
= bt_port_get_name(upstream_port
);
1751 BT_ASSERT(upstream_port_name
);
1753 if (!bt_common_star_glob_match(
1754 cfg_conn
->downstream_port_glob
->str
, SIZE_MAX
,
1755 downstream_port_name
, SIZE_MAX
)) {
1759 if (insert_trimmer
) {
1761 * In order to insert the trimmer between the
1762 * two components that were being connected, we
1763 * create a connection configuration entry which
1764 * describes a connection from the trimmer's
1765 * output to the original input that was being
1768 * Hence, the creation of the trimmer will cause
1769 * the graph "new port" listener to establish
1770 * all downstream connections as its output port
1771 * is connected. We will then establish the
1772 * connection between the original upstream
1773 * source and the trimmer.
1775 char *trimmer_name
= NULL
;
1776 bt_graph_add_component_status add_comp_status
;
1778 ret
= asprintf(&trimmer_name
,
1779 "stream-intersection-trimmer-%s",
1780 upstream_port_name
);
1786 ctx
->connect_ports
= false;
1787 add_comp_status
= bt_graph_add_filter_component(
1788 ctx
->graph
, trimmer_class
, trimmer_name
,
1789 trimmer_params
, ctx
->cfg
->log_level
,
1792 if (add_comp_status
!=
1793 BT_GRAPH_ADD_COMPONENT_STATUS_OK
) {
1799 bt_component_filter_borrow_input_port_by_index_const(
1801 if (!trimmer_input
) {
1805 bt_component_filter_borrow_output_port_by_index_const(
1807 if (!trimmer_output
) {
1812 * Replace the current downstream port by the trimmer's
1815 in_downstream_port
= trimmer_input
;
1817 bt_port_input_as_port_const(in_downstream_port
);
1818 downstream_port_name
= bt_port_get_name(
1820 BT_ASSERT(downstream_port_name
);
1823 /* We have a winner! */
1824 connect_ports_status
= bt_graph_connect_ports(ctx
->graph
,
1825 out_upstream_port
, in_downstream_port
, NULL
);
1826 downstream_port
= NULL
;
1827 switch (connect_ports_status
) {
1828 case BT_GRAPH_CONNECT_PORTS_STATUS_OK
:
1830 case BT_GRAPH_CONNECT_PORTS_STATUS_CANCELED
:
1831 BT_LOGI_STR("Graph was canceled by user.");
1834 BT_LOGE("Cannot create connection: graph refuses to connect ports: "
1835 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1836 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1837 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1838 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1840 upstream_comp
, bt_component_get_name(upstream_comp
),
1841 upstream_port
, bt_port_get_name(upstream_port
),
1842 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1843 downstream_port
, downstream_port_name
,
1844 cfg_conn
->arg
->str
);
1846 "Cannot create connection: graph refuses to connect ports (`%s` to `%s`): %s\n",
1847 bt_port_get_name(upstream_port
),
1848 downstream_port_name
,
1849 cfg_conn
->arg
->str
);
1853 BT_LOGI("Connected component ports: "
1854 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1855 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1856 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1857 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1859 upstream_comp
, bt_component_get_name(upstream_comp
),
1860 upstream_port
, bt_port_get_name(upstream_port
),
1861 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1862 downstream_port
, downstream_port_name
,
1863 cfg_conn
->arg
->str
);
1865 if (insert_trimmer
) {
1867 * The first connection, from the source to the trimmer,
1868 * has been done. We now connect the trimmer to the
1869 * original downstream port.
1871 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1873 bt_component_filter_as_component_const(trimmer
),
1874 trimmer_output
, cfg_conn
);
1878 ctx
->connect_ports
= true;
1882 * We found a matching downstream port: the search is
1888 /* No downstream port found */
1889 BT_LOGE("Cannot create connection: cannot find a matching downstream port for upstream port: "
1890 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1891 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1892 upstream_port
, bt_port_get_name(upstream_port
),
1893 cfg_conn
->downstream_comp_name
->str
,
1894 cfg_conn
->arg
->str
);
1896 "Cannot create connection: cannot find a matching downstream port for upstream port `%s`: %s\n",
1897 bt_port_get_name(upstream_port
), cfg_conn
->arg
->str
);
1903 free(intersection_begin
);
1904 free(intersection_end
);
1905 BT_VALUE_PUT_REF_AND_RESET(trimmer_params
);
1906 BT_COMPONENT_CLASS_FILTER_PUT_REF_AND_RESET(trimmer_class
);
1907 BT_COMPONENT_FILTER_PUT_REF_AND_RESET(trimmer
);
1912 int cmd_run_ctx_connect_upstream_port(struct cmd_run_ctx
*ctx
,
1913 const bt_port_output
*upstream_port
)
1916 const char *upstream_port_name
;
1917 const char *upstream_comp_name
;
1918 const bt_component
*upstream_comp
= NULL
;
1922 BT_ASSERT(upstream_port
);
1923 upstream_port_name
= bt_port_get_name(
1924 bt_port_output_as_port_const(upstream_port
));
1925 BT_ASSERT(upstream_port_name
);
1926 upstream_comp
= bt_port_borrow_component_const(
1927 bt_port_output_as_port_const(upstream_port
));
1928 if (!upstream_comp
) {
1929 BT_LOGW("Upstream port to connect is not part of a component: "
1930 "port-addr=%p, port-name=\"%s\"",
1931 upstream_port
, upstream_port_name
);
1936 upstream_comp_name
= bt_component_get_name(upstream_comp
);
1937 BT_ASSERT(upstream_comp_name
);
1938 BT_LOGI("Connecting upstream port: comp-addr=%p, comp-name=\"%s\", "
1939 "port-addr=%p, port-name=\"%s\"",
1940 upstream_comp
, upstream_comp_name
,
1941 upstream_port
, upstream_port_name
);
1943 for (i
= 0; i
< ctx
->cfg
->cmd_data
.run
.connections
->len
; i
++) {
1944 struct bt_config_connection
*cfg_conn
=
1946 ctx
->cfg
->cmd_data
.run
.connections
, i
);
1948 if (strcmp(cfg_conn
->upstream_comp_name
->str
,
1949 upstream_comp_name
)) {
1953 if (!bt_common_star_glob_match(
1954 cfg_conn
->upstream_port_glob
->str
,
1955 SIZE_MAX
, upstream_port_name
, SIZE_MAX
)) {
1959 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1960 ctx
, upstream_comp
, upstream_port
, cfg_conn
);
1962 BT_LOGE("Cannot connect upstream port: "
1963 "port-addr=%p, port-name=\"%s\"",
1965 upstream_port_name
);
1967 "Cannot connect port `%s` of component `%s` to a downstream port: %s\n",
1970 cfg_conn
->arg
->str
);
1976 BT_LOGE("Cannot connect upstream port: port does not match any connection argument: "
1977 "port-addr=%p, port-name=\"%s\"", upstream_port
,
1978 upstream_port_name
);
1980 "Cannot create connection: upstream port `%s` does not match any connection\n",
1981 upstream_port_name
);
1991 bt_graph_listener_func_status
1992 graph_output_port_added_listener(struct cmd_run_ctx
*ctx
,
1993 const bt_port_output
*out_port
)
1995 const bt_component
*comp
;
1996 const bt_port
*port
= bt_port_output_as_port_const(out_port
);
1997 bt_graph_listener_func_status ret
=
1998 BT_GRAPH_LISTENER_FUNC_STATUS_OK
;
2000 comp
= bt_port_borrow_component_const(port
);
2001 BT_LOGI("Port added to a graph's component: comp-addr=%p, "
2002 "comp-name=\"%s\", port-addr=%p, port-name=\"%s\"",
2003 comp
, comp
? bt_component_get_name(comp
) : "",
2004 port
, bt_port_get_name(port
));
2006 if (!ctx
->connect_ports
) {
2011 BT_LOGW_STR("Port has no component.");
2015 if (bt_port_is_connected(port
)) {
2016 BT_LOGW_STR("Port is already connected.");
2020 if (cmd_run_ctx_connect_upstream_port(ctx
, out_port
)) {
2021 BT_LOGF_STR("Cannot connect upstream port.");
2022 fprintf(stderr
, "Added port could not be connected: aborting\n");
2023 ret
= BT_GRAPH_LISTENER_FUNC_STATUS_ERROR
;
2032 bt_graph_listener_func_status
graph_source_output_port_added_listener(
2033 const bt_component_source
*component
,
2034 const bt_port_output
*port
, void *data
)
2036 return graph_output_port_added_listener(data
, port
);
2040 bt_graph_listener_func_status
graph_filter_output_port_added_listener(
2041 const bt_component_filter
*component
,
2042 const bt_port_output
*port
, void *data
)
2044 return graph_output_port_added_listener(data
, port
);
2048 void cmd_run_ctx_destroy(struct cmd_run_ctx
*ctx
)
2054 if (ctx
->src_components
) {
2055 g_hash_table_destroy(ctx
->src_components
);
2056 ctx
->src_components
= NULL
;
2059 if (ctx
->flt_components
) {
2060 g_hash_table_destroy(ctx
->flt_components
);
2061 ctx
->flt_components
= NULL
;
2064 if (ctx
->sink_components
) {
2065 g_hash_table_destroy(ctx
->sink_components
);
2066 ctx
->sink_components
= NULL
;
2069 if (ctx
->intersections
) {
2070 g_hash_table_destroy(ctx
->intersections
);
2071 ctx
->intersections
= NULL
;
2074 BT_GRAPH_PUT_REF_AND_RESET(ctx
->graph
);
2080 int cmd_run_ctx_init(struct cmd_run_ctx
*ctx
, struct bt_config
*cfg
)
2083 bt_graph_add_component_status add_comp_status
;
2086 ctx
->connect_ports
= false;
2087 ctx
->src_components
= g_hash_table_new_full(g_direct_hash
,
2088 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
2089 if (!ctx
->src_components
) {
2093 ctx
->flt_components
= g_hash_table_new_full(g_direct_hash
,
2094 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
2095 if (!ctx
->flt_components
) {
2099 ctx
->sink_components
= g_hash_table_new_full(g_direct_hash
,
2100 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
2101 if (!ctx
->sink_components
) {
2105 if (cfg
->cmd_data
.run
.stream_intersection_mode
) {
2106 ctx
->stream_intersection_mode
= true;
2107 ctx
->intersections
= g_hash_table_new_full(port_id_hash
,
2108 port_id_equal
, port_id_destroy
, trace_range_destroy
);
2109 if (!ctx
->intersections
) {
2114 ctx
->graph
= bt_graph_create();
2119 the_graph
= ctx
->graph
;
2120 add_comp_status
= bt_graph_add_source_component_output_port_added_listener(
2121 ctx
->graph
, graph_source_output_port_added_listener
, NULL
, ctx
,
2123 if (add_comp_status
!= BT_GRAPH_ADD_COMPONENT_STATUS_OK
) {
2124 BT_LOGE_STR("Cannot add \"port added\" listener to graph.");
2128 add_comp_status
= bt_graph_add_filter_component_output_port_added_listener(
2129 ctx
->graph
, graph_filter_output_port_added_listener
, NULL
, ctx
,
2131 if (add_comp_status
!= BT_GRAPH_ADD_COMPONENT_STATUS_OK
) {
2132 BT_LOGE_STR("Cannot add \"port added\" listener to graph.");
2139 cmd_run_ctx_destroy(ctx
);
2147 int set_stream_intersections(struct cmd_run_ctx
*ctx
,
2148 struct bt_config_component
*cfg_comp
,
2149 const bt_component_class_source
*src_comp_cls
)
2153 int64_t trace_count
;
2154 const char *path
= NULL
;
2155 const bt_value
*query_result
= NULL
;
2156 const bt_value
*trace_info
= NULL
;
2157 const bt_value
*intersection_range
= NULL
;
2158 const bt_value
*intersection_begin
= NULL
;
2159 const bt_value
*intersection_end
= NULL
;
2160 const bt_value
*stream_infos
= NULL
;
2161 const bt_value
*stream_info
= NULL
;
2162 struct port_id
*port_id
= NULL
;
2163 struct trace_range
*trace_range
= NULL
;
2164 const char *fail_reason
= NULL
;
2165 const bt_component_class
*comp_cls
=
2166 bt_component_class_source_as_component_class_const(src_comp_cls
);
2168 ret
= query(ctx
->cfg
, comp_cls
, "trace-info",
2169 cfg_comp
->params
, &query_result
,
2172 BT_LOGD("Component class does not support the `trace-info` query: %s: "
2173 "comp-class-name=\"%s\"", fail_reason
,
2174 bt_component_class_get_name(comp_cls
));
2179 BT_ASSERT(query_result
);
2181 if (!bt_value_is_array(query_result
)) {
2182 BT_LOGD("Unexpected format of \'trace-info\' query result: "
2183 "component-class-name=%s",
2184 bt_component_class_get_name(comp_cls
));
2189 trace_count
= bt_value_array_get_size(query_result
);
2190 if (trace_count
< 0) {
2195 for (trace_idx
= 0; trace_idx
< trace_count
; trace_idx
++) {
2197 uint64_t stream_idx
;
2198 int64_t stream_count
;
2200 trace_info
= bt_value_array_borrow_element_by_index_const(
2201 query_result
, trace_idx
);
2202 if (!trace_info
|| !bt_value_is_map(trace_info
)) {
2204 BT_LOGD_STR("Cannot retrieve trace from query result.");
2208 intersection_range
= bt_value_map_borrow_entry_value_const(
2209 trace_info
, "intersection-range-ns");
2210 if (!intersection_range
) {
2212 BT_LOGD_STR("Cannot retrieve \'intersetion-range-ns\' field from query result.");
2216 intersection_begin
= bt_value_map_borrow_entry_value_const(intersection_range
,
2218 if (!intersection_begin
) {
2220 BT_LOGD_STR("Cannot retrieve intersection-range-ns \'begin\' field from query result.");
2224 intersection_end
= bt_value_map_borrow_entry_value_const(intersection_range
,
2226 if (!intersection_end
) {
2228 BT_LOGD_STR("Cannot retrieve intersection-range-ns \'end\' field from query result.");
2232 begin
= bt_value_signed_integer_get(intersection_begin
);
2233 end
= bt_value_signed_integer_get(intersection_end
);
2235 if (begin
< 0 || end
< 0 || end
< begin
) {
2236 BT_LOGW("Invalid trace stream intersection values: "
2237 "intersection-range-ns:begin=%" PRId64
2238 ", intersection-range-ns:end=%" PRId64
,
2244 stream_infos
= bt_value_map_borrow_entry_value_const(trace_info
,
2246 if (!stream_infos
|| !bt_value_is_array(stream_infos
)) {
2248 BT_LOGD_STR("Cannot retrieve stream information from trace in query result.");
2252 stream_count
= bt_value_array_get_size(stream_infos
);
2253 if (stream_count
< 0) {
2258 for (stream_idx
= 0; stream_idx
< stream_count
; stream_idx
++) {
2259 const bt_value
*port_name
;
2261 port_id
= g_new0(struct port_id
, 1);
2264 BT_LOGE_STR("Cannot allocate memory for port_id structure.");
2267 port_id
->instance_name
= strdup(cfg_comp
->instance_name
->str
);
2268 if (!port_id
->instance_name
) {
2270 BT_LOGE_STR("Cannot allocate memory for port_id component instance name.");
2274 trace_range
= g_new0(struct trace_range
, 1);
2277 BT_LOGE_STR("Cannot allocate memory for trace_range structure.");
2280 trace_range
->intersection_range_begin_ns
= begin
;
2281 trace_range
->intersection_range_end_ns
= end
;
2283 stream_info
= bt_value_array_borrow_element_by_index_const(
2284 stream_infos
, stream_idx
);
2285 if (!stream_info
|| !bt_value_is_map(stream_info
)) {
2287 BT_LOGE_STR("Cannot retrieve stream informations from trace in query result.");
2291 port_name
= bt_value_map_borrow_entry_value_const(stream_info
, "port-name");
2292 if (!port_name
|| !bt_value_is_string(port_name
)) {
2294 BT_LOGE_STR("Cannot retrieve port name in query result.");
2298 port_id
->port_name
= g_strdup(bt_value_string_get(port_name
));
2299 if (!port_id
->port_name
) {
2301 BT_LOGE_STR("Cannot allocate memory for port_id port_name.");
2305 BT_LOGD("Inserting stream intersection ");
2307 g_hash_table_insert(ctx
->intersections
, port_id
, trace_range
);
2317 fprintf(stderr
, "%s%sCannot determine stream intersection of trace at path \'%s\'.%s\n",
2318 bt_common_color_bold(),
2319 bt_common_color_fg_yellow(),
2320 path
? path
: "(unknown)",
2321 bt_common_color_reset());
2323 bt_value_put_ref(query_result
);
2325 g_free(trace_range
);
2330 int cmd_run_ctx_create_components_from_config_components(
2331 struct cmd_run_ctx
*ctx
, GPtrArray
*cfg_components
)
2334 const void *comp_cls
= NULL
;
2335 const void *comp
= NULL
;
2338 for (i
= 0; i
< cfg_components
->len
; i
++) {
2339 struct bt_config_component
*cfg_comp
=
2340 g_ptr_array_index(cfg_components
, i
);
2343 switch (cfg_comp
->type
) {
2344 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2345 comp_cls
= find_source_component_class(
2346 cfg_comp
->plugin_name
->str
,
2347 cfg_comp
->comp_cls_name
->str
);
2349 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2350 comp_cls
= find_filter_component_class(
2351 cfg_comp
->plugin_name
->str
,
2352 cfg_comp
->comp_cls_name
->str
);
2354 case BT_COMPONENT_CLASS_TYPE_SINK
:
2355 comp_cls
= find_sink_component_class(
2356 cfg_comp
->plugin_name
->str
,
2357 cfg_comp
->comp_cls_name
->str
);
2364 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
2365 "comp-cls-name=\"%s\", comp-cls-type=%d",
2366 cfg_comp
->plugin_name
->str
,
2367 cfg_comp
->comp_cls_name
->str
,
2369 fprintf(stderr
, "%s%sCannot find component class %s",
2370 bt_common_color_bold(),
2371 bt_common_color_fg_red(),
2372 bt_common_color_reset());
2373 print_plugin_comp_cls_opt(stderr
,
2374 cfg_comp
->plugin_name
->str
,
2375 cfg_comp
->comp_cls_name
->str
,
2377 fprintf(stderr
, "\n");
2381 BT_ASSERT(cfg_comp
->log_level
>= BT_LOG_TRACE
);
2383 switch (cfg_comp
->type
) {
2384 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2385 ret
= bt_graph_add_source_component(ctx
->graph
,
2386 comp_cls
, cfg_comp
->instance_name
->str
,
2387 cfg_comp
->params
, cfg_comp
->log_level
,
2390 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2391 ret
= bt_graph_add_filter_component(ctx
->graph
,
2392 comp_cls
, cfg_comp
->instance_name
->str
,
2393 cfg_comp
->params
, cfg_comp
->log_level
,
2396 case BT_COMPONENT_CLASS_TYPE_SINK
:
2397 ret
= bt_graph_add_sink_component(ctx
->graph
,
2398 comp_cls
, cfg_comp
->instance_name
->str
,
2399 cfg_comp
->params
, cfg_comp
->log_level
,
2407 BT_LOGE("Cannot create component: plugin-name=\"%s\", "
2408 "comp-cls-name=\"%s\", comp-cls-type=%d, "
2410 cfg_comp
->plugin_name
->str
,
2411 cfg_comp
->comp_cls_name
->str
,
2412 cfg_comp
->type
, cfg_comp
->instance_name
->str
);
2413 fprintf(stderr
, "%s%sCannot create component `%s`%s\n",
2414 bt_common_color_bold(),
2415 bt_common_color_fg_red(),
2416 cfg_comp
->instance_name
->str
,
2417 bt_common_color_reset());
2421 if (ctx
->stream_intersection_mode
&&
2422 cfg_comp
->type
== BT_COMPONENT_CLASS_TYPE_SOURCE
) {
2423 ret
= set_stream_intersections(ctx
, cfg_comp
, comp_cls
);
2429 BT_LOGI("Created and inserted component: comp-addr=%p, comp-name=\"%s\"",
2430 comp
, cfg_comp
->instance_name
->str
);
2431 quark
= g_quark_from_string(cfg_comp
->instance_name
->str
);
2432 BT_ASSERT(quark
> 0);
2434 switch (cfg_comp
->type
) {
2435 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2436 g_hash_table_insert(ctx
->src_components
,
2437 GUINT_TO_POINTER(quark
), (void *) comp
);
2439 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2440 g_hash_table_insert(ctx
->flt_components
,
2441 GUINT_TO_POINTER(quark
), (void *) comp
);
2443 case BT_COMPONENT_CLASS_TYPE_SINK
:
2444 g_hash_table_insert(ctx
->sink_components
,
2445 GUINT_TO_POINTER(quark
), (void *) comp
);
2452 BT_OBJECT_PUT_REF_AND_RESET(comp_cls
);
2461 bt_object_put_ref(comp
);
2462 bt_object_put_ref(comp_cls
);
2467 int cmd_run_ctx_create_components(struct cmd_run_ctx
*ctx
)
2472 * Make sure that, during this phase, our graph's "port added"
2473 * listener does not connect ports while we are creating the
2474 * components because we have a special, initial phase for
2477 ctx
->connect_ports
= false;
2479 ret
= cmd_run_ctx_create_components_from_config_components(
2480 ctx
, ctx
->cfg
->cmd_data
.run
.sources
);
2486 ret
= cmd_run_ctx_create_components_from_config_components(
2487 ctx
, ctx
->cfg
->cmd_data
.run
.filters
);
2493 ret
= cmd_run_ctx_create_components_from_config_components(
2494 ctx
, ctx
->cfg
->cmd_data
.run
.sinks
);
2504 typedef uint64_t (*output_port_count_func_t
)(const void *);
2505 typedef const bt_port_output
*(*borrow_output_port_by_index_func_t
)(
2506 const void *, uint64_t);
2509 int cmd_run_ctx_connect_comp_ports(struct cmd_run_ctx
*ctx
,
2510 void *comp
, output_port_count_func_t port_count_fn
,
2511 borrow_output_port_by_index_func_t port_by_index_fn
)
2517 count
= port_count_fn(comp
);
2519 for (i
= 0; i
< count
; i
++) {
2520 const bt_port_output
*upstream_port
= port_by_index_fn(comp
, i
);
2522 BT_ASSERT(upstream_port
);
2523 ret
= cmd_run_ctx_connect_upstream_port(ctx
, upstream_port
);
2534 int cmd_run_ctx_connect_ports(struct cmd_run_ctx
*ctx
)
2537 GHashTableIter iter
;
2538 gpointer g_name_quark
, g_comp
;
2540 ctx
->connect_ports
= true;
2541 g_hash_table_iter_init(&iter
, ctx
->src_components
);
2543 while (g_hash_table_iter_next(&iter
, &g_name_quark
, &g_comp
)) {
2544 ret
= cmd_run_ctx_connect_comp_ports(ctx
, g_comp
,
2545 (output_port_count_func_t
)
2546 bt_component_source_get_output_port_count
,
2547 (borrow_output_port_by_index_func_t
)
2548 bt_component_source_borrow_output_port_by_index_const
);
2554 g_hash_table_iter_init(&iter
, ctx
->flt_components
);
2556 while (g_hash_table_iter_next(&iter
, &g_name_quark
, &g_comp
)) {
2557 ret
= cmd_run_ctx_connect_comp_ports(ctx
, g_comp
,
2558 (output_port_count_func_t
)
2559 bt_component_filter_get_output_port_count
,
2560 (borrow_output_port_by_index_func_t
)
2561 bt_component_filter_borrow_output_port_by_index_const
);
2572 int cmd_run(struct bt_config
*cfg
)
2575 struct cmd_run_ctx ctx
= { 0 };
2577 /* Initialize the command's context and the graph object */
2578 if (cmd_run_ctx_init(&ctx
, cfg
)) {
2579 BT_LOGE_STR("Cannot initialize the command's context.");
2580 fprintf(stderr
, "Cannot initialize the command's context\n");
2585 BT_LOGI_STR("Canceled by user before creating components.");
2589 BT_LOGI_STR("Creating components.");
2591 /* Create the requested component instances */
2592 if (cmd_run_ctx_create_components(&ctx
)) {
2593 BT_LOGE_STR("Cannot create components.");
2594 fprintf(stderr
, "Cannot create components\n");
2599 BT_LOGI_STR("Canceled by user before connecting components.");
2603 BT_LOGI_STR("Connecting components.");
2605 /* Connect the initially visible component ports */
2606 if (cmd_run_ctx_connect_ports(&ctx
)) {
2607 BT_LOGE_STR("Cannot connect initial component ports.");
2608 fprintf(stderr
, "Cannot connect initial component ports\n");
2613 BT_LOGI_STR("Canceled by user before running the graph.");
2617 BT_LOGI_STR("Running the graph.");
2621 bt_graph_run_status run_status
= bt_graph_run(ctx
.graph
);
2624 * Reset console in case something messed with console
2625 * codes during the graph's execution.
2627 printf("%s", bt_common_color_reset());
2629 fprintf(stderr
, "%s", bt_common_color_reset());
2630 BT_LOGT("bt_graph_run() returned: status=%s",
2631 bt_common_func_status_string(run_status
));
2633 switch (run_status
) {
2634 case BT_GRAPH_RUN_STATUS_OK
:
2636 case BT_GRAPH_RUN_STATUS_CANCELED
:
2637 BT_LOGI_STR("Graph was canceled by user.");
2639 case BT_GRAPH_RUN_STATUS_AGAIN
:
2640 if (bt_graph_is_canceled(ctx
.graph
)) {
2641 BT_LOGI_STR("Graph was canceled by user.");
2645 if (cfg
->cmd_data
.run
.retry_duration_us
> 0) {
2646 BT_LOGT("Got BT_GRAPH_RUN_STATUS_AGAIN: sleeping: "
2648 cfg
->cmd_data
.run
.retry_duration_us
);
2650 if (usleep(cfg
->cmd_data
.run
.retry_duration_us
)) {
2651 if (bt_graph_is_canceled(ctx
.graph
)) {
2652 BT_LOGI_STR("Graph was canceled by user.");
2658 case BT_GRAPH_RUN_STATUS_END
:
2661 BT_LOGE_STR("Graph failed to complete successfully");
2662 fprintf(stderr
, "Graph failed to complete successfully\n");
2675 cmd_run_ctx_destroy(&ctx
);
2680 void warn_command_name_and_directory_clash(struct bt_config
*cfg
)
2682 const char *env_clash
;
2684 if (!cfg
->command_name
) {
2688 env_clash
= getenv(ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH
);
2689 if (env_clash
&& strcmp(env_clash
, "0") == 0) {
2693 if (g_file_test(cfg
->command_name
,
2694 G_FILE_TEST_EXISTS
| G_FILE_TEST_IS_DIR
)) {
2695 fprintf(stderr
, "\nNOTE: The `%s` command was executed. If you meant to convert a\n",
2697 fprintf(stderr
, "trace located in the local `%s` directory, please use:\n",
2699 fprintf(stderr
, "\n");
2700 fprintf(stderr
, " babeltrace2 convert %s [OPTIONS]\n",
2706 void init_log_level(void)
2708 bt_cli_log_level
= bt_log_get_level_from_env(ENV_BABELTRACE_CLI_LOG_LEVEL
);
2712 void set_auto_log_levels(struct bt_config
*cfg
)
2714 const char **env_var_name
;
2717 * Override the configuration's default log level if
2718 * BABELTRACE_VERBOSE or BABELTRACE_DEBUG environment variables
2719 * are found for backward compatibility with legacy Babetrace 1.
2721 if (getenv("BABELTRACE_DEBUG") &&
2722 strcmp(getenv("BABELTRACE_DEBUG"), "1") == 0) {
2723 cfg
->log_level
= BT_LOG_TRACE
;
2724 } else if (getenv("BABELTRACE_VERBOSE") &&
2725 strcmp(getenv("BABELTRACE_VERBOSE"), "1") == 0) {
2726 cfg
->log_level
= BT_LOG_INFO
;
2730 * Set log levels according to --debug or --verbose. For
2731 * backward compatibility, --debug is more verbose than
2734 * --verbose: INFO log level
2735 * --debug: TRACE log level (includes DEBUG, which is
2736 * is less verbose than TRACE in the internal
2737 * logging framework)
2739 if (!getenv("LIBBABELTRACE2_INIT_LOG_LEVEL")) {
2741 bt_logging_set_global_level(BT_LOG_INFO
);
2742 } else if (cfg
->debug
) {
2743 bt_logging_set_global_level(BT_LOG_TRACE
);
2746 * Set library's default log level if not
2747 * explicitly specified.
2749 bt_logging_set_global_level(cfg
->log_level
);
2753 if (!getenv(ENV_BABELTRACE_CLI_LOG_LEVEL
)) {
2755 bt_cli_log_level
= BT_LOG_INFO
;
2756 } else if (cfg
->debug
) {
2757 bt_cli_log_level
= BT_LOG_TRACE
;
2760 * Set CLI's default log level if not explicitly
2763 bt_cli_log_level
= cfg
->log_level
;
2767 env_var_name
= log_level_env_var_names
;
2769 while (*env_var_name
) {
2770 if (!getenv(*env_var_name
)) {
2772 g_setenv(*env_var_name
, "INFO", 1);
2773 } else if (cfg
->debug
) {
2774 g_setenv(*env_var_name
, "TRACE", 1);
2776 char val
[2] = { 0 };
2779 * Set module's default log level if not
2780 * explicitly specified.
2782 val
[0] = bt_log_get_letter_from_level(
2784 g_setenv(*env_var_name
, val
, 1);
2792 int main(int argc
, const char **argv
)
2796 struct bt_config
*cfg
;
2799 set_signal_handler();
2801 cfg
= bt_config_cli_args_create_with_default(argc
, argv
, &retcode
);
2804 /* Quit without errors; typically usage/version */
2806 BT_LOGI_STR("Quitting without errors.");
2811 BT_LOGE("Command-line error: retcode=%d", retcode
);
2816 BT_LOGE_STR("Failed to create a valid Babeltrace configuration.");
2817 fprintf(stderr
, "Failed to create Babeltrace configuration\n");
2822 set_auto_log_levels(cfg
);
2825 if (cfg
->command_needs_plugins
) {
2826 ret
= load_all_plugins(cfg
->plugin_paths
);
2828 BT_LOGE("Failed to load plugins: ret=%d", ret
);
2834 BT_LOGI("Executing command: cmd=%d, command-name=\"%s\"",
2835 cfg
->command
, cfg
->command_name
);
2837 switch (cfg
->command
) {
2838 case BT_CONFIG_COMMAND_RUN
:
2841 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
2842 ret
= cmd_list_plugins(cfg
);
2844 case BT_CONFIG_COMMAND_HELP
:
2845 ret
= cmd_help(cfg
);
2847 case BT_CONFIG_COMMAND_QUERY
:
2848 ret
= cmd_query(cfg
);
2850 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
2851 ret
= cmd_print_ctf_metadata(cfg
);
2853 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
2854 ret
= cmd_print_lttng_live_sessions(cfg
);
2857 BT_LOGF("Invalid/unknown command: cmd=%d", cfg
->command
);
2861 BT_LOGI("Command completed: cmd=%d, command-name=\"%s\", ret=%d",
2862 cfg
->command
, cfg
->command_name
, ret
);
2863 warn_command_name_and_directory_clash(cfg
);
2864 retcode
= ret
? 1 : 0;
2867 BT_OBJECT_PUT_REF_AND_RESET(cfg
);