X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;ds=sidebyside;f=include%2Flttng%2Fringbuffer-config.h;h=ca52fc71fb02e90776e9d6157c9e100b5682f3fa;hb=04f5c9407a2bbf9fd9a160db9ffec18c0dc99189;hp=4fa57750b9dd62a8132cb59f14ff935b525b3b21;hpb=4318ae1be57eb7983ab4857a7a8eeb4a030a8216;p=lttng-ust.git diff --git a/include/lttng/ringbuffer-config.h b/include/lttng/ringbuffer-config.h index 4fa57750..ca52fc71 100644 --- a/include/lttng/ringbuffer-config.h +++ b/include/lttng/ringbuffer-config.h @@ -1,28 +1,47 @@ -#ifndef _LINUX_RING_BUFFER_CONFIG_H -#define _LINUX_RING_BUFFER_CONFIG_H +#ifndef _LTTNG_RING_BUFFER_CONFIG_H +#define _LTTNG_RING_BUFFER_CONFIG_H /* - * linux/ringbuffer/config.h + * lttng/ringbuffer-config.h * * Copyright (C) 2010 - Mathieu Desnoyers * * Ring buffer configuration header. Note: after declaring the standard inline * functions, clients should also include linux/ringbuffer/api.h. * - * Dual LGPL v2.1/GPL v2 license. + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. */ #include #include "lttng/ust-tracer.h" -#include "lttng/usterr-signal-safe.h" -#include "lttng/kcompat/kcompat.h" +#include +#include +#include +#include #include "lttng/align.h" +#include struct lttng_ust_lib_ring_buffer; struct channel; struct lttng_ust_lib_ring_buffer_config; struct lttng_ust_lib_ring_buffer_ctx; -struct lttng_ust_shm_handle *handle; +struct lttng_ust_shm_handle; /* * Ring buffer client callbacks. Only used by slow path, never on fast path. @@ -34,7 +53,7 @@ struct lttng_ust_lib_ring_buffer_client_cb { /* Mandatory callbacks */ /* A static inline version is also required for fast path */ - u64 (*ring_buffer_clock_read) (struct channel *chan); + uint64_t (*ring_buffer_clock_read) (struct channel *chan); 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, @@ -42,10 +61,10 @@ struct lttng_ust_lib_ring_buffer_client_cb { /* Slow path only, at subbuffer switch */ size_t (*subbuffer_header_size) (void); - void (*buffer_begin) (struct lttng_ust_lib_ring_buffer *buf, u64 tsc, + void (*buffer_begin) (struct lttng_ust_lib_ring_buffer *buf, uint64_t tsc, unsigned int subbuf_idx, struct lttng_ust_shm_handle *handle); - void (*buffer_end) (struct lttng_ust_lib_ring_buffer *buf, u64 tsc, + void (*buffer_end) (struct lttng_ust_lib_ring_buffer *buf, uint64_t tsc, unsigned int subbuf_idx, unsigned long data_size, struct lttng_ust_shm_handle *handle); @@ -71,7 +90,7 @@ struct lttng_ust_lib_ring_buffer_client_cb { void (*record_get) (const struct lttng_ust_lib_ring_buffer_config *config, struct channel *chan, struct lttng_ust_lib_ring_buffer *buf, size_t offset, size_t *header_len, - size_t *payload_len, u64 *timestamp, + size_t *payload_len, uint64_t *timestamp, struct lttng_ust_shm_handle *handle); }; @@ -114,6 +133,7 @@ struct lttng_ust_lib_ring_buffer_client_cb { * RING_BUFFER_WAKEUP_NONE does not perform any wakeup whatsoever. The client * has the responsibility to perform wakeups. */ +#define LTTNG_UST_RING_BUFFER_CONFIG_PADDING 32 struct lttng_ust_lib_ring_buffer_config { enum { RING_BUFFER_ALLOC_PER_CPU, @@ -161,6 +181,13 @@ struct lttng_ust_lib_ring_buffer_config { */ unsigned int tsc_bits; struct lttng_ust_lib_ring_buffer_client_cb cb; + /* + * client_type is used by the consumer process (which is in a + * different address space) to lookup the appropriate client + * callbacks and update the cb pointers. + */ + int client_type; + char padding[LTTNG_UST_RING_BUFFER_CONFIG_PADDING]; }; /* @@ -169,7 +196,12 @@ struct lttng_ust_lib_ring_buffer_config { * Context passed to lib_ring_buffer_reserve(), lib_ring_buffer_commit(), * lib_ring_buffer_try_discard_reserve(), lib_ring_buffer_align_ctx() and * lib_ring_buffer_write(). + * + * IMPORTANT: this structure is part of the ABI between the probe and + * UST. Fields need to be only added at the end, never reordered, never + * removed. */ +#define LTTNG_UST_RING_BUFFER_CTX_PADDING 24 struct lttng_ust_lib_ring_buffer_ctx { /* input received by lib_ring_buffer_reserve(), saved here. */ struct channel *chan; /* channel */ @@ -195,8 +227,9 @@ struct lttng_ust_lib_ring_buffer_ctx { * prior to record header alignment * padding. */ - u64 tsc; /* time-stamp counter value */ + uint64_t tsc; /* time-stamp counter value */ unsigned int rflags; /* reservation flags */ + char padding[LTTNG_UST_RING_BUFFER_CTX_PADDING]; }; /** @@ -208,6 +241,11 @@ struct lttng_ust_lib_ring_buffer_ctx { * @largest_align: largest alignment within data payload types * @cpu: processor id */ +static inline lttng_ust_notrace +void lib_ring_buffer_ctx_init(struct lttng_ust_lib_ring_buffer_ctx *ctx, + struct channel *chan, void *priv, + size_t data_size, int largest_align, + int cpu, struct lttng_ust_shm_handle *handle); static inline void lib_ring_buffer_ctx_init(struct lttng_ust_lib_ring_buffer_ctx *ctx, struct channel *chan, void *priv, @@ -221,6 +259,7 @@ void lib_ring_buffer_ctx_init(struct lttng_ust_lib_ring_buffer_ctx *ctx, ctx->cpu = cpu; ctx->rflags = 0; ctx->handle = handle; + memset(ctx->padding, 0, LTTNG_UST_RING_BUFFER_CTX_PADDING); } /* @@ -254,6 +293,8 @@ void lib_ring_buffer_ctx_init(struct lttng_ust_lib_ring_buffer_ctx *ctx, * Calculate the offset needed to align the type. * size_of_type must be non-zero. */ +static inline lttng_ust_notrace +unsigned int lib_ring_buffer_align(size_t align_drift, size_t size_of_type); static inline unsigned int lib_ring_buffer_align(size_t align_drift, size_t size_of_type) { @@ -268,6 +309,8 @@ unsigned int lib_ring_buffer_align(size_t align_drift, size_t size_of_type) * Calculate the offset needed to align the type. * size_of_type must be non-zero. */ +static inline lttng_ust_notrace +unsigned int lib_ring_buffer_align(size_t align_drift, size_t size_of_type); static inline unsigned int lib_ring_buffer_align(size_t align_drift, size_t size_of_type) { @@ -280,6 +323,9 @@ unsigned int lib_ring_buffer_align(size_t align_drift, size_t size_of_type) * lib_ring_buffer_align_ctx - Align context offset on "alignment" * @ctx: ring buffer context. */ +static inline lttng_ust_notrace +void lib_ring_buffer_align_ctx(struct lttng_ust_lib_ring_buffer_ctx *ctx, + size_t alignment); static inline void lib_ring_buffer_align_ctx(struct lttng_ust_lib_ring_buffer_ctx *ctx, size_t alignment) @@ -292,6 +338,10 @@ void lib_ring_buffer_align_ctx(struct lttng_ust_lib_ring_buffer_ctx *ctx, * lib_ring_buffer_check_config() returns 0 on success. * Used internally to check for valid configurations at channel creation. */ +static inline lttng_ust_notrace +int lib_ring_buffer_check_config(const struct lttng_ust_lib_ring_buffer_config *config, + unsigned int switch_timer_interval, + unsigned int read_timer_interval); static inline int lib_ring_buffer_check_config(const struct lttng_ust_lib_ring_buffer_config *config, unsigned int switch_timer_interval, @@ -304,6 +354,4 @@ int lib_ring_buffer_check_config(const struct lttng_ust_lib_ring_buffer_config * return 0; } -#include - -#endif /* _LINUX_RING_BUFFER_CONFIG_H */ +#endif /* _LTTNG_RING_BUFFER_CONFIG_H */