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 3
22 #define LTTNG_KERNEL_SYM_NAME_LEN 256
24 enum lttng_kernel_instrumentation
{
25 LTTNG_KERNEL_TRACEPOINT
= 0,
26 LTTNG_KERNEL_KPROBE
= 1,
27 LTTNG_KERNEL_FUNCTION
= 2,
28 LTTNG_KERNEL_KRETPROBE
= 3,
29 LTTNG_KERNEL_NOOP
= 4, /* not hooked */
30 LTTNG_KERNEL_SYSCALL
= 5,
31 LTTNG_KERNEL_UPROBE
= 6,
37 enum lttng_kernel_output
{
38 LTTNG_KERNEL_SPLICE
= 0,
39 LTTNG_KERNEL_MMAP
= 1,
43 * LTTng DebugFS ABI structures.
45 #define LTTNG_KERNEL_CHANNEL_PADDING LTTNG_KERNEL_SYM_NAME_LEN + 32
46 struct lttng_kernel_channel
{
47 uint64_t subbuf_size
; /* in bytes */
49 unsigned int switch_timer_interval
; /* usecs */
50 unsigned int read_timer_interval
; /* usecs */
51 enum lttng_kernel_output output
; /* splice, mmap */
52 int overwrite
; /* 1: overwrite, 0: discard */
53 char padding
[LTTNG_KERNEL_CHANNEL_PADDING
];
54 } __attribute__((packed
));
56 struct lttng_kernel_kretprobe
{
60 char symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
];
61 } __attribute__((packed
));
64 * Either addr is used, or symbol_name and offset.
66 struct lttng_kernel_kprobe
{
70 char symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
];
71 } __attribute__((packed
));
73 struct lttng_kernel_function_tracer
{
74 char symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
];
75 } __attribute__((packed
));
77 struct lttng_kernel_uprobe
{
79 } __attribute__((packed
));
81 struct lttng_kernel_event_callsite_uprobe
{
83 } __attribute__((packed
));
85 struct lttng_kernel_event_callsite
{
87 struct lttng_kernel_event_callsite_uprobe uprobe
;
89 } __attribute__((packed
));
92 * For syscall tracing, name = "*" means "enable all".
94 #define LTTNG_KERNEL_EVENT_PADDING1 16
95 #define LTTNG_KERNEL_EVENT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
96 struct lttng_kernel_event
{
97 char name
[LTTNG_KERNEL_SYM_NAME_LEN
]; /* event name */
98 enum lttng_kernel_instrumentation instrumentation
;
99 char padding
[LTTNG_KERNEL_EVENT_PADDING1
];
101 /* Per instrumentation type configuration */
103 struct lttng_kernel_kretprobe kretprobe
;
104 struct lttng_kernel_kprobe kprobe
;
105 struct lttng_kernel_function_tracer ftrace
;
106 struct lttng_kernel_uprobe uprobe
;
107 char padding
[LTTNG_KERNEL_EVENT_PADDING2
];
109 } __attribute__((packed
));
111 struct lttng_kernel_tracer_version
{
115 } __attribute__((packed
));
117 struct lttng_kernel_tracer_abi_version
{
120 } __attribute__((packed
));
122 enum lttng_kernel_calibrate_type
{
123 LTTNG_KERNEL_CALIBRATE_KRETPROBE
,
126 struct lttng_kernel_calibrate
{
127 enum lttng_kernel_calibrate_type type
; /* type (input) */
128 } __attribute__((packed
));
130 struct lttng_kernel_syscall_mask
{
131 uint32_t len
; /* in bits */
133 } __attribute__((packed
));
135 enum lttng_kernel_context_type
{
136 LTTNG_KERNEL_CONTEXT_PID
= 0,
137 LTTNG_KERNEL_CONTEXT_PERF_COUNTER
= 1,
138 LTTNG_KERNEL_CONTEXT_PROCNAME
= 2,
139 LTTNG_KERNEL_CONTEXT_PRIO
= 3,
140 LTTNG_KERNEL_CONTEXT_NICE
= 4,
141 LTTNG_KERNEL_CONTEXT_VPID
= 5,
142 LTTNG_KERNEL_CONTEXT_TID
= 6,
143 LTTNG_KERNEL_CONTEXT_VTID
= 7,
144 LTTNG_KERNEL_CONTEXT_PPID
= 8,
145 LTTNG_KERNEL_CONTEXT_VPPID
= 9,
146 LTTNG_KERNEL_CONTEXT_HOSTNAME
= 10,
147 LTTNG_KERNEL_CONTEXT_CPU_ID
= 11,
148 LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE
= 12,
149 LTTNG_KERNEL_CONTEXT_PREEMPTIBLE
= 13,
150 LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE
= 14,
151 LTTNG_KERNEL_CONTEXT_MIGRATABLE
= 15,
152 LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL
= 16,
153 LTTNG_KERNEL_CONTEXT_CALLSTACK_USER
= 17,
156 struct lttng_kernel_perf_counter_ctx
{
159 char name
[LTTNG_KERNEL_SYM_NAME_LEN
];
160 } __attribute__((packed
));
162 #define LTTNG_KERNEL_CONTEXT_PADDING1 16
163 #define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
164 struct lttng_kernel_context
{
165 enum lttng_kernel_context_type ctx
;
166 char padding
[LTTNG_KERNEL_CONTEXT_PADDING1
];
169 struct lttng_kernel_perf_counter_ctx perf_counter
;
170 char padding
[LTTNG_KERNEL_CONTEXT_PADDING2
];
172 } __attribute__((packed
));
174 #define LTTNG_KERNEL_FILTER_BYTECODE_MAX_LEN 65536
175 struct lttng_kernel_filter_bytecode
{
177 uint32_t reloc_offset
;
180 } __attribute__((packed
));
182 /* LTTng file descriptor ioctl */
183 #define LTTNG_KERNEL_SESSION _IO(0xF6, 0x45)
184 #define LTTNG_KERNEL_TRACER_VERSION \
185 _IOR(0xF6, 0x46, struct lttng_kernel_tracer_version)
186 #define LTTNG_KERNEL_TRACEPOINT_LIST _IO(0xF6, 0x47)
187 #define LTTNG_KERNEL_WAIT_QUIESCENT _IO(0xF6, 0x48)
188 #define LTTNG_KERNEL_CALIBRATE \
189 _IOWR(0xF6, 0x49, struct lttng_kernel_calibrate)
190 #define LTTNG_KERNEL_SYSCALL_LIST _IO(0xF6, 0x4A)
191 #define LTTNG_KERNEL_TRACER_ABI_VERSION \
192 _IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version)
194 /* Session FD ioctl */
195 #define LTTNG_KERNEL_METADATA \
196 _IOW(0xF6, 0x54, struct lttng_kernel_channel)
197 #define LTTNG_KERNEL_CHANNEL \
198 _IOW(0xF6, 0x55, struct lttng_kernel_channel)
199 #define LTTNG_KERNEL_SESSION_START _IO(0xF6, 0x56)
200 #define LTTNG_KERNEL_SESSION_STOP _IO(0xF6, 0x57)
201 #define LTTNG_KERNEL_SESSION_TRACK_PID \
202 _IOR(0xF6, 0x58, int32_t)
203 #define LTTNG_KERNEL_SESSION_UNTRACK_PID \
204 _IOR(0xF6, 0x59, int32_t)
206 * ioctl 0x58 and 0x59 are duplicated here. It works, since _IOR vs _IO
207 * are generating two different ioctl numbers, but this was not done on
208 * purpose. We should generally try to avoid those duplications.
210 #define LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS _IO(0xF6, 0x58)
211 #define LTTNG_KERNEL_SESSION_METADATA_REGEN _IO(0xF6, 0x59)
212 /* 0x5A and 0x5B are reserved for a future ABI-breaking cleanup. */
213 #define LTTNG_KERNEL_SESSION_STATEDUMP _IO(0xF6, 0x5C)
215 /* Channel FD ioctl */
216 #define LTTNG_KERNEL_STREAM _IO(0xF6, 0x62)
217 #define LTTNG_KERNEL_EVENT \
218 _IOW(0xF6, 0x63, struct lttng_kernel_event)
219 #define LTTNG_KERNEL_SYSCALL_MASK \
220 _IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask)
222 /* Event and Channel FD ioctl */
223 #define LTTNG_KERNEL_CONTEXT \
224 _IOW(0xF6, 0x71, struct lttng_kernel_context)
226 /* Event, Channel and Session ioctl */
227 #define LTTNG_KERNEL_ENABLE _IO(0xF6, 0x82)
228 #define LTTNG_KERNEL_DISABLE _IO(0xF6, 0x83)
231 #define LTTNG_KERNEL_FILTER _IO(0xF6, 0x90)
232 #define LTTNG_KERNEL_ADD_CALLSITE _IO(0xF6, 0x91)
234 /* LTTng-specific ioctls for the lib ringbuffer */
235 /* returns the timestamp begin of the current sub-buffer */
236 #define LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN _IOR(0xF6, 0x20, uint64_t)
237 /* returns the timestamp end of the current sub-buffer */
238 #define LTTNG_RING_BUFFER_GET_TIMESTAMP_END _IOR(0xF6, 0x21, uint64_t)
239 /* returns the number of events discarded */
240 #define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED _IOR(0xF6, 0x22, uint64_t)
241 /* returns the packet payload size */
242 #define LTTNG_RING_BUFFER_GET_CONTENT_SIZE _IOR(0xF6, 0x23, uint64_t)
243 /* returns the actual packet size */
244 #define LTTNG_RING_BUFFER_GET_PACKET_SIZE _IOR(0xF6, 0x24, uint64_t)
245 /* returns the stream id */
246 #define LTTNG_RING_BUFFER_GET_STREAM_ID _IOR(0xF6, 0x25, uint64_t)
247 /* returns the current timestamp */
248 #define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t)
249 /* returns the packet sequence number */
250 #define LTTNG_RING_BUFFER_GET_SEQ_NUM _IOR(0xF6, 0x27, uint64_t)
251 /* returns the stream instance id */
252 #define LTTNG_RING_BUFFER_INSTANCE_ID _IOR(0xF6, 0x28, uint64_t)
255 /* returns the timestamp begin of the current sub-buffer */
256 #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_BEGIN \
257 LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN
258 /* returns the timestamp end of the current sub-buffer */
259 #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END \
260 LTTNG_RING_BUFFER_GET_TIMESTAMP_END
261 /* returns the number of events discarded */
262 #define LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED \
263 LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED
264 /* returns the packet payload size */
265 #define LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE \
266 LTTNG_RING_BUFFER_GET_CONTENT_SIZE
267 /* returns the actual packet size */
268 #define LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE \
269 LTTNG_RING_BUFFER_GET_PACKET_SIZE
270 /* returns the stream id */
271 #define LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID \
272 LTTNG_RING_BUFFER_GET_STREAM_ID
273 /* returns the current timestamp */
274 #define LTTNG_RING_BUFFER_COMPAT_GET_CURRENT_TIMESTAMP \
275 LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
276 /* returns the packet sequence number */
277 #define LTTNG_RING_BUFFER_COMPAT_GET_SEQ_NUM \
278 LTTNG_RING_BUFFER_GET_SEQ_NUM
279 /* returns the stream instance id */
280 #define LTTNG_RING_BUFFER_COMPAT_INSTANCE_ID \
281 LTTNG_RING_BUFFER_INSTANCE_ID
282 #endif /* CONFIG_COMPAT */
284 #endif /* _LTTNG_ABI_H */