X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=liblttng-ust%2Flttng-ring-buffer-client.h;h=4fbfc709a19d9e8f834384aef54c0cbe3bbad2bb;hb=e7bc0ef6c86ae97886cf5f8b28854cf281d4962b;hp=ab472352f96898625db0662b9399e5762088d897;hpb=db95cf8bf1be068238f12e248f13ed103d86d1e5;p=lttng-ust.git diff --git a/liblttng-ust/lttng-ring-buffer-client.h b/liblttng-ust/lttng-ring-buffer-client.h index ab472352..4fbfc709 100644 --- a/liblttng-ust/lttng-ring-buffer-client.h +++ b/liblttng-ust/lttng-ring-buffer-client.h @@ -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 * - * 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 #include -#include -#include "lttng/bitfield.h" + +#include +#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); } } } @@ -129,8 +119,8 @@ 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_channel_buffer *chan, + 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,18 +166,18 @@ 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_channel_buffer *lttng_chan = channel_get_private(chan); + struct lttng_ust_stack_ctx *lttng_ctx = ctx->priv; size_t orig_offset = offset; size_t padding; - switch (lttng_chan->header_type) { + switch (lttng_chan->priv->header_type) { case 1: /* compact */ padding = lib_ring_buffer_align(offset, lttng_alignof(uint32_t)); offset += 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; } @@ -261,14 +242,13 @@ void lttng_write_event_header(const struct lttng_ust_lib_ring_buffer_config *con 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_channel_buffer *lttng_chan = channel_get_private(ctx->chan); + struct lttng_ust_stack_ctx *lttng_ctx = ctx->priv; if (caa_unlikely(ctx->rflags)) goto slow_path; - switch (lttng_chan->header_type) { + switch (lttng_chan->priv->header_type) { case 1: /* compact */ { uint32_t id_time = 0; @@ -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; @@ -320,11 +293,10 @@ void lttng_write_event_header_slow(const struct lttng_ust_lib_ring_buffer_config 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_channel_buffer *lttng_chan = channel_get_private(ctx->chan); + struct lttng_ust_stack_ctx *lttng_ctx = ctx->priv; - switch (lttng_chan->header_type) { + switch (lttng_chan->priv->header_type) { case 1: /* compact */ if (!(ctx->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTTNG_RFLAG_EXTENDED))) { uint32_t id_time = 0; @@ -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,21 +391,21 @@ 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, 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); uint64_t cnt = shmp_index(handle, buf->backend.buf_cnt, subbuf_idx)->seq_cnt; assert(header); if (!header) return; header->magic = CTF_MAGIC_NUMBER; - memcpy(header->uuid, lttng_chan->uuid, sizeof(lttng_chan->uuid)); - header->stream_id = lttng_chan->id; + memcpy(header->uuid, lttng_chan->priv->uuid, sizeof(lttng_chan->priv->uuid)); + header->stream_id = lttng_chan->priv->id; header->stream_instance_id = buf->backend.cpu; header->ctx.timestamp_begin = tsc; header->ctx.timestamp_end = 0; @@ -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,10 +546,11 @@ static int client_stream_id(struct lttng_ust_lib_ring_buffer *buf, struct lttng_ust_shm_handle *handle, uint64_t *stream_id) { - struct channel *chan = shmp(handle, buf->backend.chan); - struct lttng_channel *lttng_chan = channel_get_private(chan); + 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->id; + *stream_id = lttng_chan->priv->id; return 0; } @@ -592,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); @@ -607,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; } @@ -669,10 +638,8 @@ 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, +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, @@ -682,67 +649,66 @@ struct lttng_channel *_channel_create(const char *name, 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_abi_channel_config), + sizeof(struct lttng_ust_abi_channel_config), &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, 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) { - 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_channel_buffer *lttng_chan = channel_get_private(ctx->chan); + 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) return -EPERM; ctx->cpu = cpu; - switch (lttng_chan->header_type) { + switch (lttng_chan->priv->header_type) { case 1: /* compact */ if (event_id > 30) ctx->rflags |= LTTNG_RFLAG_EXTENDED; @@ -758,13 +724,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; @@ -796,32 +759,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; @@ -842,18 +806,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 = <tng_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,