Document wildcards for userspace tracer
[lttng-tools.git] / lttng / commands / enable_events.c
index 45cef9f60c7a6b55cd76c3ad7dc6379b9e951a2e..7df849e73b88d9593575a68fe59d2722283e1aaa 100644 (file)
@@ -33,9 +33,8 @@
 
 static char *opt_event_list;
 static int opt_event_type;
-static char *opt_kernel;
+static int opt_kernel;
 static char *opt_session_name;
-static int opt_pid_all;
 static int opt_userspace;
 static char *opt_cmd_name;
 static int opt_enable_all;
@@ -62,11 +61,10 @@ static struct poptOption long_options[] = {
        /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
        {"help",           'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
        {"session",        's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
-       {"all-events",     'a', POPT_ARG_VAL, &opt_enable_all, 1, 0, 0},
+       {"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},
        {"userspace",      'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
-       {"all",            0,   POPT_ARG_VAL, &opt_pid_all, 1, 0, 0},
        {"pid",            'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
        {"tracepoint",     0,   POPT_ARG_NONE, 0, OPT_TRACEPOINT, 0, 0},
        {"probe",          0,   POPT_ARG_STRING, &opt_probe, OPT_PROBE, 0, 0},
@@ -93,14 +91,20 @@ static void usage(FILE *ofp)
        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, "  -a, --all-events         Enable all tracepoints\n");
+       fprintf(ofp, "  -a, --all                Enable 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, "      --all                If -u, apply on all traceable apps\n");
-       fprintf(ofp, "  -p, --pid PID            If -u, apply on a specific PID\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, "\n");
        fprintf(ofp, "Event options:\n");
        fprintf(ofp, "    --tracepoint           Tracepoint event (default)\n");
+       fprintf(ofp, "                           - userspace tracer supports wildcards at end of string.\n");
+       fprintf(ofp, "                             Don't forget to quote to deal with bash expansion.\n");
+       fprintf(ofp, "                             e.g.:\n");
+       fprintf(ofp, "                               \"*\"\n");
+       fprintf(ofp, "                               \"app_component:na*\"\n");
        fprintf(ofp, "    --loglevel             Tracepoint loglevel\n");
        fprintf(ofp, "    --probe [addr | symbol | symbol+offset]\n");
        fprintf(ofp, "                           Dynamic probe.\n");
@@ -119,9 +123,7 @@ static void usage(FILE *ofp)
 }
 
 /*
- *  parse_probe_addr
- *
- *  Parse probe options.
+ * Parse probe options.
  */
 static int parse_probe_opts(struct lttng_event *ev, char *opt)
 {
@@ -188,9 +190,7 @@ end:
 }
 
 /*
- *  enable_events
- *
- *  Enabling event using the lttng API.
+ * Enabling event using the lttng API.
  */
 static int enable_events(char *session_name)
 {
@@ -210,21 +210,27 @@ static int enable_events(char *session_name)
        }
 
        if (opt_kernel && opt_userspace) {
-               MSG("Choose only one of --kernel or --userspace");
+               ERR("Can't use -k/--kernel and -u/--userspace together");
                ret = CMD_FATAL;
                goto error;
        }
+
        /* Create lttng domain */
        if (opt_kernel) {
                dom.type = LTTNG_DOMAIN_KERNEL;
-       }
-       if (opt_userspace) {
-               /* TODO
-                * LTTNG_DOMAIN_UST_EXEC_NAME,
-                * LTTNG_DOMAIN_UST_PID,
-                * LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN 
-                */
+       } 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;
+       } 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);
+       } else {
+               ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
+               ret = CMD_NOT_IMPLEMENTED;
+               goto error;
        }
 
        handle = lttng_create_handle(session_name, &dom);
@@ -260,9 +266,8 @@ static int enable_events(char *session_name)
                        break;
                default:
                        /*
-                        * We should not be here since
-                        * lttng_enable_event should have failed on the
-                        * event type.
+                        * We should not be here since lttng_enable_event should have
+                        * failed on the event type.
                         */
                        goto error;
                }
@@ -272,14 +277,15 @@ static int enable_events(char *session_name)
        /* Strip event list */
        event_name = strtok(opt_event_list, ",");
        while (event_name != NULL) {
+               /* Copy name and type of the event */
+               strncpy(ev.name, event_name, LTTNG_SYMBOL_NAME_LEN);
+               ev.name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
+               ev.type = opt_event_type;
+
                /* Kernel tracer action */
                if (opt_kernel) {
                        DBG("Enabling kernel event %s for channel %s",
                                        event_name, channel_name);
-                       /* Copy name and type of the event */
-                       strncpy(ev.name, event_name, LTTNG_SYMBOL_NAME_LEN);
-                       ev.name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
-                       ev.type = opt_event_type;
 
                        switch (opt_event_type) {
                        case LTTNG_EVENT_ALL:   /* Default behavior is tracepoint */
@@ -304,37 +310,26 @@ static int enable_events(char *session_name)
                                }
                                break;
                        case LTTNG_EVENT_FUNCTION_ENTRY:
-                               strncpy(ev.attr.ftrace.symbol_name,
-                                       opt_function_entry_symbol,
-                                       LTTNG_SYMBOL_NAME_LEN);
+                               strncpy(ev.attr.ftrace.symbol_name, opt_function_entry_symbol,
+                                               LTTNG_SYMBOL_NAME_LEN);
                                ev.attr.ftrace.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
                                break;
                        case LTTNG_EVENT_SYSCALL:
-                               MSG("per-syscall selection not supported yet. Use \"-a\" for all syscalls.");
-                               ret = CMD_NOT_IMPLEMENTED;
-                               goto error;
+                               MSG("per-syscall selection not supported yet. Use \"-a\" "
+                                               "for all syscalls.");
                        default:
                                ret = CMD_NOT_IMPLEMENTED;
                                goto error;
                        }
-
-                       ret = lttng_enable_event(handle, &ev, channel_name);
-                       if (ret == 0) {
-                               MSG("Kernel event %s created in channel %s", event_name, channel_name);
-                       }
                } else if (opt_userspace) {             /* User-space tracer action */
-                       /*
-                        * TODO: only supporting pid_all tracing for
-                        * now. Should have different domain based on
-                        * opt_pid.
-                        */
-                       if (!opt_pid_all) {
-                               MSG("Only supporting tracing all UST processes (-u --all) for now.");
+                       if (opt_cmd_name != NULL || opt_pid) {
+                               MSG("Only supporting tracing all UST processes (-u) for now.");
                                ret = CMD_NOT_IMPLEMENTED;
                                goto error;
                        }
-                       DBG("Enabling UST event %s for channel %s",
-                                       event_name, channel_name);
+
+                       DBG("Enabling UST event %s for channel %s", event_name,
+                                       channel_name);
 
                        switch (opt_event_type) {
                        case LTTNG_EVENT_ALL:   /* Default behavior is tracepoint */
@@ -359,16 +354,17 @@ static int enable_events(char *session_name)
                                ret = CMD_NOT_IMPLEMENTED;
                                goto error;
                        }
-
-                       ret = lttng_enable_event(handle, &ev, channel_name);
-                       if (ret == 0) {
-                               MSG("UST event %s created in channel %s", event_name, channel_name);
-                       }
                } else {
-                       ERR("Please specify a tracer (--kernel or --userspace)");
+                       ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
                        goto error;
                }
 
+               ret = lttng_enable_event(handle, &ev, channel_name);
+               if (ret == 0) {
+                       MSG("%s event %s created in channel %s",
+                                       opt_kernel ? "kernel": "UST", event_name, channel_name);
+               }
+
                /* Next event */
                event_name = strtok(NULL, ",");
        }
@@ -384,9 +380,7 @@ error:
 }
 
 /*
- *  cmd_enable_events
- *
- *  Add event to trace session
+ * Add event to trace session
  */
 int cmd_enable_events(int argc, const char **argv)
 {
This page took 0.026188 seconds and 4 git commands to generate.