lttng: Add add-trigger command
[lttng-tools.git] / src / bin / lttng / commands / enable_events.c
index e90db88d1ff86398104d1a70b4ea162f6e390c50..627b7ebf9ebeaa1a91ee781adcc023b098780073 100644 (file)
@@ -1,18 +1,8 @@
 /*
- * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
+ * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License, version 2 only,
- * as published by the Free Software Foundation.
+ * SPDX-License-Identifier: GPL-2.0-only
  *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
 #define _LGPL_SOURCE
 
 #include <common/sessiond-comm/sessiond-comm.h>
 #include <common/compat/string.h>
+#include <common/compat/getenv.h>
 #include <common/string-utils/string-utils.h>
+#include <common/utils.h>
 
 /* Mi dependancy */
 #include <common/mi-lttng.h>
 
+#include <lttng/event-internal.h>
+
 #include "../command.h"
+#include "../loglevel.h"
+#include "../uprobe.h"
 
 #if (LTTNG_SYMBOL_NAME_LEN == 256)
 #define LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API    "255"
@@ -51,6 +47,7 @@ static int opt_log4j;
 static int opt_python;
 static int opt_enable_all;
 static char *opt_probe;
+static char *opt_userspace_probe;
 static char *opt_function;
 static char *opt_channel_name;
 static char *opt_filter;
@@ -66,6 +63,7 @@ enum {
        OPT_HELP = 1,
        OPT_TRACEPOINT,
        OPT_PROBE,
+       OPT_USERSPACE_PROBE,
        OPT_FUNCTION,
        OPT_SYSCALL,
        OPT_USERSPACE,
@@ -92,6 +90,7 @@ static struct poptOption long_options[] = {
        {"python",         'p', POPT_ARG_VAL, &opt_python, 1, 0, 0},
        {"tracepoint",     0,   POPT_ARG_NONE, 0, OPT_TRACEPOINT, 0, 0},
        {"probe",          0,   POPT_ARG_STRING, &opt_probe, OPT_PROBE, 0, 0},
+       {"userspace-probe",0,   POPT_ARG_STRING, &opt_userspace_probe, OPT_USERSPACE_PROBE, 0, 0},
        {"function",       0,   POPT_ARG_STRING, &opt_function, OPT_FUNCTION, 0, 0},
        {"syscall",        0,   POPT_ARG_NONE, 0, OPT_SYSCALL, 0, 0},
        {"loglevel",       0,     POPT_ARG_STRING, 0, OPT_LOGLEVEL, 0, 0},
@@ -137,7 +136,7 @@ static int parse_probe_opts(struct lttng_event *ev, char *opt)
        }
 
        /* Check for symbol */
-       if (isalpha(name[0])) {
+       if (isalpha(name[0]) || name[0] == '_') {
                match = sscanf(opt, "%" LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API "s",
                        name);
                if (match == 1) {
@@ -154,8 +153,13 @@ static int parse_probe_opts(struct lttng_event *ev, char *opt)
        /* Check for address */
        match = sscanf(opt, "%" S_HEX_LEN_SCANF_IS_A_BROKEN_API "s", s_hex);
        if (match > 0) {
-               if (*s_hex == '\0') {
-                       ERR("Invalid probe address %s", s_hex);
+               /*
+                * Return an error if the first character of the tentative
+                * address is NULL or not a digit. It can be "0" if the address
+                * is in hexadecimal and can be 1 to 9 if it's in decimal.
+                */
+               if (*s_hex == '\0' || !isdigit(*s_hex)) {
+                       ERR("Invalid probe description %s", s_hex);
                        ret = CMD_ERROR;
                        goto end;
                }
@@ -173,190 +177,6 @@ end:
        return ret;
 }
 
-/*
- * Maps LOG4j loglevel from string to value
- */
-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.
-        */
-       while (i < (LTTNG_SYMBOL_NAME_LEN - 1) && inputstr[i] != '\0') {
-               str[i] = toupper(inputstr[i]);
-               i++;
-       }
-       str[i] = '\0';
-
-       if (!strcmp(str, "LOG4J_OFF") || !strcmp(str, "OFF")) {
-               return LTTNG_LOGLEVEL_LOG4J_OFF;
-       } else if (!strcmp(str, "LOG4J_FATAL") || !strcmp(str, "FATAL")) {
-               return LTTNG_LOGLEVEL_LOG4J_FATAL;
-       } else if (!strcmp(str, "LOG4J_ERROR") || !strcmp(str, "ERROR")) {
-               return LTTNG_LOGLEVEL_LOG4J_ERROR;
-       } else if (!strcmp(str, "LOG4J_WARN") || !strcmp(str, "WARN")) {
-               return LTTNG_LOGLEVEL_LOG4J_WARN;
-       } else if (!strcmp(str, "LOG4J_INFO") || !strcmp(str, "INFO")) {
-               return LTTNG_LOGLEVEL_LOG4J_INFO;
-       } else if (!strcmp(str, "LOG4J_DEBUG") || !strcmp(str, "DEBUG")) {
-               return LTTNG_LOGLEVEL_LOG4J_DEBUG;
-       } else if (!strcmp(str, "LOG4J_TRACE") || !strcmp(str, "TRACE")) {
-               return LTTNG_LOGLEVEL_LOG4J_TRACE;
-       } else if (!strcmp(str, "LOG4J_ALL") || !strcmp(str, "ALL")) {
-               return LTTNG_LOGLEVEL_LOG4J_ALL;
-       } else {
-               return -1;
-       }
-}
-
-/*
- * Maps JUL loglevel from string to value
- */
-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.
-        */
-       while (i < (LTTNG_SYMBOL_NAME_LEN - 1) && inputstr[i] != '\0') {
-               str[i] = toupper(inputstr[i]);
-               i++;
-       }
-       str[i] = '\0';
-
-       if (!strcmp(str, "JUL_OFF") || !strcmp(str, "OFF")) {
-               return LTTNG_LOGLEVEL_JUL_OFF;
-       } else if (!strcmp(str, "JUL_SEVERE") || !strcmp(str, "SEVERE")) {
-               return LTTNG_LOGLEVEL_JUL_SEVERE;
-       } else if (!strcmp(str, "JUL_WARNING") || !strcmp(str, "WARNING")) {
-               return LTTNG_LOGLEVEL_JUL_WARNING;
-       } else if (!strcmp(str, "JUL_INFO") || !strcmp(str, "INFO")) {
-               return LTTNG_LOGLEVEL_JUL_INFO;
-       } else if (!strcmp(str, "JUL_CONFIG") || !strcmp(str, "CONFIG")) {
-               return LTTNG_LOGLEVEL_JUL_CONFIG;
-       } else if (!strcmp(str, "JUL_FINE") || !strcmp(str, "FINE")) {
-               return LTTNG_LOGLEVEL_JUL_FINE;
-       } else if (!strcmp(str, "JUL_FINER") || !strcmp(str, "FINER")) {
-               return LTTNG_LOGLEVEL_JUL_FINER;
-       } else if (!strcmp(str, "JUL_FINEST") || !strcmp(str, "FINEST")) {
-               return LTTNG_LOGLEVEL_JUL_FINEST;
-       } else if (!strcmp(str, "JUL_ALL") || !strcmp(str, "ALL")) {
-               return LTTNG_LOGLEVEL_JUL_ALL;
-       } else {
-               return -1;
-       }
-}
-
-/*
- * Maps Python loglevel from string to value
- */
-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.
-        */
-       while (i < (LTTNG_SYMBOL_NAME_LEN - 1) && inputstr[i] != '\0') {
-               str[i] = toupper(inputstr[i]);
-               i++;
-       }
-       str[i] = '\0';
-
-       if (!strcmp(str, "PYTHON_CRITICAL") || !strcmp(str, "CRITICAL")) {
-               return LTTNG_LOGLEVEL_PYTHON_CRITICAL;
-       } else if (!strcmp(str, "PYTHON_ERROR") || !strcmp(str, "ERROR")) {
-               return LTTNG_LOGLEVEL_PYTHON_ERROR;
-       } else if (!strcmp(str, "PYTHON_WARNING") || !strcmp(str, "WARNING")) {
-               return LTTNG_LOGLEVEL_PYTHON_WARNING;
-       } else if (!strcmp(str, "PYTHON_INFO") || !strcmp(str, "INFO")) {
-               return LTTNG_LOGLEVEL_PYTHON_INFO;
-       } else if (!strcmp(str, "PYTNON_DEBUG") || !strcmp(str, "DEBUG")) {
-               return LTTNG_LOGLEVEL_PYTHON_DEBUG;
-       } else if (!strcmp(str, "PYTHON_NOTSET") || !strcmp(str, "NOTSET")) {
-               return LTTNG_LOGLEVEL_PYTHON_NOTSET;
-       } else {
-               return -1;
-       }
-}
-
-/*
- * Maps loglevel from string to value
- */
-static
-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.
-        */
-       while (i < (LTTNG_SYMBOL_NAME_LEN - 1) && inputstr[i] != '\0') {
-               str[i] = toupper(inputstr[i]);
-               i++;
-       }
-       str[i] = '\0';
-       if (!strcmp(str, "TRACE_EMERG") || !strcmp(str, "EMERG")) {
-               return LTTNG_LOGLEVEL_EMERG;
-       } else if (!strcmp(str, "TRACE_ALERT") || !strcmp(str, "ALERT")) {
-               return LTTNG_LOGLEVEL_ALERT;
-       } else if (!strcmp(str, "TRACE_CRIT") || !strcmp(str, "CRIT")) {
-               return LTTNG_LOGLEVEL_CRIT;
-       } else if (!strcmp(str, "TRACE_ERR") || !strcmp(str, "ERR")) {
-               return LTTNG_LOGLEVEL_ERR;
-       } else if (!strcmp(str, "TRACE_WARNING") || !strcmp(str, "WARNING")) {
-               return LTTNG_LOGLEVEL_WARNING;
-       } else if (!strcmp(str, "TRACE_NOTICE") || !strcmp(str, "NOTICE")) {
-               return LTTNG_LOGLEVEL_NOTICE;
-       } else if (!strcmp(str, "TRACE_INFO") || !strcmp(str, "INFO")) {
-               return LTTNG_LOGLEVEL_INFO;
-       } else if (!strcmp(str, "TRACE_DEBUG_SYSTEM") || !strcmp(str, "DEBUG_SYSTEM") || !strcmp(str, "SYSTEM")) {
-               return LTTNG_LOGLEVEL_DEBUG_SYSTEM;
-       } else if (!strcmp(str, "TRACE_DEBUG_PROGRAM") || !strcmp(str, "DEBUG_PROGRAM") || !strcmp(str, "PROGRAM")) {
-               return LTTNG_LOGLEVEL_DEBUG_PROGRAM;
-       } else if (!strcmp(str, "TRACE_DEBUG_PROCESS") || !strcmp(str, "DEBUG_PROCESS") || !strcmp(str, "PROCESS")) {
-               return LTTNG_LOGLEVEL_DEBUG_PROCESS;
-       } else if (!strcmp(str, "TRACE_DEBUG_MODULE") || !strcmp(str, "DEBUG_MODULE") || !strcmp(str, "MODULE")) {
-               return LTTNG_LOGLEVEL_DEBUG_MODULE;
-       } else if (!strcmp(str, "TRACE_DEBUG_UNIT") || !strcmp(str, "DEBUG_UNIT") || !strcmp(str, "UNIT")) {
-               return LTTNG_LOGLEVEL_DEBUG_UNIT;
-       } else if (!strcmp(str, "TRACE_DEBUG_FUNCTION") || !strcmp(str, "DEBUG_FUNCTION") || !strcmp(str, "FUNCTION")) {
-               return LTTNG_LOGLEVEL_DEBUG_FUNCTION;
-       } else if (!strcmp(str, "TRACE_DEBUG_LINE") || !strcmp(str, "DEBUG_LINE") || !strcmp(str, "LINE")) {
-               return LTTNG_LOGLEVEL_DEBUG_LINE;
-       } else if (!strcmp(str, "TRACE_DEBUG") || !strcmp(str, "DEBUG")) {
-               return LTTNG_LOGLEVEL_DEBUG;
-       } else {
-               return -1;
-       }
-}
-
 static
 const char *print_channel_name(const char *name)
 {
@@ -412,7 +232,7 @@ char *print_exclusions(char **names)
 {
        int length = 0;
        int i;
-       const char *preamble = " excluding ";
+       const char preamble[] = " excluding ";
        char *ret;
        int count = names ? strutils_array_of_strings_len(names) : 0;
 
@@ -425,9 +245,8 @@ char *print_exclusions(char **names)
                length += strlen(names[i]) + 4;
        }
 
-       /* add length of preamble + one for NUL - one for last (missing) comma */
-       length += strlen(preamble);
-       ret = zmalloc(length + 1);
+       length += sizeof(preamble);
+       ret = zmalloc(length);
        if (!ret) {
                return NULL;
        }
@@ -504,7 +323,16 @@ end:
        return ret;
 }
 
-static
+/*
+ * FIXME: find a good place to declare this since add trigger also uses it
+ */
+LTTNG_HIDDEN
+int create_exclusion_list_and_validate(const char *event_name,
+               const char *exclusions_arg,
+               char ***exclusion_list);
+
+
+LTTNG_HIDDEN
 int create_exclusion_list_and_validate(const char *event_name,
                const char *exclusions_arg,
                char ***exclusion_list)
@@ -582,6 +410,7 @@ static int enable_events(char *session_name)
        struct lttng_event *ev;
        struct lttng_domain dom;
        char **exclusion_list = NULL;
+       struct lttng_userspace_probe_location *uprobe_loc = NULL;
 
        memset(&dom, 0, sizeof(dom));
 
@@ -640,6 +469,30 @@ static int enable_events(char *session_name)
                }
        }
 
+       /*
+        * Adding a filter to a probe, function or userspace-probe would be
+        * denied by the kernel tracer as it's not supported at the moment. We
+        * do an early check here to warn the user.
+        */
+       if (opt_filter && opt_kernel) {
+               switch (opt_event_type) {
+               case LTTNG_EVENT_ALL:
+               case LTTNG_EVENT_TRACEPOINT:
+               case LTTNG_EVENT_SYSCALL:
+                       break;
+               case LTTNG_EVENT_PROBE:
+               case LTTNG_EVENT_USERSPACE_PROBE:
+               case LTTNG_EVENT_FUNCTION:
+                       ERR("Filter expressions are not supported for %s events",
+                                       get_event_type_str(opt_event_type));
+                       ret = CMD_ERROR;
+                       goto error;
+               default:
+                       ret = CMD_UNDEFINED;
+                       goto error;
+               }
+       }
+
        channel_name = opt_channel_name;
 
        handle = lttng_create_handle(session_name, &dom);
@@ -670,17 +523,34 @@ static int enable_events(char *session_name)
                        strcpy(ev->name, "*");
                        ev->loglevel_type = opt_loglevel_type;
                        if (opt_loglevel) {
+                               int name_search_ret;
+
                                assert(opt_userspace || opt_jul || opt_log4j || opt_python);
+
                                if (opt_userspace) {
-                                       ev->loglevel = loglevel_str_to_value(opt_loglevel);
+                                       enum lttng_loglevel loglevel;
+
+                                       name_search_ret = loglevel_name_to_value(opt_loglevel, &loglevel);
+                                       ev->loglevel = (int) loglevel;
                                } else if (opt_jul) {
-                                       ev->loglevel = loglevel_jul_str_to_value(opt_loglevel);
+                                       enum lttng_loglevel_jul loglevel;
+
+                                       name_search_ret = loglevel_jul_name_to_value(opt_loglevel, &loglevel);
+                                       ev->loglevel = (int) loglevel;
                                } else if (opt_log4j) {
-                                       ev->loglevel = loglevel_log4j_str_to_value(opt_loglevel);
-                               } else if (opt_python) {
-                                       ev->loglevel = loglevel_python_str_to_value(opt_loglevel);
+                                       enum lttng_loglevel_log4j loglevel;
+
+                                       name_search_ret = loglevel_log4j_name_to_value(opt_loglevel, &loglevel);
+                                       ev->loglevel = (int) loglevel;
+                               } else {
+                                       /* python domain. */
+                                       enum lttng_loglevel_python loglevel;
+
+                                       name_search_ret = loglevel_python_name_to_value(opt_loglevel, &loglevel);
+                                       ev->loglevel = (int) loglevel;
                                }
-                               if (ev->loglevel == -1) {
+
+                               if (name_search_ret == -1) {
                                        ERR("Unknown loglevel %s", opt_loglevel);
                                        ret = -LTTNG_ERR_INVALID;
                                        goto error;
@@ -944,6 +814,37 @@ static int enable_events(char *session_name)
                                        goto error;
                                }
                                break;
+                       case LTTNG_EVENT_USERSPACE_PROBE:
+                               assert(ev->type == LTTNG_EVENT_USERSPACE_PROBE);
+
+                               ret = parse_userspace_probe_opts(opt_userspace_probe, &uprobe_loc);
+                               if (ret) {
+                                       switch (ret) {
+                                       case CMD_UNSUPPORTED:
+                                               /*
+                                                * Error message describing
+                                                * what is not supported was
+                                                * printed in the function.
+                                                */
+                                               break;
+                                       case CMD_ERROR:
+                                       default:
+                                               ERR("Unable to parse userspace probe options");
+                                               break;
+                                       }
+                                       goto error;
+                               }
+
+                               ret = lttng_event_set_userspace_probe_location(ev, uprobe_loc);
+                               if (ret) {
+                                       WARN("Failed to set probe location on event");
+                                       ret = CMD_ERROR;
+                                       goto error;
+                               }
+
+                               /* Ownership of the uprobe location was transferred to the event. */
+                               uprobe_loc = NULL;
+                               break;
                        case LTTNG_EVENT_FUNCTION:
                                ret = parse_probe_opts(ev, opt_function);
                                if (ret) {
@@ -978,6 +879,7 @@ static int enable_events(char *session_name)
                        case LTTNG_EVENT_PROBE:
                        case LTTNG_EVENT_FUNCTION:
                        case LTTNG_EVENT_SYSCALL:
+                       case LTTNG_EVENT_USERSPACE_PROBE:
                        default:
                                ERR("Event type not available for user-space tracing");
                                ret = CMD_UNSUPPORTED;
@@ -1009,12 +911,16 @@ static int enable_events(char *session_name)
 
                        ev->loglevel_type = opt_loglevel_type;
                        if (opt_loglevel) {
-                               ev->loglevel = loglevel_str_to_value(opt_loglevel);
-                               if (ev->loglevel == -1) {
+                               enum lttng_loglevel loglevel;
+                               const int name_search_ret = loglevel_name_to_value(opt_loglevel, &loglevel);
+
+                               if (name_search_ret == -1) {
                                        ERR("Unknown loglevel %s", opt_loglevel);
                                        ret = -LTTNG_ERR_INVALID;
                                        goto error;
                                }
+
+                               ev->loglevel = (int) loglevel;
                        } else {
                                ev->loglevel = -1;
                        }
@@ -1028,14 +934,27 @@ static int enable_events(char *session_name)
 
                        ev->loglevel_type = opt_loglevel_type;
                        if (opt_loglevel) {
+                               int name_search_ret;
+
                                if (opt_jul) {
-                                       ev->loglevel = loglevel_jul_str_to_value(opt_loglevel);
+                                       enum lttng_loglevel_jul loglevel;
+
+                                       name_search_ret = loglevel_jul_name_to_value(opt_loglevel, &loglevel);
+                                       ev->loglevel = (int) loglevel;
                                } else if (opt_log4j) {
-                                       ev->loglevel = loglevel_log4j_str_to_value(opt_loglevel);
-                               } else if (opt_python) {
-                                       ev->loglevel = loglevel_python_str_to_value(opt_loglevel);
+                                       enum lttng_loglevel_log4j loglevel;
+
+                                       name_search_ret = loglevel_log4j_name_to_value(opt_loglevel, &loglevel);
+                                       ev->loglevel = (int) loglevel;
+                               } else {
+                                       /* python domain. */
+                                       enum lttng_loglevel_python loglevel;
+
+                                       name_search_ret = loglevel_python_name_to_value(opt_loglevel, &loglevel);
+                                       ev->loglevel = (int) loglevel;
                                }
-                               if (ev->loglevel == -1) {
+
+                               if (name_search_ret) {
                                        ERR("Unknown loglevel %s", opt_loglevel);
                                        ret = -LTTNG_ERR_INVALID;
                                        goto error;
@@ -1091,6 +1010,12 @@ static int enable_events(char *session_name)
                                        error = 1;
                                        break;
                                }
+                               case LTTNG_ERR_SDT_PROBE_SEMAPHORE:
+                                       ERR("SDT probes %s guarded by semaphores are not supported (channel %s, session %s)",
+                                                       event_name, print_channel_name(channel_name),
+                                                       session_name);
+                                       error = 1;
+                                       break;
                                default:
                                        ERR("Event %s%s: %s (channel %s, session %s)", event_name,
                                                        exclusion_string,
@@ -1252,6 +1177,7 @@ error:
        }
        lttng_destroy_handle(handle);
        strutils_free_null_terminated_array_of_strings(exclusion_list);
+       lttng_userspace_probe_location_destroy(uprobe_loc);
 
        /* Overwrite ret with error_holder if there was an actual error with
         * enabling an event.
@@ -1290,6 +1216,9 @@ int cmd_enable_events(int argc, const char **argv)
                case OPT_PROBE:
                        opt_event_type = LTTNG_EVENT_PROBE;
                        break;
+               case OPT_USERSPACE_PROBE:
+                       opt_event_type = LTTNG_EVENT_USERSPACE_PROBE;
+                       break;
                case OPT_FUNCTION:
                        opt_event_type = LTTNG_EVENT_FUNCTION;
                        break;
@@ -1332,7 +1261,9 @@ 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);
+                       opt_kernel + opt_userspace + opt_jul + opt_log4j +
+                                       opt_python,
+                       true);
        if (ret) {
                ret = CMD_ERROR;
                goto end;
This page took 0.02872 seconds and 4 git commands to generate.