[lttng-ust.git] / include / ust / 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 _UST_MARKER_H
#define _UST_MARKER_H

#include <stdarg.h>
#include <ust/immediate.h>
#include <ust/core.h>
#include <urcu/list.h>
#include <ust/processor.h>
#include <ust/kcompat/kcompat.h>
#include <ust/kcompat/stringify.h>

#include <bits/wordsize.h>

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, struct registers *regs, 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 registers *regs, ...);
	struct marker_probe_closure single;
	struct marker_probe_closure *multi;
	const char *tp_name;	/* Optional tracepoint name */
	void *tp_cb;		/* Optional tracepoint callback */
	void *location;		/* Address of marker in code */
};

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

#define _DEFINE_MARKER(channel, name, tp_name_str, tp_cb, format, unique, m)			\
		struct registers regs;								\
												\
		/* This next asm has to be a basic inline asm (no input/output/clobber), 	\
		 * because it must not require %-sign escaping, as we most certainly		\
		 * have some %-signs in the format string.					\
		 */										\
		asm volatile (									\
			/* We only define these symbols if they have not yet been defined. Indeed, \
			 * if two markers with the same channel/name are on the same line, they	\
			 * will try to create the same symbols, resulting in a conflict. This	\
			 * is not unusual as it can be the result of function inlining.		\
			 */									\
			".ifndef __mstrtab_" __stringify(channel) "_" __stringify(name) "_channel_" __stringify(unique) "\n\t"	\
			/*".section __markers_strings\n\t"*/					\
			".section __markers_strings,\"aw\"\n\t"					\
			"__mstrtab_" __stringify(channel) "_" __stringify(name) "_channel_" __stringify(unique) ":\n\t"	\
			".string \"" __stringify(channel) "\"\n\t"					\
			"__mstrtab_" __stringify(channel) "_" __stringify(name) "_name_" __stringify(unique) ":\n\t"	\
			".string \"" __stringify(name) "\"\n\t"						\
			"__mstrtab_" __stringify(channel) "_" __stringify(name) "_format_" __stringify(unique) ":\n\t"	\
			".string " "\"" format "\"" "\n\t"						\
			".previous\n\t"								\
			".endif\n\t"								\
		);										\
		asm volatile (									\
			/*".section __markers\n\t"*/ \
			".section __markers,\"aw\"\n\t"						\
			"2:\n\t" \
			_ASM_PTR "(__mstrtab_" __stringify(channel) "_" __stringify(name) "_channel_" __stringify(unique) ")\n\t" /* channel string */ \
			_ASM_PTR "(__mstrtab_" __stringify(channel) "_" __stringify(name) "_name_" __stringify(unique) ")\n\t" /* name string */ \
			_ASM_PTR "(__mstrtab_" __stringify(channel) "_" __stringify(name) "_format_" __stringify(unique) ")\n\t" /* format string */ \
			".byte 0\n\t" /* state imv */						\
			".byte 0\n\t" /* ptype */							\
			".hword 0\n\t" /* channel_id */						\
			".hword 0\n\t" /* event_id */						\
			".balign " __stringify(__WORDSIZE) " / 8\n\t" /* alignment */			\
			_ASM_PTR "(marker_probe_cb)\n\t" /* call */				\
			_ASM_PTR "(__mark_empty_function)\n\t" /* marker_probe_closure single.field1 */ \
			_ASM_PTR "0\n\t" /* marker_probe_closure single.field2 */			\
			_ASM_PTR "0\n\t" /* marker_probe_closure *multi */				\
			_ASM_PTR "0\n\t" /* tp_name */						\
			_ASM_PTR "0\n\t" /* tp_cb */						\
			_ASM_PTR "(1f)\n\t" /* location */						\
			".previous\n\t"								\
			/*".section __markers_ptrs\n\t"*/ \
			".section __markers_ptrs,\"a\"\n\t"					\
			_ASM_PTR "(2b)\n\t"							\
			".previous\n\t"								\
			"1:\n\t"								\
			ARCH_COPY_ADDR("%[outptr]")						\
		: [outptr] "=r" (m) );								\
												\
		save_registers(&regs)


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

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

#define _DEFINE_MARKER_TP(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 GET_MARKER(channel, name)		\
		__attribute__((section("__markers"))) =			\
		{ __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 };			\
		static struct marker * const __mark_ptr_##channel##_##name	\
			__attribute__((used, section("__markers_ptrs"))) =	\
			&GET_MARKER(channel, name);

/*
 * 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...) \
	__trace_mark_counter(generic, channel, name, __LINE__, call_private, format, ## args)

#define __trace_mark_counter(generic, channel, name, unique, call_private, format, args...) \
	do {								\
		struct marker *m;					\
		DEFINE_MARKER(channel, name, format, unique, m);			\
		__mark_check_format(format, ## args);			\
		if (!generic) {						\
			if (unlikely(imv_read(m->state))) \
				(m->call)(m, call_private, &regs, ## args);		\
		} else {						\
			if (unlikely(_imv_read(m->state))) \
				(m->call)(m, call_private, &regs, ## args);		\
		}							\
	} while (0)

#define __trace_mark_tp(channel, name, call_private, tp_name, tp_cb, format, args...) \
	__trace_mark_tp_counter(channel, name, __LINE__, call_private, tp_name, tp_cb, format, ## args)

#define __trace_mark_tp_counter(channel, name, unique, call_private, tp_name, tp_cb, format, args...) \
	do {								\
		struct registers regs;								\
		void __check_tp_type(void)				\
		{							\
			register_trace_##tp_name(tp_cb, call_private);		\
		}							\
		DEFINE_MARKER_TP(channel, name, tp_name, tp_cb, format);\
		__mark_check_format(format, ## args);			\
		(*GET_MARKER(channel, name).call)(&GET_MARKER(channel, name), \
			call_private, &regs, ## args);				\
	} while (0)

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

/**
 * 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.
 */
#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, struct registers *regs, ...);

/*
 * 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 * const *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 * const **marker, struct marker * const *begin,
	struct marker * const *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 marker_addr {
	struct marker *marker;
	void *addr;
};

struct lib {
	struct marker * const *markers_start;
#ifdef CONFIG_UST_GDB_INTEGRATION
	struct marker_addr *markers_addr_start;
#endif
	int markers_count;
	struct cds_list_head list;
};

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

#define MARKER_LIB							\
	extern struct marker * const __start___markers_ptrs[] __attribute__((weak, visibility("hidden"))); \
	extern struct marker * const __stop___markers_ptrs[] __attribute__((weak, visibility("hidden"))); \
									\
	static void __attribute__((constructor)) __markers__init(void)	\
	{								\
		marker_register_lib(__start___markers_ptrs,		\
				    __stop___markers_ptrs		\
				    - __start___markers_ptrs);		\
	}								\
									\
	static void __attribute__((destructor)) __markers__destroy(void)\
	{								\
		marker_unregister_lib(__start___markers_ptrs);		\
	}

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

#endif /* _UST_MARKER_H */
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
2288bf6d PMF	24	#ifndef _UST_MARKER_H
2288bf6d PMF	25	#define _UST_MARKER_H
e4621c7f	26
a72ca31a	27	#include <stdarg.h>
93d0f2ea	28	#include <ust/immediate.h>
518d7abb	29	#include <ust/core.h>
22d9080d	30	#include <urcu/list.h>
2782fc4b	31	#include <ust/processor.h>
518d7abb	32	#include <ust/kcompat/kcompat.h>
7b2c5007	33	#include <ust/kcompat/stringify.h>
59b161cd	34
9389f19d PMF	35	#include <bits/wordsize.h>
9389f19d PMF	36
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,
75667d04	53	void probe_private, struct registers regs, void *call_private,
a72ca31a PMF	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	*/
f91aa730	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 */
75667d04	72	void (call)(const struct marker mdata, void call_private, struct registers regs, ...);
a72ca31a PMF	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 */
3ea1e2fc	77	void location; / Address of marker in code */
eb5d20c6	78	};
a72ca31a	79
7b2c5007 DG	80	#define GET_MARKER(channel, name) (__mark_##channel##_##name)
7b2c5007 DG	81
9692fa18	82	#define _DEFINE_MARKER(channel, name, tp_name_str, tp_cb, format, unique, m) \
bb9ade29	83	struct registers regs; \
bb9ade29	84	\
a4db742a	85	/* This next asm has to be a basic inline asm (no input/output/clobber), \
9692fa18 PMF	86	* because it must not require %-sign escaping, as we most certainly \
	87	* have some %-signs in the format string. \
	88	*/ \
f91aa730 DG	89	asm volatile ( \
	90	/* We only define these symbols if they have not yet been defined. Indeed, \
	91	* if two markers with the same channel/name are on the same line, they \
	92	* will try to create the same symbols, resulting in a conflict. This \
	93	* is not unusual as it can be the result of function inlining. \
	94	*/ \
	95	".ifndef __mstrtab_" __stringify(channel) "_" __stringify(name) "_channel_" __stringify(unique) "\n\t" \
	96	/".section __markers_strings\n\t"/ \
7c9c083a	97	".section __markers_strings,\"aw\"\n\t" \
f91aa730 DG	98	"__mstrtab_" __stringify(channel) "_" __stringify(name) "_channel_" __stringify(unique) ":\n\t" \
	99	".string \"" __stringify(channel) "\"\n\t" \
	100	"__mstrtab_" __stringify(channel) "_" __stringify(name) "_name_" __stringify(unique) ":\n\t" \
	101	".string \"" __stringify(name) "\"\n\t" \
	102	"__mstrtab_" __stringify(channel) "_" __stringify(name) "_format_" __stringify(unique) ":\n\t" \
	103	".string " "\"" format "\"" "\n\t" \
	104	".previous\n\t" \
	105	".endif\n\t" \
9692fa18 PMF	106	); \
9692fa18 PMF	107	asm volatile ( \
f91aa730	108	/".section __markers\n\t"/ \
7c9c083a	109	".section __markers,\"aw\"\n\t" \
f91aa730 DG	110	"2:\n\t" \
	111	_ASM_PTR "(__mstrtab_" __stringify(channel) "_" __stringify(name) "_channel_" __stringify(unique) ")\n\t" /* channel string */ \
	112	_ASM_PTR "(__mstrtab_" __stringify(channel) "_" __stringify(name) "_name_" __stringify(unique) ")\n\t" /* name string */ \
	113	_ASM_PTR "(__mstrtab_" __stringify(channel) "_" __stringify(name) "_format_" __stringify(unique) ")\n\t" /* format string */ \
	114	".byte 0\n\t" /* state imv */ \
	115	".byte 0\n\t" /* ptype */ \
34174843 MD	116	".hword 0\n\t" /* channel_id */ \
34174843 MD	117	".hword 0\n\t" /* event_id */ \
f91aa730 DG	118	".balign " __stringify(__WORDSIZE) " / 8\n\t" /* alignment */ \
	119	_ASM_PTR "(marker_probe_cb)\n\t" /* call */ \
	120	_ASM_PTR "(__mark_empty_function)\n\t" /* marker_probe_closure single.field1 */ \
	121	_ASM_PTR "0\n\t" /* marker_probe_closure single.field2 */ \
	122	_ASM_PTR "0\n\t" /* marker_probe_closure multi / \
	123	_ASM_PTR "0\n\t" /* tp_name */ \
	124	_ASM_PTR "0\n\t" /* tp_cb */ \
	125	_ASM_PTR "(1f)\n\t" /* location */ \
	126	".previous\n\t" \
eb5d20c6	127	/".section __markers_ptrs\n\t"/ \
7c9c083a	128	".section __markers_ptrs,\"a\"\n\t" \
eb5d20c6 MD	129	_ASM_PTR "(2b)\n\t" \
	130	".previous\n\t" \
	131	"1:\n\t" \
f91aa730	132	ARCH_COPY_ADDR("%[outptr]") \
9692fa18	133	: [outptr] "=r" (m) ); \
bb9ade29	134	\
3ea1e2fc PMF	135	save_registers(&regs)
	136
	137
9692fa18 PMF	138	#define DEFINE_MARKER(channel, name, format, unique, m) \
9692fa18 PMF	139	_DEFINE_MARKER(channel, name, NULL, NULL, format, unique, m)
a72ca31a	140
7166e240 PMF	141	#define DEFINE_MARKER_TP(channel, name, tp_name, tp_cb, format) \
	142	_DEFINE_MARKER_TP(channel, name, #tp_name, tp_cb, format)
	143
	144	#define _DEFINE_MARKER_TP(channel, name, tp_name_str, tp_cb, format) \
	145	static const char __mstrtab_##channel##_##name[] \
	146	__attribute__((section("__markers_strings"))) \
	147	= #channel "\0" #name "\0" format; \
7b2c5007	148	static struct marker GET_MARKER(channel, name) \
eb5d20c6	149	__attribute__((section("__markers"))) = \
7166e240	150	{ __mstrtab_##channel##_##name, \
f91aa730 DG	151	&__mstrtab_##channel##_##name[sizeof(#channel)], \
	152	&__mstrtab_##channel##_##name[sizeof(#channel) + sizeof(#name)], \
	153	0, 0, 0, 0, marker_probe_cb, \
	154	{ __mark_empty_function, NULL}, \
eb5d20c6 MD	155	NULL, tp_name_str, tp_cb }; \
	156	static struct marker * const __mark_ptr_##channel##_##name \
	157	__attribute__((used, section("__markers_ptrs"))) = \
	158	&GET_MARKER(channel, name);
a72ca31a PMF	159
	160	/*
	161	* Make sure the alignment of the structure in the __markers section will
	162	* not add unwanted padding between the beginning of the section and the
	163	* structure. Force alignment to the same alignment as the section start.
	164	*
	165	* The "generic" argument controls which marker enabling mechanism must be used.
	166	* If generic is true, a variable read is used.
	167	* If generic is false, immediate values are used.
	168	*/
bb9ade29	169
a72ca31a	170	#define __trace_mark(generic, channel, name, call_private, format, args...) \
e05cba90	171	__trace_mark_counter(generic, channel, name, __LINE__, call_private, format, ## args)
bb9ade29 PMF	172
bb9ade29 PMF	173	#define __trace_mark_counter(generic, channel, name, unique, call_private, format, args...) \
a72ca31a	174	do { \
9692fa18 PMF	175	struct marker *m; \
9692fa18 PMF	176	DEFINE_MARKER(channel, name, format, unique, m); \
a72ca31a PMF	177	__mark_check_format(format, ## args); \
a72ca31a PMF	178	if (!generic) { \
9692fa18 PMF	179	if (unlikely(imv_read(m->state))) \
9692fa18 PMF	180	(m->call)(m, call_private, &regs, ## args); \
a72ca31a	181	} else { \
9692fa18 PMF	182	if (unlikely(_imv_read(m->state))) \
9692fa18 PMF	183	(m->call)(m, call_private, &regs, ## args); \
a72ca31a PMF	184	} \
	185	} while (0)
	186
bb9ade29	187	#define __trace_mark_tp(channel, name, call_private, tp_name, tp_cb, format, args...) \
e05cba90	188	__trace_mark_tp_counter(channel, name, __LINE__, call_private, tp_name, tp_cb, format, ## args)
bb9ade29 PMF	189
bb9ade29 PMF	190	#define __trace_mark_tp_counter(channel, name, unique, call_private, tp_name, tp_cb, format, args...) \
a72ca31a	191	do { \
b2cc3e50	192	struct registers regs; \
a72ca31a PMF	193	void __check_tp_type(void) \
a72ca31a PMF	194	{ \
245d371e	195	register_trace_##tp_name(tp_cb, call_private); \
a72ca31a	196	} \
b2cc3e50	197	DEFINE_MARKER_TP(channel, name, tp_name, tp_cb, format);\
a72ca31a	198	__mark_check_format(format, ## args); \
7b2c5007	199	(*GET_MARKER(channel, name).call)(&GET_MARKER(channel, name), \
75667d04	200	call_private, &regs, ## args); \
a72ca31a PMF	201	} while (0)
a72ca31a PMF	202
eb5d20c6 MD	203	extern void marker_update_probe_range(struct marker * const *begin,
eb5d20c6 MD	204	struct marker * const *end);
a72ca31a	205
a72ca31a PMF	206	/**
	207	* trace_mark - Marker using code patching
	208	* @channel: marker channel (where to send the data), not quoted.
	209	* @name: marker name, not quoted.
	210	* @format: format string
	211	* @args...: variable argument list
	212	*
	213	* Places a marker using optimized code patching technique (imv_read())
	214	* to be enabled when immediate values are present.
	215	*/
	216	#define trace_mark(channel, name, format, args...) \
	217	__trace_mark(0, channel, name, NULL, format, ## args)
	218
	219	/**
	220	* _trace_mark - Marker using variable read
	221	* @channel: marker channel (where to send the data), not quoted.
	222	* @name: marker name, not quoted.
	223	* @format: format string
	224	* @args...: variable argument list
	225	*
	226	* Places a marker using a standard memory read (_imv_read()) to be
	227	* enabled. Should be used for markers in code paths where instruction
c1f20530	228	* modification based enabling is not welcome.
a72ca31a PMF	229	*/
	230	#define _trace_mark(channel, name, format, args...) \
	231	__trace_mark(1, channel, name, NULL, format, ## args)
	232
	233	/**
	234	* trace_mark_tp - Marker in a tracepoint callback
	235	* @channel: marker channel (where to send the data), not quoted.
	236	* @name: marker name, not quoted.
	237	* @tp_name: tracepoint name, not quoted.
	238	* @tp_cb: tracepoint callback. Should have an associated global symbol so it
	239	* is not optimized away by the compiler (should not be static).
	240	* @format: format string
	241	* @args...: variable argument list
	242	*
	243	* Places a marker in a tracepoint callback.
	244	*/
	245	#define trace_mark_tp(channel, name, tp_name, tp_cb, format, args...) \
	246	__trace_mark_tp(channel, name, NULL, tp_name, tp_cb, format, ## args)
	247
	248	/**
	249	* MARK_NOARGS - Format string for a marker with no argument.
	250	*/
	251	#define MARK_NOARGS " "
	252
	253	extern void lock_markers(void);
	254	extern void unlock_markers(void);
	255
	256	extern void markers_compact_event_ids(void);
	257
	258	/* To be used for string format validity checking with gcc */
	259	static inline void __printf(1, 2) ___mark_check_format(const char *fmt, ...)
	260	{
	261	}
	262
	263	#define __mark_check_format(format, args...) \
	264	do { \
	265	if (0) \
	266	___mark_check_format(format, ## args); \
	267	} while (0)
	268
	269	extern marker_probe_func __mark_empty_function;
	270
	271	extern void marker_probe_cb(const struct marker *mdata,
75667d04	272	void call_private, struct registers regs, ...);
a72ca31a PMF	273
	274	/*
	275	* Connect a probe to a marker.
	276	* private data pointer must be a valid allocated memory address, or NULL.
	277	*/
	278	extern int marker_probe_register(const char channel, const char name,
	279	const char format, marker_probe_func probe, void *probe_private);
	280
	281	/*
	282	* Returns the private data given to marker_probe_register.
	283	*/
	284	extern int marker_probe_unregister(const char channel, const char name,
	285	marker_probe_func probe, void probe_private);
	286	/*
	287	* Unregister a marker by providing the registered private data.
	288	*/
	289	extern int marker_probe_unregister_private_data(marker_probe_func *probe,
	290	void *probe_private);
	291
	292	extern void marker_get_private_data(const char channel, const char *name,
	293	marker_probe_func *probe, int num);
	294
	295	/*
	296	* marker_synchronize_unregister must be called between the last marker probe
	297	* unregistration and the first one of
	298	* - the end of module exit function
	299	* - the free of any resource used by the probes
	300	* to ensure the code and data are valid for any possibly running probes.
	301	*/
	302	#define marker_synchronize_unregister() synchronize_sched()
	303
	304	struct marker_iter {
98963de4 PMF	305	//ust// struct module *module;
98963de4 PMF	306	struct lib *lib;
eb5d20c6	307	struct marker * const *marker;
a72ca31a PMF	308	};
	309
	310	extern void marker_iter_start(struct marker_iter *iter);
	311	extern void marker_iter_next(struct marker_iter *iter);
	312	extern void marker_iter_stop(struct marker_iter *iter);
	313	extern void marker_iter_reset(struct marker_iter *iter);
eb5d20c6 MD	314	extern int marker_get_iter_range(struct marker * const *marker, struct marker const *begin,
eb5d20c6 MD	315	struct marker * const *end);
a72ca31a PMF	316
	317	extern void marker_update_process(void);
	318	extern int is_marker_enabled(const char channel, const char name);
	319
59b161cd PMF	320	//ust// #ifdef CONFIG_MARKERS_USERSPACE
	321	//ust// extern void exit_user_markers(struct task_struct *p);
	322	//ust// #else
	323	//ust// static inline void exit_user_markers(struct task_struct *p)
	324	//ust// {
	325	//ust// }
	326	//ust// #endif
a72ca31a	327
3ea1e2fc PMF	328	struct marker_addr {
	329	struct marker *marker;
	330	void *addr;
	331	};
98963de4 PMF	332
98963de4 PMF	333	struct lib {
eb5d20c6	334	struct marker * const *markers_start;
defa46a7	335	#ifdef CONFIG_UST_GDB_INTEGRATION
3ea1e2fc	336	struct marker_addr *markers_addr_start;
defa46a7	337	#endif
98963de4	338	int markers_count;
0222e121	339	struct cds_list_head list;
98963de4 PMF	340	};
98963de4 PMF	341
eb5d20c6 MD	342	extern int marker_register_lib(struct marker * const *markers_start, int markers_count);
eb5d20c6 MD	343	extern int marker_unregister_lib(struct marker * const *markers_start);
defa46a7	344
55994a67	345	#define MARKER_LIB \
900e307e MD	346	extern struct marker * const __start___markers_ptrs[] __attribute__((weak, visibility("hidden"))); \
900e307e MD	347	extern struct marker * const __stop___markers_ptrs[] __attribute__((weak, visibility("hidden"))); \
55994a67 JB	348	\
	349	static void __attribute__((constructor)) __markers__init(void) \
	350	{ \
900e307e MD	351	marker_register_lib(__start___markers_ptrs, \
	352	__stop___markers_ptrs \
	353	- __start___markers_ptrs); \
	354	} \
	355	\
	356	static void __attribute__((destructor)) __markers__destroy(void)\
24b6668c	357	{ \
900e307e	358	marker_unregister_lib(__start___markers_ptrs); \
55994a67	359	}
98963de4	360
064842c6 PMF	361	extern void marker_set_new_marker_cb(void (cb)(struct marker ));
064842c6 PMF	362	extern void init_markers(void);
9160b4e4	363
defa46a7	364	#endif /* _UST_MARKER_H */