xref: /linux/include/trace/define_trace.h (revision 2e26ca71)
1 /*
2  * Trace files that want to automate creationg of all tracepoints defined
3  * in their file should include this file. The following are macros that the
4  * trace file may define:
5  *
6  * TRACE_SYSTEM defines the system the tracepoint is for
7  *
8  * TRACE_INCLUDE_FILE if the file name is something other than TRACE_SYSTEM.h
9  *     This macro may be defined to tell define_trace.h what file to include.
10  *     Note, leave off the ".h".
11  *
12  * TRACE_INCLUDE_PATH if the path is something other than core kernel include/trace
13  *     then this macro can define the path to use. Note, the path is relative to
14  *     define_trace.h, not the file including it. Full path names for out of tree
15  *     modules must be used.
16  */
17 
18 #ifdef CREATE_TRACE_POINTS
19 
20 /* Prevent recursion */
21 #undef CREATE_TRACE_POINTS
22 
23 #include <linux/stringify.h>
24 
25 #undef TRACE_EVENT
26 #define TRACE_EVENT(name, proto, args, tstruct, assign, print)	\
27 	DEFINE_TRACE(name)
28 
29 #undef TRACE_EVENT_FN
30 #define TRACE_EVENT_FN(name, proto, args, tstruct,		\
31 		assign, print, reg, unreg)			\
32 	DEFINE_TRACE_FN(name, reg, unreg)
33 
34 #undef DEFINE_EVENT
35 #define DEFINE_EVENT(template, name, proto, args) \
36 	DEFINE_TRACE(name)
37 
38 #undef DEFINE_EVENT_PRINT
39 #define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\
40 	DEFINE_TRACE(name)
41 
42 #undef DECLARE_TRACE
43 #define DECLARE_TRACE(name, proto, args)	\
44 	DEFINE_TRACE(name)
45 
46 #undef TRACE_INCLUDE
47 #undef __TRACE_INCLUDE
48 
49 #ifndef TRACE_INCLUDE_FILE
50 # define TRACE_INCLUDE_FILE TRACE_SYSTEM
51 # define UNDEF_TRACE_INCLUDE_FILE
52 #endif
53 
54 #ifndef TRACE_INCLUDE_PATH
55 # define __TRACE_INCLUDE(system) <trace/events/system.h>
56 # define UNDEF_TRACE_INCLUDE_PATH
57 #else
58 # define __TRACE_INCLUDE(system) __stringify(TRACE_INCLUDE_PATH/system.h)
59 #endif
60 
61 # define TRACE_INCLUDE(system) __TRACE_INCLUDE(system)
62 
63 /* Let the trace headers be reread */
64 #define TRACE_HEADER_MULTI_READ
65 
66 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
67 
68 /* Make all open coded DECLARE_TRACE nops */
69 #undef DECLARE_TRACE
70 #define DECLARE_TRACE(name, proto, args)
71 
72 #ifdef CONFIG_EVENT_TRACING
73 #include <trace/ftrace.h>
74 #endif
75 
76 #undef TRACE_EVENT
77 #undef TRACE_EVENT_FN
78 #undef DECLARE_EVENT_CLASS
79 #undef DEFINE_EVENT
80 #undef DEFINE_EVENT_PRINT
81 #undef TRACE_HEADER_MULTI_READ
82 #undef DECLARE_TRACE
83 
84 /* Only undef what we defined in this file */
85 #ifdef UNDEF_TRACE_INCLUDE_FILE
86 # undef TRACE_INCLUDE_FILE
87 # undef UNDEF_TRACE_INCLUDE_FILE
88 #endif
89 
90 #ifdef UNDEF_TRACE_INCLUDE_PATH
91 # undef TRACE_INCLUDE_PATH
92 # undef UNDEF_TRACE_INCLUDE_PATH
93 #endif
94 
95 /* We may be processing more files */
96 #define CREATE_TRACE_POINTS
97 
98 #endif /* CREATE_TRACE_POINTS */
99