src/bin/lttng/commands/create.c

   1 /*
   2  * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License, version 2 only,
   6  * as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  16  */
  17
  18 #define _GNU_SOURCE
  19 #include <assert.h>
  20 #include <popt.h>
  21 #include <stdio.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <sys/stat.h>
  25 #include <sys/types.h>
  26 #include <time.h>
  27 #include <unistd.h>
  28
  29 #include "../command.h"
  30 #include "../utils.h"
  31
  32 #include <common/defaults.h>
  33 #include <common/sessiond-comm/sessiond-comm.h>
  34 #include <common/uri.h>
  35 #include <common/utils.h>
  36
  37 static char *opt_output_path;
  38 static char *opt_session_name;
  39 static char *opt_url;
  40 static char *opt_ctrl_url;
  41 static char *opt_data_url;
  42 static int opt_no_consumer;
  43 static int opt_disable_consumer;
  44
  45 enum {
  46         OPT_HELP = 1,
  47         OPT_LIST_OPTIONS,
  48 };
  49
  50 static struct poptOption long_options[] = {
  51         /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
  52         {"help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL},
  53         {"output", 'o', POPT_ARG_STRING, &opt_output_path, 0, NULL, NULL},
  54         {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
  55         {"set-url",        'U', POPT_ARG_STRING, &opt_url, 0, 0, 0},
  56         {"ctrl-url",       'C', POPT_ARG_STRING, &opt_ctrl_url, 0, 0, 0},
  57         {"data-url",       'D', POPT_ARG_STRING, &opt_data_url, 0, 0, 0},
  58         {"no-consumer",      0, POPT_ARG_VAL, &opt_no_consumer, 1, 0, 0},
  59         {"disable-consumer", 0, POPT_ARG_VAL, &opt_disable_consumer, 1, 0, 0},
  60         {0, 0, 0, 0, 0, 0, 0}
  61 };
  62
  63 /*
  64  * Please have a look at src/lib/lttng-ctl/lttng-ctl.c for more information on
  65  * why this declaration exists and used ONLY in for this command.
  66  */
  67 extern int _lttng_create_session_ext(const char *name, const char *url,
  68                 const char *datetime);
  69
  70 /*
  71  * usage
  72  */
  73 static void usage(FILE *ofp)
  74 {
  75         fprintf(ofp, "usage: lttng create [NAME] [OPTIONS] \n");
  76         fprintf(ofp, "\n");
  77         fprintf(ofp, "Without a given NAME, the default is 'auto-<yyyymmdd>-<hhmmss>'\n");
  78         fprintf(ofp, "\n");
  79         fprintf(ofp, "Options:\n");
  80         fprintf(ofp, "  -h, --help           Show this help\n");
  81         fprintf(ofp, "      --list-options   Simple listing of options\n");
  82         fprintf(ofp, "  -o, --output PATH    Specify output path for traces\n");
  83         fprintf(ofp, "\n");
  84         fprintf(ofp, "Extended Options:\n");
  85         fprintf(ofp, "\n");
  86         fprintf(ofp, "Using these options, each API call can be controlled individually.\n");
  87         fprintf(ofp, "\n");
  88         fprintf(ofp, "  -U, --set-url=URL    Set URL destination of the trace data.\n");
  89         fprintf(ofp, "                       It is persistent for the session lifetime.\n");
  90         fprintf(ofp, "                       This will set both data and control URL.\n");
  91         fprintf(ofp, "                       You can change it with the enable-consumer cmd\n");
  92         fprintf(ofp, "  -C, --ctrl-url=URL   Set control path URL. (Must use -D also)\n");
  93         fprintf(ofp, "  -D, --data-url=URL   Set data path URL. (Must use -C also)\n");
  94         fprintf(ofp, "      --no-consumer    Don't activate a consumer for this session.\n");
  95         fprintf(ofp, "                       OBSELETE\n");
  96         fprintf(ofp, "      --disable-consumer\n");
  97         fprintf(ofp, "                       Disable consumer for this session.\n");
  98         fprintf(ofp, "                       OBSELETE\n");
  99         fprintf(ofp, "\n");
 100         fprintf(ofp, "Please refer to the man page (lttng(1)) for more information on network\n");
 101         fprintf(ofp, "streaming mechanisms and explanation of the control and data port\n");
 102         fprintf(ofp, "You must have a running remote lttng-relayd for network streaming\n");
 103         fprintf(ofp, "\n");
 104         fprintf(ofp, "URL format is has followed:\n");
 105         fprintf(ofp, "\n");
 106         fprintf(ofp, "  proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]\n");
 107         fprintf(ofp, "\n");
 108         fprintf(ofp, "  Supported protocols are (proto):\n");
 109         fprintf(ofp, "  > file://...\n");
 110         fprintf(ofp, "    Local filesystem full path.\n");
 111         fprintf(ofp, "\n");
 112         fprintf(ofp, "  > net[6]://...\n");
 113         fprintf(ofp, "    This will use the default network transport layer which is\n");
 114         fprintf(ofp, "    TCP for both control (PORT1) and data port (PORT2).\n");
 115         fprintf(ofp, "    The default ports are respectively 5342 and 5343.\n");
 116         fprintf(ofp, "\n");
 117         fprintf(ofp, "  > tcp[6]://...\n");
 118         fprintf(ofp, "    Can only be used with -C and -D together\n");
 119         fprintf(ofp, "\n");
 120         fprintf(ofp, "NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732)\n");
 121         fprintf(ofp, "\n");
 122         fprintf(ofp, "Examples:\n");
 123         fprintf(ofp, "    # lttng create -U net://192.168.1.42\n");
 124         fprintf(ofp, "    Uses TCP and default ports for the given destination.\n");
 125         fprintf(ofp, "    # lttng create -U net6://[fe80::f66d:4ff:fe53:d220]\n");
 126         fprintf(ofp, "    Uses TCP, default ports and IPv6.\n");
 127         fprintf(ofp, "    # lttng create s1 -U net://myhost.com:3229\n");
 128         fprintf(ofp, "    Set the consumer to the remote HOST on port 3229 for control.\n");
 129         fprintf(ofp, "\n");
 130 }
 131
 132 /*
 133  * For a session name, set the consumer URLs.
 134  */
 135 static int set_consumer_url(const char *session_name, const char *ctrl_url,
 136                 const char *data_url)
 137 {
 138         int ret;
 139         struct lttng_handle *handle;
 140         struct lttng_domain dom;
 141
 142         assert(session_name);
 143
 144         /*
 145          * Set handle with the session name and the domain set to 0. This means to
 146          * the session daemon that the next action applies on the tracing session
 147          * rather then the domain specific session.
 148          */
 149         memset(&dom, 0, sizeof(dom));
 150
 151         handle = lttng_create_handle(session_name, &dom);
 152         if (handle == NULL) {
 153                 ret = CMD_FATAL;
 154                 goto error;
 155         }
 156
 157         ret = lttng_set_consumer_url(handle, ctrl_url, data_url);
 158         if (ret < 0) {
 159                 goto error;
 160         }
 161
 162         if (ctrl_url) {
 163                 MSG("Control URL %s set for session %s", ctrl_url, session_name);
 164         }
 165
 166         if (data_url) {
 167                 MSG("Data URL %s set for session %s", data_url, session_name);
 168         }
 169
 170 error:
 171         lttng_destroy_handle(handle);
 172         return ret;
 173 }
 174
 175 /*
 176  *  Create a tracing session.
 177  *  If no name is specified, a default name is generated.
 178  *
 179  *  Returns one of the CMD_* result constants.
 180  */
 181 static int create_session(void)
 182 {
 183         int ret;
 184         char *session_name = NULL, *traces_path = NULL, *alloc_path = NULL;
 185         char *alloc_url = NULL, *url = NULL, datetime[16];
 186         char session_name_date[NAME_MAX + 17], *print_str_url = NULL;
 187         time_t rawtime;
 188         struct tm *timeinfo;
 189
 190         /* Get date and time for automatic session name/path */
 191         time(&rawtime);
 192         timeinfo = localtime(&rawtime);
 193         strftime(datetime, sizeof(datetime), "%Y%m%d-%H%M%S", timeinfo);
 194
 195         /* Auto session name creation */
 196         if (opt_session_name == NULL) {
 197                 ret = snprintf(session_name_date, sizeof(session_name_date),
 198                                 DEFAULT_SESSION_NAME "-%s", datetime);
 199                 if (ret < 0) {
 200                         PERROR("snprintf session name");
 201                         goto error;
 202                 }
 203                 session_name = session_name_date;
 204                 DBG("Auto session name set to %s", session_name_date);
 205         } else {
 206                 if (strlen(opt_session_name) > NAME_MAX) {
 207                         ERR("Session name too long. Length must be lower or equal to %d",
 208                                         NAME_MAX);
 209                         ret = LTTNG_ERR_SESSION_FAIL;
 210                         goto error;
 211                 }
 212                 /*
 213                  * Check if the session name begins with "auto-" or is exactly "auto".
 214                  * Both are reserved for the default session name. See bug #449 to
 215                  * understand why we need to check both here.
 216                  */
 217                 if ((strncmp(opt_session_name, DEFAULT_SESSION_NAME "-",
 218                                         strlen(DEFAULT_SESSION_NAME) + 1) == 0) ||
 219                                 (strncmp(opt_session_name, DEFAULT_SESSION_NAME,
 220                                         strlen(DEFAULT_SESSION_NAME)) == 0 &&
 221                                 strlen(opt_session_name) == strlen(DEFAULT_SESSION_NAME))) {
 222                         ERR("%s is a reserved keyword for default session(s)",
 223                                         DEFAULT_SESSION_NAME);
 224                         ret = CMD_ERROR;
 225                         goto error;
 226                 }
 227                 session_name = opt_session_name;
 228                 ret = snprintf(session_name_date, sizeof(session_name_date),
 229                                 "%s-%s", session_name, datetime);
 230                 if (ret < 0) {
 231                         PERROR("snprintf session name");
 232                         goto error;
 233                 }
 234         }
 235
 236         if (opt_output_path != NULL) {
 237                 traces_path = utils_expand_path(opt_output_path);
 238                 if (traces_path == NULL) {
 239                         ret = CMD_ERROR;
 240                         goto error;
 241                 }
 242
 243                 /* Create URL string from the local filesytem path */
 244                 ret = asprintf(&alloc_url, "file://%s", traces_path);
 245                 if (ret < 0) {
 246                         PERROR("asprintf url path");
 247                         ret = CMD_FATAL;
 248                         goto error;
 249                 }
 250                 /* URL to use in the lttng_create_session() call */
 251                 url = alloc_url;
 252                 print_str_url = traces_path;
 253         } else if (opt_url) { /* Handling URL (-U opt) */
 254                 url = opt_url;
 255                 print_str_url = url;
 256         } else {
 257                 /* Auto output path */
 258                 alloc_path = config_get_default_path();
 259                 if (alloc_path == NULL) {
 260                         ERR("HOME path not found.\n \
 261                                         Please specify an output path using -o, --output PATH");
 262                         ret = CMD_FATAL;
 263                         goto error;
 264                 }
 265                 alloc_path = strdup(alloc_path);
 266
 267                 ret = asprintf(&alloc_url,
 268                                 "file://%s/" DEFAULT_TRACE_DIR_NAME "/%s",
 269                                 alloc_path, session_name_date);
 270                 if (ret < 0) {
 271                         PERROR("asprintf trace dir name");
 272                         ret = CMD_FATAL;
 273                         goto error;
 274                 }
 275
 276                 url = alloc_url;
 277                 if (!opt_data_url && !opt_ctrl_url) {
 278                         print_str_url = alloc_url + strlen("file://");
 279                 }
 280         }
 281
 282         if ((!opt_ctrl_url && opt_data_url) || (opt_ctrl_url && !opt_data_url)) {
 283                 ERR("You need both control and data URL.");
 284                 ret = CMD_ERROR;
 285                 goto error;
 286         }
 287
 288         ret = _lttng_create_session_ext(session_name, url, datetime);
 289         if (ret < 0) {
 290                 /* Don't set ret so lttng can interpret the sessiond error. */
 291                 switch (-ret) {
 292                 case LTTNG_ERR_EXIST_SESS:
 293                         WARN("Session %s already exists", session_name);
 294                         break;
 295                 default:
 296                         ERR("%s", lttng_strerror(ret));
 297                         break;
 298                 }
 299                 goto error;
 300         }
 301
 302         if (opt_ctrl_url && opt_data_url) {
 303                 /* Setting up control URI (-C or/and -D opt) */
 304                 ret = set_consumer_url(session_name, opt_ctrl_url, opt_data_url);
 305                 if (ret < 0) {
 306                         /* Destroy created session because the URL are not valid. */
 307                         lttng_destroy_session(session_name);
 308                         goto error;
 309                 }
 310         }
 311
 312         MSG("Session %s created.", session_name);
 313         if (print_str_url) {
 314                 MSG("Traces will be written in %s", print_str_url);
 315         }
 316
 317         /* Init lttng session config */
 318         ret = config_init(session_name);
 319         if (ret < 0) {
 320                 ret = CMD_ERROR;
 321                 goto error;
 322         }
 323
 324         ret = CMD_SUCCESS;
 325
 326 error:
 327         free(alloc_url);
 328         free(traces_path);
 329         free(alloc_path);
 330
 331         if (ret < 0) {
 332                 ERR("%s", lttng_strerror(ret));
 333         }
 334         return ret;
 335 }
 336
 337 /*
 338  *  The 'create <options>' first level command
 339  *
 340  *  Returns one of the CMD_* result constants.
 341  */
 342 int cmd_create(int argc, const char **argv)
 343 {
 344         int opt, ret = CMD_SUCCESS;
 345         static poptContext pc;
 346
 347         pc = poptGetContext(NULL, argc, argv, long_options, 0);
 348         poptReadDefaultConfig(pc, 0);
 349
 350         while ((opt = poptGetNextOpt(pc)) != -1) {
 351                 switch (opt) {
 352                 case OPT_HELP:
 353                         usage(stdout);
 354                         goto end;
 355                 case OPT_LIST_OPTIONS:
 356                         list_cmd_options(stdout, long_options);
 357                         goto end;
 358                 default:
 359                         usage(stderr);
 360                         ret = CMD_UNDEFINED;
 361                         goto end;
 362                 }
 363         }
 364
 365         if (opt_no_consumer) {
 366                 MSG("The option --no-consumer is obsolete.");
 367                 ret = CMD_WARNING;
 368                 goto end;
 369         }
 370
 371         if (opt_disable_consumer) {
 372                 MSG("The option --disable-consumer is obsolete.");
 373                 ret = CMD_WARNING;
 374                 goto end;
 375         }
 376
 377         opt_session_name = (char*) poptGetArg(pc);
 378
 379         ret = create_session();
 380
 381 end:
 382         poptFreeContext(pc);
 383         return ret;
 384 }