/*
- * Copyright (C) 2011 - David Goulet <dgoulet@efficios.com>
+ * Copyright (C) 2011 David Goulet <dgoulet@efficios.com>
*
- * 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 <popt.h>
#include <stdio.h>
#include <stdlib.h>
#include <sys/types.h>
#include <unistd.h>
+#include <common/spawn-viewer.h>
#include "../command.h"
-#include <config.h>
static char *opt_session_name;
static char *opt_viewer;
-static const char *babeltrace_bin = CONFIG_BABELTRACE_BIN;
-//static const char *lttv_gui_bin = CONFIG_LTTV_GUI_BIN;
+static char *opt_trace_path;
+
+#ifdef LTTNG_EMBED_HELP
+static const char help_msg[] =
+#include <lttng-view.1.h>
+;
+#endif
enum {
OPT_HELP = 1,
{"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}
};
-/*
- * 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 },
-};
-
-/*
- * 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");
-}
-
-static struct viewers *parse_options(void)
-{
- if (opt_viewer == NULL) {
- /* Default is babeltrace */
- return &(viewers[VIEWER_BABELTRACE]);
- }
-
-#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]);
-}
-
-/*
- * 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 = malloc(sizeof(char *) * (num_opts + 2));
- if (argv == NULL) {
- goto error;
- }
-
- token = strtok(opts, " ");
- while (token != NULL) {
- argv[i] = strdup(token);
- token = strtok(NULL, " ");
- i++;
- }
-
- argv[num_opts] = (char *) trace_path;
- argv[num_opts + 1] = NULL;
-
- return argv;
-
-error:
- return NULL;
-}
+/* Is the session we are trying to view is in live mode. */
+static int session_live_mode;
/*
- * 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().
+ * Build the live path we need for the lttng live view.
*/
-static char **alloc_argv_from_local_opts(const char **opts, size_t opts_len,
- const char *trace_path)
+static char *build_live_path(char *session_name)
{
- char **argv;
- size_t size;
-
- size = sizeof(char *) * opts_len;
+ int ret;
+ char *path = NULL;
+ char hostname[LTTNG_HOST_NAME_MAX];
- /* Add two here for the trace_path and the NULL terminating element. */
- argv = malloc(size + 2);
- if (argv == NULL) {
+ ret = gethostname(hostname, sizeof(hostname));
+ if (ret < 0) {
+ PERROR("gethostname");
goto error;
}
- memcpy(argv, opts, size);
-
- 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;
- pid_t pid;
- 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;
+ ret = asprintf(&path, "net://localhost/host/%s/%s", hostname,
+ session_name);
+ if (ret < 0) {
+ PERROR("asprintf live 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;
- }
-
- if (argv == NULL) {
- ret = CMD_FATAL;
- goto error;
- }
-
- DBG("Using %s viewer", viewer_bin);
-
- ret = execvp(viewer_bin, argv);
- if (ret) {
- PERROR("exec: %s", viewer_bin);
- free(argv);
- ret = CMD_FATAL;
- goto error;
- }
- } else if (pid > 0) {
- ret = CMD_SUCCESS;
- } else {
- PERROR("Fork trace viewer");
- ret = CMD_FATAL;
- }
-
error:
- return ret;
+ return 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()) {
}
}
- 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;
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);
- ret = CMD_ERROR;
- 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, opt_viewer, session_live_mode);
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);
{
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;
}
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:
projects / lttng-tools.git / blobdiff