Move lttng_ust_dl_update to private ABI
[lttng-ust.git] / include / lttng / ust-events.h
index 164c82c4c8288617702a56edc5eec30ba341b6aa..809c056d660662b5ac537e6798811a85c939e940 100644 (file)
@@ -362,14 +362,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,
@@ -379,6 +383,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. */
 };
 
 /*
@@ -421,7 +427,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. */
@@ -473,6 +479,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 */
 
@@ -483,14 +490,6 @@ struct lttng_ust_event_notifier {
        /* End of base ABI. Fields below should be used after checking struct_size. */
 };
 
-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 channel;
 struct lttng_ust_shm_handle;
 
@@ -498,8 +497,14 @@ 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,
@@ -527,6 +532,8 @@ struct lttng_channel_ops {
        int (*flush_buffer)(struct 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. */
 };
 
 /*
@@ -548,7 +555,7 @@ struct lttng_channel {
        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 */
 
@@ -559,54 +566,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;
@@ -633,15 +609,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
 }
This page took 0.025655 seconds and 4 git commands to generate.