Pass lttng_event struct to the set_filter API call
[lttng-tools.git] / src / bin / lttng / commands / enable_events.c
index 3d2b41c02c6cac1c2afe986722b097e58e07d579..cdd137cc9193d3aed0efdfee037546b97c958402 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
@@ -28,6 +27,7 @@
 #include <ctype.h>
 
 #include "../command.h"
+#include <src/common/sessiond-comm/sessiond-comm.h>
 
 static char *opt_event_list;
 static int opt_event_type;
@@ -41,6 +41,7 @@ static char *opt_probe;
 static char *opt_function;
 static char *opt_function_entry_symbol;
 static char *opt_channel_name;
+static char *opt_filter;
 #if 0
 /* Not implemented yet */
 static char *opt_cmd_name;
@@ -58,6 +59,7 @@ enum {
        OPT_LOGLEVEL,
        OPT_LOGLEVEL_ONLY,
        OPT_LIST_OPTIONS,
+       OPT_FILTER,
 };
 
 static struct lttng_handle *handle;
@@ -69,13 +71,7 @@ static struct poptOption long_options[] = {
        {"all",            'a', POPT_ARG_VAL, &opt_enable_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
        {"tracepoint",     0,   POPT_ARG_NONE, 0, OPT_TRACEPOINT, 0, 0},
        {"probe",          0,   POPT_ARG_STRING, &opt_probe, OPT_PROBE, 0, 0},
        {"function",       0,   POPT_ARG_STRING, &opt_function, OPT_FUNCTION, 0, 0},
@@ -90,6 +86,7 @@ static struct poptOption long_options[] = {
        {"loglevel",       0,     POPT_ARG_STRING, 0, OPT_LOGLEVEL, 0, 0},
        {"loglevel-only",  0,     POPT_ARG_STRING, 0, OPT_LOGLEVEL_ONLY, 0, 0},
        {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
+       {"filter",         'f', POPT_ARG_STRING, &opt_filter, OPT_FILTER, 0, 0},
        {0, 0, 0, 0, 0, 0, 0}
 };
 
@@ -98,22 +95,16 @@ static struct poptOption long_options[] = {
  */
 static void usage(FILE *ofp)
 {
-       fprintf(ofp, "usage: lttng enable-event NAME[,NAME2,...] [options] [event_options]\n");
+       fprintf(ofp, "usage: lttng enable-event NAME[,NAME2,...] [-k|-u] [OPTIONS] \n");
        fprintf(ofp, "\n");
+       fprintf(ofp, "Options:\n");
        fprintf(ofp, "  -h, --help               Show this help\n");
        fprintf(ofp, "      --list-options       Simple listing of options\n");
-       fprintf(ofp, "  -s, --session            Apply to session name\n");
-       fprintf(ofp, "  -c, --channel            Apply to this channel\n");
-       fprintf(ofp, "  -a, --all                Enable all tracepoints\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                Enable all tracepoints and syscalls\n");
        fprintf(ofp, "  -k, --kernel             Apply for the kernel tracer\n");
-#if 0
-       fprintf(ofp, "  -u, --userspace [CMD]    Apply to 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");
-#else
        fprintf(ofp, "  -u, --userspace          Apply to the user-space tracer\n");
-#endif
        fprintf(ofp, "\n");
        fprintf(ofp, "Event options:\n");
        fprintf(ofp, "    --tracepoint           Tracepoint event (default)\n");
@@ -162,6 +153,29 @@ static void usage(FILE *ofp)
        fprintf(ofp, "                               TRACE_DEBUG_LINE     = 13\n");
        fprintf(ofp, "                               TRACE_DEBUG          = 14\n");
        fprintf(ofp, "                               (shortcuts such as \"system\" are allowed)\n");
+       fprintf(ofp, "    --filter \'expression\'\n");
+       fprintf(ofp, "                           Filter expression on event fields,\n");
+       fprintf(ofp, "                           event recording depends on evaluation.\n");
+       fprintf(ofp, "                           Only specify on first activation of\n");
+       fprintf(ofp, "                           a given event within a session.\n");
+       fprintf(ofp, "                           Filter only allowed when enabling\n");
+       fprintf(ofp, "                           events within a session before tracing\n");
+       fprintf(ofp, "                           is started. If the filter fails to link\n");
+       fprintf(ofp, "                           with the event within the traced domain,\n");
+       fprintf(ofp, "                           the event will be discarded. Currently,\n");
+       fprintf(ofp, "                           filter is only implemented for the user-space\n");
+       fprintf(ofp, "                           tracer.\n");
+       fprintf(ofp, "                           Expression examples:.\n");
+       fprintf(ofp, "                           \n");
+       fprintf(ofp, "                           'intfield > 500 && intfield < 503'\n");
+       fprintf(ofp, "                           '(stringfield == \"test\" || intfield != 10) && intfield > 33'\n");
+       fprintf(ofp, "                           'doublefield > 1.1 && intfield < 5.3'\n");
+       fprintf(ofp, "                           \n");
+       fprintf(ofp, "                           Wildcards are allowed at the end of strings:\n");
+       fprintf(ofp, "                           'seqfield1 == \"te*\"'\n");
+       fprintf(ofp, "                           In string literals, the escape character is '\\'.\n");
+       fprintf(ofp, "                           Use '\\*' for the '*' character, and '\\\\' for\n");
+       fprintf(ofp, "                           the '\\' character.\n");
        fprintf(ofp, "\n");
 }
 
@@ -287,6 +301,7 @@ int loglevel_str_to_value(const char *inputstr)
 static int enable_events(char *session_name)
 {
        int err, ret = CMD_SUCCESS, warn = 0;
+       unsigned int event_enabled = 0;
        char *event_name, *channel_name = NULL;
        struct lttng_event ev;
        struct lttng_domain dom;
@@ -294,6 +309,14 @@ static int enable_events(char *session_name)
        memset(&ev, 0, sizeof(ev));
        memset(&dom, 0, sizeof(dom));
 
+       if (opt_kernel) {
+               if (opt_filter) {
+                       ERR("Filter not implement for kernel tracing yet");
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+       }
+
        /* Create lttng domain */
        if (opt_kernel) {
                dom.type = LTTNG_DOMAIN_KERNEL;
@@ -336,7 +359,7 @@ static int enable_events(char *session_name)
                                ev.loglevel = loglevel_str_to_value(opt_loglevel);
                                if (ev.loglevel == -1) {
                                        ERR("Unknown loglevel %s", opt_loglevel);
-                                       ret = -1;
+                                       ret = -LTTNG_ERR_INVALID;
                                        goto error;
                                }
                        } else {
@@ -344,20 +367,34 @@ static int enable_events(char *session_name)
                        }
                }
 
+               /* Reset flag before enabling a new event. */
+               event_enabled = 0;
+
                ret = lttng_enable_event(handle, &ev, channel_name);
                if (ret < 0) {
-                       goto error;
+                       switch (-ret) {
+                       case LTTNG_ERR_KERN_EVENT_EXIST:
+                               WARN("Kernel events already enabled (channel %s, session %s)",
+                                               channel_name, session_name);
+                               break;
+                       default:
+                               ERR("Events: %s (channel %s, session %s)",
+                                               lttng_strerror(ret), channel_name, session_name);
+                               break;
+                       }
+                       goto end;
                }
+               event_enabled = 1;
 
                switch (opt_event_type) {
                case LTTNG_EVENT_TRACEPOINT:
                        if (opt_loglevel) {
                                MSG("All %s tracepoints are enabled in channel %s for loglevel %s",
-                                       opt_kernel ? "kernel" : "UST", channel_name,
-                                       opt_loglevel);
+                                               opt_kernel ? "kernel" : "UST", channel_name,
+                                               opt_loglevel);
                        } else {
                                MSG("All %s tracepoints are enabled in channel %s",
-                                       opt_kernel ? "kernel" : "UST", channel_name);
+                                               opt_kernel ? "kernel" : "UST", channel_name);
 
                        }
                        break;
@@ -370,11 +407,11 @@ static int enable_events(char *session_name)
                case LTTNG_EVENT_ALL:
                        if (opt_loglevel) {
                                MSG("All %s events are enabled in channel %s for loglevel %s",
-                                       opt_kernel ? "kernel" : "UST", channel_name,
-                                       opt_loglevel);
+                                               opt_kernel ? "kernel" : "UST", channel_name,
+                                               opt_loglevel);
                        } else {
                                MSG("All %s events are enabled in channel %s",
-                                       opt_kernel ? "kernel" : "UST", channel_name);
+                                               opt_kernel ? "kernel" : "UST", channel_name);
                        }
                        break;
                default:
@@ -384,6 +421,42 @@ static int enable_events(char *session_name)
                         */
                        goto error;
                }
+               if (opt_filter && event_enabled) {
+                       ret = lttng_set_event_filter(handle, &ev, channel_name,
+                                               opt_filter);
+                       if (ret < 0) {
+                               fprintf(stderr, "Ret filter: %d\n", ret);
+                               switch (-ret) {
+                               case LTTNG_ERR_FILTER_EXIST:
+                                       WARN("Filter on events is already enabled"
+                                                       " (channel %s, session %s)",
+                                               channel_name, session_name);
+                                       break;
+                               case LTTNG_ERR_FILTER_INVAL:
+                               case LTTNG_ERR_FILTER_NOMEM:
+                                       ERR("%s", lttng_strerror(ret));
+                               default:
+                                       ERR("Setting filter: '%s'", opt_filter);
+                                       /*
+                                        * The event was successfully enabled before so when
+                                        * failing to set a filter, disable the event. This has
+                                        * been discussed in bug #343 on why we do that.
+                                        */
+                                       err = lttng_disable_event(handle, ev.name, channel_name);
+                                       if (err < 0) {
+                                               ERR("Disabling all events after filter error: %s",
+                                                               lttng_strerror(err));
+                                       } else {
+                                               WARN("All events of channel %s have been disabled due "
+                                                               "to a filter error", channel_name);
+                                       }
+                                       break;
+                               }
+                               goto error;
+                       } else {
+                               MSG("Filter '%s' successfully set", opt_filter);
+                       }
+               }
                goto end;
        }
 
@@ -479,7 +552,7 @@ static int enable_events(char *session_name)
                                ev.loglevel = loglevel_str_to_value(opt_loglevel);
                                if (ev.loglevel == -1) {
                                        ERR("Unknown loglevel %s", opt_loglevel);
-                                       ret = -1;
+                                       ret = -LTTNG_ERR_INVALID;
                                        goto error;
                                }
                        } else {
@@ -491,14 +564,63 @@ static int enable_events(char *session_name)
                        goto error;
                }
 
+               /* Reset flag before enabling a new event. */
+               event_enabled = 0;
+
                ret = lttng_enable_event(handle, &ev, channel_name);
                if (ret < 0) {
-                       ERR("Event %s: %s (channel %s, session %s)", event_name,
-                                       lttng_strerror(ret), channel_name, session_name);
+                       /* Turn ret to positive value to handle the positive error code */
+                       switch (-ret) {
+                       case LTTNG_ERR_KERN_EVENT_EXIST:
+                               WARN("Kernel event %s already enabled (channel %s, session %s)",
+                                               event_name, channel_name, session_name);
+                               break;
+                       default:
+                               ERR("Event %s: %s (channel %s, session %s)", event_name,
+                                               lttng_strerror(ret), channel_name, session_name);
+                               break;
+                       }
                        warn = 1;
                } else {
                        MSG("%s event %s created in channel %s",
                                        opt_kernel ? "kernel": "UST", event_name, channel_name);
+                       event_enabled = 1;
+               }
+               if (opt_filter && event_enabled) {
+                       ret = lttng_set_event_filter(handle, &ev, channel_name,
+                                       opt_filter);
+                       if (ret < 0) {
+                               switch (-ret) {
+                               case LTTNG_ERR_FILTER_EXIST:
+                                       WARN("Filter on event %s is already enabled"
+                                                       " (channel %s, session %s)",
+                                               event_name, channel_name, session_name);
+                                       break;
+                               case LTTNG_ERR_FILTER_INVAL:
+                               case LTTNG_ERR_FILTER_NOMEM:
+                                       ERR("%s", lttng_strerror(ret));
+                               default:
+                                       ERR("Setting filter for event %s: '%s'", ev.name,
+                                                       opt_filter);
+                                       /*
+                                        * The event was successfully enabled before so when
+                                        * failing to set a filter, disable the event. This has
+                                        * been discussed in bug #343 on why we do that.
+                                        */
+                                       err = lttng_disable_event(handle, ev.name, channel_name);
+                                       if (err < 0) {
+                                               ERR("Disabling event %s after filter error: %s",
+                                                               ev.name, lttng_strerror(err));
+                                       } else {
+                                               WARN("Event %s of channel %s has been disabled due "
+                                                               "to a filter error", ev.name, channel_name);
+                                       }
+                                       break;
+                               }
+                               goto error;
+                       } else {
+                               MSG("Filter '%s' successfully set", opt_filter);
+                       }
                }
 
                /* Next event */
@@ -567,6 +689,8 @@ int cmd_enable_events(int argc, const char **argv)
                case OPT_LIST_OPTIONS:
                        list_cmd_options(stdout, long_options);
                        goto end;
+               case OPT_FILTER:
+                       break;
                default:
                        usage(stderr);
                        ret = CMD_UNDEFINED;
This page took 0.027613 seconds and 4 git commands to generate.