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 | POPT_ARGFLAG_OPTIONAL, 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. Can be set with a network\n");
 102         fprintf(ofp, "                       URL (-U or -C/-D) and must have a relayd listening.\n");
 103         fprintf(ofp, "                       By default, %u is used for the timer and the\n",
 104                                                                                         DEFAULT_LTTNG_LIVE_TIMER);
 105         fprintf(ofp, "                       network URL is set to net://127.0.0.1.\n");
 106         fprintf(ofp, "\n");
 107         fprintf(ofp, "Extended Options:\n");
 108         fprintf(ofp, "\n");
 109         fprintf(ofp, "Using these options, each API call can be controlled individually.\n");
 110         fprintf(ofp, "\n");
 111         fprintf(ofp, "  -U, --set-url=URL    Set URL destination of the trace data.\n");
 112         fprintf(ofp, "                       It is persistent for the session lifetime.\n");
 113         fprintf(ofp, "                       This will set both data and control URL.\n");
 114         fprintf(ofp, "                       You can change it with the enable-consumer cmd\n");
 115         fprintf(ofp, "  -C, --ctrl-url=URL   Set control path URL. (Must use -D also)\n");
 116         fprintf(ofp, "  -D, --data-url=URL   Set data path URL. (Must use -C also)\n");
 117         fprintf(ofp, "\n");
 118         fprintf(ofp, "Please refer to the man page (lttng(1)) for more information on network\n");
 119         fprintf(ofp, "streaming mechanisms and explanation of the control and data port\n");
 120         fprintf(ofp, "You must have a running remote lttng-relayd for network streaming\n");
 121         fprintf(ofp, "\n");
 122         fprintf(ofp, "URL format is has followed:\n");
 123         fprintf(ofp, "\n");
 124         fprintf(ofp, "  proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]\n");
 125         fprintf(ofp, "\n");
 126         fprintf(ofp, "  Supported protocols are (proto):\n");
 127         fprintf(ofp, "  > file://...\n");
 128         fprintf(ofp, "    Local filesystem full path.\n");
 129         fprintf(ofp, "\n");
 130         fprintf(ofp, "  > net[6]://...\n");
 131         fprintf(ofp, "    This will use the default network transport layer which is\n");
 132         fprintf(ofp, "    TCP for both control (PORT1) and data port (PORT2).\n");
 133         fprintf(ofp, "    The default ports are respectively 5342 and 5343.\n");
 134         fprintf(ofp, "\n");
 135         fprintf(ofp, "  > tcp[6]://...\n");
 136         fprintf(ofp, "    Can only be used with -C and -D together\n");
 137         fprintf(ofp, "\n");
 138         fprintf(ofp, "NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732)\n");
 139         fprintf(ofp, "\n");
 140         fprintf(ofp, "Examples:\n");
 141         fprintf(ofp, "    # lttng create -U net://192.168.1.42\n");
 142         fprintf(ofp, "    Uses TCP and default ports for the given destination.\n");
 143         fprintf(ofp, "    # lttng create -U net6://[fe80::f66d:4ff:fe53:d220]\n");
 144         fprintf(ofp, "    Uses TCP, default ports and IPv6.\n");
 145         fprintf(ofp, "    # lttng create s1 -U net://myhost.com:3229\n");
 146         fprintf(ofp, "    Set the consumer to the remote HOST on port 3229 for control.\n");
 147         fprintf(ofp, "\n");
 148 }
 149
 150 /*
 151  * For a session name, set the consumer URLs.
 152  */
 153 static int set_consumer_url(const char *session_name, const char *ctrl_url,
 154                 const char *data_url)
 155 {
 156         int ret;
 157         struct lttng_handle *handle;
 158         struct lttng_domain dom;
 159
 160         assert(session_name);
 161
 162         /*
 163          * Set handle with the session name and the domain set to 0. This means to
 164          * the session daemon that the next action applies on the tracing session
 165          * rather then the domain specific session.
 166          */
 167         memset(&dom, 0, sizeof(dom));
 168
 169         handle = lttng_create_handle(session_name, &dom);
 170         if (handle == NULL) {
 171                 ret = CMD_FATAL;
 172                 goto error;
 173         }
 174
 175         ret = lttng_set_consumer_url(handle, ctrl_url, data_url);
 176         if (ret < 0) {
 177                 goto error;
 178         }
 179
 180         if (ctrl_url) {
 181                 MSG("Control URL %s set for session %s", ctrl_url, session_name);
 182         }
 183
 184         if (data_url) {
 185                 MSG("Data URL %s set for session %s", data_url, session_name);
 186         }
 187
 188 error:
 189         lttng_destroy_handle(handle);
 190         return ret;
 191 }
 192
 193 static int add_snapshot_output(const char *session_name, const char *ctrl_url,
 194                 const char *data_url)
 195 {
 196         int ret;
 197         struct lttng_snapshot_output *output = NULL;
 198
 199         assert(session_name);
 200
 201         output = lttng_snapshot_output_create();
 202         if (!output) {
 203                 ret = CMD_FATAL;
 204                 goto error_create;
 205         }
 206
 207         if (ctrl_url) {
 208                 ret = lttng_snapshot_output_set_ctrl_url(ctrl_url, output);
 209                 if (ret < 0) {
 210                         goto error;
 211                 }
 212         }
 213
 214         if (data_url) {
 215                 ret = lttng_snapshot_output_set_data_url(data_url, output);
 216                 if (ret < 0) {
 217                         goto error;
 218                 }
 219         }
 220
 221         /* This call, if successful, populates the id of the output object. */
 222         ret = lttng_snapshot_add_output(session_name, output);
 223         if (ret < 0) {
 224                 goto error;
 225         }
 226
 227 error:
 228         lttng_snapshot_output_destroy(output);
 229 error_create:
 230         return ret;
 231 }
 232
 233 /*
 234  *  Create a tracing session.
 235  *  If no name is specified, a default name is generated.
 236  *
 237  *  Returns one of the CMD_* result constants.
 238  */
 239 static int create_session(void)
 240 {
 241         int ret;
 242         char *session_name = NULL, *traces_path = NULL, *alloc_path = NULL;
 243         char *alloc_url = NULL, *url = NULL, datetime[16];
 244         char session_name_date[NAME_MAX + 17], *print_str_url = NULL;
 245         time_t rawtime;
 246         struct tm *timeinfo;
 247
 248         /* Get date and time for automatic session name/path */
 249         time(&rawtime);
 250         timeinfo = localtime(&rawtime);
 251         strftime(datetime, sizeof(datetime), "%Y%m%d-%H%M%S", timeinfo);
 252
 253         /* Auto session name creation */
 254         if (opt_session_name == NULL) {
 255                 ret = snprintf(session_name_date, sizeof(session_name_date),
 256                                 DEFAULT_SESSION_NAME "-%s", datetime);
 257                 if (ret < 0) {
 258                         PERROR("snprintf session name");
 259                         goto error;
 260                 }
 261                 session_name = session_name_date;
 262                 DBG("Auto session name set to %s", session_name_date);
 263         } else {
 264                 if (strlen(opt_session_name) > NAME_MAX) {
 265                         ERR("Session name too long. Length must be lower or equal to %d",
 266                                         NAME_MAX);
 267                         ret = LTTNG_ERR_SESSION_FAIL;
 268                         goto error;
 269                 }
 270                 /*
 271                  * Check if the session name begins with "auto-" or is exactly "auto".
 272                  * Both are reserved for the default session name. See bug #449 to
 273                  * understand why we need to check both here.
 274                  */
 275                 if ((strncmp(opt_session_name, DEFAULT_SESSION_NAME "-",
 276                                         strlen(DEFAULT_SESSION_NAME) + 1) == 0) ||
 277                                 (strncmp(opt_session_name, DEFAULT_SESSION_NAME,
 278                                         strlen(DEFAULT_SESSION_NAME)) == 0 &&
 279                                 strlen(opt_session_name) == strlen(DEFAULT_SESSION_NAME))) {
 280                         ERR("%s is a reserved keyword for default session(s)",
 281                                         DEFAULT_SESSION_NAME);
 282                         ret = CMD_ERROR;
 283                         goto error;
 284                 }
 285                 session_name = opt_session_name;
 286                 ret = snprintf(session_name_date, sizeof(session_name_date),
 287                                 "%s-%s", session_name, datetime);
 288                 if (ret < 0) {
 289                         PERROR("snprintf session name");
 290                         goto error;
 291                 }
 292         }
 293
 294         if ((!opt_ctrl_url && opt_data_url) || (opt_ctrl_url && !opt_data_url)) {
 295                 ERR("You need both control and data URL.");
 296                 ret = CMD_ERROR;
 297                 goto error;
 298         }
 299
 300         if (opt_output_path != NULL) {
 301                 traces_path = utils_expand_path(opt_output_path);
 302                 if (traces_path == NULL) {
 303                         ret = CMD_ERROR;
 304                         goto error;
 305                 }
 306
 307                 /* Create URL string from the local filesytem path */
 308                 ret = asprintf(&alloc_url, "file://%s", traces_path);
 309                 if (ret < 0) {
 310                         PERROR("asprintf url path");
 311                         ret = CMD_FATAL;
 312                         goto error;
 313                 }
 314                 /* URL to use in the lttng_create_session() call */
 315                 url = alloc_url;
 316                 print_str_url = traces_path;
 317         } else if (opt_url) { /* Handling URL (-U opt) */
 318                 url = opt_url;
 319                 print_str_url = url;
 320         } else if (opt_data_url && opt_ctrl_url) {
 321                 /*
 322                  * With both control and data, we'll be setting the consumer URL after
 323                  * session creation thus use no URL.
 324                  */
 325                 url = NULL;
 326         } else if (!opt_no_output) {
 327                 /* Auto output path */
 328                 alloc_path = utils_get_home_dir();
 329                 if (alloc_path == NULL) {
 330                         ERR("HOME path not found.\n \
 331                                         Please specify an output path using -o, --output PATH");
 332                         ret = CMD_FATAL;
 333                         goto error;
 334                 }
 335                 alloc_path = strdup(alloc_path);
 336
 337                 ret = asprintf(&alloc_url,
 338                                 "file://%s/" DEFAULT_TRACE_DIR_NAME "/%s",
 339                                 alloc_path, session_name_date);
 340                 if (ret < 0) {
 341                         PERROR("asprintf trace dir name");
 342                         ret = CMD_FATAL;
 343                         goto error;
 344                 }
 345
 346                 url = alloc_url;
 347                 print_str_url = alloc_url + strlen("file://");
 348         } else {
 349                 /* No output means --no-output or --snapshot mode. */
 350                 url = NULL;
 351         }
 352
 353         /* Use default live URL if NO url is/are found. */
 354         if ((opt_live_timer && !opt_url) && (opt_live_timer && !opt_data_url)) {
 355                 ret = asprintf(&alloc_url, "net://127.0.0.1");
 356                 if (ret < 0) {
 357                         PERROR("asprintf default live URL");
 358                         ret = CMD_FATAL;
 359                         goto error;
 360                 }
 361                 url = alloc_url;
 362                 print_str_url = url;
 363         }
 364
 365         if (opt_snapshot && opt_live_timer) {
 366                 ERR("Snapshot and live modes are mutually exclusive.");
 367                 ret = CMD_ERROR;
 368                 goto error;
 369         }
 370
 371         if (opt_snapshot) {
 372                 /* No output by default. */
 373                 const char *snapshot_url = NULL;
 374
 375                 if (opt_url) {
 376                         snapshot_url = url;
 377                 } else if (!opt_data_url && !opt_ctrl_url) {
 378                         /* This is the session path that we need to use as output. */
 379                         snapshot_url = url;
 380                 }
 381                 ret = lttng_create_session_snapshot(session_name, snapshot_url);
 382         } else if (opt_live_timer) {
 383                 const char *pathname;
 384
 385                 if (opt_relayd_path) {
 386                         pathname = opt_relayd_path;
 387                 } else {
 388                         pathname = INSTALL_BIN_PATH "/lttng-relayd";
 389                 }
 390                 if (!opt_url && !opt_data_url && !check_relayd() &&
 391                                 spawn_relayd(pathname, 0) < 0) {
 392                         goto error;
 393                 }
 394                 ret = lttng_create_session_live(session_name, url, opt_live_timer);
 395         } else {
 396                 ret = _lttng_create_session_ext(session_name, url, datetime, -1);
 397         }
 398         if (ret < 0) {
 399                 /* Don't set ret so lttng can interpret the sessiond error. */
 400                 switch (-ret) {
 401                 case LTTNG_ERR_EXIST_SESS:
 402                         WARN("Session %s already exists", session_name);
 403                         break;
 404                 default:
 405                         break;
 406                 }
 407                 goto error;
 408         }
 409
 410         if (opt_ctrl_url && opt_data_url) {
 411                 if (opt_snapshot) {
 412                         ret = add_snapshot_output(session_name, opt_ctrl_url,
 413                                         opt_data_url);
 414                 } else {
 415                         /* Setting up control URI (-C or/and -D opt) */
 416                         ret = set_consumer_url(session_name, opt_ctrl_url, opt_data_url);
 417                 }
 418                 if (ret < 0) {
 419                         /* Destroy created session because the URL are not valid. */
 420                         lttng_destroy_session(session_name);
 421                         goto error;
 422                 }
 423         }
 424
 425         MSG("Session %s created.", session_name);
 426         if (print_str_url && !opt_snapshot) {
 427                 MSG("Traces will be written in %s", print_str_url);
 428
 429                 if (opt_live_timer) {
 430                         MSG("Live timer set to %u usec", opt_live_timer);
 431                 }
 432         } else if (opt_snapshot) {
 433                 if (print_str_url) {
 434                         MSG("Default snapshot output set to: %s", print_str_url);
 435                 }
 436                 MSG("Snapshot mode set. Every channel enabled for that session will "
 437                                 "be set in overwrite mode and mmap output.");
 438         }
 439
 440         /* Init lttng session config */
 441         ret = config_init(session_name);
 442         if (ret < 0) {
 443                 ret = CMD_ERROR;
 444                 goto error;
 445         }
 446
 447         ret = CMD_SUCCESS;
 448
 449 error:
 450         free(alloc_url);
 451         free(traces_path);
 452         free(alloc_path);
 453
 454         if (ret < 0) {
 455                 ERR("%s", lttng_strerror(ret));
 456         }
 457         return ret;
 458 }
 459
 460 /*
 461  *  The 'create <options>' first level command
 462  *
 463  *  Returns one of the CMD_* result constants.
 464  */
 465 int cmd_create(int argc, const char **argv)
 466 {
 467         int opt, ret = CMD_SUCCESS;
 468         char *opt_arg = NULL;
 469         static poptContext pc;
 470
 471         pc = poptGetContext(NULL, argc, argv, long_options, 0);
 472         poptReadDefaultConfig(pc, 0);
 473
 474         while ((opt = poptGetNextOpt(pc)) != -1) {
 475                 switch (opt) {
 476                 case OPT_HELP:
 477                         usage(stdout);
 478                         goto end;
 479                 case OPT_LIST_OPTIONS:
 480                         list_cmd_options(stdout, long_options);
 481                         goto end;
 482                 case OPT_LIVE_TIMER:
 483                 {
 484                         unsigned long v;
 485
 486                         errno = 0;
 487                         opt_arg = poptGetOptArg(pc);
 488                         if (!opt_arg) {
 489                                 /* Set up default values. */
 490                                 opt_live_timer = (uint32_t) DEFAULT_LTTNG_LIVE_TIMER;
 491                                 DBG("Session live timer interval set to default value %d",
 492                                                 opt_live_timer);
 493                                 break;
 494                         }
 495
 496                         v = strtoul(opt_arg, NULL, 0);
 497                         if (errno != 0 || !isdigit(opt_arg[0])) {
 498                                 ERR("Wrong value in --live parameter: %s", opt_arg);
 499                                 ret = CMD_ERROR;
 500                                 goto end;
 501                         }
 502                         if (v != (uint32_t) v) {
 503                                 ERR("32-bit overflow in --live parameter: %s", opt_arg);
 504                                 ret = CMD_ERROR;
 505                                 goto end;
 506                         }
 507                         opt_live_timer = (uint32_t) v;
 508                         DBG("Session live timer interval set to %d", opt_live_timer);
 509                         break;
 510                 }
 511                 default:
 512                         usage(stderr);
 513                         ret = CMD_UNDEFINED;
 514                         goto end;
 515                 }
 516         }
 517
 518         /* TODO: mi support */
 519         if (lttng_opt_mi) {
 520                 ret = -LTTNG_ERR_MI_NOT_IMPLEMENTED;
 521                 ERR("mi option not supported");
 522                 goto end;
 523         }
 524
 525         if (opt_no_consumer) {
 526                 MSG("The option --no-consumer is obsolete. Use --no-output now.");
 527                 ret = CMD_WARNING;
 528                 goto end;
 529         }
 530
 531         if (opt_disable_consumer) {
 532                 MSG("The option --disable-consumer is obsolete.");
 533                 ret = CMD_WARNING;
 534                 goto end;
 535         }
 536
 537         opt_session_name = (char*) poptGetArg(pc);
 538
 539         ret = create_session();
 540
 541 end:
 542         poptFreeContext(pc);
 543         return ret;
 544 }