[lttng-ust.git] / libust / marker.h

/*
 * Code markup for dynamic and static tracing.
 *
 * See Documentation/marker.txt.
 *
 * (C) Copyright 2006 Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
 * (C) Copyright 2009 Pierre-Marc Fournier <pierre-marc dot fournier at polymtl dot ca>
 *
 * 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; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * 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
 */

#ifndef _LINUX_MARKER_H
#define _LINUX_MARKER_H

#include <stdarg.h>
//ust// #include <linux/types.h>
#include "immediate.h"
//ust// #include <linux/ltt-channels.h>
#include "kernelcompat.h"
#include <kcompat/list.h>
#include "localerr.h"

//ust// struct module;
//ust// struct task_struct;
struct marker;

/**
 * marker_probe_func - Type of a marker probe function
 * @mdata: marker data
 * @probe_private: probe private data
 * @call_private: call site private data
 * @fmt: format string
 * @args: variable argument list pointer. Use a pointer to overcome C's
 *        inability to pass this around as a pointer in a portable manner in
 *        the callee otherwise.
 *
 * Type of marker probe functions. They receive the mdata and need to parse the
 * format string to recover the variable argument list.
 */
typedef void marker_probe_func(const struct marker *mdata,
		void *probe_private, void *call_private,
		const char *fmt, va_list *args);

struct marker_probe_closure {
	marker_probe_func *func;	/* Callback */
	void *probe_private;		/* Private probe data */
};

struct marker {
	const char *channel;	/* Name of channel where to send data */
	const char *name;	/* Marker name */
	const char *format;	/* Marker format string, describing the
				 * variable argument list.
				 */
 	DEFINE_IMV(char, state);/* Immediate value state. */
	char ptype;		/* probe type : 0 : single, 1 : multi */
				/* Probe wrapper */
	u16 channel_id;		/* Numeric channel identifier, dynamic */
	u16 event_id;		/* Numeric event identifier, dynamic */
	void (*call)(const struct marker *mdata, void *call_private, ...);
	struct marker_probe_closure single;
	struct marker_probe_closure *multi;
	const char *tp_name;	/* Optional tracepoint name */
	void *tp_cb;		/* Optional tracepoint callback */
} __attribute__((aligned(8)));

#define CONFIG_MARKERS
#ifdef CONFIG_MARKERS

#define _DEFINE_MARKER(channel, name, tp_name_str, tp_cb, format)	\
		static const char __mstrtab_##channel##_##name[]	\
		__attribute__((section("__markers_strings")))		\
		= #channel "\0" #name "\0" format;			\
		static struct marker __mark_##channel##_##name		\
		__attribute__((section("__markers"), aligned(8))) =	\
		{ __mstrtab_##channel##_##name,				\
		  &__mstrtab_##channel##_##name[sizeof(#channel)],	\
		  &__mstrtab_##channel##_##name[sizeof(#channel) +	\
						sizeof(#name)],		\
		  0, 0, 0, 0, marker_probe_cb,				\
		  { __mark_empty_function, NULL},			\
		  NULL, tp_name_str, tp_cb }

#define DEFINE_MARKER(channel, name, format)				\
		_DEFINE_MARKER(channel, name, NULL, NULL, format)

#define DEFINE_MARKER_TP(channel, name, tp_name, tp_cb, format)		\
		_DEFINE_MARKER(channel, name, #tp_name, tp_cb, format)

/*
 * Make sure the alignment of the structure in the __markers 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.
 *
 * The "generic" argument controls which marker enabling mechanism must be used.
 * If generic is true, a variable read is used.
 * If generic is false, immediate values are used.
 */
#define __trace_mark(generic, channel, name, call_private, format, args...) \
	do {								\
		DEFINE_MARKER(channel, name, format);			\
		__mark_check_format(format, ## args);			\
		if (!generic) {						\
			if (unlikely(imv_read(				\
					__mark_##channel##_##name.state))) \
				(*__mark_##channel##_##name.call)	\
					(&__mark_##channel##_##name,	\
					call_private, ## args);		\
		} else {						\
			if (unlikely(_imv_read(				\
					__mark_##channel##_##name.state))) \
				(*__mark_##channel##_##name.call)	\
					(&__mark_##channel##_##name,	\
					call_private, ## args);		\
		}							\
	} while (0)

#define __trace_mark_tp(channel, name, call_private, tp_name, tp_cb,	\
			format, args...)				\
	do {								\
		void __check_tp_type(void)				\
		{							\
			register_trace_##tp_name(tp_cb);		\
		}							\
		DEFINE_MARKER_TP(channel, name, tp_name, tp_cb, format);\
		__mark_check_format(format, ## args);			\
		(*__mark_##channel##_##name.call)(&__mark_##channel##_##name, \
			call_private, ## args);				\
	} while (0)

extern void marker_update_probe_range(struct marker *begin,
	struct marker *end);

#define GET_MARKER(channel, name)	(__mark_##channel##_##name)

#else /* !CONFIG_MARKERS */
#define DEFINE_MARKER(channel, name, tp_name, tp_cb, format)
#define __trace_mark(generic, channel, name, call_private, format, args...) \
		__mark_check_format(format, ## args)
#define __trace_mark_tp(channel, name, call_private, tp_name, tp_cb,	\
		format, args...)					\
	do {								\
		void __check_tp_type(void)				\
		{							\
			register_trace_##tp_name(tp_cb);		\
		}							\
		__mark_check_format(format, ## args);			\
	} while (0)
static inline void marker_update_probe_range(struct marker *begin,
	struct marker *end)
{ }
#define GET_MARKER(channel, name)
#endif /* CONFIG_MARKERS */

/**
 * trace_mark - Marker using code patching
 * @channel: marker channel (where to send the data), not quoted.
 * @name: marker name, not quoted.
 * @format: format string
 * @args...: variable argument list
 *
 * Places a marker using optimized code patching technique (imv_read())
 * to be enabled when immediate values are present.
 */
#define trace_mark(channel, name, format, args...) \
	__trace_mark(0, channel, name, NULL, format, ## args)

/**
 * _trace_mark - Marker using variable read
 * @channel: marker channel (where to send the data), not quoted.
 * @name: marker name, not quoted.
 * @format: format string
 * @args...: variable argument list
 *
 * Places a marker using a standard memory read (_imv_read()) to be
 * enabled. Should be used for markers in code paths where instruction
 * modification based enabling is not welcome. (__init and __exit functions,
 * lockdep, some traps, printk).
 */
#define _trace_mark(channel, name, format, args...) \
	__trace_mark(1, channel, name, NULL, format, ## args)

/**
 * trace_mark_tp - Marker in a tracepoint callback
 * @channel: marker channel (where to send the data), not quoted.
 * @name: marker name, not quoted.
 * @tp_name: tracepoint name, not quoted.
 * @tp_cb: tracepoint callback. Should have an associated global symbol so it
 *         is not optimized away by the compiler (should not be static).
 * @format: format string
 * @args...: variable argument list
 *
 * Places a marker in a tracepoint callback.
 */
#define trace_mark_tp(channel, name, tp_name, tp_cb, format, args...)	\
	__trace_mark_tp(channel, name, NULL, tp_name, tp_cb, format, ## args)

/**
 * MARK_NOARGS - Format string for a marker with no argument.
 */
#define MARK_NOARGS " "

extern void lock_markers(void);
extern void unlock_markers(void);

extern void markers_compact_event_ids(void);

/* To be used for string format validity checking with gcc */
static inline void __printf(1, 2) ___mark_check_format(const char *fmt, ...)
{
}

#define __mark_check_format(format, args...)				\
	do {								\
		if (0)							\
			___mark_check_format(format, ## args);		\
	} while (0)

extern marker_probe_func __mark_empty_function;

extern void marker_probe_cb(const struct marker *mdata,
	void *call_private, ...);

/*
 * Connect a probe to a marker.
 * private data pointer must be a valid allocated memory address, or NULL.
 */
extern int marker_probe_register(const char *channel, const char *name,
	const char *format, marker_probe_func *probe, void *probe_private);

/*
 * Returns the private data given to marker_probe_register.
 */
extern int marker_probe_unregister(const char *channel, const char *name,
	marker_probe_func *probe, void *probe_private);
/*
 * Unregister a marker by providing the registered private data.
 */
extern int marker_probe_unregister_private_data(marker_probe_func *probe,
	void *probe_private);

extern void *marker_get_private_data(const char *channel, const char *name,
	marker_probe_func *probe, int num);

/*
 * marker_synchronize_unregister must be called between the last marker probe
 * unregistration and the first one of
 * - the end of module exit function
 * - the free of any resource used by the probes
 * to ensure the code and data are valid for any possibly running probes.
 */
#define marker_synchronize_unregister() synchronize_sched()

struct marker_iter {
//ust//	struct module *module;
	struct lib *lib;
	struct marker *marker;
};

extern void marker_iter_start(struct marker_iter *iter);
extern void marker_iter_next(struct marker_iter *iter);
extern void marker_iter_stop(struct marker_iter *iter);
extern void marker_iter_reset(struct marker_iter *iter);
extern int marker_get_iter_range(struct marker **marker, struct marker *begin,
	struct marker *end);

extern void marker_update_process(void);
extern int is_marker_enabled(const char *channel, const char *name);

//ust// #ifdef CONFIG_MARKERS_USERSPACE
//ust// extern void exit_user_markers(struct task_struct *p);
//ust// #else
//ust// static inline void exit_user_markers(struct task_struct *p)
//ust// {
//ust// }
//ust// #endif


struct lib {
	struct marker *markers_start;
	int markers_count;
	struct list_head list;
};

extern int marker_register_lib(struct marker *markers_start,
			       int markers_count);

#define MARKER_LIB							\
extern struct marker __start___markers[] __attribute__((visibility("hidden")));	\
extern struct marker __stop___markers[] __attribute__((visibility("hidden")));		\
											\
static void __attribute__((constructor)) __markers__init(void) 				\
{											\
	DBG("next registration in "__FILE__"\n");\
	marker_register_lib(__start___markers, (((long)__stop___markers)-((long)__start___markers))/sizeof(struct marker));\
}

extern void marker_set_new_marker_cb(void (*cb)(struct marker *));
extern void init_markers(void);

#endif
Commit	Line	Data
a72ca31a PMF	1	/*
	2	* Code markup for dynamic and static tracing.
	3	*
	4	* See Documentation/marker.txt.
	5	*
	6	* (C) Copyright 2006 Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
59b161cd	7	* (C) Copyright 2009 Pierre-Marc Fournier <pierre-marc dot fournier at polymtl dot ca>
a72ca31a	8	*
8fc2d8db PMF	9	* This library is free software; you can redistribute it and/or
	10	* modify it under the terms of the GNU Lesser General Public
	11	* License as published by the Free Software Foundation; either
	12	* version 2.1 of the License, or (at your option) any later version.
	13	*
	14	* This library is distributed in the hope that it will be useful,
	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	17	* Lesser General Public License for more details.
	18	*
	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
a72ca31a PMF	22	*/
a72ca31a PMF	23
e4621c7f PMF	24	#ifndef _LINUX_MARKER_H
	25	#define _LINUX_MARKER_H
	26
a72ca31a	27	#include <stdarg.h>
59b161cd PMF	28	//ust// #include <linux/types.h>
	29	#include "immediate.h"
	30	//ust// #include <linux/ltt-channels.h>
	31	#include "kernelcompat.h"
769d0157	32	#include <kcompat/list.h>
4d65ee62	33	#include "localerr.h"
59b161cd PMF	34
	35	//ust// struct module;
	36	//ust// struct task_struct;
a72ca31a PMF	37	struct marker;
	38
	39	/**
	40	* marker_probe_func - Type of a marker probe function
	41	* @mdata: marker data
	42	* @probe_private: probe private data
	43	* @call_private: call site private data
	44	* @fmt: format string
	45	* @args: variable argument list pointer. Use a pointer to overcome C's
	46	* inability to pass this around as a pointer in a portable manner in
	47	* the callee otherwise.
	48	*
	49	* Type of marker probe functions. They receive the mdata and need to parse the
	50	* format string to recover the variable argument list.
	51	*/
	52	typedef void marker_probe_func(const struct marker *mdata,
	53	void probe_private, void call_private,
	54	const char fmt, va_list args);
	55
	56	struct marker_probe_closure {
	57	marker_probe_func func; / Callback */
	58	void probe_private; / Private probe data */
	59	};
	60
	61	struct marker {
	62	const char channel; / Name of channel where to send data */
	63	const char name; / Marker name */
	64	const char format; / Marker format string, describing the
	65	* variable argument list.
	66	*/
59b161cd	67	DEFINE_IMV(char, state);/* Immediate value state. */
a72ca31a PMF	68	char ptype; /* probe type : 0 : single, 1 : multi */
	69	/* Probe wrapper */
	70	u16 channel_id; /* Numeric channel identifier, dynamic */
	71	u16 event_id; /* Numeric event identifier, dynamic */
	72	void (call)(const struct marker mdata, void *call_private, ...);
	73	struct marker_probe_closure single;
	74	struct marker_probe_closure *multi;
	75	const char tp_name; / Optional tracepoint name */
	76	void tp_cb; / Optional tracepoint callback */
	77	} __attribute__((aligned(8)));
	78
872037bb PMF	79	#define CONFIG_MARKERS
872037bb PMF	80	#ifdef CONFIG_MARKERS
a72ca31a PMF	81
	82	#define _DEFINE_MARKER(channel, name, tp_name_str, tp_cb, format) \
	83	static const char __mstrtab_##channel##_##name[] \
	84	__attribute__((section("__markers_strings"))) \
	85	= #channel "\0" #name "\0" format; \
	86	static struct marker __mark_##channel##_##name \
	87	__attribute__((section("__markers"), aligned(8))) = \
	88	{ __mstrtab_##channel##_##name, \
	89	&__mstrtab_##channel##_##name[sizeof(#channel)], \
	90	&__mstrtab_##channel##_##name[sizeof(#channel) + \
	91	sizeof(#name)], \
	92	0, 0, 0, 0, marker_probe_cb, \
	93	{ __mark_empty_function, NULL}, \
	94	NULL, tp_name_str, tp_cb }
	95
	96	#define DEFINE_MARKER(channel, name, format) \
	97	_DEFINE_MARKER(channel, name, NULL, NULL, format)
	98
	99	#define DEFINE_MARKER_TP(channel, name, tp_name, tp_cb, format) \
	100	_DEFINE_MARKER(channel, name, #tp_name, tp_cb, format)
	101
	102	/*
	103	* Make sure the alignment of the structure in the __markers section will
	104	* not add unwanted padding between the beginning of the section and the
	105	* structure. Force alignment to the same alignment as the section start.
	106	*
	107	* The "generic" argument controls which marker enabling mechanism must be used.
	108	* If generic is true, a variable read is used.
	109	* If generic is false, immediate values are used.
	110	*/
	111	#define __trace_mark(generic, channel, name, call_private, format, args...) \
	112	do { \
	113	DEFINE_MARKER(channel, name, format); \
	114	__mark_check_format(format, ## args); \
	115	if (!generic) { \
	116	if (unlikely(imv_read( \
	117	__mark_##channel##_##name.state))) \
	118	(*__mark_##channel##_##name.call) \
	119	(&__mark_##channel##_##name, \
	120	call_private, ## args); \
	121	} else { \
	122	if (unlikely(_imv_read( \
	123	__mark_##channel##_##name.state))) \
	124	(*__mark_##channel##_##name.call) \
	125	(&__mark_##channel##_##name, \
	126	call_private, ## args); \
	127	} \
	128	} while (0)
	129
	130	#define __trace_mark_tp(channel, name, call_private, tp_name, tp_cb, \
	131	format, args...) \
	132	do { \
	133	void __check_tp_type(void) \
	134	{ \
	135	register_trace_##tp_name(tp_cb); \
	136	} \
	137	DEFINE_MARKER_TP(channel, name, tp_name, tp_cb, format);\
	138	__mark_check_format(format, ## args); \
	139	(*__mark_##channel##_##name.call)(&__mark_##channel##_##name, \
	140	call_private, ## args); \
	141	} while (0)
	142
	143	extern void marker_update_probe_range(struct marker *begin,
	144	struct marker *end);
145
146	#define GET_MARKER(channel, name) (__mark_##channel##_##name)
147
872037bb PMF	148	#else /* !CONFIG_MARKERS */
	149	#define DEFINE_MARKER(channel, name, tp_name, tp_cb, format)
	150	#define __trace_mark(generic, channel, name, call_private, format, args...) \
	151	__mark_check_format(format, ## args)
	152	#define __trace_mark_tp(channel, name, call_private, tp_name, tp_cb, \
	153	format, args...) \
	154	do { \
	155	void __check_tp_type(void) \
	156	{ \
	157	register_trace_##tp_name(tp_cb); \
	158	} \
	159	__mark_check_format(format, ## args); \
	160	} while (0)
	161	static inline void marker_update_probe_range(struct marker *begin,
	162	struct marker *end)
	163	{ }
	164	#define GET_MARKER(channel, name)
	165	#endif /* CONFIG_MARKERS */
a72ca31a PMF	166
	167	/**
	168	* trace_mark - Marker using code patching
	169	* @channel: marker channel (where to send the data), not quoted.
	170	* @name: marker name, not quoted.
	171	* @format: format string
	172	* @args...: variable argument list
	173	*
	174	* Places a marker using optimized code patching technique (imv_read())
	175	* to be enabled when immediate values are present.
	176	*/
	177	#define trace_mark(channel, name, format, args...) \
	178	__trace_mark(0, channel, name, NULL, format, ## args)
	179
	180	/**
	181	* _trace_mark - Marker using variable read
	182	* @channel: marker channel (where to send the data), not quoted.
	183	* @name: marker name, not quoted.
	184	* @format: format string
	185	* @args...: variable argument list
	186	*
	187	* Places a marker using a standard memory read (_imv_read()) to be
	188	* enabled. Should be used for markers in code paths where instruction
	189	* modification based enabling is not welcome. (__init and __exit functions,
	190	* lockdep, some traps, printk).
	191	*/
	192	#define _trace_mark(channel, name, format, args...) \
	193	__trace_mark(1, channel, name, NULL, format, ## args)
	194
	195	/**
	196	* trace_mark_tp - Marker in a tracepoint callback
	197	* @channel: marker channel (where to send the data), not quoted.
	198	* @name: marker name, not quoted.
	199	* @tp_name: tracepoint name, not quoted.
	200	* @tp_cb: tracepoint callback. Should have an associated global symbol so it
	201	* is not optimized away by the compiler (should not be static).
	202	* @format: format string
	203	* @args...: variable argument list
	204	*
	205	* Places a marker in a tracepoint callback.
	206	*/
	207	#define trace_mark_tp(channel, name, tp_name, tp_cb, format, args...) \
	208	__trace_mark_tp(channel, name, NULL, tp_name, tp_cb, format, ## args)
	209
	210	/**
	211	* MARK_NOARGS - Format string for a marker with no argument.
	212	*/
	213	#define MARK_NOARGS " "
	214
	215	extern void lock_markers(void);
	216	extern void unlock_markers(void);
	217
	218	extern void markers_compact_event_ids(void);
	219
	220	/* To be used for string format validity checking with gcc */
	221	static inline void __printf(1, 2) ___mark_check_format(const char *fmt, ...)
	222	{
	223	}
	224
	225	#define __mark_check_format(format, args...) \
	226	do { \
	227	if (0) \
	228	___mark_check_format(format, ## args); \
	229	} while (0)
230
231	extern marker_probe_func __mark_empty_function;
232
233	extern void marker_probe_cb(const struct marker *mdata,
234	void *call_private, ...);
235
236	/*
237	* Connect a probe to a marker.
238	* private data pointer must be a valid allocated memory address, or NULL.
239	*/
240	extern int marker_probe_register(const char channel, const char name,
241	const char format, marker_probe_func probe, void *probe_private);
242
243	/*
244	* Returns the private data given to marker_probe_register.
245	*/
246	extern int marker_probe_unregister(const char channel, const char name,
247	marker_probe_func probe, void probe_private);
248	/*
249	* Unregister a marker by providing the registered private data.
250	*/
251	extern int marker_probe_unregister_private_data(marker_probe_func *probe,
252	void *probe_private);
253
254	extern void marker_get_private_data(const char channel, const char *name,
255	marker_probe_func *probe, int num);
256
257	/*
258	* marker_synchronize_unregister must be called between the last marker probe
259	* unregistration and the first one of
260	* - the end of module exit function
261	* - the free of any resource used by the probes
262	* to ensure the code and data are valid for any possibly running probes.
263	*/
264	#define marker_synchronize_unregister() synchronize_sched()
265
266	struct marker_iter {
98963de4 PMF	267	//ust// struct module *module;
98963de4 PMF	268	struct lib *lib;
a72ca31a PMF	269	struct marker *marker;
	270	};
	271
	272	extern void marker_iter_start(struct marker_iter *iter);
	273	extern void marker_iter_next(struct marker_iter *iter);
	274	extern void marker_iter_stop(struct marker_iter *iter);
	275	extern void marker_iter_reset(struct marker_iter *iter);
	276	extern int marker_get_iter_range(struct marker *marker, struct marker begin,
	277	struct marker *end);
	278
	279	extern void marker_update_process(void);
	280	extern int is_marker_enabled(const char channel, const char name);
	281
59b161cd PMF	282	//ust// #ifdef CONFIG_MARKERS_USERSPACE
	283	//ust// extern void exit_user_markers(struct task_struct *p);
	284	//ust// #else
	285	//ust// static inline void exit_user_markers(struct task_struct *p)
	286	//ust// {
	287	//ust// }
	288	//ust// #endif
a72ca31a	289
98963de4 PMF	290
	291	struct lib {
	292	struct marker *markers_start;
	293	int markers_count;
	294	struct list_head list;
	295	};
	296
872037bb PMF	297	extern int marker_register_lib(struct marker *markers_start,
872037bb PMF	298	int markers_count);
c463904d	299
872037bb PMF	300	#define MARKER_LIB \
872037bb PMF	301	extern struct marker __start___markers[] __attribute__((visibility("hidden"))); \
fbd8191b PMF	302	extern struct marker __stop___markers[] __attribute__((visibility("hidden"))); \
	303	\
	304	static void __attribute__((constructor)) __markers__init(void) \
	305	{ \
4d65ee62	306	DBG("next registration in "__FILE__"\n");\
c463904d PMF	307	marker_register_lib(__start___markers, (((long)__stop___markers)-((long)__start___markers))/sizeof(struct marker));\
c463904d PMF	308	}
98963de4	309
064842c6 PMF	310	extern void marker_set_new_marker_cb(void (cb)(struct marker ));
064842c6 PMF	311	extern void init_markers(void);
9160b4e4	312
474d745f	313	#endif