src/bin/lttng/lttng.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 _LGPL_SOURCE
  19 #include <getopt.h>
  20 #include <signal.h>
  21 #include <stdio.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <sys/types.h>
  25 #include <sys/wait.h>
  26 #include <unistd.h>
  27 #include <ctype.h>
  28
  29 #include <lttng/lttng.h>
  30 #include <common/error.h>
  31 #include <common/compat/getenv.h>
  32 #include <common/utils.h>
  33
  34 #include "command.h"
  35
  36 /* Variables */
  37 static char *progname;
  38 int opt_no_sessiond;
  39 char *opt_sessiond_path;
  40
  41 char *opt_relayd_path;
  42
  43 enum {
  44         OPT_RELAYD_PATH,
  45         OPT_SESSION_PATH,
  46         OPT_DUMP_OPTIONS,
  47         OPT_DUMP_COMMANDS,
  48 };
  49
  50 /* Getopt options. No first level command. */
  51 static struct option long_options[] = {
  52         {"version",          0, NULL, 'V'},
  53         {"help",             0, NULL, 'h'},
  54         {"group",            1, NULL, 'g'},
  55         {"verbose",          0, NULL, 'v'},
  56         {"quiet",            0, NULL, 'q'},
  57         {"mi",               1, NULL, 'm'},
  58         {"no-sessiond",      0, NULL, 'n'},
  59         {"sessiond-path",    1, NULL, OPT_SESSION_PATH},
  60         {"relayd-path",      1, NULL, OPT_RELAYD_PATH},
  61         {"list-options",     0, NULL, OPT_DUMP_OPTIONS},
  62         {"list-commands",    0, NULL, OPT_DUMP_COMMANDS},
  63         {NULL, 0, NULL, 0}
  64 };
  65
  66 /* First level command */
  67 static struct cmd_struct commands[] =  {
  68         { "add-context", cmd_add_context},
  69         { "calibrate", cmd_calibrate},
  70         { "create", cmd_create},
  71         { "destroy", cmd_destroy},
  72         { "disable-channel", cmd_disable_channels},
  73         { "disable-event", cmd_disable_events},
  74         { "enable-channel", cmd_enable_channels},
  75         { "enable-event", cmd_enable_events},
  76         { "help", NULL},
  77         { "list", cmd_list},
  78         { "load", cmd_load},
  79         { "metadata", cmd_metadata},
  80         { "save", cmd_save},
  81         { "set-session", cmd_set_session},
  82         { "snapshot", cmd_snapshot},
  83         { "start", cmd_start},
  84         { "status", cmd_status},
  85         { "stop", cmd_stop},
  86         { "track", cmd_track},
  87         { "untrack", cmd_untrack},
  88         { "help", NULL},
  89         { "version", cmd_version},
  90         { "view", cmd_view},
  91         { NULL, NULL}   /* Array closure */
  92 };
  93
  94 static void version(FILE *ofp)
  95 {
  96         fprintf(ofp, "%s (LTTng Trace Control) " VERSION" - " VERSION_NAME "%s\n",
  97                         progname,
  98                         GIT_VERSION[0] == '\0' ? "" : " - " GIT_VERSION);
  99 }
 100
 101 /*
 102  * Find the MI output type enum from a string. This function is for the support
 103  * of machine interface output.
 104  */
 105 static int mi_output_type(const char *output_type)
 106 {
 107         int ret = 0;
 108
 109         if (!strncasecmp("xml", output_type, 3)) {
 110                 ret = LTTNG_MI_XML;
 111         } else {
 112                 /* Invalid output format */
 113                 ERR("MI output format not supported");
 114                 ret = -LTTNG_ERR_MI_OUTPUT_TYPE;
 115         }
 116
 117         return ret;
 118 }
 119
 120 /*
 121  *  list_options
 122  *
 123  *  List options line by line. This is mostly for bash auto completion and to
 124  *  avoid difficult parsing.
 125  */
 126 static void list_options(FILE *ofp)
 127 {
 128         int i = 0;
 129         struct option *option = NULL;
 130
 131         option = &long_options[i];
 132         while (option->name != NULL) {
 133                 fprintf(ofp, "--%s\n", option->name);
 134
 135                 if (isprint(option->val)) {
 136                         fprintf(ofp, "-%c\n", option->val);
 137                 }
 138
 139                 i++;
 140                 option = &long_options[i];
 141         }
 142 }
 143
 144 /*
 145  * clean_exit
 146  */
 147 static void clean_exit(int code)
 148 {
 149         DBG("Clean exit");
 150         exit(code);
 151 }
 152
 153 /*
 154  *  sighandler
 155  *
 156  *  Signal handler for the daemon
 157  */
 158 static void sighandler(int sig)
 159 {
 160         switch (sig) {
 161                 case SIGTERM:
 162                         DBG("SIGTERM caught");
 163                         clean_exit(EXIT_FAILURE);
 164                         break;
 165                 default:
 166                         DBG("Unknown signal %d caught", sig);
 167                         break;
 168         }
 169
 170         return;
 171 }
 172
 173 /*
 174  *  set_signal_handler
 175  *
 176  *  Setup signal handler for SIGCHLD and SIGTERM.
 177  */
 178 static int set_signal_handler(void)
 179 {
 180         int ret = 0;
 181         struct sigaction sa;
 182         sigset_t sigset;
 183
 184         if ((ret = sigemptyset(&sigset)) < 0) {
 185                 PERROR("sigemptyset");
 186                 goto end;
 187         }
 188
 189         sa.sa_handler = sighandler;
 190         sa.sa_mask = sigset;
 191         sa.sa_flags = 0;
 192
 193         if ((ret = sigaction(SIGTERM, &sa, NULL)) < 0) {
 194                 PERROR("sigaction");
 195                 goto end;
 196         }
 197
 198 end:
 199         return ret;
 200 }
 201
 202 /*
 203  *  handle_command
 204  *
 205  *  Handle the full argv list of a first level command. Will find the command
 206  *  in the global commands array and call the function callback associated.
 207  *
 208  *  If command not found, return -1
 209  *  else, return function command error code.
 210  */
 211 static int handle_command(int argc, char **argv)
 212 {
 213         int i = 0, ret;
 214         struct cmd_struct *cmd;
 215
 216         if (*argv == NULL) {
 217                 ret = CMD_SUCCESS;
 218                 goto end;
 219         }
 220
 221         /* Special case for help command which needs the commands array */
 222         if (strcmp(argv[0], "help") == 0) {
 223                 ret = cmd_help(argc, (const char**) argv, commands);
 224                 goto end;
 225         }
 226
 227         cmd = &commands[i];
 228         while (cmd->name != NULL) {
 229                 /* Find command */
 230                 if (strcmp(argv[0], cmd->name) == 0) {
 231                         ret = cmd->func(argc, (const char**) argv);
 232                         goto end;
 233                 }
 234                 i++;
 235                 cmd = &commands[i];
 236         }
 237
 238         /* Command not found */
 239         ret = CMD_UNDEFINED;
 240
 241 end:
 242         return ret;
 243 }
 244
 245 static void show_basic_help(void)
 246 {
 247         puts("Usage: lttng [--group=GROUP] [--mi=TYPE] [--no-sessiond | --sessiond-path=PATH]");
 248         puts("             [--quiet | -v | -vv | -vvv] COMMAND [COMMAND OPTIONS]");
 249         puts("");
 250         puts("Available commands:");
 251         puts("");
 252         puts("Tracing sessions:");
 253         puts("  create            " CONFIG_CMD_DESCR_CREATE);
 254         puts("  destroy           " CONFIG_CMD_DESCR_DESTROY);
 255         puts("  load              " CONFIG_CMD_DESCR_LOAD);
 256         puts("  metadata          " CONFIG_CMD_DESCR_METADATA);
 257         puts("  save              " CONFIG_CMD_DESCR_SAVE);
 258         puts("  set-session       " CONFIG_CMD_DESCR_SET_SESSION);
 259         puts("");
 260         puts("Channels:");
 261         puts("  add-context       " CONFIG_CMD_DESCR_ADD_CONTEXT);
 262         puts("  disable-channel   " CONFIG_CMD_DESCR_DISABLE_CHANNEL);
 263         puts("  enable-channel    " CONFIG_CMD_DESCR_ENABLE_CHANNEL);
 264         puts("");
 265         puts("Event rules:");
 266         puts("  disable-event     " CONFIG_CMD_DESCR_DISABLE_EVENT);
 267         puts("  enable-event      " CONFIG_CMD_DESCR_ENABLE_EVENT);
 268         puts("");
 269         puts("Status:");
 270         puts("  list              " CONFIG_CMD_DESCR_LIST);
 271         puts("  status            " CONFIG_CMD_DESCR_STATUS);
 272         puts("");
 273         puts("Control:");
 274         puts("  snapshot          " CONFIG_CMD_DESCR_SNAPSHOT);
 275         puts("  start             " CONFIG_CMD_DESCR_START);
 276         puts("  stop              " CONFIG_CMD_DESCR_STOP);
 277         puts("");
 278         puts("Resource tracking:");
 279         puts("  track             " CONFIG_CMD_DESCR_TRACK);
 280         puts("  untrack           " CONFIG_CMD_DESCR_UNTRACK);
 281         puts("");
 282         puts("Miscellaneous:");
 283         puts("  calibrate         " CONFIG_CMD_DESCR_CALIBRATE);
 284         puts("  help              " CONFIG_CMD_DESCR_HELP);
 285         puts("  version           " CONFIG_CMD_DESCR_VERSION);
 286         puts("  view              " CONFIG_CMD_DESCR_VIEW);
 287         puts("");
 288         puts("Run `lttng help COMMAND` or `lttng COMMAND --help` to get help with");
 289         puts("command COMMAND.");
 290         puts("");
 291         puts("See `man lttng` for more help with the lttng command.");
 292 }
 293
 294 /*
 295  * Parse command line arguments.
 296  *
 297  * Return 0 if OK, else -1
 298  */
 299 static int parse_args(int argc, char **argv)
 300 {
 301         int opt, ret;
 302         char *user;
 303
 304         if (lttng_is_setuid_setgid()) {
 305                 ERR("'%s' is not allowed to be executed as a setuid/setgid binary for security reasons. Aborting.", argv[0]);
 306                 clean_exit(EXIT_FAILURE);
 307         }
 308
 309         if (argc < 2) {
 310                 show_basic_help();
 311                 clean_exit(EXIT_FAILURE);
 312         }
 313
 314         while ((opt = getopt_long(argc, argv, "+Vhnvqg:m:", long_options, NULL)) != -1) {
 315                 switch (opt) {
 316                 case 'V':
 317                         version(stdout);
 318                         ret = 0;
 319                         goto end;
 320                 case 'h':
 321                         ret = utils_show_man_page(1, "lttng");
 322
 323                         if (ret) {
 324                                 ERR("Cannot view man page lttng(1)");
 325                                 perror("exec");
 326                         }
 327                         goto end;
 328                 case 'v':
 329                         /* There is only 3 possible level of verbosity. (-vvv) */
 330                         if (lttng_opt_verbose < 3) {
 331                                 lttng_opt_verbose += 1;
 332                         }
 333                         break;
 334                 case 'q':
 335                         lttng_opt_quiet = 1;
 336                         break;
 337                 case 'm':
 338                         lttng_opt_mi = mi_output_type(optarg);
 339                         if (lttng_opt_mi < 0) {
 340                                 ret = lttng_opt_mi;
 341                                 goto error;
 342                         }
 343                         break;
 344                 case 'g':
 345                         lttng_set_tracing_group(optarg);
 346                         break;
 347                 case 'n':
 348                         opt_no_sessiond = 1;
 349                         break;
 350                 case OPT_SESSION_PATH:
 351                         free(opt_sessiond_path);
 352                         opt_sessiond_path = strdup(optarg);
 353                         if (!opt_sessiond_path) {
 354                                 ret = -1;
 355                                 goto error;
 356                         }
 357                         break;
 358                 case OPT_RELAYD_PATH:
 359                         free(opt_relayd_path);
 360                         opt_relayd_path = strdup(optarg);
 361                         if (!opt_relayd_path) {
 362                                 ret = -1;
 363                                 goto error;
 364                         }
 365                         break;
 366                 case OPT_DUMP_OPTIONS:
 367                         list_options(stdout);
 368                         ret = 0;
 369                         goto end;
 370                 case OPT_DUMP_COMMANDS:
 371                         list_commands(commands, stdout);
 372                         ret = 0;
 373                         goto end;
 374                 default:
 375                         ret = 1;
 376                         goto error;
 377                 }
 378         }
 379
 380         /* If both options are specified, quiet wins */
 381         if (lttng_opt_verbose && lttng_opt_quiet) {
 382                 lttng_opt_verbose = 0;
 383         }
 384
 385         /* No leftovers, quit */
 386         if ((argc - optind) == 0) {
 387                 ret = 1;
 388                 goto error;
 389         }
 390
 391         /* For Mathieu Desnoyers a.k.a. Dr. Tracing */
 392         user = getenv("USER");
 393         if (user != NULL && ((strncmp(progname, "drtrace", 7) == 0 ||
 394                                         strncmp("compudj", user, 7) == 0))) {
 395                 MSG("%c[%d;%dmWelcome back Dr Tracing!%c[%dm\n", 27,1,33,27,0);
 396         }
 397         /* Thanks Mathieu */
 398
 399         /*
 400          * Handle leftovers which is a first level command with the trailing
 401          * options.
 402          */
 403         ret = handle_command(argc - optind, argv + optind);
 404         switch (ret) {
 405         case CMD_WARNING:
 406                 WARN("Some command(s) went wrong");
 407                 break;
 408         case CMD_ERROR:
 409                 ERR("Command error");
 410                 break;
 411         case CMD_UNDEFINED:
 412                 ERR("Undefined command or invalid arguments");
 413                 break;
 414         case CMD_FATAL:
 415                 ERR("Fatal error");
 416                 break;
 417         case CMD_UNSUPPORTED:
 418                 ERR("Unsupported command");
 419                 break;
 420         case -1:
 421                 ret = 1;
 422                 break;
 423         case 0:
 424                 break;
 425         default:
 426                 if (ret < 0) {
 427                         ret = -ret;
 428                 }
 429                 break;
 430         }
 431
 432 end:
 433 error:
 434         return ret;
 435 }
 436
 437
 438 /*
 439  *  main
 440  */
 441 int main(int argc, char *argv[])
 442 {
 443         int ret;
 444
 445         progname = argv[0] ? argv[0] : "lttng";
 446
 447         ret = set_signal_handler();
 448         if (ret < 0) {
 449                 clean_exit(ret);
 450         }
 451
 452         ret = parse_args(argc, argv);
 453         if (ret != 0) {
 454                 clean_exit(ret);
 455         }
 456
 457         return 0;
 458 }