Implement filter bytecode support in lttng-session, and parse filter string
[lttng-tools.git] / src / bin / lttng / commands / enable_events.c
index 5beb5a2b29bc352525baad0e5e857aa3a75901e7..3f304a0902ad398bfddacc76ba97ca6595836685 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;
@@ -90,6 +92,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}
 };
 
@@ -102,17 +105,17 @@ static void usage(FILE *ofp)
        fprintf(ofp, "\n");
        fprintf(ofp, "  -h, --help               Show this help\n");
        fprintf(ofp, "      --list-options       Simple listing of options\n");
-       fprintf(ofp, "  -s, --session            Apply on session name\n");
-       fprintf(ofp, "  -c, --channel            Apply on this channel\n");
-       fprintf(ofp, "  -a, --all                Enable all tracepoints\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 and syscalls\n");
        fprintf(ofp, "  -k, --kernel             Apply for the kernel tracer\n");
 #if 0
-       fprintf(ofp, "  -u, --userspace [CMD]    Apply for the user-space tracer\n");
+       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 for the user-space tracer\n");
+       fprintf(ofp, "  -u, --userspace          Apply to the user-space tracer\n");
 #endif
        fprintf(ofp, "\n");
        fprintf(ofp, "Event options:\n");
@@ -122,10 +125,6 @@ static void usage(FILE *ofp)
        fprintf(ofp, "                             e.g.:\n");
        fprintf(ofp, "                               \"*\"\n");
        fprintf(ofp, "                               \"app_component:na*\"\n");
-       fprintf(ofp, "    --loglevel name\n");
-       fprintf(ofp, "                           Tracepoint loglevel (range: 0 to loglevel)\n");
-       fprintf(ofp, "    --loglevel-only name\n");
-       fprintf(ofp, "                           Tracepoint loglevel (only this loglevel)\n");
        fprintf(ofp, "    --probe [addr | symbol | symbol+offset]\n");
        fprintf(ofp, "                           Dynamic probe.\n");
        fprintf(ofp, "                           Addr and offset can be octal (0NNN...),\n");
@@ -140,6 +139,36 @@ static void usage(FILE *ofp)
 #endif
        fprintf(ofp, "    --syscall              System call event\n");
        fprintf(ofp, "\n");
+       fprintf(ofp, "    --loglevel name\n");
+       fprintf(ofp, "                           Tracepoint loglevel range from 0 to loglevel\n");
+       fprintf(ofp, "    --loglevel-only name\n");
+       fprintf(ofp, "                           Tracepoint loglevel (only this loglevel)\n");
+       fprintf(ofp, "\n");
+       fprintf(ofp, "                           The loglevel or loglevel-only options should be\n");
+       fprintf(ofp, "                           combined with a tracepoint name or tracepoint\n");
+       fprintf(ofp, "                           wildcard.\n");
+       fprintf(ofp, "                           Available loglevels:\n");
+       fprintf(ofp, "                                              (higher value is more verbose)\n");
+       fprintf(ofp, "                               TRACE_EMERG          = 0\n");
+       fprintf(ofp, "                               TRACE_ALERT          = 1\n");
+       fprintf(ofp, "                               TRACE_CRIT           = 2\n");
+       fprintf(ofp, "                               TRACE_ERR            = 3\n");
+       fprintf(ofp, "                               TRACE_WARNING        = 4\n");
+       fprintf(ofp, "                               TRACE_NOTICE         = 5\n");
+       fprintf(ofp, "                               TRACE_INFO           = 6\n");
+       fprintf(ofp, "                               TRACE_DEBUG_SYSTEM   = 7\n");
+       fprintf(ofp, "                               TRACE_DEBUG_PROGRAM  = 8\n");
+       fprintf(ofp, "                               TRACE_DEBUG_PROCESS  = 9\n");
+       fprintf(ofp, "                               TRACE_DEBUG_MODULE   = 10\n");
+       fprintf(ofp, "                               TRACE_DEBUG_UNIT     = 11\n");
+       fprintf(ofp, "                               TRACE_DEBUG_FUNCTION = 12\n");
+       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, "\n");
 }
 
 /*
@@ -209,6 +238,55 @@ end:
        return ret;
 }
 
+/*
+ * Maps loglevel from string to value
+ */
+static
+int loglevel_str_to_value(const char *inputstr)
+{
+       int i = 0;
+       char str[LTTNG_SYMBOL_NAME_LEN];
+
+       while (inputstr[i] != '\0' && i < LTTNG_SYMBOL_NAME_LEN) {
+               str[i] = toupper(inputstr[i]);
+               i++;
+       }
+       str[i] = '\0';
+       if (!strcmp(str, "TRACE_EMERG") || !strcmp(str, "EMERG")) {
+               return LTTNG_LOGLEVEL_EMERG;
+       } else if (!strcmp(str, "TRACE_ALERT") || !strcmp(str, "ALERT")) {
+               return LTTNG_LOGLEVEL_ALERT;
+       } else if (!strcmp(str, "TRACE_CRIT") || !strcmp(str, "CRIT")) {
+               return LTTNG_LOGLEVEL_CRIT;
+       } else if (!strcmp(str, "TRACE_ERR") || !strcmp(str, "ERR")) {
+               return LTTNG_LOGLEVEL_ERR;
+       } else if (!strcmp(str, "TRACE_WARNING") || !strcmp(str, "WARNING")) {
+               return LTTNG_LOGLEVEL_WARNING;
+       } else if (!strcmp(str, "TRACE_NOTICE") || !strcmp(str, "NOTICE")) {
+               return LTTNG_LOGLEVEL_NOTICE;
+       } else if (!strcmp(str, "TRACE_INFO") || !strcmp(str, "INFO")) {
+               return LTTNG_LOGLEVEL_INFO;
+       } else if (!strcmp(str, "TRACE_DEBUG_SYSTEM") || !strcmp(str, "DEBUG_SYSTEM") || !strcmp(str, "SYSTEM")) {
+               return LTTNG_LOGLEVEL_DEBUG_SYSTEM;
+       } else if (!strcmp(str, "TRACE_DEBUG_PROGRAM") || !strcmp(str, "DEBUG_PROGRAM") || !strcmp(str, "PROGRAM")) {
+               return LTTNG_LOGLEVEL_DEBUG_PROGRAM;
+       } else if (!strcmp(str, "TRACE_DEBUG_PROCESS") || !strcmp(str, "DEBUG_PROCESS") || !strcmp(str, "PROCESS")) {
+               return LTTNG_LOGLEVEL_DEBUG_PROCESS;
+       } else if (!strcmp(str, "TRACE_DEBUG_MODULE") || !strcmp(str, "DEBUG_MODULE") || !strcmp(str, "MODULE")) {
+               return LTTNG_LOGLEVEL_DEBUG_MODULE;
+       } else if (!strcmp(str, "TRACE_DEBUG_UNIT") || !strcmp(str, "DEBUG_UNIT") || !strcmp(str, "UNIT")) {
+               return LTTNG_LOGLEVEL_DEBUG_UNIT;
+       } else if (!strcmp(str, "TRACE_DEBUG_FUNCTION") || !strcmp(str, "DEBUG_FUNCTION") || !strcmp(str, "FUNCTION")) {
+               return LTTNG_LOGLEVEL_DEBUG_FUNCTION;
+       } else if (!strcmp(str, "TRACE_DEBUG_LINE") || !strcmp(str, "DEBUG_LINE") || !strcmp(str, "LINE")) {
+               return LTTNG_LOGLEVEL_DEBUG_LINE;
+       } else if (!strcmp(str, "TRACE_DEBUG") || !strcmp(str, "DEBUG")) {
+               return LTTNG_LOGLEVEL_DEBUG;
+       } else {
+               return -1;
+       }
+}
+
 /*
  * Enabling event using the lttng API.
  */
@@ -219,6 +297,17 @@ static int enable_events(char *session_name)
        struct lttng_event ev;
        struct lttng_domain dom;
 
+       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;
@@ -251,20 +340,59 @@ static int enable_events(char *session_name)
                if (opt_kernel) {
                        ev.type = opt_event_type;
                        ev.name[0] = '\0';
+                       /* kernel loglevels not implemented */
+                       ev.loglevel_type = LTTNG_EVENT_LOGLEVEL_ALL;
                } else {
                        ev.type = LTTNG_EVENT_TRACEPOINT;
                        strcpy(ev.name, "*");
+                       ev.loglevel_type = opt_loglevel_type;
+                       if (opt_loglevel) {
+                               ev.loglevel = loglevel_str_to_value(opt_loglevel);
+                               if (ev.loglevel == -1) {
+                                       ERR("Unknown loglevel %s", opt_loglevel);
+                                       ret = -1;
+                                       goto error;
+                               }
+                       } else {
+                               ev.loglevel = -1;
+                       }
                }
 
                ret = lttng_enable_event(handle, &ev, channel_name);
                if (ret < 0) {
-                       goto error;
+                       switch (-ret) {
+                       case LTTCOMM_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;
+               }
+               if (opt_filter) {
+                       ret = lttng_set_event_filter(handle, ev.name, channel_name,
+                                               opt_filter);
+                       if (ret < 0) {
+                               ERR("Error setting filter");
+                               ret = -1;
+                               goto error;
+                       }
                }
 
                switch (opt_event_type) {
                case LTTNG_EVENT_TRACEPOINT:
-                       MSG("All %s tracepoints are enabled in channel %s",
-                               opt_kernel ? "kernel" : "UST", channel_name);
+                       if (opt_loglevel) {
+                               MSG("All %s tracepoints are enabled in channel %s for loglevel %s",
+                                       opt_kernel ? "kernel" : "UST", channel_name,
+                                       opt_loglevel);
+                       } else {
+                               MSG("All %s tracepoints are enabled in channel %s",
+                                       opt_kernel ? "kernel" : "UST", channel_name);
+
+                       }
                        break;
                case LTTNG_EVENT_SYSCALL:
                        if (opt_kernel) {
@@ -273,8 +401,14 @@ static int enable_events(char *session_name)
                        }
                        break;
                case LTTNG_EVENT_ALL:
-                       MSG("All %s events are enabled in channel %s",
-                               opt_kernel ? "kernel" : "UST", channel_name);
+                       if (opt_loglevel) {
+                               MSG("All %s events are enabled in channel %s for loglevel %s",
+                                       opt_kernel ? "kernel" : "UST", channel_name,
+                                       opt_loglevel);
+                       } else {
+                               MSG("All %s events are enabled in channel %s",
+                                       opt_kernel ? "kernel" : "UST", channel_name);
+                       }
                        break;
                default:
                        /*
@@ -341,8 +475,7 @@ static int enable_events(char *session_name)
                        }
 
                        /* kernel loglevels not implemented */
-                       ev.loglevel_type = opt_loglevel_type;
-                       ev.loglevel[0] = '\0';
+                       ev.loglevel_type = LTTNG_EVENT_LOGLEVEL_ALL;
                } else if (opt_userspace) {             /* User-space tracer action */
 #if 0
                        if (opt_cmd_name != NULL || opt_pid) {
@@ -352,8 +485,8 @@ static int enable_events(char *session_name)
                        }
 #endif
 
-                       DBG("Enabling UST event %s for channel %s", event_name,
-                                       channel_name);
+                       DBG("Enabling UST event %s for channel %s, loglevel %s", event_name,
+                                       channel_name, opt_loglevel ? : "<all>");
 
                        switch (opt_event_type) {
                        case LTTNG_EVENT_ALL:   /* Default behavior is tracepoint */
@@ -369,31 +502,55 @@ static int enable_events(char *session_name)
                        case LTTNG_EVENT_FUNCTION_ENTRY:
                        case LTTNG_EVENT_SYSCALL:
                        default:
+                               ERR("Event type not available for user-space tracing");
                                ret = CMD_UNDEFINED;
                                goto error;
                        }
 
                        ev.loglevel_type = opt_loglevel_type;
                        if (opt_loglevel) {
-                               strncpy(ev.loglevel, opt_loglevel, LTTNG_SYMBOL_NAME_LEN);
-                               ev.loglevel[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
+                               ev.loglevel = loglevel_str_to_value(opt_loglevel);
+                               if (ev.loglevel == -1) {
+                                       ERR("Unknown loglevel %s", opt_loglevel);
+                                       ret = -1;
+                                       goto error;
+                               }
                        } else {
-                               ev.loglevel[0] = '\0';
+                               ev.loglevel = -1;
                        }
                } else {
                        ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
+                       ret = CMD_ERROR;
                        goto error;
                }
 
                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 LTTCOMM_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);
                }
+               if (opt_filter) {
+                       ret = lttng_set_event_filter(handle, ev.name,
+                               channel_name, opt_filter);
+                       if (ret < 0) {
+                               ERR("Error setting filter");
+                               ret = -1;
+                               goto error;
+                       }
+               }
 
                /* Next event */
                event_name = strtok(NULL, ",");
@@ -451,16 +608,18 @@ int cmd_enable_events(int argc, const char **argv)
                        opt_userspace = 1;
                        break;
                case OPT_LOGLEVEL:
-                       opt_loglevel_type = LTTNG_EVENT_LOGLEVEL;
+                       opt_loglevel_type = LTTNG_EVENT_LOGLEVEL_RANGE;
                        opt_loglevel = poptGetOptArg(pc);
                        break;
                case OPT_LOGLEVEL_ONLY:
-                       opt_loglevel_type = LTTNG_EVENT_LOGLEVEL_ONLY;
+                       opt_loglevel_type = LTTNG_EVENT_LOGLEVEL_SINGLE;
                        opt_loglevel = poptGetOptArg(pc);
                        break;
                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.028521 seconds and 4 git commands to generate.