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 <ctype.h>
  21 #include <popt.h>
  22 #include <stdio.h>
  23 #include <stdlib.h>
  24 #include <string.h>
  25 #include <sys/stat.h>
  26 #include <sys/types.h>
  27 #include <time.h>
  28 #include <unistd.h>
  29
  30 #include "../command.h"
  31 #include "../utils.h"
  32
  33 #include <common/defaults.h>
  34 #include <common/sessiond-comm/sessiond-comm.h>
  35 #include <common/uri.h>
  36 #include <common/utils.h>
  37 #include <lttng/snapshot.h>
  38
  39 static char *opt_output_path;
  40 static char *opt_session_name;
  41 static char *opt_url;
  42 static char *opt_ctrl_url;
  43 static char *opt_data_url;
  44 static int opt_no_consumer;
  45 static int opt_no_output;
  46 static int opt_snapshot;
  47 static unsigned int opt_live_timer;
  48 static int opt_disable_consumer;
  49
  50 enum {
  51         OPT_HELP = 1,
  52         OPT_LIST_OPTIONS,
  53         OPT_LIVE_TIMER,
  54 };
  55
  56 static struct poptOption long_options[] = {
  57         /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
  58         {"help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL},
  59         {"output", 'o', POPT_ARG_STRING, &opt_output_path, 0, NULL, NULL},
  60         {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
  61         {"set-url",        'U', POPT_ARG_STRING, &opt_url, 0, 0, 0},
  62         {"ctrl-url",       'C', POPT_ARG_STRING, &opt_ctrl_url, 0, 0, 0},
  63         {"data-url",       'D', POPT_ARG_STRING, &opt_data_url, 0, 0, 0},
  64         {"no-output",       0, POPT_ARG_VAL, &opt_no_output, 1, 0, 0},
  65         {"no-consumer",     0, POPT_ARG_VAL, &opt_no_consumer, 1, 0, 0},
  66         {"disable-consumer", 0, POPT_ARG_VAL, &opt_disable_consumer, 1, 0, 0},
  67         {"snapshot",        0, POPT_ARG_VAL, &opt_snapshot, 1, 0, 0},
  68         {"live",            0, POPT_ARG_INT, 0, OPT_LIVE_TIMER, 0, 0},
  69         {0, 0, 0, 0, 0, 0, 0}
  70 };
  71
  72 /*
  73  * Please have a look at src/lib/lttng-ctl/lttng-ctl.c for more information on
  74  * why this declaration exists and used ONLY in for this command.
  75  */
  76 extern int _lttng_create_session_ext(const char *name, const char *url,
  77                 const char *datetime, int live_timer);
  78
  79 /*
  80  * usage
  81  */
  82 static void usage(FILE *ofp)
  83 {
  84         fprintf(ofp, "usage: lttng create [NAME] [OPTIONS] \n");
  85         fprintf(ofp, "\n");
  86         fprintf(ofp, "Without a given NAME, the default is 'auto-<yyyymmdd>-<hhmmss>'\n");
  87         fprintf(ofp, "\n");
  88         fprintf(ofp, "Options:\n");
  89         fprintf(ofp, "  -h, --help           Show this help\n");
  90         fprintf(ofp, "      --list-options   Simple listing of options\n");
  91         fprintf(ofp, "  -o, --output PATH    Specify output path for traces\n");
  92         fprintf(ofp, "      --no-output      Traces will not be outputted\n");
  93         fprintf(ofp, "      --snapshot       Set the session in snapshot mode.\n");
  94         fprintf(ofp, "                       Created in no-output mode and uses the URL,\n");
  95         fprintf(ofp, "                       if one, as the default snapshot output.\n");
  96         fprintf(ofp, "                       Every channel will be set in overwrite mode\n");
  97         fprintf(ofp, "                       and with mmap output (splice not supported).\n");
  98         fprintf(ofp, "      --live USEC      Set the session in live-reading mode.\n");
  99         fprintf(ofp, "                       The delay parameter in micro-seconds is the\n");
 100         fprintf(ofp, "                       maximum time the user can wait for the data\n");
 101         fprintf(ofp, "                       to be flushed. Requires a network URL (-U or -C/-D)\n");
 102         fprintf(ofp, "                       and a lttng-relayd listening.\n");
 103         fprintf(ofp, "\n");
 104         fprintf(ofp, "Extended Options:\n");
 105         fprintf(ofp, "\n");
 106         fprintf(ofp, "Using these options, each API call can be controlled individually.\n");
 107         fprintf(ofp, "\n");
 108         fprintf(ofp, "  -U, --set-url=URL    Set URL destination of the trace data.\n");
 109         fprintf(ofp, "                       It is persistent for the session lifetime.\n");
 110         fprintf(ofp, "                       This will set both data and control URL.\n");
 111         fprintf(ofp, "                       You can change it with the enable-consumer cmd\n");
 112         fprintf(ofp, "  -C, --ctrl-url=URL   Set control path URL. (Must use -D also)\n");
 113         fprintf(ofp, "  -D, --data-url=URL   Set data path URL. (Must use -C also)\n");
 114         fprintf(ofp, "\n");
 115         fprintf(ofp, "Please refer to the man page (lttng(1)) for more information on network\n");
 116         fprintf(ofp, "streaming mechanisms and explanation of the control and data port\n");
 117         fprintf(ofp, "You must have a running remote lttng-relayd for network streaming\n");
 118         fprintf(ofp, "\n");
 119         fprintf(ofp, "URL format is has followed:\n");
 120         fprintf(ofp, "\n");
 121         fprintf(ofp, "  proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]\n");
 122         fprintf(ofp, "\n");
 123         fprintf(ofp, "  Supported protocols are (proto):\n");
 124         fprintf(ofp, "  > file://...\n");
 125         fprintf(ofp, "    Local filesystem full path.\n");
 126         fprintf(ofp, "\n");
 127         fprintf(ofp, "  > net[6]://...\n");
 128         fprintf(ofp, "    This will use the default network transport layer which is\n");
 129         fprintf(ofp, "    TCP for both control (PORT1) and data port (PORT2).\n");
 130         fprintf(ofp, "    The default ports are respectively 5342 and 5343.\n");
 131         fprintf(ofp, "\n");
 132         fprintf(ofp, "  > tcp[6]://...\n");
 133         fprintf(ofp, "    Can only be used with -C and -D together\n");
 134         fprintf(ofp, "\n");
 135         fprintf(ofp, "NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732)\n");
 136         fprintf(ofp, "\n");
 137         fprintf(ofp, "Examples:\n");
 138         fprintf(ofp, "    # lttng create -U net://192.168.1.42\n");
 139         fprintf(ofp, "    Uses TCP and default ports for the given destination.\n");
 140         fprintf(ofp, "    # lttng create -U net6://[fe80::f66d:4ff:fe53:d220]\n");
 141         fprintf(ofp, "    Uses TCP, default ports and IPv6.\n");
 142         fprintf(ofp, "    # lttng create s1 -U net://myhost.com:3229\n");
 143         fprintf(ofp, "    Set the consumer to the remote HOST on port 3229 for control.\n");
 144         fprintf(ofp, "\n");
 145 }
 146
 147 /*
 148  * For a session name, set the consumer URLs.
 149  */
 150 static int set_consumer_url(const char *session_name, const char *ctrl_url,
 151                 const char *data_url)
 152 {
 153         int ret;
 154         struct lttng_handle *handle;
 155         struct lttng_domain dom;
 156
 157         assert(session_name);
 158
 159         /*
 160          * Set handle with the session name and the domain set to 0. This means to
 161          * the session daemon that the next action applies on the tracing session
 162          * rather then the domain specific session.
 163          */
 164         memset(&dom, 0, sizeof(dom));
 165
 166         handle = lttng_create_handle(session_name, &dom);
 167         if (handle == NULL) {
 168                 ret = CMD_FATAL;
 169                 goto error;
 170         }
 171
 172         ret = lttng_set_consumer_url(handle, ctrl_url, data_url);
 173         if (ret < 0) {
 174                 goto error;
 175         }
 176
 177         if (ctrl_url) {
 178                 MSG("Control URL %s set for session %s", ctrl_url, session_name);
 179         }
 180
 181         if (data_url) {
 182                 MSG("Data URL %s set for session %s", data_url, session_name);
 183         }
 184
 185 error:
 186         lttng_destroy_handle(handle);
 187         return ret;
 188 }
 189
 190 static int add_snapshot_output(const char *session_name, const char *ctrl_url,
 191                 const char *data_url)
 192 {
 193         int ret;
 194         struct lttng_snapshot_output *output = NULL;
 195
 196         assert(session_name);
 197
 198         output = lttng_snapshot_output_create();
 199         if (!output) {
 200                 ret = CMD_FATAL;
 201                 goto error_create;
 202         }
 203
 204         if (ctrl_url) {
 205                 ret = lttng_snapshot_output_set_ctrl_url(ctrl_url, output);
 206                 if (ret < 0) {
 207                         goto error;
 208                 }
 209         }
 210
 211         if (data_url) {
 212                 ret = lttng_snapshot_output_set_data_url(data_url, output);
 213                 if (ret < 0) {
 214                         goto error;
 215                 }
 216         }
 217
 218         /* This call, if successful, populates the id of the output object. */
 219         ret = lttng_snapshot_add_output(session_name, output);
 220         if (ret < 0) {
 221                 goto error;
 222         }
 223
 224 error:
 225         lttng_snapshot_output_destroy(output);
 226 error_create:
 227         return ret;
 228 }
 229
 230 /*
 231  *  Create a tracing session.
 232  *  If no name is specified, a default name is generated.
 233  *
 234  *  Returns one of the CMD_* result constants.
 235  */
 236 static int create_session(void)
 237 {
 238         int ret;
 239         char *session_name = NULL, *traces_path = NULL, *alloc_path = NULL;
 240         char *alloc_url = NULL, *url = NULL, datetime[16];
 241         char session_name_date[NAME_MAX + 17], *print_str_url = NULL;
 242         time_t rawtime;
 243         struct tm *timeinfo;
 244
 245         /* Get date and time for automatic session name/path */
 246         time(&rawtime);
 247         timeinfo = localtime(&rawtime);
 248         strftime(datetime, sizeof(datetime), "%Y%m%d-%H%M%S", timeinfo);
 249
 250         /* Auto session name creation */
 251         if (opt_session_name == NULL) {
 252                 ret = snprintf(session_name_date, sizeof(session_name_date),
 253                                 DEFAULT_SESSION_NAME "-%s", datetime);
 254                 if (ret < 0) {
 255                         PERROR("snprintf session name");
 256                         goto error;
 257                 }
 258                 session_name = session_name_date;
 259                 DBG("Auto session name set to %s", session_name_date);
 260         } else {
 261                 if (strlen(opt_session_name) > NAME_MAX) {
 262                         ERR("Session name too long. Length must be lower or equal to %d",
 263                                         NAME_MAX);
 264                         ret = LTTNG_ERR_SESSION_FAIL;
 265                         goto error;
 266                 }
 267                 /*
 268                  * Check if the session name begins with "auto-" or is exactly "auto".
 269                  * Both are reserved for the default session name. See bug #449 to
 270                  * understand why we need to check both here.
 271                  */
 272                 if ((strncmp(opt_session_name, DEFAULT_SESSION_NAME "-",
 273                                         strlen(DEFAULT_SESSION_NAME) + 1) == 0) ||
 274                                 (strncmp(opt_session_name, DEFAULT_SESSION_NAME,
 275                                         strlen(DEFAULT_SESSION_NAME)) == 0 &&
 276                                 strlen(opt_session_name) == strlen(DEFAULT_SESSION_NAME))) {
 277                         ERR("%s is a reserved keyword for default session(s)",
 278                                         DEFAULT_SESSION_NAME);
 279                         ret = CMD_ERROR;
 280                         goto error;
 281                 }
 282                 session_name = opt_session_name;
 283                 ret = snprintf(session_name_date, sizeof(session_name_date),
 284                                 "%s-%s", session_name, datetime);
 285                 if (ret < 0) {
 286                         PERROR("snprintf session name");
 287                         goto error;
 288                 }
 289         }
 290
 291         if (opt_output_path != NULL) {
 292                 traces_path = utils_expand_path(opt_output_path);
 293                 if (traces_path == NULL) {
 294                         ret = CMD_ERROR;
 295                         goto error;
 296                 }
 297
 298                 /* Create URL string from the local filesytem path */
 299                 ret = asprintf(&alloc_url, "file://%s", traces_path);
 300                 if (ret < 0) {
 301                         PERROR("asprintf url path");
 302                         ret = CMD_FATAL;
 303                         goto error;
 304                 }
 305                 /* URL to use in the lttng_create_session() call */
 306                 url = alloc_url;
 307                 print_str_url = traces_path;
 308         } else if (opt_url) { /* Handling URL (-U opt) */
 309                 url = opt_url;
 310                 print_str_url = url;
 311         } else if (!opt_no_output) {
 312                 /* Auto output path */
 313                 alloc_path = utils_get_home_dir();
 314                 if (alloc_path == NULL) {
 315                         ERR("HOME path not found.\n \
 316                                         Please specify an output path using -o, --output PATH");
 317                         ret = CMD_FATAL;
 318                         goto error;
 319                 }
 320                 alloc_path = strdup(alloc_path);
 321
 322                 ret = asprintf(&alloc_url,
 323                                 "file://%s/" DEFAULT_TRACE_DIR_NAME "/%s",
 324                                 alloc_path, session_name_date);
 325                 if (ret < 0) {
 326                         PERROR("asprintf trace dir name");
 327                         ret = CMD_FATAL;
 328                         goto error;
 329                 }
 330
 331                 url = alloc_url;
 332                 if (!opt_data_url && !opt_ctrl_url) {
 333                         print_str_url = alloc_url + strlen("file://");
 334                 }
 335         } else {
 336                 /* No output means --no-output or --snapshot mode. */
 337                 url = NULL;
 338         }
 339
 340         if ((!opt_ctrl_url && opt_data_url) || (opt_ctrl_url && !opt_data_url)) {
 341                 ERR("You need both control and data URL.");
 342                 ret = CMD_ERROR;
 343                 goto error;
 344         }
 345
 346         if ((opt_live_timer && !opt_url) && (opt_live_timer && !opt_data_url)) {
 347                 ERR("You need a network URL (-U or -C/-D) to use live tracing.");
 348                 ret = CMD_ERROR;
 349                 goto error;
 350         }
 351
 352         if (opt_snapshot && opt_live_timer) {
 353                 ERR("Snapshot and live modes are mutually exclusive.");
 354                 ret = CMD_ERROR;
 355                 goto error;
 356         }
 357
 358         if (opt_snapshot) {
 359                 /* No output by default. */
 360                 const char *snapshot_url = NULL;
 361
 362                 if (opt_url) {
 363                         snapshot_url = url;
 364                 } else if (!opt_data_url && !opt_ctrl_url) {
 365                         /* This is the session path that we need to use as output. */
 366                         snapshot_url = url;
 367                 }
 368                 ret = lttng_create_session_snapshot(session_name, snapshot_url);
 369         } else if (opt_live_timer) {
 370                 ret = lttng_create_session_live(session_name, url, opt_live_timer);
 371         } else {
 372                 ret = _lttng_create_session_ext(session_name, url, datetime, -1);
 373         }
 374         if (ret < 0) {
 375                 /* Don't set ret so lttng can interpret the sessiond error. */
 376                 switch (-ret) {
 377                 case LTTNG_ERR_EXIST_SESS:
 378                         WARN("Session %s already exists", session_name);
 379                         break;
 380                 default:
 381                         break;
 382                 }
 383                 goto error;
 384         }
 385
 386         if (opt_ctrl_url && opt_data_url) {
 387                 if (opt_snapshot) {
 388                         ret = add_snapshot_output(session_name, opt_ctrl_url,
 389                                         opt_data_url);
 390                 } else {
 391                         /* Setting up control URI (-C or/and -D opt) */
 392                         ret = set_consumer_url(session_name, opt_ctrl_url, opt_data_url);
 393                 }
 394                 if (ret < 0) {
 395                         /* Destroy created session because the URL are not valid. */
 396                         lttng_destroy_session(session_name);
 397                         goto error;
 398                 }
 399         }
 400
 401         MSG("Session %s created.", session_name);
 402         if (print_str_url && !opt_snapshot) {
 403                 MSG("Traces will be written in %s", print_str_url);
 404         } else if (opt_snapshot) {
 405                 if (print_str_url) {
 406                         MSG("Default snapshot output set to: %s", print_str_url);
 407                 }
 408                 MSG("Snapshot mode set. Every channel enabled for that session will "
 409                                 "be set in overwrite mode and mmap output.");
 410         }
 411
 412         /* Init lttng session config */
 413         ret = config_init(session_name);
 414         if (ret < 0) {
 415                 ret = CMD_ERROR;
 416                 goto error;
 417         }
 418
 419         ret = CMD_SUCCESS;
 420
 421 error:
 422         free(alloc_url);
 423         free(traces_path);
 424         free(alloc_path);
 425
 426         if (ret < 0) {
 427                 ERR("%s", lttng_strerror(ret));
 428         }
 429         return ret;
 430 }
 431
 432 /*
 433  *  The 'create <options>' first level command
 434  *
 435  *  Returns one of the CMD_* result constants.
 436  */
 437 int cmd_create(int argc, const char **argv)
 438 {
 439         int opt, ret = CMD_SUCCESS;
 440         char *opt_arg = NULL;
 441         static poptContext pc;
 442
 443         pc = poptGetContext(NULL, argc, argv, long_options, 0);
 444         poptReadDefaultConfig(pc, 0);
 445
 446         while ((opt = poptGetNextOpt(pc)) != -1) {
 447                 switch (opt) {
 448                 case OPT_HELP:
 449                         usage(stdout);
 450                         goto end;
 451                 case OPT_LIST_OPTIONS:
 452                         list_cmd_options(stdout, long_options);
 453                         goto end;
 454                 case OPT_LIVE_TIMER:
 455                 {
 456                         unsigned long v;
 457
 458                         errno = 0;
 459                         opt_arg = poptGetOptArg(pc);
 460                         v = strtoul(opt_arg, NULL, 0);
 461                         if (errno != 0 || !isdigit(opt_arg[0])) {
 462                                 ERR("Wrong value in --live parameter: %s", opt_arg);
 463                                 ret = CMD_ERROR;
 464                                 goto end;
 465                         }
 466                         if (v != (uint32_t) v) {
 467                                 ERR("32-bit overflow in --live parameter: %s", opt_arg);
 468                                 ret = CMD_ERROR;
 469                                 goto end;
 470                         }
 471                         opt_live_timer = (uint32_t) v;
 472                         DBG("Session live timer interval set to %d", opt_live_timer);
 473                         break;
 474                 }
 475                 default:
 476                         usage(stderr);
 477                         ret = CMD_UNDEFINED;
 478                         goto end;
 479                 }
 480         }
 481
 482         if (opt_no_consumer) {
 483                 MSG("The option --no-consumer is obsolete. Use --no-output now.");
 484                 ret = CMD_WARNING;
 485                 goto end;
 486         }
 487
 488         if (opt_disable_consumer) {
 489                 MSG("The option --disable-consumer is obsolete.");
 490                 ret = CMD_WARNING;
 491                 goto end;
 492         }
 493
 494         opt_session_name = (char*) poptGetArg(pc);
 495
 496         ret = create_session();
 497
 498 end:
 499         poptFreeContext(pc);
 500         return ret;
 501 }