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 |
4993071a | 20 | #define LTTNG_MODULES_ABI_MINOR_VERSION 3 |
42cabb80 | 21 | |
f8695253 | 22 | #define LTTNG_KERNEL_SYM_NAME_LEN 256 |
d6d808f3 | 23 | |
38d024ae | 24 | enum lttng_kernel_instrumentation { |
4c183524 MD |
25 | LTTNG_KERNEL_TRACEPOINT = 0, |
26 | LTTNG_KERNEL_KPROBE = 1, | |
27 | LTTNG_KERNEL_FUNCTION = 2, | |
7371f44c | 28 | LTTNG_KERNEL_KRETPROBE = 3, |
1ec65de1 | 29 | LTTNG_KERNEL_NOOP = 4, /* not hooked */ |
43880ee8 | 30 | LTTNG_KERNEL_SYSCALL = 5, |
57a13317 MD |
31 | }; |
32 | ||
96ba7208 JD |
33 | /* |
34 | * LTTng consumer mode | |
35 | */ | |
36 | enum lttng_kernel_output { | |
37 | LTTNG_KERNEL_SPLICE = 0, | |
38 | LTTNG_KERNEL_MMAP = 1, | |
39 | }; | |
40 | ||
57a13317 MD |
41 | /* |
42 | * LTTng DebugFS ABI structures. | |
43 | */ | |
8e099bae | 44 | #define LTTNG_KERNEL_CHANNEL_PADDING LTTNG_KERNEL_SYM_NAME_LEN + 32 |
38d024ae | 45 | struct lttng_kernel_channel { |
9e245ead | 46 | uint64_t subbuf_size; /* in bytes */ |
80c16bcf | 47 | uint64_t num_subbuf; |
9e245ead MD |
48 | unsigned int switch_timer_interval; /* usecs */ |
49 | unsigned int read_timer_interval; /* usecs */ | |
96ba7208 | 50 | enum lttng_kernel_output output; /* splice, mmap */ |
6dccd6c1 | 51 | int overwrite; /* 1: overwrite, 0: discard */ |
8e099bae | 52 | char padding[LTTNG_KERNEL_CHANNEL_PADDING]; |
1a598612 | 53 | } __attribute__((packed)); |
57a13317 | 54 | |
7371f44c MD |
55 | struct lttng_kernel_kretprobe { |
56 | uint64_t addr; | |
57 | ||
58 | uint64_t offset; | |
f8695253 | 59 | char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN]; |
1a598612 | 60 | } __attribute__((packed)); |
7371f44c | 61 | |
38d024ae MD |
62 | /* |
63 | * Either addr is used, or symbol_name and offset. | |
64 | */ | |
65 | struct lttng_kernel_kprobe { | |
80c16bcf | 66 | uint64_t addr; |
38d024ae | 67 | |
80c16bcf | 68 | uint64_t offset; |
f8695253 | 69 | char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN]; |
1a598612 | 70 | } __attribute__((packed)); |
d6d808f3 | 71 | |
f17701fb | 72 | struct lttng_kernel_function_tracer { |
f8695253 | 73 | char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN]; |
1a598612 | 74 | } __attribute__((packed)); |
f17701fb | 75 | |
43880ee8 | 76 | /* |
3c997079 | 77 | * For syscall tracing, name = "*" means "enable all". |
43880ee8 | 78 | */ |
8e099bae MD |
79 | #define LTTNG_KERNEL_EVENT_PADDING1 16 |
80 | #define LTTNG_KERNEL_EVENT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32 | |
d6d808f3 | 81 | struct lttng_kernel_event { |
f8695253 | 82 | char name[LTTNG_KERNEL_SYM_NAME_LEN]; /* event name */ |
d6d808f3 | 83 | enum lttng_kernel_instrumentation instrumentation; |
8e099bae MD |
84 | char padding[LTTNG_KERNEL_EVENT_PADDING1]; |
85 | ||
d6d808f3 MD |
86 | /* Per instrumentation type configuration */ |
87 | union { | |
7371f44c | 88 | struct lttng_kernel_kretprobe kretprobe; |
d6d808f3 | 89 | struct lttng_kernel_kprobe kprobe; |
f17701fb | 90 | struct lttng_kernel_function_tracer ftrace; |
8e099bae | 91 | char padding[LTTNG_KERNEL_EVENT_PADDING2]; |
d6d808f3 | 92 | } u; |
1a598612 | 93 | } __attribute__((packed)); |
c099397a | 94 | |
80c16bcf | 95 | struct lttng_kernel_tracer_version { |
c6c9e10f MD |
96 | uint32_t major; |
97 | uint32_t minor; | |
80c16bcf | 98 | uint32_t patchlevel; |
1a598612 | 99 | } __attribute__((packed)); |
80c16bcf | 100 | |
42cabb80 MD |
101 | struct lttng_kernel_tracer_abi_version { |
102 | uint32_t major; | |
103 | uint32_t minor; | |
104 | } __attribute__((packed)); | |
105 | ||
3db41b2c MD |
106 | enum lttng_kernel_calibrate_type { |
107 | LTTNG_KERNEL_CALIBRATE_KRETPROBE, | |
57105fc2 MD |
108 | }; |
109 | ||
3db41b2c MD |
110 | struct lttng_kernel_calibrate { |
111 | enum lttng_kernel_calibrate_type type; /* type (input) */ | |
1a598612 | 112 | } __attribute__((packed)); |
57105fc2 | 113 | |
12e579db MD |
114 | struct lttng_kernel_syscall_mask { |
115 | uint32_t len; /* in bits */ | |
116 | char mask[]; | |
117 | } __attribute__((packed)); | |
118 | ||
12a313a5 | 119 | enum lttng_kernel_context_type { |
4c183524 MD |
120 | LTTNG_KERNEL_CONTEXT_PID = 0, |
121 | LTTNG_KERNEL_CONTEXT_PERF_COUNTER = 1, | |
a2563e83 | 122 | LTTNG_KERNEL_CONTEXT_PROCNAME = 2, |
4c183524 MD |
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, | |
975da2c0 | 130 | LTTNG_KERNEL_CONTEXT_HOSTNAME = 10, |
b3699d90 | 131 | LTTNG_KERNEL_CONTEXT_CPU_ID = 11, |
79150a49 JD |
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, | |
2fa2d39a FG |
136 | LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL = 16, |
137 | LTTNG_KERNEL_CONTEXT_CALLSTACK_USER = 17, | |
8070f5c0 MD |
138 | }; |
139 | ||
140 | struct lttng_kernel_perf_counter_ctx { | |
141 | uint32_t type; | |
142 | uint64_t config; | |
f8695253 | 143 | char name[LTTNG_KERNEL_SYM_NAME_LEN]; |
1a598612 | 144 | } __attribute__((packed)); |
8070f5c0 | 145 | |
8e099bae MD |
146 | #define LTTNG_KERNEL_CONTEXT_PADDING1 16 |
147 | #define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32 | |
8070f5c0 | 148 | struct lttng_kernel_context { |
12a313a5 | 149 | enum lttng_kernel_context_type ctx; |
8e099bae MD |
150 | char padding[LTTNG_KERNEL_CONTEXT_PADDING1]; |
151 | ||
8070f5c0 | 152 | union { |
8070f5c0 | 153 | struct lttng_kernel_perf_counter_ctx perf_counter; |
8e099bae | 154 | char padding[LTTNG_KERNEL_CONTEXT_PADDING2]; |
8070f5c0 | 155 | } u; |
1a598612 | 156 | } __attribute__((packed)); |
8070f5c0 | 157 | |
f127e61e | 158 | #define LTTNG_KERNEL_FILTER_BYTECODE_MAX_LEN 65536 |
07dfc1d0 MD |
159 | struct lttng_kernel_filter_bytecode { |
160 | uint32_t len; | |
161 | uint32_t reloc_offset; | |
162 | uint64_t seqnum; | |
163 | char data[0]; | |
164 | } __attribute__((packed)); | |
165 | ||
33749530 | 166 | /* LTTng file descriptor ioctl */ |
6dccd6c1 | 167 | #define LTTNG_KERNEL_SESSION _IO(0xF6, 0x45) |
33749530 | 168 | #define LTTNG_KERNEL_TRACER_VERSION \ |
6dccd6c1 JD |
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) | |
57105fc2 | 172 | #define LTTNG_KERNEL_CALIBRATE \ |
6dccd6c1 | 173 | _IOWR(0xF6, 0x49, struct lttng_kernel_calibrate) |
29c956bb | 174 | #define LTTNG_KERNEL_SYSCALL_LIST _IO(0xF6, 0x4A) |
42cabb80 MD |
175 | #define LTTNG_KERNEL_TRACER_ABI_VERSION \ |
176 | _IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version) | |
33749530 MD |
177 | |
178 | /* Session FD ioctl */ | |
179 | #define LTTNG_KERNEL_METADATA \ | |
6dccd6c1 | 180 | _IOW(0xF6, 0x54, struct lttng_kernel_channel) |
ab2277d6 | 181 | #define LTTNG_KERNEL_CHANNEL \ |
6dccd6c1 JD |
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) | |
e0130fab MD |
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) | |
fe40f016 MD |
189 | /* |
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. | |
193 | */ | |
7e6f9ef6 | 194 | #define LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS _IO(0xF6, 0x58) |
9616f0bf | 195 | #define LTTNG_KERNEL_SESSION_METADATA_REGEN _IO(0xF6, 0x59) |
601252cf MD |
196 | /* 0x5A and 0x5B are reserved for a future ABI-breaking cleanup. */ |
197 | #define LTTNG_KERNEL_SESSION_STATEDUMP _IO(0xF6, 0x5C) | |
33749530 MD |
198 | |
199 | /* Channel FD ioctl */ | |
6dccd6c1 | 200 | #define LTTNG_KERNEL_STREAM _IO(0xF6, 0x62) |
ab2277d6 | 201 | #define LTTNG_KERNEL_EVENT \ |
6dccd6c1 | 202 | _IOW(0xF6, 0x63, struct lttng_kernel_event) |
12e579db MD |
203 | #define LTTNG_KERNEL_SYSCALL_MASK \ |
204 | _IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask) | |
57a13317 | 205 | |
8070f5c0 MD |
206 | /* Event and Channel FD ioctl */ |
207 | #define LTTNG_KERNEL_CONTEXT \ | |
6dccd6c1 | 208 | _IOW(0xF6, 0x71, struct lttng_kernel_context) |
8070f5c0 | 209 | |
e64957da | 210 | /* Event, Channel and Session ioctl */ |
6dccd6c1 JD |
211 | #define LTTNG_KERNEL_ENABLE _IO(0xF6, 0x82) |
212 | #define LTTNG_KERNEL_DISABLE _IO(0xF6, 0x83) | |
e64957da | 213 | |
07dfc1d0 MD |
214 | /* Event FD ioctl */ |
215 | #define LTTNG_KERNEL_FILTER _IO(0xF6, 0x90) | |
216 | ||
3b731ab1 JD |
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) | |
2348ca17 JD |
230 | /* returns the current timestamp */ |
231 | #define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t) | |
5b3cf4f9 JD |
232 | /* returns the packet sequence number */ |
233 | #define LTTNG_RING_BUFFER_GET_SEQ_NUM _IOR(0xF6, 0x27, uint64_t) | |
5594698f JD |
234 | /* returns the stream instance id */ |
235 | #define LTTNG_RING_BUFFER_INSTANCE_ID _IOR(0xF6, 0x28, uint64_t) | |
3b731ab1 JD |
236 | |
237 | #ifdef CONFIG_COMPAT | |
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 | |
2348ca17 JD |
256 | /* returns the current timestamp */ |
257 | #define LTTNG_RING_BUFFER_COMPAT_GET_CURRENT_TIMESTAMP \ | |
258 | LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP | |
5b3cf4f9 JD |
259 | /* returns the packet sequence number */ |
260 | #define LTTNG_RING_BUFFER_COMPAT_GET_SEQ_NUM \ | |
261 | LTTNG_RING_BUFFER_GET_SEQ_NUM | |
5594698f JD |
262 | /* returns the stream instance id */ |
263 | #define LTTNG_RING_BUFFER_COMPAT_INSTANCE_ID \ | |
264 | LTTNG_RING_BUFFER_INSTANCE_ID | |
3b731ab1 JD |
265 | #endif /* CONFIG_COMPAT */ |
266 | ||
e8951e63 | 267 | #endif /* _LTTNG_ABI_H */ |