SoW-2020-0002: Trace Hit Counters: Implement key-addressed counters in shared memory...
[deliverable/lttng-ust.git] / include / lttng / ust-events.h
index 3fee93c435038acf3150759aa7d5c964bd38e448..c5ff0231a6aaa617bd119ac0a62044056879eca4 100644 (file)
@@ -64,6 +64,7 @@ struct lttng_session;
 struct lttng_ust_lib_ring_buffer_ctx;
 struct lttng_ust_context_app;
 struct lttng_event_field;
+struct lttng_trigger_group;
 
 /*
  * Data structures used by tracepoint event declarations, and by the
@@ -315,6 +316,7 @@ struct lttng_ctx_value {
        enum lttng_ust_dynamic_type sel;
        union {
                int64_t s64;
+               uint64_t u64;
                const char *str;
                double d;
        } u;
@@ -360,6 +362,7 @@ struct lttng_event_desc {
        union {
                struct {
                        const char **model_emf_uri;
+                       void (*trigger_callback)(void);
                } ext;
                char padding[LTTNG_UST_EVENT_DESC_PADDING];
        } u;
@@ -380,9 +383,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,
 };
 
 /*
@@ -390,21 +393,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;
 };
 
@@ -431,34 +427,17 @@ 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. */
 };
 
+struct lttng_interpreter_output;
+
 /*
  * This structure is used in the probes. More specifically, the `filter` and
  * `node` fields are explicity used in the probes. When modifying this
@@ -467,15 +446,30 @@ enum lttng_filter_ret {
  */
 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);
+               uint64_t (*capture)(void *interpreter_data,
+                               const char *interpreter_stack_data,
+                               struct lttng_interpreter_output *interpreter_output);
+       } 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_trigger_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 trigger.
+ * This is used because an event (or a trigger) 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 */
@@ -506,7 +500,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;
@@ -514,6 +508,22 @@ struct lttng_event {
        int registered;                 /* has reg'd tracepoint probe */
 };
 
+struct lttng_trigger {
+       uint64_t id;
+       uint64_t error_counter_index;
+       int enabled;
+       int registered;                 /* has reg'd tracepoint probe */
+       size_t num_captures;            /* Needed to allocate the msgpack array. */
+       struct cds_list_head filter_bytecode_runtime_head;
+       struct cds_list_head capture_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 triggers */
+       struct cds_list_head node;      /* Trigger list in session */
+       struct lttng_trigger_group *group; /* weak ref */
+};
+
 struct lttng_enum {
        const struct lttng_enum_desc *desc;
        struct lttng_session *session;
@@ -607,6 +617,36 @@ struct lttng_channel {
        int tstate:1;                   /* Transient enable state */
 };
 
+#define LTTNG_COUNTER_DIMENSION_MAX    8
+
+struct lttng_counter_dimension {
+       uint64_t size;
+       uint64_t underflow_index;
+       uint64_t overflow_index;
+       uint8_t has_underflow;
+       uint8_t has_overflow;
+};
+
+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);
+};
+
 #define LTTNG_UST_STACK_CTX_PADDING    32
 struct lttng_stack_ctx {
        struct lttng_event *event;
@@ -622,6 +662,12 @@ struct lttng_ust_event_ht {
        struct cds_hlist_head table[LTTNG_UST_EVENT_HT_SIZE];
 };
 
+#define LTTNG_UST_TRIGGER_HT_BITS              12
+#define LTTNG_UST_TRIGGER_HT_SIZE              (1U << LTTNG_UST_TRIGGER_HT_BITS)
+struct lttng_ust_trigger_ht {
+       struct cds_hlist_head table[LTTNG_UST_TRIGGER_HT_SIZE];
+};
+
 #define LTTNG_UST_ENUM_HT_BITS         12
 #define LTTNG_UST_ENUM_HT_SIZE         (1U << LTTNG_UST_ENUM_HT_BITS)
 
@@ -662,6 +708,28 @@ struct lttng_session {
        struct lttng_ctx *ctx;                  /* contexts for filters. */
 };
 
+struct lttng_counter {
+       int objd;
+       struct lttng_trigger_group *trigger_group;      /* owner */
+       struct lttng_counter_transport *transport;
+       struct lib_counter *counter;
+       struct lttng_counter_ops *ops;
+};
+
+struct lttng_trigger_group {
+       int objd;
+       void *owner;
+       int notification_fd;
+       struct cds_list_head node;              /* Trigger group handle list */
+       struct cds_list_head enablers_head;
+       struct cds_list_head triggers_head;     /* list of triggers */
+       struct lttng_ust_trigger_ht triggers_ht; /* hashtable of triggers */
+       struct lttng_ctx *ctx;                  /* contexts for filters. */
+
+       struct lttng_counter *error_counter;
+       size_t error_counter_len;
+};
+
 struct lttng_transport {
        char *name;
        struct cds_list_head node;
@@ -669,12 +737,21 @@ struct lttng_transport {
        const struct lttng_ust_lib_ring_buffer_config *client_config;
 };
 
+struct lttng_counter_transport {
+       char *name;
+       struct cds_list_head node;
+       struct lttng_counter_ops ops;
+       const struct lib_counter_config *client_config;
+};
+
 struct lttng_session *lttng_session_create(void);
 int lttng_session_enable(struct lttng_session *session);
 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_trigger_notification_send(struct lttng_trigger *trigger, const char *stack_data);
+
 struct lttng_channel *lttng_channel_create(struct lttng_session *session,
                                       const char *transport_name,
                                       void *buf_addr,
@@ -688,26 +765,19 @@ 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);
-int lttng_session_context_init(struct lttng_ctx **ctx);
-
 void lttng_transport_register(struct lttng_transport *transport);
 void lttng_transport_unregister(struct lttng_transport *transport);
 
+void lttng_counter_transport_register(struct lttng_counter_transport *transport);
+void lttng_counter_transport_unregister(struct lttng_counter_transport *transport);
+
+struct lttng_counter *lttng_ust_counter_create(
+               const char *counter_transport_name,
+               size_t number_dimensions, const struct lttng_counter_dimension *dimensions);
+
 void synchronize_trace(void);
 
 int lttng_probe_register(struct lttng_probe_desc *desc);
@@ -794,6 +864,7 @@ extern const struct lttng_ust_client_lib_ring_buffer_client_cb *lttng_client_cal
 extern const struct lttng_ust_client_lib_ring_buffer_client_cb *lttng_client_callbacks_overwrite;
 
 struct lttng_transport *lttng_transport_find(const char *name);
+struct lttng_counter_transport *lttng_counter_transport_find(const char *name);
 
 int lttng_probes_get_event_list(struct lttng_ust_tracepoint_list *list);
 void lttng_probes_prune_event_list(struct lttng_ust_tracepoint_list *list);
@@ -804,10 +875,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);
@@ -824,9 +892,28 @@ 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);
+int lttng_session_context_init(struct lttng_ctx **ctx);
+
 
 #ifdef __cplusplus
 }
This page took 0.032129 seconds and 5 git commands to generate.