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 5
22 #define LTTNG_KERNEL_SYM_NAME_LEN 256
23 #define LTTNG_KERNEL_SESSION_NAME_LEN 256
26 * The expected iso8601 time formats are either:
28 * - YYYYmmddTHHMMSS+HHMM (20 characters + \0)
29 * - YYYY-mm-ddTHH:MM:SS+HH:MM (25 characters + \0)
31 #define LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN 26
33 enum lttng_kernel_instrumentation
{
34 LTTNG_KERNEL_TRACEPOINT
= 0,
35 LTTNG_KERNEL_KPROBE
= 1,
36 LTTNG_KERNEL_FUNCTION
= 2,
37 LTTNG_KERNEL_KRETPROBE
= 3,
38 LTTNG_KERNEL_NOOP
= 4, /* not hooked */
39 LTTNG_KERNEL_SYSCALL
= 5,
40 LTTNG_KERNEL_UPROBE
= 6,
46 enum lttng_kernel_output
{
47 LTTNG_KERNEL_SPLICE
= 0,
48 LTTNG_KERNEL_MMAP
= 1,
52 * LTTng DebugFS ABI structures.
54 #define LTTNG_KERNEL_CHANNEL_PADDING LTTNG_KERNEL_SYM_NAME_LEN + 32
55 struct lttng_kernel_channel
{
56 uint64_t subbuf_size
; /* in bytes */
58 unsigned int switch_timer_interval
; /* usecs */
59 unsigned int read_timer_interval
; /* usecs */
60 enum lttng_kernel_output output
; /* splice, mmap */
61 int overwrite
; /* 1: overwrite, 0: discard */
62 char padding
[LTTNG_KERNEL_CHANNEL_PADDING
];
63 } __attribute__((packed
));
65 struct lttng_kernel_kretprobe
{
69 char symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
];
70 } __attribute__((packed
));
73 * Either addr is used, or symbol_name and offset.
75 struct lttng_kernel_kprobe
{
79 char symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
];
80 } __attribute__((packed
));
82 struct lttng_kernel_function_tracer
{
83 char symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
];
84 } __attribute__((packed
));
86 struct lttng_kernel_uprobe
{
88 } __attribute__((packed
));
90 struct lttng_kernel_event_callsite_uprobe
{
92 } __attribute__((packed
));
94 struct lttng_kernel_event_callsite
{
96 struct lttng_kernel_event_callsite_uprobe uprobe
;
98 } __attribute__((packed
));
100 enum lttng_kernel_syscall_entryexit
{
101 LTTNG_KERNEL_SYSCALL_ENTRYEXIT
= 0,
102 LTTNG_KERNEL_SYSCALL_ENTRY
= 1, /* Not implemented. */
103 LTTNG_KERNEL_SYSCALL_EXIT
= 2, /* Not implemented. */
106 enum lttng_kernel_syscall_abi
{
107 LTTNG_KERNEL_SYSCALL_ABI_ALL
= 0,
108 LTTNG_KERNEL_SYSCALL_ABI_NATIVE
= 1, /* Not implemented. */
109 LTTNG_KERNEL_SYSCALL_ABI_COMPAT
= 2, /* Not implemented. */
112 enum lttng_kernel_syscall_match
{
113 LTTNG_SYSCALL_MATCH_NAME
= 0,
114 LTTNG_SYSCALL_MATCH_NR
= 1, /* Not implemented. */
117 struct lttng_kernel_syscall
{
118 uint8_t entryexit
; /* enum lttng_kernel_syscall_entryexit */
119 uint8_t abi
; /* enum lttng_kernel_syscall_abi */
120 uint8_t match
; /* enum lttng_kernel_syscall_match */
122 uint32_t nr
; /* For LTTNG_SYSCALL_MATCH_NR */
123 } __attribute__((packed
));
126 * For syscall tracing, name = "*" means "enable all".
128 #define LTTNG_KERNEL_EVENT_PADDING1 16
129 #define LTTNG_KERNEL_EVENT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
130 struct lttng_kernel_event
{
131 char name
[LTTNG_KERNEL_SYM_NAME_LEN
]; /* event name */
132 enum lttng_kernel_instrumentation instrumentation
;
133 char padding
[LTTNG_KERNEL_EVENT_PADDING1
];
135 /* Per instrumentation type configuration */
137 struct lttng_kernel_kretprobe kretprobe
;
138 struct lttng_kernel_kprobe kprobe
;
139 struct lttng_kernel_function_tracer ftrace
;
140 struct lttng_kernel_uprobe uprobe
;
141 struct lttng_kernel_syscall syscall
;
142 char padding
[LTTNG_KERNEL_EVENT_PADDING2
];
144 } __attribute__((packed
));
146 struct lttng_kernel_tracer_version
{
150 } __attribute__((packed
));
152 struct lttng_kernel_tracer_abi_version
{
155 } __attribute__((packed
));
157 struct lttng_kernel_session_name
{
158 char name
[LTTNG_KERNEL_SESSION_NAME_LEN
];
159 } __attribute__((packed
));
161 struct lttng_kernel_session_creation_time
{
162 char iso8601
[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN
];
163 } __attribute__((packed
));
165 enum lttng_kernel_calibrate_type
{
166 LTTNG_KERNEL_CALIBRATE_KRETPROBE
,
169 struct lttng_kernel_calibrate
{
170 enum lttng_kernel_calibrate_type type
; /* type (input) */
171 } __attribute__((packed
));
173 struct lttng_kernel_syscall_mask
{
174 uint32_t len
; /* in bits */
176 } __attribute__((packed
));
178 enum lttng_kernel_context_type
{
179 LTTNG_KERNEL_CONTEXT_PID
= 0,
180 LTTNG_KERNEL_CONTEXT_PERF_COUNTER
= 1,
181 LTTNG_KERNEL_CONTEXT_PROCNAME
= 2,
182 LTTNG_KERNEL_CONTEXT_PRIO
= 3,
183 LTTNG_KERNEL_CONTEXT_NICE
= 4,
184 LTTNG_KERNEL_CONTEXT_VPID
= 5,
185 LTTNG_KERNEL_CONTEXT_TID
= 6,
186 LTTNG_KERNEL_CONTEXT_VTID
= 7,
187 LTTNG_KERNEL_CONTEXT_PPID
= 8,
188 LTTNG_KERNEL_CONTEXT_VPPID
= 9,
189 LTTNG_KERNEL_CONTEXT_HOSTNAME
= 10,
190 LTTNG_KERNEL_CONTEXT_CPU_ID
= 11,
191 LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE
= 12,
192 LTTNG_KERNEL_CONTEXT_PREEMPTIBLE
= 13,
193 LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE
= 14,
194 LTTNG_KERNEL_CONTEXT_MIGRATABLE
= 15,
195 LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL
= 16,
196 LTTNG_KERNEL_CONTEXT_CALLSTACK_USER
= 17,
197 LTTNG_KERNEL_CONTEXT_CGROUP_NS
= 18,
198 LTTNG_KERNEL_CONTEXT_IPC_NS
= 19,
199 LTTNG_KERNEL_CONTEXT_MNT_NS
= 20,
200 LTTNG_KERNEL_CONTEXT_NET_NS
= 21,
201 LTTNG_KERNEL_CONTEXT_PID_NS
= 22,
202 LTTNG_KERNEL_CONTEXT_USER_NS
= 23,
203 LTTNG_KERNEL_CONTEXT_UTS_NS
= 24,
204 LTTNG_KERNEL_CONTEXT_UID
= 25,
205 LTTNG_KERNEL_CONTEXT_EUID
= 26,
206 LTTNG_KERNEL_CONTEXT_SUID
= 27,
207 LTTNG_KERNEL_CONTEXT_GID
= 28,
208 LTTNG_KERNEL_CONTEXT_EGID
= 29,
209 LTTNG_KERNEL_CONTEXT_SGID
= 30,
210 LTTNG_KERNEL_CONTEXT_VUID
= 31,
211 LTTNG_KERNEL_CONTEXT_VEUID
= 32,
212 LTTNG_KERNEL_CONTEXT_VSUID
= 33,
213 LTTNG_KERNEL_CONTEXT_VGID
= 34,
214 LTTNG_KERNEL_CONTEXT_VEGID
= 35,
215 LTTNG_KERNEL_CONTEXT_VSGID
= 36,
218 struct lttng_kernel_perf_counter_ctx
{
221 char name
[LTTNG_KERNEL_SYM_NAME_LEN
];
222 } __attribute__((packed
));
224 #define LTTNG_KERNEL_CONTEXT_PADDING1 16
225 #define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
226 struct lttng_kernel_context
{
227 enum lttng_kernel_context_type ctx
;
228 char padding
[LTTNG_KERNEL_CONTEXT_PADDING1
];
231 struct lttng_kernel_perf_counter_ctx perf_counter
;
232 char padding
[LTTNG_KERNEL_CONTEXT_PADDING2
];
234 } __attribute__((packed
));
236 #define LTTNG_KERNEL_FILTER_BYTECODE_MAX_LEN 65536
237 struct lttng_kernel_filter_bytecode
{
239 uint32_t reloc_offset
;
242 } __attribute__((packed
));
244 enum lttng_kernel_tracker_type
{
245 LTTNG_KERNEL_TRACKER_UNKNOWN
= -1,
247 LTTNG_KERNEL_TRACKER_PID
= 0,
248 LTTNG_KERNEL_TRACKER_VPID
= 1,
249 LTTNG_KERNEL_TRACKER_UID
= 2,
250 LTTNG_KERNEL_TRACKER_VUID
= 3,
251 LTTNG_KERNEL_TRACKER_GID
= 4,
252 LTTNG_KERNEL_TRACKER_VGID
= 5,
255 struct lttng_kernel_tracker_args
{
256 enum lttng_kernel_tracker_type type
;
260 /* LTTng file descriptor ioctl */
261 /* lttng-abi-old.h reserve 0x40, 0x41, 0x42, 0x43, and 0x44. */
262 #define LTTNG_KERNEL_SESSION _IO(0xF6, 0x45)
263 #define LTTNG_KERNEL_TRACER_VERSION \
264 _IOR(0xF6, 0x46, struct lttng_kernel_tracer_version)
265 #define LTTNG_KERNEL_TRACEPOINT_LIST _IO(0xF6, 0x47)
266 #define LTTNG_KERNEL_WAIT_QUIESCENT _IO(0xF6, 0x48)
267 #define LTTNG_KERNEL_CALIBRATE \
268 _IOWR(0xF6, 0x49, struct lttng_kernel_calibrate)
269 #define LTTNG_KERNEL_SYSCALL_LIST _IO(0xF6, 0x4A)
270 #define LTTNG_KERNEL_TRACER_ABI_VERSION \
271 _IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version)
273 /* Session FD ioctl */
274 /* lttng-abi-old.h reserve 0x50, 0x51, 0x52, and 0x53. */
275 #define LTTNG_KERNEL_METADATA \
276 _IOW(0xF6, 0x54, struct lttng_kernel_channel)
277 #define LTTNG_KERNEL_CHANNEL \
278 _IOW(0xF6, 0x55, struct lttng_kernel_channel)
279 #define LTTNG_KERNEL_SESSION_START _IO(0xF6, 0x56)
280 #define LTTNG_KERNEL_SESSION_STOP _IO(0xF6, 0x57)
281 #define LTTNG_KERNEL_SESSION_TRACK_PID \
282 _IOR(0xF6, 0x58, int32_t)
283 #define LTTNG_KERNEL_SESSION_UNTRACK_PID \
284 _IOR(0xF6, 0x59, int32_t)
287 * ioctl 0x58 and 0x59 are duplicated here. It works, since _IOR vs _IO
288 * are generating two different ioctl numbers, but this was not done on
289 * purpose. We should generally try to avoid those duplications.
291 #define LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS _IO(0xF6, 0x58)
292 #define LTTNG_KERNEL_SESSION_METADATA_REGEN _IO(0xF6, 0x59)
294 /* lttng-abi-old.h reserve 0x5A and 0x5B. */
295 #define LTTNG_KERNEL_SESSION_STATEDUMP _IO(0xF6, 0x5C)
296 #define LTTNG_KERNEL_SESSION_SET_NAME \
297 _IOR(0xF6, 0x5D, struct lttng_kernel_session_name)
298 #define LTTNG_KERNEL_SESSION_SET_CREATION_TIME \
299 _IOR(0xF6, 0x5E, struct lttng_kernel_session_creation_time)
301 /* Channel FD ioctl */
302 /* lttng-abi-old.h reserve 0x60 and 0x61. */
303 #define LTTNG_KERNEL_STREAM _IO(0xF6, 0x62)
304 #define LTTNG_KERNEL_EVENT \
305 _IOW(0xF6, 0x63, struct lttng_kernel_event)
306 #define LTTNG_KERNEL_SYSCALL_MASK \
307 _IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask)
309 /* Event and Channel FD ioctl */
310 /* lttng-abi-old.h reserve 0x70. */
311 #define LTTNG_KERNEL_CONTEXT \
312 _IOW(0xF6, 0x71, struct lttng_kernel_context)
314 /* Event, Channel and Session ioctl */
315 /* lttng-abi-old.h reserve 0x80 and 0x81. */
316 #define LTTNG_KERNEL_ENABLE _IO(0xF6, 0x82)
317 #define LTTNG_KERNEL_DISABLE _IO(0xF6, 0x83)
320 #define LTTNG_KERNEL_FILTER _IO(0xF6, 0x90)
321 #define LTTNG_KERNEL_ADD_CALLSITE _IO(0xF6, 0x91)
323 /* Session FD ioctl (continued) */
324 #define LTTNG_KERNEL_SESSION_LIST_TRACKER_IDS \
325 _IOR(0xF6, 0xA0, struct lttng_kernel_tracker_args)
326 #define LTTNG_KERNEL_SESSION_TRACK_ID \
327 _IOR(0xF6, 0xA1, struct lttng_kernel_tracker_args)
328 #define LTTNG_KERNEL_SESSION_UNTRACK_ID \
329 _IOR(0xF6, 0xA2, struct lttng_kernel_tracker_args)
332 * LTTng-specific ioctls for the lib ringbuffer.
334 * Operations applying to the current sub-buffer need to occur between
335 * a get/put or get_next/put_next ioctl pair.
338 /* returns the timestamp begin of the current sub-buffer */
339 #define LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN _IOR(0xF6, 0x20, uint64_t)
340 /* returns the timestamp end of the current sub-buffer */
341 #define LTTNG_RING_BUFFER_GET_TIMESTAMP_END _IOR(0xF6, 0x21, uint64_t)
342 /* returns the number of events discarded of the current sub-buffer */
343 #define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED _IOR(0xF6, 0x22, uint64_t)
344 /* returns the packet payload size of the current sub-buffer */
345 #define LTTNG_RING_BUFFER_GET_CONTENT_SIZE _IOR(0xF6, 0x23, uint64_t)
346 /* returns the packet size of the current sub-buffer*/
347 #define LTTNG_RING_BUFFER_GET_PACKET_SIZE _IOR(0xF6, 0x24, uint64_t)
348 /* returns the stream id (invariant for the stream) */
349 #define LTTNG_RING_BUFFER_GET_STREAM_ID _IOR(0xF6, 0x25, uint64_t)
350 /* returns the current timestamp as perceived from the tracer */
351 #define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t)
352 /* returns the packet sequence number of the current sub-buffer */
353 #define LTTNG_RING_BUFFER_GET_SEQ_NUM _IOR(0xF6, 0x27, uint64_t)
354 /* returns the stream instance id (invariant for the stream) */
355 #define LTTNG_RING_BUFFER_INSTANCE_ID _IOR(0xF6, 0x28, uint64_t)
358 /* returns the timestamp begin of the current sub-buffer */
359 #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_BEGIN \
360 LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN
361 /* returns the timestamp end of the current sub-buffer */
362 #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END \
363 LTTNG_RING_BUFFER_GET_TIMESTAMP_END
364 /* returns the number of events discarded of the current sub-buffer */
365 #define LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED \
366 LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED
367 /* returns the packet payload size of the current sub-buffer */
368 #define LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE \
369 LTTNG_RING_BUFFER_GET_CONTENT_SIZE
370 /* returns the packet size of the current sub-buffer */
371 #define LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE \
372 LTTNG_RING_BUFFER_GET_PACKET_SIZE
373 /* returns the stream id (invariant for the stream) */
374 #define LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID \
375 LTTNG_RING_BUFFER_GET_STREAM_ID
376 /* returns the current timestamp as perceived from the tracer */
377 #define LTTNG_RING_BUFFER_COMPAT_GET_CURRENT_TIMESTAMP \
378 LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
379 /* returns the packet sequence number of the current sub-buffer */
380 #define LTTNG_RING_BUFFER_COMPAT_GET_SEQ_NUM \
381 LTTNG_RING_BUFFER_GET_SEQ_NUM
382 /* returns the stream instance id (invariant for the stream) */
383 #define LTTNG_RING_BUFFER_COMPAT_INSTANCE_ID \
384 LTTNG_RING_BUFFER_INSTANCE_ID
385 #endif /* CONFIG_COMPAT */
387 #endif /* _LTTNG_ABI_H */