Rename LTTNG_ALLOCATE_COMPOUND_LITERAL_ON_HEAP to add LTTNG_UST_ prefix
[lttng-ust.git] / include / lttng / ringbuffer-context.h
index 1b200f7c7f458a422c8abf3966f19ea2f34d6b85..a31e80e3e9ea6474173d32b2f4e3a25d1a32f5f0 100644 (file)
 #include <lttng/ust-utils.h>
 #include <lttng/ust-compiler.h>
 
-struct lttng_ust_lib_ring_buffer;
-struct lttng_ust_lib_ring_buffer_channel;
-struct lttng_ust_lib_ring_buffer_ctx;
+struct lttng_ust_ring_buffer;
+struct lttng_ust_ring_buffer_channel;
+struct lttng_ust_ring_buffer_ctx;
+struct lttng_ust_ring_buffer_ctx_private;
 
 /*
  * ring buffer context
  *
- * Context passed to lib_ring_buffer_reserve(), lib_ring_buffer_commit(),
- * lib_ring_buffer_try_discard_reserve(), lib_ring_buffer_align_ctx() and
- * lib_ring_buffer_write().
- *
  * IMPORTANT: this structure is part of the ABI between the probe and
  * UST. Fields need to be only added at the end, never reordered, never
  * removed.
@@ -38,121 +35,97 @@ struct lttng_ust_lib_ring_buffer_ctx;
  * structure. It should be queried before using additional fields added
  * at the end of the structure.
  */
-struct lttng_ust_lib_ring_buffer_ctx {
+struct lttng_ust_ring_buffer_ctx {
        uint32_t struct_size;                   /* Size of this structure. */
 
-       /* input received by lib_ring_buffer_reserve(). */
-       struct lttng_ust_lib_ring_buffer_channel *chan; /* channel */
-       void *priv;                             /* client private data */
+       void *client_priv;                      /* Ring buffer client private data */
        size_t data_size;                       /* size of payload */
        int largest_align;                      /*
                                                 * alignment of the largest element
                                                 * in the payload
                                                 */
-
-       /* output from lib_ring_buffer_reserve() */
-       int reserve_cpu;                        /* processor id updated by the reserve */
-       size_t slot_size;                       /* size of the reserved slot */
-       unsigned long buf_offset;               /* offset following the record header */
-       unsigned long pre_offset;               /*
-                                                * Initial offset position _before_
-                                                * the record is written. Positioned
-                                                * prior to record header alignment
-                                                * padding.
-                                                */
-       uint64_t tsc;                           /* time-stamp counter value */
-       unsigned int rflags;                    /* reservation flags */
        void *ip;                               /* caller ip address */
 
-       struct lttng_ust_lib_ring_buffer *buf;  /*
-                                                * buffer corresponding to processor id
-                                                * for this channel
-                                                */
-       struct lttng_ust_lib_ring_buffer_backend_pages *backend_pages;
+       /* Private ring buffer context, set by reserve callback. */
+       struct lttng_ust_ring_buffer_ctx_private *priv;
 
        /* End of base ABI. Fields below should be used after checking struct_size. */
 };
 
 /**
- * lib_ring_buffer_ctx_init - initialize ring buffer context
+ * lttng_ust_ring_buffer_ctx_init - initialize ring buffer context
  * @ctx: ring buffer context to initialize
- * @chan: channel
- * @priv: client private data
+ * @client_priv: client private data
  * @data_size: size of record data payload
  * @largest_align: largest alignment within data payload types
+ * @ip: caller ip address
  */
-static inline lttng_ust_notrace
-void lib_ring_buffer_ctx_init(struct lttng_ust_lib_ring_buffer_ctx *ctx,
-                             struct lttng_ust_lib_ring_buffer_channel *chan,
-                             void *priv, size_t data_size, int largest_align);
 static inline
-void lib_ring_buffer_ctx_init(struct lttng_ust_lib_ring_buffer_ctx *ctx,
-                             struct lttng_ust_lib_ring_buffer_channel *chan,
-                             void *priv, size_t data_size, int largest_align)
+void lttng_ust_ring_buffer_ctx_init(struct lttng_ust_ring_buffer_ctx *ctx,
+                                       void *client_priv, size_t data_size, int largest_align,
+                                       void *ip)
+       lttng_ust_notrace;
+static inline
+void lttng_ust_ring_buffer_ctx_init(struct lttng_ust_ring_buffer_ctx *ctx,
+                                       void *client_priv, size_t data_size, int largest_align,
+                                       void *ip)
 {
-       ctx->struct_size = sizeof(struct lttng_ust_lib_ring_buffer_ctx);
-       ctx->chan = chan;
-       ctx->priv = priv;
+       ctx->struct_size = sizeof(struct lttng_ust_ring_buffer_ctx);
+       ctx->client_priv = client_priv;
        ctx->data_size = data_size;
-       ctx->reserve_cpu = -1;
        ctx->largest_align = largest_align;
-       ctx->rflags = 0;
-       ctx->ip = 0;
+       ctx->ip = ip;
+       ctx->priv = NULL;
 }
 
 /*
- * We need to define RING_BUFFER_ALIGN_ATTR so it is known early at
+ * We need to define LTTNG_UST_RING_BUFFER_ALIGN_ATTR so it is known early at
  * compile-time. We have to duplicate the "config->align" information and the
  * definition here because config->align is used both in the slow and fast
- * paths, but RING_BUFFER_ALIGN_ATTR is only available for the client code.
+ * paths, but LTTNG_UST_RING_BUFFER_ALIGN_ATTR is only available for the client
+ * code.
  */
-#ifdef RING_BUFFER_ALIGN
+#ifdef LTTNG_UST_RING_BUFFER_NATURAL_ALIGN
 
-# define RING_BUFFER_ALIGN_ATTR                /* Default arch alignment */
+# define LTTNG_UST_RING_BUFFER_ALIGN_ATTR      /* Default arch alignment */
 
 /*
- * Calculate the offset needed to align the type.
- * size_of_type must be non-zero.
+ * lttng_ust_ring_buffer_align - Calculate the offset needed to align the type.
+ * @align_drift:  object offset from an "alignment"-aligned address.
+ * @size_of_type: Must be non-zero, power of 2.
  */
-static inline lttng_ust_notrace
-unsigned int lib_ring_buffer_align(size_t align_drift, size_t size_of_type);
 static inline
-unsigned int lib_ring_buffer_align(size_t align_drift, size_t size_of_type)
+unsigned int lttng_ust_ring_buffer_align(size_t align_drift, size_t size_of_type)
+       lttng_ust_notrace;
+static inline
+unsigned int lttng_ust_ring_buffer_align(size_t align_drift, size_t size_of_type)
 {
        return lttng_ust_offset_align(align_drift, size_of_type);
 }
 
 #else
 
-# define RING_BUFFER_ALIGN_ATTR __attribute__((packed))
+# define LTTNG_UST_RING_BUFFER_ALIGN_ATTR __attribute__((packed))
 
 /*
- * Calculate the offset needed to align the type.
- * size_of_type must be non-zero.
+ * lttng_ust_ring_buffer_align - Calculate the offset needed to align the type.
+ * @align_drift:  object offset from an "alignment"-aligned address.
+ * @size_of_type: Must be non-zero, power of 2.
  */
-static inline lttng_ust_notrace
-unsigned int lib_ring_buffer_align(size_t align_drift, size_t size_of_type);
 static inline
-unsigned int lib_ring_buffer_align(size_t align_drift, size_t size_of_type)
+unsigned int lttng_ust_ring_buffer_align(size_t align_drift, size_t size_of_type)
+       lttng_ust_notrace;
+static inline
+unsigned int lttng_ust_ring_buffer_align(size_t align_drift __attribute__((unused)),
+               size_t size_of_type __attribute__((unused)))
 {
+       /*
+        * On architectures with efficient unaligned memory access, the content
+        * of the ringbuffer is packed and so the offset is always zero.
+        */
        return 0;
 }
 
 #endif
 
-/**
- * lib_ring_buffer_align_ctx - Align context offset on "alignment"
- * @ctx: ring buffer context.
- */
-static inline lttng_ust_notrace
-void lib_ring_buffer_align_ctx(struct lttng_ust_lib_ring_buffer_ctx *ctx,
-                          size_t alignment);
-static inline
-void lib_ring_buffer_align_ctx(struct lttng_ust_lib_ring_buffer_ctx *ctx,
-                          size_t alignment)
-{
-       ctx->buf_offset += lib_ring_buffer_align(ctx->buf_offset,
-                                                alignment);
-}
-
 #endif /* _LTTNG_RING_BUFFER_CONTEXT_H */
This page took 0.024997 seconds and 4 git commands to generate.