[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 <lttng/ust-events.h>

#include "ust-context-provider.h"

struct lttng_ust_abi_obj;
struct lttng_event_notifier_group;

union lttng_ust_abi_args {
	struct {
		void *chan_data;
		int wakeup_fd;
	} channel;
	struct {
		int shm_fd;
		int wakeup_fd;
	} stream;
	struct {
		struct lttng_ust_abi_field_iter entry;
	} field_list;
	struct {
		char *ctxname;
	} app_context;
	struct {
		int event_notifier_notif_fd;
	} event_notifier_handle;
	struct {
		void *counter_data;
	} counter;
	struct {
		int shm_fd;
	} counter_shm;
};

struct lttng_ust_abi_objd_ops {
	long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
		union lttng_ust_abi_args *args, void *owner);
	int (*release)(int objd);
};

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_abi_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_ust_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_abi_event_exclusion excluder;
};

/* Data structures used by the tracer. */

struct tp_list_entry {
	struct lttng_ust_abi_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_abi_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_ops {
	struct lib_counter *(*counter_create)(size_t nr_dimensions,
			const struct lttng_counter_dimension *dimensions,
			int64_t global_sum_step,
			int global_counter_fd,
			int nr_counter_cpu_fds,
			const int *counter_cpu_fds,
			bool is_daemon);
	void (*counter_destroy)(struct lib_counter *counter);
	int (*counter_add)(struct lib_counter *counter,
			const size_t *dimension_indexes, int64_t v);
	int (*counter_read)(struct lib_counter *counter,
			const size_t *dimension_indexes, int cpu,
			int64_t *value, bool *overflow, bool *underflow);
	int (*counter_aggregate)(struct lib_counter *counter,
			const size_t *dimension_indexes, int64_t *value,
			bool *overflow, bool *underflow);
	int (*counter_clear)(struct lib_counter *counter, const size_t *dimension_indexes);
};

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

#define LTTNG_UST_EVENT_HT_BITS		12
#define LTTNG_UST_EVENT_HT_SIZE		(1U << LTTNG_UST_EVENT_HT_BITS)

struct lttng_ust_event_ht {
	struct cds_hlist_head table[LTTNG_UST_EVENT_HT_SIZE];
};

#define LTTNG_UST_EVENT_NOTIFIER_HT_BITS		12
#define LTTNG_UST_EVENT_NOTIFIER_HT_SIZE		(1U << LTTNG_UST_EVENT_NOTIFIER_HT_BITS)
struct lttng_ust_event_notifier_ht {
	struct cds_hlist_head table[LTTNG_UST_EVENT_NOTIFIER_HT_SIZE];
};

#define LTTNG_UST_ENUM_HT_BITS		12
#define LTTNG_UST_ENUM_HT_SIZE		(1U << LTTNG_UST_ENUM_HT_BITS)

struct lttng_ust_enum_ht {
	struct cds_hlist_head table[LTTNG_UST_ENUM_HT_SIZE];
};

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_ust_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_ust_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_common_private {
	struct lttng_ust_event_common *pub;	/* Public event interface */

	const struct lttng_ust_event_desc *desc;
	/* Backward references: list of lttng_enabler_ref (ref to enablers) */
	struct cds_list_head enablers_ref_head;
	int registered;			/* has reg'd tracepoint probe */
	uint64_t user_token;
};

struct lttng_ust_event_recorder_private {
	struct lttng_ust_event_common_private parent;

	struct lttng_ust_event_recorder *pub;	/* Public event interface */
	struct cds_list_head node;		/* Event recorder list */
	struct cds_hlist_node hlist;		/* Hash table of event recorders */
};

struct lttng_ust_event_notifier_private {
	struct lttng_ust_event_common_private parent;

	struct lttng_ust_event_notifier *pub;	/* Public event notifier interface */
	struct lttng_event_notifier_group *group; /* weak ref */
	size_t num_captures;			/* Needed to allocate the msgpack array. */
	uint64_t error_counter_index;
	struct cds_list_head node;		/* Event notifier list */
	struct cds_hlist_node hlist;		/* Hash table of event notifiers */
};

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_ust_ctx **pctx;
};

struct lttng_ust_session_private {
	struct lttng_ust_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_ust_ctx *ctx;			/* contexts for filters. */
};

struct lttng_enum {
	const struct lttng_ust_enum_desc *desc;
	struct lttng_ust_session *session;
	struct cds_list_head node;	/* Enum list in session */
	struct cds_hlist_node hlist;	/* Session ht of enums */
	uint64_t id;			/* Enumeration ID in sessiond */
};

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.
 */
__attribute__((visibility("hidden")))
struct lttng_event_enabler *lttng_event_enabler_create(
		enum lttng_enabler_format_type format_type,
		struct lttng_ust_abi_event *event_param,
		struct lttng_channel *chan);

/*
 * Destroy a `struct lttng_event_enabler` object.
 */
__attribute__((visibility("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.
 */
__attribute__((visibility("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.
 */
__attribute__((visibility("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.
 */
__attribute__((visibility("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.
 */
__attribute__((visibility("hidden")))
int lttng_event_enabler_attach_context(struct lttng_event_enabler *enabler,
		struct lttng_ust_abi_context *ctx);

/*
 * Attach exclusion list to `struct lttng_event_enabler` and all
 * events related to this enabler.
 */
__attribute__((visibility("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.
 */
__attribute__((visibility("hidden")))
void lttng_enabler_link_bytecode(const struct lttng_ust_event_desc *event_desc,
		struct lttng_ust_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.
 */
__attribute__((visibility("hidden")))
struct lttng_event_notifier_group *lttng_event_notifier_group_create(void);

/*
 * Destroy a `struct lttng_event_notifier_group` object.
 */
__attribute__((visibility("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.
 */
__attribute__((visibility("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_abi_event_notifier *event_notifier_param);

/*
 * Destroy a `struct lttng_event_notifier_enabler` object.
 */
__attribute__((visibility("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.
 */
__attribute__((visibility("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.
 */
__attribute__((visibility("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.
 */
__attribute__((visibility("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.
 */
__attribute__((visibility("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.
 */
__attribute__((visibility("hidden")))
int lttng_event_notifier_enabler_attach_exclusion(
		struct lttng_event_notifier_enabler *event_notifier_enabler,
		struct lttng_ust_excluder_node **excluder);

__attribute__((visibility("hidden")))
void lttng_free_event_filter_runtime(struct lttng_ust_event_common *event);

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

__attribute__((visibility("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

__attribute__((visibility("hidden")))
int lttng_add_perf_counter_to_ctx(uint32_t type,
				  uint64_t config,
				  const char *name,
				  struct lttng_ust_ctx **ctx);

__attribute__((visibility("hidden")))
int lttng_perf_counter_init(void);

__attribute__((visibility("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_ust_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 */

__attribute__((visibility("hidden")))
int lttng_probes_get_event_list(struct lttng_ust_tracepoint_list *list);

__attribute__((visibility("hidden")))
void lttng_probes_prune_event_list(struct lttng_ust_tracepoint_list *list);

__attribute__((visibility("hidden")))
int lttng_probes_get_field_list(struct lttng_ust_field_list *list);

__attribute__((visibility("hidden")))
void lttng_probes_prune_field_list(struct lttng_ust_field_list *list);

__attribute__((visibility("hidden")))
struct lttng_ust_abi_tracepoint_iter *
	lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list *list);

__attribute__((visibility("hidden")))
struct lttng_ust_abi_field_iter *
	lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list);

__attribute__((visibility("hidden")))
struct lttng_ust_session *lttng_session_create(void);

__attribute__((visibility("hidden")))
int lttng_session_enable(struct lttng_ust_session *session);

__attribute__((visibility("hidden")))
int lttng_session_disable(struct lttng_ust_session *session);

__attribute__((visibility("hidden")))
int lttng_session_statedump(struct lttng_ust_session *session);

__attribute__((visibility("hidden")))
void lttng_session_destroy(struct lttng_ust_session *session);

/*
 * Called with ust lock held.
 */
__attribute__((visibility("hidden")))
int lttng_session_active(void);

__attribute__((visibility("hidden")))
struct cds_list_head *lttng_get_sessions(void);

__attribute__((visibility("hidden")))
void lttng_handle_pending_statedump(void *owner);

__attribute__((visibility("hidden")))
struct lttng_channel *lttng_channel_create(struct lttng_ust_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);

__attribute__((visibility("hidden")))
int lttng_channel_enable(struct lttng_channel *channel);

__attribute__((visibility("hidden")))
int lttng_channel_disable(struct lttng_channel *channel);

__attribute__((visibility("hidden")))
void lttng_transport_register(struct lttng_transport *transport);

__attribute__((visibility("hidden")))
void lttng_transport_unregister(struct lttng_transport *transport);

/* This is ABI between liblttng-ust and liblttng-ust-ctl */
struct lttng_transport *lttng_ust_transport_find(const char *name);

/* This is ABI between liblttng-ust and liblttng-ust-dl */
void lttng_ust_dl_update(void *ip);

__attribute__((visibility("hidden")))
void lttng_probe_provider_unregister_events(struct lttng_ust_probe_desc *desc);

__attribute__((visibility("hidden")))
int lttng_fix_pending_events(void);

__attribute__((visibility("hidden")))
struct cds_list_head *lttng_get_probe_list_head(void);

__attribute__((visibility("hidden")))
struct lttng_enum *lttng_ust_enum_get_from_desc(struct lttng_ust_session *session,
		const struct lttng_ust_enum_desc *enum_desc);

__attribute__((visibility("hidden")))
int lttng_abi_create_root_handle(void);

__attribute__((visibility("hidden")))
const struct lttng_ust_abi_objd_ops *lttng_ust_abi_objd_ops(int id);

__attribute__((visibility("hidden")))
int lttng_ust_abi_objd_unref(int id, int is_owner);

__attribute__((visibility("hidden")))
void lttng_ust_abi_exit(void);

__attribute__((visibility("hidden")))
void lttng_ust_abi_events_exit(void);

__attribute__((visibility("hidden")))
void lttng_ust_abi_objd_table_owner_cleanup(void *owner);

#endif /* _LTTNG_UST_EVENTS_INTERNAL_H */
Commit	Line	Data
	1	/*
	2	* SPDX-License-Identifier: MIT
	3	*
	4	* Copyright 2019 (c) Francis Deslauriers <francis.deslauriers@efficios.com>
	5	*/
	6
	7	#ifndef _LTTNG_UST_EVENTS_INTERNAL_H
	8	#define _LTTNG_UST_EVENTS_INTERNAL_H
	9
	10	#include <stdint.h>
	11
	12	#include <urcu/list.h>
	13	#include <urcu/hlist.h>
	14
	15	#include <lttng/ust-events.h>
	16
	17	#include "ust-context-provider.h"
	18
	19	struct lttng_ust_abi_obj;
	20	struct lttng_event_notifier_group;
	21
	22	union lttng_ust_abi_args {
	23	struct {
	24	void *chan_data;
	25	int wakeup_fd;
	26	} channel;
	27	struct {
	28	int shm_fd;
	29	int wakeup_fd;
	30	} stream;
	31	struct {
	32	struct lttng_ust_abi_field_iter entry;
	33	} field_list;
	34	struct {
	35	char *ctxname;
	36	} app_context;
	37	struct {
	38	int event_notifier_notif_fd;
	39	} event_notifier_handle;
	40	struct {
	41	void *counter_data;
	42	} counter;
	43	struct {
	44	int shm_fd;
	45	} counter_shm;
	46	};
	47
	48	struct lttng_ust_abi_objd_ops {
	49	long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
	50	union lttng_ust_abi_args args, void owner);
	51	int (*release)(int objd);
	52	};
	53
	54	enum lttng_enabler_format_type {
	55	LTTNG_ENABLER_FORMAT_STAR_GLOB,
	56	LTTNG_ENABLER_FORMAT_EVENT,
	57	};
	58
	59	/*
	60	* Enabler field, within whatever object is enabling an event. Target of
	61	* backward reference.
	62	*/
	63	struct lttng_enabler {
	64	enum lttng_enabler_format_type format_type;
	65
	66	/* head list of struct lttng_ust_filter_bytecode_node */
	67	struct cds_list_head filter_bytecode_head;
	68	/* head list of struct lttng_ust_excluder_node */
	69	struct cds_list_head excluder_head;
	70
	71	struct lttng_ust_abi_event event_param;
	72	unsigned int enabled:1;
	73	};
	74
	75	struct lttng_event_enabler {
	76	struct lttng_enabler base;
	77	struct cds_list_head node; /* per-session list of enablers */
	78	struct lttng_channel *chan;
	79	/*
	80	* Unused, but kept around to make it explicit that the tracer can do
	81	* it.
	82	*/
	83	struct lttng_ust_ctx *ctx;
	84	};
	85
	86	struct lttng_event_notifier_enabler {
	87	struct lttng_enabler base;
	88	uint64_t error_counter_index;
	89	struct cds_list_head node; /* per-app list of event_notifier enablers */
	90	struct cds_list_head capture_bytecode_head;
	91	struct lttng_event_notifier_group group; / weak ref */
	92	uint64_t user_token; /* User-provided token */
	93	uint64_t num_captures;
	94	};
	95
	96	enum lttng_ust_bytecode_node_type {
	97	LTTNG_UST_BYTECODE_NODE_TYPE_FILTER,
	98	LTTNG_UST_BYTECODE_NODE_TYPE_CAPTURE,
	99	};
	100
	101	struct lttng_ust_bytecode_node {
	102	enum lttng_ust_bytecode_node_type type;
	103	struct cds_list_head node;
	104	struct lttng_enabler *enabler;
	105	struct {
	106	uint32_t len;
	107	uint32_t reloc_offset;
	108	uint64_t seqnum;
	109	char data[];
	110	} bc;
	111	};
	112
	113	struct lttng_ust_excluder_node {
	114	struct cds_list_head node;
	115	struct lttng_enabler *enabler;
	116	/*
	117	* struct lttng_ust_event_exclusion had variable sized array,
	118	* must be last field.
	119	*/
	120	struct lttng_ust_abi_event_exclusion excluder;
	121	};
	122
	123	/* Data structures used by the tracer. */
	124
	125	struct tp_list_entry {
	126	struct lttng_ust_abi_tracepoint_iter tp;
	127	struct cds_list_head head;
	128	};
	129
	130	struct lttng_ust_tracepoint_list {
	131	struct tp_list_entry *iter;
	132	struct cds_list_head head;
	133	};
	134
	135	struct tp_field_list_entry {
	136	struct lttng_ust_abi_field_iter field;
	137	struct cds_list_head head;
	138	};
	139
	140	struct lttng_ust_field_list {
	141	struct tp_field_list_entry *iter;
	142	struct cds_list_head head;
	143	};
	144
	145	/*
	146	* Objects in a linked-list of enablers, owned by an event or event_notifier.
	147	* This is used because an event (or a event_notifier) can be enabled by more
	148	* than one enabler and we want a quick way to iterate over all enablers of an
	149	* object.
	150	*
	151	* For example, event rules "my_app:a" and "my_app:ab" will both match the
	152	* event with the name "my_app:abc".
	153	*/
	154	struct lttng_enabler_ref {
	155	struct cds_list_head node; /* enabler ref list */
	156	struct lttng_enabler ref; / backward ref */
	157	};
	158
	159	#define LTTNG_COUNTER_DIMENSION_MAX 8
	160	struct lttng_counter_dimension {
	161	uint64_t size;
	162	uint64_t underflow_index;
	163	uint64_t overflow_index;
	164	uint8_t has_underflow;
	165	uint8_t has_overflow;
	166	};
	167
	168	struct lttng_counter_ops {
	169	struct lib_counter (counter_create)(size_t nr_dimensions,
	170	const struct lttng_counter_dimension *dimensions,
	171	int64_t global_sum_step,
	172	int global_counter_fd,
	173	int nr_counter_cpu_fds,
	174	const int *counter_cpu_fds,
	175	bool is_daemon);
	176	void (counter_destroy)(struct lib_counter counter);
	177	int (counter_add)(struct lib_counter counter,
	178	const size_t *dimension_indexes, int64_t v);
	179	int (counter_read)(struct lib_counter counter,
	180	const size_t *dimension_indexes, int cpu,
	181	int64_t value, bool overflow, bool *underflow);
	182	int (counter_aggregate)(struct lib_counter counter,
	183	const size_t dimension_indexes, int64_t value,
	184	bool overflow, bool underflow);
	185	int (counter_clear)(struct lib_counter counter, const size_t *dimension_indexes);
	186	};
	187
	188	struct lttng_counter {
	189	int objd;
	190	struct lttng_event_notifier_group event_notifier_group; / owner */
	191	struct lttng_counter_transport *transport;
	192	struct lib_counter *counter;
	193	struct lttng_counter_ops *ops;
	194	};
	195
	196	#define LTTNG_UST_EVENT_HT_BITS 12
	197	#define LTTNG_UST_EVENT_HT_SIZE (1U << LTTNG_UST_EVENT_HT_BITS)
	198
	199	struct lttng_ust_event_ht {
	200	struct cds_hlist_head table[LTTNG_UST_EVENT_HT_SIZE];
	201	};
	202
	203	#define LTTNG_UST_EVENT_NOTIFIER_HT_BITS 12
	204	#define LTTNG_UST_EVENT_NOTIFIER_HT_SIZE (1U << LTTNG_UST_EVENT_NOTIFIER_HT_BITS)
	205	struct lttng_ust_event_notifier_ht {
	206	struct cds_hlist_head table[LTTNG_UST_EVENT_NOTIFIER_HT_SIZE];
	207	};
	208
	209	#define LTTNG_UST_ENUM_HT_BITS 12
	210	#define LTTNG_UST_ENUM_HT_SIZE (1U << LTTNG_UST_ENUM_HT_BITS)
	211
	212	struct lttng_ust_enum_ht {
	213	struct cds_hlist_head table[LTTNG_UST_ENUM_HT_SIZE];
	214	};
	215
	216	struct lttng_event_notifier_group {
	217	int objd;
	218	void *owner;
	219	int notification_fd;
	220	struct cds_list_head node; /* Event notifier group handle list */
	221	struct cds_list_head enablers_head;
	222	struct cds_list_head event_notifiers_head; /* list of event_notifiers */
	223	struct lttng_ust_event_notifier_ht event_notifiers_ht; /* hashtable of event_notifiers */
	224	struct lttng_ust_ctx ctx; / contexts for filters. */
	225
	226	struct lttng_counter *error_counter;
	227	size_t error_counter_len;
	228	};
	229
	230	struct lttng_transport {
	231	char *name;
	232	struct cds_list_head node;
	233	struct lttng_ust_channel_ops ops;
	234	const struct lttng_ust_lib_ring_buffer_config *client_config;
	235	};
	236
	237	struct lttng_counter_transport {
	238	char *name;
	239	struct cds_list_head node;
	240	struct lttng_counter_ops ops;
	241	const struct lib_counter_config *client_config;
	242	};
	243
	244	struct lttng_ust_event_common_private {
	245	struct lttng_ust_event_common pub; / Public event interface */
	246
	247	const struct lttng_ust_event_desc *desc;
	248	/* Backward references: list of lttng_enabler_ref (ref to enablers) */
	249	struct cds_list_head enablers_ref_head;
	250	int registered; /* has reg'd tracepoint probe */
	251	uint64_t user_token;
	252	};
	253
	254	struct lttng_ust_event_recorder_private {
	255	struct lttng_ust_event_common_private parent;
	256
	257	struct lttng_ust_event_recorder pub; / Public event interface */
	258	struct cds_list_head node; /* Event recorder list */
	259	struct cds_hlist_node hlist; /* Hash table of event recorders */
	260	};
	261
	262	struct lttng_ust_event_notifier_private {
	263	struct lttng_ust_event_common_private parent;
	264
	265	struct lttng_ust_event_notifier pub; / Public event notifier interface */
	266	struct lttng_event_notifier_group group; / weak ref */
	267	size_t num_captures; /* Needed to allocate the msgpack array. */
	268	uint64_t error_counter_index;
	269	struct cds_list_head node; /* Event notifier list */
	270	struct cds_hlist_node hlist; /* Hash table of event notifiers */
	271	};
	272
	273	struct lttng_ust_bytecode_runtime_private {
	274	struct bytecode_runtime pub; / Public bytecode runtime interface */
	275
	276	struct lttng_ust_bytecode_node *bc;
	277	int link_failed;
	278	/*
	279	* Pointer to a URCU-protected pointer owned by an `struct
	280	* lttng_session`or `struct lttng_event_notifier_group`.
	281	*/
	282	struct lttng_ust_ctx **pctx;
	283	};
	284
	285	struct lttng_ust_session_private {
	286	struct lttng_ust_session pub; / Public session interface */
	287
	288	int been_active; /* Been active ? */
	289	int objd; /* Object associated */
	290	struct cds_list_head chan_head; /* Channel list head */
	291	struct cds_list_head events_head; /* list of events */
	292	struct cds_list_head node; /* Session list */
	293
	294	/* New UST 2.1 */
	295	/* List of enablers */
	296	struct cds_list_head enablers_head;
	297	struct lttng_ust_event_ht events_ht; /* ht of events */
	298	void owner; / object owner */
	299	int tstate:1; /* Transient enable state */
	300
	301	/* New UST 2.4 */
	302	int statedump_pending:1;
	303
	304	/* New UST 2.8 */
	305	struct lttng_ust_enum_ht enums_ht; /* ht of enumerations */
	306	struct cds_list_head enums_head;
	307	struct lttng_ust_ctx ctx; / contexts for filters. */
	308	};
	309
	310	struct lttng_enum {
	311	const struct lttng_ust_enum_desc *desc;
	312	struct lttng_ust_session *session;
	313	struct cds_list_head node; /* Enum list in session */
	314	struct cds_hlist_node hlist; /* Session ht of enums */
	315	uint64_t id; /* Enumeration ID in sessiond */
	316	};
	317
	318	static inline
	319	struct lttng_enabler *lttng_event_enabler_as_enabler(
	320	struct lttng_event_enabler *event_enabler)
	321	{
	322	return &event_enabler->base;
	323	}
	324
	325	static inline
	326	struct lttng_enabler *lttng_event_notifier_enabler_as_enabler(
	327	struct lttng_event_notifier_enabler *event_notifier_enabler)
	328	{
	329	return &event_notifier_enabler->base;
	330	}
	331
	332	/*
	333	* Allocate and initialize a `struct lttng_event_enabler` object.
	334	*
	335	* On success, returns a `struct lttng_event_enabler`,
	336	* On memory error, returns NULL.
	337	*/
	338	__attribute__((visibility("hidden")))
	339	struct lttng_event_enabler *lttng_event_enabler_create(
	340	enum lttng_enabler_format_type format_type,
	341	struct lttng_ust_abi_event *event_param,
	342	struct lttng_channel *chan);
	343
	344	/*
	345	* Destroy a `struct lttng_event_enabler` object.
	346	*/
	347	__attribute__((visibility("hidden")))
	348	void lttng_event_enabler_destroy(struct lttng_event_enabler *enabler);
	349
	350	/*
	351	* Enable a `struct lttng_event_enabler` object and all events related to this
	352	* enabler.
	353	*/
	354	__attribute__((visibility("hidden")))
	355	int lttng_event_enabler_enable(struct lttng_event_enabler *enabler);
	356
	357	/*
	358	* Disable a `struct lttng_event_enabler` object and all events related to this
	359	* enabler.
	360	*/
	361	__attribute__((visibility("hidden")))
	362	int lttng_event_enabler_disable(struct lttng_event_enabler *enabler);
	363
	364	/*
	365	* Attach filter bytecode program to `struct lttng_event_enabler` and all
	366	* events related to this enabler.
	367	*/
	368	__attribute__((visibility("hidden")))
	369	int lttng_event_enabler_attach_filter_bytecode(
	370	struct lttng_event_enabler *enabler,
	371	struct lttng_ust_bytecode_node **bytecode);
	372
	373	/*
	374	* Attach an application context to an event enabler.
	375	*
	376	* Not implemented.
	377	*/
	378	__attribute__((visibility("hidden")))
	379	int lttng_event_enabler_attach_context(struct lttng_event_enabler *enabler,
	380	struct lttng_ust_abi_context *ctx);
	381
	382	/*
	383	* Attach exclusion list to `struct lttng_event_enabler` and all
	384	* events related to this enabler.
	385	*/
	386	__attribute__((visibility("hidden")))
	387	int lttng_event_enabler_attach_exclusion(struct lttng_event_enabler *enabler,
	388	struct lttng_ust_excluder_node **excluder);
	389
	390	/*
	391	* Synchronize bytecodes for the enabler and the instance (event or
	392	* event_notifier).
	393	*
	394	* This function goes over all bytecode programs of the enabler (event or
	395	* event_notifier enabler) to ensure each is linked to the provided instance.
	396	*/
	397	__attribute__((visibility("hidden")))
	398	void lttng_enabler_link_bytecode(const struct lttng_ust_event_desc *event_desc,
	399	struct lttng_ust_ctx **ctx,
	400	struct cds_list_head *instance_bytecode_runtime_head,
	401	struct cds_list_head *enabler_bytecode_runtime_head);
	402
	403	/*
	404	* Allocate and initialize a `struct lttng_event_notifier_group` object.
	405	*
	406	* On success, returns a `struct lttng_triggre_group`,
	407	* on memory error, returns NULL.
	408	*/
	409	__attribute__((visibility("hidden")))
	410	struct lttng_event_notifier_group *lttng_event_notifier_group_create(void);
	411
	412	/*
	413	* Destroy a `struct lttng_event_notifier_group` object.
	414	*/
	415	__attribute__((visibility("hidden")))
	416	void lttng_event_notifier_group_destroy(
	417	struct lttng_event_notifier_group *event_notifier_group);
	418
	419	/*
	420	* Allocate and initialize a `struct lttng_event_notifier_enabler` object.
	421	*
	422	* On success, returns a `struct lttng_event_notifier_enabler`,
	423	* On memory error, returns NULL.
	424	*/
	425	__attribute__((visibility("hidden")))
	426	struct lttng_event_notifier_enabler *lttng_event_notifier_enabler_create(
	427	struct lttng_event_notifier_group *event_notifier_group,
	428	enum lttng_enabler_format_type format_type,
	429	struct lttng_ust_abi_event_notifier *event_notifier_param);
	430
	431	/*
	432	* Destroy a `struct lttng_event_notifier_enabler` object.
	433	*/
	434	__attribute__((visibility("hidden")))
	435	void lttng_event_notifier_enabler_destroy(
	436	struct lttng_event_notifier_enabler *event_notifier_enabler);
	437
	438	/*
	439	* Enable a `struct lttng_event_notifier_enabler` object and all event
	440	* notifiers related to this enabler.
	441	*/
	442	__attribute__((visibility("hidden")))
	443	int lttng_event_notifier_enabler_enable(
	444	struct lttng_event_notifier_enabler *event_notifier_enabler);
	445
	446	/*
	447	* Disable a `struct lttng_event_notifier_enabler` object and all event
	448	* notifiers related to this enabler.
	449	*/
	450	__attribute__((visibility("hidden")))
	451	int lttng_event_notifier_enabler_disable(
	452	struct lttng_event_notifier_enabler *event_notifier_enabler);
	453
	454	/*
	455	* Attach filter bytecode program to `struct lttng_event_notifier_enabler` and
	456	* all event notifiers related to this enabler.
	457	*/
	458	__attribute__((visibility("hidden")))
	459	int lttng_event_notifier_enabler_attach_filter_bytecode(
	460	struct lttng_event_notifier_enabler *event_notifier_enabler,
	461	struct lttng_ust_bytecode_node **bytecode);
	462
	463	/*
	464	* Attach capture bytecode program to `struct lttng_event_notifier_enabler` and
	465	* all event_notifiers related to this enabler.
	466	*/
	467	__attribute__((visibility("hidden")))
	468	int lttng_event_notifier_enabler_attach_capture_bytecode(
	469	struct lttng_event_notifier_enabler *event_notifier_enabler,
	470	struct lttng_ust_bytecode_node **bytecode);
	471
	472	/*
	473	* Attach exclusion list to `struct lttng_event_notifier_enabler` and all
	474	* event notifiers related to this enabler.
	475	*/
	476	__attribute__((visibility("hidden")))
	477	int lttng_event_notifier_enabler_attach_exclusion(
	478	struct lttng_event_notifier_enabler *event_notifier_enabler,
	479	struct lttng_ust_excluder_node **excluder);
	480
	481	__attribute__((visibility("hidden")))
	482	void lttng_free_event_filter_runtime(struct lttng_ust_event_common *event);
	483
	484	/*
	485	* Connect the probe on all enablers matching this event description.
	486	* Called on library load.
	487	*/
	488	__attribute__((visibility("hidden")))
	489	int lttng_fix_pending_event_notifiers(void);
	490
	491	__attribute__((visibility("hidden")))
	492	struct lttng_counter *lttng_ust_counter_create(
	493	const char *counter_transport_name,
	494	size_t number_dimensions, const struct lttng_counter_dimension *dimensions);
	495
	496	#ifdef HAVE_PERF_EVENT
	497
	498	__attribute__((visibility("hidden")))
	499	int lttng_add_perf_counter_to_ctx(uint32_t type,
	500	uint64_t config,
	501	const char *name,
	502	struct lttng_ust_ctx **ctx);
	503
	504	__attribute__((visibility("hidden")))
	505	int lttng_perf_counter_init(void);
	506
	507	__attribute__((visibility("hidden")))
	508	void lttng_perf_counter_exit(void);
	509
	510	#else /* #ifdef HAVE_PERF_EVENT */
	511
	512	static inline
	513	int lttng_add_perf_counter_to_ctx(uint32_t type,
	514	uint64_t config,
	515	const char *name,
	516	struct lttng_ust_ctx **ctx)
	517	{
	518	return -ENOSYS;
	519	}
	520	static inline
	521	int lttng_perf_counter_init(void)
	522	{
	523	return 0;
	524	}
	525	static inline
	526	void lttng_perf_counter_exit(void)
	527	{
	528	}
	529	#endif /* #else #ifdef HAVE_PERF_EVENT */
	530
	531	__attribute__((visibility("hidden")))
	532	int lttng_probes_get_event_list(struct lttng_ust_tracepoint_list *list);
	533
	534	__attribute__((visibility("hidden")))
	535	void lttng_probes_prune_event_list(struct lttng_ust_tracepoint_list *list);
	536
	537	__attribute__((visibility("hidden")))
	538	int lttng_probes_get_field_list(struct lttng_ust_field_list *list);
	539
	540	__attribute__((visibility("hidden")))
	541	void lttng_probes_prune_field_list(struct lttng_ust_field_list *list);
	542
	543	__attribute__((visibility("hidden")))
	544	struct lttng_ust_abi_tracepoint_iter *
	545	lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list *list);
	546
	547	__attribute__((visibility("hidden")))
	548	struct lttng_ust_abi_field_iter *
	549	lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list);
	550
	551	__attribute__((visibility("hidden")))
	552	struct lttng_ust_session *lttng_session_create(void);
	553
	554	__attribute__((visibility("hidden")))
	555	int lttng_session_enable(struct lttng_ust_session *session);
	556
	557	__attribute__((visibility("hidden")))
	558	int lttng_session_disable(struct lttng_ust_session *session);
	559
	560	__attribute__((visibility("hidden")))
	561	int lttng_session_statedump(struct lttng_ust_session *session);
	562
	563	__attribute__((visibility("hidden")))
	564	void lttng_session_destroy(struct lttng_ust_session *session);
	565
	566	/*
	567	* Called with ust lock held.
	568	*/
	569	__attribute__((visibility("hidden")))
	570	int lttng_session_active(void);
	571
	572	__attribute__((visibility("hidden")))
	573	struct cds_list_head *lttng_get_sessions(void);
	574
	575	__attribute__((visibility("hidden")))
	576	void lttng_handle_pending_statedump(void *owner);
	577
	578	__attribute__((visibility("hidden")))
	579	struct lttng_channel lttng_channel_create(struct lttng_ust_session session,
	580	const char *transport_name,
	581	void *buf_addr,
	582	size_t subbuf_size, size_t num_subbuf,
	583	unsigned int switch_timer_interval,
	584	unsigned int read_timer_interval,
	585	int shm_fd, int wait_fd,
	586	uint64_t **memory_map_size,
	587	struct lttng_channel *chan_priv_init);
	588
	589	__attribute__((visibility("hidden")))
	590	int lttng_channel_enable(struct lttng_channel *channel);
	591
	592	__attribute__((visibility("hidden")))
	593	int lttng_channel_disable(struct lttng_channel *channel);
	594
	595	__attribute__((visibility("hidden")))
	596	void lttng_transport_register(struct lttng_transport *transport);
	597
	598	__attribute__((visibility("hidden")))
	599	void lttng_transport_unregister(struct lttng_transport *transport);
	600
	601	/* This is ABI between liblttng-ust and liblttng-ust-ctl */
	602	struct lttng_transport lttng_ust_transport_find(const char name);
	603
	604	/* This is ABI between liblttng-ust and liblttng-ust-dl */
	605	void lttng_ust_dl_update(void *ip);
	606
	607	__attribute__((visibility("hidden")))
	608	void lttng_probe_provider_unregister_events(struct lttng_ust_probe_desc *desc);
	609
	610	__attribute__((visibility("hidden")))
	611	int lttng_fix_pending_events(void);
	612
	613	__attribute__((visibility("hidden")))
	614	struct cds_list_head *lttng_get_probe_list_head(void);
	615
	616	__attribute__((visibility("hidden")))
	617	struct lttng_enum lttng_ust_enum_get_from_desc(struct lttng_ust_session session,
	618	const struct lttng_ust_enum_desc *enum_desc);
	619
	620	__attribute__((visibility("hidden")))
	621	int lttng_abi_create_root_handle(void);
	622
	623	__attribute__((visibility("hidden")))
	624	const struct lttng_ust_abi_objd_ops *lttng_ust_abi_objd_ops(int id);
	625
	626	__attribute__((visibility("hidden")))
	627	int lttng_ust_abi_objd_unref(int id, int is_owner);
	628
	629	__attribute__((visibility("hidden")))
	630	void lttng_ust_abi_exit(void);
	631
	632	__attribute__((visibility("hidden")))
	633	void lttng_ust_abi_events_exit(void);
	634
	635	__attribute__((visibility("hidden")))
	636	void lttng_ust_abi_objd_table_owner_cleanup(void *owner);
	637
	638	#endif /* _LTTNG_UST_EVENTS_INTERNAL_H */