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 | ||
f8695253 | 28 | #define LTTNG_KERNEL_SYM_NAME_LEN 256 |
d6d808f3 | 29 | |
38d024ae | 30 | enum lttng_kernel_instrumentation { |
4c183524 MD |
31 | LTTNG_KERNEL_TRACEPOINT = 0, |
32 | LTTNG_KERNEL_KPROBE = 1, | |
33 | LTTNG_KERNEL_FUNCTION = 2, | |
7371f44c | 34 | LTTNG_KERNEL_KRETPROBE = 3, |
1ec65de1 | 35 | LTTNG_KERNEL_NOOP = 4, /* not hooked */ |
43880ee8 | 36 | LTTNG_KERNEL_SYSCALL = 5, |
57a13317 MD |
37 | }; |
38 | ||
96ba7208 JD |
39 | /* |
40 | * LTTng consumer mode | |
41 | */ | |
42 | enum lttng_kernel_output { | |
43 | LTTNG_KERNEL_SPLICE = 0, | |
44 | LTTNG_KERNEL_MMAP = 1, | |
45 | }; | |
46 | ||
57a13317 MD |
47 | /* |
48 | * LTTng DebugFS ABI structures. | |
49 | */ | |
8e099bae | 50 | #define LTTNG_KERNEL_CHANNEL_PADDING LTTNG_KERNEL_SYM_NAME_LEN + 32 |
38d024ae | 51 | struct lttng_kernel_channel { |
9e245ead | 52 | uint64_t subbuf_size; /* in bytes */ |
80c16bcf | 53 | uint64_t num_subbuf; |
9e245ead MD |
54 | unsigned int switch_timer_interval; /* usecs */ |
55 | unsigned int read_timer_interval; /* usecs */ | |
96ba7208 | 56 | enum lttng_kernel_output output; /* splice, mmap */ |
6dccd6c1 | 57 | int overwrite; /* 1: overwrite, 0: discard */ |
8e099bae | 58 | char padding[LTTNG_KERNEL_CHANNEL_PADDING]; |
6dccd6c1 | 59 | }__attribute__((packed)); |
57a13317 | 60 | |
7371f44c MD |
61 | struct lttng_kernel_kretprobe { |
62 | uint64_t addr; | |
63 | ||
64 | uint64_t offset; | |
f8695253 | 65 | char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN]; |
6dccd6c1 | 66 | }__attribute__((packed)); |
7371f44c | 67 | |
38d024ae MD |
68 | /* |
69 | * Either addr is used, or symbol_name and offset. | |
70 | */ | |
71 | struct lttng_kernel_kprobe { | |
80c16bcf | 72 | uint64_t addr; |
38d024ae | 73 | |
80c16bcf | 74 | uint64_t offset; |
f8695253 | 75 | char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN]; |
6dccd6c1 | 76 | }__attribute__((packed)); |
d6d808f3 | 77 | |
f17701fb | 78 | struct lttng_kernel_function_tracer { |
f8695253 | 79 | char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN]; |
6dccd6c1 | 80 | }__attribute__((packed)); |
f17701fb | 81 | |
80f87dd2 MD |
82 | struct lttng_kernel_syscall { |
83 | char disable; | |
84 | } __attribute__((packed)); | |
85 | ||
43880ee8 MD |
86 | /* |
87 | * For syscall tracing, name = '\0' means "enable all". | |
88 | */ | |
8e099bae MD |
89 | #define LTTNG_KERNEL_EVENT_PADDING1 16 |
90 | #define LTTNG_KERNEL_EVENT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32 | |
d6d808f3 | 91 | struct lttng_kernel_event { |
f8695253 | 92 | char name[LTTNG_KERNEL_SYM_NAME_LEN]; /* event name */ |
d6d808f3 | 93 | enum lttng_kernel_instrumentation instrumentation; |
8e099bae MD |
94 | char padding[LTTNG_KERNEL_EVENT_PADDING1]; |
95 | ||
d6d808f3 MD |
96 | /* Per instrumentation type configuration */ |
97 | union { | |
7371f44c | 98 | struct lttng_kernel_kretprobe kretprobe; |
d6d808f3 | 99 | struct lttng_kernel_kprobe kprobe; |
f17701fb | 100 | struct lttng_kernel_function_tracer ftrace; |
80f87dd2 | 101 | struct lttng_kernel_syscall syscall; |
8e099bae | 102 | char padding[LTTNG_KERNEL_EVENT_PADDING2]; |
d6d808f3 | 103 | } u; |
6dccd6c1 | 104 | }__attribute__((packed)); |
c099397a | 105 | |
80c16bcf | 106 | struct lttng_kernel_tracer_version { |
c6c9e10f MD |
107 | uint32_t major; |
108 | uint32_t minor; | |
80c16bcf | 109 | uint32_t patchlevel; |
6dccd6c1 | 110 | }__attribute__((packed)); |
80c16bcf | 111 | |
3db41b2c MD |
112 | enum lttng_kernel_calibrate_type { |
113 | LTTNG_KERNEL_CALIBRATE_KRETPROBE, | |
57105fc2 MD |
114 | }; |
115 | ||
3db41b2c MD |
116 | struct lttng_kernel_calibrate { |
117 | enum lttng_kernel_calibrate_type type; /* type (input) */ | |
6dccd6c1 | 118 | }__attribute__((packed)); |
57105fc2 | 119 | |
12a313a5 | 120 | enum lttng_kernel_context_type { |
4c183524 MD |
121 | LTTNG_KERNEL_CONTEXT_PID = 0, |
122 | LTTNG_KERNEL_CONTEXT_PERF_COUNTER = 1, | |
a2563e83 | 123 | LTTNG_KERNEL_CONTEXT_PROCNAME = 2, |
4c183524 MD |
124 | LTTNG_KERNEL_CONTEXT_PRIO = 3, |
125 | LTTNG_KERNEL_CONTEXT_NICE = 4, | |
126 | LTTNG_KERNEL_CONTEXT_VPID = 5, | |
127 | LTTNG_KERNEL_CONTEXT_TID = 6, | |
128 | LTTNG_KERNEL_CONTEXT_VTID = 7, | |
129 | LTTNG_KERNEL_CONTEXT_PPID = 8, | |
130 | LTTNG_KERNEL_CONTEXT_VPPID = 9, | |
975da2c0 | 131 | LTTNG_KERNEL_CONTEXT_HOSTNAME = 10, |
8070f5c0 MD |
132 | }; |
133 | ||
134 | struct lttng_kernel_perf_counter_ctx { | |
135 | uint32_t type; | |
136 | uint64_t config; | |
f8695253 | 137 | char name[LTTNG_KERNEL_SYM_NAME_LEN]; |
6dccd6c1 | 138 | }__attribute__((packed)); |
8070f5c0 | 139 | |
8e099bae MD |
140 | #define LTTNG_KERNEL_CONTEXT_PADDING1 16 |
141 | #define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32 | |
8070f5c0 | 142 | struct lttng_kernel_context { |
12a313a5 | 143 | enum lttng_kernel_context_type ctx; |
8e099bae MD |
144 | char padding[LTTNG_KERNEL_CONTEXT_PADDING1]; |
145 | ||
8070f5c0 | 146 | union { |
8070f5c0 | 147 | struct lttng_kernel_perf_counter_ctx perf_counter; |
8e099bae | 148 | char padding[LTTNG_KERNEL_CONTEXT_PADDING2]; |
8070f5c0 | 149 | } u; |
6dccd6c1 | 150 | }__attribute__((packed)); |
8070f5c0 | 151 | |
33749530 | 152 | /* LTTng file descriptor ioctl */ |
6dccd6c1 | 153 | #define LTTNG_KERNEL_SESSION _IO(0xF6, 0x45) |
33749530 | 154 | #define LTTNG_KERNEL_TRACER_VERSION \ |
6dccd6c1 JD |
155 | _IOR(0xF6, 0x46, struct lttng_kernel_tracer_version) |
156 | #define LTTNG_KERNEL_TRACEPOINT_LIST _IO(0xF6, 0x47) | |
157 | #define LTTNG_KERNEL_WAIT_QUIESCENT _IO(0xF6, 0x48) | |
57105fc2 | 158 | #define LTTNG_KERNEL_CALIBRATE \ |
6dccd6c1 | 159 | _IOWR(0xF6, 0x49, struct lttng_kernel_calibrate) |
33749530 MD |
160 | |
161 | /* Session FD ioctl */ | |
162 | #define LTTNG_KERNEL_METADATA \ | |
6dccd6c1 | 163 | _IOW(0xF6, 0x54, struct lttng_kernel_channel) |
ab2277d6 | 164 | #define LTTNG_KERNEL_CHANNEL \ |
6dccd6c1 JD |
165 | _IOW(0xF6, 0x55, struct lttng_kernel_channel) |
166 | #define LTTNG_KERNEL_SESSION_START _IO(0xF6, 0x56) | |
167 | #define LTTNG_KERNEL_SESSION_STOP _IO(0xF6, 0x57) | |
33749530 MD |
168 | |
169 | /* Channel FD ioctl */ | |
6dccd6c1 | 170 | #define LTTNG_KERNEL_STREAM _IO(0xF6, 0x62) |
ab2277d6 | 171 | #define LTTNG_KERNEL_EVENT \ |
6dccd6c1 | 172 | _IOW(0xF6, 0x63, struct lttng_kernel_event) |
57a13317 | 173 | |
8070f5c0 MD |
174 | /* Event and Channel FD ioctl */ |
175 | #define LTTNG_KERNEL_CONTEXT \ | |
6dccd6c1 | 176 | _IOW(0xF6, 0x71, struct lttng_kernel_context) |
8070f5c0 | 177 | |
e64957da | 178 | /* Event, Channel and Session ioctl */ |
6dccd6c1 JD |
179 | #define LTTNG_KERNEL_ENABLE _IO(0xF6, 0x82) |
180 | #define LTTNG_KERNEL_DISABLE _IO(0xF6, 0x83) | |
e64957da | 181 | |
3b731ab1 JD |
182 | /* LTTng-specific ioctls for the lib ringbuffer */ |
183 | /* returns the timestamp begin of the current sub-buffer */ | |
184 | #define LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN _IOR(0xF6, 0x20, uint64_t) | |
185 | /* returns the timestamp end of the current sub-buffer */ | |
186 | #define LTTNG_RING_BUFFER_GET_TIMESTAMP_END _IOR(0xF6, 0x21, uint64_t) | |
187 | /* returns the number of events discarded */ | |
188 | #define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED _IOR(0xF6, 0x22, uint64_t) | |
189 | /* returns the packet payload size */ | |
190 | #define LTTNG_RING_BUFFER_GET_CONTENT_SIZE _IOR(0xF6, 0x23, uint64_t) | |
191 | /* returns the actual packet size */ | |
192 | #define LTTNG_RING_BUFFER_GET_PACKET_SIZE _IOR(0xF6, 0x24, uint64_t) | |
193 | /* returns the stream id */ | |
194 | #define LTTNG_RING_BUFFER_GET_STREAM_ID _IOR(0xF6, 0x25, uint64_t) | |
2348ca17 JD |
195 | /* returns the current timestamp */ |
196 | #define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t) | |
3b731ab1 JD |
197 | |
198 | #ifdef CONFIG_COMPAT | |
199 | /* returns the timestamp begin of the current sub-buffer */ | |
200 | #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_BEGIN \ | |
201 | LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN | |
202 | /* returns the timestamp end of the current sub-buffer */ | |
203 | #define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END \ | |
204 | LTTNG_RING_BUFFER_GET_TIMESTAMP_END | |
205 | /* returns the number of events discarded */ | |
206 | #define LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED \ | |
207 | LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED | |
208 | /* returns the packet payload size */ | |
209 | #define LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE \ | |
210 | LTTNG_RING_BUFFER_GET_CONTENT_SIZE | |
211 | /* returns the actual packet size */ | |
212 | #define LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE \ | |
213 | LTTNG_RING_BUFFER_GET_PACKET_SIZE | |
214 | /* returns the stream id */ | |
215 | #define LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID \ | |
216 | LTTNG_RING_BUFFER_GET_STREAM_ID | |
2348ca17 JD |
217 | /* returns the current timestamp */ |
218 | #define LTTNG_RING_BUFFER_COMPAT_GET_CURRENT_TIMESTAMP \ | |
219 | LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP | |
3b731ab1 JD |
220 | #endif /* CONFIG_COMPAT */ |
221 | ||
e8951e63 | 222 | #endif /* _LTTNG_ABI_H */ |