Commit | Line | Data |
---|---|---|
3bd1e081 MD |
1 | #ifndef _LTTNG_UST_ABI_H |
2 | #define _LTTNG_UST_ABI_H | |
3 | ||
4 | /* | |
9df8df5e | 5 | * lttng/ust-abi.h |
3bd1e081 | 6 | * |
3bd1e081 MD |
7 | * LTTng-UST ABI header |
8 | * | |
ab6a6569 | 9 | * Copyright 2010-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
3f3c65dc | 10 | * |
bf74a86d AM |
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: | |
17 | * | |
18 | * The above copyright notice and this permission notice shall be included in | |
19 | * all copies or substantial portions of the Software. | |
bb719d46 DG |
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. | |
3bd1e081 MD |
28 | */ |
29 | ||
30 | #include <stdint.h> | |
ffe60014 | 31 | #include <lttng/ust-compiler.h> |
3bd1e081 | 32 | |
57ab7638 | 33 | #define LTTNG_UST_SYM_NAME_LEN 256 |
3bd1e081 | 34 | |
ab6a6569 | 35 | /* Version for comm protocol between sessiond and ust */ |
3f3c65dc | 36 | #define LTTNG_UST_COMM_VERSION_MAJOR 2 |
bb719d46 | 37 | #define LTTNG_UST_COMM_VERSION_MINOR 1 |
3bd1e081 | 38 | |
ab6a6569 DG |
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 | ||
3bd1e081 | 44 | enum lttng_ust_instrumentation { |
177f8533 MD |
45 | LTTNG_UST_TRACEPOINT = 0, |
46 | LTTNG_UST_PROBE = 1, | |
47 | LTTNG_UST_FUNCTION = 2, | |
0cda4f28 MD |
48 | }; |
49 | ||
50 | enum lttng_ust_loglevel_type { | |
8005f29a MD |
51 | LTTNG_UST_LOGLEVEL_ALL = 0, |
52 | LTTNG_UST_LOGLEVEL_RANGE = 1, | |
53 | LTTNG_UST_LOGLEVEL_SINGLE = 2, | |
3bd1e081 MD |
54 | }; |
55 | ||
56 | enum lttng_ust_output { | |
57 | LTTNG_UST_MMAP = 0, | |
58 | }; | |
59 | ||
ffe60014 DG |
60 | enum lttng_ust_chan_type { |
61 | LTTNG_UST_CHAN_PER_CPU = 0, | |
62 | LTTNG_UST_CHAN_METADATA = 1, | |
63 | }; | |
64 | ||
3bd1e081 | 65 | struct lttng_ust_tracer_version { |
3f3c65dc MD |
66 | uint32_t major; |
67 | uint32_t minor; | |
3bd1e081 | 68 | uint32_t patchlevel; |
bb719d46 | 69 | } LTTNG_PACKED; |
3bd1e081 | 70 | |
3f3c65dc | 71 | #define LTTNG_UST_CHANNEL_PADDING LTTNG_UST_SYM_NAME_LEN + 32 |
ffe60014 DG |
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 | |
3bd1e081 | 79 | struct lttng_ust_channel { |
ffe60014 DG |
80 | uint64_t len; |
81 | enum lttng_ust_chan_type type; | |
3f3c65dc | 82 | char padding[LTTNG_UST_CHANNEL_PADDING]; |
ffe60014 | 83 | char data[]; /* variable sized data */ |
bb719d46 | 84 | } LTTNG_PACKED; |
3f3c65dc | 85 | |
ffe60014 | 86 | #define LTTNG_UST_STREAM_PADDING1 LTTNG_UST_SYM_NAME_LEN + 32 |
3f3c65dc | 87 | struct lttng_ust_stream { |
ffe60014 DG |
88 | uint64_t len; /* shm len */ |
89 | uint32_t stream_nr; /* stream number */ | |
3f3c65dc | 90 | char padding[LTTNG_UST_STREAM_PADDING1]; |
ffe60014 DG |
91 | /* |
92 | * shm_fd and wakeup_fd are send over unix socket as file | |
93 | * descriptors after this structure. | |
94 | */ | |
bb719d46 | 95 | } LTTNG_PACKED; |
3bd1e081 | 96 | |
3f3c65dc MD |
97 | #define LTTNG_UST_EVENT_PADDING1 16 |
98 | #define LTTNG_UST_EVENT_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32 | |
3bd1e081 | 99 | struct lttng_ust_event { |
69892bbb | 100 | enum lttng_ust_instrumentation instrumentation; |
0cda4f28 MD |
101 | char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */ |
102 | ||
103 | enum lttng_ust_loglevel_type loglevel_type; | |
8005f29a | 104 | int loglevel; /* value, -1: all */ |
3f3c65dc | 105 | char padding[LTTNG_UST_EVENT_PADDING1]; |
0cda4f28 | 106 | |
3bd1e081 MD |
107 | /* Per instrumentation type configuration */ |
108 | union { | |
3f3c65dc | 109 | char padding[LTTNG_UST_EVENT_PADDING2]; |
3bd1e081 | 110 | } u; |
bb719d46 | 111 | } LTTNG_PACKED; |
3bd1e081 | 112 | |
f214d69a 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 | ||
ab6a6569 | 121 | #define LTTNG_UST_FIELD_ITER_PADDING LTTNG_UST_SYM_NAME_LEN + 28 |
f214d69a 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 */ | |
590b9e3c | 127 | int nowrite; |
f214d69a | 128 | char padding[LTTNG_UST_FIELD_ITER_PADDING]; |
bb719d46 | 129 | } LTTNG_PACKED; |
f214d69a | 130 | |
3bd1e081 MD |
131 | enum lttng_ust_context_type { |
132 | LTTNG_UST_CONTEXT_VTID = 0, | |
133 | LTTNG_UST_CONTEXT_VPID = 1, | |
134 | LTTNG_UST_CONTEXT_PTHREAD_ID = 2, | |
135 | LTTNG_UST_CONTEXT_PROCNAME = 3, | |
136 | }; | |
137 | ||
3f3c65dc MD |
138 | #define LTTNG_UST_CONTEXT_PADDING1 16 |
139 | #define LTTNG_UST_CONTEXT_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32 | |
3bd1e081 MD |
140 | struct lttng_ust_context { |
141 | enum lttng_ust_context_type ctx; | |
3f3c65dc MD |
142 | char padding[LTTNG_UST_CONTEXT_PADDING1]; |
143 | ||
3bd1e081 | 144 | union { |
3f3c65dc | 145 | char padding[LTTNG_UST_CONTEXT_PADDING2]; |
3bd1e081 | 146 | } u; |
bb719d46 | 147 | } LTTNG_PACKED; |
3bd1e081 | 148 | |
13161846 DG |
149 | /* |
150 | * Tracer channel attributes. | |
151 | */ | |
3f3c65dc | 152 | #define LTTNG_UST_CHANNEL_ATTR_PADDING LTTNG_UST_SYM_NAME_LEN + 32 |
13161846 | 153 | struct lttng_ust_channel_attr { |
13161846 DG |
154 | uint64_t subbuf_size; /* bytes */ |
155 | uint64_t num_subbuf; /* power of 2 */ | |
6f30f9b8 | 156 | int overwrite; /* 1: overwrite, 0: discard */ |
13161846 DG |
157 | unsigned int switch_timer_interval; /* usec */ |
158 | unsigned int read_timer_interval; /* usec */ | |
159 | enum lttng_ust_output output; /* splice, mmap */ | |
3f3c65dc | 160 | char padding[LTTNG_UST_CHANNEL_ATTR_PADDING]; |
bb719d46 | 161 | } LTTNG_PACKED; |
13161846 | 162 | |
3f3c65dc | 163 | #define LTTNG_UST_TRACEPOINT_ITER_PADDING 16 |
177f8533 MD |
164 | struct lttng_ust_tracepoint_iter { |
165 | char name[LTTNG_UST_SYM_NAME_LEN]; /* provider:name */ | |
8005f29a | 166 | int loglevel; |
3f3c65dc | 167 | char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING]; |
bb719d46 | 168 | } LTTNG_PACKED; |
177f8533 | 169 | |
ffe60014 DG |
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 | ||
13161846 | 179 | struct lttng_ust_object_data { |
ffe60014 | 180 | enum lttng_ust_object_type type; |
13161846 | 181 | int handle; |
ffe60014 DG |
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; | |
bb719d46 | 196 | } LTTNG_PACKED; |
13161846 | 197 | |
f7e1a950 DG |
198 | enum lttng_ust_calibrate_type { |
199 | LTTNG_UST_CALIBRATE_TRACEPOINT, | |
200 | }; | |
201 | ||
3f3c65dc MD |
202 | #define LTTNG_UST_CALIBRATE_PADDING1 16 |
203 | #define LTTNG_UST_CALIBRATE_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32 | |
f7e1a950 | 204 | struct lttng_ust_calibrate { |
3f3c65dc MD |
205 | enum lttng_ust_calibrate_type type; /* type (input) */ |
206 | char padding[LTTNG_UST_CALIBRATE_PADDING1]; | |
207 | ||
208 | union { | |
209 | char padding[LTTNG_UST_CALIBRATE_PADDING2]; | |
210 | } u; | |
bb719d46 | 211 | } LTTNG_PACKED; |
f7e1a950 | 212 | |
d93c4f1f | 213 | #define FILTER_BYTECODE_MAX_LEN 65536 |
b6bbed5f | 214 | #define LTTNG_UST_FILTER_PADDING 32 |
53a80697 | 215 | struct lttng_ust_filter_bytecode { |
d93c4f1f CB |
216 | uint32_t len; |
217 | uint32_t reloc_offset; | |
b6bbed5f DG |
218 | uint64_t seqnum; |
219 | char padding[LTTNG_UST_FILTER_PADDING]; | |
53a80697 | 220 | char data[0]; |
bb719d46 | 221 | } LTTNG_PACKED; |
53a80697 | 222 | |
3bd1e081 MD |
223 | #define _UST_CMD(minor) (minor) |
224 | #define _UST_CMDR(minor, type) (minor) | |
225 | #define _UST_CMDW(minor, type) (minor) | |
226 | ||
227 | /* Handled by object descriptor */ | |
228 | #define LTTNG_UST_RELEASE _UST_CMD(0x1) | |
229 | ||
230 | /* Handled by object cmd */ | |
231 | ||
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) | |
238 | #define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44) | |
f214d69a | 239 | #define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45) |
3bd1e081 MD |
240 | |
241 | /* Session FD commands */ | |
242 | #define LTTNG_UST_METADATA \ | |
243 | _UST_CMDW(0x50, struct lttng_ust_channel) | |
244 | #define LTTNG_UST_CHANNEL \ | |
245 | _UST_CMDW(0x51, struct lttng_ust_channel) | |
246 | #define LTTNG_UST_SESSION_START _UST_CMD(0x52) | |
247 | #define LTTNG_UST_SESSION_STOP _UST_CMD(0x53) | |
248 | ||
249 | /* Channel FD commands */ | |
250 | #define LTTNG_UST_STREAM _UST_CMD(0x60) | |
251 | #define LTTNG_UST_EVENT \ | |
252 | _UST_CMDW(0x61, struct lttng_ust_event) | |
253 | ||
254 | /* Event and Channel FD commands */ | |
255 | #define LTTNG_UST_CONTEXT \ | |
256 | _UST_CMDW(0x70, struct lttng_ust_context) | |
2bdd86d4 MD |
257 | #define LTTNG_UST_FLUSH_BUFFER \ |
258 | _UST_CMD(0x71) | |
3bd1e081 MD |
259 | |
260 | /* Event, Channel and Session commands */ | |
261 | #define LTTNG_UST_ENABLE _UST_CMD(0x80) | |
262 | #define LTTNG_UST_DISABLE _UST_CMD(0x81) | |
263 | ||
8ec2d32a MD |
264 | /* Tracepoint list commands */ |
265 | #define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90) | |
f214d69a | 266 | #define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91) |
8ec2d32a | 267 | |
ab6a6569 DG |
268 | /* Event FD commands */ |
269 | #define LTTNG_UST_FILTER _UST_CMD(0xA0) | |
270 | ||
3bd1e081 MD |
271 | #define LTTNG_UST_ROOT_HANDLE 0 |
272 | ||
9df8df5e | 273 | struct lttng_ust_obj; |
3bd1e081 | 274 | |
18cef803 MD |
275 | union ust_args { |
276 | struct { | |
ffe60014 | 277 | void *chan_data; |
18cef803 MD |
278 | } channel; |
279 | struct { | |
ffe60014 DG |
280 | int shm_fd; |
281 | int wakeup_fd; | |
18cef803 | 282 | } stream; |
da0bdb87 MD |
283 | struct { |
284 | struct lttng_ust_field_iter entry; | |
285 | } field_list; | |
18cef803 MD |
286 | }; |
287 | ||
9df8df5e | 288 | struct lttng_ust_objd_ops { |
18cef803 | 289 | long (*cmd)(int objd, unsigned int cmd, unsigned long arg, |
bb719d46 | 290 | union ust_args *args, void *owner); |
3bd1e081 MD |
291 | int (*release)(int objd); |
292 | }; | |
293 | ||
294 | /* Create root handle. Always ID 0. */ | |
295 | int lttng_abi_create_root_handle(void); | |
296 | ||
9df8df5e DG |
297 | const struct lttng_ust_objd_ops *objd_ops(int id); |
298 | int lttng_ust_objd_unref(int id); | |
3bd1e081 MD |
299 | |
300 | void lttng_ust_abi_exit(void); | |
9df8df5e | 301 | void lttng_ust_events_exit(void); |
bb719d46 | 302 | void lttng_ust_objd_table_owner_cleanup(void *owner); |
3bd1e081 MD |
303 | |
304 | #endif /* _LTTNG_UST_ABI_H */ |