Move forward declarations to private header
[lttng-modules.git] / include / lttng / events-internal.h
index 128484a8ec312672615a2665527596326ba97d20..8ac87e7f741fa5663887f738e1577f2f09a2f5c3 100644 (file)
 
 #include <lttng/events.h>
 
+struct lttng_syscall_filter;
+struct lttng_metadata_cache;
+struct perf_event;
+struct perf_event_attr;
+struct lib_ring_buffer_config;
+
 enum lttng_enabler_format_type {
        LTTNG_ENABLER_FORMAT_STAR_GLOB,
        LTTNG_ENABLER_FORMAT_NAME,
@@ -216,7 +222,7 @@ struct lttng_kernel_ctx_field {
        size_t (*get_size)(void *priv, struct lttng_kernel_probe_ctx *probe_ctx,
                        size_t offset);
        void (*record)(void *priv, struct lttng_kernel_probe_ctx *probe_ctx,
-                       struct lib_ring_buffer_ctx *ctx,
+                       struct lttng_kernel_ring_buffer_ctx *ctx,
                        struct lttng_channel *chan);
        void (*get_value)(void *priv, struct lttng_kernel_probe_ctx *probe_ctx,
                        struct lttng_ctx_value *value);
@@ -231,6 +237,208 @@ struct lttng_kernel_ctx {
        size_t largest_align;   /* in bytes */
 };
 
+struct lttng_metadata_cache {
+       char *data;                     /* Metadata cache */
+       unsigned int cache_alloc;       /* Metadata allocated size (bytes) */
+       unsigned int metadata_written;  /* Number of bytes written in metadata cache */
+       atomic_t producing;             /* Metadata being produced (incomplete) */
+       struct kref refcount;           /* Metadata cache usage */
+       struct list_head metadata_stream;       /* Metadata stream list */
+       uuid_le uuid;                   /* Trace session unique ID (copy) */
+       struct mutex lock;              /* Produce/consume lock */
+       uint64_t version;               /* Current version of the metadata */
+};
+
+struct lttng_metadata_stream {
+       void *priv;                     /* Ring buffer private data */
+       struct lttng_metadata_cache *metadata_cache;
+       unsigned int metadata_in;       /* Bytes read from the cache */
+       unsigned int metadata_out;      /* Bytes consumed from stream */
+       int finalized;                  /* Has channel been finalized */
+       wait_queue_head_t read_wait;    /* Reader buffer-level wait queue */
+       struct list_head list;          /* Stream list */
+       struct lttng_transport *transport;
+       uint64_t version;               /* Current version of the metadata cache */
+       bool coherent;                  /* Stream in a coherent state */
+};
+
+struct lttng_kernel_channel_buffer_ops_private {
+       struct lttng_kernel_channel_buffer_ops *pub;    /* Public channel buffer ops interface */
+
+       struct channel *(*channel_create)(const char *name,
+                               void *priv,
+                               void *buf_addr,
+                               size_t subbuf_size, size_t num_subbuf,
+                               unsigned int switch_timer_interval,
+                               unsigned int read_timer_interval);
+       void (*channel_destroy)(struct channel *chan);
+       struct lib_ring_buffer *(*buffer_read_open)(struct channel *chan);
+       int (*buffer_has_read_closed_stream)(struct channel *chan);
+       void (*buffer_read_close)(struct lib_ring_buffer *buf);
+       /*
+        * packet_avail_size returns the available size in the current
+        * packet. Note that the size returned is only a hint, since it
+        * may change due to concurrent writes.
+        */
+       size_t (*packet_avail_size)(struct channel *chan);
+       wait_queue_head_t *(*get_writer_buf_wait_queue)(struct channel *chan, int cpu);
+       wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
+       int (*is_finalized)(struct channel *chan);
+       int (*is_disabled)(struct channel *chan);
+       int (*timestamp_begin) (const struct lib_ring_buffer_config *config,
+                       struct lib_ring_buffer *bufb,
+                       uint64_t *timestamp_begin);
+       int (*timestamp_end) (const struct lib_ring_buffer_config *config,
+                       struct lib_ring_buffer *bufb,
+                       uint64_t *timestamp_end);
+       int (*events_discarded) (const struct lib_ring_buffer_config *config,
+                       struct lib_ring_buffer *bufb,
+                       uint64_t *events_discarded);
+       int (*content_size) (const struct lib_ring_buffer_config *config,
+                       struct lib_ring_buffer *bufb,
+                       uint64_t *content_size);
+       int (*packet_size) (const struct lib_ring_buffer_config *config,
+                       struct lib_ring_buffer *bufb,
+                       uint64_t *packet_size);
+       int (*stream_id) (const struct lib_ring_buffer_config *config,
+                       struct lib_ring_buffer *bufb,
+                       uint64_t *stream_id);
+       int (*current_timestamp) (const struct lib_ring_buffer_config *config,
+                       struct lib_ring_buffer *bufb,
+                       uint64_t *ts);
+       int (*sequence_number) (const struct lib_ring_buffer_config *config,
+                       struct lib_ring_buffer *bufb,
+                       uint64_t *seq);
+       int (*instance_id) (const struct lib_ring_buffer_config *config,
+                       struct lib_ring_buffer *bufb,
+                       uint64_t *id);
+};
+
+struct lttng_counter_ops {
+       struct lib_counter *(*counter_create)(size_t nr_dimensions,
+                       const size_t *max_nr_elem,      /* for each dimension */
+                       int64_t global_sum_step);
+       void (*counter_destroy)(struct lib_counter *counter);
+       int (*counter_add)(struct lib_counter *counter, const size_t *dimension_indexes,
+                       int64_t v);
+       /*
+        * counter_read reads a specific cpu's counter if @cpu >= 0, or
+        * the global aggregation counter if @cpu == -1.
+        */
+       int (*counter_read)(struct lib_counter *counter, const size_t *dimension_indexes, int cpu,
+                        int64_t *value, bool *overflow, bool *underflow);
+       /*
+        * counter_aggregate returns the total sum of all per-cpu counters and
+        * the global aggregation counter.
+        */
+       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);
+};
+
+struct lttng_counter {
+       struct file *file;              /* File associated to counter. */
+       struct file *owner;
+       struct lttng_counter_transport *transport;
+       struct lib_counter *counter;
+       struct lttng_counter_ops *ops;
+};
+
+struct lttng_event_notifier_group {
+       struct file *file;              /* File associated to event notifier group */
+       struct file *notif_file;        /* File used to expose notifications to userspace. */
+       struct list_head node;          /* event notifier group list */
+       struct list_head enablers_head; /* List of enablers */
+       struct list_head event_notifiers_head; /* List of event notifier */
+       struct lttng_event_notifier_ht event_notifiers_ht; /* Hash table of event notifiers */
+       struct lttng_kernel_channel_buffer_ops *ops;
+       struct lttng_transport *transport;
+       struct channel *chan;           /* Ring buffer channel for event notifier group. */
+       struct lib_ring_buffer *buf;    /* Ring buffer for event notifier group. */
+       wait_queue_head_t read_wait;
+       struct irq_work wakeup_pending; /* Pending wakeup irq work. */
+       struct lttng_kernel_event_notifier *sc_unknown; /* for unknown syscalls */
+       struct lttng_kernel_event_notifier *sc_compat_unknown;
+
+       struct lttng_syscall_filter *sc_filter;
+
+       struct hlist_head *event_notifier_syscall_dispatch;
+       struct hlist_head *event_notifier_compat_syscall_dispatch;
+       struct hlist_head *event_notifier_exit_syscall_dispatch;
+       struct hlist_head *event_notifier_exit_compat_syscall_dispatch;
+
+       struct hlist_head event_notifier_unknown_syscall_dispatch;
+       struct hlist_head event_notifier_compat_unknown_syscall_dispatch;
+       struct hlist_head event_notifier_exit_unknown_syscall_dispatch;
+       struct hlist_head event_notifier_exit_compat_unknown_syscall_dispatch;
+
+       int syscall_all_entry;
+       int syscall_all_exit;
+
+       unsigned int sys_enter_registered:1, sys_exit_registered:1;
+
+       struct lttng_counter *error_counter;
+       size_t error_counter_len;
+};
+
+struct lttng_transport {
+       char *name;
+       struct module *owner;
+       struct list_head node;
+       struct lttng_kernel_channel_buffer_ops ops;
+};
+
+struct lttng_counter_transport {
+       char *name;
+       struct module *owner;
+       struct list_head node;
+       struct lttng_counter_ops ops;
+};
+
+struct lttng_kernel_session_private {
+       struct lttng_kernel_session *pub;       /* Public session interface */
+
+       int been_active;                        /* Has trace session been active ? */
+       struct file *file;                      /* File associated to session */
+       struct list_head chan;                  /* Channel list head */
+       struct list_head events;                /* Event list head */
+       struct list_head list;                  /* Session list */
+       unsigned int free_chan_id;              /* Next chan ID to allocate */
+       uuid_le uuid;                           /* Trace session unique ID */
+       struct lttng_metadata_cache *metadata_cache;
+       unsigned int metadata_dumped:1,
+               tstate:1;                       /* Transient enable state */
+       /* List of event enablers */
+       struct list_head enablers_head;
+       /* Hash table of events */
+       struct lttng_event_ht events_ht;
+       char name[LTTNG_KERNEL_ABI_SESSION_NAME_LEN];
+       char creation_time[LTTNG_KERNEL_ABI_SESSION_CREATION_TIME_ISO8601_LEN];
+};
+
+struct lttng_id_hash_node {
+       struct hlist_node hlist;
+       int id;
+};
+
+enum tracker_type {
+       TRACKER_PID,
+       TRACKER_VPID,
+       TRACKER_UID,
+       TRACKER_VUID,
+       TRACKER_GID,
+       TRACKER_VGID,
+
+       TRACKER_UNKNOWN,
+};
+
+struct lttng_kernel_id_tracker_private {
+       struct lttng_kernel_id_tracker *pub;    /* Public interface */
+
+       struct lttng_kernel_session *session;
+       enum tracker_type tracker_type;
+};
+
 extern struct lttng_kernel_ctx *lttng_static_ctx;
 
 static inline
@@ -785,12 +993,12 @@ int lttng_fix_pending_event_notifiers(void);
 int lttng_session_active(void);
 bool lttng_event_notifier_active(void);
 
-struct lttng_session *lttng_session_create(void);
-int lttng_session_enable(struct lttng_session *session);
-int lttng_session_disable(struct lttng_session *session);
-void lttng_session_destroy(struct lttng_session *session);
-int lttng_session_metadata_regenerate(struct lttng_session *session);
-int lttng_session_statedump(struct lttng_session *session);
+struct lttng_kernel_session *lttng_session_create(void);
+int lttng_session_enable(struct lttng_kernel_session *session);
+int lttng_session_disable(struct lttng_kernel_session *session);
+void lttng_session_destroy(struct lttng_kernel_session *session);
+int lttng_session_metadata_regenerate(struct lttng_kernel_session *session);
+int lttng_session_statedump(struct lttng_kernel_session *session);
 void metadata_cache_destroy(struct kref *kref);
 
 struct lttng_counter *lttng_kernel_counter_create(
@@ -811,14 +1019,14 @@ int lttng_event_notifier_group_create_error_counter(
 void lttng_event_notifier_group_destroy(
                struct lttng_event_notifier_group *event_notifier_group);
 
-struct lttng_channel *lttng_channel_create(struct lttng_session *session,
+struct lttng_channel *lttng_channel_create(struct lttng_kernel_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,
                                       enum channel_type channel_type);
-struct lttng_channel *lttng_global_channel_create(struct lttng_session *session,
+struct lttng_channel *lttng_global_channel_create(struct lttng_kernel_session *session,
                                       int overwrite, void *buf_addr,
                                       size_t subbuf_size, size_t num_subbuf,
                                       unsigned int switch_timer_interval,
@@ -878,17 +1086,21 @@ int lttng_metadata_output_channel(struct lttng_metadata_stream *stream,
                struct channel *chan, bool *coherent);
 
 int lttng_id_tracker_get_node_id(const struct lttng_id_hash_node *node);
-int lttng_id_tracker_empty_set(struct lttng_id_tracker *lf);
-void lttng_id_tracker_destroy(struct lttng_id_tracker *lf, bool rcu);
-int lttng_id_tracker_add(struct lttng_id_tracker *lf, int id);
-int lttng_id_tracker_del(struct lttng_id_tracker *lf, int id);
-
-int lttng_session_track_id(struct lttng_session *session,
+int lttng_id_tracker_empty_set(struct lttng_kernel_id_tracker *lf);
+int lttng_id_tracker_init(struct lttng_kernel_id_tracker *lf,
+               struct lttng_kernel_session *session,
+               enum tracker_type type);
+void lttng_id_tracker_fini(struct lttng_kernel_id_tracker *lf);
+void lttng_id_tracker_destroy(struct lttng_kernel_id_tracker *lf, bool rcu);
+int lttng_id_tracker_add(struct lttng_kernel_id_tracker *lf, int id);
+int lttng_id_tracker_del(struct lttng_kernel_id_tracker *lf, int id);
+
+int lttng_session_track_id(struct lttng_kernel_session *session,
                enum tracker_type tracker_type, int id);
-int lttng_session_untrack_id(struct lttng_session *session,
+int lttng_session_untrack_id(struct lttng_kernel_session *session,
                enum tracker_type tracker_type, int id);
 
-int lttng_session_list_tracker_ids(struct lttng_session *session,
+int lttng_session_list_tracker_ids(struct lttng_kernel_session *session,
                enum tracker_type tracker_type);
 
 void lttng_clock_ref(void);
@@ -901,7 +1113,7 @@ int lttng_probes_init(void);
 int lttng_logger_init(void);
 void lttng_logger_exit(void);
 
-extern int lttng_statedump_start(struct lttng_session *session);
+extern int lttng_statedump_start(struct lttng_kernel_session *session);
 
 int lttng_calibrate(struct lttng_kernel_abi_calibrate *calibrate);
 
This page took 0.026174 seconds and 4 git commands to generate.