X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fbin%2Flttng%2Fcommands%2Fview.c;h=a2623fe49e0ccb66b4baecbf1f27552d22ffad43;hp=44e0cb015c93e90bc31cc553bead112f368602cd;hb=ce0b1d61919f37517a6212f7af2afe0fa1b1dcb0;hpb=890d8fe47755c3bad936389cf48ffa141cff41c9 diff --git a/src/bin/lttng/commands/view.c b/src/bin/lttng/commands/view.c index 44e0cb015..a2623fe49 100644 --- a/src/bin/lttng/commands/view.c +++ b/src/bin/lttng/commands/view.c @@ -1,18 +1,8 @@ /* - * Copyright (C) 2011 - David Goulet + * Copyright (C) 2011 David Goulet * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License, version 2 only, - * as published by the Free Software Foundation. + * SPDX-License-Identifier: GPL-2.0-only * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License along - * with this program; if not, write to the Free Software Foundation, Inc., - * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ #define _LGPL_SOURCE @@ -24,13 +14,18 @@ #include #include +#include #include "../command.h" static char *opt_session_name; static char *opt_viewer; static char *opt_trace_path; -static const char *babeltrace_bin = CONFIG_BABELTRACE_BIN; -//static const char *lttv_gui_bin = CONFIG_LTTV_GUI_BIN; + +#ifdef LTTNG_EMBED_HELP +static const char help_msg[] = +#include +; +#endif enum { OPT_HELP = 1, @@ -46,246 +41,9 @@ static struct poptOption long_options[] = { {0, 0, 0, 0, 0, 0, 0} }; -/* - * This is needed for each viewer since we are using execvp(). - */ -static const char *babeltrace_opts[] = { "babeltrace" }; -//static const char *lttv_gui_opts[] = { "lttv-gui", "-t", }; - -/* - * Type is also use as the index in the viewers array. So please, make sure - * your enum value is in the right order in the array below. - */ -enum viewer_type { - VIEWER_BABELTRACE = 0, - VIEWER_LTTV_GUI = 1, - VIEWER_USER_DEFINED = 2, -}; - -/* - * NOTE: "lttv" is a shell command and it's not working for exec() family - * functions so we might think of removing this wrapper or using bash. - */ -static struct viewers { - const char *exec_name; - enum viewer_type type; -} viewers[] = { - { "babeltrace", VIEWER_BABELTRACE }, - { "lttv-gui", VIEWER_LTTV_GUI }, - { NULL, VIEWER_USER_DEFINED }, -}; - /* Is the session we are trying to view is in live mode. */ static int session_live_mode; -/* - * usage - */ -static void usage(FILE *ofp) -{ - fprintf(ofp, "usage: lttng view [SESSION_NAME] [OPTIONS]\n"); - fprintf(ofp, "\n"); - fprintf(ofp, "By default, the babeltrace viewer will be used for text viewing\n"); - fprintf(ofp, "\n"); - fprintf(ofp, "Where SESSION_NAME is an optional session name. If not specified, lttng will\n"); - fprintf(ofp, "get it from the configuration file (.lttngrc).\n"); - fprintf(ofp, "\n"); - fprintf(ofp, "Options:\n"); - fprintf(ofp, " -h, --help Show this help\n"); - fprintf(ofp, " --list-options Simple listing of options\n"); - fprintf(ofp, " -t, --trace-path PATH Trace directory path for the viewer\n"); - fprintf(ofp, " -e, --viewer CMD Specify viewer and/or options to use\n"); - fprintf(ofp, " This will completely override the default viewers so\n"); - fprintf(ofp, " please make sure to specify the full command. The trace\n"); - fprintf(ofp, " directory path of the session will be appended at the end\n"); - fprintf(ofp, " to the arguments\n"); - fprintf(ofp, "\n"); -} - -static struct viewers *parse_options(void) -{ - if (opt_viewer == NULL) { - /* Default is babeltrace */ - return &(viewers[VIEWER_BABELTRACE]); - } - - /* - * This means that if -e, --viewers is used, we just override everything - * with it. For supported viewers like lttv, we could simply detect if "-t" - * is passed and if not, add the trace directory to it. - */ - return &(viewers[VIEWER_USER_DEFINED]); -} - -/* - * Alloc an array of string pointer from a simple string having all options - * seperated by spaces. Also adds the trace path to the arguments. - * - * The returning pointer is ready to be passed to execvp(). - */ -static char **alloc_argv_from_user_opts(char *opts, const char *trace_path) -{ - int i = 0, ignore_space = 0; - unsigned int num_opts = 1; - char **argv, *token = opts; - - /* Count number of arguments. */ - do { - if (*token == ' ') { - /* Use to ignore consecutive spaces */ - if (!ignore_space) { - num_opts++; - } - ignore_space = 1; - } else { - ignore_space = 0; - } - token++; - } while (*token != '\0'); - - /* Add two here for the NULL terminating element and trace path */ - argv = zmalloc(sizeof(char *) * (num_opts + 2)); - if (argv == NULL) { - goto error; - } - - token = strtok(opts, " "); - while (token != NULL) { - argv[i] = strdup(token); - if (argv[i] == NULL) { - goto error; - } - token = strtok(NULL, " "); - i++; - } - - argv[num_opts] = (char *) trace_path; - argv[num_opts + 1] = NULL; - - return argv; - -error: - if (argv) { - for (i = 0; i < num_opts + 2; i++) { - free(argv[i]); - } - free(argv); - } - - return NULL; -} - -/* - * Alloc an array of string pointer from an array of strings. It also adds - * the trace path to the argv. - * - * The returning pointer is ready to be passed to execvp(). - */ -static char **alloc_argv_from_local_opts(const char **opts, size_t opts_len, - const char *trace_path) -{ - char **argv; - size_t size, mem_len; - - - /* Add one for the NULL terminating element. */ - mem_len = opts_len + 1; - if (session_live_mode) { - /* Add 3 option for the live mode being "-i lttng-live URL". */ - mem_len += 3; - } else { - /* Add option for the trace path. */ - mem_len += 1; - } - - size = sizeof(char *) * mem_len; - - /* Add two here for the trace_path and the NULL terminating element. */ - argv = zmalloc(size); - if (argv == NULL) { - goto error; - } - - memcpy(argv, opts, size); - - if (session_live_mode) { - argv[opts_len] = "-i"; - argv[opts_len + 1] = "lttng-live"; - argv[opts_len + 2] = (char *) trace_path; - argv[opts_len + 3] = NULL; - } else { - argv[opts_len] = (char *) trace_path; - argv[opts_len + 1] = NULL; - } - -error: - return argv; -} - -/* - * Spawn viewer with the trace directory path. - */ -static int spawn_viewer(const char *trace_path) -{ - int ret = 0; - struct stat status; - const char *viewer_bin = NULL; - struct viewers *viewer; - char **argv = NULL; - - /* Check for --viewer options */ - viewer = parse_options(); - if (viewer == NULL) { - ret = CMD_ERROR; - goto error; - } - - switch (viewer->type) { - case VIEWER_BABELTRACE: - if (stat(babeltrace_bin, &status) == 0) { - viewer_bin = babeltrace_bin; - } else { - viewer_bin = viewer->exec_name; - } - argv = alloc_argv_from_local_opts(babeltrace_opts, - ARRAY_SIZE(babeltrace_opts), trace_path); - break; - case VIEWER_USER_DEFINED: - argv = alloc_argv_from_user_opts(opt_viewer, trace_path); - if (argv) { - viewer_bin = argv[0]; - } - break; - default: - viewer_bin = viewers[VIEWER_BABELTRACE].exec_name; - argv = alloc_argv_from_local_opts(babeltrace_opts, - ARRAY_SIZE(babeltrace_opts), trace_path); - break; - } - - if (argv == NULL || !viewer_bin) { - ret = CMD_FATAL; - goto error; - } - - DBG("Using %s viewer", viewer_bin); - - ret = execvp(viewer_bin, argv); - if (ret) { - if (errno == ENOENT) { - ERR("%s not found on the system", viewer_bin); - } else { - PERROR("exec: %s", viewer_bin); - } - free(argv); - ret = CMD_FATAL; - goto error; - } - -error: - return ret; -} - /* * Build the live path we need for the lttng live view. */ @@ -293,7 +51,7 @@ static char *build_live_path(char *session_name) { int ret; char *path = NULL; - char hostname[HOST_NAME_MAX]; + char hostname[LTTNG_HOST_NAME_MAX]; ret = gethostname(hostname, sizeof(hostname)); if (ret < 0) { @@ -320,6 +78,7 @@ static int view_trace(void) int ret; char *session_name, *trace_path = NULL; struct lttng_session *sessions = NULL; + bool free_trace_path = false; /* * Safety net. If lttng is suid at some point for *any* useless reasons, @@ -397,6 +156,7 @@ static int view_trace(void) ret = CMD_ERROR; goto free_sessions; } + free_trace_path = true; } else { /* Get file system session path. */ trace_path = sessions[i].path; @@ -407,14 +167,14 @@ static int view_trace(void) MSG("Trace directory: %s\n", trace_path); - ret = spawn_viewer(trace_path); + ret = spawn_viewer(trace_path, opt_viewer, session_live_mode); if (ret < 0) { /* Don't set ret so lttng can interpret the sessiond error. */ goto free_sessions; } free_sessions: - if (session_live_mode) { + if (session_live_mode && free_trace_path) { free(trace_path); } free(sessions); @@ -433,6 +193,7 @@ int cmd_view(int argc, const char **argv) { int opt, ret = CMD_SUCCESS; static poptContext pc; + const char *leftover = NULL; pc = poptGetContext(NULL, argc, argv, long_options, 0); poptReadDefaultConfig(pc, 0); @@ -444,13 +205,12 @@ int cmd_view(int argc, const char **argv) while ((opt = poptGetNextOpt(pc)) != -1) { switch (opt) { case OPT_HELP: - usage(stdout); + SHOW_HELP(); goto end; case OPT_LIST_OPTIONS: list_cmd_options(stdout, long_options); goto end; default: - usage(stderr); ret = CMD_UNDEFINED; goto end; } @@ -458,6 +218,13 @@ int cmd_view(int argc, const char **argv) opt_session_name = (char*) poptGetArg(pc); + leftover = poptGetArg(pc); + if (leftover) { + ERR("Unknown argument: %s", leftover); + ret = CMD_ERROR; + goto end; + } + ret = view_trace(); end: