X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Fbin%2Flttng%2Fcommands%2Fenable_events.c;h=4b37a01aafa40e6a55dc3b45ab0dc914895fb6cd;hb=7e8f2e9cce651c81094a864bbffefcaa4bcc7a51;hp=23dff2038f3ef17b1090ba63e186771f9ee5d60a;hpb=ebbcac93ae32a4264d3355c2202034e78db703a0;p=lttng-tools.git

diff --git a/src/bin/lttng/commands/enable_events.c b/src/bin/lttng/commands/enable_events.c
index 23dff2038..4b37a01aa 100644
--- a/src/bin/lttng/commands/enable_events.c
+++ b/src/bin/lttng/commands/enable_events.c
@@ -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
@@ -36,7 +26,10 @@
 /* Mi dependancy */
 #include <common/mi-lttng.h>
 
+#include <lttng/event-internal.h>
+
 #include "../command.h"
+#include "../loglevel.h"
 
 #if (LTTNG_SYMBOL_NAME_LEN == 256)
 #define LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API	"255"
@@ -143,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) {
@@ -160,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;
 		}
@@ -290,6 +288,65 @@ end:
 	return ret;
 }
 
+/*
+ * Check if the symbol field passed by the user is in fact an address or an
+ * offset from a symbol. Those two instrumentation types are not supported yet.
+ * It's expected to be a common mistake because of the existing --probe option
+ * that does support these formats.
+ *
+ * Here are examples of these unsupported formats for the --userspace-probe
+ * option:
+ * elf:/path/to/binary:0x400430
+ * elf:/path/to/binary:4194364
+ * elf:/path/to/binary:my_symbol+0x323
+ * elf:/path/to/binary:my_symbol+43
+ */
+static int warn_userspace_probe_syntax(const char *symbol)
+{
+	int ret;
+
+	/* Check if the symbol field is an hex address. */
+	ret = sscanf(symbol, "0x%*x");
+	if (ret > 0) {
+		/* If there is a match, print a warning and return an error. */
+		ERR("Userspace probe on address not supported yet.");
+		ret = CMD_UNSUPPORTED;
+		goto error;
+	}
+
+	/* Check if the symbol field is an decimal address. */
+	ret = sscanf(symbol, "%*u");
+	if (ret > 0) {
+		/* If there is a match, print a warning and return an error. */
+		ERR("Userspace probe on address not supported yet.");
+		ret = CMD_UNSUPPORTED;
+		goto error;
+	}
+
+	/* Check if the symbol field is symbol+hex_offset. */
+	ret = sscanf(symbol, "%*[^+]+0x%*x");
+	if (ret > 0) {
+		/* If there is a match, print a warning and return an error. */
+		ERR("Userspace probe on symbol+offset not supported yet.");
+		ret = CMD_UNSUPPORTED;
+		goto error;
+	}
+
+	/* Check if the symbol field is symbol+decimal_offset. */
+	ret = sscanf(symbol, "%*[^+]+%*u");
+	if (ret > 0) {
+		/* If there is a match, print a warning and return an error. */
+		ERR("Userspace probe on symbol+offset not supported yet.");
+		ret = CMD_UNSUPPORTED;
+		goto error;
+	}
+
+	ret = 0;
+
+error:
+	return ret;
+}
+
 /*
  * Parse userspace probe options
  * Set the userspace probe fields in the lttng_event struct and set the
@@ -376,7 +433,7 @@ static int parse_userspace_probe_opts(struct lttng_event *ev, char *opt)
 		lookup_method =
 			lttng_userspace_probe_location_lookup_method_tracepoint_sdt_create();
 		if (!lookup_method) {
-			WARN("Failed to create ELF lookup method");
+			WARN("Failed to create SDT lookup method");
 			ret = CMD_ERROR;
 			goto end_string;
 		}
@@ -389,7 +446,7 @@ static int parse_userspace_probe_opts(struct lttng_event *ev, char *opt)
 	/* strutils_unescape_string allocates a new char *. */
 	unescaped_target_path = strutils_unescape_string(target_path, 0);
 	if (!unescaped_target_path) {
-		ret = -LTTNG_ERR_INVALID;
+		ret = CMD_ERROR;
 		goto end_destroy_lookup_method;
 	}
 
@@ -425,11 +482,12 @@ static int parse_userspace_probe_opts(struct lttng_event *ev, char *opt)
 		}
 
 		/*
-		 * Check if the file exists using access(2). If it does not, walk the
-		 * $PATH.
+		 * Check if the file exists using access(2), If it does not,
+		 * return an error.
 		 */
 		ret = access(real_target_path, F_OK);
 		if (ret) {
+			ERR("Cannot find binary at path: %s.", real_target_path);
 			ret = CMD_ERROR;
 			goto end_destroy_lookup_method;
 		}
@@ -437,6 +495,14 @@ static int parse_userspace_probe_opts(struct lttng_event *ev, char *opt)
 
 	switch (lttng_userspace_probe_location_lookup_method_get_type(lookup_method)) {
 	case LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_FUNCTION_ELF:
+		/*
+		 * Check for common mistakes in userspace probe description syntax.
+		 */
+		ret = warn_userspace_probe_syntax(symbol_name);
+		if (ret) {
+			goto end_destroy_lookup_method;
+		}
+
 		probe_location = lttng_userspace_probe_location_function_create(
 				real_target_path, symbol_name, lookup_method);
 		if (!probe_location) {
@@ -498,190 +564,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)
 {
@@ -737,7 +619,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;
 
@@ -750,9 +632,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;
 	}
@@ -1019,17 +900,33 @@ 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);
+					enum lttng_loglevel_log4j loglevel;
+
+					name_search_ret = loglevel_log4j_name_to_value(opt_loglevel, &loglevel);
+					ev->loglevel = (int) loglevel;
 				} else if (opt_python) {
-					ev->loglevel = loglevel_python_str_to_value(opt_loglevel);
+					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;
@@ -1296,8 +1193,19 @@ static int enable_events(char *session_name)
 			case LTTNG_EVENT_USERSPACE_PROBE:
 				ret = parse_userspace_probe_opts(ev, opt_userspace_probe);
 				if (ret) {
-					ERR("Unable to parse userspace probe options");
-					ret = CMD_ERROR;
+					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;
 				}
 				break;
@@ -1367,12 +1275,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;
 			}
@@ -1386,14 +1298,26 @@ 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);
+					enum lttng_loglevel_log4j loglevel;
+
+					name_search_ret = loglevel_log4j_name_to_value(opt_loglevel, &loglevel);
+					ev->loglevel = (int) loglevel;
 				} else if (opt_python) {
-					ev->loglevel = loglevel_python_str_to_value(opt_loglevel);
+					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;
@@ -1699,7 +1623,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;