Fix: pass private data to context callbacks
[lttng-ust.git] / libringbuffer / frontend_internal.h
index 7233ed6d91e7529c6af2aaa509f1d7e6e06532fc..7d905d4bc55fee4d951bbfcfe5daf5104afea20c 100644 (file)
@@ -1,43 +1,26 @@
-#ifndef _LTTNG_RING_BUFFER_FRONTEND_INTERNAL_H
-#define _LTTNG_RING_BUFFER_FRONTEND_INTERNAL_H
-
 /*
- * libringbuffer/frontend_internal.h
- *
- * Ring Buffer Library Synchronization Header (internal helpers).
+ * SPDX-License-Identifier: (LGPL-2.1-only or GPL-2.0-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 (internal helpers).
  *
  * See ring_buffer_frontend.c for more information on wait-free algorithms.
- *
- * Dual LGPL v2.1/GPL v2 license.
  */
 
+#ifndef _LTTNG_RING_BUFFER_FRONTEND_INTERNAL_H
+#define _LTTNG_RING_BUFFER_FRONTEND_INTERNAL_H
+
 #include <urcu/compiler.h>
 #include <urcu/tls-compat.h>
 #include <signal.h>
+#include <stdint.h>
 #include <pthread.h>
 
-#include <lttng/ringbuffer-config.h>
+#include <lttng/ringbuffer-context.h>
+#include "ringbuffer-config.h"
 #include "backend_types.h"
+#include "backend_internal.h"
 #include "frontend_types.h"
 #include "shm.h"
 
@@ -45,7 +28,8 @@
 
 /* buf_trunc mask selects only the buffer number. */
 static inline
-unsigned long buf_trunc(unsigned long offset, struct channel *chan)
+unsigned long buf_trunc(unsigned long offset,
+                       struct lttng_ust_lib_ring_buffer_channel *chan)
 {
        return offset & ~(chan->backend.buf_size - 1);
 
@@ -53,35 +37,40 @@ unsigned long buf_trunc(unsigned long offset, struct channel *chan)
 
 /* Select the buffer number value (counter). */
 static inline
-unsigned long buf_trunc_val(unsigned long offset, struct channel *chan)
+unsigned long buf_trunc_val(unsigned long offset,
+                       struct lttng_ust_lib_ring_buffer_channel *chan)
 {
        return buf_trunc(offset, chan) >> chan->backend.buf_size_order;
 }
 
 /* buf_offset mask selects only the offset within the current buffer. */
 static inline
-unsigned long buf_offset(unsigned long offset, struct channel *chan)
+unsigned long buf_offset(unsigned long offset,
+                       struct lttng_ust_lib_ring_buffer_channel *chan)
 {
        return offset & (chan->backend.buf_size - 1);
 }
 
 /* subbuf_offset mask selects the offset within the current subbuffer. */
 static inline
-unsigned long subbuf_offset(unsigned long offset, struct channel *chan)
+unsigned long subbuf_offset(unsigned long offset,
+                       struct lttng_ust_lib_ring_buffer_channel *chan)
 {
        return offset & (chan->backend.subbuf_size - 1);
 }
 
 /* subbuf_trunc mask selects the subbuffer number. */
 static inline
-unsigned long subbuf_trunc(unsigned long offset, struct channel *chan)
+unsigned long subbuf_trunc(unsigned long offset,
+                       struct lttng_ust_lib_ring_buffer_channel *chan)
 {
        return offset & ~(chan->backend.subbuf_size - 1);
 }
 
 /* subbuf_align aligns the offset to the next subbuffer. */
 static inline
-unsigned long subbuf_align(unsigned long offset, struct channel *chan)
+unsigned long subbuf_align(unsigned long offset,
+                       struct lttng_ust_lib_ring_buffer_channel *chan)
 {
        return (offset + chan->backend.subbuf_size)
               & ~(chan->backend.subbuf_size - 1);
@@ -89,7 +78,8 @@ unsigned long subbuf_align(unsigned long offset, struct channel *chan)
 
 /* subbuf_index returns the index of the current subbuffer within the buffer. */
 static inline
-unsigned long subbuf_index(unsigned long offset, struct channel *chan)
+unsigned long subbuf_index(unsigned long offset,
+                       struct lttng_ust_lib_ring_buffer_channel *chan)
 {
        return buf_offset(offset, chan) >> chan->backend.subbuf_size_order;
 }
@@ -159,27 +149,30 @@ int last_tsc_overflow(const struct lttng_ust_lib_ring_buffer_config *config,
 
 extern
 int lib_ring_buffer_reserve_slow(struct lttng_ust_lib_ring_buffer_ctx *ctx,
-               void *client_ctx);
+               void *client_ctx)
+       __attribute__((visibility("hidden")));
 
 extern
 void lib_ring_buffer_switch_slow(struct lttng_ust_lib_ring_buffer *buf,
                                 enum switch_mode mode,
-                                struct lttng_ust_shm_handle *handle);
+                                struct lttng_ust_shm_handle *handle)
+       __attribute__((visibility("hidden")));
 
 void lib_ring_buffer_check_deliver_slow(const struct lttng_ust_lib_ring_buffer_config *config,
                                   struct lttng_ust_lib_ring_buffer *buf,
-                                  struct channel *chan,
+                                  struct lttng_ust_lib_ring_buffer_channel *chan,
                                   unsigned long offset,
                                   unsigned long commit_count,
                                   unsigned long idx,
                                   struct lttng_ust_shm_handle *handle,
-                                  uint64_t tsc);
+                                  uint64_t tsc)
+       __attribute__((visibility("hidden")));
 
 /* Buffer write helpers */
 
 static inline
 void lib_ring_buffer_reserve_push_reader(struct lttng_ust_lib_ring_buffer *buf,
-                                        struct channel *chan,
+                                        struct lttng_ust_lib_ring_buffer_channel *chan,
                                         unsigned long offset)
 {
        unsigned long consumed_old, consumed_new;
@@ -218,7 +211,7 @@ static inline
 void lib_ring_buffer_clear_reader(struct lttng_ust_lib_ring_buffer *buf,
                                  struct lttng_ust_shm_handle *handle)
 {
-       struct channel *chan;
+       struct lttng_ust_lib_ring_buffer_channel *chan;
        const struct lttng_ust_lib_ring_buffer_config *config;
        unsigned long offset, consumed_old, consumed_new;
 
@@ -241,7 +234,7 @@ void lib_ring_buffer_clear_reader(struct lttng_ust_lib_ring_buffer *buf,
 static inline
 int lib_ring_buffer_pending_data(const struct lttng_ust_lib_ring_buffer_config *config,
                                 struct lttng_ust_lib_ring_buffer *buf,
-                                struct channel *chan)
+                                struct lttng_ust_lib_ring_buffer_channel *chan)
 {
        return !!subbuf_offset(v_read(config, &buf->offset), chan);
 }
@@ -263,7 +256,7 @@ unsigned long lib_ring_buffer_get_data_size(const struct lttng_ust_lib_ring_buff
 static inline
 int lib_ring_buffer_reserve_committed(const struct lttng_ust_lib_ring_buffer_config *config,
                                      struct lttng_ust_lib_ring_buffer *buf,
-                                     struct channel *chan,
+                                     struct lttng_ust_lib_ring_buffer_channel *chan,
                                      struct lttng_ust_shm_handle *handle)
 {
        unsigned long offset, idx, commit_count;
@@ -303,7 +296,7 @@ int lib_ring_buffer_reserve_committed(const struct lttng_ust_lib_ring_buffer_con
 static inline
 void lib_ring_buffer_check_deliver(const struct lttng_ust_lib_ring_buffer_config *config,
                                   struct lttng_ust_lib_ring_buffer *buf,
-                                  struct channel *chan,
+                                  struct lttng_ust_lib_ring_buffer_channel *chan,
                                   unsigned long offset,
                                   unsigned long commit_count,
                                   unsigned long idx,
@@ -329,13 +322,14 @@ void lib_ring_buffer_check_deliver(const struct lttng_ust_lib_ring_buffer_config
  * useful for crash dump.
  */
 static inline
-void lib_ring_buffer_write_commit_counter(const struct lttng_ust_lib_ring_buffer_config *config,
-                                         struct lttng_ust_lib_ring_buffer *buf,
-                                         struct channel *chan,
-                                         unsigned long buf_offset,
-                                         unsigned long commit_count,
-                                         struct lttng_ust_shm_handle *handle,
-                                         struct commit_counters_hot *cc_hot)
+void lib_ring_buffer_write_commit_counter(
+               const struct lttng_ust_lib_ring_buffer_config *config,
+               struct lttng_ust_lib_ring_buffer *buf __attribute__((unused)),
+               struct lttng_ust_lib_ring_buffer_channel *chan,
+               unsigned long buf_offset,
+               unsigned long commit_count,
+               struct lttng_ust_shm_handle *handle __attribute__((unused)),
+               struct commit_counters_hot *cc_hot)
 {
        unsigned long commit_seq_old;
 
@@ -359,11 +353,15 @@ void lib_ring_buffer_write_commit_counter(const struct lttng_ust_lib_ring_buffer
 extern int lib_ring_buffer_create(struct lttng_ust_lib_ring_buffer *buf,
                                  struct channel_backend *chanb, int cpu,
                                  struct lttng_ust_shm_handle *handle,
-                                 struct shm_object *shmobj);
+                                 struct shm_object *shmobj)
+       __attribute__((visibility("hidden")));
+
 extern void lib_ring_buffer_free(struct lttng_ust_lib_ring_buffer *buf,
-                                struct lttng_ust_shm_handle *handle);
+                                struct lttng_ust_shm_handle *handle)
+       __attribute__((visibility("hidden")));
 
 /* Keep track of trap nesting inside ring buffer code */
-extern DECLARE_URCU_TLS(unsigned int, lib_ring_buffer_nesting);
+extern DECLARE_URCU_TLS(unsigned int, lib_ring_buffer_nesting)
+       __attribute__((visibility("hidden")));
 
 #endif /* _LTTNG_RING_BUFFER_FRONTEND_INTERNAL_H */
This page took 0.025358 seconds and 4 git commands to generate.