Commit 091ad365 authored by Ingo Molnar's avatar Ingo Molnar
Browse files

events: Rename TRACE_EVENT_TEMPLATE() to DECLARE_EVENT_CLASS() 



It is not quite obvious at first sight what TRACE_EVENT_TEMPLATE
does: does it define an event as well beyond defining a template?

To clarify this, rename it to DECLARE_EVENT_CLASS, which follows
the various 'DECLARE_*()' idioms we already have in the kernel:

  DECLARE_EVENT_CLASS(class)

    DEFINE_EVENT(class, event1)
    DEFINE_EVENT(class, event2)
    DEFINE_EVENT(class, event3)

To complete this logic we should also rename TRACE_EVENT() to:

  DEFINE_SINGLE_EVENT(single_event)

... but in a more quiet moment of the kernel cycle.

Cc: Pekka Enberg <penberg@cs.helsinki.fi>
Cc: Steven Rostedt <rostedt@goodmis.org>
Cc: Frederic Weisbecker <fweisbec@gmail.com>
LKML-Reference: <4B0E286A.2000405@cn.fujitsu.com>
Signed-off-by: default avatarIngo Molnar <mingo@elte.hu>
parent 28b4e0d8

include/linux/tracepoint.h

+1 −1
Original line number Diff line number Diff line
@@ -280,7 +280,7 @@ static inline void tracepoint_synchronize_unregister(void) 
 * TRACE_EVENT_FN to perform any (un)registration work.

 */



#define TRACE_EVENT_TEMPLATE(name, proto, args, tstruct, assign, print)

#define DECLARE_EVENT_CLASS(name, proto, args, tstruct, assign, print)

#define DEFINE_EVENT(template, name, proto, args)		\

	DECLARE_TRACE(name, PARAMS(proto), PARAMS(args))

#define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\

include/trace/define_trace.h

+1 −1
Original line number Diff line number Diff line
@@ -71,7 +71,7 @@ 


#undef TRACE_EVENT

#undef TRACE_EVENT_FN

#undef TRACE_EVENT_TEMPLATE

#undef DECLARE_EVENT_CLASS

#undef DEFINE_EVENT

#undef DEFINE_EVENT_PRINT

#undef TRACE_HEADER_MULTI_READ

include/trace/events/sched.h

+3 −3
Original line number Diff line number Diff line
@@ -83,7 +83,7 @@ TRACE_EVENT(sched_wait_task, 
 * (NOTE: the 'rq' argument is not used by generic trace events,

 *        but used by the latency tracer plugin. )

 */

TRACE_EVENT_TEMPLATE(sched_wakeup_template,

DECLARE_EVENT_CLASS(sched_wakeup_template,



	TP_PROTO(struct rq *rq, struct task_struct *p, int success),
@@ -197,7 +197,7 @@ TRACE_EVENT(sched_migrate_task, 
		  __entry->orig_cpu, __entry->dest_cpu)

);



TRACE_EVENT_TEMPLATE(sched_process_template,

DECLARE_EVENT_CLASS(sched_process_template,



	TP_PROTO(struct task_struct *p),
@@ -316,7 +316,7 @@ TRACE_EVENT(sched_signal_send, 
 * XXX the below sched_stat tracepoints only apply to SCHED_OTHER/BATCH/IDLE

 *     adding sched_stat support to SCHED_FIFO/RR would be welcome.

 */

TRACE_EVENT_TEMPLATE(sched_stat_template,

DECLARE_EVENT_CLASS(sched_stat_template,



	TP_PROTO(struct task_struct *tsk, u64 delay),

include/trace/ftrace.h

+23 −23
Original line number Diff line number Diff line
@@ -19,17 +19,17 @@ 
#include <linux/ftrace_event.h>



/*

 * TRACE_EVENT_TEMPLATE can be used to add a generic function

 * DECLARE_EVENT_CLASS can be used to add a generic function

 * handlers for events. That is, if all events have the same

 * parameters and just have distinct trace points.

 * Each tracepoint can be defined with DEFINE_EVENT and that

 * will map the TRACE_EVENT_TEMPLATE to the tracepoint.

 * will map the DECLARE_EVENT_CLASS to the tracepoint.

 *

 * TRACE_EVENT is a one to one mapping between tracepoint and template.

 */

#undef TRACE_EVENT

#define TRACE_EVENT(name, proto, args, tstruct, assign, print) \

	TRACE_EVENT_TEMPLATE(name,			       \

	DECLARE_EVENT_CLASS(name,			       \

			     PARAMS(proto),		       \

			     PARAMS(args),		       \

			     PARAMS(tstruct),		       \
@@ -56,8 +56,8 @@ 
#undef TP_STRUCT__entry

#define TP_STRUCT__entry(args...) args



#undef TRACE_EVENT_TEMPLATE

#define TRACE_EVENT_TEMPLATE(name, proto, args, tstruct, assign, print)	\

#undef DECLARE_EVENT_CLASS

#define DECLARE_EVENT_CLASS(name, proto, args, tstruct, assign, print)	\

	struct ftrace_raw_##name {					\

		struct trace_entry	ent;				\

		tstruct							\
@@ -115,8 +115,8 @@ 
#undef __string

#define __string(item, src) __dynamic_array(char, item, -1)



#undef TRACE_EVENT_TEMPLATE

#define TRACE_EVENT_TEMPLATE(call, proto, args, tstruct, assign, print)	\

#undef DECLARE_EVENT_CLASS

#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\

	struct ftrace_data_offsets_##call {				\

		tstruct;						\

	};
@@ -203,8 +203,8 @@ 
#undef TP_perf_assign

#define TP_perf_assign(args...)



#undef TRACE_EVENT_TEMPLATE

#define TRACE_EVENT_TEMPLATE(call, proto, args, tstruct, func, print)	\

#undef DECLARE_EVENT_CLASS

#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, func, print)	\

static int								\

ftrace_format_setup_##call(struct ftrace_event_call *unused,		\

			   struct trace_seq *s)				\
@@ -321,8 +321,8 @@ ftrace_format_##name(struct ftrace_event_call *unused, \ 
		ftrace_print_symbols_seq(p, value, symbols);		\

	})



#undef TRACE_EVENT_TEMPLATE

#define TRACE_EVENT_TEMPLATE(call, proto, args, tstruct, assign, print)	\

#undef DECLARE_EVENT_CLASS

#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\

static enum print_line_t						\

ftrace_raw_output_id_##call(int event_id, const char *name,		\

			    struct trace_iterator *iter, int flags)	\
@@ -428,8 +428,8 @@ ftrace_raw_output_##call(struct trace_iterator *iter, int flags) \ 
#undef __string

#define __string(item, src) __dynamic_array(char, item, -1)



#undef TRACE_EVENT_TEMPLATE

#define TRACE_EVENT_TEMPLATE(call, proto, args, tstruct, func, print)	\

#undef DECLARE_EVENT_CLASS

#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, func, print)	\

static int								\

ftrace_define_fields_##call(struct ftrace_event_call *event_call)	\

{									\
@@ -480,8 +480,8 @@ ftrace_define_fields_##call(struct ftrace_event_call *event_call) \ 
#undef __string

#define __string(item, src) __dynamic_array(char, item, strlen(src) + 1)



#undef TRACE_EVENT_TEMPLATE

#define TRACE_EVENT_TEMPLATE(call, proto, args, tstruct, assign, print)	\

#undef DECLARE_EVENT_CLASS

#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\

static inline int ftrace_get_offsets_##call(				\

	struct ftrace_data_offsets_##call *__data_offsets, proto)       \

{									\
@@ -521,8 +521,8 @@ static inline int ftrace_get_offsets_##call( \ 
 *

 */



#undef TRACE_EVENT_TEMPLATE

#define TRACE_EVENT_TEMPLATE(call, proto, args, tstruct, assign, print)

#undef DECLARE_EVENT_CLASS

#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)



#undef DEFINE_EVENT

#define DEFINE_EVENT(template, name, proto, args)			\
@@ -681,8 +681,8 @@ static void ftrace_profile_disable_##name(struct ftrace_event_call *unused)\ 
#define __assign_str(dst, src)						\

	strcpy(__get_str(dst), src);



#undef TRACE_EVENT_TEMPLATE

#define TRACE_EVENT_TEMPLATE(call, proto, args, tstruct, assign, print)	\

#undef DECLARE_EVENT_CLASS

#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\

									\

static void ftrace_raw_event_id_##call(struct ftrace_event_call *event_call, \

				       proto)				\
@@ -764,8 +764,8 @@ static int ftrace_raw_init_event_##call(struct ftrace_event_call *unused)\ 


#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)



#undef TRACE_EVENT_TEMPLATE

#define TRACE_EVENT_TEMPLATE(call, proto, args, tstruct, assign, print)

#undef DECLARE_EVENT_CLASS

#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)



#undef DEFINE_EVENT

#define DEFINE_EVENT(template, call, proto, args)			\
@@ -885,8 +885,8 @@ __attribute__((section("_ftrace_events"))) event_##call = { \ 
#undef __perf_count

#define __perf_count(c) __count = (c)



#undef TRACE_EVENT_TEMPLATE

#define TRACE_EVENT_TEMPLATE(call, proto, args, tstruct, assign, print)	\

#undef DECLARE_EVENT_CLASS

#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\

static void								\

ftrace_profile_templ_##call(struct ftrace_event_call *event_call,	\

			    proto)					\

CRA Git | Maintained and supported by SUSTech CRA and CCSE