Standardize lttng command line usage text
[lttng-tools.git] / src / bin / lttng / commands / disable_events.c
index 5247110ef3ca67a0c514a6110b0762564f8f8eb3..b238b9d60ed42c38c447be06d823a2278db32678 100644 (file)
@@ -1,19 +1,18 @@
 /*
  * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
  *
- * 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; only version 2
- * of the License.
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License, version 2 only,
+ * as published by the Free Software Foundation.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
 #define _GNU_SOURCE
 #include <sys/types.h>
 #include <unistd.h>
 
-#include "../cmd.h"
-#include "../conf.h"
-#include "../utils.h"
+#include "../command.h"
 
 static char *opt_event_list;
 static int opt_kernel;
 static char *opt_channel_name;
 static char *opt_session_name;
 static int opt_userspace;
-static char *opt_cmd_name;
 static int opt_disable_all;
+#if 0
+/* Not implemented yet */
+static char *opt_cmd_name;
 static pid_t opt_pid;
+#endif
 
 enum {
        OPT_HELP = 1,
        OPT_USERSPACE,
+       OPT_LIST_OPTIONS,
 };
 
 static struct lttng_handle *handle;
@@ -52,8 +53,14 @@ static struct poptOption long_options[] = {
        {"all-events",     'a', POPT_ARG_VAL, &opt_disable_all, 1, 0, 0},
        {"channel",        'c', POPT_ARG_STRING, &opt_channel_name, 0, 0, 0},
        {"kernel",         'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
+#if 0
+       /* Not implemented yet */
        {"userspace",      'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
        {"pid",            'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
+#else
+       {"userspace",      'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
+#endif
+       {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
        {0, 0, 0, 0, 0, 0, 0}
 };
 
@@ -62,17 +69,16 @@ static struct poptOption long_options[] = {
  */
 static void usage(FILE *ofp)
 {
-       fprintf(ofp, "usage: lttng disable-event NAME[,NAME2,...] [options]\n");
+       fprintf(ofp, "usage: lttng disable-event NAME[,NAME2,...] [-k|-u] [OPTIONS]\n");
        fprintf(ofp, "\n");
+       fprintf(ofp, "Options:\n");
        fprintf(ofp, "  -h, --help               Show this help\n");
-       fprintf(ofp, "  -s, --session            Apply on session name\n");
-       fprintf(ofp, "  -c, --channel            Apply on this channel\n");
+       fprintf(ofp, "      --list-options       Simple listing of options\n");
+       fprintf(ofp, "  -s, --session NAME       Apply to session name\n");
+       fprintf(ofp, "  -c, --channel NAME       Apply to this channel\n");
        fprintf(ofp, "  -a, --all-events         Disable all tracepoints\n");
        fprintf(ofp, "  -k, --kernel             Apply for the kernel tracer\n");
-       fprintf(ofp, "  -u, --userspace [CMD]    Apply for the user-space tracer\n");
-       fprintf(ofp, "                           If no CMD, the domain used is UST global\n");
-       fprintf(ofp, "                           or else the domain is UST EXEC_NAME\n");
-       fprintf(ofp, "  -p, --pid PID            If -u, apply to specific PID (domain: UST PID)\n");
+       fprintf(ofp, "  -u, --userspace          Apply to the user-space tracer\n");
        fprintf(ofp, "\n");
 }
 
@@ -83,10 +89,24 @@ static void usage(FILE *ofp)
  */
 static int disable_events(char *session_name)
 {
-       int err, ret = CMD_SUCCESS;
+       int err, ret = CMD_SUCCESS, warn = 0;
        char *event_name, *channel_name = NULL;
        struct lttng_domain dom;
 
+       memset(&dom, 0, sizeof(dom));
+
+       /* Create lttng domain */
+       if (opt_kernel) {
+               dom.type = LTTNG_DOMAIN_KERNEL;
+       } else if (opt_userspace) {
+               dom.type = LTTNG_DOMAIN_UST;
+       } else {
+               ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
+               ret = CMD_ERROR;
+               goto error;
+       }
+
+       /* Get channel name */
        if (opt_channel_name == NULL) {
                err = asprintf(&channel_name, DEFAULT_CHANNEL_NAME);
                if (err < 0) {
@@ -97,31 +117,6 @@ static int disable_events(char *session_name)
                channel_name = opt_channel_name;
        }
 
-       if (opt_kernel && opt_userspace) {
-               ERR("Can't use -k/--kernel and -u/--userspace together");
-               ret = CMD_FATAL;
-               goto error;
-       }
-
-       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 if (opt_userspace && opt_cmd_name == NULL) {
-               dom.type = LTTNG_DOMAIN_UST;
-               DBG("UST global domain selected");
-       } else if (opt_userspace && opt_cmd_name != NULL) {
-               dom.type = LTTNG_DOMAIN_UST_EXEC_NAME;
-               strncpy(dom.attr.exec_name, opt_cmd_name, NAME_MAX);
-               dom.attr.exec_name[NAME_MAX - 1] = '\0';
-       } else {
-               ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
-               ret = CMD_NOT_IMPLEMENTED;
-               goto error;
-       }
-
        handle = lttng_create_handle(session_name, &dom);
        if (handle == NULL) {
                ret = -1;
@@ -131,6 +126,7 @@ static int disable_events(char *session_name)
        if (opt_disable_all) {
                ret = lttng_disable_event(handle, NULL, channel_name);
                if (ret < 0) {
+                       /* Don't set ret so lttng can interpret the sessiond error. */
                        goto error;
                }
 
@@ -142,40 +138,30 @@ static int disable_events(char *session_name)
        /* Strip event list */
        event_name = strtok(opt_event_list, ",");
        while (event_name != NULL) {
-               /* Kernel tracer action */
-               if (opt_kernel) {
-                       DBG("Disabling kernel event %s in channel %s",
-                                       event_name, channel_name);
-               } else if (opt_userspace) {             /* User-space tracer action */
-                       if (opt_cmd_name != NULL || opt_pid) {
-                               MSG("Only supporting tracing all UST processes (-u) for now.");
-                               ret = CMD_NOT_IMPLEMENTED;
-                               goto error;
-                       }
-                       DBG("Disabling UST event %s in channel %s",
-                                       event_name, channel_name);
-               } else {
-                       ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
-                       goto error;
-               }
+               DBG("Disabling event %s", event_name);
 
                ret = lttng_disable_event(handle, event_name, channel_name);
                if (ret < 0) {
-                       MSG("Unable to disable %s event %s in channel %s",
-                                       opt_kernel ? "kernel" : "UST", event_name,
-                                       channel_name);
+                       ERR("Event %s: %s (channel %s, session %s)", event_name,
+                                       lttng_strerror(ret), channel_name, session_name);
+                       warn = 1;
                } else {
-                       MSG("%s event %s disabled in channel %s",
-                                       opt_kernel ? "kernel" : "UST", event_name,
-                                       channel_name);
+                       MSG("%s event %s disabled in channel %s for session %s",
+                                       opt_kernel ? "kernel" : "UST", event_name, channel_name,
+                                       session_name);
                }
 
                /* Next event */
                event_name = strtok(NULL, ",");
        }
 
+       ret = CMD_SUCCESS;
+
 end:
 error:
+       if (warn) {
+               ret = CMD_WARNING;
+       }
        if (opt_channel_name == NULL) {
                free(channel_name);
        }
@@ -191,7 +177,7 @@ error:
  */
 int cmd_disable_events(int argc, const char **argv)
 {
-       int opt, ret;
+       int opt, ret = CMD_SUCCESS;
        static poptContext pc;
        char *session_name = NULL;
 
@@ -201,12 +187,14 @@ int cmd_disable_events(int argc, const char **argv)
        while ((opt = poptGetNextOpt(pc)) != -1) {
                switch (opt) {
                case OPT_HELP:
-                       usage(stderr);
-                       ret = CMD_SUCCESS;
+                       usage(stdout);
                        goto end;
                case OPT_USERSPACE:
                        opt_userspace = 1;
                        break;
+               case OPT_LIST_OPTIONS:
+                       list_cmd_options(stdout, long_options);
+                       goto end;
                default:
                        usage(stderr);
                        ret = CMD_UNDEFINED;
@@ -218,14 +206,14 @@ int cmd_disable_events(int argc, const char **argv)
        if (opt_event_list == NULL && opt_disable_all == 0) {
                ERR("Missing event name(s).\n");
                usage(stderr);
-               ret = CMD_SUCCESS;
+               ret = CMD_ERROR;
                goto end;
        }
 
        if (!opt_session_name) {
                session_name = get_session_name();
                if (session_name == NULL) {
-                       ret = -1;
+                       ret = CMD_ERROR;
                        goto end;
                }
        } else {
@@ -235,5 +223,9 @@ int cmd_disable_events(int argc, const char **argv)
        ret = disable_events(session_name);
 
 end:
+       if (!opt_session_name && session_name) {
+               free(session_name);
+       }
+       poptFreeContext(pc);
        return ret;
 }
This page took 0.026898 seconds and 4 git commands to generate.