[lttng-ust.git] / include / lttng / ust-events.h

#ifndef _LTTNG_UST_EVENTS_H
#define _LTTNG_UST_EVENTS_H

/*
 * lttng/ust-events.h
 *
 * Copyright 2010 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * Holds LTTng per-session event registry.
 *
 * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
 * OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.
 *
 * Permission is hereby granted to use or copy this program
 * for any purpose,  provided the above notices are retained on all copies.
 * Permission to modify the code and to distribute modified code is granted,
 * provided the above notices are retained, and a notice that the code was
 * modified is included with the above copyright notice.
 */

#include <urcu/list.h>
#include <uuid/uuid.h>
#include <stdint.h>
#include <lttng/ust-abi.h>
#include <lttng/ust-tracer.h>
#include <endian.h>
#include <float.h>

struct ltt_channel;
struct ltt_session;
struct lttng_ust_lib_ring_buffer_ctx;

/*
 * LTTng client type enumeration. Used by the consumer to map the
 * callbacks from its own address space.
 */
enum lttng_client_types {
	LTTNG_CLIENT_METADATA = 0,
	LTTNG_CLIENT_DISCARD = 1,
	LTTNG_CLIENT_OVERWRITE = 2,
	LTTNG_NR_CLIENT_TYPES,
};

/* 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,
	atype_float,
	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;
	unsigned int reverse_byte_order:1;
	unsigned int base;		/* 2, 8, 10, 16, for pretty print */
	enum lttng_string_encodings encoding;
};

/*
 * Only float and double are supported. long double is not supported at
 * the moment.
 */
#define _float_mant_dig(_type)						\
	(sizeof(_type) == sizeof(float) ? FLT_MANT_DIG			\
		: (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG	\
		: 0))

#define __type_float(_type)					\
	{							\
	    .atype = atype_float,				\
	    .u.basic._float =					\
		{						\
		  .exp_dig = sizeof(_type) * CHAR_BIT		\
				- _float_mant_dig(_type),	\
		  .mant_dig = _float_mant_dig(_type),		\
		  .alignment = lttng_alignof(_type) * CHAR_BIT,	\
		  .reverse_byte_order = __BYTE_ORDER != __FLOAT_WORD_ORDER, \
		},						\
	}							\

struct lttng_float_type {
	unsigned int exp_dig;		/* exponent digits, in bits */
	unsigned int mant_dig;		/* mantissa digits, in bits */
	unsigned short alignment;	/* in bits */
	unsigned int reverse_byte_order:1;
};

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

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 lttng_ust_lib_ring_buffer_ctx *ctx,
		       struct ltt_channel *chan);
	union {
	} 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 tracepoint_loglevel_entry  {
	const char *identifier;
	long value;
};

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;
	const struct tracepoint_loglevel_entry **loglevel;
};

struct lttng_probe_desc {
	const char *provider;
	const struct lttng_event_desc **event_desc;
	unsigned int nr_events;
	const struct tracepoint_loglevel_entry **loglevels;
	unsigned int nr_loglevels;
	struct cds_list_head head;		/* chain registered probes */
};

struct tp_loglevel_iter {
	struct lttng_probe_desc *desc;
	const struct tracepoint_loglevel_entry *loglevel;
};

struct ust_pending_probe;

/*
 * 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_ust_instrumentation instrumentation;
	union {
	} u;
	struct cds_list_head list;		/* Event list */
	struct ust_pending_probe *pending_probe;
	unsigned int metadata_dumped:1;
};

struct channel;
struct lttng_ust_shm_handle;

struct ltt_channel_ops {
	struct ltt_channel *(*channel_create)(const char *name,
				void *buf_addr,
				size_t subbuf_size, size_t num_subbuf,
				unsigned int switch_timer_interval,
				unsigned int read_timer_interval,
				int *shm_fd, int *wait_fd,
				uint64_t *memory_map_size,
				struct ltt_channel *chan_priv_init);
	void (*channel_destroy)(struct ltt_channel *ltt_chan);
	struct lttng_ust_lib_ring_buffer *(*buffer_read_open)(struct channel *chan,
				struct lttng_ust_shm_handle *handle,
				int *shm_fd, int *wait_fd,
				uint64_t *memory_map_size);
	void (*buffer_read_close)(struct lttng_ust_lib_ring_buffer *buf,
				struct lttng_ust_shm_handle *handle);
	int (*event_reserve)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
			     uint32_t event_id);
	void (*event_commit)(struct lttng_ust_lib_ring_buffer_ctx *ctx);
	void (*event_write)(struct lttng_ust_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,
				    struct lttng_ust_shm_handle *handle);
	//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);
	int (*flush_buffer)(struct channel *chan, struct lttng_ust_shm_handle *handle);
};

struct ltt_channel {
	/*
	 * The pointers located in this private data are NOT safe to be
	 * dereferenced by the consumer. The only operations the
	 * consumer process is designed to be allowed to do is to read
	 * and perform subbuffer flush.
	 */
	struct channel *chan;		/* Channel buffers */
	int enabled;
	struct lttng_ctx *ctx;
	/* Event ID management */
	struct ltt_session *session;
	int objd;			/* Object associated to channel */
	unsigned int free_event_id;	/* Next event ID to allocate */
	unsigned int used_event_id;	/* Max allocated event IDs */
	struct cds_list_head list;	/* Channel list */
	struct ltt_channel_ops *ops;
	int header_type;		/* 0: unset, 1: compact, 2: large */
	struct lttng_ust_shm_handle *handle;	/* shared-memory handle */
	unsigned int metadata_dumped:1;

	/* Channel ID, available for consumer too */
	unsigned int id;
	/* Copy of session UUID for consumer (availability through shm) */
	uuid_t uuid;			/* Trace session unique ID */
};

struct ltt_session {
	int active;			/* Is trace session active ? */
	int been_active;		/* Has trace session been active ? */
	int objd;			/* Object associated to session */
	struct ltt_channel *metadata;	/* Metadata channel */
	struct cds_list_head chan;	/* Channel list head */
	struct cds_list_head events;	/* Event list head */
	struct cds_list_head list;	/* Session list */
	unsigned int free_chan_id;	/* Next chan ID to allocate */
	uuid_t uuid;			/* Trace session unique ID */
	unsigned int metadata_dumped:1;
};

struct ltt_transport {
	char *name;
	struct cds_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,
				       int *shm_fd, int *wait_fd,
				       uint64_t *memory_map_size,
				       struct ltt_channel *chan_priv_init);
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,
				       int *shm_fd, int *wait_fd,
				       uint64_t *memory_map_size);

int ltt_event_create(struct ltt_channel *chan,
		struct lttng_ust_event *event_param,
		void *filter,
		struct ltt_event **event);

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_probe_register(struct lttng_probe_desc *desc);
void ltt_probe_unregister(struct lttng_probe_desc *desc);
int pending_probe_fix_events(const struct lttng_event_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);
int lttng_find_context(struct lttng_ctx *ctx, const char *name);
struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx_p);
void lttng_remove_context_field(struct lttng_ctx **ctx_p,
				struct lttng_ctx_field *field);
void lttng_destroy_context(struct lttng_ctx *ctx);
int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx);
int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx);
int lttng_add_pthread_id_to_ctx(struct lttng_ctx **ctx);
int lttng_add_procname_to_ctx(struct lttng_ctx **ctx);
void lttng_context_vtid_reset(void);
void lttng_context_vpid_reset(void);

const struct lttng_ust_lib_ring_buffer_client_cb *lttng_client_callbacks_metadata;
const struct lttng_ust_lib_ring_buffer_client_cb *lttng_client_callbacks_discard;
const struct lttng_ust_lib_ring_buffer_client_cb *lttng_client_callbacks_overwrite;

struct ltt_transport *ltt_transport_find(const char *name);

#endif /* _LTTNG_UST_EVENTS_H */
Commit	Line	Data
51489cad MD	1	#ifndef _LTTNG_UST_EVENTS_H
51489cad MD	2	#define _LTTNG_UST_EVENTS_H
8020ceb5 MD	3
8020ceb5 MD	4	/*
51489cad	5	* lttng/ust-events.h
8020ceb5 MD	6	*
	7	* Copyright 2010 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	8	*
	9	* Holds LTTng per-session event registry.
	10	*
a60d70e6 MD	11	* THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
	12	* OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
	13	*
	14	* Permission is hereby granted to use or copy this program
	15	* for any purpose, provided the above notices are retained on all copies.
	16	* Permission to modify the code and to distribute modified code is granted,
	17	* provided the above notices are retained, and a notice that the code was
	18	* modified is included with the above copyright notice.
8020ceb5 MD	19	*/
8020ceb5 MD	20
9f3fdbc6 MD	21	#include <urcu/list.h>
	22	#include <uuid/uuid.h>
	23	#include <stdint.h>
4318ae1b MD	24	#include <lttng/ust-abi.h>
4318ae1b MD	25	#include <lttng/ust-tracer.h>
20f1eee7 MD	26	#include <endian.h>
20f1eee7 MD	27	#include <float.h>
8020ceb5	28
8020ceb5 MD	29	struct ltt_channel;
8020ceb5 MD	30	struct ltt_session;
4cfec15c	31	struct lttng_ust_lib_ring_buffer_ctx;
8020ceb5	32
c1fca457 MD	33	/*
	34	* LTTng client type enumeration. Used by the consumer to map the
	35	* callbacks from its own address space.
	36	*/
	37	enum lttng_client_types {
	38	LTTNG_CLIENT_METADATA = 0,
	39	LTTNG_CLIENT_DISCARD = 1,
	40	LTTNG_CLIENT_OVERWRITE = 2,
	41	LTTNG_NR_CLIENT_TYPES,
	42	};
	43
8020ceb5 MD	44	/* Type description */
	45
	46	/* Update the astract_types name table in lttng-types.c along with this enum */
	47	enum abstract_types {
	48	atype_integer,
	49	atype_enum,
	50	atype_array,
	51	atype_sequence,
	52	atype_string,
20f1eee7	53	atype_float,
8020ceb5 MD	54	NR_ABSTRACT_TYPES,
	55	};
	56
	57	/* Update the string_encodings name table in lttng-types.c along with this enum */
	58	enum lttng_string_encodings {
	59	lttng_encode_none = 0,
	60	lttng_encode_UTF8 = 1,
	61	lttng_encode_ASCII = 2,
	62	NR_STRING_ENCODINGS,
	63	};
	64
	65	struct lttng_enum_entry {
	66	unsigned long long start, end; /* start and end are inclusive */
	67	const char *string;
	68	};
	69
	70	#define __type_integer(_type, _byte_order, _base, _encoding) \
	71	{ \
	72	.atype = atype_integer, \
	73	.u.basic.integer = \
	74	{ \
	75	.size = sizeof(_type) * CHAR_BIT, \
1dbfff0c MD	76	.alignment = lttng_alignof(_type) * CHAR_BIT, \
1dbfff0c MD	77	.signedness = lttng_is_signed_type(_type), \
8020ceb5 MD	78	.reverse_byte_order = _byte_order != __BYTE_ORDER, \
	79	.base = _base, \
	80	.encoding = lttng_encode_##_encoding, \
	81	}, \
	82	} \
	83
	84	struct lttng_integer_type {
	85	unsigned int size; /* in bits */
	86	unsigned short alignment; /* in bits */
	87	unsigned int signedness:1;
	88	unsigned int reverse_byte_order:1;
	89	unsigned int base; /* 2, 8, 10, 16, for pretty print */
	90	enum lttng_string_encodings encoding;
	91	};
	92
d3ed854b MD	93	/*
	94	* Only float and double are supported. long double is not supported at
	95	* the moment.
	96	*/
20f1eee7 MD	97	#define _float_mant_dig(_type) \
	98	(sizeof(_type) == sizeof(float) ? FLT_MANT_DIG \
	99	: (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG \
d3ed854b	100	: 0))
20f1eee7 MD	101
	102	#define __type_float(_type) \
	103	{ \
	104	.atype = atype_float, \
	105	.u.basic._float = \
	106	{ \
	107	.exp_dig = sizeof(_type) * CHAR_BIT \
	108	- _float_mant_dig(_type), \
	109	.mant_dig = _float_mant_dig(_type), \
1dbfff0c	110	.alignment = lttng_alignof(_type) * CHAR_BIT, \
20f1eee7 MD	111	.reverse_byte_order = __BYTE_ORDER != __FLOAT_WORD_ORDER, \
	112	}, \
	113	} \
	114
	115	struct lttng_float_type {
	116	unsigned int exp_dig; /* exponent digits, in bits */
	117	unsigned int mant_dig; /* mantissa digits, in bits */
	118	unsigned short alignment; /* in bits */
	119	unsigned int reverse_byte_order:1;
	120	};
	121
8020ceb5 MD	122	union _lttng_basic_type {
	123	struct lttng_integer_type integer;
	124	struct {
	125	const char *name;
	126	} enumeration;
	127	struct {
	128	enum lttng_string_encodings encoding;
	129	} string;
20f1eee7	130	struct lttng_float_type _float;
8020ceb5 MD	131	};
	132
	133	struct lttng_basic_type {
	134	enum abstract_types atype;
	135	union {
	136	union _lttng_basic_type basic;
	137	} u;
	138	};
	139
	140	struct lttng_type {
	141	enum abstract_types atype;
	142	union {
	143	union _lttng_basic_type basic;
	144	struct {
	145	struct lttng_basic_type elem_type;
	146	unsigned int length; /* num. elems. */
	147	} array;
	148	struct {
	149	struct lttng_basic_type length_type;
	150	struct lttng_basic_type elem_type;
	151	} sequence;
	152	} u;
	153	};
	154
	155	struct lttng_enum {
	156	const char *name;
	157	struct lttng_type container_type;
	158	const struct lttng_enum_entry *entries;
23c8854a	159	unsigned int len;
8020ceb5 MD	160	};
	161
	162	/* Event field description */
	163
	164	struct lttng_event_field {
	165	const char *name;
	166	struct lttng_type type;
	167	};
	168
	169	struct lttng_ctx_field {
	170	struct lttng_event_field event_field;
	171	size_t (*get_size)(size_t offset);
	172	void (record)(struct lttng_ctx_field field,
4cfec15c	173	struct lttng_ust_lib_ring_buffer_ctx *ctx,
8020ceb5 MD	174	struct ltt_channel *chan);
8020ceb5 MD	175	union {
8020ceb5 MD	176	} u;
	177	void (destroy)(struct lttng_ctx_field field);
	178	};
	179
	180	struct lttng_ctx {
	181	struct lttng_ctx_field *fields;
	182	unsigned int nr_fields;
	183	unsigned int allocated_fields;
	184	};
	185
df854e41 MD	186	struct tracepoint_loglevel_entry {
	187	const char *identifier;
	188	long value;
	189	};
	190
8020ceb5 MD	191	struct lttng_event_desc {
	192	const char *name;
	193	void *probe_callback;
	194	const struct lttng_event_ctx ctx; / context */
	195	const struct lttng_event_field fields; / event payload */
	196	unsigned int nr_fields;
df854e41	197	const struct tracepoint_loglevel_entry **loglevel;
8020ceb5 MD	198	};
	199
	200	struct lttng_probe_desc {
df854e41 MD	201	const char *provider;
df854e41 MD	202	const struct lttng_event_desc **event_desc;
8020ceb5	203	unsigned int nr_events;
df854e41 MD	204	const struct tracepoint_loglevel_entry **loglevels;
df854e41 MD	205	unsigned int nr_loglevels;
9f3fdbc6	206	struct cds_list_head head; /* chain registered probes */
df854e41 MD	207	};
	208
	209	struct tp_loglevel_iter {
	210	struct lttng_probe_desc *desc;
	211	const struct tracepoint_loglevel_entry *loglevel;
8020ceb5 MD	212	};
8020ceb5 MD	213
8165c8da MD	214	struct ust_pending_probe;
8165c8da MD	215
8020ceb5 MD	216	/*
	217	* ltt_event structure is referred to by the tracing fast path. It must be
	218	* kept small.
	219	*/
	220	struct ltt_event {
	221	unsigned int id;
	222	struct ltt_channel *chan;
976fe9ea	223	int enabled;
8020ceb5 MD	224	const struct lttng_event_desc *desc;
	225	void *filter;
	226	struct lttng_ctx *ctx;
9f3fdbc6	227	enum lttng_ust_instrumentation instrumentation;
8020ceb5	228	union {
8020ceb5	229	} u;
9f3fdbc6	230	struct cds_list_head list; /* Event list */
8165c8da	231	struct ust_pending_probe *pending_probe;
7c2caf2b	232	unsigned int metadata_dumped:1;
8020ceb5 MD	233	};
8020ceb5 MD	234
8d8a24c8	235	struct channel;
38fae1d3	236	struct lttng_ust_shm_handle;
8d8a24c8	237
8020ceb5	238	struct ltt_channel_ops {
1d498196	239	struct ltt_channel (channel_create)(const char *name,
8020ceb5 MD	240	void *buf_addr,
	241	size_t subbuf_size, size_t num_subbuf,
	242	unsigned int switch_timer_interval,
193183fb MD	243	unsigned int read_timer_interval,
193183fb MD	244	int shm_fd, int wait_fd,
d028eddb MD	245	uint64_t *memory_map_size,
d028eddb MD	246	struct ltt_channel *chan_priv_init);
1d498196	247	void (channel_destroy)(struct ltt_channel ltt_chan);
4cfec15c	248	struct lttng_ust_lib_ring_buffer (buffer_read_open)(struct channel *chan,
38fae1d3	249	struct lttng_ust_shm_handle *handle,
381c0f1e MD	250	int shm_fd, int wait_fd,
381c0f1e MD	251	uint64_t *memory_map_size);
4cfec15c	252	void (buffer_read_close)(struct lttng_ust_lib_ring_buffer buf,
38fae1d3	253	struct lttng_ust_shm_handle *handle);
4cfec15c	254	int (event_reserve)(struct lttng_ust_lib_ring_buffer_ctx ctx,
8020ceb5	255	uint32_t event_id);
4cfec15c MD	256	void (event_commit)(struct lttng_ust_lib_ring_buffer_ctx ctx);
4cfec15c MD	257	void (event_write)(struct lttng_ust_lib_ring_buffer_ctx ctx, const void *src,
8020ceb5 MD	258	size_t len);
	259	/*
	260	* packet_avail_size returns the available size in the current
	261	* packet. Note that the size returned is only a hint, since it
	262	* may change due to concurrent writes.
	263	*/
1d498196	264	size_t (packet_avail_size)(struct channel chan,
38fae1d3	265	struct lttng_ust_shm_handle *handle);
9f3fdbc6 MD	266	//wait_queue_head_t (get_reader_wait_queue)(struct channel *chan);
9f3fdbc6 MD	267	//wait_queue_head_t (get_hp_wait_queue)(struct channel *chan);
8020ceb5 MD	268	int (is_finalized)(struct channel chan);
8020ceb5 MD	269	int (is_disabled)(struct channel chan);
38fae1d3	270	int (flush_buffer)(struct channel chan, struct lttng_ust_shm_handle *handle);
8020ceb5 MD	271	};
	272
	273	struct ltt_channel {
a3f61e7f MD	274	/*
	275	* The pointers located in this private data are NOT safe to be
	276	* dereferenced by the consumer. The only operations the
	277	* consumer process is designed to be allowed to do is to read
	278	* and perform subbuffer flush.
	279	*/
8020ceb5	280	struct channel chan; / Channel buffers */
976fe9ea	281	int enabled;
8020ceb5 MD	282	struct lttng_ctx *ctx;
	283	/* Event ID management */
	284	struct ltt_session *session;
0a42beb6	285	int objd; /* Object associated to channel */
8020ceb5	286	unsigned int free_event_id; /* Next event ID to allocate */
8165c8da	287	unsigned int used_event_id; /* Max allocated event IDs */
9f3fdbc6	288	struct cds_list_head list; /* Channel list */
8020ceb5 MD	289	struct ltt_channel_ops *ops;
8020ceb5 MD	290	int header_type; /* 0: unset, 1: compact, 2: large */
38fae1d3	291	struct lttng_ust_shm_handle handle; / shared-memory handle */
7c2caf2b	292	unsigned int metadata_dumped:1;
a3f61e7f MD	293
	294	/* Channel ID, available for consumer too */
	295	unsigned int id;
	296	/* Copy of session UUID for consumer (availability through shm) */
	297	uuid_t uuid; /* Trace session unique ID */
8020ceb5 MD	298	};
	299
	300	struct ltt_session {
	301	int active; /* Is trace session active ? */
	302	int been_active; /* Has trace session been active ? */
0a42beb6	303	int objd; /* Object associated to session */
8020ceb5	304	struct ltt_channel metadata; / Metadata channel */
9f3fdbc6 MD	305	struct cds_list_head chan; /* Channel list head */
	306	struct cds_list_head events; /* Event list head */
	307	struct cds_list_head list; /* Session list */
8020ceb5	308	unsigned int free_chan_id; /* Next chan ID to allocate */
9f3fdbc6	309	uuid_t uuid; /* Trace session unique ID */
7c2caf2b	310	unsigned int metadata_dumped:1;
8020ceb5 MD	311	};
	312
	313	struct ltt_transport {
	314	char *name;
9f3fdbc6	315	struct cds_list_head node;
8020ceb5 MD	316	struct ltt_channel_ops ops;
	317	};
	318
	319	struct ltt_session *ltt_session_create(void);
976fe9ea MD	320	int ltt_session_enable(struct ltt_session *session);
976fe9ea MD	321	int ltt_session_disable(struct ltt_session *session);
8020ceb5 MD	322	void ltt_session_destroy(struct ltt_session *session);
	323
	324	struct ltt_channel ltt_channel_create(struct ltt_session session,
	325	const char *transport_name,
	326	void *buf_addr,
	327	size_t subbuf_size, size_t num_subbuf,
	328	unsigned int switch_timer_interval,
193183fb MD	329	unsigned int read_timer_interval,
193183fb MD	330	int shm_fd, int wait_fd,
d028eddb MD	331	uint64_t *memory_map_size,
d028eddb MD	332	struct ltt_channel *chan_priv_init);
8020ceb5 MD	333	struct ltt_channel ltt_global_channel_create(struct ltt_session session,
	334	int overwrite, void *buf_addr,
	335	size_t subbuf_size, size_t num_subbuf,
	336	unsigned int switch_timer_interval,
193183fb MD	337	unsigned int read_timer_interval,
	338	int shm_fd, int wait_fd,
	339	uint64_t *memory_map_size);
8020ceb5	340
576599a0 MD	341	int ltt_event_create(struct ltt_channel *chan,
	342	struct lttng_ust_event *event_param,
	343	void *filter,
	344	struct ltt_event **event);
8020ceb5	345
976fe9ea MD	346	int ltt_channel_enable(struct ltt_channel *channel);
	347	int ltt_channel_disable(struct ltt_channel *channel);
	348	int ltt_event_enable(struct ltt_event *event);
	349	int ltt_event_disable(struct ltt_event *event);
	350
8020ceb5 MD	351	void ltt_transport_register(struct ltt_transport *transport);
	352	void ltt_transport_unregister(struct ltt_transport *transport);
	353
4b4de73e	354	void synchronize_trace(void);
8020ceb5 MD	355
	356	int ltt_probe_register(struct lttng_probe_desc *desc);
	357	void ltt_probe_unregister(struct lttng_probe_desc *desc);
8165c8da	358	int pending_probe_fix_events(const struct lttng_event_desc *desc);
8020ceb5 MD	359	const struct lttng_event_desc ltt_event_get(const char name);
	360	void ltt_event_put(const struct lttng_event_desc *desc);
	361	int ltt_probes_init(void);
	362	void ltt_probes_exit(void);
8173ec7c MD	363	int lttng_find_context(struct lttng_ctx ctx, const char name);
	364	struct lttng_ctx_field lttng_append_context(struct lttng_ctx *ctx_p);
	365	void lttng_remove_context_field(struct lttng_ctx **ctx_p,
8020ceb5 MD	366	struct lttng_ctx_field *field);
8020ceb5 MD	367	void lttng_destroy_context(struct lttng_ctx *ctx);
3b402b40	368	int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx);
c1ef86f0	369	int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx);
8173ec7c	370	int lttng_add_pthread_id_to_ctx(struct lttng_ctx **ctx);
4847e9bb	371	int lttng_add_procname_to_ctx(struct lttng_ctx **ctx);
a93bfc45	372	void lttng_context_vtid_reset(void);
c1ef86f0	373	void lttng_context_vpid_reset(void);
9f3fdbc6	374
7a784989 MD	375	const struct lttng_ust_lib_ring_buffer_client_cb *lttng_client_callbacks_metadata;
	376	const struct lttng_ust_lib_ring_buffer_client_cb *lttng_client_callbacks_discard;
	377	const struct lttng_ust_lib_ring_buffer_client_cb *lttng_client_callbacks_overwrite;
c1fca457	378
c1fca457 MD	379	struct ltt_transport ltt_transport_find(const char name);
c1fca457 MD	380
51489cad	381	#endif /* _LTTNG_UST_EVENTS_H */