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