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