X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=liblttng-ust%2Flttng-ring-buffer-client.h;h=c5867dc1b697f2434a5bf17e74a98de85878661c;hb=a3492932cffa2c9dfbc9416792b20ce763708fc1;hp=ad77802f964063eced5c6ba7097db2077913c98f;hpb=7dd08bec735b428479201f9f84d59c78deabdf57;p=lttng-ust.git diff --git a/liblttng-ust/lttng-ring-buffer-client.h b/liblttng-ust/lttng-ring-buffer-client.h index ad77802f..c5867dc1 100644 --- a/liblttng-ust/lttng-ring-buffer-client.h +++ b/liblttng-ust/lttng-ring-buffer-client.h @@ -24,13 +24,17 @@ #include #include "lttng/bitfield.h" #include "clock.h" -#include "lttng-ust-uuid.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 @@ -46,6 +50,7 @@ struct packet_header { */ uint8_t uuid[LTTNG_UST_UUID_LEN]; uint32_t stream_id; + uint64_t stream_instance_id; struct { /* Stream packet context */ @@ -53,6 +58,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. @@ -70,29 +76,71 @@ static inline uint64_t lib_ring_buffer_clock_read(struct channel *chan) } static inline -size_t ctx_get_size(size_t offset, struct lttng_ctx *ctx) +size_t ctx_get_size(size_t offset, struct lttng_ctx *ctx, + enum app_ctx_mode mode) { int i; size_t orig_offset = offset; if (caa_likely(!ctx)) return 0; - for (i = 0; i < ctx->nr_fields; i++) - offset += ctx->fields[i].get_size(offset); + offset += lib_ring_buffer_align(offset, ctx->largest_align); + 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); + } + } + } return offset - orig_offset; } static inline void ctx_record(struct lttng_ust_lib_ring_buffer_ctx *bufctx, struct lttng_channel *chan, - struct lttng_ctx *ctx) + struct lttng_ctx *ctx, + enum app_ctx_mode mode) { int i; if (caa_likely(!ctx)) return; - for (i = 0; i < ctx->nr_fields; i++) - ctx->fields[i].record(&ctx->fields[i], bufctx, chan); + 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); + } 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); + } + } + } } /* @@ -109,13 +157,14 @@ void ctx_record(struct lttng_ust_lib_ring_buffer_ctx *bufctx, * contains. */ static __inline__ -unsigned char record_header_size(const struct lttng_ust_lib_ring_buffer_config *config, +size_t record_header_size(const struct lttng_ust_lib_ring_buffer_config *config, struct channel *chan, size_t offset, size_t *pre_header_padding, struct lttng_ust_lib_ring_buffer_ctx *ctx) { struct lttng_channel *lttng_chan = channel_get_private(chan); struct lttng_event *event = ctx->priv; + struct lttng_stack_ctx *lttng_ctx = ctx->priv2; size_t orig_offset = offset; size_t padding; @@ -154,14 +203,21 @@ unsigned char record_header_size(const struct lttng_ust_lib_ring_buffer_config * padding = 0; WARN_ON_ONCE(1); } - offset += ctx_get_size(offset, event->ctx); - offset += ctx_get_size(offset, lttng_chan->ctx); - + if (lttng_ctx) { + /* 2.8+ probe ABI. */ + offset += ctx_get_size(offset, lttng_ctx->chan_ctx, APP_CTX_ENABLED); + offset += ctx_get_size(offset, lttng_ctx->event_ctx, APP_CTX_ENABLED); + } else { + /* Pre 2.8 probe ABI. */ + offset += ctx_get_size(offset, lttng_chan->ctx, APP_CTX_DISABLED); + offset += ctx_get_size(offset, event->ctx, APP_CTX_DISABLED); + } *pre_header_padding = padding; return offset - orig_offset; } #include "../libringbuffer/api.h" +#include "lttng-rb-clients.h" static void lttng_write_event_header_slow(const struct lttng_ust_lib_ring_buffer_config *config, @@ -184,6 +240,7 @@ void lttng_write_event_header(const struct lttng_ust_lib_ring_buffer_config *con { struct lttng_channel *lttng_chan = channel_get_private(ctx->chan); struct lttng_event *event = ctx->priv; + struct lttng_stack_ctx *lttng_ctx = ctx->priv2; if (caa_unlikely(ctx->rflags)) goto slow_path; @@ -218,8 +275,15 @@ void lttng_write_event_header(const struct lttng_ust_lib_ring_buffer_config *con WARN_ON_ONCE(1); } - ctx_record(ctx, lttng_chan, lttng_chan->ctx); - ctx_record(ctx, lttng_chan, event->ctx); + 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); + } lib_ring_buffer_align_ctx(ctx, ctx->largest_align); return; @@ -235,6 +299,7 @@ void lttng_write_event_header_slow(const struct lttng_ust_lib_ring_buffer_config { struct lttng_channel *lttng_chan = channel_get_private(ctx->chan); struct lttng_event *event = ctx->priv; + struct lttng_stack_ctx *lttng_ctx = ctx->priv2; switch (lttng_chan->header_type) { case 1: /* compact */ @@ -291,8 +356,15 @@ 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_chan->ctx); - ctx_record(ctx, lttng_chan, event->ctx); + 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); + } lib_ring_buffer_align_ctx(ctx, ctx->largest_align); } @@ -336,14 +408,20 @@ static void client_buffer_begin(struct lttng_ust_lib_ring_buffer *buf, uint64_t 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) + return; 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; } @@ -364,6 +442,9 @@ 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->ctx.timestamp_end = tsc; header->ctx.content_size = (uint64_t) data_size * CHAR_BIT; /* in bits */ @@ -386,6 +467,162 @@ static void client_buffer_finalize(struct lttng_ust_lib_ring_buffer *buf, void * { } +static void client_content_size_field(const struct lttng_ust_lib_ring_buffer_config *config, + size_t *offset, size_t *length) +{ + *offset = offsetof(struct packet_header, ctx.content_size); + *length = sizeof(((struct packet_header *) NULL)->ctx.content_size); +} + +static void client_packet_size_field(const struct lttng_ust_lib_ring_buffer_config *config, + size_t *offset, size_t *length) +{ + *offset = offsetof(struct packet_header, ctx.packet_size); + *length = sizeof(((struct packet_header *) NULL)->ctx.packet_size); +} + +static struct packet_header *client_packet_header(struct lttng_ust_lib_ring_buffer *buf, + struct lttng_ust_shm_handle *handle) +{ + return lib_ring_buffer_read_offset_address(&buf->backend, 0, handle); +} + +static int client_timestamp_begin(struct lttng_ust_lib_ring_buffer *buf, + struct lttng_ust_shm_handle *handle, + uint64_t *timestamp_begin) +{ + struct packet_header *header; + + header = client_packet_header(buf, handle); + if (!header) + return -1; + *timestamp_begin = header->ctx.timestamp_begin; + return 0; +} + +static int client_timestamp_end(struct lttng_ust_lib_ring_buffer *buf, + struct lttng_ust_shm_handle *handle, + uint64_t *timestamp_end) +{ + struct packet_header *header; + + header = client_packet_header(buf, handle); + if (!header) + return -1; + *timestamp_end = header->ctx.timestamp_end; + return 0; +} + +static int client_events_discarded(struct lttng_ust_lib_ring_buffer *buf, + struct lttng_ust_shm_handle *handle, + uint64_t *events_discarded) +{ + struct packet_header *header; + + header = client_packet_header(buf, handle); + if (!header) + return -1; + *events_discarded = header->ctx.events_discarded; + return 0; +} + +static int client_content_size(struct lttng_ust_lib_ring_buffer *buf, + struct lttng_ust_shm_handle *handle, + uint64_t *content_size) +{ + struct packet_header *header; + + header = client_packet_header(buf, handle); + if (!header) + return -1; + *content_size = header->ctx.content_size; + return 0; +} + +static int client_packet_size(struct lttng_ust_lib_ring_buffer *buf, + struct lttng_ust_shm_handle *handle, + uint64_t *packet_size) +{ + struct packet_header *header; + + header = client_packet_header(buf, handle); + if (!header) + return -1; + *packet_size = header->ctx.packet_size; + return 0; +} + +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; + + header = client_packet_header(buf, handle); + if (!header) + return -1; + *stream_id = header->stream_id; + return 0; +} + +static int client_current_timestamp(struct lttng_ust_lib_ring_buffer *buf, + struct lttng_ust_shm_handle *handle, + uint64_t *ts) +{ + struct channel *chan; + + chan = shmp(handle, handle->chan); + *ts = client_ring_buffer_clock_read(chan); + + 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); + *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) +{ + struct packet_header *header; + + header = client_packet_header(buf, handle); + *id = header->stream_instance_id; + return 0; +} + +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, + .content_size_field = client_content_size_field, + .packet_size_field = client_packet_size_field, + }, + .timestamp_begin = client_timestamp_begin, + .timestamp_end = client_timestamp_end, + .events_discarded = client_events_discarded, + .content_size = client_content_size, + .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 = { .cb.ring_buffer_clock_read = client_ring_buffer_clock_read, .cb.record_header_size = client_record_header_size, @@ -394,6 +631,8 @@ static const struct lttng_ust_lib_ring_buffer_config client_config = { .cb.buffer_end = client_buffer_end, .cb.buffer_create = client_buffer_create, .cb.buffer_finalize = client_buffer_finalize, + .cb.content_size_field = client_content_size_field, + .cb.packet_size_field = client_packet_size_field, .tsc_bits = LTTNG_COMPACT_TSC_BITS, .alloc = RING_BUFFER_ALLOC_PER_CPU, @@ -403,11 +642,13 @@ static const struct lttng_ust_lib_ring_buffer_config client_config = { .output = RING_BUFFER_MMAP, .oops = RING_BUFFER_OOPS_CONSISTENCY, .ipi = RING_BUFFER_NO_IPI_BARRIER, - .wakeup = RING_BUFFER_WAKEUP_BY_WRITER, + .wakeup = LTTNG_CLIENT_WAKEUP, .client_type = LTTNG_CLIENT_TYPE, + + .cb_ptr = &client_cb.parent, }; -const struct lttng_ust_lib_ring_buffer_client_cb *LTTNG_CLIENT_CALLBACKS = &client_config.cb; +const struct lttng_ust_client_lib_ring_buffer_client_cb *LTTNG_CLIENT_CALLBACKS = &client_cb; static struct lttng_channel *_channel_create(const char *name, @@ -415,58 +656,37 @@ struct lttng_channel *_channel_create(const char *name, size_t subbuf_size, size_t num_subbuf, unsigned int switch_timer_interval, unsigned int read_timer_interval, - int **shm_fd, int **wait_fd, - uint64_t **memory_map_size, - struct lttng_channel *chan_priv_init) + unsigned char *uuid, + uint32_t chan_id, + const int *stream_fds, int nr_stream_fds) { - void *priv; - struct lttng_channel *lttng_chan = NULL; + struct lttng_channel chan_priv_init; struct lttng_ust_shm_handle *handle; + struct lttng_channel *lttng_chan; + void *priv; + 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), - chan_priv_init, + &priv, __alignof__(struct lttng_channel), + sizeof(struct lttng_channel), + &chan_priv_init, buf_addr, subbuf_size, num_subbuf, switch_timer_interval, read_timer_interval, - shm_fd, wait_fd, memory_map_size); + stream_fds, nr_stream_fds); if (!handle) return NULL; lttng_chan = priv; lttng_chan->handle = handle; - lttng_chan->chan = shmp(lttng_chan->handle, lttng_chan->handle->chan); + lttng_chan->chan = shmp(handle, handle->chan); return lttng_chan; } static -void lttng_channel_destroy(struct lttng_channel *lttng_chan) -{ - channel_destroy(lttng_chan->chan, lttng_chan->handle, 0); -} - -static -struct lttng_ust_lib_ring_buffer *lttng_buffer_read_open(struct channel *chan, - struct lttng_ust_shm_handle *handle, - int **shm_fd, int **wait_fd, - uint64_t **memory_map_size) -{ - struct lttng_ust_lib_ring_buffer *buf; - int cpu; - - for_each_channel_cpu(cpu, chan) { - buf = channel_get_ring_buffer(&client_config, chan, - cpu, handle, shm_fd, wait_fd, - memory_map_size); - if (!lib_ring_buffer_open_read(buf, handle, 0)) - return buf; - } - return NULL; -} - -static -void lttng_buffer_read_close(struct lttng_ust_lib_ring_buffer *buf, - struct lttng_ust_shm_handle *handle) +void lttng_channel_destroy(struct lttng_channel *chan) { - lib_ring_buffer_release_read(buf, handle, 0); + channel_destroy(chan->chan, chan->handle, 1); } static @@ -497,6 +717,14 @@ int lttng_event_reserve(struct lttng_ust_lib_ring_buffer_ctx *ctx, ret = lib_ring_buffer_reserve(&client_config, ctx); if (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; + } + } lttng_write_event_header(&client_config, ctx, event_id); return 0; put: @@ -518,6 +746,13 @@ void lttng_event_write(struct lttng_ust_lib_ring_buffer_ctx *ctx, const void *sr lib_ring_buffer_write(&client_config, ctx, src, len); } +static +void lttng_event_strcpy(struct lttng_ust_lib_ring_buffer_ctx *ctx, const char *src, + size_t len) +{ + lib_ring_buffer_strcpy(&client_config, ctx, src, len, '#'); +} + #if 0 static wait_queue_head_t *lttng_get_reader_wait_queue(struct channel *chan) @@ -551,12 +786,12 @@ int lttng_flush_buffer(struct channel *chan, struct lttng_ust_shm_handle *handle int cpu; for_each_channel_cpu(cpu, chan) { - int *shm_fd, *wait_fd; - uint64_t *memory_map_size; + int shm_fd, wait_fd, wakeup_fd; + uint64_t memory_map_size; buf = channel_get_ring_buffer(&client_config, chan, cpu, handle, &shm_fd, &wait_fd, - &memory_map_size); + &wakeup_fd, &memory_map_size); lib_ring_buffer_switch(&client_config, buf, SWITCH_ACTIVE, handle); } @@ -568,8 +803,7 @@ static struct lttng_transport lttng_relay_transport = { .ops = { .channel_create = _channel_create, .channel_destroy = lttng_channel_destroy, - .buffer_read_open = lttng_buffer_read_open, - .buffer_read_close = lttng_buffer_read_close, + .u.has_strcpy = 1, .event_reserve = lttng_event_reserve, .event_commit = lttng_event_commit, .event_write = lttng_event_write, @@ -579,17 +813,21 @@ static struct lttng_transport lttng_relay_transport = { .is_finalized = lttng_is_finalized, .is_disabled = lttng_is_disabled, .flush_buffer = lttng_flush_buffer, + .event_strcpy = lttng_event_strcpy, }, + .client_config = &client_config, }; void RING_BUFFER_MODE_TEMPLATE_INIT(void) { - DBG("LTT : ltt ring buffer client init\n"); + DBG("LTT : ltt ring buffer client \"%s\" init\n", + "relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap"); lttng_transport_register(<tng_relay_transport); } void RING_BUFFER_MODE_TEMPLATE_EXIT(void) { - DBG("LTT : ltt ring buffer client exit\n"); + DBG("LTT : ltt ring buffer client \"%s\" exit\n", + "relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap"); lttng_transport_unregister(<tng_relay_transport); }