Introduce common event structure
[lttng-ust.git] / liblttng-ust / ust-events-internal.h
index 24393936f2df4b40f4ab48cbd099e28d8612fb2c..ea62e029bc7f697967218fd7758c3acec5b6e965 100644 (file)
@@ -1,38 +1,41 @@
-#ifndef _LTTNG_UST_EVENTS_INTERNAL_H
-#define _LTTNG_UST_EVENTS_INTERNAL_H
-
 /*
- * ust-events-internal.h
- *
- * Copyright 2019 (c) - Francis Deslauriers <francis.deslauriers@efficios.com>
+ * SPDX-License-Identifier: MIT
  *
- * 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.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
+ * Copyright 2019 (c) Francis Deslauriers <francis.deslauriers@efficios.com>
  */
 
+#ifndef _LTTNG_UST_EVENTS_INTERNAL_H
+#define _LTTNG_UST_EVENTS_INTERNAL_H
+
 #include <stdint.h>
 
 #include <urcu/list.h>
 #include <urcu/hlist.h>
 
-#include <helper.h>
+#include <ust-helper.h>
 #include <lttng/ust-events.h>
 
+enum lttng_enabler_format_type {
+       LTTNG_ENABLER_FORMAT_STAR_GLOB,
+       LTTNG_ENABLER_FORMAT_EVENT,
+};
+
+/*
+ * Enabler field, within whatever object is enabling an event. Target of
+ * backward reference.
+ */
+struct lttng_enabler {
+       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 lttng_ust_event event_param;
+       unsigned int enabled:1;
+};
+
 struct lttng_event_enabler {
        struct lttng_enabler base;
        struct cds_list_head node;      /* per-session list of enablers */
@@ -46,13 +49,17 @@ struct lttng_event_enabler {
 
 struct lttng_event_notifier_enabler {
        struct lttng_enabler base;
-       struct cds_list_head node;      /* per-app list of event notifier enablers */
+       uint64_t error_counter_index;
+       struct cds_list_head node;      /* per-app list of event_notifier enablers */
+       struct cds_list_head capture_bytecode_head;
        struct lttng_event_notifier_group *group; /* weak ref */
        uint64_t user_token;            /* User-provided token */
+       uint64_t num_captures;
 };
 
 enum lttng_ust_bytecode_node_type {
        LTTNG_UST_BYTECODE_NODE_TYPE_FILTER,
+       LTTNG_UST_BYTECODE_NODE_TYPE_CAPTURE,
 };
 
 struct lttng_ust_bytecode_node {
@@ -77,6 +84,141 @@ struct lttng_ust_excluder_node {
        struct lttng_ust_event_exclusion excluder;
 };
 
+/* Data structures used by the tracer. */
+
+struct tp_list_entry {
+       struct lttng_ust_tracepoint_iter tp;
+       struct cds_list_head head;
+};
+
+struct lttng_ust_tracepoint_list {
+       struct tp_list_entry *iter;
+       struct cds_list_head head;
+};
+
+struct tp_field_list_entry {
+       struct lttng_ust_field_iter field;
+       struct cds_list_head head;
+};
+
+struct lttng_ust_field_list {
+       struct tp_field_list_entry *iter;
+       struct cds_list_head head;
+};
+
+/*
+ * 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 */
+       struct lttng_enabler *ref;              /* backward ref */
+};
+
+#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 {
+       int objd;
+       struct lttng_event_notifier_group *event_notifier_group;    /* owner */
+       struct lttng_counter_transport *transport;
+       struct lib_counter *counter;
+       struct lttng_counter_ops *ops;
+};
+
+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_counter *error_counter;
+       size_t error_counter_len;
+};
+
+struct lttng_transport {
+       char *name;
+       struct cds_list_head node;
+       struct lttng_channel_ops ops;
+       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_ust_event_common_private {
+       struct lttng_event_common *pub; /* Public event interface */
+
+       const struct lttng_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 */
+};
+
+struct lttng_ust_event_private {
+       struct lttng_ust_event_common_private parent;
+
+       struct lttng_event *pub;        /* Public event interface */
+       struct cds_list_head node;      /* Event list in session */
+       struct cds_hlist_node hlist;    /* session ht of events */
+};
+
+struct lttng_ust_bytecode_runtime_private {
+       struct bytecode_runtime *pub;   /* Public bytecode runtime interface */
+
+       struct lttng_ust_bytecode_node *bc;
+       int link_failed;
+       /*
+        * Pointer to a URCU-protected pointer owned by an `struct
+        * lttng_session`or `struct lttng_event_notifier_group`.
+        */
+       struct lttng_ctx **pctx;
+};
+
+struct lttng_ust_session_private {
+       struct lttng_session *pub;              /* Public session interface */
+
+       int been_active;                        /* Been active ? */
+       int objd;                               /* Object associated */
+       struct cds_list_head chan_head;         /* Channel list head */
+       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_ctx *ctx;                  /* contexts for filters. */
+};
+
 static inline
 struct lttng_enabler *lttng_event_enabler_as_enabler(
                struct lttng_event_enabler *event_enabler)
@@ -130,7 +272,7 @@ int lttng_event_enabler_disable(struct lttng_event_enabler *enabler);
 LTTNG_HIDDEN
 int lttng_event_enabler_attach_filter_bytecode(
                struct lttng_event_enabler *enabler,
-               struct lttng_ust_bytecode_node *bytecode);
+               struct lttng_ust_bytecode_node **bytecode);
 
 /*
  * Attach an application context to an event enabler.
@@ -147,19 +289,20 @@ int lttng_event_enabler_attach_context(struct lttng_event_enabler *enabler,
  */
 LTTNG_HIDDEN
 int lttng_event_enabler_attach_exclusion(struct lttng_event_enabler *enabler,
-               struct lttng_ust_excluder_node *excluder);
+               struct lttng_ust_excluder_node **excluder);
 
 /*
- * Synchronize bytecodes for the enabler and the event.
+ * Synchronize bytecodes for the enabler and the instance (event or
+ * event_notifier).
  *
- * This function goes over all bytecode programs of the event enabler to ensure
- * each is linked to the provided event.
+ * This function goes over all bytecode programs of the enabler (event or
+ * event_notifier enabler) to ensure each is linked to the provided instance.
  */
 LTTNG_HIDDEN
 void lttng_enabler_link_bytecode(const struct lttng_event_desc *event_desc,
                struct lttng_ctx **ctx,
-               struct cds_list_head *bytecode_runtime_head,
-               struct lttng_enabler *enabler);
+               struct cds_list_head *instance_bytecode_runtime_head,
+               struct cds_list_head *enabler_bytecode_runtime_head);
 
 /*
  * Allocate and initialize a `struct lttng_event_notifier_group` object.
@@ -219,7 +362,16 @@ int lttng_event_notifier_enabler_disable(
 LTTNG_HIDDEN
 int lttng_event_notifier_enabler_attach_filter_bytecode(
                struct lttng_event_notifier_enabler *event_notifier_enabler,
-               struct lttng_ust_bytecode_node *bytecode);
+               struct lttng_ust_bytecode_node **bytecode);
+
+/*
+ * Attach capture bytecode program to `struct lttng_event_notifier_enabler` and
+ * all event_notifiers related to this enabler.
+ */
+LTTNG_HIDDEN
+int lttng_event_notifier_enabler_attach_capture_bytecode(
+               struct lttng_event_notifier_enabler *event_notifier_enabler,
+               struct lttng_ust_bytecode_node **bytecode);
 
 /*
  * Attach exclusion list to `struct lttng_event_notifier_enabler` and all
@@ -228,7 +380,10 @@ int lttng_event_notifier_enabler_attach_filter_bytecode(
 LTTNG_HIDDEN
 int lttng_event_notifier_enabler_attach_exclusion(
                struct lttng_event_notifier_enabler *event_notifier_enabler,
-               struct lttng_ust_excluder_node *excluder);
+               struct lttng_ust_excluder_node **excluder);
+
+LTTNG_HIDDEN
+void lttng_free_event_filter_runtime(struct lttng_event *event);
 
 LTTNG_HIDDEN
 void lttng_free_event_notifier_filter_runtime(
@@ -241,4 +396,110 @@ void lttng_free_event_notifier_filter_runtime(
 LTTNG_HIDDEN
 int lttng_fix_pending_event_notifiers(void);
 
+LTTNG_HIDDEN
+struct lttng_counter *lttng_ust_counter_create(
+               const char *counter_transport_name,
+               size_t number_dimensions, const struct lttng_counter_dimension *dimensions);
+
+#ifdef HAVE_PERF_EVENT
+
+LTTNG_HIDDEN
+int lttng_add_perf_counter_to_ctx(uint32_t type,
+                                 uint64_t config,
+                                 const char *name,
+                                 struct lttng_ctx **ctx);
+LTTNG_HIDDEN
+int lttng_perf_counter_init(void);
+LTTNG_HIDDEN
+void lttng_perf_counter_exit(void);
+
+#else /* #ifdef HAVE_PERF_EVENT */
+
+static inline
+int lttng_add_perf_counter_to_ctx(uint32_t type,
+                                 uint64_t config,
+                                 const char *name,
+                                 struct lttng_ctx **ctx)
+{
+       return -ENOSYS;
+}
+static inline
+int lttng_perf_counter_init(void)
+{
+       return 0;
+}
+static inline
+void lttng_perf_counter_exit(void)
+{
+}
+#endif /* #else #ifdef HAVE_PERF_EVENT */
+
+LTTNG_HIDDEN
+int lttng_probes_get_event_list(struct lttng_ust_tracepoint_list *list);
+LTTNG_HIDDEN
+void lttng_probes_prune_event_list(struct lttng_ust_tracepoint_list *list);
+
+LTTNG_HIDDEN
+int lttng_probes_get_field_list(struct lttng_ust_field_list *list);
+LTTNG_HIDDEN
+void lttng_probes_prune_field_list(struct lttng_ust_field_list *list);
+
+LTTNG_HIDDEN
+struct lttng_ust_tracepoint_iter *
+       lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list *list);
+LTTNG_HIDDEN
+struct lttng_ust_field_iter *
+       lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list);
+
+LTTNG_HIDDEN
+struct lttng_session *lttng_session_create(void);
+LTTNG_HIDDEN
+int lttng_session_enable(struct lttng_session *session);
+LTTNG_HIDDEN
+int lttng_session_disable(struct lttng_session *session);
+LTTNG_HIDDEN
+int lttng_session_statedump(struct lttng_session *session);
+LTTNG_HIDDEN
+void lttng_session_destroy(struct lttng_session *session);
+
+LTTNG_HIDDEN
+struct cds_list_head *lttng_get_sessions(void);
+
+LTTNG_HIDDEN
+void lttng_handle_pending_statedump(void *owner);
+
+LTTNG_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);
+
+LTTNG_HIDDEN
+int lttng_channel_enable(struct lttng_channel *channel);
+LTTNG_HIDDEN
+int lttng_channel_disable(struct lttng_channel *channel);
+
+LTTNG_HIDDEN
+void lttng_transport_register(struct lttng_transport *transport);
+LTTNG_HIDDEN
+void lttng_transport_unregister(struct lttng_transport *transport);
+
+LTTNG_HIDDEN
+void lttng_probe_provider_unregister_events(struct lttng_probe_desc *desc);
+
+LTTNG_HIDDEN
+int lttng_fix_pending_events(void);
+
+LTTNG_HIDDEN
+struct cds_list_head *lttng_get_probe_list_head(void);
+
+LTTNG_HIDDEN
+struct lttng_enum *lttng_ust_enum_get_from_desc(struct lttng_session *session,
+               const struct lttng_enum_desc *enum_desc);
+
 #endif /* _LTTNG_UST_EVENTS_INTERNAL_H */
This page took 0.02708 seconds and 4 git commands to generate.