Add `interpreter_funcs` to `lttng_bytecode_runtime`
[lttng-ust.git] / include / lttng / ust-events.h
index 938e12bcd248cdd31f9352d42c88de30fed34b46..41164ac348eb1edf14e83960f07027205cb037ca 100644 (file)
@@ -88,13 +88,17 @@ enum lttng_client_types {
 /* Update the astract_types name table in lttng-types.c along with this enum */
 enum lttng_abstract_types {
        atype_integer,
-       atype_enum,
-       atype_array,
-       atype_sequence,
+       atype_enum,     /* legacy */
+       atype_array,    /* legacy */
+       atype_sequence, /* legacy */
        atype_string,
        atype_float,
        atype_dynamic,
-       atype_struct,
+       atype_struct,   /* legacy */
+       atype_enum_nestable,
+       atype_array_nestable,
+       atype_sequence_nestable,
+       atype_struct_nestable,
        NR_ABSTRACT_TYPES,
 };
 
@@ -132,17 +136,14 @@ struct lttng_enum_entry {
          .atype = atype_integer,                               \
          .u =                                                  \
                {                                               \
-                 .basic =                                      \
+                 .integer =                                    \
                        {                                       \
-                         .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,         \
-                               }                               \
+                         .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, \
                        }                                       \
                },                                              \
        }                                                       \
@@ -172,18 +173,15 @@ struct lttng_integer_type {
          .atype = atype_float,                                 \
          .u =                                                  \
                {                                               \
-                 .basic =                                      \
+                 ._float =                                     \
                        {                                       \
-                         ._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, \
-                               }                               \
+                         .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
@@ -195,20 +193,22 @@ struct lttng_float_type {
        char padding[LTTNG_UST_FLOAT_TYPE_PADDING];
 };
 
+/* legacy */
 #define LTTNG_UST_BASIC_TYPE_PADDING   128
 union _lttng_basic_type {
-       struct lttng_integer_type integer;
+       struct lttng_integer_type integer;      /* legacy */
        struct {
                const struct lttng_enum_desc *desc;     /* Enumeration mapping */
                struct lttng_integer_type container_type;
-       } enumeration;
+       } enumeration;                          /* legacy */
        struct {
                enum lttng_string_encodings encoding;
-       } string;
-       struct lttng_float_type _float;
+       } string;                               /* legacy */
+       struct lttng_float_type _float;         /* legacy */
        char padding[LTTNG_UST_BASIC_TYPE_PADDING];
 };
 
+/* legacy */
 struct lttng_basic_type {
        enum lttng_abstract_types atype;
        union {
@@ -220,19 +220,48 @@ struct lttng_basic_type {
 struct lttng_type {
        enum lttng_abstract_types atype;
        union {
-               union _lttng_basic_type basic;
+               /* provider ABI 2.0 */
+               struct lttng_integer_type integer;
+               struct lttng_float_type _float;
+               struct {
+                       enum lttng_string_encodings encoding;
+               } string;
                struct {
-                       struct lttng_basic_type elem_type;
-                       unsigned int length;            /* num. elems. */
-               } array;
+                       const struct lttng_enum_desc *desc;     /* Enumeration mapping */
+                       struct lttng_type *container_type;
+               } enum_nestable;
                struct {
-                       struct lttng_basic_type length_type;
-                       struct lttng_basic_type elem_type;
-               } sequence;
+                       const struct lttng_type *elem_type;
+                       unsigned int length;                    /* Num. elems. */
+                       unsigned int alignment;
+               } array_nestable;
                struct {
-                       uint32_t nr_fields;
-                       struct lttng_event_field *fields;       /* Array of fields. */
-               } _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_event_field *fields; /* Array of fields. */
+                       unsigned int alignment;
+               } struct_nestable;
+
+               union {
+                       /* legacy provider ABI 1.0 */
+                       union _lttng_basic_type basic;  /* legacy */
+                       struct {
+                               struct lttng_basic_type elem_type;
+                               unsigned int length;            /* Num. elems. */
+                       } array;                        /* legacy */
+                       struct {
+                               struct lttng_basic_type length_type;
+                               struct lttng_basic_type elem_type;
+                       } sequence;                     /* legacy */
+                       struct {
+                               unsigned int nr_fields;
+                               struct lttng_event_field *fields;       /* Array of fields. */
+                       } _struct;                      /* legacy */
+               } legacy;
                char padding[LTTNG_UST_TYPE_PADDING];
        } u;
 };
@@ -258,7 +287,12 @@ struct lttng_event_field {
        const char *name;
        struct lttng_type type;
        unsigned int nowrite;   /* do not write into trace */
-       char padding[LTTNG_UST_EVENT_FIELD_PADDING];
+       union {
+               struct {
+                       unsigned int nofilter:1;        /* do not consider for filter */
+               } ext;
+               char padding[LTTNG_UST_EVENT_FIELD_PADDING];
+       } u;
 };
 
 enum lttng_ust_dynamic_type {
@@ -326,6 +360,7 @@ struct lttng_event_desc {
        union {
                struct {
                        const char **model_emf_uri;
+                       void (*event_notifier_callback)(void);
                } ext;
                char padding[LTTNG_UST_EVENT_DESC_PADDING];
        } u;
@@ -346,9 +381,9 @@ struct lttng_probe_desc {
 
 /* Data structures used by the tracer. */
 
-enum lttng_enabler_type {
-       LTTNG_ENABLER_STAR_GLOB,
-       LTTNG_ENABLER_EVENT,
+enum lttng_enabler_format_type {
+       LTTNG_ENABLER_FORMAT_STAR_GLOB,
+       LTTNG_ENABLER_FORMAT_EVENT,
 };
 
 /*
@@ -356,21 +391,14 @@ enum lttng_enabler_type {
  * backward reference.
  */
 struct lttng_enabler {
-       enum lttng_enabler_type type;
+       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 cds_list_head node;      /* per-session list of enablers */
 
        struct lttng_ust_event event_param;
-       struct lttng_channel *chan;
-       /*
-        * Unused, but kept around to make it explicit that the tracer can do
-        * it.
-        */
-       struct lttng_ctx *ctx;
        unsigned int enabled:1;
 };
 
@@ -397,45 +425,45 @@ struct lttng_ust_field_list {
 struct ust_pending_probe;
 struct lttng_event;
 
-struct lttng_ust_filter_bytecode_node {
-       struct cds_list_head node;
-       struct lttng_enabler *enabler;
-       /*
-        * struct lttng_ust_filter_bytecode has var. sized array, must
-        * be last field.
-        */
-       struct lttng_ust_filter_bytecode 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_event_exclusion excluder;
-};
 /*
- * Filter return value masks.
+ * Bytecode interpreter return value masks.
  */
-enum lttng_filter_ret {
-       LTTNG_FILTER_DISCARD = 0,
-       LTTNG_FILTER_RECORD_FLAG = (1ULL << 0),
+enum lttng_bytecode_interpreter_ret {
+       LTTNG_INTERPRETER_DISCARD = 0,
+       LTTNG_INTERPRETER_RECORD_FLAG = (1ULL << 0),
        /* Other bits are kept for future use. */
 };
 
+/*
+ * This structure is used in the probes. More specifically, the `filter` 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.
+ */
 struct lttng_bytecode_runtime {
        /* Associated bytecode */
-       struct lttng_ust_filter_bytecode_node *bc;
-       uint64_t (*filter)(void *filter_data, const char *filter_stack_data);
+       struct lttng_ust_bytecode_node *bc;
+       union {
+               uint64_t (*filter)(void *interpreter_data,
+                               const char *interpreter_stack_data);
+       } interpreter_funcs;
        int link_failed;
        struct cds_list_head node;      /* list of bytecode runtime in event */
-       struct lttng_session *session;
+       /*
+        * Pointer to a URCU-protected pointer owned by an `struct
+        * lttng_session`or `struct lttng_event_notifier_group`.
+        */
+       struct lttng_ctx **pctx;
 };
 
 /*
- * Objects in a linked-list of enablers, owned by an event.
+ * 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 */
@@ -466,7 +494,7 @@ struct lttng_event {
 
        /* LTTng-UST 2.1 starts here */
        /* list of struct lttng_bytecode_runtime, sorted by seqnum */
-       struct cds_list_head bytecode_runtime_head;
+       struct cds_list_head filter_bytecode_runtime_head;
        int has_enablers_without_bytecode;
        /* Backward references: list of lttng_enabler_ref (ref to enablers) */
        struct cds_list_head enablers_ref_head;
@@ -474,6 +502,19 @@ struct lttng_event {
        int registered;                 /* has reg'd tracepoint probe */
 };
 
+struct lttng_event_notifier {
+       uint64_t user_token;
+       int enabled;
+       int registered;                 /* has reg'd tracepoint probe */
+       struct cds_list_head filter_bytecode_runtime_head;
+       int has_enablers_without_bytecode;
+       struct cds_list_head enablers_ref_head;
+       const struct lttng_event_desc *desc;
+       struct cds_hlist_node hlist;    /* hashtable of event_notifiers */
+       struct cds_list_head node;      /* event_notifier list in session */
+       struct lttng_event_notifier_group *group; /* weak ref */
+};
+
 struct lttng_enum {
        const struct lttng_enum_desc *desc;
        struct lttng_session *session;
@@ -582,6 +623,12 @@ 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)
 
@@ -622,6 +669,17 @@ struct lttng_session {
        struct lttng_ctx *ctx;                  /* contexts for filters. */
 };
 
+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_transport {
        char *name;
        struct cds_list_head node;
@@ -635,6 +693,9 @@ int lttng_session_disable(struct lttng_session *session);
 int lttng_session_statedump(struct lttng_session *session);
 void lttng_session_destroy(struct lttng_session *session);
 
+void lttng_event_notifier_notification_send(
+               struct lttng_event_notifier *event_notifier);
+
 struct lttng_channel *lttng_channel_create(struct lttng_session *session,
                                       const char *transport_name,
                                       void *buf_addr,
@@ -648,18 +709,6 @@ struct lttng_channel *lttng_channel_create(struct lttng_session *session,
 int lttng_channel_enable(struct lttng_channel *channel);
 int lttng_channel_disable(struct lttng_channel *channel);
 
-struct lttng_enabler *lttng_enabler_create(enum lttng_enabler_type type,
-               struct lttng_ust_event *event_param,
-               struct lttng_channel *chan);
-int lttng_enabler_enable(struct lttng_enabler *enabler);
-int lttng_enabler_disable(struct lttng_enabler *enabler);
-int lttng_enabler_attach_bytecode(struct lttng_enabler *enabler,
-               struct lttng_ust_filter_bytecode_node *bytecode);
-int lttng_enabler_attach_context(struct lttng_enabler *enabler,
-               struct lttng_ust_context *ctx);
-int lttng_enabler_attach_exclusion(struct lttng_enabler *enabler,
-               struct lttng_ust_excluder_node *excluder);
-
 int lttng_attach_context(struct lttng_ust_context *context_param,
                union ust_args *uargs,
                struct lttng_ctx **ctx, struct lttng_session *session);
@@ -695,6 +744,7 @@ int lttng_add_ipc_ns_to_ctx(struct lttng_ctx **ctx);
 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx **ctx);
 int lttng_add_net_ns_to_ctx(struct lttng_ctx **ctx);
 int lttng_add_pid_ns_to_ctx(struct lttng_ctx **ctx);
+int lttng_add_time_ns_to_ctx(struct lttng_ctx **ctx);
 int lttng_add_user_ns_to_ctx(struct lttng_ctx **ctx);
 int lttng_add_uts_ns_to_ctx(struct lttng_ctx **ctx);
 int lttng_add_vuid_to_ctx(struct lttng_ctx **ctx);
@@ -711,6 +761,7 @@ void lttng_context_ipc_ns_reset(void);
 void lttng_context_mnt_ns_reset(void);
 void lttng_context_net_ns_reset(void);
 void lttng_context_pid_ns_reset(void);
+void lttng_context_time_ns_reset(void);
 void lttng_context_user_ns_reset(void);
 void lttng_context_uts_ns_reset(void);
 void lttng_context_vuid_reset(void);
@@ -762,10 +813,7 @@ void lttng_probes_prune_field_list(struct lttng_ust_field_list *list);
 struct lttng_ust_field_iter *
        lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list);
 
-void lttng_enabler_event_link_bytecode(struct lttng_event *event,
-               struct lttng_enabler *enabler);
 void lttng_free_event_filter_runtime(struct lttng_event *event);
-void lttng_filter_sync_state(struct lttng_bytecode_runtime *runtime);
 
 struct cds_list_head *lttng_get_probe_list_head(void);
 int lttng_session_active(void);
@@ -782,9 +830,26 @@ void lttng_ust_fixup_fd_tracker_tls(void);
 
 /* For backward compatibility. Leave those exported symbols in place. */
 extern struct lttng_ctx *lttng_static_ctx;
+struct lttng_ust_filter_bytecode_node;
+struct lttng_ust_excluder_node;
 void lttng_context_init(void);
 void lttng_context_exit(void);
 void lttng_filter_event_link_bytecode(struct lttng_event *event);
+struct lttng_enabler *lttng_enabler_create(
+               enum lttng_enabler_format_type format_type,
+               struct lttng_ust_event *event_param,
+               struct lttng_channel *chan);
+int lttng_enabler_enable(struct lttng_enabler *enabler);
+int lttng_enabler_disable(struct lttng_enabler *enabler);
+int lttng_enabler_attach_bytecode(struct lttng_enabler *enabler,
+               struct lttng_ust_filter_bytecode_node *bytecode);
+int lttng_enabler_attach_context(struct lttng_enabler *enabler,
+               struct lttng_ust_context *ctx);
+int lttng_enabler_attach_exclusion(struct lttng_enabler *enabler,
+               struct lttng_ust_excluder_node *excluder);
+void lttng_enabler_event_link_bytecode(struct lttng_event *event,
+               struct lttng_enabler *enabler);
+void lttng_filter_sync_state(struct lttng_bytecode_runtime *runtime);
 
 #ifdef __cplusplus
 }
This page took 0.02826 seconds and 4 git commands to generate.