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 */ |
32ce8569 MD |
45 | #define LTTNG_UST_ABI_MAJOR_VERSION 4 |
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 | |
1332bb04 | 101 | #define LTTNG_UST_EVENT_PADDING1 16 |
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 */ |
1332bb04 | 109 | char padding[LTTNG_UST_EVENT_PADDING1]; |
6b0e60f1 | 110 | |
9f3fdbc6 MD |
111 | /* Per instrumentation type configuration */ |
112 | union { | |
1332bb04 | 113 | char padding[LTTNG_UST_EVENT_PADDING2]; |
9f3fdbc6 | 114 | } u; |
b3f60bbf | 115 | } LTTNG_PACKED; |
9f3fdbc6 | 116 | |
06d4f27e MD |
117 | enum lttng_ust_field_type { |
118 | LTTNG_UST_FIELD_OTHER = 0, | |
119 | LTTNG_UST_FIELD_INTEGER = 1, | |
120 | LTTNG_UST_FIELD_ENUM = 2, | |
121 | LTTNG_UST_FIELD_FLOAT = 3, | |
122 | LTTNG_UST_FIELD_STRING = 4, | |
123 | }; | |
124 | ||
74d81a6c | 125 | #define LTTNG_UST_FIELD_ITER_PADDING (LTTNG_UST_SYM_NAME_LEN + 28) |
06d4f27e MD |
126 | struct lttng_ust_field_iter { |
127 | char event_name[LTTNG_UST_SYM_NAME_LEN]; | |
128 | char field_name[LTTNG_UST_SYM_NAME_LEN]; | |
129 | enum lttng_ust_field_type type; | |
130 | int loglevel; /* event loglevel */ | |
180901e6 | 131 | int nowrite; |
06d4f27e | 132 | char padding[LTTNG_UST_FIELD_ITER_PADDING]; |
b3f60bbf | 133 | } LTTNG_PACKED; |
06d4f27e | 134 | |
9f3fdbc6 | 135 | enum lttng_ust_context_type { |
3b402b40 | 136 | LTTNG_UST_CONTEXT_VTID = 0, |
c1ef86f0 MD |
137 | LTTNG_UST_CONTEXT_VPID = 1, |
138 | LTTNG_UST_CONTEXT_PTHREAD_ID = 2, | |
4847e9bb | 139 | LTTNG_UST_CONTEXT_PROCNAME = 3, |
9f3fdbc6 MD |
140 | }; |
141 | ||
1332bb04 | 142 | #define LTTNG_UST_CONTEXT_PADDING1 16 |
74d81a6c | 143 | #define LTTNG_UST_CONTEXT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) |
9f3fdbc6 MD |
144 | struct lttng_ust_context { |
145 | enum lttng_ust_context_type ctx; | |
1332bb04 MD |
146 | char padding[LTTNG_UST_CONTEXT_PADDING1]; |
147 | ||
9f3fdbc6 | 148 | union { |
1332bb04 | 149 | char padding[LTTNG_UST_CONTEXT_PADDING2]; |
9f3fdbc6 | 150 | } u; |
b3f60bbf | 151 | } LTTNG_PACKED; |
9f3fdbc6 | 152 | |
92462b01 MD |
153 | /* |
154 | * Tracer channel attributes. | |
155 | */ | |
74d81a6c | 156 | #define LTTNG_UST_CHANNEL_ATTR_PADDING (LTTNG_UST_SYM_NAME_LEN + 32) |
92462b01 | 157 | struct lttng_ust_channel_attr { |
92462b01 MD |
158 | uint64_t subbuf_size; /* bytes */ |
159 | uint64_t num_subbuf; /* power of 2 */ | |
b3f60bbf | 160 | int overwrite; /* 1: overwrite, 0: discard */ |
92462b01 MD |
161 | unsigned int switch_timer_interval; /* usec */ |
162 | unsigned int read_timer_interval; /* usec */ | |
163 | enum lttng_ust_output output; /* splice, mmap */ | |
1332bb04 | 164 | char padding[LTTNG_UST_CHANNEL_ATTR_PADDING]; |
b3f60bbf | 165 | } LTTNG_PACKED; |
92462b01 | 166 | |
1332bb04 | 167 | #define LTTNG_UST_TRACEPOINT_ITER_PADDING 16 |
cbef6901 MD |
168 | struct lttng_ust_tracepoint_iter { |
169 | char name[LTTNG_UST_SYM_NAME_LEN]; /* provider:name */ | |
882a56d7 | 170 | int loglevel; |
1332bb04 | 171 | char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING]; |
b3f60bbf | 172 | } LTTNG_PACKED; |
cbef6901 | 173 | |
74d81a6c MD |
174 | enum lttng_ust_object_type { |
175 | LTTNG_UST_OBJECT_TYPE_UNKNOWN = -1, | |
176 | LTTNG_UST_OBJECT_TYPE_CHANNEL = 0, | |
177 | LTTNG_UST_OBJECT_TYPE_STREAM = 1, | |
32ce8569 MD |
178 | LTTNG_UST_OBJECT_TYPE_EVENT = 2, |
179 | LTTNG_UST_OBJECT_TYPE_CONTEXT = 3, | |
74d81a6c MD |
180 | }; |
181 | ||
182 | #define LTTNG_UST_OBJECT_DATA_PADDING1 32 | |
183 | #define LTTNG_UST_OBJECT_DATA_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) | |
184 | ||
92462b01 | 185 | struct lttng_ust_object_data { |
74d81a6c | 186 | enum lttng_ust_object_type type; |
92462b01 | 187 | int handle; |
74d81a6c MD |
188 | uint64_t size; |
189 | char padding1[LTTNG_UST_OBJECT_DATA_PADDING1]; | |
190 | union { | |
191 | struct { | |
192 | void *data; | |
193 | enum lttng_ust_chan_type type; | |
ff0f5728 | 194 | int wakeup_fd; |
74d81a6c MD |
195 | } channel; |
196 | struct { | |
197 | int shm_fd; | |
198 | int wakeup_fd; | |
199 | uint32_t stream_nr; | |
200 | } stream; | |
201 | char padding2[LTTNG_UST_OBJECT_DATA_PADDING2]; | |
202 | } u; | |
b3f60bbf | 203 | } LTTNG_PACKED; |
92462b01 | 204 | |
d9a9a33b MD |
205 | enum lttng_ust_calibrate_type { |
206 | LTTNG_UST_CALIBRATE_TRACEPOINT, | |
207 | }; | |
208 | ||
1332bb04 | 209 | #define LTTNG_UST_CALIBRATE_PADDING1 16 |
74d81a6c | 210 | #define LTTNG_UST_CALIBRATE_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32) |
d9a9a33b MD |
211 | struct lttng_ust_calibrate { |
212 | enum lttng_ust_calibrate_type type; /* type (input) */ | |
1332bb04 MD |
213 | char padding[LTTNG_UST_CALIBRATE_PADDING1]; |
214 | ||
215 | union { | |
216 | char padding[LTTNG_UST_CALIBRATE_PADDING2]; | |
217 | } u; | |
b3f60bbf | 218 | } LTTNG_PACKED; |
d9a9a33b | 219 | |
5b4839a8 | 220 | #define FILTER_BYTECODE_MAX_LEN 65536 |
a5930599 | 221 | #define LTTNG_UST_FILTER_PADDING 32 |
2d78951a | 222 | struct lttng_ust_filter_bytecode { |
2734ca65 CB |
223 | uint32_t len; |
224 | uint32_t reloc_offset; | |
3f6fd224 | 225 | uint64_t seqnum; |
a5930599 | 226 | char padding[LTTNG_UST_FILTER_PADDING]; |
2d78951a | 227 | char data[0]; |
b3f60bbf | 228 | } LTTNG_PACKED; |
2d78951a | 229 | |
9f3fdbc6 MD |
230 | #define _UST_CMD(minor) (minor) |
231 | #define _UST_CMDR(minor, type) (minor) | |
232 | #define _UST_CMDW(minor, type) (minor) | |
233 | ||
46050b1a MD |
234 | /* Handled by object descriptor */ |
235 | #define LTTNG_UST_RELEASE _UST_CMD(0x1) | |
236 | ||
237 | /* Handled by object cmd */ | |
238 | ||
9f3fdbc6 MD |
239 | /* LTTng-UST commands */ |
240 | #define LTTNG_UST_SESSION _UST_CMD(0x40) | |
241 | #define LTTNG_UST_TRACER_VERSION \ | |
242 | _UST_CMDR(0x41, struct lttng_ust_tracer_version) | |
243 | #define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42) | |
244 | #define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43) | |
11ff9c7d | 245 | #define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44) |
06d4f27e | 246 | #define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45) |
9f3fdbc6 | 247 | |
46050b1a | 248 | /* Session FD commands */ |
9f3fdbc6 MD |
249 | #define LTTNG_UST_CHANNEL \ |
250 | _UST_CMDW(0x51, struct lttng_ust_channel) | |
251 | #define LTTNG_UST_SESSION_START _UST_CMD(0x52) | |
252 | #define LTTNG_UST_SESSION_STOP _UST_CMD(0x53) | |
253 | ||
46050b1a | 254 | /* Channel FD commands */ |
9f3fdbc6 MD |
255 | #define LTTNG_UST_STREAM _UST_CMD(0x60) |
256 | #define LTTNG_UST_EVENT \ | |
257 | _UST_CMDW(0x61, struct lttng_ust_event) | |
258 | ||
46050b1a | 259 | /* Event and Channel FD commands */ |
9f3fdbc6 MD |
260 | #define LTTNG_UST_CONTEXT \ |
261 | _UST_CMDW(0x70, struct lttng_ust_context) | |
43d330a4 | 262 | #define LTTNG_UST_FLUSH_BUFFER \ |
43861eab | 263 | _UST_CMD(0x71) |
9f3fdbc6 | 264 | |
46050b1a | 265 | /* Event, Channel and Session commands */ |
9f3fdbc6 MD |
266 | #define LTTNG_UST_ENABLE _UST_CMD(0x80) |
267 | #define LTTNG_UST_DISABLE _UST_CMD(0x81) | |
268 | ||
51489cad MD |
269 | /* Tracepoint list commands */ |
270 | #define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90) | |
06d4f27e | 271 | #define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91) |
51489cad | 272 | |
2d78951a MD |
273 | /* Event FD commands */ |
274 | #define LTTNG_UST_FILTER _UST_CMD(0xA0) | |
275 | ||
46050b1a MD |
276 | #define LTTNG_UST_ROOT_HANDLE 0 |
277 | ||
b61ce3b2 | 278 | struct lttng_ust_obj; |
46050b1a | 279 | |
ef9ff354 MD |
280 | union ust_args { |
281 | struct { | |
74d81a6c | 282 | void *chan_data; |
ff0f5728 | 283 | int wakeup_fd; |
ef9ff354 MD |
284 | } channel; |
285 | struct { | |
74d81a6c MD |
286 | int shm_fd; |
287 | int wakeup_fd; | |
ef9ff354 | 288 | } stream; |
40003310 MD |
289 | struct { |
290 | struct lttng_ust_field_iter entry; | |
291 | } field_list; | |
ef9ff354 MD |
292 | }; |
293 | ||
b61ce3b2 | 294 | struct lttng_ust_objd_ops { |
ef9ff354 | 295 | long (*cmd)(int objd, unsigned int cmd, unsigned long arg, |
f59ed768 | 296 | union ust_args *args, void *owner); |
46050b1a MD |
297 | int (*release)(int objd); |
298 | }; | |
299 | ||
300 | /* Create root handle. Always ID 0. */ | |
301 | int lttng_abi_create_root_handle(void); | |
302 | ||
b61ce3b2 | 303 | const struct lttng_ust_objd_ops *objd_ops(int id); |
1849ef7c | 304 | int lttng_ust_objd_unref(int id, int is_owner); |
46050b1a MD |
305 | |
306 | void lttng_ust_abi_exit(void); | |
003fedf4 | 307 | void lttng_ust_events_exit(void); |
f59ed768 | 308 | void lttng_ust_objd_table_owner_cleanup(void *owner); |
b35d179d | 309 | |
9f3fdbc6 | 310 | #endif /* _LTTNG_UST_ABI_H */ |