lttng/options.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
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  17  */
  18
  19 #include <popt.h>
  20 #include <stdlib.h>
  21
  22 #include "options.h"
  23
  24 /* Option variables */
  25 char *opt_event_list;
  26 char *opt_tracing_group;
  27 char *opt_sessiond_path;
  28 char *opt_session_name;
  29 char *opt_trace_name;
  30 int opt_destroy_trace;
  31 int opt_create_session;
  32 int opt_destroy_session;
  33 int opt_trace_kernel;
  34 int opt_quiet;
  35 int opt_verbose;
  36 int opt_list_apps;
  37 int opt_list_events;
  38 int opt_no_sessiond;
  39 int opt_list_session;
  40 int opt_list_traces;
  41 int opt_create_trace;
  42 int opt_start_trace;
  43 int opt_stop_trace;
  44 int opt_enable_event;
  45 int opt_enable_all_event;
  46 int opt_disable_event;
  47 int opt_kern_create_channel;
  48 pid_t opt_trace_pid;
  49
  50 enum {
  51         OPT_HELP = 1,
  52         OPT_ENABLE_EVENT,
  53         OPT_DISABLE_EVENT,
  54         OPT_CREATE_SESSION,
  55         OPT_CREATE_TRACE,
  56         OPT_DESTROY_SESSION,
  57         OPT_DESTROY_TRACE,
  58         OPT_START_TRACE,
  59         OPT_STOP_TRACE,
  60 };
  61
  62 static struct poptOption long_options[] = {
  63         /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
  64         {"create-session",  'c',        POPT_ARG_STRING,        0, OPT_CREATE_SESSION, 0, 0},
  65         {"create-trace",    'C',    POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, 0, OPT_CREATE_TRACE, 0, 0},
  66         {"destroy-trace",   'D',    POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, 0, OPT_DESTROY_TRACE, 0, 0},
  67         {"destroy-session", 'd',        POPT_ARG_STRING,        0, OPT_DESTROY_SESSION, 0, 0},
  68         {"disable-event",       0,              POPT_ARG_STRING,        0, OPT_DISABLE_EVENT, 0, 0},
  69         {"enable-event",        'e',    POPT_ARG_STRING,        0, OPT_ENABLE_EVENT, 0, 0},
  70         {"enable-all-event",'a',        POPT_ARG_VAL,           &opt_enable_all_event, 1, 0, 0},
  71         {"group",                       0,              POPT_ARG_STRING,        &opt_tracing_group, 0, 0, 0},
  72         {"help",                        'h',    POPT_ARG_NONE,          0, OPT_HELP, 0, 0},
  73         {"kernel",                      'k',    POPT_ARG_VAL,           &opt_trace_kernel, 1, 0, 0},
  74         {"kern-create-channel",0,   POPT_ARG_VAL,               &opt_kern_create_channel, 1, 0, 0},
  75         {"list-apps",           'L',    POPT_ARG_VAL,           &opt_list_apps, 1, 0, 0},
  76         {"list-events",         0,              POPT_ARG_VAL,           &opt_list_events, 1, 0, 0},
  77         {"list-sessions",       'l',    POPT_ARG_VAL,           &opt_list_session, 1, 0, 0},
  78         {"list-traces",         't',    POPT_ARG_VAL,           &opt_list_traces, 1, 0, 0},
  79         {"no-kernel",           0,              POPT_ARG_VAL,           &opt_trace_kernel, 0, 0, 0},
  80         {"no-sessiond",         0,              POPT_ARG_VAL,           &opt_no_sessiond, 1, 0, 0},
  81         {"pid",                         'p',    POPT_ARG_INT,           &opt_trace_pid, 0, 0, 0},
  82         {"quiet",                       'q',    POPT_ARG_VAL,           &opt_quiet, 1, 0, 0},
  83         {"session",                     's',    POPT_ARG_STRING,        &opt_session_name, 0, 0, 0},
  84         {"sessiond-path",       0,              POPT_ARG_STRING,        &opt_sessiond_path, 0, 0, 0},
  85         {"start",                       0,              POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, 0, OPT_START_TRACE, 0, 0},
  86         {"stop",                        0,              POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, 0, OPT_STOP_TRACE, 0, 0},
  87         {"verbose",                     'v',    POPT_ARG_VAL,           &opt_verbose, 1, 0, 0},
  88         {0, 0, 0, 0, 0, 0, 0}
  89 };
  90
  91
  92 /*
  93  *      usage
  94  */
  95 static void usage(FILE *ofp)
  96 {
  97         fprintf(ofp, "LTTng Trace Control " VERSION"\n\n");
  98         fprintf(ofp, "usage : lttng [OPTION]\n");
  99         fprintf(ofp, "\n");
 100         fprintf(ofp, "Options:\n");
 101         fprintf(ofp, "  -v, --verbose                Verbose mode\n");
 102         fprintf(ofp, "  -q, --quiet                  Quiet mode\n");
 103         fprintf(ofp, "      --help                   Show help\n");
 104         fprintf(ofp, "      --group NAME             Unix tracing group name. (default: tracing)\n");
 105         fprintf(ofp, "      --no-sessiond            Don't spawn a session daemon\n");
 106         fprintf(ofp, "      --sessiond-path          Session daemon full path\n");
 107         fprintf(ofp, "  -L, --list-apps              List traceable user-space applications\n");
 108         fprintf(ofp, "\n");
 109         fprintf(ofp, "Session options:\n");
 110         fprintf(ofp, "  -c, --create-session NAME    Create a new session\n");
 111         fprintf(ofp, "  -l, --list-sessions          List all available sessions by name\n");
 112         fprintf(ofp, "  -s, --session UUID           Specify tracing session using UUID\n");
 113         fprintf(ofp, "  -d, --destroy-session NAME   Destroy the session specified by NAME\n");
 114         fprintf(ofp, "  -t, --list-traces            List session's traces. Use -s to specify the session\n");
 115         fprintf(ofp, "\n");
 116         fprintf(ofp, "Tracing options:\n");
 117         fprintf(ofp, "  -p, --pid PID                Specify action on user-space tracer for PID\n");
 118         fprintf(ofp, "  -k, --kernel                 Specify action on kernel tracer\n");
 119         fprintf(ofp, "      --list-events            List all available tracing events\n");
 120         fprintf(ofp, "  -e, --enable-event LIST      Enable tracing event (support marker and tracepoint)\n");
 121         fprintf(ofp, "  -a, --enable-all-event       Enable all tracing event\n");
 122         fprintf(ofp, "      --disable-event LIST     Disable tracing event (support marker and tracepoint)\n");
 123         fprintf(ofp, "  -C, --create-trace           Create a trace. Allocate and setup a trace\n");
 124         fprintf(ofp, "  -D, --destroy-trace [NAME]   Destroy a trace. Use NAME to identify user-space trace\n");
 125         fprintf(ofp, "      --start [NAME]           Start tracing. Use NAME to identify user-space trace\n");
 126         fprintf(ofp, "      --stop [NAME]            Stop tracing. Use NAME to identify user-space trace\n");
 127         fprintf(ofp, "\n");
 128         fprintf(ofp, "Kernel tracing options:\n");
 129         fprintf(ofp, "      --kern-create-channel    Create a kernel channel\n");
 130         fprintf(ofp, "\n");
 131         fprintf(ofp, "User-space tracing options:\n");
 132         fprintf(ofp, "\n");
 133         fprintf(ofp, "Please see the lttng(1) man page for full documentation.\n");
 134         fprintf(ofp, "See http://lttng.org for updates, bug reports and news.\n");
 135 }
 136
 137 /*
 138  *  parse_args
 139  *
 140  *  Parse command line arguments.
 141  *  Return 0 if OK, else -1
 142  */
 143 int parse_args(int argc, const char **argv)
 144 {
 145         static poptContext pc;
 146         int opt;
 147
 148         /* If no options, fail */
 149         if (argc < 2) {
 150                 return -1;
 151         }
 152
 153         pc = poptGetContext(NULL, argc, argv, long_options, 0);
 154         poptReadDefaultConfig(pc, 0);
 155
 156         while ((opt = poptGetNextOpt(pc)) != -1) {
 157                 switch (opt) {
 158                 case OPT_HELP:
 159                         usage(stderr);
 160                         clean_exit(EXIT_SUCCESS);
 161                         break;
 162                 case OPT_CREATE_SESSION:
 163                         opt_create_session = 1;
 164                         opt_session_name = poptGetOptArg(pc);
 165                         break;
 166                 case OPT_DESTROY_SESSION:
 167                         opt_destroy_session = 1;
 168                         opt_session_name = poptGetOptArg(pc);
 169                         break;
 170                 case OPT_ENABLE_EVENT:
 171                         opt_enable_event = 1;
 172                         opt_event_list = poptGetOptArg(pc);
 173                         break;
 174                 case OPT_DESTROY_TRACE:
 175                         opt_destroy_trace = 1;
 176                         opt_trace_name = poptGetOptArg(pc);
 177                         break;
 178                 case OPT_START_TRACE:
 179                         opt_start_trace = 1;
 180                         opt_trace_name = poptGetOptArg(pc);
 181                         break;
 182                 case OPT_STOP_TRACE:
 183                         opt_stop_trace = 1;
 184                         opt_trace_name = poptGetOptArg(pc);
 185                         break;
 186                 case OPT_CREATE_TRACE:
 187                         opt_create_trace = 1;
 188                         opt_trace_name = poptGetOptArg(pc);
 189                         break;
 190                 default:
 191                         usage(stderr);
 192                         clean_exit(EXIT_FAILURE);
 193                         break;
 194                 }
 195         }
 196
 197         if (pc) {
 198                 poptFreeContext(pc);
 199         }
 200
 201         return 0;
 202 }