-#ifndef _LTTNG_UST_EVENTS_H
-#define _LTTNG_UST_EVENTS_H
-
/*
- * lttng/ust-events.h
+ * SPDX-License-Identifier: MIT
*
- * Copyright 2010-2012 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
*
* Holds LTTng per-session event registry.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
*/
-#include <urcu/list.h>
-#include <urcu/hlist.h>
-#include <uuid/uuid.h>
+#ifndef _LTTNG_UST_EVENTS_H
+#define _LTTNG_UST_EVENTS_H
+
+#include <stddef.h>
#include <stdint.h>
#include <lttng/ust-abi.h>
#include <lttng/ust-tracer.h>
-#include <endian.h>
+#include <lttng/ust-endian.h>
#include <float.h>
+#include <errno.h>
+#include <urcu/ref.h>
+#include <pthread.h>
+#include <limits.h>
-struct ltt_channel;
-struct ltt_session;
-struct lttng_ust_lib_ring_buffer_ctx;
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#define LTTNG_UST_UUID_LEN 16
/*
- * Data structures used by tracepoint event declarations, and by the
- * tracer. Those structures have padding for future extension.
+ * 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_ust_channel_buffer;
+struct lttng_ust_session;
+struct lttng_ust_ring_buffer_ctx;
+struct lttng_ust_event_field;
+struct lttng_ust_registered_probe;
/*
- * LTTng client type enumeration. Used by the consumer to map the
- * callbacks from its own address space.
+ * Data structures used by tracepoint event declarations, and by the
+ * tracer.
*/
-enum lttng_client_types {
- LTTNG_CLIENT_METADATA = 0,
- LTTNG_CLIENT_DISCARD = 1,
- LTTNG_CLIENT_OVERWRITE = 2,
- LTTNG_NR_CLIENT_TYPES,
-};
/* Type description */
-/* Update the astract_types name table in lttng-types.c along with this enum */
-enum abstract_types {
- atype_integer,
- atype_enum,
- atype_array,
- atype_sequence,
- atype_string,
- atype_float,
- NR_ABSTRACT_TYPES,
+enum lttng_ust_type {
+ lttng_ust_type_integer,
+ lttng_ust_type_string,
+ lttng_ust_type_float,
+ lttng_ust_type_dynamic,
+ lttng_ust_type_enum,
+ lttng_ust_type_array,
+ lttng_ust_type_sequence,
+ lttng_ust_type_struct,
+ NR_LTTNG_UST_TYPE,
};
-/* 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,
+enum lttng_ust_string_encoding {
+ lttng_ust_string_encoding_none = 0,
+ lttng_ust_string_encoding_UTF8 = 1,
+ lttng_ust_string_encoding_ASCII = 2,
+ NR_LTTNG_UST_STRING_ENCODING,
};
-#define LTTNG_UST_ENUM_ENTRY_PADDING 16
-struct lttng_enum_entry {
- unsigned long long start, end; /* start and end are inclusive */
+struct lttng_ust_enum_value {
+ unsigned long long value;
+ unsigned int signedness:1;
+};
+
+enum lttng_ust_enum_entry_option {
+ LTTNG_UST_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_ust_enum_value start, end; /* start and end are inclusive */
const char *string;
- char padding[LTTNG_UST_ENUM_ENTRY_PADDING];
+ unsigned int options;
+
+ /* End of base ABI. Fields below should be used after checking struct_size. */
+};
+
+/*
+ * struct lttng_ust_type_common is fixed-size. Its children inherits
+ * from it by embedding struct lttng_ust_type_common as its first field.
+ */
+struct lttng_ust_type_common {
+ enum lttng_ust_type type;
};
-#define __type_integer(_type, _byte_order, _base, _encoding) \
- { \
- .atype = atype_integer, \
- .u.basic.integer = \
- { \
- .size = sizeof(_type) * CHAR_BIT, \
- .alignment = lttng_alignof(_type) * CHAR_BIT, \
- .signedness = lttng_is_signed_type(_type), \
- .reverse_byte_order = _byte_order != __BYTE_ORDER, \
- .base = _base, \
- .encoding = lttng_encode_##_encoding, \
- }, \
- } \
-
-#define LTTNG_UST_INTEGER_TYPE_PADDING 24
-struct lttng_integer_type {
+struct lttng_ust_type_integer {
+ struct lttng_ust_type_common parent;
+ uint32_t struct_size;
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];
+};
+
+#define lttng_ust_type_integer_define(_type, _byte_order, _base) \
+ ((struct lttng_ust_type_common *) LTTNG_UST_COMPOUND_LITERAL(struct lttng_ust_type_integer, { \
+ .parent = { \
+ .type = lttng_ust_type_integer, \
+ }, \
+ .struct_size = sizeof(struct lttng_ust_type_integer), \
+ .size = sizeof(_type) * CHAR_BIT, \
+ .alignment = lttng_ust_rb_alignof(_type) * CHAR_BIT, \
+ .signedness = lttng_ust_is_signed_type(_type), \
+ .reverse_byte_order = _byte_order != LTTNG_UST_BYTE_ORDER, \
+ .base = _base, \
+ }))
+
+struct lttng_ust_type_float {
+ struct lttng_ust_type_common parent;
+ uint32_t struct_size;
+ 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;
};
/*
* Only float and double are supported. long double is not supported at
* the moment.
*/
-#define _float_mant_dig(_type) \
+#define lttng_ust_float_mant_dig(_type) \
(sizeof(_type) == sizeof(float) ? FLT_MANT_DIG \
: (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG \
: 0))
-#define __type_float(_type) \
- { \
- .atype = atype_float, \
- .u.basic._float = \
- { \
- .exp_dig = sizeof(_type) * CHAR_BIT \
- - _float_mant_dig(_type), \
- .mant_dig = _float_mant_dig(_type), \
- .alignment = lttng_alignof(_type) * CHAR_BIT, \
- .reverse_byte_order = __BYTE_ORDER != __FLOAT_WORD_ORDER, \
- }, \
- } \
-
-#define LTTNG_UST_FLOAT_TYPE_PADDING 24
-struct lttng_float_type {
- unsigned int exp_dig; /* exponent digits, in bits */
- unsigned int mant_dig; /* mantissa digits, in bits */
- unsigned short alignment; /* in bits */
- unsigned int reverse_byte_order:1;
- char padding[LTTNG_UST_FLOAT_TYPE_PADDING];
+#define lttng_ust_type_float_define(_type) \
+ ((struct lttng_ust_type_common *) LTTNG_UST_COMPOUND_LITERAL(struct lttng_ust_type_float, { \
+ .parent = { \
+ .type = lttng_ust_type_float, \
+ }, \
+ .struct_size = sizeof(struct lttng_ust_type_float), \
+ .exp_dig = sizeof(_type) * CHAR_BIT \
+ - lttng_ust_float_mant_dig(_type), \
+ .mant_dig = lttng_ust_float_mant_dig(_type), \
+ .alignment = lttng_ust_rb_alignof(_type) * CHAR_BIT, \
+ .reverse_byte_order = LTTNG_UST_BYTE_ORDER != LTTNG_UST_FLOAT_WORD_ORDER, \
+ }))
+
+
+struct lttng_ust_type_string {
+ struct lttng_ust_type_common parent;
+ uint32_t struct_size;
+ enum lttng_ust_string_encoding encoding;
};
-#define LTTNG_UST_BASIC_TYPE_PADDING 128
-union _lttng_basic_type {
- struct lttng_integer_type integer;
- struct {
- const char *name;
- } enumeration;
- struct {
- enum lttng_string_encodings encoding;
- } string;
- struct lttng_float_type _float;
- char padding[LTTNG_UST_BASIC_TYPE_PADDING];
+struct lttng_ust_type_enum {
+ struct lttng_ust_type_common parent;
+ uint32_t struct_size;
+ const struct lttng_ust_enum_desc *desc; /* Enumeration mapping */
+ const struct lttng_ust_type_common *container_type;
};
-struct lttng_basic_type {
- enum abstract_types atype;
- union {
- union _lttng_basic_type basic;
- } u;
+/*
+ * The alignment field in structure, array, and sequence types is a
+ * minimum alignment requirement. The actual alignment of a type may be
+ * larger than this explicit alignment value if its nested types have a
+ * larger alignment.
+ */
+
+struct lttng_ust_type_array {
+ struct lttng_ust_type_common parent;
+ uint32_t struct_size;
+ const struct lttng_ust_type_common *elem_type;
+ unsigned int length; /* Num. elems. */
+ unsigned int alignment; /* Minimum alignment for this type. */
+ enum lttng_ust_string_encoding encoding;
};
-#define LTTNG_UST_TYPE_PADDING 128
-struct lttng_type {
- enum abstract_types atype;
- union {
- union _lttng_basic_type basic;
- struct {
- struct lttng_basic_type elem_type;
- unsigned int length; /* num. elems. */
- } array;
- struct {
- struct lttng_basic_type length_type;
- struct lttng_basic_type elem_type;
- } sequence;
- char padding[LTTNG_UST_TYPE_PADDING];
- } u;
+struct lttng_ust_type_sequence {
+ struct lttng_ust_type_common parent;
+ uint32_t struct_size;
+ const char *length_name; /* Length field name. */
+ const struct lttng_ust_type_common *elem_type;
+ unsigned int alignment; /* Minimum alignment before elements. */
+ enum lttng_ust_string_encoding encoding;
};
-#define LTTNG_UST_ENUM_TYPE_PADDING 24
-struct lttng_enum {
- const char *name;
- struct lttng_type container_type;
- const struct lttng_enum_entry *entries;
- unsigned int len;
- char padding[LTTNG_UST_ENUM_TYPE_PADDING];
+struct lttng_ust_type_struct {
+ struct lttng_ust_type_common parent;
+ uint32_t struct_size;
+ unsigned int nr_fields;
+ const struct lttng_ust_event_field * const *fields; /* Array of pointers to fields. */
+ unsigned int alignment; /* Minimum alignment for this type. */
};
-/* Event field description */
+/*
+ * 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;
-#define LTTNG_UST_EVENT_FIELD_PADDING 32
-struct lttng_event_field {
const char *name;
- struct lttng_type type;
- char padding[LTTNG_UST_EVENT_FIELD_PADDING];
-};
+ const struct lttng_ust_enum_entry * const *entries;
+ unsigned int nr_entries;
-#define LTTNG_UST_CTX_FIELD_PADDING 40
-struct lttng_ctx_field {
- struct lttng_event_field event_field;
- size_t (*get_size)(size_t offset);
- void (*record)(struct lttng_ctx_field *field,
- struct lttng_ust_lib_ring_buffer_ctx *ctx,
- struct ltt_channel *chan);
- union {
- char padding[LTTNG_UST_CTX_FIELD_PADDING];
- } u;
- void (*destroy)(struct lttng_ctx_field *field);
+ /* End of base ABI. Fields below should be used after checking struct_size. */
};
-#define LTTNG_UST_CTX_PADDING 24
-struct lttng_ctx {
- struct lttng_ctx_field *fields;
- unsigned int nr_fields;
- unsigned int allocated_fields;
- char padding[LTTNG_UST_CTX_PADDING];
-};
+/*
+ * 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;
-#define LTTNG_UST_EVENT_DESC_PADDING 40
-struct lttng_event_desc {
const char *name;
- void *probe_callback;
- const struct lttng_event_ctx *ctx; /* context */
- const struct lttng_event_field *fields; /* event payload */
+ const struct lttng_ust_type_common *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 *event_name;
+ const struct lttng_ust_probe_desc *probe_desc;
+ void (*probe_callback)(void);
+ const struct lttng_ust_event_field * const *fields; /* event payload */
unsigned int nr_fields;
const int **loglevel;
- const char *signature; /* Argument types/names received */
- char padding[LTTNG_UST_EVENT_DESC_PADDING];
+ 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. */
};
-#define LTTNG_UST_PROBE_DESC_PADDING 40
-struct lttng_probe_desc {
- const char *provider;
- const struct lttng_event_desc **event_desc;
+/*
+ * 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_name;
+ const struct lttng_ust_event_desc * const *event_desc;
unsigned int nr_events;
- struct cds_list_head head; /* chain registered probes */
- char padding[LTTNG_UST_PROBE_DESC_PADDING];
+ 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. */
/*
- * Entry describing a per-session active wildcard, along with the event
- * attribute and channel information configuring the events that need to
- * be enabled.
+ * 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_event_common_private;
+
+enum lttng_ust_event_type {
+ LTTNG_UST_EVENT_TYPE_RECORDER = 0,
+ LTTNG_UST_EVENT_TYPE_NOTIFIER = 1,
+};
+
+/*
+ * Result of the run_filter() callback.
*/
-struct session_wildcard {
- struct ltt_channel *chan;
- struct lttng_ctx *ctx; /* TODO */
- struct lttng_ust_event event_param;
- struct cds_list_head events; /* list of events enabled */
- struct cds_list_head list; /* per-session list of wildcards */
- struct cds_list_head session_list; /* node of session wildcard list */
- struct wildcard_entry *entry;
- unsigned int enabled:1;
+enum lttng_ust_event_filter_result {
+ LTTNG_UST_EVENT_FILTER_ACCEPT = 0,
+ LTTNG_UST_EVENT_FILTER_REJECT = 1,
};
/*
- * Entry describing an active wildcard (per name) for all sessions.
+ * 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 wildcard_entry {
- /* node of global wildcards list */
- struct cds_list_head list;
- /* head of session list to which this wildcard apply */
- struct cds_list_head session_list;
- enum lttng_ust_loglevel_type loglevel_type;
- int loglevel;
- char name[0];
+struct 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 eval_filter; /* Need to evaluate filters */
+ int (*run_filter)(const struct lttng_ust_event_common *event,
+ const char *stack_data,
+ void *filter_ctx);
+
+ /* End of base ABI. Fields below should be used after checking struct_size. */
};
-struct tp_list_entry {
- struct lttng_ust_tracepoint_iter tp;
- struct cds_list_head head;
+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 */
+
+ struct lttng_ust_channel_buffer *chan;
+
+ /* End of base ABI. Fields below should be used after checking struct_size. */
};
-struct lttng_ust_tracepoint_list {
- struct tp_list_entry *iter;
- struct cds_list_head head;
+/*
+ * 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_notification_ctx {
+ uint32_t struct_size; /* Size of this structure. */
+ int eval_capture; /* Capture evaluation available. */
+
+ /* End of base ABI. Fields below should be used after checking struct_size. */
};
-struct ust_pending_probe;
+struct lttng_ust_event_notifier_private;
/*
- * ltt_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_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 ltt_event {
- unsigned int id;
- struct ltt_channel *chan;
- int enabled;
- const struct lttng_event_desc *desc;
- void *filter;
- struct lttng_ctx *ctx;
- enum lttng_ust_instrumentation instrumentation;
- union {
- } u;
- struct cds_list_head list; /* Event list */
- struct cds_list_head wildcard_list; /* Event list for wildcard */
- struct ust_pending_probe *pending_probe;
- unsigned int metadata_dumped:1;
+struct 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 */
+
+ int eval_capture; /* Need to evaluate capture */
+ void (*notification_send)(const struct lttng_ust_event_notifier *event_notifier,
+ const char *stack_data,
+ struct lttng_ust_notification_ctx *notif_ctx);
+
+ /* End of base ABI. Fields below should be used after checking struct_size. */
+};
+
+struct lttng_ust_ring_buffer_channel;
+struct lttng_ust_channel_buffer_ops_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_channel_buffer_ops {
+ uint32_t struct_size;
+
+ struct lttng_ust_channel_buffer_ops_private *priv; /* Private channel buffer ops interface */
+
+ int (*event_reserve)(struct lttng_ust_ring_buffer_ctx *ctx);
+ void (*event_commit)(struct lttng_ust_ring_buffer_ctx *ctx);
+ void (*event_write)(struct lttng_ust_ring_buffer_ctx *ctx,
+ const void *src, size_t len, size_t alignment);
+ void (*event_strcpy)(struct lttng_ust_ring_buffer_ctx *ctx,
+ const char *src, size_t len);
+ void (*event_pstrcpy_pad)(struct lttng_ust_ring_buffer_ctx *ctx,
+ const char *src, size_t len);
+
+ /* End of base ABI. Fields below should be used after checking struct_size. */
};
-struct channel;
-struct lttng_ust_shm_handle;
-
-struct ltt_channel_ops {
- struct ltt_channel *(*channel_create)(const char *name,
- void *buf_addr,
- size_t subbuf_size, size_t num_subbuf,
- unsigned int switch_timer_interval,
- unsigned int read_timer_interval,
- int **shm_fd, int **wait_fd,
- uint64_t **memory_map_size,
- struct ltt_channel *chan_priv_init);
- void (*channel_destroy)(struct ltt_channel *ltt_chan);
- struct lttng_ust_lib_ring_buffer *(*buffer_read_open)(struct channel *chan,
- struct lttng_ust_shm_handle *handle,
- int **shm_fd, int **wait_fd,
- uint64_t **memory_map_size);
- void (*buffer_read_close)(struct lttng_ust_lib_ring_buffer *buf,
- struct lttng_ust_shm_handle *handle);
- int (*event_reserve)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
- uint32_t event_id);
- void (*event_commit)(struct lttng_ust_lib_ring_buffer_ctx *ctx);
- void (*event_write)(struct lttng_ust_lib_ring_buffer_ctx *ctx, const void *src,
- size_t len);
- /*
- * packet_avail_size returns the available size in the current
- * packet. Note that the size returned is only a hint, since it
- * may change due to concurrent writes.
- */
- size_t (*packet_avail_size)(struct channel *chan,
- struct lttng_ust_shm_handle *handle);
- //wait_queue_head_t *(*get_reader_wait_queue)(struct channel *chan);
- //wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
- int (*is_finalized)(struct channel *chan);
- int (*is_disabled)(struct channel *chan);
- int (*flush_buffer)(struct channel *chan, struct lttng_ust_shm_handle *handle);
+enum lttng_ust_channel_type {
+ LTTNG_UST_CHANNEL_TYPE_BUFFER = 0,
};
-struct ltt_channel {
- /*
- * The pointers located in this private data are NOT safe to be
- * dereferenced by the consumer. The only operations the
- * consumer process is designed to be allowed to do is to read
- * and perform subbuffer flush.
- */
- struct channel *chan; /* Channel buffers */
+struct lttng_ust_channel_common_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_channel_common {
+ uint32_t struct_size; /* Size of this structure. */
+
+ struct lttng_ust_channel_common_private *priv; /* Private channel interface */
+
+ enum lttng_ust_channel_type type;
+ void *child; /* Pointer to child, for inheritance by aggregation. */
+
int enabled;
- struct lttng_ctx *ctx;
- /* Event ID management */
- struct ltt_session *session;
- int objd; /* Object associated to channel */
- unsigned int free_event_id; /* Next event ID to allocate */
- unsigned int used_event_id; /* Max allocated event IDs */
- struct cds_list_head list; /* Channel list */
- struct ltt_channel_ops *ops;
- int header_type; /* 0: unset, 1: compact, 2: large */
- struct lttng_ust_shm_handle *handle; /* shared-memory handle */
- unsigned int metadata_dumped:1;
-
- /* Channel ID, available for consumer too */
- unsigned int id;
- /* Copy of session UUID for consumer (availability through shm) */
- uuid_t uuid; /* Trace session unique ID */
+ struct lttng_ust_session *session;
+
+ /* End of base ABI. Fields below should be used after checking struct_size. */
};
-struct ltt_session {
- int active; /* Is trace session active ? */
- int been_active; /* Has trace session been active ? */
- int objd; /* Object associated to session */
- struct ltt_channel *metadata; /* Metadata channel */
- struct cds_list_head chan; /* Channel list head */
- struct cds_list_head events; /* Event list head */
- struct cds_list_head wildcards; /* Wildcard list head */
- struct cds_list_head list; /* Session list */
- unsigned int free_chan_id; /* Next chan ID to allocate */
- uuid_t uuid; /* Trace session unique ID */
- unsigned int metadata_dumped:1;
+struct lttng_ust_channel_buffer_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_channel_buffer {
+ uint32_t struct_size; /* Size of this structure. */
+
+ struct lttng_ust_channel_common *parent; /* Inheritance by aggregation. */
+ struct lttng_ust_channel_buffer_private *priv; /* Private channel buffer interface */
+
+ struct lttng_ust_channel_buffer_ops *ops;
+
+ /* End of base ABI. Fields below should be used after checking struct_size. */
};
-struct ltt_transport {
- char *name;
- struct cds_list_head node;
- struct ltt_channel_ops ops;
+/*
+ * 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;
+
+ /* 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_ust_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. */
};
-struct ltt_session *ltt_session_create(void);
-int ltt_session_enable(struct ltt_session *session);
-int ltt_session_disable(struct ltt_session *session);
-void ltt_session_destroy(struct ltt_session *session);
-
-struct ltt_channel *ltt_channel_create(struct ltt_session *session,
- const char *transport_name,
- void *buf_addr,
- size_t subbuf_size, size_t num_subbuf,
- unsigned int switch_timer_interval,
- unsigned int read_timer_interval,
- int **shm_fd, int **wait_fd,
- uint64_t **memory_map_size,
- struct ltt_channel *chan_priv_init);
-struct ltt_channel *ltt_global_channel_create(struct ltt_session *session,
- int overwrite, void *buf_addr,
- size_t subbuf_size, size_t num_subbuf,
- unsigned int switch_timer_interval,
- unsigned int read_timer_interval,
- int **shm_fd, int **wait_fd,
- uint64_t **memory_map_size);
-
-int ltt_event_create(struct ltt_channel *chan,
- struct lttng_ust_event *event_param,
- void *filter,
- struct ltt_event **event);
-
-int ltt_channel_enable(struct ltt_channel *channel);
-int ltt_channel_disable(struct ltt_channel *channel);
-int ltt_event_enable(struct ltt_event *event);
-int ltt_event_disable(struct ltt_event *event);
-
-void ltt_transport_register(struct ltt_transport *transport);
-void ltt_transport_unregister(struct ltt_transport *transport);
-
-void synchronize_trace(void);
-
-int ltt_probe_register(struct lttng_probe_desc *desc);
-void ltt_probe_unregister(struct lttng_probe_desc *desc);
-int pending_probe_fix_events(const struct lttng_event_desc *desc);
-const struct lttng_event_desc *ltt_event_get(const char *name);
-void ltt_event_put(const struct lttng_event_desc *desc);
-int ltt_probes_init(void);
-void ltt_probes_exit(void);
-int lttng_find_context(struct lttng_ctx *ctx, const char *name);
-struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx_p);
-void lttng_remove_context_field(struct lttng_ctx **ctx_p,
- struct lttng_ctx_field *field);
-void lttng_destroy_context(struct lttng_ctx *ctx);
-int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx);
-int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx);
-int lttng_add_pthread_id_to_ctx(struct lttng_ctx **ctx);
-int lttng_add_procname_to_ctx(struct lttng_ctx **ctx);
-void lttng_context_vtid_reset(void);
-void lttng_context_vpid_reset(void);
-
-const struct lttng_ust_lib_ring_buffer_client_cb *lttng_client_callbacks_metadata;
-const struct lttng_ust_lib_ring_buffer_client_cb *lttng_client_callbacks_discard;
-const struct lttng_ust_lib_ring_buffer_client_cb *lttng_client_callbacks_overwrite;
-
-struct ltt_transport *ltt_transport_find(const char *name);
-
-int ltt_probes_get_event_list(struct lttng_ust_tracepoint_list *list);
-void ltt_probes_prune_event_list(struct lttng_ust_tracepoint_list *list);
-struct lttng_ust_tracepoint_iter *
- lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list *list);
-
-int ltt_wildcard_enable(struct session_wildcard *wildcard);
-int ltt_wildcard_disable(struct session_wildcard *wildcard);
-int ltt_wildcard_create(struct ltt_channel *chan,
- struct lttng_ust_event *event_param,
- struct session_wildcard **sl);
-int ltt_loglevel_match(const struct lttng_event_desc *desc,
- enum lttng_ust_loglevel_type req_type,
- int req_loglevel);
-void ltt_probes_create_wildcard_events(struct wildcard_entry *entry,
- struct session_wildcard *wildcard);
+/*
+ * On successful registration of a probe, a pointer to an opaque
+ * structure is returned. This pointer should be passed to
+ * lttng_ust_probe_unregister for unregistration.
+ * lttng_ust_probe_register returns NULL on error.
+ */
+struct lttng_ust_registered_probe *lttng_ust_probe_register(const struct lttng_ust_probe_desc *desc);
+
+void lttng_ust_probe_unregister(struct lttng_ust_registered_probe *reg_probe);
+
+/*
+ * 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 */
projects / lttng-ust.git / blobdiff