[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>
/*
 * module.h includes tracepoints, and because ftrace.h
 * pulls in module.h:
 *  trace/ftrace.h -> linux/ftrace_event.h -> linux/perf_event.h ->
 *  linux/ftrace.h -> linux/module.h
 * we must include module.h here before we play with any of
 * the TRACE_EVENT() macros, otherwise the tracepoints included
 * by module.h may break the build.
 */
#include <linux/module.h>

#undef TRACE_EVENT_MAP
#define TRACE_EVENT_MAP(name, map, proto, args, tstruct, assign, print)	\
	DEFINE_TRACE(name)

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

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

#undef DEFINE_EVENT_MAP
#define DEFINE_EVENT_MAP(template, name, map, proto, args) \
	DEFINE_TRACE(name)

#undef DEFINE_EVENT_PRINT_MAP
#define DEFINE_EVENT_PRINT_MAP(template, name, map, proto, args, print)	\
	DEFINE_TRACE(name)

#undef DEFINE_EVENT_CONDITION_MAP
#define DEFINE_EVENT_CONDITION_MAP(template, name, map, proto, args, cond) \
	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))


#undef TRACE_EVENT
#define TRACE_EVENT(name, proto, args, tstruct, assign, print)	\
	DEFINE_TRACE(name)

#undef TRACE_EVENT_CONDITION
#define TRACE_EVENT_CONDITION(name, proto, args, cond, tstruct, assign, print) \
	TRACE_EVENT(name,						\
		PARAMS(proto),						\
		PARAMS(args),						\
		PARAMS(tstruct),					\
		PARAMS(assign),						\
		PARAMS(print))

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

#undef DEFINE_EVENT
#define DEFINE_EVENT(template, name, proto, args) \
	DEFINE_TRACE(name)

#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\
	DEFINE_TRACE(name)

#undef DEFINE_EVENT_CONDITION
#define DEFINE_EVENT_CONDITION(template, name, proto, args, cond) \
	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))

#undef DECLARE_TRACE
#define DECLARE_TRACE(name, proto, args)	\
	DEFINE_TRACE(name)

#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 TRACE_EVENT
#undef TRACE_EVENT_FN
#undef TRACE_EVENT_CONDITION
#undef DEFINE_EVENT
#undef DEFINE_EVENT_PRINT
#undef DEFINE_EVENT_CONDITION
#undef TRACE_EVENT_MAP
#undef TRACE_EVENT_FN_MAP
#undef TRACE_EVENT_CONDITION_MAP
#undef DECLARE_EVENT_CLASS
#undef DEFINE_EVENT_MAP
#undef DEFINE_EVENT_PRINT_MAP
#undef DEFINE_EVENT_CONDITION_MAP
#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 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>
	45	/*
	46	* module.h includes tracepoints, and because ftrace.h
	47	* pulls in module.h:
	48	* trace/ftrace.h -> linux/ftrace_event.h -> linux/perf_event.h ->
	49	* linux/ftrace.h -> linux/module.h
	50	* we must include module.h here before we play with any of
	51	* the TRACE_EVENT() macros, otherwise the tracepoints included
	52	* by module.h may break the build.
	53	*/
	54	#include <linux/module.h>
	55
76e4f017 MD	56	#undef TRACE_EVENT_MAP
	57	#define TRACE_EVENT_MAP(name, map, proto, args, tstruct, assign, print) \
	58	DEFINE_TRACE(name)
	59
	60	#undef TRACE_EVENT_CONDITION_MAP
	61	#define TRACE_EVENT_CONDITION_MAP(name, map, proto, args, cond, tstruct, assign, print) \
	62	TRACE_EVENT(name, \
	63	PARAMS(proto), \
	64	PARAMS(args), \
	65	PARAMS(tstruct), \
	66	PARAMS(assign), \
	67	PARAMS(print))
	68
	69	#undef TRACE_EVENT_FN_MAP
	70	#define TRACE_EVENT_FN_MAP(name, map, proto, args, tstruct, \
	71	assign, print, reg, unreg) \
	72	DEFINE_TRACE_FN(name, reg, unreg)
	73
	74	#undef DEFINE_EVENT_MAP
	75	#define DEFINE_EVENT_MAP(template, name, map, proto, args) \
	76	DEFINE_TRACE(name)
	77
	78	#undef DEFINE_EVENT_PRINT_MAP
	79	#define DEFINE_EVENT_PRINT_MAP(template, name, map, proto, args, print) \
	80	DEFINE_TRACE(name)
	81
	82	#undef DEFINE_EVENT_CONDITION_MAP
	83	#define DEFINE_EVENT_CONDITION_MAP(template, name, map, proto, args, cond) \
	84	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
	85
	86
f62b389e MD	87	#undef TRACE_EVENT
	88	#define TRACE_EVENT(name, proto, args, tstruct, assign, print) \
	89	DEFINE_TRACE(name)
	90
	91	#undef TRACE_EVENT_CONDITION
	92	#define TRACE_EVENT_CONDITION(name, proto, args, cond, tstruct, assign, print) \
	93	TRACE_EVENT(name, \
	94	PARAMS(proto), \
	95	PARAMS(args), \
	96	PARAMS(tstruct), \
	97	PARAMS(assign), \
	98	PARAMS(print))
	99
	100	#undef TRACE_EVENT_FN
	101	#define TRACE_EVENT_FN(name, proto, args, tstruct, \
	102	assign, print, reg, unreg) \
	103	DEFINE_TRACE_FN(name, reg, unreg)
	104
	105	#undef DEFINE_EVENT
	106	#define DEFINE_EVENT(template, name, proto, args) \
	107	DEFINE_TRACE(name)
	108
	109	#undef DEFINE_EVENT_PRINT
	110	#define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
	111	DEFINE_TRACE(name)
	112
	113	#undef DEFINE_EVENT_CONDITION
	114	#define DEFINE_EVENT_CONDITION(template, name, proto, args, cond) \
	115	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
	116
	117	#undef DECLARE_TRACE
	118	#define DECLARE_TRACE(name, proto, args) \
	119	DEFINE_TRACE(name)
	120
	121	#undef TRACE_INCLUDE
	122	#undef __TRACE_INCLUDE
	123
	124	#ifndef TRACE_INCLUDE_FILE
	125	# define TRACE_INCLUDE_FILE TRACE_SYSTEM
	126	# define UNDEF_TRACE_INCLUDE_FILE
	127	#endif
	128
	129	#ifndef TRACE_INCLUDE_PATH
	130	# define __TRACE_INCLUDE(system) <trace/events/system.h>
	131	# define UNDEF_TRACE_INCLUDE_PATH
	132	#else
	133	# define __TRACE_INCLUDE(system) __stringify(TRACE_INCLUDE_PATH/system.h)
	134	#endif
	135
	136	# define TRACE_INCLUDE(system) __TRACE_INCLUDE(system)
	137
	138	/* Let the trace headers be reread */
	139	#define TRACE_HEADER_MULTI_READ
	140
	141	#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
	142
	143	/* Make all open coded DECLARE_TRACE nops */
	144	#undef DECLARE_TRACE
	145	#define DECLARE_TRACE(name, proto, args)
	146
	147	#ifdef LTTNG_PACKAGE_BUILD
	148	#include "lttng-events.h"
	149	#endif
	150
151	#undef TRACE_EVENT
152	#undef TRACE_EVENT_FN
153	#undef TRACE_EVENT_CONDITION
f62b389e MD	154	#undef DEFINE_EVENT
	155	#undef DEFINE_EVENT_PRINT
	156	#undef DEFINE_EVENT_CONDITION
76e4f017 MD	157	#undef TRACE_EVENT_MAP
	158	#undef TRACE_EVENT_FN_MAP
	159	#undef TRACE_EVENT_CONDITION_MAP
	160	#undef DECLARE_EVENT_CLASS
	161	#undef DEFINE_EVENT_MAP
	162	#undef DEFINE_EVENT_PRINT_MAP
	163	#undef DEFINE_EVENT_CONDITION_MAP
f62b389e	164	#undef TRACE_HEADER_MULTI_READ
f62b389e MD	165
	166	/* Only undef what we defined in this file */
	167	#ifdef UNDEF_TRACE_INCLUDE_FILE
	168	# undef TRACE_INCLUDE_FILE
	169	# undef UNDEF_TRACE_INCLUDE_FILE
	170	#endif
	171
	172	#ifdef UNDEF_TRACE_INCLUDE_PATH
	173	# undef TRACE_INCLUDE_PATH
	174	# undef UNDEF_TRACE_INCLUDE_PATH
	175	#endif
	176
	177	/* We may be processing more files */
	178	#define CREATE_TRACE_POINTS
	179
	180	#endif /* CREATE_TRACE_POINTS */