Refactoring: uprobes: combine common code between recorder and notifier
[lttng-modules.git] / include / lttng / events-internal.h
index cd560de84a8cb88e8af43efa56501b60fa08850b..d72502c9b0a8ee8a6b912a5cc846a46fe1058ca3 100644 (file)
@@ -8,6 +8,8 @@
 #ifndef _LTTNG_EVENTS_INTERNAL_H
 #define _LTTNG_EVENTS_INTERNAL_H
 
+#include <wrapper/compiler_attributes.h>
+
 #include <lttng/events.h>
 
 struct lttng_syscall_filter;
@@ -31,7 +33,7 @@ enum channel_type {
  */
 struct lttng_enabler_ref {
        struct list_head node;                  /* enabler ref list */
-       struct lttng_enabler *ref;              /* backward ref */
+       struct lttng_event_enabler_common *ref;         /* backward ref */
 };
 
 struct lttng_krp;                              /* Kretprobe handling */
@@ -117,27 +119,41 @@ struct lttng_kernel_event_notifier_private {
 
 };
 
-struct lttng_kernel_channel_common_private {
-       struct lttng_kernel_channel_common *pub;
-
-       struct file *file;                      /* File associated to channel */
+struct lttng_kernel_syscall_table {
        unsigned int sys_enter_registered:1,
-               sys_exit_registered:1,
-               tstate:1;                       /* Transient enable state */
+               sys_exit_registered:1;
+
+       struct hlist_head *syscall_dispatch;            /* for syscall tracing */
+       struct hlist_head *compat_syscall_dispatch;
+       struct hlist_head *syscall_exit_dispatch;       /* for syscall exit tracing */
+       struct hlist_head *compat_syscall_exit_dispatch;
+
+       /*
+        * Combining all unknown syscall events works as long as they
+        * are only matched by "all" syscalls enablers, but will require
+        * a design change when we allow matching by syscall number, for
+        * instance by allocating sc_tables accomodating NR_syscalls
+        * entries.
+        */
+       struct hlist_head unknown_syscall_dispatch;     /* for unknown syscalls */
+       struct hlist_head compat_unknown_syscall_dispatch;
+       struct hlist_head unknown_syscall_exit_dispatch;
+       struct hlist_head compat_unknown_syscall_exit_dispatch;
 
-       struct hlist_head *sc_table;            /* for syscall tracing */
-       struct hlist_head *compat_sc_table;
-       struct hlist_head *sc_exit_table;       /* for syscall exit tracing */
-       struct hlist_head *compat_sc_exit_table;
-       struct hlist_head sc_unknown;           /* for unknown syscalls */
-       struct hlist_head sc_compat_unknown;
-       struct hlist_head sc_exit_unknown;
-       struct hlist_head compat_sc_exit_unknown;
        struct lttng_syscall_filter *sc_filter;
        int syscall_all_entry;
        int syscall_all_exit;
 };
 
+struct lttng_kernel_channel_common_private {
+       struct lttng_kernel_channel_common *pub;
+
+       struct file *file;                      /* File associated to channel */
+       unsigned int tstate:1;                  /* Transient enable state */
+
+       struct lttng_kernel_syscall_table syscall_table;
+};
+
 struct lttng_kernel_channel_buffer_private {
        struct lttng_kernel_channel_common_private parent;
 
@@ -176,10 +192,15 @@ enum lttng_kernel_bytecode_type {
        LTTNG_KERNEL_BYTECODE_TYPE_CAPTURE,
 };
 
+enum lttng_kernel_event_enabler_type {
+       LTTNG_EVENT_ENABLER_TYPE_RECORDER,
+       LTTNG_EVENT_ENABLER_TYPE_NOTIFIER,
+};
+
 struct lttng_kernel_bytecode_node {
        enum lttng_kernel_bytecode_type type;
        struct list_head node;
-       struct lttng_enabler *enabler;
+       struct lttng_event_enabler_common *enabler;
        struct {
                uint32_t len;
                uint32_t reloc_offset;
@@ -205,7 +226,8 @@ struct lttng_kernel_bytecode_runtime {
  * Enabler field, within whatever object is enabling an event. Target of
  * backward reference.
  */
-struct lttng_enabler {
+struct lttng_event_enabler_common {
+       enum lttng_kernel_event_enabler_type enabler_type;
        enum lttng_enabler_format_type format_type;
 
        /* head list of struct lttng_kernel_bytecode_node */
@@ -217,14 +239,15 @@ struct lttng_enabler {
        uint64_t user_token;            /* User-provided token. */
 };
 
-struct lttng_event_enabler {
-       struct lttng_enabler base;
-       struct list_head node;  /* per-session list of enablers */
+struct lttng_event_recorder_enabler {
+       struct lttng_event_enabler_common parent;
+       struct list_head node;          /* per-session list of enablers */
+       bool published;                 /* published in per-session list. */
        struct lttng_kernel_channel_buffer *chan;
 };
 
 struct lttng_event_notifier_enabler {
-       struct lttng_enabler base;
+       struct lttng_event_enabler_common parent;
        uint64_t error_counter_index;
        struct list_head node;  /* List of event_notifier enablers */
        struct lttng_event_notifier_group *group;
@@ -407,25 +430,8 @@ struct lttng_event_notifier_group {
        struct lttng_kernel_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_kernel_syscall_table syscall_table;
 
        struct lttng_counter *error_counter;
        size_t error_counter_len;
@@ -561,9 +567,12 @@ static inline bool lttng_kernel_type_is_bytewise_integer(const struct lttng_kern
        if (!type_integer)
                return false;
        switch (type_integer->size) {
-       case 8:         /* Fall-through. */
-       case 16:        /* Fall-through. */
-       case 32:        /* Fall-through. */
+       case 8:
+               lttng_fallthrough;
+       case 16:
+               lttng_fallthrough;
+       case 32:
+               lttng_fallthrough;
        case 64:
                break;
        default:
@@ -578,17 +587,17 @@ int lttng_kernel_interpret_event_filter(const struct lttng_kernel_event_common *
                void *event_filter_ctx);
 
 static inline
-struct lttng_enabler *lttng_event_enabler_as_enabler(
-               struct lttng_event_enabler *event_enabler)
+struct lttng_event_enabler_common *lttng_event_recorder_enabler_as_enabler(
+               struct lttng_event_recorder_enabler *event_recorder_enabler)
 {
-       return &event_enabler->base;
+       return &event_recorder_enabler->parent;
 }
 
 static inline
-struct lttng_enabler *lttng_event_notifier_enabler_as_enabler(
+struct lttng_event_enabler_common *lttng_event_notifier_enabler_as_enabler(
                struct lttng_event_notifier_enabler *event_notifier_enabler)
 {
-       return &event_notifier_enabler->base;
+       return &event_notifier_enabler->parent;
 }
 
 int lttng_context_init(void);
@@ -770,34 +779,29 @@ int lttng_cpuhp_perf_counter_dead(unsigned int cpu,
 }
 #endif
 
-struct lttng_event_enabler *lttng_event_enabler_create(
+struct lttng_event_recorder_enabler *lttng_event_recorder_enabler_create(
                enum lttng_enabler_format_type format_type,
                struct lttng_kernel_abi_event *event_param,
                struct lttng_kernel_channel_buffer *chan);
+void lttng_event_enabler_session_add(struct lttng_kernel_session *session,
+               struct lttng_event_recorder_enabler *event_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_event_notifier_enabler *lttng_event_notifier_enabler_create(
                struct lttng_event_notifier_group *event_notifier_group,
                enum lttng_enabler_format_type format_type,
                struct lttng_kernel_abi_event_notifier *event_notifier_param);
-
-int lttng_event_notifier_enabler_enable(
-               struct lttng_event_notifier_enabler *event_notifier_enabler);
-int lttng_event_notifier_enabler_disable(
-               struct lttng_event_notifier_enabler *event_notifier_enabler);
-
-int lttng_event_enabler_attach_filter_bytecode(struct lttng_event_enabler *event_enabler,
-               struct lttng_kernel_abi_filter_bytecode __user *bytecode);
-int lttng_event_notifier_enabler_attach_filter_bytecode(
-               struct lttng_event_notifier_enabler *event_notifier_enabler,
-               struct lttng_kernel_abi_filter_bytecode __user *bytecode);
 int lttng_event_notifier_enabler_attach_capture_bytecode(
                struct lttng_event_notifier_enabler *event_notifier_enabler,
                struct lttng_kernel_abi_capture_bytecode __user *bytecode);
 
+int lttng_event_enabler_enable(struct lttng_event_enabler_common *event_enabler);
+int lttng_event_enabler_disable(struct lttng_event_enabler_common *event_enabler);
+int lttng_event_enabler_attach_filter_bytecode(struct lttng_event_enabler_common *event_enabler,
+               struct lttng_kernel_abi_filter_bytecode __user *bytecode);
+void lttng_event_enabler_destroy(struct lttng_event_enabler_common *event_enabler);
+
 int lttng_desc_match_enabler(const struct lttng_kernel_event_desc *desc,
-               struct lttng_enabler *enabler);
+               struct lttng_event_enabler_common *enabler);
 
 void lttng_enabler_link_bytecode(const struct lttng_kernel_event_desc *event_desc,
                struct lttng_kernel_ctx *ctx,
@@ -805,83 +809,51 @@ void lttng_enabler_link_bytecode(const struct lttng_kernel_event_desc *event_des
                struct list_head *enabler_bytecode_runtime_head);
 
 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
-int lttng_syscalls_register_event(struct lttng_event_enabler *event_enabler);
-int lttng_syscalls_unregister_channel(struct lttng_kernel_channel_buffer *chan);
-int lttng_syscalls_destroy_event(struct lttng_kernel_channel_buffer *chan);
-int lttng_syscall_filter_enable_event(
-               struct lttng_kernel_channel_buffer *chan,
-               struct lttng_kernel_event_recorder *event);
-int lttng_syscall_filter_disable_event(
-               struct lttng_kernel_channel_buffer *chan,
-               struct lttng_kernel_event_recorder *event);
+int lttng_syscalls_register_event(struct lttng_event_enabler_common *event_enabler);
+int lttng_syscall_filter_enable_event(struct lttng_kernel_event_common *event);
+int lttng_syscall_filter_disable_event(struct lttng_kernel_event_common *event);
+
+int lttng_syscalls_unregister_syscall_table(struct lttng_kernel_syscall_table *syscall_table);
+int lttng_syscalls_destroy_syscall_table(struct lttng_kernel_syscall_table *syscall_table);
 
 long lttng_channel_syscall_mask(struct lttng_kernel_channel_buffer *channel,
                struct lttng_kernel_abi_syscall_mask __user *usyscall_mask);
 
-int lttng_syscalls_register_event_notifier(
-               struct lttng_event_notifier_enabler *event_notifier_enabler);
 int lttng_syscalls_create_matching_event_notifiers(
                struct lttng_event_notifier_enabler *event_notifier_enabler);
-int lttng_syscalls_unregister_event_notifier_group(struct lttng_event_notifier_group *group);
-int lttng_syscall_filter_enable_event_notifier(struct lttng_kernel_event_notifier *event_notifier);
-int lttng_syscall_filter_disable_event_notifier(struct lttng_kernel_event_notifier *event_notifier);
 #else
-static inline int lttng_syscalls_register_event(
-               struct lttng_event_enabler *event_enabler)
+static inline int lttng_syscalls_register_event(struct lttng_event_enabler_common *event_enabler)
 {
        return -ENOSYS;
 }
 
-static inline int lttng_syscalls_unregister_channel(struct lttng_kernel_channel_buffer *chan)
-{
-       return 0;
-}
-
-static inline int lttng_syscalls_destroy(struct lttng_kernel_channel_buffer *chan)
-{
-       return 0;
-}
-
-static inline int lttng_syscall_filter_enable_event(struct lttng_kernel_channel_buffer *chan,
-               struct lttng_kernel_event_recorder *event);
+static inline int lttng_syscall_filter_enable_event(struct lttng_kernel_event_common *event)
 {
        return -ENOSYS;
 }
 
-static inline int lttng_syscall_filter_disable_event(struct lttng_kernel_channel_buffer *chan,
-               struct lttng_kernel_event_recorder *event);
+static inline int lttng_syscall_filter_disable_event(struct lttng_kernel_event_common *event)
 {
        return -ENOSYS;
 }
 
-static inline long lttng_channel_syscall_mask(struct lttng_kernel_channel_buffer *channel,
-               struct lttng_kernel_syscall_mask __user *usyscall_mask)
+static inline int lttng_syscalls_unregister_syscall_table(struct lttng_kernel_syscall_table *syscall_table)
 {
-       return -ENOSYS;
-}
-
-static inline int lttng_syscalls_register_event_notifier(
-               struct lttng_event_notifier_group *group)
-{
-       return -ENOSYS;
+       return 0;
 }
 
-static inline int lttng_syscalls_unregister_event_notifier_group(
-               struct lttng_event_notifier_group *group)
+static inline int lttng_syscalls_destroy_syscall_table(struct lttng_kernel_syscall_table *syscall_table)
 {
        return 0;
 }
 
-static inline int lttng_syscall_filter_enable_event_notifier(
-               struct lttng_event_notifier_group *group,
-               const char *name)
+static inline long lttng_channel_syscall_mask(struct lttng_kernel_channel_buffer *channel,
+               struct lttng_kernel_syscall_mask __user *usyscall_mask)
 {
        return -ENOSYS;
 }
 
-static inline int lttng_syscall_filter_disable_event_notifier(
-               struct lttng_event_notifier_group *group,
-               const char *name)
+static inline int lttng_syscalls_create_matching_event_notifiers(struct lttng_event_notifier_enabler *event_notifier_enabler)
 {
        return -ENOSYS;
 }
@@ -948,19 +920,15 @@ int lttng_event_add_callsite(struct lttng_kernel_event_common *event,
 
 #ifdef CONFIG_UPROBES
 int lttng_uprobes_register_event(const char *name,
-       int fd, struct lttng_kernel_event_recorder *event);
+       int fd, struct lttng_kernel_event_common *event);
 int lttng_uprobes_event_add_callsite(struct lttng_kernel_event_common *event,
        struct lttng_kernel_abi_event_callsite __user *callsite);
-void lttng_uprobes_unregister_event(struct lttng_kernel_event_recorder *event);
-void lttng_uprobes_destroy_event_private(struct lttng_kernel_event_recorder *event);
-int lttng_uprobes_register_event_notifier(const char *name,
-       int fd, struct lttng_kernel_event_notifier *event_notifier);
-void lttng_uprobes_unregister_event_notifier(struct lttng_kernel_event_notifier *event_notifier);
-void lttng_uprobes_destroy_event_notifier_private(struct lttng_kernel_event_notifier *event_notifier);
+void lttng_uprobes_unregister_event(struct lttng_kernel_event_common *event);
+void lttng_uprobes_destroy_event_private(struct lttng_kernel_event_common *event);
 #else
 static inline
 int lttng_uprobes_register_event(const char *name,
-       int fd, struct lttng_kernel_event_recorder *event)
+       int fd, struct lttng_kernel_event_common *event)
 {
        return -ENOSYS;
 }
@@ -973,29 +941,12 @@ int lttng_uprobes_event_add_callsite(struct lttng_kernel_event_common *event,
 }
 
 static inline
-void lttng_uprobes_unregister_event(struct lttng_kernel_event_recorder *event)
-{
-}
-
-static inline
-void lttng_uprobes_destroy_event_private(struct lttng_kernel_event_recorder *event)
-{
-}
-
-static inline
-int lttng_uprobes_register_event_notifier(const char *name,
-       int fd, struct lttng_kernel_event_notifier *event_notifier)
-{
-       return -ENOSYS;
-}
-
-static inline
-void lttng_uprobes_unregister_event_notifier(struct lttng_kernel_event_notifier *event_notifier)
+void lttng_uprobes_unregister_event(struct lttng_kernel_event_common *event)
 {
 }
 
 static inline
-void lttng_uprobes_destroy_event_notifier_private(struct lttng_kernel_event_notifier *event_notifier)
+void lttng_uprobes_destroy_event_private(struct lttng_kernel_event_common *event)
 {
 }
 #endif
@@ -1077,7 +1028,7 @@ int lttng_event_notifier_group_create_error_counter(
 void lttng_event_notifier_group_destroy(
                struct lttng_event_notifier_group *event_notifier_group);
 
-struct lttng_kernel_channel_buffer *lttng_channel_create(struct lttng_kernel_session *session,
+struct lttng_kernel_channel_buffer *lttng_channel_buffer_create(struct lttng_kernel_session *session,
                                       const char *transport_name,
                                       void *buf_addr,
                                       size_t subbuf_size, size_t num_subbuf,
@@ -1091,14 +1042,10 @@ struct lttng_kernel_channel_buffer *lttng_global_channel_create(struct lttng_ker
                                       unsigned int read_timer_interval);
 
 void lttng_metadata_channel_destroy(struct lttng_kernel_channel_buffer *chan);
-struct lttng_kernel_event_recorder *lttng_kernel_event_recorder_create(struct lttng_kernel_channel_buffer *chan,
-                               struct lttng_kernel_abi_event *event_param,
-                               const struct lttng_kernel_event_desc *event_desc,
-                               enum lttng_kernel_abi_instrumentation itype);
-struct lttng_kernel_event_recorder *_lttng_kernel_event_recorder_create(struct lttng_kernel_channel_buffer *chan,
-                               struct lttng_kernel_abi_event *event_param,
-                               const struct lttng_kernel_event_desc *event_desc,
-                               enum lttng_kernel_abi_instrumentation itype);
+struct lttng_kernel_event_recorder *lttng_kernel_event_recorder_create(struct lttng_event_recorder_enabler *event_enabler,
+                               const struct lttng_kernel_event_desc *event_desc);
+struct lttng_kernel_event_recorder *_lttng_kernel_event_recorder_create(struct lttng_event_recorder_enabler *event_enabler,
+                               const struct lttng_kernel_event_desc *event_desc);
 struct lttng_kernel_event_recorder *lttng_event_compat_old_create(struct lttng_kernel_channel_buffer *chan,
                struct lttng_kernel_abi_old_event *old_event_param,
                const struct lttng_kernel_event_desc *internal_desc);
@@ -1118,8 +1065,8 @@ struct lttng_kernel_event_notifier *_lttng_event_notifier_create(
                                struct lttng_kernel_abi_event_notifier *event_notifier_param,
                                enum lttng_kernel_abi_instrumentation itype);
 
-int lttng_channel_enable(struct lttng_kernel_channel_buffer *channel);
-int lttng_channel_disable(struct lttng_kernel_channel_buffer *channel);
+int lttng_channel_enable(struct lttng_kernel_channel_common *channel);
+int lttng_channel_disable(struct lttng_kernel_channel_common *channel);
 int lttng_event_enable(struct lttng_kernel_event_common *event);
 int lttng_event_disable(struct lttng_kernel_event_common *event);
 
This page took 0.027937 seconds and 4 git commands to generate.