Move alignment into event write callback
[lttng-modules.git] / src / lttng-ring-buffer-event-notifier-client.h
index ea0ab66ed1fa868dd3d6701014bb9e081b18c8a3..ccd3a0206f12d1a6c56437302b21de17f350bc2b 100644 (file)
@@ -7,11 +7,15 @@
  * Copyright (C) 2010-2020 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  */
 
+#include <linux/limits.h>
 #include <linux/module.h>
 #include <linux/types.h>
 #include <wrapper/vmalloc.h>   /* for wrapper_vmalloc_sync_mappings() */
+#include <lttng/abi.h>
 #include <lttng/events.h>
+#include <lttng/events-internal.h>
 #include <lttng/tracer.h>
+#include <wrapper/limits.h>
 
 static struct lttng_transport lttng_relay_transport;
 
@@ -20,42 +24,54 @@ struct event_notifier_packet_header {
 };
 
 struct event_notifier_record_header {
+       uint32_t payload_len;           /* in bytes */
        uint8_t header_end[0];          /* End of header */
 };
 
-static const struct lib_ring_buffer_config client_config;
+static const struct lttng_kernel_ring_buffer_config client_config;
 
 static inline
-u64 lib_ring_buffer_clock_read(struct channel *chan)
+u64 lib_ring_buffer_clock_read(struct lttng_kernel_ring_buffer_channel *chan)
 {
        return 0;
 }
 
 static inline
-size_t record_header_size(const struct lib_ring_buffer_config *config,
-                                struct channel *chan, size_t offset,
+size_t record_header_size(const struct lttng_kernel_ring_buffer_config *config,
+                                struct lttng_kernel_ring_buffer_channel *chan, size_t offset,
                                 size_t *pre_header_padding,
-                                struct lib_ring_buffer_ctx *ctx,
+                                struct lttng_kernel_ring_buffer_ctx *ctx,
                                 void *client_ctx)
 {
-       return 0;
+       size_t orig_offset = offset;
+       size_t padding;
+
+       padding = lib_ring_buffer_align(offset, lttng_alignof(uint32_t));
+       offset += padding;
+
+       offset += sizeof(uint32_t);
+
+       *pre_header_padding = padding;
+
+       return offset - orig_offset;
 }
 
 #include <ringbuffer/api.h>
 
-static u64 client_ring_buffer_clock_read(struct channel *chan)
+static u64 client_ring_buffer_clock_read(struct lttng_kernel_ring_buffer_channel *chan)
 {
        return 0;
 }
 
 static
-size_t client_record_header_size(const struct lib_ring_buffer_config *config,
-                                struct channel *chan, size_t offset,
+size_t client_record_header_size(const struct lttng_kernel_ring_buffer_config *config,
+                                struct lttng_kernel_ring_buffer_channel *chan, size_t offset,
                                 size_t *pre_header_padding,
-                                struct lib_ring_buffer_ctx *ctx,
+                                struct lttng_kernel_ring_buffer_ctx *ctx,
                                 void *client_ctx)
 {
-       return 0;
+       return record_header_size(config, chan, offset,
+                                 pre_header_padding, ctx, client_ctx);
 }
 
 /**
@@ -70,7 +86,7 @@ static size_t client_packet_header_size(void)
        return offsetof(struct event_notifier_packet_header, header_end);
 }
 
-static void client_buffer_begin(struct lib_ring_buffer *buf, u64 tsc,
+static void client_buffer_begin(struct lttng_kernel_ring_buffer *buf, u64 tsc,
                                unsigned int subbuf_idx)
 {
 }
@@ -79,86 +95,86 @@ static void client_buffer_begin(struct lib_ring_buffer *buf, u64 tsc,
  * offset is assumed to never be 0 here : never deliver a completely empty
  * subbuffer. data_size is between 1 and subbuf_size.
  */
-static void client_buffer_end(struct lib_ring_buffer *buf, u64 tsc,
+static void client_buffer_end(struct lttng_kernel_ring_buffer *buf, u64 tsc,
                              unsigned int subbuf_idx, unsigned long data_size)
 {
 }
 
-static int client_buffer_create(struct lib_ring_buffer *buf, void *priv,
+static int client_buffer_create(struct lttng_kernel_ring_buffer *buf, void *priv,
                                int cpu, const char *name)
 {
        return 0;
 }
 
-static void client_buffer_finalize(struct lib_ring_buffer *buf, void *priv, int cpu)
+static void client_buffer_finalize(struct lttng_kernel_ring_buffer *buf, void *priv, int cpu)
 {
 }
 
-static int client_timestamp_begin(const struct lib_ring_buffer_config *config,
-               struct lib_ring_buffer *buf, uint64_t *timestamp_begin)
+static int client_timestamp_begin(const struct lttng_kernel_ring_buffer_config *config,
+               struct lttng_kernel_ring_buffer *buf, uint64_t *timestamp_begin)
 {
        return -ENOSYS;
 }
 
-static int client_timestamp_end(const struct lib_ring_buffer_config *config,
-                       struct lib_ring_buffer *bufb,
+static int client_timestamp_end(const struct lttng_kernel_ring_buffer_config *config,
+                       struct lttng_kernel_ring_buffer *bufb,
                        uint64_t *timestamp_end)
 {
        return -ENOSYS;
 }
 
-static int client_events_discarded(const struct lib_ring_buffer_config *config,
-                       struct lib_ring_buffer *bufb,
+static int client_events_discarded(const struct lttng_kernel_ring_buffer_config *config,
+                       struct lttng_kernel_ring_buffer *bufb,
                        uint64_t *events_discarded)
 {
        return -ENOSYS;
 }
 
-static int client_current_timestamp(const struct lib_ring_buffer_config *config,
-               struct lib_ring_buffer *bufb,
+static int client_current_timestamp(const struct lttng_kernel_ring_buffer_config *config,
+               struct lttng_kernel_ring_buffer *bufb,
                uint64_t *ts)
 {
        return -ENOSYS;
 }
 
-static int client_content_size(const struct lib_ring_buffer_config *config,
-                       struct lib_ring_buffer *bufb,
+static int client_content_size(const struct lttng_kernel_ring_buffer_config *config,
+                       struct lttng_kernel_ring_buffer *bufb,
                        uint64_t *content_size)
 {
        return -ENOSYS;
 }
 
-static int client_packet_size(const struct lib_ring_buffer_config *config,
-                       struct lib_ring_buffer *bufb,
+static int client_packet_size(const struct lttng_kernel_ring_buffer_config *config,
+                       struct lttng_kernel_ring_buffer *bufb,
                        uint64_t *packet_size)
 {
        return -ENOSYS;
 }
 
-static int client_stream_id(const struct lib_ring_buffer_config *config,
-                       struct lib_ring_buffer *bufb,
+static int client_stream_id(const struct lttng_kernel_ring_buffer_config *config,
+                       struct lttng_kernel_ring_buffer *bufb,
                        uint64_t *stream_id)
 {
        return -ENOSYS;
 }
 
-static int client_sequence_number(const struct lib_ring_buffer_config *config,
-                       struct lib_ring_buffer *bufb,
+static int client_sequence_number(const struct lttng_kernel_ring_buffer_config *config,
+                       struct lttng_kernel_ring_buffer *bufb,
                        uint64_t *seq)
 {
        return -ENOSYS;
 }
 
 static
-int client_instance_id(const struct lib_ring_buffer_config *config,
-               struct lib_ring_buffer *bufb,
+int client_instance_id(const struct lttng_kernel_ring_buffer_config *config,
+               struct lttng_kernel_ring_buffer *bufb,
                uint64_t *id)
 {
        return -ENOSYS;
 }
 
-static void client_record_get(const struct lib_ring_buffer_config *config,
-       struct channel *chan, struct lib_ring_buffer *buf,
+static void client_record_get(const struct lttng_kernel_ring_buffer_config *config,
+       struct lttng_kernel_ring_buffer_channel *chan, struct lttng_kernel_ring_buffer *buf,
        size_t offset, size_t *header_len,
        size_t *payload_len, u64 *timestamp)
 {
@@ -169,14 +185,11 @@ static void client_record_get(const struct lib_ring_buffer_config *config,
                        offsetof(struct event_notifier_record_header, header_end));
        CHAN_WARN_ON(chan, ret != offsetof(struct event_notifier_record_header, header_end));
        *header_len = offsetof(struct event_notifier_record_header, header_end);
-       /*
-        * Currently, only 64-bit event notifier ID.
-        */
-       *payload_len = sizeof(uint64_t);
+       *payload_len = header.payload_len;
        *timestamp = 0;
 }
 
-static const struct lib_ring_buffer_config client_config = {
+static const struct lttng_kernel_ring_buffer_config client_config = {
        .cb.ring_buffer_clock_read = client_ring_buffer_clock_read,
        .cb.record_header_size = client_record_header_size,
        .cb.subbuffer_header_size = client_packet_header_size,
@@ -204,20 +217,20 @@ void release_priv_ops(void *priv_ops)
 }
 
 static
-void lttng_channel_destroy(struct channel *chan)
+void lttng_channel_destroy(struct lttng_kernel_ring_buffer_channel *chan)
 {
        channel_destroy(chan);
 }
 
 static
-struct channel *_channel_create(const char *name,
+struct lttng_kernel_ring_buffer_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)
 {
        struct lttng_event_notifier_group *event_notifier_group = priv;
-       struct channel *chan;
+       struct lttng_kernel_ring_buffer_channel *chan;
 
        chan = channel_create(&client_config, name,
                              event_notifier_group, buf_addr,
@@ -243,9 +256,9 @@ error:
 }
 
 static
-struct lib_ring_buffer *lttng_buffer_read_open(struct channel *chan)
+struct lttng_kernel_ring_buffer *lttng_buffer_read_open(struct lttng_kernel_ring_buffer_channel *chan)
 {
-       struct lib_ring_buffer *buf;
+       struct lttng_kernel_ring_buffer *buf;
 
        buf = channel_get_ring_buffer(&client_config, chan, 0);
        if (!lib_ring_buffer_open_read(buf))
@@ -254,9 +267,9 @@ struct lib_ring_buffer *lttng_buffer_read_open(struct channel *chan)
 }
 
 static
-int lttng_buffer_has_read_closed_stream(struct channel *chan)
+int lttng_buffer_has_read_closed_stream(struct lttng_kernel_ring_buffer_channel *chan)
 {
-       struct lib_ring_buffer *buf;
+       struct lttng_kernel_ring_buffer *buf;
        int cpu;
 
        for_each_channel_cpu(cpu, chan) {
@@ -268,63 +281,86 @@ int lttng_buffer_has_read_closed_stream(struct channel *chan)
 }
 
 static
-void lttng_buffer_read_close(struct lib_ring_buffer *buf)
+void lttng_buffer_read_close(struct lttng_kernel_ring_buffer *buf)
 {
        lib_ring_buffer_release_read(buf);
 }
 
 static
-int lttng_event_reserve(struct lib_ring_buffer_ctx *ctx, uint32_t event_id)
+void lttng_write_event_notifier_header(const struct lttng_kernel_ring_buffer_config *config,
+                           struct lttng_kernel_ring_buffer_ctx *ctx)
+{
+       uint32_t data_size;
+
+       WARN_ON_ONCE(ctx->data_size > U32_MAX);
+
+       data_size = (uint32_t) ctx->data_size;
+
+       lib_ring_buffer_write(config, ctx, &data_size, sizeof(data_size));
+
+       lib_ring_buffer_align_ctx(ctx, ctx->largest_align);
+}
+
+static
+int lttng_event_reserve(struct lttng_kernel_ring_buffer_ctx *ctx)
 {
+       struct lttng_kernel_ring_buffer_channel *chan = ctx->client_priv;
        int ret;
 
+       memset(&ctx->priv, 0, sizeof(ctx->priv));
+       ctx->priv.chan = chan;
+
        ret = lib_ring_buffer_reserve(&client_config, ctx, NULL);
        if (ret)
                return ret;
        lib_ring_buffer_backend_get_pages(&client_config, ctx,
-                       &ctx->backend_pages);
+                       &ctx->priv.backend_pages);
+
+       lttng_write_event_notifier_header(&client_config, ctx);
        return 0;
 }
 
 static
-void lttng_event_commit(struct lib_ring_buffer_ctx *ctx)
+void lttng_event_commit(struct lttng_kernel_ring_buffer_ctx *ctx)
 {
        lib_ring_buffer_commit(&client_config, ctx);
 }
 
 static
-void lttng_event_write(struct lib_ring_buffer_ctx *ctx, const void *src,
-                    size_t len)
+void lttng_event_write(struct lttng_kernel_ring_buffer_ctx *ctx, const void *src,
+                    size_t len, size_t alignment)
 {
+       lib_ring_buffer_align_ctx(ctx, alignment);
        lib_ring_buffer_write(&client_config, ctx, src, len);
 }
 
 static
-void lttng_event_write_from_user(struct lib_ring_buffer_ctx *ctx,
-                              const void __user *src, size_t len)
+void lttng_event_write_from_user(struct lttng_kernel_ring_buffer_ctx *ctx,
+                              const void __user *src, size_t len, size_t alignment)
 {
+       lib_ring_buffer_align_ctx(ctx, alignment);
        lib_ring_buffer_copy_from_user_inatomic(&client_config, ctx, src, len);
 }
 
 static
-void lttng_event_memset(struct lib_ring_buffer_ctx *ctx,
+void lttng_event_memset(struct lttng_kernel_ring_buffer_ctx *ctx,
                int c, size_t len)
 {
        lib_ring_buffer_memset(&client_config, ctx, c, len);
 }
 
 static
-void lttng_event_strcpy(struct lib_ring_buffer_ctx *ctx, const char *src,
+void lttng_event_strcpy(struct lttng_kernel_ring_buffer_ctx *ctx, const char *src,
                size_t len)
 {
        lib_ring_buffer_strcpy(&client_config, ctx, src, len, '#');
 }
 
 static
-size_t lttng_packet_avail_size(struct channel *chan)
+size_t lttng_packet_avail_size(struct lttng_kernel_ring_buffer_channel *chan)
 {
        unsigned long o_begin;
-       struct lib_ring_buffer *buf;
+       struct lttng_kernel_ring_buffer *buf;
 
        buf = chan->backend.buf;        /* Only for global buffer ! */
        o_begin = v_read(&client_config, &buf->offset);
@@ -337,27 +373,27 @@ size_t lttng_packet_avail_size(struct channel *chan)
 }
 
 static
-wait_queue_head_t *lttng_get_writer_buf_wait_queue(struct channel *chan, int cpu)
+wait_queue_head_t *lttng_get_writer_buf_wait_queue(struct lttng_kernel_ring_buffer_channel *chan, int cpu)
 {
-       struct lib_ring_buffer *buf = channel_get_ring_buffer(&client_config,
+       struct lttng_kernel_ring_buffer *buf = channel_get_ring_buffer(&client_config,
                                        chan, cpu);
        return &buf->write_wait;
 }
 
 static
-wait_queue_head_t *lttng_get_hp_wait_queue(struct channel *chan)
+wait_queue_head_t *lttng_get_hp_wait_queue(struct lttng_kernel_ring_buffer_channel *chan)
 {
        return &chan->hp_wait;
 }
 
 static
-int lttng_is_finalized(struct channel *chan)
+int lttng_is_finalized(struct lttng_kernel_ring_buffer_channel *chan)
 {
        return lib_ring_buffer_channel_is_finalized(chan);
 }
 
 static
-int lttng_is_disabled(struct channel *chan)
+int lttng_is_disabled(struct lttng_kernel_ring_buffer_channel *chan)
 {
        return lib_ring_buffer_channel_is_disabled(chan);
 }
@@ -366,32 +402,35 @@ static struct lttng_transport lttng_relay_transport = {
        .name = "relay-" RING_BUFFER_MODE_TEMPLATE_STRING,
        .owner = THIS_MODULE,
        .ops = {
-               .channel_create = _channel_create,
-               .channel_destroy = lttng_channel_destroy,
-               .buffer_read_open = lttng_buffer_read_open,
-               .buffer_has_read_closed_stream =
-                       lttng_buffer_has_read_closed_stream,
-               .buffer_read_close = lttng_buffer_read_close,
+               .priv = __LTTNG_COMPOUND_LITERAL(struct lttng_kernel_channel_buffer_ops_private, {
+                       .pub = &lttng_relay_transport.ops,
+                       .channel_create = _channel_create,
+                       .channel_destroy = lttng_channel_destroy,
+                       .buffer_read_open = lttng_buffer_read_open,
+                       .buffer_has_read_closed_stream =
+                               lttng_buffer_has_read_closed_stream,
+                       .buffer_read_close = lttng_buffer_read_close,
+                       .packet_avail_size = lttng_packet_avail_size,
+                       .get_writer_buf_wait_queue = lttng_get_writer_buf_wait_queue,
+                       .get_hp_wait_queue = lttng_get_hp_wait_queue,
+                       .is_finalized = lttng_is_finalized,
+                       .is_disabled = lttng_is_disabled,
+                       .timestamp_begin = client_timestamp_begin,
+                       .timestamp_end = client_timestamp_end,
+                       .events_discarded = client_events_discarded,
+                       .content_size = client_content_size,
+                       .packet_size = client_packet_size,
+                       .stream_id = client_stream_id,
+                       .current_timestamp = client_current_timestamp,
+                       .sequence_number = client_sequence_number,
+                       .instance_id = client_instance_id,
+               }),
                .event_reserve = lttng_event_reserve,
                .event_commit = lttng_event_commit,
                .event_write_from_user = lttng_event_write_from_user,
                .event_memset = lttng_event_memset,
                .event_write = lttng_event_write,
                .event_strcpy = lttng_event_strcpy,
-               .packet_avail_size = lttng_packet_avail_size,
-               .get_writer_buf_wait_queue = lttng_get_writer_buf_wait_queue,
-               .get_hp_wait_queue = lttng_get_hp_wait_queue,
-               .is_finalized = lttng_is_finalized,
-               .is_disabled = lttng_is_disabled,
-               .timestamp_begin = client_timestamp_begin,
-               .timestamp_end = client_timestamp_end,
-               .events_discarded = client_events_discarded,
-               .content_size = client_content_size,
-               .packet_size = client_packet_size,
-               .stream_id = client_stream_id,
-               .current_timestamp = client_current_timestamp,
-               .sequence_number = client_sequence_number,
-               .instance_id = client_instance_id,
        },
 };
 
This page took 0.029677 seconds and 4 git commands to generate.