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-uri",        'U', POPT_ARG_STRING, &opt_url, 0, 0, 0},
  56         {"ctrl-uri",       'C', POPT_ARG_STRING, &opt_ctrl_url, 0, 0, 0},
  57         {"data-uri",       '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, "      --disable-consumer\n");
  96         fprintf(ofp, "                       Disable consumer for this session.\n");
  97         fprintf(ofp, "\n");
  98         fprintf(ofp, "Please refer to the man page (lttng(1)) for more information on network\n");
  99         fprintf(ofp, "streaming mechanisms and explanation of the control and data port\n");
 100         fprintf(ofp, "You must have a running remote lttng-relayd for network streaming\n");
 101         fprintf(ofp, "\n");
 102         fprintf(ofp, "URL format is has followed:\n");
 103         fprintf(ofp, "\n");
 104         fprintf(ofp, "  proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]\n");
 105         fprintf(ofp, "\n");
 106         fprintf(ofp, "  Supported protocols are (proto):\n");
 107         fprintf(ofp, "  > file://...\n");
 108         fprintf(ofp, "    Local filesystem full path.\n");
 109         fprintf(ofp, "\n");
 110         fprintf(ofp, "  > net[6]://...\n");
 111         fprintf(ofp, "    This will use the default network transport layer which is\n");
 112         fprintf(ofp, "    TCP for both control (PORT1) and data port (PORT2).\n");
 113         fprintf(ofp, "    The default ports are respectively 5342 and 5343.\n");
 114         fprintf(ofp, "\n");
 115         fprintf(ofp, "  > tcp[4|6]://...\n");
 116         fprintf(ofp, "    Can only be used with -C and -D together\n");
 117         fprintf(ofp, "\n");
 118         fprintf(ofp, "NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732)\n");
 119         fprintf(ofp, "\n");
 120         fprintf(ofp, "Examples:\n");
 121         fprintf(ofp, "    # lttng create -U net://192.168.1.42\n");
 122         fprintf(ofp, "    Uses TCP and default ports for the given destination.\n");
 123         fprintf(ofp, "    # lttng create -U net6://[fe80::f66d:4ff:fe53:d220]\n");
 124         fprintf(ofp, "    Uses TCP, default ports and IPv6.\n");
 125         fprintf(ofp, "    # lttng create s1 -U net://myhost.com:3229\n");
 126         fprintf(ofp, "    Set the consumer to the remote HOST on port 3229 for control.\n");
 127         fprintf(ofp, "\n");
 128 }
 129
 130 /*
 131  * For a session name, set the consumer URLs.
 132  */
 133 static int set_consumer_url(const char *session_name, const char *ctrl_url,
 134                 const char *data_url)
 135 {
 136         int ret;
 137         struct lttng_handle *handle;
 138         struct lttng_domain dom;
 139
 140         assert(session_name);
 141
 142         /*
 143          * Set handle with the session name and the domain set to 0. This means to
 144          * the session daemon that the next action applies on the tracing session
 145          * rather then the domain specific session.
 146          */
 147         memset(&dom, 0, sizeof(dom));
 148
 149         handle = lttng_create_handle(session_name, &dom);
 150         if (handle == NULL) {
 151                 ret = CMD_FATAL;
 152                 goto error;
 153         }
 154
 155         ret = lttng_set_consumer_url(handle, ctrl_url, data_url);
 156         if (ret < 0) {
 157                 goto error;
 158         }
 159
 160         if (ctrl_url) {
 161                 MSG("Control URL %s set for session %s", ctrl_url, session_name);
 162         }
 163
 164         if (data_url) {
 165                 MSG("Data URL %s set for session %s", data_url, session_name);
 166         }
 167
 168 error:
 169         lttng_destroy_handle(handle);
 170         return ret;
 171 }
 172
 173 /*
 174  * For a session name, enable the consumer.
 175  */
 176 static int enable_consumer(const char *session_name)
 177 {
 178         int ret;
 179         struct lttng_handle *handle;
 180         struct lttng_domain dom;
 181
 182         assert(session_name);
 183
 184         /*
 185          * Set handle with the session name and the domain set to 0. This means to
 186          * the session daemon that the next action applies on the tracing session
 187          * rather then the domain specific session.
 188          *
 189          * XXX: This '0' value should be a domain enum value.
 190          */
 191         memset(&dom, 0, sizeof(dom));
 192
 193         handle = lttng_create_handle(session_name, 0);
 194         if (handle == NULL) {
 195                 ret = CMD_FATAL;
 196                 goto error;
 197         }
 198
 199         ret = lttng_enable_consumer(handle);
 200         if (ret < 0) {
 201                 goto error;
 202         }
 203
 204         MSG("Consumer enabled for session %s", session_name);
 205
 206 error:
 207         lttng_destroy_handle(handle);
 208         return ret;
 209 }
 210
 211 /*
 212  * For a session name, disable the consumer.
 213  */
 214 static int disable_consumer(const char *session_name)
 215 {
 216         int ret;
 217         struct lttng_handle *handle;
 218
 219         assert(session_name);
 220
 221         /*
 222          * Set handle with the session name and the domain set to 0. This means to
 223          * the session daemon that the next action applies on the tracing session
 224          * rather then the domain specific session.
 225          *
 226          * XXX: This '0' value should be a domain enum value.
 227          */
 228         handle = lttng_create_handle(session_name, 0);
 229         if (handle == NULL) {
 230                 ret = CMD_FATAL;
 231                 goto error;
 232         }
 233
 234         ret = lttng_disable_consumer(handle);
 235         if (ret < 0) {
 236                 goto error;
 237         }
 238         free(handle);
 239
 240         MSG("Consumer disabled for session %s", session_name);
 241
 242 error:
 243         return ret;
 244 }
 245
 246 /*
 247  *  Create a tracing session.
 248  *  If no name is specified, a default name is generated.
 249  *
 250  *  Returns one of the CMD_* result constants.
 251  */
 252 static int create_session(void)
 253 {
 254         int ret;
 255         char *session_name = NULL, *traces_path = NULL, *alloc_path = NULL;
 256         char *alloc_url = NULL, *url = NULL, datetime[16];
 257         char session_name_date[NAME_MAX];
 258         time_t rawtime;
 259         struct tm *timeinfo;
 260
 261         /* Get date and time for automatic session name/path */
 262         time(&rawtime);
 263         timeinfo = localtime(&rawtime);
 264         strftime(datetime, sizeof(datetime), "%Y%m%d-%H%M%S", timeinfo);
 265
 266         /* Auto session name creation */
 267         if (opt_session_name == NULL) {
 268                 ret = snprintf(session_name_date, sizeof(session_name_date),
 269                                 DEFAULT_SESSION_NAME "-%s", datetime);
 270                 if (ret < 0) {
 271                         PERROR("snprintf session name");
 272                         goto error;
 273                 }
 274                 session_name = strdup(DEFAULT_SESSION_NAME);
 275                 if (session_name == NULL) {
 276                         PERROR("strdup session name");
 277                         goto error;
 278                 }
 279                 DBG("Auto session name set to %s", session_name_date);
 280         } else {
 281                 session_name = opt_session_name;
 282                 ret = snprintf(session_name_date, sizeof(session_name_date),
 283                                 "%s-%s", session_name, datetime);
 284                 if (ret < 0) {
 285                         PERROR("snprintf session name");
 286                         goto error;
 287                 }
 288         }
 289
 290         if (opt_no_consumer) {
 291                 url = NULL;
 292         } else if (opt_output_path != NULL) {
 293                 traces_path = utils_expand_path(opt_output_path);
 294                 if (traces_path == NULL) {
 295                         ret = CMD_ERROR;
 296                         goto error;
 297                 }
 298
 299                 /* Create URL string from the local filesytem path */
 300                 ret = asprintf(&alloc_url, "file://%s", traces_path);
 301                 if (ret < 0) {
 302                         PERROR("asprintf url path");
 303                         ret = CMD_FATAL;
 304                         goto error;
 305                 }
 306                 /* URL to use in the lttng_create_session() call */
 307                 url = alloc_url;
 308                 MSG("Trace(s) output set to %s", traces_path);
 309         } else if (opt_url) { /* Handling URL (-U opt) */
 310                 url = opt_url;
 311                 MSG("Trace(s) output set to %s", url);
 312         } else if (opt_ctrl_url == NULL && opt_data_url == NULL) {
 313                 /* Auto output path */
 314                 alloc_path = config_get_default_path();
 315                 if (alloc_path == NULL) {
 316                         ERR("HOME path not found.\n \
 317                                         Please specify an output path using -o, --output PATH");
 318                         ret = CMD_FATAL;
 319                         goto error;
 320                 }
 321                 alloc_path = strdup(alloc_path);
 322
 323                 ret = asprintf(&alloc_url,
 324                                 "file://%s/" DEFAULT_TRACE_DIR_NAME "/%s",
 325                                 alloc_path, session_name_date);
 326                 if (ret < 0) {
 327                         PERROR("asprintf trace dir name");
 328                         ret = CMD_FATAL;
 329                         goto error;
 330                 }
 331
 332                 url = alloc_url;
 333                 MSG("Trace(s) output set to %s", alloc_url + strlen("file://"));
 334         }
 335
 336         ret = _lttng_create_session_ext(session_name, url, datetime);
 337         if (ret < 0) {
 338                 /* Don't set ret so lttng can interpret the sessiond error. */
 339                 switch (-ret) {
 340                 case LTTCOMM_EXIST_SESS:
 341                         WARN("Session %s already exists", session_name);
 342                         break;
 343                 }
 344                 goto error;
 345         }
 346
 347         if (opt_session_name == NULL) {
 348                 MSG("Session created with default name %s", session_name_date);
 349         } else {
 350                 MSG("Session %s created.", session_name);
 351         }
 352
 353         if (opt_ctrl_url || opt_data_url) {
 354                 /* Setting up control URI (-C or/and -D opt) */
 355                 ret = set_consumer_url(session_name, opt_ctrl_url, opt_data_url);
 356                 if (ret < 0) {
 357                         goto error;
 358                 }
 359
 360                 ret = enable_consumer(session_name);
 361                 if (ret < 0) {
 362                         goto error;
 363                 }
 364         }
 365
 366         if (opt_disable_consumer && !opt_no_consumer) {
 367                 ret = disable_consumer(session_name);
 368                 if (ret < 0) {
 369                         goto error;
 370                 }
 371         }
 372
 373         if (opt_session_name == NULL) {
 374                 free(session_name);
 375                 session_name = session_name_date;
 376         }
 377
 378         /* Init lttng session config */
 379         ret = config_init(session_name);
 380         if (ret < 0) {
 381                 ret = CMD_ERROR;
 382                 goto error;
 383         }
 384
 385
 386         ret = CMD_SUCCESS;
 387
 388 error:
 389         if (opt_session_name == NULL && session_name != session_name_date) {
 390                 free(session_name);
 391         }
 392
 393         if (alloc_url) {
 394                 free(alloc_url);
 395         }
 396
 397         if (traces_path) {
 398                 free(traces_path);
 399         }
 400
 401         if (ret < 0) {
 402                 ERR("%s", lttng_strerror(ret));
 403         }
 404         return ret;
 405 }
 406
 407 /*
 408  *  The 'create <options>' first level command
 409  *
 410  *  Returns one of the CMD_* result constants.
 411  */
 412 int cmd_create(int argc, const char **argv)
 413 {
 414         int opt, ret = CMD_SUCCESS;
 415         static poptContext pc;
 416
 417         pc = poptGetContext(NULL, argc, argv, long_options, 0);
 418         poptReadDefaultConfig(pc, 0);
 419
 420         while ((opt = poptGetNextOpt(pc)) != -1) {
 421                 switch (opt) {
 422                 case OPT_HELP:
 423                         usage(stdout);
 424                         goto end;
 425                 case OPT_LIST_OPTIONS:
 426                         list_cmd_options(stdout, long_options);
 427                         goto end;
 428                 default:
 429                         usage(stderr);
 430                         ret = CMD_UNDEFINED;
 431                         goto end;
 432                 }
 433         }
 434
 435         opt_session_name = (char*) poptGetArg(pc);
 436
 437         ret = create_session();
 438
 439 end:
 440         poptFreeContext(pc);
 441         return ret;
 442 }