Commit a8d154b0 authored by Steven Rostedt's avatar Steven Rostedt Committed by Steven Rostedt
Browse files

tracing: create automated trace defines 



This patch lowers the number of places a developer must modify to add
new tracepoints. The current method to add a new tracepoint
into an existing system is to write the trace point macro in the
trace header with one of the macros TRACE_EVENT, TRACE_FORMAT or
DECLARE_TRACE, then they must add the same named item into the C file
with the macro DEFINE_TRACE(name) and then add the trace point.

This change cuts out the needing to add the DEFINE_TRACE(name).
Every file that uses the tracepoint must still include the trace/<type>.h
file, but the one C file must also add a define before the including
of that file.

 #define CREATE_TRACE_POINTS
 #include <trace/mytrace.h>

This will cause the trace/mytrace.h file to also produce the C code
necessary to implement the trace point.

Note, if more than one trace/<type>.h is used to create the C code
it is best to list them all together.

 #define CREATE_TRACE_POINTS
 #include <trace/foo.h>
 #include <trace/bar.h>
 #include <trace/fido.h>

Thanks to Mathieu Desnoyers and Christoph Hellwig for coming up with
the cleaner solution of the define above the includes over my first
design to have the C code include a "special" header.

This patch converts sched, irq and lockdep and skb to use this new
method.

Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Neil Horman <nhorman@tuxdriver.com>
Cc: Zhao Lei <zhaolei@cn.fujitsu.com>
Cc: Eduard - Gabriel Munteanu <eduard.munteanu@linux360.ro>
Cc: Pekka Enberg <penberg@cs.helsinki.fi>
Signed-off-by: default avatarSteven Rostedt <rostedt@goodmis.org>
parent ea20d929

include/trace/define_trace.h

0 → 100644
+75 −0
Original line number Diff line number Diff line 
/*

 * Trace files that want to automate creationg of all tracepoints defined

 * in their file should include this file. The following are macros that the

 * trace file may define:

 *

 * TRACE_SYSTEM defines the system the tracepoint is for

 *

 * TRACE_INCLUDE_FILE if the file name is something other than TRACE_SYSTEM.h

 *     This macro may be defined to tell define_trace.h what file to include.

 *     Note, leave off the ".h".

 *

 * TRACE_INCLUDE_PATH if the path is something other than core kernel include/trace

 *     then this macro can define the path to use. Note, the path is relative to

 *     define_trace.h, not the file including it. Full path names for out of tree

 *     modules must be used.

 */



#ifdef CREATE_TRACE_POINTS



/* Prevent recursion */

#undef CREATE_TRACE_POINTS



#include <linux/stringify.h>



#undef TRACE_EVENT

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

	DEFINE_TRACE(name)



#undef TRACE_FORMAT

#define TRACE_FORMAT(name, proto, args, print)	\

	DEFINE_TRACE(name)



#undef DECLARE_TRACE

#define DECLARE_TRACE(name, proto, args)	\

	DEFINE_TRACE(name)



#undef TRACE_INCLUDE

#undef __TRACE_INCLUDE



#ifndef TRACE_INCLUDE_FILE

# define TRACE_INCLUDE_FILE TRACE_SYSTEM

# define UNDEF_TRACE_INCLUDE_FILE

#endif



#ifndef TRACE_INCLUDE_PATH

# define __TRACE_INCLUDE(system) <trace/system.h>

# define UNDEF_TRACE_INCLUDE_FILE

#else

# define __TRACE_INCLUDE(system) __stringify(TRACE_INCLUDE_PATH/system.h)

#endif



# define TRACE_INCLUDE(system) __TRACE_INCLUDE(system)



/* Let the trace headers be reread */

#define TRACE_HEADER_MULTI_READ



#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)



#undef TRACE_HEADER_MULTI_READ



/* Only undef what we defined in this file */

#ifdef UNDEF_TRACE_INCLUDE_FILE

# undef TRACE_INCLUDE_PATH

# undef UNDEF_TRACE_INCLUDE_FILE

#endif



#ifdef UNDEF_TRACE_INCLUDE_FILE

# undef TRACE_INCLUDE_PATH

# undef UNDEF_TRACE_INCLUDE_FILE

#endif



/* We may be processing more files */

#define CREATE_TRACE_POINTS



#endif /* CREATE_TRACE_POINTS */

include/trace/irq.h

+4 −1
Original line number Diff line number Diff line
@@ -51,4 +51,7 @@ TRACE_FORMAT(softirq_exit, 
	TP_FMT("softirq=%d action=%s", (int)(h - vec), softirq_to_name[h-vec])

	);



#endif
 
#endif /*  _TRACE_IRQ_H */



/* This part must be outside protection */

#include <trace/define_trace.h>

include/trace/kmem.h

+3 −1
Original line number Diff line number Diff line
@@ -188,5 +188,7 @@ TRACE_EVENT(kmem_cache_free, 


	TP_printk("call_site=%lx ptr=%p", __entry->call_site, __entry->ptr)

);

#endif /* _TRACE_KMEM_H */



#endif
 
/* This part must be outside protection */

#include <trace/define_trace.h>

include/trace/lockdep.h

+3 −0
Original line number Diff line number Diff line
@@ -55,3 +55,6 @@ TRACE_EVENT(lock_acquired, 
#endif



#endif /* _TRACE_LOCKDEP_H */



/* This part must be outside protection */

#include <trace/define_trace.h>

include/trace/sched.h

+3 −0
Original line number Diff line number Diff line
@@ -334,3 +334,6 @@ TRACE_EVENT(sched_signal_send, 
);



#endif /* _TRACE_SCHED_H */



/* This part must be outside protection */

#include <trace/define_trace.h>

CRA Git | Maintained and supported by SUSTech CRA and CCSE