Cleanup libkernelctl API

[lttng-tools.git] / libkernelctl / libkernelctl.h

diff --git a/libkernelctl/libkernelctl.h b/libkernelctl/libkernelctl.h
index 026f58d21df89de12faf9b552cd6672d4a7cba47..783f1258d86a273f6f1fb87d6bfb9f60bb8f3b4f 100644 (file)
--- a/libkernelctl/libkernelctl.h
+++ b/libkernelctl/libkernelctl.h
@@ -24,32 +24,48 @@
 
 #include "lttng-kernel.h"
 
-int kernctl_add_context(int fd, struct lttng_kernel_context *ctx);
-int kernctl_buffer_flush(int fd);
+int kernctl_create_session(int fd);
+int kernctl_open_metadata(int fd, struct lttng_channel_attr *chops);
 int kernctl_create_channel(int fd, struct lttng_channel_attr *chops);
+int kernctl_create_stream(int fd);
 int kernctl_create_event(int fd, struct lttng_kernel_event *ev);
+int kernctl_add_context(int fd, struct lttng_kernel_context *ctx);
+
 int kernctl_enable(int fd);
 int kernctl_disable(int fd);
-int kernctl_create_session(int fd);
-int kernctl_create_stream(int fd);
-int kernctl_get_max_subbuf_size(int fd, unsigned long *len);
-int kernctl_get_mmap_len(int fd, unsigned long *len);
-int kernctl_get_mmap_read_offset(int fd, unsigned long *len);
-int kernctl_get_next_subbuf(int fd);
-int kernctl_get_padded_subbuf_size(int fd, unsigned long *len);
-int kernctl_get_subbuf(int fd, unsigned long *len);
-int kernctl_get_subbuf_size(int fd, unsigned long *len);
-int kernctl_open_metadata(int fd, struct lttng_channel_attr *chops);
-int kernctl_put_next_subbuf(int fd);
-int kernctl_put_subbuf(int fd);
-int kernctl_snapshot(int fd);
-int kernctl_snapshot_get_consumed(int fd, unsigned long *len);
-int kernctl_snapshot_get_produced(int fd, unsigned long *len);
 int kernctl_start_session(int fd);
 int kernctl_stop_session(int fd);
+
 int kernctl_tracepoint_list(int fd);
 int kernctl_tracer_version(int fd, struct lttng_kernel_tracer_version *v);
 int kernctl_wait_quiescent(int fd);
 int kernctl_calibrate(int fd, struct lttng_kernel_calibrate *calibrate);
 
+
+/* Buffer operations */
+
+/* For mmap mode, readable without "get" operation */
+int kernctl_get_mmap_len(int fd, unsigned long *len);
+int kernctl_get_max_subbuf_size(int fd, unsigned long *len);
+
+/*
+ * For mmap mode, operate on the current packet (between get/put or
+ * get_next/put_next).
+ */
+int kernctl_get_mmap_read_offset(int fd, unsigned long *len);
+int kernctl_get_subbuf_size(int fd, unsigned long *len);
+int kernctl_get_padded_subbuf_size(int fd, unsigned long *len);
+
+int kernctl_get_next_subbuf(int fd);
+int kernctl_put_next_subbuf(int fd);
+
+/* snapshot */
+int kernctl_snapshot(int fd);
+int kernctl_snapshot_get_consumed(int fd, unsigned long *pos);
+int kernctl_snapshot_get_produced(int fd, unsigned long *pos);
+int kernctl_get_subbuf(int fd, unsigned long *pos);
+int kernctl_put_subbuf(int fd);
+
+int kernctl_buffer_flush(int fd);
+
 #endif /* _LTT_LIBKERNELCTL_H */