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

#ifndef _LTTNG_UST_EVENTS_H
#define _LTTNG_UST_EVENTS_H

/*
 * lttng/ust-events.h
 *
 * Copyright 2010-2012 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * Holds LTTng per-session event registry.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 */

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

#define LTTNG_UST_UUID_LEN		16

struct ltt_channel;
struct ltt_session;
struct lttng_ust_lib_ring_buffer_ctx;

/*
 * Data structures used by tracepoint event declarations, and by the
 * tracer. Those structures have padding for future extension.
 */

/*
 * 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,
};

#define LTTNG_UST_ENUM_ENTRY_PADDING	16
struct lttng_enum_entry {
	unsigned long long start, end;	/* start and end are inclusive */
	const char *string;
	char padding[LTTNG_UST_ENUM_ENTRY_PADDING];
};

#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,		\
		},						\
	}							\

#define LTTNG_UST_INTEGER_TYPE_PADDING	24
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;
	char padding[LTTNG_UST_INTEGER_TYPE_PADDING];
};

/*
 * 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, \
		},						\
	}							\

#define LTTNG_UST_FLOAT_TYPE_PADDING	24
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;
	char padding[LTTNG_UST_FLOAT_TYPE_PADDING];
};

#define LTTNG_UST_BASIC_TYPE_PADDING	128
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;
	char padding[LTTNG_UST_BASIC_TYPE_PADDING];
};

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

#define LTTNG_UST_TYPE_PADDING	128
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;
		char padding[LTTNG_UST_TYPE_PADDING];
	} u;
};

#define LTTNG_UST_ENUM_TYPE_PADDING	24
struct lttng_enum {
	const char *name;
	struct lttng_type container_type;
	const struct lttng_enum_entry *entries;
	unsigned int len;
	char padding[LTTNG_UST_ENUM_TYPE_PADDING];
};

/* Event field description */

#define LTTNG_UST_EVENT_FIELD_PADDING	32
struct lttng_event_field {
	const char *name;
	struct lttng_type type;
	char padding[LTTNG_UST_EVENT_FIELD_PADDING];
};

#define LTTNG_UST_CTX_FIELD_PADDING	40
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 {
		char padding[LTTNG_UST_CTX_FIELD_PADDING];
	} u;
	void (*destroy)(struct lttng_ctx_field *field);
};

#define LTTNG_UST_CTX_PADDING	24
struct lttng_ctx {
	struct lttng_ctx_field *fields;
	unsigned int nr_fields;
	unsigned int allocated_fields;
	char padding[LTTNG_UST_CTX_PADDING];
};

#define LTTNG_UST_EVENT_DESC_PADDING	40
struct lttng_event_desc {
	const char *name;
	void (*probe_callback)(void);
	const struct lttng_event_ctx *ctx;	/* context */
	const struct lttng_event_field *fields;	/* event payload */
	unsigned int nr_fields;
	const int **loglevel;
	const char *signature;	/* Argument types/names received */
	char padding[LTTNG_UST_EVENT_DESC_PADDING];
};

#define LTTNG_UST_PROBE_DESC_PADDING	40
struct lttng_probe_desc {
	const char *provider;
	const struct lttng_event_desc **event_desc;
	unsigned int nr_events;
	struct cds_list_head head;		/* chain registered probes */
	char padding[LTTNG_UST_PROBE_DESC_PADDING];
};

/* Data structures used by the tracer. */

/*
 * Entry describing a per-session active wildcard, along with the event
 * attribute and channel information configuring the events that need to
 * be enabled.
 */
struct session_wildcard {
	struct ltt_channel *chan;
	struct lttng_ctx *ctx;	/* TODO */
	struct lttng_ust_event event_param;
	struct cds_list_head events;	/* list of events enabled */
	struct cds_list_head list;	/* per-session list of wildcards */
	struct cds_list_head session_list; /* node of session wildcard list */
	struct wildcard_entry *entry;
	unsigned int enabled:1;
};

/*
 * Entry describing an active wildcard (per name) for all sessions.
 */
struct wildcard_entry {
	/* node of global wildcards list */
	struct cds_list_head list;
	/* head of session list to which this wildcard apply */
	struct cds_list_head session_list;
	enum lttng_ust_loglevel_type loglevel_type;
	int loglevel;
	char name[0];
};

struct tp_list_entry {
	struct lttng_ust_tracepoint_iter tp;
	struct cds_list_head head;
};

struct lttng_ust_tracepoint_list {
	struct tp_list_entry *iter;
	struct cds_list_head head;
};

struct tp_field_list_entry {
	struct lttng_ust_field_iter field;
	struct cds_list_head head;
};

struct lttng_ust_field_list {
	struct tp_field_list_entry *iter;
	struct cds_list_head head;
};

struct ust_pending_probe;
struct ltt_event;

/*
 * 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;
	int (*filter)(void *filter_data, const char *filter_stack_data);
	void *filter_data;
	struct lttng_ctx *ctx;
	enum lttng_ust_instrumentation instrumentation;
	union {
	} u;
	struct cds_list_head list;		/* Event list */
	struct cds_list_head wildcard_list;	/* Event list for wildcard */
	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) */
	unsigned char uuid[LTTNG_UST_UUID_LEN]; /* 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 wildcards;	/* Wildcard list head */
	struct cds_list_head list;	/* Session list */
	unsigned int free_chan_id;	/* Next chan ID to allocate */
	unsigned char uuid[LTTNG_UST_UUID_LEN]; /* 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,
		int (*filter)(void *filter_data,
			const char *filter_stack_data),
		void *filter_data,
		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);

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

struct ltt_transport *ltt_transport_find(const char *name);

int ltt_probes_get_event_list(struct lttng_ust_tracepoint_list *list);
void ltt_probes_prune_event_list(struct lttng_ust_tracepoint_list *list);
struct lttng_ust_tracepoint_iter *
	lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list *list);
int ltt_probes_get_field_list(struct lttng_ust_field_list *list);
void ltt_probes_prune_field_list(struct lttng_ust_field_list *list);
struct lttng_ust_field_iter *
	lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list);

int ltt_wildcard_enable(struct session_wildcard *wildcard);
int ltt_wildcard_disable(struct session_wildcard *wildcard);
int ltt_wildcard_create(struct ltt_channel *chan,
	struct lttng_ust_event *event_param,
	struct session_wildcard **sl);
int ltt_loglevel_match(const struct lttng_event_desc *desc,
		enum lttng_ust_loglevel_type req_type,
		int req_loglevel);
void ltt_probes_create_wildcard_events(struct wildcard_entry *entry,
				struct session_wildcard *wildcard);

#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	6	*
e92f3e28	7	* Copyright 2010-2012 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8020ceb5 MD	8	*
	9	* Holds LTTng per-session event registry.
	10	*
e92f3e28 MD	11	* Permission is hereby granted, free of charge, to any person obtaining a copy
	12	* of this software and associated documentation files (the "Software"), to deal
	13	* in the Software without restriction, including without limitation the rights
	14	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	15	* copies of the Software, and to permit persons to whom the Software is
	16	* furnished to do so, subject to the following conditions:
a60d70e6	17	*
e92f3e28 MD	18	* The above copyright notice and this permission notice shall be included in
e92f3e28 MD	19	* all copies or substantial portions of the Software.
8020ceb5 MD	20	*/
8020ceb5 MD	21
9f3fdbc6	22	#include <urcu/list.h>
1f18504e	23	#include <urcu/hlist.h>
9f3fdbc6	24	#include <stdint.h>
4318ae1b MD	25	#include <lttng/ust-abi.h>
4318ae1b MD	26	#include <lttng/ust-tracer.h>
2ae57758	27	#include <lttng/ust-endian.h>
20f1eee7	28	#include <float.h>
8020ceb5	29
19d8b1b3 MD	30	#define LTTNG_UST_UUID_LEN 16
19d8b1b3 MD	31
8020ceb5 MD	32	struct ltt_channel;
8020ceb5 MD	33	struct ltt_session;
4cfec15c	34	struct lttng_ust_lib_ring_buffer_ctx;
8020ceb5	35
37d5e202 MD	36	/*
	37	* Data structures used by tracepoint event declarations, and by the
	38	* tracer. Those structures have padding for future extension.
	39	*/
	40
c1fca457 MD	41	/*
	42	* LTTng client type enumeration. Used by the consumer to map the
	43	* callbacks from its own address space.
	44	*/
	45	enum lttng_client_types {
	46	LTTNG_CLIENT_METADATA = 0,
	47	LTTNG_CLIENT_DISCARD = 1,
	48	LTTNG_CLIENT_OVERWRITE = 2,
	49	LTTNG_NR_CLIENT_TYPES,
	50	};
	51
8020ceb5 MD	52	/* Type description */
	53
	54	/* Update the astract_types name table in lttng-types.c along with this enum */
	55	enum abstract_types {
	56	atype_integer,
	57	atype_enum,
	58	atype_array,
	59	atype_sequence,
	60	atype_string,
20f1eee7	61	atype_float,
8020ceb5 MD	62	NR_ABSTRACT_TYPES,
	63	};
	64
	65	/* Update the string_encodings name table in lttng-types.c along with this enum */
	66	enum lttng_string_encodings {
	67	lttng_encode_none = 0,
	68	lttng_encode_UTF8 = 1,
	69	lttng_encode_ASCII = 2,
	70	NR_STRING_ENCODINGS,
	71	};
	72
37d5e202	73	#define LTTNG_UST_ENUM_ENTRY_PADDING 16
8020ceb5 MD	74	struct lttng_enum_entry {
	75	unsigned long long start, end; /* start and end are inclusive */
	76	const char *string;
37d5e202	77	char padding[LTTNG_UST_ENUM_ENTRY_PADDING];
8020ceb5 MD	78	};
	79
	80	#define __type_integer(_type, _byte_order, _base, _encoding) \
	81	{ \
	82	.atype = atype_integer, \
	83	.u.basic.integer = \
	84	{ \
	85	.size = sizeof(_type) * CHAR_BIT, \
1dbfff0c MD	86	.alignment = lttng_alignof(_type) * CHAR_BIT, \
1dbfff0c MD	87	.signedness = lttng_is_signed_type(_type), \
8d1d746f	88	.reverse_byte_order = _byte_order != BYTE_ORDER, \
8020ceb5 MD	89	.base = _base, \
	90	.encoding = lttng_encode_##_encoding, \
	91	}, \
	92	} \
	93
37d5e202	94	#define LTTNG_UST_INTEGER_TYPE_PADDING 24
8020ceb5 MD	95	struct lttng_integer_type {
	96	unsigned int size; /* in bits */
	97	unsigned short alignment; /* in bits */
	98	unsigned int signedness:1;
	99	unsigned int reverse_byte_order:1;
	100	unsigned int base; /* 2, 8, 10, 16, for pretty print */
	101	enum lttng_string_encodings encoding;
37d5e202	102	char padding[LTTNG_UST_INTEGER_TYPE_PADDING];
8020ceb5 MD	103	};
8020ceb5 MD	104
d3ed854b MD	105	/*
	106	* Only float and double are supported. long double is not supported at
	107	* the moment.
	108	*/
20f1eee7 MD	109	#define _float_mant_dig(_type) \
	110	(sizeof(_type) == sizeof(float) ? FLT_MANT_DIG \
	111	: (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG \
d3ed854b	112	: 0))
20f1eee7 MD	113
	114	#define __type_float(_type) \
	115	{ \
	116	.atype = atype_float, \
	117	.u.basic._float = \
	118	{ \
	119	.exp_dig = sizeof(_type) * CHAR_BIT \
	120	- _float_mant_dig(_type), \
	121	.mant_dig = _float_mant_dig(_type), \
1dbfff0c	122	.alignment = lttng_alignof(_type) * CHAR_BIT, \
ad496c21	123	.reverse_byte_order = BYTE_ORDER != FLOAT_WORD_ORDER, \
20f1eee7 MD	124	}, \
	125	} \
	126
37d5e202	127	#define LTTNG_UST_FLOAT_TYPE_PADDING 24
20f1eee7 MD	128	struct lttng_float_type {
	129	unsigned int exp_dig; /* exponent digits, in bits */
	130	unsigned int mant_dig; /* mantissa digits, in bits */
	131	unsigned short alignment; /* in bits */
	132	unsigned int reverse_byte_order:1;
37d5e202	133	char padding[LTTNG_UST_FLOAT_TYPE_PADDING];
20f1eee7 MD	134	};
20f1eee7 MD	135
37d5e202	136	#define LTTNG_UST_BASIC_TYPE_PADDING 128
8020ceb5 MD	137	union _lttng_basic_type {
	138	struct lttng_integer_type integer;
	139	struct {
	140	const char *name;
	141	} enumeration;
	142	struct {
	143	enum lttng_string_encodings encoding;
	144	} string;
20f1eee7	145	struct lttng_float_type _float;
37d5e202	146	char padding[LTTNG_UST_BASIC_TYPE_PADDING];
8020ceb5 MD	147	};
	148
	149	struct lttng_basic_type {
	150	enum abstract_types atype;
	151	union {
	152	union _lttng_basic_type basic;
	153	} u;
	154	};
	155
37d5e202	156	#define LTTNG_UST_TYPE_PADDING 128
8020ceb5 MD	157	struct lttng_type {
	158	enum abstract_types atype;
	159	union {
	160	union _lttng_basic_type basic;
	161	struct {
	162	struct lttng_basic_type elem_type;
	163	unsigned int length; /* num. elems. */
	164	} array;
	165	struct {
	166	struct lttng_basic_type length_type;
	167	struct lttng_basic_type elem_type;
	168	} sequence;
37d5e202	169	char padding[LTTNG_UST_TYPE_PADDING];
8020ceb5 MD	170	} u;
	171	};
	172
37d5e202	173	#define LTTNG_UST_ENUM_TYPE_PADDING 24
8020ceb5 MD	174	struct lttng_enum {
	175	const char *name;
	176	struct lttng_type container_type;
	177	const struct lttng_enum_entry *entries;
23c8854a	178	unsigned int len;
37d5e202	179	char padding[LTTNG_UST_ENUM_TYPE_PADDING];
8020ceb5 MD	180	};
	181
	182	/* Event field description */
	183
37d5e202	184	#define LTTNG_UST_EVENT_FIELD_PADDING 32
8020ceb5 MD	185	struct lttng_event_field {
	186	const char *name;
	187	struct lttng_type type;
37d5e202	188	char padding[LTTNG_UST_EVENT_FIELD_PADDING];
8020ceb5 MD	189	};
8020ceb5 MD	190
37d5e202	191	#define LTTNG_UST_CTX_FIELD_PADDING 40
8020ceb5 MD	192	struct lttng_ctx_field {
	193	struct lttng_event_field event_field;
	194	size_t (*get_size)(size_t offset);
	195	void (record)(struct lttng_ctx_field field,
4cfec15c	196	struct lttng_ust_lib_ring_buffer_ctx *ctx,
8020ceb5 MD	197	struct ltt_channel *chan);
8020ceb5 MD	198	union {
37d5e202	199	char padding[LTTNG_UST_CTX_FIELD_PADDING];
8020ceb5 MD	200	} u;
	201	void (destroy)(struct lttng_ctx_field field);
	202	};
	203
37d5e202	204	#define LTTNG_UST_CTX_PADDING 24
8020ceb5 MD	205	struct lttng_ctx {
	206	struct lttng_ctx_field *fields;
	207	unsigned int nr_fields;
	208	unsigned int allocated_fields;
37d5e202 MD	209	char padding[LTTNG_UST_CTX_PADDING];
	210	};
	211
	212	#define LTTNG_UST_EVENT_DESC_PADDING 40
	213	struct lttng_event_desc {
	214	const char *name;
fbdeb5ec	215	void (*probe_callback)(void);
37d5e202 MD	216	const struct lttng_event_ctx ctx; / context */
	217	const struct lttng_event_field fields; / event payload */
	218	unsigned int nr_fields;
	219	const int **loglevel;
68755429	220	const char signature; / Argument types/names received */
37d5e202 MD	221	char padding[LTTNG_UST_EVENT_DESC_PADDING];
	222	};
	223
	224	#define LTTNG_UST_PROBE_DESC_PADDING 40
	225	struct lttng_probe_desc {
	226	const char *provider;
	227	const struct lttng_event_desc **event_desc;
	228	unsigned int nr_events;
	229	struct cds_list_head head; /* chain registered probes */
	230	char padding[LTTNG_UST_PROBE_DESC_PADDING];
8020ceb5 MD	231	};
8020ceb5 MD	232
37d5e202 MD	233	/* Data structures used by the tracer. */
37d5e202 MD	234
e6c12e3d MD	235	/*
	236	* Entry describing a per-session active wildcard, along with the event
	237	* attribute and channel information configuring the events that need to
	238	* be enabled.
	239	*/
	240	struct session_wildcard {
	241	struct ltt_channel *chan;
	242	struct lttng_ctx ctx; / TODO */
	243	struct lttng_ust_event event_param;
	244	struct cds_list_head events; /* list of events enabled */
	245	struct cds_list_head list; /* per-session list of wildcards */
51c5df09	246	struct cds_list_head session_list; /* node of session wildcard list */
e6c12e3d MD	247	struct wildcard_entry *entry;
	248	unsigned int enabled:1;
	249	};
	250
	251	/*
	252	* Entry describing an active wildcard (per name) for all sessions.
	253	*/
	254	struct wildcard_entry {
51c5df09	255	/* node of global wildcards list */
e6c12e3d	256	struct cds_list_head list;
51c5df09	257	/* head of session list to which this wildcard apply */
e6c12e3d	258	struct cds_list_head session_list;
457a6b58 MD	259	enum lttng_ust_loglevel_type loglevel_type;
457a6b58 MD	260	int loglevel;
e6c12e3d MD	261	char name[0];
	262	};
	263
c8fcf224 MD	264	struct tp_list_entry {
	265	struct lttng_ust_tracepoint_iter tp;
	266	struct cds_list_head head;
	267	};
	268
	269	struct lttng_ust_tracepoint_list {
	270	struct tp_list_entry *iter;
	271	struct cds_list_head head;
8020ceb5 MD	272	};
8020ceb5 MD	273
06d4f27e MD	274	struct tp_field_list_entry {
	275	struct lttng_ust_field_iter field;
	276	struct cds_list_head head;
	277	};
	278
	279	struct lttng_ust_field_list {
	280	struct tp_field_list_entry *iter;
	281	struct cds_list_head head;
	282	};
	283
8165c8da	284	struct ust_pending_probe;
fbdeb5ec	285	struct ltt_event;
8165c8da	286
8020ceb5 MD	287	/*
	288	* ltt_event structure is referred to by the tracing fast path. It must be
	289	* kept small.
	290	*/
	291	struct ltt_event {
	292	unsigned int id;
	293	struct ltt_channel *chan;
976fe9ea	294	int enabled;
8020ceb5	295	const struct lttng_event_desc *desc;
1ddfd641 MD	296	int (filter)(void filter_data, const char *filter_stack_data);
1ddfd641 MD	297	void *filter_data;
8020ceb5	298	struct lttng_ctx *ctx;
9f3fdbc6	299	enum lttng_ust_instrumentation instrumentation;
8020ceb5	300	union {
8020ceb5	301	} u;
9f3fdbc6	302	struct cds_list_head list; /* Event list */
e6c12e3d	303	struct cds_list_head wildcard_list; /* Event list for wildcard */
8165c8da	304	struct ust_pending_probe *pending_probe;
7c2caf2b	305	unsigned int metadata_dumped:1;
8020ceb5 MD	306	};
8020ceb5 MD	307
8d8a24c8	308	struct channel;
38fae1d3	309	struct lttng_ust_shm_handle;
8d8a24c8	310
8020ceb5	311	struct ltt_channel_ops {
1d498196	312	struct ltt_channel (channel_create)(const char *name,
8020ceb5 MD	313	void *buf_addr,
	314	size_t subbuf_size, size_t num_subbuf,
	315	unsigned int switch_timer_interval,
193183fb	316	unsigned int read_timer_interval,
ef9ff354 MD	317	int shm_fd, int wait_fd,
ef9ff354 MD	318	uint64_t **memory_map_size,
d028eddb	319	struct ltt_channel *chan_priv_init);
1d498196	320	void (channel_destroy)(struct ltt_channel ltt_chan);
4cfec15c	321	struct lttng_ust_lib_ring_buffer (buffer_read_open)(struct channel *chan,
38fae1d3	322	struct lttng_ust_shm_handle *handle,
ef9ff354 MD	323	int shm_fd, int wait_fd,
ef9ff354 MD	324	uint64_t **memory_map_size);
4cfec15c	325	void (buffer_read_close)(struct lttng_ust_lib_ring_buffer buf,
38fae1d3	326	struct lttng_ust_shm_handle *handle);
4cfec15c	327	int (event_reserve)(struct lttng_ust_lib_ring_buffer_ctx ctx,
8020ceb5	328	uint32_t event_id);
4cfec15c MD	329	void (event_commit)(struct lttng_ust_lib_ring_buffer_ctx ctx);
4cfec15c MD	330	void (event_write)(struct lttng_ust_lib_ring_buffer_ctx ctx, const void *src,
8020ceb5 MD	331	size_t len);
	332	/*
	333	* packet_avail_size returns the available size in the current
	334	* packet. Note that the size returned is only a hint, since it
	335	* may change due to concurrent writes.
	336	*/
1d498196	337	size_t (packet_avail_size)(struct channel chan,
38fae1d3	338	struct lttng_ust_shm_handle *handle);
9f3fdbc6 MD	339	//wait_queue_head_t (get_reader_wait_queue)(struct channel *chan);
9f3fdbc6 MD	340	//wait_queue_head_t (get_hp_wait_queue)(struct channel *chan);
8020ceb5 MD	341	int (is_finalized)(struct channel chan);
8020ceb5 MD	342	int (is_disabled)(struct channel chan);
38fae1d3	343	int (flush_buffer)(struct channel chan, struct lttng_ust_shm_handle *handle);
8020ceb5 MD	344	};
	345
	346	struct ltt_channel {
a3f61e7f MD	347	/*
	348	* The pointers located in this private data are NOT safe to be
	349	* dereferenced by the consumer. The only operations the
	350	* consumer process is designed to be allowed to do is to read
	351	* and perform subbuffer flush.
	352	*/
8020ceb5	353	struct channel chan; / Channel buffers */
976fe9ea	354	int enabled;
8020ceb5 MD	355	struct lttng_ctx *ctx;
	356	/* Event ID management */
	357	struct ltt_session *session;
0a42beb6	358	int objd; /* Object associated to channel */
8020ceb5	359	unsigned int free_event_id; /* Next event ID to allocate */
8165c8da	360	unsigned int used_event_id; /* Max allocated event IDs */
9f3fdbc6	361	struct cds_list_head list; /* Channel list */
8020ceb5 MD	362	struct ltt_channel_ops *ops;
8020ceb5 MD	363	int header_type; /* 0: unset, 1: compact, 2: large */
38fae1d3	364	struct lttng_ust_shm_handle handle; / shared-memory handle */
7c2caf2b	365	unsigned int metadata_dumped:1;
a3f61e7f MD	366
	367	/* Channel ID, available for consumer too */
	368	unsigned int id;
	369	/* Copy of session UUID for consumer (availability through shm) */
19d8b1b3	370	unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */
8020ceb5 MD	371	};
	372
	373	struct ltt_session {
	374	int active; /* Is trace session active ? */
	375	int been_active; /* Has trace session been active ? */
0a42beb6	376	int objd; /* Object associated to session */
8020ceb5	377	struct ltt_channel metadata; / Metadata channel */
9f3fdbc6 MD	378	struct cds_list_head chan; /* Channel list head */
9f3fdbc6 MD	379	struct cds_list_head events; /* Event list head */
e6c12e3d	380	struct cds_list_head wildcards; /* Wildcard list head */
9f3fdbc6	381	struct cds_list_head list; /* Session list */
8020ceb5	382	unsigned int free_chan_id; /* Next chan ID to allocate */
19d8b1b3	383	unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */
7c2caf2b	384	unsigned int metadata_dumped:1;
8020ceb5 MD	385	};
	386
	387	struct ltt_transport {
	388	char *name;
9f3fdbc6	389	struct cds_list_head node;
8020ceb5 MD	390	struct ltt_channel_ops ops;
	391	};
	392
	393	struct ltt_session *ltt_session_create(void);
976fe9ea MD	394	int ltt_session_enable(struct ltt_session *session);
976fe9ea MD	395	int ltt_session_disable(struct ltt_session *session);
8020ceb5 MD	396	void ltt_session_destroy(struct ltt_session *session);
	397
	398	struct ltt_channel ltt_channel_create(struct ltt_session session,
	399	const char *transport_name,
	400	void *buf_addr,
	401	size_t subbuf_size, size_t num_subbuf,
	402	unsigned int switch_timer_interval,
193183fb	403	unsigned int read_timer_interval,
ef9ff354 MD	404	int shm_fd, int wait_fd,
ef9ff354 MD	405	uint64_t **memory_map_size,
d028eddb	406	struct ltt_channel *chan_priv_init);
8020ceb5 MD	407	struct ltt_channel ltt_global_channel_create(struct ltt_session session,
	408	int overwrite, void *buf_addr,
	409	size_t subbuf_size, size_t num_subbuf,
	410	unsigned int switch_timer_interval,
193183fb	411	unsigned int read_timer_interval,
ef9ff354 MD	412	int shm_fd, int wait_fd,
ef9ff354 MD	413	uint64_t **memory_map_size);
8020ceb5	414
576599a0 MD	415	int ltt_event_create(struct ltt_channel *chan,
576599a0 MD	416	struct lttng_ust_event *event_param,
1ddfd641 MD	417	int (filter)(void filter_data,
	418	const char *filter_stack_data),
	419	void *filter_data,
576599a0	420	struct ltt_event **event);
8020ceb5	421
976fe9ea MD	422	int ltt_channel_enable(struct ltt_channel *channel);
	423	int ltt_channel_disable(struct ltt_channel *channel);
	424	int ltt_event_enable(struct ltt_event *event);
	425	int ltt_event_disable(struct ltt_event *event);
	426
8020ceb5 MD	427	void ltt_transport_register(struct ltt_transport *transport);
	428	void ltt_transport_unregister(struct ltt_transport *transport);
	429
4b4de73e	430	void synchronize_trace(void);
8020ceb5 MD	431
	432	int ltt_probe_register(struct lttng_probe_desc *desc);
	433	void ltt_probe_unregister(struct lttng_probe_desc *desc);
8165c8da	434	int pending_probe_fix_events(const struct lttng_event_desc *desc);
8020ceb5 MD	435	const struct lttng_event_desc ltt_event_get(const char name);
	436	void ltt_event_put(const struct lttng_event_desc *desc);
	437	int ltt_probes_init(void);
	438	void ltt_probes_exit(void);
8173ec7c MD	439	int lttng_find_context(struct lttng_ctx ctx, const char name);
	440	struct lttng_ctx_field lttng_append_context(struct lttng_ctx *ctx_p);
	441	void lttng_remove_context_field(struct lttng_ctx **ctx_p,
8020ceb5 MD	442	struct lttng_ctx_field *field);
8020ceb5 MD	443	void lttng_destroy_context(struct lttng_ctx *ctx);
3b402b40	444	int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx);
c1ef86f0	445	int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx);
8173ec7c	446	int lttng_add_pthread_id_to_ctx(struct lttng_ctx **ctx);
4847e9bb	447	int lttng_add_procname_to_ctx(struct lttng_ctx **ctx);
a93bfc45	448	void lttng_context_vtid_reset(void);
c1ef86f0	449	void lttng_context_vpid_reset(void);
9f3fdbc6	450
5a821cd6 MD	451	extern const struct lttng_ust_lib_ring_buffer_client_cb *lttng_client_callbacks_metadata;
	452	extern const struct lttng_ust_lib_ring_buffer_client_cb *lttng_client_callbacks_discard;
	453	extern const struct lttng_ust_lib_ring_buffer_client_cb *lttng_client_callbacks_overwrite;
c1fca457	454
c1fca457 MD	455	struct ltt_transport ltt_transport_find(const char name);
c1fca457 MD	456
c8fcf224 MD	457	int ltt_probes_get_event_list(struct lttng_ust_tracepoint_list *list);
	458	void ltt_probes_prune_event_list(struct lttng_ust_tracepoint_list *list);
	459	struct lttng_ust_tracepoint_iter *
	460	lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list *list);
06d4f27e MD	461	int ltt_probes_get_field_list(struct lttng_ust_field_list *list);
	462	void ltt_probes_prune_field_list(struct lttng_ust_field_list *list);
	463	struct lttng_ust_field_iter *
	464	lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list);
c8fcf224	465
e6c12e3d MD	466	int ltt_wildcard_enable(struct session_wildcard *wildcard);
	467	int ltt_wildcard_disable(struct session_wildcard *wildcard);
	468	int ltt_wildcard_create(struct ltt_channel *chan,
	469	struct lttng_ust_event *event_param,
	470	struct session_wildcard **sl);
457a6b58 MD	471	int ltt_loglevel_match(const struct lttng_event_desc *desc,
	472	enum lttng_ust_loglevel_type req_type,
	473	int req_loglevel);
	474	void ltt_probes_create_wildcard_events(struct wildcard_entry *entry,
	475	struct session_wildcard *wildcard);
e6c12e3d	476
51489cad	477	#endif /* _LTTNG_UST_EVENTS_H */