diff mbox series

selftests/user_events: Fix failures when user_events is not installed

Message ID 20230907223536.731-1-beaub@linux.microsoft.com (mailing list archive)
State New
Headers show
Series selftests/user_events: Fix failures when user_events is not installed | expand

Commit Message

Beau Belgrave Sept. 7, 2023, 10:35 p.m. UTC 
When user_events is not installed the self tests currently fail. Now
that these self tests run by default we need to ensure they don't fail
when user_events was not enabled for the kernel being tested.

Add common methods to detect if tracefs and user_events is enabled. If
either is not enabled skip the test. If tracefs is enabled, but is not
mounted, mount tracefs and fail if there were any errors. Fail if not
run as root.

Fixes: 68b4d2d58389 ("selftests/user_events: Reenable build")
Reported-by: Naresh Kamboju <naresh.kamboju@linaro.org>
Link: https://lore.kernel.org/all/CA+G9fYuugZ0OMeS6HvpSS4nuf_A3s455ecipGBvER0LJHojKZg@mail.gmail.com/

Signed-off-by: Beau Belgrave <beaub@linux.microsoft.com>
---
 .../testing/selftests/user_events/abi_test.c  |   3 +
 .../testing/selftests/user_events/dyn_test.c  |   2 +
 .../selftests/user_events/ftrace_test.c       |   3 +
 .../testing/selftests/user_events/perf_test.c |   3 +
 .../user_events/user_events_selftests.h       | 103 ++++++++++++++++++
 5 files changed, 114 insertions(+)
 create mode 100644 tools/testing/selftests/user_events/user_events_selftests.h


base-commit: 9b1db732866bee060b9bca9493e5ebf5e8874c48

Comments

Steven Rostedt Sept. 7, 2023, 10:55 p.m. UTC | #1 
On Thu,  7 Sep 2023 22:35:36 +0000
Beau Belgrave <beaub@linux.microsoft.com> wrote:

> diff --git a/tools/testing/selftests/user_events/user_events_selftests.h b/tools/testing/selftests/user_events/user_events_selftests.h
> new file mode 100644
> index 000000000000..72692e62c709
> --- /dev/null
> +++ b/tools/testing/selftests/user_events/user_events_selftests.h
> @@ -0,0 +1,103 @@
> +/* SPDX-License-Identifier: GPL-2.0 */
> +
> +#ifndef _USER_EVENTS_SELFTESTS_H
> +#define _USER_EVENTS_SELFTESTS_H
> +
> +#include <sys/types.h>
> +#include <sys/mount.h>
> +#include <unistd.h>
> +#include <errno.h>
> +
> +#include "../kselftest.h"
> +
> +static inline bool tracefs_enabled(char **message, bool *fail)
> +{
> +	int fd;
> +
> +	*message = "";
> +	*fail = false;
> +
> +	/* Ensure tracefs is installed */
> +	fd = open("/sys/kernel/tracing", O_RDONLY);

Instead of opening the directory, I believe that "stat()" is the preferred
method of testing existence.

> +
> +	if (fd == -1) {
> +		*message = "Tracefs is not installed";
> +		return false;
> +	}
> +
> +	close(fd);
> +
> +	/* Ensure mounted tracefs */
> +	fd = open("/sys/kernel/tracing/README", O_RDONLY);
> +
> +	if (fd == -1 && errno == ENOENT) {
> +		if (mount(NULL, "/sys/kernel/tracing", "tracefs", 0, NULL) != 0) {
> +			*message = "Cannot mount tracefs";
> +			*fail = true;
> +			return false;
> +		}
> +
> +		fd = open("/sys/kernel/tracing/README", O_RDONLY);

Same here, unless you want to make sure you can also read it.

> +	}
> +
> +	if (fd == -1) {
> +		*message = "Cannot access tracefs";
> +		*fail = true;
> +		return false;
> +	}
> +
> +	close(fd);
> +
> +	return true;
> +}
> +
> +static inline bool user_events_enabled(char **message, bool *fail)
> +{
> +	int fd;
> +
> +	*message = "";
> +	*fail = false;
> +
> +	if (getuid() != 0) {
> +		*message = "Must be run as root";
> +		*fail = true;
> +		return false;
> +	}
> +
> +	if (!tracefs_enabled(message, fail))
> +		return false;
> +
> +	/* Ensure user_events is installed */
> +	fd = open("/sys/kernel/tracing/user_events_data", O_RDONLY);

ditto.

-- Steve

> +
> +	if (fd == -1) {
> +		switch (errno) {
> +		case ENOENT:
> +			*message = "user_events is not installed";
> +			return false;
> +
> +		default:
> +			*message = "Cannot access user_events_data";
> +			*fail = true;
> +			return false;
> +		}
> +	}
> +
> +	close(fd);
> +
> +	return true;
> +}
> +
> +#define USER_EVENT_FIXTURE_SETUP(statement) do { \
> +	char *message; \
> +	bool fail; \
> +	if (!user_events_enabled(&message, &fail)) { \
> +		if (fail) { \
> +			TH_LOG("Setup failed due to: %s", message); \
> +			ASSERT_FALSE(fail); \
> +		} \
> +		SKIP(statement, "Skipping due to: %s", message); \
> +	} \
> +} while (0)
> +
> +#endif /* _USER_EVENTS_SELFTESTS_H */
> 
> base-commit: 9b1db732866bee060b9bca9493e5ebf5e8874c48
diff mbox series

Patch

diff --git a/tools/testing/selftests/user_events/abi_test.c b/tools/testing/selftests/user_events/abi_test.c
index 5125c42efe65..22374d29ffdd 100644
--- a/tools/testing/selftests/user_events/abi_test.c
+++ b/tools/testing/selftests/user_events/abi_test.c
@@ -19,6 +19,7 @@ 
 #include <asm/unistd.h>
 
 #include "../kselftest_harness.h"
+#include "user_events_selftests.h"
 
 const char *data_file = "/sys/kernel/tracing/user_events_data";
 const char *enable_file = "/sys/kernel/tracing/events/user_events/__abi_event/enable";
@@ -93,6 +94,8 @@  FIXTURE(user) {
 };
 
 FIXTURE_SETUP(user) {
+	USER_EVENT_FIXTURE_SETUP(return);
+
 	change_event(false);
 	self->check = 0;
 }
diff --git a/tools/testing/selftests/user_events/dyn_test.c b/tools/testing/selftests/user_events/dyn_test.c
index 91a4444ad42b..32c827a52d7d 100644
--- a/tools/testing/selftests/user_events/dyn_test.c
+++ b/tools/testing/selftests/user_events/dyn_test.c
@@ -15,6 +15,7 @@ 
 #include <unistd.h>
 
 #include "../kselftest_harness.h"
+#include "user_events_selftests.h"
 
 const char *abi_file = "/sys/kernel/tracing/user_events_data";
 const char *enable_file = "/sys/kernel/tracing/events/user_events/__test_event/enable";
@@ -146,6 +147,7 @@  FIXTURE(user) {
 };
 
 FIXTURE_SETUP(user) {
+	USER_EVENT_FIXTURE_SETUP(return);
 }
 
 FIXTURE_TEARDOWN(user) {
diff --git a/tools/testing/selftests/user_events/ftrace_test.c b/tools/testing/selftests/user_events/ftrace_test.c
index 5beb0aef1d81..6a260caeeddc 100644
--- a/tools/testing/selftests/user_events/ftrace_test.c
+++ b/tools/testing/selftests/user_events/ftrace_test.c
@@ -16,6 +16,7 @@ 
 #include <unistd.h>
 
 #include "../kselftest_harness.h"
+#include "user_events_selftests.h"
 
 const char *data_file = "/sys/kernel/tracing/user_events_data";
 const char *status_file = "/sys/kernel/tracing/user_events_status";
@@ -206,6 +207,8 @@  FIXTURE(user) {
 };
 
 FIXTURE_SETUP(user) {
+	USER_EVENT_FIXTURE_SETUP(return);
+
 	self->status_fd = open(status_file, O_RDONLY);
 	ASSERT_NE(-1, self->status_fd);
 
diff --git a/tools/testing/selftests/user_events/perf_test.c b/tools/testing/selftests/user_events/perf_test.c
index 8b09be566fa2..f893398cda05 100644
--- a/tools/testing/selftests/user_events/perf_test.c
+++ b/tools/testing/selftests/user_events/perf_test.c
@@ -17,6 +17,7 @@ 
 #include <asm/unistd.h>
 
 #include "../kselftest_harness.h"
+#include "user_events_selftests.h"
 
 const char *data_file = "/sys/kernel/tracing/user_events_data";
 const char *id_file = "/sys/kernel/tracing/events/user_events/__test_event/id";
@@ -113,6 +114,8 @@  FIXTURE(user) {
 };
 
 FIXTURE_SETUP(user) {
+	USER_EVENT_FIXTURE_SETUP(return);
+
 	self->data_fd = open(data_file, O_RDWR);
 	ASSERT_NE(-1, self->data_fd);
 }
diff --git a/tools/testing/selftests/user_events/user_events_selftests.h b/tools/testing/selftests/user_events/user_events_selftests.h
new file mode 100644
index 000000000000..72692e62c709
--- /dev/null
+++ b/tools/testing/selftests/user_events/user_events_selftests.h
@@ -0,0 +1,103 @@ 
+/* SPDX-License-Identifier: GPL-2.0 */
+
+#ifndef _USER_EVENTS_SELFTESTS_H
+#define _USER_EVENTS_SELFTESTS_H
+
+#include <sys/types.h>
+#include <sys/mount.h>
+#include <unistd.h>
+#include <errno.h>
+
+#include "../kselftest.h"
+
+static inline bool tracefs_enabled(char **message, bool *fail)
+{
+	int fd;
+
+	*message = "";
+	*fail = false;
+
+	/* Ensure tracefs is installed */
+	fd = open("/sys/kernel/tracing", O_RDONLY);
+
+	if (fd == -1) {
+		*message = "Tracefs is not installed";
+		return false;
+	}
+
+	close(fd);
+
+	/* Ensure mounted tracefs */
+	fd = open("/sys/kernel/tracing/README", O_RDONLY);
+
+	if (fd == -1 && errno == ENOENT) {
+		if (mount(NULL, "/sys/kernel/tracing", "tracefs", 0, NULL) != 0) {
+			*message = "Cannot mount tracefs";
+			*fail = true;
+			return false;
+		}
+
+		fd = open("/sys/kernel/tracing/README", O_RDONLY);
+	}
+
+	if (fd == -1) {
+		*message = "Cannot access tracefs";
+		*fail = true;
+		return false;
+	}
+
+	close(fd);
+
+	return true;
+}
+
+static inline bool user_events_enabled(char **message, bool *fail)
+{
+	int fd;
+
+	*message = "";
+	*fail = false;
+
+	if (getuid() != 0) {
+		*message = "Must be run as root";
+		*fail = true;
+		return false;
+	}
+
+	if (!tracefs_enabled(message, fail))
+		return false;
+
+	/* Ensure user_events is installed */
+	fd = open("/sys/kernel/tracing/user_events_data", O_RDONLY);
+
+	if (fd == -1) {
+		switch (errno) {
+		case ENOENT:
+			*message = "user_events is not installed";
+			return false;
+
+		default:
+			*message = "Cannot access user_events_data";
+			*fail = true;
+			return false;
+		}
+	}
+
+	close(fd);
+
+	return true;
+}
+
+#define USER_EVENT_FIXTURE_SETUP(statement) do { \
+	char *message; \
+	bool fail; \
+	if (!user_events_enabled(&message, &fail)) { \
+		if (fail) { \
+			TH_LOG("Setup failed due to: %s", message); \
+			ASSERT_FALSE(fail); \
+		} \
+		SKIP(statement, "Skipping due to: %s", message); \
+	} \
+} while (0)
+
+#endif /* _USER_EVENTS_SELFTESTS_H */