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",
54 "BABELTRACE_SINK_CTF_FS_LOG_LEVEL",
55 "BABELTRACE_SINK_TEXT_DETAILS_LOG_LEVEL",
56 "BABELTRACE_SRC_CTF_FS_LOG_LEVEL",
60 /* Application's processing graph (weak) */
61 static bt_graph
*the_graph
;
62 static bt_query_executor
*the_query_executor
;
63 static bool canceled
= false;
65 GPtrArray
*loaded_plugins
;
72 BOOL WINAPI
signal_handler(DWORD signal
) {
74 bt_graph_cancel(the_graph
);
83 void set_signal_handler(void)
85 if (!SetConsoleCtrlHandler(signal_handler
, TRUE
)) {
86 BT_LOGE("Failed to set the Ctrl+C handler.");
90 #else /* __MINGW32__ */
93 void signal_handler(int signum
)
95 if (signum
!= SIGINT
) {
100 bt_graph_cancel(the_graph
);
103 if (the_query_executor
) {
104 bt_query_executor_cancel(the_query_executor
);
111 void set_signal_handler(void)
113 struct sigaction new_action
, old_action
;
115 new_action
.sa_handler
= signal_handler
;
116 sigemptyset(&new_action
.sa_mask
);
117 new_action
.sa_flags
= 0;
118 sigaction(SIGINT
, NULL
, &old_action
);
120 if (old_action
.sa_handler
!= SIG_IGN
) {
121 sigaction(SIGINT
, &new_action
, NULL
);
125 #endif /* __MINGW32__ */
128 void init_static_data(void)
130 loaded_plugins
= g_ptr_array_new_with_free_func(
131 (GDestroyNotify
) bt_object_put_ref
);
135 void fini_static_data(void)
137 g_ptr_array_free(loaded_plugins
, TRUE
);
141 int create_the_query_executor(void)
145 the_query_executor
= bt_query_executor_create();
146 if (!the_query_executor
) {
147 BT_LOGE_STR("Cannot create a query executor.");
155 void destroy_the_query_executor(void)
157 BT_QUERY_EXECUTOR_PUT_REF_AND_RESET(the_query_executor
);
161 int query(struct bt_config
*cfg
, const bt_component_class
*comp_cls
,
162 const char *obj
, const bt_value
*params
,
163 const bt_value
**user_result
, const char **fail_reason
)
165 const bt_value
*result
= NULL
;
166 bt_query_executor_status status
;
167 *fail_reason
= "unknown error";
170 BT_ASSERT(fail_reason
);
171 BT_ASSERT(user_result
);
172 ret
= create_the_query_executor();
174 /* create_the_query_executor() logs errors */
179 BT_LOGI("Canceled by user before executing the query: "
180 "comp-cls-addr=%p, comp-cls-name=\"%s\", "
181 "query-obj=\"%s\"", comp_cls
,
182 bt_component_class_get_name(comp_cls
), obj
);
183 *fail_reason
= "canceled by user";
188 status
= bt_query_executor_query(the_query_executor
,
189 comp_cls
, obj
, params
, cfg
->log_level
, &result
);
191 case BT_QUERY_EXECUTOR_STATUS_OK
:
193 case BT_QUERY_EXECUTOR_STATUS_AGAIN
:
195 const uint64_t sleep_time_us
= 100000;
197 /* Wait 100 ms and retry */
198 BT_LOGD("Got BT_QUERY_EXECUTOR_STATUS_AGAIN: sleeping: "
199 "time-us=%" PRIu64
, sleep_time_us
);
201 if (usleep(sleep_time_us
)) {
202 if (bt_query_executor_is_canceled(the_query_executor
)) {
203 BT_LOGI("Query was canceled by user: "
204 "comp-cls-addr=%p, comp-cls-name=\"%s\", "
205 "query-obj=\"%s\"", comp_cls
,
206 bt_component_class_get_name(comp_cls
),
208 *fail_reason
= "canceled by user";
215 case BT_QUERY_EXECUTOR_STATUS_CANCELED
:
216 *fail_reason
= "canceled by user";
218 case BT_QUERY_EXECUTOR_STATUS_ERROR
:
220 case BT_QUERY_EXECUTOR_STATUS_INVALID_OBJECT
:
221 *fail_reason
= "invalid or unknown query object";
223 case BT_QUERY_EXECUTOR_STATUS_INVALID_PARAMS
:
224 *fail_reason
= "invalid query parameters";
226 case BT_QUERY_EXECUTOR_STATUS_UNSUPPORTED
:
227 *fail_reason
= "unsupported action";
229 case BT_QUERY_EXECUTOR_STATUS_NOMEM
:
230 *fail_reason
= "not enough memory";
233 BT_LOGF("Unknown query status: status=%d", status
);
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
;
806 bt_value_array_borrow_element_by_index_const(
808 plugin_path
= bt_value_string_get(plugin_path_value
);
811 * Skip this if the directory does not exist because
812 * bt_plugin_find_all_from_dir() expects an existing
815 if (!g_file_test(plugin_path
, G_FILE_TEST_IS_DIR
)) {
816 BT_LOGI("Skipping nonexistent directory path: "
817 "path=\"%s\"", plugin_path
);
821 plugin_set
= bt_plugin_find_all_from_dir(plugin_path
, false);
823 BT_LOGI("Unable to load dynamic plugins from directory: "
824 "path=\"%s\"", plugin_path
);
828 add_to_loaded_plugins(plugin_set
);
829 bt_plugin_set_put_ref(plugin_set
);
836 int load_static_plugins(void)
839 const bt_plugin_set
*plugin_set
;
841 BT_LOGI("Loading static plugins.");
842 plugin_set
= bt_plugin_find_all_from_static();
844 BT_LOGE("Unable to load static plugins.");
849 add_to_loaded_plugins(plugin_set
);
850 bt_plugin_set_put_ref(plugin_set
);
856 int load_all_plugins(const bt_value
*plugin_paths
)
860 if (load_dynamic_plugins(plugin_paths
)) {
865 if (load_static_plugins()) {
870 BT_LOGI("Loaded all plugins: count=%u", loaded_plugins
->len
);
877 void print_plugin_info(const bt_plugin
*plugin
)
879 unsigned int major
, minor
, patch
;
881 bt_property_availability version_avail
;
882 const char *plugin_name
;
886 const char *plugin_description
;
888 plugin_name
= bt_plugin_get_name(plugin
);
889 path
= bt_plugin_get_path(plugin
);
890 author
= bt_plugin_get_author(plugin
);
891 license
= bt_plugin_get_license(plugin
);
892 plugin_description
= bt_plugin_get_description(plugin
);
893 version_avail
= bt_plugin_get_version(plugin
, &major
, &minor
,
895 printf("%s%s%s%s:\n", bt_common_color_bold(),
896 bt_common_color_fg_blue(), plugin_name
,
897 bt_common_color_reset());
899 printf(" %sPath%s: %s\n", bt_common_color_bold(),
900 bt_common_color_reset(), path
);
905 if (version_avail
== BT_PROPERTY_AVAILABILITY_AVAILABLE
) {
906 printf(" %sVersion%s: %u.%u.%u",
907 bt_common_color_bold(), bt_common_color_reset(),
908 major
, minor
, patch
);
917 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
918 bt_common_color_reset(),
919 plugin_description
? plugin_description
: "(None)");
920 printf(" %sAuthor%s: %s\n", bt_common_color_bold(),
921 bt_common_color_reset(), author
? author
: "(Unknown)");
922 printf(" %sLicense%s: %s\n", bt_common_color_bold(),
923 bt_common_color_reset(),
924 license
? license
: "(Unknown)");
928 int cmd_query(struct bt_config
*cfg
)
931 const bt_component_class
*comp_cls
= NULL
;
932 const bt_value
*results
= NULL
;
933 const char *fail_reason
= NULL
;
935 comp_cls
= find_component_class(
936 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
937 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
938 cfg
->cmd_data
.query
.cfg_component
->type
);
940 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
941 "comp-cls-name=\"%s\", comp-cls-type=%d",
942 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
943 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
944 cfg
->cmd_data
.query
.cfg_component
->type
);
945 fprintf(stderr
, "%s%sCannot find component class %s",
946 bt_common_color_bold(),
947 bt_common_color_fg_red(),
948 bt_common_color_reset());
949 print_plugin_comp_cls_opt(stderr
,
950 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
951 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
952 cfg
->cmd_data
.query
.cfg_component
->type
);
953 fprintf(stderr
, "\n");
958 ret
= query(cfg
, comp_cls
, cfg
->cmd_data
.query
.object
->str
,
959 cfg
->cmd_data
.query
.cfg_component
->params
,
960 &results
, &fail_reason
);
965 print_value(stdout
, results
, 0);
969 BT_LOGE("Failed to query component class: %s: plugin-name=\"%s\", "
970 "comp-cls-name=\"%s\", comp-cls-type=%d "
971 "object=\"%s\"", fail_reason
,
972 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
973 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
974 cfg
->cmd_data
.query
.cfg_component
->type
,
975 cfg
->cmd_data
.query
.object
->str
);
976 fprintf(stderr
, "%s%sFailed to query info to %s",
977 bt_common_color_bold(),
978 bt_common_color_fg_red(),
979 bt_common_color_reset());
980 print_plugin_comp_cls_opt(stderr
,
981 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
982 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
983 cfg
->cmd_data
.query
.cfg_component
->type
);
984 fprintf(stderr
, "%s%s with object `%s`: %s%s\n",
985 bt_common_color_bold(),
986 bt_common_color_fg_red(),
987 cfg
->cmd_data
.query
.object
->str
,
989 bt_common_color_reset());
993 bt_component_class_put_ref(comp_cls
);
994 bt_value_put_ref(results
);
999 void print_component_class_help(const char *plugin_name
,
1000 const bt_component_class
*comp_cls
)
1002 const char *comp_class_name
=
1003 bt_component_class_get_name(comp_cls
);
1004 const char *comp_class_description
=
1005 bt_component_class_get_description(comp_cls
);
1006 const char *comp_class_help
=
1007 bt_component_class_get_help(comp_cls
);
1008 bt_component_class_type type
=
1009 bt_component_class_get_type(comp_cls
);
1011 print_plugin_comp_cls_opt(stdout
, plugin_name
, comp_class_name
, type
);
1013 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
1014 bt_common_color_reset(),
1015 comp_class_description
? comp_class_description
: "(None)");
1017 if (comp_class_help
) {
1018 printf("\n%s\n", comp_class_help
);
1023 int cmd_help(struct bt_config
*cfg
)
1026 const bt_plugin
*plugin
= NULL
;
1027 const bt_component_class
*needed_comp_cls
= NULL
;
1029 plugin
= find_plugin(cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
1031 BT_LOGE("Cannot find plugin: plugin-name=\"%s\"",
1032 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
1033 fprintf(stderr
, "%s%sCannot find plugin %s%s%s\n",
1034 bt_common_color_bold(), bt_common_color_fg_red(),
1035 bt_common_color_fg_blue(),
1036 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1037 bt_common_color_reset());
1042 print_plugin_info(plugin
);
1043 printf(" %sSource component classes%s: %d\n",
1044 bt_common_color_bold(),
1045 bt_common_color_reset(),
1046 (int) bt_plugin_get_source_component_class_count(plugin
));
1047 printf(" %sFilter component classes%s: %d\n",
1048 bt_common_color_bold(),
1049 bt_common_color_reset(),
1050 (int) bt_plugin_get_filter_component_class_count(plugin
));
1051 printf(" %sSink component classes%s: %d\n",
1052 bt_common_color_bold(),
1053 bt_common_color_reset(),
1054 (int) bt_plugin_get_sink_component_class_count(plugin
));
1056 if (strlen(cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
) == 0) {
1057 /* Plugin help only */
1061 needed_comp_cls
= find_component_class(
1062 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1063 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
1064 cfg
->cmd_data
.help
.cfg_component
->type
);
1065 if (!needed_comp_cls
) {
1066 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
1067 "comp-cls-name=\"%s\", comp-cls-type=%d",
1068 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1069 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
1070 cfg
->cmd_data
.help
.cfg_component
->type
);
1071 fprintf(stderr
, "\n%s%sCannot find component class %s",
1072 bt_common_color_bold(),
1073 bt_common_color_fg_red(),
1074 bt_common_color_reset());
1075 print_plugin_comp_cls_opt(stderr
,
1076 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1077 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
1078 cfg
->cmd_data
.help
.cfg_component
->type
);
1079 fprintf(stderr
, "\n");
1085 print_component_class_help(
1086 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
1090 bt_component_class_put_ref(needed_comp_cls
);
1091 bt_plugin_put_ref(plugin
);
1095 typedef void *(* plugin_borrow_comp_cls_by_index_func_t
)(const bt_plugin
*,
1097 typedef const bt_component_class
*(* spec_comp_cls_borrow_comp_cls_func_t
)(
1100 void cmd_list_plugins_print_component_classes(const bt_plugin
*plugin
,
1101 const char *cc_type_name
, uint64_t count
,
1102 plugin_borrow_comp_cls_by_index_func_t borrow_comp_cls_by_index_func
,
1103 spec_comp_cls_borrow_comp_cls_func_t spec_comp_cls_borrow_comp_cls_func
)
1108 printf(" %s%s component classes%s: (none)\n",
1109 bt_common_color_bold(),
1111 bt_common_color_reset());
1114 printf(" %s%s component classes%s:\n",
1115 bt_common_color_bold(),
1117 bt_common_color_reset());
1120 for (i
= 0; i
< count
; i
++) {
1121 const bt_component_class
*comp_class
=
1122 spec_comp_cls_borrow_comp_cls_func(
1123 borrow_comp_cls_by_index_func(plugin
, i
));
1124 const char *comp_class_name
=
1125 bt_component_class_get_name(comp_class
);
1126 const char *comp_class_description
=
1127 bt_component_class_get_description(comp_class
);
1128 bt_component_class_type type
=
1129 bt_component_class_get_type(comp_class
);
1132 print_plugin_comp_cls_opt(stdout
,
1133 bt_plugin_get_name(plugin
), comp_class_name
,
1136 if (comp_class_description
) {
1137 printf(": %s", comp_class_description
);
1148 int cmd_list_plugins(struct bt_config
*cfg
)
1151 int plugins_count
, component_classes_count
= 0, i
;
1153 printf("From the following plugin paths:\n\n");
1154 print_value(stdout
, cfg
->plugin_paths
, 2);
1156 plugins_count
= loaded_plugins
->len
;
1157 if (plugins_count
== 0) {
1158 printf("No plugins found.\n");
1162 for (i
= 0; i
< plugins_count
; i
++) {
1163 const bt_plugin
*plugin
= g_ptr_array_index(loaded_plugins
, i
);
1165 component_classes_count
+=
1166 bt_plugin_get_source_component_class_count(plugin
) +
1167 bt_plugin_get_filter_component_class_count(plugin
) +
1168 bt_plugin_get_sink_component_class_count(plugin
);
1171 printf("Found %s%d%s component classes in %s%d%s plugins.\n",
1172 bt_common_color_bold(),
1173 component_classes_count
,
1174 bt_common_color_reset(),
1175 bt_common_color_bold(),
1177 bt_common_color_reset());
1179 for (i
= 0; i
< plugins_count
; i
++) {
1180 const bt_plugin
*plugin
= g_ptr_array_index(loaded_plugins
, i
);
1183 print_plugin_info(plugin
);
1184 cmd_list_plugins_print_component_classes(plugin
, "Source",
1185 bt_plugin_get_source_component_class_count(plugin
),
1186 (plugin_borrow_comp_cls_by_index_func_t
)
1187 bt_plugin_borrow_source_component_class_by_index_const
,
1188 (spec_comp_cls_borrow_comp_cls_func_t
)
1189 bt_component_class_source_as_component_class
);
1190 cmd_list_plugins_print_component_classes(plugin
, "Filter",
1191 bt_plugin_get_filter_component_class_count(plugin
),
1192 (plugin_borrow_comp_cls_by_index_func_t
)
1193 bt_plugin_borrow_filter_component_class_by_index_const
,
1194 (spec_comp_cls_borrow_comp_cls_func_t
)
1195 bt_component_class_filter_as_component_class
);
1196 cmd_list_plugins_print_component_classes(plugin
, "Sink",
1197 bt_plugin_get_sink_component_class_count(plugin
),
1198 (plugin_borrow_comp_cls_by_index_func_t
)
1199 bt_plugin_borrow_sink_component_class_by_index_const
,
1200 (spec_comp_cls_borrow_comp_cls_func_t
)
1201 bt_component_class_sink_as_component_class
);
1209 int cmd_print_lttng_live_sessions(struct bt_config
*cfg
)
1212 const bt_component_class
*comp_cls
= NULL
;
1213 const bt_value
*results
= NULL
;
1214 bt_value
*params
= NULL
;
1215 const bt_value
*map
= NULL
;
1216 const bt_value
*v
= NULL
;
1217 static const char * const plugin_name
= "ctf";
1218 static const char * const comp_cls_name
= "lttng-live";
1219 static const bt_component_class_type comp_cls_type
=
1220 BT_COMPONENT_CLASS_TYPE_SOURCE
;
1221 int64_t array_size
, i
;
1222 const char *fail_reason
= NULL
;
1223 FILE *out_stream
= stdout
;
1225 BT_ASSERT(cfg
->cmd_data
.print_lttng_live_sessions
.url
);
1226 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1229 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
1230 "comp-cls-name=\"%s\", comp-cls-type=%d",
1231 plugin_name
, comp_cls_name
,
1232 BT_COMPONENT_CLASS_TYPE_SOURCE
);
1233 fprintf(stderr
, "%s%sCannot find component class %s",
1234 bt_common_color_bold(),
1235 bt_common_color_fg_red(),
1236 bt_common_color_reset());
1237 print_plugin_comp_cls_opt(stderr
, plugin_name
,
1238 comp_cls_name
, comp_cls_type
);
1239 fprintf(stderr
, "\n");
1243 params
= bt_value_map_create();
1248 ret
= bt_value_map_insert_string_entry(params
, "url",
1249 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
1254 ret
= query(cfg
, comp_cls
, "sessions", params
,
1255 &results
, &fail_reason
);
1262 if (!bt_value_is_array(results
)) {
1263 BT_LOGE_STR("Expecting an array for sessions query.");
1264 fprintf(stderr
, "%s%sUnexpected type returned by session query%s\n",
1265 bt_common_color_bold(),
1266 bt_common_color_fg_red(),
1267 bt_common_color_reset());
1271 if (cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->len
> 0) {
1273 fopen(cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
,
1277 BT_LOGE_ERRNO("Cannot open file for writing",
1279 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
1284 array_size
= bt_value_array_get_size(results
);
1285 for (i
= 0; i
< array_size
; i
++) {
1286 const char *url_text
;
1287 int64_t timer_us
, streams
, clients
;
1289 map
= bt_value_array_borrow_element_by_index_const(results
, i
);
1291 BT_LOGE_STR("Unexpected empty array entry.");
1294 if (!bt_value_is_map(map
)) {
1295 BT_LOGE_STR("Unexpected entry type.");
1299 v
= bt_value_map_borrow_entry_value_const(map
, "url");
1301 BT_LOGE_STR("Unexpected empty array \"url\" entry.");
1304 url_text
= bt_value_string_get(v
);
1305 fprintf(out_stream
, "%s", url_text
);
1306 v
= bt_value_map_borrow_entry_value_const(map
, "timer-us");
1308 BT_LOGE_STR("Unexpected empty array \"timer-us\" entry.");
1311 timer_us
= bt_value_signed_integer_get(v
);
1312 fprintf(out_stream
, " (timer = %" PRIu64
", ", timer_us
);
1313 v
= bt_value_map_borrow_entry_value_const(map
, "stream-count");
1315 BT_LOGE_STR("Unexpected empty array \"stream-count\" entry.");
1318 streams
= bt_value_signed_integer_get(v
);
1319 fprintf(out_stream
, "%" PRIu64
" stream(s), ", streams
);
1320 v
= bt_value_map_borrow_entry_value_const(map
, "client-count");
1322 BT_LOGE_STR("Unexpected empty array \"client-count\" entry.");
1325 clients
= bt_value_signed_integer_get(v
);
1326 fprintf(out_stream
, "%" PRIu64
" client(s) connected)\n", clients
);
1332 BT_LOGE("Failed to query for sessions: %s", fail_reason
);
1333 fprintf(stderr
, "%s%sFailed to request sessions: %s%s\n",
1334 bt_common_color_bold(),
1335 bt_common_color_fg_red(),
1337 bt_common_color_reset());
1343 bt_value_put_ref(results
);
1344 bt_value_put_ref(params
);
1345 bt_component_class_put_ref(comp_cls
);
1347 if (out_stream
&& out_stream
!= stdout
) {
1348 int fclose_ret
= fclose(out_stream
);
1351 BT_LOGE_ERRNO("Cannot close file stream",
1353 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
1361 int cmd_print_ctf_metadata(struct bt_config
*cfg
)
1364 const bt_component_class
*comp_cls
= NULL
;
1365 const bt_value
*results
= NULL
;
1366 bt_value
*params
= NULL
;
1367 const bt_value
*metadata_text_value
= NULL
;
1368 const char *metadata_text
= NULL
;
1369 static const char * const plugin_name
= "ctf";
1370 static const char * const comp_cls_name
= "fs";
1371 static const bt_component_class_type comp_cls_type
=
1372 BT_COMPONENT_CLASS_TYPE_SOURCE
;
1373 const char *fail_reason
= NULL
;
1374 FILE *out_stream
= stdout
;
1376 BT_ASSERT(cfg
->cmd_data
.print_ctf_metadata
.path
);
1377 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1380 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
1381 "comp-cls-name=\"%s\", comp-cls-type=%d",
1382 plugin_name
, comp_cls_name
,
1383 BT_COMPONENT_CLASS_TYPE_SOURCE
);
1384 fprintf(stderr
, "%s%sCannot find component class %s",
1385 bt_common_color_bold(),
1386 bt_common_color_fg_red(),
1387 bt_common_color_reset());
1388 print_plugin_comp_cls_opt(stderr
, plugin_name
,
1389 comp_cls_name
, comp_cls_type
);
1390 fprintf(stderr
, "\n");
1395 params
= bt_value_map_create();
1401 ret
= bt_value_map_insert_string_entry(params
, "path",
1402 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
1408 ret
= query(cfg
, comp_cls
, "metadata-info",
1409 params
, &results
, &fail_reason
);
1414 metadata_text_value
= bt_value_map_borrow_entry_value_const(results
,
1416 if (!metadata_text_value
) {
1417 BT_LOGE_STR("Cannot find `text` string value in the resulting metadata info object.");
1422 metadata_text
= bt_value_string_get(metadata_text_value
);
1424 if (cfg
->cmd_data
.print_ctf_metadata
.output_path
->len
> 0) {
1426 fopen(cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
,
1430 BT_LOGE_ERRNO("Cannot open file for writing",
1432 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1437 ret
= fprintf(out_stream
, "%s\n", metadata_text
);
1439 BT_LOGE("Cannot write whole metadata text to output stream: "
1450 BT_LOGE("Failed to query for metadata info: %s", fail_reason
);
1451 fprintf(stderr
, "%s%sFailed to request metadata info: %s%s\n",
1452 bt_common_color_bold(),
1453 bt_common_color_fg_red(),
1455 bt_common_color_reset());
1458 bt_value_put_ref(results
);
1459 bt_value_put_ref(params
);
1460 bt_component_class_put_ref(comp_cls
);
1462 if (out_stream
&& out_stream
!= stdout
) {
1463 int fclose_ret
= fclose(out_stream
);
1466 BT_LOGE_ERRNO("Cannot close file stream",
1468 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1476 char *instance_name
;
1480 struct trace_range
{
1481 uint64_t intersection_range_begin_ns
;
1482 uint64_t intersection_range_end_ns
;
1486 guint
port_id_hash(gconstpointer v
)
1488 const struct port_id
*id
= v
;
1490 BT_ASSERT(id
->instance_name
);
1491 BT_ASSERT(id
->port_name
);
1493 return g_str_hash(id
->instance_name
) ^ g_str_hash(id
->port_name
);
1497 gboolean
port_id_equal(gconstpointer v1
, gconstpointer v2
)
1499 const struct port_id
*id1
= v1
;
1500 const struct port_id
*id2
= v2
;
1502 return !strcmp(id1
->instance_name
, id2
->instance_name
) &&
1503 !strcmp(id1
->port_name
, id2
->port_name
);
1507 void port_id_destroy(gpointer data
)
1509 struct port_id
*id
= data
;
1511 free(id
->instance_name
);
1512 free(id
->port_name
);
1517 void trace_range_destroy(gpointer data
)
1522 struct cmd_run_ctx
{
1524 GHashTable
*src_components
;
1527 GHashTable
*flt_components
;
1530 GHashTable
*sink_components
;
1536 struct bt_config
*cfg
;
1540 bool stream_intersection_mode
;
1543 * Association of struct port_id -> struct trace_range.
1545 GHashTable
*intersections
;
1548 /* Returns a timestamp of the form "(-)s.ns" */
1550 char *s_from_ns(int64_t ns
)
1555 int64_t ts_sec_abs
, ts_nsec_abs
;
1556 int64_t ts_sec
= ns
/ NSEC_PER_SEC
;
1557 int64_t ts_nsec
= ns
% NSEC_PER_SEC
;
1559 if (ts_sec
>= 0 && ts_nsec
>= 0) {
1560 is_negative
= false;
1561 ts_sec_abs
= ts_sec
;
1562 ts_nsec_abs
= ts_nsec
;
1563 } else if (ts_sec
> 0 && ts_nsec
< 0) {
1564 is_negative
= false;
1565 ts_sec_abs
= ts_sec
- 1;
1566 ts_nsec_abs
= NSEC_PER_SEC
+ ts_nsec
;
1567 } else if (ts_sec
== 0 && ts_nsec
< 0) {
1569 ts_sec_abs
= ts_sec
;
1570 ts_nsec_abs
= -ts_nsec
;
1571 } else if (ts_sec
< 0 && ts_nsec
> 0) {
1573 ts_sec_abs
= -(ts_sec
+ 1);
1574 ts_nsec_abs
= NSEC_PER_SEC
- ts_nsec
;
1575 } else if (ts_sec
< 0 && ts_nsec
== 0) {
1577 ts_sec_abs
= -ts_sec
;
1578 ts_nsec_abs
= ts_nsec
;
1579 } else { /* (ts_sec < 0 && ts_nsec < 0) */
1581 ts_sec_abs
= -ts_sec
;
1582 ts_nsec_abs
= -ts_nsec
;
1585 ret
= asprintf(&s_ret
, "%s%" PRId64
".%09" PRId64
,
1586 is_negative
? "-" : "", ts_sec_abs
, ts_nsec_abs
);
1594 int cmd_run_ctx_connect_upstream_port_to_downstream_component(
1595 struct cmd_run_ctx
*ctx
,
1596 const bt_component
*upstream_comp
,
1597 const bt_port_output
*out_upstream_port
,
1598 struct bt_config_connection
*cfg_conn
)
1600 typedef uint64_t (*input_port_count_func_t
)(void *);
1601 typedef const bt_port_input
*(*borrow_input_port_by_index_func_t
)(
1602 const void *, uint64_t);
1603 const bt_port
*upstream_port
=
1604 bt_port_output_as_port_const(out_upstream_port
);
1607 GQuark downstreamp_comp_name_quark
;
1608 void *downstream_comp
;
1609 uint64_t downstream_port_count
;
1611 input_port_count_func_t port_count_fn
;
1612 borrow_input_port_by_index_func_t port_by_index_fn
;
1613 bt_graph_status status
= BT_GRAPH_STATUS_ERROR
;
1614 bool insert_trimmer
= false;
1615 bt_value
*trimmer_params
= NULL
;
1616 char *intersection_begin
= NULL
;
1617 char *intersection_end
= NULL
;
1618 const bt_component_filter
*trimmer
= NULL
;
1619 const bt_component_class_filter
*trimmer_class
= NULL
;
1620 const bt_port_input
*trimmer_input
= NULL
;
1621 const bt_port_output
*trimmer_output
= NULL
;
1623 if (ctx
->intersections
&&
1624 bt_component_get_class_type(upstream_comp
) ==
1625 BT_COMPONENT_CLASS_TYPE_SOURCE
) {
1626 struct trace_range
*range
;
1627 struct port_id port_id
= {
1628 .instance_name
= (char *) bt_component_get_name(upstream_comp
),
1629 .port_name
= (char *) bt_port_get_name(upstream_port
)
1632 if (!port_id
.instance_name
|| !port_id
.port_name
) {
1636 range
= (struct trace_range
*) g_hash_table_lookup(
1637 ctx
->intersections
, &port_id
);
1639 bt_value_status status
;
1641 intersection_begin
= s_from_ns(
1642 range
->intersection_range_begin_ns
);
1643 intersection_end
= s_from_ns(
1644 range
->intersection_range_end_ns
);
1645 if (!intersection_begin
|| !intersection_end
) {
1646 BT_LOGE_STR("Cannot create trimmer argument timestamp string.");
1650 insert_trimmer
= true;
1651 trimmer_params
= bt_value_map_create();
1652 if (!trimmer_params
) {
1656 status
= bt_value_map_insert_string_entry(
1657 trimmer_params
, "begin", intersection_begin
);
1658 if (status
!= BT_VALUE_STATUS_OK
) {
1661 status
= bt_value_map_insert_string_entry(
1663 "end", intersection_end
);
1664 if (status
!= BT_VALUE_STATUS_OK
) {
1669 trimmer_class
= find_filter_component_class("utils", "trimmer");
1670 if (!trimmer_class
) {
1675 BT_LOGI("Connecting upstream port to the next available downstream port: "
1676 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1677 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1678 upstream_port
, bt_port_get_name(upstream_port
),
1679 cfg_conn
->downstream_comp_name
->str
,
1680 cfg_conn
->arg
->str
);
1681 downstreamp_comp_name_quark
= g_quark_from_string(
1682 cfg_conn
->downstream_comp_name
->str
);
1683 BT_ASSERT(downstreamp_comp_name_quark
> 0);
1684 downstream_comp
= g_hash_table_lookup(ctx
->flt_components
,
1685 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1686 port_count_fn
= (input_port_count_func_t
)
1687 bt_component_filter_get_input_port_count
;
1688 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1689 bt_component_filter_borrow_input_port_by_index_const
;
1691 if (!downstream_comp
) {
1692 downstream_comp
= g_hash_table_lookup(ctx
->sink_components
,
1693 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1694 port_count_fn
= (input_port_count_func_t
)
1695 bt_component_sink_get_input_port_count
;
1696 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1697 bt_component_sink_borrow_input_port_by_index_const
;
1700 if (!downstream_comp
) {
1701 BT_LOGE("Cannot find downstream component: comp-name=\"%s\", "
1702 "conn-arg=\"%s\"", cfg_conn
->downstream_comp_name
->str
,
1703 cfg_conn
->arg
->str
);
1704 fprintf(stderr
, "Cannot create connection: cannot find downstream component: %s\n",
1705 cfg_conn
->arg
->str
);
1709 downstream_port_count
= port_count_fn(downstream_comp
);
1711 for (i
= 0; i
< downstream_port_count
; i
++) {
1712 const bt_port_input
*in_downstream_port
=
1713 port_by_index_fn(downstream_comp
, i
);
1714 const bt_port
*downstream_port
=
1715 bt_port_input_as_port_const(in_downstream_port
);
1716 const char *upstream_port_name
;
1717 const char *downstream_port_name
;
1719 BT_ASSERT(downstream_port
);
1721 /* Skip port if it's already connected. */
1722 if (bt_port_is_connected(downstream_port
)) {
1723 BT_LOGI("Skipping downstream port: already connected: "
1724 "port-addr=%p, port-name=\"%s\"",
1726 bt_port_get_name(downstream_port
));
1730 downstream_port_name
= bt_port_get_name(downstream_port
);
1731 BT_ASSERT(downstream_port_name
);
1732 upstream_port_name
= bt_port_get_name(upstream_port
);
1733 BT_ASSERT(upstream_port_name
);
1735 if (!bt_common_star_glob_match(
1736 cfg_conn
->downstream_port_glob
->str
, SIZE_MAX
,
1737 downstream_port_name
, SIZE_MAX
)) {
1741 if (insert_trimmer
) {
1743 * In order to insert the trimmer between the
1744 * two components that were being connected, we
1745 * create a connection configuration entry which
1746 * describes a connection from the trimmer's
1747 * output to the original input that was being
1750 * Hence, the creation of the trimmer will cause
1751 * the graph "new port" listener to establish
1752 * all downstream connections as its output port
1753 * is connected. We will then establish the
1754 * connection between the original upstream
1755 * source and the trimmer.
1757 char *trimmer_name
= NULL
;
1758 bt_graph_status graph_status
;
1760 ret
= asprintf(&trimmer_name
,
1761 "stream-intersection-trimmer-%s",
1762 upstream_port_name
);
1768 ctx
->connect_ports
= false;
1769 graph_status
= bt_graph_add_filter_component(
1770 ctx
->graph
, trimmer_class
, trimmer_name
,
1771 trimmer_params
, ctx
->cfg
->log_level
,
1774 if (graph_status
!= BT_GRAPH_STATUS_OK
) {
1780 bt_component_filter_borrow_input_port_by_index_const(
1782 if (!trimmer_input
) {
1786 bt_component_filter_borrow_output_port_by_index_const(
1788 if (!trimmer_output
) {
1793 * Replace the current downstream port by the trimmer's
1796 in_downstream_port
= trimmer_input
;
1798 bt_port_input_as_port_const(in_downstream_port
);
1799 downstream_port_name
= bt_port_get_name(
1801 BT_ASSERT(downstream_port_name
);
1804 /* We have a winner! */
1805 status
= bt_graph_connect_ports(ctx
->graph
,
1806 out_upstream_port
, in_downstream_port
, NULL
);
1807 downstream_port
= NULL
;
1809 case BT_GRAPH_STATUS_OK
:
1811 case BT_GRAPH_STATUS_CANCELED
:
1812 BT_LOGI_STR("Graph was canceled by user.");
1813 status
= BT_GRAPH_STATUS_OK
;
1815 case BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION
:
1816 BT_LOGE("A component refused a connection to one of its ports: "
1817 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1818 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1819 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1820 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1822 upstream_comp
, bt_component_get_name(upstream_comp
),
1823 upstream_port
, bt_port_get_name(upstream_port
),
1824 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1825 downstream_port
, downstream_port_name
,
1826 cfg_conn
->arg
->str
);
1828 "A component refused a connection to one of its ports (`%s` to `%s`): %s\n",
1829 bt_port_get_name(upstream_port
),
1830 downstream_port_name
,
1831 cfg_conn
->arg
->str
);
1834 BT_LOGE("Cannot create connection: graph refuses to connect ports: "
1835 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1836 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1837 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1838 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1840 upstream_comp
, bt_component_get_name(upstream_comp
),
1841 upstream_port
, bt_port_get_name(upstream_port
),
1842 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1843 downstream_port
, downstream_port_name
,
1844 cfg_conn
->arg
->str
);
1846 "Cannot create connection: graph refuses to connect ports (`%s` to `%s`): %s\n",
1847 bt_port_get_name(upstream_port
),
1848 downstream_port_name
,
1849 cfg_conn
->arg
->str
);
1853 BT_LOGI("Connected component ports: "
1854 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1855 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1856 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1857 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1859 upstream_comp
, bt_component_get_name(upstream_comp
),
1860 upstream_port
, bt_port_get_name(upstream_port
),
1861 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1862 downstream_port
, downstream_port_name
,
1863 cfg_conn
->arg
->str
);
1865 if (insert_trimmer
) {
1867 * The first connection, from the source to the trimmer,
1868 * has been done. We now connect the trimmer to the
1869 * original downstream port.
1871 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1873 bt_component_filter_as_component_const(trimmer
),
1874 trimmer_output
, cfg_conn
);
1878 ctx
->connect_ports
= true;
1882 * We found a matching downstream port: the search is
1888 /* No downstream port found */
1889 BT_LOGE("Cannot create connection: cannot find a matching downstream port for upstream port: "
1890 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1891 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1892 upstream_port
, bt_port_get_name(upstream_port
),
1893 cfg_conn
->downstream_comp_name
->str
,
1894 cfg_conn
->arg
->str
);
1896 "Cannot create connection: cannot find a matching downstream port for upstream port `%s`: %s\n",
1897 bt_port_get_name(upstream_port
), cfg_conn
->arg
->str
);
1903 free(intersection_begin
);
1904 free(intersection_end
);
1905 BT_VALUE_PUT_REF_AND_RESET(trimmer_params
);
1906 BT_COMPONENT_CLASS_FILTER_PUT_REF_AND_RESET(trimmer_class
);
1907 BT_COMPONENT_FILTER_PUT_REF_AND_RESET(trimmer
);
1912 int cmd_run_ctx_connect_upstream_port(struct cmd_run_ctx
*ctx
,
1913 const 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_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_status ret
= BT_GRAPH_LISTENER_STATUS_OK
;
1999 comp
= bt_port_borrow_component_const(port
);
2000 BT_LOGI("Port added to a graph's component: comp-addr=%p, "
2001 "comp-name=\"%s\", port-addr=%p, port-name=\"%s\"",
2002 comp
, comp
? bt_component_get_name(comp
) : "",
2003 port
, bt_port_get_name(port
));
2005 if (!ctx
->connect_ports
) {
2010 BT_LOGW_STR("Port has no component.");
2014 if (bt_port_is_connected(port
)) {
2015 BT_LOGW_STR("Port is already connected.");
2019 if (cmd_run_ctx_connect_upstream_port(ctx
, out_port
)) {
2020 BT_LOGF_STR("Cannot connect upstream port.");
2021 fprintf(stderr
, "Added port could not be connected: aborting\n");
2022 ret
= BT_GRAPH_LISTENER_STATUS_ERROR
;
2031 bt_graph_listener_status
graph_source_output_port_added_listener(
2032 const bt_component_source
*component
,
2033 const bt_port_output
*port
, void *data
)
2035 return graph_output_port_added_listener(data
, port
);
2039 bt_graph_listener_status
graph_filter_output_port_added_listener(
2040 const bt_component_filter
*component
,
2041 const bt_port_output
*port
, void *data
)
2043 return graph_output_port_added_listener(data
, port
);
2047 void cmd_run_ctx_destroy(struct cmd_run_ctx
*ctx
)
2053 if (ctx
->src_components
) {
2054 g_hash_table_destroy(ctx
->src_components
);
2055 ctx
->src_components
= NULL
;
2058 if (ctx
->flt_components
) {
2059 g_hash_table_destroy(ctx
->flt_components
);
2060 ctx
->flt_components
= NULL
;
2063 if (ctx
->sink_components
) {
2064 g_hash_table_destroy(ctx
->sink_components
);
2065 ctx
->sink_components
= NULL
;
2068 if (ctx
->intersections
) {
2069 g_hash_table_destroy(ctx
->intersections
);
2070 ctx
->intersections
= NULL
;
2073 BT_GRAPH_PUT_REF_AND_RESET(ctx
->graph
);
2079 int cmd_run_ctx_init(struct cmd_run_ctx
*ctx
, struct bt_config
*cfg
)
2082 bt_graph_status status
;
2085 ctx
->connect_ports
= false;
2086 ctx
->src_components
= g_hash_table_new_full(g_direct_hash
,
2087 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
2088 if (!ctx
->src_components
) {
2092 ctx
->flt_components
= g_hash_table_new_full(g_direct_hash
,
2093 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
2094 if (!ctx
->flt_components
) {
2098 ctx
->sink_components
= g_hash_table_new_full(g_direct_hash
,
2099 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
2100 if (!ctx
->sink_components
) {
2104 if (cfg
->cmd_data
.run
.stream_intersection_mode
) {
2105 ctx
->stream_intersection_mode
= true;
2106 ctx
->intersections
= g_hash_table_new_full(port_id_hash
,
2107 port_id_equal
, port_id_destroy
, trace_range_destroy
);
2108 if (!ctx
->intersections
) {
2113 ctx
->graph
= bt_graph_create();
2118 the_graph
= ctx
->graph
;
2119 status
= bt_graph_add_source_component_output_port_added_listener(
2120 ctx
->graph
, graph_source_output_port_added_listener
, NULL
, ctx
,
2122 if (status
!= BT_GRAPH_STATUS_OK
) {
2123 BT_LOGE_STR("Cannot add \"port added\" listener to graph.");
2127 status
= bt_graph_add_filter_component_output_port_added_listener(
2128 ctx
->graph
, graph_filter_output_port_added_listener
, NULL
, ctx
,
2130 if (status
!= BT_GRAPH_STATUS_OK
) {
2131 BT_LOGE_STR("Cannot add \"port added\" listener to graph.");
2138 cmd_run_ctx_destroy(ctx
);
2146 int set_stream_intersections(struct cmd_run_ctx
*ctx
,
2147 struct bt_config_component
*cfg_comp
,
2148 const bt_component_class_source
*src_comp_cls
)
2152 int64_t trace_count
;
2153 const char *path
= NULL
;
2154 const bt_value
*query_result
= NULL
;
2155 const bt_value
*trace_info
= NULL
;
2156 const bt_value
*intersection_range
= NULL
;
2157 const bt_value
*intersection_begin
= NULL
;
2158 const bt_value
*intersection_end
= NULL
;
2159 const bt_value
*stream_infos
= NULL
;
2160 const bt_value
*stream_info
= NULL
;
2161 struct port_id
*port_id
= NULL
;
2162 struct trace_range
*trace_range
= NULL
;
2163 const char *fail_reason
= NULL
;
2164 const bt_component_class
*comp_cls
=
2165 bt_component_class_source_as_component_class_const(src_comp_cls
);
2167 ret
= query(ctx
->cfg
, comp_cls
, "trace-info",
2168 cfg_comp
->params
, &query_result
,
2171 BT_LOGD("Component class does not support the `trace-info` query: %s: "
2172 "comp-class-name=\"%s\"", fail_reason
,
2173 bt_component_class_get_name(comp_cls
));
2178 BT_ASSERT(query_result
);
2180 if (!bt_value_is_array(query_result
)) {
2181 BT_LOGD("Unexpected format of \'trace-info\' query result: "
2182 "component-class-name=%s",
2183 bt_component_class_get_name(comp_cls
));
2188 trace_count
= bt_value_array_get_size(query_result
);
2189 if (trace_count
< 0) {
2194 for (trace_idx
= 0; trace_idx
< trace_count
; trace_idx
++) {
2196 uint64_t stream_idx
;
2197 int64_t stream_count
;
2199 trace_info
= bt_value_array_borrow_element_by_index_const(
2200 query_result
, trace_idx
);
2201 if (!trace_info
|| !bt_value_is_map(trace_info
)) {
2203 BT_LOGD_STR("Cannot retrieve trace from query result.");
2207 intersection_range
= bt_value_map_borrow_entry_value_const(
2208 trace_info
, "intersection-range-ns");
2209 if (!intersection_range
) {
2211 BT_LOGD_STR("Cannot retrieve \'intersetion-range-ns\' field from query result.");
2215 intersection_begin
= bt_value_map_borrow_entry_value_const(intersection_range
,
2217 if (!intersection_begin
) {
2219 BT_LOGD_STR("Cannot retrieve intersection-range-ns \'begin\' field from query result.");
2223 intersection_end
= bt_value_map_borrow_entry_value_const(intersection_range
,
2225 if (!intersection_end
) {
2227 BT_LOGD_STR("Cannot retrieve intersection-range-ns \'end\' field from query result.");
2231 begin
= bt_value_signed_integer_get(intersection_begin
);
2232 end
= bt_value_signed_integer_get(intersection_end
);
2234 if (begin
< 0 || end
< 0 || end
< begin
) {
2235 BT_LOGW("Invalid trace stream intersection values: "
2236 "intersection-range-ns:begin=%" PRId64
2237 ", intersection-range-ns:end=%" PRId64
,
2243 stream_infos
= bt_value_map_borrow_entry_value_const(trace_info
,
2245 if (!stream_infos
|| !bt_value_is_array(stream_infos
)) {
2247 BT_LOGD_STR("Cannot retrieve stream information from trace in query result.");
2251 stream_count
= bt_value_array_get_size(stream_infos
);
2252 if (stream_count
< 0) {
2257 for (stream_idx
= 0; stream_idx
< stream_count
; stream_idx
++) {
2258 const bt_value
*port_name
;
2260 port_id
= g_new0(struct port_id
, 1);
2263 BT_LOGE_STR("Cannot allocate memory for port_id structure.");
2266 port_id
->instance_name
= strdup(cfg_comp
->instance_name
->str
);
2267 if (!port_id
->instance_name
) {
2269 BT_LOGE_STR("Cannot allocate memory for port_id component instance name.");
2273 trace_range
= g_new0(struct trace_range
, 1);
2276 BT_LOGE_STR("Cannot allocate memory for trace_range structure.");
2279 trace_range
->intersection_range_begin_ns
= begin
;
2280 trace_range
->intersection_range_end_ns
= end
;
2282 stream_info
= bt_value_array_borrow_element_by_index_const(
2283 stream_infos
, stream_idx
);
2284 if (!stream_info
|| !bt_value_is_map(stream_info
)) {
2286 BT_LOGE_STR("Cannot retrieve stream informations from trace in query result.");
2290 port_name
= bt_value_map_borrow_entry_value_const(stream_info
, "port-name");
2291 if (!port_name
|| !bt_value_is_string(port_name
)) {
2293 BT_LOGE_STR("Cannot retrieve port name in query result.");
2297 port_id
->port_name
= g_strdup(bt_value_string_get(port_name
));
2298 if (!port_id
->port_name
) {
2300 BT_LOGE_STR("Cannot allocate memory for port_id port_name.");
2304 BT_LOGD("Inserting stream intersection ");
2306 g_hash_table_insert(ctx
->intersections
, port_id
, trace_range
);
2316 fprintf(stderr
, "%s%sCannot determine stream intersection of trace at path \'%s\'.%s\n",
2317 bt_common_color_bold(),
2318 bt_common_color_fg_yellow(),
2319 path
? path
: "(unknown)",
2320 bt_common_color_reset());
2322 bt_value_put_ref(query_result
);
2324 g_free(trace_range
);
2329 int cmd_run_ctx_create_components_from_config_components(
2330 struct cmd_run_ctx
*ctx
, GPtrArray
*cfg_components
)
2333 const void *comp_cls
= NULL
;
2334 const void *comp
= NULL
;
2337 for (i
= 0; i
< cfg_components
->len
; i
++) {
2338 struct bt_config_component
*cfg_comp
=
2339 g_ptr_array_index(cfg_components
, i
);
2342 switch (cfg_comp
->type
) {
2343 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2344 comp_cls
= find_source_component_class(
2345 cfg_comp
->plugin_name
->str
,
2346 cfg_comp
->comp_cls_name
->str
);
2348 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2349 comp_cls
= find_filter_component_class(
2350 cfg_comp
->plugin_name
->str
,
2351 cfg_comp
->comp_cls_name
->str
);
2353 case BT_COMPONENT_CLASS_TYPE_SINK
:
2354 comp_cls
= find_sink_component_class(
2355 cfg_comp
->plugin_name
->str
,
2356 cfg_comp
->comp_cls_name
->str
);
2363 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
2364 "comp-cls-name=\"%s\", comp-cls-type=%d",
2365 cfg_comp
->plugin_name
->str
,
2366 cfg_comp
->comp_cls_name
->str
,
2368 fprintf(stderr
, "%s%sCannot find component class %s",
2369 bt_common_color_bold(),
2370 bt_common_color_fg_red(),
2371 bt_common_color_reset());
2372 print_plugin_comp_cls_opt(stderr
,
2373 cfg_comp
->plugin_name
->str
,
2374 cfg_comp
->comp_cls_name
->str
,
2376 fprintf(stderr
, "\n");
2380 BT_ASSERT(cfg_comp
->log_level
>= BT_LOG_VERBOSE
);
2382 switch (cfg_comp
->type
) {
2383 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2384 ret
= bt_graph_add_source_component(ctx
->graph
,
2385 comp_cls
, cfg_comp
->instance_name
->str
,
2386 cfg_comp
->params
, cfg_comp
->log_level
,
2389 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2390 ret
= bt_graph_add_filter_component(ctx
->graph
,
2391 comp_cls
, cfg_comp
->instance_name
->str
,
2392 cfg_comp
->params
, cfg_comp
->log_level
,
2395 case BT_COMPONENT_CLASS_TYPE_SINK
:
2396 ret
= bt_graph_add_sink_component(ctx
->graph
,
2397 comp_cls
, cfg_comp
->instance_name
->str
,
2398 cfg_comp
->params
, cfg_comp
->log_level
,
2406 BT_LOGE("Cannot create component: plugin-name=\"%s\", "
2407 "comp-cls-name=\"%s\", comp-cls-type=%d, "
2409 cfg_comp
->plugin_name
->str
,
2410 cfg_comp
->comp_cls_name
->str
,
2411 cfg_comp
->type
, cfg_comp
->instance_name
->str
);
2412 fprintf(stderr
, "%s%sCannot create component `%s`%s\n",
2413 bt_common_color_bold(),
2414 bt_common_color_fg_red(),
2415 cfg_comp
->instance_name
->str
,
2416 bt_common_color_reset());
2420 if (ctx
->stream_intersection_mode
&&
2421 cfg_comp
->type
== BT_COMPONENT_CLASS_TYPE_SOURCE
) {
2422 ret
= set_stream_intersections(ctx
, cfg_comp
, comp_cls
);
2428 BT_LOGI("Created and inserted component: comp-addr=%p, comp-name=\"%s\"",
2429 comp
, cfg_comp
->instance_name
->str
);
2430 quark
= g_quark_from_string(cfg_comp
->instance_name
->str
);
2431 BT_ASSERT(quark
> 0);
2433 switch (cfg_comp
->type
) {
2434 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2435 g_hash_table_insert(ctx
->src_components
,
2436 GUINT_TO_POINTER(quark
), (void *) comp
);
2438 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2439 g_hash_table_insert(ctx
->flt_components
,
2440 GUINT_TO_POINTER(quark
), (void *) comp
);
2442 case BT_COMPONENT_CLASS_TYPE_SINK
:
2443 g_hash_table_insert(ctx
->sink_components
,
2444 GUINT_TO_POINTER(quark
), (void *) comp
);
2451 BT_OBJECT_PUT_REF_AND_RESET(comp_cls
);
2460 bt_object_put_ref(comp
);
2461 bt_object_put_ref(comp_cls
);
2466 int cmd_run_ctx_create_components(struct cmd_run_ctx
*ctx
)
2471 * Make sure that, during this phase, our graph's "port added"
2472 * listener does not connect ports while we are creating the
2473 * components because we have a special, initial phase for
2476 ctx
->connect_ports
= false;
2478 ret
= cmd_run_ctx_create_components_from_config_components(
2479 ctx
, ctx
->cfg
->cmd_data
.run
.sources
);
2485 ret
= cmd_run_ctx_create_components_from_config_components(
2486 ctx
, ctx
->cfg
->cmd_data
.run
.filters
);
2492 ret
= cmd_run_ctx_create_components_from_config_components(
2493 ctx
, ctx
->cfg
->cmd_data
.run
.sinks
);
2503 typedef uint64_t (*output_port_count_func_t
)(const void *);
2504 typedef const bt_port_output
*(*borrow_output_port_by_index_func_t
)(
2505 const void *, uint64_t);
2508 int cmd_run_ctx_connect_comp_ports(struct cmd_run_ctx
*ctx
,
2509 void *comp
, output_port_count_func_t port_count_fn
,
2510 borrow_output_port_by_index_func_t port_by_index_fn
)
2516 count
= port_count_fn(comp
);
2518 for (i
= 0; i
< count
; i
++) {
2519 const bt_port_output
*upstream_port
= port_by_index_fn(comp
, i
);
2521 BT_ASSERT(upstream_port
);
2522 ret
= cmd_run_ctx_connect_upstream_port(ctx
, upstream_port
);
2533 int cmd_run_ctx_connect_ports(struct cmd_run_ctx
*ctx
)
2536 GHashTableIter iter
;
2537 gpointer g_name_quark
, g_comp
;
2539 ctx
->connect_ports
= true;
2540 g_hash_table_iter_init(&iter
, ctx
->src_components
);
2542 while (g_hash_table_iter_next(&iter
, &g_name_quark
, &g_comp
)) {
2543 ret
= cmd_run_ctx_connect_comp_ports(ctx
, g_comp
,
2544 (output_port_count_func_t
)
2545 bt_component_source_get_output_port_count
,
2546 (borrow_output_port_by_index_func_t
)
2547 bt_component_source_borrow_output_port_by_index_const
);
2553 g_hash_table_iter_init(&iter
, ctx
->flt_components
);
2555 while (g_hash_table_iter_next(&iter
, &g_name_quark
, &g_comp
)) {
2556 ret
= cmd_run_ctx_connect_comp_ports(ctx
, g_comp
,
2557 (output_port_count_func_t
)
2558 bt_component_filter_get_output_port_count
,
2559 (borrow_output_port_by_index_func_t
)
2560 bt_component_filter_borrow_output_port_by_index_const
);
2571 const char *bt_graph_status_str(bt_graph_status status
)
2574 case BT_GRAPH_STATUS_OK
:
2575 return "BT_GRAPH_STATUS_OK";
2576 case BT_GRAPH_STATUS_END
:
2577 return "BT_GRAPH_STATUS_END";
2578 case BT_GRAPH_STATUS_AGAIN
:
2579 return "BT_GRAPH_STATUS_AGAIN";
2580 case BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION
:
2581 return "BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION";
2582 case BT_GRAPH_STATUS_CANCELED
:
2583 return "BT_GRAPH_STATUS_CANCELED";
2584 case BT_GRAPH_STATUS_ERROR
:
2585 return "BT_GRAPH_STATUS_ERROR";
2586 case BT_GRAPH_STATUS_NOMEM
:
2587 return "BT_GRAPH_STATUS_NOMEM";
2594 int cmd_run(struct bt_config
*cfg
)
2597 struct cmd_run_ctx ctx
= { 0 };
2599 /* Initialize the command's context and the graph object */
2600 if (cmd_run_ctx_init(&ctx
, cfg
)) {
2601 BT_LOGE_STR("Cannot initialize the command's context.");
2602 fprintf(stderr
, "Cannot initialize the command's context\n");
2607 BT_LOGI_STR("Canceled by user before creating components.");
2611 BT_LOGI_STR("Creating components.");
2613 /* Create the requested component instances */
2614 if (cmd_run_ctx_create_components(&ctx
)) {
2615 BT_LOGE_STR("Cannot create components.");
2616 fprintf(stderr
, "Cannot create components\n");
2621 BT_LOGI_STR("Canceled by user before connecting components.");
2625 BT_LOGI_STR("Connecting components.");
2627 /* Connect the initially visible component ports */
2628 if (cmd_run_ctx_connect_ports(&ctx
)) {
2629 BT_LOGE_STR("Cannot connect initial component ports.");
2630 fprintf(stderr
, "Cannot connect initial component ports\n");
2635 BT_LOGI_STR("Canceled by user before running the graph.");
2639 BT_LOGI_STR("Running the graph.");
2643 bt_graph_status graph_status
= bt_graph_run(ctx
.graph
);
2646 * Reset console in case something messed with console
2647 * codes during the graph's execution.
2649 printf("%s", bt_common_color_reset());
2651 fprintf(stderr
, "%s", bt_common_color_reset());
2652 BT_LOGV("bt_graph_run() returned: status=%s",
2653 bt_graph_status_str(graph_status
));
2655 switch (graph_status
) {
2656 case BT_GRAPH_STATUS_OK
:
2658 case BT_GRAPH_STATUS_CANCELED
:
2659 BT_LOGI_STR("Graph was canceled by user.");
2661 case BT_GRAPH_STATUS_AGAIN
:
2662 if (bt_graph_is_canceled(ctx
.graph
)) {
2663 BT_LOGI_STR("Graph was canceled by user.");
2667 if (cfg
->cmd_data
.run
.retry_duration_us
> 0) {
2668 BT_LOGV("Got BT_GRAPH_STATUS_AGAIN: sleeping: "
2670 cfg
->cmd_data
.run
.retry_duration_us
);
2672 if (usleep(cfg
->cmd_data
.run
.retry_duration_us
)) {
2673 if (bt_graph_is_canceled(ctx
.graph
)) {
2674 BT_LOGI_STR("Graph was canceled by user.");
2680 case BT_GRAPH_STATUS_END
:
2683 BT_LOGE_STR("Graph failed to complete successfully");
2684 fprintf(stderr
, "Graph failed to complete successfully\n");
2697 cmd_run_ctx_destroy(&ctx
);
2702 void warn_command_name_and_directory_clash(struct bt_config
*cfg
)
2704 const char *env_clash
;
2706 if (!cfg
->command_name
) {
2710 env_clash
= getenv(ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH
);
2711 if (env_clash
&& strcmp(env_clash
, "0") == 0) {
2715 if (g_file_test(cfg
->command_name
,
2716 G_FILE_TEST_EXISTS
| G_FILE_TEST_IS_DIR
)) {
2717 fprintf(stderr
, "\nNOTE: The `%s` command was executed. If you meant to convert a\n",
2719 fprintf(stderr
, "trace located in the local `%s` directory, please use:\n",
2721 fprintf(stderr
, "\n");
2722 fprintf(stderr
, " babeltrace2 convert %s [OPTIONS]\n",
2728 void init_log_level(void)
2730 bt_cli_log_level
= bt_log_get_level_from_env(ENV_BABELTRACE_CLI_LOG_LEVEL
);
2734 void set_auto_log_levels(struct bt_config
*cfg
)
2736 const char **env_var_name
;
2739 * Override the configuration's default log level if
2740 * BABELTRACE_VERBOSE or BABELTRACE_DEBUG environment variables
2741 * are found for backward compatibility with legacy Babetrace 1.
2743 if (getenv("BABELTRACE_DEBUG") &&
2744 strcmp(getenv("BABELTRACE_DEBUG"), "1") == 0) {
2745 cfg
->log_level
= BT_LOG_VERBOSE
;
2746 } else if (getenv("BABELTRACE_VERBOSE") &&
2747 strcmp(getenv("BABELTRACE_VERBOSE"), "1") == 0) {
2748 cfg
->log_level
= BT_LOG_INFO
;
2752 * Set log levels according to --debug or --verbose. For
2753 * backward compatibility, --debug is more verbose than
2756 * --verbose: INFO log level
2757 * --debug: VERBOSE log level (includes DEBUG, which is
2758 * is less verbose than VERBOSE in the internal
2759 * logging framework)
2761 if (!getenv("BABELTRACE_LOGGING_GLOBAL_LEVEL")) {
2763 bt_logging_set_global_level(BT_LOG_INFO
);
2764 } else if (cfg
->debug
) {
2765 bt_logging_set_global_level(BT_LOG_VERBOSE
);
2768 * Set library's default log level if not
2769 * explicitly specified.
2771 bt_logging_set_global_level(cfg
->log_level
);
2775 if (!getenv(ENV_BABELTRACE_CLI_LOG_LEVEL
)) {
2777 bt_cli_log_level
= BT_LOG_INFO
;
2778 } else if (cfg
->debug
) {
2779 bt_cli_log_level
= BT_LOG_VERBOSE
;
2782 * Set CLI's default log level if not explicitly
2785 bt_cli_log_level
= cfg
->log_level
;
2789 env_var_name
= log_level_env_var_names
;
2791 while (*env_var_name
) {
2792 if (!getenv(*env_var_name
)) {
2794 g_setenv(*env_var_name
, "I", 1);
2795 } else if (cfg
->debug
) {
2796 g_setenv(*env_var_name
, "V", 1);
2798 char val
[2] = { 0 };
2801 * Set module's default log level if not
2802 * explicitly specified.
2804 val
[0] = bt_log_get_letter_from_level(
2806 g_setenv(*env_var_name
, val
, 1);
2814 int main(int argc
, const char **argv
)
2818 struct bt_config
*cfg
;
2821 set_signal_handler();
2823 cfg
= bt_config_cli_args_create_with_default(argc
, argv
, &retcode
);
2826 /* Quit without errors; typically usage/version */
2828 BT_LOGI_STR("Quitting without errors.");
2833 BT_LOGE("Command-line error: retcode=%d", retcode
);
2838 BT_LOGE_STR("Failed to create a valid Babeltrace configuration.");
2839 fprintf(stderr
, "Failed to create Babeltrace configuration\n");
2844 set_auto_log_levels(cfg
);
2847 if (cfg
->command_needs_plugins
) {
2848 ret
= load_all_plugins(cfg
->plugin_paths
);
2850 BT_LOGE("Failed to load plugins: ret=%d", ret
);
2856 BT_LOGI("Executing command: cmd=%d, command-name=\"%s\"",
2857 cfg
->command
, cfg
->command_name
);
2859 switch (cfg
->command
) {
2860 case BT_CONFIG_COMMAND_RUN
:
2863 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
2864 ret
= cmd_list_plugins(cfg
);
2866 case BT_CONFIG_COMMAND_HELP
:
2867 ret
= cmd_help(cfg
);
2869 case BT_CONFIG_COMMAND_QUERY
:
2870 ret
= cmd_query(cfg
);
2872 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
2873 ret
= cmd_print_ctf_metadata(cfg
);
2875 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
2876 ret
= cmd_print_lttng_live_sessions(cfg
);
2879 BT_LOGF("Invalid/unknown command: cmd=%d", cfg
->command
);
2883 BT_LOGI("Command completed: cmd=%d, command-name=\"%s\", ret=%d",
2884 cfg
->command
, cfg
->command_name
, ret
);
2885 warn_command_name_and_directory_clash(cfg
);
2886 retcode
= ret
? 1 : 0;
2889 BT_OBJECT_PUT_REF_AND_RESET(cfg
);