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