Update TODO

[lttng-modules.git] / ltt-ring-buffer-client.h

diff --git a/ltt-ring-buffer-client.h b/ltt-ring-buffer-client.h
index 6389c98d5fc18f30307b216ae300edfeacbfd59c..8df37901095aade13f6281945ba9d32b5f940653 100644 (file)
--- a/ltt-ring-buffer-client.h
+++ b/ltt-ring-buffer-client.h
@@ -22,6 +22,14 @@
  * you ever add/remove a field from this header. Packed attribute is not used
  * because gcc generates poor code on at least powerpc and mips. Don't ever
  * let gcc add padding between the structure elements.
+ *
+ * The guarantee we have with timestamps is that all the events in a
+ * packet are included (inclusive) within the begin/end timestamps of
+ * the packet. Another guarantee we have is that the "timestamp begin",
+ * as well as the event timestamps, are monotonically increasing (never
+ * decrease) when moving forward in a stream (physically). But this
+ * guarantee does not apply to "timestamp end", because it is sampled at
+ * commit time, which is not ordered with respect to space reservation.
  */
 
 struct packet_header {
@@ -137,6 +145,7 @@ unsigned char record_header_size(const struct lib_ring_buffer_config *config,
                }
                break;
        default:
+               padding = 0;
                WARN_ON_ONCE(1);
        }
        offset += ctx_get_size(offset, event->ctx);
@@ -148,7 +157,7 @@ unsigned char record_header_size(const struct lib_ring_buffer_config *config,
 
 #include "wrapper/ringbuffer/api.h"
 
-extern
+static
 void ltt_write_event_header_slow(const struct lib_ring_buffer_config *config,
                                 struct lib_ring_buffer_ctx *ctx,
                                 uint32_t event_id);
@@ -197,8 +206,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,6 +216,7 @@ slow_path:
        ltt_write_event_header_slow(config, ctx, event_id);
 }
 
+static
 void ltt_write_event_header_slow(const struct lib_ring_buffer_config *config,
                                 struct lib_ring_buffer_ctx *ctx,
                                 uint32_t event_id)
@@ -259,8 +270,9 @@ 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;
@@ -361,7 +373,7 @@ static const struct lib_ring_buffer_config client_config = {
        .sync = RING_BUFFER_SYNC_PER_CPU,
        .mode = RING_BUFFER_MODE_TEMPLATE,
        .backend = RING_BUFFER_PAGE,
-       .output = RING_BUFFER_SPLICE,
+       .output = RING_BUFFER_OUTPUT_TEMPLATE,
        .oops = RING_BUFFER_OOPS_CONSISTENCY,
        .ipi = RING_BUFFER_IPI_BARRIER,
        .wakeup = RING_BUFFER_WAKEUP_BY_TIMER,
@@ -399,6 +411,20 @@ struct lib_ring_buffer *ltt_buffer_read_open(struct channel *chan)
        return NULL;
 }
 
+static
+int ltt_buffer_has_read_closed_stream(struct channel *chan)
+{
+       struct lib_ring_buffer *buf;
+       int cpu;
+
+       for_each_channel_cpu(cpu, chan) {
+               buf = channel_get_ring_buffer(&client_config, chan, cpu);
+               if (!atomic_long_read(&buf->active_readers))
+                       return 1;
+       }
+       return 0;
+}
+
 static
 void ltt_buffer_read_close(struct lib_ring_buffer *buf)
 {
@@ -455,9 +481,25 @@ void ltt_event_write(struct lib_ring_buffer_ctx *ctx, const void *src,
 }
 
 static
-wait_queue_head_t *ltt_get_reader_wait_queue(struct channel *chan)
+void ltt_event_write_from_user(struct lib_ring_buffer_ctx *ctx,
+                              const void __user *src, size_t len)
+{
+       lib_ring_buffer_copy_from_user(&client_config, ctx, src, len);
+}
+
+static
+void ltt_event_memset(struct lib_ring_buffer_ctx *ctx,
+               int c, size_t len)
+{
+       lib_ring_buffer_memset(&client_config, ctx, c, len);
+}
+
+static
+wait_queue_head_t *ltt_get_writer_buf_wait_queue(struct channel *chan, int cpu)
 {
-       return &chan->read_wait;
+       struct lib_ring_buffer *buf = channel_get_ring_buffer(&client_config,
+                                       chan, cpu);
+       return &buf->write_wait;
 }
 
 static
@@ -485,12 +527,16 @@ static struct ltt_transport ltt_relay_transport = {
                .channel_create = _channel_create,
                .channel_destroy = ltt_channel_destroy,
                .buffer_read_open = ltt_buffer_read_open,
+               .buffer_has_read_closed_stream =
+                       ltt_buffer_has_read_closed_stream,
                .buffer_read_close = ltt_buffer_read_close,
                .event_reserve = ltt_event_reserve,
                .event_commit = ltt_event_commit,
                .event_write = ltt_event_write,
+               .event_write_from_user = ltt_event_write_from_user,
+               .event_memset = ltt_event_memset,
                .packet_avail_size = NULL,      /* Would be racy anyway */
-               .get_reader_wait_queue = ltt_get_reader_wait_queue,
+               .get_writer_buf_wait_queue = ltt_get_writer_buf_wait_queue,
                .get_hp_wait_queue = ltt_get_hp_wait_queue,
                .is_finalized = ltt_is_finalized,
                .is_disabled = ltt_is_disabled,