Refactoring: Privatize ring buffer config header
[lttng-ust.git] / liblttng-ust / lttng-ring-buffer-client.h
index 2f67799e19feb676cb0da2b9eef26e5f74a2c0a3..188efb0fe12960880b0c1ae5d5cdcb8455a4b944 100644 (file)
@@ -1,29 +1,19 @@
 /*
- * lttng-ring-buffer-client.h
- *
- * LTTng lib ring buffer client template.
+ * SPDX-License-Identifier: LGPL-2.1-only
  *
  * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; only
- * version 2.1 of the License.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ * LTTng lib ring buffer client template.
  */
 
+#include <stddef.h>
 #include <stdint.h>
-#include <lttng/ust-events.h>
-#include "lttng/bitfield.h"
+
+#include <ust-events-internal.h>
+#include "ust-bitfield.h"
+#include "ust-compat.h"
 #include "clock.h"
+#include "context-internal.h"
 #include "lttng-tracer.h"
 #include "../libringbuffer/frontend_types.h"
 
@@ -74,13 +64,13 @@ struct lttng_client_ctx {
        size_t event_context_len;
 };
 
-static inline uint64_t lib_ring_buffer_clock_read(struct channel *chan)
+static inline uint64_t lib_ring_buffer_clock_read(struct lttng_ust_lib_ring_buffer_channel *chan)
 {
        return trace_clock_read64();
 }
 
 static inline
-size_t ctx_get_aligned_size(size_t offset, struct lttng_ctx *ctx,
+size_t ctx_get_aligned_size(size_t offset, struct lttng_ust_ctx *ctx,
                size_t ctx_len)
 {
        size_t orig_offset = offset;
@@ -93,7 +83,7 @@ size_t ctx_get_aligned_size(size_t offset, struct lttng_ctx *ctx,
 }
 
 static inline
-void ctx_get_struct_size(struct lttng_ctx *ctx, size_t *ctx_len,
+void ctx_get_struct_size(struct lttng_ust_ctx *ctx, size_t *ctx_len,
                enum app_ctx_mode mode)
 {
        int i;
@@ -105,9 +95,9 @@ void ctx_get_struct_size(struct lttng_ctx *ctx, size_t *ctx_len,
        }
        for (i = 0; i < ctx->nr_fields; i++) {
                if (mode == APP_CTX_ENABLED) {
-                       offset += ctx->fields[i].get_size(&ctx->fields[i], offset);
+                       offset += ctx->fields[i]->get_size(ctx->fields[i], offset);
                } else {
-                       if (lttng_context_is_app(ctx->fields[i].event_field.name)) {
+                       if (lttng_context_is_app(ctx->fields[i]->event_field->name)) {
                                /*
                                 * Before UST 2.8, we cannot use the
                                 * application context, because we
@@ -118,9 +108,9 @@ void ctx_get_struct_size(struct lttng_ctx *ctx, size_t *ctx_len,
                                 * concurrently with application context
                                 * register/unregister.
                                 */
-                               offset += lttng_ust_dummy_get_size(&ctx->fields[i], offset);
+                               offset += lttng_ust_dummy_get_size(ctx->fields[i], offset);
                        } else {
-                               offset += ctx->fields[i].get_size(&ctx->fields[i], offset);
+                               offset += ctx->fields[i]->get_size(ctx->fields[i], offset);
                        }
                }
        }
@@ -130,7 +120,7 @@ void ctx_get_struct_size(struct lttng_ctx *ctx, size_t *ctx_len,
 static inline
 void ctx_record(struct lttng_ust_lib_ring_buffer_ctx *bufctx,
                struct lttng_channel *chan,
-               struct lttng_ctx *ctx,
+               struct lttng_ust_ctx *ctx,
                enum app_ctx_mode mode)
 {
        int i;
@@ -140,9 +130,9 @@ void ctx_record(struct lttng_ust_lib_ring_buffer_ctx *bufctx,
        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);
+                       ctx->fields[i]->record(ctx->fields[i], bufctx, chan);
                } else {
-                       if (lttng_context_is_app(ctx->fields[i].event_field.name)) {
+                       if (lttng_context_is_app(ctx->fields[i]->event_field->name)) {
                                /*
                                 * Before UST 2.8, we cannot use the
                                 * application context, because we
@@ -153,9 +143,9 @@ void ctx_record(struct lttng_ust_lib_ring_buffer_ctx *bufctx,
                                 * concurrently with application context
                                 * register/unregister.
                                 */
-                               lttng_ust_dummy_record(&ctx->fields[i], bufctx, chan);
+                               lttng_ust_dummy_record(ctx->fields[i], bufctx, chan);
                        } else {
-                               ctx->fields[i].record(&ctx->fields[i], bufctx, chan);
+                               ctx->fields[i]->record(ctx->fields[i], bufctx, chan);
                        }
                }
        }
@@ -176,14 +166,14 @@ void ctx_record(struct lttng_ust_lib_ring_buffer_ctx *bufctx,
  */
 static __inline__
 size_t record_header_size(const struct lttng_ust_lib_ring_buffer_config *config,
-                                struct channel *chan, size_t offset,
+                                struct lttng_ust_lib_ring_buffer_channel *chan,
+                                size_t offset,
                                 size_t *pre_header_padding,
                                 struct lttng_ust_lib_ring_buffer_ctx *ctx,
                                 struct lttng_client_ctx *client_ctx)
 {
        struct lttng_channel *lttng_chan = channel_get_private(chan);
-       struct lttng_event *event = ctx->priv;
-       struct lttng_stack_ctx *lttng_ctx = ctx->priv2;
+       struct lttng_ust_stack_ctx *lttng_ctx = ctx->priv;
        size_t orig_offset = offset;
        size_t padding;
 
@@ -222,19 +212,10 @@ size_t record_header_size(const struct lttng_ust_lib_ring_buffer_config *config,
                padding = 0;
                WARN_ON_ONCE(1);
        }
-       if (lttng_ctx) {
-               /* 2.8+ probe ABI. */
-               offset += ctx_get_aligned_size(offset, lttng_ctx->chan_ctx,
-                               client_ctx->packet_context_len);
-               offset += ctx_get_aligned_size(offset, lttng_ctx->event_ctx,
-                               client_ctx->event_context_len);
-       } else {
-               /* Pre 2.8 probe ABI. */
-               offset += ctx_get_aligned_size(offset, lttng_chan->ctx,
-                               client_ctx->packet_context_len);
-               offset += ctx_get_aligned_size(offset, event->ctx,
-                               client_ctx->event_context_len);
-       }
+       offset += ctx_get_aligned_size(offset, lttng_ctx->chan_ctx,
+                       client_ctx->packet_context_len);
+       offset += ctx_get_aligned_size(offset, lttng_ctx->event_ctx,
+                       client_ctx->event_context_len);
        *pre_header_padding = padding;
        return offset - orig_offset;
 }
@@ -262,8 +243,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;
+       struct lttng_ust_stack_ctx *lttng_ctx = ctx->priv;
 
        if (caa_unlikely(ctx->rflags))
                goto slow_path;
@@ -298,15 +278,8 @@ void lttng_write_event_header(const struct lttng_ust_lib_ring_buffer_config *con
                WARN_ON_ONCE(1);
        }
 
-       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);
-       }
+       ctx_record(ctx, lttng_chan, lttng_ctx->chan_ctx, APP_CTX_ENABLED);
+       ctx_record(ctx, lttng_chan, lttng_ctx->event_ctx, APP_CTX_ENABLED);
        lib_ring_buffer_align_ctx(ctx, ctx->largest_align);
 
        return;
@@ -321,8 +294,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;
+       struct lttng_ust_stack_ctx *lttng_ctx = ctx->priv;
 
        switch (lttng_chan->header_type) {
        case 1: /* compact */
@@ -379,28 +351,22 @@ void lttng_write_event_header_slow(const struct lttng_ust_lib_ring_buffer_config
        default:
                WARN_ON_ONCE(1);
        }
-       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);
-       }
+       ctx_record(ctx, lttng_chan, lttng_ctx->chan_ctx, APP_CTX_ENABLED);
+       ctx_record(ctx, lttng_chan, lttng_ctx->event_ctx, APP_CTX_ENABLED);
        lib_ring_buffer_align_ctx(ctx, ctx->largest_align);
 }
 
 static const struct lttng_ust_lib_ring_buffer_config client_config;
 
-static uint64_t client_ring_buffer_clock_read(struct channel *chan)
+static uint64_t client_ring_buffer_clock_read(struct lttng_ust_lib_ring_buffer_channel *chan)
 {
        return lib_ring_buffer_clock_read(chan);
 }
 
 static
 size_t client_record_header_size(const struct lttng_ust_lib_ring_buffer_config *config,
-                                struct channel *chan, size_t offset,
+                                struct lttng_ust_lib_ring_buffer_channel *chan,
+                                size_t offset,
                                 size_t *pre_header_padding,
                                 struct lttng_ust_lib_ring_buffer_ctx *ctx,
                                 void *client_ctx)
@@ -425,7 +391,7 @@ static void client_buffer_begin(struct lttng_ust_lib_ring_buffer *buf, uint64_t
                                unsigned int subbuf_idx,
                                struct lttng_ust_shm_handle *handle)
 {
-       struct channel *chan = shmp(handle, buf->backend.chan);
+       struct lttng_ust_lib_ring_buffer_channel *chan = shmp(handle, buf->backend.chan);
        struct packet_header *header =
                (struct packet_header *)
                        lib_ring_buffer_offset_address(&buf->backend,
@@ -458,7 +424,7 @@ static void client_buffer_end(struct lttng_ust_lib_ring_buffer *buf, uint64_t ts
                              unsigned int subbuf_idx, unsigned long data_size,
                              struct lttng_ust_shm_handle *handle)
 {
-       struct channel *chan = shmp(handle, buf->backend.chan);
+       struct lttng_ust_lib_ring_buffer_channel *chan = shmp(handle, buf->backend.chan);
        struct packet_header *header =
                (struct packet_header *)
                        lib_ring_buffer_offset_address(&buf->backend,
@@ -473,7 +439,7 @@ static void client_buffer_end(struct lttng_ust_lib_ring_buffer *buf, uint64_t ts
        header->ctx.content_size =
                (uint64_t) data_size * CHAR_BIT;                /* in bits */
        header->ctx.packet_size =
-               (uint64_t) PAGE_ALIGN(data_size) * CHAR_BIT;    /* in bits */
+               (uint64_t) LTTNG_UST_PAGE_ALIGN(data_size) * CHAR_BIT;  /* in bits */
 
        records_lost += lib_ring_buffer_get_records_lost_full(&client_config, buf);
        records_lost += lib_ring_buffer_get_records_lost_wrap(&client_config, buf);
@@ -580,12 +546,12 @@ static int client_stream_id(struct lttng_ust_lib_ring_buffer *buf,
                struct lttng_ust_shm_handle *handle,
                uint64_t *stream_id)
 {
-       struct packet_header *header;
+       struct lttng_ust_lib_ring_buffer_channel *chan = shmp(handle,
+                       buf->backend.chan);
+       struct lttng_channel *lttng_chan = channel_get_private(chan);
+
+       *stream_id = lttng_chan->id;
 
-       header = client_packet_header(buf, handle);
-       if (!header)
-               return -1;
-       *stream_id = header->stream_id;
        return 0;
 }
 
@@ -593,7 +559,7 @@ static int client_current_timestamp(struct lttng_ust_lib_ring_buffer *buf,
                struct lttng_ust_shm_handle *handle,
                uint64_t *ts)
 {
-       struct channel *chan;
+       struct lttng_ust_lib_ring_buffer_channel *chan;
 
        chan = shmp(handle, handle->chan);
        *ts = client_ring_buffer_clock_read(chan);
@@ -608,6 +574,8 @@ static int client_sequence_number(struct lttng_ust_lib_ring_buffer *buf,
        struct packet_header *header;
 
        header = client_packet_header(buf, handle);
+       if (!header)
+               return -1;
        *seq = header->ctx.packet_seq_num;
        return 0;
 }
@@ -616,10 +584,8 @@ 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;
+       *id = buf->backend.cpu;
 
-       header = client_packet_header(buf, handle);
-       *id = header->stream_instance_id;
        return 0;
 }
 
@@ -672,8 +638,6 @@ static const struct lttng_ust_lib_ring_buffer_config client_config = {
        .cb_ptr = &client_cb.parent,
 };
 
-const struct lttng_ust_client_lib_ring_buffer_client_cb *LTTNG_CLIENT_CALLBACKS = &client_cb;
-
 static
 struct lttng_channel *_channel_create(const char *name,
                                void *buf_addr,
@@ -682,7 +646,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;
@@ -698,7 +663,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;
@@ -718,26 +683,15 @@ int lttng_event_reserve(struct lttng_ust_lib_ring_buffer_ctx *ctx,
                      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;
+       struct lttng_ust_stack_ctx *lttng_ctx = ctx->priv;
        struct lttng_client_ctx client_ctx;
        int ret, cpu;
 
        /* Compute internal size of context structures. */
-
-       if (lttng_ctx) {
-               /* 2.8+ probe ABI. */
-               ctx_get_struct_size(lttng_ctx->chan_ctx, &client_ctx.packet_context_len,
-                               APP_CTX_ENABLED);
-               ctx_get_struct_size(lttng_ctx->event_ctx, &client_ctx.event_context_len,
-                               APP_CTX_ENABLED);
-       } else {
-               /* Pre 2.8 probe ABI. */
-               ctx_get_struct_size(lttng_chan->ctx, &client_ctx.packet_context_len,
-                               APP_CTX_DISABLED);
-               ctx_get_struct_size(event->ctx, &client_ctx.event_context_len,
-                               APP_CTX_DISABLED);
-       }
+       ctx_get_struct_size(lttng_ctx->chan_ctx, &client_ctx.packet_context_len,
+                       APP_CTX_ENABLED);
+       ctx_get_struct_size(lttng_ctx->event_ctx, &client_ctx.event_context_len,
+                       APP_CTX_ENABLED);
 
        cpu = lib_ring_buffer_get_cpu(&client_config);
        if (cpu < 0)
@@ -760,13 +714,10 @@ int lttng_event_reserve(struct lttng_ust_lib_ring_buffer_ctx *ctx,
        ret = lib_ring_buffer_reserve(&client_config, ctx, &client_ctx);
        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;
-               }
+       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;
@@ -798,32 +749,33 @@ void lttng_event_strcpy(struct lttng_ust_lib_ring_buffer_ctx *ctx, const char *s
 
 #if 0
 static
-wait_queue_head_t *lttng_get_reader_wait_queue(struct channel *chan)
+wait_queue_head_t *lttng_get_reader_wait_queue(struct lttng_ust_lib_ring_buffer_channel *chan)
 {
        return &chan->read_wait;
 }
 
 static
-wait_queue_head_t *lttng_get_hp_wait_queue(struct channel *chan)
+wait_queue_head_t *lttng_get_hp_wait_queue(struct lttng_ust_lib_ring_buffer_channel *chan)
 {
        return &chan->hp_wait;
 }
 #endif //0
 
 static
-int lttng_is_finalized(struct channel *chan)
+int lttng_is_finalized(struct lttng_ust_lib_ring_buffer_channel *chan)
 {
        return lib_ring_buffer_channel_is_finalized(chan);
 }
 
 static
-int lttng_is_disabled(struct channel *chan)
+int lttng_is_disabled(struct lttng_ust_lib_ring_buffer_channel *chan)
 {
        return lib_ring_buffer_channel_is_disabled(chan);
 }
 
 static
-int lttng_flush_buffer(struct channel *chan, struct lttng_ust_shm_handle *handle)
+int lttng_flush_buffer(struct lttng_ust_lib_ring_buffer_channel *chan,
+               struct lttng_ust_shm_handle *handle)
 {
        struct lttng_ust_lib_ring_buffer *buf;
        int cpu;
@@ -844,18 +796,19 @@ int lttng_flush_buffer(struct channel *chan, struct lttng_ust_shm_handle *handle
 static struct lttng_transport lttng_relay_transport = {
        .name = "relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap",
        .ops = {
-               .channel_create = _channel_create,
-               .channel_destroy = lttng_channel_destroy,
-               .u.has_strcpy = 1,
+               .struct_size = sizeof(struct lttng_ust_channel_ops),
+               .priv = __LTTNG_COMPOUND_LITERAL(struct lttng_ust_channel_ops_private, {
+                       .pub = &lttng_relay_transport.ops,
+                       .channel_create = _channel_create,
+                       .channel_destroy = lttng_channel_destroy,
+                       .packet_avail_size = NULL,      /* Would be racy anyway */
+                       .is_finalized = lttng_is_finalized,
+                       .is_disabled = lttng_is_disabled,
+                       .flush_buffer = lttng_flush_buffer,
+               }),
                .event_reserve = lttng_event_reserve,
                .event_commit = lttng_event_commit,
                .event_write = lttng_event_write,
-               .packet_avail_size = NULL,      /* Would be racy anyway */
-               //.get_reader_wait_queue = lttng_get_reader_wait_queue,
-               //.get_hp_wait_queue = lttng_get_hp_wait_queue,
-               .is_finalized = lttng_is_finalized,
-               .is_disabled = lttng_is_disabled,
-               .flush_buffer = lttng_flush_buffer,
                .event_strcpy = lttng_event_strcpy,
        },
        .client_config = &client_config,
This page took 0.029505 seconds and 4 git commands to generate.