Cleanup: align private header comments
[lttng-ust.git] / liblttng-ust / ust-events-internal.h
index e568d5ee352a81aa8af0658c4fc12062f54e54fb..ec409457deb8f27086f8518b218865c029337bcc 100644 (file)
 
 #include <lttng/ust-events.h>
 
+#include <ust-helper.h>
 #include "ust-context-provider.h"
 
 struct lttng_ust_abi_obj;
+struct lttng_event_notifier_group;
 
 union lttng_ust_abi_args {
        struct {
@@ -74,7 +76,7 @@ struct lttng_enabler {
 struct lttng_event_enabler {
        struct lttng_enabler base;
        struct cds_list_head node;      /* per-session list of enablers */
-       struct lttng_channel *chan;
+       struct lttng_ust_channel_buffer *chan;
        /*
         * Unused, but kept around to make it explicit that the tracer can do
         * it.
@@ -92,13 +94,13 @@ struct lttng_event_notifier_enabler {
        uint64_t num_captures;
 };
 
-enum lttng_ust_bytecode_node_type {
-       LTTNG_UST_BYTECODE_NODE_TYPE_FILTER,
-       LTTNG_UST_BYTECODE_NODE_TYPE_CAPTURE,
+enum lttng_ust_bytecode_type {
+       LTTNG_UST_BYTECODE_TYPE_FILTER,
+       LTTNG_UST_BYTECODE_TYPE_CAPTURE,
 };
 
 struct lttng_ust_bytecode_node {
-       enum lttng_ust_bytecode_node_type type;
+       enum lttng_ust_bytecode_type type;
        struct cds_list_head node;
        struct lttng_enabler *enabler;
        struct  {
@@ -109,6 +111,26 @@ struct lttng_ust_bytecode_node {
        } bc;
 };
 
+/*
+ * Bytecode interpreter return value.
+ */
+enum lttng_ust_bytecode_interpreter_ret {
+       LTTNG_UST_BYTECODE_INTERPRETER_ERROR = -1,
+       LTTNG_UST_BYTECODE_INTERPRETER_OK = 0,
+};
+
+struct lttng_interpreter_output;
+struct lttng_ust_bytecode_runtime_private;
+
+enum lttng_ust_bytecode_filter_result {
+       LTTNG_UST_BYTECODE_FILTER_ACCEPT = 0,
+       LTTNG_UST_BYTECODE_FILTER_REJECT = 1,
+};
+
+struct lttng_ust_bytecode_filter_ctx {
+       enum lttng_ust_bytecode_filter_result result;
+};
+
 struct lttng_ust_excluder_node {
        struct cds_list_head node;
        struct lttng_enabler *enabler;
@@ -218,9 +240,9 @@ struct lttng_event_notifier_group {
        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 cds_list_head event_notifiers_head; /* list of event_notifiers */
        struct lttng_ust_event_notifier_ht event_notifiers_ht; /* hashtable of event_notifiers */
-       struct lttng_ust_ctx *ctx;                      /* contexts for filters. */
+       struct lttng_ust_ctx *ctx;              /* contexts for filters. */
 
        struct lttng_counter *error_counter;
        size_t error_counter_len;
@@ -243,11 +265,15 @@ struct lttng_counter_transport {
 struct lttng_ust_event_common_private {
        struct lttng_ust_event_common *pub;     /* Public event interface */
 
-       const struct lttng_ust_event_desc *desc;
+       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 */
+       int registered;                         /* has reg'd tracepoint probe */
        uint64_t user_token;
+
+       int has_enablers_without_filter_bytecode;
+       /* list of struct lttng_ust_bytecode_runtime, sorted by seqnum */
+       struct cds_list_head filter_bytecode_runtime_head;
 };
 
 struct lttng_ust_event_recorder_private {
@@ -256,6 +282,7 @@ struct lttng_ust_event_recorder_private {
        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_ctx *ctx;
 };
 
 struct lttng_ust_event_notifier_private {
@@ -267,13 +294,18 @@ struct lttng_ust_event_notifier_private {
        uint64_t error_counter_index;
        struct cds_list_head node;              /* Event notifier list */
        struct cds_hlist_node hlist;            /* Hash table of event notifiers */
-};
+       struct cds_list_head capture_bytecode_runtime_head;
 
-struct lttng_ust_bytecode_runtime_private {
-       struct bytecode_runtime *pub;   /* Public bytecode runtime interface */
+};
 
+struct lttng_ust_bytecode_runtime {
+       enum lttng_ust_bytecode_type type;
        struct lttng_ust_bytecode_node *bc;
        int link_failed;
+       int (*interpreter_func)(struct lttng_ust_bytecode_runtime *bytecode_runtime,
+                       const char *interpreter_stack_data,
+                       void *ctx);
+       struct cds_list_head node;              /* list of bytecode runtime in event */
        /*
         * Pointer to a URCU-protected pointer owned by an `struct
         * lttng_session`or `struct lttng_event_notifier_group`.
@@ -282,7 +314,7 @@ struct lttng_ust_bytecode_runtime_private {
 };
 
 struct lttng_ust_session_private {
-       struct lttng_session *pub;              /* Public session interface */
+       struct lttng_ust_session *pub;          /* Public session interface */
 
        int been_active;                        /* Been active ? */
        int objd;                               /* Object associated */
@@ -290,30 +322,258 @@ struct lttng_ust_session_private {
        struct cds_list_head events_head;       /* list of events */
        struct cds_list_head node;              /* Session list */
 
-       /* New UST 2.1 */
        /* List of enablers */
        struct cds_list_head enablers_head;
        struct lttng_ust_event_ht events_ht;    /* ht of events */
        void *owner;                            /* object owner */
        int tstate:1;                           /* Transient enable state */
 
-       /* New UST 2.4 */
        int statedump_pending:1;
 
-       /* New UST 2.8 */
        struct lttng_ust_enum_ht enums_ht;      /* ht of enumerations */
        struct cds_list_head enums_head;
-       struct lttng_ust_ctx *ctx;                      /* contexts for filters. */
+       struct lttng_ust_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 */
+       struct lttng_ust_enum_desc *desc;
+       struct lttng_ust_session *session;
+       struct cds_list_head node;              /* Enum list in session */
+       struct cds_hlist_node hlist;            /* Session ht of enums */
+       uint64_t id;                            /* Enumeration ID in sessiond */
+};
+
+struct lttng_ust_shm_handle;
+
+struct lttng_ust_channel_ops_private {
+       struct lttng_ust_channel_ops *pub;      /* Public channels ops interface */
+
+       struct lttng_ust_channel_buffer *(*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_ust_channel_buffer *chan);
+       /*
+        * 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);
+};
+
+struct lttng_ust_channel_common_private {
+       struct lttng_ust_channel_common *pub;   /* Public channel interface */
+
+       int objd;                               /* Object associated with channel. */
+       int tstate:1;                           /* Transient enable state */
+};
+
+struct lttng_ust_channel_buffer_private {
+       struct lttng_ust_channel_common_private parent;
+
+       struct lttng_ust_channel_buffer *pub;   /* Public channel buffer interface */
+       struct cds_list_head node;              /* Channel list in session */
+       int header_type;                        /* 0: unset, 1: compact, 2: large */
+       unsigned int id;                        /* Channel ID */
+       enum lttng_ust_abi_chan_type type;
+       struct lttng_ust_ctx *ctx;
+       unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */
+};
+
+/*
+ * IMPORTANT: this structure is part of the ABI between the consumer
+ * daemon and the UST library within traced applications. Changing it
+ * breaks the UST communication protocol.
+ *
+ * TODO: remove unused fields on next UST communication protocol
+ * breaking update.
+ */
+struct lttng_ust_abi_channel_config {
+       void *unused1;
+       int unused2;
+       void *unused3;
+       void *unused4;
+       int unused5;
+       struct cds_list_head unused6;
+       void *unused7;
+       int unused8;
+       void *unused9;
+
+       /* Channel ID */
+       unsigned int id;
+       enum lttng_ust_abi_chan_type unused10;
+       unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */
+       int unused11:1;
 };
 
+static inline
+struct lttng_ust_type_integer *lttng_ust_get_type_integer(struct lttng_ust_type_common *type)
+{
+       if (type->type != lttng_ust_type_integer)
+               return NULL;
+       return caa_container_of(type, struct lttng_ust_type_integer, parent);
+}
+
+static inline
+struct lttng_ust_type_float *lttng_ust_get_type_float(struct lttng_ust_type_common *type)
+{
+       if (type->type != lttng_ust_type_float)
+               return NULL;
+       return caa_container_of(type, struct lttng_ust_type_float, parent);
+}
+
+static inline
+struct lttng_ust_type_string *lttng_ust_get_type_string(struct lttng_ust_type_common *type)
+{
+       if (type->type != lttng_ust_type_string)
+               return NULL;
+       return caa_container_of(type, struct lttng_ust_type_string, parent);
+}
+
+static inline
+struct lttng_ust_type_enum *lttng_ust_get_type_enum(struct lttng_ust_type_common *type)
+{
+       if (type->type != lttng_ust_type_enum)
+               return NULL;
+       return caa_container_of(type, struct lttng_ust_type_enum, parent);
+}
+
+static inline
+struct lttng_ust_type_array *lttng_ust_get_type_array(struct lttng_ust_type_common *type)
+{
+       if (type->type != lttng_ust_type_array)
+               return NULL;
+       return caa_container_of(type, struct lttng_ust_type_array, parent);
+}
+
+static inline
+struct lttng_ust_type_sequence *lttng_ust_get_type_sequence(struct lttng_ust_type_common *type)
+{
+       if (type->type != lttng_ust_type_sequence)
+               return NULL;
+       return caa_container_of(type, struct lttng_ust_type_sequence, parent);
+}
+
+static inline
+struct lttng_ust_type_struct *lttng_ust_get_type_struct(struct lttng_ust_type_common *type)
+{
+       if (type->type != lttng_ust_type_struct)
+               return NULL;
+       return caa_container_of(type, struct lttng_ust_type_struct, parent);
+}
+
+/* Create dynamically allocated types. */
+static inline
+struct lttng_ust_type_common *lttng_ust_create_type_integer(unsigned int size,
+               unsigned short alignment, bool signedness, unsigned int byte_order,
+               unsigned int base)
+{
+       struct lttng_ust_type_integer *integer_type;
+
+       integer_type = zmalloc(sizeof(struct lttng_ust_type_integer));
+       if (!integer_type)
+               return NULL;
+       integer_type->parent.type = lttng_ust_type_integer;
+       integer_type->struct_size = sizeof(struct lttng_ust_type_integer);
+       integer_type->size = size;
+       integer_type->alignment = alignment;
+       integer_type->signedness = signedness;
+       integer_type->reverse_byte_order = byte_order != BYTE_ORDER;
+       integer_type->base = base;
+       return (struct lttng_ust_type_common *) integer_type;
+}
+
+static inline
+struct lttng_ust_type_common *lttng_ust_create_type_array_text(unsigned int length)
+{
+       struct lttng_ust_type_array *array_type;
+
+       array_type = zmalloc(sizeof(struct lttng_ust_type_array));
+       if (!array_type)
+               return NULL;
+       array_type->parent.type = lttng_ust_type_array;
+       array_type->struct_size = sizeof(struct lttng_ust_type_array);
+       array_type->length = length;
+       array_type->alignment = 0;
+       array_type->encoding = lttng_ust_string_encoding_UTF8;
+       array_type->elem_type = lttng_ust_create_type_integer(sizeof(char) * CHAR_BIT,
+                       lttng_alignof(char) * CHAR_BIT, lttng_is_signed_type(char),
+                       BYTE_ORDER, 10);
+       if (!array_type->elem_type)
+               goto error_elem;
+       return (struct lttng_ust_type_common *) array_type;
+
+error_elem:
+       free(array_type);
+       return NULL;
+}
+
+/*
+ * Destroy dynamically allocated types, including nested types.
+ * For enumerations, it does not free the enumeration mapping description.
+ */
+static inline
+void lttng_ust_destroy_type(struct lttng_ust_type_common *type)
+{
+       if (!type)
+               return;
+
+       switch (type->type) {
+       case lttng_ust_type_integer:
+       case lttng_ust_type_string:
+       case lttng_ust_type_float:
+       case lttng_ust_type_dynamic:
+               free(type);
+               break;
+       case lttng_ust_type_enum:
+       {
+               struct lttng_ust_type_enum *enum_type = (struct lttng_ust_type_enum *) type;
+
+               lttng_ust_destroy_type(enum_type->container_type);
+               free(enum_type);
+               break;
+       }
+       case lttng_ust_type_array:
+       {
+               struct lttng_ust_type_array *array_type = (struct lttng_ust_type_array *) type;
+
+               lttng_ust_destroy_type(array_type->elem_type);
+               free(array_type);
+               break;
+       }
+       case lttng_ust_type_sequence:
+       {
+               struct lttng_ust_type_sequence *sequence_type = (struct lttng_ust_type_sequence *) type;
+
+               lttng_ust_destroy_type(sequence_type->elem_type);
+               free(sequence_type);
+               break;
+       }
+       case lttng_ust_type_struct:
+       {
+               struct lttng_ust_type_struct *struct_type = (struct lttng_ust_type_struct *) type;
+               unsigned int i;
+
+               for (i = 0; i < struct_type->nr_fields; i++)
+                       lttng_ust_destroy_type(struct_type->fields[i]->type);
+               free(struct_type);
+               break;
+       }
+       default:
+               abort();
+       }
+}
+
 static inline
 struct lttng_enabler *lttng_event_enabler_as_enabler(
                struct lttng_event_enabler *event_enabler)
@@ -338,7 +598,7 @@ __attribute__((visibility("hidden")))
 struct lttng_event_enabler *lttng_event_enabler_create(
                enum lttng_enabler_format_type format_type,
                struct lttng_ust_abi_event *event_param,
-               struct lttng_channel *chan);
+               struct lttng_ust_channel_buffer *chan);
 
 /*
  * Destroy a `struct lttng_event_enabler` object.
@@ -394,7 +654,7 @@ int lttng_event_enabler_attach_exclusion(struct lttng_event_enabler *enabler,
  * event_notifier enabler) to ensure each is linked to the provided instance.
  */
 __attribute__((visibility("hidden")))
-void lttng_enabler_link_bytecode(const struct lttng_ust_event_desc *event_desc,
+void lttng_enabler_link_bytecode(struct lttng_ust_event_desc *event_desc,
                struct lttng_ust_ctx **ctx,
                struct cds_list_head *instance_bytecode_runtime_head,
                struct cds_list_head *enabler_bytecode_runtime_head);
@@ -548,19 +808,19 @@ struct lttng_ust_abi_field_iter *
        lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list);
 
 __attribute__((visibility("hidden")))
-struct lttng_session *lttng_session_create(void);
+struct lttng_ust_session *lttng_session_create(void);
 
 __attribute__((visibility("hidden")))
-int lttng_session_enable(struct lttng_session *session);
+int lttng_session_enable(struct lttng_ust_session *session);
 
 __attribute__((visibility("hidden")))
-int lttng_session_disable(struct lttng_session *session);
+int lttng_session_disable(struct lttng_ust_session *session);
 
 __attribute__((visibility("hidden")))
-int lttng_session_statedump(struct lttng_session *session);
+int lttng_session_statedump(struct lttng_ust_session *session);
 
 __attribute__((visibility("hidden")))
-void lttng_session_destroy(struct lttng_session *session);
+void lttng_session_destroy(struct lttng_ust_session *session);
 
 /*
  * Called with ust lock held.
@@ -575,21 +835,10 @@ __attribute__((visibility("hidden")))
 void lttng_handle_pending_statedump(void *owner);
 
 __attribute__((visibility("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);
+int lttng_channel_enable(struct lttng_ust_channel_common *lttng_channel);
 
 __attribute__((visibility("hidden")))
-int lttng_channel_enable(struct lttng_channel *channel);
-
-__attribute__((visibility("hidden")))
-int lttng_channel_disable(struct lttng_channel *channel);
+int lttng_channel_disable(struct lttng_ust_channel_common *lttng_channel);
 
 __attribute__((visibility("hidden")))
 void lttng_transport_register(struct lttng_transport *transport);
@@ -613,8 +862,8 @@ __attribute__((visibility("hidden")))
 struct cds_list_head *lttng_get_probe_list_head(void);
 
 __attribute__((visibility("hidden")))
-struct lttng_enum *lttng_ust_enum_get_from_desc(struct lttng_session *session,
-               const struct lttng_ust_enum_desc *enum_desc);
+struct lttng_enum *lttng_ust_enum_get_from_desc(struct lttng_ust_session *session,
+               struct lttng_ust_enum_desc *enum_desc);
 
 __attribute__((visibility("hidden")))
 int lttng_abi_create_root_handle(void);
@@ -634,4 +883,15 @@ void lttng_ust_abi_events_exit(void);
 __attribute__((visibility("hidden")))
 void lttng_ust_abi_objd_table_owner_cleanup(void *owner);
 
+__attribute__((visibility("hidden")))
+struct lttng_ust_channel_buffer *lttng_ust_alloc_channel_buffer(void);
+
+__attribute__((visibility("hidden")))
+void lttng_ust_free_channel_common(struct lttng_ust_channel_common *chan);
+
+__attribute__((visibility("hidden")))
+int lttng_ust_interpret_event_filter(struct lttng_ust_event_common *event,
+               const char *interpreter_stack_data,
+               void *filter_ctx);
+
 #endif /* _LTTNG_UST_EVENTS_INTERNAL_H */
This page took 0.029752 seconds and 4 git commands to generate.