X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fbin%2Flttng%2Fcommands%2Fview.c;h=1a9ad6c3a3868978467563b791cff34a133f6b35;hp=c7424186041491f536efd0d61b9b44238dbdcc63;hb=a85cae2bef6e4583072236c71770d4244ec5cf9d;hpb=36ef520ff4aa270d5140886b31865003bcb39fea diff --git a/src/bin/lttng/commands/view.c b/src/bin/lttng/commands/view.c index c74241860..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 as published by the Free - * Software Foundation; only version 2 of the License. + * 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., 59 Temple - * Place - Suite 330, Boston, MA 02111-1307, USA. */ -#define _GNU_SOURCE +#define _LGPL_SOURCE #include #include #include @@ -25,12 +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, @@ -42,6 +38,7 @@ static struct poptOption long_options[] = { {"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0}, {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL}, {"viewer", 'e', POPT_ARG_STRING, &opt_viewer, 0, 0, 0}, + {"trace-path", 't', POPT_ARG_STRING, &opt_trace_path, 0, 0, 0}, {0, 0, 0, 0, 0, 0, 0} }; @@ -49,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 @@ -57,61 +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 }, }; -/* - * 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, " -h, --help Show this help\n"); - fprintf(ofp, " --list-options Simple listing of options\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.\n"); - fprintf(ofp, "\n"); -} +/* Is the session we are trying to view is in live mode. */ +static int session_live_mode; -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]); } @@ -142,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; } @@ -150,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++; } @@ -160,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; } @@ -173,20 +148,37 @@ static char **alloc_argv_from_local_opts(const char **opts, size_t opts_len, const char *trace_path) { char **argv; - size_t size; + size_t size, mem_len; - size = sizeof(char *) * opts_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 = malloc(size + 2); + argv = zmalloc(size); if (argv == NULL) { goto error; } - memcpy(argv, opts, size); + memcpy(argv, opts, sizeof(char *) * opts_len); - argv[opts_len] = (char *)trace_path; - argv[opts_len + 1] = NULL; + if (session_live_mode) { + 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 { + argv[opts_len] = (char *) trace_path; + argv[opts_len + 1] = NULL; + } error: return argv; @@ -198,10 +190,9 @@ error: static int spawn_viewer(const char *trace_path) { int ret = 0; - pid_t pid; struct stat status; const char *viewer_bin = NULL; - struct viewers *viewer; + const struct viewers *viewer; char **argv = NULL; /* Check for --viewer options */ @@ -211,91 +202,128 @@ static int spawn_viewer(const char *trace_path) goto error; } - pid = fork(); - if (pid == 0) { - 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; -#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) { - 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; +retry_viewer: + switch (viewer->type) { + case VIEWER_BABELTRACE2: + if (stat(babeltrace2_bin, &status) == 0) { + viewer_bin = babeltrace2_bin; + } else { + viewer_bin = viewer->exec_name; } - - if (argv == NULL) { - ret = CMD_FATAL; - goto error; + 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; + } 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; + } - DBG("Using %s viewer", viewer_bin); + if (argv == NULL || !viewer_bin) { + ret = CMD_FATAL; + goto error; + } - ret = execvp(viewer_bin, argv); - if (ret) { - PERROR("exec: %s", viewer_bin); - free(argv); - ret = CMD_FATAL; - goto error; + DBG("Using %s viewer", viewer_bin); + + ret = execvp(viewer_bin, argv); + if (ret) { + 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("Failed to launch \"%s\" viewer", viewer_bin); } - } else if (pid > 0) { - ret = CMD_SUCCESS; - } else { - PERROR("Fork trace viewer"); ret = CMD_FATAL; + goto error; } error: + free(argv); return ret; } +/* + * Build the live path we need for the lttng live view. + */ +static char *build_live_path(char *session_name) +{ + int ret; + char *path = NULL; + char hostname[HOST_NAME_MAX]; + + ret = gethostname(hostname, sizeof(hostname)); + if (ret < 0) { + PERROR("gethostname"); + goto error; + } + + ret = asprintf(&path, "net://localhost/host/%s/%s", hostname, + session_name); + if (ret < 0) { + PERROR("asprintf live path"); + goto error; + } + +error: + return path; +} + /* * Exec viewer if found and use session name path. */ static int view_trace(void) { - int ret, count, i, found = 0; - char *session_name; + 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, - * this prevent any bad execution of binraries. + * this prevent any bad execution of binaries. */ if (getuid() != 0) { if (getuid() != geteuid()) { ERR("UID does not match effective UID."); + ret = CMD_ERROR; goto error; } else if (getgid() != getegid()) { ERR("GID does not match effective GID."); + ret = CMD_ERROR; goto error; } } - if (opt_session_name == NULL) { + /* User define trace path override the session name */ + if (opt_trace_path) { + session_name = NULL; + } else if(opt_session_name == NULL) { session_name = get_session_name(); if (session_name == NULL) { ret = CMD_ERROR; @@ -307,43 +335,73 @@ static int view_trace(void) DBG("Viewing trace for session %s", session_name); - /* Getting all sessions */ - count = lttng_list_sessions(&sessions); - if (count < 0) { - ERR("Unable to list sessions. Session name %s not found.", - session_name); - MSG("Is there a session daemon running?"); - ret = CMD_ERROR; - goto free_error; - } + if (session_name) { + int i, count, found = 0; - /* Find our session listed by the session daemon */ - for (i = 0; i < count; i++) { - if (strncmp(sessions[i].name, session_name, NAME_MAX) == 0) { - found = 1; - break; + /* Getting all sessions */ + count = lttng_list_sessions(&sessions); + if (count < 0) { + ERR("Unable to list sessions. Session name %s not found.", + session_name); + MSG("Is there a session daemon running?"); + ret = CMD_ERROR; + goto free_error; } - } - if (!found) { - MSG("Session name %s not found", session_name); - goto free_sessions; + /* Find our session listed by the session daemon */ + for (i = 0; i < count; i++) { + if (strncmp(sessions[i].name, session_name, NAME_MAX) == 0) { + found = 1; + break; + } + } + + if (!found) { + MSG("Session name %s not found", session_name); + ret = CMD_ERROR; + goto free_sessions; + } + + session_live_mode = sessions[i].live_timer_interval; + + DBG("Session live mode set to %d", session_live_mode); + + if (sessions[i].enabled && !session_live_mode) { + WARN("Session %s is running. Please stop it before reading it.", + session_name); + ret = CMD_ERROR; + goto free_sessions; + } + + /* If the timer interval is set we are in live mode. */ + if (session_live_mode) { + trace_path = build_live_path(session_name); + if (!trace_path) { + ret = CMD_ERROR; + goto free_sessions; + } + free_trace_path = true; + } else { + /* Get file system session path. */ + trace_path = sessions[i].path; + } + } else { + trace_path = opt_trace_path; } - MSG("Trace directory: %s\n", sessions[i].path); + MSG("Trace directory: %s\n", trace_path); - ret = spawn_viewer(sessions[i].path); + ret = spawn_viewer(trace_path); if (ret < 0) { /* Don't set ret so lttng can interpret the sessiond error. */ goto free_sessions; } - ret = CMD_SUCCESS; - free_sessions: - if (sessions) { - free(sessions); + if (session_live_mode && free_trace_path) { + free(trace_path); } + free(sessions); free_error: if (opt_session_name == NULL) { free(session_name); @@ -359,20 +417,24 @@ 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); + if (lttng_opt_mi) { + WARN("mi does not apply to view command"); + } + 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; } @@ -380,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: