Document wildcards for userspace tracer
[lttng-tools.git] / lttng / commands / enable_events.c
index 0f376ad09230c759ea6d0d525c9432e3fe698f07..7df849e73b88d9593575a68fe59d2722283e1aaa 100644 (file)
 
 static char *opt_event_list;
 static int opt_event_type;
-static char *opt_kernel;
-static char *opt_cmd_name;
+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;
 static pid_t opt_pid;
 static char *opt_probe;
@@ -47,29 +46,38 @@ static char *opt_channel_name;
 
 enum {
        OPT_HELP = 1,
-       OPT_USERSPACE,
        OPT_TRACEPOINT,
-       OPT_MARKER,
        OPT_PROBE,
        OPT_FUNCTION,
        OPT_FUNCTION_ENTRY,
+       OPT_SYSCALL,
+       OPT_USERSPACE,
+       OPT_TRACEPOINT_LOGLEVEL,
 };
 
+static struct lttng_handle *handle;
+
 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, 0, OPT_USERSPACE, 0, 0},
-       {"all",            0,   POPT_ARG_VAL, &opt_pid_all, 1, 0, 0},
+       {"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},
        {"tracepoint",     0,   POPT_ARG_NONE, 0, OPT_TRACEPOINT, 0, 0},
-       {"marker",         0,   POPT_ARG_NONE, 0, OPT_MARKER, 0, 0},
-       {"probe",         0,   POPT_ARG_STRING, 0, OPT_PROBE, 0, 0},
-       {"function",       0,   POPT_ARG_STRING, 0, OPT_FUNCTION, 0, 0},
-       {"function:entry", 0,   POPT_ARG_STRING, 0, OPT_FUNCTION_ENTRY, 0, 0},
+       {"probe",          0,   POPT_ARG_STRING, &opt_probe, OPT_PROBE, 0, 0},
+       {"function",       0,   POPT_ARG_STRING, &opt_function, OPT_FUNCTION, 0, 0},
+#if 0
+       /*
+        * Currently removed from lttng kernel tracer. Removed from
+        * lttng UI to discourage its use.
+        */
+       {"function:entry", 0,   POPT_ARG_STRING, &opt_function_entry_symbol, OPT_FUNCTION_ENTRY, 0, 0},
+#endif
+       {"syscall",        0,   POPT_ARG_NONE, 0, OPT_SYSCALL, 0, 0},
+       {"loglevel",     0,     POPT_ARG_NONE, 0, OPT_TRACEPOINT_LOGLEVEL, 0, 0},
        {0, 0, 0, 0, 0, 0, 0}
 };
 
@@ -83,14 +91,21 @@ 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");
        fprintf(ofp, "                           Addr and offset can be octal (0NNN...),\n");
@@ -99,16 +114,16 @@ static void usage(FILE *ofp)
        fprintf(ofp, "                           Dynamic function entry/return probe.\n");
        fprintf(ofp, "                           Addr and offset can be octal (0NNN...),\n");
        fprintf(ofp, "                           decimal (NNN...) or hexadecimal (0xNNN...)\n");
+#if 0
        fprintf(ofp, "    --function:entry symbol\n");
        fprintf(ofp, "                           Function tracer event\n");
-       fprintf(ofp, "    --marker               User-space marker (deprecated)\n");
+#endif
+       fprintf(ofp, "    --syscall              System call event\n");
        fprintf(ofp, "\n");
 }
 
 /*
- *  parse_probe_addr
- *
- *  Parse probe options.
+ * Parse probe options.
  */
 static int parse_probe_opts(struct lttng_event *ev, char *opt)
 {
@@ -125,6 +140,7 @@ static int parse_probe_opts(struct lttng_event *ev, char *opt)
        ret = sscanf(opt, "%[^'+']+%s", name, s_hex);
        if (ret == 2) {
                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) {
                        ERR("Invalid probe offset %s", s_hex);
@@ -142,6 +158,7 @@ static int parse_probe_opts(struct lttng_event *ev, char *opt)
                ret = sscanf(opt, "%s", name);
                if (ret == 1) {
                        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);
                        ev->attr.probe.offset = 0;
                        DBG("probe offset %" PRIu64, ev->attr.probe.offset);
@@ -173,11 +190,9 @@ end:
 }
 
 /*
- *  enable_events
- *
- *  Enabling event using the lttng API.
+ * Enabling event using the lttng API.
  */
-static int enable_events(void)
+static int enable_events(char *session_name)
 {
        int err, ret = CMD_SUCCESS;
        char *event_name, *channel_name = NULL;
@@ -194,45 +209,88 @@ static int enable_events(void)
                channel_name = opt_channel_name;
        }
 
+       if (opt_kernel && opt_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;
+       } 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);
+       if (handle == NULL) {
+               ret = -1;
+               goto error;
        }
 
        if (opt_enable_all) {
-               if (set_session_name(opt_session_name) < 0) {
-                       ret = CMD_ERROR;
+               /* Default setup for enable all */
+               ev.name[0] = '\0';
+               ev.type = opt_event_type;
+
+               ret = lttng_enable_event(handle, &ev, channel_name);
+               if (ret < 0) {
                        goto error;
                }
 
-               if (opt_kernel) {
-                       ret = lttng_enable_event(&dom, NULL, channel_name);
-                       if (ret == 0) {
-                               MSG("All kernel events are enabled in channel %s", channel_name);
+               switch (opt_event_type) {
+               case LTTNG_EVENT_TRACEPOINT:
+                       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:
+                       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;
                }
-
-               /* TODO: User-space tracer */
+               goto end;
        }
 
        /* Strip event list */
        event_name = strtok(opt_event_list, ",");
        while (event_name != NULL) {
-               if (set_session_name(opt_session_name) < 0) {
-                       ret = CMD_ERROR;
-                       goto error;
-               }
+               /* 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.type = opt_event_type;
 
                        switch (opt_event_type) {
+                       case LTTNG_EVENT_ALL:   /* Default behavior is tracepoint */
+                               ev.type = LTTNG_EVENT_TRACEPOINT;
+                               /* Fall-through */
                        case LTTNG_EVENT_TRACEPOINT:
                                break;
                        case LTTNG_EVENT_PROBE:
@@ -252,59 +310,89 @@ static int enable_events(void)
                                }
                                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.");
                        default:
                                ret = CMD_NOT_IMPLEMENTED;
                                goto error;
                        }
-
-                       ret = lttng_enable_event(&dom, &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: Waiting on lttng UST 2.0
-                        */
-                       if (opt_pid_all) {
-                       } else if (opt_pid != 0) {
+                       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);
+
+                       switch (opt_event_type) {
+                       case LTTNG_EVENT_ALL:   /* Default behavior is tracepoint */
+                               /* Fall-through */
+                       case LTTNG_EVENT_TRACEPOINT:
+                               /* Copy name and type of the event */
+                               ev.type = LTTNG_EVENT_TRACEPOINT;
+                               strncpy(ev.name, event_name, LTTNG_SYMBOL_NAME_LEN);
+                               ev.name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
+                               break;
+                       case LTTNG_EVENT_TRACEPOINT_LOGLEVEL:
+                               /* Copy name and type of the event */
+                               ev.type = LTTNG_EVENT_TRACEPOINT_LOGLEVEL;
+                               strncpy(ev.name, event_name, LTTNG_SYMBOL_NAME_LEN);
+                               ev.name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
+                               break;
+                       case LTTNG_EVENT_PROBE:
+                       case LTTNG_EVENT_FUNCTION:
+                       case LTTNG_EVENT_FUNCTION_ENTRY:
+                       case LTTNG_EVENT_SYSCALL:
+                       default:
+                               ret = CMD_NOT_IMPLEMENTED;
+                               goto error;
                        }
-                       ret = CMD_NOT_IMPLEMENTED;
-                       goto error;
                } 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, ",");
        }
 
+end:
 error:
        if (opt_channel_name == NULL) {
                free(channel_name);
        }
+       lttng_destroy_handle(handle);
+
        return ret;
 }
 
 /*
- *  cmd_enable_events
- *
- *  Add event to trace session
+ * Add event to trace session
  */
 int cmd_enable_events(int argc, const char **argv)
 {
        int opt, ret;
        static poptContext pc;
+       char *session_name = NULL;
 
        pc = poptGetContext(NULL, argc, argv, long_options, 0);
        poptReadDefaultConfig(pc, 0);
 
        /* Default event type */
-       opt_event_type = LTTNG_EVENT_TRACEPOINT;
+       opt_event_type = LTTNG_EVENT_ALL;
 
        while ((opt = poptGetNextOpt(pc)) != -1) {
                switch (opt) {
@@ -312,27 +400,26 @@ int cmd_enable_events(int argc, const char **argv)
                        usage(stderr);
                        ret = CMD_SUCCESS;
                        goto end;
-               case OPT_USERSPACE:
-                       opt_userspace = 1;
-                       opt_cmd_name = poptGetOptArg(pc);
-                       break;
                case OPT_TRACEPOINT:
                        opt_event_type = LTTNG_EVENT_TRACEPOINT;
                        break;
-               case OPT_MARKER:
-                       ret = CMD_NOT_IMPLEMENTED;
-                       goto end;
                case OPT_PROBE:
                        opt_event_type = LTTNG_EVENT_PROBE;
-                       opt_probe = poptGetOptArg(pc);
                        break;
                case OPT_FUNCTION:
                        opt_event_type = LTTNG_EVENT_FUNCTION;
-                       opt_function = poptGetOptArg(pc);
                        break;
                case OPT_FUNCTION_ENTRY:
                        opt_event_type = LTTNG_EVENT_FUNCTION_ENTRY;
-                       opt_function_entry_symbol = poptGetOptArg(pc);
+                       break;
+               case OPT_SYSCALL:
+                       opt_event_type = LTTNG_EVENT_SYSCALL;
+                       break;
+               case OPT_USERSPACE:
+                       opt_userspace = 1;
+                       break;
+               case OPT_TRACEPOINT_LOGLEVEL:
+                       opt_event_type = LTTNG_EVENT_TRACEPOINT_LOGLEVEL;
                        break;
                default:
                        usage(stderr);
@@ -349,8 +436,22 @@ int cmd_enable_events(int argc, const char **argv)
                goto end;
        }
 
-       ret = enable_events();
+       if (!opt_session_name) {
+               session_name = get_session_name();
+               if (session_name == NULL) {
+                       ret = -1;
+                       goto end;
+               }
+       } else {
+               session_name = opt_session_name;
+       }
+
+       ret = enable_events(session_name);
 
 end:
+       if (opt_session_name == NULL) {
+               free(session_name);
+       }
+
        return ret;
 }
This page took 0.027703 seconds and 4 git commands to generate.