X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=libringbuffer%2Ffrontend.h;h=9bc22df887228dd2a49d68dbedf4bf9ae7800b0f;hb=071dec4386ff4c89d8b0f92ab1a8dbf079abd50c;hp=160fd45532f39573b09178f6924bba71b1f65264;hpb=15500a1bb134d6bbd409da5568308c2a41291928;p=lttng-ust.git diff --git a/libringbuffer/frontend.h b/libringbuffer/frontend.h index 160fd455..9bc22df8 100644 --- a/libringbuffer/frontend.h +++ b/libringbuffer/frontend.h @@ -1,38 +1,25 @@ -#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" +#include "ust-helper.h" + /* Internal helpers */ #include "frontend_internal.h" @@ -54,6 +41,7 @@ * private data area. */ +LTTNG_HIDDEN extern struct lttng_ust_shm_handle *channel_create(const struct lttng_ust_lib_ring_buffer_config *config, const char *name, @@ -65,12 +53,14 @@ struct lttng_ust_shm_handle *channel_create(const struct lttng_ust_lib_ring_buff size_t subbuf_size, size_t num_subbuf, unsigned int switch_timer_interval, unsigned int read_timer_interval, - const int *stream_fds, int nr_stream_fds); + const int *stream_fds, int nr_stream_fds, + int64_t blocking_timeout); /* * channel_destroy finalizes all channel's buffers, waits for readers to * release all references, and destroys the channel. */ +LTTNG_HIDDEN extern void channel_destroy(struct channel *chan, struct lttng_ust_shm_handle *handle, int consumer); @@ -87,6 +77,7 @@ void channel_destroy(struct channel *chan, struct lttng_ust_shm_handle *handle, #define for_each_channel_cpu(cpu, chan) \ for_each_possible_cpu(cpu) +LTTNG_HIDDEN 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, @@ -94,27 +85,33 @@ extern struct lttng_ust_lib_ring_buffer *channel_get_ring_buffer( int *shm_fd, int *wait_fd, int *wakeup_fd, uint64_t *memory_map_size); +LTTNG_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); +LTTNG_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); +LTTNG_HIDDEN extern int ring_buffer_stream_close_wait_fd(const struct lttng_ust_lib_ring_buffer_config *config, struct channel *chan, struct lttng_ust_shm_handle *handle, int cpu); +LTTNG_HIDDEN extern int ring_buffer_stream_close_wakeup_fd(const struct lttng_ust_lib_ring_buffer_config *config, struct channel *chan, struct lttng_ust_shm_handle *handle, int cpu); +LTTNG_HIDDEN extern int lib_ring_buffer_open_read(struct lttng_ust_lib_ring_buffer *buf, struct lttng_ust_shm_handle *handle); +LTTNG_HIDDEN extern void lib_ring_buffer_release_read(struct lttng_ust_lib_ring_buffer *buf, struct lttng_ust_shm_handle *handle); @@ -122,22 +119,33 @@ extern void lib_ring_buffer_release_read(struct lttng_ust_lib_ring_buffer *buf, * Initialize signals for ring buffer. Should be called early e.g. by * main() in the program to affect all threads. */ +LTTNG_HIDDEN void lib_ringbuffer_signal_init(void); /* * Read sequence: snapshot, many get_subbuf/put_subbuf, move_consumer. */ +LTTNG_HIDDEN 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); +LTTNG_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); +LTTNG_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); +LTTNG_HIDDEN extern int lib_ring_buffer_get_subbuf(struct lttng_ust_lib_ring_buffer *buf, unsigned long consumed, struct lttng_ust_shm_handle *handle); +LTTNG_HIDDEN extern void lib_ring_buffer_put_subbuf(struct lttng_ust_lib_ring_buffer *buf, struct lttng_ust_shm_handle *handle); @@ -172,7 +180,9 @@ void lib_ring_buffer_put_next_subbuf(struct lttng_ust_lib_ring_buffer *buf, handle); } +LTTNG_HIDDEN extern void channel_reset(struct channel *chan); +LTTNG_HIDDEN extern void lib_ring_buffer_reset(struct lttng_ust_lib_ring_buffer *buf, struct lttng_ust_shm_handle *handle);