X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=libringbuffer%2Ffrontend.h;h=ed255c749508a41546546a8135745b561467fb5a;hb=1d18d519668cd559dcafa1f18113edceb2418ed0;hp=770090770e9de16081a351db63f571616c4627b3;hpb=a9ff648cc4cc06d28b522d705c467d45ab916a9d;p=lttng-ust.git diff --git a/libringbuffer/frontend.h b/libringbuffer/frontend.h index 77009077..ed255c74 100644 --- a/libringbuffer/frontend.h +++ b/libringbuffer/frontend.h @@ -1,38 +1,24 @@ -#ifndef _LTTNG_RING_BUFFER_FRONTEND_H -#define _LTTNG_RING_BUFFER_FRONTEND_H - /* - * libringbuffer/frontend.h - * - * Ring Buffer Library Synchronization Header (API). + * SPDX-License-Identifier: LGPL-2.1-only * * Copyright (C) 2005-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 - * - * - * Author: - * Mathieu Desnoyers + * Ring Buffer Library Synchronization Header (API). * * See ring_buffer_frontend.c for more information on wait-free algorithms. */ +#ifndef _LTTNG_RING_BUFFER_FRONTEND_H +#define _LTTNG_RING_BUFFER_FRONTEND_H + +#include +#include + #include #include #include "smp.h" + /* Internal helpers */ #include "frontend_internal.h" @@ -48,32 +34,34 @@ * address mapping. It is used only by RING_BUFFER_STATIC configuration. It can * be set to NULL for other backends. * - * priv_data (output) is set to a pointer into a "priv_data_len"-sized - * memory area for client-specific data. This memory is managed by lib - * ring buffer. priv_data_align is the alignment required for the - * private data area. + * private data is a memory area for configuration data. This memory is + * managed by lib ring buffer. priv_data_align is the alignment required + * for the private data area. */ extern struct lttng_ust_shm_handle *channel_create(const struct lttng_ust_lib_ring_buffer_config *config, const char *name, - void **priv_data, size_t priv_data_align, size_t priv_data_size, void *priv_data_init, + void *priv, void *buf_addr, size_t subbuf_size, size_t num_subbuf, unsigned int switch_timer_interval, unsigned int read_timer_interval, - const char *shm_path); + const int *stream_fds, int nr_stream_fds, + int64_t blocking_timeout) + __attribute__((visibility("hidden"))); /* * channel_destroy finalizes all channel's buffers, waits for readers to * release all references, and destroys the channel. */ -extern -void channel_destroy(struct channel *chan, struct lttng_ust_shm_handle *handle, - int consumer); +void channel_destroy(struct lttng_ust_lib_ring_buffer_channel *chan, + struct lttng_ust_shm_handle *handle, + int consumer) + __attribute__((visibility("hidden"))); /* Buffer read operations */ @@ -89,40 +77,53 @@ void channel_destroy(struct channel *chan, struct lttng_ust_shm_handle *handle, extern struct lttng_ust_lib_ring_buffer *channel_get_ring_buffer( const struct lttng_ust_lib_ring_buffer_config *config, - struct channel *chan, int cpu, + struct lttng_ust_lib_ring_buffer_channel *chan, int cpu, struct lttng_ust_shm_handle *handle, int *shm_fd, int *wait_fd, int *wakeup_fd, - uint64_t *memory_map_size); + uint64_t *memory_map_size) + __attribute__((visibility("hidden"))); + extern int ring_buffer_channel_close_wait_fd(const struct lttng_ust_lib_ring_buffer_config *config, - struct channel *chan, - struct lttng_ust_shm_handle *handle); + struct lttng_ust_lib_ring_buffer_channel *chan, + struct lttng_ust_shm_handle *handle) + __attribute__((visibility("hidden"))); + extern int ring_buffer_channel_close_wakeup_fd(const struct lttng_ust_lib_ring_buffer_config *config, - struct channel *chan, - struct lttng_ust_shm_handle *handle); + struct lttng_ust_lib_ring_buffer_channel *chan, + struct lttng_ust_shm_handle *handle) + __attribute__((visibility("hidden"))); + extern int ring_buffer_stream_close_wait_fd(const struct lttng_ust_lib_ring_buffer_config *config, - struct channel *chan, + struct lttng_ust_lib_ring_buffer_channel *chan, struct lttng_ust_shm_handle *handle, - int cpu); + int cpu) + __attribute__((visibility("hidden"))); + extern int ring_buffer_stream_close_wakeup_fd(const struct lttng_ust_lib_ring_buffer_config *config, - struct channel *chan, + struct lttng_ust_lib_ring_buffer_channel *chan, struct lttng_ust_shm_handle *handle, - int cpu); + int cpu) + __attribute__((visibility("hidden"))); extern int lib_ring_buffer_open_read(struct lttng_ust_lib_ring_buffer *buf, - struct lttng_ust_shm_handle *handle); + struct lttng_ust_shm_handle *handle) + __attribute__((visibility("hidden"))); + extern void lib_ring_buffer_release_read(struct lttng_ust_lib_ring_buffer *buf, - struct lttng_ust_shm_handle *handle); + struct lttng_ust_shm_handle *handle) + __attribute__((visibility("hidden"))); /* * Initialize signals for ring buffer. Should be called early e.g. by * main() in the program to affect all threads. */ -void lib_ringbuffer_signal_init(void); +void lib_ringbuffer_signal_init(void) + __attribute__((visibility("hidden"))); /* * Read sequence: snapshot, many get_subbuf/put_subbuf, move_consumer. @@ -130,16 +131,29 @@ void lib_ringbuffer_signal_init(void); extern int lib_ring_buffer_snapshot(struct lttng_ust_lib_ring_buffer *buf, unsigned long *consumed, unsigned long *produced, - struct lttng_ust_shm_handle *handle); + struct lttng_ust_shm_handle *handle) + __attribute__((visibility("hidden"))); + +extern int lib_ring_buffer_snapshot_sample_positions( + struct lttng_ust_lib_ring_buffer *buf, + unsigned long *consumed, + unsigned long *produced, + struct lttng_ust_shm_handle *handle) + __attribute__((visibility("hidden"))); + extern void lib_ring_buffer_move_consumer(struct lttng_ust_lib_ring_buffer *buf, unsigned long consumed_new, - struct lttng_ust_shm_handle *handle); + struct lttng_ust_shm_handle *handle) + __attribute__((visibility("hidden"))); extern int lib_ring_buffer_get_subbuf(struct lttng_ust_lib_ring_buffer *buf, unsigned long consumed, - struct lttng_ust_shm_handle *handle); + struct lttng_ust_shm_handle *handle) + __attribute__((visibility("hidden"))); + extern void lib_ring_buffer_put_subbuf(struct lttng_ust_lib_ring_buffer *buf, - struct lttng_ust_shm_handle *handle); + struct lttng_ust_shm_handle *handle) + __attribute__((visibility("hidden"))); /* * lib_ring_buffer_get_next_subbuf/lib_ring_buffer_put_next_subbuf are helpers @@ -162,14 +176,22 @@ static inline void lib_ring_buffer_put_next_subbuf(struct lttng_ust_lib_ring_buffer *buf, struct lttng_ust_shm_handle *handle) { + struct lttng_ust_lib_ring_buffer_channel *chan; + + chan = shmp(handle, buf->backend.chan); + if (!chan) + return; lib_ring_buffer_put_subbuf(buf, handle); - lib_ring_buffer_move_consumer(buf, subbuf_align(buf->cons_snapshot, - shmp(handle, buf->backend.chan)), handle); + lib_ring_buffer_move_consumer(buf, subbuf_align(buf->cons_snapshot, chan), + handle); } -extern void channel_reset(struct channel *chan); +extern void channel_reset(struct lttng_ust_lib_ring_buffer_channel *chan) + __attribute__((visibility("hidden"))); + extern void lib_ring_buffer_reset(struct lttng_ust_lib_ring_buffer *buf, - struct lttng_ust_shm_handle *handle); + struct lttng_ust_shm_handle *handle) + __attribute__((visibility("hidden"))); static inline unsigned long lib_ring_buffer_get_offset(const struct lttng_ust_lib_ring_buffer_config *config, @@ -202,13 +224,13 @@ int lib_ring_buffer_is_finalized(const struct lttng_ust_lib_ring_buffer_config * } static inline -int lib_ring_buffer_channel_is_finalized(const struct channel *chan) +int lib_ring_buffer_channel_is_finalized(const struct lttng_ust_lib_ring_buffer_channel *chan) { return chan->finalized; } static inline -int lib_ring_buffer_channel_is_disabled(const struct channel *chan) +int lib_ring_buffer_channel_is_disabled(const struct lttng_ust_lib_ring_buffer_channel *chan) { return uatomic_read(&chan->record_disabled); }