src/bin/lttng/commands/enable_channels.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; only version 2
   7  * of the License.
   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 #define _GNU_SOURCE
  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 <unistd.h>
  27 #include <inttypes.h>
  28
  29 #include "../command.h"
  30
  31 static char *opt_channels;
  32 static int opt_kernel;
  33 static char *opt_session_name;
  34 static int opt_userspace;
  35 static struct lttng_channel chan;
  36 #if 0
  37 /* Not implemented yet */
  38 static char *opt_cmd_name;
  39 static pid_t opt_pid;
  40 #endif
  41
  42 enum {
  43         OPT_HELP = 1,
  44         OPT_DISCARD,
  45         OPT_OVERWRITE,
  46         OPT_SUBBUF_SIZE,
  47         OPT_NUM_SUBBUF,
  48         OPT_SWITCH_TIMER,
  49         OPT_READ_TIMER,
  50         OPT_USERSPACE,
  51 };
  52
  53 static struct lttng_handle *handle;
  54
  55 static struct poptOption long_options[] = {
  56         /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
  57         {"help",           'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
  58         {"session",        's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
  59         {"kernel",         'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
  60 #if 0
  61         /* Not implemented yet */
  62         {"userspace",      'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
  63         {"pid",            'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
  64 #else
  65         {"userspace",      'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
  66 #endif
  67         {"discard",        0,   POPT_ARG_NONE, 0, OPT_DISCARD, 0, 0},
  68         {"overwrite",      0,   POPT_ARG_NONE, 0, OPT_OVERWRITE, 0, 0},
  69         {"subbuf-size",    0,   POPT_ARG_DOUBLE, 0, OPT_SUBBUF_SIZE, 0, 0},
  70         {"num-subbuf",     0,   POPT_ARG_INT, 0, OPT_NUM_SUBBUF, 0, 0},
  71         {"switch-timer",   0,   POPT_ARG_INT, 0, OPT_SWITCH_TIMER, 0, 0},
  72         {"read-timer",     0,   POPT_ARG_INT, 0, OPT_READ_TIMER, 0, 0},
  73         {0, 0, 0, 0, 0, 0, 0}
  74 };
  75
  76 /*
  77  * usage
  78  */
  79 static void usage(FILE *ofp)
  80 {
  81         fprintf(ofp, "usage: lttng enable-channel NAME[,NAME2,...] [options] [channel_options]\n");
  82         fprintf(ofp, "\n");
  83         fprintf(ofp, "  -h, --help               Show this help\n");
  84         fprintf(ofp, "  -s, --session            Apply on session name\n");
  85         fprintf(ofp, "  -k, --kernel             Apply on the kernel tracer\n");
  86 #if 0
  87         fprintf(ofp, "  -u, --userspace [CMD]    Apply for the user-space tracer\n");
  88         fprintf(ofp, "                           If no CMD, the domain used is UST global\n");
  89         fprintf(ofp, "                           or else the domain is UST EXEC_NAME\n");
  90         fprintf(ofp, "  -p, --pid PID            If -u, apply to specific PID (domain: UST PID)\n");
  91 #else
  92         fprintf(ofp, "  -u, --userspace          Apply for the user-space tracer\n");
  93 #endif
  94         fprintf(ofp, "\n");
  95         fprintf(ofp, "Channel options:\n");
  96         fprintf(ofp, "      --discard            Discard event when buffers are full%s\n",
  97                 DEFAULT_CHANNEL_OVERWRITE ? "" : " (default)");
  98         fprintf(ofp, "      --overwrite          Flight recorder mode%s\n",
  99                 DEFAULT_CHANNEL_OVERWRITE ? " (default)" : "");
 100         fprintf(ofp, "      --subbuf-size        Subbuffer size in bytes\n");
 101         fprintf(ofp, "                               (default: %u, kernel default: %u)\n",
 102                 DEFAULT_CHANNEL_SUBBUF_SIZE,
 103                 DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE);
 104         fprintf(ofp, "      --num-subbuf         Number of subbufers\n");
 105         fprintf(ofp, "                               (default: %u, kernel default: %u)\n",
 106                 DEFAULT_CHANNEL_SUBBUF_NUM,
 107                 DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM);
 108         fprintf(ofp, "      --switch-timer       Switch timer interval in usec (default: %u)\n",
 109                 DEFAULT_CHANNEL_SWITCH_TIMER);
 110         fprintf(ofp, "      --read-timer         Read timer interval in usec (default: %u)\n",
 111                 DEFAULT_CHANNEL_READ_TIMER);
 112         fprintf(ofp, "\n");
 113 }
 114
 115 /*
 116  * Set default attributes depending on those already defined from the command
 117  * line.
 118  */
 119 static void set_default_attr(struct lttng_domain *dom)
 120 {
 121         struct lttng_channel_attr default_attr;
 122
 123         /* Set attributes */
 124         lttng_channel_set_default_attr(dom, &default_attr);
 125
 126         if (chan.attr.overwrite == -1) {
 127                 chan.attr.overwrite = default_attr.overwrite;
 128         }
 129         if (chan.attr.subbuf_size == -1) {
 130                 chan.attr.subbuf_size = default_attr.subbuf_size;
 131         }
 132         if (chan.attr.num_subbuf == -1) {
 133                 chan.attr.num_subbuf = default_attr.num_subbuf;
 134         }
 135         if (chan.attr.switch_timer_interval == -1) {
 136                 chan.attr.switch_timer_interval = default_attr.switch_timer_interval;
 137         }
 138         if (chan.attr.read_timer_interval == -1) {
 139                 chan.attr.read_timer_interval = default_attr.read_timer_interval;
 140         }
 141         if (chan.attr.output == -1) {
 142                 chan.attr.output = default_attr.output;
 143         }
 144 }
 145
 146 /*
 147  * Adding channel using the lttng API.
 148  */
 149 static int enable_channel(char *session_name)
 150 {
 151         int ret = CMD_SUCCESS;
 152         char *channel_name;
 153         struct lttng_domain dom;
 154
 155         /* Create lttng domain */
 156         if (opt_kernel) {
 157                 dom.type = LTTNG_DOMAIN_KERNEL;
 158         } else if (opt_userspace) {
 159                 dom.type = LTTNG_DOMAIN_UST;
 160         } else {
 161                 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
 162                 ret = CMD_UNDEFINED;
 163                 goto error;
 164         }
 165
 166         set_default_attr(&dom);
 167
 168         handle = lttng_create_handle(session_name, &dom);
 169         if (handle == NULL) {
 170                 ret = -1;
 171                 goto error;
 172         }
 173
 174         /* Strip channel list (format: chan1,chan2,...) */
 175         channel_name = strtok(opt_channels, ",");
 176         while (channel_name != NULL) {
 177                 /* Copy channel name and normalize it */
 178                 strncpy(chan.name, channel_name, NAME_MAX);
 179                 chan.name[NAME_MAX - 1] = '\0';
 180
 181                 DBG("Enabling channel %s", channel_name);
 182
 183                 ret = lttng_enable_channel(handle, &chan);
 184                 if (ret < 0) {
 185                         goto error;
 186                 } else {
 187                         MSG("%s channel %s enabled for session %s",
 188                                         opt_kernel ? "Kernel" : "UST", channel_name,
 189                                         session_name);
 190                 }
 191
 192                 /* Next event */
 193                 channel_name = strtok(NULL, ",");
 194         }
 195
 196 error:
 197         lttng_destroy_handle(handle);
 198
 199         return ret;
 200 }
 201
 202 /*
 203  * Default value for channel configuration.
 204  */
 205 static void init_channel_config(void)
 206 {
 207         /*
 208          * Put -1 everywhere so we can identify those set by the command line and
 209          * those needed to be set by the default values.
 210          */
 211         memset(&chan.attr, -1, sizeof(chan.attr));
 212 }
 213
 214 /*
 215  * Add channel to trace session
 216  */
 217 int cmd_enable_channels(int argc, const char **argv)
 218 {
 219         int opt, ret;
 220         static poptContext pc;
 221         char *session_name = NULL;
 222
 223         init_channel_config();
 224
 225         pc = poptGetContext(NULL, argc, argv, long_options, 0);
 226         poptReadDefaultConfig(pc, 0);
 227
 228         while ((opt = poptGetNextOpt(pc)) != -1) {
 229                 switch (opt) {
 230                 case OPT_HELP:
 231                         usage(stderr);
 232                         ret = CMD_SUCCESS;
 233                         goto end;
 234                 case OPT_DISCARD:
 235                         chan.attr.overwrite = 0;
 236                         DBG("Channel set to discard");
 237                         break;
 238                 case OPT_OVERWRITE:
 239                         chan.attr.overwrite = 1;
 240                         DBG("Channel set to overwrite");
 241                         break;
 242                 case OPT_SUBBUF_SIZE:
 243                         chan.attr.subbuf_size = atol(poptGetOptArg(pc));
 244                         DBG("Channel subbuf size set to %" PRIu64, chan.attr.subbuf_size);
 245                         break;
 246                 case OPT_NUM_SUBBUF:
 247                         chan.attr.num_subbuf = atoi(poptGetOptArg(pc));
 248                         DBG("Channel subbuf num set to %" PRIu64, chan.attr.num_subbuf);
 249                         break;
 250                 case OPT_SWITCH_TIMER:
 251                         chan.attr.switch_timer_interval = atoi(poptGetOptArg(pc));
 252                         DBG("Channel switch timer interval set to %d", chan.attr.switch_timer_interval);
 253                         break;
 254                 case OPT_READ_TIMER:
 255                         chan.attr.read_timer_interval = atoi(poptGetOptArg(pc));
 256                         DBG("Channel read timer interval set to %d", chan.attr.read_timer_interval);
 257                         break;
 258                 case OPT_USERSPACE:
 259                         opt_userspace = 1;
 260                         break;
 261                 default:
 262                         usage(stderr);
 263                         ret = CMD_UNDEFINED;
 264                         goto end;
 265                 }
 266         }
 267
 268         opt_channels = (char*) poptGetArg(pc);
 269         if (opt_channels == NULL) {
 270                 ERR("Missing channel name.\n");
 271                 usage(stderr);
 272                 ret = CMD_SUCCESS;
 273                 goto end;
 274         }
 275
 276         if (!opt_session_name) {
 277                 session_name = get_session_name();
 278                 if (session_name == NULL) {
 279                         ret = -1;
 280                         goto end;
 281                 }
 282         } else {
 283                 session_name = opt_session_name;
 284         }
 285
 286         ret = enable_channel(session_name);
 287
 288 end:
 289         return ret;
 290 }