Document last supported kernel version for stable-2.10 branch

[lttng-modules.git] / lttng-abi.h

diff --git a/lttng-abi.h b/lttng-abi.h
index a40b58f51dec8487c3e3d5a3c6d1129faac65dc3..b1ccc619bfd55b0ec6cce4eece2d5bb7abbf60aa 100644 (file)
--- 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                0
+#define LTTNG_MODULES_ABI_MINOR_VERSION                3
 
 #define LTTNG_KERNEL_SYM_NAME_LEN      256
 
@@ -142,6 +142,10 @@ enum lttng_kernel_context_type {
        LTTNG_KERNEL_CONTEXT_VPPID              = 9,
        LTTNG_KERNEL_CONTEXT_HOSTNAME           = 10,
        LTTNG_KERNEL_CONTEXT_CPU_ID             = 11,
+       LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE      = 12,
+       LTTNG_KERNEL_CONTEXT_PREEMPTIBLE        = 13,
+       LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE    = 14,
+       LTTNG_KERNEL_CONTEXT_MIGRATABLE         = 15,
 };
 
 struct lttng_kernel_perf_counter_ctx {
@@ -193,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)
@@ -214,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
@@ -241,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 */