X-Git-Url: http://drtracing.org/?a=blobdiff_plain;f=converter%2Fbabeltrace-cfg.c;h=f045bf94e973b6c4c16ef989b64cb4e516d8eff9;hb=5a3ee633fdd379e8acf7535f0ba91fb05234a36a;hp=63558694dda82a62a06b8c50fc586d20bdf6fcb1;hpb=6e1bc0df89a0af874e3c1f2617e576cbf5e73cf7;p=babeltrace.git diff --git a/converter/babeltrace-cfg.c b/converter/babeltrace-cfg.c index 63558694..f045bf94 100644 --- a/converter/babeltrace-cfg.c +++ b/converter/babeltrace-cfg.c @@ -30,11 +30,17 @@ #include #include #include +#include #include #include #include +#include +#include #include "babeltrace-cfg.h" +#define DEFAULT_SOURCE_COMPONENT_NAME "ctf.fs" +#define DEFAULT_SINK_COMPONENT_NAME "text.text" + /* * Error printf() macro which prepends "Error: " the first time it's * called. This gives a nicer feel than having a bunch of error prefixes @@ -280,7 +286,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; } @@ -589,9 +595,7 @@ end: /* * Returns the parameters map value object from a command-line - * source/sink option's argument. arg is the full argument, including - * the plugin/component names, the optional colon, and the optional - * parameters. + * parameter option's argument. * * Return value is owned by the caller. */ @@ -599,19 +603,8 @@ static struct bt_value *bt_value_from_arg(const char *arg) { struct bt_value *params = NULL; - const char *colon; - const char *params_string; GString *ini_error = NULL; - /* Isolate parameters */ - colon = strchr(arg, ':'); - if (!colon) { - /* No colon: empty parameters */ - params = bt_value_map_create(); - goto end; - } - - params_string = colon + 1; ini_error = g_string_new(NULL); if (!ini_error) { print_err_oom(); @@ -619,7 +612,7 @@ struct bt_value *bt_value_from_arg(const char *arg) } /* Try INI-style parsing */ - params = bt_value_from_ini(params_string, ini_error); + params = bt_value_from_ini(arg, ini_error); if (!params) { printf_err("%s", ini_error->str); goto end; @@ -634,9 +627,12 @@ end: /* * Returns the plugin and component names from a command-line - * source/sink option's argument. arg is the full argument, including - * the plugin/component names, the optional colon, and the optional - * parameters. + * source/sink option's argument. arg must have the following format: + * + * PLUGIN.COMPONENT + * + * where PLUGIN is the plugin name, and COMPONENT is the component + * name. * * On success, both *plugin and *component are not NULL. *plugin * and *component are owned by the caller. @@ -646,48 +642,41 @@ void plugin_component_names_from_arg(const char *arg, char **plugin, char **component) { const char *dot; - const char *colon; + const char *end; size_t plugin_len; size_t component_len; + /* Initialize both return values to NULL: not found */ *plugin = NULL; *component = NULL; dot = strchr(arg, '.'); - if (!dot || dot == arg) { - goto end; - } - - colon = strchr(dot, ':'); - if (colon == dot) { + if (!dot) { + /* No dot */ goto end; } - if (!colon) { - colon = arg + strlen(arg); - } + end = arg + strlen(arg); plugin_len = dot - arg; - component_len = colon - dot - 1; + component_len = end - dot - 1; if (plugin_len == 0 || component_len == 0) { goto end; } - *plugin = malloc(plugin_len + 1); + *plugin = g_malloc0(plugin_len + 1); if (!*plugin) { print_err_oom(); goto end; } - (*plugin)[plugin_len] = '\0'; - memcpy(*plugin, arg, plugin_len); - *component = malloc(component_len + 1); + g_strlcpy(*plugin, arg, plugin_len + 1); + *component = g_malloc0(component_len + 1); if (!*component) { print_err_oom(); goto end; } - (*component)[component_len] = '\0'; - memcpy(*component, dot + 1, component_len); + g_strlcpy(*component, dot + 1, component_len + 1); end: return; @@ -739,20 +728,19 @@ void print_legacy_usage(FILE *fp) fprintf(fp, " \n"); fprintf(fp, " --clock-cycles Print timestamps in clock cycles\n"); fprintf(fp, " --clock-date Print timestamp dates\n"); - fprintf(fp, " --clock-gmt Print timestamps in GMT time zone\n"); + fprintf(fp, " --clock-gmt Print and parse timestamps in GMT time zone\n"); fprintf(fp, " (default: local time zone)\n"); 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"); - fprintf(fp, " callsite\n"); + fprintf(fp, " trace:procname, trace:vpid, loglevel, emf\n"); fprintf(fp, " (default: trace:hostname, trace:procname,\n"); fprintf(fp, " trace:vpid)\n"); fprintf(fp, " -n, --names=NAME[,NAME]... Print field names:\n"); @@ -772,50 +760,72 @@ void print_usage(FILE *fp) { fprintf(fp, "Usage: babeltrace [OPTIONS]\n"); fprintf(fp, "\n"); - fprintf(fp, " -h --help Show this help\n"); - fprintf(fp, " --help-legacy Show Babeltrace 1.x legacy options\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=BEGIN Set beginning time to BEGIN\n"); + fprintf(fp, " (format: [YYYY-MM-DD [hh:mm:]]ss[.nnnnnnnnn])\n"); fprintf(fp, " -d, --debug Enable debug mode\n"); + fprintf(fp, " --end=END Set end time to END\n"); + fprintf(fp, " (format: [YYYY-MM-DD [hh:mm:]]ss[.nnnnnnnnn])\n"); fprintf(fp, " -l, --list List available plugins and their components\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, " -i, --source=SOURCE Add source plugin/component SOURCE and its\n"); - fprintf(fp, " parameters to the active sources (may be\n"); - fprintf(fp, " repeated; see the exact format below)\n"); - fprintf(fp, " -o, --sink=SINK Add sink plugin/component SINK and its\n"); - fprintf(fp, " parameters to the active sinks (may be\n"); - fprintf(fp, " repeated; see the exact format below)\n"); + fprintf(fp, " --omit-home-plugin-path Omit home plugins from plugin search path\n"); + fprintf(fp, " (~/.local/lib/babeltrace/plugins)\n"); + fprintf(fp, " --omit-system-plugin-path Omit system plugins from plugin search 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, --path=PATH Set the `path` parameter of the latest source\n"); + fprintf(fp, " or sink component to PATH\n"); + fprintf(fp, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which dynamic\n"); + fprintf(fp, " plugins can be loaded\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, " --timerange=TIMERANGE Set time range to TIMERANGE: BEGIN,END or\n"); + fprintf(fp, " [BEGIN,END] (where [ and ] are actual brackets)\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"); fprintf(fp, " -V, --version Show version\n"); + fprintf(fp, "\n\n"); + fprintf(fp, "Format of PARAMS\n"); + fprintf(fp, "----------------\n"); fprintf(fp, "\n"); - fprintf(fp, "SOURCE/SINK argument format:\n"); - fprintf(fp, "\n"); - fprintf(fp, " One of:\n"); + fprintf(fp, " PARAM=VALUE[,PARAM=VALUE]...\n"); fprintf(fp, "\n"); - fprintf(fp, " PLUGIN.COMPONENT\n"); - fprintf(fp, " Load component COMPONENT from plugin PLUGIN with its default parameters.\n"); + fprintf(fp, "The parameter string is a comma-separated list of PARAM=VALUE assignments,\n"); + fprintf(fp, "where PARAM is the parameter name (C identifier plus [:.-] characters), and\n"); + fprintf(fp, "VALUE can be one of:\n"); fprintf(fp, "\n"); - fprintf(fp, " PLUGIN.COMPONENT:PARAM=VALUE[,PARAM=VALUE]...\n"); - fprintf(fp, " Load component COMPONENT from plugin PLUGIN with the specified parameters.\n"); + fprintf(fp, "* `null`, `nul`, `NULL`: null value (no backticks).\n"); + fprintf(fp, "* `true`, `TRUE`, `yes`, `YES`: true boolean value (no backticks).\n"); + fprintf(fp, "* `false`, `FALSE`, `no`, `NO`: false boolean value (no backticks).\n"); + fprintf(fp, "* Binary (`0b` prefix), octal (`0` prefix), decimal, or hexadecimal\n"); + fprintf(fp, " (`0x` prefix) signed 64-bit integer.\n"); + fprintf(fp, "* Double precision floating point number (scientific notation is accepted).\n"); + fprintf(fp, "* Unquoted string with no special characters, and not matching any of\n"); + fprintf(fp, " the null and boolean value symbols above.\n"); + fprintf(fp, "* Double-quoted string (accepts escape characters).\n"); fprintf(fp, "\n"); - fprintf(fp, " The parameter string is a comma-separated list of PARAM=VALUE assignments,\n"); - fprintf(fp, " where PARAM is the parameter name (C identifier plus [:.-] characters), and\n"); - fprintf(fp, " VALUE can be one of:\n"); + fprintf(fp, "Whitespaces are allowed around individual `=` and `,` tokens.\n"); fprintf(fp, "\n"); - fprintf(fp, " * \"null\", \"nul\", \"NULL\": null value (no double quotes)\n"); - fprintf(fp, " * \"true\", \"TRUE\", \"yes\", \"YES\": true boolean value (no double quotes)\n"); - fprintf(fp, " * \"false\", \"FALSE\", \"no\", \"NO\": false boolean value (no double quotes)\n"); - fprintf(fp, " * Binary (\"0b\" prefix), octal (\"0\" prefix), decimal, or\n"); - fprintf(fp, " hexadecimal (\"0x\" prefix) signed 64-bit integer\n"); - fprintf(fp, " * Double precision floating point number (scientific notation is accepted)\n"); - fprintf(fp, " * Unquoted string with no special characters, and not matching any of\n"); - fprintf(fp, " the null and boolean value symbols above\n"); - fprintf(fp, " * Double-quoted string (accepts escape characters)\n"); + fprintf(fp, "Example:\n"); fprintf(fp, "\n"); - fprintf(fp, " Example:\n"); + fprintf(fp, " many=null, fresh=yes, condition=false, squirrel=-782329,\n"); + fprintf(fp, " observe=3.14, simple=beef, needs-quotes=\"some string\",\n"); + fprintf(fp, " escape.chars-are:allowed=\"this is a \\\" double quote\"\n"); fprintf(fp, "\n"); - fprintf(fp, " plugin.comp:many=null, fresh=yes, condition=false, squirrel=-782329,\n"); - fprintf(fp, " observe=3.14, simple=beef, needs-quotes=\"some string\",\n"); - fprintf(fp, " escape.chars-are:allowed=\"this is a \\\" double quote\"\n"); + fprintf(fp, "IMPORTANT: Make sure to single-quote the whole argument when you run babeltrace\n"); + fprintf(fp, "from a shell.\n"); } /* @@ -847,16 +857,15 @@ end: } /* - * Creates a component configuration using the given plugin name, - * component name, and parameters. plugin_name and component_name - * are copied (belong to the return value), and a reference to - * params is acquired. + * Creates a component configuration using the given plugin name and + * component name. plugin_name and component_name are copied (belong to + * the return value). * * Return value is owned by the caller. */ static struct bt_config_component *bt_config_component_create(const char *plugin_name, - const char *component_name, struct bt_value *params) + const char *component_name) { struct bt_config_component *cfg_component = NULL; @@ -879,7 +888,13 @@ struct bt_config_component *bt_config_component_create(const char *plugin_name, goto error; } - cfg_component->params = bt_get(params); + /* Start with empty parameters */ + cfg_component->params = bt_value_map_create(); + if (!cfg_component->params) { + print_err_oom(); + goto error; + } + goto end; error: @@ -891,9 +906,7 @@ end: /* * Creates a component configuration from a command-line source/sink - * option's argument. arg is the full argument, including - * the plugin/component names, the optional colon, and the optional - * parameters. + * option's argument. */ static struct bt_config_component *bt_config_component_from_arg(const char *arg) @@ -901,22 +914,15 @@ struct bt_config_component *bt_config_component_from_arg(const char *arg) struct bt_config_component *bt_config_component = NULL; char *plugin_name; char *component_name; - struct bt_value *params = NULL; plugin_component_names_from_arg(arg, &plugin_name, &component_name); if (!plugin_name || !component_name) { - printf_err("Cannot get plugin or component name\n"); - goto error; - } - - params = bt_value_from_arg(arg); - if (!params) { - printf_err("Cannot parse parameters\n"); + printf_err("Cannot get plugin or component class name\n"); goto error; } bt_config_component = bt_config_component_create(plugin_name, - component_name, params); + component_name); if (!bt_config_component) { goto error; } @@ -927,9 +933,8 @@ error: BT_PUT(bt_config_component); end: - free(plugin_name); - free(component_name); - BT_PUT(params); + g_free(plugin_name); + g_free(component_name); return bt_config_component; } @@ -961,68 +966,43 @@ end: return; } +static void destroy_gstring(void *data) +{ + g_string_free(data, TRUE); +} + /* * Extracts the various paths from the string arg, delimited by ':', - * and converts them to an array value object. - * - * Returned array value object is empty if arg is empty. - * - * Return value is owned by the caller. + * and appends them to the array value object plugin_paths. */ -static -struct bt_value *plugin_paths_from_arg(const char *arg) +enum bt_value_status bt_config_append_plugin_paths( + struct bt_value *plugin_paths, const char *arg) { - struct bt_value *plugin_paths; - const char *at = arg; - const char *end = arg + strlen(arg); + enum bt_value_status status = BT_VALUE_STATUS_OK; + GPtrArray *dirs = g_ptr_array_new_with_free_func(destroy_gstring); + int ret; + size_t i; - plugin_paths = bt_value_array_create(); - if (!plugin_paths) { - print_err_oom(); - goto error; + if (!dirs) { + status = BT_VALUE_STATUS_ERROR; + goto end; } - while (at < end) { - int ret; - GString *path; - const char *next_colon; - - next_colon = strchr(at, ':'); - if (next_colon == at) { - /* - * Empty path: try next character (supported - * to conform to the typical parsing of $PATH). - */ - at++; - continue; - } else if (!next_colon) { - /* No more colon: use the remaining */ - next_colon = arg + strlen(arg); - } - - path = g_string_new(NULL); - if (!path) { - print_err_oom(); - goto error; - } - - g_string_append_len(path, at, next_colon - at); - at = next_colon + 1; - ret = bt_value_array_append_string(plugin_paths, path->str); - g_string_free(path, TRUE); - if (ret) { - print_err_oom(); - goto error; - } + ret = bt_common_append_plugin_path_dirs(arg, dirs); + if (ret) { + status = BT_VALUE_STATUS_ERROR; + goto end; } - goto end; + for (i = 0; i < dirs->len; i++) { + GString *dir = g_ptr_array_index(dirs, i); -error: - BT_PUT(plugin_paths); + bt_value_array_append_string(plugin_paths, dir->str); + } end: - return plugin_paths; + g_ptr_array_free(dirs, TRUE); + return status; } /* @@ -1154,7 +1134,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; } @@ -1171,7 +1151,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; } /* @@ -1246,7 +1226,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; } @@ -1507,11 +1487,13 @@ int append_sinks_from_legacy_opts(GPtrArray *sinks, /* Create a component configuration */ bt_config_component = bt_config_component_create(plugin_name, - component_name, params); + component_name); if (!bt_config_component) { goto error; } + BT_MOVE(bt_config_component->params, params); + /* Move created component configuration to the array */ g_ptr_array_add(sinks, bt_config_component); @@ -1634,18 +1616,19 @@ int append_sources_from_legacy_opts(GPtrArray *sources, /* Create a component configuration */ bt_config_component = bt_config_component_create("ctf", - component_name, params); + component_name); if (!bt_config_component) { goto error; } + BT_MOVE(bt_config_component->params, params); + /* Move created component configuration to the array */ g_ptr_array_add(sources, bt_config_component); /* Put current stuff */ BT_PUT(input_path); BT_PUT(input_path_copy); - BT_PUT(params); } goto end; @@ -1820,9 +1803,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 "); @@ -1844,7 +1827,7 @@ void print_output_legacy_to_sinks( text_legacy_opts_is_any_set(text_legacy_opts)) { int ret; - g_string_append(str, ":'"); + g_string_append(str, " -p '"); if (g_string_append_string_path_param(str, "output-path", text_legacy_opts->output)) { @@ -1931,9 +1914,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++) { @@ -1957,10 +1940,10 @@ void print_input_legacy_to_sources(enum legacy_input_format legacy_input_format, switch (legacy_input_format) { case LEGACY_INPUT_FORMAT_CTF: - g_string_append(str, "fs:'path=\""); + g_string_append(str, "fs -p 'path=\""); break; case LEGACY_INPUT_FORMAT_LTTNG_LIVE: - g_string_append(str, "lttng-live:'url=\""); + g_string_append(str, "lttng-live -p 'url=\""); break; default: assert(false); @@ -2007,14 +1990,12 @@ bool validate_cfg(struct bt_config *cfg, /* Determine if the input and output should be legacy-style */ if (*legacy_input_format != LEGACY_INPUT_FORMAT_NONE || - cfg->sources->len == 0 || !bt_value_array_is_empty(legacy_input_paths) || ctf_legacy_opts_is_any_set(ctf_legacy_opts)) { legacy_input = true; } if (*legacy_output_format != LEGACY_OUTPUT_FORMAT_NONE || - cfg->sinks->len == 0 || text_legacy_opts_is_any_set(text_legacy_opts)) { legacy_output = true; } @@ -2029,10 +2010,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); @@ -2064,7 +2045,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; } @@ -2082,7 +2063,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; } @@ -2114,6 +2095,8 @@ int parse_int64(const char *arg, int64_t *val) /* popt options */ enum { OPT_NONE = 0, + OPT_BASE_PARAMS, + OPT_BEGIN, OPT_CLOCK_CYCLES, OPT_CLOCK_DATE, OPT_CLOCK_FORCE_CORRELATE, @@ -2125,6 +2108,7 @@ enum { OPT_DEBUG_INFO_DIR, OPT_DEBUG_INFO_FULL_PATH, OPT_DEBUG_INFO_TARGET_PREFIX, + OPT_END, OPT_FIELDS, OPT_HELP, OPT_HELP_LEGACY, @@ -2134,17 +2118,25 @@ enum { OPT_NO_DELTA, OPT_OUTPUT_FORMAT, OPT_OUTPUT_PATH, + OPT_PATH, + OPT_PARAMS, OPT_PLUGIN_PATH, + OPT_RESET_BASE_PARAMS, OPT_SINK, OPT_SOURCE, OPT_STREAM_INTERSECTION, + OPT_TIMERANGE, OPT_VERBOSE, OPT_VERSION, + OPT_OMIT_SYSTEM_PLUGIN_PATH, + OPT_OMIT_HOME_PLUGIN_PATH, }; /* popt long option descriptions */ static struct poptOption long_options[] = { /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */ + { "base-params", 'b', POPT_ARG_STRING, NULL, OPT_BASE_PARAMS, NULL, NULL }, + { "begin", '\0', POPT_ARG_STRING, NULL, OPT_BEGIN, 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 }, @@ -2156,6 +2148,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", '\0', POPT_ARG_STRING, NULL, OPT_END, 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 }, @@ -2165,12 +2158,18 @@ static struct poptOption long_options[] = { { "no-delta", '\0', POPT_ARG_NONE, NULL, OPT_NO_DELTA, NULL, NULL }, { "output", 'w', POPT_ARG_STRING, NULL, OPT_OUTPUT_PATH, NULL, NULL }, { "output-format", 'o', POPT_ARG_STRING, NULL, OPT_OUTPUT_FORMAT, NULL, NULL }, - { "plugin-path", 'p', POPT_ARG_STRING, NULL, OPT_PLUGIN_PATH, NULL, NULL }, + { "path", 'P', POPT_ARG_STRING, NULL, OPT_PATH, NULL, NULL }, + { "params", 'p', POPT_ARG_STRING, NULL, OPT_PARAMS, NULL, NULL }, + { "plugin-path", '\0', POPT_ARG_STRING, NULL, OPT_PLUGIN_PATH, 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 }, { "stream-intersection", '\0', POPT_ARG_NONE, NULL, OPT_STREAM_INTERSECTION, NULL, NULL }, + { "timerange", '\0', POPT_ARG_STRING, NULL, OPT_TIMERANGE, NULL, NULL }, { "verbose", 'v', POPT_ARG_NONE, NULL, OPT_VERBOSE, NULL, NULL }, { "version", 'V', POPT_ARG_NONE, NULL, OPT_VERSION, NULL, NULL }, + { "omit-system-plugin-path", '\0', POPT_ARG_NONE, NULL, OPT_OMIT_SYSTEM_PLUGIN_PATH, NULL, NULL }, + { "omit-home-plugin-path", '\0', POPT_ARG_NONE, NULL, OPT_OMIT_HOME_PLUGIN_PATH, NULL, NULL }, { NULL, 0, 0, NULL, 0, NULL, NULL }, }; @@ -2183,35 +2182,203 @@ static void set_offset_value(struct offset_opt *offset_opt, int64_t value) offset_opt->is_set = true; } +enum bt_config_component_dest { + BT_CONFIG_COMPONENT_DEST_SOURCE, + BT_CONFIG_COMPONENT_DEST_SINK, +}; + /* - * Returns a Babeltrace configuration, out of command-line arguments, - * containing everything that is needed to instanciate specific - * components with given parameters. - * - * *exit_code is set to the appropriate exit code to use as far as this - * function goes. + * Adds a configuration component to the appropriate configuration + * array depending on the destination. + */ +static void add_cfg_comp(struct bt_config *cfg, + struct bt_config_component *cfg_comp, + enum bt_config_component_dest dest) +{ + if (dest == BT_CONFIG_COMPONENT_DEST_SOURCE) { + g_ptr_array_add(cfg->sources, cfg_comp); + } else { + g_ptr_array_add(cfg->sinks, cfg_comp); + } +} + +static int split_timerange(const char *arg, const char **begin, const char **end) +{ + const char *c; + + /* Try to match [begin,end] */ + c = strchr(arg, '['); + if (!c) + goto skip; + *begin = ++c; + c = strchr(c, ','); + if (!c) + goto skip; + *end = ++c; + c = strchr(c, ']'); + if (!c) + goto skip; + goto found; + +skip: + /* Try to match begin,end */ + c = arg; + *begin = c; + c = strchr(c, ','); + if (!c) + goto not_found; + *end = ++c; + /* fall-through */ +found: + return 0; +not_found: + return -1; +} + +static int add_env_var_plugin_paths(struct bt_config *cfg) +{ + int ret = 0; + const char *envvar; + + if (bt_common_is_setuid_setgid()) { + printf_debug("Skipping non-system plugin paths for setuid/setgid binary\n"); + goto end; + } + + envvar = getenv("BABELTRACE_PLUGIN_PATH"); + if (!envvar) { + goto end; + } + + ret = bt_config_append_plugin_paths(cfg->plugin_paths, envvar); + +end: + return ret; +} + +static int append_home_and_system_plugin_paths(struct bt_config *cfg) +{ + int ret; + + if (!cfg->omit_home_plugin_path) { + if (bt_common_is_setuid_setgid()) { + printf_debug("Skipping non-system plugin paths for setuid/setgid binary\n"); + } else { + char *home_plugin_dir = + bt_common_get_home_plugin_path(); + + if (home_plugin_dir) { + ret = bt_config_append_plugin_paths(cfg->plugin_paths, + home_plugin_dir); + free(home_plugin_dir); + + if (ret) { + printf_err("Invalid home plugin path\n"); + goto error; + } + } + } + } + + if (!cfg->omit_system_plugin_path) { + if (bt_config_append_plugin_paths(cfg->plugin_paths, + bt_common_get_system_plugin_path())) { + printf_err("Invalid system plugin path\n"); + goto error; + } + } + return 0; +error: + return -1; +} + +static int append_sources_from_implicit_params(GPtrArray *sources, + struct bt_config_component *implicit_source_comp) +{ + size_t i; + size_t len = sources->len; + + for (i = 0; i < len; i++) { + struct bt_config_component *comp; + struct bt_value *params_to_set; + + comp = g_ptr_array_index(sources, i); + params_to_set = bt_value_map_extend(comp->params, + implicit_source_comp->params); + if (!params_to_set) { + printf_err("Cannot extend legacy component parameters with non-legacy parameters\n"); + goto error; + } + BT_MOVE(comp->params, params_to_set); + } + return 0; +error: + return -1; +} + +struct bt_config *bt_config_create(void) +{ + struct bt_config *cfg; + + /* Create config */ + cfg = g_new0(struct bt_config, 1); + if (!cfg) { + print_err_oom(); + goto error; + } + + bt_object_init(cfg, bt_config_destroy); + cfg->sources = g_ptr_array_new_with_free_func((GDestroyNotify) bt_put); + if (!cfg->sources) { + print_err_oom(); + goto error; + } + + cfg->sinks = g_ptr_array_new_with_free_func((GDestroyNotify) bt_put); + if (!cfg->sinks) { + print_err_oom(); + goto error; + } + + cfg->plugin_paths = bt_value_array_create(); + if (!cfg->plugin_paths) { + print_err_oom(); + goto error; + } +end: + return cfg; +error: + BT_PUT(cfg); + goto end; +} + +/* + * Initializes a created Babeltrace config object according to the + * command-line arguments found in argv. * - * Return value is NULL on error, otherwise it's owned by the caller. + * Return value is set to the appropriate exit code to use. */ -struct bt_config *bt_config_from_args(int argc, char *argv[], int *exit_code) +int bt_config_init_from_args(struct bt_config *cfg, int argc, const char *argv[]) { - struct bt_config *cfg = NULL; poptContext pc = NULL; char *arg = NULL; - struct ctf_legacy_opts ctf_legacy_opts = { 0 }; - struct text_legacy_opts text_legacy_opts = { 0 }; + struct ctf_legacy_opts ctf_legacy_opts; + struct text_legacy_opts text_legacy_opts; enum legacy_input_format legacy_input_format = LEGACY_INPUT_FORMAT_NONE; enum legacy_output_format legacy_output_format = - LEGACY_OUTPUT_FORMAT_NONE; + LEGACY_OUTPUT_FORMAT_NONE; struct bt_value *legacy_input_paths = NULL; - int opt; - - *exit_code = 0; - - if (argc <= 1) { - print_usage(stdout); - goto end; - } + struct bt_config_component *implicit_source_comp = NULL; + struct bt_config_component *cur_cfg_comp = NULL; + bool cur_is_implicit_source = false; + bool use_implicit_source = false; + enum bt_config_component_dest cur_cfg_comp_dest = + BT_CONFIG_COMPONENT_DEST_SOURCE; + struct bt_value *cur_base_params = NULL; + int opt, ret = 0; + + memset(&ctf_legacy_opts, 0, sizeof(ctf_legacy_opts)); + memset(&text_legacy_opts, 0, sizeof(text_legacy_opts)); text_legacy_opts.output = g_string_new(NULL); if (!text_legacy_opts.output) { @@ -2231,30 +2398,33 @@ struct bt_config *bt_config_from_args(int argc, char *argv[], int *exit_code) goto error; } - /* Create config */ - cfg = g_new0(struct bt_config, 1); - if (!cfg) { + cur_base_params = bt_value_map_create(); + if (!cur_base_params) { print_err_oom(); goto error; } - bt_object_init(cfg, bt_config_destroy); - cfg->sources = g_ptr_array_new_with_free_func((GDestroyNotify) bt_put); - if (!cfg->sources) { + legacy_input_paths = bt_value_array_create(); + if (!legacy_input_paths) { print_err_oom(); goto error; } - cfg->sinks = g_ptr_array_new_with_free_func((GDestroyNotify) bt_put); - if (!cfg->sinks) { - print_err_oom(); + ret = add_env_var_plugin_paths(cfg); + if (ret) { + printf_err("Cannot append plugin paths from BABELTRACE_PLUGIN_PATH\n"); goto error; } - legacy_input_paths = bt_value_array_create(); - if (!legacy_input_paths) { - print_err_oom(); - goto error; + /* Note: implicit source never gets positional base params. */ + implicit_source_comp = bt_config_component_from_arg(DEFAULT_SOURCE_COMPONENT_NAME); + if (implicit_source_comp) { + cur_cfg_comp = implicit_source_comp; + cur_is_implicit_source = true; + use_implicit_source = true; + } else { + printf_debug("Cannot find implicit source plugin \"%s\"", + DEFAULT_SOURCE_COMPONENT_NAME); } /* Parse options */ @@ -2271,17 +2441,21 @@ struct bt_config *bt_config_from_args(int argc, char *argv[], int *exit_code) switch (opt) { case OPT_PLUGIN_PATH: - if (cfg->plugin_paths) { - printf_err("Duplicate --plugin-path option\n"); - goto error; - } - - cfg->plugin_paths = plugin_paths_from_arg(arg); - if (!cfg->plugin_paths) { - printf_err("Invalid --plugin-path option's argument\n"); - goto error; + if (bt_common_is_setuid_setgid()) { + printf_debug("Skipping non-system plugin paths for setuid/setgid binary\n"); + } else { + if (bt_config_append_plugin_paths(cfg->plugin_paths, arg)) { + printf_err("Invalid --plugin-path option's argument\n"); + goto error; + } } break; + case OPT_OMIT_SYSTEM_PLUGIN_PATH: + cfg->omit_system_plugin_path = true; + break; + case OPT_OMIT_HOME_PLUGIN_PATH: + cfg->omit_home_plugin_path = true; + break; case OPT_OUTPUT_PATH: if (text_legacy_opts.output->len > 0) { printf_err("Duplicate --output option\n"); @@ -2309,8 +2483,6 @@ struct bt_config *bt_config_from_args(int argc, char *argv[], int *exit_code) case OPT_INPUT_FORMAT: case OPT_SOURCE: { - struct bt_config_component *bt_config_component; - if (opt == OPT_INPUT_FORMAT) { if (!strcmp(arg, "ctf")) { /* Legacy CTF input format */ @@ -2335,22 +2507,36 @@ struct bt_config *bt_config_from_args(int argc, char *argv[], int *exit_code) } } + use_implicit_source = false; + /* Non-legacy: try to create a component config */ - bt_config_component = bt_config_component_from_arg(arg); - if (!bt_config_component) { - printf_err("Invalid source component format:\n %s\n", + if (cur_cfg_comp && !cur_is_implicit_source) { + add_cfg_comp(cfg, cur_cfg_comp, + cur_cfg_comp_dest); + } + + cur_cfg_comp = bt_config_component_from_arg(arg); + if (!cur_cfg_comp) { + printf_err("Invalid format for --source option's argument:\n %s\n", arg); goto error; } + cur_is_implicit_source = false; - g_ptr_array_add(cfg->sources, bt_config_component); + assert(cur_base_params); + bt_put(cur_cfg_comp->params); + cur_cfg_comp->params = bt_value_copy(cur_base_params); + if (!cur_cfg_comp->params) { + print_err_oom(); + goto end; + } + + cur_cfg_comp_dest = BT_CONFIG_COMPONENT_DEST_SOURCE; break; } case OPT_OUTPUT_FORMAT: case OPT_SINK: { - struct bt_config_component *bt_config_component; - if (opt == OPT_OUTPUT_FORMAT) { if (!strcmp(arg, "text")) { /* Legacy CTF-text output format */ @@ -2386,16 +2572,96 @@ struct bt_config *bt_config_from_args(int argc, char *argv[], int *exit_code) } /* Non-legacy: try to create a component config */ - bt_config_component = bt_config_component_from_arg(arg); - if (!bt_config_component) { - printf_err("Invalid sink component format:\n %s\n", + if (cur_cfg_comp && !cur_is_implicit_source) { + add_cfg_comp(cfg, cur_cfg_comp, + cur_cfg_comp_dest); + } + + cur_cfg_comp = bt_config_component_from_arg(arg); + if (!cur_cfg_comp) { + printf_err("Invalid format for --sink option's argument:\n %s\n", + arg); + goto error; + } + cur_is_implicit_source = false; + + assert(cur_base_params); + bt_put(cur_cfg_comp->params); + cur_cfg_comp->params = bt_value_copy(cur_base_params); + if (!cur_cfg_comp->params) { + print_err_oom(); + goto end; + } + + cur_cfg_comp_dest = BT_CONFIG_COMPONENT_DEST_SINK; + break; + } + case OPT_PARAMS: + { + struct bt_value *params; + struct bt_value *params_to_set; + + if (!cur_cfg_comp) { + printf_err("Can not apply parameter to unavailable default source component \"%s\".\n", + DEFAULT_SOURCE_COMPONENT_NAME); + goto error; + } + + params = bt_value_from_arg(arg); + if (!params) { + printf_err("Invalid format for --params option's argument:\n %s\n", + arg); + goto error; + } + + params_to_set = bt_value_map_extend(cur_cfg_comp->params, + params); + BT_PUT(params); + if (!params_to_set) { + printf_err("Cannot extend current component parameters with --params option's argument:\n %s\n", + arg); + goto error; + } + + BT_MOVE(cur_cfg_comp->params, params_to_set); + break; + } + case OPT_PATH: + if (!cur_cfg_comp) { + printf_err("Can not apply parameter to unavailable default source component \"%s\".\n", + DEFAULT_SOURCE_COMPONENT_NAME); + goto error; + } + + assert(cur_cfg_comp->params); + + if (bt_value_map_insert_string(cur_cfg_comp->params, + "path", arg)) { + print_err_oom(); + goto error; + } + break; + case OPT_BASE_PARAMS: + { + struct bt_value *params = bt_value_from_arg(arg); + + if (!params) { + printf_err("Invalid format for --base-params option's argument:\n %s\n", arg); goto error; } - g_ptr_array_add(cfg->sinks, bt_config_component); + BT_MOVE(cur_base_params, params); break; } + case OPT_RESET_BASE_PARAMS: + BT_PUT(cur_base_params); + cur_base_params = bt_value_map_create(); + if (!cur_base_params) { + print_err_oom(); + goto error; + } + break; case OPT_NAMES: if (text_legacy_opts.names) { printf_err("Duplicate --names option\n"); @@ -2478,16 +2744,74 @@ struct bt_config *bt_config_from_args(int argc, char *argv[], int *exit_code) case OPT_CLOCK_FORCE_CORRELATE: cfg->force_correlate = true; break; + case OPT_BEGIN: + if (!cur_cfg_comp) { + printf_err("Can not apply parameter to unavailable default source component \"%s\".\n", + DEFAULT_SOURCE_COMPONENT_NAME); + goto error; + } + if (cur_cfg_comp_dest != BT_CONFIG_COMPONENT_DEST_SOURCE) { + printf_err("--begin option must follow a --source option\n"); + goto error; + } + if (bt_value_map_insert_string(cur_cfg_comp->params, + "begin", arg)) { + print_err_oom(); + goto error; + } + break; + case OPT_END: + if (!cur_cfg_comp) { + printf_err("Can not apply parameter to unavailable default source component \"%s\".\n", + DEFAULT_SOURCE_COMPONENT_NAME); + goto error; + } + if (cur_cfg_comp_dest != BT_CONFIG_COMPONENT_DEST_SOURCE) { + printf_err("--end option must follow a --source option\n"); + goto error; + } + if (bt_value_map_insert_string(cur_cfg_comp->params, + "end", arg)) { + print_err_oom(); + goto error; + } + break; + case OPT_TIMERANGE: + { + const char *begin, *end; + + if (!cur_cfg_comp) { + printf_err("Can not apply parameter to unavailable default source component \"%s\".\n", + DEFAULT_SOURCE_COMPONENT_NAME); + goto error; + } + if (cur_cfg_comp_dest != BT_CONFIG_COMPONENT_DEST_SOURCE) { + printf_err("--timerange option must follow a --source option\n"); + goto error; + } + if (split_timerange(arg, &begin, &end)) { + printf_err("Invalid --timerange format, expecting: begin,end or [begin,end] (where [] are actual brackets)\n"); + goto error; + } + if (bt_value_map_insert_string(cur_cfg_comp->params, + "begin", begin)) { + print_err_oom(); + goto error; + } + if (bt_value_map_insert_string(cur_cfg_comp->params, + "end", end)) { + print_err_oom(); + goto error; + } + break; + } case OPT_HELP: - BT_PUT(cfg); print_usage(stdout); goto end; case OPT_HELP_LEGACY: - BT_PUT(cfg); print_legacy_usage(stdout); goto end; case OPT_VERSION: - BT_PUT(cfg); print_version(); goto end; case OPT_LIST: @@ -2509,6 +2833,11 @@ struct bt_config *bt_config_from_args(int argc, char *argv[], int *exit_code) arg = NULL; } + if (argc <= 1) { + print_usage(stdout); + goto end; + } + /* Check for option parsing error */ if (opt < -1) { printf_err("While parsing command-line options, at option %s: %s\n", @@ -2531,6 +2860,16 @@ struct bt_config *bt_config_from_args(int argc, char *argv[], int *exit_code) } } + if (append_home_and_system_plugin_paths(cfg)) { + goto error; + } + + /* Append current component configuration, if any */ + if (cur_cfg_comp && !cur_is_implicit_source) { + add_cfg_comp(cfg, cur_cfg_comp, cur_cfg_comp_dest); + } + cur_cfg_comp = NULL; + /* Validate legacy/non-legacy options */ if (!validate_cfg(cfg, &legacy_input_format, &legacy_output_format, legacy_input_paths, &ctf_legacy_opts, @@ -2547,9 +2886,27 @@ struct bt_config *bt_config_from_args(int argc, char *argv[], int *exit_code) 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"); + printf_err("Cannot convert legacy input format options to source component instance(s)\n"); + goto error; + } + if (append_sources_from_implicit_params(cfg->sources, + implicit_source_comp)) { + printf_err("Cannot initialize legacy component parameters\n"); goto error; } + use_implicit_source = false; + } else { + if (use_implicit_source) { + add_cfg_comp(cfg, implicit_source_comp, + BT_CONFIG_COMPONENT_DEST_SOURCE); + implicit_source_comp = NULL; + } else { + if (implicit_source_comp + && !bt_value_map_is_empty(implicit_source_comp->params)) { + printf_err("Arguments specified for implicit source, but an explicit source has been specified, overriding it\n"); + goto error; + } + } } /* @@ -2559,18 +2916,27 @@ 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; } } + if (cfg->sinks->len == 0) { + /* Use implicit sink as default. */ + cur_cfg_comp = bt_config_component_from_arg(DEFAULT_SINK_COMPONENT_NAME); + if (!cur_cfg_comp) { + printf_error("Cannot find implicit sink plugin \"%s\"\n", + DEFAULT_SINK_COMPONENT_NAME); + } + add_cfg_comp(cfg, cur_cfg_comp, + BT_CONFIG_COMPONENT_DEST_SINK); + cur_cfg_comp = NULL; + } + goto end; error: - BT_PUT(cfg); - cfg = NULL; - *exit_code = 1; - + ret = 1; end: if (pc) { poptFreeContext(pc); @@ -2589,8 +2955,11 @@ end: } free(arg); + BT_PUT(implicit_source_comp); + BT_PUT(cur_cfg_comp); + BT_PUT(cur_base_params); BT_PUT(text_legacy_opts.names); BT_PUT(text_legacy_opts.fields); BT_PUT(legacy_input_paths); - return cfg; + return ret; }