[lttng-ust.git] / libust / 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.
 *
 * Dual LGPL v2.1/GPL v2 license.
 */

#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 {
	struct lttng_event_field event_field;
	size_t (*get_size)(size_t offset);
	void (*record)(struct lttng_ctx_field *field,
		       struct lib_ring_buffer_ctx *ctx,
		       struct ltt_channel *chan);
	union {
		struct {
			struct perf_event **e;	/* per-cpu array */
			struct notifier_block nb;
			int hp_enable;
			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;
	int enabled;
	const struct lttng_event_desc *desc;
	void *filter;
	struct lttng_ctx *ctx;
	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 channel *chan);
	wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
	int (*is_finalized)(struct channel *chan);
	int (*is_disabled)(struct channel *chan);
};

struct ltt_channel {
	unsigned int id;
	struct channel *chan;		/* Channel buffers */
	int enabled;
	struct lttng_ctx *ctx;
	/* 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 */
	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 ? */
	int been_active;		/* Has trace session been 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_enable(struct ltt_session *session);
int ltt_session_disable(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);

int ltt_channel_enable(struct ltt_channel *channel);
int ltt_channel_disable(struct ltt_channel *channel);
int ltt_event_enable(struct ltt_event *event);
int ltt_event_disable(struct ltt_event *event);

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

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