[mirror_ubuntu-bionic-kernel.git] / include / linux / tracepoint.h

#ifndef _LINUX_TRACEPOINT_H
#define _LINUX_TRACEPOINT_H

/*
 * Kernel Tracepoint API.
 *
 * See Documentation/trace/tracepoints.txt.
 *
 * Copyright (C) 2008-2014 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * Heavily inspired from the Linux Kernel Markers.
 *
 * This file is released under the GPLv2.
 * See the file COPYING for more details.
 */

#include <linux/smp.h>
#include <linux/errno.h>
#include <linux/types.h>
#include <linux/cpumask.h>
#include <linux/rcupdate.h>
#include <linux/tracepoint-defs.h>

struct module;
struct tracepoint;
struct notifier_block;

struct trace_eval_map {
	const char		*system;
	const char		*eval_string;
	unsigned long		eval_value;
};

#define TRACEPOINT_DEFAULT_PRIO	10

extern int
tracepoint_probe_register(struct tracepoint *tp, void *probe, void *data);
extern int
tracepoint_probe_register_prio(struct tracepoint *tp, void *probe, void *data,
			       int prio);
extern int
tracepoint_probe_unregister(struct tracepoint *tp, void *probe, void *data);
extern void
for_each_kernel_tracepoint(void (*fct)(struct tracepoint *tp, void *priv),
		void *priv);

#ifdef CONFIG_MODULES
struct tp_module {
	struct list_head list;
	struct module *mod;
};

bool trace_module_has_bad_taint(struct module *mod);
extern int register_tracepoint_module_notifier(struct notifier_block *nb);
extern int unregister_tracepoint_module_notifier(struct notifier_block *nb);
#else
static inline bool trace_module_has_bad_taint(struct module *mod)
{
	return false;
}
static inline
int register_tracepoint_module_notifier(struct notifier_block *nb)
{
	return 0;
}
static inline
int unregister_tracepoint_module_notifier(struct notifier_block *nb)
{
	return 0;
}
#endif /* CONFIG_MODULES */

/*
 * tracepoint_synchronize_unregister must be called between the last tracepoint
 * probe unregistration and the end of module exit to make sure there is no
 * caller executing a probe when it is freed.
 */
static inline void tracepoint_synchronize_unregister(void)
{
	synchronize_sched();
}

#ifdef CONFIG_HAVE_SYSCALL_TRACEPOINTS
extern int syscall_regfunc(void);
extern void syscall_unregfunc(void);
#endif /* CONFIG_HAVE_SYSCALL_TRACEPOINTS */

#define PARAMS(args...) args

#define TRACE_DEFINE_ENUM(x)

#endif /* _LINUX_TRACEPOINT_H */

/*
 * Note: we keep the TRACE_EVENT and DECLARE_TRACE outside the include
 *  file ifdef protection.
 *  This is due to the way trace events work. If a file includes two
 *  trace event headers under one "CREATE_TRACE_POINTS" the first include
 *  will override the TRACE_EVENT and break the second include.
 */

#ifndef DECLARE_TRACE

#define TP_PROTO(args...)	args
#define TP_ARGS(args...)	args
#define TP_CONDITION(args...)	args

/*
 * Individual subsystem my have a separate configuration to
 * enable their tracepoints. By default, this file will create
 * the tracepoints if CONFIG_TRACEPOINT is defined. If a subsystem
 * wants to be able to disable its tracepoints from being created
 * it can define NOTRACE before including the tracepoint headers.
 */
#if defined(CONFIG_TRACEPOINTS) && !defined(NOTRACE)
#define TRACEPOINTS_ENABLED
#endif

#ifdef TRACEPOINTS_ENABLED

/*
 * it_func[0] is never NULL because there is at least one element in the array
 * when the array itself is non NULL.
 *
 * Note, the proto and args passed in includes "__data" as the first parameter.
 * The reason for this is to handle the "void" prototype. If a tracepoint
 * has a "void" prototype, then it is invalid to declare a function
 * as "(void *, void)". The DECLARE_TRACE_NOARGS() will pass in just
 * "void *data", where as the DECLARE_TRACE() will pass in "void *data, proto".
 */
#define __DO_TRACE(tp, proto, args, cond, rcucheck)			\
	do {								\
		struct tracepoint_func *it_func_ptr;			\
		void *it_func;						\
		void *__data;						\
									\
		if (!(cond))						\
			return;						\
		if (rcucheck) {						\
			if (WARN_ON_ONCE(rcu_irq_enter_disabled()))	\
				return;					\
			rcu_irq_enter_irqson();				\
		}							\
		rcu_read_lock_sched_notrace();				\
		it_func_ptr = rcu_dereference_sched((tp)->funcs);	\
		if (it_func_ptr) {					\
			do {						\
				it_func = (it_func_ptr)->func;		\
				__data = (it_func_ptr)->data;		\
				((void(*)(proto))(it_func))(args);	\
			} while ((++it_func_ptr)->func);		\
		}							\
		rcu_read_unlock_sched_notrace();			\
		if (rcucheck)						\
			rcu_irq_exit_irqson();				\
	} while (0)

#ifndef MODULE
#define __DECLARE_TRACE_RCU(name, proto, args, cond, data_proto, data_args) \
	static inline void trace_##name##_rcuidle(proto)		\
	{								\
		if (static_key_false(&__tracepoint_##name.key))		\
			__DO_TRACE(&__tracepoint_##name,		\
				TP_PROTO(data_proto),			\
				TP_ARGS(data_args),			\
				TP_CONDITION(cond), 1);			\
	}
#else
#define __DECLARE_TRACE_RCU(name, proto, args, cond, data_proto, data_args)
#endif

/*
 * Make sure the alignment of the structure in the __tracepoints section will
 * not add unwanted padding between the beginning of the section and the
 * structure. Force alignment to the same alignment as the section start.
 *
 * When lockdep is enabled, we make sure to always do the RCU portions of
 * the tracepoint code, regardless of whether tracing is on. However,
 * don't check if the condition is false, due to interaction with idle
 * instrumentation. This lets us find RCU issues triggered with tracepoints
 * even when this tracepoint is off. This code has no purpose other than
 * poking RCU a bit.
 */
#define __DECLARE_TRACE(name, proto, args, cond, data_proto, data_args) \
	extern struct tracepoint __tracepoint_##name;			\
	static inline void trace_##name(proto)				\
	{								\
		if (static_key_false(&__tracepoint_##name.key))		\
			__DO_TRACE(&__tracepoint_##name,		\
				TP_PROTO(data_proto),			\
				TP_ARGS(data_args),			\
				TP_CONDITION(cond), 0);			\
		if (IS_ENABLED(CONFIG_LOCKDEP) && (cond)) {		\
			rcu_read_lock_sched_notrace();			\
			rcu_dereference_sched(__tracepoint_##name.funcs);\
			rcu_read_unlock_sched_notrace();		\
		}							\
	}								\
	__DECLARE_TRACE_RCU(name, PARAMS(proto), PARAMS(args),		\
		PARAMS(cond), PARAMS(data_proto), PARAMS(data_args))	\
	static inline int						\
	register_trace_##name(void (*probe)(data_proto), void *data)	\
	{								\
		return tracepoint_probe_register(&__tracepoint_##name,	\
						(void *)probe, data);	\
	}								\
	static inline int						\
	register_trace_prio_##name(void (*probe)(data_proto), void *data,\
				   int prio)				\
	{								\
		return tracepoint_probe_register_prio(&__tracepoint_##name, \
					      (void *)probe, data, prio); \
	}								\
	static inline int						\
	unregister_trace_##name(void (*probe)(data_proto), void *data)	\
	{								\
		return tracepoint_probe_unregister(&__tracepoint_##name,\
						(void *)probe, data);	\
	}								\
	static inline void						\
	check_trace_callback_type_##name(void (*cb)(data_proto))	\
	{								\
	}								\
	static inline bool						\
	trace_##name##_enabled(void)					\
	{								\
		return static_key_false(&__tracepoint_##name.key);	\
	}

/*
 * We have no guarantee that gcc and the linker won't up-align the tracepoint
 * structures, so we create an array of pointers that will be used for iteration
 * on the tracepoints.
 */
#define DEFINE_TRACE_FN(name, reg, unreg)				 \
	static const char __tpstrtab_##name[]				 \
	__attribute__((section("__tracepoints_strings"))) = #name;	 \
	struct tracepoint __tracepoint_##name				 \
	__attribute__((section("__tracepoints"))) =			 \
		{ __tpstrtab_##name, STATIC_KEY_INIT_FALSE, reg, unreg, NULL };\
	static struct tracepoint * const __tracepoint_ptr_##name __used	 \
	__attribute__((section("__tracepoints_ptrs"))) =		 \
		&__tracepoint_##name;

#define DEFINE_TRACE(name)						\
	DEFINE_TRACE_FN(name, NULL, NULL);

#define EXPORT_TRACEPOINT_SYMBOL_GPL(name)				\
	EXPORT_SYMBOL_GPL(__tracepoint_##name)
#define EXPORT_TRACEPOINT_SYMBOL(name)					\
	EXPORT_SYMBOL(__tracepoint_##name)

#else /* !TRACEPOINTS_ENABLED */
#define __DECLARE_TRACE(name, proto, args, cond, data_proto, data_args) \
	static inline void trace_##name(proto)				\
	{ }								\
	static inline void trace_##name##_rcuidle(proto)		\
	{ }								\
	static inline int						\
	register_trace_##name(void (*probe)(data_proto),		\
			      void *data)				\
	{								\
		return -ENOSYS;						\
	}								\
	static inline int						\
	unregister_trace_##name(void (*probe)(data_proto),		\
				void *data)				\
	{								\
		return -ENOSYS;						\
	}								\
	static inline void check_trace_callback_type_##name(void (*cb)(data_proto)) \
	{								\
	}								\
	static inline bool						\
	trace_##name##_enabled(void)					\
	{								\
		return false;						\
	}

#define DEFINE_TRACE_FN(name, reg, unreg)
#define DEFINE_TRACE(name)
#define EXPORT_TRACEPOINT_SYMBOL_GPL(name)
#define EXPORT_TRACEPOINT_SYMBOL(name)

#endif /* TRACEPOINTS_ENABLED */

#ifdef CONFIG_TRACING
/**
 * tracepoint_string - register constant persistent string to trace system
 * @str - a constant persistent string that will be referenced in tracepoints
 *
 * If constant strings are being used in tracepoints, it is faster and
 * more efficient to just save the pointer to the string and reference
 * that with a printf "%s" instead of saving the string in the ring buffer
 * and wasting space and time.
 *
 * The problem with the above approach is that userspace tools that read
 * the binary output of the trace buffers do not have access to the string.
 * Instead they just show the address of the string which is not very
 * useful to users.
 *
 * With tracepoint_string(), the string will be registered to the tracing
 * system and exported to userspace via the debugfs/tracing/printk_formats
 * file that maps the string address to the string text. This way userspace
 * tools that read the binary buffers have a way to map the pointers to
 * the ASCII strings they represent.
 *
 * The @str used must be a constant string and persistent as it would not
 * make sense to show a string that no longer exists. But it is still fine
 * to be used with modules, because when modules are unloaded, if they
 * had tracepoints, the ring buffers are cleared too. As long as the string
 * does not change during the life of the module, it is fine to use
 * tracepoint_string() within a module.
 */
#define tracepoint_string(str)						\
	({								\
		static const char *___tp_str __tracepoint_string = str; \
		___tp_str;						\
	})
#define __tracepoint_string	__attribute__((section("__tracepoint_str")))
#else
/*
 * tracepoint_string() is used to save the string address for userspace
 * tracing tools. When tracing isn't configured, there's no need to save
 * anything.
 */
# define tracepoint_string(str) str
# define __tracepoint_string
#endif

/*
 * The need for the DECLARE_TRACE_NOARGS() is to handle the prototype
 * (void). "void" is a special value in a function prototype and can
 * not be combined with other arguments. Since the DECLARE_TRACE()
 * macro adds a data element at the beginning of the prototype,
 * we need a way to differentiate "(void *data, proto)" from
 * "(void *data, void)". The second prototype is invalid.
 *
 * DECLARE_TRACE_NOARGS() passes "void" as the tracepoint prototype
 * and "void *__data" as the callback prototype.
 *
 * DECLARE_TRACE() passes "proto" as the tracepoint protoype and
 * "void *__data, proto" as the callback prototype.
 */
#define DECLARE_TRACE_NOARGS(name)					\
	__DECLARE_TRACE(name, void, ,					\
			cpu_online(raw_smp_processor_id()),		\
			void *__data, __data)

#define DECLARE_TRACE(name, proto, args)				\
	__DECLARE_TRACE(name, PARAMS(proto), PARAMS(args),		\
			cpu_online(raw_smp_processor_id()),		\
			PARAMS(void *__data, proto),			\
			PARAMS(__data, args))

#define DECLARE_TRACE_CONDITION(name, proto, args, cond)		\
	__DECLARE_TRACE(name, PARAMS(proto), PARAMS(args),		\
			cpu_online(raw_smp_processor_id()) && (PARAMS(cond)), \
			PARAMS(void *__data, proto),			\
			PARAMS(__data, args))

#define TRACE_EVENT_FLAGS(event, flag)

#define TRACE_EVENT_PERF_PERM(event, expr...)

#endif /* DECLARE_TRACE */

#ifndef TRACE_EVENT
/*
 * For use with the TRACE_EVENT macro:
 *
 * We define a tracepoint, its arguments, its printk format
 * and its 'fast binary record' layout.
 *
 * Firstly, name your tracepoint via TRACE_EVENT(name : the
 * 'subsystem_event' notation is fine.
 *
 * Think about this whole construct as the
 * 'trace_sched_switch() function' from now on.
 *
 *
 *  TRACE_EVENT(sched_switch,
 *
 *	*
 *	* A function has a regular function arguments
 *	* prototype, declare it via TP_PROTO():
 *	*
 *
 *	TP_PROTO(struct rq *rq, struct task_struct *prev,
 *		 struct task_struct *next),
 *
 *	*
 *	* Define the call signature of the 'function'.
 *	* (Design sidenote: we use this instead of a
 *	*  TP_PROTO1/TP_PROTO2/TP_PROTO3 ugliness.)
 *	*
 *
 *	TP_ARGS(rq, prev, next),
 *
 *	*
 *	* Fast binary tracing: define the trace record via
 *	* TP_STRUCT__entry(). You can think about it like a
 *	* regular C structure local variable definition.
 *	*
 *	* This is how the trace record is structured and will
 *	* be saved into the ring buffer. These are the fields
 *	* that will be exposed to user-space in
 *	* /sys/kernel/debug/tracing/events/<*>/format.
 *	*
 *	* The declared 'local variable' is called '__entry'
 *	*
 *	* __field(pid_t, prev_prid) is equivalent to a standard declariton:
 *	*
 *	*	pid_t	prev_pid;
 *	*
 *	* __array(char, prev_comm, TASK_COMM_LEN) is equivalent to:
 *	*
 *	*	char	prev_comm[TASK_COMM_LEN];
 *	*
 *
 *	TP_STRUCT__entry(
 *		__array(	char,	prev_comm,	TASK_COMM_LEN	)
 *		__field(	pid_t,	prev_pid			)
 *		__field(	int,	prev_prio			)
 *		__array(	char,	next_comm,	TASK_COMM_LEN	)
 *		__field(	pid_t,	next_pid			)
 *		__field(	int,	next_prio			)
 *	),
 *
 *	*
 *	* Assign the entry into the trace record, by embedding
 *	* a full C statement block into TP_fast_assign(). You
 *	* can refer to the trace record as '__entry' -
 *	* otherwise you can put arbitrary C code in here.
 *	*
 *	* Note: this C code will execute every time a trace event
 *	* happens, on an active tracepoint.
 *	*
 *
 *	TP_fast_assign(
 *		memcpy(__entry->next_comm, next->comm, TASK_COMM_LEN);
 *		__entry->prev_pid	= prev->pid;
 *		__entry->prev_prio	= prev->prio;
 *		memcpy(__entry->prev_comm, prev->comm, TASK_COMM_LEN);
 *		__entry->next_pid	= next->pid;
 *		__entry->next_prio	= next->prio;
 *	),
 *
 *	*
 *	* Formatted output of a trace record via TP_printk().
 *	* This is how the tracepoint will appear under ftrace
 *	* plugins that make use of this tracepoint.
 *	*
 *	* (raw-binary tracing wont actually perform this step.)
 *	*
 *
 *	TP_printk("task %s:%d [%d] ==> %s:%d [%d]",
 *		__entry->prev_comm, __entry->prev_pid, __entry->prev_prio,
 *		__entry->next_comm, __entry->next_pid, __entry->next_prio),
 *
 * );
 *
 * This macro construct is thus used for the regular printk format
 * tracing setup, it is used to construct a function pointer based
 * tracepoint callback (this is used by programmatic plugins and
 * can also by used by generic instrumentation like SystemTap), and
 * it is also used to expose a structured trace record in
 * /sys/kernel/debug/tracing/events/.
 *
 * A set of (un)registration functions can be passed to the variant
 * TRACE_EVENT_FN to perform any (un)registration work.
 */

#define DECLARE_EVENT_CLASS(name, proto, args, tstruct, assign, print)
#define DEFINE_EVENT(template, name, proto, args)		\
	DECLARE_TRACE(name, PARAMS(proto), PARAMS(args))
#define DEFINE_EVENT_FN(template, name, proto, args, reg, unreg)\
	DECLARE_TRACE(name, PARAMS(proto), PARAMS(args))
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\
	DECLARE_TRACE(name, PARAMS(proto), PARAMS(args))
#define DEFINE_EVENT_CONDITION(template, name, proto,		\
			       args, cond)			\
	DECLARE_TRACE_CONDITION(name, PARAMS(proto),		\
				PARAMS(args), PARAMS(cond))

#define TRACE_EVENT(name, proto, args, struct, assign, print)	\
	DECLARE_TRACE(name, PARAMS(proto), PARAMS(args))
#define TRACE_EVENT_FN(name, proto, args, struct,		\
		assign, print, reg, unreg)			\
	DECLARE_TRACE(name, PARAMS(proto), PARAMS(args))
#define TRACE_EVENT_FN_COND(name, proto, args, cond, struct,		\
		assign, print, reg, unreg)			\
	DECLARE_TRACE_CONDITION(name, PARAMS(proto),	\
			PARAMS(args), PARAMS(cond))
#define TRACE_EVENT_CONDITION(name, proto, args, cond,		\
			      struct, assign, print)		\
	DECLARE_TRACE_CONDITION(name, PARAMS(proto),		\
				PARAMS(args), PARAMS(cond))

#define TRACE_EVENT_FLAGS(event, flag)

#define TRACE_EVENT_PERF_PERM(event, expr...)

#endif /* ifdef TRACE_EVENT (see note above) */
Commit	Line	Data
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	8	*
de7b2973	9	* Copyright (C) 2008-2014 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
97e1c18e MD	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
f3775549	17	#include <linux/smp.h>
b70e4f05	18	#include <linux/errno.h>
97e1c18e	19	#include <linux/types.h>
f3775549	20	#include <linux/cpumask.h>
97e1c18e	21	#include <linux/rcupdate.h>
bd2a634d	22	#include <linux/tracepoint-defs.h>
97e1c18e MD	23
	24	struct module;
	25	struct tracepoint;
de7b2973	26	struct notifier_block;
97e1c18e	27
00f4b652	28	struct trace_eval_map {
0c564a53	29	const char *system;
00f4b652 JL	30	const char *eval_string;
00f4b652 JL	31	unsigned long eval_value;
0c564a53 SRRH	32	};
0c564a53 SRRH	33
7904b5c4 SRRH	34	#define TRACEPOINT_DEFAULT_PRIO 10
7904b5c4 SRRH	35
38516ab5	36	extern int
de7b2973 MD	37	tracepoint_probe_register(struct tracepoint tp, void probe, void *data);
de7b2973 MD	38	extern int
7904b5c4 SRRH	39	tracepoint_probe_register_prio(struct tracepoint tp, void probe, void *data,
	40	int prio);
	41	extern int
de7b2973 MD	42	tracepoint_probe_unregister(struct tracepoint tp, void probe, void *data);
	43	extern void
	44	for_each_kernel_tracepoint(void (fct)(struct tracepoint tp, void *priv),
	45	void *priv);
2e26ca71	46
b75ef8b4 MD	47	#ifdef CONFIG_MODULES
	48	struct tp_module {
	49	struct list_head list;
eb7d035c	50	struct module *mod;
b75ef8b4	51	};
de7b2973	52
45ab2813	53	bool trace_module_has_bad_taint(struct module *mod);
de7b2973 MD	54	extern int register_tracepoint_module_notifier(struct notifier_block *nb);
de7b2973 MD	55	extern int unregister_tracepoint_module_notifier(struct notifier_block *nb);
45ab2813 SRRH	56	#else
	57	static inline bool trace_module_has_bad_taint(struct module *mod)
	58	{
	59	return false;
	60	}
de7b2973 MD	61	static inline
	62	int register_tracepoint_module_notifier(struct notifier_block *nb)
	63	{
	64	return 0;
	65	}
	66	static inline
	67	int unregister_tracepoint_module_notifier(struct notifier_block *nb)
	68	{
	69	return 0;
	70	}
b75ef8b4 MD	71	#endif /* CONFIG_MODULES */
b75ef8b4 MD	72
2e26ca71 SR	73	/*
	74	* tracepoint_synchronize_unregister must be called between the last tracepoint
	75	* probe unregistration and the end of module exit to make sure there is no
	76	* caller executing a probe when it is freed.
	77	*/
	78	static inline void tracepoint_synchronize_unregister(void)
	79	{
	80	synchronize_sched();
	81	}
	82
b725dfea	83	#ifdef CONFIG_HAVE_SYSCALL_TRACEPOINTS
8cf868af	84	extern int syscall_regfunc(void);
b725dfea MD	85	extern void syscall_unregfunc(void);
	86	#endif /* CONFIG_HAVE_SYSCALL_TRACEPOINTS */
	87
2e26ca71 SR	88	#define PARAMS(args...) args
2e26ca71 SR	89
0c564a53 SRRH	90	#define TRACE_DEFINE_ENUM(x)
0c564a53 SRRH	91
2e26ca71 SR	92	#endif /* _LINUX_TRACEPOINT_H */
	93
	94	/*
	95	* Note: we keep the TRACE_EVENT and DECLARE_TRACE outside the include
	96	* file ifdef protection.
	97	* This is due to the way trace events work. If a file includes two
	98	* trace event headers under one "CREATE_TRACE_POINTS" the first include
	99	* will override the TRACE_EVENT and break the second include.
	100	*/
	101
ea20d929 SR	102	#ifndef DECLARE_TRACE
ea20d929 SR	103
2939b046	104	#define TP_PROTO(args...) args
8cd09a59	105	#define TP_ARGS(args...) args
287050d3	106	#define TP_CONDITION(args...) args
97e1c18e	107
c63b7682 TS	108	/*
	109	* Individual subsystem my have a separate configuration to
	110	* enable their tracepoints. By default, this file will create
	111	* the tracepoints if CONFIG_TRACEPOINT is defined. If a subsystem
	112	* wants to be able to disable its tracepoints from being created
	113	* it can define NOTRACE before including the tracepoint headers.
	114	*/
	115	#if defined(CONFIG_TRACEPOINTS) && !defined(NOTRACE)
	116	#define TRACEPOINTS_ENABLED
	117	#endif
	118
	119	#ifdef TRACEPOINTS_ENABLED
97e1c18e MD	120
	121	/*
	122	* it_func[0] is never NULL because there is at least one element in the array
	123	* when the array itself is non NULL.
38516ab5 SR	124	*
	125	* Note, the proto and args passed in includes "__data" as the first parameter.
	126	* The reason for this is to handle the "void" prototype. If a tracepoint
	127	* has a "void" prototype, then it is invalid to declare a function
	128	* as "(void *, void)". The DECLARE_TRACE_NOARGS() will pass in just
	129	* "void data", where as the DECLARE_TRACE() will pass in "void data, proto".
97e1c18e	130	*/
d54b6eeb	131	#define __DO_TRACE(tp, proto, args, cond, rcucheck) \
97e1c18e	132	do { \
38516ab5 SR	133	struct tracepoint_func *it_func_ptr; \
	134	void *it_func; \
	135	void *__data; \
97e1c18e	136	\
287050d3 SR	137	if (!(cond)) \
287050d3 SR	138	return; \
d54b6eeb SRV	139	if (rcucheck) { \
	140	if (WARN_ON_ONCE(rcu_irq_enter_disabled())) \
	141	return; \
	142	rcu_irq_enter_irqson(); \
	143	} \
da7b3eab	144	rcu_read_lock_sched_notrace(); \
38516ab5 SR	145	it_func_ptr = rcu_dereference_sched((tp)->funcs); \
38516ab5 SR	146	if (it_func_ptr) { \
97e1c18e	147	do { \
38516ab5 SR	148	it_func = (it_func_ptr)->func; \
	149	__data = (it_func_ptr)->data; \
	150	((void(*)(proto))(it_func))(args); \
	151	} while ((++it_func_ptr)->func); \
97e1c18e	152	} \
da7b3eab	153	rcu_read_unlock_sched_notrace(); \
d54b6eeb SRV	154	if (rcucheck) \
d54b6eeb SRV	155	rcu_irq_exit_irqson(); \
97e1c18e MD	156	} while (0)
97e1c18e MD	157
7ece55a4	158	#ifndef MODULE
d54b6eeb	159	#define __DECLARE_TRACE_RCU(name, proto, args, cond, data_proto, data_args) \
7ece55a4 JT	160	static inline void trace_##name##_rcuidle(proto) \
	161	{ \
	162	if (static_key_false(&__tracepoint_##name.key)) \
	163	__DO_TRACE(&__tracepoint_##name, \
	164	TP_PROTO(data_proto), \
	165	TP_ARGS(data_args), \
d54b6eeb	166	TP_CONDITION(cond), 1); \
7ece55a4 JT	167	}
	168	#else
	169	#define __DECLARE_TRACE_RCU(name, proto, args, cond, data_proto, data_args)
	170	#endif
	171
97e1c18e MD	172	/*
	173	* Make sure the alignment of the structure in the __tracepoints section will
	174	* not add unwanted padding between the beginning of the section and the
	175	* structure. Force alignment to the same alignment as the section start.
3a630178 DH	176	*
3a630178 DH	177	* When lockdep is enabled, we make sure to always do the RCU portions of
a15920be MD	178	* the tracepoint code, regardless of whether tracing is on. However,
	179	* don't check if the condition is false, due to interaction with idle
	180	* instrumentation. This lets us find RCU issues triggered with tracepoints
	181	* even when this tracepoint is off. This code has no purpose other than
	182	* poking RCU a bit.
97e1c18e	183	*/
2fbb90db	184	#define __DECLARE_TRACE(name, proto, args, cond, data_proto, data_args) \
7e066fb8	185	extern struct tracepoint __tracepoint_##name; \
97e1c18e MD	186	static inline void trace_##name(proto) \
97e1c18e MD	187	{ \
c5905afb	188	if (static_key_false(&__tracepoint_##name.key)) \
97e1c18e	189	__DO_TRACE(&__tracepoint_##name, \
38516ab5	190	TP_PROTO(data_proto), \
287050d3	191	TP_ARGS(data_args), \
d54b6eeb	192	TP_CONDITION(cond), 0); \
a05d59a5	193	if (IS_ENABLED(CONFIG_LOCKDEP) && (cond)) { \
3a630178 DH	194	rcu_read_lock_sched_notrace(); \
	195	rcu_dereference_sched(__tracepoint_##name.funcs);\
	196	rcu_read_unlock_sched_notrace(); \
	197	} \
2fbb90db	198	} \
7ece55a4 JT	199	__DECLARE_TRACE_RCU(name, PARAMS(proto), PARAMS(args), \
7ece55a4 JT	200	PARAMS(cond), PARAMS(data_proto), PARAMS(data_args)) \
38516ab5 SR	201	static inline int \
38516ab5 SR	202	register_trace_##name(void (probe)(data_proto), void data) \
97e1c18e	203	{ \
de7b2973 MD	204	return tracepoint_probe_register(&__tracepoint_##name, \
de7b2973 MD	205	(void *)probe, data); \
97e1c18e	206	} \
38516ab5	207	static inline int \
7904b5c4 SRRH	208	register_trace_prio_##name(void (probe)(data_proto), void data,\
	209	int prio) \
	210	{ \
	211	return tracepoint_probe_register_prio(&__tracepoint_##name, \
	212	(void *)probe, data, prio); \
	213	} \
	214	static inline int \
38516ab5	215	unregister_trace_##name(void (probe)(data_proto), void data) \
97e1c18e	216	{ \
de7b2973 MD	217	return tracepoint_probe_unregister(&__tracepoint_##name,\
de7b2973 MD	218	(void *)probe, data); \
53da59aa	219	} \
38516ab5 SR	220	static inline void \
38516ab5 SR	221	check_trace_callback_type_##name(void (*cb)(data_proto)) \
53da59aa	222	{ \
7c65bbc7 SRRH	223	} \
	224	static inline bool \
	225	trace_##name##_enabled(void) \
	226	{ \
	227	return static_key_false(&__tracepoint_##name.key); \
97e1c18e MD	228	}
97e1c18e MD	229
65498646 MD	230	/*
	231	* We have no guarantee that gcc and the linker won't up-align the tracepoint
	232	* structures, so we create an array of pointers that will be used for iteration
	233	* on the tracepoints.
	234	*/
d430d3d7 JB	235	#define DEFINE_TRACE_FN(name, reg, unreg) \
	236	static const char __tpstrtab_##name[] \
	237	__attribute__((section("__tracepoints_strings"))) = #name; \
	238	struct tracepoint __tracepoint_##name \
	239	__attribute__((section("__tracepoints"))) = \
c5905afb	240	{ __tpstrtab_##name, STATIC_KEY_INIT_FALSE, reg, unreg, NULL };\
d430d3d7 JB	241	static struct tracepoint * const __tracepoint_ptr_##name __used \
d430d3d7 JB	242	__attribute__((section("__tracepoints_ptrs"))) = \
65498646	243	&__tracepoint_##name;
97419875 JS	244
	245	#define DEFINE_TRACE(name) \
	246	DEFINE_TRACE_FN(name, NULL, NULL);
7e066fb8 MD	247
	248	#define EXPORT_TRACEPOINT_SYMBOL_GPL(name) \
	249	EXPORT_SYMBOL_GPL(__tracepoint_##name)
	250	#define EXPORT_TRACEPOINT_SYMBOL(name) \
	251	EXPORT_SYMBOL(__tracepoint_##name)
	252
c63b7682	253	#else /* !TRACEPOINTS_ENABLED */
2fbb90db	254	#define __DECLARE_TRACE(name, proto, args, cond, data_proto, data_args) \
97e1c18e MD	255	static inline void trace_##name(proto) \
97e1c18e MD	256	{ } \
2fbb90db SR	257	static inline void trace_##name##_rcuidle(proto) \
2fbb90db SR	258	{ } \
38516ab5 SR	259	static inline int \
	260	register_trace_##name(void (*probe)(data_proto), \
	261	void *data) \
97e1c18e MD	262	{ \
	263	return -ENOSYS; \
	264	} \
38516ab5 SR	265	static inline int \
	266	unregister_trace_##name(void (*probe)(data_proto), \
	267	void *data) \
c420970e MD	268	{ \
c420970e MD	269	return -ENOSYS; \
53da59aa	270	} \
38516ab5	271	static inline void check_trace_callback_type_##name(void (*cb)(data_proto)) \
53da59aa	272	{ \
7c65bbc7 SRRH	273	} \
	274	static inline bool \
	275	trace_##name##_enabled(void) \
	276	{ \
	277	return false; \
c420970e	278	}
97e1c18e	279
97419875	280	#define DEFINE_TRACE_FN(name, reg, unreg)
7e066fb8 MD	281	#define DEFINE_TRACE(name)
	282	#define EXPORT_TRACEPOINT_SYMBOL_GPL(name)
	283	#define EXPORT_TRACEPOINT_SYMBOL(name)
	284
c63b7682	285	#endif /* TRACEPOINTS_ENABLED */
38516ab5	286
3c49b52b SR	287	#ifdef CONFIG_TRACING
	288	/**
	289	* tracepoint_string - register constant persistent string to trace system
	290	* @str - a constant persistent string that will be referenced in tracepoints
	291	*
	292	* If constant strings are being used in tracepoints, it is faster and
	293	* more efficient to just save the pointer to the string and reference
	294	* that with a printf "%s" instead of saving the string in the ring buffer
	295	* and wasting space and time.
	296	*
	297	* The problem with the above approach is that userspace tools that read
	298	* the binary output of the trace buffers do not have access to the string.
	299	* Instead they just show the address of the string which is not very
	300	* useful to users.
	301	*
	302	* With tracepoint_string(), the string will be registered to the tracing
	303	* system and exported to userspace via the debugfs/tracing/printk_formats
	304	* file that maps the string address to the string text. This way userspace
	305	* tools that read the binary buffers have a way to map the pointers to
	306	* the ASCII strings they represent.
	307	*
	308	* The @str used must be a constant string and persistent as it would not
	309	* make sense to show a string that no longer exists. But it is still fine
	310	* to be used with modules, because when modules are unloaded, if they
	311	* had tracepoints, the ring buffers are cleared too. As long as the string
	312	* does not change during the life of the module, it is fine to use
	313	* tracepoint_string() within a module.
	314	*/
	315	#define tracepoint_string(str) \
	316	({ \
	317	static const char *___tp_str __tracepoint_string = str; \
	318	___tp_str; \
	319	})
	320	#define __tracepoint_string __attribute__((section("__tracepoint_str")))
	321	#else
	322	/*
	323	* tracepoint_string() is used to save the string address for userspace
	324	* tracing tools. When tracing isn't configured, there's no need to save
	325	* anything.
	326	*/
	327	# define tracepoint_string(str) str
	328	# define __tracepoint_string
	329	#endif
	330
38516ab5 SR	331	/*
	332	* The need for the DECLARE_TRACE_NOARGS() is to handle the prototype
	333	* (void). "void" is a special value in a function prototype and can
	334	* not be combined with other arguments. Since the DECLARE_TRACE()
	335	* macro adds a data element at the beginning of the prototype,
	336	* we need a way to differentiate "(void *data, proto)" from
	337	* "(void *data, void)". The second prototype is invalid.
	338	*
	339	* DECLARE_TRACE_NOARGS() passes "void" as the tracepoint prototype
	340	* and "void *__data" as the callback prototype.
	341	*
	342	* DECLARE_TRACE() passes "proto" as the tracepoint protoype and
	343	* "void *__data, proto" as the callback prototype.
	344	*/
	345	#define DECLARE_TRACE_NOARGS(name) \
dc17147d SRRH	346	__DECLARE_TRACE(name, void, , \
	347	cpu_online(raw_smp_processor_id()), \
	348	void *__data, __data)
38516ab5 SR	349
38516ab5 SR	350	#define DECLARE_TRACE(name, proto, args) \
dc17147d SRRH	351	__DECLARE_TRACE(name, PARAMS(proto), PARAMS(args), \
	352	cpu_online(raw_smp_processor_id()), \
	353	PARAMS(void *__data, proto), \
	354	PARAMS(__data, args))
38516ab5	355
287050d3	356	#define DECLARE_TRACE_CONDITION(name, proto, args, cond) \
dc17147d SRRH	357	__DECLARE_TRACE(name, PARAMS(proto), PARAMS(args), \
dc17147d SRRH	358	cpu_online(raw_smp_processor_id()) && (PARAMS(cond)), \
287050d3 SR	359	PARAMS(void *__data, proto), \
	360	PARAMS(__data, args))
	361
1ed0c597 FW	362	#define TRACE_EVENT_FLAGS(event, flag)
1ed0c597 FW	363
d5b5f391 PZ	364	#define TRACE_EVENT_PERF_PERM(event, expr...)
d5b5f391 PZ	365
ea20d929	366	#endif /* DECLARE_TRACE */
97e1c18e	367
ea20d929	368	#ifndef TRACE_EVENT
823f9124 SR	369	/*
	370	* For use with the TRACE_EVENT macro:
	371	*
	372	* We define a tracepoint, its arguments, its printk format
2621bca8	373	* and its 'fast binary record' layout.
823f9124 SR	374	*
	375	* Firstly, name your tracepoint via TRACE_EVENT(name : the
	376	* 'subsystem_event' notation is fine.
	377	*
	378	* Think about this whole construct as the
	379	* 'trace_sched_switch() function' from now on.
	380	*
	381	*
	382	* TRACE_EVENT(sched_switch,
	383	*
	384	* *
	385	* * A function has a regular function arguments
	386	* * prototype, declare it via TP_PROTO():
	387	* *
	388	*
ef18012b SR	389	* TP_PROTO(struct rq rq, struct task_struct prev,
ef18012b SR	390	* struct task_struct *next),
823f9124 SR	391	*
	392	* *
	393	* * Define the call signature of the 'function'.
	394	* * (Design sidenote: we use this instead of a
	395	* * TP_PROTO1/TP_PROTO2/TP_PROTO3 ugliness.)
	396	* *
	397	*
ef18012b	398	* TP_ARGS(rq, prev, next),
823f9124 SR	399	*
	400	* *
	401	* * Fast binary tracing: define the trace record via
	402	* * TP_STRUCT__entry(). You can think about it like a
	403	* * regular C structure local variable definition.
	404	* *
	405	* * This is how the trace record is structured and will
	406	* * be saved into the ring buffer. These are the fields
	407	* * that will be exposed to user-space in
156f5a78	408	* * /sys/kernel/debug/tracing/events/<*>/format.
823f9124 SR	409	* *
	410	* * The declared 'local variable' is called '__entry'
	411	* *
	412	* * __field(pid_t, prev_prid) is equivalent to a standard declariton:
	413	* *
	414	* * pid_t prev_pid;
	415	* *
	416	* * __array(char, prev_comm, TASK_COMM_LEN) is equivalent to:
	417	* *
	418	* * char prev_comm[TASK_COMM_LEN];
	419	* *
	420	*
	421	* TP_STRUCT__entry(
	422	* __array( char, prev_comm, TASK_COMM_LEN )
	423	* __field( pid_t, prev_pid )
	424	* __field( int, prev_prio )
	425	* __array( char, next_comm, TASK_COMM_LEN )
	426	* __field( pid_t, next_pid )
	427	* __field( int, next_prio )
	428	* ),
	429	*
	430	* *
	431	* * Assign the entry into the trace record, by embedding
	432	* * a full C statement block into TP_fast_assign(). You
	433	* * can refer to the trace record as '__entry' -
	434	* * otherwise you can put arbitrary C code in here.
	435	* *
	436	* * Note: this C code will execute every time a trace event
	437	* * happens, on an active tracepoint.
	438	* *
	439	*
ef18012b SR	440	* TP_fast_assign(
	441	* memcpy(__entry->next_comm, next->comm, TASK_COMM_LEN);
	442	* __entry->prev_pid = prev->pid;
	443	* __entry->prev_prio = prev->prio;
823f9124 SR	444	* memcpy(__entry->prev_comm, prev->comm, TASK_COMM_LEN);
823f9124 SR	445	* __entry->next_pid = next->pid;
ef18012b	446	* __entry->next_prio = next->prio;
ec6e7c3a	447	* ),
823f9124 SR	448	*
	449	* *
	450	* * Formatted output of a trace record via TP_printk().
	451	* * This is how the tracepoint will appear under ftrace
	452	* * plugins that make use of this tracepoint.
	453	* *
	454	* * (raw-binary tracing wont actually perform this step.)
	455	* *
	456	*
	457	* TP_printk("task %s:%d [%d] ==> %s:%d [%d]",
	458	* __entry->prev_comm, __entry->prev_pid, __entry->prev_prio,
	459	* __entry->next_comm, __entry->next_pid, __entry->next_prio),
	460	*
	461	* );
	462	*
	463	* This macro construct is thus used for the regular printk format
	464	* tracing setup, it is used to construct a function pointer based
	465	* tracepoint callback (this is used by programmatic plugins and
	466	* can also by used by generic instrumentation like SystemTap), and
	467	* it is also used to expose a structured trace record in
156f5a78	468	* /sys/kernel/debug/tracing/events/.
97419875 JS	469	*
	470	* A set of (un)registration functions can be passed to the variant
	471	* TRACE_EVENT_FN to perform any (un)registration work.
823f9124 SR	472	*/
823f9124 SR	473
091ad365	474	#define DECLARE_EVENT_CLASS(name, proto, args, tstruct, assign, print)
ff038f5c SR	475	#define DEFINE_EVENT(template, name, proto, args) \
ff038f5c SR	476	DECLARE_TRACE(name, PARAMS(proto), PARAMS(args))
f5abaa1b SR	477	#define DEFINE_EVENT_FN(template, name, proto, args, reg, unreg)\
f5abaa1b SR	478	DECLARE_TRACE(name, PARAMS(proto), PARAMS(args))
e5bc9721 SR	479	#define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
e5bc9721 SR	480	DECLARE_TRACE(name, PARAMS(proto), PARAMS(args))
287050d3 SR	481	#define DEFINE_EVENT_CONDITION(template, name, proto, \
	482	args, cond) \
	483	DECLARE_TRACE_CONDITION(name, PARAMS(proto), \
	484	PARAMS(args), PARAMS(cond))
ff038f5c	485
30a8fecc	486	#define TRACE_EVENT(name, proto, args, struct, assign, print) \
da4d0302	487	DECLARE_TRACE(name, PARAMS(proto), PARAMS(args))
97419875 JS	488	#define TRACE_EVENT_FN(name, proto, args, struct, \
	489	assign, print, reg, unreg) \
	490	DECLARE_TRACE(name, PARAMS(proto), PARAMS(args))
2701121b DK	491	#define TRACE_EVENT_FN_COND(name, proto, args, cond, struct, \
	492	assign, print, reg, unreg) \
	493	DECLARE_TRACE_CONDITION(name, PARAMS(proto), \
	494	PARAMS(args), PARAMS(cond))
287050d3 SR	495	#define TRACE_EVENT_CONDITION(name, proto, args, cond, \
	496	struct, assign, print) \
	497	DECLARE_TRACE_CONDITION(name, PARAMS(proto), \
	498	PARAMS(args), PARAMS(cond))
7cb2e3ee	499
1ed0c597 FW	500	#define TRACE_EVENT_FLAGS(event, flag)
1ed0c597 FW	501
d5b5f391 PZ	502	#define TRACE_EVENT_PERF_PERM(event, expr...)
d5b5f391 PZ	503
7cb2e3ee	504	#endif /* ifdef TRACE_EVENT (see note above) */