babeltrace(1): escape '.' in PLUGIN.COMPCLS arguments
[babeltrace.git] / converter / babeltrace.c
index 928f623b478d9d07806dfb295a2bb42c08407812..1abda5c31550fffde5f91a335d13dfc9222325a5 100644 (file)
@@ -34,6 +34,9 @@
 #include <babeltrace/component/component-sink.h>
 #include <babeltrace/component/component-filter.h>
 #include <babeltrace/component/component-class.h>
+#include <babeltrace/component/port.h>
+#include <babeltrace/component/graph.h>
+#include <babeltrace/component/connection.h>
 #include <babeltrace/component/notification/iterator.h>
 #include <babeltrace/ref.h>
 #include <babeltrace/values.h>
@@ -109,9 +112,100 @@ void print_indent(size_t indent)
        }
 }
 
+static char *escape_name_for_shell(const char *input)
+{
+       char *output = g_malloc0(strlen(input) * 5 + 1);
+       const char *in;
+       char *out = output;
+
+       if (!output) {
+               goto end;
+       }
+
+       for (in = input; *in != '\0'; in++) {
+               switch (*in) {
+               case '\\':
+                       *out++ = '\\';
+                       *out++ = '\\';
+                       break;
+               case '\'':
+                       *out++ = '\'';
+                       *out++ = '"';
+                       *out++ = '\'';
+                       *out++ = '"';
+                       *out++ = '\'';
+                       break;
+               case '.':
+                       *out++ = '\\';
+                       *out++ = '.';
+                       break;
+               default:
+                       *out++ = *in;
+                       break;
+               }
+       }
+
+end:
+       return output;
+}
+
+static
+const char *component_type_str(enum bt_component_class_type type)
+{
+       switch (type) {
+       case BT_COMPONENT_CLASS_TYPE_SOURCE:
+               return "source";
+       case BT_COMPONENT_CLASS_TYPE_SINK:
+               return "sink";
+       case BT_COMPONENT_CLASS_TYPE_FILTER:
+               return "filter";
+       case BT_COMPONENT_CLASS_TYPE_UNKNOWN:
+       default:
+               return "unknown";
+       }
+}
+
+static void print_plugin_comp_cls_opt(FILE *fh, const char *plugin_name,
+               const char *comp_cls_name, enum bt_component_class_type type)
+{
+       char *shell_plugin_name = NULL;
+       char *shell_comp_cls_name = NULL;
+
+       shell_plugin_name = escape_name_for_shell(plugin_name);
+       if (!shell_plugin_name) {
+               goto end;
+       }
+
+       shell_comp_cls_name = escape_name_for_shell(comp_cls_name);
+       if (!shell_comp_cls_name) {
+               goto end;
+       }
+
+       fprintf(fh, "%s%s--%s%s %s'%s%s%s%s.%s%s%s'",
+               bt_common_color_bold(),
+               bt_common_color_fg_cyan(),
+               component_type_str(type),
+               bt_common_color_reset(),
+               bt_common_color_fg_default(),
+               bt_common_color_bold(),
+               bt_common_color_fg_blue(),
+               shell_plugin_name,
+               bt_common_color_fg_default(),
+               bt_common_color_fg_yellow(),
+               shell_comp_cls_name,
+               bt_common_color_reset());
+
+end:
+       g_free(shell_plugin_name);
+       g_free(shell_comp_cls_name);
+}
+
 static
 void print_value(struct bt_value *, size_t);
 
+static
+void print_value_rec(struct bt_value *, size_t);
+
 static
 bool print_map_value(const char *key, struct bt_value *object, void *data)
 {
@@ -137,12 +231,12 @@ bool print_map_value(const char *key, struct bt_value *object, void *data)
                printf("\n");
        }
 
-       print_value(object, *indent + 2);
+       print_value_rec(object, *indent + 2);
        return true;
 }
 
 static
-void print_value(struct bt_value *value, size_t indent)
+void print_value_rec(struct bt_value *value, size_t indent)
 {
        bool bool_val;
        int64_t int_val;
@@ -157,23 +251,32 @@ void print_value(struct bt_value *value, size_t indent)
 
        switch (bt_value_get_type(value)) {
        case BT_VALUE_TYPE_NULL:
-               printf("null\n");
+               printf("%snull%s\n", bt_common_color_bold(),
+                       bt_common_color_reset());
                break;
        case BT_VALUE_TYPE_BOOL:
                bt_value_bool_get(value, &bool_val);
-               printf("%s\n", bool_val ? "yes" : "no");
+               printf("%s%s%s%s\n", bt_common_color_bold(),
+                       bt_common_color_fg_cyan(), bool_val ? "yes" : "no",
+                       bt_common_color_reset());
                break;
        case BT_VALUE_TYPE_INTEGER:
                bt_value_integer_get(value, &int_val);
-               printf("%" PRId64 "\n", int_val);
+               printf("%s%s%" PRId64 "%s\n", bt_common_color_bold(),
+                       bt_common_color_fg_red(), int_val,
+                       bt_common_color_reset());
                break;
        case BT_VALUE_TYPE_FLOAT:
                bt_value_float_get(value, &dbl_val);
-               printf("%lf\n", dbl_val);
+               printf("%s%s%lf%s\n", bt_common_color_bold(),
+                       bt_common_color_fg_red(), dbl_val,
+                       bt_common_color_reset());
                break;
        case BT_VALUE_TYPE_STRING:
                bt_value_string_get(value, &str_val);
-               printf("%s\n", str_val);
+               printf("%s%s%s%s\n", bt_common_color_bold(),
+                       bt_common_color_fg_green(), str_val,
+                       bt_common_color_reset());
                break;
        case BT_VALUE_TYPE_ARRAY:
                size = bt_value_array_size(value);
@@ -210,7 +313,7 @@ void print_value(struct bt_value *value, size_t indent)
                                printf("\n");
                        }
 
-                       print_value(element, indent + 2);
+                       print_value_rec(element, indent + 2);
                        BT_PUT(element);
                }
                break;
@@ -228,11 +331,24 @@ void print_value(struct bt_value *value, size_t indent)
        }
 }
 
+static
+void print_value(struct bt_value *value, size_t indent)
+{
+       if (!bt_value_is_array(value) && !bt_value_is_map(value)) {
+               print_indent(indent);
+       }
+
+       print_value_rec(value, indent);
+}
+
 static
 void print_bt_config_component(struct bt_config_component *bt_config_component)
 {
-       printf("    %s.%s:\n", bt_config_component->plugin_name->str,
-               bt_config_component->component_name->str);
+       printf("    ");
+       print_plugin_comp_cls_opt(stdout, bt_config_component->plugin_name->str,
+               bt_config_component->component_name->str,
+               bt_config_component->type);
+       printf(":\n");
 
        if (bt_config_component->instance_name->len > 0) {
                printf("      Name: %s\n",
@@ -271,6 +387,8 @@ void print_cfg_convert(struct bt_config *cfg)
        printf("  Force correlate: %s\n",
                cfg->cmd_data.convert.force_correlate ? "yes" : "no");
        print_plugin_paths(cfg->cmd_data.convert.plugin_paths);
+       printf("  Print CTF metadata: %s\n",
+               cfg->cmd_data.convert.print_ctf_metadata ? "yes" : "no");
        printf("  Source component instances:\n");
        print_bt_config_components(cfg->cmd_data.convert.sources);
 
@@ -304,6 +422,21 @@ void print_cfg_list_plugins(struct bt_config *cfg)
        print_plugin_paths(cfg->cmd_data.list_plugins.plugin_paths);
 }
 
+static
+void print_cfg_help(struct bt_config *cfg)
+{
+       print_plugin_paths(cfg->cmd_data.help.plugin_paths);
+}
+
+static
+void print_cfg_query(struct bt_config *cfg)
+{
+       print_plugin_paths(cfg->cmd_data.query.plugin_paths);
+       printf("  Object: `%s`\n", cfg->cmd_data.query.object->str);
+       printf("  Component class:\n");
+       print_bt_config_component(cfg->cmd_data.query.cfg_component);
+}
+
 static
 void print_cfg(struct bt_config *cfg)
 {
@@ -322,6 +455,12 @@ void print_cfg(struct bt_config *cfg)
        case BT_CONFIG_COMMAND_LIST_PLUGINS:
                print_cfg_list_plugins(cfg);
                break;
+       case BT_CONFIG_COMMAND_HELP:
+               print_cfg_help(cfg);
+               break;
+       case BT_CONFIG_COMMAND_QUERY:
+               print_cfg_query(cfg);
+               break;
        default:
                assert(false);
        }
@@ -392,28 +531,35 @@ end:
 }
 
 static
-int connect_source_sink(struct bt_component *source,
+int connect_source_sink(struct bt_graph *graph,
+               struct bt_component *source,
                struct bt_config_component *source_cfg,
                struct bt_component *sink)
 {
        int ret = 0;
-       enum bt_component_status sink_status;
+       struct bt_connection *connection = NULL;
        struct bt_component *trimmer = NULL;
-       struct bt_notification_iterator *source_it = NULL;
-       struct bt_notification_iterator *to_sink_it = NULL;
-
-       source_it = bt_component_source_create_notification_iterator(source);
-       if (!source_it) {
-               fprintf(stderr, "Failed to instantiate source iterator. Aborting...\n");
-                ret = -1;
-                goto end;
-        }
+       struct bt_port *source_port =
+                       bt_component_source_get_default_output_port(source);
+       struct bt_port *sink_port =
+                       bt_component_sink_get_default_input_port(sink);
+       struct bt_port *to_sink_port = NULL;
+       struct bt_port *trimmer_input_port = NULL;
+
+       if (!source_port) {
+               fprintf(stderr, "Failed to find default source output port. Aborting...\n");
+               ret = -1;
+               goto end;
+       }
+       if (!sink_port) {
+               fprintf(stderr, "Failed to find default sink input port. Aborting...\n");
+               ret = -1;
+               goto end;
+       }
 
        if (bt_value_map_has_key(source_cfg->params, "begin")
                        || bt_value_map_has_key(source_cfg->params, "end")) {
                /* A trimmer must be inserted in the graph. */
-               enum bt_component_status trimmer_status;
-
                trimmer = create_trimmer(source_cfg);
                if (!trimmer) {
                        fprintf(stderr, "Failed to create trimmer component. Aborting...\n");
@@ -421,35 +567,45 @@ int connect_source_sink(struct bt_component *source,
                        goto end;
                }
 
-               trimmer_status = bt_component_filter_add_iterator(trimmer,
-                               source_it);
-               BT_PUT(source_it);
-               if (trimmer_status != BT_COMPONENT_STATUS_OK) {
-                       fprintf(stderr, "Failed to connect source to trimmer. Aborting...\n");
+               trimmer_input_port = bt_component_filter_get_default_input_port(
+                               trimmer);
+               if (!trimmer_input_port) {
+                       fprintf(stderr, "Failed to find trimmer input port. Aborting...\n");
+                       ret = -1;
+                       goto end;
+               }
+               to_sink_port = bt_component_filter_get_default_output_port(
+                               trimmer);
+               if (!to_sink_port) {
+                       fprintf(stderr, "Failed to find trimmer output port. Aborting...\n");
                        ret = -1;
                        goto end;
                }
 
-               to_sink_it = bt_component_filter_create_notification_iterator(trimmer);
-               if (!to_sink_it) {
-                       fprintf(stderr, "Failed to instantiate trimmer iterator. Aborting...\n");
+               connection = bt_graph_connect(graph, source_port,
+                               trimmer_input_port);
+               if (!connection) {
+                       fprintf(stderr, "Failed to connect source to trimmer. Aborting...\n");
                        ret = -1;
                        goto end;
                }
+               BT_PUT(connection);
        } else {
-               BT_MOVE(to_sink_it, source_it);
+               BT_MOVE(to_sink_port, source_port);
        }
 
-       sink_status = bt_component_sink_add_iterator(sink, to_sink_it);
-       if (sink_status != BT_COMPONENT_STATUS_OK) {
-               fprintf(stderr, "Failed to connect to sink component. Aborting...\n");
+       connection = bt_graph_connect(graph, to_sink_port, sink_port);
+       if (!connection) {
+               fprintf(stderr, "Failed to connect to sink. Aborting...\n");
                ret = -1;
                goto end;
        }
 end:
        bt_put(trimmer);
-       bt_put(source_it);
-       bt_put(to_sink_it);
+       bt_put(source_port);
+       bt_put(sink_port);
+       bt_put(to_sink_port);
+       bt_put(connection);
        return ret;
 }
 
@@ -535,22 +691,6 @@ end:
        return ret;
 }
 
-static
-const char *component_type_str(enum bt_component_class_type type)
-{
-       switch (type) {
-       case BT_COMPONENT_CLASS_TYPE_SOURCE:
-               return "source";
-       case BT_COMPONENT_CLASS_TYPE_SINK:
-               return "sink";
-       case BT_COMPONENT_CLASS_TYPE_FILTER:
-               return "filter";
-       case BT_COMPONENT_CLASS_TYPE_UNKNOWN:
-       default:
-               return "unknown";
-       }
-}
-
 static int load_all_plugins(struct bt_value *plugin_paths)
 {
        int ret = 0;
@@ -617,20 +757,61 @@ static void print_plugin_info(struct bt_plugin *plugin)
                license ? license : "(Unknown)");
 }
 
-static void print_plugin_comp_cls_opt(FILE *fh, const char *plugin_name,
-               const char *comp_cls_name, enum bt_component_class_type type)
+static int cmd_query(struct bt_config *cfg)
 {
-       fprintf(fh, "%s%s--%s%s %s%s%s.%s%s%s",
-               bt_common_color_bold(),
-               bt_common_color_fg_cyan(),
-               component_type_str(type),
-               bt_common_color_fg_default(),
-               bt_common_color_fg_blue(),
-               plugin_name,
-               bt_common_color_fg_default(),
-               bt_common_color_fg_yellow(),
-               comp_cls_name,
-               bt_common_color_reset());
+       int ret;
+       struct bt_component_class *comp_cls = NULL;
+       struct bt_value *results = NULL;
+
+       ret = load_all_plugins(cfg->cmd_data.list_plugins.plugin_paths);
+       if (ret) {
+               goto end;
+       }
+
+       comp_cls = find_component_class(cfg->cmd_data.query.cfg_component->plugin_name->str,
+               cfg->cmd_data.query.cfg_component->component_name->str,
+               cfg->cmd_data.query.cfg_component->type);
+       if (!comp_cls) {
+               fprintf(stderr, "%s%sCannot find component class %s",
+                       bt_common_color_bold(),
+                       bt_common_color_fg_red(),
+                       bt_common_color_reset());
+               print_plugin_comp_cls_opt(stderr,
+                       cfg->cmd_data.query.cfg_component->plugin_name->str,
+                       cfg->cmd_data.query.cfg_component->component_name->str,
+                       cfg->cmd_data.query.cfg_component->type);
+               fprintf(stderr, "\n");
+               ret = -1;
+               goto end;
+       }
+
+       results = bt_component_class_query(comp_cls,
+               cfg->cmd_data.query.object->str,
+               cfg->cmd_data.query.cfg_component->params);
+       if (!results) {
+               fprintf(stderr, "%s%sFailed to query info to %s",
+                       bt_common_color_bold(),
+                       bt_common_color_fg_red(),
+                       bt_common_color_reset());
+               print_plugin_comp_cls_opt(stderr,
+                       cfg->cmd_data.query.cfg_component->plugin_name->str,
+                       cfg->cmd_data.query.cfg_component->component_name->str,
+                       cfg->cmd_data.query.cfg_component->type);
+               fprintf(stderr, "%s%s with object `%s`%s\n",
+                       bt_common_color_bold(),
+                       bt_common_color_fg_red(),
+                       cfg->cmd_data.query.object->str,
+                       bt_common_color_reset());
+               ret = -1;
+               goto end;
+       }
+
+       print_value(results, 0);
+
+end:
+       bt_put(comp_cls);
+       bt_put(results);
+       return ret;
 }
 
 static int cmd_help(struct bt_config *cfg)
@@ -821,6 +1002,86 @@ end:
        return ret;
 }
 
+static int print_ctf_metadata(struct bt_config *cfg)
+{
+       int ret = 0;
+       struct bt_component_class *comp_cls = NULL;
+       struct bt_config_component *source_cfg = NULL;
+       struct bt_value *results = NULL;
+       struct bt_value *path = NULL;
+       struct bt_value *params = NULL;
+       struct bt_value *metadata_text_value = NULL;
+       const char *metadata_text = NULL;
+
+       assert(cfg->cmd_data.convert.sources->len == 1);
+       source_cfg = bt_config_get_component(cfg->cmd_data.convert.sources, 0);
+       assert(source_cfg);
+       comp_cls = find_component_class(source_cfg->plugin_name->str,
+                       source_cfg->component_name->str,
+                       source_cfg->type);
+       if (!comp_cls) {
+               fprintf(stderr, "%s%sCannot find component class %s",
+                       bt_common_color_bold(),
+                       bt_common_color_fg_red(),
+                       bt_common_color_reset());
+               print_plugin_comp_cls_opt(stderr,
+                       source_cfg->plugin_name->str,
+                       source_cfg->component_name->str,
+                       source_cfg->type);
+               fprintf(stderr, "\n");
+               ret = -1;
+               goto end;
+       }
+
+       path = bt_value_map_get(source_cfg->params, "path");
+       if (!path) {
+               ret = -1;
+               goto end;
+       }
+
+       params = bt_value_map_create();
+       if (!params) {
+               ret = -1;
+               goto end;
+       }
+
+       ret = bt_value_map_insert(params, "path", path);
+       if (ret) {
+               ret = -1;
+               goto end;
+       }
+
+       results = bt_component_class_query(comp_cls, "metadata-info",
+               params);
+       if (!results) {
+               ret = -1;
+               fprintf(stderr, "%s%sFailed to request metadata info%s\n",
+                       bt_common_color_bold(),
+                       bt_common_color_fg_red(),
+                       bt_common_color_reset());
+               goto end;
+       }
+
+       metadata_text_value = bt_value_map_get(results, "text");
+       if (!metadata_text_value) {
+               ret = -1;
+               goto end;
+       }
+
+       ret = bt_value_string_get(metadata_text_value, &metadata_text);
+       assert(ret == 0);
+       printf("%s\n", metadata_text);
+
+end:
+       bt_put(results);
+       bt_put(path);
+       bt_put(params);
+       bt_put(metadata_text_value);
+       bt_put(comp_cls);
+       bt_put(source_cfg);
+       return 0;
+}
+
 static int cmd_convert(struct bt_config *cfg)
 {
        int ret = 0;
@@ -828,8 +1089,19 @@ static int cmd_convert(struct bt_config *cfg)
        struct bt_component_class *sink_class = NULL;
        struct bt_component *source = NULL, *sink = NULL;
        struct bt_value *source_params = NULL, *sink_params = NULL;
-       enum bt_component_status sink_status;
        struct bt_config_component *source_cfg = NULL, *sink_cfg = NULL;
+       struct bt_graph *graph = NULL;
+
+       ret = load_all_plugins(cfg->cmd_data.convert.plugin_paths);
+       if (ret) {
+               fprintf(stderr, "Could not load plugins from configured plugin paths. Aborting...\n");
+               goto end;
+       }
+
+       if (cfg->cmd_data.convert.print_ctf_metadata) {
+               ret = print_ctf_metadata(cfg);
+               goto end;
+       }
 
        /* TODO handle more than 1 source and 1 sink. */
        if (cfg->cmd_data.convert.sources->len != 1 ||
@@ -839,21 +1111,16 @@ static int cmd_convert(struct bt_config *cfg)
                goto end;
        }
 
-       ret = load_all_plugins(cfg->cmd_data.convert.plugin_paths);
-       if (ret) {
-               fprintf(stderr, "Could not load plugins from configured plugin paths. Aborting...\n");
-               goto end;
-       }
-
        source_cfg = bt_config_get_component(cfg->cmd_data.convert.sources, 0);
        source_params = bt_get(source_cfg->params);
        source_class = find_component_class(source_cfg->plugin_name->str,
                        source_cfg->component_name->str,
                        BT_COMPONENT_CLASS_TYPE_SOURCE);
        if (!source_class) {
-               fprintf(stderr, "Could not find %s.%s source component class. Aborting...\n",
-                               source_cfg->plugin_name->str,
-                               source_cfg->component_name->str);
+               fprintf(stderr, "Could not find ");
+               print_plugin_comp_cls_opt(stderr, source_cfg->plugin_name->str,
+                       source_cfg->component_name->str, BT_COMPONENT_CLASS_TYPE_SOURCE);
+               fprintf(stderr, ". Aborting...\n");
                ret = -1;
                goto end;
        }
@@ -864,9 +1131,16 @@ static int cmd_convert(struct bt_config *cfg)
                        sink_cfg->component_name->str,
                        BT_COMPONENT_CLASS_TYPE_SINK);
        if (!sink_class) {
-               fprintf(stderr, "Could not find %s.%s output component class. Aborting...\n",
-                               sink_cfg->plugin_name->str,
-                               sink_cfg->component_name->str);
+               fprintf(stderr, "Could not find ");
+               print_plugin_comp_cls_opt(stderr, sink_cfg->plugin_name->str,
+                       sink_cfg->component_name->str, BT_COMPONENT_CLASS_TYPE_SINK);
+               fprintf(stderr, ". Aborting...\n");
+               ret = -1;
+               goto end;
+       }
+
+       graph = bt_graph_create();
+       if (!graph) {
                ret = -1;
                goto end;
        }
@@ -885,21 +1159,21 @@ static int cmd_convert(struct bt_config *cfg)
                goto end;
        }
 
-       ret = connect_source_sink(source, source_cfg, sink);
+       ret = connect_source_sink(graph, source, source_cfg, sink);
        if (ret) {
                ret = -1;
                goto end;
        }
 
        while (true) {
-               sink_status = bt_component_sink_consume(sink);
-               switch (sink_status) {
-               case BT_COMPONENT_STATUS_AGAIN:
+               enum bt_graph_status graph_status;
+
+               graph_status = bt_graph_run(graph, NULL);
+               switch (graph_status) {
+               case BT_GRAPH_STATUS_AGAIN:
                        /* Wait for an arbitraty 500 ms. */
                        usleep(500000);
                        break;
-               case BT_COMPONENT_STATUS_OK:
-                       break;
                case BT_COMPONENT_STATUS_END:
                        goto end;
                default:
@@ -910,14 +1184,15 @@ static int cmd_convert(struct bt_config *cfg)
        }
 
 end:
-       BT_PUT(sink_class);
-       BT_PUT(source_class);
-       BT_PUT(source);
-       BT_PUT(sink);
-       BT_PUT(source_params);
-       BT_PUT(sink_params);
-       BT_PUT(sink_cfg);
-       BT_PUT(source_cfg);
+       bt_put(sink_class);
+       bt_put(source_class);
+       bt_put(source);
+       bt_put(sink);
+       bt_put(source_params);
+       bt_put(sink_params);
+       bt_put(sink_cfg);
+       bt_put(source_cfg);
+       bt_put(graph);
        return ret;
 }
 
@@ -977,6 +1252,9 @@ int main(int argc, const char **argv)
        case BT_CONFIG_COMMAND_HELP:
                ret = cmd_help(cfg);
                break;
+       case BT_CONFIG_COMMAND_QUERY:
+               ret = cmd_query(cfg);
+               break;
        default:
                assert(false);
        }
This page took 0.030666 seconds and 4 git commands to generate.