Fix: check illegal combinations of ctrl-url/data-url/ouput/set-url
[lttng-tools.git] / src / bin / lttng / commands / create.c
index efc9e60c1609c189daae7ca09f3b765568c27b4c..d3e5b9a84106f84fbde44c50eb8376bcd8faae94 100644 (file)
@@ -24,7 +24,7 @@
 #include <string.h>
 #include <sys/stat.h>
 #include <sys/types.h>
-#include <time.h>
+#include <common/compat/time.h>
 #include <unistd.h>
 #include <signal.h>
 #include <sys/wait.h>
@@ -49,7 +49,13 @@ static char *opt_shm_path;
 static int opt_no_consumer;
 static int opt_no_output;
 static int opt_snapshot;
-static unsigned int opt_live_timer;
+static uint32_t opt_live_timer;
+
+#ifdef LTTNG_EMBED_HELP
+static const char help_msg[] =
+#include <lttng-create.1.h>
+;
+#endif
 
 enum {
        OPT_HELP = 1,
@@ -82,79 +88,6 @@ static struct poptOption long_options[] = {
 extern int _lttng_create_session_ext(const char *name, const char *url,
                const char *datetime);
 
-/*
- * usage
- */
-static void usage(FILE *ofp)
-{
-       fprintf(ofp, "usage: lttng create [NAME] [OPTIONS] \n");
-       fprintf(ofp, "\n");
-       fprintf(ofp, "Without a given NAME, the default is 'auto-<yyyymmdd>-<hhmmss>'\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, "  -o, --output PATH    Specify output path for traces\n");
-       fprintf(ofp, "      --no-output      Traces will not be outputted\n");
-       fprintf(ofp, "      --snapshot       Set the session in snapshot mode.\n");
-       fprintf(ofp, "                       Created in no-output mode and uses the URL,\n");
-       fprintf(ofp, "                       if one, as the default snapshot output.\n");
-       fprintf(ofp, "                       Every channel will be set in overwrite mode\n");
-       fprintf(ofp, "                       and with mmap output (splice not supported).\n");
-       fprintf(ofp, "      --live [USEC]    Set the session in live-reading mode.\n");
-       fprintf(ofp, "                       The delay parameter in micro-seconds is the\n");
-       fprintf(ofp, "                       maximum time the user can wait for the data\n");
-       fprintf(ofp, "                       to be flushed. Can be set with a network\n");
-       fprintf(ofp, "                       URL (-U or -C/-D) and must have a relayd listening.\n");
-       fprintf(ofp, "                       By default, %u is used for the timer and the\n",
-                                                                                       DEFAULT_LTTNG_LIVE_TIMER);
-       fprintf(ofp, "                       network URL is set to net://127.0.0.1.\n");
-       fprintf(ofp, "      --shm-path PATH  Path where shared memory holding buffers\n");
-       fprintf(ofp, "                       should be created. Useful when used with pramfs\n");
-       fprintf(ofp, "                       to extract trace data after crash.\n");
-       fprintf(ofp, "\n");
-       fprintf(ofp, "Extended Options:\n");
-       fprintf(ofp, "\n");
-       fprintf(ofp, "Using these options, each API call can be controlled individually.\n");
-       fprintf(ofp, "\n");
-       fprintf(ofp, "  -U, --set-url=URL    Set URL destination of the trace data.\n");
-       fprintf(ofp, "                       It is persistent for the session lifetime.\n");
-       fprintf(ofp, "                       This will set both data and control URL.\n");
-       fprintf(ofp, "  -C, --ctrl-url=URL   Set control path URL. (Must use -D also)\n");
-       fprintf(ofp, "  -D, --data-url=URL   Set data path URL. (Must use -C also)\n");
-       fprintf(ofp, "\n");
-       fprintf(ofp, "Please refer to the man page (lttng(1)) for more information on network\n");
-       fprintf(ofp, "streaming mechanisms and explanation of the control and data port\n");
-       fprintf(ofp, "You must have a running remote lttng-relayd for network streaming\n");
-       fprintf(ofp, "\n");
-       fprintf(ofp, "URL format is has followed:\n");
-       fprintf(ofp, "\n");
-       fprintf(ofp, "  proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]\n");
-       fprintf(ofp, "\n");
-       fprintf(ofp, "  Supported protocols are (proto):\n");
-       fprintf(ofp, "  > file://...\n");
-       fprintf(ofp, "    Local filesystem full path.\n");
-       fprintf(ofp, "\n");
-       fprintf(ofp, "  > net[6]://...\n");
-       fprintf(ofp, "    This will use the default network transport layer which is\n");
-       fprintf(ofp, "    TCP for both control (PORT1) and data port (PORT2).\n");
-       fprintf(ofp, "    The default ports are respectively 5342 and 5343.\n");
-       fprintf(ofp, "\n");
-       fprintf(ofp, "  > tcp[6]://...\n");
-       fprintf(ofp, "    Can only be used with -C and -D together\n");
-       fprintf(ofp, "\n");
-       fprintf(ofp, "NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732)\n");
-       fprintf(ofp, "\n");
-       fprintf(ofp, "Examples:\n");
-       fprintf(ofp, "    # lttng create -U net://192.168.1.42\n");
-       fprintf(ofp, "    Uses TCP and default ports for the given destination.\n");
-       fprintf(ofp, "    # lttng create -U net6://[fe80::f66d:4ff:fe53:d220]\n");
-       fprintf(ofp, "    Uses TCP, default ports and IPv6.\n");
-       fprintf(ofp, "    # lttng create s1 -U net://myhost.com:3229\n");
-       fprintf(ofp, "    Set the consumer to the remote HOST on port 3229 for control.\n");
-       fprintf(ofp, "\n");
-}
-
 /*
  * Retrieve the created session and mi output it based on provided argument
  * This is currently a summary of what was pretty printed and is subject to
@@ -214,18 +147,15 @@ static int set_consumer_url(const char *session_name, const char *ctrl_url,
 {
        int ret;
        struct lttng_handle *handle;
-       struct lttng_domain dom;
 
        assert(session_name);
 
        /*
-        * Set handle with the session name and the domain set to 0. This means to
-        * the session daemon that the next action applies on the tracing session
-        * rather then the domain specific session.
+        * Set handle with the session_name, but no domain. This implies that
+        * the actions taken with this handle apply on the tracing session
+        * rather then the domain-specific session.
         */
-       memset(&dom, 0, sizeof(dom));
-
-       handle = lttng_create_handle(session_name, &dom);
+       handle = lttng_create_handle(session_name, NULL);
        if (handle == NULL) {
                ret = CMD_FATAL;
                goto error;
@@ -418,6 +348,10 @@ static int create_session(void)
 
        /* Use default live URL if NO url is/are found. */
        if ((opt_live_timer && !opt_url) && (opt_live_timer && !opt_data_url)) {
+               /* Override the url */
+               free(url);
+               url = NULL;
+
                ret = asprintf(&alloc_url, "net://127.0.0.1");
                if (ret < 0) {
                        PERROR("asprintf default live URL");
@@ -508,14 +442,14 @@ static int create_session(void)
                MSG("Traces will be written in %s", print_str_url);
 
                if (opt_live_timer) {
-                       MSG("Live timer set to %u usec", opt_live_timer);
+                       MSG("Live timer set to %u %s", opt_live_timer, USEC_UNIT);
                }
        } else if (opt_snapshot) {
                if (print_str_url) {
                        MSG("Default snapshot output set to: %s", print_str_url);
                }
                MSG("Snapshot mode set. Every channel enabled for that session will "
-                               "be set in overwrite mode and mmap output.");
+                               "be set to mmap output, and default to overwrite mode.");
        }
        if (opt_shm_path) {
                MSG("Session %s set to shm_path: %s.", session_name,
@@ -682,6 +616,22 @@ end:
        return ret;
 }
 
+int validate_url_option_combination(void)
+{
+       int ret = 0;
+       int used_count = 0;
+
+       used_count += !!opt_url;
+       used_count += !!opt_output_path;
+       used_count += (opt_data_url || opt_ctrl_url);
+       if (used_count > 1) {
+               ERR("Only one of the --set-url, --ctrl-url/data-url, or --output options may be used at once.");
+               ret = -1;
+       }
+
+       return ret;
+}
+
 /*
  *  The 'create <options>' first level command
  *
@@ -691,6 +641,7 @@ int cmd_create(int argc, const char **argv)
 {
        int opt, ret = CMD_SUCCESS, command_ret = CMD_SUCCESS, success = 1;
        char *opt_arg = NULL;
+       const char *leftover = NULL;
        static poptContext pc;
 
        pc = poptGetContext(NULL, argc, argv, long_options, 0);
@@ -706,7 +657,7 @@ int cmd_create(int argc, const char **argv)
                        goto end;
                case OPT_LIVE_TIMER:
                {
-                       unsigned long v;
+                       uint64_t v;
 
                        errno = 0;
                        opt_arg = poptGetOptArg(pc);
@@ -718,28 +669,29 @@ int cmd_create(int argc, const char **argv)
                                break;
                        }
 
-                       v = strtoul(opt_arg, NULL, 0);
-                       if (errno != 0 || !isdigit(opt_arg[0])) {
-                               ERR("Wrong value in --live parameter: %s", opt_arg);
+                       if (utils_parse_time_suffix(opt_arg, &v) < 0) {
+                               ERR("Wrong value for --live parameter: %s", opt_arg);
                                ret = CMD_ERROR;
                                goto end;
                        }
+
                        if (v != (uint32_t) v) {
                                ERR("32-bit overflow in --live parameter: %s", opt_arg);
                                ret = CMD_ERROR;
                                goto end;
                        }
+
                        if (v == 0) {
                                ERR("Live timer interval must be greater than zero");
                                ret = CMD_ERROR;
                                goto end;
                        }
+
                        opt_live_timer = (uint32_t) v;
                        DBG("Session live timer interval set to %d", opt_live_timer);
                        break;
                }
                default:
-                       usage(stderr);
                        ret = CMD_UNDEFINED;
                        goto end;
                }
@@ -751,6 +703,12 @@ int cmd_create(int argc, const char **argv)
                goto end;
        }
 
+       ret = validate_url_option_combination();
+       if (ret) {
+               ret = CMD_ERROR;
+               goto end;
+       }
+
        /* Spawn a session daemon if needed */
        if (!opt_no_sessiond) {
                ret = launch_sessiond();
@@ -786,6 +744,13 @@ int cmd_create(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;
+       }
+
        command_ret = create_session();
        if (command_ret) {
                success = 0;
This page took 0.029809 seconds and 5 git commands to generate.