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>
33 #ifndef __ust_stringify
34 #define __ust_stringify1(x) #x
35 #define __ust_stringify(x) __ust_stringify1(x)
36 #endif /* __ust_stringify */
38 #define LTTNG_UST_SYM_NAME_LEN 256
39 #define LTTNG_UST_ABI_PROCNAME_LEN 16
41 /* UST comm magic number, used to validate protocol and endianness. */
42 #define LTTNG_UST_COMM_MAGIC 0xC57C57C5
44 /* Version for ABI between liblttng-ust, sessiond, consumerd */
45 #define LTTNG_UST_ABI_MAJOR_VERSION 5
46 #define LTTNG_UST_ABI_MINOR_VERSION 0
48 enum lttng_ust_instrumentation
{
49 LTTNG_UST_TRACEPOINT
= 0,
51 LTTNG_UST_FUNCTION
= 2,
54 enum lttng_ust_loglevel_type
{
55 LTTNG_UST_LOGLEVEL_ALL
= 0,
56 LTTNG_UST_LOGLEVEL_RANGE
= 1,
57 LTTNG_UST_LOGLEVEL_SINGLE
= 2,
60 enum lttng_ust_output
{
64 enum lttng_ust_chan_type
{
65 LTTNG_UST_CHAN_PER_CPU
= 0,
66 LTTNG_UST_CHAN_METADATA
= 1,
69 struct lttng_ust_tracer_version
{
75 #define LTTNG_UST_CHANNEL_PADDING (LTTNG_UST_SYM_NAME_LEN + 32)
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.
82 #define LTTNG_UST_CHANNEL_DATA_MAX_LEN 1048576U
83 struct lttng_ust_channel
{
85 enum lttng_ust_chan_type type
;
86 char padding
[LTTNG_UST_CHANNEL_PADDING
];
87 char data
[]; /* variable sized data */
90 #define LTTNG_UST_STREAM_PADDING1 (LTTNG_UST_SYM_NAME_LEN + 32)
91 struct lttng_ust_stream
{
92 uint64_t len
; /* shm len */
93 uint32_t stream_nr
; /* stream number */
94 char padding
[LTTNG_UST_STREAM_PADDING1
];
96 * shm_fd and wakeup_fd are send over unix socket as file
97 * descriptors after this structure.
101 #define LTTNG_UST_EVENT_PADDING1 16
102 #define LTTNG_UST_EVENT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
103 struct lttng_ust_event
{
104 enum lttng_ust_instrumentation instrumentation
;
105 char name
[LTTNG_UST_SYM_NAME_LEN
]; /* event name */
107 enum lttng_ust_loglevel_type loglevel_type
;
108 int loglevel
; /* value, -1: all */
109 char padding
[LTTNG_UST_EVENT_PADDING1
];
111 /* Per instrumentation type configuration */
113 char padding
[LTTNG_UST_EVENT_PADDING2
];
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,
125 #define LTTNG_UST_FIELD_ITER_PADDING (LTTNG_UST_SYM_NAME_LEN + 28)
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 */
132 char padding
[LTTNG_UST_FIELD_ITER_PADDING
];
135 enum lttng_ust_context_type
{
136 LTTNG_UST_CONTEXT_VTID
= 0,
137 LTTNG_UST_CONTEXT_VPID
= 1,
138 LTTNG_UST_CONTEXT_PTHREAD_ID
= 2,
139 LTTNG_UST_CONTEXT_PROCNAME
= 3,
140 LTTNG_UST_CONTEXT_IP
= 4,
143 #define LTTNG_UST_CONTEXT_PADDING1 16
144 #define LTTNG_UST_CONTEXT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
145 struct lttng_ust_context
{
146 enum lttng_ust_context_type ctx
;
147 char padding
[LTTNG_UST_CONTEXT_PADDING1
];
150 char padding
[LTTNG_UST_CONTEXT_PADDING2
];
155 * Tracer channel attributes.
157 #define LTTNG_UST_CHANNEL_ATTR_PADDING (LTTNG_UST_SYM_NAME_LEN + 32)
158 struct lttng_ust_channel_attr
{
159 uint64_t subbuf_size
; /* bytes */
160 uint64_t num_subbuf
; /* power of 2 */
161 int overwrite
; /* 1: overwrite, 0: discard */
162 unsigned int switch_timer_interval
; /* usec */
163 unsigned int read_timer_interval
; /* usec */
164 enum lttng_ust_output output
; /* splice, mmap */
165 char padding
[LTTNG_UST_CHANNEL_ATTR_PADDING
];
168 #define LTTNG_UST_TRACEPOINT_ITER_PADDING 16
169 struct lttng_ust_tracepoint_iter
{
170 char name
[LTTNG_UST_SYM_NAME_LEN
]; /* provider:name */
172 char padding
[LTTNG_UST_TRACEPOINT_ITER_PADDING
];
175 enum lttng_ust_object_type
{
176 LTTNG_UST_OBJECT_TYPE_UNKNOWN
= -1,
177 LTTNG_UST_OBJECT_TYPE_CHANNEL
= 0,
178 LTTNG_UST_OBJECT_TYPE_STREAM
= 1,
179 LTTNG_UST_OBJECT_TYPE_EVENT
= 2,
180 LTTNG_UST_OBJECT_TYPE_CONTEXT
= 3,
183 #define LTTNG_UST_OBJECT_DATA_PADDING1 32
184 #define LTTNG_UST_OBJECT_DATA_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
186 struct lttng_ust_object_data
{
187 enum lttng_ust_object_type type
;
190 char padding1
[LTTNG_UST_OBJECT_DATA_PADDING1
];
194 enum lttng_ust_chan_type type
;
202 char padding2
[LTTNG_UST_OBJECT_DATA_PADDING2
];
206 enum lttng_ust_calibrate_type
{
207 LTTNG_UST_CALIBRATE_TRACEPOINT
,
210 #define LTTNG_UST_CALIBRATE_PADDING1 16
211 #define LTTNG_UST_CALIBRATE_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
212 struct lttng_ust_calibrate
{
213 enum lttng_ust_calibrate_type type
; /* type (input) */
214 char padding
[LTTNG_UST_CALIBRATE_PADDING1
];
217 char padding
[LTTNG_UST_CALIBRATE_PADDING2
];
221 #define FILTER_BYTECODE_MAX_LEN 65536
222 #define LTTNG_UST_FILTER_PADDING 32
223 struct lttng_ust_filter_bytecode
{
225 uint32_t reloc_offset
;
227 char padding
[LTTNG_UST_FILTER_PADDING
];
231 #define LTTNG_UST_EXCLUSION_PADDING 32
232 struct lttng_ust_event_exclusion
{
234 char padding
[LTTNG_UST_EXCLUSION_PADDING
];
235 char names
[LTTNG_UST_SYM_NAME_LEN
][0];
238 #define _UST_CMD(minor) (minor)
239 #define _UST_CMDR(minor, type) (minor)
240 #define _UST_CMDW(minor, type) (minor)
242 /* Handled by object descriptor */
243 #define LTTNG_UST_RELEASE _UST_CMD(0x1)
245 /* Handled by object cmd */
247 /* LTTng-UST commands */
248 #define LTTNG_UST_SESSION _UST_CMD(0x40)
249 #define LTTNG_UST_TRACER_VERSION \
250 _UST_CMDR(0x41, struct lttng_ust_tracer_version)
251 #define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
252 #define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
253 #define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
254 #define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45)
256 /* Session FD commands */
257 #define LTTNG_UST_CHANNEL \
258 _UST_CMDW(0x51, struct lttng_ust_channel)
259 #define LTTNG_UST_SESSION_START _UST_CMD(0x52)
260 #define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
262 /* Channel FD commands */
263 #define LTTNG_UST_STREAM _UST_CMD(0x60)
264 #define LTTNG_UST_EVENT \
265 _UST_CMDW(0x61, struct lttng_ust_event)
267 /* Event and Channel FD commands */
268 #define LTTNG_UST_CONTEXT \
269 _UST_CMDW(0x70, struct lttng_ust_context)
270 #define LTTNG_UST_FLUSH_BUFFER \
273 /* Event, Channel and Session commands */
274 #define LTTNG_UST_ENABLE _UST_CMD(0x80)
275 #define LTTNG_UST_DISABLE _UST_CMD(0x81)
277 /* Tracepoint list commands */
278 #define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90)
279 #define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91)
281 /* Event FD commands */
282 #define LTTNG_UST_FILTER _UST_CMD(0xA0)
283 #define LTTNG_UST_EXCLUSION _UST_CMD(0xA1)
285 #define LTTNG_UST_ROOT_HANDLE 0
287 struct lttng_ust_obj
;
299 struct lttng_ust_field_iter entry
;
303 struct lttng_ust_objd_ops
{
304 long (*cmd
)(int objd
, unsigned int cmd
, unsigned long arg
,
305 union ust_args
*args
, void *owner
);
306 int (*release
)(int objd
);
309 /* Create root handle. Always ID 0. */
310 int lttng_abi_create_root_handle(void);
312 const struct lttng_ust_objd_ops
*objd_ops(int id
);
313 int lttng_ust_objd_unref(int id
, int is_owner
);
315 void lttng_ust_abi_exit(void);
316 void lttng_ust_events_exit(void);
317 void lttng_ust_objd_table_owner_cleanup(void *owner
);
319 #endif /* _LTTNG_UST_ABI_H */