Cleanup: remove old comments
[lttng-ust.git] / liblttng-ust / lttng-ring-buffer-metadata-client.h
index 7dbdb821095c2554d26ad839a30f4d0fdbbcb52c..8a5943972bbcc0e911047ae14fa740e2dae35262 100644 (file)
@@ -1,28 +1,17 @@
 /*
- * 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 "lttng-tracer.h"
 #include "../libringbuffer/frontend_types.h"
 
@@ -46,32 +35,37 @@ struct metadata_record_header {
 
 static const struct lttng_ust_lib_ring_buffer_config client_config;
 
-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 0;
 }
 
 static inline
-unsigned char record_header_size(const struct lttng_ust_lib_ring_buffer_config *config,
-                                struct channel *chan, size_t offset,
+size_t record_header_size(const struct lttng_ust_lib_ring_buffer_config *config,
+                                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_ust_lib_ring_buffer_ctx *ctx,
+                                void *client_ctx)
 {
        return 0;
 }
 
 #include "../libringbuffer/api.h"
+#include "lttng-rb-clients.h"
 
-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 0;
 }
 
 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)
+                                struct lttng_ust_lib_ring_buffer_ctx *ctx,
+                                void *client_ctx)
 {
        return 0;
 }
@@ -92,16 +86,19 @@ 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 metadata_packet_header *header =
                (struct metadata_packet_header *)
                        lib_ring_buffer_offset_address(&buf->backend,
                                subbuf_idx * chan->backend.subbuf_size,
                                handle);
-       struct lttng_channel *lttng_chan = channel_get_private(chan);
+       struct lttng_ust_channel_buffer *lttng_chan = channel_get_private(chan);
 
+       assert(header);
+       if (!header)
+               return;
        header->magic = TSDL_MAGIC_NUMBER;
-       memcpy(header->uuid, lttng_chan->uuid, sizeof(lttng_chan->uuid));
+       memcpy(header->uuid, lttng_chan->priv->uuid, sizeof(lttng_chan->priv->uuid));
        header->checksum = 0;           /* 0 if unused */
        header->content_size = 0xFFFFFFFF; /* in bits, for debugging */
        header->packet_size = 0xFFFFFFFF;  /* in bits, for debugging */
@@ -120,7 +117,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 metadata_packet_header *header =
                (struct metadata_packet_header *)
                        lib_ring_buffer_offset_address(&buf->backend,
@@ -128,8 +125,11 @@ static void client_buffer_end(struct lttng_ust_lib_ring_buffer *buf, uint64_t ts
                                handle);
        unsigned long records_lost = 0;
 
+       assert(header);
+       if (!header)
+               return;
        header->content_size = data_size * CHAR_BIT;            /* in bits */
-       header->packet_size = PAGE_ALIGN(data_size) * CHAR_BIT; /* in bits */
+       header->packet_size = LTTNG_UST_PAGE_ALIGN(data_size) * CHAR_BIT; /* in bits */
        /*
         * We do not care about the records lost count, because the metadata
         * channel waits and retry.
@@ -153,6 +153,19 @@ static void client_buffer_finalize(struct lttng_ust_lib_ring_buffer *buf,
 {
 }
 
+static const
+struct lttng_ust_client_lib_ring_buffer_client_cb client_cb = {
+       .parent = {
+               .ring_buffer_clock_read = client_ring_buffer_clock_read,
+               .record_header_size = client_record_header_size,
+               .subbuffer_header_size = client_packet_header_size,
+               .buffer_begin = client_buffer_begin,
+               .buffer_end = client_buffer_end,
+               .buffer_create = client_buffer_create,
+               .buffer_finalize = client_buffer_finalize,
+       },
+};
+
 static const struct lttng_ust_lib_ring_buffer_config client_config = {
        .cb.ring_buffer_clock_read = client_ring_buffer_clock_read,
        .cb.record_header_size = client_record_header_size,
@@ -172,50 +185,72 @@ static const struct lttng_ust_lib_ring_buffer_config client_config = {
        .ipi = RING_BUFFER_NO_IPI_BARRIER,
        .wakeup = RING_BUFFER_WAKEUP_BY_WRITER,
        .client_type = LTTNG_CLIENT_TYPE,
-};
 
-const struct lttng_ust_lib_ring_buffer_client_cb *LTTNG_CLIENT_CALLBACKS = &client_config.cb;
+        .cb_ptr = &client_cb.parent,
+};
 
 static
-struct lttng_channel *_channel_create(const char *name,
+struct lttng_ust_channel_buffer *_channel_create(const char *name,
                                void *buf_addr,
                                size_t subbuf_size, size_t num_subbuf,
                                unsigned int switch_timer_interval,
                                unsigned int read_timer_interval,
                                unsigned char *uuid,
-                               uint32_t chan_id)
+                               uint32_t chan_id,
+                               const int *stream_fds, int nr_stream_fds,
+                               int64_t blocking_timeout)
 {
-       struct lttng_channel chan_priv_init;
+       struct lttng_ust_abi_channel_config chan_priv_init;
        struct lttng_ust_shm_handle *handle;
-       struct lttng_channel *lttng_chan;
-       void *priv;
+       struct lttng_ust_channel_buffer *lttng_chan_buf;
+
+       lttng_chan_buf = lttng_ust_alloc_channel_buffer();
+       if (!lttng_chan_buf)
+               return NULL;
+       memcpy(lttng_chan_buf->priv->uuid, uuid, LTTNG_UST_UUID_LEN);
+       lttng_chan_buf->priv->id = chan_id;
 
        memset(&chan_priv_init, 0, sizeof(chan_priv_init));
        memcpy(chan_priv_init.uuid, uuid, LTTNG_UST_UUID_LEN);
        chan_priv_init.id = chan_id;
+
        handle = channel_create(&client_config, name,
-                       &priv, __alignof__(*lttng_chan), sizeof(*lttng_chan),
+                       __alignof__(struct lttng_ust_channel_buffer),
+                       sizeof(struct lttng_ust_channel_buffer),
                        &chan_priv_init,
-                       buf_addr, subbuf_size, num_subbuf,
-                       switch_timer_interval, read_timer_interval);
+                       lttng_chan_buf, buf_addr, subbuf_size, num_subbuf,
+                       switch_timer_interval, read_timer_interval,
+                       stream_fds, nr_stream_fds, blocking_timeout);
        if (!handle)
-               return NULL;
-       lttng_chan = priv;
-       lttng_chan->handle = handle;
-       lttng_chan->chan = shmp(handle, handle->chan);
-       return lttng_chan;
+               goto error;
+       lttng_chan_buf->handle = handle;
+       lttng_chan_buf->chan = shmp(handle, handle->chan);
+       return lttng_chan_buf;
+
+error:
+       lttng_ust_free_channel_common(lttng_chan_buf->parent);
+       return NULL;
 }
 
 static
-void lttng_channel_destroy(struct lttng_channel *chan)
+void lttng_channel_destroy(struct lttng_ust_channel_buffer *lttng_chan_buf)
 {
-       channel_destroy(chan->chan, chan->handle, 1);
+       channel_destroy(lttng_chan_buf->chan, lttng_chan_buf->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)
 {
-       return lib_ring_buffer_reserve(&client_config, ctx);
+       int ret;
+
+       ret = lib_ring_buffer_reserve(&client_config, ctx, NULL);
+       if (ret)
+               return ret;
+       if (lib_ring_buffer_backend_get_pages(&client_config, ctx,
+                       &ctx->backend_pages))
+               return -EPERM;
+       return 0;
 }
 
 static
@@ -232,8 +267,8 @@ void lttng_event_write(struct lttng_ust_lib_ring_buffer_ctx *ctx, const void *sr
 }
 
 static
-size_t lttng_packet_avail_size(struct channel *chan, struct lttng_ust_shm_handle *handle)
-                            
+size_t lttng_packet_avail_size(struct lttng_ust_lib_ring_buffer_channel *chan,
+               struct lttng_ust_shm_handle *handle)
 {
        unsigned long o_begin;
        struct lttng_ust_lib_ring_buffer *buf;
@@ -250,32 +285,33 @@ size_t lttng_packet_avail_size(struct channel *chan, struct lttng_ust_shm_handle
 
 #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 shm_fd, wait_fd, wakeup_fd;
@@ -292,17 +328,20 @@ 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,
+               .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 = lttng_packet_avail_size,
+                       .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 = lttng_packet_avail_size,
-               //.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,
        },
        .client_config = &client_config,
 };
This page took 0.026712 seconds and 4 git commands to generate.