[lttng-modules.git] / probes / define_trace.h

/*
 * define_trace.h
 *
 * Copyright (C) 2009 Steven Rostedt <rostedt@goodmis.org>
 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * 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; only
 * 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
 */

/*
 * Trace files that want to automate creationg of all tracepoints defined
 * in their file should include this file. The following are macros that the
 * trace file may define:
 *
 * TRACE_SYSTEM defines the system the tracepoint is for
 *
 * TRACE_INCLUDE_FILE if the file name is something other than TRACE_SYSTEM.h
 *     This macro may be defined to tell define_trace.h what file to include.
 *     Note, leave off the ".h".
 *
 * TRACE_INCLUDE_PATH if the path is something other than core kernel include/trace
 *     then this macro can define the path to use. Note, the path is relative to
 *     define_trace.h, not the file including it. Full path names for out of tree
 *     modules must be used.
 */

#ifdef CREATE_TRACE_POINTS

/* Prevent recursion */
#undef CREATE_TRACE_POINTS

#include <linux/stringify.h>

#undef LTTNG_TRACEPOINT_EVENT_MAP
#define LTTNG_TRACEPOINT_EVENT_MAP(name, map, proto, args, tstruct, assign, print)

#undef LTTNG_TRACEPOINT_EVENT_MAP_NOARGS
#define LTTNG_TRACEPOINT_EVENT_MAP_NOARGS(name, map, tstruct, assign, print)

#undef LTTNG_TRACEPOINT_EVENT_CONDITION_MAP
#define LTTNG_TRACEPOINT_EVENT_CONDITION_MAP(name, map, proto, args, cond, tstruct, assign, print) \
	LTTNG_TRACEPOINT_EVENT(name,					\
		PARAMS(proto),						\
		PARAMS(args),						\
		PARAMS(tstruct),					\
		PARAMS(assign),						\
		PARAMS(print))

#undef LTTNG_TRACEPOINT_EVENT_FN_MAP
#define LTTNG_TRACEPOINT_EVENT_FN_MAP(name, map, proto, args, tstruct,	\
		assign, print, reg, unreg)

#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_MAP
#define LTTNG_TRACEPOINT_EVENT_INSTANCE_MAP(template, name, map, proto, args)

#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_PRINT_MAP
#define LTTNG_TRACEPOINT_EVENT_INSTANCE_PRINT_MAP(template, name, map, proto, args, print)

#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_CONDITION_MAP
#define LTTNG_TRACEPOINT_EVENT_INSTANCE_CONDITION_MAP(template, name, map, proto, args, cond) \
	LTTNG_TRACEPOINT_EVENT_INSTANCE(template, name, PARAMS(proto), PARAMS(args))

#undef LTTNG_TRACEPOINT_EVENT
#define LTTNG_TRACEPOINT_EVENT(name, proto, args, tstruct, assign, print)

#undef LTTNG_TRACEPOINT_EVENT_CONDITION
#define LTTNG_TRACEPOINT_EVENT_CONDITION(name, proto, args, cond, tstruct, assign, print) \
	LTTNG_TRACEPOINT_EVENT(name,					\
		PARAMS(proto),						\
		PARAMS(args),						\
		PARAMS(tstruct),					\
		PARAMS(assign),						\
		PARAMS(print))

#undef LTTNG_TRACEPOINT_EVENT_CODE
#define LTTNG_TRACEPOINT_EVENT_CODE(name, proto, args, _locvar, _code, tstruct, assign, print)

#undef LTTNG_TRACEPOINT_EVENT_FN
#define LTTNG_TRACEPOINT_EVENT_FN(name, proto, args, tstruct,		\
		assign, print, reg, unreg)

#undef LTTNG_TRACEPOINT_EVENT_INSTANCE
#define LTTNG_TRACEPOINT_EVENT_INSTANCE(template, name, proto, args)

#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_NOARGS
#define LTTNG_TRACEPOINT_EVENT_INSTANCE_NOARGS(template, name)

#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_MAP_NOARGS
#define LTTNG_TRACEPOINT_EVENT_INSTANCE_MAP_NOARGS(template, name, map)

#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_PRINT
#define LTTNG_TRACEPOINT_EVENT_INSTANCE_PRINT(template, name, proto, args, print)

#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_CONDITION
#define LTTNG_TRACEPOINT_EVENT_INSTANCE_CONDITION(template, name, proto, args, cond) \
	LTTNG_TRACEPOINT_EVENT_INSTANCE(template, name, PARAMS(proto), PARAMS(args))

#undef TRACE_INCLUDE
#undef __TRACE_INCLUDE

#ifndef TRACE_INCLUDE_FILE
# define TRACE_INCLUDE_FILE TRACE_SYSTEM
# define UNDEF_TRACE_INCLUDE_FILE
#endif

#ifndef TRACE_INCLUDE_PATH
# define __TRACE_INCLUDE(system) <trace/events/system.h>
# define UNDEF_TRACE_INCLUDE_PATH
#else
# define __TRACE_INCLUDE(system) __stringify(TRACE_INCLUDE_PATH/system.h)
#endif

# define TRACE_INCLUDE(system) __TRACE_INCLUDE(system)

/* Let the trace headers be reread */
#define TRACE_HEADER_MULTI_READ

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

/* Make all open coded DECLARE_TRACE nops */
#undef DECLARE_TRACE
#define DECLARE_TRACE(name, proto, args)

#ifdef LTTNG_PACKAGE_BUILD
#include "lttng-events.h"
#endif

#undef LTTNG_TRACEPOINT_EVENT
#undef LTTNG_TRACEPOINT_EVENT_FN
#undef LTTNG_TRACEPOINT_EVENT_CONDITION
#undef LTTNG_TRACEPOINT_EVENT_INSTANCE
#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_PRINT
#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_CONDITION
#undef LTTNG_TRACEPOINT_EVENT_MAP
#undef LTTNG_TRACEPOINT_EVENT_FN_MAP
#undef LTTNG_TRACEPOINT_EVENT_CONDITION_MAP
#undef LTTNG_TRACEPOINT_EVENT_CLASS
#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_MAP
#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_PRINT_MAP
#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_CONDITION_MAP
#undef LTTNG_TRACEPOINT_EVENT_CODE
#undef LTTNG_TRACEPOINT_EVENT_MAP_NOARGS
#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_NOARGS
#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_MAP_NOARGS
#undef TRACE_HEADER_MULTI_READ

/* Only undef what we defined in this file */
#ifdef UNDEF_TRACE_INCLUDE_FILE
# undef TRACE_INCLUDE_FILE
# undef UNDEF_TRACE_INCLUDE_FILE
#endif

#ifdef UNDEF_TRACE_INCLUDE_PATH
# undef TRACE_INCLUDE_PATH
# undef UNDEF_TRACE_INCLUDE_PATH
#endif

/*
 * We want to re-include lttng-tracepoint-event.h for a following probe.
 */
#undef LTTNG_TRACEPOINT_EVENT_H

/* We may be processing more files */
#define CREATE_TRACE_POINTS

#endif /* CREATE_TRACE_POINTS */
Commit	Line	Data
17baffe2 MD	1	/*
	2	* define_trace.h
	3	*
	4	* Copyright (C) 2009 Steven Rostedt <rostedt@goodmis.org>
886d51a3	5	* Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
17baffe2	6	*
886d51a3 MD	7	* This library is free software; you can redistribute it and/or
	8	* modify it under the terms of the GNU Lesser General Public
	9	* License as published by the Free Software Foundation; only
	10	* version 2.1 of the License.
	11	*
	12	* This library is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	15	* Lesser General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU Lesser General Public
	18	* License along with this library; if not, write to the Free Software
	19	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17baffe2 MD	20	*/
17baffe2 MD	21
f62b389e MD	22	/*
	23	* Trace files that want to automate creationg of all tracepoints defined
	24	* in their file should include this file. The following are macros that the
	25	* trace file may define:
	26	*
	27	* TRACE_SYSTEM defines the system the tracepoint is for
	28	*
	29	* TRACE_INCLUDE_FILE if the file name is something other than TRACE_SYSTEM.h
	30	* This macro may be defined to tell define_trace.h what file to include.
	31	* Note, leave off the ".h".
	32	*
	33	* TRACE_INCLUDE_PATH if the path is something other than core kernel include/trace
	34	* then this macro can define the path to use. Note, the path is relative to
	35	* define_trace.h, not the file including it. Full path names for out of tree
	36	* modules must be used.
	37	*/
	38
	39	#ifdef CREATE_TRACE_POINTS
	40
	41	/* Prevent recursion */
	42	#undef CREATE_TRACE_POINTS
	43
	44	#include <linux/stringify.h>
f62b389e	45
3bc29f0a MD	46	#undef LTTNG_TRACEPOINT_EVENT_MAP
	47	#define LTTNG_TRACEPOINT_EVENT_MAP(name, map, proto, args, tstruct, assign, print)
	48
	49	#undef LTTNG_TRACEPOINT_EVENT_MAP_NOARGS
	50	#define LTTNG_TRACEPOINT_EVENT_MAP_NOARGS(name, map, tstruct, assign, print)
76e4f017	51
3bc29f0a MD	52	#undef LTTNG_TRACEPOINT_EVENT_CONDITION_MAP
	53	#define LTTNG_TRACEPOINT_EVENT_CONDITION_MAP(name, map, proto, args, cond, tstruct, assign, print) \
	54	LTTNG_TRACEPOINT_EVENT(name, \
76e4f017 MD	55	PARAMS(proto), \
	56	PARAMS(args), \
	57	PARAMS(tstruct), \
	58	PARAMS(assign), \
	59	PARAMS(print))
	60
3bc29f0a MD	61	#undef LTTNG_TRACEPOINT_EVENT_FN_MAP
3bc29f0a MD	62	#define LTTNG_TRACEPOINT_EVENT_FN_MAP(name, map, proto, args, tstruct, \
20591cf7	63	assign, print, reg, unreg)
76e4f017	64
3bc29f0a MD	65	#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_MAP
3bc29f0a MD	66	#define LTTNG_TRACEPOINT_EVENT_INSTANCE_MAP(template, name, map, proto, args)
76e4f017	67
3bc29f0a MD	68	#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_PRINT_MAP
3bc29f0a MD	69	#define LTTNG_TRACEPOINT_EVENT_INSTANCE_PRINT_MAP(template, name, map, proto, args, print)
76e4f017	70
3bc29f0a MD	71	#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_CONDITION_MAP
	72	#define LTTNG_TRACEPOINT_EVENT_INSTANCE_CONDITION_MAP(template, name, map, proto, args, cond) \
	73	LTTNG_TRACEPOINT_EVENT_INSTANCE(template, name, PARAMS(proto), PARAMS(args))
76e4f017	74
3bc29f0a MD	75	#undef LTTNG_TRACEPOINT_EVENT
3bc29f0a MD	76	#define LTTNG_TRACEPOINT_EVENT(name, proto, args, tstruct, assign, print)
76e4f017	77
3bc29f0a MD	78	#undef LTTNG_TRACEPOINT_EVENT_CONDITION
	79	#define LTTNG_TRACEPOINT_EVENT_CONDITION(name, proto, args, cond, tstruct, assign, print) \
	80	LTTNG_TRACEPOINT_EVENT(name, \
f62b389e MD	81	PARAMS(proto), \
	82	PARAMS(args), \
	83	PARAMS(tstruct), \
	84	PARAMS(assign), \
	85	PARAMS(print))
	86
3bc29f0a MD	87	#undef LTTNG_TRACEPOINT_EVENT_CODE
3bc29f0a MD	88	#define LTTNG_TRACEPOINT_EVENT_CODE(name, proto, args, _locvar, _code, tstruct, assign, print)
7ca580f8	89
3bc29f0a MD	90	#undef LTTNG_TRACEPOINT_EVENT_FN
3bc29f0a MD	91	#define LTTNG_TRACEPOINT_EVENT_FN(name, proto, args, tstruct, \
20591cf7	92	assign, print, reg, unreg)
f62b389e	93
3bc29f0a MD	94	#undef LTTNG_TRACEPOINT_EVENT_INSTANCE
3bc29f0a MD	95	#define LTTNG_TRACEPOINT_EVENT_INSTANCE(template, name, proto, args)
f62b389e	96
3bc29f0a MD	97	#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_NOARGS
3bc29f0a MD	98	#define LTTNG_TRACEPOINT_EVENT_INSTANCE_NOARGS(template, name)
f62b389e	99
3bc29f0a MD	100	#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_MAP_NOARGS
3bc29f0a MD	101	#define LTTNG_TRACEPOINT_EVENT_INSTANCE_MAP_NOARGS(template, name, map)
f62b389e	102
3bc29f0a MD	103	#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_PRINT
	104	#define LTTNG_TRACEPOINT_EVENT_INSTANCE_PRINT(template, name, proto, args, print)
	105
	106	#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_CONDITION
	107	#define LTTNG_TRACEPOINT_EVENT_INSTANCE_CONDITION(template, name, proto, args, cond) \
	108	LTTNG_TRACEPOINT_EVENT_INSTANCE(template, name, PARAMS(proto), PARAMS(args))
f62b389e MD	109
	110	#undef TRACE_INCLUDE
	111	#undef __TRACE_INCLUDE
	112
	113	#ifndef TRACE_INCLUDE_FILE
	114	# define TRACE_INCLUDE_FILE TRACE_SYSTEM
	115	# define UNDEF_TRACE_INCLUDE_FILE
	116	#endif
	117
	118	#ifndef TRACE_INCLUDE_PATH
	119	# define __TRACE_INCLUDE(system) <trace/events/system.h>
	120	# define UNDEF_TRACE_INCLUDE_PATH
	121	#else
	122	# define __TRACE_INCLUDE(system) __stringify(TRACE_INCLUDE_PATH/system.h)
	123	#endif
	124
	125	# define TRACE_INCLUDE(system) __TRACE_INCLUDE(system)
	126
	127	/* Let the trace headers be reread */
	128	#define TRACE_HEADER_MULTI_READ
	129
	130	#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
	131
	132	/* Make all open coded DECLARE_TRACE nops */
	133	#undef DECLARE_TRACE
	134	#define DECLARE_TRACE(name, proto, args)
	135
	136	#ifdef LTTNG_PACKAGE_BUILD
	137	#include "lttng-events.h"
	138	#endif
	139
3bc29f0a MD	140	#undef LTTNG_TRACEPOINT_EVENT
	141	#undef LTTNG_TRACEPOINT_EVENT_FN
	142	#undef LTTNG_TRACEPOINT_EVENT_CONDITION
	143	#undef LTTNG_TRACEPOINT_EVENT_INSTANCE
	144	#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_PRINT
	145	#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_CONDITION
	146	#undef LTTNG_TRACEPOINT_EVENT_MAP
	147	#undef LTTNG_TRACEPOINT_EVENT_FN_MAP
	148	#undef LTTNG_TRACEPOINT_EVENT_CONDITION_MAP
	149	#undef LTTNG_TRACEPOINT_EVENT_CLASS
	150	#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_MAP
	151	#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_PRINT_MAP
	152	#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_CONDITION_MAP
	153	#undef LTTNG_TRACEPOINT_EVENT_CODE
	154	#undef LTTNG_TRACEPOINT_EVENT_MAP_NOARGS
	155	#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_NOARGS
	156	#undef LTTNG_TRACEPOINT_EVENT_INSTANCE_MAP_NOARGS
f62b389e	157	#undef TRACE_HEADER_MULTI_READ
f62b389e MD	158
	159	/* Only undef what we defined in this file */
	160	#ifdef UNDEF_TRACE_INCLUDE_FILE
	161	# undef TRACE_INCLUDE_FILE
	162	# undef UNDEF_TRACE_INCLUDE_FILE
	163	#endif
	164
	165	#ifdef UNDEF_TRACE_INCLUDE_PATH
	166	# undef TRACE_INCLUDE_PATH
	167	# undef UNDEF_TRACE_INCLUDE_PATH
	168	#endif
	169
3bc29f0a MD	170	/*
	171	* We want to re-include lttng-tracepoint-event.h for a following probe.
	172	*/
	173	#undef LTTNG_TRACEPOINT_EVENT_H
	174
f62b389e MD	175	/* We may be processing more files */
	176	#define CREATE_TRACE_POINTS
	177
	178	#endif /* CREATE_TRACE_POINTS */