New API: lttng_ust_init_thread() for async-signal tracing
[lttng-ust.git] / liblttng-ust / lttng-ring-buffer-client.h
index 0be36aa2d932793c43bce1fc5d955acbe11b714c..dfc98ceeff8c4bc5044b35c771ef31043c985b92 100644 (file)
@@ -6,6 +6,7 @@
  * LTTng lib ring buffer client template.
  */
 
+#include <limits.h>
 #include <stddef.h>
 #include <stdint.h>
 
@@ -17,6 +18,7 @@
 #include "context-internal.h"
 #include "lttng-tracer.h"
 #include "../libringbuffer/frontend_types.h"
+#include <urcu/tls-compat.h>
 
 #define LTTNG_COMPACT_EVENT_BITS       5
 #define LTTNG_COMPACT_TSC_BITS         27
@@ -67,6 +69,20 @@ struct lttng_client_ctx {
        struct lttng_ust_ctx *event_ctx;
 };
 
+/*
+ * Indexed by lib_ring_buffer_nesting_count().
+ */
+typedef struct lttng_ust_lib_ring_buffer_ctx_private private_ctx_stack_t[LIB_RING_BUFFER_MAX_NESTING];
+static DEFINE_URCU_TLS(private_ctx_stack_t, private_ctx_stack);
+
+/*
+ * Force a read (imply TLS fixup for dlopen) of TLS variables.
+ */
+void RING_BUFFER_MODE_TEMPLATE_TLS_FIXUP(void)
+{
+       asm volatile ("" : : "m" (URCU_TLS(private_ctx_stack)));
+}
+
 static inline uint64_t lib_ring_buffer_clock_read(struct lttng_ust_lib_ring_buffer_channel *chan)
 {
        return trace_clock_read64();
@@ -80,7 +96,7 @@ size_t ctx_get_aligned_size(size_t offset, struct lttng_ust_ctx *ctx,
 
        if (caa_likely(!ctx))
                return 0;
-       offset += lib_ring_buffer_align(offset, ctx->largest_align);
+       offset += lttng_ust_lib_ring_buffer_align(offset, ctx->largest_align);
        offset += ctx_len;
        return offset - orig_offset;
 }
@@ -130,7 +146,7 @@ void ctx_record(struct lttng_ust_lib_ring_buffer_ctx *bufctx,
 
        if (caa_likely(!ctx))
                return;
-       lib_ring_buffer_align_ctx(bufctx, ctx->largest_align);
+       lttng_ust_lib_ring_buffer_align_ctx(bufctx, ctx->largest_align);
        for (i = 0; i < ctx->nr_fields; i++) {
                if (mode == APP_CTX_ENABLED) {
                        ctx->fields[i]->record(ctx->fields[i], bufctx, chan);
@@ -181,32 +197,32 @@ size_t record_header_size(const struct lttng_ust_lib_ring_buffer_config *config,
 
        switch (lttng_chan->priv->header_type) {
        case 1: /* compact */
-               padding = lib_ring_buffer_align(offset, lttng_alignof(uint32_t));
+               padding = lttng_ust_lib_ring_buffer_align(offset, lttng_ust_rb_alignof(uint32_t));
                offset += padding;
-               if (!(ctx->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTTNG_RFLAG_EXTENDED))) {
+               if (!(ctx->priv->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTTNG_RFLAG_EXTENDED))) {
                        offset += sizeof(uint32_t);     /* id and timestamp */
                } else {
                        /* Minimum space taken by LTTNG_COMPACT_EVENT_BITS id */
                        offset += (LTTNG_COMPACT_EVENT_BITS + CHAR_BIT - 1) / CHAR_BIT;
                        /* Align extended struct on largest member */
-                       offset += lib_ring_buffer_align(offset, lttng_alignof(uint64_t));
+                       offset += lttng_ust_lib_ring_buffer_align(offset, lttng_ust_rb_alignof(uint64_t));
                        offset += sizeof(uint32_t);     /* id */
-                       offset += lib_ring_buffer_align(offset, lttng_alignof(uint64_t));
+                       offset += lttng_ust_lib_ring_buffer_align(offset, lttng_ust_rb_alignof(uint64_t));
                        offset += sizeof(uint64_t);     /* timestamp */
                }
                break;
        case 2: /* large */
-               padding = lib_ring_buffer_align(offset, lttng_alignof(uint16_t));
+               padding = lttng_ust_lib_ring_buffer_align(offset, lttng_ust_rb_alignof(uint16_t));
                offset += padding;
                offset += sizeof(uint16_t);
-               if (!(ctx->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTTNG_RFLAG_EXTENDED))) {
-                       offset += lib_ring_buffer_align(offset, lttng_alignof(uint32_t));
+               if (!(ctx->priv->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTTNG_RFLAG_EXTENDED))) {
+                       offset += lttng_ust_lib_ring_buffer_align(offset, lttng_ust_rb_alignof(uint32_t));
                        offset += sizeof(uint32_t);     /* timestamp */
                } else {
                        /* Align extended struct on largest member */
-                       offset += lib_ring_buffer_align(offset, lttng_alignof(uint64_t));
+                       offset += lttng_ust_lib_ring_buffer_align(offset, lttng_ust_rb_alignof(uint64_t));
                        offset += sizeof(uint32_t);     /* id */
-                       offset += lib_ring_buffer_align(offset, lttng_alignof(uint64_t));
+                       offset += lttng_ust_lib_ring_buffer_align(offset, lttng_ust_rb_alignof(uint64_t));
                        offset += sizeof(uint64_t);     /* timestamp */
                }
                break;
@@ -246,9 +262,9 @@ void lttng_write_event_header(const struct lttng_ust_lib_ring_buffer_config *con
                            struct lttng_client_ctx *client_ctx,
                            uint32_t event_id)
 {
-       struct lttng_ust_channel_buffer *lttng_chan = channel_get_private(ctx->chan);
+       struct lttng_ust_channel_buffer *lttng_chan = channel_get_private(ctx->priv->chan);
 
-       if (caa_unlikely(ctx->rflags))
+       if (caa_unlikely(ctx->priv->rflags))
                goto slow_path;
 
        switch (lttng_chan->priv->header_type) {
@@ -263,17 +279,17 @@ void lttng_write_event_header(const struct lttng_ust_lib_ring_buffer_config *con
                bt_bitfield_write(&id_time, uint32_t,
                                LTTNG_COMPACT_EVENT_BITS,
                                LTTNG_COMPACT_TSC_BITS,
-                               ctx->tsc);
+                               ctx->priv->tsc);
                lib_ring_buffer_write(config, ctx, &id_time, sizeof(id_time));
                break;
        }
        case 2: /* large */
        {
-               uint32_t timestamp = (uint32_t) ctx->tsc;
+               uint32_t timestamp = (uint32_t) ctx->priv->tsc;
                uint16_t id = event_id;
 
                lib_ring_buffer_write(config, ctx, &id, sizeof(id));
-               lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint32_t));
+               lttng_ust_lib_ring_buffer_align_ctx(ctx, lttng_ust_rb_alignof(uint32_t));
                lib_ring_buffer_write(config, ctx, &timestamp, sizeof(timestamp));
                break;
        }
@@ -283,7 +299,7 @@ void lttng_write_event_header(const struct lttng_ust_lib_ring_buffer_config *con
 
        ctx_record(ctx, lttng_chan, client_ctx->chan_ctx, APP_CTX_ENABLED);
        ctx_record(ctx, lttng_chan, client_ctx->event_ctx, APP_CTX_ENABLED);
-       lib_ring_buffer_align_ctx(ctx, ctx->largest_align);
+       lttng_ust_lib_ring_buffer_align_ctx(ctx, ctx->largest_align);
 
        return;
 
@@ -297,11 +313,12 @@ void lttng_write_event_header_slow(const struct lttng_ust_lib_ring_buffer_config
                                 struct lttng_client_ctx *client_ctx,
                                 uint32_t event_id)
 {
-       struct lttng_ust_channel_buffer *lttng_chan = channel_get_private(ctx->chan);
+       struct lttng_ust_lib_ring_buffer_ctx_private *ctx_private = ctx->priv;
+       struct lttng_ust_channel_buffer *lttng_chan = channel_get_private(ctx->priv->chan);
 
        switch (lttng_chan->priv->header_type) {
        case 1: /* compact */
-               if (!(ctx->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTTNG_RFLAG_EXTENDED))) {
+               if (!(ctx_private->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTTNG_RFLAG_EXTENDED))) {
                        uint32_t id_time = 0;
 
                        bt_bitfield_write(&id_time, uint32_t,
@@ -311,11 +328,11 @@ void lttng_write_event_header_slow(const struct lttng_ust_lib_ring_buffer_config
                        bt_bitfield_write(&id_time, uint32_t,
                                        LTTNG_COMPACT_EVENT_BITS,
                                        LTTNG_COMPACT_TSC_BITS,
-                                       ctx->tsc);
+                                       ctx_private->tsc);
                        lib_ring_buffer_write(config, ctx, &id_time, sizeof(id_time));
                } else {
                        uint8_t id = 0;
-                       uint64_t timestamp = ctx->tsc;
+                       uint64_t timestamp = ctx_private->tsc;
 
                        bt_bitfield_write(&id, uint8_t,
                                        0,
@@ -323,30 +340,30 @@ void lttng_write_event_header_slow(const struct lttng_ust_lib_ring_buffer_config
                                        31);
                        lib_ring_buffer_write(config, ctx, &id, sizeof(id));
                        /* Align extended struct on largest member */
-                       lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint64_t));
+                       lttng_ust_lib_ring_buffer_align_ctx(ctx, lttng_ust_rb_alignof(uint64_t));
                        lib_ring_buffer_write(config, ctx, &event_id, sizeof(event_id));
-                       lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint64_t));
+                       lttng_ust_lib_ring_buffer_align_ctx(ctx, lttng_ust_rb_alignof(uint64_t));
                        lib_ring_buffer_write(config, ctx, &timestamp, sizeof(timestamp));
                }
                break;
        case 2: /* large */
        {
-               if (!(ctx->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTTNG_RFLAG_EXTENDED))) {
-                       uint32_t timestamp = (uint32_t) ctx->tsc;
+               if (!(ctx_private->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTTNG_RFLAG_EXTENDED))) {
+                       uint32_t timestamp = (uint32_t) ctx_private->tsc;
                        uint16_t id = event_id;
 
                        lib_ring_buffer_write(config, ctx, &id, sizeof(id));
-                       lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint32_t));
+                       lttng_ust_lib_ring_buffer_align_ctx(ctx, lttng_ust_rb_alignof(uint32_t));
                        lib_ring_buffer_write(config, ctx, &timestamp, sizeof(timestamp));
                } else {
                        uint16_t id = 65535;
-                       uint64_t timestamp = ctx->tsc;
+                       uint64_t timestamp = ctx_private->tsc;
 
                        lib_ring_buffer_write(config, ctx, &id, sizeof(id));
                        /* Align extended struct on largest member */
-                       lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint64_t));
+                       lttng_ust_lib_ring_buffer_align_ctx(ctx, lttng_ust_rb_alignof(uint64_t));
                        lib_ring_buffer_write(config, ctx, &event_id, sizeof(event_id));
-                       lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint64_t));
+                       lttng_ust_lib_ring_buffer_align_ctx(ctx, lttng_ust_rb_alignof(uint64_t));
                        lib_ring_buffer_write(config, ctx, &timestamp, sizeof(timestamp));
                }
                break;
@@ -356,7 +373,7 @@ void lttng_write_event_header_slow(const struct lttng_ust_lib_ring_buffer_config
        }
        ctx_record(ctx, lttng_chan, client_ctx->chan_ctx, APP_CTX_ENABLED);
        ctx_record(ctx, lttng_chan, client_ctx->event_ctx, APP_CTX_ENABLED);
-       lib_ring_buffer_align_ctx(ctx, ctx->largest_align);
+       lttng_ust_lib_ring_buffer_align_ctx(ctx, ctx->largest_align);
 }
 
 static const struct lttng_ust_lib_ring_buffer_config client_config;
@@ -481,9 +498,10 @@ static struct packet_header *client_packet_header(struct lttng_ust_lib_ring_buff
 }
 
 static int client_timestamp_begin(struct lttng_ust_lib_ring_buffer *buf,
-               struct lttng_ust_shm_handle *handle,
+               struct lttng_ust_lib_ring_buffer_channel *chan,
                uint64_t *timestamp_begin)
 {
+       struct lttng_ust_shm_handle *handle = chan->handle;
        struct packet_header *header;
 
        header = client_packet_header(buf, handle);
@@ -494,9 +512,10 @@ static int client_timestamp_begin(struct lttng_ust_lib_ring_buffer *buf,
 }
 
 static int client_timestamp_end(struct lttng_ust_lib_ring_buffer *buf,
-               struct lttng_ust_shm_handle *handle,
+               struct lttng_ust_lib_ring_buffer_channel *chan,
                uint64_t *timestamp_end)
 {
+       struct lttng_ust_shm_handle *handle = chan->handle;
        struct packet_header *header;
 
        header = client_packet_header(buf, handle);
@@ -507,9 +526,10 @@ static int client_timestamp_end(struct lttng_ust_lib_ring_buffer *buf,
 }
 
 static int client_events_discarded(struct lttng_ust_lib_ring_buffer *buf,
-               struct lttng_ust_shm_handle *handle,
+               struct lttng_ust_lib_ring_buffer_channel *chan,
                uint64_t *events_discarded)
 {
+       struct lttng_ust_shm_handle *handle = chan->handle;
        struct packet_header *header;
 
        header = client_packet_header(buf, handle);
@@ -520,9 +540,10 @@ static int client_events_discarded(struct lttng_ust_lib_ring_buffer *buf,
 }
 
 static int client_content_size(struct lttng_ust_lib_ring_buffer *buf,
-               struct lttng_ust_shm_handle *handle,
+               struct lttng_ust_lib_ring_buffer_channel *chan,
                uint64_t *content_size)
 {
+       struct lttng_ust_shm_handle *handle = chan->handle;
        struct packet_header *header;
 
        header = client_packet_header(buf, handle);
@@ -533,9 +554,10 @@ static int client_content_size(struct lttng_ust_lib_ring_buffer *buf,
 }
 
 static int client_packet_size(struct lttng_ust_lib_ring_buffer *buf,
-               struct lttng_ust_shm_handle *handle,
+               struct lttng_ust_lib_ring_buffer_channel *chan,
                uint64_t *packet_size)
 {
+       struct lttng_ust_shm_handle *handle = chan->handle;
        struct packet_header *header;
 
        header = client_packet_header(buf, handle);
@@ -546,11 +568,9 @@ static int client_packet_size(struct lttng_ust_lib_ring_buffer *buf,
 }
 
 static int client_stream_id(struct lttng_ust_lib_ring_buffer *buf,
-               struct lttng_ust_shm_handle *handle,
+               struct lttng_ust_lib_ring_buffer_channel *chan,
                uint64_t *stream_id)
 {
-       struct lttng_ust_lib_ring_buffer_channel *chan = shmp(handle,
-                       buf->backend.chan);
        struct lttng_ust_channel_buffer *lttng_chan = channel_get_private(chan);
 
        *stream_id = lttng_chan->priv->id;
@@ -559,21 +579,19 @@ static int client_stream_id(struct lttng_ust_lib_ring_buffer *buf,
 }
 
 static int client_current_timestamp(struct lttng_ust_lib_ring_buffer *buf,
-               struct lttng_ust_shm_handle *handle,
+               struct lttng_ust_lib_ring_buffer_channel *chan,
                uint64_t *ts)
 {
-       struct lttng_ust_lib_ring_buffer_channel *chan;
-
-       chan = shmp(handle, handle->chan);
        *ts = client_ring_buffer_clock_read(chan);
 
        return 0;
 }
 
 static int client_sequence_number(struct lttng_ust_lib_ring_buffer *buf,
-               struct lttng_ust_shm_handle *handle,
+               struct lttng_ust_lib_ring_buffer_channel *chan,
                uint64_t *seq)
 {
+       struct lttng_ust_shm_handle *handle = chan->handle;
        struct packet_header *header;
 
        header = client_packet_header(buf, handle);
@@ -584,7 +602,7 @@ static int client_sequence_number(struct lttng_ust_lib_ring_buffer *buf,
 }
 
 static int client_instance_id(struct lttng_ust_lib_ring_buffer *buf,
-               struct lttng_ust_shm_handle *handle,
+               struct lttng_ust_lib_ring_buffer_channel *chan,
                uint64_t *id)
 {
        *id = buf->backend.cpu;
@@ -675,7 +693,7 @@ struct lttng_ust_channel_buffer *_channel_create(const char *name,
                        stream_fds, nr_stream_fds, blocking_timeout);
        if (!handle)
                goto error;
-       lttng_chan_buf->chan = shmp(handle, handle->chan);
+       lttng_chan_buf->priv->rb_chan = shmp(handle, handle->chan);
        return lttng_chan_buf;
 
 error:
@@ -686,20 +704,21 @@ error:
 static
 void lttng_channel_destroy(struct lttng_ust_channel_buffer *lttng_chan_buf)
 {
-       channel_destroy(lttng_chan_buf->chan, lttng_chan_buf->chan->handle, 1);
+       channel_destroy(lttng_chan_buf->priv->rb_chan, lttng_chan_buf->priv->rb_chan->handle, 1);
        lttng_ust_free_channel_common(lttng_chan_buf->parent);
 }
 
 static
-int lttng_event_reserve(struct lttng_ust_lib_ring_buffer_ctx *ctx,
-                     uint32_t event_id)
+int lttng_event_reserve(struct lttng_ust_lib_ring_buffer_ctx *ctx)
 {
-       struct lttng_ust_channel_buffer *lttng_chan = channel_get_private(ctx->chan);
-       struct lttng_ust_stack_ctx *lttng_ctx = ctx->priv;
-       struct lttng_ust_event_recorder *event_recorder = lttng_ctx->event_recorder;
+       struct lttng_ust_event_recorder *event_recorder = ctx->client_priv;
+       struct lttng_ust_channel_buffer *lttng_chan = event_recorder->chan;
        struct lttng_client_ctx client_ctx;
-       int ret;
+       int ret, nesting;
+       struct lttng_ust_lib_ring_buffer_ctx_private *private_ctx;
+       uint32_t event_id;
 
+       event_id = event_recorder->priv->id;
        client_ctx.chan_ctx = lttng_ust_rcu_dereference(lttng_chan->priv->ctx);
        client_ctx.event_ctx = lttng_ust_rcu_dereference(event_recorder->priv->ctx);
        /* Compute internal size of context structures. */
@@ -708,17 +727,25 @@ int lttng_event_reserve(struct lttng_ust_lib_ring_buffer_ctx *ctx,
        ctx_get_struct_size(client_ctx.event_ctx, &client_ctx.event_context_len,
                        APP_CTX_ENABLED);
 
-       if (lib_ring_buffer_nesting_inc(&client_config) < 0)
+       nesting = lib_ring_buffer_nesting_inc(&client_config);
+       if (nesting < 0)
                return -EPERM;
 
+       private_ctx = &URCU_TLS(private_ctx_stack)[nesting];
+       memset(private_ctx, 0, sizeof(*private_ctx));
+       private_ctx->pub = ctx;
+       private_ctx->chan = lttng_chan->priv->rb_chan;
+
+       ctx->priv = private_ctx;
+
        switch (lttng_chan->priv->header_type) {
        case 1: /* compact */
                if (event_id > 30)
-                       ctx->rflags |= LTTNG_RFLAG_EXTENDED;
+                       private_ctx->rflags |= LTTNG_RFLAG_EXTENDED;
                break;
        case 2: /* large */
                if (event_id > 65534)
-                       ctx->rflags |= LTTNG_RFLAG_EXTENDED;
+                       private_ctx->rflags |= LTTNG_RFLAG_EXTENDED;
                break;
        default:
                WARN_ON_ONCE(1);
@@ -728,7 +755,7 @@ int lttng_event_reserve(struct lttng_ust_lib_ring_buffer_ctx *ctx,
        if (caa_unlikely(ret))
                goto put;
        if (lib_ring_buffer_backend_get_pages(&client_config, ctx,
-                       &ctx->backend_pages)) {
+                       &private_ctx->backend_pages)) {
                ret = -EPERM;
                goto put;
        }
@@ -747,68 +774,59 @@ void lttng_event_commit(struct lttng_ust_lib_ring_buffer_ctx *ctx)
 }
 
 static
-void lttng_event_write(struct lttng_ust_lib_ring_buffer_ctx *ctx, const void *src,
-                    size_t len)
+void lttng_event_write(struct lttng_ust_lib_ring_buffer_ctx *ctx,
+               const void *src, size_t len, size_t alignment)
 {
+       lttng_ust_lib_ring_buffer_align_ctx(ctx, alignment);
        lib_ring_buffer_write(&client_config, ctx, src, len);
 }
 
 static
-void lttng_event_strcpy(struct lttng_ust_lib_ring_buffer_ctx *ctx, const char *src,
-                    size_t len)
+void lttng_event_strcpy(struct lttng_ust_lib_ring_buffer_ctx *ctx,
+               const char *src, size_t len)
 {
        lib_ring_buffer_strcpy(&client_config, ctx, src, len, '#');
 }
 
 static
 void lttng_event_pstrcpy_pad(struct lttng_ust_lib_ring_buffer_ctx *ctx,
-                    const char *src, size_t len)
+               const char *src, size_t len)
 {
        lib_ring_buffer_pstrcpy(&client_config, ctx, src, len, '\0');
 }
 
-#if 0
 static
-wait_queue_head_t *lttng_get_reader_wait_queue(struct lttng_ust_lib_ring_buffer_channel *chan)
+int lttng_is_finalized(struct lttng_ust_channel_buffer *chan)
 {
-       return &chan->read_wait;
-}
+       struct lttng_ust_lib_ring_buffer_channel *rb_chan = chan->priv->rb_chan;
 
-static
-wait_queue_head_t *lttng_get_hp_wait_queue(struct lttng_ust_lib_ring_buffer_channel *chan)
-{
-       return &chan->hp_wait;
+       return lib_ring_buffer_channel_is_finalized(rb_chan);
 }
-#endif //0
 
 static
-int lttng_is_finalized(struct lttng_ust_lib_ring_buffer_channel *chan)
+int lttng_is_disabled(struct lttng_ust_channel_buffer *chan)
 {
-       return lib_ring_buffer_channel_is_finalized(chan);
-}
+       struct lttng_ust_lib_ring_buffer_channel *rb_chan = chan->priv->rb_chan;
 
-static
-int lttng_is_disabled(struct lttng_ust_lib_ring_buffer_channel *chan)
-{
-       return lib_ring_buffer_channel_is_disabled(chan);
+       return lib_ring_buffer_channel_is_disabled(rb_chan);
 }
 
 static
-int lttng_flush_buffer(struct lttng_ust_lib_ring_buffer_channel *chan,
-               struct lttng_ust_shm_handle *handle)
+int lttng_flush_buffer(struct lttng_ust_channel_buffer *chan)
 {
+       struct lttng_ust_lib_ring_buffer_channel *rb_chan = chan->priv->rb_chan;
        struct lttng_ust_lib_ring_buffer *buf;
        int cpu;
 
-       for_each_channel_cpu(cpu, chan) {
+       for_each_channel_cpu(cpu, rb_chan) {
                int shm_fd, wait_fd, wakeup_fd;
                uint64_t memory_map_size;
 
-               buf = channel_get_ring_buffer(&client_config, chan,
-                               cpu, handle, &shm_fd, &wait_fd,
+               buf = channel_get_ring_buffer(&client_config, rb_chan,
+                               cpu, rb_chan->handle, &shm_fd, &wait_fd,
                                &wakeup_fd, &memory_map_size);
                lib_ring_buffer_switch(&client_config, buf,
-                               SWITCH_ACTIVE, handle);
+                               SWITCH_ACTIVE, rb_chan->handle);
        }
        return 0;
 }
This page took 0.031738 seconds and 4 git commands to generate.