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"
38 #include "babeltrace2-cfg.h"
39 #include "babeltrace2-cfg-cli-args.h"
40 #include "babeltrace2-cfg-cli-args-default.h"
41 #include "babeltrace2-log-level.h"
42 #include "babeltrace2-plugins.h"
43 #include "babeltrace2-query.h"
45 #define ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH "BABELTRACE_CLI_WARN_COMMAND_NAME_DIRECTORY_CLASH"
46 #define NSEC_PER_SEC 1000000000LL
48 /* Application's interrupter (owned by this) */
49 static bt_interrupter
*the_interrupter
;
56 BOOL WINAPI
signal_handler(DWORD signal
) {
57 if (the_interrupter
) {
58 bt_interrupter_set(the_interrupter
);
65 void set_signal_handler(void)
67 if (!SetConsoleCtrlHandler(signal_handler
, TRUE
)) {
68 BT_LOGE("Failed to set the Ctrl+C handler.");
72 #else /* __MINGW32__ */
75 void signal_handler(int signum
)
77 if (signum
!= SIGINT
) {
81 if (the_interrupter
) {
82 bt_interrupter_set(the_interrupter
);
87 void set_signal_handler(void)
89 struct sigaction new_action
, old_action
;
91 new_action
.sa_handler
= signal_handler
;
92 sigemptyset(&new_action
.sa_mask
);
93 new_action
.sa_flags
= 0;
94 sigaction(SIGINT
, NULL
, &old_action
);
96 if (old_action
.sa_handler
!= SIG_IGN
) {
97 sigaction(SIGINT
, &new_action
, NULL
);
101 #endif /* __MINGW32__ */
104 int query(struct bt_config
*cfg
, const bt_component_class
*comp_cls
,
105 const char *obj
, const bt_value
*params
,
106 const bt_value
**user_result
, const char **fail_reason
)
108 return cli_query(comp_cls
, obj
, params
, cfg
->log_level
,
109 the_interrupter
, user_result
, fail_reason
);
112 typedef const void *(*plugin_borrow_comp_cls_func_t
)(
113 const bt_plugin
*, const char *);
116 const void *find_component_class_from_plugin(const char *plugin_name
,
117 const char *comp_class_name
,
118 plugin_borrow_comp_cls_func_t plugin_borrow_comp_cls_func
)
120 const void *comp_class
= NULL
;
121 const bt_plugin
*plugin
;
123 BT_LOGI("Finding component class: plugin-name=\"%s\", "
124 "comp-cls-name=\"%s\"", plugin_name
, comp_class_name
);
126 plugin
= find_loaded_plugin(plugin_name
);
131 comp_class
= plugin_borrow_comp_cls_func(plugin
, comp_class_name
);
132 bt_object_get_ref(comp_class
);
133 BT_PLUGIN_PUT_REF_AND_RESET(plugin
);
137 BT_LOGI("Found component class: plugin-name=\"%s\", "
138 "comp-cls-name=\"%s\"", plugin_name
, comp_class_name
);
140 BT_LOGI("Cannot find source component class: "
141 "plugin-name=\"%s\", comp-cls-name=\"%s\"",
142 plugin_name
, comp_class_name
);
149 const bt_component_class_source
*find_source_component_class(
150 const char *plugin_name
, const char *comp_class_name
)
152 return (const void *) find_component_class_from_plugin(
153 plugin_name
, comp_class_name
,
154 (plugin_borrow_comp_cls_func_t
)
155 bt_plugin_borrow_source_component_class_by_name_const
);
159 const bt_component_class_filter
*find_filter_component_class(
160 const char *plugin_name
, const char *comp_class_name
)
162 return (const void *) find_component_class_from_plugin(
163 plugin_name
, comp_class_name
,
164 (plugin_borrow_comp_cls_func_t
)
165 bt_plugin_borrow_filter_component_class_by_name_const
);
169 const bt_component_class_sink
*find_sink_component_class(
170 const char *plugin_name
, const char *comp_class_name
)
172 return (const void *) find_component_class_from_plugin(plugin_name
,
174 (plugin_borrow_comp_cls_func_t
)
175 bt_plugin_borrow_sink_component_class_by_name_const
);
179 const bt_component_class
*find_component_class(const char *plugin_name
,
180 const char *comp_class_name
,
181 bt_component_class_type comp_class_type
)
183 const bt_component_class
*comp_cls
= NULL
;
185 switch (comp_class_type
) {
186 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
187 comp_cls
= bt_component_class_source_as_component_class_const(find_source_component_class(plugin_name
, comp_class_name
));
189 case BT_COMPONENT_CLASS_TYPE_FILTER
:
190 comp_cls
= bt_component_class_filter_as_component_class_const(find_filter_component_class(plugin_name
, comp_class_name
));
192 case BT_COMPONENT_CLASS_TYPE_SINK
:
193 comp_cls
= bt_component_class_sink_as_component_class_const(find_sink_component_class(plugin_name
, comp_class_name
));
203 void print_indent(FILE *fp
, size_t indent
)
207 for (i
= 0; i
< indent
; i
++) {
213 const char *component_type_str(bt_component_class_type type
)
216 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
218 case BT_COMPONENT_CLASS_TYPE_SINK
:
220 case BT_COMPONENT_CLASS_TYPE_FILTER
:
228 void print_plugin_comp_cls_opt(FILE *fh
, const char *plugin_name
,
229 const char *comp_cls_name
, bt_component_class_type type
)
231 GString
*shell_plugin_name
= NULL
;
232 GString
*shell_comp_cls_name
= NULL
;
235 shell_plugin_name
= bt_common_shell_quote(plugin_name
, false);
236 if (!shell_plugin_name
) {
241 shell_comp_cls_name
= bt_common_shell_quote(comp_cls_name
, false);
242 if (!shell_comp_cls_name
) {
246 fprintf(fh
, "'%s%s%s%s",
247 bt_common_color_bold(),
248 bt_common_color_fg_cyan(),
249 component_type_str(type
),
250 bt_common_color_fg_default());
252 if (shell_plugin_name
) {
253 fprintf(fh
, ".%s%s%s",
254 bt_common_color_fg_blue(),
255 shell_plugin_name
->str
,
256 bt_common_color_fg_default());
259 fprintf(fh
, ".%s%s%s'",
260 bt_common_color_fg_yellow(),
261 shell_comp_cls_name
->str
,
262 bt_common_color_reset());
265 if (shell_plugin_name
) {
266 g_string_free(shell_plugin_name
, TRUE
);
269 if (shell_comp_cls_name
) {
270 g_string_free(shell_comp_cls_name
, TRUE
);
275 void print_value(FILE *, const bt_value
*, size_t);
278 void print_value_rec(FILE *, const bt_value
*, size_t);
281 void print_map_value(const char *key
, const bt_value
*object
, FILE *fp
,
284 print_indent(fp
, indent
);
285 fprintf(fp
, "%s: ", key
);
288 if (bt_value_is_array(object
) &&
289 bt_value_array_is_empty(object
)) {
290 fprintf(fp
, "[ ]\n");
294 if (bt_value_is_map(object
) &&
295 bt_value_map_is_empty(object
)) {
296 fprintf(fp
, "{ }\n");
300 if (bt_value_is_array(object
) ||
301 bt_value_is_map(object
)) {
305 print_value_rec(fp
, object
, indent
+ 2);
312 bt_bool
collect_map_keys(const char *key
, const bt_value
*object
, void *data
)
314 GPtrArray
*map_keys
= data
;
316 g_ptr_array_add(map_keys
, (gpointer
*) key
);
322 gint
g_ptr_array_sort_strings(gconstpointer a
, gconstpointer b
) {
323 const char *s1
= *((const char **) a
);
324 const char *s2
= *((const char **) b
);
326 return g_strcmp0(s1
, s2
);
330 void print_value_rec(FILE *fp
, const bt_value
*value
, size_t indent
)
337 GPtrArray
*map_keys
= NULL
;
343 switch (bt_value_get_type(value
)) {
344 case BT_VALUE_TYPE_NULL
:
345 fprintf(fp
, "%snull%s\n", bt_common_color_bold(),
346 bt_common_color_reset());
348 case BT_VALUE_TYPE_BOOL
:
349 bool_val
= bt_value_bool_get(value
);
350 fprintf(fp
, "%s%s%s%s\n", bt_common_color_bold(),
351 bt_common_color_fg_cyan(), bool_val
? "yes" : "no",
352 bt_common_color_reset());
354 case BT_VALUE_TYPE_UNSIGNED_INTEGER
:
355 uint_val
= bt_value_integer_unsigned_get(value
);
356 fprintf(fp
, "%s%s%" PRIu64
"%s\n", bt_common_color_bold(),
357 bt_common_color_fg_red(), uint_val
,
358 bt_common_color_reset());
360 case BT_VALUE_TYPE_SIGNED_INTEGER
:
361 int_val
= bt_value_integer_signed_get(value
);
362 fprintf(fp
, "%s%s%" PRId64
"%s\n", bt_common_color_bold(),
363 bt_common_color_fg_red(), int_val
,
364 bt_common_color_reset());
366 case BT_VALUE_TYPE_REAL
:
367 dbl_val
= bt_value_real_get(value
);
368 fprintf(fp
, "%s%s%lf%s\n", bt_common_color_bold(),
369 bt_common_color_fg_red(), dbl_val
,
370 bt_common_color_reset());
372 case BT_VALUE_TYPE_STRING
:
373 str_val
= bt_value_string_get(value
);
374 fprintf(fp
, "%s%s%s%s\n", bt_common_color_bold(),
375 bt_common_color_fg_green(), str_val
,
376 bt_common_color_reset());
378 case BT_VALUE_TYPE_ARRAY
:
381 size
= bt_value_array_get_length(value
);
383 print_indent(fp
, indent
);
384 fprintf(fp
, "[ ]\n");
388 for (i
= 0; i
< size
; i
++) {
389 const bt_value
*element
=
390 bt_value_array_borrow_element_by_index_const(
396 print_indent(fp
, indent
);
399 if (bt_value_is_array(element
) &&
400 bt_value_array_is_empty(element
)) {
401 fprintf(fp
, "[ ]\n");
405 if (bt_value_is_map(element
) &&
406 bt_value_map_is_empty(element
)) {
407 fprintf(fp
, "{ }\n");
411 if (bt_value_is_array(element
) ||
412 bt_value_is_map(element
)) {
416 print_value_rec(fp
, element
, indent
+ 2);
420 case BT_VALUE_TYPE_MAP
:
423 bt_value_map_foreach_entry_const_status foreach_status
;
425 if (bt_value_map_is_empty(value
)) {
426 print_indent(fp
, indent
);
427 fprintf(fp
, "{ }\n");
431 map_keys
= g_ptr_array_new();
433 BT_CLI_LOGE_APPEND_CAUSE("Failed to allocated on GPtrArray.");
438 * We want to print the map entries in a stable order. Collect
439 * all the map's keys in a GPtrArray, sort it, then print the
440 * entries in that order.
442 foreach_status
= bt_value_map_foreach_entry_const(value
,
443 collect_map_keys
, map_keys
);
444 if (foreach_status
!= BT_VALUE_MAP_FOREACH_ENTRY_CONST_STATUS_OK
) {
445 BT_CLI_LOGE_APPEND_CAUSE("Failed to iterator on map value.");
449 g_ptr_array_sort(map_keys
, g_ptr_array_sort_strings
);
451 for (i
= 0; i
< map_keys
->len
; i
++) {
452 const char *map_key
= g_ptr_array_index(map_keys
, i
);
453 const bt_value
*map_value
;
455 map_value
= bt_value_map_borrow_entry_value_const(value
, map_key
);
456 BT_ASSERT(map_value
);
458 print_map_value(map_key
, map_value
, fp
, indent
);
470 BT_LOGE("Error printing value of type %s.",
471 bt_common_value_type_string(bt_value_get_type(value
)));
475 g_ptr_array_free(map_keys
, TRUE
);
480 void print_value(FILE *fp
, const bt_value
*value
, size_t indent
)
482 if (!bt_value_is_array(value
) && !bt_value_is_map(value
)) {
483 print_indent(fp
, indent
);
486 print_value_rec(fp
, value
, indent
);
490 void print_bt_config_component(struct bt_config_component
*bt_config_component
)
492 fprintf(stderr
, " ");
493 print_plugin_comp_cls_opt(stderr
, bt_config_component
->plugin_name
->str
,
494 bt_config_component
->comp_cls_name
->str
,
495 bt_config_component
->type
);
496 fprintf(stderr
, ":\n");
498 if (bt_config_component
->instance_name
->len
> 0) {
499 fprintf(stderr
, " Name: %s\n",
500 bt_config_component
->instance_name
->str
);
503 fprintf(stderr
, " Parameters:\n");
504 print_value(stderr
, bt_config_component
->params
, 8);
508 void print_bt_config_components(GPtrArray
*array
)
512 for (i
= 0; i
< array
->len
; i
++) {
513 struct bt_config_component
*cfg_component
=
514 bt_config_get_component(array
, i
);
515 print_bt_config_component(cfg_component
);
516 BT_OBJECT_PUT_REF_AND_RESET(cfg_component
);
521 void print_plugin_paths(const bt_value
*plugin_paths
)
523 fprintf(stderr
, " Plugin paths:\n");
524 print_value(stderr
, plugin_paths
, 4);
528 void print_cfg_run(struct bt_config
*cfg
)
532 print_plugin_paths(cfg
->plugin_paths
);
533 fprintf(stderr
, " Source component instances:\n");
534 print_bt_config_components(cfg
->cmd_data
.run
.sources
);
536 if (cfg
->cmd_data
.run
.filters
->len
> 0) {
537 fprintf(stderr
, " Filter component instances:\n");
538 print_bt_config_components(cfg
->cmd_data
.run
.filters
);
541 fprintf(stderr
, " Sink component instances:\n");
542 print_bt_config_components(cfg
->cmd_data
.run
.sinks
);
543 fprintf(stderr
, " Connections:\n");
545 for (i
= 0; i
< cfg
->cmd_data
.run
.connections
->len
; i
++) {
546 struct bt_config_connection
*cfg_connection
=
547 g_ptr_array_index(cfg
->cmd_data
.run
.connections
,
550 fprintf(stderr
, " %s%s%s -> %s%s%s\n",
551 cfg_connection
->upstream_comp_name
->str
,
552 cfg_connection
->upstream_port_glob
->len
> 0 ? "." : "",
553 cfg_connection
->upstream_port_glob
->str
,
554 cfg_connection
->downstream_comp_name
->str
,
555 cfg_connection
->downstream_port_glob
->len
> 0 ? "." : "",
556 cfg_connection
->downstream_port_glob
->str
);
561 void print_cfg_list_plugins(struct bt_config
*cfg
)
563 print_plugin_paths(cfg
->plugin_paths
);
567 void print_cfg_help(struct bt_config
*cfg
)
569 print_plugin_paths(cfg
->plugin_paths
);
573 void print_cfg_print_ctf_metadata(struct bt_config
*cfg
)
575 print_plugin_paths(cfg
->plugin_paths
);
576 fprintf(stderr
, " Path: %s\n",
577 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
581 void print_cfg_print_lttng_live_sessions(struct bt_config
*cfg
)
583 print_plugin_paths(cfg
->plugin_paths
);
584 fprintf(stderr
, " URL: %s\n",
585 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
589 void print_cfg_query(struct bt_config
*cfg
)
591 print_plugin_paths(cfg
->plugin_paths
);
592 fprintf(stderr
, " Object: `%s`\n", cfg
->cmd_data
.query
.object
->str
);
593 fprintf(stderr
, " Component class:\n");
594 print_bt_config_component(cfg
->cmd_data
.query
.cfg_component
);
598 void print_cfg(struct bt_config
*cfg
)
600 if (!BT_LOG_ON_INFO
) {
604 BT_LOGI_STR("CLI configuration:");
606 switch (cfg
->command
) {
607 case BT_CONFIG_COMMAND_RUN
:
610 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
611 print_cfg_list_plugins(cfg
);
613 case BT_CONFIG_COMMAND_HELP
:
616 case BT_CONFIG_COMMAND_QUERY
:
617 print_cfg_query(cfg
);
619 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
620 print_cfg_print_ctf_metadata(cfg
);
622 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
623 print_cfg_print_lttng_live_sessions(cfg
);
631 void print_plugin_info(const bt_plugin
*plugin
)
633 unsigned int major
, minor
, patch
;
635 bt_property_availability version_avail
;
636 const char *plugin_name
;
640 const char *plugin_description
;
642 plugin_name
= bt_plugin_get_name(plugin
);
643 path
= bt_plugin_get_path(plugin
);
644 author
= bt_plugin_get_author(plugin
);
645 license
= bt_plugin_get_license(plugin
);
646 plugin_description
= bt_plugin_get_description(plugin
);
647 version_avail
= bt_plugin_get_version(plugin
, &major
, &minor
,
649 printf("%s%s%s%s:\n", bt_common_color_bold(),
650 bt_common_color_fg_blue(), plugin_name
,
651 bt_common_color_reset());
653 printf(" %sPath%s: %s\n", bt_common_color_bold(),
654 bt_common_color_reset(), path
);
659 if (version_avail
== BT_PROPERTY_AVAILABILITY_AVAILABLE
) {
660 printf(" %sVersion%s: %u.%u.%u",
661 bt_common_color_bold(), bt_common_color_reset(),
662 major
, minor
, patch
);
671 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
672 bt_common_color_reset(),
673 plugin_description
? plugin_description
: "(None)");
674 printf(" %sAuthor%s: %s\n", bt_common_color_bold(),
675 bt_common_color_reset(), author
? author
: "(Unknown)");
676 printf(" %sLicense%s: %s\n", bt_common_color_bold(),
677 bt_common_color_reset(),
678 license
? license
: "(Unknown)");
682 int cmd_query(struct bt_config
*cfg
)
685 const bt_component_class
*comp_cls
= NULL
;
686 const bt_value
*results
= NULL
;
687 const char *fail_reason
= NULL
;
689 comp_cls
= find_component_class(
690 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
691 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
692 cfg
->cmd_data
.query
.cfg_component
->type
);
694 BT_CLI_LOGE_APPEND_CAUSE(
695 "Cannot find component class: plugin-name=\"%s\", "
696 "comp-cls-name=\"%s\", comp-cls-type=%d",
697 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
698 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
699 cfg
->cmd_data
.query
.cfg_component
->type
);
704 ret
= query(cfg
, comp_cls
, cfg
->cmd_data
.query
.object
->str
,
705 cfg
->cmd_data
.query
.cfg_component
->params
,
706 &results
, &fail_reason
);
711 print_value(stdout
, results
, 0);
715 BT_CLI_LOGE_APPEND_CAUSE(
716 "Failed to query component class: %s: plugin-name=\"%s\", "
717 "comp-cls-name=\"%s\", comp-cls-type=%d "
718 "object=\"%s\"", fail_reason
,
719 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
720 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
721 cfg
->cmd_data
.query
.cfg_component
->type
,
722 cfg
->cmd_data
.query
.object
->str
);
726 bt_component_class_put_ref(comp_cls
);
727 bt_value_put_ref(results
);
732 void print_component_class_help(const char *plugin_name
,
733 const bt_component_class
*comp_cls
)
735 const char *comp_class_name
=
736 bt_component_class_get_name(comp_cls
);
737 const char *comp_class_description
=
738 bt_component_class_get_description(comp_cls
);
739 const char *comp_class_help
=
740 bt_component_class_get_help(comp_cls
);
741 bt_component_class_type type
=
742 bt_component_class_get_type(comp_cls
);
744 print_plugin_comp_cls_opt(stdout
, plugin_name
, comp_class_name
, type
);
746 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
747 bt_common_color_reset(),
748 comp_class_description
? comp_class_description
: "(None)");
750 if (comp_class_help
) {
751 printf("\n%s\n", comp_class_help
);
756 int cmd_help(struct bt_config
*cfg
)
759 const bt_plugin
*plugin
= NULL
;
760 const bt_component_class
*needed_comp_cls
= NULL
;
762 plugin
= find_loaded_plugin(cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
764 BT_CLI_LOGE_APPEND_CAUSE(
765 "Cannot find plugin: plugin-name=\"%s\"",
766 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
771 print_plugin_info(plugin
);
772 printf(" %sSource component classes%s: %d\n",
773 bt_common_color_bold(),
774 bt_common_color_reset(),
775 (int) bt_plugin_get_source_component_class_count(plugin
));
776 printf(" %sFilter component classes%s: %d\n",
777 bt_common_color_bold(),
778 bt_common_color_reset(),
779 (int) bt_plugin_get_filter_component_class_count(plugin
));
780 printf(" %sSink component classes%s: %d\n",
781 bt_common_color_bold(),
782 bt_common_color_reset(),
783 (int) bt_plugin_get_sink_component_class_count(plugin
));
785 if (strlen(cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
) == 0) {
786 /* Plugin help only */
790 needed_comp_cls
= find_component_class(
791 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
792 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
793 cfg
->cmd_data
.help
.cfg_component
->type
);
794 if (!needed_comp_cls
) {
795 BT_CLI_LOGE_APPEND_CAUSE(
796 "Cannot find component class: plugin-name=\"%s\", "
797 "comp-cls-name=\"%s\", comp-cls-type=%d",
798 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
799 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
800 cfg
->cmd_data
.help
.cfg_component
->type
);
806 print_component_class_help(
807 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
811 bt_component_class_put_ref(needed_comp_cls
);
812 bt_plugin_put_ref(plugin
);
816 typedef void *(* plugin_borrow_comp_cls_by_index_func_t
)(const bt_plugin
*,
818 typedef const bt_component_class
*(* spec_comp_cls_borrow_comp_cls_func_t
)(
821 void cmd_list_plugins_print_component_classes(const bt_plugin
*plugin
,
822 const char *cc_type_name
, uint64_t count
,
823 plugin_borrow_comp_cls_by_index_func_t borrow_comp_cls_by_index_func
,
824 spec_comp_cls_borrow_comp_cls_func_t spec_comp_cls_borrow_comp_cls_func
)
829 printf(" %s%s component classes%s: (none)\n",
830 bt_common_color_bold(),
832 bt_common_color_reset());
835 printf(" %s%s component classes%s:\n",
836 bt_common_color_bold(),
838 bt_common_color_reset());
841 for (i
= 0; i
< count
; i
++) {
842 const bt_component_class
*comp_class
=
843 spec_comp_cls_borrow_comp_cls_func(
844 borrow_comp_cls_by_index_func(plugin
, i
));
845 const char *comp_class_name
=
846 bt_component_class_get_name(comp_class
);
847 const char *comp_class_description
=
848 bt_component_class_get_description(comp_class
);
849 bt_component_class_type type
=
850 bt_component_class_get_type(comp_class
);
853 print_plugin_comp_cls_opt(stdout
,
854 bt_plugin_get_name(plugin
), comp_class_name
,
857 if (comp_class_description
) {
858 printf(": %s", comp_class_description
);
869 int cmd_list_plugins(struct bt_config
*cfg
)
872 int plugins_count
, component_classes_count
= 0, i
;
874 printf("From the following plugin paths:\n\n");
875 print_value(stdout
, cfg
->plugin_paths
, 2);
877 plugins_count
= get_loaded_plugins_count();
878 if (plugins_count
== 0) {
879 printf("No plugins found.\n");
883 for (i
= 0; i
< plugins_count
; i
++) {
884 const bt_plugin
*plugin
= borrow_loaded_plugin(i
);
886 component_classes_count
+=
887 bt_plugin_get_source_component_class_count(plugin
) +
888 bt_plugin_get_filter_component_class_count(plugin
) +
889 bt_plugin_get_sink_component_class_count(plugin
);
892 printf("Found %s%d%s component classes in %s%d%s plugins.\n",
893 bt_common_color_bold(),
894 component_classes_count
,
895 bt_common_color_reset(),
896 bt_common_color_bold(),
898 bt_common_color_reset());
900 for (i
= 0; i
< plugins_count
; i
++) {
901 const bt_plugin
*plugin
= borrow_loaded_plugin(i
);
904 print_plugin_info(plugin
);
905 cmd_list_plugins_print_component_classes(plugin
, "Source",
906 bt_plugin_get_source_component_class_count(plugin
),
907 (plugin_borrow_comp_cls_by_index_func_t
)
908 bt_plugin_borrow_source_component_class_by_index_const
,
909 (spec_comp_cls_borrow_comp_cls_func_t
)
910 bt_component_class_source_as_component_class
);
911 cmd_list_plugins_print_component_classes(plugin
, "Filter",
912 bt_plugin_get_filter_component_class_count(plugin
),
913 (plugin_borrow_comp_cls_by_index_func_t
)
914 bt_plugin_borrow_filter_component_class_by_index_const
,
915 (spec_comp_cls_borrow_comp_cls_func_t
)
916 bt_component_class_filter_as_component_class
);
917 cmd_list_plugins_print_component_classes(plugin
, "Sink",
918 bt_plugin_get_sink_component_class_count(plugin
),
919 (plugin_borrow_comp_cls_by_index_func_t
)
920 bt_plugin_borrow_sink_component_class_by_index_const
,
921 (spec_comp_cls_borrow_comp_cls_func_t
)
922 bt_component_class_sink_as_component_class
);
930 int cmd_print_lttng_live_sessions(struct bt_config
*cfg
)
933 const bt_component_class
*comp_cls
= NULL
;
934 const bt_value
*results
= NULL
;
935 bt_value
*params
= NULL
;
936 const bt_value
*map
= NULL
;
937 const bt_value
*v
= NULL
;
938 static const char * const plugin_name
= "ctf";
939 static const char * const comp_cls_name
= "lttng-live";
940 static const bt_component_class_type comp_cls_type
=
941 BT_COMPONENT_CLASS_TYPE_SOURCE
;
942 uint64_t array_size
, i
;
943 const char *fail_reason
= NULL
;
944 FILE *out_stream
= stdout
;
946 BT_ASSERT(cfg
->cmd_data
.print_lttng_live_sessions
.url
);
947 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
950 BT_CLI_LOGE_APPEND_CAUSE(
951 "Cannot find component class: plugin-name=\"%s\", "
952 "comp-cls-name=\"%s\", comp-cls-type=%d",
953 plugin_name
, comp_cls_name
,
954 BT_COMPONENT_CLASS_TYPE_SOURCE
);
958 params
= bt_value_map_create();
963 ret
= bt_value_map_insert_string_entry(params
, "url",
964 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
969 ret
= query(cfg
, comp_cls
, "sessions", params
,
970 &results
, &fail_reason
);
977 if (!bt_value_is_array(results
)) {
978 BT_CLI_LOGE_APPEND_CAUSE(
979 "Expecting an array for LTTng live `sessions` query.");
983 if (cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->len
> 0) {
985 fopen(cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
,
989 BT_LOGE_ERRNO("Cannot open file for writing",
991 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
992 (void) BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
994 "Cannot open file for writing: path=\"%s\"",
995 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
1000 array_size
= bt_value_array_get_length(results
);
1001 for (i
= 0; i
< array_size
; i
++) {
1002 const char *url_text
;
1003 int64_t timer_us
, streams
, clients
;
1005 map
= bt_value_array_borrow_element_by_index_const(results
, i
);
1007 BT_CLI_LOGE_APPEND_CAUSE("Unexpected empty array entry.");
1010 if (!bt_value_is_map(map
)) {
1011 BT_CLI_LOGE_APPEND_CAUSE("Unexpected entry type.");
1015 v
= bt_value_map_borrow_entry_value_const(map
, "url");
1017 BT_CLI_LOGE_APPEND_CAUSE("Missing `url` entry.");
1020 url_text
= bt_value_string_get(v
);
1021 fprintf(out_stream
, "%s", url_text
);
1022 v
= bt_value_map_borrow_entry_value_const(map
, "timer-us");
1024 BT_CLI_LOGE_APPEND_CAUSE("Missing `timer-us` entry.");
1027 timer_us
= bt_value_integer_unsigned_get(v
);
1028 fprintf(out_stream
, " (timer = %" PRIu64
", ", timer_us
);
1029 v
= bt_value_map_borrow_entry_value_const(map
, "stream-count");
1031 BT_CLI_LOGE_APPEND_CAUSE(
1032 "Missing `stream-count` entry.");
1035 streams
= bt_value_integer_unsigned_get(v
);
1036 fprintf(out_stream
, "%" PRIu64
" stream(s), ", streams
);
1037 v
= bt_value_map_borrow_entry_value_const(map
, "client-count");
1039 BT_CLI_LOGE_APPEND_CAUSE(
1040 "Missing `client-count` entry.");
1043 clients
= bt_value_integer_unsigned_get(v
);
1044 fprintf(out_stream
, "%" PRIu64
" client(s) connected)\n", clients
);
1050 BT_CLI_LOGE_APPEND_CAUSE("Failed to query `sessions` object: %s",
1057 bt_value_put_ref(results
);
1058 bt_value_put_ref(params
);
1059 bt_component_class_put_ref(comp_cls
);
1061 if (out_stream
&& out_stream
!= stdout
) {
1062 int fclose_ret
= fclose(out_stream
);
1065 BT_LOGE_ERRNO("Cannot close file stream",
1067 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
1075 int cmd_print_ctf_metadata(struct bt_config
*cfg
)
1078 const bt_component_class
*comp_cls
= NULL
;
1079 const bt_value
*results
= NULL
;
1080 bt_value
*params
= NULL
;
1081 const bt_value
*metadata_text_value
= NULL
;
1082 const char *metadata_text
= NULL
;
1083 static const char * const plugin_name
= "ctf";
1084 static const char * const comp_cls_name
= "fs";
1085 static const bt_component_class_type comp_cls_type
=
1086 BT_COMPONENT_CLASS_TYPE_SOURCE
;
1087 const char *fail_reason
= NULL
;
1088 FILE *out_stream
= stdout
;
1090 BT_ASSERT(cfg
->cmd_data
.print_ctf_metadata
.path
);
1091 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1094 BT_CLI_LOGE_APPEND_CAUSE(
1095 "Cannot find component class: plugin-name=\"%s\", "
1096 "comp-cls-name=\"%s\", comp-cls-type=%d",
1097 plugin_name
, comp_cls_name
,
1098 BT_COMPONENT_CLASS_TYPE_SOURCE
);
1103 params
= bt_value_map_create();
1109 ret
= bt_value_map_insert_string_entry(params
, "path",
1110 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
1116 ret
= query(cfg
, comp_cls
, "metadata-info",
1117 params
, &results
, &fail_reason
);
1122 metadata_text_value
= bt_value_map_borrow_entry_value_const(results
,
1124 if (!metadata_text_value
) {
1125 BT_CLI_LOGE_APPEND_CAUSE(
1126 "Cannot find `text` string value in the resulting metadata info object.");
1131 metadata_text
= bt_value_string_get(metadata_text_value
);
1133 if (cfg
->cmd_data
.print_ctf_metadata
.output_path
->len
> 0) {
1135 fopen(cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
,
1138 BT_LOGE_ERRNO("Cannot open file for writing",
1140 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1141 (void) BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
1143 "Cannot open file for writing: path=\"%s\"",
1144 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1150 ret
= fprintf(out_stream
, "%s\n", metadata_text
);
1152 BT_CLI_LOGE_APPEND_CAUSE(
1153 "Cannot write whole metadata text to output stream: "
1163 BT_CLI_LOGE_APPEND_CAUSE(
1164 "Failed to query `metadata-info` object: %s", fail_reason
);
1167 bt_value_put_ref(results
);
1168 bt_value_put_ref(params
);
1169 bt_component_class_put_ref(comp_cls
);
1171 if (out_stream
&& out_stream
!= stdout
) {
1172 int fclose_ret
= fclose(out_stream
);
1175 BT_LOGE_ERRNO("Cannot close file stream",
1177 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1185 char *instance_name
;
1189 struct trace_range
{
1190 uint64_t intersection_range_begin_ns
;
1191 uint64_t intersection_range_end_ns
;
1195 guint
port_id_hash(gconstpointer v
)
1197 const struct port_id
*id
= v
;
1199 BT_ASSERT(id
->instance_name
);
1200 BT_ASSERT(id
->port_name
);
1202 return g_str_hash(id
->instance_name
) ^ g_str_hash(id
->port_name
);
1206 gboolean
port_id_equal(gconstpointer v1
, gconstpointer v2
)
1208 const struct port_id
*id1
= v1
;
1209 const struct port_id
*id2
= v2
;
1211 return strcmp(id1
->instance_name
, id2
->instance_name
) == 0 &&
1212 strcmp(id1
->port_name
, id2
->port_name
) == 0;
1216 void port_id_destroy(gpointer data
)
1218 struct port_id
*id
= data
;
1220 free(id
->instance_name
);
1221 free(id
->port_name
);
1226 void trace_range_destroy(gpointer data
)
1231 struct cmd_run_ctx
{
1233 GHashTable
*src_components
;
1236 GHashTable
*flt_components
;
1239 GHashTable
*sink_components
;
1245 struct bt_config
*cfg
;
1249 bool stream_intersection_mode
;
1252 * Association of struct port_id -> struct trace_range.
1254 GHashTable
*intersections
;
1257 /* Returns a timestamp of the form "(-)s.ns" */
1259 char *s_from_ns(int64_t ns
)
1264 int64_t ts_sec_abs
, ts_nsec_abs
;
1265 int64_t ts_sec
= ns
/ NSEC_PER_SEC
;
1266 int64_t ts_nsec
= ns
% NSEC_PER_SEC
;
1268 if (ts_sec
>= 0 && ts_nsec
>= 0) {
1269 is_negative
= false;
1270 ts_sec_abs
= ts_sec
;
1271 ts_nsec_abs
= ts_nsec
;
1272 } else if (ts_sec
> 0 && ts_nsec
< 0) {
1273 is_negative
= false;
1274 ts_sec_abs
= ts_sec
- 1;
1275 ts_nsec_abs
= NSEC_PER_SEC
+ ts_nsec
;
1276 } else if (ts_sec
== 0 && ts_nsec
< 0) {
1278 ts_sec_abs
= ts_sec
;
1279 ts_nsec_abs
= -ts_nsec
;
1280 } else if (ts_sec
< 0 && ts_nsec
> 0) {
1282 ts_sec_abs
= -(ts_sec
+ 1);
1283 ts_nsec_abs
= NSEC_PER_SEC
- ts_nsec
;
1284 } else if (ts_sec
< 0 && ts_nsec
== 0) {
1286 ts_sec_abs
= -ts_sec
;
1287 ts_nsec_abs
= ts_nsec
;
1288 } else { /* (ts_sec < 0 && ts_nsec < 0) */
1290 ts_sec_abs
= -ts_sec
;
1291 ts_nsec_abs
= -ts_nsec
;
1294 ret
= asprintf(&s_ret
, "%s%" PRId64
".%09" PRId64
,
1295 is_negative
? "-" : "", ts_sec_abs
, ts_nsec_abs
);
1303 int cmd_run_ctx_connect_upstream_port_to_downstream_component(
1304 struct cmd_run_ctx
*ctx
,
1305 const bt_component
*upstream_comp
,
1306 const bt_port_output
*out_upstream_port
,
1307 struct bt_config_connection
*cfg_conn
)
1309 typedef uint64_t (*input_port_count_func_t
)(void *);
1310 typedef const bt_port_input
*(*borrow_input_port_by_index_func_t
)(
1311 const void *, uint64_t);
1312 const bt_port
*upstream_port
=
1313 bt_port_output_as_port_const(out_upstream_port
);
1316 GQuark downstreamp_comp_name_quark
;
1317 void *downstream_comp
;
1318 uint64_t downstream_port_count
;
1320 input_port_count_func_t port_count_fn
;
1321 borrow_input_port_by_index_func_t port_by_index_fn
;
1322 bt_graph_connect_ports_status connect_ports_status
=
1323 BT_GRAPH_CONNECT_PORTS_STATUS_OK
;
1324 bool insert_trimmer
= false;
1325 bt_value
*trimmer_params
= NULL
;
1326 char *intersection_begin
= NULL
;
1327 char *intersection_end
= NULL
;
1328 const bt_component_filter
*trimmer
= NULL
;
1329 const bt_component_class_filter
*trimmer_class
= NULL
;
1330 const bt_port_input
*trimmer_input
= NULL
;
1331 const bt_port_output
*trimmer_output
= NULL
;
1333 if (ctx
->intersections
&&
1334 bt_component_get_class_type(upstream_comp
) ==
1335 BT_COMPONENT_CLASS_TYPE_SOURCE
) {
1336 struct trace_range
*range
;
1337 struct port_id port_id
= {
1338 .instance_name
= (char *) bt_component_get_name(upstream_comp
),
1339 .port_name
= (char *) bt_port_get_name(upstream_port
)
1342 if (!port_id
.instance_name
|| !port_id
.port_name
) {
1346 range
= (struct trace_range
*) g_hash_table_lookup(
1347 ctx
->intersections
, &port_id
);
1349 bt_value_map_insert_entry_status insert_status
;
1351 intersection_begin
= s_from_ns(
1352 range
->intersection_range_begin_ns
);
1353 intersection_end
= s_from_ns(
1354 range
->intersection_range_end_ns
);
1355 if (!intersection_begin
|| !intersection_end
) {
1356 BT_CLI_LOGE_APPEND_CAUSE(
1357 "Cannot create trimmer argument timestamp string.");
1361 insert_trimmer
= true;
1362 trimmer_params
= bt_value_map_create();
1363 if (!trimmer_params
) {
1367 insert_status
= bt_value_map_insert_string_entry(
1368 trimmer_params
, "begin", intersection_begin
);
1369 if (insert_status
< 0) {
1372 insert_status
= bt_value_map_insert_string_entry(
1374 "end", intersection_end
);
1375 if (insert_status
< 0) {
1380 trimmer_class
= find_filter_component_class("utils", "trimmer");
1381 if (!trimmer_class
) {
1386 BT_LOGI("Connecting upstream port to the next available downstream port: "
1387 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1388 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1389 upstream_port
, bt_port_get_name(upstream_port
),
1390 cfg_conn
->downstream_comp_name
->str
,
1391 cfg_conn
->arg
->str
);
1392 downstreamp_comp_name_quark
= g_quark_from_string(
1393 cfg_conn
->downstream_comp_name
->str
);
1394 BT_ASSERT(downstreamp_comp_name_quark
> 0);
1395 downstream_comp
= g_hash_table_lookup(ctx
->flt_components
,
1396 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1397 port_count_fn
= (input_port_count_func_t
)
1398 bt_component_filter_get_input_port_count
;
1399 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1400 bt_component_filter_borrow_input_port_by_index_const
;
1402 if (!downstream_comp
) {
1403 downstream_comp
= g_hash_table_lookup(ctx
->sink_components
,
1404 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1405 port_count_fn
= (input_port_count_func_t
)
1406 bt_component_sink_get_input_port_count
;
1407 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1408 bt_component_sink_borrow_input_port_by_index_const
;
1411 if (!downstream_comp
) {
1412 BT_CLI_LOGE_APPEND_CAUSE("Cannot find downstream component: "
1413 "comp-name=\"%s\", conn-arg=\"%s\"",
1414 cfg_conn
->downstream_comp_name
->str
,
1415 cfg_conn
->arg
->str
);
1419 downstream_port_count
= port_count_fn(downstream_comp
);
1421 for (i
= 0; i
< downstream_port_count
; i
++) {
1422 const bt_port_input
*in_downstream_port
=
1423 port_by_index_fn(downstream_comp
, i
);
1424 const bt_port
*downstream_port
=
1425 bt_port_input_as_port_const(in_downstream_port
);
1426 const char *upstream_port_name
;
1427 const char *downstream_port_name
;
1429 BT_ASSERT(downstream_port
);
1431 /* Skip port if it's already connected. */
1432 if (bt_port_is_connected(downstream_port
)) {
1433 BT_LOGI("Skipping downstream port: already connected: "
1434 "port-addr=%p, port-name=\"%s\"",
1436 bt_port_get_name(downstream_port
));
1440 downstream_port_name
= bt_port_get_name(downstream_port
);
1441 BT_ASSERT(downstream_port_name
);
1442 upstream_port_name
= bt_port_get_name(upstream_port
);
1443 BT_ASSERT(upstream_port_name
);
1445 if (!bt_common_star_glob_match(
1446 cfg_conn
->downstream_port_glob
->str
, SIZE_MAX
,
1447 downstream_port_name
, SIZE_MAX
)) {
1451 if (insert_trimmer
) {
1453 * In order to insert the trimmer between the
1454 * two components that were being connected, we
1455 * create a connection configuration entry which
1456 * describes a connection from the trimmer's
1457 * output to the original input that was being
1460 * Hence, the creation of the trimmer will cause
1461 * the graph "new port" listener to establish
1462 * all downstream connections as its output port
1463 * is connected. We will then establish the
1464 * connection between the original upstream
1465 * source and the trimmer.
1467 char *trimmer_name
= NULL
;
1468 bt_graph_add_component_status add_comp_status
;
1470 ret
= asprintf(&trimmer_name
,
1471 "stream-intersection-trimmer-%s",
1472 upstream_port_name
);
1478 ctx
->connect_ports
= false;
1479 add_comp_status
= bt_graph_add_filter_component(
1480 ctx
->graph
, trimmer_class
, trimmer_name
,
1481 trimmer_params
, ctx
->cfg
->log_level
,
1484 if (add_comp_status
!=
1485 BT_GRAPH_ADD_COMPONENT_STATUS_OK
) {
1491 bt_component_filter_borrow_input_port_by_index_const(
1493 if (!trimmer_input
) {
1497 bt_component_filter_borrow_output_port_by_index_const(
1499 if (!trimmer_output
) {
1504 * Replace the current downstream port by the trimmer's
1507 in_downstream_port
= trimmer_input
;
1509 bt_port_input_as_port_const(in_downstream_port
);
1510 downstream_port_name
= bt_port_get_name(
1512 BT_ASSERT(downstream_port_name
);
1515 /* We have a winner! */
1516 connect_ports_status
= bt_graph_connect_ports(ctx
->graph
,
1517 out_upstream_port
, in_downstream_port
, NULL
);
1518 downstream_port
= NULL
;
1519 switch (connect_ports_status
) {
1520 case BT_GRAPH_CONNECT_PORTS_STATUS_OK
:
1523 BT_CLI_LOGE_APPEND_CAUSE(
1524 "Cannot create connection: graph refuses to connect ports: "
1525 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1526 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1527 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1528 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1530 upstream_comp
, bt_component_get_name(upstream_comp
),
1531 upstream_port
, bt_port_get_name(upstream_port
),
1532 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1533 downstream_port
, downstream_port_name
,
1534 cfg_conn
->arg
->str
);
1538 BT_LOGI("Connected component ports: "
1539 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1540 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1541 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1542 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1544 upstream_comp
, bt_component_get_name(upstream_comp
),
1545 upstream_port
, bt_port_get_name(upstream_port
),
1546 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1547 downstream_port
, downstream_port_name
,
1548 cfg_conn
->arg
->str
);
1550 if (insert_trimmer
) {
1552 * The first connection, from the source to the trimmer,
1553 * has been done. We now connect the trimmer to the
1554 * original downstream port.
1556 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1558 bt_component_filter_as_component_const(trimmer
),
1559 trimmer_output
, cfg_conn
);
1563 ctx
->connect_ports
= true;
1567 * We found a matching downstream port: the search is
1573 /* No downstream port found */
1574 BT_CLI_LOGE_APPEND_CAUSE(
1575 "Cannot create connection: cannot find a matching downstream port for upstream port: "
1576 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1577 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1578 upstream_port
, bt_port_get_name(upstream_port
),
1579 cfg_conn
->downstream_comp_name
->str
,
1580 cfg_conn
->arg
->str
);
1586 free(intersection_begin
);
1587 free(intersection_end
);
1588 BT_VALUE_PUT_REF_AND_RESET(trimmer_params
);
1589 BT_COMPONENT_CLASS_FILTER_PUT_REF_AND_RESET(trimmer_class
);
1590 BT_COMPONENT_FILTER_PUT_REF_AND_RESET(trimmer
);
1595 int cmd_run_ctx_connect_upstream_port(struct cmd_run_ctx
*ctx
,
1596 const bt_port_output
*upstream_port
)
1599 const char *upstream_port_name
;
1600 const char *upstream_comp_name
;
1601 const bt_component
*upstream_comp
= NULL
;
1605 BT_ASSERT(upstream_port
);
1606 upstream_port_name
= bt_port_get_name(
1607 bt_port_output_as_port_const(upstream_port
));
1608 BT_ASSERT(upstream_port_name
);
1609 upstream_comp
= bt_port_borrow_component_const(
1610 bt_port_output_as_port_const(upstream_port
));
1611 BT_ASSERT(upstream_comp
);
1612 upstream_comp_name
= bt_component_get_name(upstream_comp
);
1613 BT_ASSERT(upstream_comp_name
);
1614 BT_LOGI("Connecting upstream port: comp-addr=%p, comp-name=\"%s\", "
1615 "port-addr=%p, port-name=\"%s\"",
1616 upstream_comp
, upstream_comp_name
,
1617 upstream_port
, upstream_port_name
);
1619 for (i
= 0; i
< ctx
->cfg
->cmd_data
.run
.connections
->len
; i
++) {
1620 struct bt_config_connection
*cfg_conn
=
1622 ctx
->cfg
->cmd_data
.run
.connections
, i
);
1624 if (strcmp(cfg_conn
->upstream_comp_name
->str
,
1625 upstream_comp_name
)) {
1629 if (!bt_common_star_glob_match(
1630 cfg_conn
->upstream_port_glob
->str
,
1631 SIZE_MAX
, upstream_port_name
, SIZE_MAX
)) {
1635 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1636 ctx
, upstream_comp
, upstream_port
, cfg_conn
);
1638 BT_CLI_LOGE_APPEND_CAUSE(
1639 "Cannot connect upstream port: "
1640 "port-addr=%p, port-name=\"%s\"",
1642 upstream_port_name
);
1648 BT_CLI_LOGE_APPEND_CAUSE(
1649 "Cannot connect upstream port: port does not match any connection argument: "
1650 "port-addr=%p, port-name=\"%s\"", upstream_port
,
1651 upstream_port_name
);
1661 bt_graph_listener_func_status
1662 graph_output_port_added_listener(struct cmd_run_ctx
*ctx
,
1663 const bt_port_output
*out_port
)
1665 const bt_component
*comp
;
1666 const bt_port
*port
= bt_port_output_as_port_const(out_port
);
1667 bt_graph_listener_func_status ret
=
1668 BT_GRAPH_LISTENER_FUNC_STATUS_OK
;
1670 comp
= bt_port_borrow_component_const(port
);
1671 BT_LOGI("Port added to a graph's component: comp-addr=%p, "
1672 "comp-name=\"%s\", port-addr=%p, port-name=\"%s\"",
1673 comp
, comp
? bt_component_get_name(comp
) : "",
1674 port
, bt_port_get_name(port
));
1676 if (!ctx
->connect_ports
) {
1682 if (bt_port_is_connected(port
)) {
1683 BT_LOGW_STR("Port is already connected.");
1687 if (cmd_run_ctx_connect_upstream_port(ctx
, out_port
)) {
1688 BT_CLI_LOGE_APPEND_CAUSE("Cannot connect upstream port.");
1689 ret
= BT_GRAPH_LISTENER_FUNC_STATUS_ERROR
;
1698 bt_graph_listener_func_status
graph_source_output_port_added_listener(
1699 const bt_component_source
*component
,
1700 const bt_port_output
*port
, void *data
)
1702 return graph_output_port_added_listener(data
, port
);
1706 bt_graph_listener_func_status
graph_filter_output_port_added_listener(
1707 const bt_component_filter
*component
,
1708 const bt_port_output
*port
, void *data
)
1710 return graph_output_port_added_listener(data
, port
);
1714 void cmd_run_ctx_destroy(struct cmd_run_ctx
*ctx
)
1720 if (ctx
->src_components
) {
1721 g_hash_table_destroy(ctx
->src_components
);
1722 ctx
->src_components
= NULL
;
1725 if (ctx
->flt_components
) {
1726 g_hash_table_destroy(ctx
->flt_components
);
1727 ctx
->flt_components
= NULL
;
1730 if (ctx
->sink_components
) {
1731 g_hash_table_destroy(ctx
->sink_components
);
1732 ctx
->sink_components
= NULL
;
1735 if (ctx
->intersections
) {
1736 g_hash_table_destroy(ctx
->intersections
);
1737 ctx
->intersections
= NULL
;
1740 BT_GRAPH_PUT_REF_AND_RESET(ctx
->graph
);
1745 int add_descriptor_to_component_descriptor_set(
1746 bt_component_descriptor_set
*comp_descr_set
,
1747 const char *plugin_name
, const char *comp_cls_name
,
1748 bt_component_class_type comp_cls_type
,
1749 const bt_value
*params
)
1751 const bt_component_class
*comp_cls
;
1754 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1757 BT_CLI_LOGE_APPEND_CAUSE(
1758 "Cannot find component class: plugin-name=\"%s\", "
1759 "comp-cls-name=\"%s\", comp-cls-type=%d",
1760 plugin_name
, comp_cls_name
, comp_cls_type
);
1765 status
= bt_component_descriptor_set_add_descriptor(
1766 comp_descr_set
, comp_cls
, params
);
1767 if (status
!= BT_COMPONENT_DESCRIPTOR_SET_ADD_DESCRIPTOR_STATUS_OK
) {
1768 BT_CLI_LOGE_APPEND_CAUSE(
1769 "Cannot append descriptor to component descriptor set: "
1770 "status=%s", bt_common_func_status_string(status
));
1775 bt_component_class_put_ref(comp_cls
);
1780 int append_descriptors_from_bt_config_component_array(
1781 bt_component_descriptor_set
*comp_descr_set
,
1782 GPtrArray
*component_configs
)
1787 for (i
= 0; i
< component_configs
->len
; i
++) {
1788 struct bt_config_component
*cfg_comp
=
1789 component_configs
->pdata
[i
];
1791 ret
= add_descriptor_to_component_descriptor_set(
1793 cfg_comp
->plugin_name
->str
,
1794 cfg_comp
->comp_cls_name
->str
,
1795 cfg_comp
->type
, cfg_comp
->params
);
1806 bt_get_greatest_operative_mip_version_status
get_greatest_operative_mip_version(
1807 struct bt_config
*cfg
, uint64_t *mip_version
)
1809 bt_get_greatest_operative_mip_version_status status
=
1810 BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_OK
;
1811 bt_component_descriptor_set
*comp_descr_set
= NULL
;
1815 BT_ASSERT(mip_version
);
1816 comp_descr_set
= bt_component_descriptor_set_create();
1817 if (!comp_descr_set
) {
1818 BT_CLI_LOGE_APPEND_CAUSE(
1819 "Failed to create a component descriptor set object.");
1820 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_MEMORY_ERROR
;
1824 ret
= append_descriptors_from_bt_config_component_array(
1825 comp_descr_set
, cfg
->cmd_data
.run
.sources
);
1827 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR
;
1831 ret
= append_descriptors_from_bt_config_component_array(
1832 comp_descr_set
, cfg
->cmd_data
.run
.filters
);
1834 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR
;
1838 ret
= append_descriptors_from_bt_config_component_array(
1839 comp_descr_set
, cfg
->cmd_data
.run
.sinks
);
1841 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR
;
1845 if (cfg
->cmd_data
.run
.stream_intersection_mode
) {
1847 * Stream intersection mode adds `flt.utils.trimmer`
1848 * components; we need to include this type of component
1849 * in the component descriptor set to get the real
1850 * greatest operative MIP version.
1852 ret
= add_descriptor_to_component_descriptor_set(
1853 comp_descr_set
, "utils", "trimmer",
1854 BT_COMPONENT_CLASS_TYPE_FILTER
, NULL
);
1856 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR
;
1861 status
= bt_get_greatest_operative_mip_version(comp_descr_set
,
1862 bt_cli_log_level
, mip_version
);
1865 bt_component_descriptor_set_put_ref(comp_descr_set
);
1870 int cmd_run_ctx_init(struct cmd_run_ctx
*ctx
, struct bt_config
*cfg
)
1873 bt_graph_add_listener_status add_listener_status
;
1874 bt_get_greatest_operative_mip_version_status mip_version_status
;
1875 uint64_t mip_version
= UINT64_C(-1);
1878 ctx
->connect_ports
= false;
1879 ctx
->src_components
= g_hash_table_new_full(g_direct_hash
,
1880 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
1881 if (!ctx
->src_components
) {
1885 ctx
->flt_components
= g_hash_table_new_full(g_direct_hash
,
1886 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
1887 if (!ctx
->flt_components
) {
1891 ctx
->sink_components
= g_hash_table_new_full(g_direct_hash
,
1892 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
1893 if (!ctx
->sink_components
) {
1897 if (cfg
->cmd_data
.run
.stream_intersection_mode
) {
1898 ctx
->stream_intersection_mode
= true;
1899 ctx
->intersections
= g_hash_table_new_full(port_id_hash
,
1900 port_id_equal
, port_id_destroy
, trace_range_destroy
);
1901 if (!ctx
->intersections
) {
1907 * Get the greatest operative MIP version to use to configure
1908 * the graph to create.
1910 mip_version_status
= get_greatest_operative_mip_version(
1912 if (mip_version_status
== BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_NO_MATCH
) {
1913 BT_CLI_LOGE_APPEND_CAUSE(
1914 "Failed to find an operative message interchange "
1915 "protocol version to use to create the `run` command's "
1916 "graph (components are not interoperable).");
1918 } else if (mip_version_status
< 0) {
1919 BT_CLI_LOGE_APPEND_CAUSE(
1920 "Cannot find an operative message interchange "
1921 "protocol version to use to create the `run` command's "
1923 bt_common_func_status_string(mip_version_status
));
1927 BT_ASSERT(mip_version_status
== BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_OK
);
1928 BT_LOGI("Found operative message interchange protocol version to "
1929 "configure the `run` command's graph: mip-version=%" PRIu64
,
1931 ctx
->graph
= bt_graph_create(mip_version
);
1936 bt_graph_add_interrupter(ctx
->graph
, the_interrupter
);
1937 add_listener_status
= bt_graph_add_source_component_output_port_added_listener(
1938 ctx
->graph
, graph_source_output_port_added_listener
, NULL
, ctx
,
1940 if (add_listener_status
!= BT_GRAPH_ADD_LISTENER_STATUS_OK
) {
1941 BT_CLI_LOGE_APPEND_CAUSE(
1942 "Cannot add \"port added\" listener to graph.");
1946 add_listener_status
= bt_graph_add_filter_component_output_port_added_listener(
1947 ctx
->graph
, graph_filter_output_port_added_listener
, NULL
, ctx
,
1949 if (add_listener_status
!= BT_GRAPH_ADD_LISTENER_STATUS_OK
) {
1950 BT_CLI_LOGE_APPEND_CAUSE(
1951 "Cannot add \"port added\" listener to graph.");
1958 cmd_run_ctx_destroy(ctx
);
1966 * Compute the intersection of all streams in the array `streams`, write it
1971 int compute_stream_intersection(const bt_value
*streams
,
1972 struct trace_range
*range
)
1974 uint64_t i
, stream_count
;
1977 BT_ASSERT(bt_value_get_type(streams
) == BT_VALUE_TYPE_ARRAY
);
1979 stream_count
= bt_value_array_get_length(streams
);
1981 BT_ASSERT(stream_count
> 0);
1983 range
->intersection_range_begin_ns
= 0;
1984 range
->intersection_range_end_ns
= UINT64_MAX
;
1986 for (i
= 0; i
< stream_count
; i
++) {
1987 int64_t begin_ns
, end_ns
;
1988 uint64_t begin_ns_u
, end_ns_u
;
1989 const bt_value
*stream_value
;
1990 const bt_value
*range_ns_value
;
1991 const bt_value
*begin_value
;
1992 const bt_value
*end_value
;
1994 stream_value
= bt_value_array_borrow_element_by_index_const(streams
, i
);
1995 if (bt_value_get_type(stream_value
) != BT_VALUE_TYPE_MAP
) {
1996 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
1997 "expected streams array element to be a map, got %s.",
1998 bt_common_value_type_string(bt_value_get_type(stream_value
)));
2002 range_ns_value
= bt_value_map_borrow_entry_value_const(
2003 stream_value
, "range-ns");
2004 if (!range_ns_value
) {
2005 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2006 "missing expected `range-ns` key in stream map.");
2010 if (bt_value_get_type(range_ns_value
) != BT_VALUE_TYPE_MAP
) {
2011 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2012 "expected `range-ns` entry value of stream map to be a map, got %s.",
2013 bt_common_value_type_string(bt_value_get_type(range_ns_value
)));
2017 begin_value
= bt_value_map_borrow_entry_value_const(range_ns_value
, "begin");
2019 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2020 "missing expected `begin` key in range-ns map.");
2024 if (bt_value_get_type(begin_value
) != BT_VALUE_TYPE_SIGNED_INTEGER
) {
2025 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2026 "expected `begin` entry value of range-ns map to be a signed integer, got %s.",
2027 bt_common_value_type_string(bt_value_get_type(range_ns_value
)));
2031 end_value
= bt_value_map_borrow_entry_value_const(range_ns_value
, "end");
2033 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2034 "missing expected `end` key in range-ns map.");
2038 if (bt_value_get_type(end_value
) != BT_VALUE_TYPE_SIGNED_INTEGER
) {
2039 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2040 "expected `end` entry value of range-ns map to be a signed integer, got %s.",
2041 bt_common_value_type_string(bt_value_get_type(range_ns_value
)));
2045 begin_ns
= bt_value_integer_signed_get(begin_value
);
2046 end_ns
= bt_value_integer_signed_get(end_value
);
2048 if (begin_ns
< 0 || end_ns
< 0 || end_ns
< begin_ns
) {
2049 BT_CLI_LOGE_APPEND_CAUSE(
2050 "Invalid stream range values: "
2051 "range-ns:begin=%" PRId64
", "
2052 "range-ns:end=%" PRId64
,
2057 begin_ns_u
= begin_ns
;
2060 range
->intersection_range_begin_ns
=
2061 MAX(range
->intersection_range_begin_ns
, begin_ns_u
);
2062 range
->intersection_range_end_ns
=
2063 MIN(range
->intersection_range_end_ns
, end_ns_u
);
2076 int set_stream_intersections(struct cmd_run_ctx
*ctx
,
2077 struct bt_config_component
*cfg_comp
,
2078 const bt_component_class_source
*src_comp_cls
)
2082 uint64_t trace_count
;
2083 const bt_value
*query_result
= NULL
;
2084 const bt_value
*trace_info
= NULL
;
2085 const bt_value
*stream_infos
= NULL
;
2086 const bt_value
*stream_info
= NULL
;
2087 struct port_id
*port_id
= NULL
;
2088 struct trace_range
*stream_intersection
= NULL
;
2089 const char *fail_reason
= NULL
;
2090 const bt_component_class
*comp_cls
=
2091 bt_component_class_source_as_component_class_const(src_comp_cls
);
2093 ret
= query(ctx
->cfg
, comp_cls
, "babeltrace.trace-infos",
2094 cfg_comp
->params
, &query_result
,
2097 BT_CLI_LOGE_APPEND_CAUSE("Failed to execute `babeltrace.trace-infos` query: %s: "
2098 "comp-class-name=\"%s\"", fail_reason
,
2099 bt_component_class_get_name(comp_cls
));
2104 BT_ASSERT(query_result
);
2106 if (!bt_value_is_array(query_result
)) {
2107 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting result to be an array: "
2108 "component-class-name=%s, actual-type=%s",
2109 bt_component_class_get_name(comp_cls
),
2110 bt_common_value_type_string(bt_value_get_type(query_result
)));
2115 trace_count
= bt_value_array_get_length(query_result
);
2116 if (trace_count
== 0) {
2117 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: result is empty: "
2118 "component-class-name=%s", bt_component_class_get_name(comp_cls
));
2123 for (trace_idx
= 0; trace_idx
< trace_count
; trace_idx
++) {
2124 uint64_t stream_idx
;
2125 int64_t stream_count
;
2126 struct trace_range trace_intersection
;
2128 trace_info
= bt_value_array_borrow_element_by_index_const(
2129 query_result
, trace_idx
);
2130 BT_ASSERT(trace_info
);
2131 if (!bt_value_is_map(trace_info
)) {
2133 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting element to be a map: "
2134 "component-class-name=%s, actual-type=%s",
2135 bt_component_class_get_name(comp_cls
),
2136 bt_common_value_type_string(bt_value_get_type(trace_info
)));
2140 stream_infos
= bt_value_map_borrow_entry_value_const(
2141 trace_info
, "stream-infos");
2142 if (!stream_infos
) {
2144 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: missing `streams` key in trace info map: "
2145 "component-class-name=%s",
2146 bt_component_class_get_name(comp_cls
));
2150 if (!bt_value_is_array(stream_infos
)) {
2152 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting `streams` entry of trace info map to be an array: "
2153 "component-class-name=%s, actual-type=%s",
2154 bt_component_class_get_name(comp_cls
),
2155 bt_common_value_type_string(bt_value_get_type(stream_infos
)));
2159 stream_count
= bt_value_array_get_length(stream_infos
);
2160 if (stream_count
== 0) {
2162 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: list of streams is empty: "
2163 "component-class-name=%s",
2164 bt_component_class_get_name(comp_cls
));
2168 ret
= compute_stream_intersection(stream_infos
, &trace_intersection
);
2170 BT_CLI_LOGE_APPEND_CAUSE("Failed to compute trace streams intersection.");
2174 for (stream_idx
= 0; stream_idx
< stream_count
; stream_idx
++) {
2175 const bt_value
*port_name
;
2177 port_id
= g_new0(struct port_id
, 1);
2180 BT_CLI_LOGE_APPEND_CAUSE(
2181 "Cannot allocate memory for port_id structure.");
2184 port_id
->instance_name
= strdup(cfg_comp
->instance_name
->str
);
2185 if (!port_id
->instance_name
) {
2187 BT_CLI_LOGE_APPEND_CAUSE(
2188 "Cannot allocate memory for port_id component instance name.");
2192 stream_intersection
= g_new0(struct trace_range
, 1);
2193 if (!stream_intersection
) {
2195 BT_CLI_LOGE_APPEND_CAUSE(
2196 "Cannot allocate memory for trace_range structure.");
2200 *stream_intersection
= trace_intersection
;
2202 stream_info
= bt_value_array_borrow_element_by_index_const(
2203 stream_infos
, stream_idx
);
2204 BT_ASSERT(stream_info
);
2205 if (!bt_value_is_map(stream_info
)) {
2207 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: "
2208 "expecting element of stream list to be a map: "
2209 "component-class-name=%s, actual-type=%s",
2210 bt_component_class_get_name(comp_cls
),
2211 bt_common_value_type_string(bt_value_get_type(stream_info
)));
2215 port_name
= bt_value_map_borrow_entry_value_const(stream_info
, "port-name");
2218 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: "
2219 "missing `port-name` key in stream info map: "
2220 "component-class-name=%s",
2221 bt_component_class_get_name(comp_cls
));
2225 if (!bt_value_is_string(port_name
)) {
2227 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: "
2228 "expecting `port-name` entry of stream info map to be a string: "
2229 "component-class-name=%s, actual-type=%s",
2230 bt_component_class_get_name(comp_cls
),
2231 bt_common_value_type_string(bt_value_get_type(port_name
)));
2235 port_id
->port_name
= g_strdup(bt_value_string_get(port_name
));
2236 if (!port_id
->port_name
) {
2238 BT_CLI_LOGE_APPEND_CAUSE(
2239 "Cannot allocate memory for port_id port_name.");
2243 BT_LOGD("Inserting stream intersection ");
2245 g_hash_table_insert(ctx
->intersections
, port_id
, stream_intersection
);
2248 stream_intersection
= NULL
;
2255 bt_value_put_ref(query_result
);
2257 g_free(stream_intersection
);
2262 int cmd_run_ctx_create_components_from_config_components(
2263 struct cmd_run_ctx
*ctx
, GPtrArray
*cfg_components
)
2266 const void *comp_cls
= NULL
;
2267 const void *comp
= NULL
;
2270 for (i
= 0; i
< cfg_components
->len
; i
++) {
2271 struct bt_config_component
*cfg_comp
=
2272 g_ptr_array_index(cfg_components
, i
);
2275 switch (cfg_comp
->type
) {
2276 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2277 comp_cls
= find_source_component_class(
2278 cfg_comp
->plugin_name
->str
,
2279 cfg_comp
->comp_cls_name
->str
);
2281 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2282 comp_cls
= find_filter_component_class(
2283 cfg_comp
->plugin_name
->str
,
2284 cfg_comp
->comp_cls_name
->str
);
2286 case BT_COMPONENT_CLASS_TYPE_SINK
:
2287 comp_cls
= find_sink_component_class(
2288 cfg_comp
->plugin_name
->str
,
2289 cfg_comp
->comp_cls_name
->str
);
2296 BT_CLI_LOGE_APPEND_CAUSE(
2297 "Cannot find component class: plugin-name=\"%s\", "
2298 "comp-cls-name=\"%s\", comp-cls-type=%d",
2299 cfg_comp
->plugin_name
->str
,
2300 cfg_comp
->comp_cls_name
->str
,
2305 BT_ASSERT(cfg_comp
->log_level
>= BT_LOG_TRACE
);
2307 switch (cfg_comp
->type
) {
2308 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2309 ret
= bt_graph_add_source_component(ctx
->graph
,
2310 comp_cls
, cfg_comp
->instance_name
->str
,
2311 cfg_comp
->params
, cfg_comp
->log_level
,
2314 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2315 ret
= bt_graph_add_filter_component(ctx
->graph
,
2316 comp_cls
, cfg_comp
->instance_name
->str
,
2317 cfg_comp
->params
, cfg_comp
->log_level
,
2320 case BT_COMPONENT_CLASS_TYPE_SINK
:
2321 ret
= bt_graph_add_sink_component(ctx
->graph
,
2322 comp_cls
, cfg_comp
->instance_name
->str
,
2323 cfg_comp
->params
, cfg_comp
->log_level
,
2331 BT_CLI_LOGE_APPEND_CAUSE(
2332 "Cannot create component: plugin-name=\"%s\", "
2333 "comp-cls-name=\"%s\", comp-cls-type=%d, "
2335 cfg_comp
->plugin_name
->str
,
2336 cfg_comp
->comp_cls_name
->str
,
2337 cfg_comp
->type
, cfg_comp
->instance_name
->str
);
2341 if (ctx
->stream_intersection_mode
&&
2342 cfg_comp
->type
== BT_COMPONENT_CLASS_TYPE_SOURCE
) {
2343 ret
= set_stream_intersections(ctx
, cfg_comp
, comp_cls
);
2345 BT_CLI_LOGE_APPEND_CAUSE(
2346 "Cannot determine stream intersection of trace.");
2351 BT_LOGI("Created and inserted component: comp-addr=%p, comp-name=\"%s\"",
2352 comp
, cfg_comp
->instance_name
->str
);
2353 quark
= g_quark_from_string(cfg_comp
->instance_name
->str
);
2354 BT_ASSERT(quark
> 0);
2356 switch (cfg_comp
->type
) {
2357 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2358 g_hash_table_insert(ctx
->src_components
,
2359 GUINT_TO_POINTER(quark
), (void *) comp
);
2361 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2362 g_hash_table_insert(ctx
->flt_components
,
2363 GUINT_TO_POINTER(quark
), (void *) comp
);
2365 case BT_COMPONENT_CLASS_TYPE_SINK
:
2366 g_hash_table_insert(ctx
->sink_components
,
2367 GUINT_TO_POINTER(quark
), (void *) comp
);
2374 BT_OBJECT_PUT_REF_AND_RESET(comp_cls
);
2383 bt_object_put_ref(comp
);
2384 bt_object_put_ref(comp_cls
);
2389 int cmd_run_ctx_create_components(struct cmd_run_ctx
*ctx
)
2394 * Make sure that, during this phase, our graph's "port added"
2395 * listener does not connect ports while we are creating the
2396 * components because we have a special, initial phase for
2399 ctx
->connect_ports
= false;
2401 ret
= cmd_run_ctx_create_components_from_config_components(
2402 ctx
, ctx
->cfg
->cmd_data
.run
.sources
);
2408 ret
= cmd_run_ctx_create_components_from_config_components(
2409 ctx
, ctx
->cfg
->cmd_data
.run
.filters
);
2415 ret
= cmd_run_ctx_create_components_from_config_components(
2416 ctx
, ctx
->cfg
->cmd_data
.run
.sinks
);
2426 typedef uint64_t (*output_port_count_func_t
)(const void *);
2427 typedef const bt_port_output
*(*borrow_output_port_by_index_func_t
)(
2428 const void *, uint64_t);
2431 int cmd_run_ctx_connect_comp_ports(struct cmd_run_ctx
*ctx
,
2432 void *comp
, output_port_count_func_t port_count_fn
,
2433 borrow_output_port_by_index_func_t port_by_index_fn
)
2439 count
= port_count_fn(comp
);
2441 for (i
= 0; i
< count
; i
++) {
2442 const bt_port_output
*upstream_port
= port_by_index_fn(comp
, i
);
2444 BT_ASSERT(upstream_port
);
2445 ret
= cmd_run_ctx_connect_upstream_port(ctx
, upstream_port
);
2456 int cmd_run_ctx_connect_ports(struct cmd_run_ctx
*ctx
)
2459 GHashTableIter iter
;
2460 gpointer g_name_quark
, g_comp
;
2462 ctx
->connect_ports
= true;
2463 g_hash_table_iter_init(&iter
, ctx
->src_components
);
2465 while (g_hash_table_iter_next(&iter
, &g_name_quark
, &g_comp
)) {
2466 ret
= cmd_run_ctx_connect_comp_ports(ctx
, g_comp
,
2467 (output_port_count_func_t
)
2468 bt_component_source_get_output_port_count
,
2469 (borrow_output_port_by_index_func_t
)
2470 bt_component_source_borrow_output_port_by_index_const
);
2476 g_hash_table_iter_init(&iter
, ctx
->flt_components
);
2478 while (g_hash_table_iter_next(&iter
, &g_name_quark
, &g_comp
)) {
2479 ret
= cmd_run_ctx_connect_comp_ports(ctx
, g_comp
,
2480 (output_port_count_func_t
)
2481 bt_component_filter_get_output_port_count
,
2482 (borrow_output_port_by_index_func_t
)
2483 bt_component_filter_borrow_output_port_by_index_const
);
2494 int cmd_run(struct bt_config
*cfg
)
2497 struct cmd_run_ctx ctx
= { 0 };
2499 /* Initialize the command's context and the graph object */
2500 if (cmd_run_ctx_init(&ctx
, cfg
)) {
2501 BT_CLI_LOGE_APPEND_CAUSE(
2502 "Cannot initialize the command's context.");
2506 if (bt_interrupter_is_set(the_interrupter
)) {
2507 BT_CLI_LOGW_APPEND_CAUSE(
2508 "Interrupted by user before creating components.");
2512 BT_LOGI_STR("Creating components.");
2514 /* Create the requested component instances */
2515 if (cmd_run_ctx_create_components(&ctx
)) {
2516 BT_CLI_LOGE_APPEND_CAUSE("Cannot create components.");
2520 if (bt_interrupter_is_set(the_interrupter
)) {
2521 BT_CLI_LOGW_APPEND_CAUSE(
2522 "Interrupted by user before connecting components.");
2526 BT_LOGI_STR("Connecting components.");
2528 /* Connect the initially visible component ports */
2529 if (cmd_run_ctx_connect_ports(&ctx
)) {
2530 BT_CLI_LOGE_APPEND_CAUSE(
2531 "Cannot connect initial component ports.");
2535 BT_LOGI_STR("Running the graph.");
2539 bt_graph_run_status run_status
= bt_graph_run(ctx
.graph
);
2542 * Reset console in case something messed with console
2543 * codes during the graph's execution.
2545 printf("%s", bt_common_color_reset());
2547 fprintf(stderr
, "%s", bt_common_color_reset());
2548 BT_LOGT("bt_graph_run() returned: status=%s",
2549 bt_common_func_status_string(run_status
));
2551 switch (run_status
) {
2552 case BT_GRAPH_RUN_STATUS_OK
:
2554 case BT_GRAPH_RUN_STATUS_AGAIN
:
2555 if (bt_interrupter_is_set(the_interrupter
)) {
2556 BT_CLI_LOGW_APPEND_CAUSE(
2557 "Graph was interrupted by user.");
2561 if (cfg
->cmd_data
.run
.retry_duration_us
> 0) {
2562 BT_LOGT("Got BT_GRAPH_RUN_STATUS_AGAIN: sleeping: "
2564 cfg
->cmd_data
.run
.retry_duration_us
);
2566 if (usleep(cfg
->cmd_data
.run
.retry_duration_us
)) {
2567 if (bt_interrupter_is_set(the_interrupter
)) {
2568 BT_CLI_LOGW_APPEND_CAUSE(
2569 "Graph was interrupted by user.");
2575 case BT_GRAPH_RUN_STATUS_END
:
2578 if (bt_interrupter_is_set(the_interrupter
)) {
2579 BT_CLI_LOGW_APPEND_CAUSE(
2580 "Graph was interrupted by user and failed: "
2582 bt_common_func_status_string(run_status
));
2586 BT_CLI_LOGE_APPEND_CAUSE(
2587 "Graph failed to complete successfully");
2600 cmd_run_ctx_destroy(&ctx
);
2605 void warn_command_name_and_directory_clash(struct bt_config
*cfg
)
2607 const char *env_clash
;
2609 if (!cfg
->command_name
) {
2613 env_clash
= getenv(ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH
);
2614 if (env_clash
&& strcmp(env_clash
, "0") == 0) {
2618 if (g_file_test(cfg
->command_name
,
2619 G_FILE_TEST_EXISTS
| G_FILE_TEST_IS_DIR
)) {
2620 _bt_log_write_d(_BT_LOG_SRCLOC_FUNCTION
, __FILE__
, __LINE__
,
2621 BT_LOG_WARNING
, BT_LOG_TAG
,
2622 "The `%s` command was executed. "
2623 "If you meant to convert a trace located in "
2624 "the local `%s` directory, please use:\n\n"
2625 " babeltrace2 convert %s [OPTIONS]",
2626 cfg
->command_name
, cfg
->command_name
,
2632 void init_log_level(void)
2634 bt_cli_log_level
= bt_log_get_level_from_env(ENV_BABELTRACE_CLI_LOG_LEVEL
);
2638 void print_error_causes(void)
2640 const bt_error
*error
= bt_current_thread_take_error();
2642 GString
*folded
= NULL
;
2643 unsigned int columns
;
2645 if (!error
|| bt_error_get_cause_count(error
) == 0) {
2646 fprintf(stderr
, "%s%sUnknown command-line error.%s\n",
2647 bt_common_color_bold(), bt_common_color_fg_red(),
2648 bt_common_color_reset());
2652 /* Try to get terminal width to fold the error cause messages */
2653 if (bt_common_get_term_size(&columns
, NULL
) < 0) {
2654 /* Width not found: default to 80 */
2659 * This helps visually separate the error causes from the last
2660 * logging statement.
2662 fprintf(stderr
, "\n");
2664 /* Reverse order: deepest (root) cause printed at the end */
2665 for (i
= bt_error_get_cause_count(error
) - 1; i
>= 0; i
--) {
2666 const bt_error_cause
*cause
=
2667 bt_error_borrow_cause_by_index(error
, (uint64_t) i
);
2668 const char *prefix_fmt
=
2669 i
== bt_error_get_cause_count(error
) - 1 ?
2670 "%s%sERROR%s: " : "%s%sCAUSED BY%s ";
2673 fprintf(stderr
, prefix_fmt
,
2674 bt_common_color_bold(), bt_common_color_fg_red(),
2675 bt_common_color_reset());
2677 /* Print actor name */
2678 fprintf(stderr
, "[");
2679 switch (bt_error_cause_get_actor_type(cause
)) {
2680 case BT_ERROR_CAUSE_ACTOR_TYPE_UNKNOWN
:
2681 fprintf(stderr
, "%s%s%s",
2682 bt_common_color_bold(),
2683 bt_error_cause_get_module_name(cause
),
2684 bt_common_color_reset());
2686 case BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT
:
2687 fprintf(stderr
, "%s%s%s: ",
2688 bt_common_color_bold(),
2689 bt_error_cause_component_actor_get_component_name(cause
),
2690 bt_common_color_reset());
2691 print_plugin_comp_cls_opt(stderr
,
2692 bt_error_cause_component_actor_get_plugin_name(cause
),
2693 bt_error_cause_component_actor_get_component_class_name(cause
),
2694 bt_error_cause_component_actor_get_component_class_type(cause
));
2696 case BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT_CLASS
:
2697 print_plugin_comp_cls_opt(stderr
,
2698 bt_error_cause_component_class_actor_get_plugin_name(cause
),
2699 bt_error_cause_component_class_actor_get_component_class_name(cause
),
2700 bt_error_cause_component_class_actor_get_component_class_type(cause
));
2702 case BT_ERROR_CAUSE_ACTOR_TYPE_MESSAGE_ITERATOR
:
2703 fprintf(stderr
, "%s%s%s (%s%s%s): ",
2704 bt_common_color_bold(),
2705 bt_error_cause_message_iterator_actor_get_component_name(cause
),
2706 bt_common_color_reset(),
2707 bt_common_color_bold(),
2708 bt_error_cause_message_iterator_actor_get_component_output_port_name(cause
),
2709 bt_common_color_reset());
2710 print_plugin_comp_cls_opt(stderr
,
2711 bt_error_cause_message_iterator_actor_get_plugin_name(cause
),
2712 bt_error_cause_message_iterator_actor_get_component_class_name(cause
),
2713 bt_error_cause_message_iterator_actor_get_component_class_type(cause
));
2719 /* Print file name and line number */
2720 fprintf(stderr
, "] (%s%s%s%s:%s%" PRIu64
"%s)\n",
2721 bt_common_color_bold(),
2722 bt_common_color_fg_magenta(),
2723 bt_error_cause_get_file_name(cause
),
2724 bt_common_color_reset(),
2725 bt_common_color_fg_green(),
2726 bt_error_cause_get_line_number(cause
),
2727 bt_common_color_reset());
2730 folded
= bt_common_fold(bt_error_cause_get_message(cause
),
2733 BT_LOGE_STR("Could not fold string.");
2734 fprintf(stderr
, "%s\n",
2735 bt_error_cause_get_message(cause
));
2739 fprintf(stderr
, "%s\n", folded
->str
);
2740 g_string_free(folded
, TRUE
);
2748 bt_error_release(error
);
2752 int main(int argc
, const char **argv
)
2756 struct bt_config
*cfg
= NULL
;
2759 set_signal_handler();
2760 init_loaded_plugins();
2762 BT_ASSERT(!the_interrupter
);
2763 the_interrupter
= bt_interrupter_create();
2764 if (!the_interrupter
) {
2765 BT_CLI_LOGE_APPEND_CAUSE("Failed to create an interrupter object.");
2770 cfg
= bt_config_cli_args_create_with_default(argc
, argv
, &retcode
,
2774 /* Quit without errors; typically usage/version */
2776 BT_LOGI_STR("Quitting without errors.");
2781 BT_CLI_LOGE_APPEND_CAUSE(
2782 "Command-line error: retcode=%d", retcode
);
2787 BT_CLI_LOGE_APPEND_CAUSE(
2788 "Failed to create a valid Babeltrace CLI configuration.");
2795 if (cfg
->command_needs_plugins
) {
2796 ret
= require_loaded_plugins(cfg
->plugin_paths
);
2798 BT_CLI_LOGE_APPEND_CAUSE(
2799 "Failed to load plugins: ret=%d", ret
);
2805 BT_LOGI("Executing command: cmd=%d, command-name=\"%s\"",
2806 cfg
->command
, cfg
->command_name
);
2808 switch (cfg
->command
) {
2809 case BT_CONFIG_COMMAND_RUN
:
2812 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
2813 ret
= cmd_list_plugins(cfg
);
2815 case BT_CONFIG_COMMAND_HELP
:
2816 ret
= cmd_help(cfg
);
2818 case BT_CONFIG_COMMAND_QUERY
:
2819 ret
= cmd_query(cfg
);
2821 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
2822 ret
= cmd_print_ctf_metadata(cfg
);
2824 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
2825 ret
= cmd_print_lttng_live_sessions(cfg
);
2828 BT_LOGF("Invalid/unknown command: cmd=%d", cfg
->command
);
2832 BT_LOGI("Command completed: cmd=%d, command-name=\"%s\", ret=%d",
2833 cfg
->command
, cfg
->command_name
, ret
);
2834 warn_command_name_and_directory_clash(cfg
);
2835 retcode
= ret
? 1 : 0;
2838 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
2839 fini_loaded_plugins();
2840 bt_interrupter_put_ref(the_interrupter
);
2843 print_error_causes();
2847 * Clear current thread's error in case there is one to avoid a
2850 bt_current_thread_clear_error();