1 #ifndef _LTTNG_UST_ABI_H
2 #define _LTTNG_UST_ABI_H
9 * Copyright 2010-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
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
31 #include <lttng/ust-compiler.h>
34 #error "LTTNG_PACKED should be defined"
37 #ifndef __ust_stringify
38 #define __ust_stringify1(x) #x
39 #define __ust_stringify(x) __ust_stringify1(x)
40 #endif /* __ust_stringify */
42 #define LTTNG_UST_SYM_NAME_LEN 256
43 #define LTTNG_UST_ABI_PROCNAME_LEN 16
45 /* UST comm magic number, used to validate protocol and endianness. */
46 #define LTTNG_UST_COMM_MAGIC 0xC57C57C5
48 /* Version for ABI between liblttng-ust, sessiond, consumerd */
49 #define LTTNG_UST_ABI_MAJOR_VERSION 9
50 #define LTTNG_UST_ABI_MAJOR_VERSION_OLDEST_COMPATIBLE 8
51 #define LTTNG_UST_ABI_MINOR_VERSION 0
53 enum lttng_ust_instrumentation
{
54 LTTNG_UST_TRACEPOINT
= 0,
56 LTTNG_UST_FUNCTION
= 2,
59 enum lttng_ust_loglevel_type
{
60 LTTNG_UST_LOGLEVEL_ALL
= 0,
61 LTTNG_UST_LOGLEVEL_RANGE
= 1,
62 LTTNG_UST_LOGLEVEL_SINGLE
= 2,
65 enum lttng_ust_output
{
69 enum lttng_ust_chan_type
{
70 LTTNG_UST_CHAN_PER_CPU
= 0,
71 LTTNG_UST_CHAN_METADATA
= 1,
74 struct lttng_ust_tracer_version
{
80 #define LTTNG_UST_CHANNEL_PADDING (LTTNG_UST_SYM_NAME_LEN + 32)
82 * Given that the consumerd is limited to 64k file descriptors, we
83 * cannot expect much more than 1MB channel structure size. This size is
84 * depends on the number of streams within a channel, which depends on
85 * the number of possible CPUs on the system.
87 #define LTTNG_UST_CHANNEL_DATA_MAX_LEN 1048576U
88 struct lttng_ust_channel
{
90 enum lttng_ust_chan_type type
;
91 char padding
[LTTNG_UST_CHANNEL_PADDING
];
92 char data
[]; /* variable sized data */
95 #define LTTNG_UST_STREAM_PADDING1 (LTTNG_UST_SYM_NAME_LEN + 32)
96 struct lttng_ust_stream
{
97 uint64_t len
; /* shm len */
98 uint32_t stream_nr
; /* stream number */
99 char padding
[LTTNG_UST_STREAM_PADDING1
];
101 * shm_fd and wakeup_fd are send over unix socket as file
102 * descriptors after this structure.
106 #define LTTNG_UST_EVENT_PADDING1 8
107 #define LTTNG_UST_EVENT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
108 struct lttng_ust_event
{
109 enum lttng_ust_instrumentation instrumentation
;
110 char name
[LTTNG_UST_SYM_NAME_LEN
]; /* event name */
112 enum lttng_ust_loglevel_type loglevel_type
;
113 int loglevel
; /* value, -1: all */
114 uint64_t token
; /* User-provided token */
115 char padding
[LTTNG_UST_EVENT_PADDING1
];
117 /* Per instrumentation type configuration */
119 char padding
[LTTNG_UST_EVENT_PADDING2
];
123 #define LTTNG_UST_EVENT_NOTIFIER_PADDING1 16
124 struct lttng_ust_event_notifier
{
125 struct lttng_ust_event event
;
126 char padding
[LTTNG_UST_EVENT_NOTIFIER_PADDING1
];
129 #define LTTNG_EVENT_NOTIFIER_NOTIFICATION_PADDING 32
130 struct lttng_ust_event_notifier_notification
{
132 uint16_t capture_buf_size
;
133 char padding
[LTTNG_EVENT_NOTIFIER_NOTIFICATION_PADDING
];
136 enum lttng_ust_field_type
{
137 LTTNG_UST_FIELD_OTHER
= 0,
138 LTTNG_UST_FIELD_INTEGER
= 1,
139 LTTNG_UST_FIELD_ENUM
= 2,
140 LTTNG_UST_FIELD_FLOAT
= 3,
141 LTTNG_UST_FIELD_STRING
= 4,
144 #define LTTNG_UST_FIELD_ITER_PADDING (LTTNG_UST_SYM_NAME_LEN + 28)
145 struct lttng_ust_field_iter
{
146 char event_name
[LTTNG_UST_SYM_NAME_LEN
];
147 char field_name
[LTTNG_UST_SYM_NAME_LEN
];
148 enum lttng_ust_field_type type
;
149 int loglevel
; /* event loglevel */
151 char padding
[LTTNG_UST_FIELD_ITER_PADDING
];
154 enum lttng_ust_context_type
{
155 LTTNG_UST_CONTEXT_VTID
= 0,
156 LTTNG_UST_CONTEXT_VPID
= 1,
157 LTTNG_UST_CONTEXT_PTHREAD_ID
= 2,
158 LTTNG_UST_CONTEXT_PROCNAME
= 3,
159 LTTNG_UST_CONTEXT_IP
= 4,
160 LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
= 5,
161 LTTNG_UST_CONTEXT_CPU_ID
= 6,
162 LTTNG_UST_CONTEXT_APP_CONTEXT
= 7,
163 LTTNG_UST_CONTEXT_CGROUP_NS
= 8,
164 LTTNG_UST_CONTEXT_IPC_NS
= 9,
165 LTTNG_UST_CONTEXT_MNT_NS
= 10,
166 LTTNG_UST_CONTEXT_NET_NS
= 11,
167 LTTNG_UST_CONTEXT_PID_NS
= 12,
168 LTTNG_UST_CONTEXT_USER_NS
= 13,
169 LTTNG_UST_CONTEXT_UTS_NS
= 14,
170 LTTNG_UST_CONTEXT_VUID
= 15,
171 LTTNG_UST_CONTEXT_VEUID
= 16,
172 LTTNG_UST_CONTEXT_VSUID
= 17,
173 LTTNG_UST_CONTEXT_VGID
= 18,
174 LTTNG_UST_CONTEXT_VEGID
= 19,
175 LTTNG_UST_CONTEXT_VSGID
= 20,
176 LTTNG_UST_CONTEXT_TIME_NS
= 21,
179 struct lttng_ust_perf_counter_ctx
{
182 char name
[LTTNG_UST_SYM_NAME_LEN
];
185 #define LTTNG_UST_CONTEXT_PADDING1 16
186 #define LTTNG_UST_CONTEXT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
187 struct lttng_ust_context
{
188 enum lttng_ust_context_type ctx
;
189 char padding
[LTTNG_UST_CONTEXT_PADDING1
];
192 struct lttng_ust_perf_counter_ctx perf_counter
;
194 /* Includes trailing '\0'. */
195 uint32_t provider_name_len
;
196 uint32_t ctx_name_len
;
198 char padding
[LTTNG_UST_CONTEXT_PADDING2
];
203 * Tracer channel attributes.
205 #define LTTNG_UST_CHANNEL_ATTR_PADDING (LTTNG_UST_SYM_NAME_LEN + 32)
206 struct lttng_ust_channel_attr
{
207 uint64_t subbuf_size
; /* bytes */
208 uint64_t num_subbuf
; /* power of 2 */
209 int overwrite
; /* 1: overwrite, 0: discard */
210 unsigned int switch_timer_interval
; /* usec */
211 unsigned int read_timer_interval
; /* usec */
212 enum lttng_ust_output output
; /* splice, mmap */
215 int64_t blocking_timeout
; /* Blocking timeout (usec) */
217 char padding
[LTTNG_UST_CHANNEL_ATTR_PADDING
];
221 #define LTTNG_UST_TRACEPOINT_ITER_PADDING 16
222 struct lttng_ust_tracepoint_iter
{
223 char name
[LTTNG_UST_SYM_NAME_LEN
]; /* provider:name */
225 char padding
[LTTNG_UST_TRACEPOINT_ITER_PADDING
];
228 enum lttng_ust_object_type
{
229 LTTNG_UST_OBJECT_TYPE_UNKNOWN
= -1,
230 LTTNG_UST_OBJECT_TYPE_CHANNEL
= 0,
231 LTTNG_UST_OBJECT_TYPE_STREAM
= 1,
232 LTTNG_UST_OBJECT_TYPE_EVENT
= 2,
233 LTTNG_UST_OBJECT_TYPE_CONTEXT
= 3,
234 LTTNG_UST_OBJECT_TYPE_EVENT_NOTIFIER_GROUP
= 4,
235 LTTNG_UST_OBJECT_TYPE_EVENT_NOTIFIER
= 5,
238 #define LTTNG_UST_OBJECT_DATA_PADDING1 32
239 #define LTTNG_UST_OBJECT_DATA_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
241 struct lttng_ust_object_data
{
242 enum lttng_ust_object_type type
;
245 char padding1
[LTTNG_UST_OBJECT_DATA_PADDING1
];
249 enum lttng_ust_chan_type type
;
257 char padding2
[LTTNG_UST_OBJECT_DATA_PADDING2
];
261 enum lttng_ust_calibrate_type
{
262 LTTNG_UST_CALIBRATE_TRACEPOINT
,
265 #define LTTNG_UST_CALIBRATE_PADDING1 16
266 #define LTTNG_UST_CALIBRATE_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
267 struct lttng_ust_calibrate
{
268 enum lttng_ust_calibrate_type type
; /* type (input) */
269 char padding
[LTTNG_UST_CALIBRATE_PADDING1
];
272 char padding
[LTTNG_UST_CALIBRATE_PADDING2
];
276 #define FILTER_BYTECODE_MAX_LEN 65536
277 #define LTTNG_UST_FILTER_PADDING 32
278 struct lttng_ust_filter_bytecode
{
280 uint32_t reloc_offset
;
282 char padding
[LTTNG_UST_FILTER_PADDING
];
286 #define CAPTURE_BYTECODE_MAX_LEN 65536
287 #define LTTNG_UST_CAPTURE_PADDING 32
288 struct lttng_ust_capture_bytecode
{
290 uint32_t reloc_offset
;
292 char padding
[LTTNG_UST_CAPTURE_PADDING
];
296 #define LTTNG_UST_EXCLUSION_PADDING 32
297 struct lttng_ust_event_exclusion
{
299 char padding
[LTTNG_UST_EXCLUSION_PADDING
];
300 char names
[LTTNG_UST_SYM_NAME_LEN
][0];
303 #define _UST_CMD(minor) (minor)
304 #define _UST_CMDR(minor, type) (minor)
305 #define _UST_CMDW(minor, type) (minor)
307 /* Handled by object descriptor */
308 #define LTTNG_UST_RELEASE _UST_CMD(0x1)
310 /* Handled by object cmd */
312 /* LTTng-UST commands */
313 #define LTTNG_UST_SESSION _UST_CMD(0x40)
314 #define LTTNG_UST_TRACER_VERSION \
315 _UST_CMDR(0x41, struct lttng_ust_tracer_version)
316 #define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
317 #define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
318 #define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
319 #define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45)
320 #define LTTNG_UST_EVENT_NOTIFIER_GROUP_CREATE _UST_CMD(0x46)
322 /* Session FD commands */
323 #define LTTNG_UST_CHANNEL \
324 _UST_CMDW(0x51, struct lttng_ust_channel)
325 #define LTTNG_UST_SESSION_START _UST_CMD(0x52)
326 #define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
327 #define LTTNG_UST_SESSION_STATEDUMP _UST_CMD(0x54)
329 /* Channel FD commands */
330 #define LTTNG_UST_STREAM _UST_CMD(0x60)
331 #define LTTNG_UST_EVENT \
332 _UST_CMDW(0x61, struct lttng_ust_event)
334 /* Event and Channel FD commands */
335 #define LTTNG_UST_CONTEXT \
336 _UST_CMDW(0x70, struct lttng_ust_context)
337 #define LTTNG_UST_FLUSH_BUFFER \
340 /* Event, Channel and Session commands */
341 #define LTTNG_UST_ENABLE _UST_CMD(0x80)
342 #define LTTNG_UST_DISABLE _UST_CMD(0x81)
344 /* Tracepoint list commands */
345 #define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90)
346 #define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91)
348 /* Event FD commands */
349 #define LTTNG_UST_FILTER _UST_CMD(0xA0)
350 #define LTTNG_UST_EXCLUSION _UST_CMD(0xA1)
352 /* Event notifier group commands */
353 #define LTTNG_UST_EVENT_NOTIFIER_CREATE \
354 _UST_CMDW(0xB0, struct lttng_ust_event_notifier)
355 #define LTTNG_UST_CAPTURE _UST_CMD(0xB1)
357 #define LTTNG_UST_ROOT_HANDLE 0
359 struct lttng_ust_obj
;
371 struct lttng_ust_field_iter entry
;
377 int event_notifier_notif_fd
;
378 } event_notifier_handle
;
381 struct lttng_ust_objd_ops
{
382 long (*cmd
)(int objd
, unsigned int cmd
, unsigned long arg
,
383 union ust_args
*args
, void *owner
);
384 int (*release
)(int objd
);
387 /* Create root handle. Always ID 0. */
388 int lttng_abi_create_root_handle(void);
390 const struct lttng_ust_objd_ops
*objd_ops(int id
);
391 int lttng_ust_objd_unref(int id
, int is_owner
);
393 void lttng_ust_abi_exit(void);
394 void lttng_ust_events_exit(void);
395 void lttng_ust_objd_table_owner_cleanup(void *owner
);
397 #endif /* _LTTNG_UST_ABI_H */