[lttng-ust.git] / include / lttng / tracepoint.h

#ifndef _LTTNG_TRACEPOINT_H
#define _LTTNG_TRACEPOINT_H

/*
 * Copyright (C) 2008-2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 * Copyright (C) 2009 Pierre-Marc Fournier
 * Copyright (C) 2009 Steven Rostedt <rostedt@goodmis.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
 *
 * Heavily inspired from the Linux Kernel Markers.
 */

#include <urcu-bp.h>
#include <urcu/list.h>
#include <lttng/tracepoint-types.h>

#ifdef __cplusplus
extern "C" {
#endif

/*
 * Tracepoints should be added to the instrumented code using the
 * "tracepoint()" macro.
 */
#define tracepoint(provider, name, args...)	\
		__trace_##provider##___##name(args)

/*
 * it_func[0] is never NULL because there is at least one element in the array
 * when the array itself is non NULL.
 */
#define __DO_TRACE(tp, proto, vars)					\
	do {								\
		struct tracepoint_probe *__tp_it_probe_ptr;		\
		void *__tp_it_func;					\
		void *__tp_cb_data;					\
									\
		rcu_read_lock();					\
		__tp_it_probe_ptr = rcu_dereference((tp)->probes);	\
		if (__tp_it_probe_ptr) {				\
			do {						\
				__tp_it_func = __tp_it_probe_ptr->func;	\
				__tp_cb_data = __tp_it_probe_ptr->data;	\
				URCU_FORCE_CAST(void(*)(proto), __tp_it_func)(vars); \
			} while ((++__tp_it_probe_ptr)->func);		\
		}							\
		rcu_read_unlock();					\
	} while (0)

#define TP_PARAMS(args...)	args
#define TP_ARGS(args...)	args

/*
 * TP_ARGS takes tuples of type, argument separated by a comma. It can
 * take up to 10 tuples (which means that less than 10 tuples is fine
 * too). Each tuple is also separated by a comma.
 */

#define TP_COMBINE_TOKENS1(_tokena, _tokenb)       _tokena##_tokenb
#define TP_COMBINE_TOKENS(_tokena, _tokenb)        TP_COMBINE_TOKENS1(_tokena, _tokenb)

/* _TP_EVEN* extracts the vars names. */
/* 0 and 1 are for void */
#define _TP_EVEN0()
#define _TP_EVEN1(a)
#define _TP_EVEN2(a,b)						b
#define _TP_EVEN4(a,b,c,d)					b,d
#define _TP_EVEN6(a,b,c,d,e,f)					b,d,f
#define _TP_EVEN8(a,b,c,d,e,f,g,h)				b,d,f,h
#define _TP_EVEN10(a,b,c,d,e,f,g,h,i,j)				b,d,f,h,j
#define _TP_EVEN12(a,b,c,d,e,f,g,h,i,j,k,l)			b,d,f,h,j,l
#define _TP_EVEN14(a,b,c,d,e,f,g,h,i,j,k,l,m,n)			b,d,f,h,j,l,n
#define _TP_EVEN16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p)		b,d,f,h,j,l,n,p
#define _TP_EVEN18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r)		b,d,f,h,j,l,n,p,r
#define _TP_EVEN20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t)	b,d,f,h,j,l,n,p,r,t

/* 0 and 1 are for void */
#define _TP_EVEN_DATA0()						__tp_cb_data
#define _TP_EVEN_DATA1(a)						__tp_cb_data
#define _TP_EVEN_DATA2(a,b)						__tp_cb_data,b
#define _TP_EVEN_DATA4(a,b,c,d)						__tp_cb_data,b,d
#define _TP_EVEN_DATA6(a,b,c,d,e,f)					__tp_cb_data,b,d,f
#define _TP_EVEN_DATA8(a,b,c,d,e,f,g,h)					__tp_cb_data,b,d,f,h
#define _TP_EVEN_DATA10(a,b,c,d,e,f,g,h,i,j)				__tp_cb_data,b,d,f,h,j
#define _TP_EVEN_DATA12(a,b,c,d,e,f,g,h,i,j,k,l)			__tp_cb_data,b,d,f,h,j,l
#define _TP_EVEN_DATA14(a,b,c,d,e,f,g,h,i,j,k,l,m,n)			__tp_cb_data,b,d,f,h,j,l,n
#define _TP_EVEN_DATA16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p)		__tp_cb_data,b,d,f,h,j,l,n,p
#define _TP_EVEN_DATA18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r)		__tp_cb_data,b,d,f,h,j,l,n,p,r
#define _TP_EVEN_DATA20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t)	__tp_cb_data,b,d,f,h,j,l,n,p,r,t

/* _TP_SPLIT extracts tuples of type, var */
/* 0 and 1 are for void */
#define _TP_SPLIT0()
#define _TP_SPLIT1(a)
#define _TP_SPLIT2(a,b)						a b
#define _TP_SPLIT4(a,b,c,d)					a b,c d
#define _TP_SPLIT6(a,b,c,d,e,f)					a b,c d,e f
#define _TP_SPLIT8(a,b,c,d,e,f,g,h)				a b,c d,e f,g h
#define _TP_SPLIT10(a,b,c,d,e,f,g,h,i,j)			a b,c d,e f,g h,i j
#define _TP_SPLIT12(a,b,c,d,e,f,g,h,i,j,k,l)			a b,c d,e f,g h,i j,k l
#define _TP_SPLIT14(a,b,c,d,e,f,g,h,i,j,k,l,m,n)		a b,c d,e f,g h,i j,k l,m n
#define _TP_SPLIT16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p)		a b,c d,e f,g h,i j,k l,m n,o p
#define _TP_SPLIT18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r)	a b,c d,e f,g h,i j,k l,m n,o p,q r
#define _TP_SPLIT20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t)	a b,c d,e f,g h,i j,k l,m n,o p,q r,s t

/* 0 and 1 are for void */
#define _TP_SPLIT_DATA0()						void *__tp_cb_data
#define _TP_SPLIT_DATA1(a)						void *__tp_cb_data
#define _TP_SPLIT_DATA2(a,b)						void *__tp_cb_data,a b
#define _TP_SPLIT_DATA4(a,b,c,d)					void *__tp_cb_data,a b,c d
#define _TP_SPLIT_DATA6(a,b,c,d,e,f)					void *__tp_cb_data,a b,c d,e f
#define _TP_SPLIT_DATA8(a,b,c,d,e,f,g,h)				void *__tp_cb_data,a b,c d,e f,g h
#define _TP_SPLIT_DATA10(a,b,c,d,e,f,g,h,i,j)				void *__tp_cb_data,a b,c d,e f,g h,i j
#define _TP_SPLIT_DATA12(a,b,c,d,e,f,g,h,i,j,k,l)			void *__tp_cb_data,a b,c d,e f,g h,i j,k l
#define _TP_SPLIT_DATA14(a,b,c,d,e,f,g,h,i,j,k,l,m,n)			void *__tp_cb_data,a b,c d,e f,g h,i j,k l,m n
#define _TP_SPLIT_DATA16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p)		void *__tp_cb_data,a b,c d,e f,g h,i j,k l,m n,o p
#define _TP_SPLIT_DATA18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r)		void *__tp_cb_data,a b,c d,e f,g h,i j,k l,m n,o p,q r
#define _TP_SPLIT_DATA20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t)	void *__tp_cb_data,a b,c d,e f,g h,i j,k l,m n,o p,q r,s t

/* Preprocessor trick to count arguments. Inspired from sdt.h. */
#define _TP_NARGS(...)	__TP_NARGS(__VA_ARGS__, 20,19,18,17,16,15,14,13,12,11,10,9,8,7,6,5,4,3,2,1,0)
#define __TP_NARGS(_0,_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,_11,_12,_13,_14,_15,_16,_17,_18,_19,_20, N, ...) N
#define _TP_PROTO_N(N, ...)	\
	TP_PARAMS(TP_COMBINE_TOKENS(_TP_SPLIT, N)(__VA_ARGS__))
#define _TP_VARS_N(N, ...)	\
	TP_PARAMS(TP_COMBINE_TOKENS(_TP_EVEN, N)(__VA_ARGS__))
#define _TP_PROTO_DATA_N(N, ...)	\
	TP_PARAMS(TP_COMBINE_TOKENS(_TP_SPLIT_DATA, N)(__VA_ARGS__))
#define _TP_VARS_DATA_N(N, ...)	\
	TP_PARAMS(TP_COMBINE_TOKENS(_TP_EVEN_DATA, N)(__VA_ARGS__))

#define _TP_ARGS_PROTO(...)		_TP_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
#define _TP_ARGS_VARS(...)		_TP_VARS_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)

#define _TP_ARGS_PROTO_DATA(...)	_TP_PROTO_DATA_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
#define _TP_ARGS_VARS_DATA(...)		_TP_VARS_DATA_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)

#define __CHECK_TRACE(provider, name, proto, args)			\
	do {								\
		if (caa_unlikely(__tracepoint_##provider##___##name.state))	\
			__DO_TRACE(&__tracepoint_##provider##___##name,	\
				TP_PARAMS(proto), TP_PARAMS(args));	\
	} while (0)

/*
 * 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.
 */
#define __DECLARE_TRACEPOINT(provider, name, proto, args, data_proto, data_args)	\
	extern struct tracepoint __tracepoint_##provider##___##name;	\
	static inline void __trace_##provider##___##name(proto)		\
	{								\
		__CHECK_TRACE(provider, name, TP_PARAMS(data_proto),	\
			      TP_PARAMS(data_args));			\
	}								\
	static inline int						\
	__register_trace_##provider##___##name(void (*probe)(data_proto), void *data)	\
	{								\
		return __tracepoint_probe_register(#provider ":" #name, (void *) probe,	\
						 data);			\
	}								\
	static inline int						\
	__unregister_trace_##provider##___##name(void (*probe)(data_proto), void *data)	\
	{								\
		return __tracepoint_probe_unregister(#provider ":" #name, (void *) probe, \
						   data);		\
	}

#define _DECLARE_TRACEPOINT(provider, name, args)			\
	__DECLARE_TRACEPOINT(provider, name, _TP_ARGS_PROTO(args), _TP_ARGS_VARS(args),	\
			_TP_ARGS_PROTO_DATA(args), _TP_ARGS_VARS_DATA(args))

/*
 * __tracepoints_ptrs section is not const (read-only) to let the linker update
 * the pointer, allowing PIC code.
 */
#define _DEFINE_TRACEPOINT(provider, name)				\
	static const char __tpstrtab_##provider##___##name[]		\
	__attribute__((section("__tracepoints_strings"))) =		\
		#provider ":" #name;					\
	struct tracepoint __tracepoint_##provider##___##name		\
	__attribute__((section("__tracepoints"))) =			\
		{ __tpstrtab_##provider##___##name, 0, NULL };		\
	static struct tracepoint * __tracepoint_ptr_##provider##___##name	\
	__attribute__((used, section("__tracepoints_ptrs"))) =		\
		&__tracepoint_##provider##___##name;


#define __register_tracepoint(provider, name, probe, data)		\
		__register_trace_##provider##___##name(probe, data)
#define __unregister_tracepoint(provider, name, probe, data)		\
		__unregister_trace_##provider##___##name(probe, data)

/*
 * Connect a probe to a tracepoint.
 * Internal API.
 */
extern
int __tracepoint_probe_register(const char *name, void *probe, void *data);

/*
 * Disconnect a probe from a tracepoint.
 * Internal API.
 */
extern
int __tracepoint_probe_unregister(const char *name, void *probe, void *data);

extern
int tracepoint_register_lib(struct tracepoint * const *tracepoints_start,
			    int tracepoints_count);
extern
int tracepoint_unregister_lib(struct tracepoint * const *tracepoints_start);

/*
 * These weak symbols, the constructor, and destructor take care of
 * registering only _one_ instance of the tracepoints per shared-ojbect
 * (or for the whole main program).
 */
extern struct tracepoint * const __start___tracepoints_ptrs[]
	__attribute__((weak, visibility("hidden")));
extern struct tracepoint * const __stop___tracepoints_ptrs[]
	__attribute__((weak, visibility("hidden")));
int __tracepoint_registered
	__attribute__((weak, visibility("hidden")));

static void __attribute__((constructor)) __tracepoints__init(void)
{
	if (__tracepoint_registered++)
		return;
	tracepoint_register_lib(__start___tracepoints_ptrs,
				__stop___tracepoints_ptrs -
				__start___tracepoints_ptrs);
}

static void __attribute__((destructor)) __tracepoints__destroy(void)
{
	if (--__tracepoint_registered)
		return;
	tracepoint_unregister_lib(__start___tracepoints_ptrs);
}

#ifdef __cplusplus 
}
#endif

#endif /* _LTTNG_TRACEPOINT_H */

/*
 * For multiple probe generation, we need to redefine TRACEPOINT_EVENT
 * each time tracepoint.h is included.
 */

#ifndef TRACEPOINT_EVENT
/*
 * Usage of the TRACEPOINT_EVENT macro:
 *
 * In short, an example:
 *
 * TRACEPOINT_EVENT(< [com_company_]project[_component] >, < event >,
 *
 *     * TP_ARGS takes from 0 to 10 "type, field_name" pairs *
 *
 *     TP_ARGS(int, arg0, void *, arg1, char *, string, size_t, strlen,
 *             long *, arg4, size_t, arg4_len),
 *     TP_FIELDS(
 *
 *         * Integer, printed in base 10 * 
 *         ctf_integer(int, field_a, arg0)
 *
 *         * Integer, printed with 0x base 16 * 
 *         ctf_integer_hex(unsigned long, field_d, arg1)
 *
 *         * Array Sequence, printed as UTF8-encoded array of bytes * 
 *         ctf_array_text(char, field_b, string, FIXED_LEN)
 *         ctf_sequence_text(char, field_c, string, size_t, strlen)
 *
 *         * String, printed as UTF8-encoded string * 
 *         ctf_string(field_e, string)
 *
 *         * Array sequence of signed integer values * 
 *         ctf_array(long, field_f, arg4, FIXED_LEN4)
 *         ctf_sequence(long, field_g, arg4, size_t, arg4_len)
 *     )
 * )
 *
 * In more detail:
 *
 * We define a tracepoint, its arguments, and its 'fast binary record'
 * layout.
 *
 * Firstly, name your tracepoint via TRACEPOINT_EVENT(provider, name,
 *
 * The provider and name should be a proper C99 identifier.
 * The "provider" and "name" MUST follow these rules to ensure no
 * namespace clash occurs:
 *
 * For projects (applications and libraries) for which an entity
 * specific to the project controls the source code and thus its
 * tracepoints (typically with a scope larger than a single company):
 *
 * either:
 *   project_component, event
 * or:
 *   project, event
 *
 * Where "project" is the name of the project,
 *       "component" is the name of the project component (which may
 *       include several levels of sub-components, e.g.
 *       ...component_subcomponent_...) where the tracepoint is located
 *       (optional),
 *       "event" is the name of the tracepoint event.
 *
 * For projects issued from a single company wishing to advertise that
 * the company controls the source code and thus the tracepoints, the
 * "com_" prefix should be used:
 *
 * either:
 *   com_company_project_component, event
 * or:
 *   com_company_project, event
 *
 * Where "company" is the name of the company,
 *       "project" is the name of the project,
 *       "component" is the name of the project component (which may
 *       include several levels of sub-components, e.g.
 *       ...component_subcomponent_...) where the tracepoint is located
 *       (optional),
 *       "event" is the name of the tracepoint event.
 *
 * the provider:event identifier is limited to 127 characters.
 *
 * As an example, let's consider a user-space application "someproject"
 * that would have an internal thread scheduler:
 *
 *  TRACEPOINT_EVENT(someproject_sched, switch,
 *
 *	*
 *	* Arguments to pass to the tracepoint. Supports from
 *	* 0 to 10 "type, name" tuples.
 *	*
 *
 *	TP_ARGS(struct rq *, rq, struct task_struct *, prev,
 *		struct task_struct *, next),
 *
 *	*
 *	* Fast binary tracing: define the trace record via
 *	* TP_FIELDS(). 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 readers.
 *	*
 *	* ctf_integer(pid_t, prev_pid, prev->pid) is equivalent
 *	* to a standard declaraton:
 *	*
 *	*	pid_t prev_pid;
 *	*
 *	* followed by an assignment:
 *	*
 *	*	prev_pid = prev->pid;
 *	*
 *	* ctf_array(char, prev_comm, prev->comm, TASK_COMM_LEN) is
 *	* equivalent to:
 *	*
 *	*	char prev_comm[TASK_COMM_LEN];
 *	*
 *	* followed by an assignment:
 *	*
 *	*	memcpy(prev_comm, prev->comm, TASK_COMM_LEN);
 *	*
 *
 *	TP_FIELDS(
 *		ctf_array(char, prev_comm, prev->comm, TASK_COMM_LEN)
 *		ctf_integer(pid_t, prev_pid,  prev->pid)
 *		ctf_integer(int, prev_prio, prev->prio)
 *		ctf_array(char, next_comm, next->comm, TASK_COMM_LEN)
 *		ctf_integer(pid_t, next_pid,  next->pid)
 *		ctf_integer(int, next_prio, next->prio)
 *	)
 * )
 *
 * Do _NOT_ add comma (,) nor semicolon (;) after the TRACEPOINT_EVENT
 * declaration.
 *
 * The TRACEPOINT_PROVIDER must be defined when declaring a
 * TRACEPOINT_EVENT. See ust/tracepoint-event.h for information about
 * usage of other macros controlling TRACEPOINT_EVENT.
 */

#define TRACEPOINT_EVENT(provider, name, args, fields)		\
	_DECLARE_TRACEPOINT(provider, name, TP_PARAMS(args))

#define TRACEPOINT_EVENT_CLASS(provider, name, args, fields)
#define TRACEPOINT_EVENT_INSTANCE(provider, template, name, args)\
	_DECLARE_TRACEPOINT(provider, name, TP_PARAMS(args))

#endif /* #ifndef TRACEPOINT_EVENT */

#ifndef TRACEPOINT_LOGLEVEL

/*
 * Tracepoint Loglevel Declaration Facility
 *
 * This is a place-holder the tracepoint loglevel declaration,
 * overridden by the tracer implementation.
 *
 * Typical use of these loglevels:
 *
 * 1) Declare the mapping between loglevel names and an integer values
 *    within TRACEPOINT_LOGLEVEL_ENUM, using TP_LOGLEVEL for each tuple.
 *    Do _NOT_ add comma (,) nor semicolon (;) between the
 *    TRACEPOINT_LOGLEVEL_ENUM entries. Do _NOT_ add comma (,) nor
 *    semicolon (;) after the TRACEPOINT_LOGLEVEL_ENUM declaration.  The
 *    name should be a proper C99 identifier.
 *
 *      TRACEPOINT_LOGLEVEL_ENUM(
 *              TP_LOGLEVEL( < loglevel_name >, < value > )
 *              TP_LOGLEVEL( < loglevel_name >, < value > )
 *              ...
 *      )
 *
 *    e.g.:
 *
 *      TRACEPOINT_LOGLEVEL_ENUM(
 *              TP_LOGLEVEL(LOG_EMERG,   0)
 *              TP_LOGLEVEL(LOG_ALERT,   1)
 *              TP_LOGLEVEL(LOG_CRIT,    2)
 *              TP_LOGLEVEL(LOG_ERR,     3)
 *              TP_LOGLEVEL(LOG_WARNING, 4)
 *              TP_LOGLEVEL(LOG_NOTICE,  5)
 *              TP_LOGLEVEL(LOG_INFO,    6)
 *              TP_LOGLEVEL(LOG_DEBUG,   7)
 *      )
 *
 * 2) Then, declare tracepoint loglevels for tracepoints. A
 *    TRACEPOINT_EVENT should be declared prior to the the
 *    TRACEPOINT_LOGLEVEL for a given tracepoint name. The first field
 *    is the name of the tracepoint, the second field is the loglevel
 *    name.
 *
 *      TRACEPOINT_LOGLEVEL(< [com_company_]project[_component] >, < event >,
 *              < loglevel_name >)
 *
 * The TRACEPOINT_PROVIDER must be defined when declaring a
 * TRACEPOINT_LOGLEVEL_ENUM and TRACEPOINT_LOGLEVEL. The tracepoint
 * loglevel enumeration apply to the entire TRACEPOINT_PROVIDER. Only one
 * tracepoint loglevel enumeration should be declared per tracepoint
 * provider.
 */

#define TRACEPOINT_LOGLEVEL_ENUM()
#define TRACEPOINT_LOGLEVEL(name, loglevel)

#endif /* #ifndef TRACEPOINT_LOGLEVEL */
Commit	Line	Data
51489cad MD	1	#ifndef _LTTNG_TRACEPOINT_H
51489cad MD	2	#define _LTTNG_TRACEPOINT_H
f99be407 PMF	3
f99be407 PMF	4	/*
e9090899	5	* Copyright (C) 2008-2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
1f8b0dff	6	* Copyright (C) 2009 Pierre-Marc Fournier
22d72948	7	* Copyright (C) 2009 Steven Rostedt <rostedt@goodmis.org>
f99be407	8	*
8fc2d8db PMF	9	* This library is free software; you can redistribute it and/or
8fc2d8db PMF	10	* modify it under the terms of the GNU Lesser General Public
f37142a4 MD	11	* License as published by the Free Software Foundation;
f37142a4 MD	12	* version 2.1 of the License.
f99be407	13	*
8fc2d8db	14	* This library is distributed in the hope that it will be useful,
1f8b0dff	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
8fc2d8db PMF	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
8fc2d8db PMF	17	* Lesser General Public License for more details.
1f8b0dff	18	*
8fc2d8db PMF	19	* You should have received a copy of the GNU Lesser General Public
	20	* License along with this library; if not, write to the Free Software
	21	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
f99be407 PMF	22	*
f99be407 PMF	23	* Heavily inspired from the Linux Kernel Markers.
f99be407 PMF	24	*/
f99be407 PMF	25
b7ea1a1c	26	#include <urcu-bp.h>
b0c4126f	27	#include <urcu/list.h>
51489cad	28	#include <lttng/tracepoint-types.h>
f99be407	29
1ea2c2df MD	30	#ifdef __cplusplus
	31	extern "C" {
	32	#endif
	33
cc7b66ba MD	34	/*
	35	* Tracepoints should be added to the instrumented code using the
	36	* "tracepoint()" macro.
	37	*/
7083f0fe MD	38	#define tracepoint(provider, name, args...) \
7083f0fe MD	39	__trace_##provider##___##name(args)
cc7b66ba	40
f99be407 PMF	41	/*
	42	* it_func[0] is never NULL because there is at least one element in the array
	43	* when the array itself is non NULL.
	44	*/
63ef2693	45	#define __DO_TRACE(tp, proto, vars) \
f99be407	46	do { \
b979b346 MD	47	struct tracepoint_probe *__tp_it_probe_ptr; \
	48	void *__tp_it_func; \
	49	void *__tp_cb_data; \
f99be407	50	\
9dec086e	51	rcu_read_lock(); \
b979b346 MD	52	__tp_it_probe_ptr = rcu_dereference((tp)->probes); \
b979b346 MD	53	if (__tp_it_probe_ptr) { \
f99be407	54	do { \
b979b346 MD	55	__tp_it_func = __tp_it_probe_ptr->func; \
b979b346 MD	56	__tp_cb_data = __tp_it_probe_ptr->data; \
63ef2693	57	URCU_FORCE_CAST(void(*)(proto), __tp_it_func)(vars); \
b979b346	58	} while ((++__tp_it_probe_ptr)->func); \
f99be407	59	} \
9dec086e	60	rcu_read_unlock(); \
f99be407 PMF	61	} while (0)
f99be407 PMF	62
81614639	63	#define TP_PARAMS(args...) args
63ef2693 MD	64	#define TP_ARGS(args...) args
	65
	66	/*
	67	* TP_ARGS takes tuples of type, argument separated by a comma. It can
	68	* take up to 10 tuples (which means that less than 10 tuples is fine
	69	* too). Each tuple is also separated by a comma.
	70	*/
	71
	72	#define TP_COMBINE_TOKENS1(_tokena, _tokenb) _tokena##_tokenb
	73	#define TP_COMBINE_TOKENS(_tokena, _tokenb) TP_COMBINE_TOKENS1(_tokena, _tokenb)
	74
	75	/* _TP_EVEN* extracts the vars names. */
992abe11	76	/* 0 and 1 are for void */
63ef2693	77	#define _TP_EVEN0()
992abe11	78	#define _TP_EVEN1(a)
63ef2693 MD	79	#define _TP_EVEN2(a,b) b
	80	#define _TP_EVEN4(a,b,c,d) b,d
	81	#define _TP_EVEN6(a,b,c,d,e,f) b,d,f
	82	#define _TP_EVEN8(a,b,c,d,e,f,g,h) b,d,f,h
	83	#define _TP_EVEN10(a,b,c,d,e,f,g,h,i,j) b,d,f,h,j
	84	#define _TP_EVEN12(a,b,c,d,e,f,g,h,i,j,k,l) b,d,f,h,j,l
	85	#define _TP_EVEN14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) b,d,f,h,j,l,n
	86	#define _TP_EVEN16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p) b,d,f,h,j,l,n,p
	87	#define _TP_EVEN18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r) b,d,f,h,j,l,n,p,r
	88	#define _TP_EVEN20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t) b,d,f,h,j,l,n,p,r,t
	89
992abe11	90	/* 0 and 1 are for void */
63ef2693	91	#define _TP_EVEN_DATA0() __tp_cb_data
992abe11	92	#define _TP_EVEN_DATA1(a) __tp_cb_data
63ef2693 MD	93	#define _TP_EVEN_DATA2(a,b) __tp_cb_data,b
	94	#define _TP_EVEN_DATA4(a,b,c,d) __tp_cb_data,b,d
	95	#define _TP_EVEN_DATA6(a,b,c,d,e,f) __tp_cb_data,b,d,f
	96	#define _TP_EVEN_DATA8(a,b,c,d,e,f,g,h) __tp_cb_data,b,d,f,h
	97	#define _TP_EVEN_DATA10(a,b,c,d,e,f,g,h,i,j) __tp_cb_data,b,d,f,h,j
	98	#define _TP_EVEN_DATA12(a,b,c,d,e,f,g,h,i,j,k,l) __tp_cb_data,b,d,f,h,j,l
	99	#define _TP_EVEN_DATA14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) __tp_cb_data,b,d,f,h,j,l,n
	100	#define _TP_EVEN_DATA16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p) __tp_cb_data,b,d,f,h,j,l,n,p
	101	#define _TP_EVEN_DATA18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r) __tp_cb_data,b,d,f,h,j,l,n,p,r
	102	#define _TP_EVEN_DATA20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t) __tp_cb_data,b,d,f,h,j,l,n,p,r,t
	103
	104	/* _TP_SPLIT extracts tuples of type, var */
992abe11	105	/* 0 and 1 are for void */
63ef2693	106	#define _TP_SPLIT0()
992abe11	107	#define _TP_SPLIT1(a)
63ef2693 MD	108	#define _TP_SPLIT2(a,b) a b
	109	#define _TP_SPLIT4(a,b,c,d) a b,c d
	110	#define _TP_SPLIT6(a,b,c,d,e,f) a b,c d,e f
	111	#define _TP_SPLIT8(a,b,c,d,e,f,g,h) a b,c d,e f,g h
	112	#define _TP_SPLIT10(a,b,c,d,e,f,g,h,i,j) a b,c d,e f,g h,i j
	113	#define _TP_SPLIT12(a,b,c,d,e,f,g,h,i,j,k,l) a b,c d,e f,g h,i j,k l
	114	#define _TP_SPLIT14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) a b,c d,e f,g h,i j,k l,m n
	115	#define _TP_SPLIT16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p) a b,c d,e f,g h,i j,k l,m n,o p
	116	#define _TP_SPLIT18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r) a b,c d,e f,g h,i j,k l,m n,o p,q r
	117	#define _TP_SPLIT20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t) a b,c d,e f,g h,i j,k l,m n,o p,q r,s t
	118
992abe11	119	/* 0 and 1 are for void */
63ef2693	120	#define _TP_SPLIT_DATA0() void *__tp_cb_data
992abe11	121	#define _TP_SPLIT_DATA1(a) void *__tp_cb_data
63ef2693 MD	122	#define _TP_SPLIT_DATA2(a,b) void *__tp_cb_data,a b
	123	#define _TP_SPLIT_DATA4(a,b,c,d) void *__tp_cb_data,a b,c d
	124	#define _TP_SPLIT_DATA6(a,b,c,d,e,f) void *__tp_cb_data,a b,c d,e f
	125	#define _TP_SPLIT_DATA8(a,b,c,d,e,f,g,h) void *__tp_cb_data,a b,c d,e f,g h
	126	#define _TP_SPLIT_DATA10(a,b,c,d,e,f,g,h,i,j) void *__tp_cb_data,a b,c d,e f,g h,i j
	127	#define _TP_SPLIT_DATA12(a,b,c,d,e,f,g,h,i,j,k,l) void *__tp_cb_data,a b,c d,e f,g h,i j,k l
	128	#define _TP_SPLIT_DATA14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) void *__tp_cb_data,a b,c d,e f,g h,i j,k l,m n
	129	#define _TP_SPLIT_DATA16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p) void *__tp_cb_data,a b,c d,e f,g h,i j,k l,m n,o p
	130	#define _TP_SPLIT_DATA18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r) void *__tp_cb_data,a b,c d,e f,g h,i j,k l,m n,o p,q r
	131	#define _TP_SPLIT_DATA20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t) void *__tp_cb_data,a b,c d,e f,g h,i j,k l,m n,o p,q r,s t
	132
	133	/* Preprocessor trick to count arguments. Inspired from sdt.h. */
	134	#define _TP_NARGS(...) __TP_NARGS(__VA_ARGS__, 20,19,18,17,16,15,14,13,12,11,10,9,8,7,6,5,4,3,2,1,0)
	135	#define __TP_NARGS(_0,_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,_11,_12,_13,_14,_15,_16,_17,_18,_19,_20, N, ...) N
	136	#define _TP_PROTO_N(N, ...) \
	137	TP_PARAMS(TP_COMBINE_TOKENS(_TP_SPLIT, N)(__VA_ARGS__))
	138	#define _TP_VARS_N(N, ...) \
	139	TP_PARAMS(TP_COMBINE_TOKENS(_TP_EVEN, N)(__VA_ARGS__))
	140	#define _TP_PROTO_DATA_N(N, ...) \
	141	TP_PARAMS(TP_COMBINE_TOKENS(_TP_SPLIT_DATA, N)(__VA_ARGS__))
	142	#define _TP_VARS_DATA_N(N, ...) \
	143	TP_PARAMS(TP_COMBINE_TOKENS(_TP_EVEN_DATA, N)(__VA_ARGS__))
	144
	145	#define _TP_ARGS_PROTO(...) _TP_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
	146	#define _TP_ARGS_VARS(...) _TP_VARS_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
	147
	148	#define _TP_ARGS_PROTO_DATA(...) _TP_PROTO_DATA_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
	149	#define _TP_ARGS_VARS_DATA(...) _TP_VARS_DATA_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
81614639	150
7083f0fe	151	#define __CHECK_TRACE(provider, name, proto, args) \
f99be407	152	do { \
7083f0fe MD	153	if (caa_unlikely(__tracepoint_##provider##___##name.state)) \
7083f0fe MD	154	__DO_TRACE(&__tracepoint_##provider##___##name, \
63ef2693	155	TP_PARAMS(proto), TP_PARAMS(args)); \
f99be407 PMF	156	} while (0)
	157
	158	/*
	159	* Make sure the alignment of the structure in the __tracepoints section will
	160	* not add unwanted padding between the beginning of the section and the
	161	* structure. Force alignment to the same alignment as the section start.
f99be407	162	*/
7083f0fe MD	163	#define __DECLARE_TRACEPOINT(provider, name, proto, args, data_proto, data_args) \
	164	extern struct tracepoint __tracepoint_##provider##___##name; \
	165	static inline void __trace_##provider##___##name(proto) \
f99be407	166	{ \
63ef2693 MD	167	__CHECK_TRACE(provider, name, TP_PARAMS(data_proto), \
63ef2693 MD	168	TP_PARAMS(data_args)); \
f99be407	169	} \
9dec086e	170	static inline int \
7083f0fe	171	__register_trace_##provider##___##name(void (probe)(data_proto), void data) \
f99be407	172	{ \
7083f0fe	173	return __tracepoint_probe_register(#provider ":" #name, (void *) probe, \
9dec086e	174	data); \
f99be407	175	} \
9dec086e	176	static inline int \
7083f0fe	177	__unregister_trace_##provider##___##name(void (probe)(data_proto), void data) \
f99be407	178	{ \
7083f0fe	179	return __tracepoint_probe_unregister(#provider ":" #name, (void *) probe, \
9dec086e	180	data); \
f99be407 PMF	181	}
f99be407 PMF	182
63ef2693 MD	183	#define _DECLARE_TRACEPOINT(provider, name, args) \
	184	__DECLARE_TRACEPOINT(provider, name, _TP_ARGS_PROTO(args), _TP_ARGS_VARS(args), \
	185	_TP_ARGS_PROTO_DATA(args), _TP_ARGS_VARS_DATA(args))
9dec086e	186
f99be407	187	/*
81614639 MD	188	* __tracepoints_ptrs section is not const (read-only) to let the linker update
81614639 MD	189	* the pointer, allowing PIC code.
f99be407	190	*/
7083f0fe MD	191	#define _DEFINE_TRACEPOINT(provider, name) \
	192	static const char __tpstrtab_##provider##___##name[] \
	193	__attribute__((section("__tracepoints_strings"))) = \
	194	#provider ":" #name; \
	195	struct tracepoint __tracepoint_##provider##___##name \
81614639	196	__attribute__((section("__tracepoints"))) = \
7083f0fe MD	197	{ __tpstrtab_##provider##___##name, 0, NULL }; \
7083f0fe MD	198	static struct tracepoint * __tracepoint_ptr_##provider##___##name \
81614639	199	__attribute__((used, section("__tracepoints_ptrs"))) = \
7083f0fe	200	&__tracepoint_##provider##___##name;
f99be407	201
f99be407	202
7083f0fe MD	203	#define __register_tracepoint(provider, name, probe, data) \
	204	__register_trace_##provider##___##name(probe, data)
	205	#define __unregister_tracepoint(provider, name, probe, data) \
	206	__unregister_trace_##provider##___##name(probe, data)
f99be407	207
81614639 MD	208	/*
	209	* Connect a probe to a tracepoint.
	210	* Internal API.
	211	*/
	212	extern
	213	int __tracepoint_probe_register(const char name, void probe, void *data);
f99be407 PMF	214
f99be407 PMF	215	/*
81614639 MD	216	* Disconnect a probe from a tracepoint.
81614639 MD	217	* Internal API.
f99be407	218	*/
81614639 MD	219	extern
81614639 MD	220	int __tracepoint_probe_unregister(const char name, void probe, void *data);
f99be407	221
81614639 MD	222	extern
	223	int tracepoint_register_lib(struct tracepoint * const *tracepoints_start,
	224	int tracepoints_count);
	225	extern
	226	int tracepoint_unregister_lib(struct tracepoint * const *tracepoints_start);
872037bb	227
6cdf29f8 MD	228	/*
	229	* These weak symbols, the constructor, and destructor take care of
	230	* registering only _one_ instance of the tracepoints per shared-ojbect
	231	* (or for the whole main program).
6cdf29f8 MD	232	*/
	233	extern struct tracepoint * const __start___tracepoints_ptrs[]
	234	__attribute__((weak, visibility("hidden")));
	235	extern struct tracepoint * const __stop___tracepoints_ptrs[]
	236	__attribute__((weak, visibility("hidden")));
	237	int __tracepoint_registered
	238	__attribute__((weak, visibility("hidden")));
	239
	240	static void __attribute__((constructor)) __tracepoints__init(void)
	241	{
	242	if (__tracepoint_registered++)
	243	return;
	244	tracepoint_register_lib(__start___tracepoints_ptrs,
	245	__stop___tracepoints_ptrs -
	246	__start___tracepoints_ptrs);
	247	}
	248
	249	static void __attribute__((destructor)) __tracepoints__destroy(void)
	250	{
	251	if (--__tracepoint_registered)
	252	return;
	253	tracepoint_unregister_lib(__start___tracepoints_ptrs);
	254	}
22d72948	255
9e0e41bf MD	256	#ifdef __cplusplus
	257	}
	258	#endif
	259
	260	#endif /* _LTTNG_TRACEPOINT_H */
	261
	262	/*
	263	* For multiple probe generation, we need to redefine TRACEPOINT_EVENT
	264	* each time tracepoint.h is included.
	265	*/
	266
8d71973c	267	#ifndef TRACEPOINT_EVENT
22d72948	268	/*
d75775a6 MD	269	* Usage of the TRACEPOINT_EVENT macro:
	270	*
	271	* In short, an example:
	272	*
7083f0fe	273	* TRACEPOINT_EVENT(< [com_company_]project[_component] >, < event >,
63ef2693 MD	274	*
	275	* * TP_ARGS takes from 0 to 10 "type, field_name" pairs *
	276	*
	277	* TP_ARGS(int, arg0, void , arg1, char , string, size_t, strlen,
	278	* long *, arg4, size_t, arg4_len),
d75775a6 MD	279	* TP_FIELDS(
	280	*
	281	* * Integer, printed in base 10 *
	282	* ctf_integer(int, field_a, arg0)
	283	*
	284	* * Integer, printed with 0x base 16 *
	285	* ctf_integer_hex(unsigned long, field_d, arg1)
	286	*
	287	* * Array Sequence, printed as UTF8-encoded array of bytes *
	288	* ctf_array_text(char, field_b, string, FIXED_LEN)
	289	* ctf_sequence_text(char, field_c, string, size_t, strlen)
	290	*
	291	* * String, printed as UTF8-encoded string *
	292	* ctf_string(field_e, string)
	293	*
	294	* * Array sequence of signed integer values *
	295	* ctf_array(long, field_f, arg4, FIXED_LEN4)
	296	* ctf_sequence(long, field_g, arg4, size_t, arg4_len)
	297	* )
	298	* )
	299	*
	300	* In more detail:
22d72948	301	*
0a42beb6 MD	302	* We define a tracepoint, its arguments, and its 'fast binary record'
0a42beb6 MD	303	* layout.
22d72948	304	*
7083f0fe	305	* Firstly, name your tracepoint via TRACEPOINT_EVENT(provider, name,
22d72948	306	*
7083f0fe MD	307	* The provider and name should be a proper C99 identifier.
	308	* The "provider" and "name" MUST follow these rules to ensure no
	309	* namespace clash occurs:
22d72948	310	*
0a42beb6 MD	311	* For projects (applications and libraries) for which an entity
	312	* specific to the project controls the source code and thus its
	313	* tracepoints (typically with a scope larger than a single company):
22d72948	314	*
0a42beb6	315	* either:
7083f0fe	316	* project_component, event
0a42beb6	317	* or:
7083f0fe	318	* project, event
0a42beb6 MD	319	*
0a42beb6 MD	320	* Where "project" is the name of the project,
d5001b43 MD	321	* "component" is the name of the project component (which may
	322	* include several levels of sub-components, e.g.
	323	* ...component_subcomponent_...) where the tracepoint is located
	324	* (optional),
0a42beb6 MD	325	* "event" is the name of the tracepoint event.
	326	*
	327	* For projects issued from a single company wishing to advertise that
	328	* the company controls the source code and thus the tracepoints, the
	329	* "com_" prefix should be used:
	330	*
	331	* either:
7083f0fe	332	* com_company_project_component, event
0a42beb6	333	* or:
7083f0fe	334	* com_company_project, event
0a42beb6 MD	335	*
	336	* Where "company" is the name of the company,
	337	* "project" is the name of the project,
d5001b43 MD	338	* "component" is the name of the project component (which may
	339	* include several levels of sub-components, e.g.
	340	* ...component_subcomponent_...) where the tracepoint is located
	341	* (optional),
0a42beb6 MD	342	* "event" is the name of the tracepoint event.
0a42beb6 MD	343	*
b43de1e7	344	* the provider:event identifier is limited to 127 characters.
0a42beb6 MD	345	*
	346	* As an example, let's consider a user-space application "someproject"
	347	* that would have an internal thread scheduler:
	348	*
7083f0fe	349	* TRACEPOINT_EVENT(someproject_sched, switch,
22d72948 NC	350	*
22d72948 NC	351	* *
63ef2693 MD	352	* * Arguments to pass to the tracepoint. Supports from
63ef2693 MD	353	* * 0 to 10 "type, name" tuples.
22d72948 NC	354	* *
22d72948 NC	355	*
63ef2693 MD	356	* TP_ARGS(struct rq , rq, struct task_struct , prev,
63ef2693 MD	357	* struct task_struct *, next),
22d72948 NC	358	*
	359	* *
	360	* * Fast binary tracing: define the trace record via
81614639	361	* * TP_FIELDS(). You can think about it like a
22d72948 NC	362	* * regular C structure local variable definition.
	363	* *
	364	* * This is how the trace record is structured and will
	365	* * be saved into the ring buffer. These are the fields
	366	* * that will be exposed to readers.
	367	* *
0a42beb6	368	* * ctf_integer(pid_t, prev_pid, prev->pid) is equivalent
81614639	369	* * to a standard declaraton:
22d72948	370	* *
81614639	371	* * pid_t prev_pid;
22d72948	372	* *
81614639	373	* * followed by an assignment:
22d72948	374	* *
81614639	375	* * prev_pid = prev->pid;
22d72948	376	* *
0a42beb6	377	* * ctf_array(char, prev_comm, prev->comm, TASK_COMM_LEN) is
81614639	378	* * equivalent to:
22d72948	379	* *
81614639	380	* * char prev_comm[TASK_COMM_LEN];
22d72948	381	* *
81614639	382	* * followed by an assignment:
22d72948	383	* *
81614639	384	* * memcpy(prev_comm, prev->comm, TASK_COMM_LEN);
22d72948 NC	385	* *
22d72948 NC	386	*
81614639	387	* TP_FIELDS(
0a42beb6 MD	388	* ctf_array(char, prev_comm, prev->comm, TASK_COMM_LEN)
	389	* ctf_integer(pid_t, prev_pid, prev->pid)
	390	* ctf_integer(int, prev_prio, prev->prio)
	391	* ctf_array(char, next_comm, next->comm, TASK_COMM_LEN)
	392	* ctf_integer(pid_t, next_pid, next->pid)
	393	* ctf_integer(int, next_prio, next->prio)
22d72948	394	* )
0a42beb6	395	* )
abcdecad MD	396	*
	397	* Do _NOT_ add comma (,) nor semicolon (;) after the TRACEPOINT_EVENT
	398	* declaration.
	399	*
a4ada9b8	400	* The TRACEPOINT_PROVIDER must be defined when declaring a
abcdecad MD	401	* TRACEPOINT_EVENT. See ust/tracepoint-event.h for information about
abcdecad MD	402	* usage of other macros controlling TRACEPOINT_EVENT.
22d72948 NC	403	*/
22d72948 NC	404
63ef2693 MD	405	#define TRACEPOINT_EVENT(provider, name, args, fields) \
63ef2693 MD	406	_DECLARE_TRACEPOINT(provider, name, TP_PARAMS(args))
0c0686ee	407
63ef2693 MD	408	#define TRACEPOINT_EVENT_CLASS(provider, name, args, fields)
	409	#define TRACEPOINT_EVENT_INSTANCE(provider, template, name, args)\
	410	_DECLARE_TRACEPOINT(provider, name, TP_PARAMS(args))
0c0686ee	411
81614639	412	#endif /* #ifndef TRACEPOINT_EVENT */
22d72948	413
abcdecad MD	414	#ifndef TRACEPOINT_LOGLEVEL
	415
	416	/*
	417	* Tracepoint Loglevel Declaration Facility
	418	*
	419	* This is a place-holder the tracepoint loglevel declaration,
	420	* overridden by the tracer implementation.
	421	*
	422	* Typical use of these loglevels:
	423	*
	424	* 1) Declare the mapping between loglevel names and an integer values
	425	* within TRACEPOINT_LOGLEVEL_ENUM, using TP_LOGLEVEL for each tuple.
	426	* Do _NOT_ add comma (,) nor semicolon (;) between the
	427	* TRACEPOINT_LOGLEVEL_ENUM entries. Do _NOT_ add comma (,) nor
	428	* semicolon (;) after the TRACEPOINT_LOGLEVEL_ENUM declaration. The
	429	* name should be a proper C99 identifier.
	430	*
	431	* TRACEPOINT_LOGLEVEL_ENUM(
	432	* TP_LOGLEVEL( < loglevel_name >, < value > )
	433	* TP_LOGLEVEL( < loglevel_name >, < value > )
	434	* ...
	435	* )
	436	*
	437	* e.g.:
	438	*
	439	* TRACEPOINT_LOGLEVEL_ENUM(
	440	* TP_LOGLEVEL(LOG_EMERG, 0)
	441	* TP_LOGLEVEL(LOG_ALERT, 1)
	442	* TP_LOGLEVEL(LOG_CRIT, 2)
	443	* TP_LOGLEVEL(LOG_ERR, 3)
	444	* TP_LOGLEVEL(LOG_WARNING, 4)
	445	* TP_LOGLEVEL(LOG_NOTICE, 5)
	446	* TP_LOGLEVEL(LOG_INFO, 6)
	447	* TP_LOGLEVEL(LOG_DEBUG, 7)
	448	* )
	449	*
e9f37b4c MD	450	* 2) Then, declare tracepoint loglevels for tracepoints. A
	451	* TRACEPOINT_EVENT should be declared prior to the the
	452	* TRACEPOINT_LOGLEVEL for a given tracepoint name. The first field
	453	* is the name of the tracepoint, the second field is the loglevel
	454	* name.
abcdecad	455	*
7083f0fe	456	* TRACEPOINT_LOGLEVEL(< [com_company_]project[_component] >, < event >,
abcdecad MD	457	* < loglevel_name >)
abcdecad MD	458	*
a4ada9b8	459	* The TRACEPOINT_PROVIDER must be defined when declaring a
abcdecad	460	* TRACEPOINT_LOGLEVEL_ENUM and TRACEPOINT_LOGLEVEL. The tracepoint
a4ada9b8	461	* loglevel enumeration apply to the entire TRACEPOINT_PROVIDER. Only one
abcdecad	462	* tracepoint loglevel enumeration should be declared per tracepoint
a4ada9b8	463	* provider.
abcdecad MD	464	*/
	465
	466	#define TRACEPOINT_LOGLEVEL_ENUM()
	467	#define TRACEPOINT_LOGLEVEL(name, loglevel)
	468
	469	#endif /* #ifndef TRACEPOINT_LOGLEVEL */