KVM: VMX: disable PEBS before a guest entry
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / linux / tracepoint.h
CommitLineData
97e1c18e
MD
1#ifndef _LINUX_TRACEPOINT_H
2#define _LINUX_TRACEPOINT_H
3
4/*
5 * Kernel Tracepoint API.
6 *
8cd09a59 7 * See Documentation/trace/tracepoints.txt.
97e1c18e
MD
8 *
9 * (C) Copyright 2008 Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
10 *
11 * Heavily inspired from the Linux Kernel Markers.
12 *
13 * This file is released under the GPLv2.
14 * See the file COPYING for more details.
15 */
16
c3e07084 17#include <linux/smp.h>
b70e4f05 18#include <linux/errno.h>
97e1c18e 19#include <linux/types.h>
c3e07084
SRRH
20#include <linux/percpu.h>
21#include <linux/cpumask.h>
97e1c18e 22#include <linux/rcupdate.h>
c5905afb 23#include <linux/static_key.h>
97e1c18e
MD
24
25struct module;
26struct tracepoint;
27
38516ab5
SR
28struct tracepoint_func {
29 void *func;
30 void *data;
31};
32
97e1c18e
MD
33struct tracepoint {
34 const char *name; /* Tracepoint name */
c5905afb 35 struct static_key key;
97419875
JS
36 void (*regfunc)(void);
37 void (*unregfunc)(void);
bd1c8b22 38 struct tracepoint_func __rcu *funcs;
65498646 39};
97e1c18e 40
2e26ca71
SR
41/*
42 * Connect a probe to a tracepoint.
43 * Internal API, should not be used directly.
44 */
38516ab5 45extern int tracepoint_probe_register(const char *name, void *probe, void *data);
2e26ca71
SR
46
47/*
48 * Disconnect a probe from a tracepoint.
49 * Internal API, should not be used directly.
50 */
38516ab5
SR
51extern int
52tracepoint_probe_unregister(const char *name, void *probe, void *data);
2e26ca71 53
38516ab5
SR
54extern int tracepoint_probe_register_noupdate(const char *name, void *probe,
55 void *data);
56extern int tracepoint_probe_unregister_noupdate(const char *name, void *probe,
57 void *data);
2e26ca71
SR
58extern void tracepoint_probe_update_all(void);
59
b75ef8b4
MD
60#ifdef CONFIG_MODULES
61struct tp_module {
62 struct list_head list;
63 unsigned int num_tracepoints;
64 struct tracepoint * const *tracepoints_ptrs;
65};
d6a6d1f3
SRRH
66bool trace_module_has_bad_taint(struct module *mod);
67#else
68static inline bool trace_module_has_bad_taint(struct module *mod)
69{
70 return false;
71}
b75ef8b4
MD
72#endif /* CONFIG_MODULES */
73
2e26ca71 74struct tracepoint_iter {
b75ef8b4
MD
75#ifdef CONFIG_MODULES
76 struct tp_module *module;
77#endif /* CONFIG_MODULES */
65498646 78 struct tracepoint * const *tracepoint;
2e26ca71
SR
79};
80
81extern void tracepoint_iter_start(struct tracepoint_iter *iter);
82extern void tracepoint_iter_next(struct tracepoint_iter *iter);
83extern void tracepoint_iter_stop(struct tracepoint_iter *iter);
84extern void tracepoint_iter_reset(struct tracepoint_iter *iter);
2e26ca71
SR
85
86/*
87 * tracepoint_synchronize_unregister must be called between the last tracepoint
88 * probe unregistration and the end of module exit to make sure there is no
89 * caller executing a probe when it is freed.
90 */
91static inline void tracepoint_synchronize_unregister(void)
92{
93 synchronize_sched();
94}
95
96#define PARAMS(args...) args
97
2e26ca71
SR
98#endif /* _LINUX_TRACEPOINT_H */
99
100/*
101 * Note: we keep the TRACE_EVENT and DECLARE_TRACE outside the include
102 * file ifdef protection.
103 * This is due to the way trace events work. If a file includes two
104 * trace event headers under one "CREATE_TRACE_POINTS" the first include
105 * will override the TRACE_EVENT and break the second include.
106 */
107
ea20d929
SR
108#ifndef DECLARE_TRACE
109
2939b046 110#define TP_PROTO(args...) args
8cd09a59 111#define TP_ARGS(args...) args
287050d3 112#define TP_CONDITION(args...) args
97e1c18e
MD
113
114#ifdef CONFIG_TRACEPOINTS
115
116/*
117 * it_func[0] is never NULL because there is at least one element in the array
118 * when the array itself is non NULL.
38516ab5
SR
119 *
120 * Note, the proto and args passed in includes "__data" as the first parameter.
121 * The reason for this is to handle the "void" prototype. If a tracepoint
122 * has a "void" prototype, then it is invalid to declare a function
123 * as "(void *, void)". The DECLARE_TRACE_NOARGS() will pass in just
124 * "void *data", where as the DECLARE_TRACE() will pass in "void *data, proto".
97e1c18e 125 */
2fbb90db 126#define __DO_TRACE(tp, proto, args, cond, prercu, postrcu) \
97e1c18e 127 do { \
38516ab5
SR
128 struct tracepoint_func *it_func_ptr; \
129 void *it_func; \
130 void *__data; \
c3e07084
SRRH
131 \
132 if (!cpu_online(raw_smp_processor_id())) \
133 return; \
97e1c18e 134 \
287050d3
SR
135 if (!(cond)) \
136 return; \
2fbb90db 137 prercu; \
da7b3eab 138 rcu_read_lock_sched_notrace(); \
38516ab5
SR
139 it_func_ptr = rcu_dereference_sched((tp)->funcs); \
140 if (it_func_ptr) { \
97e1c18e 141 do { \
38516ab5
SR
142 it_func = (it_func_ptr)->func; \
143 __data = (it_func_ptr)->data; \
144 ((void(*)(proto))(it_func))(args); \
145 } while ((++it_func_ptr)->func); \
97e1c18e 146 } \
da7b3eab 147 rcu_read_unlock_sched_notrace(); \
2fbb90db 148 postrcu; \
97e1c18e
MD
149 } while (0)
150
7ece55a4
JT
151#ifndef MODULE
152#define __DECLARE_TRACE_RCU(name, proto, args, cond, data_proto, data_args) \
153 static inline void trace_##name##_rcuidle(proto) \
154 { \
155 if (static_key_false(&__tracepoint_##name.key)) \
156 __DO_TRACE(&__tracepoint_##name, \
157 TP_PROTO(data_proto), \
158 TP_ARGS(data_args), \
159 TP_CONDITION(cond), \
d6284099
PM
160 rcu_irq_enter(), \
161 rcu_irq_exit()); \
7ece55a4
JT
162 }
163#else
164#define __DECLARE_TRACE_RCU(name, proto, args, cond, data_proto, data_args)
165#endif
166
97e1c18e
MD
167/*
168 * Make sure the alignment of the structure in the __tracepoints section will
169 * not add unwanted padding between the beginning of the section and the
170 * structure. Force alignment to the same alignment as the section start.
171 */
2fbb90db 172#define __DECLARE_TRACE(name, proto, args, cond, data_proto, data_args) \
7e066fb8 173 extern struct tracepoint __tracepoint_##name; \
97e1c18e
MD
174 static inline void trace_##name(proto) \
175 { \
c5905afb 176 if (static_key_false(&__tracepoint_##name.key)) \
97e1c18e 177 __DO_TRACE(&__tracepoint_##name, \
38516ab5 178 TP_PROTO(data_proto), \
287050d3 179 TP_ARGS(data_args), \
2fbb90db
SR
180 TP_CONDITION(cond),,); \
181 } \
7ece55a4
JT
182 __DECLARE_TRACE_RCU(name, PARAMS(proto), PARAMS(args), \
183 PARAMS(cond), PARAMS(data_proto), PARAMS(data_args)) \
38516ab5
SR
184 static inline int \
185 register_trace_##name(void (*probe)(data_proto), void *data) \
97e1c18e 186 { \
38516ab5
SR
187 return tracepoint_probe_register(#name, (void *)probe, \
188 data); \
97e1c18e 189 } \
38516ab5
SR
190 static inline int \
191 unregister_trace_##name(void (*probe)(data_proto), void *data) \
97e1c18e 192 { \
38516ab5
SR
193 return tracepoint_probe_unregister(#name, (void *)probe, \
194 data); \
53da59aa 195 } \
38516ab5
SR
196 static inline void \
197 check_trace_callback_type_##name(void (*cb)(data_proto)) \
53da59aa 198 { \
97e1c18e
MD
199 }
200
65498646
MD
201/*
202 * We have no guarantee that gcc and the linker won't up-align the tracepoint
203 * structures, so we create an array of pointers that will be used for iteration
204 * on the tracepoints.
205 */
d430d3d7
JB
206#define DEFINE_TRACE_FN(name, reg, unreg) \
207 static const char __tpstrtab_##name[] \
208 __attribute__((section("__tracepoints_strings"))) = #name; \
209 struct tracepoint __tracepoint_##name \
210 __attribute__((section("__tracepoints"))) = \
c5905afb 211 { __tpstrtab_##name, STATIC_KEY_INIT_FALSE, reg, unreg, NULL };\
d430d3d7
JB
212 static struct tracepoint * const __tracepoint_ptr_##name __used \
213 __attribute__((section("__tracepoints_ptrs"))) = \
65498646 214 &__tracepoint_##name;
97419875
JS
215
216#define DEFINE_TRACE(name) \
217 DEFINE_TRACE_FN(name, NULL, NULL);
7e066fb8
MD
218
219#define EXPORT_TRACEPOINT_SYMBOL_GPL(name) \
220 EXPORT_SYMBOL_GPL(__tracepoint_##name)
221#define EXPORT_TRACEPOINT_SYMBOL(name) \
222 EXPORT_SYMBOL(__tracepoint_##name)
223
97e1c18e 224#else /* !CONFIG_TRACEPOINTS */
2fbb90db 225#define __DECLARE_TRACE(name, proto, args, cond, data_proto, data_args) \
97e1c18e
MD
226 static inline void trace_##name(proto) \
227 { } \
2fbb90db
SR
228 static inline void trace_##name##_rcuidle(proto) \
229 { } \
38516ab5
SR
230 static inline int \
231 register_trace_##name(void (*probe)(data_proto), \
232 void *data) \
97e1c18e
MD
233 { \
234 return -ENOSYS; \
235 } \
38516ab5
SR
236 static inline int \
237 unregister_trace_##name(void (*probe)(data_proto), \
238 void *data) \
c420970e
MD
239 { \
240 return -ENOSYS; \
53da59aa 241 } \
38516ab5 242 static inline void check_trace_callback_type_##name(void (*cb)(data_proto)) \
53da59aa 243 { \
c420970e 244 }
97e1c18e 245
97419875 246#define DEFINE_TRACE_FN(name, reg, unreg)
7e066fb8
MD
247#define DEFINE_TRACE(name)
248#define EXPORT_TRACEPOINT_SYMBOL_GPL(name)
249#define EXPORT_TRACEPOINT_SYMBOL(name)
250
97e1c18e 251#endif /* CONFIG_TRACEPOINTS */
38516ab5
SR
252
253/*
254 * The need for the DECLARE_TRACE_NOARGS() is to handle the prototype
255 * (void). "void" is a special value in a function prototype and can
256 * not be combined with other arguments. Since the DECLARE_TRACE()
257 * macro adds a data element at the beginning of the prototype,
258 * we need a way to differentiate "(void *data, proto)" from
259 * "(void *data, void)". The second prototype is invalid.
260 *
261 * DECLARE_TRACE_NOARGS() passes "void" as the tracepoint prototype
262 * and "void *__data" as the callback prototype.
263 *
264 * DECLARE_TRACE() passes "proto" as the tracepoint protoype and
265 * "void *__data, proto" as the callback prototype.
266 */
267#define DECLARE_TRACE_NOARGS(name) \
287050d3 268 __DECLARE_TRACE(name, void, , 1, void *__data, __data)
38516ab5
SR
269
270#define DECLARE_TRACE(name, proto, args) \
287050d3 271 __DECLARE_TRACE(name, PARAMS(proto), PARAMS(args), 1, \
38516ab5
SR
272 PARAMS(void *__data, proto), \
273 PARAMS(__data, args))
274
287050d3
SR
275#define DECLARE_TRACE_CONDITION(name, proto, args, cond) \
276 __DECLARE_TRACE(name, PARAMS(proto), PARAMS(args), PARAMS(cond), \
277 PARAMS(void *__data, proto), \
278 PARAMS(__data, args))
279
1ed0c597
FW
280#define TRACE_EVENT_FLAGS(event, flag)
281
ea20d929 282#endif /* DECLARE_TRACE */
97e1c18e 283
ea20d929 284#ifndef TRACE_EVENT
823f9124
SR
285/*
286 * For use with the TRACE_EVENT macro:
287 *
288 * We define a tracepoint, its arguments, its printk format
289 * and its 'fast binay record' layout.
290 *
291 * Firstly, name your tracepoint via TRACE_EVENT(name : the
292 * 'subsystem_event' notation is fine.
293 *
294 * Think about this whole construct as the
295 * 'trace_sched_switch() function' from now on.
296 *
297 *
298 * TRACE_EVENT(sched_switch,
299 *
300 * *
301 * * A function has a regular function arguments
302 * * prototype, declare it via TP_PROTO():
303 * *
304 *
ef18012b
SR
305 * TP_PROTO(struct rq *rq, struct task_struct *prev,
306 * struct task_struct *next),
823f9124
SR
307 *
308 * *
309 * * Define the call signature of the 'function'.
310 * * (Design sidenote: we use this instead of a
311 * * TP_PROTO1/TP_PROTO2/TP_PROTO3 ugliness.)
312 * *
313 *
ef18012b 314 * TP_ARGS(rq, prev, next),
823f9124
SR
315 *
316 * *
317 * * Fast binary tracing: define the trace record via
318 * * TP_STRUCT__entry(). You can think about it like a
319 * * regular C structure local variable definition.
320 * *
321 * * This is how the trace record is structured and will
322 * * be saved into the ring buffer. These are the fields
323 * * that will be exposed to user-space in
156f5a78 324 * * /sys/kernel/debug/tracing/events/<*>/format.
823f9124
SR
325 * *
326 * * The declared 'local variable' is called '__entry'
327 * *
328 * * __field(pid_t, prev_prid) is equivalent to a standard declariton:
329 * *
330 * * pid_t prev_pid;
331 * *
332 * * __array(char, prev_comm, TASK_COMM_LEN) is equivalent to:
333 * *
334 * * char prev_comm[TASK_COMM_LEN];
335 * *
336 *
337 * TP_STRUCT__entry(
338 * __array( char, prev_comm, TASK_COMM_LEN )
339 * __field( pid_t, prev_pid )
340 * __field( int, prev_prio )
341 * __array( char, next_comm, TASK_COMM_LEN )
342 * __field( pid_t, next_pid )
343 * __field( int, next_prio )
344 * ),
345 *
346 * *
347 * * Assign the entry into the trace record, by embedding
348 * * a full C statement block into TP_fast_assign(). You
349 * * can refer to the trace record as '__entry' -
350 * * otherwise you can put arbitrary C code in here.
351 * *
352 * * Note: this C code will execute every time a trace event
353 * * happens, on an active tracepoint.
354 * *
355 *
ef18012b
SR
356 * TP_fast_assign(
357 * memcpy(__entry->next_comm, next->comm, TASK_COMM_LEN);
358 * __entry->prev_pid = prev->pid;
359 * __entry->prev_prio = prev->prio;
823f9124
SR
360 * memcpy(__entry->prev_comm, prev->comm, TASK_COMM_LEN);
361 * __entry->next_pid = next->pid;
ef18012b 362 * __entry->next_prio = next->prio;
ec6e7c3a 363 * ),
823f9124
SR
364 *
365 * *
366 * * Formatted output of a trace record via TP_printk().
367 * * This is how the tracepoint will appear under ftrace
368 * * plugins that make use of this tracepoint.
369 * *
370 * * (raw-binary tracing wont actually perform this step.)
371 * *
372 *
373 * TP_printk("task %s:%d [%d] ==> %s:%d [%d]",
374 * __entry->prev_comm, __entry->prev_pid, __entry->prev_prio,
375 * __entry->next_comm, __entry->next_pid, __entry->next_prio),
376 *
377 * );
378 *
379 * This macro construct is thus used for the regular printk format
380 * tracing setup, it is used to construct a function pointer based
381 * tracepoint callback (this is used by programmatic plugins and
382 * can also by used by generic instrumentation like SystemTap), and
383 * it is also used to expose a structured trace record in
156f5a78 384 * /sys/kernel/debug/tracing/events/.
97419875
JS
385 *
386 * A set of (un)registration functions can be passed to the variant
387 * TRACE_EVENT_FN to perform any (un)registration work.
823f9124
SR
388 */
389
091ad365 390#define DECLARE_EVENT_CLASS(name, proto, args, tstruct, assign, print)
ff038f5c
SR
391#define DEFINE_EVENT(template, name, proto, args) \
392 DECLARE_TRACE(name, PARAMS(proto), PARAMS(args))
e5bc9721
SR
393#define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
394 DECLARE_TRACE(name, PARAMS(proto), PARAMS(args))
287050d3
SR
395#define DEFINE_EVENT_CONDITION(template, name, proto, \
396 args, cond) \
397 DECLARE_TRACE_CONDITION(name, PARAMS(proto), \
398 PARAMS(args), PARAMS(cond))
ff038f5c 399
30a8fecc 400#define TRACE_EVENT(name, proto, args, struct, assign, print) \
da4d0302 401 DECLARE_TRACE(name, PARAMS(proto), PARAMS(args))
97419875
JS
402#define TRACE_EVENT_FN(name, proto, args, struct, \
403 assign, print, reg, unreg) \
404 DECLARE_TRACE(name, PARAMS(proto), PARAMS(args))
287050d3
SR
405#define TRACE_EVENT_CONDITION(name, proto, args, cond, \
406 struct, assign, print) \
407 DECLARE_TRACE_CONDITION(name, PARAMS(proto), \
408 PARAMS(args), PARAMS(cond))
7cb2e3ee 409
1ed0c597
FW
410#define TRACE_EVENT_FLAGS(event, flag)
411
7cb2e3ee 412#endif /* ifdef TRACE_EVENT (see note above) */