lttng-abi: Document ioctl numbers reserved by lttng-abi-old.h
[lttng-modules.git] / lttng-abi.h
index dac8658479f52d8079982f742a4bb425a808c10c..9d345f4a7c841fe683e5872ee2eb6eeb958a176d 100644 (file)
@@ -1,28 +1,15 @@
-#ifndef _LTTNG_ABI_H
-#define _LTTNG_ABI_H
-
-/*
+/* SPDX-License-Identifier: (GPL-2.0 or LGPL-2.1)
+ *
  * lttng-abi.h
  *
  * LTTng ABI header
  *
  * Copyright (C) 2010-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
  */
 
+#ifndef _LTTNG_ABI_H
+#define _LTTNG_ABI_H
+
 #include <linux/fs.h>
 
 /*
  * should be increased when an incompatible ABI change is done.
  */
 #define LTTNG_MODULES_ABI_MAJOR_VERSION                2
-#define LTTNG_MODULES_ABI_MINOR_VERSION                3
+#define LTTNG_MODULES_ABI_MINOR_VERSION                4
 
 #define LTTNG_KERNEL_SYM_NAME_LEN      256
+#define LTTNG_KERNEL_SESSION_NAME_LEN  256
+#define LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN 26
 
 enum lttng_kernel_instrumentation {
        LTTNG_KERNEL_TRACEPOINT = 0,
@@ -41,6 +30,7 @@ enum lttng_kernel_instrumentation {
        LTTNG_KERNEL_KRETPROBE  = 3,
        LTTNG_KERNEL_NOOP       = 4,    /* not hooked */
        LTTNG_KERNEL_SYSCALL    = 5,
+       LTTNG_KERNEL_UPROBE     = 6,
 };
 
 /*
@@ -86,6 +76,20 @@ struct lttng_kernel_function_tracer {
        char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
 } __attribute__((packed));
 
+struct lttng_kernel_uprobe {
+       int fd;
+} __attribute__((packed));
+
+struct lttng_kernel_event_callsite_uprobe {
+       uint64_t offset;
+} __attribute__((packed));
+
+struct lttng_kernel_event_callsite {
+       union {
+               struct lttng_kernel_event_callsite_uprobe uprobe;
+       } u;
+} __attribute__((packed));
+
 /*
  * For syscall tracing, name = "*" means "enable all".
  */
@@ -101,6 +105,7 @@ struct lttng_kernel_event {
                struct lttng_kernel_kretprobe kretprobe;
                struct lttng_kernel_kprobe kprobe;
                struct lttng_kernel_function_tracer ftrace;
+               struct lttng_kernel_uprobe uprobe;
                char padding[LTTNG_KERNEL_EVENT_PADDING2];
        } u;
 } __attribute__((packed));
@@ -116,6 +121,14 @@ struct lttng_kernel_tracer_abi_version {
        uint32_t minor;
 } __attribute__((packed));
 
+struct lttng_kernel_session_name {
+       char name[LTTNG_KERNEL_SESSION_NAME_LEN];
+} __attribute__((packed));
+
+struct lttng_kernel_session_creation_time {
+       char iso8601[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN];
+} __attribute__((packed));
+
 enum lttng_kernel_calibrate_type {
        LTTNG_KERNEL_CALIBRATE_KRETPROBE,
 };
@@ -146,6 +159,27 @@ enum lttng_kernel_context_type {
        LTTNG_KERNEL_CONTEXT_PREEMPTIBLE        = 13,
        LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE    = 14,
        LTTNG_KERNEL_CONTEXT_MIGRATABLE         = 15,
+       LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL   = 16,
+       LTTNG_KERNEL_CONTEXT_CALLSTACK_USER     = 17,
+       LTTNG_KERNEL_CONTEXT_CGROUP_NS          = 18,
+       LTTNG_KERNEL_CONTEXT_IPC_NS             = 19,
+       LTTNG_KERNEL_CONTEXT_MNT_NS             = 20,
+       LTTNG_KERNEL_CONTEXT_NET_NS             = 21,
+       LTTNG_KERNEL_CONTEXT_PID_NS             = 22,
+       LTTNG_KERNEL_CONTEXT_USER_NS            = 23,
+       LTTNG_KERNEL_CONTEXT_UTS_NS             = 24,
+       LTTNG_KERNEL_CONTEXT_UID                = 25,
+       LTTNG_KERNEL_CONTEXT_EUID               = 26,
+       LTTNG_KERNEL_CONTEXT_SUID               = 27,
+       LTTNG_KERNEL_CONTEXT_GID                = 28,
+       LTTNG_KERNEL_CONTEXT_EGID               = 29,
+       LTTNG_KERNEL_CONTEXT_SGID               = 30,
+       LTTNG_KERNEL_CONTEXT_VUID               = 31,
+       LTTNG_KERNEL_CONTEXT_VEUID              = 32,
+       LTTNG_KERNEL_CONTEXT_VSUID              = 33,
+       LTTNG_KERNEL_CONTEXT_VGID               = 34,
+       LTTNG_KERNEL_CONTEXT_VEGID              = 35,
+       LTTNG_KERNEL_CONTEXT_VSGID              = 36,
 };
 
 struct lttng_kernel_perf_counter_ctx {
@@ -175,6 +209,7 @@ struct lttng_kernel_filter_bytecode {
 } __attribute__((packed));
 
 /* LTTng file descriptor ioctl */
+/* lttng-abi-old.h reserve 0x40, 0x41, 0x42, 0x43, and 0x44. */
 #define LTTNG_KERNEL_SESSION                   _IO(0xF6, 0x45)
 #define LTTNG_KERNEL_TRACER_VERSION            \
        _IOR(0xF6, 0x46, struct lttng_kernel_tracer_version)
@@ -187,6 +222,7 @@ struct lttng_kernel_filter_bytecode {
        _IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version)
 
 /* Session FD ioctl */
+/* lttng-abi-old.h reserve 0x50, 0x51, 0x52, and 0x53. */
 #define LTTNG_KERNEL_METADATA                  \
        _IOW(0xF6, 0x54, struct lttng_kernel_channel)
 #define LTTNG_KERNEL_CHANNEL                   \
@@ -204,10 +240,16 @@ struct lttng_kernel_filter_bytecode {
  */
 #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. */
+
+/* lttng-abi-old.h reserve 0x5A and 0x5B. */
 #define LTTNG_KERNEL_SESSION_STATEDUMP         _IO(0xF6, 0x5C)
+#define LTTNG_KERNEL_SESSION_SET_NAME          \
+       _IOR(0xF6, 0x5D, struct lttng_kernel_session_name)
+#define LTTNG_KERNEL_SESSION_SET_CREATION_TIME         \
+       _IOR(0xF6, 0x5E, struct lttng_kernel_session_creation_time)
 
 /* Channel FD ioctl */
+/* lttng-abi-old.h reserve 0x60 and 0x61. */
 #define LTTNG_KERNEL_STREAM                    _IO(0xF6, 0x62)
 #define LTTNG_KERNEL_EVENT                     \
        _IOW(0xF6, 0x63, struct lttng_kernel_event)
@@ -215,34 +257,43 @@ struct lttng_kernel_filter_bytecode {
        _IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask)
 
 /* Event and Channel FD ioctl */
+/* lttng-abi-old.h reserve 0x70. */
 #define LTTNG_KERNEL_CONTEXT                   \
        _IOW(0xF6, 0x71, struct lttng_kernel_context)
 
 /* Event, Channel and Session ioctl */
+/* lttng-abi-old.h reserve 0x80 and 0x81. */
 #define LTTNG_KERNEL_ENABLE                    _IO(0xF6, 0x82)
 #define LTTNG_KERNEL_DISABLE                   _IO(0xF6, 0x83)
 
 /* Event FD ioctl */
 #define LTTNG_KERNEL_FILTER                    _IO(0xF6, 0x90)
+#define LTTNG_KERNEL_ADD_CALLSITE              _IO(0xF6, 0x91)
+
+/*
+ * 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.
+ */
 
-/* LTTng-specific ioctls for the lib ringbuffer */
 /* 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
@@ -252,25 +303,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 */
This page took 0.027115 seconds and 4 git commands to generate.