X-Git-Url: http://git.lttng.org./?a=blobdiff_plain;f=include%2Flttng%2Fust-events.h;h=650784272ac3618abc03f930791b47c79ea16f25;hb=06e646e04714e0e0f7537841107ab0528ef33a52;hp=acea99105a86492646723732f930cc8fe250ab85;hpb=25cff019d711338b8a7efe1cc54e4b1870157348;p=lttng-ust.git

diff --git a/include/lttng/ust-events.h b/include/lttng/ust-events.h
index acea9910..65078427 100644
--- a/include/lttng/ust-events.h
+++ b/include/lttng/ust-events.h
@@ -83,16 +83,26 @@ enum lttng_enum_entry_options {
 	LTTNG_ENUM_ENTRY_OPTION_IS_AUTO = 1U << 0,
 };
 
-#define LTTNG_UST_ENUM_ENTRY_PADDING	16
-struct lttng_enum_entry {
+/*
+ * 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;
-	union {
-		struct {
-			unsigned int options;
-		} LTTNG_PACKED extra;
-		char padding[LTTNG_UST_ENUM_ENTRY_PADDING];
-	} u;
+	unsigned int options;
+
+	/* End of base ABI. Fields below should be used after checking struct_size. */
 };
 
 #define __type_integer(_type, _byte_order, _base, _encoding)	\
@@ -168,7 +178,7 @@ struct lttng_type {
 			enum lttng_string_encodings encoding;
 		} string;
 		struct {
-			const struct lttng_enum_desc *desc;	/* Enumeration mapping */
+			const struct lttng_ust_enum_desc *desc;	/* Enumeration mapping */
 			struct lttng_type *container_type;
 		} enum_nestable;
 		struct {
@@ -191,12 +201,26 @@ struct lttng_type {
 	} u;
 };
 
-#define LTTNG_UST_ENUM_TYPE_PADDING	24
-struct lttng_enum_desc {
+/*
+ * 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_enum_entry *entries;
+	const struct lttng_ust_enum_entry **entries;
 	unsigned int nr_entries;
-	char padding[LTTNG_UST_ENUM_TYPE_PADDING];
+
+	/* End of base ABI. Fields below should be used after checking struct_size. */
 };
 
 /*
@@ -222,59 +246,6 @@ struct lttng_ust_event_field {
 	/* End of base ABI. Fields below should be used after checking struct_size. */
 };
 
-enum lttng_ust_dynamic_type {
-	LTTNG_UST_DYNAMIC_TYPE_NONE,
-	LTTNG_UST_DYNAMIC_TYPE_S8,
-	LTTNG_UST_DYNAMIC_TYPE_S16,
-	LTTNG_UST_DYNAMIC_TYPE_S32,
-	LTTNG_UST_DYNAMIC_TYPE_S64,
-	LTTNG_UST_DYNAMIC_TYPE_U8,
-	LTTNG_UST_DYNAMIC_TYPE_U16,
-	LTTNG_UST_DYNAMIC_TYPE_U32,
-	LTTNG_UST_DYNAMIC_TYPE_U64,
-	LTTNG_UST_DYNAMIC_TYPE_FLOAT,
-	LTTNG_UST_DYNAMIC_TYPE_DOUBLE,
-	LTTNG_UST_DYNAMIC_TYPE_STRING,
-	_NR_LTTNG_UST_DYNAMIC_TYPES,
-};
-
-struct lttng_ctx_value {
-	enum lttng_ust_dynamic_type sel;
-	union {
-		int64_t s64;
-		uint64_t u64;
-		const char *str;
-		double d;
-	} u;
-};
-
-struct lttng_perf_counter_field;
-
-#define LTTNG_UST_CTX_FIELD_PADDING	40
-struct lttng_ctx_field {
-	struct lttng_ust_event_field event_field;
-	size_t (*get_size)(struct lttng_ctx_field *field, size_t offset);
-	void (*record)(struct lttng_ctx_field *field,
-		       struct lttng_ust_lib_ring_buffer_ctx *ctx,
-		       struct lttng_channel *chan);
-	void (*get_value)(struct lttng_ctx_field *field,
-			 struct lttng_ctx_value *value);
-	union {
-		struct lttng_perf_counter_field *perf_counter;
-		char padding[LTTNG_UST_CTX_FIELD_PADDING];
-	} u;
-	void (*destroy)(struct lttng_ctx_field *field);
-	char *field_name;	/* Has ownership, dynamically allocated. */
-};
-
-#define LTTNG_UST_CTX_PADDING	20
-struct lttng_ctx {
-	struct lttng_ctx_field *fields;
-	unsigned int nr_fields;
-	unsigned int allocated_fields;
-	unsigned int largest_align;
-	char padding[LTTNG_UST_CTX_PADDING];
-};
 
 /*
  * IMPORTANT: this structure is part of the ABI between the probe and
@@ -338,14 +309,18 @@ struct lttng_interpreter_output;
 struct lttng_ust_bytecode_runtime_private;
 
 /*
- * This structure is used in the probes. More specifically, the
- * `interpreter_funcs` and `node` fields are explicity used in the
- * probes. When modifying this structure we must not change the layout
- * of these two fields as it is considered ABI.
+ * 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_bytecode_runtime {
-	struct lttng_ust_bytecode_runtime_private *priv;
+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,
@@ -355,6 +330,8 @@ struct lttng_bytecode_runtime {
 				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. */
 };
 
 /*
@@ -366,6 +343,7 @@ struct lttng_bytecode_runtime {
  * removed.
  */
 
+struct lttng_ctx;
 struct lttng_ust_event_common_private;
 
 enum lttng_ust_event_type {
@@ -397,7 +375,7 @@ struct lttng_ust_event_common {
 
 	int enabled;
 	int has_enablers_without_bytecode;
-	/* list of struct lttng_bytecode_runtime, sorted by seqnum */
+	/* 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. */
@@ -449,6 +427,7 @@ struct lttng_ust_event_notifier_private;
  */
 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 */
 
@@ -459,23 +438,21 @@ struct lttng_ust_event_notifier {
 	/* End of base ABI. Fields below should be used after checking struct_size. */
 };
 
-struct lttng_enum {
-	const struct lttng_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 */
-};
-
-struct channel;
+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_channel_ops {
+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,
@@ -496,13 +473,16 @@ struct lttng_channel_ops {
 	 * 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,
+	size_t (*packet_avail_size)(struct lttng_ust_lib_ring_buffer_channel *chan,
 				    struct lttng_ust_shm_handle *handle);
-	int (*is_finalized)(struct channel *chan);
-	int (*is_disabled)(struct channel *chan);
-	int (*flush_buffer)(struct 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. */
 };
 
 /*
@@ -517,14 +497,14 @@ struct lttng_channel {
 	 * consumer process is designed to be allowed to do is to read
 	 * and perform subbuffer flush.
 	 */
-	struct channel *chan;		/* Channel buffers */
+	struct lttng_ust_lib_ring_buffer_channel *chan; /* Channel buffers */
 	int enabled;
 	struct lttng_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_channel_ops *ops;
+	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 */
 
@@ -535,54 +515,23 @@ struct lttng_channel {
 	int tstate:1;			/* Transient enable state */
 };
 
-struct lttng_counter_dimension;
-
-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);
-};
+/*
+ * 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 */
 
-#define LTTNG_UST_STACK_CTX_PADDING	32
-struct lttng_stack_ctx {
 	struct lttng_ust_event_recorder *event_recorder;
 	struct lttng_ctx *chan_ctx;	/* RCU dereferenced. */
 	struct lttng_ctx *event_ctx;	/* RCU dereferenced. */
-	char padding[LTTNG_UST_STACK_CTX_PADDING];
-};
-
-#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];
+	/* End of base ABI. Fields below should be used after checking struct_size. */
 };
 
 struct lttng_ust_session_private;
@@ -609,15 +558,12 @@ int lttng_ust_probe_register(struct lttng_ust_probe_desc *desc);
 void lttng_ust_probe_unregister(struct lttng_ust_probe_desc *desc);
 
 /*
- * Can be used by applications that change their procname to clear the ust cached value.
+ * 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_context_procname_reset(void);
-
-struct lttng_transport *lttng_transport_find(const char *name);
-
-int lttng_session_active(void);
-
-void lttng_ust_dl_update(void *ip);
+void lttng_ust_context_procname_reset(void);
 
 #ifdef __cplusplus
 }