Commit | Line | Data |
---|---|---|
e8951e63 MD |
1 | #ifndef _LTTNG_ABI_H |
2 | #define _LTTNG_ABI_H | |
57a13317 MD |
3 | |
4 | /* | |
e8951e63 | 5 | * lttng-abi.h |
57a13317 | 6 | * |
80996790 | 7 | * LTTng ABI header |
17baffe2 | 8 | * |
886d51a3 MD |
9 | * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
10 | * | |
11 | * This library is free software; you can redistribute it and/or | |
12 | * modify it under the terms of the GNU Lesser General Public | |
13 | * License as published by the Free Software Foundation; only | |
14 | * version 2.1 of the License. | |
15 | * | |
16 | * This library is distributed in the hope that it will be useful, | |
17 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
19 | * Lesser General Public License for more details. | |
20 | * | |
21 | * You should have received a copy of the GNU Lesser General Public | |
22 | * License along with this library; if not, write to the Free Software | |
23 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA | |
57a13317 MD |
24 | */ |
25 | ||
26 | #include <linux/fs.h> | |
27 | ||
42cabb80 MD |
28 | /* |
29 | * Major/minor version of ABI exposed to lttng tools. Major number | |
30 | * should be increased when an incompatible ABI change is done. | |
31 | */ | |
3c997079 | 32 | #define LTTNG_MODULES_ABI_MAJOR_VERSION 2 |
42cabb80 MD |
33 | #define LTTNG_MODULES_ABI_MINOR_VERSION 0 |
34 | ||
f8695253 | 35 | #define LTTNG_KERNEL_SYM_NAME_LEN 256 |
d6d808f3 | 36 | |
38d024ae | 37 | enum lttng_kernel_instrumentation { |
4c183524 MD |
38 | LTTNG_KERNEL_TRACEPOINT = 0, |
39 | LTTNG_KERNEL_KPROBE = 1, | |
40 | LTTNG_KERNEL_FUNCTION = 2, | |
7371f44c | 41 | LTTNG_KERNEL_KRETPROBE = 3, |
1ec65de1 | 42 | LTTNG_KERNEL_NOOP = 4, /* not hooked */ |
43880ee8 | 43 | LTTNG_KERNEL_SYSCALL = 5, |
57a13317 MD |
44 | }; |
45 | ||
96ba7208 JD |
46 | /* |
47 | * LTTng consumer mode | |
48 | */ | |
49 | enum lttng_kernel_output { | |
50 | LTTNG_KERNEL_SPLICE = 0, | |
51 | LTTNG_KERNEL_MMAP = 1, | |
52 | }; | |
53 | ||
57a13317 MD |
54 | /* |
55 | * LTTng DebugFS ABI structures. | |
56 | */ | |
8e099bae | 57 | #define LTTNG_KERNEL_CHANNEL_PADDING LTTNG_KERNEL_SYM_NAME_LEN + 32 |
38d024ae | 58 | struct lttng_kernel_channel { |
9e245ead | 59 | uint64_t subbuf_size; /* in bytes */ |
80c16bcf | 60 | uint64_t num_subbuf; |
9e245ead MD |
61 | unsigned int switch_timer_interval; /* usecs */ |
62 | unsigned int read_timer_interval; /* usecs */ | |
96ba7208 | 63 | enum lttng_kernel_output output; /* splice, mmap */ |
6dccd6c1 | 64 | int overwrite; /* 1: overwrite, 0: discard */ |
8e099bae | 65 | char padding[LTTNG_KERNEL_CHANNEL_PADDING]; |
1a598612 | 66 | } __attribute__((packed)); |
57a13317 | 67 | |
7371f44c MD |
68 | struct lttng_kernel_kretprobe { |
69 | uint64_t addr; | |
70 | ||
71 | uint64_t offset; | |
f8695253 | 72 | char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN]; |
1a598612 | 73 | } __attribute__((packed)); |
7371f44c | 74 | |
38d024ae MD |
75 | /* |
76 | * Either addr is used, or symbol_name and offset. | |
77 | */ | |
78 | struct lttng_kernel_kprobe { | |
80c16bcf | 79 | uint64_t addr; |
38d024ae | 80 | |
80c16bcf | 81 | uint64_t offset; |
f8695253 | 82 | char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN]; |
1a598612 | 83 | } __attribute__((packed)); |
d6d808f3 | 84 | |
f17701fb | 85 | struct lttng_kernel_function_tracer { |
f8695253 | 86 | char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN]; |
1a598612 | 87 | } __attribute__((packed)); |
f17701fb | 88 | |
80f87dd2 | 89 | struct lttng_kernel_syscall { |
4ee2453d | 90 | char enable; |
80f87dd2 MD |
91 | } __attribute__((packed)); |
92 | ||
43880ee8 | 93 | /* |
3c997079 | 94 | * For syscall tracing, name = "*" means "enable all". |
43880ee8 | 95 | */ |
8e099bae MD |
96 | #define LTTNG_KERNEL_EVENT_PADDING1 16 |
97 | #define LTTNG_KERNEL_EVENT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32 | |
d6d808f3 | 98 | struct lttng_kernel_event { |
f8695253 | 99 | char name[LTTNG_KERNEL_SYM_NAME_LEN]; /* event name */ |
d6d808f3 | 100 | enum lttng_kernel_instrumentation instrumentation; |
8e099bae MD |
101 | char padding[LTTNG_KERNEL_EVENT_PADDING1]; |
102 | ||
d6d808f3 MD |
103 | /* Per instrumentation type configuration */ |
104 | union { | |
7371f44c | 105 | struct lttng_kernel_kretprobe kretprobe; |
d6d808f3 | 106 | struct lttng_kernel_kprobe kprobe; |
f17701fb | 107 | struct lttng_kernel_function_tracer ftrace; |
80f87dd2 | 108 | struct lttng_kernel_syscall syscall; |
8e099bae | 109 | char padding[LTTNG_KERNEL_EVENT_PADDING2]; |
d6d808f3 | 110 | } u; |
1a598612 | 111 | } __attribute__((packed)); |
c099397a | 112 | |
80c16bcf | 113 | struct lttng_kernel_tracer_version { |
c6c9e10f MD |
114 | uint32_t major; |
115 | uint32_t minor; | |
80c16bcf | 116 | uint32_t patchlevel; |
1a598612 | 117 | } __attribute__((packed)); |
80c16bcf | 118 | |
42cabb80 MD |
119 | struct lttng_kernel_tracer_abi_version { |
120 | uint32_t major; | |
121 | uint32_t minor; | |
122 | } __attribute__((packed)); | |
123 | ||
3db41b2c MD |
124 | enum lttng_kernel_calibrate_type { |
125 | LTTNG_KERNEL_CALIBRATE_KRETPROBE, | |
57105fc2 MD |
126 | }; |
127 | ||
3db41b2c MD |
128 | struct lttng_kernel_calibrate { |
129 | enum lttng_kernel_calibrate_type type; /* type (input) */ | |
1a598612 | 130 | } __attribute__((packed)); |
57105fc2 | 131 | |
12e579db MD |
132 | struct lttng_kernel_syscall_mask { |
133 | uint32_t len; /* in bits */ | |
134 | char mask[]; | |
135 | } __attribute__((packed)); | |
136 | ||
12a313a5 | 137 | enum lttng_kernel_context_type { |
4c183524 MD |
138 | LTTNG_KERNEL_CONTEXT_PID = 0, |
139 | LTTNG_KERNEL_CONTEXT_PERF_COUNTER = 1, | |
a2563e83 | 140 | LTTNG_KERNEL_CONTEXT_PROCNAME = 2, |
4c183524 MD |
141 | LTTNG_KERNEL_CONTEXT_PRIO = 3, |
142 | LTTNG_KERNEL_CONTEXT_NICE = 4, | |
143 | LTTNG_KERNEL_CONTEXT_VPID = 5, | |
144 | LTTNG_KERNEL_CONTEXT_TID = 6, | |
145 | LTTNG_KERNEL_CONTEXT_VTID = 7, | |
146 | LTTNG_KERNEL_CONTEXT_PPID = 8, | |
147 | LTTNG_KERNEL_CONTEXT_VPPID = 9, | |
975da2c0 | 148 | LTTNG_KERNEL_CONTEXT_HOSTNAME = 10, |
8070f5c0 MD |
149 | }; |
150 | ||
151 | struct lttng_kernel_perf_counter_ctx { | |
152 | uint32_t type; | |
153 | uint64_t config; | |
f8695253 | 154 | char name[LTTNG_KERNEL_SYM_NAME_LEN]; |
1a598612 | 155 | } __attribute__((packed)); |
8070f5c0 | 156 | |
8e099bae MD |
157 | #define LTTNG_KERNEL_CONTEXT_PADDING1 16 |
158 | #define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32 | |
8070f5c0 | 159 | struct lttng_kernel_context { |
12a313a5 | 160 | enum lttng_kernel_context_type ctx; |
8e099bae MD |
161 | char padding[LTTNG_KERNEL_CONTEXT_PADDING1]; |
162 | ||
8070f5c0 | 163 | union { |
8070f5c0 | 164 | struct lttng_kernel_perf_counter_ctx perf_counter; |
8e099bae | 165 | char padding[LTTNG_KERNEL_CONTEXT_PADDING2]; |
8070f5c0 | 166 | } u; |
1a598612 | 167 | } __attribute__((packed)); |
8070f5c0 | 168 | |
33749530 | 169 | /* LTTng file descriptor ioctl */ |
6dccd6c1 | 170 | #define LTTNG_KERNEL_SESSION _IO(0xF6, 0x45) |
33749530 | 171 | #define LTTNG_KERNEL_TRACER_VERSION \ |
6dccd6c1 JD |
172 | _IOR(0xF6, 0x46, struct lttng_kernel_tracer_version) |
173 | #define LTTNG_KERNEL_TRACEPOINT_LIST _IO(0xF6, 0x47) | |
174 | #define LTTNG_KERNEL_WAIT_QUIESCENT _IO(0xF6, 0x48) | |
57105fc2 | 175 | #define LTTNG_KERNEL_CALIBRATE \ |
6dccd6c1 | 176 | _IOWR(0xF6, 0x49, struct lttng_kernel_calibrate) |
29c956bb | 177 | #define LTTNG_KERNEL_SYSCALL_LIST _IO(0xF6, 0x4A) |
42cabb80 MD |
178 | #define LTTNG_KERNEL_TRACER_ABI_VERSION \ |
179 | _IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version) | |
33749530 MD |
180 | |
181 | /* Session FD ioctl */ | |
182 | #define LTTNG_KERNEL_METADATA \ | |
6dccd6c1 | 183 | _IOW(0xF6, 0x54, struct lttng_kernel_channel) |
ab2277d6 | 184 | #define LTTNG_KERNEL_CHANNEL \ |
6dccd6c1 JD |
185 | _IOW(0xF6, 0x55, struct lttng_kernel_channel) |
186 | #define LTTNG_KERNEL_SESSION_START _IO(0xF6, 0x56) | |
187 | #define LTTNG_KERNEL_SESSION_STOP _IO(0xF6, 0x57) | |
e0130fab MD |
188 | #define LTTNG_KERNEL_SESSION_TRACK_PID \ |
189 | _IOR(0xF6, 0x58, int32_t) | |
190 | #define LTTNG_KERNEL_SESSION_UNTRACK_PID \ | |
191 | _IOR(0xF6, 0x59, int32_t) | |
7e6f9ef6 | 192 | #define LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS _IO(0xF6, 0x58) |
33749530 MD |
193 | |
194 | /* Channel FD ioctl */ | |
6dccd6c1 | 195 | #define LTTNG_KERNEL_STREAM _IO(0xF6, 0x62) |
ab2277d6 | 196 | #define LTTNG_KERNEL_EVENT \ |
6dccd6c1 | 197 | _IOW(0xF6, 0x63, struct lttng_kernel_event) |
12e579db MD |
198 | #define LTTNG_KERNEL_SYSCALL_MASK \ |
199 | _IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask) | |
57a13317 | 200 | |
8070f5c0 MD |
201 | /* Event and Channel FD ioctl */ |
202 | #define LTTNG_KERNEL_CONTEXT \ | |
6dccd6c1 | 203 | _IOW(0xF6, 0x71, struct lttng_kernel_context) |
8070f5c0 | 204 | |
e64957da | 205 | /* Event, Channel and Session ioctl */ |
6dccd6c1 JD |
206 | #define LTTNG_KERNEL_ENABLE _IO(0xF6, 0x82) |
207 | #define LTTNG_KERNEL_DISABLE _IO(0xF6, 0x83) | |
e64957da | 208 | |
3b731ab1 JD |
209 | /* LTTng-specific ioctls for the lib ringbuffer */ |
210 | /* returns the timestamp begin of the current sub-buffer */ | |
211 | #define LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN _IOR(0xF6, 0x20, uint64_t) | |
212 | /* returns the timestamp end of the current sub-buffer */ | |
213 | #define LTTNG_RING_BUFFER_GET_TIMESTAMP_END _IOR(0xF6, 0x21, uint64_t) | |
214 | /* returns the number of events discarded */ | |
215 | #define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED _IOR(0xF6, 0x22, uint64_t) | |
216 | /* returns the packet payload size */ | |
217 | #define LTTNG_RING_BUFFER_GET_CONTENT_SIZE _IOR(0xF6, 0x23, uint64_t) | |
218 | /* returns the actual packet size */ | |
219 | #define LTTNG_RING_BUFFER_GET_PACKET_SIZE _IOR(0xF6, 0x24, uint64_t) | |
220 | /* returns the stream id */ | |
221 | #define LTTNG_RING_BUFFER_GET_STREAM_ID _IOR(0xF6, 0x25, uint64_t) | |
2348ca17 JD |
222 | /* returns the current timestamp */ |
223 | #define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t) | |
3b731ab1 JD |
224 | |
225 | #ifdef CONFIG_COMPAT | |
226 | /* returns the timestamp begin of the current sub-buffer */ | |
227 | #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_BEGIN \ | |
228 | LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN | |
229 | /* returns the timestamp end of the current sub-buffer */ | |
230 | #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END \ | |
231 | LTTNG_RING_BUFFER_GET_TIMESTAMP_END | |
232 | /* returns the number of events discarded */ | |
233 | #define LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED \ | |
234 | LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED | |
235 | /* returns the packet payload size */ | |
236 | #define LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE \ | |
237 | LTTNG_RING_BUFFER_GET_CONTENT_SIZE | |
238 | /* returns the actual packet size */ | |
239 | #define LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE \ | |
240 | LTTNG_RING_BUFFER_GET_PACKET_SIZE | |
241 | /* returns the stream id */ | |
242 | #define LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID \ | |
243 | LTTNG_RING_BUFFER_GET_STREAM_ID | |
2348ca17 JD |
244 | /* returns the current timestamp */ |
245 | #define LTTNG_RING_BUFFER_COMPAT_GET_CURRENT_TIMESTAMP \ | |
246 | LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP | |
3b731ab1 JD |
247 | #endif /* CONFIG_COMPAT */ |
248 | ||
e8951e63 | 249 | #endif /* _LTTNG_ABI_H */ |