Commit | Line | Data |
---|---|---|
3bd1e081 MD |
1 | #ifndef _LTTNG_UST_ABI_H |
2 | #define _LTTNG_UST_ABI_H | |
3 | ||
4 | /* | |
9df8df5e | 5 | * lttng/ust-abi.h |
3bd1e081 | 6 | * |
3bd1e081 MD |
7 | * LTTng-UST ABI header |
8 | * | |
ab6a6569 | 9 | * Copyright 2010-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
3f3c65dc | 10 | * |
bf74a86d AM |
11 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
12 | * of this software and associated documentation files (the "Software"), to deal | |
13 | * in the Software without restriction, including without limitation the rights | |
14 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
15 | * copies of the Software, and to permit persons to whom the Software is | |
16 | * furnished to do so, subject to the following conditions: | |
17 | * | |
18 | * The above copyright notice and this permission notice shall be included in | |
19 | * all copies or substantial portions of the Software. | |
bb719d46 DG |
20 | * |
21 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
22 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
23 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
24 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
25 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
26 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
27 | * SOFTWARE. | |
3bd1e081 MD |
28 | */ |
29 | ||
30 | #include <stdint.h> | |
534b3ed8 DG |
31 | |
32 | #define lttng_ust_notrace __attribute__((no_instrument_function)) | |
33 | #define LTTNG_PACKED __attribute__((__packed__)) | |
3bd1e081 | 34 | |
7972aab2 DG |
35 | #ifndef __ust_stringify |
36 | #define __ust_stringify1(x) #x | |
37 | #define __ust_stringify(x) __ust_stringify1(x) | |
38 | #endif /* __ust_stringify */ | |
3bd1e081 | 39 | |
7972aab2 DG |
40 | #define LTTNG_UST_SYM_NAME_LEN 256 |
41 | #define LTTNG_UST_ABI_PROCNAME_LEN 16 | |
42 | ||
43 | /* UST comm magic number, used to validate protocol and endianness. */ | |
44 | #define LTTNG_UST_COMM_MAGIC 0xC57C57C5 | |
3bd1e081 | 45 | |
ab6a6569 | 46 | /* Version for ABI between liblttng-ust, sessiond, consumerd */ |
5430c50d MD |
47 | #define LTTNG_UST_ABI_MAJOR_VERSION 8 |
48 | #define LTTNG_UST_ABI_MINOR_VERSION 0 | |
ab6a6569 | 49 | |
b4a8eff7 JG |
50 | struct lttng_ust_calibrate; |
51 | ||
3bd1e081 | 52 | enum lttng_ust_instrumentation { |
177f8533 MD |
53 | LTTNG_UST_TRACEPOINT = 0, |
54 | LTTNG_UST_PROBE = 1, | |
55 | LTTNG_UST_FUNCTION = 2, | |
0cda4f28 MD |
56 | }; |
57 | ||
58 | enum lttng_ust_loglevel_type { | |
8005f29a MD |
59 | LTTNG_UST_LOGLEVEL_ALL = 0, |
60 | LTTNG_UST_LOGLEVEL_RANGE = 1, | |
61 | LTTNG_UST_LOGLEVEL_SINGLE = 2, | |
3bd1e081 MD |
62 | }; |
63 | ||
64 | enum lttng_ust_output { | |
65 | LTTNG_UST_MMAP = 0, | |
66 | }; | |
67 | ||
ffe60014 DG |
68 | enum lttng_ust_chan_type { |
69 | LTTNG_UST_CHAN_PER_CPU = 0, | |
70 | LTTNG_UST_CHAN_METADATA = 1, | |
71 | }; | |
72 | ||
3bd1e081 | 73 | struct lttng_ust_tracer_version { |
3f3c65dc MD |
74 | uint32_t major; |
75 | uint32_t minor; | |
3bd1e081 | 76 | uint32_t patchlevel; |
bb719d46 | 77 | } LTTNG_PACKED; |
3bd1e081 | 78 | |
7972aab2 | 79 | #define LTTNG_UST_CHANNEL_PADDING (LTTNG_UST_SYM_NAME_LEN + 32) |
ffe60014 DG |
80 | /* |
81 | * Given that the consumerd is limited to 64k file descriptors, we | |
82 | * cannot expect much more than 1MB channel structure size. This size is | |
83 | * depends on the number of streams within a channel, which depends on | |
84 | * the number of possible CPUs on the system. | |
85 | */ | |
86 | #define LTTNG_UST_CHANNEL_DATA_MAX_LEN 1048576U | |
3bd1e081 | 87 | struct lttng_ust_channel { |
ffe60014 DG |
88 | uint64_t len; |
89 | enum lttng_ust_chan_type type; | |
3f3c65dc | 90 | char padding[LTTNG_UST_CHANNEL_PADDING]; |
ffe60014 | 91 | char data[]; /* variable sized data */ |
bb719d46 | 92 | } LTTNG_PACKED; |
3f3c65dc | 93 | |
7972aab2 | 94 | #define LTTNG_UST_STREAM_PADDING1 (LTTNG_UST_SYM_NAME_LEN + 32) |
3f3c65dc | 95 | struct lttng_ust_stream { |
ffe60014 DG |
96 | uint64_t len; /* shm len */ |
97 | uint32_t stream_nr; /* stream number */ | |
3f3c65dc | 98 | char padding[LTTNG_UST_STREAM_PADDING1]; |
ffe60014 DG |
99 | /* |
100 | * shm_fd and wakeup_fd are send over unix socket as file | |
101 | * descriptors after this structure. | |
102 | */ | |
bb719d46 | 103 | } LTTNG_PACKED; |
3bd1e081 | 104 | |
3f3c65dc | 105 | #define LTTNG_UST_EVENT_PADDING1 16 |
7972aab2 | 106 | #define LTTNG_UST_EVENT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) |
3bd1e081 | 107 | struct lttng_ust_event { |
69892bbb | 108 | enum lttng_ust_instrumentation instrumentation; |
0cda4f28 MD |
109 | char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */ |
110 | ||
111 | enum lttng_ust_loglevel_type loglevel_type; | |
8005f29a | 112 | int loglevel; /* value, -1: all */ |
3f3c65dc | 113 | char padding[LTTNG_UST_EVENT_PADDING1]; |
0cda4f28 | 114 | |
3bd1e081 MD |
115 | /* Per instrumentation type configuration */ |
116 | union { | |
3f3c65dc | 117 | char padding[LTTNG_UST_EVENT_PADDING2]; |
3bd1e081 | 118 | } u; |
bb719d46 | 119 | } LTTNG_PACKED; |
3bd1e081 | 120 | |
f214d69a MD |
121 | enum lttng_ust_field_type { |
122 | LTTNG_UST_FIELD_OTHER = 0, | |
123 | LTTNG_UST_FIELD_INTEGER = 1, | |
124 | LTTNG_UST_FIELD_ENUM = 2, | |
125 | LTTNG_UST_FIELD_FLOAT = 3, | |
126 | LTTNG_UST_FIELD_STRING = 4, | |
127 | }; | |
128 | ||
7972aab2 | 129 | #define LTTNG_UST_FIELD_ITER_PADDING (LTTNG_UST_SYM_NAME_LEN + 28) |
f214d69a MD |
130 | struct lttng_ust_field_iter { |
131 | char event_name[LTTNG_UST_SYM_NAME_LEN]; | |
132 | char field_name[LTTNG_UST_SYM_NAME_LEN]; | |
133 | enum lttng_ust_field_type type; | |
134 | int loglevel; /* event loglevel */ | |
590b9e3c | 135 | int nowrite; |
f214d69a | 136 | char padding[LTTNG_UST_FIELD_ITER_PADDING]; |
bb719d46 | 137 | } LTTNG_PACKED; |
f214d69a | 138 | |
3bd1e081 MD |
139 | enum lttng_ust_context_type { |
140 | LTTNG_UST_CONTEXT_VTID = 0, | |
141 | LTTNG_UST_CONTEXT_VPID = 1, | |
142 | LTTNG_UST_CONTEXT_PTHREAD_ID = 2, | |
143 | LTTNG_UST_CONTEXT_PROCNAME = 3, | |
7c612c2e | 144 | LTTNG_UST_CONTEXT_IP = 4, |
aa3514e9 | 145 | LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER = 5, |
9f35c1ad | 146 | LTTNG_UST_CONTEXT_CPU_ID = 6, |
bdf64013 | 147 | LTTNG_UST_CONTEXT_APP_CONTEXT = 7, |
f48ccdb2 MJ |
148 | LTTNG_UST_CONTEXT_CGROUP_NS = 8, |
149 | LTTNG_UST_CONTEXT_IPC_NS = 9, | |
150 | LTTNG_UST_CONTEXT_MNT_NS = 10, | |
151 | LTTNG_UST_CONTEXT_NET_NS = 11, | |
152 | LTTNG_UST_CONTEXT_PID_NS = 12, | |
153 | LTTNG_UST_CONTEXT_USER_NS = 13, | |
154 | LTTNG_UST_CONTEXT_UTS_NS = 14, | |
b9eae072 MJ |
155 | LTTNG_UST_CONTEXT_VUID = 15, |
156 | LTTNG_UST_CONTEXT_VEUID = 16, | |
157 | LTTNG_UST_CONTEXT_VSUID = 17, | |
158 | LTTNG_UST_CONTEXT_VGID = 18, | |
159 | LTTNG_UST_CONTEXT_VEGID = 19, | |
160 | LTTNG_UST_CONTEXT_VSGID = 20, | |
3bd1e081 MD |
161 | }; |
162 | ||
aa3514e9 MD |
163 | struct lttng_ust_perf_counter_ctx { |
164 | uint32_t type; | |
165 | uint64_t config; | |
166 | char name[LTTNG_UST_SYM_NAME_LEN]; | |
167 | } LTTNG_PACKED; | |
168 | ||
3f3c65dc | 169 | #define LTTNG_UST_CONTEXT_PADDING1 16 |
7972aab2 | 170 | #define LTTNG_UST_CONTEXT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) |
3bd1e081 MD |
171 | struct lttng_ust_context { |
172 | enum lttng_ust_context_type ctx; | |
3f3c65dc MD |
173 | char padding[LTTNG_UST_CONTEXT_PADDING1]; |
174 | ||
3bd1e081 | 175 | union { |
aa3514e9 | 176 | struct lttng_ust_perf_counter_ctx perf_counter; |
bdf64013 JG |
177 | struct { |
178 | /* Includes trailing '\0'. */ | |
179 | uint32_t provider_name_len; | |
180 | uint32_t ctx_name_len; | |
181 | } app_ctx; | |
3f3c65dc | 182 | char padding[LTTNG_UST_CONTEXT_PADDING2]; |
3bd1e081 | 183 | } u; |
bb719d46 | 184 | } LTTNG_PACKED; |
3bd1e081 | 185 | |
13161846 DG |
186 | /* |
187 | * Tracer channel attributes. | |
188 | */ | |
7972aab2 | 189 | #define LTTNG_UST_CHANNEL_ATTR_PADDING (LTTNG_UST_SYM_NAME_LEN + 32) |
13161846 | 190 | struct lttng_ust_channel_attr { |
7daee932 | 191 | uint64_t subbuf_size; /* bytes, power of 2 */ |
13161846 | 192 | uint64_t num_subbuf; /* power of 2 */ |
6f30f9b8 | 193 | int overwrite; /* 1: overwrite, 0: discard */ |
13161846 DG |
194 | unsigned int switch_timer_interval; /* usec */ |
195 | unsigned int read_timer_interval; /* usec */ | |
196 | enum lttng_ust_output output; /* splice, mmap */ | |
491d1539 MD |
197 | union { |
198 | struct { | |
199 | int64_t blocking_timeout; /* Retry timeout (usec) */ | |
200 | } s; | |
201 | char padding[LTTNG_UST_CHANNEL_ATTR_PADDING]; | |
202 | } u; | |
bb719d46 | 203 | } LTTNG_PACKED; |
13161846 | 204 | |
3f3c65dc | 205 | #define LTTNG_UST_TRACEPOINT_ITER_PADDING 16 |
177f8533 MD |
206 | struct lttng_ust_tracepoint_iter { |
207 | char name[LTTNG_UST_SYM_NAME_LEN]; /* provider:name */ | |
8005f29a | 208 | int loglevel; |
3f3c65dc | 209 | char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING]; |
bb719d46 | 210 | } LTTNG_PACKED; |
177f8533 | 211 | |
ffe60014 DG |
212 | enum lttng_ust_object_type { |
213 | LTTNG_UST_OBJECT_TYPE_UNKNOWN = -1, | |
214 | LTTNG_UST_OBJECT_TYPE_CHANNEL = 0, | |
215 | LTTNG_UST_OBJECT_TYPE_STREAM = 1, | |
7972aab2 DG |
216 | LTTNG_UST_OBJECT_TYPE_EVENT = 2, |
217 | LTTNG_UST_OBJECT_TYPE_CONTEXT = 3, | |
ffe60014 DG |
218 | }; |
219 | ||
7972aab2 DG |
220 | #define LTTNG_UST_OBJECT_DATA_PADDING1 32 |
221 | #define LTTNG_UST_OBJECT_DATA_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) | |
ffe60014 | 222 | |
13161846 | 223 | struct lttng_ust_object_data { |
ffe60014 | 224 | enum lttng_ust_object_type type; |
13161846 | 225 | int handle; |
ffe60014 DG |
226 | uint64_t size; |
227 | char padding1[LTTNG_UST_OBJECT_DATA_PADDING1]; | |
228 | union { | |
229 | struct { | |
230 | void *data; | |
231 | enum lttng_ust_chan_type type; | |
7972aab2 | 232 | int wakeup_fd; |
ffe60014 DG |
233 | } channel; |
234 | struct { | |
235 | int shm_fd; | |
236 | int wakeup_fd; | |
237 | uint32_t stream_nr; | |
238 | } stream; | |
239 | char padding2[LTTNG_UST_OBJECT_DATA_PADDING2]; | |
240 | } u; | |
bb719d46 | 241 | } LTTNG_PACKED; |
13161846 | 242 | |
d93c4f1f | 243 | #define FILTER_BYTECODE_MAX_LEN 65536 |
b6bbed5f | 244 | #define LTTNG_UST_FILTER_PADDING 32 |
53a80697 | 245 | struct lttng_ust_filter_bytecode { |
d93c4f1f CB |
246 | uint32_t len; |
247 | uint32_t reloc_offset; | |
b6bbed5f DG |
248 | uint64_t seqnum; |
249 | char padding[LTTNG_UST_FILTER_PADDING]; | |
53a80697 | 250 | char data[0]; |
bb719d46 | 251 | } LTTNG_PACKED; |
53a80697 | 252 | |
18e46d40 JI |
253 | #define LTTNG_UST_EXCLUSION_PADDING 32 |
254 | struct lttng_ust_event_exclusion { | |
255 | uint32_t count; | |
256 | char padding[LTTNG_UST_EXCLUSION_PADDING]; | |
257 | char names[LTTNG_UST_SYM_NAME_LEN][0]; | |
258 | } LTTNG_PACKED; | |
259 | ||
3bd1e081 MD |
260 | #define _UST_CMD(minor) (minor) |
261 | #define _UST_CMDR(minor, type) (minor) | |
262 | #define _UST_CMDW(minor, type) (minor) | |
263 | ||
264 | /* Handled by object descriptor */ | |
265 | #define LTTNG_UST_RELEASE _UST_CMD(0x1) | |
266 | ||
267 | /* Handled by object cmd */ | |
268 | ||
269 | /* LTTng-UST commands */ | |
270 | #define LTTNG_UST_SESSION _UST_CMD(0x40) | |
271 | #define LTTNG_UST_TRACER_VERSION \ | |
272 | _UST_CMDR(0x41, struct lttng_ust_tracer_version) | |
273 | #define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42) | |
274 | #define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43) | |
275 | #define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44) | |
f214d69a | 276 | #define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45) |
3bd1e081 MD |
277 | |
278 | /* Session FD commands */ | |
3bd1e081 MD |
279 | #define LTTNG_UST_CHANNEL \ |
280 | _UST_CMDW(0x51, struct lttng_ust_channel) | |
281 | #define LTTNG_UST_SESSION_START _UST_CMD(0x52) | |
282 | #define LTTNG_UST_SESSION_STOP _UST_CMD(0x53) | |
ebdc9371 | 283 | #define LTTNG_UST_SESSION_STATEDUMP _UST_CMD(0x54) |
3bd1e081 MD |
284 | |
285 | /* Channel FD commands */ | |
286 | #define LTTNG_UST_STREAM _UST_CMD(0x60) | |
287 | #define LTTNG_UST_EVENT \ | |
288 | _UST_CMDW(0x61, struct lttng_ust_event) | |
289 | ||
290 | /* Event and Channel FD commands */ | |
291 | #define LTTNG_UST_CONTEXT \ | |
292 | _UST_CMDW(0x70, struct lttng_ust_context) | |
2bdd86d4 MD |
293 | #define LTTNG_UST_FLUSH_BUFFER \ |
294 | _UST_CMD(0x71) | |
3bd1e081 MD |
295 | |
296 | /* Event, Channel and Session commands */ | |
297 | #define LTTNG_UST_ENABLE _UST_CMD(0x80) | |
298 | #define LTTNG_UST_DISABLE _UST_CMD(0x81) | |
299 | ||
8ec2d32a MD |
300 | /* Tracepoint list commands */ |
301 | #define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90) | |
f214d69a | 302 | #define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91) |
8ec2d32a | 303 | |
ab6a6569 DG |
304 | /* Event FD commands */ |
305 | #define LTTNG_UST_FILTER _UST_CMD(0xA0) | |
306 | ||
3bd1e081 MD |
307 | #define LTTNG_UST_ROOT_HANDLE 0 |
308 | ||
9df8df5e | 309 | struct lttng_ust_obj; |
3bd1e081 | 310 | |
18cef803 MD |
311 | union ust_args { |
312 | struct { | |
ffe60014 | 313 | void *chan_data; |
7972aab2 | 314 | int wakeup_fd; |
18cef803 MD |
315 | } channel; |
316 | struct { | |
ffe60014 DG |
317 | int shm_fd; |
318 | int wakeup_fd; | |
18cef803 | 319 | } stream; |
da0bdb87 MD |
320 | struct { |
321 | struct lttng_ust_field_iter entry; | |
322 | } field_list; | |
18cef803 MD |
323 | }; |
324 | ||
9df8df5e | 325 | struct lttng_ust_objd_ops { |
18cef803 | 326 | long (*cmd)(int objd, unsigned int cmd, unsigned long arg, |
bb719d46 | 327 | union ust_args *args, void *owner); |
3bd1e081 MD |
328 | int (*release)(int objd); |
329 | }; | |
330 | ||
331 | /* Create root handle. Always ID 0. */ | |
332 | int lttng_abi_create_root_handle(void); | |
333 | ||
9df8df5e | 334 | const struct lttng_ust_objd_ops *objd_ops(int id); |
7972aab2 | 335 | int lttng_ust_objd_unref(int id, int is_owner); |
3bd1e081 MD |
336 | |
337 | void lttng_ust_abi_exit(void); | |
9df8df5e | 338 | void lttng_ust_events_exit(void); |
bb719d46 | 339 | void lttng_ust_objd_table_owner_cleanup(void *owner); |
3bd1e081 MD |
340 | |
341 | #endif /* _LTTNG_UST_ABI_H */ |