Move to kernel style SPDX license identifiers
[lttng-ust.git] / include / lttng / ust-events.h
index 4c02ffa3307027ecb7a12a54ca11a25d5503cca7..a2d6a585d8924e8b8e62443a0e8795f1ae63f05b 100644 (file)
@@ -1,32 +1,14 @@
-#ifndef _LTTNG_UST_EVENTS_H
-#define _LTTNG_UST_EVENTS_H
-
 /*
- * lttng/ust-events.h
+ * SPDX-License-Identifier: MIT
  *
- * Copyright 2010-2012 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  *
  * Holds LTTng per-session event registry.
- *
- * 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.
  */
 
+#ifndef _LTTNG_UST_EVENTS_H
+#define _LTTNG_UST_EVENTS_H
+
 #include <urcu/list.h>
 #include <urcu/hlist.h>
 #include <stddef.h>
@@ -64,6 +46,8 @@ struct lttng_session;
 struct lttng_ust_lib_ring_buffer_ctx;
 struct lttng_ust_context_app;
 struct lttng_event_field;
+struct lttng_event_notifier;
+struct lttng_event_notifier_group;
 
 /*
  * Data structures used by tracepoint event declarations, and by the
@@ -315,6 +299,7 @@ struct lttng_ctx_value {
        enum lttng_ust_dynamic_type sel;
        union {
                int64_t s64;
+               uint64_t u64;
                const char *str;
                double d;
        } u;
@@ -426,14 +411,16 @@ struct ust_pending_probe;
 struct lttng_event;
 
 /*
- * 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
@@ -443,8 +430,13 @@ enum lttng_filter_ret {
 struct lttng_bytecode_runtime {
        /* Associated bytecode */
        struct lttng_ust_bytecode_node *bc;
-       uint64_t (*filter)(void *interpreter_data,
-                       const char *interpreter_stack_data);
+       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 */
        /*
@@ -477,20 +469,14 @@ struct lttng_enabler_ref {
  * removed.
  */
 struct lttng_event {
-       /* LTTng-UST 2.0 starts here */
        unsigned int id;
        struct lttng_channel *chan;
        int enabled;
        const struct lttng_event_desc *desc;
-       void *_deprecated1;
        struct lttng_ctx *ctx;
        enum lttng_ust_instrumentation instrumentation;
        struct cds_list_head node;              /* Event list in session */
-       struct cds_list_head _deprecated2;
-       void *_deprecated3;
-       unsigned int _deprecated4:1;
 
-       /* LTTng-UST 2.1 starts here */
        /* list of struct lttng_bytecode_runtime, sorted by seqnum */
        struct cds_list_head filter_bytecode_runtime_head;
        int has_enablers_without_bytecode;
@@ -502,9 +488,14 @@ struct lttng_event {
 
 struct lttng_event_notifier {
        uint64_t user_token;
+       uint64_t error_counter_index;
        int enabled;
        int registered;                 /* has reg'd tracepoint probe */
+       size_t num_captures;            /* Needed to allocate the msgpack array. */
+       void (*notification_send)(struct lttng_event_notifier *event_notifier,
+               const char *stack_data);
        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;
@@ -540,18 +531,6 @@ struct lttng_channel_ops {
                        const int *stream_fds, int nr_stream_fds,
                        int64_t blocking_timeout);
        void (*channel_destroy)(struct lttng_channel *chan);
-       union {
-               void *_deprecated1;
-               /*
-                * has_strcpy is needed by probe providers version 1.0 to
-                * dynamically detect whether the LTTng-UST tracepoint
-                * provider ABI implements event_strcpy. Starting from
-                * probe providers version 2.0, the check is not needed,
-                * but backward compatibility is provided for older versions.
-                */
-               unsigned long has_strcpy:1;             /* ABI has strcpy */
-       } u;
-       void *_deprecated2;
        int (*event_reserve)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
                             uint32_t event_id);
        void (*event_commit)(struct lttng_ust_lib_ring_buffer_ctx *ctx);
@@ -564,8 +543,6 @@ struct lttng_channel_ops {
         */
        size_t (*packet_avail_size)(struct channel *chan,
                                    struct lttng_ust_shm_handle *handle);
-       //wait_queue_head_t *(*get_reader_wait_queue)(struct channel *chan);
-       //wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
        int (*is_finalized)(struct channel *chan);
        int (*is_disabled)(struct channel *chan);
        int (*flush_buffer)(struct channel *chan, struct lttng_ust_shm_handle *handle);
@@ -591,13 +568,10 @@ struct lttng_channel {
        /* Event ID management */
        struct lttng_session *session;
        int objd;                       /* Object associated to channel */
-       unsigned int _deprecated1;
-       unsigned int _deprecated2;
        struct cds_list_head node;      /* Channel list in session */
        const struct lttng_channel_ops *ops;
        int header_type;                /* 0: unset, 1: compact, 2: large */
        struct lttng_ust_shm_handle *handle;    /* shared-memory handle */
-       unsigned int _deprecated3:1;
 
        /* Channel ID */
        unsigned int id;
@@ -606,6 +580,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;
@@ -643,13 +647,9 @@ struct lttng_session {
        int active;                             /* Is trace session active ? */
        int been_active;                        /* Been active ? */
        int objd;                               /* Object associated */
-       void *_deprecated1;
        struct cds_list_head chan_head;         /* Channel list head */
        struct cds_list_head events_head;       /* list of events */
-       struct cds_list_head _deprecated2;
        struct cds_list_head node;              /* Session list */
-       int _deprecated3;
-       unsigned int _deprecated4:1;
 
        /* New UST 2.1 */
        /* List of enablers */
@@ -667,6 +667,14 @@ struct lttng_session {
        struct lttng_ctx *ctx;                  /* contexts for filters. */
 };
 
+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;
@@ -676,6 +684,9 @@ struct lttng_event_notifier_group {
        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 {
@@ -685,15 +696,19 @@ 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_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,
@@ -710,13 +725,9 @@ int lttng_channel_disable(struct lttng_channel *channel);
 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 synchronize_trace(void);
-
 int lttng_probe_register(struct lttng_probe_desc *desc);
 void lttng_probe_unregister(struct lttng_probe_desc *desc);
 void lttng_probe_provider_unregister_events(struct lttng_probe_desc *desc);
@@ -742,7 +753,6 @@ 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);
@@ -759,7 +769,6 @@ 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);
@@ -812,7 +821,6 @@ struct lttng_ust_field_iter *
        lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list);
 
 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);
@@ -827,28 +835,6 @@ struct lttng_enum *lttng_ust_enum_get_from_desc(struct lttng_session *session,
 void lttng_ust_dl_update(void *ip);
 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);
-
 #ifdef __cplusplus
 }
 #endif
This page took 0.027309 seconds and 4 git commands to generate.