X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=liblttng-ust%2Flttng-ring-buffer-client.h;h=188efb0fe12960880b0c1ae5d5cdcb8455a4b944;hb=0466ac28c41336fd6d373cc8b0b26ef132225b9f;hp=d219b79c91dfb0ea45658865a97b0dded461ac20;hpb=53569322d40ed45abe0368ddb08eb4a2738afc37;p=lttng-ust.git diff --git a/liblttng-ust/lttng-ring-buffer-client.h b/liblttng-ust/lttng-ring-buffer-client.h index d219b79c..188efb0f 100644 --- a/liblttng-ust/lttng-ring-buffer-client.h +++ b/liblttng-ust/lttng-ring-buffer-client.h @@ -1,35 +1,30 @@ /* - * 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" #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 @@ -45,6 +40,7 @@ struct packet_header { */ uint8_t uuid[LTTNG_UST_UUID_LEN]; uint32_t stream_id; + uint64_t stream_instance_id; struct { /* Stream packet context */ @@ -52,6 +48,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. @@ -62,38 +59,96 @@ struct packet_header { } ctx; }; +struct lttng_client_ctx { + size_t packet_context_len; + 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_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) { - int i; size_t orig_offset = offset; 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); + offset += ctx_len; return offset - orig_offset; } +static inline +void ctx_get_struct_size(struct lttng_ust_ctx *ctx, size_t *ctx_len, + enum app_ctx_mode mode) +{ + int i; + size_t offset = 0; + + if (caa_likely(!ctx)) { + *ctx_len = 0; + return; + } + 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); + } + } + } + *ctx_len = offset; +} + 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; 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); + } + } + } } /* @@ -111,12 +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_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_ust_stack_ctx *lttng_ctx = ctx->priv; size_t orig_offset = offset; size_t padding; @@ -155,9 +212,10 @@ 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); - + 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; } @@ -185,7 +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_stack_ctx *lttng_ctx = ctx->priv2; + struct lttng_ust_stack_ctx *lttng_ctx = ctx->priv; if (caa_unlikely(ctx->rflags)) goto slow_path; @@ -220,8 +278,8 @@ 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); + 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; @@ -236,7 +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_stack_ctx *lttng_ctx = ctx->priv2; + struct lttng_ust_stack_ctx *lttng_ctx = ctx->priv; switch (lttng_chan->header_type) { case 1: /* compact */ @@ -293,26 +351,28 @@ 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); + 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) + struct lttng_ust_lib_ring_buffer_ctx *ctx, + void *client_ctx) { return record_header_size(config, chan, offset, - pre_header_padding, ctx); + pre_header_padding, ctx, client_ctx); } /** @@ -331,13 +391,14 @@ 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); + uint64_t cnt = shmp_index(handle, buf->backend.buf_cnt, subbuf_idx)->seq_cnt; assert(header); if (!header) @@ -345,10 +406,12 @@ static void client_buffer_begin(struct lttng_ust_lib_ring_buffer *buf, uint64_t header->magic = CTF_MAGIC_NUMBER; memcpy(header->uuid, lttng_chan->uuid, sizeof(lttng_chan->uuid)); header->stream_id = lttng_chan->id; + header->stream_instance_id = buf->backend.cpu; header->ctx.timestamp_begin = tsc; 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; } @@ -361,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, @@ -376,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); @@ -483,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; } @@ -496,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); @@ -504,6 +567,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); + if (!header) + return -1; + *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) +{ + *id = buf->backend.cpu; + + return 0; +} + static const struct lttng_ust_client_lib_ring_buffer_client_cb client_cb = { .parent = { @@ -524,6 +609,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 = { @@ -551,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, @@ -561,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; @@ -577,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; @@ -597,8 +683,16 @@ 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_ust_stack_ctx *lttng_ctx = ctx->priv; + struct lttng_client_ctx client_ctx; int ret, cpu; + /* Compute internal size of context structures. */ + 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; @@ -617,9 +711,14 @@ int lttng_event_reserve(struct lttng_ust_lib_ring_buffer_ctx *ctx, WARN_ON_ONCE(1); } - ret = lib_ring_buffer_reserve(&client_config, ctx); - if (ret) + ret = lib_ring_buffer_reserve(&client_config, ctx, &client_ctx); + if (caa_unlikely(ret)) 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; put: @@ -650,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; @@ -696,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 = <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,