Commit | Line | Data |
---|---|---|
9f36eaed MJ |
1 | /* SPDX-License-Identifier: (GPL-2.0 or LGPL-2.1) |
2 | * | |
e8951e63 | 3 | * lttng-abi.h |
57a13317 | 4 | * |
80996790 | 5 | * LTTng ABI header |
17baffe2 | 6 | * |
886d51a3 | 7 | * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
57a13317 MD |
8 | */ |
9 | ||
9f36eaed MJ |
10 | #ifndef _LTTNG_ABI_H |
11 | #define _LTTNG_ABI_H | |
12 | ||
57a13317 MD |
13 | #include <linux/fs.h> |
14 | ||
42cabb80 MD |
15 | /* |
16 | * Major/minor version of ABI exposed to lttng tools. Major number | |
17 | * should be increased when an incompatible ABI change is done. | |
18 | */ | |
3c997079 | 19 | #define LTTNG_MODULES_ABI_MAJOR_VERSION 2 |
e026f97d | 20 | #define LTTNG_MODULES_ABI_MINOR_VERSION 4 |
42cabb80 | 21 | |
f8695253 | 22 | #define LTTNG_KERNEL_SYM_NAME_LEN 256 |
e026f97d | 23 | #define LTTNG_KERNEL_SESSION_NAME_LEN 256 |
a9550ab5 | 24 | #define LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN 26 |
d6d808f3 | 25 | |
38d024ae | 26 | enum lttng_kernel_instrumentation { |
4c183524 MD |
27 | LTTNG_KERNEL_TRACEPOINT = 0, |
28 | LTTNG_KERNEL_KPROBE = 1, | |
29 | LTTNG_KERNEL_FUNCTION = 2, | |
7371f44c | 30 | LTTNG_KERNEL_KRETPROBE = 3, |
1ec65de1 | 31 | LTTNG_KERNEL_NOOP = 4, /* not hooked */ |
43880ee8 | 32 | LTTNG_KERNEL_SYSCALL = 5, |
149b9a9d | 33 | LTTNG_KERNEL_UPROBE = 6, |
57a13317 MD |
34 | }; |
35 | ||
96ba7208 JD |
36 | /* |
37 | * LTTng consumer mode | |
38 | */ | |
39 | enum lttng_kernel_output { | |
40 | LTTNG_KERNEL_SPLICE = 0, | |
41 | LTTNG_KERNEL_MMAP = 1, | |
42 | }; | |
43 | ||
57a13317 MD |
44 | /* |
45 | * LTTng DebugFS ABI structures. | |
46 | */ | |
8e099bae | 47 | #define LTTNG_KERNEL_CHANNEL_PADDING LTTNG_KERNEL_SYM_NAME_LEN + 32 |
38d024ae | 48 | struct lttng_kernel_channel { |
9e245ead | 49 | uint64_t subbuf_size; /* in bytes */ |
80c16bcf | 50 | uint64_t num_subbuf; |
9e245ead MD |
51 | unsigned int switch_timer_interval; /* usecs */ |
52 | unsigned int read_timer_interval; /* usecs */ | |
96ba7208 | 53 | enum lttng_kernel_output output; /* splice, mmap */ |
6dccd6c1 | 54 | int overwrite; /* 1: overwrite, 0: discard */ |
8e099bae | 55 | char padding[LTTNG_KERNEL_CHANNEL_PADDING]; |
1a598612 | 56 | } __attribute__((packed)); |
57a13317 | 57 | |
7371f44c MD |
58 | struct lttng_kernel_kretprobe { |
59 | uint64_t addr; | |
60 | ||
61 | uint64_t offset; | |
f8695253 | 62 | char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN]; |
1a598612 | 63 | } __attribute__((packed)); |
7371f44c | 64 | |
38d024ae MD |
65 | /* |
66 | * Either addr is used, or symbol_name and offset. | |
67 | */ | |
68 | struct lttng_kernel_kprobe { | |
80c16bcf | 69 | uint64_t addr; |
38d024ae | 70 | |
80c16bcf | 71 | uint64_t offset; |
f8695253 | 72 | char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN]; |
1a598612 | 73 | } __attribute__((packed)); |
d6d808f3 | 74 | |
f17701fb | 75 | struct lttng_kernel_function_tracer { |
f8695253 | 76 | char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN]; |
1a598612 | 77 | } __attribute__((packed)); |
f17701fb | 78 | |
149b9a9d | 79 | struct lttng_kernel_uprobe { |
56377c91 | 80 | int fd; |
3aed4dca FD |
81 | } __attribute__((packed)); |
82 | ||
83 | struct lttng_kernel_event_callsite_uprobe { | |
149b9a9d YB |
84 | uint64_t offset; |
85 | } __attribute__((packed)); | |
86 | ||
3aed4dca FD |
87 | struct lttng_kernel_event_callsite { |
88 | union { | |
89 | struct lttng_kernel_event_callsite_uprobe uprobe; | |
90 | } u; | |
91 | } __attribute__((packed)); | |
92 | ||
e298d6af MD |
93 | enum lttng_kernel_syscall_entryexit { |
94 | LTTNG_KERNEL_SYSCALL_ENTRYEXIT = 0, | |
95 | LTTNG_KERNEL_SYSCALL_ENTRY = 1, /* Not implemented. */ | |
96 | LTTNG_KERNEL_SYSCALL_EXIT = 2, /* Not implemented. */ | |
97 | }; | |
98 | ||
99 | enum lttng_kernel_syscall_abi { | |
100 | LTTNG_KERNEL_SYSCALL_ABI_ALL = 0, | |
101 | LTTNG_KERNEL_SYSCALL_ABI_NATIVE = 1, /* Not implemented. */ | |
102 | LTTNG_KERNEL_SYSCALL_ABI_COMPAT = 2, /* Not implemented. */ | |
103 | }; | |
104 | ||
105 | enum lttng_kernel_syscall_match { | |
106 | LTTNG_SYSCALL_MATCH_NAME = 0, | |
107 | LTTNG_SYSCALL_MATCH_NR = 1, /* Not implemented. */ | |
108 | }; | |
109 | ||
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 */ | |
114 | uint8_t padding; | |
115 | uint32_t nr; /* For LTTNG_SYSCALL_MATCH_NR */ | |
116 | } __attribute__((packed)); | |
117 | ||
43880ee8 | 118 | /* |
3c997079 | 119 | * For syscall tracing, name = "*" means "enable all". |
43880ee8 | 120 | */ |
8e099bae MD |
121 | #define LTTNG_KERNEL_EVENT_PADDING1 16 |
122 | #define LTTNG_KERNEL_EVENT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32 | |
d6d808f3 | 123 | struct lttng_kernel_event { |
f8695253 | 124 | char name[LTTNG_KERNEL_SYM_NAME_LEN]; /* event name */ |
d6d808f3 | 125 | enum lttng_kernel_instrumentation instrumentation; |
8e099bae MD |
126 | char padding[LTTNG_KERNEL_EVENT_PADDING1]; |
127 | ||
d6d808f3 MD |
128 | /* Per instrumentation type configuration */ |
129 | union { | |
7371f44c | 130 | struct lttng_kernel_kretprobe kretprobe; |
d6d808f3 | 131 | struct lttng_kernel_kprobe kprobe; |
f17701fb | 132 | struct lttng_kernel_function_tracer ftrace; |
149b9a9d | 133 | struct lttng_kernel_uprobe uprobe; |
e298d6af | 134 | struct lttng_kernel_syscall syscall; |
8e099bae | 135 | char padding[LTTNG_KERNEL_EVENT_PADDING2]; |
d6d808f3 | 136 | } u; |
1a598612 | 137 | } __attribute__((packed)); |
c099397a | 138 | |
80c16bcf | 139 | struct lttng_kernel_tracer_version { |
c6c9e10f MD |
140 | uint32_t major; |
141 | uint32_t minor; | |
80c16bcf | 142 | uint32_t patchlevel; |
1a598612 | 143 | } __attribute__((packed)); |
80c16bcf | 144 | |
42cabb80 MD |
145 | struct lttng_kernel_tracer_abi_version { |
146 | uint32_t major; | |
147 | uint32_t minor; | |
148 | } __attribute__((packed)); | |
149 | ||
e026f97d JR |
150 | struct lttng_kernel_session_name { |
151 | char name[LTTNG_KERNEL_SESSION_NAME_LEN]; | |
152 | } __attribute__((packed)); | |
153 | ||
a9550ab5 JR |
154 | struct lttng_kernel_session_creation_time { |
155 | char iso8601[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN]; | |
156 | } __attribute__((packed)); | |
157 | ||
3db41b2c MD |
158 | enum lttng_kernel_calibrate_type { |
159 | LTTNG_KERNEL_CALIBRATE_KRETPROBE, | |
57105fc2 MD |
160 | }; |
161 | ||
3db41b2c MD |
162 | struct lttng_kernel_calibrate { |
163 | enum lttng_kernel_calibrate_type type; /* type (input) */ | |
1a598612 | 164 | } __attribute__((packed)); |
57105fc2 | 165 | |
12e579db MD |
166 | struct lttng_kernel_syscall_mask { |
167 | uint32_t len; /* in bits */ | |
168 | char mask[]; | |
169 | } __attribute__((packed)); | |
170 | ||
12a313a5 | 171 | enum lttng_kernel_context_type { |
4c183524 MD |
172 | LTTNG_KERNEL_CONTEXT_PID = 0, |
173 | LTTNG_KERNEL_CONTEXT_PERF_COUNTER = 1, | |
a2563e83 | 174 | LTTNG_KERNEL_CONTEXT_PROCNAME = 2, |
4c183524 MD |
175 | LTTNG_KERNEL_CONTEXT_PRIO = 3, |
176 | LTTNG_KERNEL_CONTEXT_NICE = 4, | |
177 | LTTNG_KERNEL_CONTEXT_VPID = 5, | |
178 | LTTNG_KERNEL_CONTEXT_TID = 6, | |
179 | LTTNG_KERNEL_CONTEXT_VTID = 7, | |
180 | LTTNG_KERNEL_CONTEXT_PPID = 8, | |
181 | LTTNG_KERNEL_CONTEXT_VPPID = 9, | |
975da2c0 | 182 | LTTNG_KERNEL_CONTEXT_HOSTNAME = 10, |
b3699d90 | 183 | LTTNG_KERNEL_CONTEXT_CPU_ID = 11, |
79150a49 JD |
184 | LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE = 12, |
185 | LTTNG_KERNEL_CONTEXT_PREEMPTIBLE = 13, | |
186 | LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE = 14, | |
187 | LTTNG_KERNEL_CONTEXT_MIGRATABLE = 15, | |
2fa2d39a FG |
188 | LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL = 16, |
189 | LTTNG_KERNEL_CONTEXT_CALLSTACK_USER = 17, | |
8070f5c0 MD |
190 | }; |
191 | ||
192 | struct lttng_kernel_perf_counter_ctx { | |
193 | uint32_t type; | |
194 | uint64_t config; | |
f8695253 | 195 | char name[LTTNG_KERNEL_SYM_NAME_LEN]; |
1a598612 | 196 | } __attribute__((packed)); |
8070f5c0 | 197 | |
8e099bae MD |
198 | #define LTTNG_KERNEL_CONTEXT_PADDING1 16 |
199 | #define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32 | |
8070f5c0 | 200 | struct lttng_kernel_context { |
12a313a5 | 201 | enum lttng_kernel_context_type ctx; |
8e099bae MD |
202 | char padding[LTTNG_KERNEL_CONTEXT_PADDING1]; |
203 | ||
8070f5c0 | 204 | union { |
8070f5c0 | 205 | struct lttng_kernel_perf_counter_ctx perf_counter; |
8e099bae | 206 | char padding[LTTNG_KERNEL_CONTEXT_PADDING2]; |
8070f5c0 | 207 | } u; |
1a598612 | 208 | } __attribute__((packed)); |
8070f5c0 | 209 | |
f127e61e | 210 | #define LTTNG_KERNEL_FILTER_BYTECODE_MAX_LEN 65536 |
07dfc1d0 MD |
211 | struct lttng_kernel_filter_bytecode { |
212 | uint32_t len; | |
213 | uint32_t reloc_offset; | |
214 | uint64_t seqnum; | |
215 | char data[0]; | |
216 | } __attribute__((packed)); | |
217 | ||
33749530 | 218 | /* LTTng file descriptor ioctl */ |
6dccd6c1 | 219 | #define LTTNG_KERNEL_SESSION _IO(0xF6, 0x45) |
33749530 | 220 | #define LTTNG_KERNEL_TRACER_VERSION \ |
6dccd6c1 JD |
221 | _IOR(0xF6, 0x46, struct lttng_kernel_tracer_version) |
222 | #define LTTNG_KERNEL_TRACEPOINT_LIST _IO(0xF6, 0x47) | |
223 | #define LTTNG_KERNEL_WAIT_QUIESCENT _IO(0xF6, 0x48) | |
57105fc2 | 224 | #define LTTNG_KERNEL_CALIBRATE \ |
6dccd6c1 | 225 | _IOWR(0xF6, 0x49, struct lttng_kernel_calibrate) |
29c956bb | 226 | #define LTTNG_KERNEL_SYSCALL_LIST _IO(0xF6, 0x4A) |
42cabb80 MD |
227 | #define LTTNG_KERNEL_TRACER_ABI_VERSION \ |
228 | _IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version) | |
33749530 MD |
229 | |
230 | /* Session FD ioctl */ | |
231 | #define LTTNG_KERNEL_METADATA \ | |
6dccd6c1 | 232 | _IOW(0xF6, 0x54, struct lttng_kernel_channel) |
ab2277d6 | 233 | #define LTTNG_KERNEL_CHANNEL \ |
6dccd6c1 JD |
234 | _IOW(0xF6, 0x55, struct lttng_kernel_channel) |
235 | #define LTTNG_KERNEL_SESSION_START _IO(0xF6, 0x56) | |
236 | #define LTTNG_KERNEL_SESSION_STOP _IO(0xF6, 0x57) | |
e0130fab MD |
237 | #define LTTNG_KERNEL_SESSION_TRACK_PID \ |
238 | _IOR(0xF6, 0x58, int32_t) | |
239 | #define LTTNG_KERNEL_SESSION_UNTRACK_PID \ | |
240 | _IOR(0xF6, 0x59, int32_t) | |
fe40f016 MD |
241 | /* |
242 | * ioctl 0x58 and 0x59 are duplicated here. It works, since _IOR vs _IO | |
243 | * are generating two different ioctl numbers, but this was not done on | |
244 | * purpose. We should generally try to avoid those duplications. | |
245 | */ | |
7e6f9ef6 | 246 | #define LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS _IO(0xF6, 0x58) |
9616f0bf | 247 | #define LTTNG_KERNEL_SESSION_METADATA_REGEN _IO(0xF6, 0x59) |
e026f97d | 248 | |
601252cf MD |
249 | /* 0x5A and 0x5B are reserved for a future ABI-breaking cleanup. */ |
250 | #define LTTNG_KERNEL_SESSION_STATEDUMP _IO(0xF6, 0x5C) | |
e026f97d JR |
251 | #define LTTNG_KERNEL_SESSION_SET_NAME \ |
252 | _IOR(0xF6, 0x5D, struct lttng_kernel_session_name) | |
a9550ab5 JR |
253 | #define LTTNG_KERNEL_SESSION_SET_CREATION_TIME \ |
254 | _IOR(0xF6, 0x5E, struct lttng_kernel_session_creation_time) | |
33749530 MD |
255 | |
256 | /* Channel FD ioctl */ | |
6dccd6c1 | 257 | #define LTTNG_KERNEL_STREAM _IO(0xF6, 0x62) |
ab2277d6 | 258 | #define LTTNG_KERNEL_EVENT \ |
6dccd6c1 | 259 | _IOW(0xF6, 0x63, struct lttng_kernel_event) |
12e579db MD |
260 | #define LTTNG_KERNEL_SYSCALL_MASK \ |
261 | _IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask) | |
57a13317 | 262 | |
8070f5c0 MD |
263 | /* Event and Channel FD ioctl */ |
264 | #define LTTNG_KERNEL_CONTEXT \ | |
6dccd6c1 | 265 | _IOW(0xF6, 0x71, struct lttng_kernel_context) |
8070f5c0 | 266 | |
e64957da | 267 | /* Event, Channel and Session ioctl */ |
6dccd6c1 JD |
268 | #define LTTNG_KERNEL_ENABLE _IO(0xF6, 0x82) |
269 | #define LTTNG_KERNEL_DISABLE _IO(0xF6, 0x83) | |
e64957da | 270 | |
07dfc1d0 MD |
271 | /* Event FD ioctl */ |
272 | #define LTTNG_KERNEL_FILTER _IO(0xF6, 0x90) | |
3aed4dca | 273 | #define LTTNG_KERNEL_ADD_CALLSITE _IO(0xF6, 0x91) |
07dfc1d0 | 274 | |
72a20ef7 MD |
275 | /* |
276 | * LTTng-specific ioctls for the lib ringbuffer. | |
277 | * | |
278 | * Operations applying to the current sub-buffer need to occur between | |
279 | * a get/put or get_next/put_next ioctl pair. | |
280 | */ | |
281 | ||
3b731ab1 JD |
282 | /* returns the timestamp begin of the current sub-buffer */ |
283 | #define LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN _IOR(0xF6, 0x20, uint64_t) | |
284 | /* returns the timestamp end of the current sub-buffer */ | |
285 | #define LTTNG_RING_BUFFER_GET_TIMESTAMP_END _IOR(0xF6, 0x21, uint64_t) | |
72a20ef7 | 286 | /* returns the number of events discarded of the current sub-buffer */ |
3b731ab1 | 287 | #define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED _IOR(0xF6, 0x22, uint64_t) |
72a20ef7 | 288 | /* returns the packet payload size of the current sub-buffer */ |
3b731ab1 | 289 | #define LTTNG_RING_BUFFER_GET_CONTENT_SIZE _IOR(0xF6, 0x23, uint64_t) |
72a20ef7 | 290 | /* returns the packet size of the current sub-buffer*/ |
3b731ab1 | 291 | #define LTTNG_RING_BUFFER_GET_PACKET_SIZE _IOR(0xF6, 0x24, uint64_t) |
72a20ef7 | 292 | /* returns the stream id (invariant for the stream) */ |
3b731ab1 | 293 | #define LTTNG_RING_BUFFER_GET_STREAM_ID _IOR(0xF6, 0x25, uint64_t) |
72a20ef7 | 294 | /* returns the current timestamp as perceived from the tracer */ |
2348ca17 | 295 | #define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t) |
72a20ef7 | 296 | /* returns the packet sequence number of the current sub-buffer */ |
5b3cf4f9 | 297 | #define LTTNG_RING_BUFFER_GET_SEQ_NUM _IOR(0xF6, 0x27, uint64_t) |
72a20ef7 | 298 | /* returns the stream instance id (invariant for the stream) */ |
5594698f | 299 | #define LTTNG_RING_BUFFER_INSTANCE_ID _IOR(0xF6, 0x28, uint64_t) |
3b731ab1 JD |
300 | |
301 | #ifdef CONFIG_COMPAT | |
302 | /* returns the timestamp begin of the current sub-buffer */ | |
303 | #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_BEGIN \ | |
304 | LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN | |
305 | /* returns the timestamp end of the current sub-buffer */ | |
306 | #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END \ | |
307 | LTTNG_RING_BUFFER_GET_TIMESTAMP_END | |
72a20ef7 | 308 | /* returns the number of events discarded of the current sub-buffer */ |
3b731ab1 JD |
309 | #define LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED \ |
310 | LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED | |
72a20ef7 | 311 | /* returns the packet payload size of the current sub-buffer */ |
3b731ab1 JD |
312 | #define LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE \ |
313 | LTTNG_RING_BUFFER_GET_CONTENT_SIZE | |
72a20ef7 | 314 | /* returns the packet size of the current sub-buffer */ |
3b731ab1 JD |
315 | #define LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE \ |
316 | LTTNG_RING_BUFFER_GET_PACKET_SIZE | |
72a20ef7 | 317 | /* returns the stream id (invariant for the stream) */ |
3b731ab1 JD |
318 | #define LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID \ |
319 | LTTNG_RING_BUFFER_GET_STREAM_ID | |
72a20ef7 | 320 | /* returns the current timestamp as perceived from the tracer */ |
2348ca17 JD |
321 | #define LTTNG_RING_BUFFER_COMPAT_GET_CURRENT_TIMESTAMP \ |
322 | LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP | |
72a20ef7 | 323 | /* returns the packet sequence number of the current sub-buffer */ |
5b3cf4f9 JD |
324 | #define LTTNG_RING_BUFFER_COMPAT_GET_SEQ_NUM \ |
325 | LTTNG_RING_BUFFER_GET_SEQ_NUM | |
72a20ef7 | 326 | /* returns the stream instance id (invariant for the stream) */ |
5594698f JD |
327 | #define LTTNG_RING_BUFFER_COMPAT_INSTANCE_ID \ |
328 | LTTNG_RING_BUFFER_INSTANCE_ID | |
3b731ab1 JD |
329 | #endif /* CONFIG_COMPAT */ |
330 | ||
e8951e63 | 331 | #endif /* _LTTNG_ABI_H */ |