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 */ |
3e762260 | 49 | #define LTTNG_UST_ABI_MAJOR_VERSION 7 |
3151a51d | 50 | #define LTTNG_UST_ABI_MINOR_VERSION 2 |
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 | |
89f26d57 | 105 | #define LTTNG_UST_EVENT_PADDING1 16 |
74d81a6c | 106 | #define LTTNG_UST_EVENT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) |
9f3fdbc6 | 107 | struct lttng_ust_event { |
9f3fdbc6 | 108 | enum lttng_ust_instrumentation instrumentation; |
6b0e60f1 MD |
109 | char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */ |
110 | ||
111 | enum lttng_ust_loglevel_type loglevel_type; | |
882a56d7 | 112 | int loglevel; /* value, -1: all */ |
1332bb04 | 113 | char padding[LTTNG_UST_EVENT_PADDING1]; |
6b0e60f1 | 114 | |
9f3fdbc6 MD |
115 | /* Per instrumentation type configuration */ |
116 | union { | |
1332bb04 | 117 | char padding[LTTNG_UST_EVENT_PADDING2]; |
9f3fdbc6 | 118 | } u; |
b3f60bbf | 119 | } LTTNG_PACKED; |
9f3fdbc6 | 120 | |
06d4f27e 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 | ||
74d81a6c | 129 | #define LTTNG_UST_FIELD_ITER_PADDING (LTTNG_UST_SYM_NAME_LEN + 28) |
06d4f27e 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 */ | |
180901e6 | 135 | int nowrite; |
06d4f27e | 136 | char padding[LTTNG_UST_FIELD_ITER_PADDING]; |
b3f60bbf | 137 | } LTTNG_PACKED; |
06d4f27e | 138 | |
9f3fdbc6 | 139 | enum lttng_ust_context_type { |
3b402b40 | 140 | LTTNG_UST_CONTEXT_VTID = 0, |
c1ef86f0 MD |
141 | LTTNG_UST_CONTEXT_VPID = 1, |
142 | LTTNG_UST_CONTEXT_PTHREAD_ID = 2, | |
4847e9bb | 143 | LTTNG_UST_CONTEXT_PROCNAME = 3, |
96f85541 | 144 | LTTNG_UST_CONTEXT_IP = 4, |
d58d1454 | 145 | LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER = 5, |
c7ea8487 | 146 | LTTNG_UST_CONTEXT_CPU_ID = 6, |
53f0df51 | 147 | LTTNG_UST_CONTEXT_APP_CONTEXT = 7, |
9f3fdbc6 MD |
148 | }; |
149 | ||
d58d1454 MD |
150 | struct lttng_ust_perf_counter_ctx { |
151 | uint32_t type; | |
152 | uint64_t config; | |
153 | char name[LTTNG_UST_SYM_NAME_LEN]; | |
154 | } LTTNG_PACKED; | |
155 | ||
1332bb04 | 156 | #define LTTNG_UST_CONTEXT_PADDING1 16 |
74d81a6c | 157 | #define LTTNG_UST_CONTEXT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) |
9f3fdbc6 MD |
158 | struct lttng_ust_context { |
159 | enum lttng_ust_context_type ctx; | |
1332bb04 MD |
160 | char padding[LTTNG_UST_CONTEXT_PADDING1]; |
161 | ||
9f3fdbc6 | 162 | union { |
d58d1454 | 163 | struct lttng_ust_perf_counter_ctx perf_counter; |
53f0df51 JG |
164 | struct { |
165 | /* Includes trailing '\0'. */ | |
166 | uint32_t provider_name_len; | |
167 | uint32_t ctx_name_len; | |
168 | } app_ctx; | |
1332bb04 | 169 | char padding[LTTNG_UST_CONTEXT_PADDING2]; |
9f3fdbc6 | 170 | } u; |
b3f60bbf | 171 | } LTTNG_PACKED; |
9f3fdbc6 | 172 | |
92462b01 MD |
173 | /* |
174 | * Tracer channel attributes. | |
175 | */ | |
74d81a6c | 176 | #define LTTNG_UST_CHANNEL_ATTR_PADDING (LTTNG_UST_SYM_NAME_LEN + 32) |
92462b01 | 177 | struct lttng_ust_channel_attr { |
92462b01 MD |
178 | uint64_t subbuf_size; /* bytes */ |
179 | uint64_t num_subbuf; /* power of 2 */ | |
b3f60bbf | 180 | int overwrite; /* 1: overwrite, 0: discard */ |
92462b01 MD |
181 | unsigned int switch_timer_interval; /* usec */ |
182 | unsigned int read_timer_interval; /* usec */ | |
183 | enum lttng_ust_output output; /* splice, mmap */ | |
b2c5f61a MD |
184 | union { |
185 | struct { | |
186 | int64_t blocking_timeout; /* Blocking timeout (usec) */ | |
187 | } s; | |
188 | char padding[LTTNG_UST_CHANNEL_ATTR_PADDING]; | |
189 | } u; | |
b3f60bbf | 190 | } LTTNG_PACKED; |
92462b01 | 191 | |
1332bb04 | 192 | #define LTTNG_UST_TRACEPOINT_ITER_PADDING 16 |
cbef6901 MD |
193 | struct lttng_ust_tracepoint_iter { |
194 | char name[LTTNG_UST_SYM_NAME_LEN]; /* provider:name */ | |
882a56d7 | 195 | int loglevel; |
1332bb04 | 196 | char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING]; |
b3f60bbf | 197 | } LTTNG_PACKED; |
cbef6901 | 198 | |
74d81a6c MD |
199 | enum lttng_ust_object_type { |
200 | LTTNG_UST_OBJECT_TYPE_UNKNOWN = -1, | |
201 | LTTNG_UST_OBJECT_TYPE_CHANNEL = 0, | |
202 | LTTNG_UST_OBJECT_TYPE_STREAM = 1, | |
32ce8569 MD |
203 | LTTNG_UST_OBJECT_TYPE_EVENT = 2, |
204 | LTTNG_UST_OBJECT_TYPE_CONTEXT = 3, | |
74d81a6c MD |
205 | }; |
206 | ||
207 | #define LTTNG_UST_OBJECT_DATA_PADDING1 32 | |
208 | #define LTTNG_UST_OBJECT_DATA_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) | |
209 | ||
92462b01 | 210 | struct lttng_ust_object_data { |
74d81a6c | 211 | enum lttng_ust_object_type type; |
92462b01 | 212 | int handle; |
74d81a6c MD |
213 | uint64_t size; |
214 | char padding1[LTTNG_UST_OBJECT_DATA_PADDING1]; | |
215 | union { | |
216 | struct { | |
217 | void *data; | |
218 | enum lttng_ust_chan_type type; | |
ff0f5728 | 219 | int wakeup_fd; |
74d81a6c MD |
220 | } channel; |
221 | struct { | |
222 | int shm_fd; | |
223 | int wakeup_fd; | |
224 | uint32_t stream_nr; | |
225 | } stream; | |
226 | char padding2[LTTNG_UST_OBJECT_DATA_PADDING2]; | |
227 | } u; | |
b3f60bbf | 228 | } LTTNG_PACKED; |
92462b01 | 229 | |
d9a9a33b MD |
230 | enum lttng_ust_calibrate_type { |
231 | LTTNG_UST_CALIBRATE_TRACEPOINT, | |
232 | }; | |
233 | ||
1332bb04 | 234 | #define LTTNG_UST_CALIBRATE_PADDING1 16 |
74d81a6c | 235 | #define LTTNG_UST_CALIBRATE_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) |
d9a9a33b MD |
236 | struct lttng_ust_calibrate { |
237 | enum lttng_ust_calibrate_type type; /* type (input) */ | |
1332bb04 MD |
238 | char padding[LTTNG_UST_CALIBRATE_PADDING1]; |
239 | ||
240 | union { | |
241 | char padding[LTTNG_UST_CALIBRATE_PADDING2]; | |
242 | } u; | |
b3f60bbf | 243 | } LTTNG_PACKED; |
d9a9a33b | 244 | |
5b4839a8 | 245 | #define FILTER_BYTECODE_MAX_LEN 65536 |
a5930599 | 246 | #define LTTNG_UST_FILTER_PADDING 32 |
2d78951a | 247 | struct lttng_ust_filter_bytecode { |
2734ca65 CB |
248 | uint32_t len; |
249 | uint32_t reloc_offset; | |
3f6fd224 | 250 | uint64_t seqnum; |
a5930599 | 251 | char padding[LTTNG_UST_FILTER_PADDING]; |
2d78951a | 252 | char data[0]; |
b3f60bbf | 253 | } LTTNG_PACKED; |
2d78951a | 254 | |
86e0c24e JI |
255 | #define LTTNG_UST_EXCLUSION_PADDING 32 |
256 | struct lttng_ust_event_exclusion { | |
257 | uint32_t count; | |
258 | char padding[LTTNG_UST_EXCLUSION_PADDING]; | |
259 | char names[LTTNG_UST_SYM_NAME_LEN][0]; | |
260 | } LTTNG_PACKED; | |
261 | ||
9f3fdbc6 MD |
262 | #define _UST_CMD(minor) (minor) |
263 | #define _UST_CMDR(minor, type) (minor) | |
264 | #define _UST_CMDW(minor, type) (minor) | |
265 | ||
46050b1a MD |
266 | /* Handled by object descriptor */ |
267 | #define LTTNG_UST_RELEASE _UST_CMD(0x1) | |
268 | ||
269 | /* Handled by object cmd */ | |
270 | ||
9f3fdbc6 MD |
271 | /* LTTng-UST commands */ |
272 | #define LTTNG_UST_SESSION _UST_CMD(0x40) | |
273 | #define LTTNG_UST_TRACER_VERSION \ | |
274 | _UST_CMDR(0x41, struct lttng_ust_tracer_version) | |
275 | #define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42) | |
276 | #define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43) | |
11ff9c7d | 277 | #define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44) |
06d4f27e | 278 | #define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45) |
9f3fdbc6 | 279 | |
46050b1a | 280 | /* Session FD commands */ |
9f3fdbc6 MD |
281 | #define LTTNG_UST_CHANNEL \ |
282 | _UST_CMDW(0x51, struct lttng_ust_channel) | |
283 | #define LTTNG_UST_SESSION_START _UST_CMD(0x52) | |
284 | #define LTTNG_UST_SESSION_STOP _UST_CMD(0x53) | |
710b8ee3 | 285 | #define LTTNG_UST_SESSION_STATEDUMP _UST_CMD(0x54) |
9f3fdbc6 | 286 | |
46050b1a | 287 | /* Channel FD commands */ |
9f3fdbc6 MD |
288 | #define LTTNG_UST_STREAM _UST_CMD(0x60) |
289 | #define LTTNG_UST_EVENT \ | |
290 | _UST_CMDW(0x61, struct lttng_ust_event) | |
291 | ||
46050b1a | 292 | /* Event and Channel FD commands */ |
9f3fdbc6 MD |
293 | #define LTTNG_UST_CONTEXT \ |
294 | _UST_CMDW(0x70, struct lttng_ust_context) | |
43d330a4 | 295 | #define LTTNG_UST_FLUSH_BUFFER \ |
43861eab | 296 | _UST_CMD(0x71) |
9f3fdbc6 | 297 | |
46050b1a | 298 | /* Event, Channel and Session commands */ |
9f3fdbc6 MD |
299 | #define LTTNG_UST_ENABLE _UST_CMD(0x80) |
300 | #define LTTNG_UST_DISABLE _UST_CMD(0x81) | |
301 | ||
51489cad MD |
302 | /* Tracepoint list commands */ |
303 | #define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90) | |
06d4f27e | 304 | #define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91) |
51489cad | 305 | |
2d78951a MD |
306 | /* Event FD commands */ |
307 | #define LTTNG_UST_FILTER _UST_CMD(0xA0) | |
75582b3a | 308 | #define LTTNG_UST_EXCLUSION _UST_CMD(0xA1) |
2d78951a | 309 | |
46050b1a MD |
310 | #define LTTNG_UST_ROOT_HANDLE 0 |
311 | ||
b61ce3b2 | 312 | struct lttng_ust_obj; |
46050b1a | 313 | |
ef9ff354 MD |
314 | union ust_args { |
315 | struct { | |
74d81a6c | 316 | void *chan_data; |
ff0f5728 | 317 | int wakeup_fd; |
ef9ff354 MD |
318 | } channel; |
319 | struct { | |
74d81a6c MD |
320 | int shm_fd; |
321 | int wakeup_fd; | |
ef9ff354 | 322 | } stream; |
40003310 MD |
323 | struct { |
324 | struct lttng_ust_field_iter entry; | |
325 | } field_list; | |
8e696cfa MD |
326 | struct { |
327 | char *ctxname; | |
328 | } app_context; | |
ef9ff354 MD |
329 | }; |
330 | ||
b61ce3b2 | 331 | struct lttng_ust_objd_ops { |
ef9ff354 | 332 | long (*cmd)(int objd, unsigned int cmd, unsigned long arg, |
f59ed768 | 333 | union ust_args *args, void *owner); |
46050b1a MD |
334 | int (*release)(int objd); |
335 | }; | |
336 | ||
337 | /* Create root handle. Always ID 0. */ | |
338 | int lttng_abi_create_root_handle(void); | |
339 | ||
b61ce3b2 | 340 | const struct lttng_ust_objd_ops *objd_ops(int id); |
1849ef7c | 341 | int lttng_ust_objd_unref(int id, int is_owner); |
46050b1a MD |
342 | |
343 | void lttng_ust_abi_exit(void); | |
003fedf4 | 344 | void lttng_ust_events_exit(void); |
f59ed768 | 345 | void lttng_ust_objd_table_owner_cleanup(void *owner); |
b35d179d | 346 | |
9f3fdbc6 | 347 | #endif /* _LTTNG_UST_ABI_H */ |