#include <stdbool.h>
#include <inttypes.h>
#include <babeltrace/babeltrace.h>
+#include <babeltrace/common-internal.h>
#include <babeltrace/values.h>
#include <popt.h>
#include <glib.h>
#include <pwd.h>
#include "babeltrace-cfg.h"
-#define SYSTEM_PLUGIN_PATH INSTALL_LIBDIR "/babeltrace/plugins"
#define DEFAULT_SOURCE_COMPONENT_NAME "ctf.fs"
-#define HOME_ENV_VAR "HOME"
-#define HOME_SUBPATH "/.babeltrace/plugins"
+#define DEFAULT_SINK_COMPONENT_NAME "text.text"
/*
* Error printf() macro which prepends "Error: " the first time it's
LEGACY_OUTPUT_FORMAT_DUMMY,
};
-static bool omit_system_plugin_path;
-static bool omit_home_plugin_path;
-
/*
* Prints the "out of memory" error.
*/
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, --path=PATH Set the `path` parameter of the latest source\n");
- fprintf(fp, " or sink component to PATH\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, " --plugin-path=PATH[:PATH]... Set paths from which dynamic plugins can be\n");
- fprintf(fp, " loaded to PATH\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, " -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, " --begin Start time: [YYYY-MM-DD [hh:mm:]]ss[.nnnnnnnnn]\n");
- fprintf(fp, " --end End time: [YYYY-MM-DD [hh:mm:]]ss[.nnnnnnnnn]\n");
- fprintf(fp, " --timerange Time range: begin,end or [begin,end] (where [] are actual brackets)\n");
- fprintf(fp, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
- fprintf(fp, " --omit-home-plugin-path Omit home plugins from plugin search path\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");
return;
}
-static
-bool is_setuid_setgid(void)
+static void destroy_gstring(void *data)
{
- return (geteuid() != getuid() || getegid() != getgid());
+ 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
-enum bt_value_status plugin_paths_from_arg(struct bt_value *plugin_paths,
- const char *arg)
+enum bt_value_status bt_config_append_plugin_paths(
+ struct bt_value *plugin_paths, const char *arg)
{
- 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;
- while (at < end) {
- int ret;
- GString *path;
- const char *next_colon;
+ if (!dirs) {
+ status = BT_VALUE_STATUS_ERROR;
+ goto end;
+ }
- 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);
- }
+ ret = bt_common_append_plugin_path_dirs(arg, dirs);
+ if (ret) {
+ status = BT_VALUE_STATUS_ERROR;
+ goto end;
+ }
- path = g_string_new(NULL);
- if (!path) {
- print_err_oom();
- goto error;
- }
+ for (i = 0; i < dirs->len; i++) {
+ GString *dir = g_ptr_array_index(dirs, i);
- 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;
- }
+ bt_value_array_append_string(plugin_paths, dir->str);
}
- return BT_VALUE_STATUS_OK;
-error:
- return BT_VALUE_STATUS_ERROR;
+end:
+ g_ptr_array_free(dirs, TRUE);
+ return status;
}
/*
enum legacy_output_format *legacy_output_format,
struct bt_value *legacy_input_paths,
struct ctf_legacy_opts *ctf_legacy_opts,
- struct text_legacy_opts *text_legacy_opts,
- bool *use_implicit_source)
+ struct text_legacy_opts *text_legacy_opts)
{
bool legacy_input = false;
bool legacy_output = false;
/* 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;
}
if (legacy_input) {
- *use_implicit_source = false;
/* If no legacy input format was specified, default to CTF */
if (*legacy_input_format == LEGACY_INPUT_FORMAT_NONE) {
*legacy_input_format = LEGACY_INPUT_FORMAT_CTF;
}
if (legacy_output) {
- *use_implicit_source = false;
/*
* If no legacy output format was specified, default to
* "text".
return -1;
}
-static char *bt_secure_getenv(const char *name)
-{
- if (is_setuid_setgid()) {
- printf_err("Disregarding %s environment variable for setuid/setgid binary", name);
- return NULL;
- }
- return getenv(name);
-}
-
-static const char *get_home_dir(void)
+static int add_env_var_plugin_paths(struct bt_config *cfg)
{
- char *val = NULL;
- struct passwd *pwd;
+ int ret = 0;
+ const char *envvar;
- val = bt_secure_getenv(HOME_ENV_VAR);
- if (val) {
+ if (bt_common_is_setuid_setgid()) {
+ printf_debug("Skipping non-system plugin paths for setuid/setgid binary\n");
goto end;
}
- /* Fallback on password file. */
- pwd = getpwuid(getuid());
- if (!pwd) {
+
+ envvar = getenv("BABELTRACE_PLUGIN_PATH");
+ if (!envvar) {
goto end;
}
- val = pwd->pw_dir;
+
+ ret = bt_config_append_plugin_paths(cfg->plugin_paths, envvar);
+
end:
- return val;
+ return ret;
}
-static int add_internal_plugin_paths(struct bt_config *cfg)
+static int append_home_and_system_plugin_paths(struct bt_config *cfg)
{
- if (!omit_home_plugin_path) {
- char path[PATH_MAX];
- const char *home_dir;
+ int ret;
- if (is_setuid_setgid()) {
- printf_debug("Skipping non-system plugin paths for setuid/setgid binary.");
+ 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 {
- home_dir = get_home_dir();
- if (home_dir) {
- if (strlen(home_dir) + strlen(HOME_SUBPATH) + 1
- >= PATH_MAX) {
- printf_err("Home directory path too long\n");
- goto error;
- }
- strcpy(path, home_dir);
- strcat(path, HOME_SUBPATH);
- if (plugin_paths_from_arg(cfg->plugin_paths, path)) {
+ 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 (!omit_system_plugin_path) {
- if (plugin_paths_from_arg(cfg->plugin_paths,
- SYSTEM_PLUGIN_PATH)) {
+ 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 -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;
+}
+
/*
- * Returns a Babeltrace configuration, out of command-line arguments,
- * containing everything that is needed to instanciate specific
- * components with given parameters.
+ * Initializes a created Babeltrace config object according to the
+ * command-line arguments found in argv.
*
- * *exit_code is set to the appropriate exit code to use as far as this
- * function goes.
- *
- * 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, const 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;
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;
struct bt_config_component *implicit_source_comp = NULL;
struct bt_config_component *cur_cfg_comp = NULL;
enum bt_config_component_dest cur_cfg_comp_dest =
BT_CONFIG_COMPONENT_DEST_SOURCE;
struct bt_value *cur_base_params = NULL;
- int opt;
+ int opt, ret = 0;
memset(&ctf_legacy_opts, 0, sizeof(ctf_legacy_opts));
memset(&text_legacy_opts, 0, sizeof(text_legacy_opts));
- *exit_code = 0;
-
- if (argc <= 1) {
- print_usage(stdout);
- goto end;
- }
text_legacy_opts.output = g_string_new(NULL);
if (!text_legacy_opts.output) {
goto error;
}
- /* 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) {
+ legacy_input_paths = bt_value_array_create();
+ if (!legacy_input_paths) {
print_err_oom();
goto error;
}
- legacy_input_paths = bt_value_array_create();
- if (!legacy_input_paths) {
- 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;
}
DEFAULT_SOURCE_COMPONENT_NAME);
}
- cfg->plugin_paths = bt_value_array_create();
- if (!cfg->plugin_paths) {
- print_err_oom();
- goto error;
- }
-
/* Parse options */
pc = poptGetContext(NULL, argc, (const char **) argv, long_options, 0);
if (!pc) {
switch (opt) {
case OPT_PLUGIN_PATH:
- if (is_setuid_setgid()) {
- printf_debug("Skipping non-system plugin paths for setuid/setgid binary.");
+ if (bt_common_is_setuid_setgid()) {
+ printf_debug("Skipping non-system plugin paths for setuid/setgid binary\n");
} else {
- if (plugin_paths_from_arg(cfg->plugin_paths, arg)) {
+ 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:
- omit_system_plugin_path = true;
+ cfg->omit_system_plugin_path = true;
break;
case OPT_OMIT_HOME_PLUGIN_PATH:
- omit_home_plugin_path = true;
+ cfg->omit_home_plugin_path = true;
break;
case OPT_OUTPUT_PATH:
if (text_legacy_opts.output->len > 0) {
assert(cur_base_params);
bt_put(cur_cfg_comp->params);
cur_cfg_comp->params = bt_value_copy(cur_base_params);
- if (!cur_cfg_comp) {
+ if (!cur_cfg_comp->params) {
print_err_oom();
goto end;
}
assert(cur_base_params);
bt_put(cur_cfg_comp->params);
cur_cfg_comp->params = bt_value_copy(cur_base_params);
- if (!cur_cfg_comp) {
+ if (!cur_cfg_comp->params) {
print_err_oom();
goto end;
}
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:
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",
}
}
- if (add_internal_plugin_paths(cfg)) {
+ if (append_home_and_system_plugin_paths(cfg)) {
goto error;
}
/* Validate legacy/non-legacy options */
if (!validate_cfg(cfg, &legacy_input_format, &legacy_output_format,
legacy_input_paths, &ctf_legacy_opts,
- &text_legacy_opts, &use_implicit_source)) {
+ &text_legacy_opts)) {
printf_err("Command-line options form an invalid configuration\n");
goto error;
}
- 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;
- }
- }
-
/*
* If there's a legacy input format, convert it to source
* component configurations.
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;
+ }
+ }
}
/*
}
}
+ 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);
BT_PUT(text_legacy_opts.names);
BT_PUT(text_legacy_opts.fields);
BT_PUT(legacy_input_paths);
- return cfg;
+ return ret;
}
projects / babeltrace.git / blobdiff