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