Re: [RFC][PATCH] tracepoint: Have tracepoints created with DECLARE_TRACE() have _tp suffix

Linux Trace Kernel
 help / color / mirror / Atom feed

From: Jiri Olsa <olsajiri@gmail.com>
To: Steven Rostedt <rostedt@goodmis.org>
Cc: LKML <linux-kernel@vger.kernel.org>,
	Linux Trace Kernel <linux-trace-kernel@vger.kernel.org>,
	Mathieu Desnoyers <mathieu.desnoyers@efficios.com>,
	Masami Hiramatsu <mhiramat@kernel.org>,
	Peter Zijlstra <peterz@infradead.org>,
	David Ahern <dsahern@kernel.org>,
	Juri Lelli <juri.lelli@gmail.com>,
	Breno Leitao <leitao@debian.org>,
	netdev@vger.kernel.org,
	Alexei Starovoitov <alexei.starovoitov@gmail.com>,
	Andrii Nakryiko <andrii.nakryiko@gmail.com>,
	bpf@vger.kernel.org, Gabriele Monaco <gmonaco@redhat.com>
Subject: Re: [RFC][PATCH] tracepoint: Have tracepoints created with DECLARE_TRACE() have _tp suffix
Date: Mon, 21 Apr 2025 14:44:21 +0200	[thread overview]
Message-ID: <aAY9pcvYHkYKFwZ5@krava> (raw)
In-Reply-To: <20250418110104.12af6883@gandalf.local.home>

On Fri, Apr 18, 2025 at 11:01:04AM -0400, Steven Rostedt wrote:
> From: Steven Rostedt <rostedt@goodmis.org>
> 
> Most tracepoints in the kernel are created with TRACE_EVENT(). The
> TRACE_EVENT() macro (and DECLARE_EVENT_CLASS() and DEFINE_EVENT() where in
> reality, TRACE_EVENT() is just a helper macro that calls those other two
> macros), will create not only a tracepoint (the function trace_<event>()
> used in the kernel), it also exposes the tracepoint to user space along
> with defining what fields will be saved by that tracepoint.
> 
> There are a few places that tracepoints are created in the kernel that are
> not exposed to userspace via tracefs. They can only be accessed from code
> within the kernel. These tracepoints are created with DEFINE_TRACE()
> 
> Most of these tracepoints end with "_tp". This is useful as when the
> developer sees that, they know that the tracepoint is for in-kernel only
> and is not exposed to user space.
> 
> Instead of making this only a process to add "_tp", enforce it by making
> the DECLARE_TRACE() append the "_tp" suffix to the tracepoint. This
> requires adding DECLARE_TRACE_EVENT() macros for the TRACE_EVENT() macro
> to use that keeps the original name.
> 
> Link: https://lore.kernel.org/all/20250418083351.20a60e64@gandalf.local.home/
> 
> Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
> ---
>  include/linux/tracepoint.h   | 38 ++++++++++++++++++++++++------------
>  include/trace/bpf_probe.h    |  4 ++--
>  include/trace/define_trace.h | 17 +++++++++++++++-
>  include/trace/events/sched.h | 30 ++++++++++++++--------------
>  include/trace/events/tcp.h   |  2 +-
>  5 files changed, 60 insertions(+), 31 deletions(-)
> 
> diff --git a/include/linux/tracepoint.h b/include/linux/tracepoint.h
> index a351763e6965..826ce3f8e1f8 100644
> --- a/include/linux/tracepoint.h
> +++ b/include/linux/tracepoint.h
> @@ -464,16 +464,30 @@ static inline struct tracepoint *tracepoint_ptr_deref(tracepoint_ptr_t *p)
>  #endif
>  
>  #define DECLARE_TRACE(name, proto, args)				\
> -	__DECLARE_TRACE(name, PARAMS(proto), PARAMS(args),		\
> +	__DECLARE_TRACE(name##_tp, PARAMS(proto), PARAMS(args),		\
>  			cpu_online(raw_smp_processor_id()),		\
>  			PARAMS(void *__data, proto))
>  
>  #define DECLARE_TRACE_CONDITION(name, proto, args, cond)		\
> -	__DECLARE_TRACE(name, PARAMS(proto), PARAMS(args),		\
> +	__DECLARE_TRACE(name##_tp, PARAMS(proto), PARAMS(args),		\
>  			cpu_online(raw_smp_processor_id()) && (PARAMS(cond)), \
>  			PARAMS(void *__data, proto))
>  
>  #define DECLARE_TRACE_SYSCALL(name, proto, args)			\
> +	__DECLARE_TRACE_SYSCALL(name##_tp, PARAMS(proto), PARAMS(args),	\
> +				PARAMS(void *__data, proto))
> +
> +#define DECLARE_TRACE_EVENT(name, proto, args)				\
> +	__DECLARE_TRACE(name, PARAMS(proto), PARAMS(args),		\
> +			cpu_online(raw_smp_processor_id()),		\
> +			PARAMS(void *__data, proto))
> +
> +#define DECLARE_TRACE_EVENT_CONDITION(name, proto, args, cond)		\
> +	__DECLARE_TRACE(name, PARAMS(proto), PARAMS(args),		\
> +			cpu_online(raw_smp_processor_id()) && (PARAMS(cond)), \
> +			PARAMS(void *__data, proto))
> +
> +#define DECLARE_TRACE_EVENT_SYSCALL(name, proto, args)			\
>  	__DECLARE_TRACE_SYSCALL(name, PARAMS(proto), PARAMS(args),	\
>  				PARAMS(void *__data, proto))
>  
> @@ -591,32 +605,32 @@ static inline struct tracepoint *tracepoint_ptr_deref(tracepoint_ptr_t *p)
>  
>  #define DECLARE_EVENT_CLASS(name, proto, args, tstruct, assign, print)
>  #define DEFINE_EVENT(template, name, proto, args)		\
> -	DECLARE_TRACE(name, PARAMS(proto), PARAMS(args))
> +	DECLARE_TRACE_EVENT(name, PARAMS(proto), PARAMS(args))
>  #define DEFINE_EVENT_FN(template, name, proto, args, reg, unreg)\
> -	DECLARE_TRACE(name, PARAMS(proto), PARAMS(args))
> +	DECLARE_TRACE_EVENT(name, PARAMS(proto), PARAMS(args))
>  #define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\
> -	DECLARE_TRACE(name, PARAMS(proto), PARAMS(args))
> +	DECLARE_TRACE_EVENT(name, PARAMS(proto), PARAMS(args))
>  #define DEFINE_EVENT_CONDITION(template, name, proto,		\
>  			       args, cond)			\
> -	DECLARE_TRACE_CONDITION(name, PARAMS(proto),		\
> +	DECLARE_TRACE_EVENT_CONDITION(name, PARAMS(proto),	\
>  				PARAMS(args), PARAMS(cond))
>  
>  #define TRACE_EVENT(name, proto, args, struct, assign, print)	\
> -	DECLARE_TRACE(name, PARAMS(proto), PARAMS(args))
> +	DECLARE_TRACE_EVENT(name, PARAMS(proto), PARAMS(args))
>  #define TRACE_EVENT_FN(name, proto, args, struct,		\
>  		assign, print, reg, unreg)			\
> -	DECLARE_TRACE(name, PARAMS(proto), PARAMS(args))
> -#define TRACE_EVENT_FN_COND(name, proto, args, cond, struct,		\
> +	DECLARE_TRACE_EVENT(name, PARAMS(proto), PARAMS(args))
> +#define TRACE_EVENT_FN_COND(name, proto, args, cond, struct,	\
>  		assign, print, reg, unreg)			\
> -	DECLARE_TRACE_CONDITION(name, PARAMS(proto),	\
> +	DECLARE_TRACE_EVENT_CONDITION(name, PARAMS(proto),	\
>  			PARAMS(args), PARAMS(cond))
>  #define TRACE_EVENT_CONDITION(name, proto, args, cond,		\
>  			      struct, assign, print)		\
> -	DECLARE_TRACE_CONDITION(name, PARAMS(proto),		\
> +	DECLARE_TRACE_EVENT_CONDITION(name, PARAMS(proto),	\
>  				PARAMS(args), PARAMS(cond))
>  #define TRACE_EVENT_SYSCALL(name, proto, args, struct, assign,	\
>  			    print, reg, unreg)			\
> -	DECLARE_TRACE_SYSCALL(name, PARAMS(proto), PARAMS(args))
> +	DECLARE_TRACE_EVENT_SYSCALL(name, PARAMS(proto), PARAMS(args))
>  
>  #define TRACE_EVENT_FLAGS(event, flag)
>  
> diff --git a/include/trace/bpf_probe.h b/include/trace/bpf_probe.h
> index 183fa2aa2935..fbfe83b939ac 100644
> --- a/include/trace/bpf_probe.h
> +++ b/include/trace/bpf_probe.h
> @@ -119,8 +119,8 @@ static inline void bpf_test_buffer_##call(void)				\
>  
>  #undef DECLARE_TRACE
>  #define DECLARE_TRACE(call, proto, args)				\
> -	__BPF_DECLARE_TRACE(call, PARAMS(proto), PARAMS(args))		\
> -	__DEFINE_EVENT(call, call, PARAMS(proto), PARAMS(args), 0)
> +	__BPF_DECLARE_TRACE(call##_tp, PARAMS(proto), PARAMS(args))		\
> +	__DEFINE_EVENT(call##_tp, call##_tp, PARAMS(proto), PARAMS(args), 0)
>  
>  #undef DECLARE_TRACE_WRITABLE
>  #define DECLARE_TRACE_WRITABLE(call, proto, args, size) \

hi,
do we need the change also for DECLARE_TRACE_WRITABLE?
I needed change below for bpf selftest kmod

jirka


---
diff --git a/include/trace/bpf_probe.h b/include/trace/bpf_probe.h
index fbfe83b939ac..9391d54d3f12 100644
--- a/include/trace/bpf_probe.h
+++ b/include/trace/bpf_probe.h
@@ -125,8 +125,8 @@ static inline void bpf_test_buffer_##call(void)				\
 #undef DECLARE_TRACE_WRITABLE
 #define DECLARE_TRACE_WRITABLE(call, proto, args, size) \
 	__CHECK_WRITABLE_BUF_SIZE(call, PARAMS(proto), PARAMS(args), size) \
-	__BPF_DECLARE_TRACE(call, PARAMS(proto), PARAMS(args)) \
-	__DEFINE_EVENT(call, call, PARAMS(proto), PARAMS(args), size)
+	__BPF_DECLARE_TRACE(call##_tp, PARAMS(proto), PARAMS(args)) \
+	__DEFINE_EVENT(call##_tp, call##_tp, PARAMS(proto), PARAMS(args), size)
 
 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
 
diff --git a/tools/testing/selftests/bpf/test_kmods/bpf_testmod-events.h b/tools/testing/selftests/bpf/test_kmods/bpf_testmod-events.h
index aeef86b3da74..2bac14ef507f 100644
--- a/tools/testing/selftests/bpf/test_kmods/bpf_testmod-events.h
+++ b/tools/testing/selftests/bpf/test_kmods/bpf_testmod-events.h
@@ -42,7 +42,7 @@ DECLARE_TRACE(bpf_testmod_test_nullable_bare,
 
 struct sk_buff;
 
-DECLARE_TRACE(bpf_testmod_test_raw_tp_null,
+DECLARE_TRACE(bpf_testmod_test_raw_null,
 	TP_PROTO(struct sk_buff *skb),
 	TP_ARGS(skb)
 );
diff --git a/tools/testing/selftests/bpf/test_kmods/bpf_testmod.c b/tools/testing/selftests/bpf/test_kmods/bpf_testmod.c
index f38eaf0d35ef..dd9b806d255e 100644
--- a/tools/testing/selftests/bpf/test_kmods/bpf_testmod.c
+++ b/tools/testing/selftests/bpf/test_kmods/bpf_testmod.c
@@ -413,7 +413,7 @@ bpf_testmod_test_read(struct file *file, struct kobject *kobj,
 
 	(void)bpf_testmod_test_arg_ptr_to_struct(&struct_arg1_2);
 
-	(void)trace_bpf_testmod_test_raw_tp_null(NULL);
+	(void)trace_bpf_testmod_test_raw_null_tp(NULL);
 
 	bpf_testmod_test_struct_ops3();
 
@@ -431,14 +431,14 @@ bpf_testmod_test_read(struct file *file, struct kobject *kobj,
 	if (bpf_testmod_loop_test(101) > 100)
 		trace_bpf_testmod_test_read(current, &ctx);
 
-	trace_bpf_testmod_test_nullable_bare(NULL);
+	trace_bpf_testmod_test_nullable_bare_tp(NULL);
 
 	/* Magic number to enable writable tp */
 	if (len == 64) {
 		struct bpf_testmod_test_writable_ctx writable = {
 			.val = 1024,
 		};
-		trace_bpf_testmod_test_writable_bare(&writable);
+		trace_bpf_testmod_test_writable_bare_tp(&writable);
 		if (writable.early_ret)
 			return snprintf(buf, len, "%d\n", writable.val);
 	}
@@ -470,7 +470,7 @@ bpf_testmod_test_write(struct file *file, struct kobject *kobj,
 		.len = len,
 	};
 
-	trace_bpf_testmod_test_write_bare(current, &ctx);
+	trace_bpf_testmod_test_write_bare_tp(current, &ctx);
 
 	return -EIO; /* always fail */
 }

next prev parent reply	other threads:[~2025-04-21 12:44 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-04-18 15:01 [RFC][PATCH] tracepoint: Have tracepoints created with DECLARE_TRACE() have _tp suffix Steven Rostedt
2025-04-21 12:44 ` Jiri Olsa [this message]
2025-04-21 13:58   ` Steven Rostedt
2025-04-21 14:53     ` Mathieu Desnoyers
2025-04-23 18:21 ` Andrii Nakryiko
2025-04-23 18:53   ` Steven Rostedt
2025-04-23 21:21     ` Andrii Nakryiko
2025-04-23 21:27       ` Steven Rostedt

find likely ancestor, descendant, or conflicting patches for this message:
( dfblob:fbfe83b939a dfblob:9391d54d3f1 dfblob:aeef86b3da7
dfblob:2bac14ef507 dfblob:f38eaf0d35e dfblob:dd9b806d255 )
 OR (
bs:"Re: [RFC][PATCH] tracepoint: Have tracepoints created with DECLARE_TRACE() have _tp suffix" )
	(help)

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=aAY9pcvYHkYKFwZ5@krava \
    --to=olsajiri@gmail.com \
    --cc=alexei.starovoitov@gmail.com \
    --cc=andrii.nakryiko@gmail.com \
    --cc=bpf@vger.kernel.org \
    --cc=dsahern@kernel.org \
    --cc=gmonaco@redhat.com \
    --cc=juri.lelli@gmail.com \
    --cc=leitao@debian.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-trace-kernel@vger.kernel.org \
    --cc=mathieu.desnoyers@efficios.com \
    --cc=mhiramat@kernel.org \
    --cc=netdev@vger.kernel.org \
    --cc=peterz@infradead.org \
    --cc=rostedt@goodmis.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Be sure your reply has a Subject: header at the top and a blank line before the message body.

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox