diff mbox series

tracing: Move user_events.h temporarily out of include/uapi

Message ID 20220401143903.188384f3@gandalf.local.home (mailing list archive)
State Accepted
Commit 5cfff569cab8bf544bab62c911c5d6efd5af5e05
Headers show
Series tracing: Move user_events.h temporarily out of include/uapi | expand

Checks

Context Check Description
netdev/tree_selection success Not a local patch

Commit Message

Steven Rostedt April 1, 2022, 6:39 p.m. UTC 
From: "Steven Rostedt (Google)" <rostedt@goodmis.org>

While user_events API is under development and has been marked for broken
to not let the API become fixed, move the header file out of the uapi
directory. This is to prevent it from being installed, then later changed,
and then have an old distro user space update with a new kernel, where
applications see the user_events being available, but the old header is in
place, and then they get compiled incorrectly.

Also, surround the include with CONFIG_COMPILE_TEST to the current
location, but when the BROKEN tag is taken off, it will use the uapi
directory, and fail to compile. This is a good way to remind us to move
the header back.

Link: https://lore.kernel.org/all/20220330155835.5e1f6669@gandalf.local.home
Link: https://lkml.kernel.org/r/20220330201755.29319-1-mathieu.desnoyers@efficios.com

Suggested-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
---
 include/{uapi => }/linux/user_events.h | 0
 kernel/trace/trace_events_user.c       | 5 +++++
 2 files changed, 5 insertions(+)
 rename include/{uapi => }/linux/user_events.h (100%)

Comments

patchwork-bot+netdevbpf@kernel.org April 5, 2022, 4:20 p.m. UTC | #1 
Hello:

This patch was applied to netdev/net-next.git (master)
by Steven Rostedt (Google) <rostedt@goodmis.org>:

On Fri, 1 Apr 2022 14:39:03 -0400 you wrote:
> From: "Steven Rostedt (Google)" <rostedt@goodmis.org>
> 
> While user_events API is under development and has been marked for broken
> to not let the API become fixed, move the header file out of the uapi
> directory. This is to prevent it from being installed, then later changed,
> and then have an old distro user space update with a new kernel, where
> applications see the user_events being available, but the old header is in
> place, and then they get compiled incorrectly.
> 
> [...]

Here is the summary with links:
  - tracing: Move user_events.h temporarily out of include/uapi
    https://git.kernel.org/netdev/net-next/c/5cfff569cab8

You are awesome, thank you!
Steven Rostedt April 5, 2022, 4:32 p.m. UTC | #2 
On Tue, 05 Apr 2022 16:20:48 +0000
patchwork-bot+netdevbpf@kernel.org wrote:

> Hello:
> 
> This patch was applied to netdev/net-next.git (master)
> by Steven Rostedt (Google) <rostedt@goodmis.org>:

It was added to Linus's tree too.

https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=5cfff569cab8bf544bab62c911c5d6efd5af5e05

-- Steve
diff mbox series

Patch

diff --git a/include/uapi/linux/user_events.h b/include/linux/user_events.h
similarity index 100%
rename from include/uapi/linux/user_events.h
rename to include/linux/user_events.h
diff --git a/kernel/trace/trace_events_user.c b/kernel/trace/trace_events_user.c
index 846c27bc7aef..706e1686b5eb 100644
--- a/kernel/trace/trace_events_user.c
+++ b/kernel/trace/trace_events_user.c
@@ -18,7 +18,12 @@ 
 #include <linux/tracefs.h>
 #include <linux/types.h>
 #include <linux/uaccess.h>
+/* Reminder to move to uapi when everything works */
+#ifdef CONFIG_COMPILE_TEST
+#include <linux/user_events.h>
+#else
 #include <uapi/linux/user_events.h>
+#endif
 #include "trace.h"
 #include "trace_dynevent.h"