trace.h: doc: various fixes
[babeltrace.git] / converter / babeltrace-cfg.c
index fca9820662cc0ef9d9965cf50d20a64fec0b1ff9..a7c5b12a6b2b6759c8c21fcbccc9d243a00b519c 100644 (file)
@@ -280,7 +280,7 @@ int ini_handle_state(struct ini_parsing_state *state)
 
                if (bt_value_map_has_key(state->params, state->last_map_key)) {
                        g_string_append_printf(state->ini_error,
-                               "Duplicate parameter key: \"%s\"\n",
+                               "Duplicate parameter key: `%s`\n",
                                state->last_map_key);
                        goto error;
                }
@@ -727,11 +727,11 @@ void print_legacy_usage(FILE *fp)
        fprintf(fp, "      --clock-seconds          Print the timestamps as [SEC.NS]\n");
        fprintf(fp, "                               (default format: [HH:MM:SS.NS])\n");
        fprintf(fp, "      --debug-info-dir=DIR     Search for debug info in directory DIR\n");
-       fprintf(fp, "                               (default: \"/usr/lib/debug\")\n");
+       fprintf(fp, "                               (default: `/usr/lib/debug`)\n");
        fprintf(fp, "      --debug-info-full-path   Show full debug info source and binary paths\n");
        fprintf(fp, "      --debug-info-target-prefix=DIR  Use directory DIR as a prefix when looking\n");
        fprintf(fp, "                                      up executables during debug info analysis\n");
-       fprintf(fp, "                               (default: \"/usr/lib/debug\")\n");
+       fprintf(fp, "                               (default: `/usr/lib/debug`)\n");
        fprintf(fp, "  -f, --fields=NAME[,NAME]...  Print additional fields:\n");
        fprintf(fp, "                                 all, trace, trace:hostname, trace:domain,\n");
        fprintf(fp, "                                 trace:procname, trace:vpid, loglevel, emf,\n");
@@ -755,27 +755,40 @@ void print_usage(FILE *fp)
 {
        fprintf(fp, "Usage: babeltrace [OPTIONS]\n");
        fprintf(fp, "\n");
+       fprintf(fp, "  -B, --base-begin-ns=NS            Set NS as the current base beginning\n");
+       fprintf(fp, "                                    timestamp of the following source component\n");
+       fprintf(fp, "                                    instances\n");
+       fprintf(fp, "  -E, --base-end-ns=NS              Set NS as the current base end timestamp\n");
+       fprintf(fp, "                                    of the following source component instances\n");
        fprintf(fp, "  -b, --base-params=PARAMS          Set PARAMS as the current base parameters\n");
        fprintf(fp, "                                    of the following source and sink component\n");
        fprintf(fp, "                                    instances (see the exact format of PARAMS\n");
        fprintf(fp, "                                    below)\n");
+       fprintf(fp, "      --begin-ns=NS                 Set the beginning timestamp of the latest\n");
+       fprintf(fp, "                                    source component instance to NS\n");
        fprintf(fp, "  -d, --debug                       Enable debug mode\n");
-       fprintf(fp, "  -i, --source=PLUGIN.COMPCLS       Instantiate a source component from plugin\n");
-       fprintf(fp, "                                    PLUGIN and component class COMPCLS (may be\n");
-       fprintf(fp, "                                    repeated)\n");
+       fprintf(fp, "      --end-ns=NS                   Set the end timestamp of the latest source\n");
+       fprintf(fp, "                                    component instance to NS\n");
        fprintf(fp, "  -l, --list                        List available plugins and their components\n");
-       fprintf(fp, "  -o, --sink=PLUGIN.COMPCLS         Instantiate a sink component from plugin\n");
-       fprintf(fp, "                                    PLUGIN and component class COMPCLS (may be\n");
-       fprintf(fp, "                                    repeated)\n");
-       fprintf(fp, "  -P, --plugin-path=PATH[:PATH]...  Set paths from which dynamic plugins can be\n");
-       fprintf(fp, "                                    loaded to PATH\n");
        fprintf(fp, "  -p, --params=PARAMS               Set the parameters of the latest source or\n");
        fprintf(fp, "                                    sink component instance (in command-line \n");
        fprintf(fp, "                                    order) to PARAMS (see the exact format of\n");
        fprintf(fp, "                                    PARAMS below)\n");
+       fprintf(fp, "  -P, --plugin-path=PATH[:PATH]...  Set paths from which dynamic plugins can be\n");
+       fprintf(fp, "                                    loaded to PATH\n");
+       fprintf(fp, "      --reset-base-begin-ns         Reset the current base beginning timestamp\n");
+       fprintf(fp, "                                    of the following source component instances\n");
+       fprintf(fp, "      --reset-base-end-ns           Reset the current base end timestamp of the\n");
+       fprintf(fp, "                                    following source component instances\n");
        fprintf(fp, "  -r, --reset-base-params           Reset the current base parameters of the\n");
        fprintf(fp, "                                    following source and sink component\n");
        fprintf(fp, "                                    instances to an empty map\n");
+       fprintf(fp, "  -o, --sink=PLUGIN.COMPCLS         Instantiate a sink component from plugin\n");
+       fprintf(fp, "                                    PLUGIN and component class COMPCLS (may be\n");
+       fprintf(fp, "                                    repeated)\n");
+       fprintf(fp, "  -i, --source=PLUGIN.COMPCLS       Instantiate a source component from plugin\n");
+       fprintf(fp, "                                    PLUGIN and component class COMPCLS (may be\n");
+       fprintf(fp, "                                    repeated)\n");
        fprintf(fp, "  -h  --help                        Show this help\n");
        fprintf(fp, "      --help-legacy                 Show Babeltrace 1.x legacy options\n");
        fprintf(fp, "  -v, --verbose                     Enable verbose output\n");
@@ -879,6 +892,10 @@ struct bt_config_component *bt_config_component_create(const char *plugin_name,
                goto error;
        }
 
+       /* Begin/end timestamp: not set */
+       cfg_component->begin_ns = -1ULL;
+       cfg_component->end_ns = -1ULL;
+
        goto end;
 
 error:
@@ -901,7 +918,7 @@ struct bt_config_component *bt_config_component_from_arg(const char *arg)
 
        plugin_component_names_from_arg(arg, &plugin_name, &component_name);
        if (!plugin_name || !component_name) {
-               printf_err("Cannot get plugin or component name\n");
+               printf_err("Cannot get plugin or component class name\n");
                goto error;
        }
 
@@ -1143,7 +1160,7 @@ struct bt_value *names_from_arg(const char *arg)
                                        goto error;
                                }
                        } else {
-                               printf_err("Unknown field name: \"%s\"\n",
+                               printf_err("Unknown field name: `%s`\n",
                                        identifier);
                                goto error;
                        }
@@ -1160,7 +1177,7 @@ struct bt_value *names_from_arg(const char *arg)
 
 end:
        if (found_none && found_all) {
-               printf_err("Only either \"all\" or \"none\" can be specified in the list given to the \"--names\" option, but not both.\n");
+               printf_err("Only either `all` or `none` can be specified in the list given to the --names option, but not both.\n");
                goto error;
        }
        /*
@@ -1235,7 +1252,7 @@ struct bt_value *fields_from_arg(const char *arg)
                                        goto error;
                                }
                        } else {
-                               printf_err("Unknown field name: \"%s\"\n",
+                               printf_err("Unknown field name: `%s`\n",
                                        identifier);
                                goto error;
                        }
@@ -1566,7 +1583,8 @@ static
 int append_sources_from_legacy_opts(GPtrArray *sources,
                enum legacy_input_format legacy_input_format,
                struct ctf_legacy_opts *ctf_legacy_opts,
-               struct bt_value *legacy_input_paths)
+               struct bt_value *legacy_input_paths,
+               uint64_t begin_ns, uint64_t end_ns)
 {
        int ret = 0;
        int i;
@@ -1631,6 +1649,8 @@ int append_sources_from_legacy_opts(GPtrArray *sources,
                }
 
                BT_MOVE(bt_config_component->params, params);
+               bt_config_component->begin_ns = begin_ns;
+               bt_config_component->end_ns = end_ns;
 
                /* Move created component configuration to the array */
                g_ptr_array_add(sources, bt_config_component);
@@ -1812,9 +1832,9 @@ void print_output_legacy_to_sinks(
                assert(false);
        }
 
-       printf_err("Both \"%s\" legacy output format and non-legacy sink(s) specified.\n\n",
+       printf_err("Both `%s` legacy output format and non-legacy sink component\ninstances(s) specified.\n\n",
                input_format);
-       printf_err("Specify the following non-legacy sink instead of the legacy \"%s\"\noutput format options:\n\n",
+       printf_err("Specify the following non-legacy sink component instance instead of the\nlegacy `%s` output format options:\n\n",
                input_format);
        g_string_append(str, "-o ");
 
@@ -1923,9 +1943,9 @@ void print_input_legacy_to_sources(enum legacy_input_format legacy_input_format,
                assert(false);
        }
 
-       printf_err("Both \"%s\" legacy input format and non-legacy source(s) specified.\n\n",
+       printf_err("Both `%s` legacy input format and non-legacy source component\ninstance(s) specified.\n\n",
                input_format);
-       printf_err("Specify the following non-legacy source(s) instead of the legacy \"%s\"\ninput format options and positional arguments:\n\n",
+       printf_err("Specify the following non-legacy source component instance(s) instead of the\nlegacy `%s` input format options and positional arguments:\n\n",
                input_format);
 
        for (i = 0; i < bt_value_array_size(legacy_input_paths); i++) {
@@ -1979,6 +1999,28 @@ end:
        return;
 }
 
+/*
+ * Validates a given source component configuration.
+ */
+static
+bool validate_source_config_component(struct bt_config_component *cfg_comp)
+{
+       bool valid = false;
+
+       if (cfg_comp->begin_ns != -1ULL && cfg_comp->end_ns != -1ULL) {
+               if (cfg_comp->begin_ns > cfg_comp->end_ns) {
+                       printf_err("Beginning timestamp (%" PRIu64 ") is greater than end timestamp (%" PRIu64 ")\n",
+                               cfg_comp->begin_ns, cfg_comp->end_ns);
+                       goto end;
+               }
+       }
+
+       valid = true;
+
+end:
+       return valid;
+}
+
 /*
  * Validates a given configuration, with optional legacy input and
  * output formats options. Prints useful error messages if anything
@@ -2021,10 +2063,10 @@ bool validate_cfg(struct bt_config *cfg,
                if (bt_value_array_is_empty(legacy_input_paths)) {
                        switch (*legacy_input_format) {
                        case LEGACY_INPUT_FORMAT_CTF:
-                               printf_err("No input path specified for legacy \"ctf\" input format\n");
+                               printf_err("No input path specified for legacy `ctf` input format\n");
                                break;
                        case LEGACY_INPUT_FORMAT_LTTNG_LIVE:
-                               printf_err("No URL specified for legacy \"lttng-live\" input format\n");
+                               printf_err("No URL specified for legacy `lttng-live` input format\n");
                                break;
                        default:
                                assert(false);
@@ -2056,7 +2098,7 @@ bool validate_cfg(struct bt_config *cfg,
                if (text_legacy_opts_is_any_set(text_legacy_opts) &&
                                *legacy_output_format !=
                                LEGACY_OUTPUT_FORMAT_TEXT) {
-                       printf_err("Options for legacy \"text\" output format specified with a different legacy output format\n");
+                       printf_err("Options for legacy `text` output format specified with a different legacy output format\n");
                        goto error;
                }
 
@@ -2074,7 +2116,7 @@ bool validate_cfg(struct bt_config *cfg,
         */
        if (*legacy_output_format == LEGACY_OUTPUT_FORMAT_CTF_METADATA &&
                        *legacy_input_format != LEGACY_INPUT_FORMAT_CTF) {
-               printf_err("Legacy \"ctf-metadata\" output format requires using legacy \"ctf\" input format\n");
+               printf_err("Legacy `ctf-metadata` output format requires using legacy `ctf` input format\n");
                goto error;
        }
 
@@ -2103,10 +2145,40 @@ int parse_int64(const char *arg, int64_t *val)
        return 0;
 }
 
+/*
+ * Parses a time in nanoseconds.
+ *
+ * Returns a negative value if anything goes wrong.
+ */
+static
+int ns_from_arg(const char *arg, uint64_t *ns)
+{
+       int ret = 0;
+       int64_t value;
+
+       if (parse_int64(arg, &value)) {
+               ret = -1;
+               goto end;
+       }
+
+       if (value < 0) {
+               ret = -1;
+               goto end;
+       }
+
+       *ns = (uint64_t) value;
+
+end:
+       return ret;
+}
+
 /* popt options */
 enum {
        OPT_NONE = 0,
+       OPT_BASE_BEGIN_NS,
+       OPT_BASE_END_NS,
        OPT_BASE_PARAMS,
+       OPT_BEGIN_NS,
        OPT_CLOCK_CYCLES,
        OPT_CLOCK_DATE,
        OPT_CLOCK_FORCE_CORRELATE,
@@ -2118,6 +2190,7 @@ enum {
        OPT_DEBUG_INFO_DIR,
        OPT_DEBUG_INFO_FULL_PATH,
        OPT_DEBUG_INFO_TARGET_PREFIX,
+       OPT_END_NS,
        OPT_FIELDS,
        OPT_HELP,
        OPT_HELP_LEGACY,
@@ -2129,6 +2202,8 @@ enum {
        OPT_OUTPUT_PATH,
        OPT_PARAMS,
        OPT_PLUGIN_PATH,
+       OPT_RESET_BASE_BEGIN_NS,
+       OPT_RESET_BASE_END_NS,
        OPT_RESET_BASE_PARAMS,
        OPT_SINK,
        OPT_SOURCE,
@@ -2140,7 +2215,10 @@ enum {
 /* popt long option descriptions */
 static struct poptOption long_options[] = {
        /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
+       { "base-begin-ns", 'B', POPT_ARG_STRING, NULL, OPT_BASE_BEGIN_NS, NULL, NULL },
+       { "base-end-ns", 'E', POPT_ARG_STRING, NULL, OPT_BASE_END_NS, NULL, NULL },
        { "base-params", 'b', POPT_ARG_STRING, NULL, OPT_BASE_PARAMS, NULL, NULL },
+       { "begin-ns", '\0', POPT_ARG_STRING, NULL, OPT_BEGIN_NS, NULL, NULL },
        { "clock-cycles", '\0', POPT_ARG_NONE, NULL, OPT_CLOCK_CYCLES, NULL, NULL },
        { "clock-date", '\0', POPT_ARG_NONE, NULL, OPT_CLOCK_DATE, NULL, NULL },
        { "clock-force-correlate", '\0', POPT_ARG_NONE, NULL, OPT_CLOCK_FORCE_CORRELATE, NULL, NULL },
@@ -2152,6 +2230,7 @@ static struct poptOption long_options[] = {
        { "debug-info-dir", 0, POPT_ARG_STRING, NULL, OPT_DEBUG_INFO_DIR, NULL, NULL },
        { "debug-info-full-path", 0, POPT_ARG_NONE, NULL, OPT_DEBUG_INFO_FULL_PATH, NULL, NULL },
        { "debug-info-target-prefix", 0, POPT_ARG_STRING, NULL, OPT_DEBUG_INFO_TARGET_PREFIX, NULL, NULL },
+       { "end-ns", '\0', POPT_ARG_STRING, NULL, OPT_END_NS, NULL, NULL },
        { "fields", 'f', POPT_ARG_STRING, NULL, OPT_FIELDS, NULL, NULL },
        { "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL },
        { "help-legacy", '\0', POPT_ARG_NONE, NULL, OPT_HELP_LEGACY, NULL, NULL },
@@ -2163,6 +2242,8 @@ static struct poptOption long_options[] = {
        { "output-format", 'o', POPT_ARG_STRING, NULL, OPT_OUTPUT_FORMAT, NULL, NULL },
        { "params", 'p', POPT_ARG_STRING, NULL, OPT_PARAMS, NULL, NULL },
        { "plugin-path", 'P', POPT_ARG_STRING, NULL, OPT_PLUGIN_PATH, NULL, NULL },
+       { "reset-base-begin-ns", '\0', POPT_ARG_NONE, NULL, OPT_RESET_BASE_BEGIN_NS, NULL, NULL },
+       { "reset-base-end-ns", '\0', POPT_ARG_NONE, NULL, OPT_RESET_BASE_END_NS, NULL, NULL },
        { "reset-base-params", 'r', POPT_ARG_NONE, NULL, OPT_RESET_BASE_PARAMS, NULL, NULL },
        { "sink", '\0', POPT_ARG_STRING, NULL, OPT_SINK, NULL, NULL },
        { "source", '\0', POPT_ARG_STRING, NULL, OPT_SOURCE, NULL, NULL },
@@ -2226,8 +2307,11 @@ struct bt_config *bt_config_from_args(int argc, char *argv[], int *exit_code)
        enum bt_config_component_dest cur_cfg_comp_dest =
                BT_CONFIG_COMPONENT_DEST_SOURCE;
        struct bt_value *cur_base_params = NULL;
+       uint64_t cur_base_begin_ns = -1ULL;
+       uint64_t cur_base_end_ns = -1ULL;
        int opt;
        bool cur_cfg_comp_params_set = false;
+       unsigned int i;
 
        *exit_code = 0;
 
@@ -2370,7 +2454,7 @@ struct bt_config *bt_config_from_args(int argc, char *argv[], int *exit_code)
 
                        cur_cfg_comp = bt_config_component_from_arg(arg);
                        if (!cur_cfg_comp) {
-                               printf_err("Invalid source component format:\n    %s\n",
+                               printf_err("Invalid format for --source option's argument:\n    %s\n",
                                        arg);
                                goto error;
                        }
@@ -2378,6 +2462,8 @@ struct bt_config *bt_config_from_args(int argc, char *argv[], int *exit_code)
                        assert(cur_base_params);
                        bt_put(cur_cfg_comp->params);
                        cur_cfg_comp->params = bt_get(cur_base_params);
+                       cur_cfg_comp->begin_ns = cur_base_begin_ns;
+                       cur_cfg_comp->end_ns = cur_base_end_ns;
                        cur_cfg_comp_dest = BT_CONFIG_COMPONENT_DEST_SOURCE;
                        cur_cfg_comp_params_set = false;
                        break;
@@ -2427,7 +2513,7 @@ struct bt_config *bt_config_from_args(int argc, char *argv[], int *exit_code)
 
                        cur_cfg_comp = bt_config_component_from_arg(arg);
                        if (!cur_cfg_comp) {
-                               printf_err("Invalid sink component format:\n    %s\n",
+                               printf_err("Invalid format for --sink option's argument:\n    %s\n",
                                        arg);
                                goto error;
                        }
@@ -2450,7 +2536,7 @@ struct bt_config *bt_config_from_args(int argc, char *argv[], int *exit_code)
                        }
 
                        if (cur_cfg_comp_params_set) {
-                               printf_err("Duplicate --params option for the same current component (%s.%s)\n",
+                               printf_err("Duplicate --params option for the same current component\ninstance (class %s.%s)\n",
                                        cur_cfg_comp->plugin_name->str,
                                        cur_cfg_comp->component_name->str);
                                goto error;
@@ -2497,6 +2583,52 @@ struct bt_config *bt_config_from_args(int argc, char *argv[], int *exit_code)
                                goto error;
                        }
                        break;
+               case OPT_BASE_BEGIN_NS:
+                       if (ns_from_arg(arg, &cur_base_begin_ns)) {
+                               printf_err("Invalid --base-begin-ns option's argument:\n    %s\n",
+                                       arg);
+                               goto error;
+                       }
+                       break;
+               case OPT_BASE_END_NS:
+                       if (ns_from_arg(arg, &cur_base_end_ns)) {
+                               printf_err("Invalid --base-end-ns option's argument:\n    %s\n",
+                                       arg);
+                               goto error;
+                       }
+                       break;
+               case OPT_RESET_BASE_BEGIN_NS:
+                       cur_base_begin_ns = -1ULL;
+                       break;
+               case OPT_RESET_BASE_END_NS:
+                       cur_base_end_ns = -1ULL;
+                       break;
+               case OPT_BEGIN_NS:
+                       if (!cur_cfg_comp || cur_cfg_comp_dest ==
+                                       BT_CONFIG_COMPONENT_DEST_SINK) {
+                               printf_err("--begin-ns option must follow a --source option\n");
+                               goto error;
+                       }
+
+                       if (ns_from_arg(arg, &cur_cfg_comp->begin_ns)) {
+                               printf_err("Invalid --begin-ns option's argument:\n    %s\n",
+                                       arg);
+                               goto error;
+                       }
+                       break;
+               case OPT_END_NS:
+                       if (!cur_cfg_comp || cur_cfg_comp_dest ==
+                                       BT_CONFIG_COMPONENT_DEST_SINK) {
+                               printf_err("--end-ns option must follow a --source option\n");
+                               goto error;
+                       }
+
+                       if (ns_from_arg(arg, &cur_cfg_comp->end_ns)) {
+                               printf_err("Invalid --end-ns option's argument:\n    %s\n",
+                                       arg);
+                               goto error;
+                       }
+                       break;
                case OPT_NAMES:
                        if (text_legacy_opts.names) {
                                printf_err("Duplicate --names option\n");
@@ -2653,8 +2785,9 @@ struct bt_config *bt_config_from_args(int argc, char *argv[], int *exit_code)
        if (legacy_input_format) {
                if (append_sources_from_legacy_opts(cfg->sources,
                                legacy_input_format, &ctf_legacy_opts,
-                               legacy_input_paths)) {
-                       printf_err("Cannot convert legacy input format options to source(s)\n");
+                               legacy_input_paths, cur_base_begin_ns,
+                               cur_base_end_ns)) {
+                       printf_err("Cannot convert legacy input format options to source component instance(s)\n");
                        goto error;
                }
        }
@@ -2666,7 +2799,22 @@ struct bt_config *bt_config_from_args(int argc, char *argv[], int *exit_code)
        if (legacy_output_format) {
                if (append_sinks_from_legacy_opts(cfg->sinks,
                                legacy_output_format, &text_legacy_opts)) {
-                       printf_err("Cannot convert legacy output format options to sink(s)\n");
+                       printf_err("Cannot convert legacy output format options to sink component instance(s)\n");
+                       goto error;
+               }
+       }
+
+       for (i = 0; i < cfg->sources->len; i++) {
+               struct bt_config_component *cfg_component =
+                       bt_config_get_component(cfg->sources, i);
+
+               /* Only peek */
+               bt_put(cfg_component);
+
+               if (!validate_source_config_component(cfg_component)) {
+                       printf_err("Invalid source component instance (class %s.%s)\n",
+                               cfg_component->plugin_name->str,
+                               cfg_component->component_name->str);
                        goto error;
                }
        }
This page took 0.030395 seconds and 4 git commands to generate.