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

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * Holds LTTng per-session event registry.
 */

#ifndef _LTTNG_UST_EVENTS_H
#define _LTTNG_UST_EVENTS_H

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

#ifndef LTTNG_PACKED
#error "LTTNG_PACKED should be defined"
#endif

#ifdef __cplusplus
extern "C" {
#endif

#define LTTNG_UST_UUID_LEN		16

/*
 * Tracepoint provider version. Compatibility based on the major number.
 * Older tracepoint providers can always register to newer lttng-ust
 * library, but the opposite is rejected: a newer tracepoint provider is
 * rejected by an older lttng-ust library.
 */
#define LTTNG_UST_PROVIDER_MAJOR	2
#define LTTNG_UST_PROVIDER_MINOR	0

struct lttng_channel;
struct lttng_session;
struct lttng_ust_lib_ring_buffer_ctx;
struct lttng_ust_event_field;
struct lttng_event_notifier_group;

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

/* Type description */

/* Update the astract_types name table in lttng-types.c along with this enum */
enum lttng_abstract_types {
	atype_integer,
	atype_string,
	atype_float,
	atype_dynamic,
	atype_enum_nestable,
	atype_array_nestable,
	atype_sequence_nestable,
	atype_struct_nestable,
	NR_ABSTRACT_TYPES,
};

/* Update the string_encodings name table in lttng-types.c along with this enum */
enum lttng_string_encodings {
	lttng_encode_none = 0,
	lttng_encode_UTF8 = 1,
	lttng_encode_ASCII = 2,
	NR_STRING_ENCODINGS,
};

struct lttng_enum_value {
	unsigned long long value;
	unsigned int signedness:1;
};

enum lttng_enum_entry_options {
	LTTNG_ENUM_ENTRY_OPTION_IS_AUTO = 1U << 0,
};

/*
 * Enumeration entry description
 *
 * IMPORTANT: this structure is part of the ABI between the probe and
 * UST. Fields need to be only added at the end, never reordered, never
 * removed.
 *
 * The field @struct_size should be used to determine the size of the
 * structure. It should be queried before using additional fields added
 * at the end of the structure.
 */

struct lttng_ust_enum_entry {
	uint32_t struct_size;

	struct lttng_enum_value start, end; /* start and end are inclusive */
	const char *string;
	unsigned int options;

	/* End of base ABI. Fields below should be used after checking struct_size. */
};

#define __type_integer(_type, _byte_order, _base, _encoding)		\
	{								\
		.atype = atype_integer,					\
		.u = {							\
			.integer = {					\
				.size = sizeof(_type) * CHAR_BIT,	\
				.alignment = lttng_alignof(_type) * CHAR_BIT, \
				.signedness = lttng_is_signed_type(_type), \
				.reverse_byte_order = _byte_order != BYTE_ORDER, \
				.base = _base,			\
				.encoding = lttng_encode_##_encoding, \
			}					\
		},						\
	}							\

#define LTTNG_UST_INTEGER_TYPE_PADDING	24
struct lttng_integer_type {
	unsigned int size;		/* in bits */
	unsigned short alignment;	/* in bits */
	unsigned int signedness:1;
	unsigned int reverse_byte_order:1;
	unsigned int base;		/* 2, 8, 10, 16, for pretty print */
	enum lttng_string_encodings encoding;
	char padding[LTTNG_UST_INTEGER_TYPE_PADDING];
};

/*
 * Only float and double are supported. long double is not supported at
 * the moment.
 */
#define _float_mant_dig(_type)						\
	(sizeof(_type) == sizeof(float) ? FLT_MANT_DIG			\
		: (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG	\
		: 0))

#define __type_float(_type)						\
	{								\
		.atype = atype_float,					\
		.u = {							\
			._float = {					\
				.exp_dig = sizeof(_type) * CHAR_BIT	\
					- _float_mant_dig(_type),	\
				.mant_dig = _float_mant_dig(_type),	\
				.alignment = lttng_alignof(_type) * CHAR_BIT, \
				.reverse_byte_order = BYTE_ORDER != FLOAT_WORD_ORDER,	\
			}						\
		}							\
	}								\

#define LTTNG_UST_FLOAT_TYPE_PADDING	24
struct lttng_float_type {
	unsigned int exp_dig;		/* exponent digits, in bits */
	unsigned int mant_dig;		/* mantissa digits, in bits */
	unsigned short alignment;	/* in bits */
	unsigned int reverse_byte_order:1;
	char padding[LTTNG_UST_FLOAT_TYPE_PADDING];
};

#define LTTNG_UST_TYPE_PADDING	128
struct lttng_type {
	enum lttng_abstract_types atype;
	union {
		/* provider ABI 2.0 */
		struct lttng_integer_type integer;
		struct lttng_float_type _float;
		struct {
			enum lttng_string_encodings encoding;
		} string;
		struct {
			const struct lttng_ust_enum_desc *desc;	/* Enumeration mapping */
			struct lttng_type *container_type;
		} enum_nestable;
		struct {
			const struct lttng_type *elem_type;
			unsigned int length;			/* Num. elems. */
			unsigned int alignment;
		} array_nestable;
		struct {
			const char *length_name;		/* Length field name. */
			const struct lttng_type *elem_type;
			unsigned int alignment;			/* Alignment before elements. */
		} sequence_nestable;
		struct {
			unsigned int nr_fields;
			const struct lttng_ust_event_field **fields; /* Array of pointers to fields. */
			unsigned int alignment;
		} struct_nestable;

		char padding[LTTNG_UST_TYPE_PADDING];
	} u;
};

/*
 * Enumeration description
 *
 * IMPORTANT: this structure is part of the ABI between the probe and
 * UST. Fields need to be only added at the end, never reordered, never
 * removed.
 *
 * The field @struct_size should be used to determine the size of the
 * structure. It should be queried before using additional fields added
 * at the end of the structure.
 */

struct lttng_ust_enum_desc {
	uint32_t struct_size;

	const char *name;
	const struct lttng_ust_enum_entry **entries;
	unsigned int nr_entries;

	/* End of base ABI. Fields below should be used after checking struct_size. */
};

/*
 * Event field description
 *
 * IMPORTANT: this structure is part of the ABI between the probe and
 * UST. Fields need to be only added at the end, never reordered, never
 * removed.
 *
 * The field @struct_size should be used to determine the size of the
 * structure. It should be queried before using additional fields added
 * at the end of the structure.
 */

struct lttng_ust_event_field {
	uint32_t struct_size;

	const char *name;
	struct lttng_type type;
	unsigned int nowrite:1,		/* do not write into trace */
		nofilter:1;		/* do not consider for filter */

	/* End of base ABI. Fields below should be used after checking struct_size. */
};


/*
 * IMPORTANT: this structure is part of the ABI between the probe and
 * UST. Fields need to be only added at the end, never reordered, never
 * removed.
 *
 * The field @struct_size should be used to determine the size of the
 * structure. It should be queried before using additional fields added
 * at the end of the structure.
 */
struct lttng_ust_event_desc {
	uint32_t struct_size;			/* Size of this structure. */

	const char *name;
	void (*probe_callback)(void);
	const struct lttng_event_ctx *ctx;	/* context */
	const struct lttng_ust_event_field **fields;	/* event payload */
	unsigned int nr_fields;
	const int **loglevel;
	const char *signature;			/* Argument types/names received */
	const char **model_emf_uri;

	/* End of base ABI. Fields below should be used after checking struct_size. */
};

/*
 * IMPORTANT: this structure is part of the ABI between the probe and
 * UST. Fields need to be only added at the end, never reordered, never
 * removed.
 *
 * The field @struct_size should be used to determine the size of the
 * structure. It should be queried before using additional fields added
 * at the end of the structure.
 */
struct lttng_ust_probe_desc {
	uint32_t struct_size;			/* Size of this structure. */

	const char *provider;
	const struct lttng_ust_event_desc **event_desc;
	unsigned int nr_events;
	struct cds_list_head head;		/* chain registered probes */
	struct cds_list_head lazy_init_head;
	int lazy;				/* lazy registration */
	uint32_t major;
	uint32_t minor;

	/* End of base ABI. Fields below should be used after checking struct_size. */
};

/* Data structures used by the tracer. */

/*
 * Bytecode interpreter return value masks.
 */
enum lttng_bytecode_interpreter_ret {
	LTTNG_INTERPRETER_DISCARD = 0,
	LTTNG_INTERPRETER_RECORD_FLAG = (1ULL << 0),
	/* Other bits are kept for future use. */
};

struct lttng_interpreter_output;
struct lttng_ust_bytecode_runtime_private;

/*
 * IMPORTANT: this structure is part of the ABI between the probe and
 * UST. Fields need to be only added at the end, never reordered, never
 * removed.
 *
 * The field @struct_size should be used to determine the size of the
 * structure. It should be queried before using additional fields added
 * at the end of the structure.
 */
struct lttng_ust_bytecode_runtime {
	uint32_t struct_size;			/* Size of this structure. */

	struct lttng_ust_bytecode_runtime_private *priv;
	/* Associated bytecode */
	union {
		uint64_t (*filter)(void *interpreter_data,
				const char *interpreter_stack_data);
		uint64_t (*capture)(void *interpreter_data,
				const char *interpreter_stack_data,
				struct lttng_interpreter_output *interpreter_output);
	} interpreter_funcs;
	struct cds_list_head node;	/* list of bytecode runtime in event */

	/* End of base ABI. Fields below should be used after checking struct_size. */
};

/*
 * lttng_event structure is referred to by the tracing fast path. It
 * must be kept small.
 *
 * IMPORTANT: this structure is part of the ABI between the probe and
 * UST. Fields need to be only added at the end, never reordered, never
 * removed.
 */

struct lttng_ust_ctx;
struct lttng_ust_event_common_private;

enum lttng_ust_event_type {
	LTTNG_UST_EVENT_TYPE_RECORDER = 0,
	LTTNG_UST_EVENT_TYPE_NOTIFIER = 1,
};

/*
 * IMPORTANT: this structure is part of the ABI between the probe and
 * UST. Fields need to be only added at the end, never reordered, never
 * removed.
 *
 * struct lttng_ust_event_common is the common ancestor of the various
 * public event actions. Inheritance is done by composition: The parent
 * has a pointer to its child, and the child has a pointer to its
 * parent. Inheritance of those public structures is done by composition
 * to ensure both parent and child structures can be extended.
 *
 * The field @struct_size should be used to determine the size of the
 * structure. It should be queried before using additional fields added
 * at the end of the structure.
 */
struct lttng_ust_event_common {
	uint32_t struct_size;				/* Size of this structure. */

	struct lttng_ust_event_common_private *priv;	/* Private event interface */

	enum lttng_ust_event_type type;
	void *child;					/* Pointer to child, for inheritance by aggregation. */

	int enabled;
	int has_enablers_without_bytecode;
	/* list of struct lttng_ust_bytecode_runtime, sorted by seqnum */
	struct cds_list_head filter_bytecode_runtime_head;

	/* End of base ABI. Fields below should be used after checking struct_size. */
};

struct lttng_ust_event_recorder_private;

/*
 * IMPORTANT: this structure is part of the ABI between the probe and
 * UST. Fields need to be only added at the end, never reordered, never
 * removed.
 *
 * struct lttng_ust_event_recorder is the action for recording events
 * into a ring buffer. It inherits from struct lttng_ust_event_common
 * by composition to ensure both parent and child structure are
 * extensible.
 *
 * The field @struct_size should be used to determine the size of the
 * structure. It should be queried before using additional fields added
 * at the end of the structure.
 */
struct lttng_ust_event_recorder {
	uint32_t struct_size;				/* Size of this structure. */

	struct lttng_ust_event_common *parent;		/* Inheritance by aggregation. */
	struct lttng_ust_event_recorder_private *priv;	/* Private event record interface */

	unsigned int id;
	struct lttng_channel *chan;
	struct lttng_ust_ctx *ctx;

	/* End of base ABI. Fields below should be used after checking struct_size. */
};

struct lttng_ust_event_notifier_private;

/*
 * IMPORTANT: this structure is part of the ABI between the probe and
 * UST. Fields need to be only added at the end, never reordered, never
 * removed.
 *
 * struct lttng_ust_event_notifier is the action for sending
 * notifications. It inherits from struct lttng_ust_event_common
 * by composition to ensure both parent and child structure are
 * extensible.
 *
 * The field @struct_size should be used to determine the size of the
 * structure. It should be queried before using additional fields added
 * at the end of the structure.
 */
struct lttng_ust_event_notifier {
	uint32_t struct_size;				/* Size of this structure. */

	struct lttng_ust_event_common *parent;		/* Inheritance by aggregation. */
	struct lttng_ust_event_notifier_private *priv;	/* Private event notifier interface */

	void (*notification_send)(struct lttng_ust_event_notifier *event_notifier,
		const char *stack_data);
	struct cds_list_head capture_bytecode_runtime_head;

	/* End of base ABI. Fields below should be used after checking struct_size. */
};

struct lttng_ust_lib_ring_buffer_channel;
struct lttng_ust_shm_handle;

/*
 * IMPORTANT: this structure is part of the ABI between the probe and
 * UST. Fields need to be only added at the end, never reordered, never
 * removed.
 *
 * The field @struct_size should be used to determine the size of the
 * structure. It should be queried before using additional fields added
 * at the end of the structure.
 */
struct lttng_ust_channel_ops {
	uint32_t struct_size;

	struct lttng_channel *(*channel_create)(const char *name,
			void *buf_addr,
			size_t subbuf_size, size_t num_subbuf,
			unsigned int switch_timer_interval,
			unsigned int read_timer_interval,
			unsigned char *uuid,
			uint32_t chan_id,
			const int *stream_fds, int nr_stream_fds,
			int64_t blocking_timeout);
	void (*channel_destroy)(struct lttng_channel *chan);
	int (*event_reserve)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
			     uint32_t event_id);
	void (*event_commit)(struct lttng_ust_lib_ring_buffer_ctx *ctx);
	void (*event_write)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
			const void *src, size_t len);
	/*
	 * packet_avail_size returns the available size in the current
	 * packet. Note that the size returned is only a hint, since it
	 * may change due to concurrent writes.
	 */
	size_t (*packet_avail_size)(struct lttng_ust_lib_ring_buffer_channel *chan,
				    struct lttng_ust_shm_handle *handle);
	int (*is_finalized)(struct lttng_ust_lib_ring_buffer_channel *chan);
	int (*is_disabled)(struct lttng_ust_lib_ring_buffer_channel *chan);
	int (*flush_buffer)(struct lttng_ust_lib_ring_buffer_channel *chan,
			    struct lttng_ust_shm_handle *handle);
	void (*event_strcpy)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
			const char *src, size_t len);

	/* End of base ABI. Fields below should be used after checking struct_size. */
};

/*
 * IMPORTANT: this structure is part of the ABI between the probe and
 * UST. Fields need to be only added at the end, never reordered, never
 * removed.
 */
struct lttng_channel {
	/*
	 * The pointers located in this private data are NOT safe to be
	 * dereferenced by the consumer. The only operations the
	 * consumer process is designed to be allowed to do is to read
	 * and perform subbuffer flush.
	 */
	struct lttng_ust_lib_ring_buffer_channel *chan; /* Channel buffers */
	int enabled;
	struct lttng_ust_ctx *ctx;
	/* Event ID management */
	struct lttng_session *session;
	int objd;			/* Object associated to channel */
	struct cds_list_head node;	/* Channel list in session */
	const struct lttng_ust_channel_ops *ops;
	int header_type;		/* 0: unset, 1: compact, 2: large */
	struct lttng_ust_shm_handle *handle;	/* shared-memory handle */

	/* Channel ID */
	unsigned int id;
	enum lttng_ust_abi_chan_type type;
	unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */
	int tstate:1;			/* Transient enable state */
};

/*
 * IMPORTANT: this structure is part of the ABI between the probe and
 * UST. Fields need to be only added at the end, never reordered, never
 * removed.
 *
 * The field @struct_size should be used to determine the size of the
 * structure. It should be queried before using additional fields added
 * at the end of the structure.
 */
struct lttng_ust_stack_ctx {
	uint32_t struct_size;			/* Size of this structure */

	struct lttng_ust_event_recorder *event_recorder;
	struct lttng_ust_ctx *chan_ctx;	/* RCU dereferenced. */
	struct lttng_ust_ctx *event_ctx;	/* RCU dereferenced. */

	/* End of base ABI. Fields below should be used after checking struct_size. */
};

struct lttng_ust_session_private;

/*
 * IMPORTANT: this structure is part of the ABI between the probe and
 * UST. Fields need to be only added at the end, never reordered, never
 * removed.
 *
 * The field @struct_size should be used to determine the size of the
 * structure. It should be queried before using additional fields added
 * at the end of the structure.
 */
struct lttng_session {
	uint32_t struct_size;			/* Size of this structure */

	struct lttng_ust_session_private *priv;	/* Private session interface */

	int active;				/* Is trace session active ? */

	/* End of base ABI. Fields below should be used after checking struct_size. */
};

int lttng_ust_probe_register(struct lttng_ust_probe_desc *desc);
void lttng_ust_probe_unregister(struct lttng_ust_probe_desc *desc);

/*
 * Applications that change their procname and need the new value to be
 * reflected in the procname event context have to call this function to clear
 * the internally cached value. This should not be called from a signal
 * handler.
 */
void lttng_ust_context_procname_reset(void);

#ifdef __cplusplus
}
#endif

#endif /* _LTTNG_UST_EVENTS_H */