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,
36 enum lttng_kernel_output
{
37 LTTNG_KERNEL_SPLICE
= 0,
38 LTTNG_KERNEL_MMAP
= 1,
42 * LTTng DebugFS ABI structures.
44 #define LTTNG_KERNEL_CHANNEL_PADDING LTTNG_KERNEL_SYM_NAME_LEN + 32
45 struct lttng_kernel_channel
{
46 uint64_t subbuf_size
; /* in bytes */
48 unsigned int switch_timer_interval
; /* usecs */
49 unsigned int read_timer_interval
; /* usecs */
50 enum lttng_kernel_output output
; /* splice, mmap */
51 int overwrite
; /* 1: overwrite, 0: discard */
52 char padding
[LTTNG_KERNEL_CHANNEL_PADDING
];
53 } __attribute__((packed
));
55 struct lttng_kernel_kretprobe
{
59 char symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
];
60 } __attribute__((packed
));
63 * Either addr is used, or symbol_name and offset.
65 struct lttng_kernel_kprobe
{
69 char symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
];
70 } __attribute__((packed
));
72 struct lttng_kernel_function_tracer
{
73 char symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
];
74 } __attribute__((packed
));
77 * For syscall tracing, name = "*" means "enable all".
79 #define LTTNG_KERNEL_EVENT_PADDING1 16
80 #define LTTNG_KERNEL_EVENT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
81 struct lttng_kernel_event
{
82 char name
[LTTNG_KERNEL_SYM_NAME_LEN
]; /* event name */
83 enum lttng_kernel_instrumentation instrumentation
;
84 char padding
[LTTNG_KERNEL_EVENT_PADDING1
];
86 /* Per instrumentation type configuration */
88 struct lttng_kernel_kretprobe kretprobe
;
89 struct lttng_kernel_kprobe kprobe
;
90 struct lttng_kernel_function_tracer ftrace
;
91 char padding
[LTTNG_KERNEL_EVENT_PADDING2
];
93 } __attribute__((packed
));
95 struct lttng_kernel_tracer_version
{
99 } __attribute__((packed
));
101 struct lttng_kernel_tracer_abi_version
{
104 } __attribute__((packed
));
106 enum lttng_kernel_calibrate_type
{
107 LTTNG_KERNEL_CALIBRATE_KRETPROBE
,
110 struct lttng_kernel_calibrate
{
111 enum lttng_kernel_calibrate_type type
; /* type (input) */
112 } __attribute__((packed
));
114 struct lttng_kernel_syscall_mask
{
115 uint32_t len
; /* in bits */
117 } __attribute__((packed
));
119 enum lttng_kernel_context_type
{
120 LTTNG_KERNEL_CONTEXT_PID
= 0,
121 LTTNG_KERNEL_CONTEXT_PERF_COUNTER
= 1,
122 LTTNG_KERNEL_CONTEXT_PROCNAME
= 2,
123 LTTNG_KERNEL_CONTEXT_PRIO
= 3,
124 LTTNG_KERNEL_CONTEXT_NICE
= 4,
125 LTTNG_KERNEL_CONTEXT_VPID
= 5,
126 LTTNG_KERNEL_CONTEXT_TID
= 6,
127 LTTNG_KERNEL_CONTEXT_VTID
= 7,
128 LTTNG_KERNEL_CONTEXT_PPID
= 8,
129 LTTNG_KERNEL_CONTEXT_VPPID
= 9,
130 LTTNG_KERNEL_CONTEXT_HOSTNAME
= 10,
131 LTTNG_KERNEL_CONTEXT_CPU_ID
= 11,
132 LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE
= 12,
133 LTTNG_KERNEL_CONTEXT_PREEMPTIBLE
= 13,
134 LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE
= 14,
135 LTTNG_KERNEL_CONTEXT_MIGRATABLE
= 15,
136 LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL
= 16,
137 LTTNG_KERNEL_CONTEXT_CALLSTACK_USER
= 17,
140 struct lttng_kernel_perf_counter_ctx
{
143 char name
[LTTNG_KERNEL_SYM_NAME_LEN
];
144 } __attribute__((packed
));
146 #define LTTNG_KERNEL_CONTEXT_PADDING1 16
147 #define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
148 struct lttng_kernel_context
{
149 enum lttng_kernel_context_type ctx
;
150 char padding
[LTTNG_KERNEL_CONTEXT_PADDING1
];
153 struct lttng_kernel_perf_counter_ctx perf_counter
;
154 char padding
[LTTNG_KERNEL_CONTEXT_PADDING2
];
156 } __attribute__((packed
));
158 #define LTTNG_KERNEL_FILTER_BYTECODE_MAX_LEN 65536
159 struct lttng_kernel_filter_bytecode
{
161 uint32_t reloc_offset
;
164 } __attribute__((packed
));
166 /* LTTng file descriptor ioctl */
167 #define LTTNG_KERNEL_SESSION _IO(0xF6, 0x45)
168 #define LTTNG_KERNEL_TRACER_VERSION \
169 _IOR(0xF6, 0x46, struct lttng_kernel_tracer_version)
170 #define LTTNG_KERNEL_TRACEPOINT_LIST _IO(0xF6, 0x47)
171 #define LTTNG_KERNEL_WAIT_QUIESCENT _IO(0xF6, 0x48)
172 #define LTTNG_KERNEL_CALIBRATE \
173 _IOWR(0xF6, 0x49, struct lttng_kernel_calibrate)
174 #define LTTNG_KERNEL_SYSCALL_LIST _IO(0xF6, 0x4A)
175 #define LTTNG_KERNEL_TRACER_ABI_VERSION \
176 _IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version)
178 /* Session FD ioctl */
179 #define LTTNG_KERNEL_METADATA \
180 _IOW(0xF6, 0x54, struct lttng_kernel_channel)
181 #define LTTNG_KERNEL_CHANNEL \
182 _IOW(0xF6, 0x55, struct lttng_kernel_channel)
183 #define LTTNG_KERNEL_SESSION_START _IO(0xF6, 0x56)
184 #define LTTNG_KERNEL_SESSION_STOP _IO(0xF6, 0x57)
185 #define LTTNG_KERNEL_SESSION_TRACK_PID \
186 _IOR(0xF6, 0x58, int32_t)
187 #define LTTNG_KERNEL_SESSION_UNTRACK_PID \
188 _IOR(0xF6, 0x59, int32_t)
190 * ioctl 0x58 and 0x59 are duplicated here. It works, since _IOR vs _IO
191 * are generating two different ioctl numbers, but this was not done on
192 * purpose. We should generally try to avoid those duplications.
194 #define LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS _IO(0xF6, 0x58)
195 #define LTTNG_KERNEL_SESSION_METADATA_REGEN _IO(0xF6, 0x59)
196 /* 0x5A and 0x5B are reserved for a future ABI-breaking cleanup. */
197 #define LTTNG_KERNEL_SESSION_STATEDUMP _IO(0xF6, 0x5C)
199 /* Channel FD ioctl */
200 #define LTTNG_KERNEL_STREAM _IO(0xF6, 0x62)
201 #define LTTNG_KERNEL_EVENT \
202 _IOW(0xF6, 0x63, struct lttng_kernel_event)
203 #define LTTNG_KERNEL_SYSCALL_MASK \
204 _IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask)
206 /* Event and Channel FD ioctl */
207 #define LTTNG_KERNEL_CONTEXT \
208 _IOW(0xF6, 0x71, struct lttng_kernel_context)
210 /* Event, Channel and Session ioctl */
211 #define LTTNG_KERNEL_ENABLE _IO(0xF6, 0x82)
212 #define LTTNG_KERNEL_DISABLE _IO(0xF6, 0x83)
215 #define LTTNG_KERNEL_FILTER _IO(0xF6, 0x90)
217 /* LTTng-specific ioctls for the lib ringbuffer */
218 /* returns the timestamp begin of the current sub-buffer */
219 #define LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN _IOR(0xF6, 0x20, uint64_t)
220 /* returns the timestamp end of the current sub-buffer */
221 #define LTTNG_RING_BUFFER_GET_TIMESTAMP_END _IOR(0xF6, 0x21, uint64_t)
222 /* returns the number of events discarded */
223 #define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED _IOR(0xF6, 0x22, uint64_t)
224 /* returns the packet payload size */
225 #define LTTNG_RING_BUFFER_GET_CONTENT_SIZE _IOR(0xF6, 0x23, uint64_t)
226 /* returns the actual packet size */
227 #define LTTNG_RING_BUFFER_GET_PACKET_SIZE _IOR(0xF6, 0x24, uint64_t)
228 /* returns the stream id */
229 #define LTTNG_RING_BUFFER_GET_STREAM_ID _IOR(0xF6, 0x25, uint64_t)
230 /* returns the current timestamp */
231 #define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t)
232 /* returns the packet sequence number */
233 #define LTTNG_RING_BUFFER_GET_SEQ_NUM _IOR(0xF6, 0x27, uint64_t)
234 /* returns the stream instance id */
235 #define LTTNG_RING_BUFFER_INSTANCE_ID _IOR(0xF6, 0x28, uint64_t)
238 /* returns the timestamp begin of the current sub-buffer */
239 #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_BEGIN \
240 LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN
241 /* returns the timestamp end of the current sub-buffer */
242 #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END \
243 LTTNG_RING_BUFFER_GET_TIMESTAMP_END
244 /* returns the number of events discarded */
245 #define LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED \
246 LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED
247 /* returns the packet payload size */
248 #define LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE \
249 LTTNG_RING_BUFFER_GET_CONTENT_SIZE
250 /* returns the actual packet size */
251 #define LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE \
252 LTTNG_RING_BUFFER_GET_PACKET_SIZE
253 /* returns the stream id */
254 #define LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID \
255 LTTNG_RING_BUFFER_GET_STREAM_ID
256 /* returns the current timestamp */
257 #define LTTNG_RING_BUFFER_COMPAT_GET_CURRENT_TIMESTAMP \
258 LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
259 /* returns the packet sequence number */
260 #define LTTNG_RING_BUFFER_COMPAT_GET_SEQ_NUM \
261 LTTNG_RING_BUFFER_GET_SEQ_NUM
262 /* returns the stream instance id */
263 #define LTTNG_RING_BUFFER_COMPAT_INSTANCE_ID \
264 LTTNG_RING_BUFFER_INSTANCE_ID
265 #endif /* CONFIG_COMPAT */
267 #endif /* _LTTNG_ABI_H */