X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=lttng-abi.h;h=b414549cbacb48de2e31d524281d9ccce8805fcb;hb=fa83eadcc704bb7446c1adc2e4f5244e17a4be4d;hp=e23393ff9e0a28b183f1c143dbfc2f9a1b7256c6;hpb=6cdc77f6f9d680b780e2eea0d1b09b289da675e2;p=lttng-modules.git

diff --git a/lttng-abi.h b/lttng-abi.h
index e23393ff..b414549c 100644
--- a/lttng-abi.h
+++ b/lttng-abi.h
@@ -30,7 +30,7 @@
  * should be increased when an incompatible ABI change is done.
  */
 #define LTTNG_MODULES_ABI_MAJOR_VERSION		2
-#define LTTNG_MODULES_ABI_MINOR_VERSION		1
+#define LTTNG_MODULES_ABI_MINOR_VERSION		2
 
 #define LTTNG_KERNEL_SYM_NAME_LEN	256
 
@@ -197,8 +197,15 @@ struct lttng_kernel_filter_bytecode {
 	_IOR(0xF6, 0x58, int32_t)
 #define LTTNG_KERNEL_SESSION_UNTRACK_PID	\
 	_IOR(0xF6, 0x59, int32_t)
+/*
+ * ioctl 0x58 and 0x59 are duplicated here. It works, since _IOR vs _IO
+ * are generating two different ioctl numbers, but this was not done on
+ * purpose. We should generally try to avoid those duplications.
+ */
 #define LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS	_IO(0xF6, 0x58)
 #define LTTNG_KERNEL_SESSION_METADATA_REGEN	_IO(0xF6, 0x59)
+/* 0x5A and 0x5B are reserved for a future ABI-breaking cleanup. */
+#define LTTNG_KERNEL_SESSION_STATEDUMP		_IO(0xF6, 0x5C)
 
 /* Channel FD ioctl */
 #define LTTNG_KERNEL_STREAM			_IO(0xF6, 0x62)
@@ -218,24 +225,30 @@ struct lttng_kernel_filter_bytecode {
 /* Event FD ioctl */
 #define LTTNG_KERNEL_FILTER			_IO(0xF6, 0x90)
 
-/* LTTng-specific ioctls for the lib ringbuffer */
+/*
+ * LTTng-specific ioctls for the lib ringbuffer.
+ *
+ * Operations applying to the current sub-buffer need to occur between
+ * a get/put or get_next/put_next ioctl pair.
+ */
+
 /* returns the timestamp begin of the current sub-buffer */
 #define LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN	_IOR(0xF6, 0x20, uint64_t)
 /* returns the timestamp end of the current sub-buffer */
 #define LTTNG_RING_BUFFER_GET_TIMESTAMP_END	_IOR(0xF6, 0x21, uint64_t)
-/* returns the number of events discarded */
+/* returns the number of events discarded of the current sub-buffer */
 #define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED	_IOR(0xF6, 0x22, uint64_t)
-/* returns the packet payload size */
+/* returns the packet payload size of the current sub-buffer */
 #define LTTNG_RING_BUFFER_GET_CONTENT_SIZE	_IOR(0xF6, 0x23, uint64_t)
-/* returns the actual packet size */
+/* returns the packet size of the current sub-buffer*/
 #define LTTNG_RING_BUFFER_GET_PACKET_SIZE	_IOR(0xF6, 0x24, uint64_t)
-/* returns the stream id */
+/* returns the stream id (invariant for the stream) */
 #define LTTNG_RING_BUFFER_GET_STREAM_ID		_IOR(0xF6, 0x25, uint64_t)
-/* returns the current timestamp */
+/* returns the current timestamp as perceived from the tracer */
 #define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP	_IOR(0xF6, 0x26, uint64_t)
-/* returns the packet sequence number */
+/* returns the packet sequence number of the current sub-buffer */
 #define LTTNG_RING_BUFFER_GET_SEQ_NUM		_IOR(0xF6, 0x27, uint64_t)
-/* returns the stream instance id */
+/* returns the stream instance id (invariant for the stream) */
 #define LTTNG_RING_BUFFER_INSTANCE_ID		_IOR(0xF6, 0x28, uint64_t)
 
 #ifdef CONFIG_COMPAT
@@ -245,25 +258,25 @@ struct lttng_kernel_filter_bytecode {
 /* returns the timestamp end of the current sub-buffer */
 #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END \
 	LTTNG_RING_BUFFER_GET_TIMESTAMP_END
-/* returns the number of events discarded */
+/* returns the number of events discarded of the current sub-buffer */
 #define LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED \
 	LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED
-/* returns the packet payload size */
+/* returns the packet payload size of the current sub-buffer */
 #define LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE \
 	LTTNG_RING_BUFFER_GET_CONTENT_SIZE
-/* returns the actual packet size */
+/* returns the packet size of the current sub-buffer */
 #define LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE \
 	LTTNG_RING_BUFFER_GET_PACKET_SIZE
-/* returns the stream id */
+/* returns the stream id (invariant for the stream) */
 #define LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID \
 	LTTNG_RING_BUFFER_GET_STREAM_ID
-/* returns the current timestamp */
+/* returns the current timestamp as perceived from the tracer */
 #define LTTNG_RING_BUFFER_COMPAT_GET_CURRENT_TIMESTAMP \
 	LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
-/* returns the packet sequence number */
+/* returns the packet sequence number of the current sub-buffer */
 #define LTTNG_RING_BUFFER_COMPAT_GET_SEQ_NUM	\
 	LTTNG_RING_BUFFER_GET_SEQ_NUM
-/* returns the stream instance id */
+/* returns the stream instance id (invariant for the stream) */
 #define LTTNG_RING_BUFFER_COMPAT_INSTANCE_ID	\
 	LTTNG_RING_BUFFER_INSTANCE_ID
 #endif /* CONFIG_COMPAT */