Documentation: filter $ctx manpage and --help
[lttng-tools.git] / src / bin / lttng / commands / enable_events.c
index 860472fa9c370e8a1d934065d9c2cde54ca0975a..0e6bb55d8bc7b618fadcc830c1a7ee736145a3c3 100644 (file)
@@ -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, "  -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,42 @@ 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 and context.\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. Wildcard match any sequence of,\n");
+       fprintf(ofp, "                           characters including an empty sub-string (match 0 or\n");
+       fprintf(ofp, "                           more characters).\n");
+       fprintf(ofp, "\n");
+       fprintf(ofp, "                           Context information can be used for filtering. The\n");
+       fprintf(ofp, "                           examples below show usage of context filtering on\n");
+       fprintf(ofp, "                           process name (with a wildcard), process ID range, and\n");
+       fprintf(ofp, "                           unique thread ID for filtering. The process and\n");
+       fprintf(ofp, "                           thread ID of running applications can be found under\n");
+       fprintf(ofp, "                           columns \"PID\" and \"LWP\" of the \"ps -eLf\" command.\n");
+       fprintf(ofp, "\n");
+       fprintf(ofp, "                           '$ctx.procname == \"demo*\"'\n");
+       fprintf(ofp, "                           '$ctx.vpid >= 4433 && $ctx.vpid < 4455'\n");
+       fprintf(ofp, "                           '$ctx.vtid == 1234'\n");
        fprintf(ofp, "\n");
 }
 
@@ -185,7 +212,7 @@ static int parse_probe_opts(struct lttng_event *ev, char *opt)
                strncpy(ev->attr.probe.symbol_name, name, LTTNG_SYMBOL_NAME_LEN);
                ev->attr.probe.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
                DBG("probe symbol %s", ev->attr.probe.symbol_name);
-               if (strlen(s_hex) == 0) {
+               if (*s_hex == '\0') {
                        ERR("Invalid probe offset %s", s_hex);
                        ret = -1;
                        goto end;
@@ -213,7 +240,7 @@ static int parse_probe_opts(struct lttng_event *ev, char *opt)
        /* Check for address */
        ret = sscanf(opt, "%s", s_hex);
        if (ret > 0) {
-               if (strlen(s_hex) == 0) {
+               if (*s_hex == '\0') {
                        ERR("Invalid probe address %s", s_hex);
                        ret = -1;
                        goto end;
@@ -241,7 +268,7 @@ 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) {
+       while (i < LTTNG_SYMBOL_NAME_LEN && inputstr[i] != '\0') {
                str[i] = toupper(inputstr[i]);
                i++;
        }
@@ -294,11 +321,22 @@ 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;
+               dom.buf_type = LTTNG_BUFFER_GLOBAL;
        } else if (opt_userspace) {
                dom.type = LTTNG_DOMAIN_UST;
+               /* Default. */
+               dom.buf_type = LTTNG_BUFFER_PER_PID;
        } else {
                ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
                ret = CMD_ERROR;
@@ -336,7 +374,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,54 +382,80 @@ static int enable_events(char *session_name)
                        }
                }
 
-               ret = lttng_enable_event(handle, &ev, channel_name);
-               if (ret < 0) {
-                       switch (-ret) {
-                       case LTTCOMM_KERN_EVENT_EXIST:
-                               WARN("Kernel events already enabled (channel %s, session %s)",
-                                               channel_name, session_name);
+               if (!opt_filter) {
+                       ret = lttng_enable_event(handle, &ev, channel_name);
+                       if (ret < 0) {
+                               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;
-                       default:
-                               ERR("Event %s: %s (channel %s, session %s)", event_name,
-                                               lttng_strerror(ret), channel_name, session_name);
-                               break;
                        }
-               }
 
-               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);
-                       } else {
-                               MSG("All %s tracepoints are enabled in channel %s",
-                                       opt_kernel ? "kernel" : "UST", channel_name);
+                       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);
+                               } else {
+                                       MSG("All %s tracepoints are enabled in channel %s",
+                                                       opt_kernel ? "kernel" : "UST", channel_name);
 
+                               }
+                               break;
+                       case LTTNG_EVENT_SYSCALL:
+                               if (opt_kernel) {
+                                       MSG("All kernel system calls are enabled in channel %s",
+                                                       channel_name);
+                               }
+                               break;
+                       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);
+                               } else {
+                                       MSG("All %s events are enabled in channel %s",
+                                                       opt_kernel ? "kernel" : "UST", channel_name);
+                               }
+                               break;
+                       default:
+                               /*
+                                * We should not be here since lttng_enable_event should have
+                                * failed on the event type.
+                                */
+                               goto error;
                        }
-                       break;
-               case LTTNG_EVENT_SYSCALL:
-                       if (opt_kernel) {
-                               MSG("All kernel system calls are enabled in channel %s",
-                                               channel_name);
-                       }
-                       break;
-               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);
+               }
+               if (opt_filter) {
+                       ret = lttng_enable_event_with_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);
+                                       break;
+                               }
+                               goto error;
                        } else {
-                               MSG("All %s events are enabled in channel %s",
-                                       opt_kernel ? "kernel" : "UST", channel_name);
+                               MSG("Filter '%s' successfully set", opt_filter);
                        }
-                       break;
-               default:
-                       /*
-                        * We should not be here since lttng_enable_event should have
-                        * failed on the event type.
-                        */
-                       goto error;
                }
                goto end;
        }
@@ -446,7 +510,7 @@ static int enable_events(char *session_name)
 
                        if (opt_loglevel) {
                                MSG("Kernel loglevels are not supported.");
-                               ret = CMD_UNDEFINED;
+                               ret = CMD_UNSUPPORTED;
                                goto error;
                        }
 
@@ -479,7 +543,7 @@ static int enable_events(char *session_name)
                        case LTTNG_EVENT_SYSCALL:
                        default:
                                ERR("Event type not available for user-space tracing");
-                               ret = CMD_UNDEFINED;
+                               ret = CMD_UNSUPPORTED;
                                goto error;
                        }
 
@@ -488,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 {
@@ -500,23 +564,49 @@ static int enable_events(char *session_name)
                        goto error;
                }
 
-               ret = lttng_enable_event(handle, &ev, channel_name);
-               if (ret < 0) {
-                       /* 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)",
+               if (!opt_filter) {
+                       ret = lttng_enable_event(handle, &ev, channel_name);
+                       if (ret < 0) {
+                               /* 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);
+                       }
+               }
+
+               if (opt_filter) {
+                       ret = lttng_enable_event_with_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;
-                       default:
-                               ERR("Event %s: %s (channel %s, session %s)", event_name,
-                                               lttng_strerror(ret), channel_name, session_name);
-                               break;
+                                       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);
+                                       break;
+                               }
+                               goto error;
+                       } else {
+                               MSG("Filter '%s' successfully set", opt_filter);
                        }
-                       warn = 1;
-               } else {
-                       MSG("%s event %s created in channel %s",
-                                       opt_kernel ? "kernel": "UST", event_name, channel_name);
                }
 
                /* Next event */
@@ -585,6 +675,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.028474 seconds and 4 git commands to generate.