1 /* SPDX-License-Identifier: (GPL-2.0 or LGPL-2.1)
7 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
16 * Major/minor version of ABI exposed to lttng tools. Major number
17 * should be increased when an incompatible ABI change is done.
19 #define LTTNG_MODULES_ABI_MAJOR_VERSION 2
20 #define LTTNG_MODULES_ABI_MINOR_VERSION 4
22 #define LTTNG_KERNEL_SYM_NAME_LEN 256
23 #define LTTNG_KERNEL_SESSION_NAME_LEN 256
24 #define LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN 26
26 enum lttng_kernel_instrumentation
{
27 LTTNG_KERNEL_TRACEPOINT
= 0,
28 LTTNG_KERNEL_KPROBE
= 1,
29 LTTNG_KERNEL_FUNCTION
= 2,
30 LTTNG_KERNEL_KRETPROBE
= 3,
31 LTTNG_KERNEL_NOOP
= 4, /* not hooked */
32 LTTNG_KERNEL_SYSCALL
= 5,
33 LTTNG_KERNEL_UPROBE
= 6,
39 enum lttng_kernel_output
{
40 LTTNG_KERNEL_SPLICE
= 0,
41 LTTNG_KERNEL_MMAP
= 1,
45 * LTTng DebugFS ABI structures.
47 #define LTTNG_KERNEL_CHANNEL_PADDING LTTNG_KERNEL_SYM_NAME_LEN + 32
48 struct lttng_kernel_channel
{
49 uint64_t subbuf_size
; /* in bytes */
51 unsigned int switch_timer_interval
; /* usecs */
52 unsigned int read_timer_interval
; /* usecs */
53 enum lttng_kernel_output output
; /* splice, mmap */
54 int overwrite
; /* 1: overwrite, 0: discard */
55 char padding
[LTTNG_KERNEL_CHANNEL_PADDING
];
56 } __attribute__((packed
));
58 struct lttng_kernel_kretprobe
{
62 char symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
];
63 } __attribute__((packed
));
66 * Either addr is used, or symbol_name and offset.
68 struct lttng_kernel_kprobe
{
72 char symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
];
73 } __attribute__((packed
));
75 struct lttng_kernel_function_tracer
{
76 char symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
];
77 } __attribute__((packed
));
79 struct lttng_kernel_uprobe
{
81 } __attribute__((packed
));
83 struct lttng_kernel_event_callsite_uprobe
{
85 } __attribute__((packed
));
87 struct lttng_kernel_event_callsite
{
89 struct lttng_kernel_event_callsite_uprobe uprobe
;
91 } __attribute__((packed
));
94 * For syscall tracing, name = "*" means "enable all".
96 #define LTTNG_KERNEL_EVENT_PADDING1 16
97 #define LTTNG_KERNEL_EVENT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
98 struct lttng_kernel_event
{
99 char name
[LTTNG_KERNEL_SYM_NAME_LEN
]; /* event name */
100 enum lttng_kernel_instrumentation instrumentation
;
101 char padding
[LTTNG_KERNEL_EVENT_PADDING1
];
103 /* Per instrumentation type configuration */
105 struct lttng_kernel_kretprobe kretprobe
;
106 struct lttng_kernel_kprobe kprobe
;
107 struct lttng_kernel_function_tracer ftrace
;
108 struct lttng_kernel_uprobe uprobe
;
109 char padding
[LTTNG_KERNEL_EVENT_PADDING2
];
111 } __attribute__((packed
));
113 struct lttng_kernel_tracer_version
{
117 } __attribute__((packed
));
119 struct lttng_kernel_tracer_abi_version
{
122 } __attribute__((packed
));
124 struct lttng_kernel_session_name
{
125 char name
[LTTNG_KERNEL_SESSION_NAME_LEN
];
126 } __attribute__((packed
));
128 struct lttng_kernel_session_creation_time
{
129 char iso8601
[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN
];
130 } __attribute__((packed
));
132 enum lttng_kernel_calibrate_type
{
133 LTTNG_KERNEL_CALIBRATE_KRETPROBE
,
136 struct lttng_kernel_calibrate
{
137 enum lttng_kernel_calibrate_type type
; /* type (input) */
138 } __attribute__((packed
));
140 struct lttng_kernel_syscall_mask
{
141 uint32_t len
; /* in bits */
143 } __attribute__((packed
));
145 enum lttng_kernel_context_type
{
146 LTTNG_KERNEL_CONTEXT_PID
= 0,
147 LTTNG_KERNEL_CONTEXT_PERF_COUNTER
= 1,
148 LTTNG_KERNEL_CONTEXT_PROCNAME
= 2,
149 LTTNG_KERNEL_CONTEXT_PRIO
= 3,
150 LTTNG_KERNEL_CONTEXT_NICE
= 4,
151 LTTNG_KERNEL_CONTEXT_VPID
= 5,
152 LTTNG_KERNEL_CONTEXT_TID
= 6,
153 LTTNG_KERNEL_CONTEXT_VTID
= 7,
154 LTTNG_KERNEL_CONTEXT_PPID
= 8,
155 LTTNG_KERNEL_CONTEXT_VPPID
= 9,
156 LTTNG_KERNEL_CONTEXT_HOSTNAME
= 10,
157 LTTNG_KERNEL_CONTEXT_CPU_ID
= 11,
158 LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE
= 12,
159 LTTNG_KERNEL_CONTEXT_PREEMPTIBLE
= 13,
160 LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE
= 14,
161 LTTNG_KERNEL_CONTEXT_MIGRATABLE
= 15,
162 LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL
= 16,
163 LTTNG_KERNEL_CONTEXT_CALLSTACK_USER
= 17,
164 LTTNG_KERNEL_CONTEXT_CGROUP_NS
= 18,
165 LTTNG_KERNEL_CONTEXT_IPC_NS
= 19,
166 LTTNG_KERNEL_CONTEXT_MNT_NS
= 20,
167 LTTNG_KERNEL_CONTEXT_NET_NS
= 21,
168 LTTNG_KERNEL_CONTEXT_PID_NS
= 22,
169 LTTNG_KERNEL_CONTEXT_USER_NS
= 23,
170 LTTNG_KERNEL_CONTEXT_UTS_NS
= 24,
173 struct lttng_kernel_perf_counter_ctx
{
176 char name
[LTTNG_KERNEL_SYM_NAME_LEN
];
177 } __attribute__((packed
));
179 #define LTTNG_KERNEL_CONTEXT_PADDING1 16
180 #define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
181 struct lttng_kernel_context
{
182 enum lttng_kernel_context_type ctx
;
183 char padding
[LTTNG_KERNEL_CONTEXT_PADDING1
];
186 struct lttng_kernel_perf_counter_ctx perf_counter
;
187 char padding
[LTTNG_KERNEL_CONTEXT_PADDING2
];
189 } __attribute__((packed
));
191 #define LTTNG_KERNEL_FILTER_BYTECODE_MAX_LEN 65536
192 struct lttng_kernel_filter_bytecode
{
194 uint32_t reloc_offset
;
197 } __attribute__((packed
));
199 /* LTTng file descriptor ioctl */
200 #define LTTNG_KERNEL_SESSION _IO(0xF6, 0x45)
201 #define LTTNG_KERNEL_TRACER_VERSION \
202 _IOR(0xF6, 0x46, struct lttng_kernel_tracer_version)
203 #define LTTNG_KERNEL_TRACEPOINT_LIST _IO(0xF6, 0x47)
204 #define LTTNG_KERNEL_WAIT_QUIESCENT _IO(0xF6, 0x48)
205 #define LTTNG_KERNEL_CALIBRATE \
206 _IOWR(0xF6, 0x49, struct lttng_kernel_calibrate)
207 #define LTTNG_KERNEL_SYSCALL_LIST _IO(0xF6, 0x4A)
208 #define LTTNG_KERNEL_TRACER_ABI_VERSION \
209 _IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version)
211 /* Session FD ioctl */
212 #define LTTNG_KERNEL_METADATA \
213 _IOW(0xF6, 0x54, struct lttng_kernel_channel)
214 #define LTTNG_KERNEL_CHANNEL \
215 _IOW(0xF6, 0x55, struct lttng_kernel_channel)
216 #define LTTNG_KERNEL_SESSION_START _IO(0xF6, 0x56)
217 #define LTTNG_KERNEL_SESSION_STOP _IO(0xF6, 0x57)
218 #define LTTNG_KERNEL_SESSION_TRACK_PID \
219 _IOR(0xF6, 0x58, int32_t)
220 #define LTTNG_KERNEL_SESSION_UNTRACK_PID \
221 _IOR(0xF6, 0x59, int32_t)
223 * ioctl 0x58 and 0x59 are duplicated here. It works, since _IOR vs _IO
224 * are generating two different ioctl numbers, but this was not done on
225 * purpose. We should generally try to avoid those duplications.
227 #define LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS _IO(0xF6, 0x58)
228 #define LTTNG_KERNEL_SESSION_METADATA_REGEN _IO(0xF6, 0x59)
230 /* 0x5A and 0x5B are reserved for a future ABI-breaking cleanup. */
231 #define LTTNG_KERNEL_SESSION_STATEDUMP _IO(0xF6, 0x5C)
232 #define LTTNG_KERNEL_SESSION_SET_NAME \
233 _IOR(0xF6, 0x5D, struct lttng_kernel_session_name)
234 #define LTTNG_KERNEL_SESSION_SET_CREATION_TIME \
235 _IOR(0xF6, 0x5E, struct lttng_kernel_session_creation_time)
237 /* Channel FD ioctl */
238 #define LTTNG_KERNEL_STREAM _IO(0xF6, 0x62)
239 #define LTTNG_KERNEL_EVENT \
240 _IOW(0xF6, 0x63, struct lttng_kernel_event)
241 #define LTTNG_KERNEL_SYSCALL_MASK \
242 _IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask)
244 /* Event and Channel FD ioctl */
245 #define LTTNG_KERNEL_CONTEXT \
246 _IOW(0xF6, 0x71, struct lttng_kernel_context)
248 /* Event, Channel and Session ioctl */
249 #define LTTNG_KERNEL_ENABLE _IO(0xF6, 0x82)
250 #define LTTNG_KERNEL_DISABLE _IO(0xF6, 0x83)
253 #define LTTNG_KERNEL_FILTER _IO(0xF6, 0x90)
254 #define LTTNG_KERNEL_ADD_CALLSITE _IO(0xF6, 0x91)
257 * LTTng-specific ioctls for the lib ringbuffer.
259 * Operations applying to the current sub-buffer need to occur between
260 * a get/put or get_next/put_next ioctl pair.
263 /* returns the timestamp begin of the current sub-buffer */
264 #define LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN _IOR(0xF6, 0x20, uint64_t)
265 /* returns the timestamp end of the current sub-buffer */
266 #define LTTNG_RING_BUFFER_GET_TIMESTAMP_END _IOR(0xF6, 0x21, uint64_t)
267 /* returns the number of events discarded of the current sub-buffer */
268 #define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED _IOR(0xF6, 0x22, uint64_t)
269 /* returns the packet payload size of the current sub-buffer */
270 #define LTTNG_RING_BUFFER_GET_CONTENT_SIZE _IOR(0xF6, 0x23, uint64_t)
271 /* returns the packet size of the current sub-buffer*/
272 #define LTTNG_RING_BUFFER_GET_PACKET_SIZE _IOR(0xF6, 0x24, uint64_t)
273 /* returns the stream id (invariant for the stream) */
274 #define LTTNG_RING_BUFFER_GET_STREAM_ID _IOR(0xF6, 0x25, uint64_t)
275 /* returns the current timestamp as perceived from the tracer */
276 #define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t)
277 /* returns the packet sequence number of the current sub-buffer */
278 #define LTTNG_RING_BUFFER_GET_SEQ_NUM _IOR(0xF6, 0x27, uint64_t)
279 /* returns the stream instance id (invariant for the stream) */
280 #define LTTNG_RING_BUFFER_INSTANCE_ID _IOR(0xF6, 0x28, uint64_t)
283 /* returns the timestamp begin of the current sub-buffer */
284 #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_BEGIN \
285 LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN
286 /* returns the timestamp end of the current sub-buffer */
287 #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END \
288 LTTNG_RING_BUFFER_GET_TIMESTAMP_END
289 /* returns the number of events discarded of the current sub-buffer */
290 #define LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED \
291 LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED
292 /* returns the packet payload size of the current sub-buffer */
293 #define LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE \
294 LTTNG_RING_BUFFER_GET_CONTENT_SIZE
295 /* returns the packet size of the current sub-buffer */
296 #define LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE \
297 LTTNG_RING_BUFFER_GET_PACKET_SIZE
298 /* returns the stream id (invariant for the stream) */
299 #define LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID \
300 LTTNG_RING_BUFFER_GET_STREAM_ID
301 /* returns the current timestamp as perceived from the tracer */
302 #define LTTNG_RING_BUFFER_COMPAT_GET_CURRENT_TIMESTAMP \
303 LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
304 /* returns the packet sequence number of the current sub-buffer */
305 #define LTTNG_RING_BUFFER_COMPAT_GET_SEQ_NUM \
306 LTTNG_RING_BUFFER_GET_SEQ_NUM
307 /* returns the stream instance id (invariant for the stream) */
308 #define LTTNG_RING_BUFFER_COMPAT_INSTANCE_ID \
309 LTTNG_RING_BUFFER_INSTANCE_ID
310 #endif /* CONFIG_COMPAT */
312 #endif /* _LTTNG_ABI_H */