X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fbin%2Flttng%2Fcommands%2Fview.c;h=1a9ad6c3a3868978467563b791cff34a133f6b35;hp=dcd4d66245fb5049fa241c00feb771fdf52d93ba;hb=a85cae2bef6e4583072236c71770d4244ec5cf9d;hpb=c7e35b037773dbbfe10178c946ba44feefb226e1 diff --git a/src/bin/lttng/commands/view.c b/src/bin/lttng/commands/view.c index dcd4d6624..1a9ad6c3a 100644 --- a/src/bin/lttng/commands/view.c +++ b/src/bin/lttng/commands/view.c @@ -1,21 +1,11 @@ /* - * 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 _GNU_SOURCE +#define _LGPL_SOURCE #include #include #include @@ -25,13 +15,18 @@ #include #include "../command.h" -#include 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; +static const char *babeltrace2_bin = CONFIG_BABELTRACE2_BIN; + +#ifdef LTTNG_EMBED_HELP +static const char help_msg[] = +#include +; +#endif enum { OPT_HELP = 1, @@ -51,7 +46,7 @@ static struct poptOption long_options[] = { * 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", }; +static const char *babeltrace2_opts[] = { "babeltrace2" }; /* * Type is also use as the index in the viewers array. So please, make sure @@ -59,68 +54,29 @@ static const char *babeltrace_opts[] = { "babeltrace" }; */ enum viewer_type { VIEWER_BABELTRACE = 0, - VIEWER_LTTV_GUI = 1, + VIEWER_BABELTRACE2 = 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 { +static const struct viewers { const char *exec_name; enum viewer_type type; } viewers[] = { { "babeltrace", VIEWER_BABELTRACE }, - { "lttv-gui", VIEWER_LTTV_GUI }, + { "babeltrace2", VIEWER_BABELTRACE2 }, { 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) +static const struct viewers *parse_options(void) { if (opt_viewer == NULL) { /* Default is babeltrace */ - return &(viewers[VIEWER_BABELTRACE]); + return &(viewers[VIEWER_BABELTRACE2]); } -#if 0 - if (strstr(opt_viewer, viewers[VIEWER_LTTV_GUI].exec_name) == 0) { - return &(viewers[VIEWER_LTTV_GUI]); - } -#endif - - /* - * 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]); } @@ -151,7 +107,7 @@ static char **alloc_argv_from_user_opts(char *opts, const char *trace_path) } while (*token != '\0'); /* Add two here for the NULL terminating element and trace path */ - argv = malloc(sizeof(char *) * (num_opts + 2)); + argv = zmalloc(sizeof(char *) * (num_opts + 2)); if (argv == NULL) { goto error; } @@ -159,6 +115,9 @@ static char **alloc_argv_from_user_opts(char *opts, const char *trace_path) token = strtok(opts, " "); while (token != NULL) { argv[i] = strdup(token); + if (argv[i] == NULL) { + goto error; + } token = strtok(NULL, " "); i++; } @@ -169,6 +128,13 @@ static char **alloc_argv_from_user_opts(char *opts, const char *trace_path) return argv; error: + if (argv) { + for (i = 0; i < num_opts + 2; i++) { + free(argv[i]); + } + free(argv); + } + return NULL; } @@ -184,7 +150,6 @@ static char **alloc_argv_from_local_opts(const char **opts, size_t opts_len, char **argv; size_t size, mem_len; - /* Add one for the NULL terminating element. */ mem_len = opts_len + 1; if (session_live_mode) { @@ -198,16 +163,16 @@ static char **alloc_argv_from_local_opts(const char **opts, size_t opts_len, size = sizeof(char *) * mem_len; /* Add two here for the trace_path and the NULL terminating element. */ - argv = malloc(size); + argv = zmalloc(size); if (argv == NULL) { goto error; } - memcpy(argv, opts, size); + memcpy(argv, opts, sizeof(char *) * opts_len); if (session_live_mode) { - argv[opts_len] = "-i"; - argv[opts_len + 1] = "lttng-live"; + argv[opts_len] = (char *) "-i"; + argv[opts_len + 1] = (char *) "lttng-live"; argv[opts_len + 2] = (char *) trace_path; argv[opts_len + 3] = NULL; } else { @@ -227,7 +192,7 @@ static int spawn_viewer(const char *trace_path) int ret = 0; struct stat status; const char *viewer_bin = NULL; - struct viewers *viewer; + const struct viewers *viewer; char **argv = NULL; /* Check for --viewer options */ @@ -237,7 +202,17 @@ static int spawn_viewer(const char *trace_path) goto error; } +retry_viewer: switch (viewer->type) { + case VIEWER_BABELTRACE2: + if (stat(babeltrace2_bin, &status) == 0) { + viewer_bin = babeltrace2_bin; + } else { + viewer_bin = viewer->exec_name; + } + argv = alloc_argv_from_local_opts(babeltrace2_opts, + ARRAY_SIZE(babeltrace2_opts), trace_path); + break; case VIEWER_BABELTRACE: if (stat(babeltrace_bin, &status) == 0) { viewer_bin = babeltrace_bin; @@ -247,17 +222,6 @@ static int spawn_viewer(const char *trace_path) argv = alloc_argv_from_local_opts(babeltrace_opts, ARRAY_SIZE(babeltrace_opts), trace_path); break; -#if 0 - case VIEWER_LTTV_GUI: - if (stat(lttv_gui_bin, &status) == 0) { - viewer_bin = lttv_gui_bin; - } else { - viewer_bin = viewer->exec_name; - } - argv = alloc_argv_from_local_opts(lttv_gui_opts, - ARRAY_SIZE(lttv_gui_opts), trace_path); - break; -#endif case VIEWER_USER_DEFINED: argv = alloc_argv_from_user_opts(opt_viewer, trace_path); if (argv) { @@ -271,7 +235,7 @@ static int spawn_viewer(const char *trace_path) break; } - if (argv == NULL) { + if (argv == NULL || !viewer_bin) { ret = CMD_FATAL; goto error; } @@ -280,17 +244,27 @@ static int spawn_viewer(const char *trace_path) ret = execvp(viewer_bin, argv); if (ret) { - if (errno == ENOENT) { - ERR("%s not found on the system", viewer_bin); + if (errno == ENOENT && viewer->exec_name) { + if (viewer->type == VIEWER_BABELTRACE2) { + /* Fallback to legacy babeltrace. */ + DBG("babeltrace2 not installed on the system, falling back to babeltrace 1.x"); + viewer = &viewers[VIEWER_BABELTRACE]; + free(argv); + argv = NULL; + goto retry_viewer; + } else { + ERR("Viewer \"%s\" not found on the system", + viewer_bin); + } } else { - PERROR("exec: %s", viewer_bin); + PERROR("Failed to launch \"%s\" viewer", viewer_bin); } - free(argv); ret = CMD_FATAL; goto error; } error: + free(argv); return ret; } @@ -305,14 +279,14 @@ static char *build_live_path(char *session_name) ret = gethostname(hostname, sizeof(hostname)); if (ret < 0) { - perror("gethostname"); + PERROR("gethostname"); goto error; } ret = asprintf(&path, "net://localhost/host/%s/%s", hostname, session_name); if (ret < 0) { - perror("asprintf live path"); + PERROR("asprintf live path"); goto error; } @@ -328,6 +302,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, @@ -405,6 +380,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; @@ -422,7 +398,7 @@ static int view_trace(void) } free_sessions: - if (session_live_mode) { + if (session_live_mode && free_trace_path) { free(trace_path); } free(sessions); @@ -441,6 +417,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); @@ -452,13 +429,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; } @@ -466,6 +442,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: