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 | |
32ce8569 MD |
33 | #ifndef __ust_stringify |
34 | #define __ust_stringify1(x) #x | |
35 | #define __ust_stringify(x) __ust_stringify1(x) | |
36 | #endif /* __ust_stringify */ | |
9f3fdbc6 | 37 | |
32ce8569 MD |
38 | #define LTTNG_UST_SYM_NAME_LEN 256 |
39 | #define LTTNG_UST_ABI_PROCNAME_LEN 16 | |
40 | ||
41 | /* UST comm magic number, used to validate protocol and endianness. */ | |
42 | #define LTTNG_UST_COMM_MAGIC 0xC57C57C5 | |
b35d179d | 43 | |
0f4eaec3 | 44 | /* Version for ABI between liblttng-ust, sessiond, consumerd */ |
d1c0394b | 45 | #define LTTNG_UST_ABI_MAJOR_VERSION 5 |
32ce8569 | 46 | #define LTTNG_UST_ABI_MINOR_VERSION 0 |
0f4eaec3 | 47 | |
9f3fdbc6 | 48 | enum lttng_ust_instrumentation { |
df854e41 MD |
49 | LTTNG_UST_TRACEPOINT = 0, |
50 | LTTNG_UST_PROBE = 1, | |
51 | LTTNG_UST_FUNCTION = 2, | |
6b0e60f1 MD |
52 | }; |
53 | ||
54 | enum lttng_ust_loglevel_type { | |
882a56d7 MD |
55 | LTTNG_UST_LOGLEVEL_ALL = 0, |
56 | LTTNG_UST_LOGLEVEL_RANGE = 1, | |
57 | LTTNG_UST_LOGLEVEL_SINGLE = 2, | |
9f3fdbc6 MD |
58 | }; |
59 | ||
9f3fdbc6 | 60 | enum lttng_ust_output { |
b35d179d | 61 | LTTNG_UST_MMAP = 0, |
9f3fdbc6 MD |
62 | }; |
63 | ||
74d81a6c MD |
64 | enum lttng_ust_chan_type { |
65 | LTTNG_UST_CHAN_PER_CPU = 0, | |
66 | LTTNG_UST_CHAN_METADATA = 1, | |
67 | }; | |
68 | ||
b35d179d | 69 | struct lttng_ust_tracer_version { |
b728d87e MD |
70 | uint32_t major; |
71 | uint32_t minor; | |
b35d179d | 72 | uint32_t patchlevel; |
b3f60bbf | 73 | } LTTNG_PACKED; |
9f3fdbc6 | 74 | |
74d81a6c MD |
75 | #define LTTNG_UST_CHANNEL_PADDING (LTTNG_UST_SYM_NAME_LEN + 32) |
76 | /* | |
77 | * Given that the consumerd is limited to 64k file descriptors, we | |
78 | * cannot expect much more than 1MB channel structure size. This size is | |
79 | * depends on the number of streams within a channel, which depends on | |
80 | * the number of possible CPUs on the system. | |
81 | */ | |
82 | #define LTTNG_UST_CHANNEL_DATA_MAX_LEN 1048576U | |
9f3fdbc6 | 83 | struct lttng_ust_channel { |
74d81a6c MD |
84 | uint64_t len; |
85 | enum lttng_ust_chan_type type; | |
1332bb04 | 86 | char padding[LTTNG_UST_CHANNEL_PADDING]; |
74d81a6c | 87 | char data[]; /* variable sized data */ |
b3f60bbf | 88 | } LTTNG_PACKED; |
9f3fdbc6 | 89 | |
74d81a6c | 90 | #define LTTNG_UST_STREAM_PADDING1 (LTTNG_UST_SYM_NAME_LEN + 32) |
381c0f1e | 91 | struct lttng_ust_stream { |
74d81a6c MD |
92 | uint64_t len; /* shm len */ |
93 | uint32_t stream_nr; /* stream number */ | |
1332bb04 | 94 | char padding[LTTNG_UST_STREAM_PADDING1]; |
74d81a6c MD |
95 | /* |
96 | * shm_fd and wakeup_fd are send over unix socket as file | |
97 | * descriptors after this structure. | |
98 | */ | |
b3f60bbf | 99 | } LTTNG_PACKED; |
381c0f1e | 100 | |
353c9dc0 | 101 | #define LTTNG_UST_EVENT_PADDING1 15 |
74d81a6c | 102 | #define LTTNG_UST_EVENT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) |
9f3fdbc6 | 103 | struct lttng_ust_event { |
9f3fdbc6 | 104 | enum lttng_ust_instrumentation instrumentation; |
6b0e60f1 MD |
105 | char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */ |
106 | ||
107 | enum lttng_ust_loglevel_type loglevel_type; | |
882a56d7 | 108 | int loglevel; /* value, -1: all */ |
353c9dc0 | 109 | char disabled; |
1332bb04 | 110 | char padding[LTTNG_UST_EVENT_PADDING1]; |
6b0e60f1 | 111 | |
9f3fdbc6 MD |
112 | /* Per instrumentation type configuration */ |
113 | union { | |
1332bb04 | 114 | char padding[LTTNG_UST_EVENT_PADDING2]; |
9f3fdbc6 | 115 | } u; |
b3f60bbf | 116 | } LTTNG_PACKED; |
9f3fdbc6 | 117 | |
06d4f27e MD |
118 | enum lttng_ust_field_type { |
119 | LTTNG_UST_FIELD_OTHER = 0, | |
120 | LTTNG_UST_FIELD_INTEGER = 1, | |
121 | LTTNG_UST_FIELD_ENUM = 2, | |
122 | LTTNG_UST_FIELD_FLOAT = 3, | |
123 | LTTNG_UST_FIELD_STRING = 4, | |
124 | }; | |
125 | ||
74d81a6c | 126 | #define LTTNG_UST_FIELD_ITER_PADDING (LTTNG_UST_SYM_NAME_LEN + 28) |
06d4f27e MD |
127 | struct lttng_ust_field_iter { |
128 | char event_name[LTTNG_UST_SYM_NAME_LEN]; | |
129 | char field_name[LTTNG_UST_SYM_NAME_LEN]; | |
130 | enum lttng_ust_field_type type; | |
131 | int loglevel; /* event loglevel */ | |
180901e6 | 132 | int nowrite; |
06d4f27e | 133 | char padding[LTTNG_UST_FIELD_ITER_PADDING]; |
b3f60bbf | 134 | } LTTNG_PACKED; |
06d4f27e | 135 | |
9f3fdbc6 | 136 | enum lttng_ust_context_type { |
3b402b40 | 137 | LTTNG_UST_CONTEXT_VTID = 0, |
c1ef86f0 MD |
138 | LTTNG_UST_CONTEXT_VPID = 1, |
139 | LTTNG_UST_CONTEXT_PTHREAD_ID = 2, | |
4847e9bb | 140 | LTTNG_UST_CONTEXT_PROCNAME = 3, |
96f85541 | 141 | LTTNG_UST_CONTEXT_IP = 4, |
9f3fdbc6 MD |
142 | }; |
143 | ||
1332bb04 | 144 | #define LTTNG_UST_CONTEXT_PADDING1 16 |
74d81a6c | 145 | #define LTTNG_UST_CONTEXT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) |
9f3fdbc6 MD |
146 | struct lttng_ust_context { |
147 | enum lttng_ust_context_type ctx; | |
1332bb04 MD |
148 | char padding[LTTNG_UST_CONTEXT_PADDING1]; |
149 | ||
9f3fdbc6 | 150 | union { |
1332bb04 | 151 | char padding[LTTNG_UST_CONTEXT_PADDING2]; |
9f3fdbc6 | 152 | } u; |
b3f60bbf | 153 | } LTTNG_PACKED; |
9f3fdbc6 | 154 | |
92462b01 MD |
155 | /* |
156 | * Tracer channel attributes. | |
157 | */ | |
74d81a6c | 158 | #define LTTNG_UST_CHANNEL_ATTR_PADDING (LTTNG_UST_SYM_NAME_LEN + 32) |
92462b01 | 159 | struct lttng_ust_channel_attr { |
92462b01 MD |
160 | uint64_t subbuf_size; /* bytes */ |
161 | uint64_t num_subbuf; /* power of 2 */ | |
b3f60bbf | 162 | int overwrite; /* 1: overwrite, 0: discard */ |
92462b01 MD |
163 | unsigned int switch_timer_interval; /* usec */ |
164 | unsigned int read_timer_interval; /* usec */ | |
165 | enum lttng_ust_output output; /* splice, mmap */ | |
1332bb04 | 166 | char padding[LTTNG_UST_CHANNEL_ATTR_PADDING]; |
b3f60bbf | 167 | } LTTNG_PACKED; |
92462b01 | 168 | |
1332bb04 | 169 | #define LTTNG_UST_TRACEPOINT_ITER_PADDING 16 |
cbef6901 MD |
170 | struct lttng_ust_tracepoint_iter { |
171 | char name[LTTNG_UST_SYM_NAME_LEN]; /* provider:name */ | |
882a56d7 | 172 | int loglevel; |
1332bb04 | 173 | char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING]; |
b3f60bbf | 174 | } LTTNG_PACKED; |
cbef6901 | 175 | |
74d81a6c MD |
176 | enum lttng_ust_object_type { |
177 | LTTNG_UST_OBJECT_TYPE_UNKNOWN = -1, | |
178 | LTTNG_UST_OBJECT_TYPE_CHANNEL = 0, | |
179 | LTTNG_UST_OBJECT_TYPE_STREAM = 1, | |
32ce8569 MD |
180 | LTTNG_UST_OBJECT_TYPE_EVENT = 2, |
181 | LTTNG_UST_OBJECT_TYPE_CONTEXT = 3, | |
74d81a6c MD |
182 | }; |
183 | ||
184 | #define LTTNG_UST_OBJECT_DATA_PADDING1 32 | |
185 | #define LTTNG_UST_OBJECT_DATA_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) | |
186 | ||
92462b01 | 187 | struct lttng_ust_object_data { |
74d81a6c | 188 | enum lttng_ust_object_type type; |
92462b01 | 189 | int handle; |
74d81a6c MD |
190 | uint64_t size; |
191 | char padding1[LTTNG_UST_OBJECT_DATA_PADDING1]; | |
192 | union { | |
193 | struct { | |
194 | void *data; | |
195 | enum lttng_ust_chan_type type; | |
ff0f5728 | 196 | int wakeup_fd; |
74d81a6c MD |
197 | } channel; |
198 | struct { | |
199 | int shm_fd; | |
200 | int wakeup_fd; | |
201 | uint32_t stream_nr; | |
202 | } stream; | |
203 | char padding2[LTTNG_UST_OBJECT_DATA_PADDING2]; | |
204 | } u; | |
b3f60bbf | 205 | } LTTNG_PACKED; |
92462b01 | 206 | |
d9a9a33b MD |
207 | enum lttng_ust_calibrate_type { |
208 | LTTNG_UST_CALIBRATE_TRACEPOINT, | |
209 | }; | |
210 | ||
1332bb04 | 211 | #define LTTNG_UST_CALIBRATE_PADDING1 16 |
74d81a6c | 212 | #define LTTNG_UST_CALIBRATE_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) |
d9a9a33b MD |
213 | struct lttng_ust_calibrate { |
214 | enum lttng_ust_calibrate_type type; /* type (input) */ | |
1332bb04 MD |
215 | char padding[LTTNG_UST_CALIBRATE_PADDING1]; |
216 | ||
217 | union { | |
218 | char padding[LTTNG_UST_CALIBRATE_PADDING2]; | |
219 | } u; | |
b3f60bbf | 220 | } LTTNG_PACKED; |
d9a9a33b | 221 | |
5b4839a8 | 222 | #define FILTER_BYTECODE_MAX_LEN 65536 |
a5930599 | 223 | #define LTTNG_UST_FILTER_PADDING 32 |
2d78951a | 224 | struct lttng_ust_filter_bytecode { |
2734ca65 CB |
225 | uint32_t len; |
226 | uint32_t reloc_offset; | |
3f6fd224 | 227 | uint64_t seqnum; |
a5930599 | 228 | char padding[LTTNG_UST_FILTER_PADDING]; |
2d78951a | 229 | char data[0]; |
b3f60bbf | 230 | } LTTNG_PACKED; |
2d78951a | 231 | |
86e0c24e JI |
232 | #define LTTNG_UST_EXCLUSION_PADDING 32 |
233 | struct lttng_ust_event_exclusion { | |
234 | uint32_t count; | |
235 | char padding[LTTNG_UST_EXCLUSION_PADDING]; | |
236 | char names[LTTNG_UST_SYM_NAME_LEN][0]; | |
237 | } LTTNG_PACKED; | |
238 | ||
9f3fdbc6 MD |
239 | #define _UST_CMD(minor) (minor) |
240 | #define _UST_CMDR(minor, type) (minor) | |
241 | #define _UST_CMDW(minor, type) (minor) | |
242 | ||
46050b1a MD |
243 | /* Handled by object descriptor */ |
244 | #define LTTNG_UST_RELEASE _UST_CMD(0x1) | |
245 | ||
246 | /* Handled by object cmd */ | |
247 | ||
9f3fdbc6 MD |
248 | /* LTTng-UST commands */ |
249 | #define LTTNG_UST_SESSION _UST_CMD(0x40) | |
250 | #define LTTNG_UST_TRACER_VERSION \ | |
251 | _UST_CMDR(0x41, struct lttng_ust_tracer_version) | |
252 | #define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42) | |
253 | #define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43) | |
11ff9c7d | 254 | #define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44) |
06d4f27e | 255 | #define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45) |
9f3fdbc6 | 256 | |
46050b1a | 257 | /* Session FD commands */ |
9f3fdbc6 MD |
258 | #define LTTNG_UST_CHANNEL \ |
259 | _UST_CMDW(0x51, struct lttng_ust_channel) | |
260 | #define LTTNG_UST_SESSION_START _UST_CMD(0x52) | |
261 | #define LTTNG_UST_SESSION_STOP _UST_CMD(0x53) | |
262 | ||
46050b1a | 263 | /* Channel FD commands */ |
9f3fdbc6 MD |
264 | #define LTTNG_UST_STREAM _UST_CMD(0x60) |
265 | #define LTTNG_UST_EVENT \ | |
266 | _UST_CMDW(0x61, struct lttng_ust_event) | |
267 | ||
46050b1a | 268 | /* Event and Channel FD commands */ |
9f3fdbc6 MD |
269 | #define LTTNG_UST_CONTEXT \ |
270 | _UST_CMDW(0x70, struct lttng_ust_context) | |
43d330a4 | 271 | #define LTTNG_UST_FLUSH_BUFFER \ |
43861eab | 272 | _UST_CMD(0x71) |
9f3fdbc6 | 273 | |
46050b1a | 274 | /* Event, Channel and Session commands */ |
9f3fdbc6 MD |
275 | #define LTTNG_UST_ENABLE _UST_CMD(0x80) |
276 | #define LTTNG_UST_DISABLE _UST_CMD(0x81) | |
277 | ||
51489cad MD |
278 | /* Tracepoint list commands */ |
279 | #define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90) | |
06d4f27e | 280 | #define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91) |
51489cad | 281 | |
2d78951a MD |
282 | /* Event FD commands */ |
283 | #define LTTNG_UST_FILTER _UST_CMD(0xA0) | |
75582b3a | 284 | #define LTTNG_UST_EXCLUSION _UST_CMD(0xA1) |
2d78951a | 285 | |
46050b1a MD |
286 | #define LTTNG_UST_ROOT_HANDLE 0 |
287 | ||
b61ce3b2 | 288 | struct lttng_ust_obj; |
46050b1a | 289 | |
ef9ff354 MD |
290 | union ust_args { |
291 | struct { | |
74d81a6c | 292 | void *chan_data; |
ff0f5728 | 293 | int wakeup_fd; |
ef9ff354 MD |
294 | } channel; |
295 | struct { | |
74d81a6c MD |
296 | int shm_fd; |
297 | int wakeup_fd; | |
ef9ff354 | 298 | } stream; |
40003310 MD |
299 | struct { |
300 | struct lttng_ust_field_iter entry; | |
301 | } field_list; | |
ef9ff354 MD |
302 | }; |
303 | ||
b61ce3b2 | 304 | struct lttng_ust_objd_ops { |
ef9ff354 | 305 | long (*cmd)(int objd, unsigned int cmd, unsigned long arg, |
f59ed768 | 306 | union ust_args *args, void *owner); |
46050b1a MD |
307 | int (*release)(int objd); |
308 | }; | |
309 | ||
310 | /* Create root handle. Always ID 0. */ | |
311 | int lttng_abi_create_root_handle(void); | |
312 | ||
b61ce3b2 | 313 | const struct lttng_ust_objd_ops *objd_ops(int id); |
1849ef7c | 314 | int lttng_ust_objd_unref(int id, int is_owner); |
46050b1a MD |
315 | |
316 | void lttng_ust_abi_exit(void); | |
003fedf4 | 317 | void lttng_ust_events_exit(void); |
f59ed768 | 318 | void lttng_ust_objd_table_owner_cleanup(void *owner); |
b35d179d | 319 | |
9f3fdbc6 | 320 | #endif /* _LTTNG_UST_ABI_H */ |