X-Git-Url: http://git.liburcu.org/?p=lttng-modules.git;a=blobdiff_plain;f=lttng-ring-buffer-metadata-client.h;h=17ffd7593812a45af8f80e75a7b25e1301e4cfe9;hp=9b9ac2c2ae0d39fca6a2b534c3ada6bc3766b9b0;hb=HEAD;hpb=2459130397d7e7eecc44a5f06a39d65c78257eef diff --git a/lttng-ring-buffer-metadata-client.h b/lttng-ring-buffer-metadata-client.h deleted file mode 100644 index 9b9ac2c2..00000000 --- a/lttng-ring-buffer-metadata-client.h +++ /dev/null @@ -1,451 +0,0 @@ -/* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only) - * - * lttng-ring-buffer-client.h - * - * LTTng lib ring buffer client template. - * - * Copyright (C) 2010-2012 Mathieu Desnoyers - */ - -#include -#include -#include /* for wrapper_vmalloc_sync_mappings() */ -#include -#include - -static struct lttng_transport lttng_relay_transport; - -struct metadata_packet_header { - uint32_t magic; /* 0x75D11D57 */ - uint8_t uuid[16]; /* Unique Universal Identifier */ - uint32_t checksum; /* 0 if unused */ - uint32_t content_size; /* in bits */ - uint32_t packet_size; /* in bits */ - uint8_t compression_scheme; /* 0 if unused */ - uint8_t encryption_scheme; /* 0 if unused */ - uint8_t checksum_scheme; /* 0 if unused */ - uint8_t major; /* CTF spec major version number */ - uint8_t minor; /* CTF spec minor version number */ - uint8_t header_end[0]; -}; - -struct metadata_record_header { - uint8_t header_end[0]; /* End of header */ -}; - -static const struct lib_ring_buffer_config client_config; - -static inline -u64 lib_ring_buffer_clock_read(struct channel *chan) -{ - return 0; -} - -static inline -size_t record_header_size(const struct lib_ring_buffer_config *config, - struct channel *chan, size_t offset, - size_t *pre_header_padding, - struct lib_ring_buffer_ctx *ctx, - void *client_ctx) -{ - return 0; -} - -#include - -static u64 client_ring_buffer_clock_read(struct channel *chan) -{ - return 0; -} - -static -size_t client_record_header_size(const struct lib_ring_buffer_config *config, - struct channel *chan, size_t offset, - size_t *pre_header_padding, - struct lib_ring_buffer_ctx *ctx, - void *client_ctx) -{ - return 0; -} - -/** - * client_packet_header_size - called on buffer-switch to a new sub-buffer - * - * Return header size without padding after the structure. Don't use packed - * structure because gcc generates inefficient code on some architectures - * (powerpc, mips..) - */ -static size_t client_packet_header_size(void) -{ - return offsetof(struct metadata_packet_header, header_end); -} - -static void client_buffer_begin(struct lib_ring_buffer *buf, u64 tsc, - unsigned int subbuf_idx) -{ - struct channel *chan = 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); - struct lttng_metadata_cache *metadata_cache = - channel_get_private(chan); - - header->magic = TSDL_MAGIC_NUMBER; - memcpy(header->uuid, metadata_cache->uuid.b, - sizeof(metadata_cache->uuid)); - header->checksum = 0; /* 0 if unused */ - header->content_size = 0xFFFFFFFF; /* in bits, for debugging */ - header->packet_size = 0xFFFFFFFF; /* in bits, for debugging */ - header->compression_scheme = 0; /* 0 if unused */ - header->encryption_scheme = 0; /* 0 if unused */ - header->checksum_scheme = 0; /* 0 if unused */ - header->major = CTF_SPEC_MAJOR; - header->minor = CTF_SPEC_MINOR; -} - -/* - * offset is assumed to never be 0 here : never deliver a completely empty - * subbuffer. data_size is between 1 and subbuf_size. - */ -static void client_buffer_end(struct lib_ring_buffer *buf, u64 tsc, - unsigned int subbuf_idx, unsigned long data_size) -{ - struct channel *chan = 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); - unsigned long records_lost = 0; - - header->content_size = data_size * CHAR_BIT; /* in bits */ - header->packet_size = PAGE_ALIGN(data_size) * CHAR_BIT; /* in bits */ - /* - * We do not care about the records lost count, because the metadata - * channel waits and retry. - */ - (void) lib_ring_buffer_get_records_lost_full(&client_config, buf); - records_lost += lib_ring_buffer_get_records_lost_wrap(&client_config, buf); - records_lost += lib_ring_buffer_get_records_lost_big(&client_config, buf); - WARN_ON_ONCE(records_lost != 0); -} - -static int client_buffer_create(struct lib_ring_buffer *buf, void *priv, - int cpu, const char *name) -{ - return 0; -} - -static void client_buffer_finalize(struct lib_ring_buffer *buf, void *priv, int cpu) -{ -} - -static int client_timestamp_begin(const struct lib_ring_buffer_config *config, - struct lib_ring_buffer *buf, uint64_t *timestamp_begin) -{ - return -ENOSYS; -} - -static int client_timestamp_end(const struct lib_ring_buffer_config *config, - struct lib_ring_buffer *bufb, - uint64_t *timestamp_end) -{ - return -ENOSYS; -} - -static int client_events_discarded(const struct lib_ring_buffer_config *config, - struct lib_ring_buffer *bufb, - uint64_t *events_discarded) -{ - return -ENOSYS; -} - -static int client_current_timestamp(const struct lib_ring_buffer_config *config, - struct lib_ring_buffer *bufb, - uint64_t *ts) -{ - return -ENOSYS; -} - -static int client_content_size(const struct lib_ring_buffer_config *config, - struct lib_ring_buffer *bufb, - uint64_t *content_size) -{ - return -ENOSYS; -} - -static int client_packet_size(const struct lib_ring_buffer_config *config, - struct lib_ring_buffer *bufb, - uint64_t *packet_size) -{ - return -ENOSYS; -} - -static int client_stream_id(const struct lib_ring_buffer_config *config, - struct lib_ring_buffer *bufb, - uint64_t *stream_id) -{ - return -ENOSYS; -} - -static int client_sequence_number(const struct lib_ring_buffer_config *config, - struct lib_ring_buffer *bufb, - uint64_t *seq) -{ - return -ENOSYS; -} - -static -int client_instance_id(const struct lib_ring_buffer_config *config, - struct lib_ring_buffer *bufb, - uint64_t *id) -{ - return -ENOSYS; -} - -static const struct lib_ring_buffer_config client_config = { - .cb.ring_buffer_clock_read = client_ring_buffer_clock_read, - .cb.record_header_size = client_record_header_size, - .cb.subbuffer_header_size = client_packet_header_size, - .cb.buffer_begin = client_buffer_begin, - .cb.buffer_end = client_buffer_end, - .cb.buffer_create = client_buffer_create, - .cb.buffer_finalize = client_buffer_finalize, - - .tsc_bits = 0, - .alloc = RING_BUFFER_ALLOC_GLOBAL, - .sync = RING_BUFFER_SYNC_GLOBAL, - .mode = RING_BUFFER_MODE_TEMPLATE, - .backend = RING_BUFFER_PAGE, - .output = RING_BUFFER_OUTPUT_TEMPLATE, - .oops = RING_BUFFER_OOPS_CONSISTENCY, - .ipi = RING_BUFFER_IPI_BARRIER, - .wakeup = RING_BUFFER_WAKEUP_BY_TIMER, -}; - -static -void release_priv_ops(void *priv_ops) -{ - module_put(THIS_MODULE); -} - -static -void lttng_channel_destroy(struct channel *chan) -{ - channel_destroy(chan); -} - -static -struct channel *_channel_create(const char *name, - struct lttng_channel *lttng_chan, void *buf_addr, - size_t subbuf_size, size_t num_subbuf, - unsigned int switch_timer_interval, - unsigned int read_timer_interval) -{ - struct channel *chan; - - chan = channel_create(&client_config, name, - lttng_chan->session->metadata_cache, buf_addr, - subbuf_size, num_subbuf, switch_timer_interval, - read_timer_interval); - if (chan) { - /* - * Ensure this module is not unloaded before we finish - * using lttng_relay_transport.ops. - */ - if (!try_module_get(THIS_MODULE)) { - printk(KERN_WARNING "LTT : Can't lock transport module.\n"); - goto error; - } - chan->backend.priv_ops = <tng_relay_transport.ops; - chan->backend.release_priv_ops = release_priv_ops; - } - return chan; - -error: - lttng_channel_destroy(chan); - return NULL; -} - -static -struct lib_ring_buffer *lttng_buffer_read_open(struct channel *chan) -{ - struct lib_ring_buffer *buf; - - buf = channel_get_ring_buffer(&client_config, chan, 0); - if (!lib_ring_buffer_open_read(buf)) - return buf; - return NULL; -} - -static -int lttng_buffer_has_read_closed_stream(struct channel *chan) -{ - struct lib_ring_buffer *buf; - int cpu; - - for_each_channel_cpu(cpu, chan) { - buf = channel_get_ring_buffer(&client_config, chan, cpu); - if (!atomic_long_read(&buf->active_readers)) - return 1; - } - return 0; -} - -static -void lttng_buffer_read_close(struct lib_ring_buffer *buf) -{ - lib_ring_buffer_release_read(buf); -} - -static -int lttng_event_reserve(struct lib_ring_buffer_ctx *ctx, uint32_t event_id) -{ - int ret; - - ret = lib_ring_buffer_reserve(&client_config, ctx, NULL); - if (ret) - return ret; - lib_ring_buffer_backend_get_pages(&client_config, ctx, - &ctx->backend_pages); - return 0; - -} - -static -void lttng_event_commit(struct lib_ring_buffer_ctx *ctx) -{ - lib_ring_buffer_commit(&client_config, ctx); -} - -static -void lttng_event_write(struct lib_ring_buffer_ctx *ctx, const void *src, - size_t len) -{ - lib_ring_buffer_write(&client_config, ctx, src, len); -} - -static -void lttng_event_write_from_user(struct lib_ring_buffer_ctx *ctx, - const void __user *src, size_t len) -{ - lib_ring_buffer_copy_from_user_inatomic(&client_config, ctx, src, len); -} - -static -void lttng_event_memset(struct lib_ring_buffer_ctx *ctx, - int c, size_t len) -{ - lib_ring_buffer_memset(&client_config, ctx, c, len); -} - -static -void lttng_event_strcpy(struct lib_ring_buffer_ctx *ctx, const char *src, - size_t len) -{ - lib_ring_buffer_strcpy(&client_config, ctx, src, len, '#'); -} - -static -size_t lttng_packet_avail_size(struct channel *chan) -{ - unsigned long o_begin; - struct lib_ring_buffer *buf; - - buf = chan->backend.buf; /* 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); - } else { - return chan->backend.subbuf_size - subbuf_offset(o_begin, chan) - - sizeof(struct metadata_packet_header); - } -} - -static -wait_queue_head_t *lttng_get_writer_buf_wait_queue(struct channel *chan, int cpu) -{ - struct lib_ring_buffer *buf = channel_get_ring_buffer(&client_config, - chan, cpu); - return &buf->write_wait; -} - -static -wait_queue_head_t *lttng_get_hp_wait_queue(struct channel *chan) -{ - return &chan->hp_wait; -} - -static -int lttng_is_finalized(struct channel *chan) -{ - return lib_ring_buffer_channel_is_finalized(chan); -} - -static -int lttng_is_disabled(struct channel *chan) -{ - return lib_ring_buffer_channel_is_disabled(chan); -} - -static struct lttng_transport lttng_relay_transport = { - .name = "relay-" RING_BUFFER_MODE_TEMPLATE_STRING, - .owner = THIS_MODULE, - .ops = { - .channel_create = _channel_create, - .channel_destroy = lttng_channel_destroy, - .buffer_read_open = lttng_buffer_read_open, - .buffer_has_read_closed_stream = - lttng_buffer_has_read_closed_stream, - .buffer_read_close = lttng_buffer_read_close, - .event_reserve = lttng_event_reserve, - .event_commit = lttng_event_commit, - .event_write_from_user = lttng_event_write_from_user, - .event_memset = lttng_event_memset, - .event_write = lttng_event_write, - .event_strcpy = lttng_event_strcpy, - .packet_avail_size = lttng_packet_avail_size, - .get_writer_buf_wait_queue = lttng_get_writer_buf_wait_queue, - .get_hp_wait_queue = lttng_get_hp_wait_queue, - .is_finalized = lttng_is_finalized, - .is_disabled = lttng_is_disabled, - .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 int __init lttng_ring_buffer_client_init(void) -{ - /* - * This vmalloc sync all also takes care of the lib ring buffer - * vmalloc'd module pages when it is built as a module into LTTng. - */ - wrapper_vmalloc_sync_mappings(); - lttng_transport_register(<tng_relay_transport); - return 0; -} - -module_init(lttng_ring_buffer_client_init); - -static void __exit lttng_ring_buffer_client_exit(void) -{ - lttng_transport_unregister(<tng_relay_transport); -} - -module_exit(lttng_ring_buffer_client_exit); - -MODULE_LICENSE("GPL and additional rights"); -MODULE_AUTHOR("Mathieu Desnoyers "); -MODULE_DESCRIPTION("LTTng ring buffer " RING_BUFFER_MODE_TEMPLATE_STRING - " client"); -MODULE_VERSION(__stringify(LTTNG_MODULES_MAJOR_VERSION) "." - __stringify(LTTNG_MODULES_MINOR_VERSION) "." - __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION) - LTTNG_MODULES_EXTRAVERSION);