Commit 1cd927ad authored by Steven Rostedt (Google)'s avatar Steven Rostedt (Google) Committed by Linus Torvalds
Browse files

tracing: mark user_events as BROKEN 

After being merged, user_events become more visible to a wider audience
that have concerns with the current API.

It is too late to fix this for this release, but instead of a full
revert, just mark it as BROKEN (which prevents it from being selected in
make config).  Then we can work finding a better API.  If that fails,
then it will need to be completely reverted.

To not have the code silently bitrot, still allow building it with
COMPILE_TEST.

And to prevent the uapi header from being installed, then later changed,
and then have an old distro user space see the old version, move the
header file out of the uapi directory.

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: default avatarMathieu Desnoyers <mathieu.desnoyers@efficios.com>
Signed-off-by: default avatarSteven Rostedt (Google) <rostedt@goodmis.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 88e6c020

kernel/trace/Kconfig

+1 −0
Original line number Diff line number Diff line
@@ -767,6 +767,7 @@ config USER_EVENTS 
	bool "User trace events"

	select TRACING

	select DYNAMIC_EVENTS

	depends on BROKEN || COMPILE_TEST # API needs to be straighten out

	help

	  User trace events are user-defined trace events that

	  can be used like an existing kernel trace event.  User trace

kernel/trace/trace_events_user.c

+5 −0
Original line number Diff line number Diff line
@@ -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"