Namespace 'struct channel' under 'lttng_ust_lib_ring_buffer_'
[lttng-ust.git] / libringbuffer / frontend.h
index 2eda6e945b218c8b557886084202feb4b5151716..de924a0a8af8f090ed9e1caf9ecb61d02da17b2c 100644 (file)
@@ -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 <mathieu.desnoyers@efficios.com>
  *
- * 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 <mathieu.desnoyers@efficios.com>
+ * 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 <stddef.h>
+#include <stdint.h>
+
 #include <urcu/compiler.h>
 #include <urcu/uatomic.h>
 
 #include "smp.h"
+
 /* Internal helpers */
 #include "frontend_internal.h"
 
@@ -54,6 +40,7 @@
  * private data area.
  */
 
+__attribute__((visibility("hidden")))
 extern
 struct lttng_ust_shm_handle *channel_create(const struct lttng_ust_lib_ring_buffer_config *config,
                                const char *name,
@@ -64,14 +51,18 @@ struct lttng_ust_shm_handle *channel_create(const struct lttng_ust_lib_ring_buff
                                void *buf_addr,
                                size_t subbuf_size, size_t num_subbuf,
                                unsigned int switch_timer_interval,
-                               unsigned int read_timer_interval);
+                               unsigned int read_timer_interval,
+                               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.
  */
+__attribute__((visibility("hidden")))
 extern
-void channel_destroy(struct channel *chan, struct lttng_ust_shm_handle *handle,
+void channel_destroy(struct lttng_ust_lib_ring_buffer_channel *chan,
+               struct lttng_ust_shm_handle *handle,
                int consumer);
 
 
@@ -86,26 +77,46 @@ void channel_destroy(struct channel *chan, struct lttng_ust_shm_handle *handle,
 #define for_each_channel_cpu(cpu, chan)                                        \
        for_each_possible_cpu(cpu)
 
+__attribute__((visibility("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_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);
+
+__attribute__((visibility("hidden")))
+extern
+int ring_buffer_channel_close_wait_fd(const struct lttng_ust_lib_ring_buffer_config *config,
+                       struct lttng_ust_lib_ring_buffer_channel *chan,
+                       struct lttng_ust_shm_handle *handle);
+
+__attribute__((visibility("hidden")))
 extern
-int ring_buffer_close_wait_fd(const struct lttng_ust_lib_ring_buffer_config *config,
-               struct channel *chan,
+int ring_buffer_channel_close_wakeup_fd(const struct lttng_ust_lib_ring_buffer_config *config,
+                       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 lttng_ust_lib_ring_buffer_channel *chan,
                struct lttng_ust_shm_handle *handle,
                int cpu);
+
+__attribute__((visibility("hidden")))
 extern
-int ring_buffer_close_wakeup_fd(const struct lttng_ust_lib_ring_buffer_config *config,
-               struct channel *chan,
+int ring_buffer_stream_close_wakeup_fd(const struct lttng_ust_lib_ring_buffer_config *config,
+               struct lttng_ust_lib_ring_buffer_channel *chan,
                struct lttng_ust_shm_handle *handle,
                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);
+
+__attribute__((visibility("hidden")))
 extern void lib_ring_buffer_release_read(struct lttng_ust_lib_ring_buffer *buf,
                                         struct lttng_ust_shm_handle *handle);
 
@@ -113,22 +124,35 @@ 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.
  */
+__attribute__((visibility("hidden")))
 void lib_ringbuffer_signal_init(void);
 
 /*
  * Read sequence: snapshot, many get_subbuf/put_subbuf, move_consumer.
  */
+__attribute__((visibility("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);
+
+__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);
 
+__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);
+__attribute__((visibility("hidden")))
 extern void lib_ring_buffer_put_subbuf(struct lttng_ust_lib_ring_buffer *buf,
                                       struct lttng_ust_shm_handle *handle);
 
@@ -153,12 +177,20 @@ 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);
+__attribute__((visibility("hidden")))
+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);
 
@@ -193,13 +225,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);
 }
This page took 0.026345 seconds and 4 git commands to generate.