X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=libringbuffer%2Ffrontend.h;h=9bc22df887228dd2a49d68dbedf4bf9ae7800b0f;hb=071dec4386ff4c89d8b0f92ab1a8dbf079abd50c;hp=e1d9d575599e2baee592ccbe87b4c45097c2bf3d;hpb=4cfec15c93af7e0cfe3ce769ee90486bb8ab7c37;p=lttng-ust.git diff --git a/libringbuffer/frontend.h b/libringbuffer/frontend.h index e1d9d575..9bc22df8 100644 --- a/libringbuffer/frontend.h +++ b/libringbuffer/frontend.h @@ -1,25 +1,25 @@ -#ifndef _LINUX_RING_BUFFER_FRONTEND_H -#define _LINUX_RING_BUFFER_FRONTEND_H - /* - * linux/ringbuffer/frontend.h + * SPDX-License-Identifier: LGPL-2.1-only * - * (C) Copyright 2005-2010 - Mathieu Desnoyers + * Copyright (C) 2005-2012 Mathieu Desnoyers * * Ring Buffer Library Synchronization Header (API). * - * Author: - * Mathieu Desnoyers - * * See ring_buffer_frontend.c for more information on wait-free algorithms. - * - * Dual LGPL v2.1/GPL v2 license. */ +#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" @@ -34,36 +34,36 @@ * buf_addr is a pointer the the beginning of the preallocated buffer contiguous * 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. */ +LTTNG_HIDDEN extern struct lttng_ust_shm_handle *channel_create(const struct lttng_ust_lib_ring_buffer_config *config, - const char *name, void *priv, + const char *name, + void **priv_data, + size_t priv_data_align, + size_t priv_data_size, + void *priv_data_init, void *buf_addr, 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); - -/* channel_handle_create - for consumer. */ -extern -struct lttng_ust_shm_handle *channel_handle_create(int shm_fd, int wait_fd, - uint64_t memory_map_size); - -/* channel_handle_add_stream - for consumer. */ -extern -int channel_handle_add_stream(struct lttng_ust_shm_handle *handle, - int shm_fd, int wait_fd, uint64_t memory_map_size); + const int *stream_fds, int nr_stream_fds, + int64_t blocking_timeout); /* - * channel_destroy returns the private data pointer. It finalizes all channel's - * buffers, waits for readers to release all references, and destroys the - * channel. + * 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 shadow); +void channel_destroy(struct channel *chan, struct lttng_ust_shm_handle *handle, + int consumer); /* Buffer read operations */ @@ -77,33 +77,75 @@ 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, struct lttng_ust_shm_handle *handle, 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, - int shadow); + 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, - int shadow); + struct lttng_ust_shm_handle *handle); + +/* + * 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); @@ -128,12 +170,19 @@ static inline void lib_ring_buffer_put_next_subbuf(struct lttng_ust_lib_ring_buffer *buf, struct lttng_ust_shm_handle *handle) { + struct 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); } +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); @@ -236,4 +285,4 @@ unsigned long lib_ring_buffer_get_records_read( return v_read(config, &buf->backend.records_read); } -#endif /* _LINUX_RING_BUFFER_FRONTEND_H */ +#endif /* _LTTNG_RING_BUFFER_FRONTEND_H */