Rename struct lib_ring_buffer* to struct lttng_ust_lib_ring_buffer*
[lttng-ust.git] / libust / ltt-ring-buffer-client.h
index 0d8051ece35bd5ec2e42e3641524b1c5c6a993fb..6361b9edeb912e0a8f543483e6c67e30d527328c 100644 (file)
@@ -8,14 +8,12 @@
  * Dual LGPL v2.1/GPL v2 license.
  */
 
-#include <linux/module.h>
-#include <linux/types.h>
-#include "lib/bitfield.h"
-#include "wrapper/vmalloc.h"   /* for wrapper_vmalloc_sync_all() */
-#include "wrapper/trace-clock.h"
-#include "ltt-events.h"
+#include <stdint.h>
+#include <ust/lttng-events.h>
+#include "ust/bitfield.h"
+#include "ust/clock.h"
 #include "ltt-tracer.h"
-#include "wrapper/ringbuffer/frontend_types.h"
+#include "../libringbuffer/frontend_types.h"
 
 /*
  * Keep the natural field alignment for _each field_ within this structure if
@@ -69,7 +67,7 @@ size_t ctx_get_size(size_t offset, struct lttng_ctx *ctx)
 }
 
 static inline
-void ctx_record(struct lib_ring_buffer_ctx *bufctx,
+void ctx_record(struct lttng_ust_lib_ring_buffer_ctx *bufctx,
                struct ltt_channel *chan,
                struct lttng_ctx *ctx)
 {
@@ -95,10 +93,10 @@ void ctx_record(struct lib_ring_buffer_ctx *bufctx,
  * contains.
  */
 static __inline__
-unsigned char record_header_size(const struct lib_ring_buffer_config *config,
+unsigned char record_header_size(const struct lttng_ust_lib_ring_buffer_config *config,
                                 struct channel *chan, size_t offset,
                                 size_t *pre_header_padding,
-                                struct lib_ring_buffer_ctx *ctx)
+                                struct lttng_ust_lib_ring_buffer_ctx *ctx)
 {
        struct ltt_channel *ltt_chan = channel_get_private(chan);
        struct ltt_event *event = ctx->priv;
@@ -107,7 +105,7 @@ unsigned char record_header_size(const struct lib_ring_buffer_config *config,
 
        switch (ltt_chan->header_type) {
        case 1: /* compact */
-               padding = lib_ring_buffer_align(offset, ltt_alignof(uint32_t));
+               padding = lib_ring_buffer_align(offset, lttng_alignof(uint32_t));
                offset += padding;
                if (!(ctx->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTT_RFLAG_EXTENDED))) {
                        offset += sizeof(uint32_t);     /* id and timestamp */
@@ -115,28 +113,29 @@ unsigned char record_header_size(const struct lib_ring_buffer_config *config,
                        /* Minimum space taken by 5-bit id */
                        offset += sizeof(uint8_t);
                        /* Align extended struct on largest member */
-                       offset += lib_ring_buffer_align(offset, ltt_alignof(uint64_t));
+                       offset += lib_ring_buffer_align(offset, lttng_alignof(uint64_t));
                        offset += sizeof(uint32_t);     /* id */
-                       offset += lib_ring_buffer_align(offset, ltt_alignof(uint64_t));
+                       offset += lib_ring_buffer_align(offset, lttng_alignof(uint64_t));
                        offset += sizeof(uint64_t);     /* timestamp */
                }
                break;
        case 2: /* large */
-               padding = lib_ring_buffer_align(offset, ltt_alignof(uint16_t));
+               padding = lib_ring_buffer_align(offset, lttng_alignof(uint16_t));
                offset += padding;
                offset += sizeof(uint16_t);
                if (!(ctx->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTT_RFLAG_EXTENDED))) {
-                       offset += lib_ring_buffer_align(offset, ltt_alignof(uint32_t));
+                       offset += lib_ring_buffer_align(offset, lttng_alignof(uint32_t));
                        offset += sizeof(uint32_t);     /* timestamp */
                } else {
                        /* Align extended struct on largest member */
-                       offset += lib_ring_buffer_align(offset, ltt_alignof(uint64_t));
+                       offset += lib_ring_buffer_align(offset, lttng_alignof(uint64_t));
                        offset += sizeof(uint32_t);     /* id */
-                       offset += lib_ring_buffer_align(offset, ltt_alignof(uint64_t));
+                       offset += lib_ring_buffer_align(offset, lttng_alignof(uint64_t));
                        offset += sizeof(uint64_t);     /* timestamp */
                }
                break;
        default:
+               padding = 0;
                WARN_ON_ONCE(1);
        }
        offset += ctx_get_size(offset, event->ctx);
@@ -146,11 +145,11 @@ unsigned char record_header_size(const struct lib_ring_buffer_config *config,
        return offset - orig_offset;
 }
 
-#include "wrapper/ringbuffer/api.h"
+#include "../libringbuffer/api.h"
 
-extern
-void ltt_write_event_header_slow(const struct lib_ring_buffer_config *config,
-                                struct lib_ring_buffer_ctx *ctx,
+static
+void ltt_write_event_header_slow(const struct lttng_ust_lib_ring_buffer_config *config,
+                                struct lttng_ust_lib_ring_buffer_ctx *ctx,
                                 uint32_t event_id);
 
 /*
@@ -163,8 +162,8 @@ void ltt_write_event_header_slow(const struct lib_ring_buffer_config *config,
  * @event_id: event ID
  */
 static __inline__
-void ltt_write_event_header(const struct lib_ring_buffer_config *config,
-                           struct lib_ring_buffer_ctx *ctx,
+void ltt_write_event_header(const struct lttng_ust_lib_ring_buffer_config *config,
+                           struct lttng_ust_lib_ring_buffer_ctx *ctx,
                            uint32_t event_id)
 {
        struct ltt_channel *ltt_chan = channel_get_private(ctx->chan);
@@ -189,7 +188,7 @@ void ltt_write_event_header(const struct lib_ring_buffer_config *config,
                uint16_t id = event_id;
 
                lib_ring_buffer_write(config, ctx, &id, sizeof(id));
-               lib_ring_buffer_align_ctx(ctx, ltt_alignof(uint32_t));
+               lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint32_t));
                lib_ring_buffer_write(config, ctx, &timestamp, sizeof(timestamp));
                break;
        }
@@ -197,8 +196,9 @@ void ltt_write_event_header(const struct lib_ring_buffer_config *config,
                WARN_ON_ONCE(1);
        }
 
-       ctx_record(ctx, ltt_chan, event->ctx);
        ctx_record(ctx, ltt_chan, ltt_chan->ctx);
+       ctx_record(ctx, ltt_chan, event->ctx);
+       lib_ring_buffer_align_ctx(ctx, ctx->largest_align);
 
        return;
 
@@ -206,8 +206,9 @@ slow_path:
        ltt_write_event_header_slow(config, ctx, event_id);
 }
 
-void ltt_write_event_header_slow(const struct lib_ring_buffer_config *config,
-                                struct lib_ring_buffer_ctx *ctx,
+static
+void ltt_write_event_header_slow(const struct lttng_ust_lib_ring_buffer_config *config,
+                                struct lttng_ust_lib_ring_buffer_ctx *ctx,
                                 uint32_t event_id)
 {
        struct ltt_channel *ltt_chan = channel_get_private(ctx->chan);
@@ -228,9 +229,9 @@ void ltt_write_event_header_slow(const struct lib_ring_buffer_config *config,
                        bt_bitfield_write(&id, uint8_t, 0, 5, 31);
                        lib_ring_buffer_write(config, ctx, &id, sizeof(id));
                        /* Align extended struct on largest member */
-                       lib_ring_buffer_align_ctx(ctx, ltt_alignof(uint64_t));
+                       lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint64_t));
                        lib_ring_buffer_write(config, ctx, &event_id, sizeof(event_id));
-                       lib_ring_buffer_align_ctx(ctx, ltt_alignof(uint64_t));
+                       lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint64_t));
                        lib_ring_buffer_write(config, ctx, &timestamp, sizeof(timestamp));
                }
                break;
@@ -241,7 +242,7 @@ void ltt_write_event_header_slow(const struct lib_ring_buffer_config *config,
                        uint16_t id = event_id;
 
                        lib_ring_buffer_write(config, ctx, &id, sizeof(id));
-                       lib_ring_buffer_align_ctx(ctx, ltt_alignof(uint32_t));
+                       lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint32_t));
                        lib_ring_buffer_write(config, ctx, &timestamp, sizeof(timestamp));
                } else {
                        uint16_t id = 65535;
@@ -249,9 +250,9 @@ void ltt_write_event_header_slow(const struct lib_ring_buffer_config *config,
 
                        lib_ring_buffer_write(config, ctx, &id, sizeof(id));
                        /* Align extended struct on largest member */
-                       lib_ring_buffer_align_ctx(ctx, ltt_alignof(uint64_t));
+                       lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint64_t));
                        lib_ring_buffer_write(config, ctx, &event_id, sizeof(event_id));
-                       lib_ring_buffer_align_ctx(ctx, ltt_alignof(uint64_t));
+                       lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint64_t));
                        lib_ring_buffer_write(config, ctx, &timestamp, sizeof(timestamp));
                }
                break;
@@ -259,11 +260,12 @@ void ltt_write_event_header_slow(const struct lib_ring_buffer_config *config,
        default:
                WARN_ON_ONCE(1);
        }
-       ctx_record(ctx, ltt_chan, event->ctx);
        ctx_record(ctx, ltt_chan, ltt_chan->ctx);
+       ctx_record(ctx, ltt_chan, event->ctx);
+       lib_ring_buffer_align_ctx(ctx, ctx->largest_align);
 }
 
-static const struct lib_ring_buffer_config client_config;
+static const struct lttng_ust_lib_ring_buffer_config client_config;
 
 static u64 client_ring_buffer_clock_read(struct channel *chan)
 {
@@ -271,10 +273,10 @@ static u64 client_ring_buffer_clock_read(struct channel *chan)
 }
 
 static
-size_t client_record_header_size(const struct lib_ring_buffer_config *config,
+size_t client_record_header_size(const struct lttng_ust_lib_ring_buffer_config *config,
                                 struct channel *chan, size_t offset,
                                 size_t *pre_header_padding,
-                                struct lib_ring_buffer_ctx *ctx)
+                                struct lttng_ust_lib_ring_buffer_ctx *ctx)
 {
        return record_header_size(config, chan, offset,
                                  pre_header_padding, ctx);
@@ -292,19 +294,21 @@ static size_t client_packet_header_size(void)
        return offsetof(struct packet_header, ctx.header_end);
 }
 
-static void client_buffer_begin(struct lib_ring_buffer *buf, u64 tsc,
-                               unsigned int subbuf_idx)
+static void client_buffer_begin(struct lttng_ust_lib_ring_buffer *buf, u64 tsc,
+                               unsigned int subbuf_idx,
+                               struct lttng_ust_shm_handle *handle)
 {
-       struct channel *chan = buf->backend.chan;
+       struct channel *chan = shmp(handle, buf->backend.chan);
        struct packet_header *header =
                (struct packet_header *)
                        lib_ring_buffer_offset_address(&buf->backend,
-                               subbuf_idx * chan->backend.subbuf_size);
+                               subbuf_idx * chan->backend.subbuf_size,
+                               handle);
        struct ltt_channel *ltt_chan = channel_get_private(chan);
        struct ltt_session *session = ltt_chan->session;
 
        header->magic = CTF_MAGIC_NUMBER;
-       memcpy(header->uuid, session->uuid.b, sizeof(session->uuid));
+       memcpy(header->uuid, session->uuid, sizeof(session->uuid));
        header->stream_id = ltt_chan->id;
        header->ctx.timestamp_begin = tsc;
        header->ctx.timestamp_end = 0;
@@ -318,36 +322,42 @@ 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,
-                             unsigned int subbuf_idx, unsigned long data_size)
+static void client_buffer_end(struct lttng_ust_lib_ring_buffer *buf, u64 tsc,
+                             unsigned int subbuf_idx, unsigned long data_size,
+                             struct lttng_ust_shm_handle *handle)
 {
-       struct channel *chan = buf->backend.chan;
+       struct channel *chan = shmp(handle, buf->backend.chan);
        struct packet_header *header =
                (struct packet_header *)
                        lib_ring_buffer_offset_address(&buf->backend,
-                               subbuf_idx * chan->backend.subbuf_size);
+                               subbuf_idx * chan->backend.subbuf_size,
+                               handle);
        unsigned long records_lost = 0;
 
        header->ctx.timestamp_end = tsc;
        header->ctx.content_size = data_size * CHAR_BIT;        /* in bits */
        header->ctx.packet_size = PAGE_ALIGN(data_size) * CHAR_BIT; /* in bits */
-       records_lost += lib_ring_buffer_get_records_lost_full(&client_config, buf);
+       /*
+        * We do not care about the records lost count, because the metadata
+        * channel waits and retry.
+        */
+       (void) lib_ring_buffer_get_records_lost_full(&client_config, buf);
        records_lost += lib_ring_buffer_get_records_lost_wrap(&client_config, buf);
        records_lost += lib_ring_buffer_get_records_lost_big(&client_config, buf);
        header->ctx.events_discarded = records_lost;
 }
 
-static int client_buffer_create(struct lib_ring_buffer *buf, void *priv,
-                               int cpu, const char *name)
+static int client_buffer_create(struct lttng_ust_lib_ring_buffer *buf, void *priv,
+                               int cpu, const char *name, struct lttng_ust_shm_handle *handle)
 {
        return 0;
 }
 
-static void client_buffer_finalize(struct lib_ring_buffer *buf, void *priv, int cpu)
+static void client_buffer_finalize(struct lttng_ust_lib_ring_buffer *buf, void *priv, int cpu, struct lttng_ust_shm_handle *handle)
 {
 }
 
-static const struct lib_ring_buffer_config client_config = {
+static const struct lttng_ust_lib_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,
@@ -358,55 +368,68 @@ static const struct lib_ring_buffer_config client_config = {
 
        .tsc_bits = 32,
        .alloc = RING_BUFFER_ALLOC_PER_CPU,
-       .sync = RING_BUFFER_SYNC_PER_CPU,
+       .sync = RING_BUFFER_SYNC_GLOBAL,
        .mode = RING_BUFFER_MODE_TEMPLATE,
        .backend = RING_BUFFER_PAGE,
-       .output = RING_BUFFER_SPLICE,
+       .output = RING_BUFFER_MMAP,
        .oops = RING_BUFFER_OOPS_CONSISTENCY,
-       .ipi = RING_BUFFER_IPI_BARRIER,
-       .wakeup = RING_BUFFER_WAKEUP_BY_TIMER,
+       .ipi = RING_BUFFER_NO_IPI_BARRIER,
+       .wakeup = RING_BUFFER_WAKEUP_BY_WRITER,
 };
 
 static
-struct channel *_channel_create(const char *name,
+struct ltt_channel *_channel_create(const char *name,
                                struct ltt_channel *ltt_chan, void *buf_addr,
                                size_t subbuf_size, size_t num_subbuf,
                                unsigned int switch_timer_interval,
-                               unsigned int read_timer_interval)
+                               unsigned int read_timer_interval,
+                               int *shm_fd, int *wait_fd,
+                               uint64_t *memory_map_size)
 {
-       return channel_create(&client_config, name, ltt_chan, buf_addr,
+       ltt_chan->handle = channel_create(&client_config, name, ltt_chan, buf_addr,
                              subbuf_size, num_subbuf, switch_timer_interval,
-                             read_timer_interval);
+                             read_timer_interval, shm_fd, wait_fd,
+                             memory_map_size);
+       if (!ltt_chan->handle)
+               return NULL;
+       ltt_chan->chan = shmp(ltt_chan->handle, ltt_chan->handle->chan);
+       return ltt_chan;
 }
 
 static
-void ltt_channel_destroy(struct channel *chan)
+void ltt_channel_destroy(struct ltt_channel *ltt_chan)
 {
-       channel_destroy(chan);
+       channel_destroy(ltt_chan->chan, ltt_chan->handle, 0);
 }
 
 static
-struct lib_ring_buffer *ltt_buffer_read_open(struct channel *chan)
+struct lttng_ust_lib_ring_buffer *ltt_buffer_read_open(struct channel *chan,
+                                            struct lttng_ust_shm_handle *handle,
+                                            int *shm_fd, int *wait_fd,
+                                            uint64_t *memory_map_size)
 {
-       struct lib_ring_buffer *buf;
+       struct lttng_ust_lib_ring_buffer *buf;
        int cpu;
 
        for_each_channel_cpu(cpu, chan) {
-               buf = channel_get_ring_buffer(&client_config, chan, cpu);
-               if (!lib_ring_buffer_open_read(buf))
+               buf = channel_get_ring_buffer(&client_config, chan,
+                               cpu, handle, shm_fd, wait_fd,
+                               memory_map_size);
+               if (!lib_ring_buffer_open_read(buf, handle, 0))
                        return buf;
        }
        return NULL;
 }
 
 static
-void ltt_buffer_read_close(struct lib_ring_buffer *buf)
+void ltt_buffer_read_close(struct lttng_ust_lib_ring_buffer *buf,
+                          struct lttng_ust_shm_handle *handle)
 {
-       lib_ring_buffer_release_read(buf);
+       lib_ring_buffer_release_read(buf, handle, 0);
 }
 
 static
-int ltt_event_reserve(struct lib_ring_buffer_ctx *ctx,
+int ltt_event_reserve(struct lttng_ust_lib_ring_buffer_ctx *ctx,
                      uint32_t event_id)
 {
        struct ltt_channel *ltt_chan = channel_get_private(ctx->chan);
@@ -441,19 +464,20 @@ put:
 }
 
 static
-void ltt_event_commit(struct lib_ring_buffer_ctx *ctx)
+void ltt_event_commit(struct lttng_ust_lib_ring_buffer_ctx *ctx)
 {
        lib_ring_buffer_commit(&client_config, ctx);
        lib_ring_buffer_put_cpu(&client_config);
 }
 
 static
-void ltt_event_write(struct lib_ring_buffer_ctx *ctx, const void *src,
+void ltt_event_write(struct lttng_ust_lib_ring_buffer_ctx *ctx, const void *src,
                     size_t len)
 {
        lib_ring_buffer_write(&client_config, ctx, src, len);
 }
 
+#if 0
 static
 wait_queue_head_t *ltt_get_reader_wait_queue(struct channel *chan)
 {
@@ -465,6 +489,7 @@ wait_queue_head_t *ltt_get_hp_wait_queue(struct channel *chan)
 {
        return &chan->hp_wait;
 }
+#endif //0
 
 static
 int ltt_is_finalized(struct channel *chan)
@@ -478,9 +503,27 @@ int ltt_is_disabled(struct channel *chan)
        return lib_ring_buffer_channel_is_disabled(chan);
 }
 
+static
+int ltt_flush_buffer(struct channel *chan, struct lttng_ust_shm_handle *handle)
+{
+       struct lttng_ust_lib_ring_buffer *buf;
+       int cpu;
+
+       for_each_channel_cpu(cpu, chan) {
+               int shm_fd, wait_fd;
+               uint64_t memory_map_size;
+
+               buf = channel_get_ring_buffer(&client_config, chan,
+                               cpu, handle, &shm_fd, &wait_fd,
+                               &memory_map_size);
+               lib_ring_buffer_switch(&client_config, buf,
+                               SWITCH_ACTIVE, handle);
+       }
+       return 0;
+}
+
 static struct ltt_transport ltt_relay_transport = {
-       .name = "relay-" RING_BUFFER_MODE_TEMPLATE_STRING,
-       .owner = THIS_MODULE,
+       .name = "relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap",
        .ops = {
                .channel_create = _channel_create,
                .channel_destroy = ltt_channel_destroy,
@@ -490,36 +533,22 @@ static struct ltt_transport ltt_relay_transport = {
                .event_commit = ltt_event_commit,
                .event_write = ltt_event_write,
                .packet_avail_size = NULL,      /* Would be racy anyway */
-               .get_reader_wait_queue = ltt_get_reader_wait_queue,
-               .get_hp_wait_queue = ltt_get_hp_wait_queue,
+               //.get_reader_wait_queue = ltt_get_reader_wait_queue,
+               //.get_hp_wait_queue = ltt_get_hp_wait_queue,
                .is_finalized = ltt_is_finalized,
                .is_disabled = ltt_is_disabled,
+               .flush_buffer = ltt_flush_buffer,
        },
 };
 
-static int __init ltt_ring_buffer_client_init(void)
+void RING_BUFFER_MODE_TEMPLATE_INIT(void)
 {
-       /*
-        * This vmalloc sync all also takes care of the lib ring buffer
-        * vmalloc'd module pages when it is built as a module into LTTng.
-        */
-       wrapper_vmalloc_sync_all();
-       printk(KERN_INFO "LTT : ltt ring buffer client init\n");
+       DBG("LTT : ltt ring buffer client init\n");
        ltt_transport_register(&ltt_relay_transport);
-       return 0;
 }
 
-module_init(ltt_ring_buffer_client_init);
-
-static void __exit ltt_ring_buffer_client_exit(void)
+void RING_BUFFER_MODE_TEMPLATE_EXIT(void)
 {
-       printk(KERN_INFO "LTT : ltt ring buffer client exit\n");
+       DBG("LTT : ltt ring buffer client exit\n");
        ltt_transport_unregister(&ltt_relay_transport);
 }
-
-module_exit(ltt_ring_buffer_client_exit);
-
-MODULE_LICENSE("GPL and additional rights");
-MODULE_AUTHOR("Mathieu Desnoyers");
-MODULE_DESCRIPTION("LTTng ring buffer " RING_BUFFER_MODE_TEMPLATE_STRING
-                  " client");
This page took 0.031809 seconds and 4 git commands to generate.