[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 "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 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 = 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 */
	unsigned int metadata_dumped:1;
};

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 lttng_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 */
	unsigned int metadata_dumped:1;
};

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);

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);
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);

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);

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