Introduce LTTNG_UST_ALLOW_BLOCKING env. var.
[lttng-ust.git] / liblttng-ust / lttng-ring-buffer-client.h
index 536a31a8db7591a8c78b291fbad7f3143485f355..52c759f78020da2ce00833fc4d50ddd746dbc40e 100644 (file)
 #define LTTNG_COMPACT_EVENT_BITS       5
 #define LTTNG_COMPACT_TSC_BITS         27
 
+enum app_ctx_mode {
+       APP_CTX_DISABLED,
+       APP_CTX_ENABLED,
+};
+
 /*
  * Keep the natural field alignment for _each field_ within this structure if
  * you ever add/remove a field from this header. Packed attribute is not used
@@ -53,6 +58,7 @@ struct packet_header {
                uint64_t timestamp_end;         /* Cycle count at subbuffer end */
                uint64_t content_size;          /* Size of data in subbuffer */
                uint64_t packet_size;           /* Subbuffer size (include padding) */
+               uint64_t packet_seq_num;        /* Packet sequence number */
                unsigned long events_discarded; /*
                                                 * Events lost in this subbuffer since
                                                 * the beginning of the trace.
@@ -70,7 +76,8 @@ static inline uint64_t lib_ring_buffer_clock_read(struct channel *chan)
 }
 
 static inline
-size_t ctx_get_size(size_t offset, struct lttng_ctx *ctx)
+size_t ctx_get_size(size_t offset, struct lttng_ctx *ctx,
+               enum app_ctx_mode mode)
 {
        int i;
        size_t orig_offset = offset;
@@ -78,23 +85,62 @@ size_t ctx_get_size(size_t offset, struct lttng_ctx *ctx)
        if (caa_likely(!ctx))
                return 0;
        offset += lib_ring_buffer_align(offset, ctx->largest_align);
-       for (i = 0; i < ctx->nr_fields; i++)
-               offset += ctx->fields[i].get_size(&ctx->fields[i], offset);
+       for (i = 0; i < ctx->nr_fields; i++) {
+               if (mode == APP_CTX_ENABLED) {
+                       offset += ctx->fields[i].get_size(&ctx->fields[i], offset);
+               } else {
+                       if (lttng_context_is_app(ctx->fields[i].event_field.name)) {
+                               /*
+                                * Before UST 2.8, we cannot use the
+                                * application context, because we
+                                * cannot trust that the handler used
+                                * for get_size is the same used for
+                                * ctx_record, which would result in
+                                * corrupted traces when tracing
+                                * concurrently with application context
+                                * register/unregister.
+                                */
+                               offset += lttng_ust_dummy_get_size(&ctx->fields[i], offset);
+                       } else {
+                               offset += ctx->fields[i].get_size(&ctx->fields[i], offset);
+                       }
+               }
+       }
        return offset - orig_offset;
 }
 
 static inline
 void ctx_record(struct lttng_ust_lib_ring_buffer_ctx *bufctx,
                struct lttng_channel *chan,
-               struct lttng_ctx *ctx)
+               struct lttng_ctx *ctx,
+               enum app_ctx_mode mode)
 {
        int i;
 
        if (caa_likely(!ctx))
                return;
        lib_ring_buffer_align_ctx(bufctx, ctx->largest_align);
-       for (i = 0; i < ctx->nr_fields; i++)
-               ctx->fields[i].record(&ctx->fields[i], bufctx, chan);
+       for (i = 0; i < ctx->nr_fields; i++) {
+               if (mode == APP_CTX_ENABLED) {
+                       ctx->fields[i].record(&ctx->fields[i], bufctx, chan);
+               } else {
+                       if (lttng_context_is_app(ctx->fields[i].event_field.name)) {
+                               /*
+                                * Before UST 2.8, we cannot use the
+                                * application context, because we
+                                * cannot trust that the handler used
+                                * for get_size is the same used for
+                                * ctx_record, which would result in
+                                * corrupted traces when tracing
+                                * concurrently with application context
+                                * register/unregister.
+                                */
+                               lttng_ust_dummy_record(&ctx->fields[i], bufctx, chan);
+                       } else {
+                               ctx->fields[i].record(&ctx->fields[i], bufctx, chan);
+                       }
+               }
+       }
 }
 
 /*
@@ -118,6 +164,7 @@ size_t record_header_size(const struct lttng_ust_lib_ring_buffer_config *config,
 {
        struct lttng_channel *lttng_chan = channel_get_private(chan);
        struct lttng_event *event = ctx->priv;
+       struct lttng_stack_ctx *lttng_ctx = ctx->priv2;
        size_t orig_offset = offset;
        size_t padding;
 
@@ -156,9 +203,15 @@ size_t record_header_size(const struct lttng_ust_lib_ring_buffer_config *config,
                padding = 0;
                WARN_ON_ONCE(1);
        }
-       offset += ctx_get_size(offset, event->ctx);
-       offset += ctx_get_size(offset, lttng_chan->ctx);
-
+       if (lttng_ctx) {
+               /* 2.8+ probe ABI. */
+               offset += ctx_get_size(offset, lttng_ctx->chan_ctx, APP_CTX_ENABLED);
+               offset += ctx_get_size(offset, lttng_ctx->event_ctx, APP_CTX_ENABLED);
+       } else {
+               /* Pre 2.8 probe ABI. */
+               offset += ctx_get_size(offset, lttng_chan->ctx, APP_CTX_DISABLED);
+               offset += ctx_get_size(offset, event->ctx, APP_CTX_DISABLED);
+       }
        *pre_header_padding = padding;
        return offset - orig_offset;
 }
@@ -186,6 +239,7 @@ void lttng_write_event_header(const struct lttng_ust_lib_ring_buffer_config *con
                            uint32_t event_id)
 {
        struct lttng_channel *lttng_chan = channel_get_private(ctx->chan);
+       struct lttng_event *event = ctx->priv;
        struct lttng_stack_ctx *lttng_ctx = ctx->priv2;
 
        if (caa_unlikely(ctx->rflags))
@@ -221,8 +275,15 @@ void lttng_write_event_header(const struct lttng_ust_lib_ring_buffer_config *con
                WARN_ON_ONCE(1);
        }
 
-       ctx_record(ctx, lttng_chan, lttng_ctx->chan_ctx);
-       ctx_record(ctx, lttng_chan, lttng_ctx->event_ctx);
+       if (lttng_ctx) {
+               /* 2.8+ probe ABI. */
+               ctx_record(ctx, lttng_chan, lttng_ctx->chan_ctx, APP_CTX_ENABLED);
+               ctx_record(ctx, lttng_chan, lttng_ctx->event_ctx, APP_CTX_ENABLED);
+       } else {
+               /* Pre 2.8 probe ABI. */
+               ctx_record(ctx, lttng_chan, lttng_chan->ctx, APP_CTX_DISABLED);
+               ctx_record(ctx, lttng_chan, event->ctx, APP_CTX_DISABLED);
+       }
        lib_ring_buffer_align_ctx(ctx, ctx->largest_align);
 
        return;
@@ -237,6 +298,7 @@ void lttng_write_event_header_slow(const struct lttng_ust_lib_ring_buffer_config
                                 uint32_t event_id)
 {
        struct lttng_channel *lttng_chan = channel_get_private(ctx->chan);
+       struct lttng_event *event = ctx->priv;
        struct lttng_stack_ctx *lttng_ctx = ctx->priv2;
 
        switch (lttng_chan->header_type) {
@@ -294,8 +356,15 @@ void lttng_write_event_header_slow(const struct lttng_ust_lib_ring_buffer_config
        default:
                WARN_ON_ONCE(1);
        }
-       ctx_record(ctx, lttng_chan, lttng_ctx->chan_ctx);
-       ctx_record(ctx, lttng_chan, lttng_ctx->event_ctx);
+       if (lttng_ctx) {
+               /* 2.8+ probe ABI. */
+               ctx_record(ctx, lttng_chan, lttng_ctx->chan_ctx, APP_CTX_ENABLED);
+               ctx_record(ctx, lttng_chan, lttng_ctx->event_ctx, APP_CTX_ENABLED);
+       } else {
+               /* Pre 2.8 probe ABI. */
+               ctx_record(ctx, lttng_chan, lttng_chan->ctx, APP_CTX_DISABLED);
+               ctx_record(ctx, lttng_chan, event->ctx, APP_CTX_DISABLED);
+       }
        lib_ring_buffer_align_ctx(ctx, ctx->largest_align);
 }
 
@@ -339,6 +408,7 @@ static void client_buffer_begin(struct lttng_ust_lib_ring_buffer *buf, uint64_t
                                subbuf_idx * chan->backend.subbuf_size,
                                handle);
        struct lttng_channel *lttng_chan = channel_get_private(chan);
+       uint64_t cnt = shmp_index(handle, buf->backend.buf_cnt, subbuf_idx)->seq_cnt;
 
        assert(header);
        if (!header)
@@ -351,6 +421,7 @@ static void client_buffer_begin(struct lttng_ust_lib_ring_buffer *buf, uint64_t
        header->ctx.timestamp_end = 0;
        header->ctx.content_size = ~0ULL; /* for debugging */
        header->ctx.packet_size = ~0ULL;
+       header->ctx.packet_seq_num = chan->backend.num_subbuf * cnt + subbuf_idx;
        header->ctx.events_discarded = 0;
        header->ctx.cpu_id = buf->backend.cpu;
 }
@@ -506,6 +577,28 @@ static int client_current_timestamp(struct lttng_ust_lib_ring_buffer *buf,
        return 0;
 }
 
+static int client_sequence_number(struct lttng_ust_lib_ring_buffer *buf,
+               struct lttng_ust_shm_handle *handle,
+               uint64_t *seq)
+{
+       struct packet_header *header;
+
+       header = client_packet_header(buf, handle);
+       *seq = header->ctx.packet_seq_num;
+       return 0;
+}
+
+static int client_instance_id(struct lttng_ust_lib_ring_buffer *buf,
+               struct lttng_ust_shm_handle *handle,
+               uint64_t *id)
+{
+       struct packet_header *header;
+
+       header = client_packet_header(buf, handle);
+       *id = header->stream_instance_id;
+       return 0;
+}
+
 static const
 struct lttng_ust_client_lib_ring_buffer_client_cb client_cb = {
        .parent = {
@@ -526,6 +619,8 @@ struct lttng_ust_client_lib_ring_buffer_client_cb client_cb = {
        .packet_size = client_packet_size,
        .stream_id = client_stream_id,
        .current_timestamp = client_current_timestamp,
+       .sequence_number = client_sequence_number,
+       .instance_id = client_instance_id,
 };
 
 static const struct lttng_ust_lib_ring_buffer_config client_config = {
@@ -563,7 +658,8 @@ struct lttng_channel *_channel_create(const char *name,
                                unsigned int read_timer_interval,
                                unsigned char *uuid,
                                uint32_t chan_id,
-                               const int *stream_fds, int nr_stream_fds)
+                               const int *stream_fds, int nr_stream_fds,
+                               int64_t blocking_timeout)
 {
        struct lttng_channel chan_priv_init;
        struct lttng_ust_shm_handle *handle;
@@ -579,7 +675,7 @@ struct lttng_channel *_channel_create(const char *name,
                        &chan_priv_init,
                        buf_addr, subbuf_size, num_subbuf,
                        switch_timer_interval, read_timer_interval,
-                       stream_fds, nr_stream_fds);
+                       stream_fds, nr_stream_fds, blocking_timeout);
        if (!handle)
                return NULL;
        lttng_chan = priv;
@@ -620,8 +716,16 @@ int lttng_event_reserve(struct lttng_ust_lib_ring_buffer_ctx *ctx,
        }
 
        ret = lib_ring_buffer_reserve(&client_config, ctx);
-       if (ret)
+       if (caa_unlikely(ret))
                goto put;
+       if (caa_likely(ctx->ctx_len
+                       >= sizeof(struct lttng_ust_lib_ring_buffer_ctx))) {
+               if (lib_ring_buffer_backend_get_pages(&client_config, ctx,
+                               &ctx->backend_pages)) {
+                       ret = -EPERM;
+                       goto put;
+               }
+       }
        lttng_write_event_header(&client_config, ctx, event_id);
        return 0;
 put:
This page took 0.025663 seconds and 4 git commands to generate.