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
;
341 switch (bt_value_get_type(value
)) {
342 case BT_VALUE_TYPE_NULL
:
343 fprintf(fp
, "%snull%s\n", bt_common_color_bold(),
344 bt_common_color_reset());
346 case BT_VALUE_TYPE_BOOL
:
347 bool_val
= bt_value_bool_get(value
);
348 fprintf(fp
, "%s%s%s%s\n", bt_common_color_bold(),
349 bt_common_color_fg_cyan(), bool_val
? "yes" : "no",
350 bt_common_color_reset());
352 case BT_VALUE_TYPE_UNSIGNED_INTEGER
:
353 uint_val
= bt_value_integer_unsigned_get(value
);
354 fprintf(fp
, "%s%s%" PRIu64
"%s\n", bt_common_color_bold(),
355 bt_common_color_fg_red(), uint_val
,
356 bt_common_color_reset());
358 case BT_VALUE_TYPE_SIGNED_INTEGER
:
359 int_val
= bt_value_integer_signed_get(value
);
360 fprintf(fp
, "%s%s%" PRId64
"%s\n", bt_common_color_bold(),
361 bt_common_color_fg_red(), int_val
,
362 bt_common_color_reset());
364 case BT_VALUE_TYPE_REAL
:
365 dbl_val
= bt_value_real_get(value
);
366 fprintf(fp
, "%s%s%lf%s\n", bt_common_color_bold(),
367 bt_common_color_fg_red(), dbl_val
,
368 bt_common_color_reset());
370 case BT_VALUE_TYPE_STRING
:
371 str_val
= bt_value_string_get(value
);
372 fprintf(fp
, "%s%s%s%s\n", bt_common_color_bold(),
373 bt_common_color_fg_green(), str_val
,
374 bt_common_color_reset());
376 case BT_VALUE_TYPE_ARRAY
:
379 size
= bt_value_array_get_length(value
);
381 print_indent(fp
, indent
);
382 fprintf(fp
, "[ ]\n");
386 for (i
= 0; i
< size
; i
++) {
387 const bt_value
*element
=
388 bt_value_array_borrow_element_by_index_const(
391 print_indent(fp
, indent
);
394 if (bt_value_is_array(element
) &&
395 bt_value_array_is_empty(element
)) {
396 fprintf(fp
, "[ ]\n");
400 if (bt_value_is_map(element
) &&
401 bt_value_map_is_empty(element
)) {
402 fprintf(fp
, "{ }\n");
406 if (bt_value_is_array(element
) ||
407 bt_value_is_map(element
)) {
411 print_value_rec(fp
, element
, indent
+ 2);
415 case BT_VALUE_TYPE_MAP
:
418 bt_value_map_foreach_entry_const_status foreach_status
;
420 if (bt_value_map_is_empty(value
)) {
421 print_indent(fp
, indent
);
422 fprintf(fp
, "{ }\n");
426 map_keys
= g_ptr_array_new();
428 BT_CLI_LOGE_APPEND_CAUSE("Failed to allocated on GPtrArray.");
433 * We want to print the map entries in a stable order. Collect
434 * all the map's keys in a GPtrArray, sort it, then print the
435 * entries in that order.
437 foreach_status
= bt_value_map_foreach_entry_const(value
,
438 collect_map_keys
, map_keys
);
439 if (foreach_status
!= BT_VALUE_MAP_FOREACH_ENTRY_CONST_STATUS_OK
) {
440 BT_CLI_LOGE_APPEND_CAUSE("Failed to iterator on map value.");
444 g_ptr_array_sort(map_keys
, g_ptr_array_sort_strings
);
446 for (i
= 0; i
< map_keys
->len
; i
++) {
447 const char *map_key
= g_ptr_array_index(map_keys
, i
);
448 const bt_value
*map_value
;
450 map_value
= bt_value_map_borrow_entry_value_const(value
, map_key
);
451 BT_ASSERT(map_value
);
453 print_map_value(map_key
, map_value
, fp
, indent
);
466 g_ptr_array_free(map_keys
, TRUE
);
471 void print_value(FILE *fp
, const bt_value
*value
, size_t indent
)
473 if (!bt_value_is_array(value
) && !bt_value_is_map(value
)) {
474 print_indent(fp
, indent
);
477 print_value_rec(fp
, value
, indent
);
481 void print_bt_config_component(struct bt_config_component
*bt_config_component
)
483 fprintf(stderr
, " ");
484 print_plugin_comp_cls_opt(stderr
, bt_config_component
->plugin_name
->str
,
485 bt_config_component
->comp_cls_name
->str
,
486 bt_config_component
->type
);
487 fprintf(stderr
, ":\n");
489 if (bt_config_component
->instance_name
->len
> 0) {
490 fprintf(stderr
, " Name: %s\n",
491 bt_config_component
->instance_name
->str
);
494 fprintf(stderr
, " Parameters:\n");
495 print_value(stderr
, bt_config_component
->params
, 8);
499 void print_bt_config_components(GPtrArray
*array
)
503 for (i
= 0; i
< array
->len
; i
++) {
504 struct bt_config_component
*cfg_component
=
505 bt_config_get_component(array
, i
);
506 print_bt_config_component(cfg_component
);
507 BT_OBJECT_PUT_REF_AND_RESET(cfg_component
);
512 void print_plugin_paths(const bt_value
*plugin_paths
)
514 fprintf(stderr
, " Plugin paths:\n");
515 print_value(stderr
, plugin_paths
, 4);
519 void print_cfg_run(struct bt_config
*cfg
)
523 print_plugin_paths(cfg
->plugin_paths
);
524 fprintf(stderr
, " Source component instances:\n");
525 print_bt_config_components(cfg
->cmd_data
.run
.sources
);
527 if (cfg
->cmd_data
.run
.filters
->len
> 0) {
528 fprintf(stderr
, " Filter component instances:\n");
529 print_bt_config_components(cfg
->cmd_data
.run
.filters
);
532 fprintf(stderr
, " Sink component instances:\n");
533 print_bt_config_components(cfg
->cmd_data
.run
.sinks
);
534 fprintf(stderr
, " Connections:\n");
536 for (i
= 0; i
< cfg
->cmd_data
.run
.connections
->len
; i
++) {
537 struct bt_config_connection
*cfg_connection
=
538 g_ptr_array_index(cfg
->cmd_data
.run
.connections
,
541 fprintf(stderr
, " %s%s%s -> %s%s%s\n",
542 cfg_connection
->upstream_comp_name
->str
,
543 cfg_connection
->upstream_port_glob
->len
> 0 ? "." : "",
544 cfg_connection
->upstream_port_glob
->str
,
545 cfg_connection
->downstream_comp_name
->str
,
546 cfg_connection
->downstream_port_glob
->len
> 0 ? "." : "",
547 cfg_connection
->downstream_port_glob
->str
);
552 void print_cfg_list_plugins(struct bt_config
*cfg
)
554 print_plugin_paths(cfg
->plugin_paths
);
558 void print_cfg_help(struct bt_config
*cfg
)
560 print_plugin_paths(cfg
->plugin_paths
);
564 void print_cfg_print_ctf_metadata(struct bt_config
*cfg
)
566 print_plugin_paths(cfg
->plugin_paths
);
567 fprintf(stderr
, " Path: %s\n",
568 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
572 void print_cfg_print_lttng_live_sessions(struct bt_config
*cfg
)
574 print_plugin_paths(cfg
->plugin_paths
);
575 fprintf(stderr
, " URL: %s\n",
576 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
580 void print_cfg_query(struct bt_config
*cfg
)
582 print_plugin_paths(cfg
->plugin_paths
);
583 fprintf(stderr
, " Object: `%s`\n", cfg
->cmd_data
.query
.object
->str
);
584 fprintf(stderr
, " Component class:\n");
585 print_bt_config_component(cfg
->cmd_data
.query
.cfg_component
);
589 void print_cfg(struct bt_config
*cfg
)
591 if (!BT_LOG_ON_INFO
) {
595 BT_LOGI_STR("CLI configuration:");
597 switch (cfg
->command
) {
598 case BT_CONFIG_COMMAND_RUN
:
601 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
602 print_cfg_list_plugins(cfg
);
604 case BT_CONFIG_COMMAND_HELP
:
607 case BT_CONFIG_COMMAND_QUERY
:
608 print_cfg_query(cfg
);
610 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
611 print_cfg_print_ctf_metadata(cfg
);
613 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
614 print_cfg_print_lttng_live_sessions(cfg
);
622 void print_plugin_info(const bt_plugin
*plugin
)
624 unsigned int major
, minor
, patch
;
626 bt_property_availability version_avail
;
627 const char *plugin_name
;
631 const char *plugin_description
;
633 plugin_name
= bt_plugin_get_name(plugin
);
634 path
= bt_plugin_get_path(plugin
);
635 author
= bt_plugin_get_author(plugin
);
636 license
= bt_plugin_get_license(plugin
);
637 plugin_description
= bt_plugin_get_description(plugin
);
638 version_avail
= bt_plugin_get_version(plugin
, &major
, &minor
,
640 printf("%s%s%s%s:\n", bt_common_color_bold(),
641 bt_common_color_fg_blue(), plugin_name
,
642 bt_common_color_reset());
644 printf(" %sPath%s: %s\n", bt_common_color_bold(),
645 bt_common_color_reset(), path
);
650 if (version_avail
== BT_PROPERTY_AVAILABILITY_AVAILABLE
) {
651 printf(" %sVersion%s: %u.%u.%u",
652 bt_common_color_bold(), bt_common_color_reset(),
653 major
, minor
, patch
);
662 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
663 bt_common_color_reset(),
664 plugin_description
? plugin_description
: "(None)");
665 printf(" %sAuthor%s: %s\n", bt_common_color_bold(),
666 bt_common_color_reset(), author
? author
: "(Unknown)");
667 printf(" %sLicense%s: %s\n", bt_common_color_bold(),
668 bt_common_color_reset(),
669 license
? license
: "(Unknown)");
673 int cmd_query(struct bt_config
*cfg
)
676 const bt_component_class
*comp_cls
= NULL
;
677 const bt_value
*results
= NULL
;
678 const char *fail_reason
= NULL
;
680 comp_cls
= find_component_class(
681 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
682 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
683 cfg
->cmd_data
.query
.cfg_component
->type
);
685 BT_CLI_LOGE_APPEND_CAUSE(
686 "Cannot find component class: plugin-name=\"%s\", "
687 "comp-cls-name=\"%s\", comp-cls-type=%d",
688 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
689 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
690 cfg
->cmd_data
.query
.cfg_component
->type
);
695 ret
= query(cfg
, comp_cls
, cfg
->cmd_data
.query
.object
->str
,
696 cfg
->cmd_data
.query
.cfg_component
->params
,
697 &results
, &fail_reason
);
702 print_value(stdout
, results
, 0);
706 BT_CLI_LOGE_APPEND_CAUSE(
707 "Failed to query component class: %s: plugin-name=\"%s\", "
708 "comp-cls-name=\"%s\", comp-cls-type=%d "
709 "object=\"%s\"", fail_reason
,
710 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
711 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
712 cfg
->cmd_data
.query
.cfg_component
->type
,
713 cfg
->cmd_data
.query
.object
->str
);
717 bt_component_class_put_ref(comp_cls
);
718 bt_value_put_ref(results
);
723 void print_component_class_help(const char *plugin_name
,
724 const bt_component_class
*comp_cls
)
726 const char *comp_class_name
=
727 bt_component_class_get_name(comp_cls
);
728 const char *comp_class_description
=
729 bt_component_class_get_description(comp_cls
);
730 const char *comp_class_help
=
731 bt_component_class_get_help(comp_cls
);
732 bt_component_class_type type
=
733 bt_component_class_get_type(comp_cls
);
735 print_plugin_comp_cls_opt(stdout
, plugin_name
, comp_class_name
, type
);
737 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
738 bt_common_color_reset(),
739 comp_class_description
? comp_class_description
: "(None)");
741 if (comp_class_help
) {
742 printf("\n%s\n", comp_class_help
);
747 int cmd_help(struct bt_config
*cfg
)
750 const bt_plugin
*plugin
= NULL
;
751 const bt_component_class
*needed_comp_cls
= NULL
;
753 plugin
= find_loaded_plugin(cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
755 BT_CLI_LOGE_APPEND_CAUSE(
756 "Cannot find plugin: plugin-name=\"%s\"",
757 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
762 print_plugin_info(plugin
);
763 printf(" %sSource component classes%s: %d\n",
764 bt_common_color_bold(),
765 bt_common_color_reset(),
766 (int) bt_plugin_get_source_component_class_count(plugin
));
767 printf(" %sFilter component classes%s: %d\n",
768 bt_common_color_bold(),
769 bt_common_color_reset(),
770 (int) bt_plugin_get_filter_component_class_count(plugin
));
771 printf(" %sSink component classes%s: %d\n",
772 bt_common_color_bold(),
773 bt_common_color_reset(),
774 (int) bt_plugin_get_sink_component_class_count(plugin
));
776 if (strlen(cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
) == 0) {
777 /* Plugin help only */
781 needed_comp_cls
= find_component_class(
782 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
783 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
784 cfg
->cmd_data
.help
.cfg_component
->type
);
785 if (!needed_comp_cls
) {
786 BT_CLI_LOGE_APPEND_CAUSE(
787 "Cannot find component class: plugin-name=\"%s\", "
788 "comp-cls-name=\"%s\", comp-cls-type=%d",
789 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
790 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
791 cfg
->cmd_data
.help
.cfg_component
->type
);
797 print_component_class_help(
798 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
802 bt_component_class_put_ref(needed_comp_cls
);
803 bt_plugin_put_ref(plugin
);
807 typedef void *(* plugin_borrow_comp_cls_by_index_func_t
)(const bt_plugin
*,
809 typedef const bt_component_class
*(* spec_comp_cls_borrow_comp_cls_func_t
)(
813 void cmd_list_plugins_print_component_classes(const bt_plugin
*plugin
,
814 const char *cc_type_name
, uint64_t count
,
815 plugin_borrow_comp_cls_by_index_func_t borrow_comp_cls_by_index_func
,
816 spec_comp_cls_borrow_comp_cls_func_t spec_comp_cls_borrow_comp_cls_func
)
821 printf(" %s%s component classes%s: (none)\n",
822 bt_common_color_bold(),
824 bt_common_color_reset());
827 printf(" %s%s component classes%s:\n",
828 bt_common_color_bold(),
830 bt_common_color_reset());
833 for (i
= 0; i
< count
; i
++) {
834 const bt_component_class
*comp_class
=
835 spec_comp_cls_borrow_comp_cls_func(
836 borrow_comp_cls_by_index_func(plugin
, i
));
837 const char *comp_class_name
=
838 bt_component_class_get_name(comp_class
);
839 const char *comp_class_description
=
840 bt_component_class_get_description(comp_class
);
841 bt_component_class_type type
=
842 bt_component_class_get_type(comp_class
);
845 print_plugin_comp_cls_opt(stdout
,
846 bt_plugin_get_name(plugin
), comp_class_name
,
849 if (comp_class_description
) {
850 printf(": %s", comp_class_description
);
861 int cmd_list_plugins(struct bt_config
*cfg
)
864 int plugins_count
, component_classes_count
= 0, i
;
866 printf("From the following plugin paths:\n\n");
867 print_value(stdout
, cfg
->plugin_paths
, 2);
869 plugins_count
= get_loaded_plugins_count();
870 if (plugins_count
== 0) {
871 printf("No plugins found.\n");
875 for (i
= 0; i
< plugins_count
; i
++) {
876 const bt_plugin
*plugin
= borrow_loaded_plugin(i
);
878 component_classes_count
+=
879 bt_plugin_get_source_component_class_count(plugin
) +
880 bt_plugin_get_filter_component_class_count(plugin
) +
881 bt_plugin_get_sink_component_class_count(plugin
);
884 printf("Found %s%d%s component classes in %s%d%s plugins.\n",
885 bt_common_color_bold(),
886 component_classes_count
,
887 bt_common_color_reset(),
888 bt_common_color_bold(),
890 bt_common_color_reset());
892 for (i
= 0; i
< plugins_count
; i
++) {
893 const bt_plugin
*plugin
= borrow_loaded_plugin(i
);
896 print_plugin_info(plugin
);
897 cmd_list_plugins_print_component_classes(plugin
, "Source",
898 bt_plugin_get_source_component_class_count(plugin
),
899 (plugin_borrow_comp_cls_by_index_func_t
)
900 bt_plugin_borrow_source_component_class_by_index_const
,
901 (spec_comp_cls_borrow_comp_cls_func_t
)
902 bt_component_class_source_as_component_class
);
903 cmd_list_plugins_print_component_classes(plugin
, "Filter",
904 bt_plugin_get_filter_component_class_count(plugin
),
905 (plugin_borrow_comp_cls_by_index_func_t
)
906 bt_plugin_borrow_filter_component_class_by_index_const
,
907 (spec_comp_cls_borrow_comp_cls_func_t
)
908 bt_component_class_filter_as_component_class
);
909 cmd_list_plugins_print_component_classes(plugin
, "Sink",
910 bt_plugin_get_sink_component_class_count(plugin
),
911 (plugin_borrow_comp_cls_by_index_func_t
)
912 bt_plugin_borrow_sink_component_class_by_index_const
,
913 (spec_comp_cls_borrow_comp_cls_func_t
)
914 bt_component_class_sink_as_component_class
);
922 int cmd_print_lttng_live_sessions(struct bt_config
*cfg
)
925 const bt_component_class
*comp_cls
= NULL
;
926 const bt_value
*results
= NULL
;
927 bt_value
*params
= NULL
;
928 const bt_value
*map
= NULL
;
929 const bt_value
*v
= NULL
;
930 static const char * const plugin_name
= "ctf";
931 static const char * const comp_cls_name
= "lttng-live";
932 static const bt_component_class_type comp_cls_type
=
933 BT_COMPONENT_CLASS_TYPE_SOURCE
;
934 uint64_t array_size
, i
;
935 const char *fail_reason
= NULL
;
936 FILE *out_stream
= stdout
;
938 BT_ASSERT(cfg
->cmd_data
.print_lttng_live_sessions
.url
);
939 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
942 BT_CLI_LOGE_APPEND_CAUSE(
943 "Cannot find component class: plugin-name=\"%s\", "
944 "comp-cls-name=\"%s\", comp-cls-type=%d",
945 plugin_name
, comp_cls_name
,
946 BT_COMPONENT_CLASS_TYPE_SOURCE
);
950 params
= bt_value_map_create();
955 ret
= bt_value_map_insert_string_entry(params
, "url",
956 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
961 ret
= query(cfg
, comp_cls
, "sessions", params
,
962 &results
, &fail_reason
);
969 if (!bt_value_is_array(results
)) {
970 BT_CLI_LOGE_APPEND_CAUSE(
971 "Expecting an array for LTTng live `sessions` query.");
975 if (cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->len
> 0) {
977 fopen(cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
,
981 BT_LOGE_ERRNO("Cannot open file for writing",
983 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
984 (void) BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
986 "Cannot open file for writing: path=\"%s\"",
987 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
992 array_size
= bt_value_array_get_length(results
);
993 for (i
= 0; i
< array_size
; i
++) {
994 const char *url_text
;
995 int64_t timer_us
, streams
, clients
;
997 map
= bt_value_array_borrow_element_by_index_const(results
, i
);
998 if (!bt_value_is_map(map
)) {
999 BT_CLI_LOGE_APPEND_CAUSE("Unexpected entry type.");
1003 v
= bt_value_map_borrow_entry_value_const(map
, "url");
1005 BT_CLI_LOGE_APPEND_CAUSE("Missing `url` entry.");
1008 url_text
= bt_value_string_get(v
);
1009 fprintf(out_stream
, "%s", url_text
);
1010 v
= bt_value_map_borrow_entry_value_const(map
, "timer-us");
1012 BT_CLI_LOGE_APPEND_CAUSE("Missing `timer-us` entry.");
1015 timer_us
= bt_value_integer_unsigned_get(v
);
1016 fprintf(out_stream
, " (timer = %" PRIu64
", ", timer_us
);
1017 v
= bt_value_map_borrow_entry_value_const(map
, "stream-count");
1019 BT_CLI_LOGE_APPEND_CAUSE(
1020 "Missing `stream-count` entry.");
1023 streams
= bt_value_integer_unsigned_get(v
);
1024 fprintf(out_stream
, "%" PRIu64
" stream(s), ", streams
);
1025 v
= bt_value_map_borrow_entry_value_const(map
, "client-count");
1027 BT_CLI_LOGE_APPEND_CAUSE(
1028 "Missing `client-count` entry.");
1031 clients
= bt_value_integer_unsigned_get(v
);
1032 fprintf(out_stream
, "%" PRIu64
" client(s) connected)\n", clients
);
1038 BT_CLI_LOGE_APPEND_CAUSE("Failed to query `sessions` object: %s",
1045 bt_value_put_ref(results
);
1046 bt_value_put_ref(params
);
1047 bt_component_class_put_ref(comp_cls
);
1049 if (out_stream
&& out_stream
!= stdout
) {
1050 int fclose_ret
= fclose(out_stream
);
1053 BT_LOGE_ERRNO("Cannot close file stream",
1055 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
1063 int cmd_print_ctf_metadata(struct bt_config
*cfg
)
1066 const bt_component_class
*comp_cls
= NULL
;
1067 const bt_value
*results
= NULL
;
1068 bt_value
*params
= NULL
;
1069 const bt_value
*metadata_text_value
= NULL
;
1070 const char *metadata_text
= NULL
;
1071 static const char * const plugin_name
= "ctf";
1072 static const char * const comp_cls_name
= "fs";
1073 static const bt_component_class_type comp_cls_type
=
1074 BT_COMPONENT_CLASS_TYPE_SOURCE
;
1075 const char *fail_reason
= NULL
;
1076 FILE *out_stream
= stdout
;
1078 BT_ASSERT(cfg
->cmd_data
.print_ctf_metadata
.path
);
1079 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1082 BT_CLI_LOGE_APPEND_CAUSE(
1083 "Cannot find component class: plugin-name=\"%s\", "
1084 "comp-cls-name=\"%s\", comp-cls-type=%d",
1085 plugin_name
, comp_cls_name
,
1086 BT_COMPONENT_CLASS_TYPE_SOURCE
);
1091 params
= bt_value_map_create();
1097 ret
= bt_value_map_insert_string_entry(params
, "path",
1098 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
1104 ret
= query(cfg
, comp_cls
, "metadata-info",
1105 params
, &results
, &fail_reason
);
1110 metadata_text_value
= bt_value_map_borrow_entry_value_const(results
,
1112 if (!metadata_text_value
) {
1113 BT_CLI_LOGE_APPEND_CAUSE(
1114 "Cannot find `text` string value in the resulting metadata info object.");
1119 metadata_text
= bt_value_string_get(metadata_text_value
);
1121 if (cfg
->cmd_data
.print_ctf_metadata
.output_path
->len
> 0) {
1123 fopen(cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
,
1126 BT_LOGE_ERRNO("Cannot open file for writing",
1128 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1129 (void) BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
1131 "Cannot open file for writing: path=\"%s\"",
1132 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1138 ret
= fprintf(out_stream
, "%s\n", metadata_text
);
1140 BT_CLI_LOGE_APPEND_CAUSE(
1141 "Cannot write whole metadata text to output stream: "
1151 BT_CLI_LOGE_APPEND_CAUSE(
1152 "Failed to query `metadata-info` object: %s", fail_reason
);
1155 bt_value_put_ref(results
);
1156 bt_value_put_ref(params
);
1157 bt_component_class_put_ref(comp_cls
);
1159 if (out_stream
&& out_stream
!= stdout
) {
1160 int fclose_ret
= fclose(out_stream
);
1163 BT_LOGE_ERRNO("Cannot close file stream",
1165 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1173 char *instance_name
;
1177 struct trace_range
{
1178 uint64_t intersection_range_begin_ns
;
1179 uint64_t intersection_range_end_ns
;
1183 guint
port_id_hash(gconstpointer v
)
1185 const struct port_id
*id
= v
;
1187 BT_ASSERT(id
->instance_name
);
1188 BT_ASSERT(id
->port_name
);
1190 return g_str_hash(id
->instance_name
) ^ g_str_hash(id
->port_name
);
1194 gboolean
port_id_equal(gconstpointer v1
, gconstpointer v2
)
1196 const struct port_id
*id1
= v1
;
1197 const struct port_id
*id2
= v2
;
1199 return strcmp(id1
->instance_name
, id2
->instance_name
) == 0 &&
1200 strcmp(id1
->port_name
, id2
->port_name
) == 0;
1204 void port_id_destroy(gpointer data
)
1206 struct port_id
*id
= data
;
1208 free(id
->instance_name
);
1209 free(id
->port_name
);
1214 void trace_range_destroy(gpointer data
)
1219 struct cmd_run_ctx
{
1221 GHashTable
*src_components
;
1224 GHashTable
*flt_components
;
1227 GHashTable
*sink_components
;
1233 struct bt_config
*cfg
;
1237 bool stream_intersection_mode
;
1240 * Association of struct port_id -> struct trace_range.
1242 GHashTable
*intersections
;
1245 /* Returns a timestamp of the form "(-)s.ns" */
1247 char *s_from_ns(int64_t ns
)
1252 int64_t ts_sec_abs
, ts_nsec_abs
;
1253 int64_t ts_sec
= ns
/ NSEC_PER_SEC
;
1254 int64_t ts_nsec
= ns
% NSEC_PER_SEC
;
1256 if (ts_sec
>= 0 && ts_nsec
>= 0) {
1257 is_negative
= false;
1258 ts_sec_abs
= ts_sec
;
1259 ts_nsec_abs
= ts_nsec
;
1260 } else if (ts_sec
> 0 && ts_nsec
< 0) {
1261 is_negative
= false;
1262 ts_sec_abs
= ts_sec
- 1;
1263 ts_nsec_abs
= NSEC_PER_SEC
+ ts_nsec
;
1264 } else if (ts_sec
== 0 && ts_nsec
< 0) {
1266 ts_sec_abs
= ts_sec
;
1267 ts_nsec_abs
= -ts_nsec
;
1268 } else if (ts_sec
< 0 && ts_nsec
> 0) {
1270 ts_sec_abs
= -(ts_sec
+ 1);
1271 ts_nsec_abs
= NSEC_PER_SEC
- ts_nsec
;
1272 } else if (ts_sec
< 0 && ts_nsec
== 0) {
1274 ts_sec_abs
= -ts_sec
;
1275 ts_nsec_abs
= ts_nsec
;
1276 } else { /* (ts_sec < 0 && ts_nsec < 0) */
1278 ts_sec_abs
= -ts_sec
;
1279 ts_nsec_abs
= -ts_nsec
;
1282 ret
= asprintf(&s_ret
, "%s%" PRId64
".%09" PRId64
,
1283 is_negative
? "-" : "", ts_sec_abs
, ts_nsec_abs
);
1291 int cmd_run_ctx_connect_upstream_port_to_downstream_component(
1292 struct cmd_run_ctx
*ctx
,
1293 const bt_component
*upstream_comp
,
1294 const bt_port_output
*out_upstream_port
,
1295 struct bt_config_connection
*cfg_conn
)
1297 typedef uint64_t (*input_port_count_func_t
)(void *);
1298 typedef const bt_port_input
*(*borrow_input_port_by_index_func_t
)(
1299 const void *, uint64_t);
1300 const bt_port
*upstream_port
=
1301 bt_port_output_as_port_const(out_upstream_port
);
1304 GQuark downstreamp_comp_name_quark
;
1305 void *downstream_comp
;
1306 uint64_t downstream_port_count
;
1308 input_port_count_func_t port_count_fn
;
1309 borrow_input_port_by_index_func_t port_by_index_fn
;
1310 bt_graph_connect_ports_status connect_ports_status
=
1311 BT_GRAPH_CONNECT_PORTS_STATUS_OK
;
1312 bool insert_trimmer
= false;
1313 bt_value
*trimmer_params
= NULL
;
1314 char *intersection_begin
= NULL
;
1315 char *intersection_end
= NULL
;
1316 const bt_component_filter
*trimmer
= NULL
;
1317 const bt_component_class_filter
*trimmer_class
= NULL
;
1318 const bt_port_input
*trimmer_input
= NULL
;
1319 const bt_port_output
*trimmer_output
= NULL
;
1321 if (ctx
->intersections
&&
1322 bt_component_get_class_type(upstream_comp
) ==
1323 BT_COMPONENT_CLASS_TYPE_SOURCE
) {
1324 struct trace_range
*range
;
1325 struct port_id port_id
= {
1326 .instance_name
= (char *) bt_component_get_name(upstream_comp
),
1327 .port_name
= (char *) bt_port_get_name(upstream_port
)
1330 if (!port_id
.instance_name
|| !port_id
.port_name
) {
1334 range
= (struct trace_range
*) g_hash_table_lookup(
1335 ctx
->intersections
, &port_id
);
1337 bt_value_map_insert_entry_status insert_status
;
1339 intersection_begin
= s_from_ns(
1340 range
->intersection_range_begin_ns
);
1341 intersection_end
= s_from_ns(
1342 range
->intersection_range_end_ns
);
1343 if (!intersection_begin
|| !intersection_end
) {
1344 BT_CLI_LOGE_APPEND_CAUSE(
1345 "Cannot create trimmer argument timestamp string.");
1349 insert_trimmer
= true;
1350 trimmer_params
= bt_value_map_create();
1351 if (!trimmer_params
) {
1355 insert_status
= bt_value_map_insert_string_entry(
1356 trimmer_params
, "begin", intersection_begin
);
1357 if (insert_status
< 0) {
1360 insert_status
= bt_value_map_insert_string_entry(
1362 "end", intersection_end
);
1363 if (insert_status
< 0) {
1368 trimmer_class
= find_filter_component_class("utils", "trimmer");
1369 if (!trimmer_class
) {
1374 BT_LOGI("Connecting upstream port to the next available downstream port: "
1375 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1376 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1377 upstream_port
, bt_port_get_name(upstream_port
),
1378 cfg_conn
->downstream_comp_name
->str
,
1379 cfg_conn
->arg
->str
);
1380 downstreamp_comp_name_quark
= g_quark_from_string(
1381 cfg_conn
->downstream_comp_name
->str
);
1382 BT_ASSERT(downstreamp_comp_name_quark
> 0);
1383 downstream_comp
= g_hash_table_lookup(ctx
->flt_components
,
1384 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1385 port_count_fn
= (input_port_count_func_t
)
1386 bt_component_filter_get_input_port_count
;
1387 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1388 bt_component_filter_borrow_input_port_by_index_const
;
1390 if (!downstream_comp
) {
1391 downstream_comp
= g_hash_table_lookup(ctx
->sink_components
,
1392 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1393 port_count_fn
= (input_port_count_func_t
)
1394 bt_component_sink_get_input_port_count
;
1395 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1396 bt_component_sink_borrow_input_port_by_index_const
;
1399 if (!downstream_comp
) {
1400 BT_CLI_LOGE_APPEND_CAUSE("Cannot find downstream component: "
1401 "comp-name=\"%s\", conn-arg=\"%s\"",
1402 cfg_conn
->downstream_comp_name
->str
,
1403 cfg_conn
->arg
->str
);
1407 downstream_port_count
= port_count_fn(downstream_comp
);
1409 for (i
= 0; i
< downstream_port_count
; i
++) {
1410 const bt_port_input
*in_downstream_port
=
1411 port_by_index_fn(downstream_comp
, i
);
1412 const bt_port
*downstream_port
=
1413 bt_port_input_as_port_const(in_downstream_port
);
1414 const char *upstream_port_name
;
1415 const char *downstream_port_name
;
1417 BT_ASSERT(downstream_port
);
1419 /* Skip port if it's already connected. */
1420 if (bt_port_is_connected(downstream_port
)) {
1421 BT_LOGI("Skipping downstream port: already connected: "
1422 "port-addr=%p, port-name=\"%s\"",
1424 bt_port_get_name(downstream_port
));
1428 downstream_port_name
= bt_port_get_name(downstream_port
);
1429 BT_ASSERT(downstream_port_name
);
1430 upstream_port_name
= bt_port_get_name(upstream_port
);
1431 BT_ASSERT(upstream_port_name
);
1433 if (!bt_common_star_glob_match(
1434 cfg_conn
->downstream_port_glob
->str
, SIZE_MAX
,
1435 downstream_port_name
, SIZE_MAX
)) {
1439 if (insert_trimmer
) {
1441 * In order to insert the trimmer between the
1442 * two components that were being connected, we
1443 * create a connection configuration entry which
1444 * describes a connection from the trimmer's
1445 * output to the original input that was being
1448 * Hence, the creation of the trimmer will cause
1449 * the graph "new port" listener to establish
1450 * all downstream connections as its output port
1451 * is connected. We will then establish the
1452 * connection between the original upstream
1453 * source and the trimmer.
1455 char *trimmer_name
= NULL
;
1456 bt_graph_add_component_status add_comp_status
;
1458 ret
= asprintf(&trimmer_name
,
1459 "stream-intersection-trimmer-%s",
1460 upstream_port_name
);
1466 ctx
->connect_ports
= false;
1467 add_comp_status
= bt_graph_add_filter_component(
1468 ctx
->graph
, trimmer_class
, trimmer_name
,
1469 trimmer_params
, ctx
->cfg
->log_level
,
1472 if (add_comp_status
!=
1473 BT_GRAPH_ADD_COMPONENT_STATUS_OK
) {
1479 bt_component_filter_borrow_input_port_by_index_const(
1481 if (!trimmer_input
) {
1485 bt_component_filter_borrow_output_port_by_index_const(
1487 if (!trimmer_output
) {
1492 * Replace the current downstream port by the trimmer's
1495 in_downstream_port
= trimmer_input
;
1497 bt_port_input_as_port_const(in_downstream_port
);
1498 downstream_port_name
= bt_port_get_name(
1500 BT_ASSERT(downstream_port_name
);
1503 /* We have a winner! */
1504 connect_ports_status
= bt_graph_connect_ports(ctx
->graph
,
1505 out_upstream_port
, in_downstream_port
, NULL
);
1506 downstream_port
= NULL
;
1507 switch (connect_ports_status
) {
1508 case BT_GRAPH_CONNECT_PORTS_STATUS_OK
:
1511 BT_CLI_LOGE_APPEND_CAUSE(
1512 "Cannot create connection: graph refuses to connect ports: "
1513 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1514 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1515 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1516 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1518 upstream_comp
, bt_component_get_name(upstream_comp
),
1519 upstream_port
, bt_port_get_name(upstream_port
),
1520 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1521 downstream_port
, downstream_port_name
,
1522 cfg_conn
->arg
->str
);
1526 BT_LOGI("Connected component ports: "
1527 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1528 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1529 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1530 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1532 upstream_comp
, bt_component_get_name(upstream_comp
),
1533 upstream_port
, bt_port_get_name(upstream_port
),
1534 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1535 downstream_port
, downstream_port_name
,
1536 cfg_conn
->arg
->str
);
1538 if (insert_trimmer
) {
1540 * The first connection, from the source to the trimmer,
1541 * has been done. We now connect the trimmer to the
1542 * original downstream port.
1544 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1546 bt_component_filter_as_component_const(trimmer
),
1547 trimmer_output
, cfg_conn
);
1551 ctx
->connect_ports
= true;
1555 * We found a matching downstream port: the search is
1561 /* No downstream port found */
1562 BT_CLI_LOGE_APPEND_CAUSE(
1563 "Cannot create connection: cannot find a matching downstream port for upstream port: "
1564 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1565 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1566 upstream_port
, bt_port_get_name(upstream_port
),
1567 cfg_conn
->downstream_comp_name
->str
,
1568 cfg_conn
->arg
->str
);
1574 free(intersection_begin
);
1575 free(intersection_end
);
1576 BT_VALUE_PUT_REF_AND_RESET(trimmer_params
);
1577 BT_COMPONENT_CLASS_FILTER_PUT_REF_AND_RESET(trimmer_class
);
1578 BT_COMPONENT_FILTER_PUT_REF_AND_RESET(trimmer
);
1583 int cmd_run_ctx_connect_upstream_port(struct cmd_run_ctx
*ctx
,
1584 const bt_port_output
*upstream_port
)
1587 const char *upstream_port_name
;
1588 const char *upstream_comp_name
;
1589 const bt_component
*upstream_comp
= NULL
;
1593 BT_ASSERT(upstream_port
);
1594 upstream_port_name
= bt_port_get_name(
1595 bt_port_output_as_port_const(upstream_port
));
1596 BT_ASSERT(upstream_port_name
);
1597 upstream_comp
= bt_port_borrow_component_const(
1598 bt_port_output_as_port_const(upstream_port
));
1599 BT_ASSERT(upstream_comp
);
1600 upstream_comp_name
= bt_component_get_name(upstream_comp
);
1601 BT_ASSERT(upstream_comp_name
);
1602 BT_LOGI("Connecting upstream port: comp-addr=%p, comp-name=\"%s\", "
1603 "port-addr=%p, port-name=\"%s\"",
1604 upstream_comp
, upstream_comp_name
,
1605 upstream_port
, upstream_port_name
);
1607 for (i
= 0; i
< ctx
->cfg
->cmd_data
.run
.connections
->len
; i
++) {
1608 struct bt_config_connection
*cfg_conn
=
1610 ctx
->cfg
->cmd_data
.run
.connections
, i
);
1612 if (strcmp(cfg_conn
->upstream_comp_name
->str
,
1613 upstream_comp_name
)) {
1617 if (!bt_common_star_glob_match(
1618 cfg_conn
->upstream_port_glob
->str
,
1619 SIZE_MAX
, upstream_port_name
, SIZE_MAX
)) {
1623 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1624 ctx
, upstream_comp
, upstream_port
, cfg_conn
);
1626 BT_CLI_LOGE_APPEND_CAUSE(
1627 "Cannot connect upstream port: "
1628 "port-addr=%p, port-name=\"%s\"",
1630 upstream_port_name
);
1636 BT_CLI_LOGE_APPEND_CAUSE(
1637 "Cannot connect upstream port: port does not match any connection argument: "
1638 "port-addr=%p, port-name=\"%s\"", upstream_port
,
1639 upstream_port_name
);
1649 bt_graph_listener_func_status
1650 graph_output_port_added_listener(struct cmd_run_ctx
*ctx
,
1651 const bt_port_output
*out_port
)
1653 const bt_component
*comp
;
1654 const bt_port
*port
= bt_port_output_as_port_const(out_port
);
1655 bt_graph_listener_func_status ret
=
1656 BT_GRAPH_LISTENER_FUNC_STATUS_OK
;
1658 comp
= bt_port_borrow_component_const(port
);
1659 BT_LOGI("Port added to a graph's component: comp-addr=%p, "
1660 "comp-name=\"%s\", port-addr=%p, port-name=\"%s\"",
1661 comp
, comp
? bt_component_get_name(comp
) : "",
1662 port
, bt_port_get_name(port
));
1664 if (!ctx
->connect_ports
) {
1670 if (bt_port_is_connected(port
)) {
1671 BT_LOGW_STR("Port is already connected.");
1675 if (cmd_run_ctx_connect_upstream_port(ctx
, out_port
)) {
1676 BT_CLI_LOGE_APPEND_CAUSE("Cannot connect upstream port.");
1677 ret
= BT_GRAPH_LISTENER_FUNC_STATUS_ERROR
;
1686 bt_graph_listener_func_status
graph_source_output_port_added_listener(
1687 const bt_component_source
*component
,
1688 const bt_port_output
*port
, void *data
)
1690 return graph_output_port_added_listener(data
, port
);
1694 bt_graph_listener_func_status
graph_filter_output_port_added_listener(
1695 const bt_component_filter
*component
,
1696 const bt_port_output
*port
, void *data
)
1698 return graph_output_port_added_listener(data
, port
);
1702 void cmd_run_ctx_destroy(struct cmd_run_ctx
*ctx
)
1708 if (ctx
->src_components
) {
1709 g_hash_table_destroy(ctx
->src_components
);
1710 ctx
->src_components
= NULL
;
1713 if (ctx
->flt_components
) {
1714 g_hash_table_destroy(ctx
->flt_components
);
1715 ctx
->flt_components
= NULL
;
1718 if (ctx
->sink_components
) {
1719 g_hash_table_destroy(ctx
->sink_components
);
1720 ctx
->sink_components
= NULL
;
1723 if (ctx
->intersections
) {
1724 g_hash_table_destroy(ctx
->intersections
);
1725 ctx
->intersections
= NULL
;
1728 BT_GRAPH_PUT_REF_AND_RESET(ctx
->graph
);
1733 int add_descriptor_to_component_descriptor_set(
1734 bt_component_descriptor_set
*comp_descr_set
,
1735 const char *plugin_name
, const char *comp_cls_name
,
1736 bt_component_class_type comp_cls_type
,
1737 const bt_value
*params
)
1739 const bt_component_class
*comp_cls
;
1742 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1745 BT_CLI_LOGE_APPEND_CAUSE(
1746 "Cannot find component class: plugin-name=\"%s\", "
1747 "comp-cls-name=\"%s\", comp-cls-type=%d",
1748 plugin_name
, comp_cls_name
, comp_cls_type
);
1753 status
= bt_component_descriptor_set_add_descriptor(
1754 comp_descr_set
, comp_cls
, params
);
1755 if (status
!= BT_COMPONENT_DESCRIPTOR_SET_ADD_DESCRIPTOR_STATUS_OK
) {
1756 BT_CLI_LOGE_APPEND_CAUSE(
1757 "Cannot append descriptor to component descriptor set: "
1758 "status=%s", bt_common_func_status_string(status
));
1763 bt_component_class_put_ref(comp_cls
);
1768 int append_descriptors_from_bt_config_component_array(
1769 bt_component_descriptor_set
*comp_descr_set
,
1770 GPtrArray
*component_configs
)
1775 for (i
= 0; i
< component_configs
->len
; i
++) {
1776 struct bt_config_component
*cfg_comp
=
1777 component_configs
->pdata
[i
];
1779 ret
= add_descriptor_to_component_descriptor_set(
1781 cfg_comp
->plugin_name
->str
,
1782 cfg_comp
->comp_cls_name
->str
,
1783 cfg_comp
->type
, cfg_comp
->params
);
1794 bt_get_greatest_operative_mip_version_status
get_greatest_operative_mip_version(
1795 struct bt_config
*cfg
, uint64_t *mip_version
)
1797 bt_get_greatest_operative_mip_version_status status
=
1798 BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_OK
;
1799 bt_component_descriptor_set
*comp_descr_set
= NULL
;
1803 BT_ASSERT(mip_version
);
1804 comp_descr_set
= bt_component_descriptor_set_create();
1805 if (!comp_descr_set
) {
1806 BT_CLI_LOGE_APPEND_CAUSE(
1807 "Failed to create a component descriptor set object.");
1808 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_MEMORY_ERROR
;
1812 ret
= append_descriptors_from_bt_config_component_array(
1813 comp_descr_set
, cfg
->cmd_data
.run
.sources
);
1815 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR
;
1819 ret
= append_descriptors_from_bt_config_component_array(
1820 comp_descr_set
, cfg
->cmd_data
.run
.filters
);
1822 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR
;
1826 ret
= append_descriptors_from_bt_config_component_array(
1827 comp_descr_set
, cfg
->cmd_data
.run
.sinks
);
1829 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR
;
1833 if (cfg
->cmd_data
.run
.stream_intersection_mode
) {
1835 * Stream intersection mode adds `flt.utils.trimmer`
1836 * components; we need to include this type of component
1837 * in the component descriptor set to get the real
1838 * greatest operative MIP version.
1840 ret
= add_descriptor_to_component_descriptor_set(
1841 comp_descr_set
, "utils", "trimmer",
1842 BT_COMPONENT_CLASS_TYPE_FILTER
, NULL
);
1844 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR
;
1849 status
= bt_get_greatest_operative_mip_version(comp_descr_set
,
1850 bt_cli_log_level
, mip_version
);
1853 bt_component_descriptor_set_put_ref(comp_descr_set
);
1858 int cmd_run_ctx_init(struct cmd_run_ctx
*ctx
, struct bt_config
*cfg
)
1861 bt_graph_add_listener_status add_listener_status
;
1862 bt_get_greatest_operative_mip_version_status mip_version_status
;
1863 uint64_t mip_version
= UINT64_C(-1);
1866 ctx
->connect_ports
= false;
1867 ctx
->src_components
= g_hash_table_new_full(g_direct_hash
,
1868 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
1869 if (!ctx
->src_components
) {
1873 ctx
->flt_components
= g_hash_table_new_full(g_direct_hash
,
1874 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
1875 if (!ctx
->flt_components
) {
1879 ctx
->sink_components
= g_hash_table_new_full(g_direct_hash
,
1880 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
1881 if (!ctx
->sink_components
) {
1885 if (cfg
->cmd_data
.run
.stream_intersection_mode
) {
1886 ctx
->stream_intersection_mode
= true;
1887 ctx
->intersections
= g_hash_table_new_full(port_id_hash
,
1888 port_id_equal
, port_id_destroy
, trace_range_destroy
);
1889 if (!ctx
->intersections
) {
1895 * Get the greatest operative MIP version to use to configure
1896 * the graph to create.
1898 mip_version_status
= get_greatest_operative_mip_version(
1900 if (mip_version_status
== BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_NO_MATCH
) {
1901 BT_CLI_LOGE_APPEND_CAUSE(
1902 "Failed to find an operative message interchange "
1903 "protocol version to use to create the `run` command's "
1904 "graph (components are not interoperable).");
1906 } else if (mip_version_status
< 0) {
1907 BT_CLI_LOGE_APPEND_CAUSE(
1908 "Cannot find an operative message interchange "
1909 "protocol version to use to create the `run` command's "
1911 bt_common_func_status_string(mip_version_status
));
1915 BT_ASSERT(mip_version_status
== BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_OK
);
1916 BT_LOGI("Found operative message interchange protocol version to "
1917 "configure the `run` command's graph: mip-version=%" PRIu64
,
1919 ctx
->graph
= bt_graph_create(mip_version
);
1924 bt_graph_add_interrupter(ctx
->graph
, the_interrupter
);
1925 add_listener_status
= bt_graph_add_source_component_output_port_added_listener(
1926 ctx
->graph
, graph_source_output_port_added_listener
, NULL
, ctx
,
1928 if (add_listener_status
!= BT_GRAPH_ADD_LISTENER_STATUS_OK
) {
1929 BT_CLI_LOGE_APPEND_CAUSE(
1930 "Cannot add \"port added\" listener to graph.");
1934 add_listener_status
= bt_graph_add_filter_component_output_port_added_listener(
1935 ctx
->graph
, graph_filter_output_port_added_listener
, NULL
, ctx
,
1937 if (add_listener_status
!= BT_GRAPH_ADD_LISTENER_STATUS_OK
) {
1938 BT_CLI_LOGE_APPEND_CAUSE(
1939 "Cannot add \"port added\" listener to graph.");
1946 cmd_run_ctx_destroy(ctx
);
1954 * Compute the intersection of all streams in the array `streams`, write it
1959 int compute_stream_intersection(const bt_value
*streams
,
1960 struct trace_range
*range
)
1962 uint64_t i
, stream_count
;
1965 BT_ASSERT(bt_value_get_type(streams
) == BT_VALUE_TYPE_ARRAY
);
1967 stream_count
= bt_value_array_get_length(streams
);
1969 BT_ASSERT(stream_count
> 0);
1971 range
->intersection_range_begin_ns
= 0;
1972 range
->intersection_range_end_ns
= UINT64_MAX
;
1974 for (i
= 0; i
< stream_count
; i
++) {
1975 int64_t begin_ns
, end_ns
;
1976 uint64_t begin_ns_u
, end_ns_u
;
1977 const bt_value
*stream_value
;
1978 const bt_value
*range_ns_value
;
1979 const bt_value
*begin_value
;
1980 const bt_value
*end_value
;
1982 stream_value
= bt_value_array_borrow_element_by_index_const(streams
, i
);
1983 if (bt_value_get_type(stream_value
) != BT_VALUE_TYPE_MAP
) {
1984 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
1985 "expected streams array element to be a map, got %s.",
1986 bt_common_value_type_string(bt_value_get_type(stream_value
)));
1990 range_ns_value
= bt_value_map_borrow_entry_value_const(
1991 stream_value
, "range-ns");
1992 if (!range_ns_value
) {
1993 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
1994 "missing expected `range-ns` key in stream map.");
1998 if (bt_value_get_type(range_ns_value
) != BT_VALUE_TYPE_MAP
) {
1999 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2000 "expected `range-ns` entry value of stream map to be a map, got %s.",
2001 bt_common_value_type_string(bt_value_get_type(range_ns_value
)));
2005 begin_value
= bt_value_map_borrow_entry_value_const(range_ns_value
, "begin");
2007 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2008 "missing expected `begin` key in range-ns map.");
2012 if (bt_value_get_type(begin_value
) != BT_VALUE_TYPE_SIGNED_INTEGER
) {
2013 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2014 "expected `begin` entry value of range-ns map to be a signed integer, got %s.",
2015 bt_common_value_type_string(bt_value_get_type(range_ns_value
)));
2019 end_value
= bt_value_map_borrow_entry_value_const(range_ns_value
, "end");
2021 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2022 "missing expected `end` key in range-ns map.");
2026 if (bt_value_get_type(end_value
) != BT_VALUE_TYPE_SIGNED_INTEGER
) {
2027 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2028 "expected `end` entry value of range-ns map to be a signed integer, got %s.",
2029 bt_common_value_type_string(bt_value_get_type(range_ns_value
)));
2033 begin_ns
= bt_value_integer_signed_get(begin_value
);
2034 end_ns
= bt_value_integer_signed_get(end_value
);
2036 if (begin_ns
< 0 || end_ns
< 0 || end_ns
< begin_ns
) {
2037 BT_CLI_LOGE_APPEND_CAUSE(
2038 "Invalid stream range values: "
2039 "range-ns:begin=%" PRId64
", "
2040 "range-ns:end=%" PRId64
,
2045 begin_ns_u
= begin_ns
;
2048 range
->intersection_range_begin_ns
=
2049 MAX(range
->intersection_range_begin_ns
, begin_ns_u
);
2050 range
->intersection_range_end_ns
=
2051 MIN(range
->intersection_range_end_ns
, end_ns_u
);
2064 int set_stream_intersections(struct cmd_run_ctx
*ctx
,
2065 struct bt_config_component
*cfg_comp
,
2066 const bt_component_class_source
*src_comp_cls
)
2070 uint64_t trace_count
;
2071 const bt_value
*query_result
= NULL
;
2072 const bt_value
*trace_info
= NULL
;
2073 const bt_value
*stream_infos
= NULL
;
2074 const bt_value
*stream_info
= NULL
;
2075 struct port_id
*port_id
= NULL
;
2076 struct trace_range
*stream_intersection
= NULL
;
2077 const char *fail_reason
= NULL
;
2078 const bt_component_class
*comp_cls
=
2079 bt_component_class_source_as_component_class_const(src_comp_cls
);
2081 ret
= query(ctx
->cfg
, comp_cls
, "babeltrace.trace-infos",
2082 cfg_comp
->params
, &query_result
,
2085 BT_CLI_LOGE_APPEND_CAUSE("Failed to execute `babeltrace.trace-infos` query: %s: "
2086 "comp-class-name=\"%s\"", fail_reason
,
2087 bt_component_class_get_name(comp_cls
));
2092 BT_ASSERT(query_result
);
2094 if (!bt_value_is_array(query_result
)) {
2095 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting result to be an array: "
2096 "component-class-name=%s, actual-type=%s",
2097 bt_component_class_get_name(comp_cls
),
2098 bt_common_value_type_string(bt_value_get_type(query_result
)));
2103 trace_count
= bt_value_array_get_length(query_result
);
2104 if (trace_count
== 0) {
2105 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: result is empty: "
2106 "component-class-name=%s", bt_component_class_get_name(comp_cls
));
2111 for (trace_idx
= 0; trace_idx
< trace_count
; trace_idx
++) {
2112 uint64_t stream_idx
;
2113 int64_t stream_count
;
2114 struct trace_range trace_intersection
;
2116 trace_info
= bt_value_array_borrow_element_by_index_const(
2117 query_result
, trace_idx
);
2118 if (!bt_value_is_map(trace_info
)) {
2120 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting element to be a map: "
2121 "component-class-name=%s, actual-type=%s",
2122 bt_component_class_get_name(comp_cls
),
2123 bt_common_value_type_string(bt_value_get_type(trace_info
)));
2127 stream_infos
= bt_value_map_borrow_entry_value_const(
2128 trace_info
, "stream-infos");
2129 if (!stream_infos
) {
2131 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: missing `streams` key in trace info map: "
2132 "component-class-name=%s",
2133 bt_component_class_get_name(comp_cls
));
2137 if (!bt_value_is_array(stream_infos
)) {
2139 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting `streams` entry of trace info map to be an array: "
2140 "component-class-name=%s, actual-type=%s",
2141 bt_component_class_get_name(comp_cls
),
2142 bt_common_value_type_string(bt_value_get_type(stream_infos
)));
2146 stream_count
= bt_value_array_get_length(stream_infos
);
2147 if (stream_count
== 0) {
2149 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: list of streams is empty: "
2150 "component-class-name=%s",
2151 bt_component_class_get_name(comp_cls
));
2155 ret
= compute_stream_intersection(stream_infos
, &trace_intersection
);
2157 BT_CLI_LOGE_APPEND_CAUSE("Failed to compute trace streams intersection.");
2161 for (stream_idx
= 0; stream_idx
< stream_count
; stream_idx
++) {
2162 const bt_value
*port_name
;
2164 port_id
= g_new0(struct port_id
, 1);
2167 BT_CLI_LOGE_APPEND_CAUSE(
2168 "Cannot allocate memory for port_id structure.");
2171 port_id
->instance_name
= strdup(cfg_comp
->instance_name
->str
);
2172 if (!port_id
->instance_name
) {
2174 BT_CLI_LOGE_APPEND_CAUSE(
2175 "Cannot allocate memory for port_id component instance name.");
2179 stream_intersection
= g_new0(struct trace_range
, 1);
2180 if (!stream_intersection
) {
2182 BT_CLI_LOGE_APPEND_CAUSE(
2183 "Cannot allocate memory for trace_range structure.");
2187 *stream_intersection
= trace_intersection
;
2189 stream_info
= bt_value_array_borrow_element_by_index_const(
2190 stream_infos
, stream_idx
);
2191 if (!bt_value_is_map(stream_info
)) {
2193 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: "
2194 "expecting element of stream list to be a map: "
2195 "component-class-name=%s, actual-type=%s",
2196 bt_component_class_get_name(comp_cls
),
2197 bt_common_value_type_string(bt_value_get_type(stream_info
)));
2201 port_name
= bt_value_map_borrow_entry_value_const(stream_info
, "port-name");
2204 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: "
2205 "missing `port-name` key in stream info map: "
2206 "component-class-name=%s",
2207 bt_component_class_get_name(comp_cls
));
2211 if (!bt_value_is_string(port_name
)) {
2213 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: "
2214 "expecting `port-name` entry of stream info map to be a string: "
2215 "component-class-name=%s, actual-type=%s",
2216 bt_component_class_get_name(comp_cls
),
2217 bt_common_value_type_string(bt_value_get_type(port_name
)));
2221 port_id
->port_name
= g_strdup(bt_value_string_get(port_name
));
2222 if (!port_id
->port_name
) {
2224 BT_CLI_LOGE_APPEND_CAUSE(
2225 "Cannot allocate memory for port_id port_name.");
2229 BT_LOGD("Inserting stream intersection ");
2231 g_hash_table_insert(ctx
->intersections
, port_id
, stream_intersection
);
2234 stream_intersection
= NULL
;
2241 bt_value_put_ref(query_result
);
2243 g_free(stream_intersection
);
2248 int cmd_run_ctx_create_components_from_config_components(
2249 struct cmd_run_ctx
*ctx
, GPtrArray
*cfg_components
)
2252 const void *comp_cls
= NULL
;
2253 const void *comp
= NULL
;
2256 for (i
= 0; i
< cfg_components
->len
; i
++) {
2257 struct bt_config_component
*cfg_comp
=
2258 g_ptr_array_index(cfg_components
, i
);
2261 switch (cfg_comp
->type
) {
2262 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2263 comp_cls
= find_source_component_class(
2264 cfg_comp
->plugin_name
->str
,
2265 cfg_comp
->comp_cls_name
->str
);
2267 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2268 comp_cls
= find_filter_component_class(
2269 cfg_comp
->plugin_name
->str
,
2270 cfg_comp
->comp_cls_name
->str
);
2272 case BT_COMPONENT_CLASS_TYPE_SINK
:
2273 comp_cls
= find_sink_component_class(
2274 cfg_comp
->plugin_name
->str
,
2275 cfg_comp
->comp_cls_name
->str
);
2282 BT_CLI_LOGE_APPEND_CAUSE(
2283 "Cannot find component class: plugin-name=\"%s\", "
2284 "comp-cls-name=\"%s\", comp-cls-type=%d",
2285 cfg_comp
->plugin_name
->str
,
2286 cfg_comp
->comp_cls_name
->str
,
2291 BT_ASSERT(cfg_comp
->log_level
>= BT_LOG_TRACE
);
2293 switch (cfg_comp
->type
) {
2294 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2295 ret
= bt_graph_add_source_component(ctx
->graph
,
2296 comp_cls
, cfg_comp
->instance_name
->str
,
2297 cfg_comp
->params
, cfg_comp
->log_level
,
2300 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2301 ret
= bt_graph_add_filter_component(ctx
->graph
,
2302 comp_cls
, cfg_comp
->instance_name
->str
,
2303 cfg_comp
->params
, cfg_comp
->log_level
,
2306 case BT_COMPONENT_CLASS_TYPE_SINK
:
2307 ret
= bt_graph_add_sink_component(ctx
->graph
,
2308 comp_cls
, cfg_comp
->instance_name
->str
,
2309 cfg_comp
->params
, cfg_comp
->log_level
,
2317 BT_CLI_LOGE_APPEND_CAUSE(
2318 "Cannot create component: plugin-name=\"%s\", "
2319 "comp-cls-name=\"%s\", comp-cls-type=%d, "
2321 cfg_comp
->plugin_name
->str
,
2322 cfg_comp
->comp_cls_name
->str
,
2323 cfg_comp
->type
, cfg_comp
->instance_name
->str
);
2327 if (ctx
->stream_intersection_mode
&&
2328 cfg_comp
->type
== BT_COMPONENT_CLASS_TYPE_SOURCE
) {
2329 ret
= set_stream_intersections(ctx
, cfg_comp
, comp_cls
);
2331 BT_CLI_LOGE_APPEND_CAUSE(
2332 "Cannot determine stream intersection of trace.");
2337 BT_LOGI("Created and inserted component: comp-addr=%p, comp-name=\"%s\"",
2338 comp
, cfg_comp
->instance_name
->str
);
2339 quark
= g_quark_from_string(cfg_comp
->instance_name
->str
);
2340 BT_ASSERT(quark
> 0);
2342 switch (cfg_comp
->type
) {
2343 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2344 g_hash_table_insert(ctx
->src_components
,
2345 GUINT_TO_POINTER(quark
), (void *) comp
);
2347 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2348 g_hash_table_insert(ctx
->flt_components
,
2349 GUINT_TO_POINTER(quark
), (void *) comp
);
2351 case BT_COMPONENT_CLASS_TYPE_SINK
:
2352 g_hash_table_insert(ctx
->sink_components
,
2353 GUINT_TO_POINTER(quark
), (void *) comp
);
2360 BT_OBJECT_PUT_REF_AND_RESET(comp_cls
);
2369 bt_object_put_ref(comp
);
2370 bt_object_put_ref(comp_cls
);
2375 int cmd_run_ctx_create_components(struct cmd_run_ctx
*ctx
)
2380 * Make sure that, during this phase, our graph's "port added"
2381 * listener does not connect ports while we are creating the
2382 * components because we have a special, initial phase for
2385 ctx
->connect_ports
= false;
2387 ret
= cmd_run_ctx_create_components_from_config_components(
2388 ctx
, ctx
->cfg
->cmd_data
.run
.sources
);
2394 ret
= cmd_run_ctx_create_components_from_config_components(
2395 ctx
, ctx
->cfg
->cmd_data
.run
.filters
);
2401 ret
= cmd_run_ctx_create_components_from_config_components(
2402 ctx
, ctx
->cfg
->cmd_data
.run
.sinks
);
2412 typedef uint64_t (*output_port_count_func_t
)(const void *);
2413 typedef const bt_port_output
*(*borrow_output_port_by_index_func_t
)(
2414 const void *, uint64_t);
2417 int cmd_run_ctx_connect_comp_ports(struct cmd_run_ctx
*ctx
,
2418 void *comp
, output_port_count_func_t port_count_fn
,
2419 borrow_output_port_by_index_func_t port_by_index_fn
)
2425 count
= port_count_fn(comp
);
2427 for (i
= 0; i
< count
; i
++) {
2428 const bt_port_output
*upstream_port
= port_by_index_fn(comp
, i
);
2430 BT_ASSERT(upstream_port
);
2431 ret
= cmd_run_ctx_connect_upstream_port(ctx
, upstream_port
);
2442 int cmd_run_ctx_connect_ports(struct cmd_run_ctx
*ctx
)
2445 GHashTableIter iter
;
2446 gpointer g_name_quark
, g_comp
;
2448 ctx
->connect_ports
= true;
2449 g_hash_table_iter_init(&iter
, ctx
->src_components
);
2451 while (g_hash_table_iter_next(&iter
, &g_name_quark
, &g_comp
)) {
2452 ret
= cmd_run_ctx_connect_comp_ports(ctx
, g_comp
,
2453 (output_port_count_func_t
)
2454 bt_component_source_get_output_port_count
,
2455 (borrow_output_port_by_index_func_t
)
2456 bt_component_source_borrow_output_port_by_index_const
);
2462 g_hash_table_iter_init(&iter
, ctx
->flt_components
);
2464 while (g_hash_table_iter_next(&iter
, &g_name_quark
, &g_comp
)) {
2465 ret
= cmd_run_ctx_connect_comp_ports(ctx
, g_comp
,
2466 (output_port_count_func_t
)
2467 bt_component_filter_get_output_port_count
,
2468 (borrow_output_port_by_index_func_t
)
2469 bt_component_filter_borrow_output_port_by_index_const
);
2480 int cmd_run(struct bt_config
*cfg
)
2483 struct cmd_run_ctx ctx
= { 0 };
2485 /* Initialize the command's context and the graph object */
2486 if (cmd_run_ctx_init(&ctx
, cfg
)) {
2487 BT_CLI_LOGE_APPEND_CAUSE(
2488 "Cannot initialize the command's context.");
2492 if (bt_interrupter_is_set(the_interrupter
)) {
2493 BT_CLI_LOGW_APPEND_CAUSE(
2494 "Interrupted by user before creating components.");
2498 BT_LOGI_STR("Creating components.");
2500 /* Create the requested component instances */
2501 if (cmd_run_ctx_create_components(&ctx
)) {
2502 BT_CLI_LOGE_APPEND_CAUSE("Cannot create components.");
2506 if (bt_interrupter_is_set(the_interrupter
)) {
2507 BT_CLI_LOGW_APPEND_CAUSE(
2508 "Interrupted by user before connecting components.");
2512 BT_LOGI_STR("Connecting components.");
2514 /* Connect the initially visible component ports */
2515 if (cmd_run_ctx_connect_ports(&ctx
)) {
2516 BT_CLI_LOGE_APPEND_CAUSE(
2517 "Cannot connect initial component ports.");
2521 BT_LOGI_STR("Running the graph.");
2525 bt_graph_run_status run_status
= bt_graph_run(ctx
.graph
);
2528 * Reset console in case something messed with console
2529 * codes during the graph's execution.
2531 printf("%s", bt_common_color_reset());
2533 fprintf(stderr
, "%s", bt_common_color_reset());
2534 BT_LOGT("bt_graph_run() returned: status=%s",
2535 bt_common_func_status_string(run_status
));
2537 switch (run_status
) {
2538 case BT_GRAPH_RUN_STATUS_OK
:
2540 case BT_GRAPH_RUN_STATUS_AGAIN
:
2541 if (bt_interrupter_is_set(the_interrupter
)) {
2542 BT_CLI_LOGW_APPEND_CAUSE(
2543 "Graph was interrupted by user.");
2547 if (cfg
->cmd_data
.run
.retry_duration_us
> 0) {
2548 BT_LOGT("Got BT_GRAPH_RUN_STATUS_AGAIN: sleeping: "
2550 cfg
->cmd_data
.run
.retry_duration_us
);
2552 if (usleep(cfg
->cmd_data
.run
.retry_duration_us
)) {
2553 if (bt_interrupter_is_set(the_interrupter
)) {
2554 BT_CLI_LOGW_APPEND_CAUSE(
2555 "Graph was interrupted by user.");
2562 if (bt_interrupter_is_set(the_interrupter
)) {
2563 BT_CLI_LOGW_APPEND_CAUSE(
2564 "Graph was interrupted by user and failed: "
2566 bt_common_func_status_string(run_status
));
2570 BT_CLI_LOGE_APPEND_CAUSE(
2571 "Graph failed to complete successfully");
2584 cmd_run_ctx_destroy(&ctx
);
2589 void warn_command_name_and_directory_clash(struct bt_config
*cfg
)
2591 const char *env_clash
;
2593 if (!cfg
->command_name
) {
2597 env_clash
= getenv(ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH
);
2598 if (env_clash
&& strcmp(env_clash
, "0") == 0) {
2602 if (g_file_test(cfg
->command_name
,
2603 G_FILE_TEST_EXISTS
| G_FILE_TEST_IS_DIR
)) {
2604 _bt_log_write_d(_BT_LOG_SRCLOC_FUNCTION
, __FILE__
, __LINE__
,
2605 BT_LOG_WARNING
, BT_LOG_TAG
,
2606 "The `%s` command was executed. "
2607 "If you meant to convert a trace located in "
2608 "the local `%s` directory, please use:\n\n"
2609 " babeltrace2 convert %s [OPTIONS]",
2610 cfg
->command_name
, cfg
->command_name
,
2616 void init_log_level(void)
2618 bt_cli_log_level
= bt_log_get_level_from_env(ENV_BABELTRACE_CLI_LOG_LEVEL
);
2622 void print_error_causes(void)
2624 const bt_error
*error
= bt_current_thread_take_error();
2626 GString
*folded
= NULL
;
2627 unsigned int columns
;
2629 if (!error
|| bt_error_get_cause_count(error
) == 0) {
2630 fprintf(stderr
, "%s%sUnknown command-line error.%s\n",
2631 bt_common_color_bold(), bt_common_color_fg_red(),
2632 bt_common_color_reset());
2636 /* Try to get terminal width to fold the error cause messages */
2637 if (bt_common_get_term_size(&columns
, NULL
) < 0) {
2638 /* Width not found: default to 80 */
2643 * This helps visually separate the error causes from the last
2644 * logging statement.
2646 fprintf(stderr
, "\n");
2648 /* Reverse order: deepest (root) cause printed at the end */
2649 for (i
= bt_error_get_cause_count(error
) - 1; i
>= 0; i
--) {
2650 const bt_error_cause
*cause
=
2651 bt_error_borrow_cause_by_index(error
, (uint64_t) i
);
2652 const char *prefix_fmt
=
2653 i
== bt_error_get_cause_count(error
) - 1 ?
2654 "%s%sERROR%s: " : "%s%sCAUSED BY%s ";
2657 fprintf(stderr
, prefix_fmt
,
2658 bt_common_color_bold(), bt_common_color_fg_red(),
2659 bt_common_color_reset());
2661 /* Print actor name */
2662 fprintf(stderr
, "[");
2663 switch (bt_error_cause_get_actor_type(cause
)) {
2664 case BT_ERROR_CAUSE_ACTOR_TYPE_UNKNOWN
:
2665 fprintf(stderr
, "%s%s%s",
2666 bt_common_color_bold(),
2667 bt_error_cause_get_module_name(cause
),
2668 bt_common_color_reset());
2670 case BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT
:
2671 fprintf(stderr
, "%s%s%s: ",
2672 bt_common_color_bold(),
2673 bt_error_cause_component_actor_get_component_name(cause
),
2674 bt_common_color_reset());
2675 print_plugin_comp_cls_opt(stderr
,
2676 bt_error_cause_component_actor_get_plugin_name(cause
),
2677 bt_error_cause_component_actor_get_component_class_name(cause
),
2678 bt_error_cause_component_actor_get_component_class_type(cause
));
2680 case BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT_CLASS
:
2681 print_plugin_comp_cls_opt(stderr
,
2682 bt_error_cause_component_class_actor_get_plugin_name(cause
),
2683 bt_error_cause_component_class_actor_get_component_class_name(cause
),
2684 bt_error_cause_component_class_actor_get_component_class_type(cause
));
2686 case BT_ERROR_CAUSE_ACTOR_TYPE_MESSAGE_ITERATOR
:
2687 fprintf(stderr
, "%s%s%s (%s%s%s): ",
2688 bt_common_color_bold(),
2689 bt_error_cause_message_iterator_actor_get_component_name(cause
),
2690 bt_common_color_reset(),
2691 bt_common_color_bold(),
2692 bt_error_cause_message_iterator_actor_get_component_output_port_name(cause
),
2693 bt_common_color_reset());
2694 print_plugin_comp_cls_opt(stderr
,
2695 bt_error_cause_message_iterator_actor_get_plugin_name(cause
),
2696 bt_error_cause_message_iterator_actor_get_component_class_name(cause
),
2697 bt_error_cause_message_iterator_actor_get_component_class_type(cause
));
2703 /* Print file name and line number */
2704 fprintf(stderr
, "] (%s%s%s%s:%s%" PRIu64
"%s)\n",
2705 bt_common_color_bold(),
2706 bt_common_color_fg_magenta(),
2707 bt_error_cause_get_file_name(cause
),
2708 bt_common_color_reset(),
2709 bt_common_color_fg_green(),
2710 bt_error_cause_get_line_number(cause
),
2711 bt_common_color_reset());
2714 folded
= bt_common_fold(bt_error_cause_get_message(cause
),
2717 BT_LOGE_STR("Could not fold string.");
2718 fprintf(stderr
, "%s\n",
2719 bt_error_cause_get_message(cause
));
2723 fprintf(stderr
, "%s\n", folded
->str
);
2724 g_string_free(folded
, TRUE
);
2732 bt_error_release(error
);
2736 int main(int argc
, const char **argv
)
2740 struct bt_config
*cfg
= NULL
;
2743 set_signal_handler();
2744 init_loaded_plugins();
2746 BT_ASSERT(!the_interrupter
);
2747 the_interrupter
= bt_interrupter_create();
2748 if (!the_interrupter
) {
2749 BT_CLI_LOGE_APPEND_CAUSE("Failed to create an interrupter object.");
2754 cfg
= bt_config_cli_args_create_with_default(argc
, argv
, &retcode
,
2758 /* Quit without errors; typically usage/version */
2760 BT_LOGI_STR("Quitting without errors.");
2765 BT_CLI_LOGE_APPEND_CAUSE(
2766 "Command-line error: retcode=%d", retcode
);
2771 BT_CLI_LOGE_APPEND_CAUSE(
2772 "Failed to create a valid Babeltrace CLI configuration.");
2779 if (cfg
->command_needs_plugins
) {
2780 ret
= require_loaded_plugins(cfg
->plugin_paths
);
2782 BT_CLI_LOGE_APPEND_CAUSE(
2783 "Failed to load plugins: ret=%d", ret
);
2789 BT_LOGI("Executing command: cmd=%d, command-name=\"%s\"",
2790 cfg
->command
, cfg
->command_name
);
2792 switch (cfg
->command
) {
2793 case BT_CONFIG_COMMAND_RUN
:
2796 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
2797 ret
= cmd_list_plugins(cfg
);
2799 case BT_CONFIG_COMMAND_HELP
:
2800 ret
= cmd_help(cfg
);
2802 case BT_CONFIG_COMMAND_QUERY
:
2803 ret
= cmd_query(cfg
);
2805 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
2806 ret
= cmd_print_ctf_metadata(cfg
);
2808 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
2809 ret
= cmd_print_lttng_live_sessions(cfg
);
2812 BT_LOGF("Invalid/unknown command: cmd=%d", cfg
->command
);
2816 BT_LOGI("Command completed: cmd=%d, command-name=\"%s\", ret=%d",
2817 cfg
->command
, cfg
->command_name
, ret
);
2818 warn_command_name_and_directory_clash(cfg
);
2819 retcode
= ret
? 1 : 0;
2822 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
2823 fini_loaded_plugins();
2824 bt_interrupter_put_ref(the_interrupter
);
2827 print_error_causes();
2831 * Clear current thread's error in case there is one to avoid a
2834 bt_current_thread_clear_error();