/*
- * 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 <limits.h>
+#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"
+#include <urcu/tls-compat.h>
struct metadata_packet_header {
uint32_t magic; /* 0x75D11D57 */
static const struct lttng_ust_lib_ring_buffer_config client_config;
-static inline uint64_t lib_ring_buffer_clock_read(struct channel *chan)
+/* No nested use supported for metadata ring buffer. */
+static DEFINE_URCU_TLS(struct lttng_ust_lib_ring_buffer_ctx_private, private_ctx);
+
+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;
}
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 */
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,
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.
.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,
+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,
- 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_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__(struct lttng_channel),
- sizeof(struct lttng_channel),
+ __alignof__(struct lttng_ust_channel_buffer),
+ sizeof(struct lttng_ust_channel_buffer),
&chan_priv_init,
- buf_addr, subbuf_size, num_subbuf,
+ lttng_chan_buf, 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;
- lttng_chan->handle = handle;
- lttng_chan->chan = shmp(handle, handle->chan);
- return lttng_chan;
+ goto error;
+ lttng_chan_buf->priv->rb_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->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)
{
- return lib_ring_buffer_reserve(&client_config, ctx);
+ int ret;
+
+ memset(&URCU_TLS(private_ctx), 0, sizeof(struct lttng_ust_lib_ring_buffer_ctx_private));
+ URCU_TLS(private_ctx).pub = ctx;
+ URCU_TLS(private_ctx).chan = ctx->client_priv;
+ ctx->priv = &URCU_TLS(private_ctx);
+ ret = lib_ring_buffer_reserve(&client_config, ctx, NULL);
+ if (ret)
+ return ret;
+ if (lib_ring_buffer_backend_get_pages(&client_config, ctx,
+ &ctx->priv->backend_pages))
+ return -EPERM;
+ return 0;
}
static
}
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
-size_t lttng_packet_avail_size(struct channel *chan, struct lttng_ust_shm_handle *handle)
-
+size_t lttng_packet_avail_size(struct lttng_ust_channel_buffer *chan)
{
+ struct lttng_ust_lib_ring_buffer_channel *rb_chan = chan->priv->rb_chan;
unsigned long o_begin;
struct lttng_ust_lib_ring_buffer *buf;
- buf = shmp(handle, chan->backend.buf[0].shmp); /* Only for global buffer ! */
+ buf = shmp(rb_chan->handle, rb_chan->backend.buf[0].shmp); /* Only for global buffer ! */
o_begin = v_read(&client_config, &buf->offset);
- if (subbuf_offset(o_begin, chan) != 0) {
- return chan->backend.subbuf_size - subbuf_offset(o_begin, chan);
+ if (subbuf_offset(o_begin, rb_chan) != 0) {
+ return rb_chan->backend.subbuf_size - subbuf_offset(o_begin, rb_chan);
} else {
- return chan->backend.subbuf_size - subbuf_offset(o_begin, chan)
+ return rb_chan->backend.subbuf_size - subbuf_offset(o_begin, rb_chan)
- sizeof(struct metadata_packet_header);
}
}
-#if 0
static
-wait_queue_head_t *lttng_get_reader_wait_queue(struct 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 channel *chan)
-{
- return &chan->hp_wait;
+ return lib_ring_buffer_channel_is_finalized(rb_chan);
}
-#endif //0
static
-int lttng_is_finalized(struct 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 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 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 shm_fd, wait_fd, wakeup_fd;
uint64_t memory_map_size;
- buf = channel_get_ring_buffer(&client_config, chan,
- 0, handle, &shm_fd, &wait_fd, &wakeup_fd,
+ buf = channel_get_ring_buffer(&client_config, rb_chan,
+ 0, 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;
}
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_buffer_ops),
+
+ .priv = __LTTNG_COMPOUND_LITERAL(struct lttng_ust_channel_buffer_ops_private, {
+ .pub = <tng_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,
};