[lttng-ust.git] / liblttng-ust / ust-events-internal.h

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright 2019 (c) Francis Deslauriers <francis.deslauriers@efficios.com>
 */

#ifndef _LTTNG_UST_EVENTS_INTERNAL_H
#define _LTTNG_UST_EVENTS_INTERNAL_H

#include <stdint.h>

#include <urcu/list.h>
#include <urcu/hlist.h>

#include <ust-helper.h>
#include <lttng/ust-events.h>

enum lttng_enabler_format_type {
	LTTNG_ENABLER_FORMAT_STAR_GLOB,
	LTTNG_ENABLER_FORMAT_EVENT,
};

/*
 * Enabler field, within whatever object is enabling an event. Target of
 * backward reference.
 */
struct lttng_enabler {
	enum lttng_enabler_format_type format_type;

	/* head list of struct lttng_ust_filter_bytecode_node */
	struct cds_list_head filter_bytecode_head;
	/* head list of struct lttng_ust_excluder_node */
	struct cds_list_head excluder_head;

	struct lttng_ust_event event_param;
	unsigned int enabled:1;
};

struct lttng_event_enabler {
	struct lttng_enabler base;
	struct cds_list_head node;	/* per-session list of enablers */
	struct lttng_channel *chan;
	/*
	 * Unused, but kept around to make it explicit that the tracer can do
	 * it.
	 */
	struct lttng_ctx *ctx;
};

struct lttng_event_notifier_enabler {
	struct lttng_enabler base;
	uint64_t error_counter_index;
	struct cds_list_head node;	/* per-app list of event_notifier enablers */
	struct cds_list_head capture_bytecode_head;
	struct lttng_event_notifier_group *group; /* weak ref */
	uint64_t user_token;		/* User-provided token */
	uint64_t num_captures;
};

enum lttng_ust_bytecode_node_type {
	LTTNG_UST_BYTECODE_NODE_TYPE_FILTER,
	LTTNG_UST_BYTECODE_NODE_TYPE_CAPTURE,
};

struct lttng_ust_bytecode_node {
	enum lttng_ust_bytecode_node_type type;
	struct cds_list_head node;
	struct lttng_enabler *enabler;
	struct  {
		uint32_t len;
		uint32_t reloc_offset;
		uint64_t seqnum;
		char data[];
	} bc;
};

struct lttng_ust_excluder_node {
	struct cds_list_head node;
	struct lttng_enabler *enabler;
	/*
	 * struct lttng_ust_event_exclusion had variable sized array,
	 * must be last field.
	 */
	struct lttng_ust_event_exclusion excluder;
};

/* Data structures used by the tracer. */

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

/*
 * Objects in a linked-list of enablers, owned by an event or event_notifier.
 * This is used because an event (or a event_notifier) can be enabled by more
 * than one enabler and we want a quick way to iterate over all enablers of an
 * object.
 *
 * For example, event rules "my_app:a*" and "my_app:ab*" will both match the
 * event with the name "my_app:abc".
 */
struct lttng_enabler_ref {
	struct cds_list_head node;		/* enabler ref list */
	struct lttng_enabler *ref;		/* backward ref */
};

#define LTTNG_COUNTER_DIMENSION_MAX	8
struct lttng_counter_dimension {
	uint64_t size;
	uint64_t underflow_index;
	uint64_t overflow_index;
	uint8_t has_underflow;
	uint8_t has_overflow;
};

struct lttng_counter {
	int objd;
	struct lttng_event_notifier_group *event_notifier_group;    /* owner */
	struct lttng_counter_transport *transport;
	struct lib_counter *counter;
	struct lttng_counter_ops *ops;
};

struct lttng_event_notifier_group {
	int objd;
	void *owner;
	int notification_fd;
	struct cds_list_head node;		/* Event notifier group handle list */
	struct cds_list_head enablers_head;
	struct cds_list_head event_notifiers_head;	/* list of event_notifiers */
	struct lttng_ust_event_notifier_ht event_notifiers_ht; /* hashtable of event_notifiers */
	struct lttng_ctx *ctx;			/* contexts for filters. */

	struct lttng_counter *error_counter;
	size_t error_counter_len;
};

struct lttng_transport {
	char *name;
	struct cds_list_head node;
	struct lttng_channel_ops ops;
	const struct lttng_ust_lib_ring_buffer_config *client_config;
};

struct lttng_counter_transport {
	char *name;
	struct cds_list_head node;
	struct lttng_counter_ops ops;
	const struct lib_counter_config *client_config;
};

struct lttng_ust_event_private {
	struct lttng_event *pub;	/* Public event interface */

	const struct lttng_event_desc *desc;
	enum lttng_ust_instrumentation instrumentation;
	struct cds_list_head node;		/* Event list in session */

	/* Backward references: list of lttng_enabler_ref (ref to enablers) */
	struct cds_list_head enablers_ref_head;
	struct cds_hlist_node hlist;	/* session ht of events */
	int registered;			/* has reg'd tracepoint probe */
};

struct lttng_ust_bytecode_runtime_private {
	struct bytecode_runtime *pub;	/* Public bytecode runtime interface */

	struct lttng_ust_bytecode_node *bc;
	int link_failed;
	/*
	 * Pointer to a URCU-protected pointer owned by an `struct
	 * lttng_session`or `struct lttng_event_notifier_group`.
	 */
	struct lttng_ctx **pctx;
};

struct lttng_ust_session_private {
	struct lttng_session *pub;		/* Public session interface */

	int been_active;			/* Been active ? */
	int objd;				/* Object associated */
	struct cds_list_head chan_head;		/* Channel list head */
	struct cds_list_head events_head;	/* list of events */
	struct cds_list_head node;		/* Session list */

	/* New UST 2.1 */
	/* List of enablers */
	struct cds_list_head enablers_head;
	struct lttng_ust_event_ht events_ht;	/* ht of events */
	void *owner;				/* object owner */
	int tstate:1;				/* Transient enable state */

	/* New UST 2.4 */
	int statedump_pending:1;

	/* New UST 2.8 */
	struct lttng_ust_enum_ht enums_ht;	/* ht of enumerations */
	struct cds_list_head enums_head;
	struct lttng_ctx *ctx;			/* contexts for filters. */
};

static inline
struct lttng_enabler *lttng_event_enabler_as_enabler(
		struct lttng_event_enabler *event_enabler)
{
	return &event_enabler->base;
}

static inline
struct lttng_enabler *lttng_event_notifier_enabler_as_enabler(
		struct lttng_event_notifier_enabler *event_notifier_enabler)
{
	return &event_notifier_enabler->base;
}

/*
 * Allocate and initialize a `struct lttng_event_enabler` object.
 *
 * On success, returns a `struct lttng_event_enabler`,
 * On memory error, returns NULL.
 */
LTTNG_HIDDEN
struct lttng_event_enabler *lttng_event_enabler_create(
		enum lttng_enabler_format_type format_type,
		struct lttng_ust_event *event_param,
		struct lttng_channel *chan);

/*
 * Destroy a `struct lttng_event_enabler` object.
 */
LTTNG_HIDDEN
void lttng_event_enabler_destroy(struct lttng_event_enabler *enabler);

/*
 * Enable a `struct lttng_event_enabler` object and all events related to this
 * enabler.
 */
LTTNG_HIDDEN
int lttng_event_enabler_enable(struct lttng_event_enabler *enabler);

/*
 * Disable a `struct lttng_event_enabler` object and all events related to this
 * enabler.
 */
LTTNG_HIDDEN
int lttng_event_enabler_disable(struct lttng_event_enabler *enabler);

/*
 * Attach filter bytecode program to `struct lttng_event_enabler` and all
 * events related to this enabler.
 */
LTTNG_HIDDEN
int lttng_event_enabler_attach_filter_bytecode(
		struct lttng_event_enabler *enabler,
		struct lttng_ust_bytecode_node **bytecode);

/*
 * Attach an application context to an event enabler.
 *
 * Not implemented.
 */
LTTNG_HIDDEN
int lttng_event_enabler_attach_context(struct lttng_event_enabler *enabler,
		struct lttng_ust_context *ctx);

/*
 * Attach exclusion list to `struct lttng_event_enabler` and all
 * events related to this enabler.
 */
LTTNG_HIDDEN
int lttng_event_enabler_attach_exclusion(struct lttng_event_enabler *enabler,
		struct lttng_ust_excluder_node **excluder);

/*
 * Synchronize bytecodes for the enabler and the instance (event or
 * event_notifier).
 *
 * This function goes over all bytecode programs of the enabler (event or
 * event_notifier enabler) to ensure each is linked to the provided instance.
 */
LTTNG_HIDDEN
void lttng_enabler_link_bytecode(const struct lttng_event_desc *event_desc,
		struct lttng_ctx **ctx,
		struct cds_list_head *instance_bytecode_runtime_head,
		struct cds_list_head *enabler_bytecode_runtime_head);

/*
 * Allocate and initialize a `struct lttng_event_notifier_group` object.
 *
 * On success, returns a `struct lttng_triggre_group`,
 * on memory error, returns NULL.
 */
LTTNG_HIDDEN
struct lttng_event_notifier_group *lttng_event_notifier_group_create(void);

/*
 * Destroy a `struct lttng_event_notifier_group` object.
 */
LTTNG_HIDDEN
void lttng_event_notifier_group_destroy(
		struct lttng_event_notifier_group *event_notifier_group);

/*
 * Allocate and initialize a `struct lttng_event_notifier_enabler` object.
 *
 * On success, returns a `struct lttng_event_notifier_enabler`,
 * On memory error, returns NULL.
 */
LTTNG_HIDDEN
struct lttng_event_notifier_enabler *lttng_event_notifier_enabler_create(
		struct lttng_event_notifier_group *event_notifier_group,
		enum lttng_enabler_format_type format_type,
		struct lttng_ust_event_notifier *event_notifier_param);

/*
 * Destroy a `struct lttng_event_notifier_enabler` object.
 */
LTTNG_HIDDEN
void lttng_event_notifier_enabler_destroy(
		struct lttng_event_notifier_enabler *event_notifier_enabler);

/*
 * Enable a `struct lttng_event_notifier_enabler` object and all event
 * notifiers related to this enabler.
 */
LTTNG_HIDDEN
int lttng_event_notifier_enabler_enable(
		struct lttng_event_notifier_enabler *event_notifier_enabler);

/*
 * Disable a `struct lttng_event_notifier_enabler` object and all event
 * notifiers related to this enabler.
 */
LTTNG_HIDDEN
int lttng_event_notifier_enabler_disable(
		struct lttng_event_notifier_enabler *event_notifier_enabler);

/*
 * Attach filter bytecode program to `struct lttng_event_notifier_enabler` and
 * all event notifiers related to this enabler.
 */
LTTNG_HIDDEN
int lttng_event_notifier_enabler_attach_filter_bytecode(
		struct lttng_event_notifier_enabler *event_notifier_enabler,
		struct lttng_ust_bytecode_node **bytecode);

/*
 * Attach capture bytecode program to `struct lttng_event_notifier_enabler` and
 * all event_notifiers related to this enabler.
 */
LTTNG_HIDDEN
int lttng_event_notifier_enabler_attach_capture_bytecode(
		struct lttng_event_notifier_enabler *event_notifier_enabler,
		struct lttng_ust_bytecode_node **bytecode);

/*
 * Attach exclusion list to `struct lttng_event_notifier_enabler` and all
 * event notifiers related to this enabler.
 */
LTTNG_HIDDEN
int lttng_event_notifier_enabler_attach_exclusion(
		struct lttng_event_notifier_enabler *event_notifier_enabler,
		struct lttng_ust_excluder_node **excluder);

LTTNG_HIDDEN
void lttng_free_event_filter_runtime(struct lttng_event *event);

LTTNG_HIDDEN
void lttng_free_event_notifier_filter_runtime(
		struct lttng_event_notifier *event_notifier);

/*
 * Connect the probe on all enablers matching this event description.
 * Called on library load.
 */
LTTNG_HIDDEN
int lttng_fix_pending_event_notifiers(void);

LTTNG_HIDDEN
struct lttng_counter *lttng_ust_counter_create(
		const char *counter_transport_name,
		size_t number_dimensions, const struct lttng_counter_dimension *dimensions);

#ifdef HAVE_PERF_EVENT

LTTNG_HIDDEN
int lttng_add_perf_counter_to_ctx(uint32_t type,
				  uint64_t config,
				  const char *name,
				  struct lttng_ctx **ctx);
LTTNG_HIDDEN
int lttng_perf_counter_init(void);
LTTNG_HIDDEN
void lttng_perf_counter_exit(void);

#else /* #ifdef HAVE_PERF_EVENT */

static inline
int lttng_add_perf_counter_to_ctx(uint32_t type,
				  uint64_t config,
				  const char *name,
				  struct lttng_ctx **ctx)
{
	return -ENOSYS;
}
static inline
int lttng_perf_counter_init(void)
{
	return 0;
}
static inline
void lttng_perf_counter_exit(void)
{
}
#endif /* #else #ifdef HAVE_PERF_EVENT */

LTTNG_HIDDEN
int lttng_probes_get_event_list(struct lttng_ust_tracepoint_list *list);
LTTNG_HIDDEN
void lttng_probes_prune_event_list(struct lttng_ust_tracepoint_list *list);

LTTNG_HIDDEN
int lttng_probes_get_field_list(struct lttng_ust_field_list *list);
LTTNG_HIDDEN
void lttng_probes_prune_field_list(struct lttng_ust_field_list *list);

LTTNG_HIDDEN
struct lttng_ust_tracepoint_iter *
	lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list *list);
LTTNG_HIDDEN
struct lttng_ust_field_iter *
	lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list);

LTTNG_HIDDEN
struct lttng_session *lttng_session_create(void);
LTTNG_HIDDEN
int lttng_session_enable(struct lttng_session *session);
LTTNG_HIDDEN
int lttng_session_disable(struct lttng_session *session);
LTTNG_HIDDEN
int lttng_session_statedump(struct lttng_session *session);
LTTNG_HIDDEN
void lttng_session_destroy(struct lttng_session *session);

LTTNG_HIDDEN
struct cds_list_head *lttng_get_sessions(void);

LTTNG_HIDDEN
void lttng_handle_pending_statedump(void *owner);

LTTNG_HIDDEN
struct lttng_channel *lttng_channel_create(struct lttng_session *session,
				       const char *transport_name,
				       void *buf_addr,
				       size_t subbuf_size, size_t num_subbuf,
				       unsigned int switch_timer_interval,
				       unsigned int read_timer_interval,
				       int **shm_fd, int **wait_fd,
				       uint64_t **memory_map_size,
				       struct lttng_channel *chan_priv_init);

LTTNG_HIDDEN
int lttng_channel_enable(struct lttng_channel *channel);
LTTNG_HIDDEN
int lttng_channel_disable(struct lttng_channel *channel);

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

LTTNG_HIDDEN
void lttng_probe_provider_unregister_events(struct lttng_probe_desc *desc);

LTTNG_HIDDEN
int lttng_fix_pending_events(void);

LTTNG_HIDDEN
struct cds_list_head *lttng_get_probe_list_head(void);

LTTNG_HIDDEN
struct lttng_enum *lttng_ust_enum_get_from_desc(struct lttng_session *session,
		const struct lttng_enum_desc *enum_desc);

#endif /* _LTTNG_UST_EVENTS_INTERNAL_H */
Commit	Line	Data
d871c65b	1	/*
c0c0989a	2	* SPDX-License-Identifier: MIT
d871c65b	3	*
c0c0989a	4	* Copyright 2019 (c) Francis Deslauriers <francis.deslauriers@efficios.com>
d871c65b FD	5	*/
d871c65b FD	6
c0c0989a MJ	7	#ifndef _LTTNG_UST_EVENTS_INTERNAL_H
	8	#define _LTTNG_UST_EVENTS_INTERNAL_H
	9
d871c65b FD	10	#include <stdint.h>
	11
	12	#include <urcu/list.h>
	13	#include <urcu/hlist.h>
	14
864a1eda	15	#include <ust-helper.h>
d871c65b FD	16	#include <lttng/ust-events.h>
d871c65b FD	17
8665f6a4 MJ	18	enum lttng_enabler_format_type {
	19	LTTNG_ENABLER_FORMAT_STAR_GLOB,
	20	LTTNG_ENABLER_FORMAT_EVENT,
	21	};
	22
	23	/*
	24	* Enabler field, within whatever object is enabling an event. Target of
	25	* backward reference.
	26	*/
	27	struct lttng_enabler {
	28	enum lttng_enabler_format_type format_type;
	29
	30	/* head list of struct lttng_ust_filter_bytecode_node */
	31	struct cds_list_head filter_bytecode_head;
	32	/* head list of struct lttng_ust_excluder_node */
	33	struct cds_list_head excluder_head;
	34
	35	struct lttng_ust_event event_param;
	36	unsigned int enabled:1;
	37	};
	38
d871c65b FD	39	struct lttng_event_enabler {
	40	struct lttng_enabler base;
	41	struct cds_list_head node; /* per-session list of enablers */
	42	struct lttng_channel *chan;
	43	/*
	44	* Unused, but kept around to make it explicit that the tracer can do
	45	* it.
	46	*/
	47	struct lttng_ctx *ctx;
	48	};
	49
d8d2416d FD	50	struct lttng_event_notifier_enabler {
d8d2416d FD	51	struct lttng_enabler base;
6566528b	52	uint64_t error_counter_index;
d37ecb3f FD	53	struct cds_list_head node; /* per-app list of event_notifier enablers */
d37ecb3f FD	54	struct cds_list_head capture_bytecode_head;
d8d2416d FD	55	struct lttng_event_notifier_group group; / weak ref */
d8d2416d FD	56	uint64_t user_token; /* User-provided token */
d37ecb3f	57	uint64_t num_captures;
d8d2416d FD	58	};
d8d2416d FD	59
ab249ecf FD	60	enum lttng_ust_bytecode_node_type {
ab249ecf FD	61	LTTNG_UST_BYTECODE_NODE_TYPE_FILTER,
d37ecb3f	62	LTTNG_UST_BYTECODE_NODE_TYPE_CAPTURE,
ab249ecf FD	63	};
	64
	65	struct lttng_ust_bytecode_node {
	66	enum lttng_ust_bytecode_node_type type;
92495593 FD	67	struct cds_list_head node;
92495593 FD	68	struct lttng_enabler *enabler;
ab249ecf FD	69	struct {
	70	uint32_t len;
	71	uint32_t reloc_offset;
	72	uint64_t seqnum;
	73	char data[];
	74	} bc;
92495593 FD	75	};
	76
	77	struct lttng_ust_excluder_node {
	78	struct cds_list_head node;
	79	struct lttng_enabler *enabler;
	80	/*
	81	* struct lttng_ust_event_exclusion had variable sized array,
	82	* must be last field.
	83	*/
	84	struct lttng_ust_event_exclusion excluder;
	85	};
	86
bb7ad29d MJ	87	/* Data structures used by the tracer. */
	88
	89	struct tp_list_entry {
	90	struct lttng_ust_tracepoint_iter tp;
	91	struct cds_list_head head;
	92	};
	93
	94	struct lttng_ust_tracepoint_list {
	95	struct tp_list_entry *iter;
	96	struct cds_list_head head;
	97	};
	98
	99	struct tp_field_list_entry {
	100	struct lttng_ust_field_iter field;
	101	struct cds_list_head head;
	102	};
	103
	104	struct lttng_ust_field_list {
	105	struct tp_field_list_entry *iter;
	106	struct cds_list_head head;
	107	};
	108
	109	/*
	110	* Objects in a linked-list of enablers, owned by an event or event_notifier.
	111	* This is used because an event (or a event_notifier) can be enabled by more
	112	* than one enabler and we want a quick way to iterate over all enablers of an
	113	* object.
	114	*
	115	* For example, event rules "my_app:a" and "my_app:ab" will both match the
	116	* event with the name "my_app:abc".
	117	*/
	118	struct lttng_enabler_ref {
	119	struct cds_list_head node; /* enabler ref list */
	120	struct lttng_enabler ref; / backward ref */
	121	};
	122
	123	#define LTTNG_COUNTER_DIMENSION_MAX 8
	124	struct lttng_counter_dimension {
	125	uint64_t size;
	126	uint64_t underflow_index;
	127	uint64_t overflow_index;
	128	uint8_t has_underflow;
	129	uint8_t has_overflow;
	130	};
	131
	132	struct lttng_counter {
	133	int objd;
	134	struct lttng_event_notifier_group event_notifier_group; / owner */
	135	struct lttng_counter_transport *transport;
	136	struct lib_counter *counter;
	137	struct lttng_counter_ops *ops;
	138	};
	139
	140	struct lttng_event_notifier_group {
	141	int objd;
	142	void *owner;
	143	int notification_fd;
	144	struct cds_list_head node; /* Event notifier group handle list */
	145	struct cds_list_head enablers_head;
	146	struct cds_list_head event_notifiers_head; /* list of event_notifiers */
	147	struct lttng_ust_event_notifier_ht event_notifiers_ht; /* hashtable of event_notifiers */
	148	struct lttng_ctx ctx; / contexts for filters. */
	149
	150	struct lttng_counter *error_counter;
151	size_t error_counter_len;
152	};
153
154	struct lttng_transport {
155	char *name;
156	struct cds_list_head node;
157	struct lttng_channel_ops ops;
158	const struct lttng_ust_lib_ring_buffer_config *client_config;
159	};
160
161	struct lttng_counter_transport {
162	char *name;
163	struct cds_list_head node;
164	struct lttng_counter_ops ops;
165	const struct lib_counter_config *client_config;
166	};
167
68bb7559 MD	168	struct lttng_ust_event_private {
	169	struct lttng_event pub; / Public event interface */
	170
	171	const struct lttng_event_desc *desc;
	172	enum lttng_ust_instrumentation instrumentation;
	173	struct cds_list_head node; /* Event list in session */
	174
	175	/* Backward references: list of lttng_enabler_ref (ref to enablers) */
	176	struct cds_list_head enablers_ref_head;
	177	struct cds_hlist_node hlist; /* session ht of events */
	178	int registered; /* has reg'd tracepoint probe */
	179	};
	180
362a65de MD	181	struct lttng_ust_bytecode_runtime_private {
	182	struct bytecode_runtime pub; / Public bytecode runtime interface */
	183
	184	struct lttng_ust_bytecode_node *bc;
	185	int link_failed;
	186	/*
	187	* Pointer to a URCU-protected pointer owned by an `struct
	188	* lttng_session`or `struct lttng_event_notifier_group`.
	189	*/
	190	struct lttng_ctx **pctx;
	191	};
	192
bdb12629 MD	193	struct lttng_ust_session_private {
	194	struct lttng_session pub; / Public session interface */
	195
	196	int been_active; /* Been active ? */
	197	int objd; /* Object associated */
	198	struct cds_list_head chan_head; /* Channel list head */
	199	struct cds_list_head events_head; /* list of events */
	200	struct cds_list_head node; /* Session list */
	201
	202	/* New UST 2.1 */
	203	/* List of enablers */
	204	struct cds_list_head enablers_head;
	205	struct lttng_ust_event_ht events_ht; /* ht of events */
	206	void owner; / object owner */
	207	int tstate:1; /* Transient enable state */
	208
	209	/* New UST 2.4 */
	210	int statedump_pending:1;
	211
	212	/* New UST 2.8 */
	213	struct lttng_ust_enum_ht enums_ht; /* ht of enumerations */
	214	struct cds_list_head enums_head;
	215	struct lttng_ctx ctx; / contexts for filters. */
	216	};
	217
d871c65b FD	218	static inline
	219	struct lttng_enabler *lttng_event_enabler_as_enabler(
	220	struct lttng_event_enabler *event_enabler)
	221	{
	222	return &event_enabler->base;
	223	}
	224
d8d2416d FD	225	static inline
	226	struct lttng_enabler *lttng_event_notifier_enabler_as_enabler(
	227	struct lttng_event_notifier_enabler *event_notifier_enabler)
	228	{
	229	return &event_notifier_enabler->base;
	230	}
d871c65b FD	231
	232	/*
	233	* Allocate and initialize a `struct lttng_event_enabler` object.
	234	*
	235	* On success, returns a `struct lttng_event_enabler`,
	236	* On memory error, returns NULL.
	237	*/
	238	LTTNG_HIDDEN
	239	struct lttng_event_enabler *lttng_event_enabler_create(
	240	enum lttng_enabler_format_type format_type,
	241	struct lttng_ust_event *event_param,
	242	struct lttng_channel *chan);
	243
	244	/*
	245	* Destroy a `struct lttng_event_enabler` object.
	246	*/
	247	LTTNG_HIDDEN
	248	void lttng_event_enabler_destroy(struct lttng_event_enabler *enabler);
	249
	250	/*
	251	* Enable a `struct lttng_event_enabler` object and all events related to this
	252	* enabler.
	253	*/
	254	LTTNG_HIDDEN
	255	int lttng_event_enabler_enable(struct lttng_event_enabler *enabler);
	256
	257	/*
	258	* Disable a `struct lttng_event_enabler` object and all events related to this
	259	* enabler.
	260	*/
	261	LTTNG_HIDDEN
	262	int lttng_event_enabler_disable(struct lttng_event_enabler *enabler);
	263
	264	/*
	265	* Attach filter bytecode program to `struct lttng_event_enabler` and all
	266	* events related to this enabler.
	267	*/
	268	LTTNG_HIDDEN
a56fd376 FD	269	int lttng_event_enabler_attach_filter_bytecode(
a56fd376 FD	270	struct lttng_event_enabler *enabler,
ab89263e	271	struct lttng_ust_bytecode_node **bytecode);
d871c65b FD	272
	273	/*
	274	* Attach an application context to an event enabler.
	275	*
	276	* Not implemented.
	277	*/
	278	LTTNG_HIDDEN
	279	int lttng_event_enabler_attach_context(struct lttng_event_enabler *enabler,
	280	struct lttng_ust_context *ctx);
	281
	282	/*
	283	* Attach exclusion list to `struct lttng_event_enabler` and all
	284	* events related to this enabler.
	285	*/
	286	LTTNG_HIDDEN
	287	int lttng_event_enabler_attach_exclusion(struct lttng_event_enabler *enabler,
e9fe6aad	288	struct lttng_ust_excluder_node **excluder);
d871c65b FD	289
d871c65b FD	290	/*
d37ecb3f FD	291	* Synchronize bytecodes for the enabler and the instance (event or
d37ecb3f FD	292	* event_notifier).
d871c65b	293	*
621c07fc	294	* This function goes over all bytecode programs of the enabler (event or
d37ecb3f	295	* event_notifier enabler) to ensure each is linked to the provided instance.
d871c65b FD	296	*/
d871c65b FD	297	LTTNG_HIDDEN
53b9d7db FD	298	void lttng_enabler_link_bytecode(const struct lttng_event_desc *event_desc,
53b9d7db FD	299	struct lttng_ctx **ctx,
621c07fc FD	300	struct cds_list_head *instance_bytecode_runtime_head,
621c07fc FD	301	struct cds_list_head *enabler_bytecode_runtime_head);
d871c65b	302
d8d2416d FD	303	/*
	304	* Allocate and initialize a `struct lttng_event_notifier_group` object.
	305	*
	306	* On success, returns a `struct lttng_triggre_group`,
	307	* on memory error, returns NULL.
	308	*/
	309	LTTNG_HIDDEN
	310	struct lttng_event_notifier_group *lttng_event_notifier_group_create(void);
	311
	312	/*
	313	* Destroy a `struct lttng_event_notifier_group` object.
	314	*/
	315	LTTNG_HIDDEN
	316	void lttng_event_notifier_group_destroy(
	317	struct lttng_event_notifier_group *event_notifier_group);
	318
	319	/*
	320	* Allocate and initialize a `struct lttng_event_notifier_enabler` object.
	321	*
	322	* On success, returns a `struct lttng_event_notifier_enabler`,
	323	* On memory error, returns NULL.
	324	*/
	325	LTTNG_HIDDEN
	326	struct lttng_event_notifier_enabler *lttng_event_notifier_enabler_create(
	327	struct lttng_event_notifier_group *event_notifier_group,
	328	enum lttng_enabler_format_type format_type,
	329	struct lttng_ust_event_notifier *event_notifier_param);
	330
	331	/*
	332	* Destroy a `struct lttng_event_notifier_enabler` object.
	333	*/
	334	LTTNG_HIDDEN
	335	void lttng_event_notifier_enabler_destroy(
	336	struct lttng_event_notifier_enabler *event_notifier_enabler);
	337
	338	/*
	339	* Enable a `struct lttng_event_notifier_enabler` object and all event
	340	* notifiers related to this enabler.
	341	*/
	342	LTTNG_HIDDEN
	343	int lttng_event_notifier_enabler_enable(
	344	struct lttng_event_notifier_enabler *event_notifier_enabler);
	345
	346	/*
	347	* Disable a `struct lttng_event_notifier_enabler` object and all event
	348	* notifiers related to this enabler.
	349	*/
	350	LTTNG_HIDDEN
	351	int lttng_event_notifier_enabler_disable(
	352	struct lttng_event_notifier_enabler *event_notifier_enabler);
	353
	354	/*
	355	* Attach filter bytecode program to `struct lttng_event_notifier_enabler` and
	356	* all event notifiers related to this enabler.
	357	*/
	358	LTTNG_HIDDEN
a56fd376	359	int lttng_event_notifier_enabler_attach_filter_bytecode(
d8d2416d	360	struct lttng_event_notifier_enabler *event_notifier_enabler,
ab89263e	361	struct lttng_ust_bytecode_node **bytecode);
d8d2416d	362
d37ecb3f FD	363	/*
	364	* Attach capture bytecode program to `struct lttng_event_notifier_enabler` and
	365	* all event_notifiers related to this enabler.
	366	*/
	367	LTTNG_HIDDEN
	368	int lttng_event_notifier_enabler_attach_capture_bytecode(
	369	struct lttng_event_notifier_enabler *event_notifier_enabler,
49cde654	370	struct lttng_ust_bytecode_node **bytecode);
d37ecb3f	371
d8d2416d FD	372	/*
	373	* Attach exclusion list to `struct lttng_event_notifier_enabler` and all
	374	* event notifiers related to this enabler.
	375	*/
	376	LTTNG_HIDDEN
	377	int lttng_event_notifier_enabler_attach_exclusion(
	378	struct lttng_event_notifier_enabler *event_notifier_enabler,
e9fe6aad	379	struct lttng_ust_excluder_node **excluder);
d8d2416d	380
7753d283 MJ	381	LTTNG_HIDDEN
	382	void lttng_free_event_filter_runtime(struct lttng_event *event);
	383
d8d2416d FD	384	LTTNG_HIDDEN
	385	void lttng_free_event_notifier_filter_runtime(
	386	struct lttng_event_notifier *event_notifier);
	387
	388	/*
	389	* Connect the probe on all enablers matching this event description.
	390	* Called on library load.
	391	*/
	392	LTTNG_HIDDEN
	393	int lttng_fix_pending_event_notifiers(void);
	394
67d4e8f5 MJ	395	LTTNG_HIDDEN
	396	struct lttng_counter *lttng_ust_counter_create(
	397	const char *counter_transport_name,
	398	size_t number_dimensions, const struct lttng_counter_dimension *dimensions);
	399
bd8c1787 MJ	400	#ifdef HAVE_PERF_EVENT
	401
	402	LTTNG_HIDDEN
	403	int lttng_add_perf_counter_to_ctx(uint32_t type,
	404	uint64_t config,
	405	const char *name,
	406	struct lttng_ctx **ctx);
	407	LTTNG_HIDDEN
	408	int lttng_perf_counter_init(void);
	409	LTTNG_HIDDEN
	410	void lttng_perf_counter_exit(void);
	411
	412	#else /* #ifdef HAVE_PERF_EVENT */
	413
	414	static inline
	415	int lttng_add_perf_counter_to_ctx(uint32_t type,
	416	uint64_t config,
	417	const char *name,
	418	struct lttng_ctx **ctx)
	419	{
	420	return -ENOSYS;
	421	}
	422	static inline
	423	int lttng_perf_counter_init(void)
	424	{
	425	return 0;
	426	}
	427	static inline
	428	void lttng_perf_counter_exit(void)
	429	{
	430	}
	431	#endif /* #else #ifdef HAVE_PERF_EVENT */
	432
7753d283 MJ	433	LTTNG_HIDDEN
	434	int lttng_probes_get_event_list(struct lttng_ust_tracepoint_list *list);
	435	LTTNG_HIDDEN
	436	void lttng_probes_prune_event_list(struct lttng_ust_tracepoint_list *list);
	437
	438	LTTNG_HIDDEN
	439	int lttng_probes_get_field_list(struct lttng_ust_field_list *list);
	440	LTTNG_HIDDEN
	441	void lttng_probes_prune_field_list(struct lttng_ust_field_list *list);
	442
	443	LTTNG_HIDDEN
	444	struct lttng_ust_tracepoint_iter *
	445	lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list *list);
	446	LTTNG_HIDDEN
	447	struct lttng_ust_field_iter *
	448	lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list);
	449
	450	LTTNG_HIDDEN
	451	struct lttng_session *lttng_session_create(void);
	452	LTTNG_HIDDEN
	453	int lttng_session_enable(struct lttng_session *session);
	454	LTTNG_HIDDEN
	455	int lttng_session_disable(struct lttng_session *session);
	456	LTTNG_HIDDEN
	457	int lttng_session_statedump(struct lttng_session *session);
	458	LTTNG_HIDDEN
	459	void lttng_session_destroy(struct lttng_session *session);
	460
	461	LTTNG_HIDDEN
	462	struct cds_list_head *lttng_get_sessions(void);
	463
	464	LTTNG_HIDDEN
	465	void lttng_handle_pending_statedump(void *owner);
	466
	467	LTTNG_HIDDEN
	468	struct lttng_channel lttng_channel_create(struct lttng_session session,
	469	const char *transport_name,
	470	void *buf_addr,
	471	size_t subbuf_size, size_t num_subbuf,
	472	unsigned int switch_timer_interval,
	473	unsigned int read_timer_interval,
	474	int shm_fd, int wait_fd,
	475	uint64_t **memory_map_size,
	476	struct lttng_channel *chan_priv_init);
	477
	478	LTTNG_HIDDEN
	479	int lttng_channel_enable(struct lttng_channel *channel);
	480	LTTNG_HIDDEN
	481	int lttng_channel_disable(struct lttng_channel *channel);
	482
	483	LTTNG_HIDDEN
	484	void lttng_transport_register(struct lttng_transport *transport);
	485	LTTNG_HIDDEN
	486	void lttng_transport_unregister(struct lttng_transport *transport);
	487
	488	LTTNG_HIDDEN
	489	void lttng_probe_provider_unregister_events(struct lttng_probe_desc *desc);
	490
	491	LTTNG_HIDDEN
	492	int lttng_fix_pending_events(void);
	493
	494	LTTNG_HIDDEN
	495	struct cds_list_head *lttng_get_probe_list_head(void);
	496
497	LTTNG_HIDDEN
498	struct lttng_enum lttng_ust_enum_get_from_desc(struct lttng_session session,
499	const struct lttng_enum_desc *enum_desc);
500
d871c65b	501	#endif /* _LTTNG_UST_EVENTS_INTERNAL_H */