Add default ust channel attributes
[lttng-tools.git] / lttng / commands / enable_channels.c
index 7dbec903a1664f8b9894fd8eae2351d5517bd035..c5887d07bf17ac10688e3dbb3b74bc6d57564ddc 100644 (file)
@@ -3,8 +3,8 @@
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * as published by the Free Software Foundation; only version 2
+ * of the License.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 #include <sys/stat.h>
 #include <sys/types.h>
 #include <unistd.h>
+#include <inttypes.h>
 
-#include "cmd.h"
-#include "conf.h"
-#include "utils.h"
+#include "../cmd.h"
+#include "../conf.h"
+#include "../utils.h"
 
 static char *opt_channels;
 static char *opt_kernel;
+static char *opt_cmd_name;
 static char *opt_session_name;
 static int opt_pid_all;
 static int opt_userspace;
 static pid_t opt_pid;
+static struct lttng_channel chan;
 
 enum {
        OPT_HELP = 1,
+       OPT_DISCARD,
+       OPT_OVERWRITE,
+       OPT_SUBBUF_SIZE,
+       OPT_NUM_SUBBUF,
+       OPT_SWITCH_TIMER,
+       OPT_READ_TIMER,
        OPT_USERSPACE,
 };
 
+static struct lttng_handle *handle;
+
 static struct poptOption long_options[] = {
        /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
        {"help",           'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
        {"session",        's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
        {"kernel",         'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
-       {"userspace",      'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
+       {"userspace",      'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, 0, OPT_USERSPACE, 0, 0},
        {"all",            0,   POPT_ARG_VAL, &opt_pid_all, 1, 0, 0},
        {"pid",            'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
+       {"discard",        0,   POPT_ARG_NONE, 0, OPT_DISCARD, 0, 0},
+       {"overwrite",      0,   POPT_ARG_NONE, 0, OPT_OVERWRITE, 0, 0},
+       {"subbuf-size",    0,   POPT_ARG_DOUBLE, 0, OPT_SUBBUF_SIZE, 0, 0},
+       {"num-subbuf",     0,   POPT_ARG_INT, 0, OPT_NUM_SUBBUF, 0, 0},
+       {"switch-timer",   0,   POPT_ARG_INT, 0, OPT_SWITCH_TIMER, 0, 0},
+       {"read-timer",     0,   POPT_ARG_INT, 0, OPT_READ_TIMER, 0, 0},
        {0, 0, 0, 0, 0, 0, 0}
 };
 
@@ -57,56 +74,77 @@ static struct poptOption long_options[] = {
  */
 static void usage(FILE *ofp)
 {
-       fprintf(ofp, "usage: lttng enable-channel NAME[,NAME2,...] [options]\n");
+       fprintf(ofp, "usage: lttng enable-channel NAME[,NAME2,...] [options] [channel_options]\n");
        fprintf(ofp, "\n");
-       fprintf(ofp, "  -h, --help            Show this help\n");
+       fprintf(ofp, "  -h, --help               Show this help\n");
        fprintf(ofp, "  -s, --session            Apply on session name\n");
-       fprintf(ofp, "  -k, --kernel          Apply for the kernel tracer\n");
-       fprintf(ofp, "  -u, --userspace       Apply for the user-space tracer\n");
-       fprintf(ofp, "      --all             If -u, apply on all traceable apps\n");
-       fprintf(ofp, "  -p, --pid PID         If -u, apply on a specific PID\n");
+       fprintf(ofp, "  -k, --kernel             Apply on the kernel tracer\n");
+       fprintf(ofp, "  -u, --userspace [CMD]    Apply on the user-space tracer\n");
+       fprintf(ofp, "      --all                If -u, apply on all traceable apps\n");
+       fprintf(ofp, "  -p, --pid PID            If -u, apply on a specific PID\n");
+       fprintf(ofp, "\n");
+       fprintf(ofp, "Channel options:\n");
+       fprintf(ofp, "      --discard            Discard event when buffers are full%s\n",
+               DEFAULT_CHANNEL_OVERWRITE ? "" : " (default)");
+       fprintf(ofp, "      --overwrite          Flight recorder mode%s\n",
+               DEFAULT_CHANNEL_OVERWRITE ? " (default)" : "");
+       fprintf(ofp, "      --subbuf-size        Subbuffer size in bytes\n");
+       fprintf(ofp, "                               (default: %u, kernel default: %u)\n",
+               DEFAULT_CHANNEL_SUBBUF_SIZE,
+               DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE);
+       fprintf(ofp, "      --num-subbuf         Number of subbufers\n");
+       fprintf(ofp, "                               (default: %u, kernel default: %u)\n",
+               DEFAULT_CHANNEL_SUBBUF_NUM,
+               DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM);
+       fprintf(ofp, "      --switch-timer       Switch timer interval in usec (default: %u)\n",
+               DEFAULT_CHANNEL_SWITCH_TIMER);
+       fprintf(ofp, "      --read-timer         Read timer interval in usec (default: %u)\n",
+               DEFAULT_CHANNEL_READ_TIMER);
        fprintf(ofp, "\n");
 }
 
 /*
- *  enable_channels
- *
- *  Enabling channel using the lttng API.
+ * Adding channel using the lttng API.
  */
-static int enable_channels(void)
+static int enable_channel(char *session_name)
 {
        int ret = CMD_SUCCESS;
        char *channel_name;
+       struct lttng_domain dom;
+
+       if (opt_kernel) {
+               dom.type = LTTNG_DOMAIN_KERNEL;
+       } else if (opt_pid != 0) {
+               dom.type = LTTNG_DOMAIN_UST_PID;
+               dom.attr.pid = opt_pid;
+               DBG("PID %d set to lttng handle", opt_pid);
+       } else {
+               ERR("Please specify a tracer (--kernel or --userspace)");
+               ret = CMD_NOT_IMPLEMENTED;
+               goto error;
+       }
 
-       if (set_session_name(opt_session_name) < 0) {
-               ret = CMD_ERROR;
+       handle = lttng_create_handle(session_name, &dom);
+       if (handle == NULL) {
+               ret = -1;
                goto error;
        }
 
-       /* Strip event list */
+       /* Strip channel list (format: chan1,chan2,...) */
        channel_name = strtok(opt_channels, ",");
        while (channel_name != NULL) {
-               /* Kernel tracer action */
-               if (opt_kernel) {
-                       DBG("Enabling kernel channel %s", channel_name);
-                       ret = lttng_kernel_enable_channel(channel_name);
-                       if (ret < 0) {
-                               goto error;
-                       } else {
-                               MSG("Kernel channel enabled %s", channel_name);
-                       }
-               } else if (opt_userspace) {             /* User-space tracer action */
-                       /*
-                        * TODO: Waiting on lttng UST 2.0
-                        */
-                       if (opt_pid_all) {
-                       } else if (opt_pid != 0) {
-                       }
-                       ret = CMD_NOT_IMPLEMENTED;
+               /* Copy channel name and normalize it */
+               strncpy(chan.name, channel_name, NAME_MAX);
+               chan.name[NAME_MAX - 1] = '\0';
+
+               DBG("Enabling channel %s", channel_name);
+
+               ret = lttng_enable_channel(handle, &chan);
+               if (ret < 0) {
                        goto error;
                } else {
-                       ERR("Please specify a tracer (kernel or user-space)");
-                       goto error;
+                       MSG("Channel enabled %s for session %s",
+                                       channel_name, session_name);
                }
 
                /* Next event */
@@ -114,18 +152,47 @@ static int enable_channels(void)
        }
 
 error:
+       lttng_destroy_handle(handle);
+
        return ret;
 }
 
 /*
- *  cmd_enable_channels
- *
- *  Enable channel to trace session
+ * Default value for channel configuration.
+ */
+static void init_channel_config(void)
+{
+       if (opt_kernel) {
+               /* kernel default */
+               chan.attr.overwrite = DEFAULT_CHANNEL_OVERWRITE;
+               chan.attr.switch_timer_interval = DEFAULT_CHANNEL_SWITCH_TIMER;
+               chan.attr.read_timer_interval = DEFAULT_CHANNEL_READ_TIMER;
+
+               chan.attr.subbuf_size = DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE;
+               chan.attr.num_subbuf = DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM;
+               chan.attr.output = DEFAULT_KERNEL_CHANNEL_OUTPUT;
+       } else {
+               /* default behavior, used by UST. */
+               chan.attr.overwrite = DEFAULT_CHANNEL_OVERWRITE;
+               chan.attr.switch_timer_interval = DEFAULT_CHANNEL_SWITCH_TIMER;
+               chan.attr.read_timer_interval = DEFAULT_CHANNEL_READ_TIMER;
+
+               chan.attr.subbuf_size = DEFAULT_UST_CHANNEL_SUBBUF_SIZE;
+               chan.attr.num_subbuf = DEFAULT_UST_CHANNEL_SUBBUF_NUM;
+               chan.attr.output = DEFAULT_CHANNEL_OUTPUT;
+       }
+}
+
+/*
+ * Add channel to trace session
  */
 int cmd_enable_channels(int argc, const char **argv)
 {
        int opt, ret;
        static poptContext pc;
+       char *session_name = NULL;
+
+       init_channel_config();
 
        pc = poptGetContext(NULL, argc, argv, long_options, 0);
        poptReadDefaultConfig(pc, 0);
@@ -138,6 +205,31 @@ int cmd_enable_channels(int argc, const char **argv)
                        goto end;
                case OPT_USERSPACE:
                        opt_userspace = 1;
+                       opt_cmd_name = poptGetOptArg(pc);
+                       break;
+               case OPT_DISCARD:
+                       chan.attr.overwrite = 0;
+                       DBG("Channel set to discard");
+                       break;
+               case OPT_OVERWRITE:
+                       chan.attr.overwrite = 1;
+                       DBG("Channel set to overwrite");
+                       break;
+               case OPT_SUBBUF_SIZE:
+                       chan.attr.subbuf_size = atol(poptGetOptArg(pc));
+                       DBG("Channel subbuf size set to %" PRIu64, chan.attr.subbuf_size);
+                       break;
+               case OPT_NUM_SUBBUF:
+                       chan.attr.num_subbuf = atoi(poptGetOptArg(pc));
+                       DBG("Channel subbuf num set to %" PRIu64, chan.attr.num_subbuf);
+                       break;
+               case OPT_SWITCH_TIMER:
+                       chan.attr.switch_timer_interval = atoi(poptGetOptArg(pc));
+                       DBG("Channel switch timer interval set to %d", chan.attr.switch_timer_interval);
+                       break;
+               case OPT_READ_TIMER:
+                       chan.attr.read_timer_interval = atoi(poptGetOptArg(pc));
+                       DBG("Channel read timer interval set to %d", chan.attr.read_timer_interval);
                        break;
                default:
                        usage(stderr);
@@ -148,13 +240,23 @@ int cmd_enable_channels(int argc, const char **argv)
 
        opt_channels = (char*) poptGetArg(pc);
        if (opt_channels == NULL) {
-               ERR("Missing channel name(s).\n");
+               ERR("Missing channel name.\n");
                usage(stderr);
                ret = CMD_SUCCESS;
                goto end;
        }
 
-       ret = enable_channels();
+       if (!opt_session_name) {
+               session_name = get_session_name();
+               if (session_name == NULL) {
+                       ret = -1;
+                       goto end;
+               }
+       } else {
+               session_name = opt_session_name;
+       }
+
+       ret = enable_channel(session_name);
 
 end:
        return ret;
This page took 0.026098 seconds and 4 git commands to generate.