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

#ifndef _LTTNG_TRACEPOINT_H
#define _LTTNG_TRACEPOINT_H

/*
 * Copyright (c) 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
 * OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.
 *
 * Permission is hereby granted to use or copy this program
 * for any purpose,  provided the above notices are retained on all copies.
 * Permission to modify the code and to distribute modified code is granted,
 * provided the above notices are retained, and a notice that the code was
 * modified is included with the above copyright notice.
 */

#include <lttng/tracepoint-types.h>
#include <lttng/tracepoint-rcu.h>
#include <urcu/compiler.h>
#include <dlfcn.h>	/* for dlopen */
#include <assert.h>

#ifdef __cplusplus
extern "C" {
#endif

#define tracepoint(provider, name, ...)					    \
	do {								    \
		if (caa_unlikely(__tracepoint_##provider##___##name.state)) \
			__tracepoint_cb_##provider##___##name(__VA_ARGS__); \
	} while (0)

#define TP_ARGS(...)       __VA_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_TOKENS(_tokena, _tokenb)				\
		_tokena##_tokenb
#define _TP_COMBINE_TOKENS(_tokena, _tokenb)				\
		__TP_COMBINE_TOKENS(_tokena, _tokenb)
#define __TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc)			\
		_tokena##_tokenb##_tokenc
#define _TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc)			\
		__TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc)
#define __TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend)	\
		_tokena##_tokenb##_tokenc##_tokend
#define _TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend)		\
		__TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend)

/* _TP_EXVAR* extract the var names. */
#define _TP_EXVAR0()
#define _TP_EXVAR2(a,b)						b
#define _TP_EXVAR4(a,b,c,d)					b,d
#define _TP_EXVAR6(a,b,c,d,e,f)					b,d,f
#define _TP_EXVAR8(a,b,c,d,e,f,g,h)				b,d,f,h
#define _TP_EXVAR10(a,b,c,d,e,f,g,h,i,j)			b,d,f,h,j
#define _TP_EXVAR12(a,b,c,d,e,f,g,h,i,j,k,l)			b,d,f,h,j,l
#define _TP_EXVAR14(a,b,c,d,e,f,g,h,i,j,k,l,m,n)		b,d,f,h,j,l,n
#define _TP_EXVAR16(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_EXVAR18(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_EXVAR20(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

#define _TP_EXDATA_VAR0()						__tp_data
#define _TP_EXDATA_VAR2(a,b)						__tp_data,b
#define _TP_EXDATA_VAR4(a,b,c,d)					__tp_data,b,d
#define _TP_EXDATA_VAR6(a,b,c,d,e,f)					__tp_data,b,d,f
#define _TP_EXDATA_VAR8(a,b,c,d,e,f,g,h)				__tp_data,b,d,f,h
#define _TP_EXDATA_VAR10(a,b,c,d,e,f,g,h,i,j)				__tp_data,b,d,f,h,j
#define _TP_EXDATA_VAR12(a,b,c,d,e,f,g,h,i,j,k,l)			__tp_data,b,d,f,h,j,l
#define _TP_EXDATA_VAR14(a,b,c,d,e,f,g,h,i,j,k,l,m,n)			__tp_data,b,d,f,h,j,l,n
#define _TP_EXDATA_VAR16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p)		__tp_data,b,d,f,h,j,l,n,p
#define _TP_EXDATA_VAR18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r)		__tp_data,b,d,f,h,j,l,n,p,r
#define _TP_EXDATA_VAR20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t)	__tp_data,b,d,f,h,j,l,n,p,r,t

/* _TP_EXPROTO* extract tuples of type, var */
#define _TP_EXPROTO0()
#define _TP_EXPROTO2(a,b)					a b
#define _TP_EXPROTO4(a,b,c,d)					a b,c d
#define _TP_EXPROTO6(a,b,c,d,e,f)				a b,c d,e f
#define _TP_EXPROTO8(a,b,c,d,e,f,g,h)				a b,c d,e f,g h
#define _TP_EXPROTO10(a,b,c,d,e,f,g,h,i,j)			a b,c d,e f,g h,i j
#define _TP_EXPROTO12(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_EXPROTO14(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_EXPROTO16(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_EXPROTO18(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_EXPROTO20(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

#define _TP_EXDATA_PROTO0()						void *__tp_data
#define _TP_EXDATA_PROTO2(a,b)						void *__tp_data,a b
#define _TP_EXDATA_PROTO4(a,b,c,d)					void *__tp_data,a b,c d
#define _TP_EXDATA_PROTO6(a,b,c,d,e,f)					void *__tp_data,a b,c d,e f
#define _TP_EXDATA_PROTO8(a,b,c,d,e,f,g,h)				void *__tp_data,a b,c d,e f,g h
#define _TP_EXDATA_PROTO10(a,b,c,d,e,f,g,h,i,j)				void *__tp_data,a b,c d,e f,g h,i j
#define _TP_EXDATA_PROTO12(a,b,c,d,e,f,g,h,i,j,k,l)			void *__tp_data,a b,c d,e f,g h,i j,k l
#define _TP_EXDATA_PROTO14(a,b,c,d,e,f,g,h,i,j,k,l,m,n)			void *__tp_data,a b,c d,e f,g h,i j,k l,m n
#define _TP_EXDATA_PROTO16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p)		void *__tp_data,a b,c d,e f,g h,i j,k l,m n,o p
#define _TP_EXDATA_PROTO18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r)		void *__tp_data,a b,c d,e f,g h,i j,k l,m n,o p,q r
#define _TP_EXDATA_PROTO20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t)	void *__tp_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_EXPROTO, N)(__VA_ARGS__))
#define _TP_VAR_N(N, ...)		_TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXVAR, N)(__VA_ARGS__))
#define _TP_DATA_PROTO_N(N, ...)	_TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXDATA_PROTO, N)(__VA_ARGS__))
#define _TP_DATA_VAR_N(N, ...)		_TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXDATA_VAR, N)(__VA_ARGS__))
#define _TP_ARGS_PROTO(...)		_TP_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
#define _TP_ARGS_VAR(...)		_TP_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
#define _TP_ARGS_DATA_PROTO(...)	_TP_DATA_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
#define _TP_ARGS_DATA_VAR(...)		_TP_DATA_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
#define _TP_PARAMS(...)			__VA_ARGS__

#define _DECLARE_TRACEPOINT(provider, name, ...)			 		\
extern struct tracepoint __tracepoint_##provider##___##name;				\
static inline void __tracepoint_cb_##provider##___##name(_TP_ARGS_PROTO(__VA_ARGS__))	\
{											\
	struct tracepoint_probe *__tp_probe;						\
											\
	if (!TP_RCU_LINK_TEST())							\
		return;									\
	tp_rcu_read_lock_bp();								\
	__tp_probe = tp_rcu_dereference_bp(__tracepoint_##provider##___##name.probes);	\
	if (caa_unlikely(!__tp_probe))							\
		goto end;								\
	do {										\
		void *__tp_cb =	__tp_probe->func;					\
		void *__tp_data = __tp_probe->data;					\
											\
		URCU_FORCE_CAST(void (*)(_TP_ARGS_DATA_PROTO(__VA_ARGS__)), __tp_cb)	\
				(_TP_ARGS_DATA_VAR(__VA_ARGS__));			\
	} while ((++__tp_probe)->func);							\
end:											\
	tp_rcu_read_unlock_bp();							\
}											\
static inline void __tracepoint_register_##provider##___##name(char *name,		\
		void *func, void *data)							\
{											\
	__tracepoint_probe_register(name, func, data);					\
}											\
static inline void __tracepoint_unregister_##provider##___##name(char *name,		\
		void *func, void *data)							\
{											\
	__tracepoint_probe_unregister(name, func, data);				\
}

extern int __tracepoint_probe_register(const char *name, void *func, void *data);
extern int __tracepoint_probe_unregister(const char *name, void *func, void *data);

#ifdef TRACEPOINT_DEFINE

/*
 * When TRACEPOINT_PROBE_DYNAMIC_LINKAGE is defined, we do not emit a
 * unresolved symbol that requires the provider to be linked in. When
 * TRACEPOINT_PROBE_DYNAMIC_LINKAGE is not defined, we emit an
 * unresolved symbol that depends on having the provider linked in,
 * otherwise the linker complains. This deals with use of static
 * libraries, ensuring that the linker does not remove the provider
 * object from the executable.
 */
#ifdef TRACEPOINT_PROBE_DYNAMIC_LINKAGE
#define _TRACEPOINT_UNDEFINED_REF(provider)
#else	/* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
#define _TRACEPOINT_UNDEFINED_REF(provider)	\
	&__tracepoint_provider_##provider,
#endif /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */

/*
 * Note: to allow PIC code, we need to allow the linker to update the pointers
 * in the __tracepoints_ptrs section.
 * Therefore, this section is _not_ const (read-only).
 */
#define _DEFINE_TRACEPOINT(provider, name)					\
	extern int __tracepoint_provider_##provider; 				\
	static const char __tp_strtab_##provider##___##name[]			\
		__attribute__((section("__tracepoints_strings"))) =		\
			#provider ":" #name;					\
	struct tracepoint __tracepoint_##provider##___##name			\
		__attribute__((section("__tracepoints"))) =			\
			{ __tp_strtab_##provider##___##name, 0, NULL, _TRACEPOINT_UNDEFINED_REF(provider) };		\
	static struct tracepoint * __tracepoint_ptr_##provider##___##name	\
		__attribute__((used, section("__tracepoints_ptrs"))) =		\
			&__tracepoint_##provider##___##name;

static int (*tracepoint_register_lib)(struct tracepoint * const *tracepoints_start,
		int tracepoints_count);
static int (*tracepoint_unregister_lib)(struct tracepoint * const *tracepoints_start);
static void *liblttngust_handle;

/*
 * 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;

	liblttngust_handle = dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW | RTLD_GLOBAL);
	if (!liblttngust_handle)
		return;
	tracepoint_register_lib =
		URCU_FORCE_CAST(int (*)(struct tracepoint * const *, int),
				dlsym(liblttngust_handle,
					"tracepoint_register_lib"));
	tracepoint_unregister_lib =
		URCU_FORCE_CAST(int (*)(struct tracepoint * const *),
				dlsym(liblttngust_handle,
					"tracepoint_unregister_lib"));
#ifndef _LGPL_SOURCE
	tp_rcu_read_lock_bp =
		URCU_FORCE_CAST(void (*)(void),
				dlsym(liblttngust_handle,
					"tp_rcu_read_lock_bp"));
	tp_rcu_read_unlock_bp =
		URCU_FORCE_CAST(void (*)(void),
				dlsym(liblttngust_handle,
					"tp_rcu_read_unlock_bp"));
	tp_rcu_dereference_sym_bp =
		URCU_FORCE_CAST(void *(*)(void *p),
				dlsym(liblttngust_handle,
					"tp_rcu_dereference_sym_bp"));
#endif
	tracepoint_register_lib(__start___tracepoints_ptrs,
				__stop___tracepoints_ptrs -
				__start___tracepoints_ptrs);
}

static void __attribute__((destructor)) __tracepoints__destroy(void)
{
	int ret;
	if (--__tracepoint_registered)
		return;
	if (tracepoint_unregister_lib)
		tracepoint_unregister_lib(__start___tracepoints_ptrs);
	if (liblttngust_handle) {
		tracepoint_unregister_lib = NULL;
		tracepoint_register_lib = NULL;
		ret = dlclose(liblttngust_handle);
		assert(!ret);
	}
}

#else /* TRACEPOINT_DEFINE */

#define _DEFINE_TRACEPOINT(provider, name)

#endif /* #else TRACEPOINT_DEFINE */

#ifdef __cplusplus
}
#endif

#endif /* _LTTNG_TRACEPOINT_H */

/* The following declarations must be outside re-inclusion protection. */

#ifndef TRACEPOINT_EVENT

/*
 * How to use the TRACEPOINT_EVENT macro:
 *
 * An example:
 * 
 * TRACEPOINT_EVENT(someproject_component, event_name,
 *
 *     * 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 describes the event payload layout in the trace *
 *
 *     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)
 *     )
 * )
 *
 * More detailed explanation:
 *
 * The name of the tracepoint is expressed as a tuple with the provider
 * and name arguments.
 *
 * 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.
 */

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

#define TRACEPOINT_EVENT_CLASS(provider, name, args, fields)

#define TRACEPOINT_EVENT_INSTANCE(provider, _template, name, args)	\
	_DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args))		\
	_DEFINE_TRACEPOINT(provider, name)

#endif /* #ifndef TRACEPOINT_EVENT */

#ifndef TRACEPOINT_LOGLEVEL

/*
 * Tracepoint Loglevels
 *
 * Typical use of these loglevels:
 *
 * The loglevels go from 0 to 15. Higher numbers imply the most
 * verbosity (higher event throughput expected.
 *
 * Loglevels 0 through 6, and loglevel 15, match syslog(3) loglevels
 * semantic. Loglevels 7 through 14 offer more fine-grained selection of
 * traced information.
 *
 * TRACE_EMERG    0
 * system is unusable
 *
 * TRACE_ALERT    1
 * action must be taken immediately
 *
 * TRACE_CRIT     2
 * critical conditions
 *
 * TRACE_ERR      3
 * error conditions
 *
 * TRACE_WARNING  4
 * warning conditions
 *
 * TRACE_NOTICE   5
 * normal, but significant, condition
 *
 * TRACE_INFO     6
 * informational message
 *
 * TRACE_SYSTEM   7
 * information has system-level scope (set of programs)
 *
 * TRACE_PROGRAM  8
 * information has program-level scope (set of processes)
 *
 * TRACE_PROCESS  9
 * information has process-level scope (set of modules)
 *
 * TRACE_MODULE   10
 * information has module (executable/library) scope (set of units)
 *
 * TRACE_UNIT     11
 * information has compilation unit scope (set of functions)
 *
 * TRACE_FUNCTION 12
 * information has function-level scope
 *
 * TRACE_DEFAULT  13
 * default trace loglevel (TRACEPOINT_EVENT default)
 *
 * TRACE_VERBOSE  14
 * verbose information
 *
 * TRACE_DEBUG    15
 * debug-level message (trace_printf default)
 *
 * 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 already declared before declaring a
 * TRACEPOINT_LOGLEVEL.
 */

enum {
	TRACE_EMERG	= 0,
	TRACE_ALERT	= 1,
	TRACE_CRIT	= 2,
	TRACE_ERR	= 3,
	TRACE_WARNING	= 4,
	TRACE_NOTICE	= 5,
	TRACE_INFO	= 6,
	TRACE_SYSTEM	= 7,
	TRACE_PROGRAM   = 8,
	TRACE_PROCESS	= 9,
	TRACE_MODULE	= 10,
	TRACE_UNIT	= 11,
	TRACE_FUNCTION	= 12,
	TRACE_DEFAULT	= 13,
	TRACE_VERBOSE	= 14,
	TRACE_DEBUG	= 15,
};

#define TRACEPOINT_LOGLEVEL(provider, name, loglevel)

#endif /* #ifndef TRACEPOINT_LOGLEVEL */
Commit	Line	Data
b728d87e MD	1	#ifndef _LTTNG_TRACEPOINT_H
	2	#define _LTTNG_TRACEPOINT_H
	3
	4	/*
	5	* Copyright (c) 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	6	*
	7	* THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
	8	* OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
	9	*
	10	* Permission is hereby granted to use or copy this program
	11	* for any purpose, provided the above notices are retained on all copies.
	12	* Permission to modify the code and to distribute modified code is granted,
	13	* provided the above notices are retained, and a notice that the code was
	14	* modified is included with the above copyright notice.
	15	*/
	16
8fce9e2b	17	#include <lttng/tracepoint-types.h>
40b2b5a4	18	#include <lttng/tracepoint-rcu.h>
b728d87e	19	#include <urcu/compiler.h>
deb6e540	20	#include <dlfcn.h> /* for dlopen */
40b2b5a4	21	#include <assert.h>
b728d87e MD	22
	23	#ifdef __cplusplus
	24	extern "C" {
	25	#endif
	26
23c8854a MD	27	#define tracepoint(provider, name, ...) \
	28	do { \
	29	if (caa_unlikely(__tracepoint_##provider##___##name.state)) \
	30	__tracepoint_cb_##provider##___##name(__VA_ARGS__); \
b728d87e MD	31	} while (0)
	32
	33	#define TP_ARGS(...) __VA_ARGS__
	34
	35	/*
	36	* TP_ARGS takes tuples of type, argument separated by a comma.
	37	* It can take up to 10 tuples (which means that less than 10 tuples is
	38	* fine too).
	39	* Each tuple is also separated by a comma.
	40	*/
df854e41 MD	41	#define __TP_COMBINE_TOKENS(_tokena, _tokenb) \
	42	_tokena##_tokenb
	43	#define _TP_COMBINE_TOKENS(_tokena, _tokenb) \
	44	__TP_COMBINE_TOKENS(_tokena, _tokenb)
	45	#define __TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc) \
	46	_tokena##_tokenb##_tokenc
	47	#define _TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc) \
	48	__TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc)
	49	#define __TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend) \
	50	_tokena##_tokenb##_tokenc##_tokend
	51	#define _TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend) \
	52	__TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend)
b728d87e	53
23c8854a	54	/* _TP_EXVAR* extract the var names. */
b728d87e MD	55	#define _TP_EXVAR0()
	56	#define _TP_EXVAR2(a,b) b
	57	#define _TP_EXVAR4(a,b,c,d) b,d
	58	#define _TP_EXVAR6(a,b,c,d,e,f) b,d,f
	59	#define _TP_EXVAR8(a,b,c,d,e,f,g,h) b,d,f,h
	60	#define _TP_EXVAR10(a,b,c,d,e,f,g,h,i,j) b,d,f,h,j
	61	#define _TP_EXVAR12(a,b,c,d,e,f,g,h,i,j,k,l) b,d,f,h,j,l
	62	#define _TP_EXVAR14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) b,d,f,h,j,l,n
	63	#define _TP_EXVAR16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p) b,d,f,h,j,l,n,p
	64	#define _TP_EXVAR18(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
	65	#define _TP_EXVAR20(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
	66
	67	#define _TP_EXDATA_VAR0() __tp_data
	68	#define _TP_EXDATA_VAR2(a,b) __tp_data,b
	69	#define _TP_EXDATA_VAR4(a,b,c,d) __tp_data,b,d
	70	#define _TP_EXDATA_VAR6(a,b,c,d,e,f) __tp_data,b,d,f
	71	#define _TP_EXDATA_VAR8(a,b,c,d,e,f,g,h) __tp_data,b,d,f,h
	72	#define _TP_EXDATA_VAR10(a,b,c,d,e,f,g,h,i,j) __tp_data,b,d,f,h,j
	73	#define _TP_EXDATA_VAR12(a,b,c,d,e,f,g,h,i,j,k,l) __tp_data,b,d,f,h,j,l
	74	#define _TP_EXDATA_VAR14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) __tp_data,b,d,f,h,j,l,n
	75	#define _TP_EXDATA_VAR16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p) __tp_data,b,d,f,h,j,l,n,p
	76	#define _TP_EXDATA_VAR18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r) __tp_data,b,d,f,h,j,l,n,p,r
	77	#define _TP_EXDATA_VAR20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t) __tp_data,b,d,f,h,j,l,n,p,r,t
	78
	79	/* _TP_EXPROTO* extract tuples of type, var */
	80	#define _TP_EXPROTO0()
	81	#define _TP_EXPROTO2(a,b) a b
	82	#define _TP_EXPROTO4(a,b,c,d) a b,c d
	83	#define _TP_EXPROTO6(a,b,c,d,e,f) a b,c d,e f
	84	#define _TP_EXPROTO8(a,b,c,d,e,f,g,h) a b,c d,e f,g h
	85	#define _TP_EXPROTO10(a,b,c,d,e,f,g,h,i,j) a b,c d,e f,g h,i j
	86	#define _TP_EXPROTO12(a,b,c,d,e,f,g,h,i,j,k,l) a b,c d,e f,g h,i j,k l
	87	#define _TP_EXPROTO14(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
	88	#define _TP_EXPROTO16(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
	89	#define _TP_EXPROTO18(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
	90	#define _TP_EXPROTO20(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
	91
	92	#define _TP_EXDATA_PROTO0() void *__tp_data
	93	#define _TP_EXDATA_PROTO2(a,b) void *__tp_data,a b
	94	#define _TP_EXDATA_PROTO4(a,b,c,d) void *__tp_data,a b,c d
	95	#define _TP_EXDATA_PROTO6(a,b,c,d,e,f) void *__tp_data,a b,c d,e f
	96	#define _TP_EXDATA_PROTO8(a,b,c,d,e,f,g,h) void *__tp_data,a b,c d,e f,g h
	97	#define _TP_EXDATA_PROTO10(a,b,c,d,e,f,g,h,i,j) void *__tp_data,a b,c d,e f,g h,i j
	98	#define _TP_EXDATA_PROTO12(a,b,c,d,e,f,g,h,i,j,k,l) void *__tp_data,a b,c d,e f,g h,i j,k l
	99	#define _TP_EXDATA_PROTO14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) void *__tp_data,a b,c d,e f,g h,i j,k l,m n
	100	#define _TP_EXDATA_PROTO16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p) void *__tp_data,a b,c d,e f,g h,i j,k l,m n,o p
	101	#define _TP_EXDATA_PROTO18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r) void *__tp_data,a b,c d,e f,g h,i j,k l,m n,o p,q r
	102	#define _TP_EXDATA_PROTO20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t) void *__tp_data,a b,c d,e f,g h,i j,k l,m n,o p,q r,s t
	103
	104	/* Preprocessor trick to count arguments. Inspired from sdt.h. */
	105	#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)
	106	#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
23c8854a MD	107	#define _TP_PROTO_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXPROTO, N)(__VA_ARGS__))
	108	#define _TP_VAR_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXVAR, N)(__VA_ARGS__))
	109	#define _TP_DATA_PROTO_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXDATA_PROTO, N)(__VA_ARGS__))
	110	#define _TP_DATA_VAR_N(N, ...) _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXDATA_VAR, N)(__VA_ARGS__))
b728d87e	111	#define _TP_ARGS_PROTO(...) _TP_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
23c8854a	112	#define _TP_ARGS_VAR(...) _TP_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
b728d87e	113	#define _TP_ARGS_DATA_PROTO(...) _TP_DATA_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
23c8854a	114	#define _TP_ARGS_DATA_VAR(...) _TP_DATA_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
b728d87e MD	115	#define _TP_PARAMS(...) __VA_ARGS__
	116
	117	#define _DECLARE_TRACEPOINT(provider, name, ...) \
23c8854a MD	118	extern struct tracepoint __tracepoint_##provider##___##name; \
23c8854a MD	119	static inline void __tracepoint_cb_##provider##___##name(_TP_ARGS_PROTO(__VA_ARGS__)) \
b728d87e MD	120	{ \
	121	struct tracepoint_probe *__tp_probe; \
	122	\
40b2b5a4	123	if (!TP_RCU_LINK_TEST()) \
deb6e540	124	return; \
40b2b5a4 MD	125	tp_rcu_read_lock_bp(); \
40b2b5a4 MD	126	__tp_probe = tp_rcu_dereference_bp(__tracepoint_##provider##___##name.probes); \
23c8854a	127	if (caa_unlikely(!__tp_probe)) \
b728d87e MD	128	goto end; \
b728d87e MD	129	do { \
23c8854a MD	130	void *__tp_cb = __tp_probe->func; \
23c8854a MD	131	void *__tp_data = __tp_probe->data; \
b728d87e	132	\
23c8854a MD	133	URCU_FORCE_CAST(void (*)(_TP_ARGS_DATA_PROTO(__VA_ARGS__)), __tp_cb) \
	134	(_TP_ARGS_DATA_VAR(__VA_ARGS__)); \
	135	} while ((++__tp_probe)->func); \
b728d87e	136	end: \
40b2b5a4	137	tp_rcu_read_unlock_bp(); \
b728d87e	138	} \
23c8854a MD	139	static inline void __tracepoint_register_##provider##___##name(char *name, \
23c8854a MD	140	void func, void data) \
b728d87e	141	{ \
23c8854a	142	__tracepoint_probe_register(name, func, data); \
b728d87e	143	} \
23c8854a MD	144	static inline void __tracepoint_unregister_##provider##___##name(char *name, \
23c8854a MD	145	void func, void data) \
b728d87e	146	{ \
23c8854a	147	__tracepoint_probe_unregister(name, func, data); \
b728d87e MD	148	}
b728d87e MD	149
deb6e540 MD	150	extern int __tracepoint_probe_register(const char name, void func, void *data);
	151	extern int __tracepoint_probe_unregister(const char name, void func, void *data);
	152
	153	#ifdef TRACEPOINT_DEFINE
	154
628e1d81 MD	155	/*
	156	* When TRACEPOINT_PROBE_DYNAMIC_LINKAGE is defined, we do not emit a
	157	* unresolved symbol that requires the provider to be linked in. When
	158	* TRACEPOINT_PROBE_DYNAMIC_LINKAGE is not defined, we emit an
	159	* unresolved symbol that depends on having the provider linked in,
	160	* otherwise the linker complains. This deals with use of static
	161	* libraries, ensuring that the linker does not remove the provider
	162	* object from the executable.
	163	*/
	164	#ifdef TRACEPOINT_PROBE_DYNAMIC_LINKAGE
	165	#define _TRACEPOINT_UNDEFINED_REF(provider)
	166	#else /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
	167	#define _TRACEPOINT_UNDEFINED_REF(provider) \
	168	&__tracepoint_provider_##provider,
	169	#endif /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
	170
b728d87e MD	171	/*
	172	* Note: to allow PIC code, we need to allow the linker to update the pointers
	173	* in the __tracepoints_ptrs section.
	174	* Therefore, this section is _not_ const (read-only).
	175	*/
	176	#define _DEFINE_TRACEPOINT(provider, name) \
628e1d81	177	extern int __tracepoint_provider_##provider; \
b728d87e MD	178	static const char __tp_strtab_##provider##___##name[] \
	179	__attribute__((section("__tracepoints_strings"))) = \
	180	#provider ":" #name; \
	181	struct tracepoint __tracepoint_##provider##___##name \
	182	__attribute__((section("__tracepoints"))) = \
628e1d81	183	{ __tp_strtab_##provider##___##name, 0, NULL, _TRACEPOINT_UNDEFINED_REF(provider) }; \
b728d87e MD	184	static struct tracepoint * __tracepoint_ptr_##provider##___##name \
	185	__attribute__((used, section("__tracepoints_ptrs"))) = \
	186	&__tracepoint_##provider##___##name;
	187
deb6e540	188	static int (tracepoint_register_lib)(struct tracepoint const *tracepoints_start,
b728d87e	189	int tracepoints_count);
deb6e540 MD	190	static int (tracepoint_unregister_lib)(struct tracepoint const *tracepoints_start);
deb6e540 MD	191	static void *liblttngust_handle;
b728d87e MD	192
	193	/*
	194	* These weak symbols, the constructor, and destructor take care of
	195	* registering only _one_ instance of the tracepoints per shared-ojbect
	196	* (or for the whole main program).
	197	*/
	198	extern struct tracepoint * const __start___tracepoints_ptrs[]
	199	__attribute__((weak, visibility("hidden")));
	200	extern struct tracepoint * const __stop___tracepoints_ptrs[]
	201	__attribute__((weak, visibility("hidden")));
	202	int __tracepoint_registered
	203	__attribute__((weak, visibility("hidden")));
	204
	205	static void __attribute__((constructor)) __tracepoints__init(void)
	206	{
	207	if (__tracepoint_registered++)
	208	return;
deb6e540	209
8792fbae	210	liblttngust_handle = dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW \| RTLD_GLOBAL);
deb6e540 MD	211	if (!liblttngust_handle)
deb6e540 MD	212	return;
93ffe366 MD	213	tracepoint_register_lib =
	214	URCU_FORCE_CAST(int ()(struct tracepoint const *, int),
	215	dlsym(liblttngust_handle,
	216	"tracepoint_register_lib"));
	217	tracepoint_unregister_lib =
	218	URCU_FORCE_CAST(int ()(struct tracepoint const *),
	219	dlsym(liblttngust_handle,
	220	"tracepoint_unregister_lib"));
40b2b5a4 MD	221	#ifndef _LGPL_SOURCE
	222	tp_rcu_read_lock_bp =
	223	URCU_FORCE_CAST(void (*)(void),
	224	dlsym(liblttngust_handle,
	225	"tp_rcu_read_lock_bp"));
	226	tp_rcu_read_unlock_bp =
	227	URCU_FORCE_CAST(void (*)(void),
	228	dlsym(liblttngust_handle,
	229	"tp_rcu_read_unlock_bp"));
	230	tp_rcu_dereference_sym_bp =
	231	URCU_FORCE_CAST(void ()(void *p),
	232	dlsym(liblttngust_handle,
	233	"tp_rcu_dereference_sym_bp"));
	234	#endif
b728d87e MD	235	tracepoint_register_lib(__start___tracepoints_ptrs,
	236	__stop___tracepoints_ptrs -
	237	__start___tracepoints_ptrs);
	238	}
	239
	240	static void __attribute__((destructor)) __tracepoints__destroy(void)
	241	{
deb6e540	242	int ret;
b728d87e MD	243	if (--__tracepoint_registered)
b728d87e MD	244	return;
deb6e540 MD	245	if (tracepoint_unregister_lib)
	246	tracepoint_unregister_lib(__start___tracepoints_ptrs);
	247	if (liblttngust_handle) {
	248	tracepoint_unregister_lib = NULL;
	249	tracepoint_register_lib = NULL;
	250	ret = dlclose(liblttngust_handle);
	251	assert(!ret);
	252	}
b728d87e MD	253	}
b728d87e MD	254
deb6e540 MD	255	#else /* TRACEPOINT_DEFINE */
	256
	257	#define _DEFINE_TRACEPOINT(provider, name)
	258
	259	#endif /* #else TRACEPOINT_DEFINE */
	260
b728d87e MD	261	#ifdef __cplusplus
	262	}
	263	#endif
	264
	265	#endif /* _LTTNG_TRACEPOINT_H */
	266
	267	/* The following declarations must be outside re-inclusion protection. */
	268
	269	#ifndef TRACEPOINT_EVENT
	270
	271	/*
	272	* How to use the TRACEPOINT_EVENT macro:
	273	*
	274	* An example:
	275	*
	276	* TRACEPOINT_EVENT(someproject_component, event_name,
	277	*
	278	* * TP_ARGS takes from 0 to 10 "type, field_name" pairs *
	279	*
	280	* TP_ARGS(int, arg0, void , arg1, char , string, size_t, strlen,
	281	* long *, arg4, size_t, arg4_len),
	282	*
	283	* * TP_FIELDS describes the event payload layout in the trace *
	284	*
	285	* TP_FIELDS(
	286	* * Integer, printed in base 10 *
	287	* ctf_integer(int, field_a, arg0)
	288	*
	289	* * Integer, printed with 0x base 16 *
	290	* ctf_integer_hex(unsigned long, field_d, arg1)
	291	*
	292	* * Array Sequence, printed as UTF8-encoded array of bytes *
	293	* ctf_array_text(char, field_b, string, FIXED_LEN)
	294	* ctf_sequence_text(char, field_c, string, size_t, strlen)
	295	*
	296	* * String, printed as UTF8-encoded string *
	297	* ctf_string(field_e, string)
	298	*
	299	* * Array sequence of signed integer values *
	300	* ctf_array(long, field_f, arg4, FIXED_LEN4)
	301	* ctf_sequence(long, field_g, arg4, size_t, arg4_len)
	302	* )
	303	* )
	304	*
	305	* More detailed explanation:
	306	*
	307	* The name of the tracepoint is expressed as a tuple with the provider
	308	* and name arguments.
	309	*
	310	* The provider and name should be a proper C99 identifier.
	311	* The "provider" and "name" MUST follow these rules to ensure no
	312	* namespace clash occurs:
	313	*
	314	* For projects (applications and libraries) for which an entity
	315	* specific to the project controls the source code and thus its
	316	* tracepoints (typically with a scope larger than a single company):
	317	*
	318	* either:
	319	* project_component, event
	320	* or:
	321	* project, event
	322	*
	323	* Where "project" is the name of the project,
	324	* "component" is the name of the project component (which may
325	* include several levels of sub-components, e.g.
326	* ...component_subcomponent_...) where the tracepoint is located
327	* (optional),
328	* "event" is the name of the tracepoint event.
329	*
330	* For projects issued from a single company wishing to advertise that
331	* the company controls the source code and thus the tracepoints, the
332	* "com_" prefix should be used:
333	*
334	* either:
335	* com_company_project_component, event
336	* or:
337	* com_company_project, event
338	*
339	* Where "company" is the name of the company,
340	* "project" is the name of the project,
341	* "component" is the name of the project component (which may
342	* include several levels of sub-components, e.g.
343	* ...component_subcomponent_...) where the tracepoint is located
344	* (optional),
345	* "event" is the name of the tracepoint event.
346	*
347	* the provider:event identifier is limited to 127 characters.
348	*/
349
b728d87e	350	#define TRACEPOINT_EVENT(provider, name, args, fields) \
deb6e540 MD	351	_DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args)) \
deb6e540 MD	352	_DEFINE_TRACEPOINT(provider, name)
b728d87e MD	353
	354	#define TRACEPOINT_EVENT_CLASS(provider, name, args, fields)
	355
	356	#define TRACEPOINT_EVENT_INSTANCE(provider, _template, name, args) \
deb6e540 MD	357	_DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args)) \
deb6e540 MD	358	_DEFINE_TRACEPOINT(provider, name)
b728d87e MD	359
	360	#endif /* #ifndef TRACEPOINT_EVENT */
	361
	362	#ifndef TRACEPOINT_LOGLEVEL
	363
	364	/*
75c5ad79	365	* Tracepoint Loglevels
b728d87e MD	366	*
	367	* Typical use of these loglevels:
	368	*
75c5ad79 MD	369	* The loglevels go from 0 to 15. Higher numbers imply the most
	370	* verbosity (higher event throughput expected.
	371	*
	372	* Loglevels 0 through 6, and loglevel 15, match syslog(3) loglevels
	373	* semantic. Loglevels 7 through 14 offer more fine-grained selection of
	374	* traced information.
	375	*
	376	* TRACE_EMERG 0
	377	* system is unusable
	378	*
	379	* TRACE_ALERT 1
	380	* action must be taken immediately
	381	*
	382	* TRACE_CRIT 2
	383	* critical conditions
	384	*
	385	* TRACE_ERR 3
	386	* error conditions
	387	*
	388	* TRACE_WARNING 4
	389	* warning conditions
	390	*
	391	* TRACE_NOTICE 5
	392	* normal, but significant, condition
	393	*
	394	* TRACE_INFO 6
	395	* informational message
	396	*
882a56d7	397	* TRACE_SYSTEM 7
902e1379	398	* information has system-level scope (set of programs)
75c5ad79	399	*
902e1379 MD	400	* TRACE_PROGRAM 8
902e1379 MD	401	* information has program-level scope (set of processes)
75c5ad79	402	*
902e1379 MD	403	* TRACE_PROCESS 9
902e1379 MD	404	* information has process-level scope (set of modules)
75c5ad79	405	*
902e1379 MD	406	* TRACE_MODULE 10
902e1379 MD	407	* information has module (executable/library) scope (set of units)
75c5ad79	408	*
902e1379 MD	409	* TRACE_UNIT 11
902e1379 MD	410	* information has compilation unit scope (set of functions)
75c5ad79	411	*
902e1379	412	* TRACE_FUNCTION 12
75c5ad79 MD	413	* information has function-level scope
75c5ad79 MD	414	*
902e1379 MD	415	* TRACE_DEFAULT 13
	416	* default trace loglevel (TRACEPOINT_EVENT default)
	417	*
	418	* TRACE_VERBOSE 14
	419	* verbose information
75c5ad79 MD	420	*
75c5ad79 MD	421	* TRACE_DEBUG 15
902e1379	422	* debug-level message (trace_printf default)
75c5ad79 MD	423	*
	424	* Declare tracepoint loglevels for tracepoints. A TRACEPOINT_EVENT
	425	* should be declared prior to the the TRACEPOINT_LOGLEVEL for a given
	426	* tracepoint name. The first field is the name of the tracepoint, the
	427	* second field is the loglevel name.
b728d87e MD	428	*
	429	* TRACEPOINT_LOGLEVEL(< [com_company_]project[_component] >, < event >,
	430	* < loglevel_name >)
	431	*
75c5ad79 MD	432	* The TRACEPOINT_PROVIDER must be already declared before declaring a
75c5ad79 MD	433	* TRACEPOINT_LOGLEVEL.
b728d87e MD	434	*/
b728d87e MD	435
882a56d7 MD	436	enum {
	437	TRACE_EMERG = 0,
	438	TRACE_ALERT = 1,
	439	TRACE_CRIT = 2,
	440	TRACE_ERR = 3,
	441	TRACE_WARNING = 4,
	442	TRACE_NOTICE = 5,
	443	TRACE_INFO = 6,
	444	TRACE_SYSTEM = 7,
902e1379 MD	445	TRACE_PROGRAM = 8,
	446	TRACE_PROCESS = 9,
	447	TRACE_MODULE = 10,
	448	TRACE_UNIT = 11,
	449	TRACE_FUNCTION = 12,
	450	TRACE_DEFAULT = 13,
	451	TRACE_VERBOSE = 14,
882a56d7 MD	452	TRACE_DEBUG = 15,
	453	};
	454
05ceaafd	455	#define TRACEPOINT_LOGLEVEL(provider, name, loglevel)
b728d87e MD	456
b728d87e MD	457	#endif /* #ifndef TRACEPOINT_LOGLEVEL */