Warn when exclusion names are truncated
[lttng-tools.git] / src / bin / lttng / commands / enable_events.c
index c4da3dfb67c50ea9cd00d6148a52192722a102d5..6a536976636e6d4f5729ccc9333f6ec066da4b48 100644 (file)
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
-#define _GNU_SOURCE
+#define _LGPL_SOURCE
 #include <assert.h>
 #include <popt.h>
 #include <stdio.h>
 #include <stdlib.h>
-#include <string.h>
 #include <sys/stat.h>
 #include <sys/types.h>
 #include <unistd.h>
@@ -28,6 +27,7 @@
 #include <ctype.h>
 
 #include <src/common/sessiond-comm/sessiond-comm.h>
+#include <common/compat/string.h>
 
 /* Mi dependancy */
 #include <common/mi-lttng.h>
@@ -51,22 +51,15 @@ static int opt_python;
 static int opt_enable_all;
 static char *opt_probe;
 static char *opt_function;
-static char *opt_function_entry_symbol;
 static char *opt_channel_name;
 static char *opt_filter;
 static char *opt_exclude;
-#if 0
-/* Not implemented yet */
-static char *opt_cmd_name;
-static pid_t opt_pid;
-#endif
 
 enum {
        OPT_HELP = 1,
        OPT_TRACEPOINT,
        OPT_PROBE,
        OPT_FUNCTION,
-       OPT_FUNCTION_ENTRY,
        OPT_SYSCALL,
        OPT_USERSPACE,
        OPT_LOGLEVEL,
@@ -93,13 +86,6 @@ static struct poptOption long_options[] = {
        {"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},
-#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_STRING, 0, OPT_LOGLEVEL, 0, 0},
        {"loglevel-only",  0,     POPT_ARG_STRING, 0, OPT_LOGLEVEL_ONLY, 0, 0},
@@ -114,7 +100,7 @@ static struct poptOption long_options[] = {
  */
 static void usage(FILE *ofp)
 {
-       fprintf(ofp, "usage: lttng enable-event NAME[,NAME2,...] [-k|-u] [OPTIONS] \n");
+       fprintf(ofp, "usage: lttng enable-event NAME[,NAME2,...] (-k | -u | -j | -l | -p) [OPTIONS] \n");
        fprintf(ofp, "\n");
        fprintf(ofp, "Options:\n");
        fprintf(ofp, "  -h, --help               Show this help\n");
@@ -122,11 +108,11 @@ static void usage(FILE *ofp)
        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");
+       fprintf(ofp, "  -k, --kernel             Apply to the kernel tracer\n");
        fprintf(ofp, "  -u, --userspace          Apply to the user-space tracer\n");
-       fprintf(ofp, "  -j, --jul                Apply for Java application using JUL\n");
+       fprintf(ofp, "  -j, --jul                Apply to Java application using JUL\n");
        fprintf(ofp, "  -l, --log4j              Apply for Java application using LOG4j\n");
-       fprintf(ofp, "  -p, --python             Apply for Java application using LOG4j\n");
+       fprintf(ofp, "  -p, --python             Apply for Python application\n");
        fprintf(ofp, "\n");
        fprintf(ofp, "Event options:\n");
        fprintf(ofp, "    --tracepoint           Tracepoint event (default)\n");
@@ -143,15 +129,11 @@ 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");
-#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, "                           For JUL/LOG4j domain, see the table below for the range values.\n");
+       fprintf(ofp, "                           For JUL/LOG4j/Python domains, see the table below for the range values.\n");
        fprintf(ofp, "    --loglevel-only name\n");
        fprintf(ofp, "                           Tracepoint loglevel (only this loglevel)\n");
        fprintf(ofp, "\n");
@@ -333,6 +315,10 @@ static int loglevel_log4j_str_to_value(const char *inputstr)
        int i = 0;
        char str[LTTNG_SYMBOL_NAME_LEN];
 
+       if (!inputstr || strlen(inputstr) == 0) {
+               return -1;
+       }
+
        /*
         * Loop up to LTTNG_SYMBOL_NAME_LEN minus one because the NULL bytes is
         * added at the end of the loop so a the upper bound we avoid the overflow.
@@ -372,6 +358,10 @@ static int loglevel_jul_str_to_value(const char *inputstr)
        int i = 0;
        char str[LTTNG_SYMBOL_NAME_LEN];
 
+       if (!inputstr || strlen(inputstr) == 0) {
+               return -1;
+       }
+
        /*
         * Loop up to LTTNG_SYMBOL_NAME_LEN minus one because the NULL bytes is
         * added at the end of the loop so a the upper bound we avoid the overflow.
@@ -413,6 +403,10 @@ static int loglevel_python_str_to_value(const char *inputstr)
        int i = 0;
        char str[LTTNG_SYMBOL_NAME_LEN];
 
+       if (!inputstr || strlen(inputstr) == 0) {
+               return -1;
+       }
+
        /*
         * Loop up to LTTNG_SYMBOL_NAME_LEN minus one because the NULL bytes is
         * added at the end of the loop so a the upper bound we avoid the overflow.
@@ -449,6 +443,10 @@ int loglevel_str_to_value(const char *inputstr)
        int i = 0;
        char str[LTTNG_SYMBOL_NAME_LEN];
 
+       if (!inputstr || strlen(inputstr) == 0) {
+               return -1;
+       }
+
        /*
         * Loop up to LTTNG_SYMBOL_NAME_LEN minus one because the NULL bytes is
         * added at the end of the loop so a the upper bound we avoid the overflow.
@@ -561,7 +559,10 @@ char *print_exclusions(int count, char **names)
 
        /* add length of preamble + one for NUL - one for last (missing) comma */
        length += strlen(preamble);
-       ret = malloc(length);
+       ret = zmalloc(length);
+       if (!ret) {
+               return NULL;
+       }
        strncpy(ret, preamble, length);
        for (i = 0; i < count; i++) {
                strcat(ret, names[i]);
@@ -620,11 +621,25 @@ int check_exclusion_subsets(const char *event_name,
                                goto error;
                        }
                        if (e == '*') {
+                               char *string;
+                               char **new_exclusion_list;
+
                                /* Excluder is a proper subset of event */
+                               string = lttng_strndup(next_excluder, excluder_length);
+                               if (!string) {
+                                       PERROR("lttng_strndup error");
+                                       goto error;
+                               }
+                               new_exclusion_list = realloc(exclusion_list,
+                                       sizeof(char *) * (exclusion_count + 1));
+                               if (!new_exclusion_list) {
+                                       PERROR("realloc");
+                                       free(string);
+                                       goto error;
+                               }
+                               exclusion_list = new_exclusion_list;
                                exclusion_count++;
-                               exclusion_list = realloc(exclusion_list, sizeof(char **) * exclusion_count);
-                               exclusion_list[exclusion_count - 1] = strndup(next_excluder, excluder_length);
-
+                               exclusion_list[exclusion_count - 1] = string;
                                break;
                        }
                        if (x != e) {
@@ -661,6 +676,24 @@ end:
        *exclusion_list_ptr = exclusion_list;
        return ret;
 }
+
+static void warn_on_truncated_exclusion_names(char **exclusion_list,
+       int exclusion_count, int *warn)
+{
+       size_t i = 0;
+
+       for (i = 0; i < exclusion_count; ++i) {
+               const char *name = exclusion_list[i];
+               size_t len = strlen(name);
+
+               if (len >= LTTNG_SYMBOL_NAME_LEN) {
+                       WARN("Event exclusion \"%s\" will be truncated",
+                               name);
+                       *warn = 1;
+               }
+       }
+}
+
 /*
  * Enabling event using the lttng API.
  * Note: in case of error only the last error code will be return.
@@ -679,11 +712,6 @@ static int enable_events(char *session_name)
        memset(&dom, 0, sizeof(dom));
 
        if (opt_kernel) {
-               if (opt_filter) {
-                       ERR("Filter not implement for kernel tracing yet");
-                       ret = CMD_ERROR;
-                       goto error;
-               }
                if (opt_loglevel) {
                        WARN("Kernel loglevels are not supported.");
                }
@@ -710,15 +738,26 @@ static int enable_events(char *session_name)
                /* Default. */
                dom.buf_type = LTTNG_BUFFER_PER_UID;
        } else {
-               print_missing_domain();
-               ret = CMD_ERROR;
-               goto error;
+               /* Checked by the caller. */
+               assert(0);
        }
 
-       if (opt_kernel && opt_exclude) {
-               ERR("Event name exclusions are not yet implemented for kernel events");
-               ret = CMD_ERROR;
-               goto error;
+       if (opt_exclude) {
+               switch (dom.type) {
+               case LTTNG_DOMAIN_KERNEL:
+               case LTTNG_DOMAIN_JUL:
+               case LTTNG_DOMAIN_LOG4J:
+               case LTTNG_DOMAIN_PYTHON:
+                       ERR("Event name exclusions are not yet implemented for %s events",
+                                       get_domain_str(dom.type));
+                       ret = CMD_ERROR;
+                       goto error;
+               case LTTNG_DOMAIN_UST:
+                       /* Exclusions supported */
+                       break;
+               default:
+                       assert(0);
+               }
        }
 
        channel_name = opt_channel_name;
@@ -743,7 +782,7 @@ static int enable_events(char *session_name)
                /* Default setup for enable all */
                if (opt_kernel) {
                        ev.type = opt_event_type;
-                       ev.name[0] = '\0';
+                       strcpy(ev.name, "*");
                        /* kernel loglevels not implemented */
                        ev.loglevel_type = LTTNG_EVENT_LOGLEVEL_ALL;
                } else {
@@ -770,8 +809,10 @@ static int enable_events(char *session_name)
                                assert(opt_userspace || opt_jul || opt_log4j || opt_python);
                                if (opt_userspace) {
                                        ev.loglevel = -1;
-                               } else if (opt_jul || opt_log4j) {
+                               } else if (opt_jul) {
                                        ev.loglevel = LTTNG_LOGLEVEL_JUL_ALL;
+                               } else if (opt_log4j) {
+                                       ev.loglevel = LTTNG_LOGLEVEL_LOG4J_ALL;
                                } else if (opt_python) {
                                        ev.loglevel = LTTNG_LOGLEVEL_PYTHON_DEBUG;
                                }
@@ -785,6 +826,9 @@ static int enable_events(char *session_name)
                                goto error;
                        }
                        ev.exclusion = 1;
+
+                       warn_on_truncated_exclusion_names(exclusion_list,
+                               exclusion_count, &warn);
                }
                if (!opt_filter) {
                        ret = lttng_enable_event_with_exclusions(handle,
@@ -825,6 +869,12 @@ static int enable_events(char *session_name)
                        case LTTNG_EVENT_TRACEPOINT:
                                if (opt_loglevel && dom.type != LTTNG_DOMAIN_KERNEL) {
                                        char *exclusion_string = print_exclusions(exclusion_count, exclusion_list);
+
+                                       if (!exclusion_string) {
+                                               PERROR("Cannot allocate exclusion_string");
+                                               error = 1;
+                                               goto end;
+                                       }
                                        MSG("All %s tracepoints%s are enabled in channel %s for loglevel %s",
                                                        get_domain_str(dom.type),
                                                        exclusion_string,
@@ -833,6 +883,12 @@ static int enable_events(char *session_name)
                                        free(exclusion_string);
                                } else {
                                        char *exclusion_string = print_exclusions(exclusion_count, exclusion_list);
+
+                                       if (!exclusion_string) {
+                                               PERROR("Cannot allocate exclusion_string");
+                                               error = 1;
+                                               goto end;
+                                       }
                                        MSG("All %s tracepoints%s are enabled in channel %s",
                                                        get_domain_str(dom.type),
                                                        exclusion_string,
@@ -850,6 +906,12 @@ static int enable_events(char *session_name)
                        case LTTNG_EVENT_ALL:
                                if (opt_loglevel && dom.type != LTTNG_DOMAIN_KERNEL) {
                                        char *exclusion_string = print_exclusions(exclusion_count, exclusion_list);
+
+                                       if (!exclusion_string) {
+                                               PERROR("Cannot allocate exclusion_string");
+                                               error = 1;
+                                               goto end;
+                                       }
                                        MSG("All %s events%s are enabled in channel %s for loglevel %s",
                                                        get_domain_str(dom.type),
                                                        exclusion_string,
@@ -858,6 +920,12 @@ static int enable_events(char *session_name)
                                        free(exclusion_string);
                                } else {
                                        char *exclusion_string = print_exclusions(exclusion_count, exclusion_list);
+
+                                       if (!exclusion_string) {
+                                               PERROR("Cannot allocate exclusion_string");
+                                               error = 1;
+                                               goto end;
+                                       }
                                        MSG("All %s events%s are enabled in channel %s",
                                                        get_domain_str(dom.type),
                                                        exclusion_string,
@@ -976,9 +1044,12 @@ static int enable_events(char *session_name)
                                        print_channel_name(channel_name));
 
                        switch (opt_event_type) {
-                       case LTTNG_EVENT_ALL:   /* Default behavior is tracepoint */
-                               ev.type = LTTNG_EVENT_TRACEPOINT;
-                               /* Fall-through */
+                       case LTTNG_EVENT_ALL:   /* Enable tracepoints and syscalls */
+                               /* If event name differs from *, select tracepoint. */
+                               if (strcmp(ev.name, "*")) {
+                                       ev.type = LTTNG_EVENT_TRACEPOINT;
+                               }
+                               break;
                        case LTTNG_EVENT_TRACEPOINT:
                                break;
                        case LTTNG_EVENT_PROBE:
@@ -997,11 +1068,6 @@ static int enable_events(char *session_name)
                                        goto error;
                                }
                                break;
-                       case LTTNG_EVENT_FUNCTION_ENTRY:
-                               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:
                                ev.type = LTTNG_EVENT_SYSCALL;
                                break;
@@ -1013,14 +1079,6 @@ static int enable_events(char *session_name)
                        /* kernel loglevels not implemented */
                        ev.loglevel_type = LTTNG_EVENT_LOGLEVEL_ALL;
                } else if (opt_userspace) {             /* User-space tracer action */
-#if 0
-                       if (opt_cmd_name != NULL || opt_pid) {
-                               MSG("Only supporting tracing all UST processes (-u) for now.");
-                               ret = CMD_UNDEFINED;
-                               goto error;
-                       }
-#endif
-
                        DBG("Enabling UST event %s for channel %s, loglevel %s", event_name,
                                        print_channel_name(channel_name), opt_loglevel ? : "<all>");
 
@@ -1035,7 +1093,6 @@ static int enable_events(char *session_name)
                                break;
                        case LTTNG_EVENT_PROBE:
                        case LTTNG_EVENT_FUNCTION:
-                       case LTTNG_EVENT_FUNCTION_ENTRY:
                        case LTTNG_EVENT_SYSCALL:
                        default:
                                ERR("Event type not available for user-space tracing");
@@ -1064,6 +1121,9 @@ static int enable_events(char *session_name)
                                if (ret == CMD_ERROR) {
                                        goto error;
                                }
+
+                               warn_on_truncated_exclusion_names(
+                                       exclusion_list, exclusion_count, &warn);
                        }
 
                        ev.loglevel_type = opt_loglevel_type;
@@ -1112,9 +1172,7 @@ static int enable_events(char *session_name)
                        strncpy(ev.name, event_name, LTTNG_SYMBOL_NAME_LEN);
                        ev.name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
                } else {
-                       print_missing_domain();
-                       ret = CMD_ERROR;
-                       goto error;
+                       assert(0);
                }
 
                if (!opt_filter) {
@@ -1124,6 +1182,11 @@ static int enable_events(char *session_name)
                                        &ev, channel_name,
                                        NULL, exclusion_count, exclusion_list);
                        exclusion_string = print_exclusions(exclusion_count, exclusion_list);
+                       if (!exclusion_string) {
+                               PERROR("Cannot allocate exclusion_string");
+                               error = 1;
+                               goto end;
+                       }
                        if (command_ret < 0) {
                                /* Turn ret to positive value to handle the positive error code */
                                switch (-command_ret) {
@@ -1158,17 +1221,29 @@ static int enable_events(char *session_name)
                                }
                                error_holder = command_ret;
                        } else {
-                               /* So we don't print the default channel name for agent domain. */
-                               if (dom.type == LTTNG_DOMAIN_JUL ||
-                                               dom.type == LTTNG_DOMAIN_LOG4J) {
-                                       MSG("%s event %s%s enabled.",
-                                                       get_domain_str(dom.type), event_name,
-                                                       exclusion_string);
-                               } else {
+                               switch (dom.type) {
+                               case LTTNG_DOMAIN_KERNEL:
+                               case LTTNG_DOMAIN_UST:
                                        MSG("%s event %s%s created in channel %s",
-                                                       get_domain_str(dom.type), event_name,
-                                                       exclusion_string,
-                                                       print_channel_name(channel_name));
+                                               get_domain_str(dom.type),
+                                               event_name,
+                                               exclusion_string,
+                                               print_channel_name(channel_name));
+                                       break;
+                               case LTTNG_DOMAIN_JUL:
+                               case LTTNG_DOMAIN_LOG4J:
+                               case LTTNG_DOMAIN_PYTHON:
+                                       /*
+                                        * Don't print the default channel
+                                        * name for agent domains.
+                                        */
+                                       MSG("%s event %s%s enabled",
+                                               get_domain_str(dom.type),
+                                               event_name,
+                                               exclusion_string);
+                                       break;
+                               default:
+                                       assert(0);
                                }
                        }
                        free(exclusion_string);
@@ -1183,7 +1258,11 @@ static int enable_events(char *session_name)
                        command_ret = lttng_enable_event_with_exclusions(handle, &ev, channel_name,
                                        opt_filter, exclusion_count, exclusion_list);
                        exclusion_string = print_exclusions(exclusion_count, exclusion_list);
-
+                       if (!exclusion_string) {
+                               PERROR("Cannot allocate exclusion_string");
+                               error = 1;
+                               goto end;
+                       }
                        if (command_ret < 0) {
                                switch (-command_ret) {
                                case LTTNG_ERR_FILTER_EXIST:
@@ -1333,9 +1412,6 @@ int cmd_enable_events(int argc, const char **argv)
                case OPT_FUNCTION:
                        opt_event_type = LTTNG_EVENT_FUNCTION;
                        break;
-               case OPT_FUNCTION_ENTRY:
-                       opt_event_type = LTTNG_EVENT_FUNCTION_ENTRY;
-                       break;
                case OPT_SYSCALL:
                        opt_event_type = LTTNG_EVENT_SYSCALL;
                        break;
@@ -1375,6 +1451,13 @@ int cmd_enable_events(int argc, const char **argv)
                }
        }
 
+       ret = print_missing_or_multiple_domains(
+               opt_kernel + opt_userspace + opt_jul + opt_log4j + opt_python);
+       if (ret) {
+               ret = CMD_ERROR;
+               goto end;
+       }
+
        /* Mi check */
        if (lttng_opt_mi) {
                writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi);
This page took 0.029712 seconds and 4 git commands to generate.