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

#ifndef _LTTNG_EVENTS_H
#define _LTTNG_EVENTS_H

/*
 * lttng-events.h
 *
 * Holds LTTng per-session event registry.
 *
 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; only
 * version 2.1 of the License.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

#include <linux/version.h>
#include <linux/list.h>
#include <linux/kprobes.h>
#include <linux/kref.h>
#include "wrapper/uuid.h"
#include "lttng-abi.h"
#include "lttng-abi-old.h"

#define lttng_is_signed_type(type)	(((type)(-1)) < 0)

struct lttng_channel;
struct lttng_session;
struct lttng_metadata_cache;
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,
};

enum channel_type {
	PER_CPU_CHANNEL,
	METADATA_CHANNEL,
};

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 = lttng_alignof(_type) * CHAR_BIT,	\
		  .signedness = lttng_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,
		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;
};

/*
 * We need to keep this perf counter field separately from struct
 * lttng_ctx_field because cpu hotplug needs fixed-location addresses.
 */
struct lttng_perf_counter_field {
	struct notifier_block nb;
	int hp_enable;
	struct perf_event_attr *attr;
	struct perf_event **e;	/* per-cpu array */
};

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 lttng_channel *chan);
	union {
		struct lttng_perf_counter_field *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 */
};

struct lttng_krp;				/* Kretprobe handling */

/*
 * lttng_event structure is referred to by the tracing fast path. It must be
 * kept small.
 */
struct lttng_event {
	unsigned int id;
	struct lttng_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 {
			struct lttng_krp *lttng_krp;
			char *symbol_name;
		} kretprobe;
		struct {
			char *symbol_name;
		} ftrace;
	} u;
	struct list_head list;		/* Event list */
	unsigned int metadata_dumped:1;
};

struct lttng_channel_ops {
	struct channel *(*channel_create)(const char *name,
				struct lttng_channel *lttng_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);
	int (*buffer_has_read_closed_stream)(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);
	void (*event_write_from_user)(struct lib_ring_buffer_ctx *ctx,
				      const void *src, size_t len);
	void (*event_memset)(struct lib_ring_buffer_ctx *ctx,
			     int c, 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_writer_buf_wait_queue)(struct channel *chan, int cpu);
	wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
	int (*is_finalized)(struct channel *chan);
	int (*is_disabled)(struct channel *chan);
};

struct lttng_transport {
	char *name;
	struct module *owner;
	struct list_head node;
	struct lttng_channel_ops ops;
};

struct lttng_channel {
	unsigned int id;
	struct channel *chan;		/* Channel buffers */
	int enabled;
	struct lttng_ctx *ctx;
	/* Event ID management */
	struct lttng_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 lttng_channel_ops *ops;
	struct lttng_transport *transport;
	struct lttng_event **sc_table;	/* for syscall tracing */
	struct lttng_event **compat_sc_table;
	struct lttng_event *sc_unknown;	/* for unknown syscalls */
	struct lttng_event *sc_compat_unknown;
	struct lttng_event *sc_exit;	/* for syscall exit */
	int header_type;		/* 0: unset, 1: compact, 2: large */
	enum channel_type channel_type;
	unsigned int metadata_dumped:1;
};

struct lttng_metadata_stream {
	void *priv;			/* Ring buffer private data */
	struct lttng_metadata_cache *metadata_cache;
	unsigned int metadata_in;	/* Bytes read from the cache */
	unsigned int metadata_out;	/* Bytes consumed from stream */
	int finalized;			/* Has channel been finalized */
	wait_queue_head_t read_wait;	/* Reader buffer-level wait queue */
	struct list_head list;		/* Stream list */
};

struct lttng_session {
	int active;			/* Is trace session active ? */
	int been_active;		/* Has trace session been active ? */
	struct file *file;		/* File associated to session */
	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 */
	struct lttng_metadata_cache *metadata_cache;
	unsigned int metadata_dumped:1;
};

struct lttng_metadata_cache {
	char *data;			/* Metadata cache */
	unsigned int cache_alloc;	/* Metadata allocated size (bytes) */
	unsigned int metadata_written;	/* Number of bytes written in metadata cache */
	struct kref refcount;		/* Metadata cache usage */
	struct list_head metadata_stream;	/* Metadata stream list */
};

struct lttng_session *lttng_session_create(void);
int lttng_session_enable(struct lttng_session *session);
int lttng_session_disable(struct lttng_session *session);
void lttng_session_destroy(struct lttng_session *session);
void metadata_cache_destroy(struct kref *kref);

struct lttng_channel *lttng_channel_create(struct lttng_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,
				       enum channel_type channel_type);
struct lttng_channel *lttng_global_channel_create(struct lttng_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);

void lttng_metadata_channel_destroy(struct lttng_channel *chan);
struct lttng_event *lttng_event_create(struct lttng_channel *chan,
				   struct lttng_kernel_event *event_param,
				   void *filter,
				   const struct lttng_event_desc *internal_desc);
struct lttng_event *lttng_event_compat_old_create(struct lttng_channel *chan,
		struct lttng_kernel_old_event *old_event_param,
		void *filter,
		const struct lttng_event_desc *internal_desc);

int lttng_channel_enable(struct lttng_channel *channel);
int lttng_channel_disable(struct lttng_channel *channel);
int lttng_event_enable(struct lttng_event *event);
int lttng_event_disable(struct lttng_event *event);

void lttng_transport_register(struct lttng_transport *transport);
void lttng_transport_unregister(struct lttng_transport *transport);

void synchronize_trace(void);
int lttng_abi_init(void);
int lttng_abi_compat_old_init(void);
void lttng_abi_exit(void);
void lttng_abi_compat_old_exit(void);

int lttng_probe_register(struct lttng_probe_desc *desc);
void lttng_probe_unregister(struct lttng_probe_desc *desc);
const struct lttng_event_desc *lttng_event_get(const char *name);
void lttng_event_put(const struct lttng_event_desc *desc);
int lttng_probes_init(void);
void lttng_probes_exit(void);

int lttng_metadata_output_channel(struct lttng_channel *chan,
		struct lttng_metadata_stream *stream);

#if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
int lttng_syscalls_register(struct lttng_channel *chan, void *filter);
int lttng_syscalls_unregister(struct lttng_channel *chan);
#else
static inline int lttng_syscalls_register(struct lttng_channel *chan, void *filter)
{
	return -ENOSYS;
}

static inline int lttng_syscalls_unregister(struct lttng_channel *chan)
{
	return 0;
}
#endif

struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx);
int lttng_find_context(struct lttng_ctx *ctx, const char *name);
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_procname_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_vpid_to_ctx(struct lttng_ctx **ctx);
int lttng_add_tid_to_ctx(struct lttng_ctx **ctx);
int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx);
int lttng_add_ppid_to_ctx(struct lttng_ctx **ctx);
int lttng_add_vppid_to_ctx(struct lttng_ctx **ctx);
int lttng_add_hostname_to_ctx(struct lttng_ctx **ctx);
#if defined(CONFIG_PERF_EVENTS) && (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,33))
int lttng_add_perf_counter_to_ctx(uint32_t type,
				  uint64_t config,
				  const char *name,
				  struct lttng_ctx **ctx);
#else
static inline
int lttng_add_perf_counter_to_ctx(uint32_t type,
				  uint64_t config,
				  const char *name,
				  struct lttng_ctx **ctx)
{
	return -ENOSYS;
}
#endif

extern int lttng_statedump_start(struct lttng_session *session);

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

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

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

#ifdef CONFIG_KRETPROBES
int lttng_kretprobes_register(const char *name,
		const char *symbol_name,
		uint64_t offset,
		uint64_t addr,
		struct lttng_event *event_entry,
		struct lttng_event *event_exit);
void lttng_kretprobes_unregister(struct lttng_event *event);
void lttng_kretprobes_destroy_private(struct lttng_event *event);
#else
static inline
int lttng_kretprobes_register(const char *name,
		const char *symbol_name,
		uint64_t offset,
		uint64_t addr,
		struct lttng_event *event_entry,
		struct lttng_event *event_exit)
{
	return -ENOSYS;
}

static inline
void lttng_kretprobes_unregister(struct lttng_event *event)
{
}

static inline
void lttng_kretprobes_destroy_private(struct lttng_event *event)
{
}
#endif

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

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

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

int lttng_calibrate(struct lttng_kernel_calibrate *calibrate);

extern const struct file_operations lttng_tracepoint_list_fops;

#if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,35))
#define TRACEPOINT_HAS_DATA_ARG
#endif

#endif /* _LTTNG_EVENTS_H */
Commit	Line	Data
a90917c3 MD	1	#ifndef _LTTNG_EVENTS_H
a90917c3 MD	2	#define _LTTNG_EVENTS_H
11b5a3c2	3
4e3c1b9b	4	/*
a90917c3	5	* lttng-events.h
4e3c1b9b	6	*
4e3c1b9b	7	* Holds LTTng per-session event registry.
17baffe2	8	*
886d51a3 MD	9	* Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	10	*
	11	* This library is free software; you can redistribute it and/or
	12	* modify it under the terms of the GNU Lesser General Public
	13	* License as published by the Free Software Foundation; only
	14	* version 2.1 of the License.
	15	*
	16	* This library is distributed in the hope that it will be useful,
	17	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	18	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	19	* Lesser General Public License for more details.
	20	*
	21	* You should have received a copy of the GNU Lesser General Public
	22	* License along with this library; if not, write to the Free Software
	23	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
4e3c1b9b MD	24	*/
4e3c1b9b MD	25
3a523f5b	26	#include <linux/version.h>
4e3c1b9b	27	#include <linux/list.h>
d6d808f3	28	#include <linux/kprobes.h>
d83004aa	29	#include <linux/kref.h>
a864fb02	30	#include "wrapper/uuid.h"
e8951e63	31	#include "lttng-abi.h"
6dccd6c1	32	#include "lttng-abi-old.h"
4e3c1b9b	33
06254b0f	34	#define lttng_is_signed_type(type) (((type)(-1)) < 0)
9e7e4892	35
a90917c3 MD	36	struct lttng_channel;
a90917c3 MD	37	struct lttng_session;
d83004aa	38	struct lttng_metadata_cache;
1c25284c	39	struct lib_ring_buffer_ctx;
ba1f5986	40	struct perf_event;
833ad6a0	41	struct perf_event_attr;
4e3c1b9b	42
c0edae1d MD	43	/* Type description */
	44
	45	/* Update the astract_types name table in lttng-types.c along with this enum */
	46	enum abstract_types {
	47	atype_integer,
	48	atype_enum,
	49	atype_array,
	50	atype_sequence,
	51	atype_string,
	52	NR_ABSTRACT_TYPES,
	53	};
	54
	55	/* Update the string_encodings name table in lttng-types.c along with this enum */
	56	enum lttng_string_encodings {
e0a7a7c4 MD	57	lttng_encode_none = 0,
	58	lttng_encode_UTF8 = 1,
	59	lttng_encode_ASCII = 2,
c0edae1d MD	60	NR_STRING_ENCODINGS,
	61	};
	62
d83004aa JD	63	enum channel_type {
	64	PER_CPU_CHANNEL,
	65	METADATA_CHANNEL,
	66	};
	67
c0edae1d MD	68	struct lttng_enum_entry {
	69	unsigned long long start, end; /* start and end are inclusive */
	70	const char *string;
	71	};
	72
64c796d8	73	#define __type_integer(_type, _byte_order, _base, _encoding) \
c099397a MD	74	{ \
	75	.atype = atype_integer, \
	76	.u.basic.integer = \
	77	{ \
30bdb6e4	78	.size = sizeof(_type) * CHAR_BIT, \
a90917c3	79	.alignment = lttng_alignof(_type) * CHAR_BIT, \
06254b0f	80	.signedness = lttng_is_signed_type(_type), \
c099397a	81	.reverse_byte_order = _byte_order != __BYTE_ORDER, \
e0a7a7c4	82	.base = _base, \
64c796d8	83	.encoding = lttng_encode_##_encoding, \
c099397a MD	84	}, \
	85	} \
	86
	87	struct lttng_integer_type {
	88	unsigned int size; /* in bits */
	89	unsigned short alignment; /* in bits */
9cccf98a MD	90	unsigned int signedness:1,
9cccf98a MD	91	reverse_byte_order:1;
e0a7a7c4 MD	92	unsigned int base; /* 2, 8, 10, 16, for pretty print */
e0a7a7c4 MD	93	enum lttng_string_encodings encoding;
c099397a MD	94	};
	95
	96	union _lttng_basic_type {
	97	struct lttng_integer_type integer;
	98	struct {
	99	const char *name;
	100	} enumeration;
	101	struct {
	102	enum lttng_string_encodings encoding;
	103	} string;
	104	};
	105
	106	struct lttng_basic_type {
	107	enum abstract_types atype;
	108	union {
	109	union _lttng_basic_type basic;
	110	} u;
c0edae1d MD	111	};
	112
	113	struct lttng_type {
	114	enum abstract_types atype;
c0edae1d	115	union {
c099397a	116	union _lttng_basic_type basic;
c0edae1d	117	struct {
c099397a	118	struct lttng_basic_type elem_type;
c0edae1d MD	119	unsigned int length; /* num. elems. */
	120	} array;
	121	struct {
c099397a MD	122	struct lttng_basic_type length_type;
c099397a MD	123	struct lttng_basic_type elem_type;
c0edae1d	124	} sequence;
c0edae1d	125	} u;
c099397a MD	126	};
	127
	128	struct lttng_enum {
	129	const char *name;
	130	struct lttng_type container_type;
	131	const struct lttng_enum_entry *entries;
	132	unsigned int len;
	133	};
c0edae1d MD	134
	135	/* Event field description */
	136
	137	struct lttng_event_field {
	138	const char *name;
f17701fb	139	struct lttng_type type;
c0edae1d MD	140	};
c0edae1d MD	141
2001023e MD	142	/*
	143	* We need to keep this perf counter field separately from struct
	144	* lttng_ctx_field because cpu hotplug needs fixed-location addresses.
	145	*/
	146	struct lttng_perf_counter_field {
	147	struct notifier_block nb;
	148	int hp_enable;
	149	struct perf_event_attr *attr;
	150	struct perf_event *e; / per-cpu array */
	151	};
	152
ba1f5986	153	struct lttng_ctx_field {
8070f5c0	154	struct lttng_event_field event_field;
f1676205 MD	155	size_t (*get_size)(size_t offset);
	156	void (record)(struct lttng_ctx_field field,
	157	struct lib_ring_buffer_ctx *ctx,
a90917c3	158	struct lttng_channel *chan);
ba1f5986	159	union {
2001023e	160	struct lttng_perf_counter_field *perf_counter;
ba1f5986	161	} u;
2dccf128	162	void (destroy)(struct lttng_ctx_field field);
ba1f5986 MD	163	};
	164
	165	struct lttng_ctx {
833ad6a0	166	struct lttng_ctx_field *fields;
0d1a681e	167	unsigned int nr_fields;
ba1f5986	168	unsigned int allocated_fields;
0d1a681e MD	169	};
	170
	171	struct lttng_event_desc {
c0edae1d MD	172	const char *name;
c0edae1d MD	173	void *probe_callback;
0d1a681e MD	174	const struct lttng_event_ctx ctx; / context */
0d1a681e MD	175	const struct lttng_event_field fields; / event payload */
c0edae1d	176	unsigned int nr_fields;
dc7f600a	177	struct module *owner;
c0edae1d MD	178	};
c0edae1d MD	179
85a9ca7f	180	struct lttng_probe_desc {
f7bdf4db	181	const struct lttng_event_desc **event_desc;
85a9ca7f MD	182	unsigned int nr_events;
	183	struct list_head head; /* chain registered probes */
	184	};
	185
7371f44c MD	186	struct lttng_krp; /* Kretprobe handling */
7371f44c MD	187
85a9ca7f	188	/*
a90917c3	189	* lttng_event structure is referred to by the tracing fast path. It must be
85a9ca7f MD	190	* kept small.
85a9ca7f MD	191	*/
a90917c3	192	struct lttng_event {
85a9ca7f	193	unsigned int id;
a90917c3	194	struct lttng_channel *chan;
e64957da	195	int enabled;
d3dbe23c	196	const struct lttng_event_desc *desc;
85a9ca7f	197	void *filter;
f1676205	198	struct lttng_ctx *ctx;
38d024ae	199	enum lttng_kernel_instrumentation instrumentation;
d6d808f3 MD	200	union {
	201	struct {
	202	struct kprobe kp;
	203	char *symbol_name;
	204	} kprobe;
7371f44c MD	205	struct {
	206	struct lttng_krp *lttng_krp;
	207	char *symbol_name;
	208	} kretprobe;
e0a7a7c4 MD	209	struct {
	210	char *symbol_name;
	211	} ftrace;
d6d808f3	212	} u;
85a9ca7f	213	struct list_head list; /* Event list */
9cccf98a	214	unsigned int metadata_dumped:1;
85a9ca7f MD	215	};
85a9ca7f MD	216
a90917c3	217	struct lttng_channel_ops {
85a9ca7f	218	struct channel (channel_create)(const char *name,
a90917c3	219	struct lttng_channel *lttng_chan,
85a9ca7f MD	220	void *buf_addr,
	221	size_t subbuf_size, size_t num_subbuf,
	222	unsigned int switch_timer_interval,
	223	unsigned int read_timer_interval);
	224	void (channel_destroy)(struct channel chan);
	225	struct lib_ring_buffer (buffer_read_open)(struct channel *chan);
f71ecafa	226	int (buffer_has_read_closed_stream)(struct channel chan);
85a9ca7f	227	void (buffer_read_close)(struct lib_ring_buffer buf);
4e1f08f4	228	int (event_reserve)(struct lib_ring_buffer_ctx ctx,
64c796d8	229	uint32_t event_id);
85a9ca7f MD	230	void (event_commit)(struct lib_ring_buffer_ctx ctx);
	231	void (event_write)(struct lib_ring_buffer_ctx ctx, const void *src,
	232	size_t len);
4ea00e4f JD	233	void (event_write_from_user)(struct lib_ring_buffer_ctx ctx,
4ea00e4f JD	234	const void *src, size_t len);
58aa5d24 MD	235	void (event_memset)(struct lib_ring_buffer_ctx ctx,
58aa5d24 MD	236	int c, size_t len);
1ec3f75a MD	237	/*
	238	* packet_avail_size returns the available size in the current
	239	* packet. Note that the size returned is only a hint, since it
	240	* may change due to concurrent writes.
	241	*/
	242	size_t (packet_avail_size)(struct channel chan);
71c1d843	243	wait_queue_head_t (get_writer_buf_wait_queue)(struct channel *chan, int cpu);
24cedcfe MD	244	wait_queue_head_t (get_hp_wait_queue)(struct channel *chan);
24cedcfe MD	245	int (is_finalized)(struct channel chan);
254ec7bc	246	int (is_disabled)(struct channel chan);
85a9ca7f MD	247	};
85a9ca7f MD	248
a90917c3	249	struct lttng_transport {
a33c9927 MD	250	char *name;
	251	struct module *owner;
	252	struct list_head node;
a90917c3	253	struct lttng_channel_ops ops;
a33c9927 MD	254	};
a33c9927 MD	255
a90917c3	256	struct lttng_channel {
c099397a	257	unsigned int id;
85a9ca7f	258	struct channel chan; / Channel buffers */
e64957da	259	int enabled;
f1676205	260	struct lttng_ctx *ctx;
85a9ca7f	261	/* Event ID management */
a90917c3	262	struct lttng_session *session;
85a9ca7f MD	263	struct file file; / File associated to channel */
	264	unsigned int free_event_id; /* Next event ID to allocate */
	265	struct list_head list; /* Channel list */
a90917c3 MD	266	struct lttng_channel_ops *ops;
	267	struct lttng_transport *transport;
	268	struct lttng_event *sc_table; / for syscall tracing */
	269	struct lttng_event **compat_sc_table;
	270	struct lttng_event sc_unknown; / for unknown syscalls */
	271	struct lttng_event *sc_compat_unknown;
	272	struct lttng_event sc_exit; / for syscall exit */
9115fbdc	273	int header_type; /* 0: unset, 1: compact, 2: large */
d83004aa	274	enum channel_type channel_type;
9cccf98a	275	unsigned int metadata_dumped:1;
85a9ca7f MD	276	};
85a9ca7f MD	277
d83004aa JD	278	struct lttng_metadata_stream {
	279	void priv; / Ring buffer private data */
	280	struct lttng_metadata_cache *metadata_cache;
f613e3e6 MD	281	unsigned int metadata_in; /* Bytes read from the cache */
f613e3e6 MD	282	unsigned int metadata_out; /* Bytes consumed from stream */
d83004aa JD	283	int finalized; /* Has channel been finalized */
	284	wait_queue_head_t read_wait; /* Reader buffer-level wait queue */
	285	struct list_head list; /* Stream list */
	286	};
	287
a90917c3	288	struct lttng_session {
85a9ca7f	289	int active; /* Is trace session active ? */
8070f5c0	290	int been_active; /* Has trace session been active ? */
85a9ca7f MD	291	struct file file; / File associated to session */
	292	struct list_head chan; /* Channel list head */
	293	struct list_head events; /* Event list head */
	294	struct list_head list; /* Session list */
c099397a	295	unsigned int free_chan_id; /* Next chan ID to allocate */
d793d5e1	296	uuid_le uuid; /* Trace session unique ID */
d83004aa	297	struct lttng_metadata_cache *metadata_cache;
9cccf98a	298	unsigned int metadata_dumped:1;
85a9ca7f MD	299	};
85a9ca7f MD	300
d83004aa JD	301	struct lttng_metadata_cache {
	302	char data; / Metadata cache */
	303	unsigned int cache_alloc; /* Metadata allocated size (bytes) */
	304	unsigned int metadata_written; /* Number of bytes written in metadata cache */
	305	struct kref refcount; /* Metadata cache usage */
	306	struct list_head metadata_stream; /* Metadata stream list */
	307	};
	308
a90917c3 MD	309	struct lttng_session *lttng_session_create(void);
	310	int lttng_session_enable(struct lttng_session *session);
	311	int lttng_session_disable(struct lttng_session *session);
	312	void lttng_session_destroy(struct lttng_session *session);
d83004aa	313	void metadata_cache_destroy(struct kref *kref);
4e3c1b9b	314
a90917c3	315	struct lttng_channel lttng_channel_create(struct lttng_session session,
5dbbdb43 MD	316	const char *transport_name,
	317	void *buf_addr,
	318	size_t subbuf_size, size_t num_subbuf,
	319	unsigned int switch_timer_interval,
d83004aa JD	320	unsigned int read_timer_interval,
d83004aa JD	321	enum channel_type channel_type);
a90917c3	322	struct lttng_channel lttng_global_channel_create(struct lttng_session session,
4e3c1b9b MD	323	int overwrite, void *buf_addr,
	324	size_t subbuf_size, size_t num_subbuf,
	325	unsigned int switch_timer_interval,
	326	unsigned int read_timer_interval);
4e3c1b9b	327
d83004aa	328	void lttng_metadata_channel_destroy(struct lttng_channel *chan);
a90917c3	329	struct lttng_event lttng_event_create(struct lttng_channel chan,
d6d808f3	330	struct lttng_kernel_event *event_param,
259b6cb3 MD	331	void *filter,
259b6cb3 MD	332	const struct lttng_event_desc *internal_desc);
6dccd6c1 JD	333	struct lttng_event lttng_event_compat_old_create(struct lttng_channel chan,
	334	struct lttng_kernel_old_event *old_event_param,
	335	void *filter,
	336	const struct lttng_event_desc *internal_desc);
c0e31d2e	337
a90917c3 MD	338	int lttng_channel_enable(struct lttng_channel *channel);
	339	int lttng_channel_disable(struct lttng_channel *channel);
	340	int lttng_event_enable(struct lttng_event *event);
	341	int lttng_event_disable(struct lttng_event *event);
e64957da	342
a90917c3 MD	343	void lttng_transport_register(struct lttng_transport *transport);
a90917c3 MD	344	void lttng_transport_unregister(struct lttng_transport *transport);
11b5a3c2	345
360f38ea	346	void synchronize_trace(void);
80996790	347	int lttng_abi_init(void);
6dccd6c1	348	int lttng_abi_compat_old_init(void);
80996790	349	void lttng_abi_exit(void);
6dccd6c1	350	void lttng_abi_compat_old_exit(void);
1c25284c	351
a90917c3 MD	352	int lttng_probe_register(struct lttng_probe_desc *desc);
	353	void lttng_probe_unregister(struct lttng_probe_desc *desc);
	354	const struct lttng_event_desc lttng_event_get(const char name);
	355	void lttng_event_put(const struct lttng_event_desc *desc);
	356	int lttng_probes_init(void);
	357	void lttng_probes_exit(void);
1ec65de1	358
d83004aa JD	359	int lttng_metadata_output_channel(struct lttng_channel *chan,
	360	struct lttng_metadata_stream *stream);
	361
3a523f5b	362	#if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
a90917c3 MD	363	int lttng_syscalls_register(struct lttng_channel chan, void filter);
a90917c3 MD	364	int lttng_syscalls_unregister(struct lttng_channel *chan);
1ec65de1	365	#else
a90917c3	366	static inline int lttng_syscalls_register(struct lttng_channel chan, void filter)
1ec65de1 MD	367	{
	368	return -ENOSYS;
	369	}
	370
a90917c3	371	static inline int lttng_syscalls_unregister(struct lttng_channel *chan)
1ec65de1 MD	372	{
	373	return 0;
	374	}
	375	#endif
	376
2dccf128	377	struct lttng_ctx_field lttng_append_context(struct lttng_ctx *ctx);
44252f0f	378	int lttng_find_context(struct lttng_ctx ctx, const char name);
8289661d MD	379	void lttng_remove_context_field(struct lttng_ctx **ctx,
8289661d MD	380	struct lttng_ctx_field *field);
2dccf128	381	void lttng_destroy_context(struct lttng_ctx *ctx);
8070f5c0	382	int lttng_add_pid_to_ctx(struct lttng_ctx **ctx);
a2563e83	383	int lttng_add_procname_to_ctx(struct lttng_ctx **ctx);
a8ad3613	384	int lttng_add_prio_to_ctx(struct lttng_ctx **ctx);
53f1f0ca	385	int lttng_add_nice_to_ctx(struct lttng_ctx **ctx);
b64bc438 MD	386	int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx);
	387	int lttng_add_tid_to_ctx(struct lttng_ctx **ctx);
	388	int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx);
	389	int lttng_add_ppid_to_ctx(struct lttng_ctx **ctx);
	390	int lttng_add_vppid_to_ctx(struct lttng_ctx **ctx);
975da2c0	391	int lttng_add_hostname_to_ctx(struct lttng_ctx **ctx);
41c3c24e	392	#if defined(CONFIG_PERF_EVENTS) && (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,33))
c24a0d71 MD	393	int lttng_add_perf_counter_to_ctx(uint32_t type,
	394	uint64_t config,
	395	const char *name,
	396	struct lttng_ctx **ctx);
1d443b34 MD	397	#else
	398	static inline
	399	int lttng_add_perf_counter_to_ctx(uint32_t type,
	400	uint64_t config,
	401	const char *name,
	402	struct lttng_ctx **ctx)
	403	{
	404	return -ENOSYS;
	405	}
	406	#endif
02119ee5	407
c337ddc2 MD	408	extern int lttng_statedump_start(struct lttng_session *session);
c337ddc2 MD	409
acd614cc	410	#ifdef CONFIG_KPROBES
f17701fb MD	411	int lttng_kprobes_register(const char *name,
	412	const char *symbol_name,
	413	uint64_t offset,
	414	uint64_t addr,
a90917c3 MD	415	struct lttng_event *event);
	416	void lttng_kprobes_unregister(struct lttng_event *event);
	417	void lttng_kprobes_destroy_private(struct lttng_event *event);
acd614cc MD	418	#else
	419	static inline
	420	int lttng_kprobes_register(const char *name,
	421	const char *symbol_name,
	422	uint64_t offset,
	423	uint64_t addr,
a90917c3	424	struct lttng_event *event)
acd614cc MD	425	{
	426	return -ENOSYS;
	427	}
	428
25f53c39	429	static inline
a90917c3	430	void lttng_kprobes_unregister(struct lttng_event *event)
acd614cc MD	431	{
acd614cc MD	432	}
edeb3137 MD	433
edeb3137 MD	434	static inline
a90917c3	435	void lttng_kprobes_destroy_private(struct lttng_event *event)
edeb3137 MD	436	{
edeb3137 MD	437	}
acd614cc	438	#endif
d6d808f3	439
7371f44c MD	440	#ifdef CONFIG_KRETPROBES
	441	int lttng_kretprobes_register(const char *name,
	442	const char *symbol_name,
	443	uint64_t offset,
	444	uint64_t addr,
a90917c3 MD	445	struct lttng_event *event_entry,
	446	struct lttng_event *event_exit);
	447	void lttng_kretprobes_unregister(struct lttng_event *event);
	448	void lttng_kretprobes_destroy_private(struct lttng_event *event);
7371f44c MD	449	#else
	450	static inline
	451	int lttng_kretprobes_register(const char *name,
	452	const char *symbol_name,
	453	uint64_t offset,
	454	uint64_t addr,
a90917c3 MD	455	struct lttng_event *event_entry,
a90917c3 MD	456	struct lttng_event *event_exit)
7371f44c MD	457	{
	458	return -ENOSYS;
	459	}
	460
	461	static inline
a90917c3	462	void lttng_kretprobes_unregister(struct lttng_event *event)
7371f44c MD	463	{
	464	}
	465
	466	static inline
a90917c3	467	void lttng_kretprobes_destroy_private(struct lttng_event *event)
7371f44c MD	468	{
	469	}
	470	#endif
	471
e0a7a7c4 MD	472	#ifdef CONFIG_DYNAMIC_FTRACE
	473	int lttng_ftrace_register(const char *name,
	474	const char *symbol_name,
a90917c3 MD	475	struct lttng_event *event);
	476	void lttng_ftrace_unregister(struct lttng_event *event);
	477	void lttng_ftrace_destroy_private(struct lttng_event *event);
e0a7a7c4 MD	478	#else
	479	static inline
	480	int lttng_ftrace_register(const char *name,
	481	const char *symbol_name,
a90917c3	482	struct lttng_event *event)
e0a7a7c4	483	{
acd614cc	484	return -ENOSYS;
e0a7a7c4 MD	485	}
	486
	487	static inline
a90917c3	488	void lttng_ftrace_unregister(struct lttng_event *event)
e0a7a7c4 MD	489	{
e0a7a7c4 MD	490	}
edeb3137 MD	491
edeb3137 MD	492	static inline
a90917c3	493	void lttng_ftrace_destroy_private(struct lttng_event *event)
edeb3137 MD	494	{
edeb3137 MD	495	}
e0a7a7c4	496	#endif
271b6681	497
3db41b2c	498	int lttng_calibrate(struct lttng_kernel_calibrate *calibrate);
57105fc2	499
271b6681 MD	500	extern const struct file_operations lttng_tracepoint_list_fops;
271b6681 MD	501
ef200626 MD	502	#if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,35))
	503	#define TRACEPOINT_HAS_DATA_ARG
	504	#endif
	505
a90917c3	506	#endif /* _LTTNG_EVENTS_H */