Copy the packet_header in the plugins
[babeltrace.git] / cli / babeltrace.c
index 124ee53ae54b29ac34c9dc0eabe4ccb42a12f521..3c44db359025eb3e73936eb2b129ceac64d81b76 100644 (file)
@@ -26,6 +26,9 @@
  * SOFTWARE.
  */
 
+#define BT_LOG_TAG "CLI"
+#include "logging.h"
+
 #include <babeltrace/babeltrace.h>
 #include <babeltrace/plugin/plugin.h>
 #include <babeltrace/common-internal.h>
 #include "babeltrace-cfg-cli-args.h"
 #include "babeltrace-cfg-cli-args-default.h"
 
-#define BT_LOG_TAG "CLI"
-#include "logging.h"
-
 #define ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH "BABELTRACE_CLI_WARN_COMMAND_NAME_DIRECTORY_CLASH"
+#define ENV_BABELTRACE_CLI_LOG_LEVEL "BABELTRACE_CLI_LOG_LEVEL"
+
+/*
+ * Known environment variable names for the log levels of the project's
+ * modules.
+ */
+static const char* log_level_env_var_names[] = {
+       "BABELTRACE_COMMON_LOG_LEVEL",
+       "BABELTRACE_PLUGIN_CTF_BTR_LOG_LEVEL",
+       "BABELTRACE_PLUGIN_CTF_FS_SRC_LOG_LEVEL",
+       "BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_SRC_LOG_LEVEL",
+       "BABELTRACE_PLUGIN_CTF_METADATA_LOG_LEVEL",
+       "BABELTRACE_PLUGIN_CTF_NOTIF_ITER_LOG_LEVEL",
+       "BABELTRACE_PLUGIN_LTTNG_UTILS_DEBUG_INFO_FLT_LOG_LEVEL",
+       "BABELTRACE_PLUGIN_UTILS_TRIMMER_FLT_LOG_LEVEL",
+       "BABELTRACE_PYTHON_PLUGIN_PROVIDER_LOG_LEVEL",
+       NULL,
+};
 
 /* Application's processing graph (weak) */
 static struct bt_graph *the_graph;
@@ -65,9 +83,6 @@ static bool canceled = false;
 
 GPtrArray *loaded_plugins;
 
-BT_HIDDEN
-int bt_cli_log_level = BT_LOG_NONE;
-
 static
 void sigint_handler(int signum)
 {
@@ -181,7 +196,7 @@ const char *component_type_str(enum bt_component_class_type type)
                return "filter";
        case BT_COMPONENT_CLASS_TYPE_UNKNOWN:
        default:
-               return "unknown";
+               return "(unknown)";
        }
 }
 
@@ -202,13 +217,11 @@ void print_plugin_comp_cls_opt(FILE *fh, const char *plugin_name,
                goto end;
        }
 
-       fprintf(fh, "%s%s--%s%s %s'%s%s%s%s.%s%s%s'",
+       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_reset(),
                bt_common_color_fg_default(),
-               bt_common_color_bold(),
                bt_common_color_fg_blue(),
                shell_plugin_name->str,
                bt_common_color_fg_default(),
@@ -366,7 +379,7 @@ void print_value_rec(FILE *fp, struct bt_value *value, size_t indent)
                break;
        }
        default:
-               assert(false);
+               abort();
        }
 }
 
@@ -519,7 +532,7 @@ void print_cfg(struct bt_config *cfg)
                print_cfg_print_lttng_live_sessions(cfg);
                break;
        default:
-               assert(false);
+               abort();
        }
 }
 
@@ -581,6 +594,19 @@ int load_dynamic_plugins(struct bt_value *plugin_paths)
                plugin_path_value = bt_value_array_get(plugin_paths, i);
                bt_value_string_get(plugin_path_value, &plugin_path);
                assert(plugin_path);
+
+               /*
+                * Skip this if the directory does not exist because
+                * bt_plugin_create_all_from_dir() expects an existing
+                * directory.
+                */
+               if (!g_file_test(plugin_path, G_FILE_TEST_IS_DIR)) {
+                       BT_LOGV("Skipping nonexistent directory path: "
+                               "path=\"%s\"", plugin_path);
+                       BT_PUT(plugin_path_value);
+                       continue;
+               }
+
                plugin_set = bt_plugin_create_all_from_dir(plugin_path, false);
                if (!plugin_set) {
                        BT_LOGD("Unable to load dynamic plugins: path=\"%s\"",
@@ -1168,7 +1194,7 @@ int cmd_run_ctx_connect_upstream_port_to_downstream_component(
        uint64_t i;
        int64_t (*port_count_fn)(struct bt_component *);
        struct bt_port *(*port_by_index_fn)(struct bt_component *, uint64_t);
-       void *conn = NULL;
+       enum bt_graph_status status = BT_GRAPH_STATUS_ERROR;
 
        BT_LOGI("Connecting upstream port to the next available downstream port: "
                "upstream-port-addr=%p, upstream-port-name=\"%s\", "
@@ -1180,7 +1206,7 @@ int cmd_run_ctx_connect_upstream_port_to_downstream_component(
                cfg_conn->downstream_comp_name->str);
        assert(downstreamp_comp_name_quark > 0);
        downstream_comp = g_hash_table_lookup(ctx->components,
-               (gpointer) (long) downstreamp_comp_name_quark);
+               GUINT_TO_POINTER(downstreamp_comp_name_quark));
        if (!downstream_comp) {
                BT_LOGE("Cannot find downstream component:  comp-name=\"%s\", "
                        "conn-arg=\"%s\"", cfg_conn->downstream_comp_name->str,
@@ -1203,7 +1229,7 @@ int cmd_run_ctx_connect_upstream_port_to_downstream_component(
                 */
                BT_LOGF("Invalid connection: downstream component is a source: "
                        "conn-arg=\"%s\"", cfg_conn->arg->str);
-               assert(false);
+               abort();
        }
 
        downstream_port_count = port_count_fn(downstream_comp);
@@ -1233,10 +1259,35 @@ int cmd_run_ctx_connect_upstream_port_to_downstream_component(
                                cfg_conn->downstream_port_glob->str, -1ULL,
                                downstream_port_name, -1ULL)) {
                        /* We have a winner! */
-                       conn = bt_graph_connect_ports(ctx->graph,
-                               upstream_port, downstream_port);
+                       status = bt_graph_connect_ports(ctx->graph,
+                               upstream_port, downstream_port, NULL);
                        bt_put(downstream_port);
-                       if (!conn) {
+                       switch (status) {
+                       case BT_GRAPH_STATUS_OK:
+                               break;
+                       case BT_GRAPH_STATUS_CANCELED:
+                               BT_LOGI_STR("Graph was canceled by user.");
+                               status = BT_GRAPH_STATUS_OK;
+                               break;
+                       case BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION:
+                               BT_LOGE("A component refused a connection to one of its ports: "
+                                       "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
+                                       "upstream-port-addr=%p, upstream-port-name=\"%s\", "
+                                       "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
+                                       "downstream-port-addr=%p, downstream-port-name=\"%s\", "
+                                       "conn-arg=\"%s\"",
+                                       upstream_comp, bt_component_get_name(upstream_comp),
+                                       upstream_port, bt_port_get_name(upstream_port),
+                                       downstream_comp, cfg_conn->downstream_comp_name->str,
+                                       downstream_port, downstream_port_name,
+                                       cfg_conn->arg->str);
+                               fprintf(stderr,
+                                       "A component refused a connection to one of its ports (`%s` to `%s`): %s\n",
+                                       bt_port_get_name(upstream_port),
+                                       downstream_port_name,
+                                       cfg_conn->arg->str);
+                               break;
+                       default:
                                BT_LOGE("Cannot create connection: graph refuses to connect ports: "
                                        "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
                                        "upstream-port-addr=%p, upstream-port-name=\"%s\", "
@@ -1274,7 +1325,7 @@ int cmd_run_ctx_connect_upstream_port_to_downstream_component(
                bt_put(downstream_port);
        }
 
-       if (!conn) {
+       if (status != BT_GRAPH_STATUS_OK) {
                BT_LOGE("Cannot create connection: cannot find a matching downstream port for upstream port: "
                        "upstream-port-addr=%p, upstream-port-name=\"%s\", "
                        "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
@@ -1293,7 +1344,6 @@ error:
        ret = -1;
 
 end:
-       bt_put(conn);
        return ret;
 }
 
@@ -1384,6 +1434,11 @@ void graph_port_added_listener(struct bt_port *port, void *data)
                "comp-name=\"%s\", port-addr=%p, port-name=\"%s\"",
                comp, comp ? bt_component_get_name(comp) : "",
                port, bt_port_get_name(port));
+
+       if (!ctx->connect_ports) {
+               goto end;
+       }
+
        if (!comp) {
                BT_LOGW_STR("Port has no component.");
                goto end;
@@ -1494,25 +1549,29 @@ int cmd_run_ctx_init(struct cmd_run_ctx *ctx, struct bt_config *cfg)
        the_graph = ctx->graph;
        ret = bt_graph_add_port_added_listener(ctx->graph,
                graph_port_added_listener, ctx);
-       if (ret) {
+       if (ret < 0) {
+               BT_LOGE_STR("Cannot add \"port added\" listener to graph.");
                goto error;
        }
 
        ret = bt_graph_add_port_removed_listener(ctx->graph,
                graph_port_removed_listener, ctx);
-       if (ret) {
+       if (ret < 0) {
+               BT_LOGE_STR("Cannot add \"port removed\" listener to graph.");
                goto error;
        }
 
        ret = bt_graph_add_ports_connected_listener(ctx->graph,
                graph_ports_connected_listener, ctx);
-       if (ret) {
+       if (ret < 0) {
+               BT_LOGE_STR("Cannot add \"ports connected\" listener to graph.");
                goto error;
        }
 
        ret = bt_graph_add_ports_disconnected_listener(ctx->graph,
                graph_ports_disconnected_listener, ctx);
-       if (ret) {
+       if (ret < 0) {
+               BT_LOGE_STR("Cannot add \"ports disconnected\" listener to graph.");
                goto error;
        }
 
@@ -1560,11 +1619,11 @@ int cmd_run_ctx_create_components_from_config_components(
                        goto error;
                }
 
-               comp = bt_component_create(comp_cls,
-                       cfg_comp->instance_name->str, cfg_comp->params);
-               if (!comp) {
+               ret = bt_graph_add_component(ctx->graph, comp_cls,
+                       cfg_comp->instance_name->str, cfg_comp->params, &comp);
+               if (ret) {
                        BT_LOGE("Cannot create component: plugin-name=\"%s\", "
-                               "comp-cls-name=\"%s\", comp-cls-type=%d",
+                               "comp-cls-name=\"%s\", comp-cls-type=%d, "
                                "comp-name=\"%s\"",
                                cfg_comp->plugin_name->str,
                                cfg_comp->comp_cls_name->str,
@@ -1582,7 +1641,7 @@ int cmd_run_ctx_create_components_from_config_components(
                quark = g_quark_from_string(cfg_comp->instance_name->str);
                assert(quark > 0);
                g_hash_table_insert(ctx->components,
-                       (gpointer) (long) quark, comp);
+                       GUINT_TO_POINTER(quark), comp);
                comp = NULL;
                BT_PUT(comp_cls);
        }
@@ -1706,8 +1765,6 @@ const char *bt_graph_status_str(enum bt_graph_status status)
                return "BT_GRAPH_STATUS_END";
        case BT_GRAPH_STATUS_OK:
                return "BT_GRAPH_STATUS_OK";
-       case BT_GRAPH_STATUS_ALREADY_IN_A_GRAPH:
-               return "BT_GRAPH_STATUS_ALREADY_IN_A_GRAPH";
        case BT_GRAPH_STATUS_INVALID:
                return "BT_GRAPH_STATUS_INVALID";
        case BT_GRAPH_STATUS_NO_SINK:
@@ -1732,6 +1789,13 @@ int cmd_run(struct bt_config *cfg)
                goto error;
        }
 
+       if (canceled) {
+               BT_LOGI_STR("Canceled by user before creating components.");
+               goto error;
+       }
+
+       BT_LOGI_STR("Creating components.");
+
        /* Create the requested component instances */
        if (cmd_run_ctx_create_components(&ctx)) {
                BT_LOGE_STR("Cannot create components.");
@@ -1739,6 +1803,13 @@ int cmd_run(struct bt_config *cfg)
                goto error;
        }
 
+       if (canceled) {
+               BT_LOGI_STR("Canceled by user before connecting components.");
+               goto error;
+       }
+
+       BT_LOGI_STR("Connecting components.");
+
        /* Connect the initially visible component ports */
        if (cmd_run_ctx_connect_ports(&ctx)) {
                BT_LOGE_STR("Cannot connect initial component ports.");
@@ -1747,7 +1818,8 @@ int cmd_run(struct bt_config *cfg)
        }
 
        if (canceled) {
-               goto end;
+               BT_LOGI_STR("Canceled by user before running the graph.");
+               goto error;
        }
 
        BT_LOGI_STR("Running the graph.");
@@ -1756,6 +1828,13 @@ int cmd_run(struct bt_config *cfg)
        while (true) {
                enum bt_graph_status graph_status = bt_graph_run(ctx.graph);
 
+               /*
+                * Reset console in case something messed with console
+                * codes during the graph's execution.
+                */
+               printf("%s", bt_common_color_reset());
+               fflush(stdout);
+               fprintf(stderr, "%s", bt_common_color_reset());
                BT_LOGV("bt_graph_run() returned: status=%s",
                        bt_graph_status_str(graph_status));
 
@@ -1834,33 +1913,138 @@ void warn_command_name_and_directory_clash(struct bt_config *cfg)
 static
 void init_log_level(void)
 {
-       enum bt_logging_level log_level = BT_LOG_NONE;
-       const char *log_level_env = getenv("BABELTRACE_CLI_LOG_LEVEL");
-
-       if (!log_level_env) {
-               goto set_level;
-       }
-
-       if (strcmp(log_level_env, "VERBOSE") == 0) {
-               log_level = BT_LOGGING_LEVEL_VERBOSE;
-       } else if (strcmp(log_level_env, "DEBUG") == 0) {
-               log_level = BT_LOGGING_LEVEL_DEBUG;
-       } else if (strcmp(log_level_env, "INFO") == 0) {
-               log_level = BT_LOGGING_LEVEL_INFO;
-       } else if (strcmp(log_level_env, "WARN") == 0) {
-               log_level = BT_LOGGING_LEVEL_WARN;
-       } else if (strcmp(log_level_env, "ERROR") == 0) {
-               log_level = BT_LOGGING_LEVEL_ERROR;
-       } else if (strcmp(log_level_env, "FATAL") == 0) {
-               log_level = BT_LOGGING_LEVEL_FATAL;
-       } else if (strcmp(log_level_env, "NONE") == 0) {
-               log_level = BT_LOGGING_LEVEL_NONE;
-       }
-
-set_level:
-       bt_cli_log_level = log_level;
+       bt_cli_log_level = bt_log_get_level_from_env(ENV_BABELTRACE_CLI_LOG_LEVEL);
 }
 
+static
+void set_auto_log_levels(struct bt_config *cfg)
+{
+       const char **env_var_name;
+
+       /*
+        * Override the configuration's default log level if
+        * BABELTRACE_VERBOSE or BABELTRACE_DEBUG environment variables
+        * are found for backward compatibility with legacy Babetrace 1.
+        */
+       if (getenv("BABELTRACE_DEBUG") &&
+                       strcmp(getenv("BABELTRACE_DEBUG"), "1") == 0) {
+               cfg->log_level = 'V';
+       } else if (getenv("BABELTRACE_VERBOSE") &&
+                       strcmp(getenv("BABELTRACE_VERBOSE"), "1") == 0) {
+               cfg->log_level = 'I';
+       }
+
+       /*
+        * Set log levels according to --debug or --verbose. For
+        * backward compatibility, --debug is more verbose than
+        * --verbose. So:
+        *
+        *     --verbose: INFO log level
+        *     --debug:   VERBOSE log level (includes DEBUG, which is
+        *                is less verbose than VERBOSE in the internal
+        *                logging framework)
+        */
+       if (!getenv("BABELTRACE_LOGGING_GLOBAL_LEVEL")) {
+               if (cfg->verbose) {
+                       bt_logging_set_global_level(BT_LOGGING_LEVEL_INFO);
+               } else if (cfg->debug) {
+                       bt_logging_set_global_level(BT_LOGGING_LEVEL_VERBOSE);
+               } else {
+                       /*
+                        * Set library's default log level if not
+                        * explicitly specified.
+                        */
+                       switch (cfg->log_level) {
+                       case 'N':
+                               bt_logging_set_global_level(BT_LOGGING_LEVEL_NONE);
+                               break;
+                       case 'V':
+                               bt_logging_set_global_level(BT_LOGGING_LEVEL_VERBOSE);
+                               break;
+                       case 'D':
+                               bt_logging_set_global_level(BT_LOGGING_LEVEL_DEBUG);
+                               break;
+                       case 'I':
+                               bt_logging_set_global_level(BT_LOGGING_LEVEL_INFO);
+                               break;
+                       case 'W':
+                               bt_logging_set_global_level(BT_LOGGING_LEVEL_WARN);
+                               break;
+                       case 'E':
+                               bt_logging_set_global_level(BT_LOGGING_LEVEL_ERROR);
+                               break;
+                       case 'F':
+                               bt_logging_set_global_level(BT_LOGGING_LEVEL_FATAL);
+                               break;
+                       default:
+                               abort();
+                       }
+               }
+       }
+
+       if (!getenv(ENV_BABELTRACE_CLI_LOG_LEVEL)) {
+               if (cfg->verbose) {
+                       bt_cli_log_level = BT_LOG_INFO;
+               } else if (cfg->debug) {
+                       bt_cli_log_level = BT_LOG_VERBOSE;
+               } else {
+                       /*
+                        * Set CLI's default log level if not explicitly
+                        * specified.
+                        */
+                       switch (cfg->log_level) {
+                       case 'N':
+                               bt_cli_log_level = BT_LOG_NONE;
+                               break;
+                       case 'V':
+                               bt_cli_log_level = BT_LOG_VERBOSE;
+                               break;
+                       case 'D':
+                               bt_cli_log_level = BT_LOG_DEBUG;
+                               break;
+                       case 'I':
+                               bt_cli_log_level = BT_LOG_INFO;
+                               break;
+                       case 'W':
+                               bt_cli_log_level = BT_LOG_WARN;
+                               break;
+                       case 'E':
+                               bt_cli_log_level = BT_LOG_ERROR;
+                               break;
+                       case 'F':
+                               bt_cli_log_level = BT_LOG_FATAL;
+                               break;
+                       default:
+                               abort();
+                       }
+               }
+       }
+
+       env_var_name = log_level_env_var_names;
+
+       while (*env_var_name) {
+               if (!getenv(*env_var_name)) {
+                       if (cfg->verbose) {
+                               setenv(*env_var_name, "I", 1);
+                       } else if (cfg->debug) {
+                               setenv(*env_var_name, "V", 1);
+                       } else {
+                               char val[2] = { 0 };
+
+                               /*
+                                * Set module's default log level if not
+                                * explicitly specified.
+                                */
+                               val[0] = cfg->log_level;
+                               setenv(*env_var_name, val, 1);
+                       }
+               }
+
+               env_var_name++;
+       }
+}
+
+static
 void set_sigint_handler(void)
 {
        struct sigaction new_action, old_action;
@@ -1905,22 +2089,7 @@ int main(int argc, const char **argv)
                goto end;
        }
 
-       if (cfg->verbose) {
-               bt_cli_log_level = BT_LOGGING_LEVEL_VERBOSE;
-               bt_logging_set_global_level(BT_LOGGING_LEVEL_VERBOSE);
-               // TODO: for backward compat., set the log level
-               //       environment variables of the known plugins
-               //       to VERBOSE
-       } else if (cfg->debug) {
-               bt_cli_log_level = BT_LOGGING_LEVEL_DEBUG;
-               bt_logging_set_global_level(BT_LOGGING_LEVEL_DEBUG);
-               // TODO: for backward compat., set the log level
-               //       environment variables of the known plugins
-               //       to DEBUG
-       }
-
-       babeltrace_debug = cfg->debug;
-       babeltrace_verbose = cfg->verbose;
+       set_auto_log_levels(cfg);
        print_cfg(cfg);
 
        if (cfg->command_needs_plugins) {
@@ -1955,8 +2124,8 @@ int main(int argc, const char **argv)
                ret = cmd_print_lttng_live_sessions(cfg);
                break;
        default:
-               BT_LOGF("Invalid command: cmd=%d", cfg->command);
-               assert(false);
+               BT_LOGF("Invalid/unknown command: cmd=%d", cfg->command);
+               abort();
        }
 
        BT_LOGI("Command completed: cmd=%d, command-name=\"%s\", ret=%d",
This page took 0.031379 seconds and 4 git commands to generate.