Commit | Line | Data |
---|---|---|
9f3fdbc6 MD |
1 | #ifndef _LTTNG_UST_ABI_H |
2 | #define _LTTNG_UST_ABI_H | |
3 | ||
4 | /* | |
4318ae1b | 5 | * lttng/ust-abi.h |
9f3fdbc6 | 6 | * |
9f3fdbc6 MD |
7 | * LTTng-UST ABI header |
8 | * | |
e92f3e28 MD |
9 | * Copyright 2010-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
10 | * | |
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: | |
a60d70e6 | 17 | * |
e92f3e28 MD |
18 | * The above copyright notice and this permission notice shall be included in |
19 | * all copies or substantial portions of the Software. | |
d2428e87 MD |
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. | |
9f3fdbc6 MD |
28 | */ |
29 | ||
0a42beb6 | 30 | #include <stdint.h> |
b3f60bbf | 31 | #include <lttng/ust-compiler.h> |
0a42beb6 | 32 | |
db56acaf MD |
33 | #ifndef LTTNG_PACKED |
34 | #error "LTTNG_PACKED should be defined" | |
35 | #endif | |
36 | ||
32ce8569 MD |
37 | #ifndef __ust_stringify |
38 | #define __ust_stringify1(x) #x | |
39 | #define __ust_stringify(x) __ust_stringify1(x) | |
40 | #endif /* __ust_stringify */ | |
9f3fdbc6 | 41 | |
32ce8569 MD |
42 | #define LTTNG_UST_SYM_NAME_LEN 256 |
43 | #define LTTNG_UST_ABI_PROCNAME_LEN 16 | |
44 | ||
45 | /* UST comm magic number, used to validate protocol and endianness. */ | |
46 | #define LTTNG_UST_COMM_MAGIC 0xC57C57C5 | |
b35d179d | 47 | |
0f4eaec3 | 48 | /* Version for ABI between liblttng-ust, sessiond, consumerd */ |
6a359b8a MD |
49 | #define LTTNG_UST_ABI_MAJOR_VERSION 9 |
50 | #define LTTNG_UST_ABI_MAJOR_VERSION_OLDEST_COMPATIBLE 8 | |
51 | #define LTTNG_UST_ABI_MINOR_VERSION 0 | |
0f4eaec3 | 52 | |
9f3fdbc6 | 53 | enum lttng_ust_instrumentation { |
df854e41 MD |
54 | LTTNG_UST_TRACEPOINT = 0, |
55 | LTTNG_UST_PROBE = 1, | |
56 | LTTNG_UST_FUNCTION = 2, | |
6b0e60f1 MD |
57 | }; |
58 | ||
59 | enum lttng_ust_loglevel_type { | |
882a56d7 MD |
60 | LTTNG_UST_LOGLEVEL_ALL = 0, |
61 | LTTNG_UST_LOGLEVEL_RANGE = 1, | |
62 | LTTNG_UST_LOGLEVEL_SINGLE = 2, | |
9f3fdbc6 MD |
63 | }; |
64 | ||
9f3fdbc6 | 65 | enum lttng_ust_output { |
b35d179d | 66 | LTTNG_UST_MMAP = 0, |
9f3fdbc6 MD |
67 | }; |
68 | ||
74d81a6c MD |
69 | enum lttng_ust_chan_type { |
70 | LTTNG_UST_CHAN_PER_CPU = 0, | |
71 | LTTNG_UST_CHAN_METADATA = 1, | |
72 | }; | |
73 | ||
b35d179d | 74 | struct lttng_ust_tracer_version { |
b728d87e MD |
75 | uint32_t major; |
76 | uint32_t minor; | |
b35d179d | 77 | uint32_t patchlevel; |
b3f60bbf | 78 | } LTTNG_PACKED; |
9f3fdbc6 | 79 | |
74d81a6c MD |
80 | #define LTTNG_UST_CHANNEL_PADDING (LTTNG_UST_SYM_NAME_LEN + 32) |
81 | /* | |
82 | * Given that the consumerd is limited to 64k file descriptors, we | |
83 | * cannot expect much more than 1MB channel structure size. This size is | |
84 | * depends on the number of streams within a channel, which depends on | |
85 | * the number of possible CPUs on the system. | |
86 | */ | |
87 | #define LTTNG_UST_CHANNEL_DATA_MAX_LEN 1048576U | |
9f3fdbc6 | 88 | struct lttng_ust_channel { |
74d81a6c MD |
89 | uint64_t len; |
90 | enum lttng_ust_chan_type type; | |
1332bb04 | 91 | char padding[LTTNG_UST_CHANNEL_PADDING]; |
74d81a6c | 92 | char data[]; /* variable sized data */ |
b3f60bbf | 93 | } LTTNG_PACKED; |
9f3fdbc6 | 94 | |
74d81a6c | 95 | #define LTTNG_UST_STREAM_PADDING1 (LTTNG_UST_SYM_NAME_LEN + 32) |
381c0f1e | 96 | struct lttng_ust_stream { |
74d81a6c MD |
97 | uint64_t len; /* shm len */ |
98 | uint32_t stream_nr; /* stream number */ | |
1332bb04 | 99 | char padding[LTTNG_UST_STREAM_PADDING1]; |
74d81a6c MD |
100 | /* |
101 | * shm_fd and wakeup_fd are send over unix socket as file | |
102 | * descriptors after this structure. | |
103 | */ | |
b3f60bbf | 104 | } LTTNG_PACKED; |
381c0f1e | 105 | |
8968a99f | 106 | #define LTTNG_UST_EVENT_PADDING1 8 |
74d81a6c | 107 | #define LTTNG_UST_EVENT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) |
9f3fdbc6 | 108 | struct lttng_ust_event { |
9f3fdbc6 | 109 | enum lttng_ust_instrumentation instrumentation; |
6b0e60f1 MD |
110 | char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */ |
111 | ||
112 | enum lttng_ust_loglevel_type loglevel_type; | |
882a56d7 | 113 | int loglevel; /* value, -1: all */ |
8968a99f | 114 | uint64_t token; /* User-provided token */ |
1332bb04 | 115 | char padding[LTTNG_UST_EVENT_PADDING1]; |
6b0e60f1 | 116 | |
9f3fdbc6 MD |
117 | /* Per instrumentation type configuration */ |
118 | union { | |
1332bb04 | 119 | char padding[LTTNG_UST_EVENT_PADDING2]; |
9f3fdbc6 | 120 | } u; |
b3f60bbf | 121 | } LTTNG_PACKED; |
9f3fdbc6 | 122 | |
d8d2416d FD |
123 | #define LTTNG_UST_EVENT_NOTIFIER_PADDING1 16 |
124 | struct lttng_ust_event_notifier { | |
125 | struct lttng_ust_event event; | |
126 | char padding[LTTNG_UST_EVENT_NOTIFIER_PADDING1]; | |
127 | } LTTNG_PACKED; | |
128 | ||
129 | #define LTTNG_EVENT_NOTIFIER_NOTIFICATION_PADDING 32 | |
130 | struct lttng_ust_event_notifier_notification { | |
131 | uint64_t token; | |
132 | char padding[LTTNG_EVENT_NOTIFIER_NOTIFICATION_PADDING]; | |
133 | } LTTNG_PACKED; | |
134 | ||
06d4f27e MD |
135 | enum lttng_ust_field_type { |
136 | LTTNG_UST_FIELD_OTHER = 0, | |
137 | LTTNG_UST_FIELD_INTEGER = 1, | |
138 | LTTNG_UST_FIELD_ENUM = 2, | |
139 | LTTNG_UST_FIELD_FLOAT = 3, | |
140 | LTTNG_UST_FIELD_STRING = 4, | |
141 | }; | |
142 | ||
74d81a6c | 143 | #define LTTNG_UST_FIELD_ITER_PADDING (LTTNG_UST_SYM_NAME_LEN + 28) |
06d4f27e MD |
144 | struct lttng_ust_field_iter { |
145 | char event_name[LTTNG_UST_SYM_NAME_LEN]; | |
146 | char field_name[LTTNG_UST_SYM_NAME_LEN]; | |
147 | enum lttng_ust_field_type type; | |
148 | int loglevel; /* event loglevel */ | |
180901e6 | 149 | int nowrite; |
06d4f27e | 150 | char padding[LTTNG_UST_FIELD_ITER_PADDING]; |
b3f60bbf | 151 | } LTTNG_PACKED; |
06d4f27e | 152 | |
9f3fdbc6 | 153 | enum lttng_ust_context_type { |
3b402b40 | 154 | LTTNG_UST_CONTEXT_VTID = 0, |
c1ef86f0 MD |
155 | LTTNG_UST_CONTEXT_VPID = 1, |
156 | LTTNG_UST_CONTEXT_PTHREAD_ID = 2, | |
4847e9bb | 157 | LTTNG_UST_CONTEXT_PROCNAME = 3, |
96f85541 | 158 | LTTNG_UST_CONTEXT_IP = 4, |
d58d1454 | 159 | LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER = 5, |
c7ea8487 | 160 | LTTNG_UST_CONTEXT_CPU_ID = 6, |
53f0df51 | 161 | LTTNG_UST_CONTEXT_APP_CONTEXT = 7, |
735bef47 MJ |
162 | LTTNG_UST_CONTEXT_CGROUP_NS = 8, |
163 | LTTNG_UST_CONTEXT_IPC_NS = 9, | |
164 | LTTNG_UST_CONTEXT_MNT_NS = 10, | |
165 | LTTNG_UST_CONTEXT_NET_NS = 11, | |
166 | LTTNG_UST_CONTEXT_PID_NS = 12, | |
167 | LTTNG_UST_CONTEXT_USER_NS = 13, | |
168 | LTTNG_UST_CONTEXT_UTS_NS = 14, | |
fca2f191 MJ |
169 | LTTNG_UST_CONTEXT_VUID = 15, |
170 | LTTNG_UST_CONTEXT_VEUID = 16, | |
171 | LTTNG_UST_CONTEXT_VSUID = 17, | |
172 | LTTNG_UST_CONTEXT_VGID = 18, | |
173 | LTTNG_UST_CONTEXT_VEGID = 19, | |
174 | LTTNG_UST_CONTEXT_VSGID = 20, | |
cefef7a7 | 175 | LTTNG_UST_CONTEXT_TIME_NS = 21, |
9f3fdbc6 MD |
176 | }; |
177 | ||
d58d1454 MD |
178 | struct lttng_ust_perf_counter_ctx { |
179 | uint32_t type; | |
180 | uint64_t config; | |
181 | char name[LTTNG_UST_SYM_NAME_LEN]; | |
182 | } LTTNG_PACKED; | |
183 | ||
1332bb04 | 184 | #define LTTNG_UST_CONTEXT_PADDING1 16 |
74d81a6c | 185 | #define LTTNG_UST_CONTEXT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) |
9f3fdbc6 MD |
186 | struct lttng_ust_context { |
187 | enum lttng_ust_context_type ctx; | |
1332bb04 MD |
188 | char padding[LTTNG_UST_CONTEXT_PADDING1]; |
189 | ||
9f3fdbc6 | 190 | union { |
d58d1454 | 191 | struct lttng_ust_perf_counter_ctx perf_counter; |
53f0df51 JG |
192 | struct { |
193 | /* Includes trailing '\0'. */ | |
194 | uint32_t provider_name_len; | |
195 | uint32_t ctx_name_len; | |
196 | } app_ctx; | |
1332bb04 | 197 | char padding[LTTNG_UST_CONTEXT_PADDING2]; |
9f3fdbc6 | 198 | } u; |
b3f60bbf | 199 | } LTTNG_PACKED; |
9f3fdbc6 | 200 | |
92462b01 MD |
201 | /* |
202 | * Tracer channel attributes. | |
203 | */ | |
74d81a6c | 204 | #define LTTNG_UST_CHANNEL_ATTR_PADDING (LTTNG_UST_SYM_NAME_LEN + 32) |
92462b01 | 205 | struct lttng_ust_channel_attr { |
92462b01 MD |
206 | uint64_t subbuf_size; /* bytes */ |
207 | uint64_t num_subbuf; /* power of 2 */ | |
b3f60bbf | 208 | int overwrite; /* 1: overwrite, 0: discard */ |
92462b01 MD |
209 | unsigned int switch_timer_interval; /* usec */ |
210 | unsigned int read_timer_interval; /* usec */ | |
211 | enum lttng_ust_output output; /* splice, mmap */ | |
b2c5f61a MD |
212 | union { |
213 | struct { | |
214 | int64_t blocking_timeout; /* Blocking timeout (usec) */ | |
215 | } s; | |
216 | char padding[LTTNG_UST_CHANNEL_ATTR_PADDING]; | |
217 | } u; | |
b3f60bbf | 218 | } LTTNG_PACKED; |
92462b01 | 219 | |
1332bb04 | 220 | #define LTTNG_UST_TRACEPOINT_ITER_PADDING 16 |
cbef6901 MD |
221 | struct lttng_ust_tracepoint_iter { |
222 | char name[LTTNG_UST_SYM_NAME_LEN]; /* provider:name */ | |
882a56d7 | 223 | int loglevel; |
1332bb04 | 224 | char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING]; |
b3f60bbf | 225 | } LTTNG_PACKED; |
cbef6901 | 226 | |
74d81a6c MD |
227 | enum lttng_ust_object_type { |
228 | LTTNG_UST_OBJECT_TYPE_UNKNOWN = -1, | |
229 | LTTNG_UST_OBJECT_TYPE_CHANNEL = 0, | |
230 | LTTNG_UST_OBJECT_TYPE_STREAM = 1, | |
32ce8569 MD |
231 | LTTNG_UST_OBJECT_TYPE_EVENT = 2, |
232 | LTTNG_UST_OBJECT_TYPE_CONTEXT = 3, | |
d8d2416d FD |
233 | LTTNG_UST_OBJECT_TYPE_EVENT_NOTIFIER_GROUP = 4, |
234 | LTTNG_UST_OBJECT_TYPE_EVENT_NOTIFIER = 5, | |
74d81a6c MD |
235 | }; |
236 | ||
237 | #define LTTNG_UST_OBJECT_DATA_PADDING1 32 | |
238 | #define LTTNG_UST_OBJECT_DATA_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) | |
239 | ||
92462b01 | 240 | struct lttng_ust_object_data { |
74d81a6c | 241 | enum lttng_ust_object_type type; |
92462b01 | 242 | int handle; |
74d81a6c MD |
243 | uint64_t size; |
244 | char padding1[LTTNG_UST_OBJECT_DATA_PADDING1]; | |
245 | union { | |
246 | struct { | |
247 | void *data; | |
248 | enum lttng_ust_chan_type type; | |
ff0f5728 | 249 | int wakeup_fd; |
74d81a6c MD |
250 | } channel; |
251 | struct { | |
252 | int shm_fd; | |
253 | int wakeup_fd; | |
254 | uint32_t stream_nr; | |
255 | } stream; | |
256 | char padding2[LTTNG_UST_OBJECT_DATA_PADDING2]; | |
257 | } u; | |
b3f60bbf | 258 | } LTTNG_PACKED; |
92462b01 | 259 | |
d9a9a33b MD |
260 | enum lttng_ust_calibrate_type { |
261 | LTTNG_UST_CALIBRATE_TRACEPOINT, | |
262 | }; | |
263 | ||
1332bb04 | 264 | #define LTTNG_UST_CALIBRATE_PADDING1 16 |
74d81a6c | 265 | #define LTTNG_UST_CALIBRATE_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) |
d9a9a33b MD |
266 | struct lttng_ust_calibrate { |
267 | enum lttng_ust_calibrate_type type; /* type (input) */ | |
1332bb04 MD |
268 | char padding[LTTNG_UST_CALIBRATE_PADDING1]; |
269 | ||
270 | union { | |
271 | char padding[LTTNG_UST_CALIBRATE_PADDING2]; | |
272 | } u; | |
b3f60bbf | 273 | } LTTNG_PACKED; |
d9a9a33b | 274 | |
5b4839a8 | 275 | #define FILTER_BYTECODE_MAX_LEN 65536 |
a5930599 | 276 | #define LTTNG_UST_FILTER_PADDING 32 |
2d78951a | 277 | struct lttng_ust_filter_bytecode { |
2734ca65 CB |
278 | uint32_t len; |
279 | uint32_t reloc_offset; | |
3f6fd224 | 280 | uint64_t seqnum; |
a5930599 | 281 | char padding[LTTNG_UST_FILTER_PADDING]; |
2d78951a | 282 | char data[0]; |
b3f60bbf | 283 | } LTTNG_PACKED; |
2d78951a | 284 | |
86e0c24e JI |
285 | #define LTTNG_UST_EXCLUSION_PADDING 32 |
286 | struct lttng_ust_event_exclusion { | |
287 | uint32_t count; | |
288 | char padding[LTTNG_UST_EXCLUSION_PADDING]; | |
289 | char names[LTTNG_UST_SYM_NAME_LEN][0]; | |
290 | } LTTNG_PACKED; | |
291 | ||
9f3fdbc6 MD |
292 | #define _UST_CMD(minor) (minor) |
293 | #define _UST_CMDR(minor, type) (minor) | |
294 | #define _UST_CMDW(minor, type) (minor) | |
295 | ||
46050b1a MD |
296 | /* Handled by object descriptor */ |
297 | #define LTTNG_UST_RELEASE _UST_CMD(0x1) | |
298 | ||
299 | /* Handled by object cmd */ | |
300 | ||
9f3fdbc6 MD |
301 | /* LTTng-UST commands */ |
302 | #define LTTNG_UST_SESSION _UST_CMD(0x40) | |
303 | #define LTTNG_UST_TRACER_VERSION \ | |
304 | _UST_CMDR(0x41, struct lttng_ust_tracer_version) | |
305 | #define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42) | |
306 | #define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43) | |
11ff9c7d | 307 | #define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44) |
06d4f27e | 308 | #define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45) |
d8d2416d | 309 | #define LTTNG_UST_EVENT_NOTIFIER_GROUP_CREATE _UST_CMD(0x46) |
9f3fdbc6 | 310 | |
46050b1a | 311 | /* Session FD commands */ |
9f3fdbc6 MD |
312 | #define LTTNG_UST_CHANNEL \ |
313 | _UST_CMDW(0x51, struct lttng_ust_channel) | |
314 | #define LTTNG_UST_SESSION_START _UST_CMD(0x52) | |
315 | #define LTTNG_UST_SESSION_STOP _UST_CMD(0x53) | |
710b8ee3 | 316 | #define LTTNG_UST_SESSION_STATEDUMP _UST_CMD(0x54) |
9f3fdbc6 | 317 | |
46050b1a | 318 | /* Channel FD commands */ |
9f3fdbc6 MD |
319 | #define LTTNG_UST_STREAM _UST_CMD(0x60) |
320 | #define LTTNG_UST_EVENT \ | |
321 | _UST_CMDW(0x61, struct lttng_ust_event) | |
322 | ||
46050b1a | 323 | /* Event and Channel FD commands */ |
9f3fdbc6 MD |
324 | #define LTTNG_UST_CONTEXT \ |
325 | _UST_CMDW(0x70, struct lttng_ust_context) | |
43d330a4 | 326 | #define LTTNG_UST_FLUSH_BUFFER \ |
43861eab | 327 | _UST_CMD(0x71) |
9f3fdbc6 | 328 | |
46050b1a | 329 | /* Event, Channel and Session commands */ |
9f3fdbc6 MD |
330 | #define LTTNG_UST_ENABLE _UST_CMD(0x80) |
331 | #define LTTNG_UST_DISABLE _UST_CMD(0x81) | |
332 | ||
51489cad MD |
333 | /* Tracepoint list commands */ |
334 | #define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90) | |
06d4f27e | 335 | #define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91) |
51489cad | 336 | |
2d78951a MD |
337 | /* Event FD commands */ |
338 | #define LTTNG_UST_FILTER _UST_CMD(0xA0) | |
75582b3a | 339 | #define LTTNG_UST_EXCLUSION _UST_CMD(0xA1) |
2d78951a | 340 | |
d8d2416d FD |
341 | /* Event notifier group commands */ |
342 | #define LTTNG_UST_EVENT_NOTIFIER_CREATE \ | |
343 | _UST_CMDW(0xB0, struct lttng_ust_event_notifier) | |
344 | ||
46050b1a MD |
345 | #define LTTNG_UST_ROOT_HANDLE 0 |
346 | ||
b61ce3b2 | 347 | struct lttng_ust_obj; |
46050b1a | 348 | |
ef9ff354 MD |
349 | union ust_args { |
350 | struct { | |
74d81a6c | 351 | void *chan_data; |
ff0f5728 | 352 | int wakeup_fd; |
ef9ff354 MD |
353 | } channel; |
354 | struct { | |
74d81a6c MD |
355 | int shm_fd; |
356 | int wakeup_fd; | |
ef9ff354 | 357 | } stream; |
40003310 MD |
358 | struct { |
359 | struct lttng_ust_field_iter entry; | |
360 | } field_list; | |
8e696cfa MD |
361 | struct { |
362 | char *ctxname; | |
363 | } app_context; | |
d8d2416d FD |
364 | struct { |
365 | int event_notifier_notif_fd; | |
366 | } event_notifier_handle; | |
ef9ff354 MD |
367 | }; |
368 | ||
b61ce3b2 | 369 | struct lttng_ust_objd_ops { |
ef9ff354 | 370 | long (*cmd)(int objd, unsigned int cmd, unsigned long arg, |
f59ed768 | 371 | union ust_args *args, void *owner); |
46050b1a MD |
372 | int (*release)(int objd); |
373 | }; | |
374 | ||
375 | /* Create root handle. Always ID 0. */ | |
376 | int lttng_abi_create_root_handle(void); | |
377 | ||
b61ce3b2 | 378 | const struct lttng_ust_objd_ops *objd_ops(int id); |
1849ef7c | 379 | int lttng_ust_objd_unref(int id, int is_owner); |
46050b1a MD |
380 | |
381 | void lttng_ust_abi_exit(void); | |
003fedf4 | 382 | void lttng_ust_events_exit(void); |
f59ed768 | 383 | void lttng_ust_objd_table_owner_cleanup(void *owner); |
b35d179d | 384 | |
9f3fdbc6 | 385 | #endif /* _LTTNG_UST_ABI_H */ |