Documentation: filter $ctx manpage and --help
[lttng-tools.git] / src / bin / lttng / commands / enable_events.c
index 0bd96eb303680cc715dced1bda4eb845d74c75eb..0e6bb55d8bc7b618fadcc830c1a7ee736145a3c3 100644 (file)
@@ -154,8 +154,8 @@ static void usage(FILE *ofp)
        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, "                           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");
@@ -175,7 +175,20 @@ static void usage(FILE *ofp)
        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, "                           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");
 }
 
@@ -199,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;
@@ -227,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;
@@ -255,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++;
        }
@@ -319,8 +332,11 @@ static int enable_events(char *session_name)
        /* 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;
@@ -358,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 {
@@ -366,60 +382,63 @@ static int enable_events(char *session_name)
                        }
                }
 
-               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;
+               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;
                        }
-                       goto end;
-               }
 
-               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);
-                       } 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;
                }
                if (opt_filter) {
-                       ret = lttng_set_event_filter(handle, ev.name, channel_name,
+                       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"
@@ -431,19 +450,6 @@ static int enable_events(char *session_name)
                                        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;
@@ -504,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;
                        }
 
@@ -537,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;
                        }
 
@@ -546,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 {
@@ -558,26 +564,29 @@ 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 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;
+               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);
                        }
-                       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,
+                       ret = lttng_enable_event_with_filter(handle, &ev, channel_name,
                                        opt_filter);
                        if (ret < 0) {
                                switch (-ret) {
@@ -592,19 +601,6 @@ static int enable_events(char *session_name)
                                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;
This page took 0.028969 seconds and 4 git commands to generate.