SoW-2019-0002: Dynamic Snapshot
[deliverable/lttng-modules.git] / lttng-events.h
index 78b427a317d18972e9cea252b62154fc11b66b4d..b06360b9dfcd397d858b93053e90b8107bfebf63 100644 (file)
@@ -20,6 +20,7 @@
 #include <lttng-tracer.h>
 #include <lttng-abi.h>
 #include <lttng-abi-old.h>
+#include <linux/irq_work.h>
 
 #define lttng_is_signed_type(type)     (((type)(-1)) < 0)
 
@@ -188,6 +189,7 @@ struct lttng_perf_counter_field {
 
 struct lttng_probe_ctx {
        struct lttng_event *event;
+       struct lttng_trigger *trigger; // Not sure if we will ever need it.
        uint8_t interruptible;
 };
 
@@ -230,6 +232,7 @@ struct lttng_event_desc {
        const struct lttng_event_field *fields; /* event payload */
        unsigned int nr_fields;
        struct module *owner;
+       void *trigger_callback;
 };
 
 struct lttng_probe_desc {
@@ -274,7 +277,7 @@ struct lttng_bytecode_runtime {
                        const char *filter_stack_data);
        int link_failed;
        struct list_head node;  /* list of bytecode runtime in event */
-       struct lttng_event *event;
+       struct lttng_ctx *ctx;
 };
 
 /*
@@ -286,12 +289,31 @@ struct lttng_enabler_ref {
 };
 
 struct lttng_uprobe_handler {
-       struct lttng_event *event;
+       union {
+               struct lttng_event *event;
+               struct lttng_trigger *trigger;
+       } u;
        loff_t offset;
        struct uprobe_consumer up_consumer;
        struct list_head node;
 };
 
+struct lttng_kprobe {
+       struct kprobe kp;
+       char *symbol_name;
+};
+
+struct lttng_uprobe {
+       struct inode *inode;
+       struct list_head head;
+};
+
+struct lttng_syscall {
+       struct list_head node;                  /* chain registered syscall trigger */
+       unsigned int syscall_id;
+       bool is_compat;
+};
+
 /*
  * lttng_event structure is referred to by the tracing fast path. It must be
  * kept small.
@@ -306,10 +328,7 @@ struct lttng_event {
        struct lttng_ctx *ctx;
        enum lttng_kernel_instrumentation instrumentation;
        union {
-               struct {
-                       struct kprobe kp;
-                       char *symbol_name;
-               } kprobe;
+               struct lttng_kprobe kprobe;
                struct {
                        struct lttng_krp *lttng_krp;
                        char *symbol_name;
@@ -317,10 +336,7 @@ struct lttng_event {
                struct {
                        char *symbol_name;
                } ftrace;
-               struct {
-                       struct inode *inode;
-                       struct list_head head;
-               } uprobe;
+               struct lttng_uprobe uprobe;
        } u;
        struct list_head list;          /* Event list in session */
        unsigned int metadata_dumped:1;
@@ -334,9 +350,37 @@ struct lttng_event {
        int has_enablers_without_bytecode;
 };
 
-enum lttng_enabler_type {
-       LTTNG_ENABLER_STAR_GLOB,
-       LTTNG_ENABLER_NAME,
+// FIXME: Really similar to lttng_event above. Could those be merged ?
+struct lttng_trigger {
+       enum lttng_event_type evtype;   /* First field. */
+       uint64_t id;
+       int enabled;
+       int registered;                 /* has reg'd tracepoint probe */
+       const struct lttng_event_desc *desc;
+       void *filter;
+       struct list_head list;          /* Trigger list in trigger group */
+
+       enum lttng_kernel_instrumentation instrumentation;
+       union {
+               struct lttng_kprobe kprobe;
+               struct lttng_uprobe uprobe;
+               struct lttng_syscall syscall;
+       } u;
+
+       /* Backward references: list of lttng_enabler_ref (ref to enablers) */
+       struct list_head enablers_ref_head;
+       struct hlist_node hlist;        /* session ht of triggers */
+       /* list of struct lttng_bytecode_runtime, sorted by seqnum */
+       struct list_head bytecode_runtime_head;
+       int has_enablers_without_bytecode;
+
+       void (*send_notification)(struct lttng_trigger *trigger);
+       struct lttng_trigger_group *group; /* Weak ref */
+};
+
+enum lttng_enabler_format_type {
+       LTTNG_ENABLER_FORMAT_STAR_GLOB,
+       LTTNG_ENABLER_FORMAT_NAME,
 };
 
 /*
@@ -346,21 +390,50 @@ enum lttng_enabler_type {
 struct lttng_enabler {
        enum lttng_event_type evtype;   /* First field. */
 
-       enum lttng_enabler_type type;
+       enum lttng_enabler_format_type format_type;
 
-       struct list_head node;  /* per-session list of enablers */
        /* head list of struct lttng_ust_filter_bytecode_node */
        struct list_head filter_bytecode_head;
 
        struct lttng_kernel_event event_param;
+       unsigned int enabled:1;
+};
+
+struct lttng_event_enabler {
+       struct lttng_enabler base;
+       struct list_head node;  /* per-session list of enablers */
        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;
 };
 
+struct lttng_trigger_enabler {
+       struct lttng_enabler base;
+       uint64_t id;
+       struct list_head node;  /* List of trigger enablers */
+       struct lttng_trigger_group *group;
+};
+
+static inline
+struct lttng_enabler *lttng_event_enabler_as_enabler(
+               struct lttng_event_enabler *event_enabler)
+{
+       return &event_enabler->base;
+}
+
+static inline
+struct lttng_enabler *lttng_trigger_enabler_as_enabler(
+               struct lttng_trigger_enabler *trigger_enabler)
+{
+       return &trigger_enabler->base;
+}
+
 struct lttng_channel_ops {
        struct channel *(*channel_create)(const char *name,
-                               struct lttng_channel *lttng_chan,
+                               void *priv,
                                void *buf_addr,
                                size_t subbuf_size, size_t num_subbuf,
                                unsigned int switch_timer_interval,
@@ -437,6 +510,13 @@ struct lttng_event_ht {
        struct hlist_head table[LTTNG_EVENT_HT_SIZE];
 };
 
+#define LTTNG_TRIGGER_HT_BITS          12
+#define LTTNG_TRIGGER_HT_SIZE          (1U << LTTNG_TRIGGER_HT_BITS)
+
+struct lttng_trigger_ht {
+       struct hlist_head table[LTTNG_TRIGGER_HT_SIZE];
+};
+
 struct lttng_channel {
        unsigned int id;
        struct channel *chan;           /* Channel buffers */
@@ -539,14 +619,36 @@ struct lttng_session {
        struct lttng_id_tracker vgid_tracker;
        unsigned int metadata_dumped:1,
                tstate:1;               /* Transient enable state */
-       /* List of enablers */
+       /* List of event enablers */
        struct list_head enablers_head;
-       /* Hash table of events */
+/* Hash table of events */
        struct lttng_event_ht events_ht;
        char name[LTTNG_KERNEL_SESSION_NAME_LEN];
        char creation_time[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN];
 };
 
+struct lttng_trigger_group {
+       struct file *file;              /* File associated to trigger group */
+       struct file *notif_file;        /* File used to expose notifications to userspace. */
+       struct list_head node;          /* Trigger group list */
+       struct list_head enablers_head; /* List of enablers */
+       struct list_head triggers_head; /* List of triggers */
+       struct lttng_trigger_ht triggers_ht; /* Hash table of triggers */
+       struct lttng_ctx *ctx;              /* Contexts for filters. */
+       struct lttng_channel_ops *ops;
+       struct lttng_transport *transport;
+       struct channel *chan;           /* Ring buffer channel for trigger group. */
+       struct lib_ring_buffer *buf;    /* Ring buffer for trigger group. */
+       wait_queue_head_t read_wait;
+       struct irq_work wakeup_pending; /* Pending wakeup irq work. */
+
+       struct list_head *trigger_syscall_dispatch;
+       struct list_head *trigger_compat_syscall_dispatch;
+
+       unsigned int syscall_all:1,
+               sys_enter_registered:1;
+};
+
 struct lttng_metadata_cache {
        char *data;                     /* Metadata cache */
        unsigned int cache_alloc;       /* Metadata allocated size (bytes) */
@@ -563,14 +665,24 @@ void lttng_unlock_sessions(void);
 
 struct list_head *lttng_get_probe_list_head(void);
 
-struct lttng_enabler *lttng_enabler_create(enum lttng_enabler_type type,
+struct lttng_event_enabler *lttng_event_enabler_create(
+               enum lttng_enabler_format_type format_type,
                struct lttng_kernel_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_event_enabler_enable(struct lttng_event_enabler *event_enabler);
+int lttng_event_enabler_disable(struct lttng_event_enabler *event_enabler);
+struct lttng_trigger_enabler *lttng_trigger_enabler_create(
+               struct lttng_trigger_group *trigger_group,
+               enum lttng_enabler_format_type format_type,
+               struct lttng_kernel_trigger *trigger_param);
+
+int lttng_trigger_enabler_enable(struct lttng_trigger_enabler *trigger_enabler);
+int lttng_trigger_enabler_disable(struct lttng_trigger_enabler *trigger_enabler);
 int lttng_fix_pending_events(void);
+int lttng_fix_pending_triggers(void);
 int lttng_session_active(void);
+bool lttng_trigger_active(void);
 
 struct lttng_session *lttng_session_create(void);
 int lttng_session_enable(struct lttng_session *session);
@@ -580,6 +692,9 @@ int lttng_session_metadata_regenerate(struct lttng_session *session);
 int lttng_session_statedump(struct lttng_session *session);
 void metadata_cache_destroy(struct kref *kref);
 
+struct lttng_trigger_group *lttng_trigger_group_create(void);
+void lttng_trigger_group_destroy(struct lttng_trigger_group *trigger_group);
+
 struct lttng_channel *lttng_channel_create(struct lttng_session *session,
                                       const char *transport_name,
                                       void *buf_addr,
@@ -609,11 +724,29 @@ struct lttng_event *lttng_event_compat_old_create(struct lttng_channel *chan,
                void *filter,
                const struct lttng_event_desc *internal_desc);
 
+struct lttng_trigger *lttng_trigger_create(
+                               const struct lttng_event_desc *trigger_desc,
+                               uint64_t id,
+                               struct lttng_trigger_group *trigger_group,
+                               struct lttng_kernel_trigger *trigger_param,
+                               void *filter,
+                               enum lttng_kernel_instrumentation itype);
+struct lttng_trigger *_lttng_trigger_create(
+                               const struct lttng_event_desc *trigger_desc,
+                               uint64_t id,
+                               struct lttng_trigger_group *trigger_group,
+                               struct lttng_kernel_trigger *trigger_param,
+                               void *filter,
+                               enum lttng_kernel_instrumentation itype);
+
 int lttng_channel_enable(struct lttng_channel *channel);
 int lttng_channel_disable(struct lttng_channel *channel);
 int lttng_event_enable(struct lttng_event *event);
 int lttng_event_disable(struct lttng_event *event);
 
+int lttng_trigger_enable(struct lttng_trigger *trigger);
+int lttng_trigger_disable(struct lttng_trigger *trigger);
+
 void lttng_transport_register(struct lttng_transport *transport);
 void lttng_transport_unregister(struct lttng_transport *transport);
 
@@ -625,8 +758,8 @@ void lttng_abi_compat_old_exit(void);
 
 int lttng_probe_register(struct lttng_probe_desc *desc);
 void lttng_probe_unregister(struct lttng_probe_desc *desc);
-const struct lttng_event_desc *lttng_event_get(const char *name);
-void lttng_event_put(const struct lttng_event_desc *desc);
+const struct lttng_event_desc *lttng_event_desc_get(const char *name);
+void lttng_event_desc_put(const struct lttng_event_desc *desc);
 int lttng_probes_init(void);
 void lttng_probes_exit(void);
 
@@ -651,33 +784,43 @@ int lttng_session_list_tracker_ids(struct lttng_session *session,
 void lttng_clock_ref(void);
 void lttng_clock_unref(void);
 
+int lttng_desc_match_enabler(const struct lttng_event_desc *desc,
+               struct lttng_enabler *enabler);
+
 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
-int lttng_syscalls_register(struct lttng_channel *chan, void *filter);
-int lttng_syscalls_unregister(struct lttng_channel *chan);
-int lttng_syscall_filter_enable(struct lttng_channel *chan,
+int lttng_syscalls_register_event(struct lttng_channel *chan, void *filter);
+int lttng_syscalls_unregister_event(struct lttng_channel *chan);
+int lttng_syscall_filter_enable_event(struct lttng_channel *chan,
                const char *name);
-int lttng_syscall_filter_disable(struct lttng_channel *chan,
+int lttng_syscall_filter_disable_event(struct lttng_channel *chan,
                const char *name);
 long lttng_channel_syscall_mask(struct lttng_channel *channel,
                struct lttng_kernel_syscall_mask __user *usyscall_mask);
+
+int lttng_syscalls_register_trigger(struct lttng_trigger_enabler *trigger_enabler, void *filter);
+int lttng_syscals_create_matching_triggers(struct lttng_trigger_enabler *trigger_enabler, void *filter);
+int lttng_syscalls_unregister_trigger(struct lttng_trigger_group *group);
+int lttng_syscall_filter_enable_trigger(struct lttng_trigger *trigger);
+int lttng_syscall_filter_disable_trigger(struct lttng_trigger *trigger);
 #else
-static inline int lttng_syscalls_register(struct lttng_channel *chan, void *filter)
+static inline int lttng_syscalls_register_event(
+               struct lttng_channel *chan, void *filter)
 {
        return -ENOSYS;
 }
 
-static inline int lttng_syscalls_unregister(struct lttng_channel *chan)
+static inline int lttng_syscalls_unregister_event(struct lttng_channel *chan)
 {
        return 0;
 }
 
-static inline int lttng_syscall_filter_enable(struct lttng_channel *chan,
+static inline int lttng_syscall_filter_enable_event(struct lttng_channel *chan,
                const char *name)
 {
        return -ENOSYS;
 }
 
-static inline int lttng_syscall_filter_disable(struct lttng_channel *chan,
+static inline int lttng_syscall_filter_disable_event(struct lttng_channel *chan,
                const char *name)
 {
        return -ENOSYS;
@@ -688,12 +831,41 @@ static inline long lttng_channel_syscall_mask(struct lttng_channel *channel,
 {
        return -ENOSYS;
 }
+
+static inline int lttng_syscalls_register_trigger(
+               struct lttng_trigger_group *group, void *filter)
+{
+       return -ENOSYS;
+}
+
+static inline int lttng_syscalls_unregister_trigger(struct lttng_trigger_group *group)
+{
+       return 0;
+}
+
+static inline int lttng_syscall_filter_enable_trigger(struct lttng_trigger_group *group,
+               const char *name)
+{
+       return -ENOSYS;
+}
+
+static inline int lttng_syscall_filter_disable_trigger(struct lttng_trigger_group *group,
+               const char *name)
+{
+       return -ENOSYS;
+}
+
 #endif
 
 void lttng_filter_sync_state(struct lttng_bytecode_runtime *runtime);
-int lttng_enabler_attach_bytecode(struct lttng_enabler *enabler,
+int lttng_event_enabler_attach_bytecode(struct lttng_event_enabler *event_enabler,
+               struct lttng_kernel_filter_bytecode __user *bytecode);
+int lttng_trigger_enabler_attach_bytecode(struct lttng_trigger_enabler *trigger_enabler,
                struct lttng_kernel_filter_bytecode __user *bytecode);
-void lttng_enabler_event_link_bytecode(struct lttng_event *event,
+
+void lttng_enabler_link_bytecode(const struct lttng_event_desc *event_desc,
+               struct lttng_ctx *ctx,
+               struct list_head *bytecode_runtime_head,
                struct lttng_enabler *enabler);
 
 int lttng_probes_init(void);
@@ -872,16 +1044,22 @@ void lttng_logger_exit(void);
 extern int lttng_statedump_start(struct lttng_session *session);
 
 #ifdef CONFIG_KPROBES
-int lttng_kprobes_register(const char *name,
+int lttng_kprobes_register_event(const char *name,
                const char *symbol_name,
                uint64_t offset,
                uint64_t addr,
                struct lttng_event *event);
-void lttng_kprobes_unregister(struct lttng_event *event);
-void lttng_kprobes_destroy_private(struct lttng_event *event);
+void lttng_kprobes_unregister_event(struct lttng_event *event);
+void lttng_kprobes_destroy_event_private(struct lttng_event *event);
+int lttng_kprobes_register_trigger(const char *symbol_name,
+               uint64_t offset,
+               uint64_t addr,
+               struct lttng_trigger *trigger);
+void lttng_kprobes_unregister_trigger(struct lttng_trigger *trigger);
+void lttng_kprobes_destroy_trigger_private(struct lttng_trigger *trigger);
 #else
 static inline
-int lttng_kprobes_register(const char *name,
+int lttng_kprobes_register_event(const char *name,
                const char *symbol_name,
                uint64_t offset,
                uint64_t addr,
@@ -891,12 +1069,31 @@ int lttng_kprobes_register(const char *name,
 }
 
 static inline
-void lttng_kprobes_unregister(struct lttng_event *event)
+void lttng_kprobes_unregister_event(struct lttng_event *event)
 {
 }
 
 static inline
-void lttng_kprobes_destroy_private(struct lttng_event *event)
+void lttng_kprobes_destroy_event_private(struct lttng_event *event)
+{
+}
+
+static inline
+int lttng_kprobes_register_trigger(const char *symbol_name,
+               uint64_t offset,
+               uint64_t addr,
+               struct lttng_trigger *trigger)
+{
+       return -ENOSYS;
+}
+
+static inline
+void lttng_kprobes_unregister_trigger(struct lttng_trigger *trigger)
+{
+}
+
+static inline
+void lttng_kprobes_destroy_trigger_private(struct lttng_trigger *trigger)
 {
 }
 #endif
@@ -904,35 +1101,68 @@ void lttng_kprobes_destroy_private(struct lttng_event *event)
 int lttng_event_add_callsite(struct lttng_event *event,
        struct lttng_kernel_event_callsite *callsite);
 
+int lttng_trigger_add_callsite(struct lttng_trigger *trigger,
+       struct lttng_kernel_event_callsite *callsite);
+
 #ifdef CONFIG_UPROBES
-int lttng_uprobes_register(const char *name,
+int lttng_uprobes_register_event(const char *name,
        int fd, struct lttng_event *event);
-int lttng_uprobes_add_callsite(struct lttng_event *event,
+int lttng_uprobes_event_add_callsite(struct lttng_event *event,
        struct lttng_kernel_event_callsite *callsite);
-void lttng_uprobes_unregister(struct lttng_event *event);
-void lttng_uprobes_destroy_private(struct lttng_event *event);
+void lttng_uprobes_unregister_event(struct lttng_event *event);
+void lttng_uprobes_destroy_event_private(struct lttng_event *event);
+int lttng_uprobes_register_trigger(const char *name,
+       int fd, struct lttng_trigger *trigger);
+int lttng_uprobes_trigger_add_callsite(struct lttng_trigger *trigger,
+       struct lttng_kernel_event_callsite *callsite);
+void lttng_uprobes_unregister_trigger(struct lttng_trigger *trigger);
+void lttng_uprobes_destroy_trigger_private(struct lttng_trigger *trigger);
 #else
 static inline
-int lttng_uprobes_register(const char *name,
+int lttng_uprobes_register_event(const char *name,
        int fd, struct lttng_event *event)
 {
        return -ENOSYS;
 }
 
 static inline
-int lttng_uprobes_add_callsite(struct lttng_event *event,
+int lttng_uprobes_event_add_callsite(struct lttng_event *event,
+       struct lttng_kernel_event_callsite *callsite)
+{
+       return -ENOSYS;
+}
+
+static inline
+void lttng_uprobes_unregister_event(struct lttng_event *event)
+{
+}
+
+static inline
+void lttng_uprobes_destroy_event_private(struct lttng_event *event)
+{
+}
+
+static inline
+int lttng_uprobes_register_trigger(const char *name,
+       int fd, struct lttng_trigger *trigger)
+{
+       return -ENOSYS;
+}
+
+static inline
+int lttng_uprobes_trigger_add_callsite(struct lttng_trigger *trigger,
        struct lttng_kernel_event_callsite *callsite)
 {
        return -ENOSYS;
 }
 
 static inline
-void lttng_uprobes_unregister(struct lttng_event *event)
+void lttng_uprobes_unregister_trigger(struct lttng_trigger *trigger)
 {
 }
 
 static inline
-void lttng_uprobes_destroy_private(struct lttng_event *event)
+void lttng_uprobes_destroy_trigger_private(struct lttng_trigger *trigger)
 {
 }
 #endif
This page took 0.0316 seconds and 5 git commands to generate.