X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=libringbuffer%2Ffrontend.h;h=eb95e6225986a759df3e809be09ad6e955222d5a;hb=d028eddb5959160ef6ec4b09f786730910d0f8f8;hp=9fa0f04d2a67d0bf6e1b46a997755e8fc16ff64e;hpb=824f40b81426c6ac82685251018dae00947786a9;p=lttng-ust.git

diff --git a/libringbuffer/frontend.h b/libringbuffer/frontend.h
index 9fa0f04d..eb95e622 100644
--- a/libringbuffer/frontend.h
+++ b/libringbuffer/frontend.h
@@ -34,11 +34,20 @@
  * 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 shm_handle *channel_create(const struct lib_ring_buffer_config *config,
-				const char *name, void *priv,
+struct lttng_ust_shm_handle *channel_create(const struct lttng_ust_lib_ring_buffer_config *config,
+				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,
@@ -48,21 +57,20 @@ struct shm_handle *channel_create(const struct lib_ring_buffer_config *config,
 
 /* channel_handle_create - for consumer. */
 extern
-struct shm_handle *channel_handle_create(int shm_fd, int wait_fd,
+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 shm_handle *handle,
+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 shm_handle *handle,
+void channel_destroy(struct channel *chan, struct lttng_ust_shm_handle *handle,
 		int shadow);
 
 
@@ -77,42 +85,42 @@ void *channel_destroy(struct channel *chan, struct shm_handle *handle,
 #define for_each_channel_cpu(cpu, chan)					\
 	for_each_possible_cpu(cpu)
 
-extern struct lib_ring_buffer *channel_get_ring_buffer(
-				const struct lib_ring_buffer_config *config,
+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 shm_handle *handle,
+				struct lttng_ust_shm_handle *handle,
 				int *shm_fd, int *wait_fd,
 				uint64_t *memory_map_size);
-extern int lib_ring_buffer_open_read(struct lib_ring_buffer *buf,
-				     struct shm_handle *handle,
+extern int lib_ring_buffer_open_read(struct lttng_ust_lib_ring_buffer *buf,
+				     struct lttng_ust_shm_handle *handle,
 				     int shadow);
-extern void lib_ring_buffer_release_read(struct lib_ring_buffer *buf,
-					 struct shm_handle *handle,
+extern void lib_ring_buffer_release_read(struct lttng_ust_lib_ring_buffer *buf,
+					 struct lttng_ust_shm_handle *handle,
 					 int shadow);
 
 /*
  * Read sequence: snapshot, many get_subbuf/put_subbuf, move_consumer.
  */
-extern int lib_ring_buffer_snapshot(struct lib_ring_buffer *buf,
+extern int lib_ring_buffer_snapshot(struct lttng_ust_lib_ring_buffer *buf,
 				    unsigned long *consumed,
 				    unsigned long *produced,
-				    struct shm_handle *handle);
-extern void lib_ring_buffer_move_consumer(struct lib_ring_buffer *buf,
+				    struct lttng_ust_shm_handle *handle);
+extern void lib_ring_buffer_move_consumer(struct lttng_ust_lib_ring_buffer *buf,
 					  unsigned long consumed_new,
-					  struct shm_handle *handle);
+					  struct lttng_ust_shm_handle *handle);
 
-extern int lib_ring_buffer_get_subbuf(struct lib_ring_buffer *buf,
+extern int lib_ring_buffer_get_subbuf(struct lttng_ust_lib_ring_buffer *buf,
 				      unsigned long consumed,
-				      struct shm_handle *handle);
-extern void lib_ring_buffer_put_subbuf(struct lib_ring_buffer *buf,
-				       struct shm_handle *handle);
+				      struct lttng_ust_shm_handle *handle);
+extern void lib_ring_buffer_put_subbuf(struct lttng_ust_lib_ring_buffer *buf,
+				       struct lttng_ust_shm_handle *handle);
 
 /*
  * lib_ring_buffer_get_next_subbuf/lib_ring_buffer_put_next_subbuf are helpers
  * to read sub-buffers sequentially.
  */
-static inline int lib_ring_buffer_get_next_subbuf(struct lib_ring_buffer *buf,
-						  struct shm_handle *handle)
+static inline int lib_ring_buffer_get_next_subbuf(struct lttng_ust_lib_ring_buffer *buf,
+						  struct lttng_ust_shm_handle *handle)
 {
 	int ret;
 
@@ -125,8 +133,8 @@ static inline int lib_ring_buffer_get_next_subbuf(struct lib_ring_buffer *buf,
 }
 
 static inline
-void lib_ring_buffer_put_next_subbuf(struct lib_ring_buffer *buf,
-				     struct shm_handle *handle)
+void lib_ring_buffer_put_next_subbuf(struct lttng_ust_lib_ring_buffer *buf,
+				     struct lttng_ust_shm_handle *handle)
 {
 	lib_ring_buffer_put_subbuf(buf, handle);
 	lib_ring_buffer_move_consumer(buf, subbuf_align(buf->cons_snapshot,
@@ -134,19 +142,19 @@ void lib_ring_buffer_put_next_subbuf(struct lib_ring_buffer *buf,
 }
 
 extern void channel_reset(struct channel *chan);
-extern void lib_ring_buffer_reset(struct lib_ring_buffer *buf,
-				  struct shm_handle *handle);
+extern void lib_ring_buffer_reset(struct lttng_ust_lib_ring_buffer *buf,
+				  struct lttng_ust_shm_handle *handle);
 
 static inline
-unsigned long lib_ring_buffer_get_offset(const struct lib_ring_buffer_config *config,
-					 struct lib_ring_buffer *buf)
+unsigned long lib_ring_buffer_get_offset(const struct lttng_ust_lib_ring_buffer_config *config,
+					 struct lttng_ust_lib_ring_buffer *buf)
 {
 	return v_read(config, &buf->offset);
 }
 
 static inline
-unsigned long lib_ring_buffer_get_consumed(const struct lib_ring_buffer_config *config,
-					   struct lib_ring_buffer *buf)
+unsigned long lib_ring_buffer_get_consumed(const struct lttng_ust_lib_ring_buffer_config *config,
+					   struct lttng_ust_lib_ring_buffer *buf)
 {
 	return uatomic_read(&buf->consumed);
 }
@@ -156,8 +164,8 @@ unsigned long lib_ring_buffer_get_consumed(const struct lib_ring_buffer_config *
  * ordering enforced with respect to trace teardown).
  */
 static inline
-int lib_ring_buffer_is_finalized(const struct lib_ring_buffer_config *config,
-				 struct lib_ring_buffer *buf)
+int lib_ring_buffer_is_finalized(const struct lttng_ust_lib_ring_buffer_config *config,
+				 struct lttng_ust_lib_ring_buffer *buf)
 {
 	int finalized = CMM_ACCESS_ONCE(buf->finalized);
 	/*
@@ -181,57 +189,57 @@ int lib_ring_buffer_channel_is_disabled(const struct channel *chan)
 
 static inline
 unsigned long lib_ring_buffer_get_read_data_size(
-				const struct lib_ring_buffer_config *config,
-				struct lib_ring_buffer *buf,
-				struct shm_handle *handle)
+				const struct lttng_ust_lib_ring_buffer_config *config,
+				struct lttng_ust_lib_ring_buffer *buf,
+				struct lttng_ust_shm_handle *handle)
 {
 	return subbuffer_get_read_data_size(config, &buf->backend, handle);
 }
 
 static inline
 unsigned long lib_ring_buffer_get_records_count(
-				const struct lib_ring_buffer_config *config,
-				struct lib_ring_buffer *buf)
+				const struct lttng_ust_lib_ring_buffer_config *config,
+				struct lttng_ust_lib_ring_buffer *buf)
 {
 	return v_read(config, &buf->records_count);
 }
 
 static inline
 unsigned long lib_ring_buffer_get_records_overrun(
-				const struct lib_ring_buffer_config *config,
-				struct lib_ring_buffer *buf)
+				const struct lttng_ust_lib_ring_buffer_config *config,
+				struct lttng_ust_lib_ring_buffer *buf)
 {
 	return v_read(config, &buf->records_overrun);
 }
 
 static inline
 unsigned long lib_ring_buffer_get_records_lost_full(
-				const struct lib_ring_buffer_config *config,
-				struct lib_ring_buffer *buf)
+				const struct lttng_ust_lib_ring_buffer_config *config,
+				struct lttng_ust_lib_ring_buffer *buf)
 {
 	return v_read(config, &buf->records_lost_full);
 }
 
 static inline
 unsigned long lib_ring_buffer_get_records_lost_wrap(
-				const struct lib_ring_buffer_config *config,
-				struct lib_ring_buffer *buf)
+				const struct lttng_ust_lib_ring_buffer_config *config,
+				struct lttng_ust_lib_ring_buffer *buf)
 {
 	return v_read(config, &buf->records_lost_wrap);
 }
 
 static inline
 unsigned long lib_ring_buffer_get_records_lost_big(
-				const struct lib_ring_buffer_config *config,
-				struct lib_ring_buffer *buf)
+				const struct lttng_ust_lib_ring_buffer_config *config,
+				struct lttng_ust_lib_ring_buffer *buf)
 {
 	return v_read(config, &buf->records_lost_big);
 }
 
 static inline
 unsigned long lib_ring_buffer_get_records_read(
-				const struct lib_ring_buffer_config *config,
-				struct lib_ring_buffer *buf)
+				const struct lttng_ust_lib_ring_buffer_config *config,
+				struct lttng_ust_lib_ring_buffer *buf)
 {
 	return v_read(config, &buf->backend.records_read);
 }