1 /* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
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 5
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 uint32_t output
; /* enum lttng_kernel_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
));
93 enum lttng_kernel_syscall_entryexit
{
94 LTTNG_KERNEL_SYSCALL_ENTRYEXIT
= 0,
95 LTTNG_KERNEL_SYSCALL_ENTRY
= 1,
96 LTTNG_KERNEL_SYSCALL_EXIT
= 2,
99 enum lttng_kernel_syscall_abi
{
100 LTTNG_KERNEL_SYSCALL_ABI_ALL
= 0,
101 LTTNG_KERNEL_SYSCALL_ABI_NATIVE
= 1,
102 LTTNG_KERNEL_SYSCALL_ABI_COMPAT
= 2,
105 enum lttng_kernel_syscall_match
{
106 LTTNG_KERNEL_SYSCALL_MATCH_NAME
= 0,
107 LTTNG_KERNEL_SYSCALL_MATCH_NR
= 1, /* Not implemented. */
110 struct lttng_kernel_syscall
{
111 uint8_t entryexit
; /* enum lttng_kernel_syscall_entryexit */
112 uint8_t abi
; /* enum lttng_kernel_syscall_abi */
113 uint8_t match
; /* enum lttng_kernel_syscall_match */
115 uint32_t nr
; /* For LTTNG_SYSCALL_MATCH_NR */
116 } __attribute__((packed
));
119 * For syscall tracing, name = "*" means "enable all".
121 #define LTTNG_KERNEL_EVENT_PADDING1 8
122 #define LTTNG_KERNEL_EVENT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
123 struct lttng_kernel_event
{
124 char name
[LTTNG_KERNEL_SYM_NAME_LEN
]; /* event name */
125 uint32_t instrumentation
; /* enum lttng_kernel_instrumentation */
126 uint64_t token
; /* User-provided token */
127 char padding
[LTTNG_KERNEL_EVENT_PADDING1
];
129 /* Per instrumentation type configuration */
131 struct lttng_kernel_kretprobe kretprobe
;
132 struct lttng_kernel_kprobe kprobe
;
133 struct lttng_kernel_function_tracer ftrace
;
134 struct lttng_kernel_uprobe uprobe
;
135 struct lttng_kernel_syscall syscall
;
136 char padding
[LTTNG_KERNEL_EVENT_PADDING2
];
138 } __attribute__((packed
));
140 #define LTTNG_KERNEL_EVENT_NOTIFIER_PADDING1 16
141 struct lttng_kernel_event_notifier
{
142 struct lttng_kernel_event event
;
144 char padding
[LTTNG_KERNEL_EVENT_NOTIFIER_PADDING1
];
145 } __attribute__((packed
));
147 #define LTTNG_KERNEL_EVENT_NOTIFIER_NOTIFICATION_PADDING 32
148 struct lttng_kernel_event_notifier_notification
{
150 uint16_t capture_buf_size
;
151 char padding
[LTTNG_KERNEL_EVENT_NOTIFIER_NOTIFICATION_PADDING
];
152 } __attribute__((packed
));
154 struct lttng_kernel_tracer_version
{
158 } __attribute__((packed
));
160 struct lttng_kernel_tracer_abi_version
{
163 } __attribute__((packed
));
165 struct lttng_kernel_session_name
{
166 char name
[LTTNG_KERNEL_SESSION_NAME_LEN
];
167 } __attribute__((packed
));
169 struct lttng_kernel_session_creation_time
{
170 char iso8601
[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN
];
171 } __attribute__((packed
));
173 enum lttng_kernel_calibrate_type
{
174 LTTNG_KERNEL_CALIBRATE_KRETPROBE
,
177 struct lttng_kernel_calibrate
{
178 uint32_t type
; /* enum lttng_kernel_calibrate_type (input) */
179 } __attribute__((packed
));
181 struct lttng_kernel_syscall_mask
{
182 uint32_t len
; /* in bits */
184 } __attribute__((packed
));
186 enum lttng_kernel_context_type
{
187 LTTNG_KERNEL_CONTEXT_PID
= 0,
188 LTTNG_KERNEL_CONTEXT_PERF_COUNTER
= 1,
189 LTTNG_KERNEL_CONTEXT_PROCNAME
= 2,
190 LTTNG_KERNEL_CONTEXT_PRIO
= 3,
191 LTTNG_KERNEL_CONTEXT_NICE
= 4,
192 LTTNG_KERNEL_CONTEXT_VPID
= 5,
193 LTTNG_KERNEL_CONTEXT_TID
= 6,
194 LTTNG_KERNEL_CONTEXT_VTID
= 7,
195 LTTNG_KERNEL_CONTEXT_PPID
= 8,
196 LTTNG_KERNEL_CONTEXT_VPPID
= 9,
197 LTTNG_KERNEL_CONTEXT_HOSTNAME
= 10,
198 LTTNG_KERNEL_CONTEXT_CPU_ID
= 11,
199 LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE
= 12,
200 LTTNG_KERNEL_CONTEXT_PREEMPTIBLE
= 13,
201 LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE
= 14,
202 LTTNG_KERNEL_CONTEXT_MIGRATABLE
= 15,
203 LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL
= 16,
204 LTTNG_KERNEL_CONTEXT_CALLSTACK_USER
= 17,
205 LTTNG_KERNEL_CONTEXT_CGROUP_NS
= 18,
206 LTTNG_KERNEL_CONTEXT_IPC_NS
= 19,
207 LTTNG_KERNEL_CONTEXT_MNT_NS
= 20,
208 LTTNG_KERNEL_CONTEXT_NET_NS
= 21,
209 LTTNG_KERNEL_CONTEXT_PID_NS
= 22,
210 LTTNG_KERNEL_CONTEXT_USER_NS
= 23,
211 LTTNG_KERNEL_CONTEXT_UTS_NS
= 24,
212 LTTNG_KERNEL_CONTEXT_UID
= 25,
213 LTTNG_KERNEL_CONTEXT_EUID
= 26,
214 LTTNG_KERNEL_CONTEXT_SUID
= 27,
215 LTTNG_KERNEL_CONTEXT_GID
= 28,
216 LTTNG_KERNEL_CONTEXT_EGID
= 29,
217 LTTNG_KERNEL_CONTEXT_SGID
= 30,
218 LTTNG_KERNEL_CONTEXT_VUID
= 31,
219 LTTNG_KERNEL_CONTEXT_VEUID
= 32,
220 LTTNG_KERNEL_CONTEXT_VSUID
= 33,
221 LTTNG_KERNEL_CONTEXT_VGID
= 34,
222 LTTNG_KERNEL_CONTEXT_VEGID
= 35,
223 LTTNG_KERNEL_CONTEXT_VSGID
= 36,
224 LTTNG_KERNEL_CONTEXT_TIME_NS
= 37,
227 struct lttng_kernel_perf_counter_ctx
{
230 char name
[LTTNG_KERNEL_SYM_NAME_LEN
];
231 } __attribute__((packed
));
233 #define LTTNG_KERNEL_CONTEXT_PADDING1 16
234 #define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
235 struct lttng_kernel_context
{
236 uint32_t ctx
; /*enum lttng_kernel_context_type */
237 char padding
[LTTNG_KERNEL_CONTEXT_PADDING1
];
240 struct lttng_kernel_perf_counter_ctx perf_counter
;
241 char padding
[LTTNG_KERNEL_CONTEXT_PADDING2
];
243 } __attribute__((packed
));
245 #define LTTNG_KERNEL_FILTER_BYTECODE_MAX_LEN 65536
246 struct lttng_kernel_filter_bytecode
{
248 uint32_t reloc_offset
;
251 } __attribute__((packed
));
253 #define LTTNG_KERNEL_CAPTURE_BYTECODE_MAX_LEN 65536
254 struct lttng_kernel_capture_bytecode
{
256 uint32_t reloc_offset
;
259 } __attribute__((packed
));
261 enum lttng_kernel_tracker_type
{
262 LTTNG_KERNEL_TRACKER_UNKNOWN
= -1,
264 LTTNG_KERNEL_TRACKER_PID
= 0,
265 LTTNG_KERNEL_TRACKER_VPID
= 1,
266 LTTNG_KERNEL_TRACKER_UID
= 2,
267 LTTNG_KERNEL_TRACKER_VUID
= 3,
268 LTTNG_KERNEL_TRACKER_GID
= 4,
269 LTTNG_KERNEL_TRACKER_VGID
= 5,
272 struct lttng_kernel_tracker_args
{
273 uint32_t type
; /* enum lttng_kernel_tracker_type */
277 /* LTTng file descriptor ioctl */
278 /* lttng/abi-old.h reserve 0x40, 0x41, 0x42, 0x43, and 0x44. */
279 #define LTTNG_KERNEL_SESSION _IO(0xF6, 0x45)
280 #define LTTNG_KERNEL_TRACER_VERSION \
281 _IOR(0xF6, 0x46, struct lttng_kernel_tracer_version)
282 #define LTTNG_KERNEL_TRACEPOINT_LIST _IO(0xF6, 0x47)
283 #define LTTNG_KERNEL_WAIT_QUIESCENT _IO(0xF6, 0x48)
284 #define LTTNG_KERNEL_CALIBRATE \
285 _IOWR(0xF6, 0x49, struct lttng_kernel_calibrate)
286 #define LTTNG_KERNEL_SYSCALL_LIST _IO(0xF6, 0x4A)
287 #define LTTNG_KERNEL_TRACER_ABI_VERSION \
288 _IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version)
289 #define LTTNG_KERNEL_EVENT_NOTIFIER_GROUP_CREATE _IO(0xF6, 0x4C)
291 /* Session FD ioctl */
292 /* lttng/abi-old.h reserve 0x50, 0x51, 0x52, and 0x53. */
293 #define LTTNG_KERNEL_METADATA \
294 _IOW(0xF6, 0x54, struct lttng_kernel_channel)
295 #define LTTNG_KERNEL_CHANNEL \
296 _IOW(0xF6, 0x55, struct lttng_kernel_channel)
297 #define LTTNG_KERNEL_SESSION_START _IO(0xF6, 0x56)
298 #define LTTNG_KERNEL_SESSION_STOP _IO(0xF6, 0x57)
299 #define LTTNG_KERNEL_SESSION_TRACK_PID \
300 _IOR(0xF6, 0x58, int32_t)
301 #define LTTNG_KERNEL_SESSION_UNTRACK_PID \
302 _IOR(0xF6, 0x59, int32_t)
305 * ioctl 0x58 and 0x59 are duplicated here. It works, since _IOR vs _IO
306 * are generating two different ioctl numbers, but this was not done on
307 * purpose. We should generally try to avoid those duplications.
309 #define LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS _IO(0xF6, 0x58)
310 #define LTTNG_KERNEL_SESSION_METADATA_REGEN _IO(0xF6, 0x59)
312 /* lttng/abi-old.h reserve 0x5A and 0x5B. */
313 #define LTTNG_KERNEL_SESSION_STATEDUMP _IO(0xF6, 0x5C)
314 #define LTTNG_KERNEL_SESSION_SET_NAME \
315 _IOR(0xF6, 0x5D, struct lttng_kernel_session_name)
316 #define LTTNG_KERNEL_SESSION_SET_CREATION_TIME \
317 _IOR(0xF6, 0x5E, struct lttng_kernel_session_creation_time)
319 /* Channel FD ioctl */
320 /* lttng/abi-old.h reserve 0x60 and 0x61. */
321 #define LTTNG_KERNEL_STREAM _IO(0xF6, 0x62)
322 #define LTTNG_KERNEL_EVENT \
323 _IOW(0xF6, 0x63, struct lttng_kernel_event)
324 #define LTTNG_KERNEL_SYSCALL_MASK \
325 _IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask)
327 /* Event and Channel FD ioctl */
328 /* lttng/abi-old.h reserve 0x70. */
329 #define LTTNG_KERNEL_CONTEXT \
330 _IOW(0xF6, 0x71, struct lttng_kernel_context)
332 /* Event, Event notifier, Channel and Session ioctl */
333 /* lttng/abi-old.h reserve 0x80 and 0x81. */
334 #define LTTNG_KERNEL_ENABLE _IO(0xF6, 0x82)
335 #define LTTNG_KERNEL_DISABLE _IO(0xF6, 0x83)
337 /* Event and Event notifier FD ioctl */
338 #define LTTNG_KERNEL_FILTER _IO(0xF6, 0x90)
339 #define LTTNG_KERNEL_ADD_CALLSITE _IO(0xF6, 0x91)
341 /* Session FD ioctl (continued) */
342 #define LTTNG_KERNEL_SESSION_LIST_TRACKER_IDS \
343 _IOR(0xF6, 0xA0, struct lttng_kernel_tracker_args)
344 #define LTTNG_KERNEL_SESSION_TRACK_ID \
345 _IOR(0xF6, 0xA1, struct lttng_kernel_tracker_args)
346 #define LTTNG_KERNEL_SESSION_UNTRACK_ID \
347 _IOR(0xF6, 0xA2, struct lttng_kernel_tracker_args)
349 /* Event notifier group file descriptor ioctl */
350 #define LTTNG_KERNEL_EVENT_NOTIFIER_CREATE \
351 _IOW(0xF6, 0xB0, struct lttng_kernel_event_notifier)
352 #define LTTNG_KERNEL_EVENT_NOTIFIER_GROUP_NOTIFICATION_FD \
355 /* Event notifier file descriptor ioctl */
356 #define LTTNG_KERNEL_CAPTURE _IO(0xF6, 0xB8)
359 * LTTng-specific ioctls for the lib ringbuffer.
361 * Operations applying to the current sub-buffer need to occur between
362 * a get/put or get_next/put_next ioctl pair.
365 /* returns the timestamp begin of the current sub-buffer */
366 #define LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN _IOR(0xF6, 0x20, uint64_t)
367 /* returns the timestamp end of the current sub-buffer */
368 #define LTTNG_RING_BUFFER_GET_TIMESTAMP_END _IOR(0xF6, 0x21, uint64_t)
369 /* returns the number of events discarded of the current sub-buffer */
370 #define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED _IOR(0xF6, 0x22, uint64_t)
371 /* returns the packet payload size of the current sub-buffer */
372 #define LTTNG_RING_BUFFER_GET_CONTENT_SIZE _IOR(0xF6, 0x23, uint64_t)
373 /* returns the packet size of the current sub-buffer*/
374 #define LTTNG_RING_BUFFER_GET_PACKET_SIZE _IOR(0xF6, 0x24, uint64_t)
375 /* returns the stream id (invariant for the stream) */
376 #define LTTNG_RING_BUFFER_GET_STREAM_ID _IOR(0xF6, 0x25, uint64_t)
377 /* returns the current timestamp as perceived from the tracer */
378 #define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t)
379 /* returns the packet sequence number of the current sub-buffer */
380 #define LTTNG_RING_BUFFER_GET_SEQ_NUM _IOR(0xF6, 0x27, uint64_t)
381 /* returns the stream instance id (invariant for the stream) */
382 #define LTTNG_RING_BUFFER_INSTANCE_ID _IOR(0xF6, 0x28, uint64_t)
385 /* returns the timestamp begin of the current sub-buffer */
386 #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_BEGIN \
387 LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN
388 /* returns the timestamp end of the current sub-buffer */
389 #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END \
390 LTTNG_RING_BUFFER_GET_TIMESTAMP_END
391 /* returns the number of events discarded of the current sub-buffer */
392 #define LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED \
393 LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED
394 /* returns the packet payload size of the current sub-buffer */
395 #define LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE \
396 LTTNG_RING_BUFFER_GET_CONTENT_SIZE
397 /* returns the packet size of the current sub-buffer */
398 #define LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE \
399 LTTNG_RING_BUFFER_GET_PACKET_SIZE
400 /* returns the stream id (invariant for the stream) */
401 #define LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID \
402 LTTNG_RING_BUFFER_GET_STREAM_ID
403 /* returns the current timestamp as perceived from the tracer */
404 #define LTTNG_RING_BUFFER_COMPAT_GET_CURRENT_TIMESTAMP \
405 LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
406 /* returns the packet sequence number of the current sub-buffer */
407 #define LTTNG_RING_BUFFER_COMPAT_GET_SEQ_NUM \
408 LTTNG_RING_BUFFER_GET_SEQ_NUM
409 /* returns the stream instance id (invariant for the stream) */
410 #define LTTNG_RING_BUFFER_COMPAT_INSTANCE_ID \
411 LTTNG_RING_BUFFER_INSTANCE_ID
412 #endif /* CONFIG_COMPAT */
414 #endif /* _LTTNG_ABI_H */