Add the lttng view command
[lttng-tools.git] / src / bin / lttng / lttng.c
index 65cea55a25e73a8698fd01c2846b4a405488916a..1c1d5a82631e27ec45487fe66aa7c4ba795fb1bc 100644 (file)
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
+#include <sys/types.h>
+#include <sys/wait.h>
 #include <unistd.h>
 #include <config.h>
 
 #include <lttng/lttng.h>
-#include <common/lttngerr.h>
+#include <common/error.h>
 
-#include "cmd.h"
-#include "conf.h"
+#include "command.h"
 
 /* Variables */
 static char *progname;
@@ -38,6 +39,8 @@ int opt_quiet;
 int opt_verbose;
 static int opt_no_sessiond;
 static char *opt_sessiond_path;
+static pid_t sessiond_pid;
+static volatile int recv_child_signal;
 
 enum {
        OPT_SESSION_PATH,
@@ -73,29 +76,30 @@ static struct cmd_struct commands[] =  {
        { "set-session", cmd_set_session},
        { "version", cmd_version},
        { "calibrate", cmd_calibrate},
+       { "view", cmd_view},
        { NULL, NULL}   /* Array closure */
 };
 
 static void usage(FILE *ofp)
 {
        fprintf(ofp, "LTTng Trace Control " VERSION"\n\n");
-       fprintf(ofp, "usage: lttng [options] <command>\n");
+       fprintf(ofp, "usage: lttng [OPTIONS] <COMMAND>\n");
        fprintf(ofp, "\n");
        fprintf(ofp, "Options:\n");
-       fprintf(ofp, "  -h, --help             Show this help\n");
-       fprintf(ofp, "  -g, --group NAME       Unix tracing group name. (default: tracing)\n");
-       fprintf(ofp, "  -v, --verbose          Verbose mode\n");
-       fprintf(ofp, "  -q, --quiet            Quiet mode\n");
-       fprintf(ofp, "  -n, --no-sessiond      Don't spawn a session daemon\n");
-       fprintf(ofp, "      --sessiond-path    Session daemon full path\n");
-       fprintf(ofp, "      --list-options     Simple listing of lttng options\n");
-       fprintf(ofp, "      --list-commands    Simple listing of lttng commands\n");
+       fprintf(ofp, "  -h, --help                 Show this help\n");
+       fprintf(ofp, "      --list-options         Simple listing of lttng options\n");
+       fprintf(ofp, "      --list-commands        Simple listing of lttng commands\n");
+       fprintf(ofp, "  -v, --verbose              Increase verbosity\n");
+       fprintf(ofp, "  -q, --quiet                Quiet mode\n");
+       fprintf(ofp, "  -g, --group NAME           Unix tracing group name. (default: tracing)\n");
+       fprintf(ofp, "  -n, --no-sessiond          Don't spawn a session daemon\n");
+       fprintf(ofp, "      --sessiond-path PATH   Session daemon full path\n");
        fprintf(ofp, "\n");
        fprintf(ofp, "Commands:\n");
-       fprintf(ofp, "    add-context     Add context to event or/and channel\n");
+       fprintf(ofp, "    add-context     Add context to event and/or channel\n");
        fprintf(ofp, "    calibrate       Quantify LTTng overhead\n");
        fprintf(ofp, "    create          Create tracing session\n");
-       fprintf(ofp, "    destroy         Teardown tracing session\n");
+       fprintf(ofp, "    destroy         Tear down tracing session\n");
        fprintf(ofp, "    enable-channel  Enable tracing channel\n");
        fprintf(ofp, "    enable-event    Enable tracing event\n");
        fprintf(ofp, "    disable-channel Disable tracing channel\n");
@@ -105,6 +109,9 @@ static void usage(FILE *ofp)
        fprintf(ofp, "    start           Start tracing\n");
        fprintf(ofp, "    stop            Stop tracing\n");
        fprintf(ofp, "    version         Show version information\n");
+       fprintf(ofp, "    view            Start trace viewer\n");
+       fprintf(ofp, "\n");
+       fprintf(ofp, "Each command also has its own -h, --help option.\n");
        fprintf(ofp, "\n");
        fprintf(ofp, "Please see the lttng(1) man page for full documentation.\n");
        fprintf(ofp, "See http://lttng.org for updates, bug reports and news.\n");
@@ -169,17 +176,28 @@ static void clean_exit(int code)
  */
 static void sighandler(int sig)
 {
+       int status;
+
        switch (sig) {
                case SIGTERM:
-                       DBG("SIGTERM catched");
+                       DBG("SIGTERM caught");
                        clean_exit(EXIT_FAILURE);
                        break;
                case SIGCHLD:
+                       DBG("SIGCHLD caught");
+                       waitpid(sessiond_pid, &status, 0);
+                       recv_child_signal = 1;
+                       /* Indicate that the session daemon died */
+                       sessiond_pid = 0;
+                       ERR("Session daemon died (exit status %d)", WEXITSTATUS(status));
+                       break;
+               case SIGUSR1:
                        /* Notify is done */
-                       DBG("SIGCHLD catched");
+                       recv_child_signal = 1;
+                       DBG("SIGUSR1 caught");
                        break;
                default:
-                       DBG("Unknown signal %d catched", sig);
+                       DBG("Unknown signal %d caught", sig);
                        break;
        }
 
@@ -205,7 +223,7 @@ static int set_signal_handler(void)
        sa.sa_handler = sighandler;
        sa.sa_mask = sigset;
        sa.sa_flags = 0;
-       if ((ret = sigaction(SIGCHLD, &sa, NULL)) < 0) {
+       if ((ret = sigaction(SIGUSR1, &sa, NULL)) < 0) {
                perror("sigaction");
                goto end;
        }
@@ -215,6 +233,11 @@ static int set_signal_handler(void)
                goto end;
        }
 
+       if ((ret = sigaction(SIGCHLD, &sa, NULL)) < 0) {
+               perror("sigaction");
+               goto end;
+       }
+
 end:
        return ret;
 }
@@ -243,20 +266,6 @@ static int handle_command(int argc, char **argv)
                /* Find command */
                if (strcmp(argv[0], cmd->name) == 0) {
                        ret = cmd->func(argc, (const char**) argv);
-                       switch (ret) {
-                       case CMD_ERROR:
-                               ERR("Command error");
-                               break;
-                       case CMD_NOT_IMPLEMENTED:
-                               ERR("Options not implemented");
-                               break;
-                       case CMD_UNDEFINED:
-                               ERR("Undefined command");
-                               break;
-                       case CMD_FATAL:
-                               ERR("Fatal error");
-                               break;
-                       }
                        goto end;
                }
                i++;
@@ -281,6 +290,7 @@ static int spawn_sessiond(char *pathname)
        pid_t pid;
 
        MSG("Spawning a session daemon");
+       recv_child_signal = 0;
        pid = fork();
        if (pid == 0) {
                /*
@@ -294,11 +304,28 @@ static int spawn_sessiond(char *pathname)
                } else {
                        perror("execlp");
                }
-               kill(getppid(), SIGTERM);       /* unpause parent */
+               kill(getppid(), SIGTERM);       /* wake parent */
                exit(EXIT_FAILURE);
        } else if (pid > 0) {
-               /* Wait for lttng-sessiond to start */
-               pause();
+               sessiond_pid = pid;
+               /*
+                * Wait for lttng-sessiond to start. We need to use a flag to check if
+                * the signal has been sent to us, because the child can be scheduled
+                * before the parent, and thus send the signal before this check. In
+                * the signal handler, we set the recv_child_signal flag, so anytime we
+                * check it after the fork is fine. Note that sleep() is interrupted
+                * before the 1 second delay as soon as the signal is received, so it
+                * will not cause visible delay for the user.
+                */
+               while (!recv_child_signal) {
+                       sleep(1);
+               }
+               /*
+                * The signal handler will nullify sessiond_pid on SIGCHLD
+                */
+               if (!sessiond_pid) {
+                       exit(EXIT_FAILURE);
+               }
                goto end;
        } else {
                perror("fork");
@@ -328,13 +355,13 @@ static int check_sessiond(void)
                if (opt_sessiond_path != NULL) {
                        ret = access(opt_sessiond_path, F_OK | X_OK);
                        if (ret < 0) {
-                               ERR("No such file: %s", opt_sessiond_path);
+                               ERR("No such file or access denied: %s", opt_sessiond_path);
                                goto end;
                        }
                        pathname = opt_sessiond_path;
                } else {
                        /* Try LTTNG_SESSIOND_PATH env variable */
-                       pathname = getenv(LTTNG_SESSIOND_PATH_ENV);
+                       pathname = getenv(DEFAULT_SESSIOND_PATH_ENV);
                }
 
                /* Let's rock and roll */
@@ -350,25 +377,33 @@ static int check_sessiond(void)
                ret = spawn_sessiond(pathname);
                free(alloc_pathname);
                if (ret < 0) {
-                       ERR("Problem occurs when starting %s", pathname);
+                       ERR("Problem occurred when starting %s", pathname);
                        goto end;
                }
        }
 
 end:
+       printf("HIT essiond %d\n", ret);
        return ret;
 }
 
 /*
- * Check for the "help" option in the argv. If found, return 1 else return 0.
+ * Check args for specific options that *must* not trigger a session daemon
+ * execution.
+ *
+ * Return 1 if match else 0.
  */
-static int check_help_command(int argc, char **argv)
+static int check_args_no_sessiond(int argc, char **argv)
 {
        int i;
 
        for (i = 0; i < argc; i++) {
-               if ((strncmp(argv[i], "-h", 2) == 0) ||
-                               strncmp(argv[i], "--h", 3) == 0) {
+               if ((strncmp(argv[i], "-h", sizeof("-h")) == 0) ||
+                               strncmp(argv[i], "--h", sizeof("--h")) == 0 ||
+                               strncmp(argv[i], "--list-options", sizeof("--list-options")) == 0 ||
+                               strncmp(argv[i], "--list-commands", sizeof("--list-commands")) == 0 ||
+                               strncmp(argv[i], "version", sizeof("version")) == 0 ||
+                               strncmp(argv[i], "view", sizeof("view")) == 0) {
                        return 1;
                }
        }
@@ -377,10 +412,9 @@ static int check_help_command(int argc, char **argv)
 }
 
 /*
- *  parse_args
+ * Parse command line arguments.
  *
- *  Parse command line arguments.
- *  Return 0 if OK, else -1
+ * Return 0 if OK, else -1
  */
 static int parse_args(int argc, char **argv)
 {
@@ -394,8 +428,9 @@ static int parse_args(int argc, char **argv)
        while ((opt = getopt_long(argc, argv, "+hnvqg:", long_options, NULL)) != -1) {
                switch (opt) {
                case 'h':
-                       usage(stderr);
-                       goto error;
+                       usage(stdout);
+                       ret = 0;
+                       goto end;
                case 'v':
                        opt_verbose += 1;
                        break;
@@ -414,13 +449,14 @@ static int parse_args(int argc, char **argv)
                case OPT_DUMP_OPTIONS:
                        list_options(stdout);
                        ret = 0;
-                       goto error;
+                       goto end;
                case OPT_DUMP_COMMANDS:
                        list_commands(stdout);
                        ret = 0;
-                       goto error;
+                       goto end;
                default:
                        usage(stderr);
+                       ret = 1;
                        goto error;
                }
        }
@@ -431,14 +467,16 @@ static int parse_args(int argc, char **argv)
        }
 
        /* Spawn session daemon if needed */
-       if (opt_no_sessiond == 0 && check_help_command(argc, argv) == 0 &&
+       if (opt_no_sessiond == 0 && check_args_no_sessiond(argc, argv) == 0 &&
                        (check_sessiond() < 0)) {
+               ret = 1;
                goto error;
        }
 
        /* No leftovers, print usage and quit */
        if ((argc - optind) == 0) {
                usage(stderr);
+               ret = 1;
                goto error;
        }
 
@@ -447,19 +485,33 @@ static int parse_args(int argc, char **argv)
         * options.
         */
        ret = handle_command(argc - optind, argv + optind);
-       if (ret < 0) {
-               if (ret == -1) {
-                       usage(stderr);
-               } else {
-                       ERR("%s", lttng_strerror(ret));
-               }
-               goto error;
+       switch (ret) {
+       case CMD_WARNING:
+               WARN("Some command(s) went wrong");
+               break;
+       case CMD_ERROR:
+               ERR("Command error");
+               break;
+       case CMD_UNDEFINED:
+               ERR("Undefined command");
+               break;
+       case CMD_FATAL:
+               ERR("Fatal error");
+               break;
+       case -1:
+               usage(stderr);
+               ret = 1;
+               break;
+       case 0:
+               break;
+       default:
+               ERR("%s", lttng_strerror(ret));
+               break;
        }
 
-       return 0;
-
+end:
 error:
-       return -1;
+       return ret;
 }
 
 
@@ -472,9 +524,10 @@ int main(int argc, char *argv[])
 
        progname = argv[0] ? argv[0] : "lttng";
 
-       /* For Mathieu Desnoyers aka Dr Tracing */
-       if (strncmp(progname, "drtrace", 7) == 0) {
-               MSG("%c[%d;%dmWelcome back Dr Tracing!%c[%dm\n\n", 27,1,33,27,0);
+       /* For Mathieu Desnoyers a.k.a. Dr. Tracing */
+       if (strncmp(progname, "drtrace", 7) == 0 ||
+                       strncmp("compudj", getenv("USER"), 7) == 0) {
+               MSG("%c[%d;%dmWelcome back Dr Tracing!%c[%dm\n", 27,1,33,27,0);
        }
 
        ret = set_signal_handler();
@@ -483,8 +536,8 @@ int main(int argc, char *argv[])
        }
 
        ret = parse_args(argc, argv);
-       if (ret < 0) {
-               clean_exit(EXIT_FAILURE);
+       if (ret != 0) {
+               clean_exit(ret);
        }
 
        return 0;
This page took 0.02849 seconds and 4 git commands to generate.