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

/*
 * 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;
	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 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 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) */
	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 wildcards;	/* Wildcard 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);

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