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


struct lttng_ust_abi_obj;

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

struct lttng_enum {
	const struct lttng_ust_enum_desc *desc;
	struct lttng_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.
 */
LTTNG_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.
 */
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_abi_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_ust_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_abi_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_ust_event_common *event);

/*
 * 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_abi_tracepoint_iter *
	lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list *list);
LTTNG_HIDDEN
struct lttng_ust_abi_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_ust_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_ust_enum_desc *enum_desc);

LTTNG_HIDDEN
int lttng_abi_create_root_handle(void);

LTTNG_HIDDEN
const struct lttng_ust_abi_objd_ops *lttng_ust_abi_objd_ops(int id);
LTTNG_HIDDEN
int lttng_ust_abi_objd_unref(int id, int is_owner);
LTTNG_HIDDEN
void lttng_ust_abi_exit(void);
LTTNG_HIDDEN
void lttng_ust_abi_events_exit(void);
LTTNG_HIDDEN
void lttng_ust_abi_objd_table_owner_cleanup(void *owner);

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