[lttng-modules.git] / ltt-events.h

#ifndef _LTT_EVENTS_H
#define _LTT_EVENTS_H

/*
 * ltt-events.h
 *
 * Copyright 2010 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * Holds LTTng per-session event registry.
 */

#include <linux/list.h>
#include <linux/uuid.h>
#include <linux/kprobes.h>
#include "ltt-debugfs-abi.h"

#undef is_signed_type
#define is_signed_type(type)		(((type)(-1)) < 0)

struct ltt_channel;
struct ltt_session;
struct lib_ring_buffer_ctx;
struct perf_event;
struct perf_event_attr;

/* Type description */

/* Update the astract_types name table in lttng-types.c along with this enum */
enum abstract_types {
	atype_integer,
	atype_enum,
	atype_array,
	atype_sequence,
	atype_string,
	NR_ABSTRACT_TYPES,
};

/* Update the string_encodings name table in lttng-types.c along with this enum */
enum lttng_string_encodings {
	lttng_encode_none = 0,
	lttng_encode_UTF8 = 1,
	lttng_encode_ASCII = 2,
	NR_STRING_ENCODINGS,
};

struct lttng_enum_entry {
	unsigned long long start, end;	/* start and end are inclusive */
	const char *string;
};

#define __type_integer(_type, _byte_order, _base, _encoding)	\
	{							\
	    .atype = atype_integer,				\
	    .u.basic.integer =					\
		{						\
		  .size = sizeof(_type) * CHAR_BIT,		\
		  .alignment = ltt_alignof(_type) * CHAR_BIT,	\
		  .signedness = is_signed_type(_type),		\
		  .reverse_byte_order = _byte_order != __BYTE_ORDER,	\
		  .base = _base,				\
		  .encoding = lttng_encode_##_encoding,		\
		},						\
	}							\

struct lttng_integer_type {
	unsigned int size;		/* in bits */
	unsigned short alignment;	/* in bits */
	unsigned int signedness:1;
	unsigned int reverse_byte_order:1;
	unsigned int base;		/* 2, 8, 10, 16, for pretty print */
	enum lttng_string_encodings encoding;
};

union _lttng_basic_type {
	struct lttng_integer_type integer;
	struct {
		const char *name;
	} enumeration;
	struct {
		enum lttng_string_encodings encoding;
	} string;
};

struct lttng_basic_type {
	enum abstract_types atype;
	union {
		union _lttng_basic_type basic;
	} u;
};

struct lttng_type {
	enum abstract_types atype;
	union {
		union _lttng_basic_type basic;
		struct {
			struct lttng_basic_type elem_type;
			unsigned int length;		/* num. elems. */
		} array;
		struct {
			struct lttng_basic_type length_type;
			struct lttng_basic_type elem_type;
		} sequence;
	} u;
};

struct lttng_enum {
	const char *name;
	struct lttng_type container_type;
	const struct lttng_enum_entry *entries;
	unsigned int len;
};

/* Event field description */

struct lttng_event_field {
	const char *name;
	struct lttng_type type;
};

struct lttng_ctx_field {
	const char *name;
	struct lttng_type type;
	void *callback;
	union {
		struct {
			struct perf_event **e;	/* per-cpu array */
			struct list_head head;
			struct perf_event_attr *attr;
		} perf_counter;
	} u;
	void (*destroy)(struct lttng_ctx_field *field);
};

struct lttng_ctx {
	struct lttng_ctx_field *fields;
	unsigned int nr_fields;
	unsigned int allocated_fields;
};

struct lttng_event_desc {
	const char *name;
	void *probe_callback;
	const struct lttng_event_ctx *ctx;	/* context */
	const struct lttng_event_field *fields;	/* event payload */
	unsigned int nr_fields;
	struct module *owner;
};

struct lttng_probe_desc {
	const struct lttng_event_desc *event_desc;
	unsigned int nr_events;
	struct list_head head;			/* chain registered probes */
};

/*
 * ltt_event structure is referred to by the tracing fast path. It must be
 * kept small.
 */
struct ltt_event {
	unsigned int id;
	struct ltt_channel *chan;
	const struct lttng_event_desc *desc;
	void *filter;
	enum lttng_kernel_instrumentation instrumentation;
	union {
		struct {
			struct kprobe kp;
			char *symbol_name;
		} kprobe;
		struct {
			char *symbol_name;
		} ftrace;
	} u;
	struct list_head list;		/* Event list */
	int metadata_dumped:1;
};

struct ltt_channel_ops {
	struct channel *(*channel_create)(const char *name,
				struct ltt_channel *ltt_chan,
				void *buf_addr,
				size_t subbuf_size, size_t num_subbuf,
				unsigned int switch_timer_interval,
				unsigned int read_timer_interval);
	void (*channel_destroy)(struct channel *chan);
	struct lib_ring_buffer *(*buffer_read_open)(struct channel *chan);
	void (*buffer_read_close)(struct lib_ring_buffer *buf);
	int (*event_reserve)(struct lib_ring_buffer_ctx *ctx,
			     uint32_t event_id);
	void (*event_commit)(struct lib_ring_buffer_ctx *ctx);
	void (*event_write)(struct lib_ring_buffer_ctx *ctx, const void *src,
			    size_t len);
	/*
	 * packet_avail_size returns the available size in the current
	 * packet. Note that the size returned is only a hint, since it
	 * may change due to concurrent writes.
	 */
	size_t (*packet_avail_size)(struct channel *chan);
	wait_queue_head_t *(*get_reader_wait_queue)(struct ltt_channel *chan);
};

struct ltt_channel {
	unsigned int id;
	struct channel *chan;		/* Channel buffers */
	/* Event ID management */
	struct ltt_session *session;
	struct file *file;		/* File associated to channel */
	unsigned int free_event_id;	/* Next event ID to allocate */
	struct list_head list;		/* Channel list */
	wait_queue_head_t notify_wait;	/* Channel addition notif. waitqueue */
	struct ltt_channel_ops *ops;
	int header_type;		/* 0: unset, 1: compact, 2: large */
	int metadata_dumped:1;
};

struct ltt_session {
	int active;			/* Is trace session active ? */
	struct file *file;		/* File associated to session */
	struct ltt_channel *metadata;	/* Metadata channel */
	struct list_head chan;		/* Channel list head */
	struct list_head events;	/* Event list head */
	struct list_head list;		/* Session list */
	unsigned int free_chan_id;	/* Next chan ID to allocate */
	uuid_le uuid;			/* Trace session unique ID */
	int metadata_dumped:1;
};

struct ltt_transport {
	char *name;
	struct module *owner;
	struct list_head node;
	struct ltt_channel_ops ops;
};

struct ltt_session *ltt_session_create(void);
int ltt_session_start(struct ltt_session *session);
int ltt_session_stop(struct ltt_session *session);
void ltt_session_destroy(struct ltt_session *session);

struct ltt_channel *ltt_channel_create(struct ltt_session *session,
				       const char *transport_name,
				       void *buf_addr,
				       size_t subbuf_size, size_t num_subbuf,
				       unsigned int switch_timer_interval,
				       unsigned int read_timer_interval);
struct ltt_channel *ltt_global_channel_create(struct ltt_session *session,
				       int overwrite, void *buf_addr,
				       size_t subbuf_size, size_t num_subbuf,
				       unsigned int switch_timer_interval,
				       unsigned int read_timer_interval);

struct ltt_event *ltt_event_create(struct ltt_channel *chan,
				   struct lttng_kernel_event *event_param,
				   void *filter);

void ltt_transport_register(struct ltt_transport *transport);
void ltt_transport_unregister(struct ltt_transport *transport);

int ltt_debugfs_abi_init(void);
void ltt_debugfs_abi_exit(void);

int ltt_probe_register(struct lttng_probe_desc *desc);
void ltt_probe_unregister(struct lttng_probe_desc *desc);
const struct lttng_event_desc *ltt_event_get(const char *name);
void ltt_event_put(const struct lttng_event_desc *desc);
int ltt_probes_init(void);
void ltt_probes_exit(void);
struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx);
void lttng_destroy_context(struct lttng_ctx *ctx);

#ifdef CONFIG_KPROBES
int lttng_kprobes_register(const char *name,
		const char *symbol_name,
		uint64_t offset,
		uint64_t addr,
		struct ltt_event *event);
void lttng_kprobes_unregister(struct ltt_event *event);
void lttng_kprobes_destroy_private(struct ltt_event *event);
#else
static inline
int lttng_kprobes_register(const char *name,
		const char *symbol_name,
		uint64_t offset,
		uint64_t addr,
		struct ltt_event *event)
{
	return -ENOSYS;
}

static inline
void lttng_kprobes_unregister(struct ltt_event *event)
{
}

static inline
void lttng_kprobes_destroy_private(struct ltt_event *event)
{
}
#endif

#ifdef CONFIG_DYNAMIC_FTRACE
int lttng_ftrace_register(const char *name,
			  const char *symbol_name,
			  struct ltt_event *event);
void lttng_ftrace_unregister(struct ltt_event *event);
void lttng_ftrace_destroy_private(struct ltt_event *event);
#else
static inline
int lttng_ftrace_register(const char *name,
			  const char *symbol_name,
			  struct ltt_event *event)
{
	return -ENOSYS;
}

static inline
void lttng_ftrace_unregister(struct ltt_event *event)
{
}

static inline
void lttng_ftrace_destroy_private(struct ltt_event *event)
{
}
#endif

extern const struct file_operations lttng_tracepoint_list_fops;

#endif /* _LTT_EVENTS_H */
Commit	Line	Data
11b5a3c2 MD	1	#ifndef _LTT_EVENTS_H
	2	#define _LTT_EVENTS_H
	3
4e3c1b9b MD	4	/*
	5	* ltt-events.h
	6	*
	7	* Copyright 2010 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	8	*
	9	* Holds LTTng per-session event registry.
	10	*/
	11
	12	#include <linux/list.h>
d793d5e1	13	#include <linux/uuid.h>
d6d808f3	14	#include <linux/kprobes.h>
11b5a3c2	15	#include "ltt-debugfs-abi.h"
4e3c1b9b	16
9e7e4892 MD	17	#undef is_signed_type
	18	#define is_signed_type(type) (((type)(-1)) < 0)
	19
4e3c1b9b MD	20	struct ltt_channel;
4e3c1b9b MD	21	struct ltt_session;
1c25284c	22	struct lib_ring_buffer_ctx;
ba1f5986	23	struct perf_event;
833ad6a0	24	struct perf_event_attr;
4e3c1b9b	25
c0edae1d MD	26	/* Type description */
	27
	28	/* Update the astract_types name table in lttng-types.c along with this enum */
	29	enum abstract_types {
	30	atype_integer,
	31	atype_enum,
	32	atype_array,
	33	atype_sequence,
	34	atype_string,
	35	NR_ABSTRACT_TYPES,
	36	};
	37
	38	/* Update the string_encodings name table in lttng-types.c along with this enum */
	39	enum lttng_string_encodings {
e0a7a7c4 MD	40	lttng_encode_none = 0,
	41	lttng_encode_UTF8 = 1,
	42	lttng_encode_ASCII = 2,
c0edae1d MD	43	NR_STRING_ENCODINGS,
	44	};
	45
	46	struct lttng_enum_entry {
	47	unsigned long long start, end; /* start and end are inclusive */
	48	const char *string;
	49	};
	50
64c796d8	51	#define __type_integer(_type, _byte_order, _base, _encoding) \
c099397a MD	52	{ \
	53	.atype = atype_integer, \
	54	.u.basic.integer = \
	55	{ \
30bdb6e4	56	.size = sizeof(_type) * CHAR_BIT, \
d793d5e1	57	.alignment = ltt_alignof(_type) * CHAR_BIT, \
c099397a MD	58	.signedness = is_signed_type(_type), \
c099397a MD	59	.reverse_byte_order = _byte_order != __BYTE_ORDER, \
e0a7a7c4	60	.base = _base, \
64c796d8	61	.encoding = lttng_encode_##_encoding, \
c099397a MD	62	}, \
	63	} \
	64
	65	struct lttng_integer_type {
	66	unsigned int size; /* in bits */
	67	unsigned short alignment; /* in bits */
	68	unsigned int signedness:1;
	69	unsigned int reverse_byte_order:1;
e0a7a7c4 MD	70	unsigned int base; /* 2, 8, 10, 16, for pretty print */
e0a7a7c4 MD	71	enum lttng_string_encodings encoding;
c099397a MD	72	};
	73
	74	union _lttng_basic_type {
	75	struct lttng_integer_type integer;
	76	struct {
	77	const char *name;
	78	} enumeration;
	79	struct {
	80	enum lttng_string_encodings encoding;
	81	} string;
	82	};
	83
	84	struct lttng_basic_type {
	85	enum abstract_types atype;
	86	union {
	87	union _lttng_basic_type basic;
	88	} u;
c0edae1d MD	89	};
	90
	91	struct lttng_type {
	92	enum abstract_types atype;
c0edae1d	93	union {
c099397a	94	union _lttng_basic_type basic;
c0edae1d	95	struct {
c099397a	96	struct lttng_basic_type elem_type;
c0edae1d MD	97	unsigned int length; /* num. elems. */
	98	} array;
	99	struct {
c099397a MD	100	struct lttng_basic_type length_type;
c099397a MD	101	struct lttng_basic_type elem_type;
c0edae1d	102	} sequence;
c0edae1d	103	} u;
c099397a MD	104	};
	105
	106	struct lttng_enum {
	107	const char *name;
	108	struct lttng_type container_type;
	109	const struct lttng_enum_entry *entries;
	110	unsigned int len;
	111	};
c0edae1d MD	112
	113	/* Event field description */
	114
	115	struct lttng_event_field {
	116	const char *name;
f17701fb	117	struct lttng_type type;
c0edae1d MD	118	};
c0edae1d MD	119
ba1f5986 MD	120	struct lttng_ctx_field {
	121	const char *name;
	122	struct lttng_type type;
833ad6a0	123	void *callback;
ba1f5986 MD	124	union {
	125	struct {
	126	struct perf_event *e; / per-cpu array */
833ad6a0 MD	127	struct list_head head;
833ad6a0 MD	128	struct perf_event_attr *attr;
ba1f5986 MD	129	} perf_counter;
ba1f5986 MD	130	} u;
2dccf128	131	void (destroy)(struct lttng_ctx_field field);
ba1f5986 MD	132	};
	133
	134	struct lttng_ctx {
833ad6a0	135	struct lttng_ctx_field *fields;
0d1a681e	136	unsigned int nr_fields;
ba1f5986	137	unsigned int allocated_fields;
0d1a681e MD	138	};
	139
	140	struct lttng_event_desc {
c0edae1d MD	141	const char *name;
c0edae1d MD	142	void *probe_callback;
0d1a681e MD	143	const struct lttng_event_ctx ctx; / context */
0d1a681e MD	144	const struct lttng_event_field fields; / event payload */
c0edae1d	145	unsigned int nr_fields;
dc7f600a	146	struct module *owner;
c0edae1d MD	147	};
c0edae1d MD	148
85a9ca7f MD	149	struct lttng_probe_desc {
	150	const struct lttng_event_desc *event_desc;
	151	unsigned int nr_events;
	152	struct list_head head; /* chain registered probes */
	153	};
	154
	155	/*
	156	* ltt_event structure is referred to by the tracing fast path. It must be
	157	* kept small.
	158	*/
	159	struct ltt_event {
	160	unsigned int id;
	161	struct ltt_channel *chan;
d3dbe23c	162	const struct lttng_event_desc *desc;
85a9ca7f	163	void *filter;
38d024ae	164	enum lttng_kernel_instrumentation instrumentation;
d6d808f3 MD	165	union {
	166	struct {
	167	struct kprobe kp;
	168	char *symbol_name;
	169	} kprobe;
e0a7a7c4 MD	170	struct {
	171	char *symbol_name;
	172	} ftrace;
d6d808f3	173	} u;
85a9ca7f	174	struct list_head list; /* Event list */
c099397a	175	int metadata_dumped:1;
85a9ca7f MD	176	};
	177
	178	struct ltt_channel_ops {
	179	struct channel (channel_create)(const char *name,
9115fbdc	180	struct ltt_channel *ltt_chan,
85a9ca7f MD	181	void *buf_addr,
	182	size_t subbuf_size, size_t num_subbuf,
	183	unsigned int switch_timer_interval,
	184	unsigned int read_timer_interval);
	185	void (channel_destroy)(struct channel chan);
	186	struct lib_ring_buffer (buffer_read_open)(struct channel *chan);
	187	void (buffer_read_close)(struct lib_ring_buffer buf);
4e1f08f4	188	int (event_reserve)(struct lib_ring_buffer_ctx ctx,
64c796d8	189	uint32_t event_id);
85a9ca7f MD	190	void (event_commit)(struct lib_ring_buffer_ctx ctx);
	191	void (event_write)(struct lib_ring_buffer_ctx ctx, const void *src,
	192	size_t len);
1ec3f75a MD	193	/*
	194	* packet_avail_size returns the available size in the current
	195	* packet. Note that the size returned is only a hint, since it
	196	* may change due to concurrent writes.
	197	*/
	198	size_t (packet_avail_size)(struct channel chan);
c099397a	199	wait_queue_head_t (get_reader_wait_queue)(struct ltt_channel *chan);
85a9ca7f MD	200	};
	201
	202	struct ltt_channel {
c099397a	203	unsigned int id;
85a9ca7f MD	204	struct channel chan; / Channel buffers */
	205	/* Event ID management */
	206	struct ltt_session *session;
	207	struct file file; / File associated to channel */
	208	unsigned int free_event_id; /* Next event ID to allocate */
	209	struct list_head list; /* Channel list */
	210	wait_queue_head_t notify_wait; /* Channel addition notif. waitqueue */
	211	struct ltt_channel_ops *ops;
9115fbdc	212	int header_type; /* 0: unset, 1: compact, 2: large */
c099397a	213	int metadata_dumped:1;
85a9ca7f MD	214	};
	215
	216	struct ltt_session {
	217	int active; /* Is trace session active ? */
	218	struct file file; / File associated to session */
c099397a	219	struct ltt_channel metadata; / Metadata channel */
85a9ca7f MD	220	struct list_head chan; /* Channel list head */
	221	struct list_head events; /* Event list head */
	222	struct list_head list; /* Session list */
c099397a	223	unsigned int free_chan_id; /* Next chan ID to allocate */
d793d5e1	224	uuid_le uuid; /* Trace session unique ID */
c099397a	225	int metadata_dumped:1;
85a9ca7f MD	226	};
	227
	228	struct ltt_transport {
	229	char *name;
	230	struct module *owner;
	231	struct list_head node;
	232	struct ltt_channel_ops ops;
	233	};
	234
baf20995	235	struct ltt_session *ltt_session_create(void);
c0e31d2e MD	236	int ltt_session_start(struct ltt_session *session);
c0e31d2e MD	237	int ltt_session_stop(struct ltt_session *session);
11b5a3c2	238	void ltt_session_destroy(struct ltt_session *session);
4e3c1b9b	239
baf20995	240	struct ltt_channel ltt_channel_create(struct ltt_session session,
5dbbdb43 MD	241	const char *transport_name,
	242	void *buf_addr,
	243	size_t subbuf_size, size_t num_subbuf,
	244	unsigned int switch_timer_interval,
	245	unsigned int read_timer_interval);
	246	struct ltt_channel ltt_global_channel_create(struct ltt_session session,
4e3c1b9b MD	247	int overwrite, void *buf_addr,
	248	size_t subbuf_size, size_t num_subbuf,
	249	unsigned int switch_timer_interval,
	250	unsigned int read_timer_interval);
4e3c1b9b	251
653fe716	252	struct ltt_event ltt_event_create(struct ltt_channel chan,
d6d808f3	253	struct lttng_kernel_event *event_param,
85a9ca7f	254	void *filter);
c0e31d2e MD	255
	256	void ltt_transport_register(struct ltt_transport *transport);
	257	void ltt_transport_unregister(struct ltt_transport *transport);
11b5a3c2	258
1c25284c MD	259	int ltt_debugfs_abi_init(void);
	260	void ltt_debugfs_abi_exit(void);
	261
85a9ca7f MD	262	int ltt_probe_register(struct lttng_probe_desc *desc);
	263	void ltt_probe_unregister(struct lttng_probe_desc *desc);
	264	const struct lttng_event_desc ltt_event_get(const char name);
	265	void ltt_event_put(const struct lttng_event_desc *desc);
cd4bd11f MD	266	int ltt_probes_init(void);
cd4bd11f MD	267	void ltt_probes_exit(void);
2dccf128 MD	268	struct lttng_ctx_field lttng_append_context(struct lttng_ctx *ctx);
2dccf128 MD	269	void lttng_destroy_context(struct lttng_ctx *ctx);
02119ee5	270
acd614cc	271	#ifdef CONFIG_KPROBES
f17701fb MD	272	int lttng_kprobes_register(const char *name,
	273	const char *symbol_name,
	274	uint64_t offset,
	275	uint64_t addr,
	276	struct ltt_event *event);
	277	void lttng_kprobes_unregister(struct ltt_event *event);
edeb3137	278	void lttng_kprobes_destroy_private(struct ltt_event *event);
acd614cc MD	279	#else
	280	static inline
	281	int lttng_kprobes_register(const char *name,
	282	const char *symbol_name,
	283	uint64_t offset,
	284	uint64_t addr,
	285	struct ltt_event *event)
	286	{
	287	return -ENOSYS;
	288	}
	289
25f53c39	290	static inline
acd614cc MD	291	void lttng_kprobes_unregister(struct ltt_event *event)
	292	{
	293	}
edeb3137 MD	294
	295	static inline
	296	void lttng_kprobes_destroy_private(struct ltt_event *event)
	297	{
	298	}
acd614cc	299	#endif
d6d808f3	300
e0a7a7c4 MD	301	#ifdef CONFIG_DYNAMIC_FTRACE
	302	int lttng_ftrace_register(const char *name,
	303	const char *symbol_name,
	304	struct ltt_event *event);
	305	void lttng_ftrace_unregister(struct ltt_event *event);
edeb3137	306	void lttng_ftrace_destroy_private(struct ltt_event *event);
e0a7a7c4 MD	307	#else
	308	static inline
	309	int lttng_ftrace_register(const char *name,
	310	const char *symbol_name,
	311	struct ltt_event *event)
	312	{
acd614cc	313	return -ENOSYS;
e0a7a7c4 MD	314	}
	315
	316	static inline
	317	void lttng_ftrace_unregister(struct ltt_event *event)
	318	{
	319	}
edeb3137 MD	320
	321	static inline
	322	void lttng_ftrace_destroy_private(struct ltt_event *event)
	323	{
	324	}
e0a7a7c4	325	#endif
271b6681 MD	326
	327	extern const struct file_operations lttng_tracepoint_list_fops;
	328
11b5a3c2	329	#endif /* _LTT_EVENTS_H */