Sync lttng-ust ABI version in ust-abi-internal.h
[lttng-tools.git] / src / bin / lttng-sessiond / ust-abi-internal.h
1 /*
2 * Copied from LTTng-UST lttng/ust-abi.h
3 *
4 * LTTng-UST ABI header
5 *
6 * Copyright 2010-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 * SOFTWARE.
25 */
26
27 #ifndef LTTNG_UST_ABI_INTERNAL_H
28 #define LTTNG_UST_ABI_INTERNAL_H
29
30 #include <stdint.h>
31 #include <common/macros.h>
32
33 #ifndef LTTNG_PACKED
34 #error "LTTNG_PACKED should be defined"
35 #endif
36
37 #ifndef __ust_stringify
38 #define __ust_stringify1(x) #x
39 #define __ust_stringify(x) __ust_stringify1(x)
40 #endif /* __ust_stringify */
41
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
47
48 /* Version for ABI between liblttng-ust, sessiond, consumerd */
49 #define LTTNG_UST_ABI_MAJOR_VERSION 8
50 #define LTTNG_UST_ABI_MINOR_VERSION 1
51
52 enum lttng_ust_instrumentation {
53 LTTNG_UST_TRACEPOINT = 0,
54 LTTNG_UST_PROBE = 1,
55 LTTNG_UST_FUNCTION = 2,
56 };
57
58 enum lttng_ust_loglevel_type {
59 LTTNG_UST_LOGLEVEL_ALL = 0,
60 LTTNG_UST_LOGLEVEL_RANGE = 1,
61 LTTNG_UST_LOGLEVEL_SINGLE = 2,
62 };
63
64 enum lttng_ust_output {
65 LTTNG_UST_MMAP = 0,
66 };
67
68 enum lttng_ust_chan_type {
69 LTTNG_UST_CHAN_PER_CPU = 0,
70 LTTNG_UST_CHAN_METADATA = 1,
71 };
72
73 struct lttng_ust_tracer_version {
74 uint32_t major;
75 uint32_t minor;
76 uint32_t patchlevel;
77 } LTTNG_PACKED;
78
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
87 struct lttng_ust_channel {
88 uint64_t len;
89 enum lttng_ust_chan_type type;
90 char padding[LTTNG_UST_CHANNEL_PADDING];
91 char data[]; /* variable sized data */
92 } LTTNG_PACKED;
93
94 #define LTTNG_UST_STREAM_PADDING1 (LTTNG_UST_SYM_NAME_LEN + 32)
95 struct lttng_ust_stream {
96 uint64_t len; /* shm len */
97 uint32_t stream_nr; /* stream number */
98 char padding[LTTNG_UST_STREAM_PADDING1];
99 /*
100 * shm_fd and wakeup_fd are send over unix socket as file
101 * descriptors after this structure.
102 */
103 } LTTNG_PACKED;
104
105 #define LTTNG_UST_EVENT_PADDING1 16
106 #define LTTNG_UST_EVENT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
107 struct lttng_ust_event {
108 enum lttng_ust_instrumentation instrumentation;
109 char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */
110
111 enum lttng_ust_loglevel_type loglevel_type;
112 int loglevel; /* value, -1: all */
113 char padding[LTTNG_UST_EVENT_PADDING1];
114
115 /* Per instrumentation type configuration */
116 union {
117 char padding[LTTNG_UST_EVENT_PADDING2];
118 } u;
119 } LTTNG_PACKED;
120
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
129 #define LTTNG_UST_FIELD_ITER_PADDING (LTTNG_UST_SYM_NAME_LEN + 28)
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 */
135 int nowrite;
136 char padding[LTTNG_UST_FIELD_ITER_PADDING];
137 } LTTNG_PACKED;
138
139 enum lttng_ust_context_type {
140 LTTNG_UST_CONTEXT_VTID = 0,
141 LTTNG_UST_CONTEXT_VPID = 1,
142 LTTNG_UST_CONTEXT_PTHREAD_ID = 2,
143 LTTNG_UST_CONTEXT_PROCNAME = 3,
144 LTTNG_UST_CONTEXT_IP = 4,
145 LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER = 5,
146 LTTNG_UST_CONTEXT_CPU_ID = 6,
147 LTTNG_UST_CONTEXT_APP_CONTEXT = 7,
148 LTTNG_UST_CONTEXT_CGROUP_NS = 8,
149 LTTNG_UST_CONTEXT_IPC_NS = 9,
150 LTTNG_UST_CONTEXT_MNT_NS = 10,
151 LTTNG_UST_CONTEXT_NET_NS = 11,
152 LTTNG_UST_CONTEXT_PID_NS = 12,
153 LTTNG_UST_CONTEXT_USER_NS = 13,
154 LTTNG_UST_CONTEXT_UTS_NS = 14,
155 LTTNG_UST_CONTEXT_VUID = 15,
156 LTTNG_UST_CONTEXT_VEUID = 16,
157 LTTNG_UST_CONTEXT_VSUID = 17,
158 LTTNG_UST_CONTEXT_VGID = 18,
159 LTTNG_UST_CONTEXT_VEGID = 19,
160 LTTNG_UST_CONTEXT_VSGID = 20,
161 };
162
163 struct lttng_ust_perf_counter_ctx {
164 uint32_t type;
165 uint64_t config;
166 char name[LTTNG_UST_SYM_NAME_LEN];
167 } LTTNG_PACKED;
168
169 #define LTTNG_UST_CONTEXT_PADDING1 16
170 #define LTTNG_UST_CONTEXT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
171 struct lttng_ust_context {
172 enum lttng_ust_context_type ctx;
173 char padding[LTTNG_UST_CONTEXT_PADDING1];
174
175 union {
176 struct lttng_ust_perf_counter_ctx perf_counter;
177 struct {
178 /* Includes trailing '\0'. */
179 uint32_t provider_name_len;
180 uint32_t ctx_name_len;
181 } app_ctx;
182 char padding[LTTNG_UST_CONTEXT_PADDING2];
183 } u;
184 } LTTNG_PACKED;
185
186 /*
187 * Tracer channel attributes.
188 */
189 #define LTTNG_UST_CHANNEL_ATTR_PADDING (LTTNG_UST_SYM_NAME_LEN + 32)
190 struct lttng_ust_channel_attr {
191 uint64_t subbuf_size; /* bytes */
192 uint64_t num_subbuf; /* power of 2 */
193 int overwrite; /* 1: overwrite, 0: discard */
194 unsigned int switch_timer_interval; /* usec */
195 unsigned int read_timer_interval; /* usec */
196 enum lttng_ust_output output; /* splice, mmap */
197 union {
198 struct {
199 int64_t blocking_timeout; /* Blocking timeout (usec) */
200 } s;
201 char padding[LTTNG_UST_CHANNEL_ATTR_PADDING];
202 } u;
203 } LTTNG_PACKED;
204
205 #define LTTNG_UST_TRACEPOINT_ITER_PADDING 16
206 struct lttng_ust_tracepoint_iter {
207 char name[LTTNG_UST_SYM_NAME_LEN]; /* provider:name */
208 int loglevel;
209 char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING];
210 } LTTNG_PACKED;
211
212 enum lttng_ust_object_type {
213 LTTNG_UST_OBJECT_TYPE_UNKNOWN = -1,
214 LTTNG_UST_OBJECT_TYPE_CHANNEL = 0,
215 LTTNG_UST_OBJECT_TYPE_STREAM = 1,
216 LTTNG_UST_OBJECT_TYPE_EVENT = 2,
217 LTTNG_UST_OBJECT_TYPE_CONTEXT = 3,
218 };
219
220 #define LTTNG_UST_OBJECT_DATA_PADDING1 32
221 #define LTTNG_UST_OBJECT_DATA_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
222
223 struct lttng_ust_object_data {
224 enum lttng_ust_object_type type;
225 int handle;
226 uint64_t size;
227 char padding1[LTTNG_UST_OBJECT_DATA_PADDING1];
228 union {
229 struct {
230 void *data;
231 enum lttng_ust_chan_type type;
232 int wakeup_fd;
233 } channel;
234 struct {
235 int shm_fd;
236 int wakeup_fd;
237 uint32_t stream_nr;
238 } stream;
239 char padding2[LTTNG_UST_OBJECT_DATA_PADDING2];
240 } u;
241 } LTTNG_PACKED;
242
243 enum lttng_ust_calibrate_type {
244 LTTNG_UST_CALIBRATE_TRACEPOINT,
245 };
246
247 #define LTTNG_UST_CALIBRATE_PADDING1 16
248 #define LTTNG_UST_CALIBRATE_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
249 struct lttng_ust_calibrate {
250 enum lttng_ust_calibrate_type type; /* type (input) */
251 char padding[LTTNG_UST_CALIBRATE_PADDING1];
252
253 union {
254 char padding[LTTNG_UST_CALIBRATE_PADDING2];
255 } u;
256 } LTTNG_PACKED;
257
258 #define FILTER_BYTECODE_MAX_LEN 65536
259 #define LTTNG_UST_FILTER_PADDING 32
260 struct lttng_ust_filter_bytecode {
261 uint32_t len;
262 uint32_t reloc_offset;
263 uint64_t seqnum;
264 char padding[LTTNG_UST_FILTER_PADDING];
265 char data[0];
266 } LTTNG_PACKED;
267
268 #define LTTNG_UST_EXCLUSION_PADDING 32
269 struct lttng_ust_event_exclusion {
270 uint32_t count;
271 char padding[LTTNG_UST_EXCLUSION_PADDING];
272 char names[LTTNG_UST_SYM_NAME_LEN][0];
273 } LTTNG_PACKED;
274
275 #define _UST_CMD(minor) (minor)
276 #define _UST_CMDR(minor, type) (minor)
277 #define _UST_CMDW(minor, type) (minor)
278
279 /* Handled by object descriptor */
280 #define LTTNG_UST_RELEASE _UST_CMD(0x1)
281
282 /* Handled by object cmd */
283
284 /* LTTng-UST commands */
285 #define LTTNG_UST_SESSION _UST_CMD(0x40)
286 #define LTTNG_UST_TRACER_VERSION \
287 _UST_CMDR(0x41, struct lttng_ust_tracer_version)
288 #define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
289 #define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
290 #define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
291 #define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45)
292
293 /* Session FD commands */
294 #define LTTNG_UST_CHANNEL \
295 _UST_CMDW(0x51, struct lttng_ust_channel)
296 #define LTTNG_UST_SESSION_START _UST_CMD(0x52)
297 #define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
298 #define LTTNG_UST_SESSION_STATEDUMP _UST_CMD(0x54)
299
300 /* Channel FD commands */
301 #define LTTNG_UST_STREAM _UST_CMD(0x60)
302 #define LTTNG_UST_EVENT \
303 _UST_CMDW(0x61, struct lttng_ust_event)
304
305 /* Event and Channel FD commands */
306 #define LTTNG_UST_CONTEXT \
307 _UST_CMDW(0x70, struct lttng_ust_context)
308 #define LTTNG_UST_FLUSH_BUFFER \
309 _UST_CMD(0x71)
310
311 /* Event, Channel and Session commands */
312 #define LTTNG_UST_ENABLE _UST_CMD(0x80)
313 #define LTTNG_UST_DISABLE _UST_CMD(0x81)
314
315 /* Tracepoint list commands */
316 #define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90)
317 #define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91)
318
319 /* Event FD commands */
320 #define LTTNG_UST_FILTER _UST_CMD(0xA0)
321 #define LTTNG_UST_EXCLUSION _UST_CMD(0xA1)
322
323 #define LTTNG_UST_ROOT_HANDLE 0
324
325 struct lttng_ust_obj;
326
327 union ust_args {
328 struct {
329 void *chan_data;
330 int wakeup_fd;
331 } channel;
332 struct {
333 int shm_fd;
334 int wakeup_fd;
335 } stream;
336 struct {
337 struct lttng_ust_field_iter entry;
338 } field_list;
339 struct {
340 char *ctxname;
341 } app_context;
342 };
343
344 struct lttng_ust_objd_ops {
345 long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
346 union ust_args *args, void *owner);
347 int (*release)(int objd);
348 };
349
350 /* Create root handle. Always ID 0. */
351 int lttng_abi_create_root_handle(void);
352
353 const struct lttng_ust_objd_ops *objd_ops(int id);
354 int lttng_ust_objd_unref(int id, int is_owner);
355
356 void lttng_ust_abi_exit(void);
357 void lttng_ust_events_exit(void);
358 void lttng_ust_objd_table_owner_cleanup(void *owner);
359
360 #endif /* LTTNG_UST_ABI_INTERNAL_H */
This page took 0.053737 seconds and 5 git commands to generate.