X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=libringbuffer%2Ffrontend.h;h=b1ccddec1e8bfd3367a53f08714f5f153ed4a9b4;hb=abcabd6a23a42744beb0a80afee4104b690f23aa;hp=e1d9d575599e2baee592ccbe87b4c45097c2bf3d;hpb=4cfec15c93af7e0cfe3ce769ee90486bb8ab7c37;p=lttng-ust.git

diff --git a/libringbuffer/frontend.h b/libringbuffer/frontend.h
index e1d9d575..b1ccddec 100644
--- a/libringbuffer/frontend.h
+++ b/libringbuffer/frontend.h
@@ -1,19 +1,32 @@
-#ifndef _LINUX_RING_BUFFER_FRONTEND_H
-#define _LINUX_RING_BUFFER_FRONTEND_H
+#ifndef _LTTNG_RING_BUFFER_FRONTEND_H
+#define _LTTNG_RING_BUFFER_FRONTEND_H
 
 /*
- * linux/ringbuffer/frontend.h
- *
- * (C) Copyright 2005-2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * libringbuffer/frontend.h
  *
  * Ring Buffer Library Synchronization Header (API).
  *
+ * 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>
  *
  * See ring_buffer_frontend.c for more information on wait-free algorithms.
- *
- * Dual LGPL v2.1/GPL v2 license.
  */
 
 #include <urcu/compiler.h>
@@ -34,17 +47,26 @@
  * 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.
  */
 
 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);
+				int **shm_fd, int **wait_fd,
+				uint64_t **memory_map_size);
 
 /* channel_handle_create - for consumer. */
 extern
@@ -57,12 +79,11 @@ int channel_handle_add_stream(struct lttng_ust_shm_handle *handle,
 		int shm_fd, int wait_fd, uint64_t memory_map_size);
 
 /*
- * 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.
  */
 extern
-void *channel_destroy(struct channel *chan, struct lttng_ust_shm_handle *handle,
+void channel_destroy(struct channel *chan, struct lttng_ust_shm_handle *handle,
 		int shadow);
 
 
@@ -81,8 +102,8 @@ 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,
-				uint64_t *memory_map_size);
+				int **shm_fd, int **wait_fd,
+				uint64_t **memory_map_size);
 extern int lib_ring_buffer_open_read(struct lttng_ust_lib_ring_buffer *buf,
 				     struct lttng_ust_shm_handle *handle,
 				     int shadow);
@@ -236,4 +257,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 */