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
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 #define LTTNG_KERNEL_TRIGGER_PADDING1 16
114 #define LTTNG_KERNEL_TRIGGER_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
115 struct lttng_kernel_trigger
{
117 char name
[LTTNG_KERNEL_SYM_NAME_LEN
]; /* event name */
118 enum lttng_kernel_instrumentation instrumentation
;
119 char padding
[LTTNG_KERNEL_TRIGGER_PADDING1
];
121 /* Per instrumentation type configuration */
123 struct lttng_kernel_kretprobe kretprobe
;
124 struct lttng_kernel_kprobe kprobe
;
125 struct lttng_kernel_function_tracer ftrace
;
126 struct lttng_kernel_uprobe uprobe
;
127 char padding
[LTTNG_KERNEL_TRIGGER_PADDING2
];
129 } __attribute__((packed
));
131 struct lttng_kernel_tracer_version
{
135 } __attribute__((packed
));
137 struct lttng_kernel_tracer_abi_version
{
140 } __attribute__((packed
));
142 struct lttng_kernel_session_name
{
143 char name
[LTTNG_KERNEL_SESSION_NAME_LEN
];
144 } __attribute__((packed
));
146 struct lttng_kernel_session_creation_time
{
147 char iso8601
[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN
];
148 } __attribute__((packed
));
150 enum lttng_kernel_calibrate_type
{
151 LTTNG_KERNEL_CALIBRATE_KRETPROBE
,
154 struct lttng_kernel_calibrate
{
155 enum lttng_kernel_calibrate_type type
; /* type (input) */
156 } __attribute__((packed
));
158 struct lttng_kernel_syscall_mask
{
159 uint32_t len
; /* in bits */
161 } __attribute__((packed
));
163 enum lttng_kernel_context_type
{
164 LTTNG_KERNEL_CONTEXT_PID
= 0,
165 LTTNG_KERNEL_CONTEXT_PERF_COUNTER
= 1,
166 LTTNG_KERNEL_CONTEXT_PROCNAME
= 2,
167 LTTNG_KERNEL_CONTEXT_PRIO
= 3,
168 LTTNG_KERNEL_CONTEXT_NICE
= 4,
169 LTTNG_KERNEL_CONTEXT_VPID
= 5,
170 LTTNG_KERNEL_CONTEXT_TID
= 6,
171 LTTNG_KERNEL_CONTEXT_VTID
= 7,
172 LTTNG_KERNEL_CONTEXT_PPID
= 8,
173 LTTNG_KERNEL_CONTEXT_VPPID
= 9,
174 LTTNG_KERNEL_CONTEXT_HOSTNAME
= 10,
175 LTTNG_KERNEL_CONTEXT_CPU_ID
= 11,
176 LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE
= 12,
177 LTTNG_KERNEL_CONTEXT_PREEMPTIBLE
= 13,
178 LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE
= 14,
179 LTTNG_KERNEL_CONTEXT_MIGRATABLE
= 15,
180 LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL
= 16,
181 LTTNG_KERNEL_CONTEXT_CALLSTACK_USER
= 17,
182 LTTNG_KERNEL_CONTEXT_CGROUP_NS
= 18,
183 LTTNG_KERNEL_CONTEXT_IPC_NS
= 19,
184 LTTNG_KERNEL_CONTEXT_MNT_NS
= 20,
185 LTTNG_KERNEL_CONTEXT_NET_NS
= 21,
186 LTTNG_KERNEL_CONTEXT_PID_NS
= 22,
187 LTTNG_KERNEL_CONTEXT_USER_NS
= 23,
188 LTTNG_KERNEL_CONTEXT_UTS_NS
= 24,
189 LTTNG_KERNEL_CONTEXT_UID
= 25,
190 LTTNG_KERNEL_CONTEXT_EUID
= 26,
191 LTTNG_KERNEL_CONTEXT_SUID
= 27,
192 LTTNG_KERNEL_CONTEXT_GID
= 28,
193 LTTNG_KERNEL_CONTEXT_EGID
= 29,
194 LTTNG_KERNEL_CONTEXT_SGID
= 30,
195 LTTNG_KERNEL_CONTEXT_VUID
= 31,
196 LTTNG_KERNEL_CONTEXT_VEUID
= 32,
197 LTTNG_KERNEL_CONTEXT_VSUID
= 33,
198 LTTNG_KERNEL_CONTEXT_VGID
= 34,
199 LTTNG_KERNEL_CONTEXT_VEGID
= 35,
200 LTTNG_KERNEL_CONTEXT_VSGID
= 36,
203 struct lttng_kernel_perf_counter_ctx
{
206 char name
[LTTNG_KERNEL_SYM_NAME_LEN
];
207 } __attribute__((packed
));
209 #define LTTNG_KERNEL_CONTEXT_PADDING1 16
210 #define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
211 struct lttng_kernel_context
{
212 enum lttng_kernel_context_type ctx
;
213 char padding
[LTTNG_KERNEL_CONTEXT_PADDING1
];
216 struct lttng_kernel_perf_counter_ctx perf_counter
;
217 char padding
[LTTNG_KERNEL_CONTEXT_PADDING2
];
219 } __attribute__((packed
));
221 #define LTTNG_KERNEL_FILTER_BYTECODE_MAX_LEN 65536
222 struct lttng_kernel_filter_bytecode
{
224 uint32_t reloc_offset
;
227 } __attribute__((packed
));
229 enum lttng_kernel_tracker_type
{
230 LTTNG_KERNEL_TRACKER_UNKNOWN
= -1,
232 LTTNG_KERNEL_TRACKER_PID
= 0,
233 LTTNG_KERNEL_TRACKER_VPID
= 1,
234 LTTNG_KERNEL_TRACKER_UID
= 2,
235 LTTNG_KERNEL_TRACKER_VUID
= 3,
236 LTTNG_KERNEL_TRACKER_GID
= 4,
237 LTTNG_KERNEL_TRACKER_VGID
= 5,
240 struct lttng_kernel_tracker_args
{
241 enum lttng_kernel_tracker_type type
;
245 /* LTTng file descriptor ioctl */
246 /* lttng-abi-old.h reserve 0x40, 0x41, 0x42, 0x43, and 0x44. */
247 #define LTTNG_KERNEL_SESSION _IO(0xF6, 0x45)
248 #define LTTNG_KERNEL_TRACER_VERSION \
249 _IOR(0xF6, 0x46, struct lttng_kernel_tracer_version)
250 #define LTTNG_KERNEL_TRACEPOINT_LIST _IO(0xF6, 0x47)
251 #define LTTNG_KERNEL_WAIT_QUIESCENT _IO(0xF6, 0x48)
252 #define LTTNG_KERNEL_CALIBRATE \
253 _IOWR(0xF6, 0x49, struct lttng_kernel_calibrate)
254 #define LTTNG_KERNEL_SYSCALL_LIST _IO(0xF6, 0x4A)
255 #define LTTNG_KERNEL_TRACER_ABI_VERSION \
256 _IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version)
257 #define LTTNG_KERNEL_TRIGGER_GROUP_CREATE _IO(0xF6, 0x4C)
259 /* Trigger group file descriptor ioctl */
260 #define LTTNG_KERNEL_TRIGGER_GROUP_NOTIFICATION_FD \
262 #define LTTNG_KERNEL_TRIGGER_CREATE \
263 _IOW(0xF6, 0x31, struct lttng_kernel_trigger)
265 /* Session FD ioctl */
266 /* lttng-abi-old.h reserve 0x50, 0x51, 0x52, and 0x53. */
267 #define LTTNG_KERNEL_METADATA \
268 _IOW(0xF6, 0x54, struct lttng_kernel_channel)
269 #define LTTNG_KERNEL_CHANNEL \
270 _IOW(0xF6, 0x55, struct lttng_kernel_channel)
271 #define LTTNG_KERNEL_SESSION_START _IO(0xF6, 0x56)
272 #define LTTNG_KERNEL_SESSION_STOP _IO(0xF6, 0x57)
273 #define LTTNG_KERNEL_SESSION_TRACK_PID \
274 _IOR(0xF6, 0x58, int32_t)
275 #define LTTNG_KERNEL_SESSION_UNTRACK_PID \
276 _IOR(0xF6, 0x59, int32_t)
279 * ioctl 0x58 and 0x59 are duplicated here. It works, since _IOR vs _IO
280 * are generating two different ioctl numbers, but this was not done on
281 * purpose. We should generally try to avoid those duplications.
283 #define LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS _IO(0xF6, 0x58)
284 #define LTTNG_KERNEL_SESSION_METADATA_REGEN _IO(0xF6, 0x59)
286 /* lttng-abi-old.h reserve 0x5A and 0x5B. */
287 #define LTTNG_KERNEL_SESSION_STATEDUMP _IO(0xF6, 0x5C)
288 #define LTTNG_KERNEL_SESSION_SET_NAME \
289 _IOR(0xF6, 0x5D, struct lttng_kernel_session_name)
290 #define LTTNG_KERNEL_SESSION_SET_CREATION_TIME \
291 _IOR(0xF6, 0x5E, struct lttng_kernel_session_creation_time)
293 /* Channel FD ioctl */
294 /* lttng-abi-old.h reserve 0x60 and 0x61. */
295 #define LTTNG_KERNEL_STREAM _IO(0xF6, 0x62)
296 #define LTTNG_KERNEL_EVENT \
297 _IOW(0xF6, 0x63, struct lttng_kernel_event)
298 #define LTTNG_KERNEL_SYSCALL_MASK \
299 _IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask)
301 /* Event and Channel FD ioctl */
302 /* lttng-abi-old.h reserve 0x70. */
303 #define LTTNG_KERNEL_CONTEXT \
304 _IOW(0xF6, 0x71, struct lttng_kernel_context)
306 /* Event, Channel and Session ioctl */
307 /* lttng-abi-old.h reserve 0x80 and 0x81. */
308 #define LTTNG_KERNEL_ENABLE _IO(0xF6, 0x82)
309 #define LTTNG_KERNEL_DISABLE _IO(0xF6, 0x83)
312 #define LTTNG_KERNEL_FILTER _IO(0xF6, 0x90)
313 #define LTTNG_KERNEL_ADD_CALLSITE _IO(0xF6, 0x91)
315 /* Session FD ioctl (continued) */
316 #define LTTNG_KERNEL_SESSION_LIST_TRACKER_IDS \
317 _IOR(0xF6, 0xA0, struct lttng_kernel_tracker_args)
318 #define LTTNG_KERNEL_SESSION_TRACK_ID \
319 _IOR(0xF6, 0xA1, struct lttng_kernel_tracker_args)
320 #define LTTNG_KERNEL_SESSION_UNTRACK_ID \
321 _IOR(0xF6, 0xA2, struct lttng_kernel_tracker_args)
324 * LTTng-specific ioctls for the lib ringbuffer.
326 * Operations applying to the current sub-buffer need to occur between
327 * a get/put or get_next/put_next ioctl pair.
330 /* returns the timestamp begin of the current sub-buffer */
331 #define LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN _IOR(0xF6, 0x20, uint64_t)
332 /* returns the timestamp end of the current sub-buffer */
333 #define LTTNG_RING_BUFFER_GET_TIMESTAMP_END _IOR(0xF6, 0x21, uint64_t)
334 /* returns the number of events discarded of the current sub-buffer */
335 #define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED _IOR(0xF6, 0x22, uint64_t)
336 /* returns the packet payload size of the current sub-buffer */
337 #define LTTNG_RING_BUFFER_GET_CONTENT_SIZE _IOR(0xF6, 0x23, uint64_t)
338 /* returns the packet size of the current sub-buffer*/
339 #define LTTNG_RING_BUFFER_GET_PACKET_SIZE _IOR(0xF6, 0x24, uint64_t)
340 /* returns the stream id (invariant for the stream) */
341 #define LTTNG_RING_BUFFER_GET_STREAM_ID _IOR(0xF6, 0x25, uint64_t)
342 /* returns the current timestamp as perceived from the tracer */
343 #define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t)
344 /* returns the packet sequence number of the current sub-buffer */
345 #define LTTNG_RING_BUFFER_GET_SEQ_NUM _IOR(0xF6, 0x27, uint64_t)
346 /* returns the stream instance id (invariant for the stream) */
347 #define LTTNG_RING_BUFFER_INSTANCE_ID _IOR(0xF6, 0x28, uint64_t)
350 /* returns the timestamp begin of the current sub-buffer */
351 #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_BEGIN \
352 LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN
353 /* returns the timestamp end of the current sub-buffer */
354 #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END \
355 LTTNG_RING_BUFFER_GET_TIMESTAMP_END
356 /* returns the number of events discarded of the current sub-buffer */
357 #define LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED \
358 LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED
359 /* returns the packet payload size of the current sub-buffer */
360 #define LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE \
361 LTTNG_RING_BUFFER_GET_CONTENT_SIZE
362 /* returns the packet size of the current sub-buffer */
363 #define LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE \
364 LTTNG_RING_BUFFER_GET_PACKET_SIZE
365 /* returns the stream id (invariant for the stream) */
366 #define LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID \
367 LTTNG_RING_BUFFER_GET_STREAM_ID
368 /* returns the current timestamp as perceived from the tracer */
369 #define LTTNG_RING_BUFFER_COMPAT_GET_CURRENT_TIMESTAMP \
370 LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
371 /* returns the packet sequence number of the current sub-buffer */
372 #define LTTNG_RING_BUFFER_COMPAT_GET_SEQ_NUM \
373 LTTNG_RING_BUFFER_GET_SEQ_NUM
374 /* returns the stream instance id (invariant for the stream) */
375 #define LTTNG_RING_BUFFER_COMPAT_INSTANCE_ID \
376 LTTNG_RING_BUFFER_INSTANCE_ID
377 #endif /* CONFIG_COMPAT */
379 #endif /* _LTTNG_ABI_H */