xref: /OK3568_Linux_fs/kernel/include/trace/define_trace.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Trace files that want to automate creation of all tracepoints defined
4*4882a593Smuzhiyun  * in their file should include this file. The following are macros that the
5*4882a593Smuzhiyun  * trace file may define:
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  * TRACE_SYSTEM defines the system the tracepoint is for
8*4882a593Smuzhiyun  *
9*4882a593Smuzhiyun  * TRACE_INCLUDE_FILE if the file name is something other than TRACE_SYSTEM.h
10*4882a593Smuzhiyun  *     This macro may be defined to tell define_trace.h what file to include.
11*4882a593Smuzhiyun  *     Note, leave off the ".h".
12*4882a593Smuzhiyun  *
13*4882a593Smuzhiyun  * TRACE_INCLUDE_PATH if the path is something other than core kernel include/trace
14*4882a593Smuzhiyun  *     then this macro can define the path to use. Note, the path is relative to
15*4882a593Smuzhiyun  *     define_trace.h, not the file including it. Full path names for out of tree
16*4882a593Smuzhiyun  *     modules must be used.
17*4882a593Smuzhiyun  */
18*4882a593Smuzhiyun 
19*4882a593Smuzhiyun #ifdef CREATE_TRACE_POINTS
20*4882a593Smuzhiyun 
21*4882a593Smuzhiyun /* Prevent recursion */
22*4882a593Smuzhiyun #undef CREATE_TRACE_POINTS
23*4882a593Smuzhiyun 
24*4882a593Smuzhiyun #include <linux/stringify.h>
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun #undef TRACE_EVENT
27*4882a593Smuzhiyun #define TRACE_EVENT(name, proto, args, tstruct, assign, print)	\
28*4882a593Smuzhiyun 	DEFINE_TRACE(name, PARAMS(proto), PARAMS(args))
29*4882a593Smuzhiyun 
30*4882a593Smuzhiyun #undef TRACE_EVENT_CONDITION
31*4882a593Smuzhiyun #define TRACE_EVENT_CONDITION(name, proto, args, cond, tstruct, assign, print) \
32*4882a593Smuzhiyun 	TRACE_EVENT(name,						\
33*4882a593Smuzhiyun 		PARAMS(proto),						\
34*4882a593Smuzhiyun 		PARAMS(args),						\
35*4882a593Smuzhiyun 		PARAMS(tstruct),					\
36*4882a593Smuzhiyun 		PARAMS(assign),						\
37*4882a593Smuzhiyun 		PARAMS(print))
38*4882a593Smuzhiyun 
39*4882a593Smuzhiyun #undef TRACE_EVENT_FN
40*4882a593Smuzhiyun #define TRACE_EVENT_FN(name, proto, args, tstruct,		\
41*4882a593Smuzhiyun 		assign, print, reg, unreg)			\
42*4882a593Smuzhiyun 	DEFINE_TRACE_FN(name, reg, unreg, PARAMS(proto), PARAMS(args))
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun #undef TRACE_EVENT_FN_COND
45*4882a593Smuzhiyun #define TRACE_EVENT_FN_COND(name, proto, args, cond, tstruct,		\
46*4882a593Smuzhiyun 		assign, print, reg, unreg)			\
47*4882a593Smuzhiyun 	DEFINE_TRACE_FN(name, reg, unreg, PARAMS(proto), PARAMS(args))
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun #undef TRACE_EVENT_NOP
50*4882a593Smuzhiyun #define TRACE_EVENT_NOP(name, proto, args, struct, assign, print)
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun #undef DEFINE_EVENT_NOP
53*4882a593Smuzhiyun #define DEFINE_EVENT_NOP(template, name, proto, args)
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun #undef DEFINE_EVENT
56*4882a593Smuzhiyun #define DEFINE_EVENT(template, name, proto, args) \
57*4882a593Smuzhiyun 	DEFINE_TRACE(name, PARAMS(proto), PARAMS(args))
58*4882a593Smuzhiyun 
59*4882a593Smuzhiyun #undef DEFINE_EVENT_FN
60*4882a593Smuzhiyun #define DEFINE_EVENT_FN(template, name, proto, args, reg, unreg) \
61*4882a593Smuzhiyun 	DEFINE_TRACE_FN(name, reg, unreg, PARAMS(proto), PARAMS(args))
62*4882a593Smuzhiyun 
63*4882a593Smuzhiyun #undef DEFINE_EVENT_PRINT
64*4882a593Smuzhiyun #define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\
65*4882a593Smuzhiyun 	DEFINE_TRACE(name, PARAMS(proto), PARAMS(args))
66*4882a593Smuzhiyun 
67*4882a593Smuzhiyun #undef DEFINE_EVENT_CONDITION
68*4882a593Smuzhiyun #define DEFINE_EVENT_CONDITION(template, name, proto, args, cond) \
69*4882a593Smuzhiyun 	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
70*4882a593Smuzhiyun 
71*4882a593Smuzhiyun #undef DECLARE_TRACE
72*4882a593Smuzhiyun #define DECLARE_TRACE(name, proto, args)	\
73*4882a593Smuzhiyun 	DEFINE_TRACE(name, PARAMS(proto), PARAMS(args))
74*4882a593Smuzhiyun 
75*4882a593Smuzhiyun #undef TRACE_INCLUDE
76*4882a593Smuzhiyun #undef __TRACE_INCLUDE
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun #ifndef TRACE_INCLUDE_FILE
79*4882a593Smuzhiyun # define TRACE_INCLUDE_FILE TRACE_SYSTEM
80*4882a593Smuzhiyun # define UNDEF_TRACE_INCLUDE_FILE
81*4882a593Smuzhiyun #endif
82*4882a593Smuzhiyun 
83*4882a593Smuzhiyun #ifndef TRACE_INCLUDE_PATH
84*4882a593Smuzhiyun # define __TRACE_INCLUDE(system) <trace/events/system.h>
85*4882a593Smuzhiyun # define UNDEF_TRACE_INCLUDE_PATH
86*4882a593Smuzhiyun #else
87*4882a593Smuzhiyun # define __TRACE_INCLUDE(system) __stringify(TRACE_INCLUDE_PATH/system.h)
88*4882a593Smuzhiyun #endif
89*4882a593Smuzhiyun 
90*4882a593Smuzhiyun # define TRACE_INCLUDE(system) __TRACE_INCLUDE(system)
91*4882a593Smuzhiyun 
92*4882a593Smuzhiyun /* Let the trace headers be reread */
93*4882a593Smuzhiyun #define TRACE_HEADER_MULTI_READ
94*4882a593Smuzhiyun 
95*4882a593Smuzhiyun #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
96*4882a593Smuzhiyun 
97*4882a593Smuzhiyun /* Make all open coded DECLARE_TRACE nops */
98*4882a593Smuzhiyun #undef DECLARE_TRACE
99*4882a593Smuzhiyun #define DECLARE_TRACE(name, proto, args)
100*4882a593Smuzhiyun 
101*4882a593Smuzhiyun #ifdef TRACEPOINTS_ENABLED
102*4882a593Smuzhiyun #include <trace/trace_events.h>
103*4882a593Smuzhiyun #include <trace/perf.h>
104*4882a593Smuzhiyun #include <trace/bpf_probe.h>
105*4882a593Smuzhiyun #endif
106*4882a593Smuzhiyun 
107*4882a593Smuzhiyun #undef TRACE_EVENT
108*4882a593Smuzhiyun #undef TRACE_EVENT_FN
109*4882a593Smuzhiyun #undef TRACE_EVENT_FN_COND
110*4882a593Smuzhiyun #undef TRACE_EVENT_CONDITION
111*4882a593Smuzhiyun #undef TRACE_EVENT_NOP
112*4882a593Smuzhiyun #undef DEFINE_EVENT_NOP
113*4882a593Smuzhiyun #undef DECLARE_EVENT_CLASS
114*4882a593Smuzhiyun #undef DEFINE_EVENT
115*4882a593Smuzhiyun #undef DEFINE_EVENT_FN
116*4882a593Smuzhiyun #undef DEFINE_EVENT_PRINT
117*4882a593Smuzhiyun #undef DEFINE_EVENT_CONDITION
118*4882a593Smuzhiyun #undef TRACE_HEADER_MULTI_READ
119*4882a593Smuzhiyun #undef DECLARE_TRACE
120*4882a593Smuzhiyun 
121*4882a593Smuzhiyun /* Only undef what we defined in this file */
122*4882a593Smuzhiyun #ifdef UNDEF_TRACE_INCLUDE_FILE
123*4882a593Smuzhiyun # undef TRACE_INCLUDE_FILE
124*4882a593Smuzhiyun # undef UNDEF_TRACE_INCLUDE_FILE
125*4882a593Smuzhiyun #endif
126*4882a593Smuzhiyun 
127*4882a593Smuzhiyun #ifdef UNDEF_TRACE_INCLUDE_PATH
128*4882a593Smuzhiyun # undef TRACE_INCLUDE_PATH
129*4882a593Smuzhiyun # undef UNDEF_TRACE_INCLUDE_PATH
130*4882a593Smuzhiyun #endif
131*4882a593Smuzhiyun 
132*4882a593Smuzhiyun /* We may be processing more files */
133*4882a593Smuzhiyun #define CREATE_TRACE_POINTS
134*4882a593Smuzhiyun 
135*4882a593Smuzhiyun #endif /* CREATE_TRACE_POINTS */
136