Metadata generation (partial)
[lttng-modules.git] / ltt-ring-buffer-client.h
index a262da105a6eec1dc9bfb6611d0fcc406cb4f2e0..9056dd79ba2e17ded7f3c47b50c06200cc1e319f 100644 (file)
  */
 
 #include <linux/module.h>
+#include <linux/types.h>
+#include "wrapper/vmalloc.h"   /* for wrapper_vmalloc_sync_all() */
+#include "wrapper/trace-clock.h"
+#include "ltt-events.h"
 #include "ltt-tracer.h"
 
-struct ring_buffer_priv {
-       struct dentry *dentry;
+static inline notrace u64 lib_ring_buffer_clock_read(struct channel *chan)
+{
+       return trace_clock_read64();
 }
 
-struct channel_priv {
-       struct ltt_trace *trace;
-       struct ring_buffer_priv *buf;
-};
+/*
+ * record_header_size - Calculate the header size and padding necessary.
+ * @config: ring buffer instance configuration
+ * @chan: channel
+ * @offset: offset in the write buffer
+ * @data_size: size of the payload
+ * @pre_header_padding: padding to add before the header (output)
+ * @rflags: reservation flags
+ * @ctx: reservation context
+ *
+ * Returns the event header size (including padding).
+ *
+ * Important note :
+ * The event header must be 32-bits. The total offset calculated here :
+ *
+ * Alignment of header struct on 32 bits (min arch size, header size)
+ * + sizeof(header struct)  (32-bits)
+ * + (opt) u16 (ext. event id)
+ * + (opt) u16 (event_size)
+ *             (if event_size == LTT_MAX_SMALL_SIZE, has ext. event size)
+ * + (opt) u32 (ext. event size)
+ * + (opt) u64 full TSC (aligned on min(64-bits, arch size))
+ *
+ * The payload must itself determine its own alignment from the biggest type it
+ * contains.
+ */
+static __inline__
+unsigned char record_header_size(const struct lib_ring_buffer_config *config,
+                                struct channel *chan, size_t offset,
+                                size_t data_size, size_t *pre_header_padding,
+                                unsigned int rflags,
+                                struct lib_ring_buffer_ctx *ctx)
+{
+       size_t orig_offset = offset;
+       size_t padding;
+
+       BUILD_BUG_ON(sizeof(struct event_header) != sizeof(u32));
+
+       padding = lib_ring_buffer_align(offset,
+                                       sizeof(struct event_header));
+       offset += padding;
+       offset += sizeof(struct event_header);
+
+       if (unlikely(rflags)) {
+               switch (rflags) {
+               case LTT_RFLAG_ID_SIZE_TSC:
+                       offset += sizeof(u16) + sizeof(u16);
+                       if (data_size >= LTT_MAX_SMALL_SIZE)
+                               offset += sizeof(u32);
+                       offset += lib_ring_buffer_align(offset, sizeof(u64));
+                       offset += sizeof(u64);
+                       break;
+               case LTT_RFLAG_ID_SIZE:
+                       offset += sizeof(u16) + sizeof(u16);
+                       if (data_size >= LTT_MAX_SMALL_SIZE)
+                               offset += sizeof(u32);
+                       break;
+               case LTT_RFLAG_ID:
+                       offset += sizeof(u16);
+                       break;
+               }
+       }
+
+       *pre_header_padding = padding;
+       return offset - orig_offset;
+}
+
+#include "wrapper/ringbuffer/api.h"
+
+extern
+void ltt_write_event_header_slow(const struct lib_ring_buffer_config *config,
+                                struct lib_ring_buffer_ctx *ctx,
+                                u16 eID, u32 event_size);
+
+/*
+ * ltt_write_event_header
+ *
+ * Writes the event header to the offset (already aligned on 32-bits).
+ *
+ * @config: ring buffer instance configuration
+ * @ctx: reservation context
+ * @eID : event ID
+ * @event_size : size of the event, excluding the event header.
+ */
+static __inline__
+void ltt_write_event_header(const struct lib_ring_buffer_config *config,
+                           struct lib_ring_buffer_ctx *ctx,
+                           u16 eID, u32 event_size)
+{
+       struct event_header header;
+
+       if (unlikely(ctx->rflags))
+               goto slow_path;
+
+       header.id_time = eID << LTT_TSC_BITS;
+       header.id_time |= (u32)ctx->tsc & LTT_TSC_MASK;
+       lib_ring_buffer_write(config, ctx, &header, sizeof(header));
+
+slow_path:
+       ltt_write_event_header_slow(config, ctx, eID, event_size);
+}
+
+/**
+ * ltt_write_trace_header - Write trace header
+ * @priv: Private data (struct trace)
+ * @header: Memory address where the information must be written to
+ */
+static __inline__
+void write_trace_header(const struct lib_ring_buffer_config *config,
+                       struct packet_header *header)
+{
+       header->magic = CTF_MAGIC_NUMBER;
+#if 0
+       /* TODO: move start time to metadata */
+       header->major_version = LTT_TRACER_VERSION_MAJOR;
+       header->minor_version = LTT_TRACER_VERSION_MINOR;
+       header->arch_size = sizeof(void *);
+       header->alignment = lib_ring_buffer_get_alignment(config);
+       header->start_time_sec = ltt_chan->session->start_time.tv_sec;
+       header->start_time_usec = ltt_chan->session->start_time.tv_usec;
+       header->start_freq = ltt_chan->session->start_freq;
+       header->freq_scale = ltt_chan->session->freq_scale;
+#endif //0
+}
+
+void ltt_write_event_header_slow(const struct lib_ring_buffer_config *config,
+                                  struct lib_ring_buffer_ctx *ctx,
+                                  u16 eID, u32 event_size)
+{
+       struct event_header header;
+       u16 small_size;
+
+       switch (ctx->rflags) {
+       case LTT_RFLAG_ID_SIZE_TSC:
+               header.id_time = 29 << LTT_TSC_BITS;
+               break;
+       case LTT_RFLAG_ID_SIZE:
+               header.id_time = 30 << LTT_TSC_BITS;
+               break;
+       case LTT_RFLAG_ID:
+               header.id_time = 31 << LTT_TSC_BITS;
+               break;
+       default:
+               WARN_ON_ONCE(1);
+               header.id_time = 0;
+       }
+
+       header.id_time |= (u32)ctx->tsc & LTT_TSC_MASK;
+       lib_ring_buffer_write(config, ctx, &header, sizeof(header));
+
+       switch (ctx->rflags) {
+       case LTT_RFLAG_ID_SIZE_TSC:
+               small_size = (u16)min_t(u32, event_size, LTT_MAX_SMALL_SIZE);
+               lib_ring_buffer_write(config, ctx, &eID, sizeof(u16));
+               lib_ring_buffer_write(config, ctx, &small_size, sizeof(u16));
+               if (small_size == LTT_MAX_SMALL_SIZE)
+                       lib_ring_buffer_write(config, ctx, &event_size,
+                                             sizeof(u32));
+               lib_ring_buffer_align_ctx(ctx, sizeof(u64));
+               lib_ring_buffer_write(config, ctx, &ctx->tsc, sizeof(u64));
+               break;
+       case LTT_RFLAG_ID_SIZE:
+               small_size = (u16)min_t(u32, event_size, LTT_MAX_SMALL_SIZE);
+               lib_ring_buffer_write(config, ctx, &eID, sizeof(u16));
+               lib_ring_buffer_write(config, ctx, &small_size, sizeof(u16));
+               if (small_size == LTT_MAX_SMALL_SIZE)
+                       lib_ring_buffer_write(config, ctx, &event_size,
+                                             sizeof(u32));
+               break;
+       case LTT_RFLAG_ID:
+               lib_ring_buffer_write(config, ctx, &eID, sizeof(u16));
+               break;
+       }
+}
 
 static const struct lib_ring_buffer_config client_config;
 
@@ -40,29 +215,29 @@ size_t client_record_header_size(const struct lib_ring_buffer_config *config,
 }
 
 /**
- * client_subbuffer_header_size - called on buffer-switch to a new sub-buffer
+ * client_packet_header_size - called on buffer-switch to a new sub-buffer
  *
  * Return header size without padding after the structure. Don't use packed
  * structure because gcc generates inefficient code on some architectures
  * (powerpc, mips..)
  */
-static size_t client_subbuffer_header_size(void)
+static size_t client_packet_header_size(void)
 {
-       return offsetof(struct subbuffer_header, header_end);
+       return offsetof(struct packet_header, header_end);
 }
 
 static void client_buffer_begin(struct lib_ring_buffer *buf, u64 tsc,
                                unsigned int subbuf_idx)
 {
        struct channel *chan = buf->backend.chan;
-       struct subbuffer_header *header =
-               (struct subbuffer_header *)
+       struct packet_header *header =
+               (struct packet_header *)
                        lib_ring_buffer_offset_address(&buf->backend,
                                subbuf_idx * chan->backend.subbuf_size);
 
-       header->cycle_count_begin = tsc;
-       header->data_size = 0xFFFFFFFF; /* for debugging */
-       write_trace_header(chan->backend.priv, header);
+       header->timestamp_begin = tsc;
+       header->content_size = 0xFFFFFFFF; /* for debugging */
+       write_trace_header(&client_config, header);
 }
 
 /*
@@ -73,77 +248,35 @@ static void client_buffer_end(struct lib_ring_buffer *buf, u64 tsc,
                              unsigned int subbuf_idx, unsigned long data_size)
 {
        struct channel *chan = buf->backend.chan;
-       struct subbuffer_header *header =
-               (struct subbuffer_header *)
+       struct packet_header *header =
+               (struct packet_header *)
                        lib_ring_buffer_offset_address(&buf->backend,
                                subbuf_idx * chan->backend.subbuf_size);
        unsigned long records_lost = 0;
 
-       header->data_size = data_size;
-       header->subbuf_size = PAGE_ALIGN(data_size);
-       header->cycle_count_end = tsc;
+       header->content_size = data_size;
+       header->packet_size = PAGE_ALIGN(data_size);
+       header->timestamp_end = tsc;
        records_lost += 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->events_lost = records_lost;
-       header->subbuf_corrupt = 0;     /* deprecated */
 }
 
 static int client_buffer_create(struct lib_ring_buffer *buf, void *priv,
                                int cpu, const char *name)
 {
-       struct channel_priv *chan_priv = priv;
-       struct ring_buffer_priv *buf_priv;
-       struct dentry *trace_dentry;
-       char *tmpname;
-       int ret = 0;
-
-       if (client_config.alloc == RING_BUFFER_ALLOC_PER_CPU)
-               buf_priv = per_cpu_ptr(chan_priv->buf, cpu);
-       else
-               buf_priv = chan_priv->buf;
-
-       tmpname = kzalloc(NAME_MAX + 1, GFP_KERNEL);
-       if (!tmpname) {
-               ret = -ENOMEM;
-               goto end;
-       }
-
-       snprintf(tmpname, NAME_MAX, "%s%s_%d",
-                (client_config.mode == RING_BUFFER_OVERWRITE) ? "flight-" : "",
-                name, cpu);
-
-       trace_dentry = chan_priv->trace->dentry.trace_root;
-       buf_priv->dentry = debugfs_create_file(tmpname, S_IRUSR, trace_dentry,
-                                              buf,
-                                              &lib_ring_buffer_file_operations);
-       if (!buf_priv->dentry) {
-               ret = -ENOMEM;
-               goto free_name;
-       }
-free_name:
-       kfree(tmpname);
-end:
-       return ret;
+       return 0;
 }
 
 static void client_buffer_finalize(struct lib_ring_buffer *buf, void *priv, int cpu)
 {
-       struct channel_priv *chan_priv = priv;
-       struct lib_ring_buffer_priv *buf_priv;
-
-       if (client_config.alloc == RING_BUFFER_ALLOC_PER_CPU)
-               buf_priv = per_cpu_ptr(chan_priv->buf, cpu);
-       else
-               buf_priv = chan_priv->buf;
-
-       debugfs_remove(buf_priv->dentry);
 }
 
 static const struct 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_subbuffer_header_size,
+       .cb.subbuffer_header_size = client_packet_header_size,
        .cb.buffer_begin = client_buffer_begin,
        .cb.buffer_end = client_buffer_end,
        .cb.buffer_create = client_buffer_create,
@@ -153,11 +286,6 @@ static const struct lib_ring_buffer_config client_config = {
        .alloc = RING_BUFFER_ALLOC_PER_CPU,
        .sync = RING_BUFFER_SYNC_PER_CPU,
        .mode = RING_BUFFER_MODE_TEMPLATE,
-#ifdef RING_BUFFER_ALIGN
-       .align = RING_BUFFER_NATURAL,
-#else
-       .align = RING_BUFFER_PACKED,
-#endif
        .backend = RING_BUFFER_PAGE,
        .output = RING_BUFFER_SPLICE,
        .oops = RING_BUFFER_OOPS_CONSISTENCY,
@@ -166,105 +294,121 @@ static const struct lib_ring_buffer_config client_config = {
 };
 
 static
-struct channel *ltt_channel_create(const char *name, struct ltt_trace *trace,
-                                  void *buf_addr,
-                                  size_t subbuf_size, size_t num_subbuf,
-                                  unsigned int switch_timer_interval,
-                                  unsigned int read_timer_interval)
+struct channel *_channel_create(const char *name,
+                               struct ltt_session *session, void *buf_addr,
+                               size_t subbuf_size, size_t num_subbuf,
+                               unsigned int switch_timer_interval,
+                               unsigned int read_timer_interval)
 {
-       struct channel *chan;
-       struct chan_priv *chan_priv;
-
-       chan_priv = kzalloc(sizeof(struct chan_priv), GFP_KERNEL);
-       if (!chan_priv)
-               return NULL;
-       if (client_config.alloc == RING_BUFFER_ALLOC_PER_CPU) {
-               chan_priv->buf = alloc_percpu(struct lib_ring_buffer_priv);
-               memset(chan_priv->buf, 0, sizeof(*chan_priv->buf));
-       } else
-               chan_priv->buf = kzalloc(sizeof(*chan_priv->buf), GFP_KERNEL)
-       if (!channel_priv->buf)
-               goto free_chan_priv;
-       chan_priv->trace = trace;
-       chan = channel_create(&client_config, name, chan_priv, buf_addr,
+       return channel_create(&client_config, name, session, buf_addr,
                              subbuf_size, num_subbuf, switch_timer_interval,
                              read_timer_interval);
-       if (!chan)
-               goto free_buf_priv;
-       return chan;
-
-free_buf_priv:
-       if (client_config.alloc == RING_BUFFER_ALLOC_PER_CPU)
-               free_percpu(chan_priv->buf);
-       else
-               kfree(chan_priv->buf);
-free_chan_priv:
-       kfree(chan_priv);
-       return NULL;
 }
 
 static
 void ltt_channel_destroy(struct channel *chan)
 {
-       struct chan_priv *chan_priv = channel_get_private(chan);
-
        channel_destroy(chan);
-       if (client_config.alloc == RING_BUFFER_ALLOC_PER_CPU)
-               free_percpu(chan_priv->buf);
-       else
-               kfree(chan_priv->buf);
-       kfree(chan_priv);
 }
 
-static void ltt_relay_remove_dirs(struct ltt_trace *trace)
+static
+struct lib_ring_buffer *ltt_buffer_read_open(struct channel *chan)
 {
-       debugfs_remove(trace->dentry.trace_root);
+       struct 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))
+                       return buf;
+       }
+       return NULL;
 }
 
-static int ltt_relay_create_dirs(struct ltt_trace *new_trace)
+static
+void ltt_buffer_read_close(struct lib_ring_buffer *buf)
 {
-       struct dentry *ltt_root_dentry;
-       int ret;
-
-       ltt_root_dentry = get_ltt_root();
-       if (!ltt_root_dentry)
-               return ENOENT;
-
-       new_trace->dentry.trace_root = debugfs_create_dir(new_trace->trace_name,
-                                                         ltt_root_dentry);
-       put_ltt_root();
-       if (new_trace->dentry.trace_root == NULL) {
-               printk(KERN_ERR "LTT : Trace directory name %s already taken\n",
-                      new_trace->trace_name);
-               return EEXIST;
-       }
-       return 0;
+       lib_ring_buffer_release_read(buf);
+       
+}
+
+static
+int ltt_event_reserve(struct lib_ring_buffer_ctx *ctx)
+{
+       int ret, cpu;
+
+       cpu = lib_ring_buffer_get_cpu(&client_config);
+       if (cpu < 0)
+               return -EPERM;
+       ctx->cpu = cpu;
+
+       ret = lib_ring_buffer_reserve(&client_config, ctx);
+       if (ret)
+               goto put;
+       return ret;
+
+put:
+       lib_ring_buffer_put_cpu(&client_config);
+       return ret;
+}
+
+static
+void ltt_event_commit(struct 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,
+                    size_t len)
+{
+       lib_ring_buffer_write(&client_config, ctx, src, len);
+}
+
+static
+wait_queue_head_t *ltt_get_reader_wait_queue(struct ltt_channel *chan)
+{
+       return &chan->chan->read_wait;
 }
 
 static struct ltt_transport ltt_relay_transport = {
        .name = "relay-" RING_BUFFER_MODE_TEMPLATE_STRING,
        .owner = THIS_MODULE,
        .ops = {
-               .create_dirs = ltt_relay_create_dirs,
-               .remove_dirs = ltt_relay_remove_dirs,
-               .create_channel = ltt_channel_create,
-               .destroy_channel = ltt_channel_destroy,
+               .channel_create = _channel_create,
+               .channel_destroy = ltt_channel_destroy,
+               .buffer_read_open = ltt_buffer_read_open,
+               .buffer_read_close = ltt_buffer_read_close,
+               .event_reserve = ltt_event_reserve,
+               .event_commit = ltt_event_commit,
+               .event_write = ltt_event_write,
+               .get_reader_wait_queue = ltt_get_reader_wait_queue,
        },
 };
 
 static int __init ltt_ring_buffer_client_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");
        ltt_transport_register(&ltt_relay_transport);
        return 0;
 }
 
+module_init(ltt_ring_buffer_client_init);
+
 static void __exit ltt_ring_buffer_client_exit(void)
 {
        printk(KERN_INFO "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
This page took 0.029357 seconds and 4 git commands to generate.