cli: make `--clock-force-correlate` use `force-clock-class-origin-unix-epoch`
[babeltrace.git] / src / cli / babeltrace2-cfg-cli-args.c
index 1e2da506ad49722fe2a9535bc9ba041bed920e46..fa1c1f54ee3ffb908e755ac31c258fce7a6e7dd8 100644 (file)
@@ -1300,6 +1300,8 @@ void print_expected_params_format(FILE *fp)
        fprintf(fp, "* Double-quoted string (accepts escape characters).\n");
        fprintf(fp, "* Array, formatted as an opening `[`, a list of comma-separated values\n");
        fprintf(fp, "  (as described by the current list) and a closing `]`.\n");
+       fprintf(fp, "* Map, formatted as an opening `{`, a comma-separated list of PARAM=VALUE\n");
+       fprintf(fp, "  assignments and a closing `}`.\n");
        fprintf(fp, "\n");
        fprintf(fp, "You can put whitespaces allowed around individual `=` and `,` symbols.\n");
        fprintf(fp, "\n");
@@ -1722,7 +1724,7 @@ void print_run_usage(FILE *fp)
        fprintf(fp, "  -x, --connect=CONNECTION          Connect two created components (see the\n");
        fprintf(fp, "                                    expected format of CONNECTION below)\n");
        fprintf(fp, "  -l, --log-level=LVL               Set the log level of the current component to LVL\n");
-       fprintf(fp, "                                    (`N`, `V`, `D`, `I`, `W`, `E`, or `F`)\n");
+       fprintf(fp, "                                    (`N`, `T`, `D`, `I`, `W`, `E`, or `F`)\n");
        fprintf(fp, "  -p, --params=PARAMS               Add initialization parameters PARAMS to the\n");
        fprintf(fp, "                                    current component (see the expected format\n");
        fprintf(fp, "                                    of PARAMS below)\n");
@@ -2126,7 +2128,7 @@ void print_convert_usage(FILE *fp)
        fprintf(fp, "                                    conversion graph, and optionally name it\n");
        fprintf(fp, "                                    NAME\n");
        fprintf(fp, "  -l, --log-level=LVL               Set the log level of the current component to LVL\n");
-       fprintf(fp, "                                    (`N`, `V`, `D`, `I`, `W`, `E`, or `F`)\n");
+       fprintf(fp, "                                    (`N`, `T`, `D`, `I`, `W`, `E`, or `F`)\n");
        fprintf(fp, "  -p, --params=PARAMS               Add initialization parameters PARAMS to the\n");
        fprintf(fp, "                                    current component (see the expected format\n");
        fprintf(fp, "                                    of PARAMS below)\n");
@@ -2146,6 +2148,8 @@ void print_convert_usage(FILE *fp)
        fprintf(fp, "\n");
        fprintf(fp, "Implicit `source.ctf.fs` component options:\n");
        fprintf(fp, "\n");
+       fprintf(fp, "      --clock-force-correlate       Force the origin of all clocks\n");
+       fprintf(fp, "                                    to the Unix epoch\n");
        fprintf(fp, "      --clock-offset=SEC            Set clock offset to SEC seconds\n");
        fprintf(fp, "      --clock-offset-ns=NS          Set clock offset to NS ns\n");
        fprintf(fp, "\n");
@@ -2173,11 +2177,6 @@ void print_convert_usage(FILE *fp)
        fprintf(fp, "  -w, --output=PATH                 Write output text to PATH instead of\n");
        fprintf(fp, "                                    the standard output\n");
        fprintf(fp, "\n");
-       fprintf(fp, "Implicit `filter.utils.muxer` component options:\n");
-       fprintf(fp, "\n");
-       fprintf(fp, "      --clock-force-correlate       Assume that clocks are inherently\n");
-       fprintf(fp, "                                    correlated across traces\n");
-       fprintf(fp, "\n");
        fprintf(fp, "Implicit `filter.utils.trimmer` component options:\n");
        fprintf(fp, "\n");
        fprintf(fp, "  -b, --begin=BEGIN                 Set the beginning time of the conversion\n");
@@ -2979,6 +2978,9 @@ end:
  * Create `struct implicit_component_args` structures for each of the
  * source components we identified.  Add them to `component_args`.
  *
+ * `non_opts` is an array of the non-option arguments passed on the command
+ * line.
+ *
  * `non_opt_params` is an array where each element is an array of
  * strings containing all the arguments to `--params` that apply to the
  * non-option argument at the same index.  For example, if, for a
@@ -2994,6 +2996,7 @@ end:
 static
 int create_implicit_component_args_from_auto_discovered_sources(
                const struct auto_source_discovery *auto_disc,
+               const bt_value *non_opts,
                const bt_value *non_opt_params,
                const bt_value *non_opt_loglevels,
                GPtrArray *component_args)
@@ -3084,6 +3087,42 @@ int create_implicit_component_args_from_auto_discovered_sources(
                        }
                }
 
+               /*
+                * If single input and a src.ctf.fs component, provide the
+                * relative path from the path passed on the command line to the
+                * found trace.
+                */
+               if (bt_value_array_get_length(res->inputs) == 1 &&
+                               strcmp(res->plugin_name, "ctf") == 0 &&
+                               strcmp(res->source_cc_name, "fs") == 0) {
+                       const bt_value *orig_idx_value =
+                               bt_value_array_borrow_element_by_index(
+                                       res->original_input_indices, 0);
+                       uint64_t orig_idx = bt_value_integer_unsigned_get(orig_idx_value);
+                       const bt_value *non_opt_value =
+                               bt_value_array_borrow_element_by_index_const(
+                                       non_opts, orig_idx);
+                       const char *non_opt = bt_value_string_get(non_opt_value);
+                       const bt_value *input_value =
+                               bt_value_array_borrow_element_by_index_const(
+                                       res->inputs, 0);
+                       const char *input = bt_value_string_get(input_value);
+
+                       BT_ASSERT(orig_indices_count == 1);
+                       BT_ASSERT(g_str_has_prefix(input, non_opt));
+
+                       input += strlen(non_opt);
+
+                       while (G_IS_DIR_SEPARATOR(*input)) {
+                               input++;
+                       }
+
+                       if (strlen(input) > 0) {
+                               append_string_parameter_to_args(comp->extra_params,
+                                       "trace-name", input);
+                       }
+               }
+
                status = append_parameter_to_args(comp->extra_params, "inputs", res->inputs);
                if (status != 0) {
                        goto error;
@@ -3134,7 +3173,7 @@ enum convert_current_item_type {
 static
 struct bt_config *bt_config_convert_from_args(int argc, const char *argv[],
                int *retcode, const bt_value *plugin_paths,
-               int *default_log_level)
+               int *default_log_level, const bt_interrupter *interrupter)
 {
        enum convert_current_item_type current_item_type =
                CONVERT_CURRENT_ITEM_TYPE_NONE;
@@ -3172,6 +3211,7 @@ struct bt_config *bt_config_convert_from_args(int argc, const char *argv[],
        struct bt_argpar_parse_ret argpar_parse_ret = { 0 };
        GString *name_gstr = NULL;
        GString *component_arg_for_run = NULL;
+       bt_value *live_inputs_array_val = NULL;
 
        /*
         * Array of `struct implicit_component_args *` created for the sources
@@ -3186,6 +3226,7 @@ struct bt_config *bt_config_convert_from_args(int argc, const char *argv[],
        const char *auto_source_discovery_restrict_plugin_name = NULL;
        const char *auto_source_discovery_restrict_component_class_name = NULL;
 
+       bool ctf_fs_source_force_clock_class_unix_epoch_origin = false;
        gchar *ctf_fs_source_clock_class_offset_arg = NULL;
        gchar *ctf_fs_source_clock_class_offset_ns_arg = NULL;
        *retcode = 0;
@@ -3439,10 +3480,16 @@ struct bt_config *bt_config_convert_from_args(int argc, const char *argv[],
                                         * it in `non_opt_params`.
                                         */
                                        bt_value *array;
+                                       bt_value_array_append_element_status append_element_status;
                                        uint64_t idx = bt_value_array_get_length(non_opt_params) - 1;
 
                                        array = bt_value_array_borrow_element_by_index(non_opt_params, idx);
-                                       bt_value_array_append_string_element(array, arg);
+
+                                       append_element_status = bt_value_array_append_string_element(array, arg);
+                                       if (append_element_status != BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK) {
+                                               BT_CLI_LOGE_APPEND_CAUSE_OOM();
+                                               goto error;
+                                       }
                                } else {
                                        BT_CLI_LOGE_APPEND_CAUSE(
                                                "No current component (--component option) or non-option argument of which to set parameters:\n    %s",
@@ -3652,9 +3699,7 @@ struct bt_config *bt_config_convert_from_args(int argc, const char *argv[],
                        implicit_text_args.exists = true;
                        break;
                case OPT_CLOCK_FORCE_CORRELATE:
-                       append_implicit_component_param(
-                               &implicit_muxer_args,
-                               "assume-absolute-clock-classes", "yes");
+                       ctf_fs_source_force_clock_class_unix_epoch_origin = true;
                        break;
                case OPT_CLOCK_GMT:
                        append_implicit_component_param(
@@ -3840,7 +3885,7 @@ struct bt_config *bt_config_convert_from_args(int argc, const char *argv[],
                case OPT_STREAM_INTERSECTION:
                        /*
                         * Applies to all traces implementing the
-                        * babeltrace.trace-info query.
+                        * babeltrace.trace-infos query.
                         */
                        stream_intersection_mode = true;
                        break;
@@ -3996,9 +4041,22 @@ struct bt_config *bt_config_convert_from_args(int argc, const char *argv[],
                                goto end;
                        }
 
-                       ret = append_implicit_component_extra_param(
-                               &implicit_lttng_live_args, "url",
-                               bt_value_string_get(bt_val_non_opt));
+                       live_inputs_array_val = bt_value_array_create();
+                       if (!live_inputs_array_val) {
+                               BT_CLI_LOGE_APPEND_CAUSE_OOM();
+                               goto error;
+                       }
+
+                       if (bt_value_array_append_string_element(
+                                       live_inputs_array_val,
+                                       bt_value_string_get(bt_val_non_opt))) {
+                               BT_CLI_LOGE_APPEND_CAUSE_OOM();
+                               goto error;
+                       }
+
+                       ret = append_parameter_to_args(
+                               implicit_lttng_live_args.extra_params,
+                               "inputs", live_inputs_array_val);
                        if (ret) {
                                goto error;
                        }
@@ -4031,14 +4089,18 @@ struct bt_config *bt_config_convert_from_args(int argc, const char *argv[],
 
                        status = auto_discover_source_components(non_opts, plugins, plugin_count,
                                auto_source_discovery_restrict_component_class_name,
-                               *default_log_level, &auto_disc);
+                               *default_log_level, &auto_disc, interrupter);
 
                        if (status != 0) {
+                               if (status == AUTO_SOURCE_DISCOVERY_STATUS_INTERRUPTED) {
+                                       BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
+                                               "Babeltrace CLI", "Automatic source discovery interrupted by the user");
+                               }
                                goto error;
                        }
 
                        status = create_implicit_component_args_from_auto_discovered_sources(
-                               &auto_disc, non_opt_params, non_opt_loglevels,
+                               &auto_disc, non_opts, non_opt_params, non_opt_loglevels,
                                discovered_source_args);
                        if (status != 0) {
                                goto error;
@@ -4046,6 +4108,23 @@ struct bt_config *bt_config_convert_from_args(int argc, const char *argv[],
                }
        }
 
+
+       /*
+        * If --clock-force-correlated was given, apply it to any src.ctf.fs
+        * component.
+        */
+       if (ctf_fs_source_force_clock_class_unix_epoch_origin) {
+               int n;
+
+               n = append_multiple_implicit_components_param(
+                       discovered_source_args, "source.ctf.fs", "force-clock-class-origin-unix-epoch",
+                       "yes");
+               if (n == 0) {
+                       BT_CLI_LOGE_APPEND_CAUSE("--clock-force-correlate specified, but no source.ctf.fs component instantiated.");
+                       goto error;
+               }
+       }
+
        /* If --clock-offset was given, apply it to any src.ctf.fs component. */
        if (ctf_fs_source_clock_class_offset_arg) {
                int n;
@@ -4337,6 +4416,7 @@ end:
                g_string_free(name_gstr, TRUE);
        }
 
+       bt_value_put_ref(live_inputs_array_val);
        bt_value_put_ref(run_args);
        bt_value_put_ref(all_names);
        destroy_glist_of_gstring(source_names);
@@ -4379,9 +4459,9 @@ void print_gen_usage(FILE *fp)
        fprintf(fp, "\n");
        fprintf(fp, "General options:\n");
        fprintf(fp, "\n");
-       fprintf(fp, "  -d, --debug                       Enable debug mode (same as --log-level=V)\n");
+       fprintf(fp, "  -d, --debug                       Enable debug mode (same as --log-level=T)\n");
        fprintf(fp, "  -h, --help                        Show this help and quit\n");
-       fprintf(fp, "  -l, --log-level=LVL               Set the default log level to LVL (`N`, `V`, `D`,\n");
+       fprintf(fp, "  -l, --log-level=LVL               Set the default log level to LVL (`N`, `T`, `D`,\n");
        fprintf(fp, "                                    `I`, `W` (default), `E`, or `F`)\n");
        fprintf(fp, "      --omit-home-plugin-path       Omit home plugins from plugin search path\n");
        fprintf(fp, "                                    (~/.local/lib/babeltrace2/plugins)\n");
@@ -4405,7 +4485,8 @@ void print_gen_usage(FILE *fp)
 struct bt_config *bt_config_cli_args_create(int argc, const char *argv[],
                int *retcode, bool omit_system_plugin_path,
                bool omit_home_plugin_path,
-               const bt_value *initial_plugin_paths)
+               const bt_value *initial_plugin_paths,
+               const bt_interrupter *interrupter)
 {
        struct bt_config *config = NULL;
        int i;
@@ -4635,7 +4716,7 @@ struct bt_config *bt_config_cli_args_create(int argc, const char *argv[],
                break;
        case COMMAND_TYPE_CONVERT:
                config = bt_config_convert_from_args(command_argc, command_argv,
-                       retcode, plugin_paths, &default_log_level);
+                       retcode, plugin_paths, &default_log_level, interrupter);
                break;
        case COMMAND_TYPE_LIST_PLUGINS:
                config = bt_config_list_plugins_from_args(command_argc,
This page took 0.028071 seconds and 4 git commands to generate.