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
32 #define lttng_ust_notrace __attribute__((no_instrument_function))
33 #define LTTNG_PACKED __attribute__((__packed__))
35 #ifndef __ust_stringify
36 #define __ust_stringify1(x) #x
37 #define __ust_stringify(x) __ust_stringify1(x)
38 #endif /* __ust_stringify */
40 #define LTTNG_UST_SYM_NAME_LEN 256
41 #define LTTNG_UST_ABI_PROCNAME_LEN 16
43 /* UST comm magic number, used to validate protocol and endianness. */
44 #define LTTNG_UST_COMM_MAGIC 0xC57C57C5
46 /* Version for ABI between liblttng-ust, sessiond, consumerd */
47 #define LTTNG_UST_ABI_MAJOR_VERSION 5
48 #define LTTNG_UST_ABI_MINOR_VERSION 0
50 enum lttng_ust_instrumentation
{
51 LTTNG_UST_TRACEPOINT
= 0,
53 LTTNG_UST_FUNCTION
= 2,
56 enum lttng_ust_loglevel_type
{
57 LTTNG_UST_LOGLEVEL_ALL
= 0,
58 LTTNG_UST_LOGLEVEL_RANGE
= 1,
59 LTTNG_UST_LOGLEVEL_SINGLE
= 2,
62 enum lttng_ust_output
{
66 enum lttng_ust_chan_type
{
67 LTTNG_UST_CHAN_PER_CPU
= 0,
68 LTTNG_UST_CHAN_METADATA
= 1,
71 struct lttng_ust_tracer_version
{
77 #define LTTNG_UST_CHANNEL_PADDING (LTTNG_UST_SYM_NAME_LEN + 32)
79 * Given that the consumerd is limited to 64k file descriptors, we
80 * cannot expect much more than 1MB channel structure size. This size is
81 * depends on the number of streams within a channel, which depends on
82 * the number of possible CPUs on the system.
84 #define LTTNG_UST_CHANNEL_DATA_MAX_LEN 1048576U
85 struct lttng_ust_channel
{
87 enum lttng_ust_chan_type type
;
88 char padding
[LTTNG_UST_CHANNEL_PADDING
];
89 char data
[]; /* variable sized data */
92 #define LTTNG_UST_STREAM_PADDING1 (LTTNG_UST_SYM_NAME_LEN + 32)
93 struct lttng_ust_stream
{
94 uint64_t len
; /* shm len */
95 uint32_t stream_nr
; /* stream number */
96 char padding
[LTTNG_UST_STREAM_PADDING1
];
98 * shm_fd and wakeup_fd are send over unix socket as file
99 * descriptors after this structure.
103 #define LTTNG_UST_EVENT_PADDING1 16
104 #define LTTNG_UST_EVENT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
105 struct lttng_ust_event
{
106 enum lttng_ust_instrumentation instrumentation
;
107 char name
[LTTNG_UST_SYM_NAME_LEN
]; /* event name */
109 enum lttng_ust_loglevel_type loglevel_type
;
110 int loglevel
; /* value, -1: all */
111 char padding
[LTTNG_UST_EVENT_PADDING1
];
113 /* Per instrumentation type configuration */
115 char padding
[LTTNG_UST_EVENT_PADDING2
];
119 enum lttng_ust_field_type
{
120 LTTNG_UST_FIELD_OTHER
= 0,
121 LTTNG_UST_FIELD_INTEGER
= 1,
122 LTTNG_UST_FIELD_ENUM
= 2,
123 LTTNG_UST_FIELD_FLOAT
= 3,
124 LTTNG_UST_FIELD_STRING
= 4,
127 #define LTTNG_UST_FIELD_ITER_PADDING (LTTNG_UST_SYM_NAME_LEN + 28)
128 struct lttng_ust_field_iter
{
129 char event_name
[LTTNG_UST_SYM_NAME_LEN
];
130 char field_name
[LTTNG_UST_SYM_NAME_LEN
];
131 enum lttng_ust_field_type type
;
132 int loglevel
; /* event loglevel */
134 char padding
[LTTNG_UST_FIELD_ITER_PADDING
];
137 enum lttng_ust_context_type
{
138 LTTNG_UST_CONTEXT_VTID
= 0,
139 LTTNG_UST_CONTEXT_VPID
= 1,
140 LTTNG_UST_CONTEXT_PTHREAD_ID
= 2,
141 LTTNG_UST_CONTEXT_PROCNAME
= 3,
142 LTTNG_UST_CONTEXT_IP
= 4,
145 #define LTTNG_UST_CONTEXT_PADDING1 16
146 #define LTTNG_UST_CONTEXT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
147 struct lttng_ust_context
{
148 enum lttng_ust_context_type ctx
;
149 char padding
[LTTNG_UST_CONTEXT_PADDING1
];
152 char padding
[LTTNG_UST_CONTEXT_PADDING2
];
157 * Tracer channel attributes.
159 #define LTTNG_UST_CHANNEL_ATTR_PADDING (LTTNG_UST_SYM_NAME_LEN + 32)
160 struct lttng_ust_channel_attr
{
161 uint64_t subbuf_size
; /* bytes */
162 uint64_t num_subbuf
; /* power of 2 */
163 int overwrite
; /* 1: overwrite, 0: discard */
164 unsigned int switch_timer_interval
; /* usec */
165 unsigned int read_timer_interval
; /* usec */
166 enum lttng_ust_output output
; /* splice, mmap */
167 char padding
[LTTNG_UST_CHANNEL_ATTR_PADDING
];
170 #define LTTNG_UST_TRACEPOINT_ITER_PADDING 16
171 struct lttng_ust_tracepoint_iter
{
172 char name
[LTTNG_UST_SYM_NAME_LEN
]; /* provider:name */
174 char padding
[LTTNG_UST_TRACEPOINT_ITER_PADDING
];
177 enum lttng_ust_object_type
{
178 LTTNG_UST_OBJECT_TYPE_UNKNOWN
= -1,
179 LTTNG_UST_OBJECT_TYPE_CHANNEL
= 0,
180 LTTNG_UST_OBJECT_TYPE_STREAM
= 1,
181 LTTNG_UST_OBJECT_TYPE_EVENT
= 2,
182 LTTNG_UST_OBJECT_TYPE_CONTEXT
= 3,
185 #define LTTNG_UST_OBJECT_DATA_PADDING1 32
186 #define LTTNG_UST_OBJECT_DATA_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
188 struct lttng_ust_object_data
{
189 enum lttng_ust_object_type type
;
192 char padding1
[LTTNG_UST_OBJECT_DATA_PADDING1
];
196 enum lttng_ust_chan_type type
;
204 char padding2
[LTTNG_UST_OBJECT_DATA_PADDING2
];
208 enum lttng_ust_calibrate_type
{
209 LTTNG_UST_CALIBRATE_TRACEPOINT
,
212 #define LTTNG_UST_CALIBRATE_PADDING1 16
213 #define LTTNG_UST_CALIBRATE_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
214 struct lttng_ust_calibrate
{
215 enum lttng_ust_calibrate_type type
; /* type (input) */
216 char padding
[LTTNG_UST_CALIBRATE_PADDING1
];
219 char padding
[LTTNG_UST_CALIBRATE_PADDING2
];
223 #define FILTER_BYTECODE_MAX_LEN 65536
224 #define LTTNG_UST_FILTER_PADDING 32
225 struct lttng_ust_filter_bytecode
{
227 uint32_t reloc_offset
;
229 char padding
[LTTNG_UST_FILTER_PADDING
];
233 #define LTTNG_UST_EXCLUSION_PADDING 32
234 struct lttng_ust_event_exclusion
{
236 char padding
[LTTNG_UST_EXCLUSION_PADDING
];
237 char names
[LTTNG_UST_SYM_NAME_LEN
][0];
240 #define _UST_CMD(minor) (minor)
241 #define _UST_CMDR(minor, type) (minor)
242 #define _UST_CMDW(minor, type) (minor)
244 /* Handled by object descriptor */
245 #define LTTNG_UST_RELEASE _UST_CMD(0x1)
247 /* Handled by object cmd */
249 /* LTTng-UST commands */
250 #define LTTNG_UST_SESSION _UST_CMD(0x40)
251 #define LTTNG_UST_TRACER_VERSION \
252 _UST_CMDR(0x41, struct lttng_ust_tracer_version)
253 #define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
254 #define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
255 #define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
256 #define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45)
258 /* Session FD commands */
259 #define LTTNG_UST_CHANNEL \
260 _UST_CMDW(0x51, struct lttng_ust_channel)
261 #define LTTNG_UST_SESSION_START _UST_CMD(0x52)
262 #define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
264 /* Channel FD commands */
265 #define LTTNG_UST_STREAM _UST_CMD(0x60)
266 #define LTTNG_UST_EVENT \
267 _UST_CMDW(0x61, struct lttng_ust_event)
269 /* Event and Channel FD commands */
270 #define LTTNG_UST_CONTEXT \
271 _UST_CMDW(0x70, struct lttng_ust_context)
272 #define LTTNG_UST_FLUSH_BUFFER \
275 /* Event, Channel and Session commands */
276 #define LTTNG_UST_ENABLE _UST_CMD(0x80)
277 #define LTTNG_UST_DISABLE _UST_CMD(0x81)
279 /* Tracepoint list commands */
280 #define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90)
281 #define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91)
283 /* Event FD commands */
284 #define LTTNG_UST_FILTER _UST_CMD(0xA0)
286 #define LTTNG_UST_ROOT_HANDLE 0
288 struct lttng_ust_obj
;
300 struct lttng_ust_field_iter entry
;
304 struct lttng_ust_objd_ops
{
305 long (*cmd
)(int objd
, unsigned int cmd
, unsigned long arg
,
306 union ust_args
*args
, void *owner
);
307 int (*release
)(int objd
);
310 /* Create root handle. Always ID 0. */
311 int lttng_abi_create_root_handle(void);
313 const struct lttng_ust_objd_ops
*objd_ops(int id
);
314 int lttng_ust_objd_unref(int id
, int is_owner
);
316 void lttng_ust_abi_exit(void);
317 void lttng_ust_events_exit(void);
318 void lttng_ust_objd_table_owner_cleanup(void *owner
);
320 #endif /* _LTTNG_UST_ABI_H */